Language.Symantic.CLI.Help

Type Reader

data Reader d

Constructors

Reader

Fields

• reader_help :: Maybe d
• reader_command_indent :: Indent
• reader_option_indent :: Indent
• reader_plain :: Reader d
• reader_option_empty :: Bool

defReader :: Textable d => Reader d

Type Result

type Result d = Forest (DocNode d)

defResult :: Monoid d => Result d

Type DocNode

data DocNode d

Constructors

Leaf

Fields

• docNodeSep :: d
• docNode :: d

Indented

Fields

• docNodeIndent :: Indent
• docNodeSep :: d
• docNode :: d

BreakableFill

Fields

• docNodeIndent :: Indent
• docNodeSep :: d
• docNode :: d

docTree :: Monoid d => Textable d => Indentable d => Tree (DocNode d) -> d

docTrees :: Monoid d => Textable d => Indentable d => Forest (DocNode d) -> d

Type Help

data Help d e t a

Constructors

Help

Fields

• help_result :: Reader d -> Result d
• help_plain :: Plain d e t a

Instances

Doc d => Sym_Help d (Help d)

Defined in Language.Symantic.CLI.Help

Methods

help :: d -> Help d e t a -> Help d e t a

Doc d => Sym_Exit (Help d)

Defined in Language.Symantic.CLI.Help

Methods

exit :: e -> Help d e t ()

Doc d => Sym_Option (Help d)

Defined in Language.Symantic.CLI.Help

Methods

opt :: OptionName -> Help d e s a -> Help d e ArgOption a

var :: Name -> (String -> Either e a) -> Help d e ArgValue a

tag :: String -> Help d e ArgValue ()

long :: Name -> Help d e ArgValue a -> Help d e ArgOption a

short :: Char -> Help d e ArgValue a -> Help d e ArgOption a

flag :: OptionName -> (Bool, Help d e ArgOption Bool)

endOpt :: Help d e ArgOption ()

string :: Name -> Help d e ArgValue String

Doc d => Sym_Command (Help d)

Defined in Language.Symantic.CLI.Help

Methods

main :: Name -> Help d e t a -> Help d e ArgCommand a

command :: Name -> Help d e t a -> Help d e ArgCommand a

Doc d => Sym_Rule (Help d)

Defined in Language.Symantic.CLI.Help

Methods

rule :: String -> Help d e t a -> Help d e t a

Doc d => Sym_Interleaved (Help d)

Defined in Language.Symantic.CLI.Help

Methods

interleaved :: Perm (Help d e t) a -> Help d e t a

(<<$>>) :: (a -> b) -> Help d e t a -> Perm (Help d e t) b

(<<$?>>) :: (a -> b) -> (a, Help d e t a) -> Perm (Help d e t) b

(<<$*>>) :: ([a] -> b) -> Help d e t a -> Perm (Help d e t) b

(<<|>>) :: Perm (Help d e t) (a -> b) -> Help d e t a -> Perm (Help d e t) b

(<<|?>>) :: Perm (Help d e t) (a -> b) -> (a, Help d e t a) -> Perm (Help d e t) b

(<<|*>>) :: Perm (Help d e t) ([a] -> b) -> Help d e t a -> Perm (Help d e t) b

(<<$) :: a -> Help d e t b -> Perm (Help d e t) a

(<<$?) :: a -> (b, Help d e t b) -> Perm (Help d e t) a

Doc d => Sym_AltApp (Help d)

Defined in Language.Symantic.CLI.Help

Methods

many :: Help d e t a -> Help d e t [a]

some :: Help d e t a -> Help d e t [a]

intermany :: [Help d e t a] -> Help d e t [a]

Doc d => Sym_Alt (Help d)

Defined in Language.Symantic.CLI.Help

Methods

(<||>) :: Help d e t a -> Help d e t a -> Help d e t a

choice :: [Help d e t a] -> Help d e t a

optional :: Help d e t a -> Help d e t (Maybe a)

option :: a -> Help d e t a -> Help d e t a

try :: Help d e t a -> Help d e t a

Doc d => Sym_App (Help d)

Defined in Language.Symantic.CLI.Help

Methods

value :: a -> Help d e ArgValue a

(<**>) :: Help d e t (a -> b) -> Help d e u a -> Help d e u b

(**>) :: Help d e t a -> Help d e u b -> Help d e u b

(<**) :: Help d e t a -> Help d e u b -> Help d e u a

end :: Help d e t ()

Doc d => Sym_Fun (Help d)

Defined in Language.Symantic.CLI.Help

Methods

(<$$>) :: (a -> b) -> Help d e t a -> Help d e t b

(<$$) :: a -> Help d e t b -> Help d e t a

($$>) :: Help d e t b -> a -> Help d e t a

Textable d => Semigroup (Help d e s a)

Defined in Language.Symantic.CLI.Help

Methods

(<>) :: Help d e s a -> Help d e s a -> Help d e s a

sconcat :: NonEmpty (Help d e s a) -> Help d e s a

stimes :: Integral b => b -> Help d e s a -> Help d e s a

(Textable d, Monoid d) => Monoid (Help d e s a)

Defined in Language.Symantic.CLI.Help

Methods

mempty :: Help d e s a

mappend :: Help d e s a -> Help d e s a -> Help d e s a

mconcat :: [Help d e s a] -> Help d e s a

type Perm (Help d e t)

Defined in Language.Symantic.CLI.Help

type Perm (Help d e t) = PermHelp d e t

runHelp :: Monoid d => Indentable d => Textable d => Help d e t a -> d

textHelp :: Doc d => Reader d -> Help d e t a -> d

coerceHelp :: Help d e s a -> Help d e t b

Type PermHelp

data PermHelp d e t a

Constructors

PermHelp (Reader d -> Result d) [Plain d e t a]