Symantic.CLI.Help

Type Help

data Help d f k

Constructors

Help

Fields

• help_result :: HelpInh d -> HelpResult d

  The HelpResult of the current symantic.

• help_schema :: Schema d f k

  The Schema of the current symantic.

Instances

SchemaDoc d => CLI_Help (Help d)

Defined in Symantic.CLI.Help

Associated Types

type HelpConstraint (Help d) d :: Constraint

Methods

help :: HelpConstraint (Help d) d0 => d0 -> Help d f k -> Help d f k

program :: Name -> Help d f k -> Help d f k

rule :: Name -> Help d f k -> Help d f k

SchemaDoc d => CLI_Response (Help d)

Defined in Symantic.CLI.Help

Associated Types

type ResponseConstraint (Help d) a :: Constraint

type ResponseArgs (Help d) a :: Type

type Response (Help d) :: Type

Methods

response' :: ResponseConstraint (Help d) a => Help d (ResponseArgs (Help d) a) (Response (Help d))

SchemaDoc d => CLI_Tag (Help d)

Defined in Symantic.CLI.Help

Associated Types

type TagConstraint (Help d) a :: Constraint

Methods

tag :: Tag -> Help d f k -> Help d f k

endOpts :: Help d k k

flag :: TagConstraint (Help d) Bool => Tag -> Permutation (Help d) k Bool

optionalTag :: (TagConstraint (Help d) a, AltApp (Help d), Alt (Help d), Pro (Help d)) => Tag -> Help d (a -> k) k -> Permutation (Help d) k (Maybe a)

defaultTag :: TagConstraint (Help d) a => Tag -> a -> Help d (a -> k) k -> Permutation (Help d) k a

requiredTag :: TagConstraint (Help d) a => Tag -> Help d (a -> k) k -> Permutation (Help d) k a

many0Tag :: (TagConstraint (Help d) a, AltApp (Help d)) => Tag -> Help d (a -> k) k -> Permutation (Help d) k [a]

many1Tag :: (TagConstraint (Help d) a, AltApp (Help d)) => Tag -> Help d (a -> k) k -> Permutation (Help d) k [a]

SchemaDoc d => CLI_Env (Help d)

Defined in Symantic.CLI.Help

Associated Types

type EnvConstraint (Help d) a :: Constraint

Methods

env' :: EnvConstraint (Help d) a => Name -> Help d (a -> k) k

SchemaDoc d => CLI_Constant (Help d)

Defined in Symantic.CLI.Help

Methods

constant :: Segment -> a -> Help d (a -> k) k

just :: a -> Help d (a -> k) k

nothing :: Help d k k

SchemaDoc d => CLI_Var (Help d)

Defined in Symantic.CLI.Help

Associated Types

type VarConstraint (Help d) a :: Constraint

Methods

var' :: VarConstraint (Help d) a => Name -> Help d (a -> k) k

SchemaDoc d => CLI_Command (Help d)

Defined in Symantic.CLI.Help

Methods

command :: Name -> Help d a k -> Help d a k

SchemaDoc d => Permutable (Help d)

Defined in Symantic.CLI.Help

Associated Types

type Permutation (Help d) = (r :: Type -> Type -> Type)

Methods

runPermutation :: Permutation (Help d) k a -> Help d (a -> k) k

toPermutation :: Help d (a -> k) k -> Permutation (Help d) k a

toPermDefault :: a -> Help d (a -> k) k -> Permutation (Help d) k a

SchemaDoc d => AltApp (Help d)

Defined in Symantic.CLI.Help

Methods

many0 :: Help d (a -> k) k -> Help d ([a] -> k) k

many1 :: Help d (a -> k) k -> Help d ([a] -> k) k

Pro (Help d)

Defined in Symantic.CLI.Help

Methods

dimap :: (a -> b) -> (b -> a) -> Help d (a -> k) k -> Help d (b -> k) k

SchemaDoc d => Alt (Help d)

Defined in Symantic.CLI.Help

Methods

(<!>) :: Help d a k -> Help d b k -> Help d (a :!: b) k

alt :: Help d a k -> Help d a k -> Help d a k

opt :: Help d (a -> k) k -> Help d (Maybe a -> k) k

SchemaDoc d => App (Help d)

Defined in Symantic.CLI.Help

Methods

(<.>) :: Help d a b -> Help d b c -> Help d a c

Semigroup d => Semigroup (Help d f k)

Defined in Symantic.CLI.Help

Methods

(<>) :: Help d f k -> Help d f k -> Help d f k

sconcat :: NonEmpty (Help d f k) -> Help d f k

stimes :: Integral b => b -> Help d f k -> Help d f k

Monoid d => Monoid (Help d f k)

Defined in Symantic.CLI.Help

Methods

mempty :: Help d f k

mappend :: Help d f k -> Help d f k -> Help d f k

mconcat :: [Help d f k] -> Help d f k

type Response (Help d)

Defined in Symantic.CLI.Help

type Response (Help d) = ()

type Permutation (Help d)

Defined in Symantic.CLI.Help

type Permutation (Help d) = HelpPerm d

type HelpConstraint (Help d) d'

Defined in Symantic.CLI.Help

type HelpConstraint (Help d) d' = d ~ d'

type ResponseConstraint (Help d) a

Defined in Symantic.CLI.Help

type ResponseConstraint (Help d) a = ()

type ResponseArgs (Help d) a

Defined in Symantic.CLI.Help

type ResponseArgs (Help d) a = SchemaResponseArgs a

type TagConstraint (Help d) a

Defined in Symantic.CLI.Help

type TagConstraint (Help d) a = ()

type EnvConstraint (Help d) a

Defined in Symantic.CLI.Help

type EnvConstraint (Help d) a = ()

type VarConstraint (Help d) a

Defined in Symantic.CLI.Help

type VarConstraint (Help d) a = ()

runHelp :: SchemaDoc d => HelpInh d -> Help d f k -> d

docHelp :: SchemaDoc d => Indentable d => SchemaDoc d => Help d f k -> d

coerceHelp :: Help d f k -> Help d f' k'

Type HelpInh

data HelpInh d

Configuration inherited top-down.

Constructors

HelpInh

Fields

• helpInh_message :: !(Maybe d)

  The message inherited from helps.

• helpInh_command_indent :: !Indent

  Indentation for commands.

• helpInh_tag_indent :: !Indent

  Indentation for Tags.

• helpInh_schema :: !(SchemaInh d)

  The inherited SchemaInh for runSchema.

• helpInh_helpless_options :: !Bool

  Whether to include options without help in the listing.

• helpInh_command_rule :: !Bool

  Whether to print the name of the rule.

• helpInh_full :: !Bool

  Whether to print full help.

defHelpInh :: SchemaDoc d => HelpInh d

Type HelpResult

type HelpResult d = Forest (HelpNode, d)

defHelpResult :: Monoid d => HelpResult d

Type HelpNode

data HelpNode

Constructors

HelpNode_Message

HelpNode_Rule

HelpNode_Command

HelpNode_Tag

HelpNode_Env

Instances

Show HelpNode

Defined in Symantic.CLI.Help

Methods

showsPrec :: Int -> HelpNode -> ShowS

show :: HelpNode -> String

showList :: [HelpNode] -> ShowS

runHelpNode :: SchemaDoc d => Tree (HelpNode, d) -> d

runHelpNodes :: SchemaDoc d => HelpInh d -> Forest (HelpNode, d) -> d

Introduce newline according to the HelpNodes put next to each others.

type HelpResponseArgs = SchemaResponseArgs

Type HelpPerm

data HelpPerm d k a

Constructors

HelpPerm (HelpInh d -> HelpResult d) (SchemaPerm d k a)

Instances

SchemaDoc d => CLI_Help (HelpPerm d)

Defined in Symantic.CLI.Help

Associated Types

type HelpConstraint (HelpPerm d) d :: Constraint

Methods

help :: HelpConstraint (HelpPerm d) d0 => d0 -> HelpPerm d f k -> HelpPerm d f k

program :: Name -> HelpPerm d f k -> HelpPerm d f k

rule :: Name -> HelpPerm d f k -> HelpPerm d f k

Functor (HelpPerm d k)

Defined in Symantic.CLI.Help

Methods

fmap :: (a -> b) -> HelpPerm d k a -> HelpPerm d k b

(<$) :: a -> HelpPerm d k b -> HelpPerm d k a

Applicative (HelpPerm d k)

Defined in Symantic.CLI.Help

Methods

pure :: a -> HelpPerm d k a

(<*>) :: HelpPerm d k (a -> b) -> HelpPerm d k a -> HelpPerm d k b

liftA2 :: (a -> b -> c) -> HelpPerm d k a -> HelpPerm d k b -> HelpPerm d k c

(*>) :: HelpPerm d k a -> HelpPerm d k b -> HelpPerm d k b

(<*) :: HelpPerm d k a -> HelpPerm d k b -> HelpPerm d k a

type HelpConstraint (HelpPerm d) d'

Defined in Symantic.CLI.Help

type HelpConstraint (HelpPerm d) d' = d ~ d'