| Portability | unportable |
|---|---|
| Stability | unstable |
| Maintainer | Martin Avanzini <martin.avanzini@uibk.ac.at> |
| Safe Haskell | Safe-Infered |
Tct.Processor.Args
Contents
Description
This module implements processor arguments.
- class Argument a where
- class Argument a => ParsableArgument a where
- parseArg :: Phantom a -> ProcessorParser (Domain a)
- interactiveParser :: Phantom a -> AnyProcessor -> InteractiveParser a
- data Arg t = Arg {
- name :: String
- description :: String
- defaultValue :: Domain t
- isOptional_ :: Bool
- arg :: Arg t
- optional :: Arg t -> String -> Domain t -> Arg t
- data Unit = Unit
- data a :+: b = a :+: b
Documentation
class Argument a where
Instances of this class can be used as processor arguments.
Parsers are specified separately in the class ParsableArgument.
The associated type 'Domain a' reflects the type of the Haskell values.
This type does not necessarily need to coincide with a, but for simple
instances like Bool it does, i.e. 'Domain Bool == Bool'.
Associated Types
type Domain a
class Argument a => ParsableArgument a where
Instances of this class additionally provide parsers for arguments.
Methods
parseArg :: Phantom a -> ProcessorParser (Domain a)
interactiveParser :: Phantom a -> AnyProcessor -> InteractiveParser a
Instances
| ParsableArgument Bool | |
| ParsableArgument Processor | |
| ParsableArgument Nat | |
| ParsableArgument a => ParsableArgument [a] | |
| ParsableArgument a => ParsableArgument (Maybe a) | |
| (Show a, AssocArgument a) => ParsableArgument (Assoc a) | |
| (Typeable a, Show a, Enum a, Bounded a) => ParsableArgument (EnumOf a) |
Argument Descriptions
data Arg t
This datatype captures the description of a single argument.
Constructors
| Arg | |
Fields
| |
optional :: Arg t -> String -> Domain t -> Arg t
Constructor for description of optional arguments of type t.
The following describes an optional argument dimension with default
value 2.
>>>optional naturalArg "dimension" 2
data Unit
Unit represents the empty argument list.
Constructors
| Unit |
Instances
| Show Unit | |
| Typeable Unit | |
| ParsableArguments Unit | |
| Arguments Unit | |
| Processor proc => AsStrategy (InstanceOf proc) ConstantDeclaration | |
| Transformer trans => AsStrategy (TheTransformer trans) ConstantDeclaration | |
| (Processor proc, ~ * (ProofOf proc) res) => WithProblem (InstanceOf proc) (InstanceOf (Custom Unit res)) |