Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell98 |
Descriptive parsers.
- consume :: Consumer s d a -> s -> Result (Description d) a
- describe :: Consumer s d a -> s -> Description d
- runConsumer :: Monad m => Consumer s d a -> StateT s m (Result (Description d) a)
- runDescription :: Monad m => Consumer s d a -> StateT s m (Description d)
- data Description a
- = Unit !a
- | Bounded !Integer !Bound !(Description a)
- | And !(Description a) !(Description a)
- | Or !(Description a) !(Description a)
- | Sequence ![Description a]
- | Wrap a !(Description a)
- | None
- data Bound
- data Consumer s d a = Consumer {
- consumerDesc :: forall m. Monad m => StateT s m (Description d)
- consumerParse :: forall m. Monad m => StateT s m (Result (Description d) a)
- data Result e a
- consumer :: (forall m. Monad m => StateT s m (Description d)) -> (forall m. Monad m => StateT s m (Result (Description d) a)) -> Consumer s d a
- wrap :: (forall m. Monad m => StateT t m (Description d) -> StateT s m (Description d)) -> (forall m. Monad m => StateT t m (Description d) -> StateT t m (Result (Description d) a) -> StateT s m (Result (Description d) b)) -> Consumer t d a -> Consumer s d b
Consuming and describing
:: Consumer s d a | The consumer to run. |
-> s | Initial state. |
-> Result (Description d) a |
Run a consumer.
:: Consumer s d a | The consumer to run. |
-> s | Initial state. Can be "empty" if you don't use it for generating descriptions. |
-> Description d | A description and resultant state. |
Describe a consumer.
Lower-level runners
:: Monad m | |
=> Consumer s d a | The consumer to run. |
-> StateT s m (Result (Description d) a) |
Run a consumer.
:: Monad m | |
=> Consumer s d a | The consumer to run. |
-> StateT s m (Description d) | A description and resultant state. |
Describe a consumer.
Types
data Description a Source
Description of a consumable thing.
Unit !a | |
Bounded !Integer !Bound !(Description a) | |
And !(Description a) !(Description a) | |
Or !(Description a) !(Description a) | |
Sequence ![Description a] | |
Wrap a !(Description a) | |
None |
Eq a => Eq (Description a) | |
Show a => Show (Description a) | |
Monoid (Description d) | |
Monoid a => Monoid (Result (Description d) a) |
The bounds of a many-consumable thing.
A consumer.
Consumer | |
|
Alternative (Consumer s d) | |
Functor (Consumer s d) | |
Applicative (Consumer s d) | |
Monoid a => Monoid (Consumer s d a) |
Some result.
Combinators
:: (forall m. Monad m => StateT s m (Description d)) | Produce description based on the state. |
-> (forall m. Monad m => StateT s m (Result (Description d) a)) | Parse the state and maybe transform it if desired. |
-> Consumer s d a |
Make a self-describing consumer.
:: (forall m. Monad m => StateT t m (Description d) -> StateT s m (Description d)) | Transform the description. |
-> (forall m. Monad m => StateT t m (Description d) -> StateT t m (Result (Description d) a) -> StateT s m (Result (Description d) b)) | Transform the parser. Can re-run the parser as many times as desired. |
-> Consumer t d a | |
-> Consumer s d b |
Wrap a consumer with another consumer. The type looks more intimidating than it actually is. The source code is trivial. It simply allows for a way to transform the type of the state.