REPL.Haskeline

Documentation

data ReplMode

Constructors

InteractiveRepl

Interactive terminal session

Batch FilePath

Execute from a batch file

InteractiveBatch FilePath

Execute from a batch file, but behave as though lines are entered in an interactive session.

Instances

Show ReplMode

Defined in REPL.Haskeline

Methods

showsPrec :: Int -> ReplMode -> ShowS

show :: ReplMode -> String

showList :: [ReplMode] -> ShowS

Eq ReplMode

Defined in REPL.Haskeline

Methods

(==) :: ReplMode -> ReplMode -> Bool

(/=) :: ReplMode -> ReplMode -> Bool

crySession :: ReplMode -> Bool -> REPL CommandResult

One REPL invocation, either from a file or from the terminal.

data NextLine

Constructors

NextLine [String]

NoMoreLines

Interrupted

getInputLines :: String -> InputT REPL NextLine

loadCryRC :: Cryptolrc -> REPL CommandResult

repl

Arguments

:: Cryptolrc

-> Maybe Config

-> LoadProjectMode

refresh project

-> ReplMode

-> Bool

-> Bool

-> REPL ()

-> IO CommandResult

Haskeline-specific repl implementation.

setHistoryFile :: Settings REPL -> IO (Settings REPL)

Try to set the history file.

replSettings :: Bool -> Settings REPL

Haskeline settings for the REPL.

data Cryptolrc

Configuration of .cryptolrc file behavior. The default option searches the following locations in order, and evaluates the first file that exists in batch mode on interpreter startup:

1. $PWD/.cryptolrc
2. $HOME/.cryptolrc

If files are specified, they will all be evaluated, but none of the default files will be (unless they are explicitly specified).

The disabled option inhibits any reading of any .cryptolrc files.

Constructors

CryrcDefault

CryrcDisabled

CryrcFiles [FilePath]

Instances

Show Cryptolrc

Defined in REPL.Haskeline

Methods

showsPrec :: Int -> Cryptolrc -> ShowS

show :: Cryptolrc -> String

showList :: [Cryptolrc] -> ShowS

mkTitle :: Maybe LoadedModule -> String

setREPLTitle :: REPL ()

shouldSetREPLTitle :: REPL Bool

In certain environments like Emacs, we shouldn't set the terminal title. Note: this does not imply we can't use color output. We can use ANSI color sequences in places like Emacs, but not terminal codes.

This checks that stdout is a proper terminal handle, and that the terminal mode is not dumb, which is set by Emacs and others.

canDisplayColor :: REPL Bool

Whether we can display color titles. This checks that stdout is a proper terminal handle, and that the terminal mode is not dumb, which is set by Emacs and others.

cryptolCommand :: CompletionFunc REPL

Completion for cryptol commands.

cmdComp :: String -> CommandDescr -> [Completion]

Generate completions from a REPL command definition.

cmdArgument :: CommandBody -> CompletionFunc REPL

Dispatch to a completion function based on the kind of completion the command is expecting.

keywords :: [String]

Additional keywords to suggest in the REPL autocompletion list.

completeExpr :: CompletionFunc REPL

Complete a name from the expression environment.

completeType :: CompletionFunc REPL

Complete a name from the type synonym environment.

completeHelp :: CompletionFunc REPL

Complete a name for which we can show REPL help documentation.

completeModName :: CompletionFunc REPL

Complete a name from the list of loaded modules.

nameComp :: String -> String -> Completion

Generate a completion from a prefix and a name.

takeIdent :: String -> String

Return longest identifier (possibly a qualified name) that is a prefix of the given string

isIdentChar :: Char -> Bool

(+++) :: CompletionFunc REPL -> CompletionFunc REPL -> CompletionFunc REPL

Join two completion functions together, merging and sorting their results.

completeOption :: CompletionFunc REPL

Complete an option from the options environment.

XXX this can do better, as it has access to the expected form of the value