Hedi-0.1.1: Line oriented editor Source code Contents Index

Editor

Description

Main datas and types for the editor

Synopsis

data Stato = Stato { file :: Engine lastre :: String filename :: Maybe String pending :: Maybe Command lastsaved :: Maybe Engine } type StatoE m = UndoT Stato m liftStatoE :: Ctx m => StatoE m a -> Editor m a hputfile :: Ctx m => Engine -> Editor m () class (SIO m, HCtx m Stato) => Ctx m data Err = StopErr | ParserErr String | RegexUnmatched | EvalErr Err | BackendErr | Ahi String | FileReadErr String | FileNameMissing | FileWriteErr String | ExternalCommandErr String | PendingState Command | NoMoreUndo | NoMoreRedo | CommandHelpMissing | CommandHelpParseErr String class Monad m => SIO m where inputSio :: String -> m (Maybe String) outputSio :: String -> m () historySio :: String -> m () errorSIO :: String -> m () readfileSio :: String -> ErrorT String m String writefileSio :: String -> String -> ErrorT String m () externalSio :: String -> ErrorT String m String commandhelpSIO :: m FilePath liftSio :: Ctx m => m a -> Editor m a data Command = Append | Insert | Change | Delete | Print | SmallG String | BigG String | NoCommand | Edit String | Write | WriteNew String | SetFilename String | GetFilename | EditExternal String | UndoChange | RedoChange | HelpList | HelpTopic String data Offset = LastLine | Absolute Int | Current | Prev Int | Next Int | ReNext String | LastReNext | RePrev String | LastRePrev | MarkedAs Char data Range = Range Offset Offset data OffsetOrRange = ORO Offset | ORR Range | ORN data CompleteCommand = CC Command OffsetOrRange type Editor m = ErrorT Err (StatoE m) backend :: Ctx m => Maybe a -> Editor m a through :: Ctx m => (Engine -> Maybe a) -> Editor m a pinput :: Ctx m => String -> Editor m (Maybe String) input :: Ctx m => Editor m (Maybe String) output :: Ctx m => String -> Editor m () history :: Ctx m => String -> Editor m () errorlog :: Ctx m => String -> Editor m () run :: Ctx m => Editor m a -> Stato -> m Stato

Documentation

data Stato Source

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 file :: Engine 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 Engine Instances Eq Stato Show Stato

type StatoE m = UndoT Stato m Source

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

liftStatoE :: Ctx m => StatoE m a -> Editor m a Source

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

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

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

placeholder for the two constraints

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 where Source

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 :: String -> m () output a normal string historySio Source :: String -> m () put a line in the history (which is global) errorSIO Source :: String -> m () output an error string readfileSio Source :: String -> ErrorT String m String read a file writefileSio Source :: 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 SIO CState

liftSio :: Ctx m => m a -> Editor m a Source

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 Instances Show Offset

data Range Source

a couple of Offsets Constructors Range Offset Offset Instances Show Range

data OffsetOrRange Source

wrapper a round the two possible addressing for a command Offset and Range Constructors ORO Offset ORR Range ORN Instances Show OffsetOrRange

data CompleteCommand Source

a complete command is a Command coupled with a Range or an Offset Constructors CC Command OffsetOrRange Instances Show CompleteCommand

type Editor m = ErrorT Err (StatoE m) Source

main datatype for the program-- beyond the core state, a simulation layer SIO can be read and errors Err can be thrown to kill the monad flow

backend Source

:: Ctx m => Maybe a maybe action -> Editor m a monading wrap a maybe action and throw a backend error on a Nothing

through Source

:: Ctx m => Engine -> Maybe a an action from an engine w to a maybe -> Editor m a the result from Just in the Editor monad execute an action on the file

pinput :: Ctx m => String -> Editor m (Maybe String) Source

the inputSio action lifted to Editor

input :: Ctx m => Editor m (Maybe String) Source

the inputSio action lifted to Editor with empty prompt

output :: Ctx m => String -> Editor m () Source

the outputSio action lifted to Editor

history :: Ctx m => String -> Editor m () Source

the historySIO action lifted to Editor

errorlog :: Ctx m => String -> Editor m () Source

the errorSIO action lifted to Editor

run Source

:: Ctx m => Editor m a the action to run -> Stato the initial state -> m Stato the final state wrapped in the monad choosen for the SIO editor runner . resolve the all monad from a core state to another

Produced by Haddock version 2.3.0