| Safe Haskell | None |
|---|---|
| Language | Haskell98 |
System.Console.Haskeline.Completion
Synopsis
- type CompletionFunc m = (String, String) -> m (String, [Completion])
- data Completion = Completion {
- replacement :: String
- display :: String
- isFinished :: Bool
- noCompletion :: Monad m => CompletionFunc m
- simpleCompletion :: String -> Completion
- fallbackCompletion :: Monad m => CompletionFunc m -> CompletionFunc m -> CompletionFunc m
- completeWord :: Monad m => Maybe Char -> [Char] -> (String -> m [Completion]) -> CompletionFunc m
- completeWord' :: Monad m => Maybe Char -> (Char -> Bool) -> (String -> m [Completion]) -> CompletionFunc m
- completeWordWithPrev :: Monad m => Maybe Char -> [Char] -> (String -> String -> m [Completion]) -> CompletionFunc m
- completeWordWithPrev' :: Monad m => Maybe Char -> (Char -> Bool) -> (String -> String -> m [Completion]) -> CompletionFunc m
- completeQuotedWord :: Monad m => Maybe Char -> [Char] -> (String -> m [Completion]) -> CompletionFunc m -> CompletionFunc m
- completeFilename :: MonadIO m => CompletionFunc m
- listFiles :: MonadIO m => FilePath -> m [Completion]
- filenameWordBreakChars :: String
Documentation
type CompletionFunc m = (String, String) -> m (String, [Completion]) Source #
data Completion Source #
Constructors
| Completion | |
Fields
| |
Instances
| Eq Completion Source # | |
Defined in System.Console.Haskeline.Completion | |
| Ord Completion Source # | |
Defined in System.Console.Haskeline.Completion Methods compare :: Completion -> Completion -> Ordering # (<) :: Completion -> Completion -> Bool # (<=) :: Completion -> Completion -> Bool # (>) :: Completion -> Completion -> Bool # (>=) :: Completion -> Completion -> Bool # max :: Completion -> Completion -> Completion # min :: Completion -> Completion -> Completion # | |
| Show Completion Source # | |
Defined in System.Console.Haskeline.Completion Methods showsPrec :: Int -> Completion -> ShowS # show :: Completion -> String # showList :: [Completion] -> ShowS # | |
noCompletion :: Monad m => CompletionFunc m Source #
Disable completion altogether.
simpleCompletion :: String -> Completion Source #
Create a finished completion out of the given word.
fallbackCompletion :: Monad m => CompletionFunc m -> CompletionFunc m -> CompletionFunc m Source #
If the first completer produces no suggestions, fallback to the second completer's output.
Word completion
Arguments
| :: 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.
Arguments
| :: 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
Arguments
| :: 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.
completeWordWithPrev' Source #
Arguments
| :: 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
Arguments
| :: 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
completeFilename :: MonadIO m => CompletionFunc m Source #