UI.Butcher.Monadic.Types

Types used in the butcher interface.

Documentation

data CommandDesc out

A representation/description of a command parser built via the CmdParser monad. Can be transformed into a pretty Doc to display as usage/help via ppUsage and related functions.

Note that there is the _cmd_out accessor that contains Maybe out which might be useful after successful parsing.

Constructors

CommandDesc

Fields

• _cmd_mParent :: Maybe (Maybe String, CommandDesc out)
• _cmd_synopsis :: Maybe Doc
• _cmd_help :: Maybe Doc
• _cmd_parts :: [PartDesc]
• _cmd_out :: Maybe out
• _cmd_children :: Deque (Maybe String, CommandDesc out)
• _cmd_visibility :: Visibility

Instances

Functor CommandDesc

Methods

fmap :: (a -> b) -> CommandDesc a -> CommandDesc b

(<$) :: a -> CommandDesc b -> CommandDesc a

Show (CommandDesc out)

Methods

showsPrec :: Int -> CommandDesc out -> ShowS

show :: CommandDesc out -> String

showList :: [CommandDesc out] -> ShowS

cmd_out :: forall out. Lens' (CommandDesc out) (Maybe out)

type CmdParser f out = Free (CmdParserF f out)

The CmdParser monad type. It is a free monad over some functor but users of butcher don't need to know more than that CmdParser is a Monad.

data Input

Butcher supports two input modi: String and [String]. Program arguments have the latter form, while parsing interactive command input (e.g. when you implement a terminal of sorts) is easier when you can process the full String without having to wordify it first by some means (and List.words is not the right approach in many situations.)

Constructors

InputString String

InputArgs [String]

Instances

Eq Input

Methods

(==) :: Input -> Input -> Bool

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

Show Input

Methods

showsPrec :: Int -> Input -> ShowS

show :: Input -> String

showList :: [Input] -> ShowS

data ParsingError

Information about an error that occured when trying to parse some Input using some CmdParser.

Constructors

ParsingError

Fields

• _pe_messages :: [String]
• _pe_remaining :: Input

Instances

Eq ParsingError

Methods

(==) :: ParsingError -> ParsingError -> Bool

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

Show ParsingError

Methods

showsPrec :: Int -> ParsingError -> ShowS

show :: ParsingError -> String

showList :: [ParsingError] -> ShowS

data PartDesc

A representation/description of a command's parts, i.e. flags or params. As a butcher user, the higher-level pretty-printing functions for CommandDesc are probably sufficient.

Constructors

PartLiteral String

PartVariable String

PartOptional PartDesc

PartAlts [PartDesc]

PartSeq [PartDesc]

PartDefault String PartDesc

PartSuggestion [CompletionItem] PartDesc

PartRedirect String PartDesc

PartReorder [PartDesc]

PartMany PartDesc

PartWithHelp Doc PartDesc

PartHidden PartDesc

Instances

Show PartDesc

Methods

showsPrec :: Int -> PartDesc -> ShowS

show :: PartDesc -> String

showList :: [PartDesc] -> ShowS

emptyCommandDesc :: CommandDesc out

Empty CommandDesc value. Mostly for butcher-internal usage.

data Visibility

Constructors

Visible

Hidden

Instances

Eq Visibility

Methods

(==) :: Visibility -> Visibility -> Bool

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

Show Visibility

Methods

showsPrec :: Int -> Visibility -> ShowS

show :: Visibility -> String

showList :: [Visibility] -> ShowS