xmonad-contrib-0.8.1: Third party extensions for xmonadSource codeContentsIndex
XMonad.Prompt
Portabilityunportable
Stabilityunstable
Maintainerandrea.rossato@unibz.it
Contents
Usage
X Utilities
Other Utilities
nextCompletion implementations
List utilities
Description
A module for writing graphical prompts for XMonad
Synopsis
mkXPrompt :: XPrompt p => p -> XPConfig -> ComplFunction -> (String -> X ()) -> X ()
mkXPromptWithReturn :: XPrompt p => p -> XPConfig -> ComplFunction -> (String -> X a) -> X (Maybe a)
defaultXPConfig :: XPConfig
data XPType = forall p . XPrompt p => XPT p
data XPPosition
= Top
| Bottom
data XPConfig = XPC {
font :: String
bgColor :: String
fgColor :: String
fgHLight :: String
bgHLight :: String
borderColor :: String
promptBorderWidth :: !Dimension
position :: XPPosition
height :: !Dimension
historySize :: !Int
defaultText :: String
autoComplete :: Maybe Int
}
class XPrompt t where
showXPrompt :: t -> String
nextCompletion :: t -> String -> [String] -> String
commandToComplete :: t -> String -> String
completionToCommand :: t -> String -> String
type ComplFunction = String -> IO [String]
mkUnmanagedWindow :: Display -> Screen -> Window -> Position -> Position -> Dimension -> Dimension -> IO Window
fillDrawable :: Display -> Drawable -> GC -> Pixel -> Pixel -> Dimension -> Dimension -> Dimension -> IO ()
mkComplFunFromList :: [String] -> String -> IO [String]
mkComplFunFromList' :: [String] -> String -> IO [String]
getNextOfLastWord :: XPrompt t => t -> String -> [String] -> String
getNextCompletion :: String -> [String] -> String
getLastWord :: String -> String
skipLastWord :: String -> String
splitInSubListsAt :: Int -> [a] -> [[a]]
breakAtSpace :: String -> (String, String)
uniqSort :: Ord a => [a] -> [a]
decodeInput :: String -> String
encodeOutput :: String -> String
historyCompletion :: ComplFunction
Usage

For usage examples see XMonad.Prompt.Shell, XMonad.Prompt.XMonad or XMonad.Prompt.Ssh

TODO:

  • scrolling the completions that don't fit in the window (?)
mkXPrompt :: XPrompt p => p -> XPConfig -> ComplFunction -> (String -> X ()) -> X ()Source

Creates a prompt given:

  • a prompt type, instance of the XPrompt class.
  • a prompt configuration (defaultXPConfig can be used as a starting point)
  • a completion function (mkComplFunFromList can be used to create a completions function given a list of possible completions)
  • an action to be run: the action must take a string and return X ()
mkXPromptWithReturn :: XPrompt p => p -> XPConfig -> ComplFunction -> (String -> X a) -> X (Maybe a)Source
Same as mkXPrompt, except that the action function can have type String -> X a, for any a, and the final action returned by mkXPromptWithReturn will have type X (Maybe a). Nothing is yielded if the user cancels the prompt (by e.g. hitting Esc or Ctrl-G). For an example of use, see the XMonad.Prompt.Input module.
defaultXPConfig :: XPConfigSource
data XPType Source
Constructors
forall p . XPrompt p => XPT p
show/hide Instances
data XPPosition Source
Constructors
Top
Bottom
show/hide Instances
data XPConfig Source
Constructors
XPC
font :: StringFont
bgColor :: StringBackground color
fgColor :: StringFont color
fgHLight :: StringFont color of a highlighted completion entry
bgHLight :: StringBackground color of a highlighted completion entry
borderColor :: StringBorder color
promptBorderWidth :: !DimensionBorder width
position :: XPPositionPosition: Top or Bottom
height :: !DimensionWindow height
historySize :: !IntThe number of history entries to be saved
defaultText :: StringThe text by default in the prompt line
autoComplete :: Maybe IntJust x: if only one completion remains, auto-select it, and delay by x microseconds
show/hide Instances
class XPrompt t whereSource

The class prompt types must be an instance of. In order to create a prompt you need to create a data type, without parameters, and make it an instance of this class, by implementing a simple method, showXPrompt, which will be used to print the string to be displayed in the command line window.

This is an example of a XPrompt instance definition: 

     instance XPrompt Shell where
          showXPrompt Shell = "Run: "
Methods
showXPrompt :: t -> StringSource
This method is used to print the string to be displayed in the command line window.
nextCompletion :: t -> String -> [String] -> StringSource
This method is used to generate the next completion to be printed in the command line when tab is pressed, given the string presently in the command line and the list of completion.
commandToComplete :: t -> String -> StringSource
This method is used to generate the string to be passed to the completion function.
completionToCommand :: t -> String -> StringSource
This method is used to process each completion in order to generate the string that will be compared with the command presently displayed in the command line. If the prompt is using getNextOfLastWord for implementing nextCompletion (the default implementation), this method is also used to generate, from the returned completion, the string that will form the next command line when tab is pressed.
show/hide Instances
XPrompt XPType
XPrompt AppendFile
XPrompt InputPrompt
XPrompt DirExec
XPrompt Shell
XPrompt AppPrompt
XPrompt Man
XPrompt Ssh
XPrompt Wor
XPrompt Dir
XPrompt Wor
XPrompt ThemePrompt
XPrompt WindowPrompt
XPrompt RunOrRaisePrompt
XPrompt TagPrompt
XPrompt Search
XPrompt Wor
XPrompt XMonad
type ComplFunction = String -> IO [String]Source
X Utilities
mkUnmanagedWindow :: Display -> Screen -> Window -> Position -> Position -> Dimension -> Dimension -> IO WindowSource
Creates a window with the attribute override_redirect set to True. Windows Managers should not touch this kind of windows.
fillDrawable :: Display -> Drawable -> GC -> Pixel -> Pixel -> Dimension -> Dimension -> Dimension -> IO ()Source
Fills a Drawable with a rectangle and a border
Other Utilities
mkComplFunFromList :: [String] -> String -> IO [String]Source
This function takes a list of possible completions and returns a completions function to be used with mkXPrompt
mkComplFunFromList' :: [String] -> String -> IO [String]Source
This function takes a list of possible completions and returns a completions function to be used with mkXPrompt. If the string is null it will return all completions.
nextCompletion implementations
getNextOfLastWord :: XPrompt t => t -> String -> [String] -> StringSource
Given the prompt type, the command line and the completion list, return the next completion in the list for the last word of the command line. This is the default nextCompletion implementation.
getNextCompletion :: String -> [String] -> StringSource
An alternative nextCompletion implementation: given a command and a completion list, get the next completion in the list matching the whole command line.
List utilities
getLastWord :: String -> StringSource
Gets the last word of a string or the whole string if formed by only one word
skipLastWord :: String -> StringSource
Skips the last word of the string, if the string is composed by more then one word. Otherwise returns the string.
splitInSubListsAt :: Int -> [a] -> [[a]]Source
Given a maximum length, splits a list into sublists
breakAtSpace :: String -> (String, String)Source
uniqSort :: Ord a => [a] -> [a]Source
Sort a list and remove duplicates.
decodeInput :: String -> StringSource
encodeOutput :: String -> StringSource
historyCompletion :: ComplFunctionSource
historyCompletion provides a canned completion function much like getShellCompl; you pass it to mkXPrompt, and it will make completions work from the query history stored in ~.xmonadhistory.
Produced by Haddock version 2.4.2