Agda.Interaction.InteractionTop

Documentation

putResponse :: Response -> CommandM ()

Put a response by the callback function given by stInteractionOutputCallback.

localStateCommandM :: CommandM a -> CommandM a

Restore both TCState and CommandState.

status :: CommandM Status

Computes some status information.

Does not change the state.

whyInScope :: String -> CommandM ()

Explain why something is in scope.

initialiseCommandQueue

Arguments

:: IO Command

Returns the next command.

-> IO CommandQueue

Creates a command queue, and forks a thread that writes commands to the queue. The queue is returned.

maybeAbort :: (IOTCM -> CommandM a) -> CommandM (Command' (Maybe a))

If the next command from the command queue is anything but an actual command, then the command is returned.

If the command is an IOTCM command, then the following happens: The given computation is applied to the command and executed. If an abort command is encountered (and acted upon), then the computation is interrupted, the persistent state and all options are restored, and some commands are sent to the frontend. If the computation was not interrupted, then its result is returned.

atTopLevel :: CommandM a -> CommandM a

withCurrentFile :: CommandM a -> CommandM a

Set envCurrentPath to theCurrentFile, if any.

data GiveRefine

Constructors

Give

Refine

Intro

ElaborateGive Rewrite

Instances

Show GiveRefine

Defined in Agda.Interaction.InteractionTop

Methods

showsPrec :: Int -> GiveRefine -> ShowS

show :: GiveRefine -> String

showList :: [GiveRefine] -> ShowS

Eq GiveRefine

Defined in Agda.Interaction.InteractionTop

Methods

(==) :: GiveRefine -> GiveRefine -> Bool

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

liftLocalState :: TCM a -> CommandM a

Restore TCState, do not touch CommandState.

revLift

Arguments

:: MonadState st m

=> (forall c. m c -> st -> k (c, st))

run

-> (forall b. k b -> m b)

lift

-> (forall x. (m a -> k x) -> k x)

-> m a

reverse lift in double negative position

Build an opposite action to lift for state monads.

revLiftTC

Arguments

:: MonadTCState m

=> (forall c. m c -> TCState -> k (c, TCState))

run

-> (forall b. k b -> m b)

lift

-> (forall x. (m a -> k x) -> k x)

-> m a

reverse lift in double negative position

commandMToIO :: (forall x. (CommandM a -> IO x) -> IO x) -> CommandM a

Opposite of liftIO for CommandM.

This function should only be applied to computations that are guaranteed not to raise any errors (except for IOExceptions).

liftCommandMT :: (forall x. TCM x -> TCM x) -> CommandM a -> CommandM a

Lift a TCM action transformer to a CommandM action transformer.

liftCommandMTLocalState :: (forall x. TCM x -> TCM x) -> CommandM a -> CommandM a

Ditto, but restore state.

modifyTheInteractionPoints :: ([InteractionId] -> [InteractionId]) -> CommandM ()

A Lens for theInteractionPoints.

modifyOldInteractionScopes :: (OldInteractionScopes -> OldInteractionScopes) -> CommandM ()

A Lens for oldInteractionScopes.

insertOldInteractionScope :: InteractionId -> ScopeInfo -> CommandM ()

removeOldInteractionScope :: InteractionId -> CommandM ()

getOldInteractionScope :: InteractionId -> CommandM ScopeInfo

handleCommand_ :: CommandM () -> CommandM ()

Do setup and error handling for a command.

handleCommand :: (forall a. CommandM a -> CommandM a) -> CommandM () -> CommandM () -> CommandM ()

tellEmacsToJumpToError :: Range -> [Response]

Tells the Emacs mode to go to the first error position (if any).

runInteraction :: IOTCM -> CommandM ()

Run an IOTCM value, catch the exceptions, emit output

If an error happens the state of CommandM does not change, but stPersistent may change (which contains successfully loaded interfaces for example).

independent :: Interaction -> Bool

Can the command run even if the relevant file has not been loaded into the state?

cmd_load'

Arguments

:: FilePath

File to load into interaction.

-> [String]

Arguments to Agda for loading this file

-> Bool

Allow unsolved meta-variables?

-> Mode

Full type-checking, or only scope-checking?

-> (CheckResult -> CommandM a)

Continuation after successful loading.

-> CommandM a

cmd_load' file argv unsolvedOk cmd loads the module in file file, using argv as the command-line options.

If type checking completes without any exceptions having been encountered then the command cmd r is executed, where r is the result of typeCheckMain.

interpret :: Interaction -> CommandM ()

Interpret an interaction

updateInteractionPointsAfter :: Interaction -> Bool

Should Resp_InteractionPoints be issued after the command has run?

displayStatus :: CommandM ()

Displays or updates status information.

Does not change the state.

display_info :: DisplayInfo -> CommandM ()

display_info does what display_info' False does, but additionally displays some status information (see status and displayStatus).

showModuleContents :: Rewrite -> Range -> String -> CommandM ()

Shows all the top-level names in the given module, along with their types.

searchAbout :: Rewrite -> Range -> String -> CommandM ()

Shows all the top-level names in scope which mention all the given identifiers in their type.

solveInstantiatedGoals :: Rewrite -> Maybe InteractionId -> CommandM ()

Solved goals already instantiated internally The second argument potentially limits it to one specific goal.

parseAndDoAtToplevel

Arguments

:: (Expr -> TCM a)

The command to perform.

-> String

The expression to parse.

-> CommandM (Maybe CPUTime, a)

Parses and scope checks an expression (using the "inside scope" as the scope), performs the given command with the expression as input, and returns the result and the time it takes.

setCommandLineOpts :: CommandLineOptions -> CommandM ()

Sets the command line options and updates the status information.

tellToUpdateHighlighting :: Maybe (HighlightingInfo, HighlightingMethod, ModuleToSource) -> IO [Response]

Tell to highlight the code using the given highlighting info (unless it is Nothing).

highlightExpr :: Expr -> TCM ()

give_gen

Arguments

:: UseForce

Should safety checks be skipped?

-> InteractionId

-> Range

-> String

-> GiveRefine

-> CommandM ()

A "give"-like action (give, refine, etc).

give_gen force ii rng s give_ref mk_newtxt acts on interaction point ii occupying range rng, placing the new content given by string s, and replacing ii by the newly created interaction points in the state if safety checks pass (unless force is applied).

maybeTimed :: CommandM a -> CommandM (Maybe CPUTime, a)

cmd_goal_type_context_and :: GoalTypeAux -> Rewrite -> InteractionId -> Range -> String -> CommandM ()

Displays the current goal, the given document, and the current context.

Should not modify the state.

sortInteractionPoints :: (MonadInteractionPoints m, MonadError TCErr m, MonadFail m) => [InteractionId] -> m [InteractionId]

Sorts interaction points based on their ranges.