Modulehaskeline-0.8.2.1Haskell98

System.Console.Haskeline.Completion

2 types
11 values

Packagehaskeline-0.8.2.1
Exports13
LanguageHaskell98
LicenceBSD-3-Clause
SourceCompletion.hs

typetype CompletionFunc (m :: Type -> Type) = (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.

datadata 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.

Instances3Eq, Ord, Show

Eq CompletionDefined in haskeline-0.8.2.1 · System.Console.Haskeline.Completion
Ord CompletionDefined in haskeline-0.8.2.1 · System.Console.Haskeline.Completion
Show CompletionDefined in haskeline-0.8.2.1 · System.Console.Haskeline.Completion

valuenoCompletion :: Monad m => CompletionFunc m

Disable completion altogether.

valuesimpleCompletion :: String -> Completion

Create a finished completion out of the given word.

valuefallbackCompletion

:: Monad m
=> CompletionFunc m
-> CompletionFunc m
-> CompletionFunc m

If the first completer produces no suggestions, fallback to the second completer's output.

Word completion

5 declarations

valuecompleteWord

:: Monad m
=> Maybe Char
An optional escape character
-> [Char]
Characters which count as whitespace
-> (String -> m [Completion])
Function to produce a list of possible completions
-> CompletionFunc m

A custom CompletionFunc which completes the word immediately to the left of the cursor.

A word begins either at the start of the line or after an unescaped whitespace character.

valuecompleteWord'

:: Monad m
=> Maybe Char
An optional escape character
-> (Char -> Bool)
Characters which count as whitespace
-> (String -> m [Completion])
Function to produce a list of possible completions
-> CompletionFunc m

The same as completeWord but takes a predicate for the whitespace characters

valuecompleteWordWithPrev

:: Monad m
=> Maybe Char
An optional escape character
-> [Char]
Characters which count as whitespace
-> (String -> String -> m [Completion])
Function to produce a list of possible completions. The first argument is the line contents to the left of the word, reversed. The second argument is the word to be completed.
-> CompletionFunc m

A custom CompletionFunc which completes the word immediately to the left of the cursor, and takes into account the line contents to the left of the word.

A word begins either at the start of the line or after an unescaped whitespace character.

valuecompleteWordWithPrev'

:: Monad m
=> Maybe Char
An optional escape character
-> (Char -> Bool)
Characters which count as whitespace
-> (String -> String -> m [Completion])
Function to produce a list of possible completions. The first argument is the line contents to the left of the word, reversed. The second argument is the word to be completed.
-> CompletionFunc m

The same as completeWordWithPrev but takes a predicate for the whitespace characters

valuecompleteQuotedWord

:: Monad m
=> Maybe Char
An optional escape character
-> [Char]
Characters which set off quotes
-> (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

Filename completion

3 declarations

valuecompleteFilename :: MonadIO m => CompletionFunc m

valuelistFiles :: MonadIO m => FilePath -> m [Completion]

List all of the files or folders beginning with this path.

valuefilenameWordBreakChars :: String