Documentation

Stato is parametrized on an Engine instance and hold the engine with the last regex entered , regex G and g are not implemented now

Constructors

Stato
Fields file :: w data holding the file lastre :: String a regex filename :: Maybe String the file we are editing pending :: Maybe Command a sensible state for data lost lastsaved :: Maybe w

Instances

Eq w => Eq (Stato w)
Show w => Show (Stato w)

type StatoE m w = UndoT (Stato w) mSource

the core editor runs under the state monad with state (Stato w) . Wrapped around a monad (IO mainly) to permit console input and output of commands with IO and testing with State

liftStatoE :: Ctx m w => StatoE m w a -> Editor m w aSource

hputfile :: Ctx m w => w -> Editor m w ()Source

push a new file (data Engine instance) in the core State, pushing the old state in the undo stack

class (Engine w, SIO m, HCtx m (Stato w)) => Ctx m w Source

placeholder for the two constraints

Instances

(Engine w, SIO m, HCtx m (Stato w)) => Ctx m w

data Err Source

the errors (monad failers) which can break the monad flow

Constructors

StopErr	issued on ctrl-d or q command (q not implemented)
ParserErr String	command line was not parsed to a CompleteCommand
RegexUnmatched	the regex doesn't match a line
EvalErr Err	something bad happened in the evaluation process
BackendErr	lines were addressed out of file (see `Engine`)
Ahi String	uncontrolled errors
FileReadErr String	io error trying to load a file
FileNameMissing	filename is not set
FileWriteErr String	io error trying to write the file
ExternalCommandErr String	io error executing an external program
PendingState Command	a sensible data discarding command has been entered
NoMoreUndo	reached the first state remembered
NoMoreRedo	reached the last state remembered
CommandHelpMissing	a help for a missing command was asked
CommandHelpParseErr String	error parsing the help for commands

Instances

Show Err
Error Err

class Monad m => SIO m whereSource

a layer for IO simulation, see Main for the real program one and Test for tests

Methods

inputSio :: String -> m (Maybe String)Source

accepts a prompt and should return Nothing on eof else a line of input

outputSio Source

Arguments

:: String
-> m ()	output a normal string

historySio Source

Arguments

:: String
-> m ()	put a line in the history (which is global)

errorSIO Source

Arguments

:: String
-> m ()	output an error string

readfileSio Source

Arguments

:: String
-> ErrorT String m String	read a file

writefileSio Source

Arguments

:: String
-> String
-> ErrorT String m ()	write a file \| runs an external command , first arg is the command the output is returned or an error is signalled in the errort monad

externalSio :: String -> ErrorT String m String Source

commandhelpSIO :: m FilePath Source

Instances

SIO IO	a SIO data made right for running the editor
SIO CState

liftSio :: Ctx m w => m a -> Editor m w aSource

data Command Source

commands for the editor

Constructors

Append	get some text and add it after the addressed line
Insert	get some text and add it before the addressed line
Change	get some text and add it in place of some deleted lines
Delete	delete some lines
Print	print some lines
SmallG String	get some commands and execute them on each line matching a regex
BigG String	interactively execute commands on each line matching a regex
NoCommand	Change the addressed line
Edit String	Load a file
Write	Write the file
WriteNew String	Write a new file
SetFilename String	Set filename
GetFilename	Print filename
EditExternal String	Load the output of an external command
UndoChange	Revert the last change if ever
RedoChange	Restore via the last change
HelpList	Asking help
HelpTopic String	Spedific help

Instances

Eq Command
Show Command

data Offset Source

represents a line position in the file

Constructors

LastLine	beyond last line, the append line
Absolute Int	the nth line
Current	the line addressed by the engine
Prev Int	the nth line before the addressed one
Next Int	the nth line aftor the addressed one
ReNext String	the next line (wrapping around) matching a regex
LastReNext	the next line matching the last learned regex
RePrev String	the previous line (wrapping around) matching a regex
LastRePrev	the previous matching the last learned regex
MarkedAs Char	the line marked previously with a char