Yi.Eval

Evaluator for actions (Action, YiAction). Uses a GHCi session under the hood.

Main (generic) evaluation interface

execEditorAction :: String -> YiM ()

Runs the action, as written by the user.

The behaviour of this function can be customised by modifying the Evaluator variable.

getAllNamesInScope :: YiM [String]

Lists the action names in scope, for use by execEditorAction, and help index.

The behaviour of this function can be customised by modifying the Evaluator variable.

describeNamedAction :: String -> YiM String

Describes the named action in scope, for use by help.

The behaviour of this function can be customised by modifying the Evaluator variable.

data Evaluator

Config variable for customising the behaviour of execEditorAction and getAllNamesInScope.

Set this variable using evaluator. See ghciEvaluator and finiteListEvaluator for two implementation.

Constructors

Evaluator

Fields

execEditorActionImpl :: String -> YiM ()

implementation of execEditorAction

getAllNamesInScopeImpl :: YiM [String]

implementation of getAllNamesInScope

describeNamedActionImpl :: String -> YiM String

describe named action (or at least its type.), simplest implementation is at least return.

Instances

Default Evaluator

YiConfigVariable Evaluator

Typeable * Evaluator

evaluator :: Field Evaluator

The evaluator to use for execEditorAction and getAllNamesInScope.

Standard evaluators

publishedActionsEvaluator :: Evaluator

Evaluator based on a fixed list of published actions. Has a few differences from ghciEvaluator:

• expressions can't be evaluated
• all suggested actions are actually valued
• (related to the above) doesn't contain junk actions from Prelude
• doesn't require GHCi backend, so uses less memory

publishedActions :: Field (HashMap String Action)

Accessor for the published actions. Consider using publishAction.

publishAction :: (YiAction a x, Show x) => String -> a -> ConfigM ()

Publish the given action, by the given name. This will overwrite any existing actions by the same name.

Eval/Interpretation

jumpToErrorE :: YiM ()

Tries to jump to error at the current line. See parseErrorMessageB.

jumpToE

Arguments

:: FilePath

Filename to make the jump in.

-> Int

Line to jump to.

-> Int

Column to jump to.

-> YiM ()

Jumps to specified position in a given file.

consoleKeymap :: Keymap