Language.Symantic.CLI.Sym

Arg types

data ArgCommand

Types to type the symantics: eg. to segregate options from commands.

data ArgOption

data ArgValue

data ArgRule t

Type Name

type Name = String

Class Sym_Fun

class Sym_Fun repr where

Minimal complete definition

(<$$>)

Methods

(<$$>) :: (a -> b) -> repr e t a -> repr e t b infixl 4

(<$$) :: a -> repr e t b -> repr e t a

($$>) :: repr e t b -> a -> repr e t a

Instances

Sym_Fun Parser

Defined in Language.Symantic.CLI.Read

Methods

(<$$>) :: (a -> b) -> Parser e t a -> Parser e t b

(<$$) :: a -> Parser e t b -> Parser e t a

($$>) :: Parser e t b -> a -> Parser e t a

Doc d => Sym_Fun (Plain d)

Defined in Language.Symantic.CLI.Plain

Methods

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

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

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

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

Class Sym_App

class Sym_Fun repr => Sym_App repr where

Minimal complete definition

value, (<**>), end

Methods

value :: a -> repr e ArgValue a

(<**>) :: repr e t (a -> b) -> repr e u a -> repr e u b infixl 4

(**>) :: repr e t a -> repr e u b -> repr e u b

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

end :: repr e t ()

Instances

Sym_App Parser

Defined in Language.Symantic.CLI.Read

Methods

value :: a -> Parser e ArgValue a

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

(**>) :: Parser e t a -> Parser e u b -> Parser e u b

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

end :: Parser e t ()

Doc d => Sym_App (Plain d)

Defined in Language.Symantic.CLI.Plain

Methods

value :: a -> Plain d e ArgValue a

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

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

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

end :: Plain d e t ()

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 ()

Class Sym_Alt

class Sym_Fun repr => Sym_Alt repr where

Minimal complete definition

(<||>), choice, option, try

Methods

(<||>) :: repr e t a -> repr e t a -> repr e t a infixl 3

choice :: [repr e t a] -> repr e t a

optional :: repr e t a -> repr e t (Maybe a)

option :: a -> repr e t a -> repr e t a

try :: repr e t a -> repr e t a

Instances

Sym_Alt Parser

Defined in Language.Symantic.CLI.Read

Methods

(<||>) :: Parser e t a -> Parser e t a -> Parser e t a

choice :: [Parser e t a] -> Parser e t a

optional :: Parser e t a -> Parser e t (Maybe a)

option :: a -> Parser e t a -> Parser e t a

try :: Parser e t a -> Parser e t a

Doc d => Sym_Alt (Plain d)

Defined in Language.Symantic.CLI.Plain

Methods

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

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

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

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

try :: Plain d e t a -> Plain 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

Class Sym_AltApp

class (Sym_Alt repr, Sym_App repr) => Sym_AltApp repr where

Minimal complete definition

many, some

Methods

many :: repr e t a -> repr e t [a]

some :: repr e t a -> repr e t [a]

intermany :: [repr e t a] -> repr e t [a]

Instances

Sym_AltApp Parser

Defined in Language.Symantic.CLI.Read

Methods

many :: Parser e t a -> Parser e t [a]

some :: Parser e t a -> Parser e t [a]

intermany :: [Parser e t a] -> Parser e t [a]

Doc d => Sym_AltApp (Plain d)

Defined in Language.Symantic.CLI.Plain

Methods

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

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

intermany :: [Plain d e t a] -> Plain 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]

Class Sym_Interleaved

class Sym_Interleaved repr where

Minimal complete definition

interleaved, (<<$>>), (<<$?>>), (<<$*>>), (<<|>>), (<<|?>>), (<<|*>>)

Methods

interleaved :: Perm (repr e t) a -> repr e t a

(<<$>>) :: (a -> b) -> repr e t a -> Perm (repr e t) b infixl 2

(<<$?>>) :: (a -> b) -> (a, repr e t a) -> Perm (repr e t) b infixl 2

(<<$*>>) :: ([a] -> b) -> repr e t a -> Perm (repr e t) b infixl 2

(<<|>>) :: Perm (repr e t) (a -> b) -> repr e t a -> Perm (repr e t) b infixl 1

(<<|?>>) :: Perm (repr e t) (a -> b) -> (a, repr e t a) -> Perm (repr e t) b infixl 1

(<<|*>>) :: Perm (repr e t) ([a] -> b) -> repr e t a -> Perm (repr e t) b infixl 1

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

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

Instances

Sym_Interleaved Parser

Defined in Language.Symantic.CLI.Read

Methods

interleaved :: Perm (Parser e t) a -> Parser e t a

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

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

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

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

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

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

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

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

Doc d => Sym_Interleaved (Plain d)

Defined in Language.Symantic.CLI.Plain

Methods

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

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

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

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

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

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

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

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

(<<$?) :: a -> (b, Plain d e t b) -> Perm (Plain 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

Type family Perm

type family Perm (repr :: * -> *) = (r :: * -> *) | r -> repr

Instances

type Perm (Parser e s)

Defined in Language.Symantic.CLI.Read

type Perm (Parser e s) = PermParser Args (Parser e s)

type Perm (Plain d e t)

Defined in Language.Symantic.CLI.Plain

type Perm (Plain d e t) = Compose [] (Plain d e t)

type Perm (Help d e t)

Defined in Language.Symantic.CLI.Help

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

Class Sym_Rule

class Sym_Rule repr where

Minimal complete definition

rule

Methods

rule :: String -> repr e t a -> repr e t a

Instances

Sym_Rule Parser

Defined in Language.Symantic.CLI.Read

Methods

rule :: String -> Parser e t a -> Parser e t a

Doc d => Sym_Rule (Plain d)

Defined in Language.Symantic.CLI.Plain

Methods

rule :: String -> Plain d e t a -> Plain d e t 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

Class Sym_Command

class Sym_Command repr where

Minimal complete definition

main, command

Methods

main :: Name -> repr e t a -> repr e ArgCommand a

command :: Name -> repr e t a -> repr e ArgCommand a

Instances

Sym_Command Parser

Defined in Language.Symantic.CLI.Read

Methods

main :: Name -> Parser e t a -> Parser e ArgCommand a

command :: Name -> Parser e t a -> Parser e ArgCommand a

Doc d => Sym_Command (Plain d)

Defined in Language.Symantic.CLI.Plain

Methods

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

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

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

Class Sym_Option

class Sym_AltApp repr => Sym_Option repr where

Minimal complete definition

opt, var, tag

Methods

opt :: OptionName -> repr e s a -> repr e ArgOption a

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

tag :: String -> repr e ArgValue ()

long :: Name -> repr e ArgValue a -> repr e ArgOption a

short :: Char -> repr e ArgValue a -> repr e ArgOption a

flag :: OptionName -> (Bool, repr e ArgOption Bool)

endOpt :: repr e ArgOption ()

string :: Name -> repr e ArgValue String

Instances

Sym_Option Parser

Defined in Language.Symantic.CLI.Read

Methods

opt :: OptionName -> Parser e s a -> Parser e ArgOption a

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

tag :: String -> Parser e ArgValue ()

long :: Name -> Parser e ArgValue a -> Parser e ArgOption a

short :: Char -> Parser e ArgValue a -> Parser e ArgOption a

flag :: OptionName -> (Bool, Parser e ArgOption Bool)

endOpt :: Parser e ArgOption ()

string :: Name -> Parser e ArgValue String

Doc d => Sym_Option (Plain d)

Defined in Language.Symantic.CLI.Plain

Methods

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

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

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

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

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

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

endOpt :: Plain d e ArgOption ()

string :: Name -> Plain d e ArgValue String

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

Type OptionName

data OptionName

Constructors

OptionName Char Name

OptionNameLong Name

OptionNameShort Char

Instances

Eq OptionName

Defined in Language.Symantic.CLI.Sym

Methods

(==) :: OptionName -> OptionName -> Bool

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

Ord OptionName

Defined in Language.Symantic.CLI.Sym

Methods

compare :: OptionName -> OptionName -> Ordering

(<) :: OptionName -> OptionName -> Bool

(<=) :: OptionName -> OptionName -> Bool

(>) :: OptionName -> OptionName -> Bool

(>=) :: OptionName -> OptionName -> Bool

max :: OptionName -> OptionName -> OptionName

min :: OptionName -> OptionName -> OptionName

Show OptionName

Defined in Language.Symantic.CLI.Sym

Methods

showsPrec :: Int -> OptionName -> ShowS

show :: OptionName -> String

showList :: [OptionName] -> ShowS

Class Sym_Help

class Sym_Help d repr where

Minimal complete definition

help

Methods

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

Instances

Sym_Help d Parser

Defined in Language.Symantic.CLI.Read

Methods

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

Doc d => Sym_Help d (Plain d)

Defined in Language.Symantic.CLI.Plain

Methods

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

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

Class Sym_Exit

class Sym_Exit repr where

Minimal complete definition

exit

Methods

exit :: e -> repr e t ()

Instances

Sym_Exit Parser

Defined in Language.Symantic.CLI.Read

Methods

exit :: e -> Parser e t ()

Doc d => Sym_Exit (Plain d)

Defined in Language.Symantic.CLI.Plain

Methods

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

Doc d => Sym_Exit (Help d)

Defined in Language.Symantic.CLI.Help

Methods

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