Hedi-0.1.1: Line oriented editor Source code Contents Index

Helper

Description

Parse and pretty print the string of help of commands

Synopsis

data CommandHelp = CommandHelp { name :: String synopsis :: String descriptions :: [String] errors :: [String] implementation :: String } parseACommandHelp :: CharParser () CommandHelp parseCommandsHelp :: CharParser () [CommandHelp] run :: String -> GenParser Char () a -> (a -> Maybe b) -> Either String (Maybe b) tabulate :: [[String]] -> String listOfCommands :: String -> Either String (Maybe String) helpCommand :: String -> String -> Either String (Maybe String)

Documentation

data CommandHelp Source

structure for the help of a command Constructors CommandHelp name :: String the command name synopsis :: String how to run it descriptions :: [String] aspects errors :: [String] errors explanations implementation :: String implementation state Instances Show CommandHelp

parseACommandHelp :: CharParser () CommandHelp Source

parses a CommandHelp

parseCommandsHelp :: CharParser () [CommandHelp] Source

parses all commands help

run Source

:: => String The string to parse -> GenParser Char () a the parser to use -> a -> Maybe b a function to use on the result , if it succed -> Either String (Maybe b) the error showed if it fails or the result closed run the parser against a string

tabulate :: [[String]] -> String Source

create a nice table from lines of words

listOfCommands Source

:: String the string with the help inside -> Either String (Maybe String) a parse error or Just a prettyprint of a list of command helps parse a prettyprint of a list of command helps from a string

helpCommand Source

:: String the command name -> String the string with the help inside -> Either String (Maybe String) a parse error or (Just the command help or Nothing if the command is missing) parse a prettyprint of a list of command helps from a string

Produced by Haddock version 2.3.0