HERMIT.Shell.Types

Documentation

data ShellCommand

There are four types of commands.

Constructors

KernelEffect KernelEffect

Command that modifies the state of the (scoped) kernel.

ShellEffect ShellEffect

Command that modifies the state of the shell.

QueryFun QueryFun

Command that queries the AST with a Translate (read only).

MetaCommand MetaCommand

Command that otherwise controls HERMIT (abort, resume, save, etc).

data KernelEffect where

KernelEffects are things that affect the state of the Kernel - Apply a rewrite (giving a whole new lower-level AST). - Change the current location using a computed path. - Change the currect location using directions. - Begin or end a scope. - Delete an AST - Run a precondition or other predicate that must not fail.

Constructors

Apply :: (Injection ModGuts g, Walker HermitC g) => RewriteH g -> KernelEffect

Pathfinder :: (Injection ModGuts g, Walker HermitC g) => TranslateH g LocalPathH -> KernelEffect

Direction :: Direction -> KernelEffect

BeginScope :: KernelEffect

EndScope :: KernelEffect

Delete :: SAST -> KernelEffect

CorrectnessCritera :: (Injection ModGuts g, Walker HermitC g) => TranslateH g () -> KernelEffect

Instances

Typeable KernelEffect

Extern KernelEffect

data ShellEffect where

Constructors

CLSModify :: (CommandLineState -> IO CommandLineState) -> ShellEffect

Instances

Typeable ShellEffect

Extern ShellEffect

data QueryFun where

Constructors

QueryString :: (Injection ModGuts g, Walker HermitC g) => TranslateH g String -> QueryFun

QueryDocH :: (PrettyC -> PrettyH CoreTC -> TranslateH CoreTC DocH) -> QueryFun

Display :: QueryFun

Inquiry :: (CommandLineState -> IO String) -> QueryFun

Instances

Typeable QueryFun

Extern QueryFun

message :: String -> QueryFun

type RewriteName = String

data MetaCommand

Constructors

Resume

Abort

Continue

Diff SAST SAST

Dump String String Int

LoadFile ScriptName FilePath

SaveFile FilePath

ScriptToRewrite RewriteName ScriptName

DefineScript ScriptName String

RunScript ScriptName

SaveScript FilePath ScriptName

SeqMeta [MetaCommand]

Instances

Typeable MetaCommand

Extern MetaCommand

loadAndRun :: FilePath -> MetaCommand

A composite meta-command for running a loaded script immediately. The script is given the same name as the filepath.

data VersionCmd

Constructors

Back

Step

Goto Int

GotoTag String

AddTag String

Instances

Show VersionCmd

data CLException

Constructors

CLAbort

CLResume SAST

CLContinue CommandLineState

CLError String

Instances

Error CLException

Monad m => MonadError CLException (CLM m)

newtype CLM m a

Constructors

CLM

Fields

unCLM :: ErrorT CLException (StateT CommandLineState m) a

Instances

MonadTrans CLM

Monad m => MonadState CommandLineState (CLM m)

Monad m => MonadError CLException (CLM m)

Monad m => Monad (CLM m)

Our own custom instance of Monad for CLM m so we don't have to depend on newtype deriving to do the right thing for fail.

Functor m => Functor (CLM m)

(Monad m, Functor m) => Applicative (CLM m)

MonadIO m => MonadIO (CLM m)

Monad m => MonadCatch (CLM m)

abort :: Monad m => CLM m ()

resume :: Monad m => SAST -> CLM m ()

continue :: Monad m => CommandLineState -> CLM m ()

runCLM :: CommandLineState -> CLM m a -> m (Either CLException a, CommandLineState)

iokm2clm' :: MonadIO m => String -> (a -> CLM m b) -> IO (KureM a) -> CLM m b

iokm2clm :: MonadIO m => String -> IO (KureM a) -> CLM m a

iokm2clm'' :: MonadIO m => IO (KureM a) -> CLM m a

data VersionStore

Constructors

VersionStore

Fields

vs_graph :: [(SAST, ExprH, SAST)]

vs_tags :: [(String, SAST)]

newSAST :: ExprH -> SAST -> CommandLineState -> CommandLineState

data CommandLineState

Constructors

CommandLineState

Fields

cl_cursor :: SAST

the current AST

cl_pretty :: PrettyH CoreTC

which pretty printer to use

cl_pretty_opts :: PrettyOptions

the options for the pretty printer

cl_render :: Handle -> PrettyOptions -> Either String DocH -> IO ()

the way of outputing to the screen

cl_height :: Int

console height, in lines

cl_nav :: Bool

keyboard input the nav panel

cl_running_script :: Bool

if running a script

cl_tick :: TVar (Map String Int)

the list of ticked messages

cl_corelint :: Bool

if true, run Core Lint on module after each rewrite

cl_diffonly :: Bool

if true, show diffs rather than pp full code

cl_failhard :: Bool

if true, abort on *any* failure

cl_window :: PathH

path to beginning of window, always a prefix of focus path in kernel these four should be in a reader

cl_dict :: Dictionary

cl_scripts :: [(ScriptName, Script)]

cl_kernel :: ScopedKernel

cl_initSAST :: SAST

cl_version :: VersionStore

Instances

Monad m => MonadState CommandLineState (CLM m)

type ScriptName = String