Safe Haskell	None
Language	Haskell2010

Symantic.CLI.Schema

Contents

Type Schema

Synopsis

newtype Schema d f k = Schema {
- unSchema :: SchemaInh d -> Maybe d
}
runSchema :: Monoid d => Schema d f k -> SchemaInh d -> d
docSchema :: Monoid d => SchemaDoc d => Schema d f k -> d
coerceSchema :: Schema d f k -> Schema d f' k'
type SchemaDoc d = (Semigroup d, Monoid d, IsString d, Colorable16 d, Decorable d, Spaceable d, Indentable d, Wrappable d, From (Word Char) d, From (Word Text) d, From (Word String) d)
data SchemaInh d = SchemaInh {
- schemaInh_op :: (Infix, Side)
- schemaInh_define :: Bool
- schemaInh_or :: d
}
defSchemaInh :: SchemaDoc d => SchemaInh d
pairIfNeeded :: SchemaDoc d => (Infix, Side) -> Infix -> d -> d
docOrH :: Spaceable d => From (Word Char) d => d
docOrV :: Spaceable d => From (Word Char) d => d
data SchemaResponseArgs a
data SchemaSeq d k a = SchemaSeq {
- schemaSeq_finalizer :: forall b c. Schema d (b -> c) c -> Schema d (b -> c) c
- schemaSeq_alternatives :: [Schema d (a -> k) k]
}
data SchemaPerm d k a = SchemaPerm {
- schemaPerm_finalizer :: forall b c. Schema d (b -> c) c -> Schema d (b -> c) c
- schemaPerm_alternatives :: [Schema d (a -> k) k]
}

Type `Schema`

newtype Schema d f k Source #

Constructors

Schema
Fields unSchema :: SchemaInh d -> Maybe d

Instances

SchemaDoc d => CLI_Help (Schema d) Source #
Instance details Defined in Symantic.CLI.Schema Associated Types type HelpConstraint (Schema d) d :: Constraint Source # Methods help :: HelpConstraint (Schema d) d0 => d0 -> Schema d f k -> Schema d f k Source # program :: Name -> Schema d f k -> Schema d f k Source # rule :: Name -> Schema d f k -> Schema d f k Source #
SchemaDoc d => CLI_Response (Schema d) Source #
Instance details Defined in Symantic.CLI.Schema Associated Types type ResponseConstraint (Schema d) a :: Constraint Source # type ResponseArgs (Schema d) a :: Type Source # type Response (Schema d) :: Type Source # Methods response' :: ResponseConstraint (Schema d) a => Schema d (ResponseArgs (Schema d) a) (Response (Schema d)) Source #
SchemaDoc d => CLI_Tag (Schema d) Source #
Instance details Defined in Symantic.CLI.Schema Associated Types type TagConstraint (Schema d) a :: Constraint Source # Methods tag :: Tag -> Schema d f k -> Schema d f k Source # endOpts :: Schema d k k Source # flag :: TagConstraint (Schema d) Bool => Tag -> Permutation (Schema d) k Bool Source # optionalTag :: (TagConstraint (Schema d) a, AltApp (Schema d), Alt (Schema d), Pro (Schema d)) => Tag -> Schema d (a -> k) k -> Permutation (Schema d) k (Maybe a) Source # defaultTag :: TagConstraint (Schema d) a => Tag -> a -> Schema d (a -> k) k -> Permutation (Schema d) k a Source # requiredTag :: TagConstraint (Schema d) a => Tag -> Schema d (a -> k) k -> Permutation (Schema d) k a Source # many0Tag :: (TagConstraint (Schema d) a, AltApp (Schema d)) => Tag -> Schema d (a -> k) k -> Permutation (Schema d) k [a] Source # many1Tag :: (TagConstraint (Schema d) a, AltApp (Schema d)) => Tag -> Schema d (a -> k) k -> Permutation (Schema d) k [a] Source #
SchemaDoc d => CLI_Env (Schema d) Source #
Instance details Defined in Symantic.CLI.Schema Associated Types type EnvConstraint (Schema d) a :: Constraint Source # Methods env' :: EnvConstraint (Schema d) a => Name -> Schema d (a -> k) k Source #
SchemaDoc d => CLI_Constant (Schema d) Source #
Instance details Defined in Symantic.CLI.Schema Methods constant :: Segment -> a -> Schema d (a -> k) k Source # just :: a -> Schema d (a -> k) k Source # nothing :: Schema d k k Source #
SchemaDoc d => CLI_Var (Schema d) Source #
Instance details Defined in Symantic.CLI.Schema Associated Types type VarConstraint (Schema d) a :: Constraint Source # Methods var' :: VarConstraint (Schema d) a => Name -> Schema d (a -> k) k Source #
SchemaDoc d => CLI_Command (Schema d) Source #
Instance details Defined in Symantic.CLI.Schema Methods command :: Name -> Schema d a k -> Schema d a k Source #
SchemaDoc d => Sequenceable (Schema d) Source #
Instance details Defined in Symantic.CLI.Schema Associated Types type Sequence (Schema d) = (r :: Type -> Type -> Type) Source # Methods runSequence :: Sequence (Schema d) k a -> Schema d (a -> k) k Source # toSequence :: Schema d (a -> k) k -> Sequence (Schema d) k a Source #
SchemaDoc d => Permutable (Schema d) Source #
Instance details Defined in Symantic.CLI.Schema Associated Types type Permutation (Schema d) = (r :: Type -> Type -> Type) Source # Methods runPermutation :: Permutation (Schema d) k a -> Schema d (a -> k) k Source # toPermutation :: Schema d (a -> k) k -> Permutation (Schema d) k a Source # toPermDefault :: a -> Schema d (a -> k) k -> Permutation (Schema d) k a Source #
SchemaDoc d => AltApp (Schema d) Source #
Instance details Defined in Symantic.CLI.Schema Methods many0 :: Schema d (a -> k) k -> Schema d ([a] -> k) k Source # many1 :: Schema d (a -> k) k -> Schema d ([a] -> k) k Source #
Pro (Schema d) Source #
Instance details Defined in Symantic.CLI.Schema Methods dimap :: (a -> b) -> (b -> a) -> Schema d (a -> k) k -> Schema d (b -> k) k Source #
SchemaDoc d => Alt (Schema d) Source #
Instance details Defined in Symantic.CLI.Schema Methods (<!>) :: Schema d a k -> Schema d b k -> Schema d (a :!: b) k Source # alt :: Schema d a k -> Schema d a k -> Schema d a k Source # opt :: Schema d (a -> k) k -> Schema d (Maybe a -> k) k Source #
SchemaDoc d => App (Schema d) Source #
Instance details Defined in Symantic.CLI.Schema Methods (<.>) :: Schema d a b -> Schema d b c -> Schema d a c Source #
Show (Schema (Plain Builder) a k) Source #
Instance details Defined in Symantic.CLI.Schema Methods showsPrec :: Int -> Schema (Plain Builder) a k -> ShowS # show :: Schema (Plain Builder) a k -> String # showList :: [Schema (Plain Builder) a k] -> ShowS #
(Semigroup d, IsString d) => IsString (Schema d f k) Source #
Instance details Defined in Symantic.CLI.Schema Methods fromString :: String -> Schema d f k #
Semigroup d => Semigroup (Schema d f k) Source #
Instance details Defined in Symantic.CLI.Schema Methods (<>) :: Schema d f k -> Schema d f k -> Schema d f k # sconcat :: NonEmpty (Schema d f k) -> Schema d f k # stimes :: Integral b => b -> Schema d f k -> Schema d f k #
(Semigroup d, Monoid d) => Monoid (Schema d f k) Source #
Instance details Defined in Symantic.CLI.Schema Methods mempty :: Schema d f k # mappend :: Schema d f k -> Schema d f k -> Schema d f k # mconcat :: [Schema d f k] -> Schema d f k #
type Response (Schema d) Source #
Instance details Defined in Symantic.CLI.Schema type Response (Schema d) = ()
type Sequence (Schema d) Source #
Instance details Defined in Symantic.CLI.Schema type Sequence (Schema d) = SchemaSeq d
type Permutation (Schema d) Source #
Instance details Defined in Symantic.CLI.Schema type Permutation (Schema d) = SchemaPerm d
type HelpConstraint (Schema d) d' Source #
Instance details Defined in Symantic.CLI.Schema type HelpConstraint (Schema d) d' = d ~ d'
type ResponseConstraint (Schema d) a Source #
Instance details Defined in Symantic.CLI.Schema type ResponseConstraint (Schema d) a = ()
type ResponseArgs (Schema d) a Source #
Instance details Defined in Symantic.CLI.Schema type ResponseArgs (Schema d) a = SchemaResponseArgs a
type TagConstraint (Schema d) a Source #
Instance details Defined in Symantic.CLI.Schema type TagConstraint (Schema d) a = ()
type EnvConstraint (Schema d) a Source #
Instance details Defined in Symantic.CLI.Schema type EnvConstraint (Schema d) a = ()
type VarConstraint (Schema d) a Source #
Instance details Defined in Symantic.CLI.Schema type VarConstraint (Schema d) a = ()

runSchema :: Monoid d => Schema d f k -> SchemaInh d -> d Source #

docSchema :: Monoid d => SchemaDoc d => Schema d f k -> d Source #

coerceSchema :: Schema d f k -> Schema d f' k' Source #

Class `SchemaDoc`

type SchemaDoc d = (Semigroup d, Monoid d, IsString d, Colorable16 d, Decorable d, Spaceable d, Indentable d, Wrappable d, From (Word Char) d, From (Word Text) d, From (Word String) d) Source #

Type `SchemaInh`

data SchemaInh d Source #

Inherited top-down.

Constructors

SchemaInh
Fields schemaInh_op :: (Infix, Side) Parent operator. schemaInh_define :: Bool Whether to print a definition, or not. schemaInh_or :: d The separator to use between alternatives.

defSchemaInh :: SchemaDoc d => SchemaInh d Source #

pairIfNeeded :: SchemaDoc d => (Infix, Side) -> Infix -> d -> d Source #

docOrH :: Spaceable d => From (Word Char) d => d Source #

docOrV :: Spaceable d => From (Word Char) d => d Source #

data SchemaResponseArgs a Source #

Type `SchemaSeq`

data SchemaSeq d k a Source #

Constructors

SchemaSeq
Fields schemaSeq_finalizer :: forall b c. Schema d (b -> c) c -> Schema d (b -> c) c Used to implement `rule`. schemaSeq_alternatives :: [Schema d (a -> k) k] Collect alternatives for rendering them all at once in `runSequence`.

Instances

SchemaDoc d => CLI_Help (SchemaSeq d) Source #
Instance details Defined in Symantic.CLI.Schema Associated Types type HelpConstraint (SchemaSeq d) d :: Constraint Source # Methods help :: HelpConstraint (SchemaSeq d) d0 => d0 -> SchemaSeq d f k -> SchemaSeq d f k Source # program :: Name -> SchemaSeq d f k -> SchemaSeq d f k Source # rule :: Name -> SchemaSeq d f k -> SchemaSeq d f k Source #
Functor (SchemaSeq d k) Source #
Instance details Defined in Symantic.CLI.Schema Methods fmap :: (a -> b) -> SchemaSeq d k a -> SchemaSeq d k b # (<$) :: a -> SchemaSeq d k b -> SchemaSeq d k a #
Applicative (SchemaSeq d k) Source #
Instance details Defined in Symantic.CLI.Schema Methods pure :: a -> SchemaSeq d k a # (<>) :: SchemaSeq d k (a -> b) -> SchemaSeq d k a -> SchemaSeq d k b # liftA2 :: (a -> b -> c) -> SchemaSeq d k a -> SchemaSeq d k b -> SchemaSeq d k c # (>) :: SchemaSeq d k a -> SchemaSeq d k b -> SchemaSeq d k b # (<*) :: SchemaSeq d k a -> SchemaSeq d k b -> SchemaSeq d k a #
type HelpConstraint (SchemaSeq d) d' Source #
Instance details Defined in Symantic.CLI.Schema type HelpConstraint (SchemaSeq d) d' = d ~ d'

Type `SchemaPerm`

data SchemaPerm d k a Source #

Constructors

SchemaPerm
Fields schemaPerm_finalizer :: forall b c. Schema d (b -> c) c -> Schema d (b -> c) c Used to implement `rule`. schemaPerm_alternatives :: [Schema d (a -> k) k] Collect alternatives for rendering them all at once in `runPermutation`.

Instances

SchemaDoc d => CLI_Help (SchemaPerm d) Source #
Instance details Defined in Symantic.CLI.Schema Associated Types type HelpConstraint (SchemaPerm d) d :: Constraint Source # Methods help :: HelpConstraint (SchemaPerm d) d0 => d0 -> SchemaPerm d f k -> SchemaPerm d f k Source # program :: Name -> SchemaPerm d f k -> SchemaPerm d f k Source # rule :: Name -> SchemaPerm d f k -> SchemaPerm d f k Source #
Functor (SchemaPerm d k) Source #
Instance details Defined in Symantic.CLI.Schema Methods fmap :: (a -> b) -> SchemaPerm d k a -> SchemaPerm d k b # (<$) :: a -> SchemaPerm d k b -> SchemaPerm d k a #
Applicative (SchemaPerm d k) Source #
Instance details Defined in Symantic.CLI.Schema Methods pure :: a -> SchemaPerm d k a # (<>) :: SchemaPerm d k (a -> b) -> SchemaPerm d k a -> SchemaPerm d k b # liftA2 :: (a -> b -> c) -> SchemaPerm d k a -> SchemaPerm d k b -> SchemaPerm d k c # (>) :: SchemaPerm d k a -> SchemaPerm d k b -> SchemaPerm d k b # (<*) :: SchemaPerm d k a -> SchemaPerm d k b -> SchemaPerm d k a #
type HelpConstraint (SchemaPerm d) d' Source #
Instance details Defined in Symantic.CLI.Schema type HelpConstraint (SchemaPerm d) d' = d ~ d'

Type Schema

Class SchemaDoc

Type SchemaInh

Type SchemaSeq

Type SchemaPerm

Type `Schema`

Class `SchemaDoc`

Type `SchemaInh`

Type `SchemaSeq`

Type `SchemaPerm`