Descriptive

Descriptive parsers.

Consuming and describing

consume

Arguments

:: Consumer s d a

The consumer to run.

-> s

Initial state.

-> Result (Description d) a

Run a consumer.

describe

Arguments

:: 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

runConsumer

Arguments

:: Consumer s d a

The consumer to run.

-> s

Initial state.

-> (Result (Description d) a, s)

Run a consumer.

runDescription

Arguments

:: 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, s)

A description and resultant state.

Describe a consumer.

Types

data Description a

Description of a consumable thing.

Constructors

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

Instances

Eq a => Eq (Description a)

Show a => Show (Description a)

Monoid (Description d)

Monoid a => Monoid (Result (Description d) a)

data Bound

The bounds of a many-consumable thing.

Constructors

NaturalBound !Integer

UnlimitedBound

Instances

Eq Bound

Show Bound

data Consumer s d a

A consumer.

Constructors

Consumer

Fields

consumerDesc :: s -> (Description d, s)

consumerParse :: s -> (Result (Description d) a, s)

Instances

Alternative (Consumer s d)

Functor (Consumer s d)

Applicative (Consumer s d)

Monoid a => Monoid (Consumer s d a)

data Result e a

Some result.

Constructors

Failed e

The whole process failed.

Succeeded a

The whole process succeeded.

Continued e

There were errors but we continued to collect all the errors.

Instances

Bifunctor Result

(Eq e, Eq a) => Eq (Result e a)

(Ord e, Ord a) => Ord (Result e a)

(Show e, Show a) => Show (Result e a)

Monoid a => Monoid (Result (Description d) a)

Combinators

consumer

Arguments

:: (s -> (Description d, s))

Produce description based on the state.

-> (s -> (Result (Description d) a, s))

Parse the state and maybe transform it if desired.

-> Consumer s d a

Make a consumer.

wrap

Arguments

:: (s -> (t -> (Description d, t)) -> (Description d, s))

Transformer the description.

-> (s -> (t -> (Description d, t)) -> (t -> (Result (Description d) a, t)) -> (Result (Description d) b, s))

Transform the parser. Can re-run the parser if desired.

-> Consumer t d a

The consumer to transform.

-> Consumer s d b

A new consumer with a potentially new state type.

Wrap a consumer with another consumer.

sequencing :: [Consumer d s a] -> Consumer d s [a]

Compose contiguous items into one sequence. Similar to sequenceA.