Creates a prompt given:

• a prompt type, instance of the XPrompt class.
• a prompt configuration (def 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 ()

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 Input module.

Creates a prompt with multiple modes given:

• A non-empty list of modes
• A prompt configuration

The created prompt allows to switch between modes with changeModeKey in conf. The modes are instances of XPrompt. See XMonad.Actions.Launcher for more details

The argument supplied to the action to execute is always the current highlighted item, that means that this prompt overrides the value alwaysHighlight for its configuration to True.

The default value for this type.

A class for an abstract prompt. In order for your data type to be a valid prompt you _must_ make it an instance of this class.

The minimal complete definition is just showXPrompt, i.e. the name of the prompt. This string will be displayed in the command line window (before the cursor).

As an example of a complete XPrompt instance definition, we can look at the Shell prompt from XMonad.Prompt.Shell:

    data Shell = Shell

    instance XPrompt Shell where
         showXPrompt Shell = "Run: "

Default key bindings for prompts. Click on the "Source" link to the right to see the complete list. See also defaultXPKeymap'.

A variant of defaultXPKeymap which lets you specify a custom predicate for identifying non-word characters, which affects all the word-oriented commands (move/kill word). The default is isSpace. For example, by default a path like foo/bar/baz would be considered as a single word. You could use a predicate like (\c -> isSpace c || c == '/') to move through or delete components of the path one at a time.

A keymap with many emacs-like key bindings. Click on the "Source" link to the right to see the complete list. See also emacsLikeXPKeymap'.

A variant of emacsLikeXPKeymap which lets you specify a custom predicate for identifying non-word characters, which affects all the word-oriented commands (move/kill word). The default is isSpace. For example, by default a path like foo/bar/baz would be considered as a single word. You could use a predicate like (\c -> isSpace c || c == '/') to move through or delete components of the path one at a time.

Vim-ish key bindings. Click on the "Source" link to the right to see the complete list. See also vimLikeXPKeymap'.

A variant of vimLikeXPKeymap with customizable aspects:

Quit.

Initiate a prompt sub-map event loop. Submaps are intended to provide alternate keybindings. Accepts a default action and a mapping from key combinations to actions. If no entry matches, the default action is run.

Initiate a prompt input buffer event loop. Input is sent to a buffer and bypasses the prompt. The provided function is given the existing buffer and the input keystring. The first field of the result determines whether the input loop continues (if True). The second field determines whether the input is appended to the buffer, or dropped (if False). If the loop is to stop without keeping input - that is, (False,False) - the event is prepended to the event buffer to be processed by the parent loop. This allows loop to process both fixed and indeterminate inputs.

Result given (continue,keep):

• cont and keep

  • grow input buffer

• stop and keep

  • grow input buffer
  • stop loop

• stop and drop

  • buffer event
  • stop loop

• cont and drop

  • do nothing

Move the cursor in the given direction to the first instance of the first character of the given string, assuming the string is not empty. The starting cursor character is not considered, and the cursor is placed over the matching character.

Predicate instructing promptBuffer to get (and keep) a single non-empty KeyEvent.

Kill the portion of the command before the cursor

Kill the portion of the command including and after the cursor

Put the cursor at the start of line

Put the cursor at the end of line

Insert a character at the cursor position

Insert the current X selection string at the cursor position. The X selection is not modified.

A variant of pasteString which allows modifying the X selection before pasting.

Ensure the cursor remains over the command by shifting left if necessary.

Move the cursor one position.

Move the cursor one position, but not beyond the command.

Sets the input string to the given value.

Returns the current input string. Intended for use in custom keymaps where get or similar can't be used to retrieve it.

Returns the offset of the current input string. Intended for use in custom keys where get or similar can't be used to retrieve it.

Accessor encapsulating disparate color fields of XPConfig into an XPColor (the configuration provides default values).

Modify the prompt colors.

Set the prompt colors.

Reset the prompt colors to those from XPConfig.

Set the prompt border color.

Modify the prompter, i.e. for chaining prompters.

Set the prompter.

Reset the prompter to the one from XPConfig.

Return the selected completion, i.e. the String we actually act upon after the user confirmed their selection (by pressing Enter).

Set the current completion list, or Nothing to invalidate the current completions.

Get the current completion list.

Move the cursor one word, using isSpace as the default predicate for non-word characters. See moveWord'.

Given a direction, move the cursor to just before the next (predicate,not-predicate) character transition. This means a (not-word,word) transition should be followed by a moveCursorClip action. Always considers the character under the current cursor position. This means a (word,not-word) transition should be preceded by a moveCursorClip action. Calculated as the length of consecutive non-predicate characters starting from the cursor position, plus the length of subsequent consecutive predicate characters, plus when moving backwards the distance of the cursor beyond the input. Reduced by one to avoid jumping off either end of the input, when present.

Use these identities to retain the pre-0.14 behavior:

    (oldMoveWord' p Prev) = (moveCursor Prev >> moveWord' p Prev)

    (oldMoveWord' p Next) = (moveWord' p Next >> moveCursor Next)

Kill the next/previous word, using isSpace as the default predicate for non-word characters. See killWord'.

Kill the next/previous word, given a predicate to identify non-word characters. First delete any consecutive non-word characters; then delete consecutive word characters, stopping just before the next non-word character.

For example, by default (using killWord) a path like foo/bar/baz would be deleted in its entirety. Instead you can use something like killWord' (\c -> isSpace c || c == '/') to delete the path one component at a time.

From Vim's :help cw:

• Special case: When the cursor is in a word, "cw" and "cW" do not include the white space after a word, they only change up to the end of the word.

Remove a character at the cursor position

Set the prompt's input to an entry further up or further down the history stack. Use Stack functions from StackSet, i.e. focusUp' or focusDown'.

Set True to save the prompt's entry to history and run it via the provided action.

Set True to leave all event loops, no matter how nested.

Set True to leave the current event loop, i.e. submaps.

One-dimensional directions:

Creates a window with the attribute override_redirect set to True. Windows Managers should not touch this kind of windows.

Fills a Drawable with a rectangle and a border

This function takes a list of possible completions and returns a completions function to be used with mkXPrompt

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.

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.

An alternative nextCompletion implementation: given a command and a completion list, get the next completion in the list matching the whole command line.

Gets the last word of a string or the whole string if formed by only one word

Skips the last word of the string, if the string is composed by more then one word. Otherwise returns the string.

Given a maximum length, splits a list into sublists

Sort a list and remove duplicates. Like deleteAllDuplicates, but trades off laziness and stability for efficiency.

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 the XMonad cache directory.

Like historyCompletion but only uses history data from Prompts whose name satisfies the given predicate.

Functions to be used with the historyFilter setting. deleteAllDuplicates will remove all duplicate entries. deleteConsecutive will only remove duplicate elements immediately next to each other.

Functions to be used with the historyFilter setting. deleteAllDuplicates will remove all duplicate entries. deleteConsecutive will only remove duplicate elements immediately next to each other.

Initializes a new HistoryMatches structure to be passed to historyUpMatching

Retrieve the next history element that starts with the current input. Pass it the result of initMatches when creating the prompt. Example:

..
((modMask,xK_p), shellPrompt . myPrompt =<< initMatches)
..
myPrompt ref = def
  { promptKeymap = M.union [((0,xK_Up), historyUpMatching ref)
                           ,((0,xK_Down), historyDownMatching ref)]
                           (promptKeymap def)
  , .. }

Retrieve the next history element that starts with the current input. Pass it the result of initMatches when creating the prompt. Example:

..
((modMask,xK_p), shellPrompt . myPrompt =<< initMatches)
..
myPrompt ref = def
  { promptKeymap = M.union [((0,xK_Up), historyUpMatching ref)
                           ,((0,xK_Down), historyDownMatching ref)]
                           (promptKeymap def)
  , .. }