Text.Syntax.Combinators

Lexemes

text :: Syntax delta => String -> delta ()

text parses/prints a fixed text and consumes/produces a unit value.

comma :: Syntax delta => delta ()

dot :: Syntax delta => delta ()

Repetition

many :: Syntax delta => delta alpha -> delta [alpha]

many1 :: Syntax delta => delta alpha -> delta [alpha]

sepBy :: Syntax delta => delta alpha -> delta () -> delta [alpha]

chainl1 :: Syntax delta => delta alpha -> delta beta -> Iso (alpha, (beta, alpha)) alpha -> delta alpha

The chainl1 combinator is used to parse a left-associative chain of infix operators.

Sequencing

(*>) :: Syntax delta => delta () -> delta alpha -> delta alpha

This variant of <*> ignores its left result. In contrast to its counterpart derived from the Applicative class, the ignored parts have type `delta ()` rather than `delta beta` because otherwise information relevant for pretty-printing would be lost.

(<*) :: Syntax delta => delta alpha -> delta () -> delta alpha

This variant of <*> ignores its right result. In contrast to its counterpart derived from the Applicative class, the ignored parts have type `delta ()` rather than `delta beta` because otherwise information relevant for pretty-printing would be lost.

between :: Syntax delta => delta () -> delta () -> delta alpha -> delta alpha

The between function combines *> and <* in the obvious way.

Alternation

(<+>) :: Syntax delta => delta alpha -> delta beta -> delta (Either alpha beta)

optional :: Syntax delta => delta alpha -> delta (Maybe alpha)

Whitespace

skipSpace :: Syntax delta => delta ()

skipSpace marks a position where whitespace is allowed to occur. It accepts arbitrary space while parsing, and produces no space while printing.

sepSpace :: Syntax delta => delta ()

sepSpace marks a position where whitespace is required to occur. It requires one or more space characters while parsing, and produces a single space character while printing.

optSpace :: Syntax delta => delta ()

optSpace marks a position where whitespace is desired to occur. It accepts arbitrary space while parsing, and produces a single space character while printing.