Symantic.CLI.Schema

Type Schema

newtype Schema d f k

Constructors

Schema

Fields

• unSchema :: SchemaInh d -> Maybe d

Instances

SchemaDoc d => CLI_Help (Schema d)

Defined in Symantic.CLI.Schema

Associated Types

type HelpConstraint (Schema d) d :: Constraint

Methods

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

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

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

SchemaDoc d => CLI_Response (Schema d)

Defined in Symantic.CLI.Schema

Associated Types

type ResponseConstraint (Schema d) a :: Constraint

type ResponseArgs (Schema d) a :: Type

type Response (Schema d) :: Type

Methods

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

SchemaDoc d => CLI_Tag (Schema d)

Defined in Symantic.CLI.Schema

Associated Types

type TagConstraint (Schema d) a :: Constraint

Methods

tagged :: Tag -> Schema d f k -> Schema d f k

endOpts :: Schema d k k

short :: TagConstraint (Schema d) a => Char -> Schema d (a -> k) k -> Permutation (Schema d) k a

long :: TagConstraint (Schema d) a => Name -> Schema d (a -> k) k -> Permutation (Schema d) k a

option :: TagConstraint (Schema d) a => a -> Schema d (a -> k) k -> Permutation (Schema d) k a

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

shortOpt :: TagConstraint (Schema d) a => Char -> a -> Schema d (a -> k) k -> Permutation (Schema d) k a

longOpt :: TagConstraint (Schema d) a => Name -> a -> Schema d (a -> k) k -> Permutation (Schema d) k a

SchemaDoc d => CLI_Env (Schema d)

Defined in Symantic.CLI.Schema

Associated Types

type EnvConstraint (Schema d) a :: Constraint

Methods

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

SchemaDoc d => CLI_Var (Schema d)

Defined in Symantic.CLI.Schema

Associated Types

type VarConstraint (Schema d) a :: Constraint

Methods

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

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

nothing :: Schema d k k

SchemaDoc d => CLI_Command (Schema d)

Defined in Symantic.CLI.Schema

Methods

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

SchemaDoc d => Permutable (Schema d)

Defined in Symantic.CLI.Schema

Associated Types

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

Methods

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

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

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

SchemaDoc d => AltApp (Schema d)

Defined in Symantic.CLI.Schema

Methods

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

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

Pro (Schema d)

Defined in Symantic.CLI.Schema

Methods

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

SchemaDoc d => Alt (Schema d)

Defined in Symantic.CLI.Schema

Methods

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

alt :: Schema d a k -> Schema d a k -> Schema d a k

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

SchemaDoc d => App (Schema d)

Defined in Symantic.CLI.Schema

Methods

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

Show (Schema (Plain Builder) a k)

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)

Defined in Symantic.CLI.Schema

Methods

fromString :: String -> Schema d f k

Semigroup d => Semigroup (Schema d f k)

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)

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)

Defined in Symantic.CLI.Schema

type Response (Schema d) = ()

type Permutation (Schema d)

Defined in Symantic.CLI.Schema

type Permutation (Schema d) = SchemaPerm d

type HelpConstraint (Schema d) d'

Defined in Symantic.CLI.Schema

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

type ResponseConstraint (Schema d) a

Defined in Symantic.CLI.Schema

type ResponseConstraint (Schema d) a = ()

type ResponseArgs (Schema d) a

Defined in Symantic.CLI.Schema

type ResponseArgs (Schema d) a = SchemaResponseArgs a

type TagConstraint (Schema d) a

Defined in Symantic.CLI.Schema

type TagConstraint (Schema d) a = ()

type EnvConstraint (Schema d) a

Defined in Symantic.CLI.Schema

type EnvConstraint (Schema d) a = ()

type VarConstraint (Schema d) a

Defined in Symantic.CLI.Schema

type VarConstraint (Schema d) a = ()

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'

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)

Type SchemaInh

data SchemaInh d

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

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

Type SchemaPerm

data SchemaPerm d k a

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)

Defined in Symantic.CLI.Schema

Associated Types

type HelpConstraint (SchemaPerm d) d :: Constraint

Methods

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

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

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

Functor (SchemaPerm d k)

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)

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'

Defined in Symantic.CLI.Schema

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