 | haskeline-0.6.2.1: A command-line interface for user input, written in Haskell. | Contents | Index |
|
System.Console.Haskeline.Completion |
|
|
|
|
|
Synopsis |
|
|
|
Documentation |
|
type CompletionFunc m = (String, String) -> m (String, [Completion]) |
Performs completions from the given line state.
The first String argument is the contents of the line to the left of the cursor,
reversed.
The second String argument is the contents of the line to the right of the cursor.
The output String is the unused portion of the left half of the line, reversed.
|
|
data Completion |
Constructors | Completion | | replacement :: String | Text to insert in line.
| display :: String | Text to display when listing
alternatives.
| isFinished :: Bool | Whether this word should be followed by a
space, end quote, etc.
|
|
| Instances | |
|
|
completeWord |
:: Monad m | | => Maybe Char | An optional escape character
| -> String | List of characters which count as whitespace
| -> String -> m [Completion] | Function to produce a list of possible completions
| -> CompletionFunc m | | The following function creates a custom CompletionFunc for use in the 'Settings.'
|
|
|
completeQuotedWord |
:: Monad m | | => Maybe Char | An optional escape character
| -> String | | -> String -> m [Completion] | Function to produce a list of possible completions
| -> CompletionFunc m | Alternate completion to perform if the
cursor is not at a quoted word
| -> CompletionFunc m | |
|
|
Building CompletionFuncs
|
|
noCompletion :: Monad m => CompletionFunc m |
Disable completion altogether.
|
|
simpleCompletion :: String -> Completion |
Create a finished completion out of the given word.
|
|
Filename completion
|
|
completeFilename :: MonadIO m => CompletionFunc m |
|
listFiles :: MonadIO m => FilePath -> m [Completion] |
List all of the files or folders beginning with this path.
|
|
filenameWordBreakChars :: String |
|
Produced by Haddock version 2.3.0 |