Package jjparse

Class Parsing.Parser<T>

java.lang.Object

jjparse.Parsing.Parser<T>

Type Parameters:

T - The covariant type of the value that is the result of running this Parsing.Parser.

All Implemented Interfaces:

Function<Input<I>,Parsing<I>.Result<T>>

Enclosing class:

Parsing<I>

public abstract class Parsing.Parser<T>
extends Object
implements Function<Input<I>,Parsing<I>.Result<T>>

The abstract base class of a Parsing.Parser.

Very similar to recursive descent parsing, a Parsing.Parser is just a Function that takes an Input and produces a Parsing.Result. In order to implement a Parsing.Parser it therefore suffices to implement the apply(jjparse.input.Input<I>) method.

Note: This class is intended to be immutable and hence covariant in its type parameter.

Implementation Note: Unfortunately, Java does not support instance interfaces which is why this class is not a FunctionalInterface and we cannot use the lambda syntax to implement a Parsing.Parser.

Author:

Björn Lötters

Constructor Summary

Constructors

Constructor	Description
Parser()

Method Summary

Modifier and Type	Method	Description
final <U> Parsing<I>.Parser<Product<T,U>>	and(Parsing<I>.Parser<U> right)	Concatenates this and the provided Parsing.Parser and returns a Product of the corresponding values on Parsing.Success.
final <U> Parsing<I>.Parser<T>	andl(Parsing<I>.Parser<U> right)	Concatenates this and the provided Parsing.Parser but returns only the value parsed by this Parsing.Parser.
final <U> Parsing<I>.Parser<U>	andr(Parsing<I>.Parser<U> right)	Concatenates this and the provided Parsing.Parser but returns only the value parsed by the provided one.
abstract Parsing<I>.Result<T>	apply(Input<I> input)	Applies this Parsing.Parser to the provided Input, returning a Parsing.Result.
final Parsing<I>.Parser<T>	between(Parsing<I>.Parser<?> left, Parsing<I>.Parser<?> right)	Creates a Parsing.Parser which parses this Parsing.Parser in between the two provided Parsing.Parsers, only returning the value of this Parsing.Parser.
final Parsing<I>.Parser<T>	chainl(Parsing<I>.Parser<BiFunction<T,T,T>> separator, T otherwise)	Just like separate(jjparse.Parsing.Parser<?>), this method separates this Parsing.Parser using the separator Parsing.Parser.
final Parsing<I>.Parser<T>	chainl1(Parsing<I>.Parser<BiFunction<T,T,T>> separator)	Just like separate1(jjparse.Parsing.Parser<?>), this method separates this Parsing.Parser using the separator Parsing.Parser.
final Parsing<I>.Parser<T>	chainr(Parsing<I>.Parser<BiFunction<T,T,T>> separator, T otherwise)	Just like separate(jjparse.Parsing.Parser<?>), this method separates this Parsing.Parser using the separator Parsing.Parser.
final Parsing<I>.Parser<T>	chainr1(Parsing<I>.Parser<BiFunction<T,T,T>> separator)	Just like separate1(jjparse.Parsing.Parser<?>), this method separates this Parsing.Parser using the separator Parsing.Parser.
final Parsing<I>.Parser<T>	commit()	Creates a Parsing.Parser which behaves like this Parsing.Parser except that the created Parsing.Parser aborts with an Parsing.Abort when this Parsing.Parser fails with an Parsing.Error.
Description	description()	This method shall return a Description for this Parsing.Parser which provides details about the shape of the Input this Parsing.Parser expects.
final <U> Parsing<I>.Parser<U>	flatMap(Function<T,Parsing<I>.Parser<U>> function)	Maps this Parsing.Parser by applying the provided Function to the Parsing.Results it produces.
final Parsing<I>.Parser<T>	log(String name)	Creates a Parsing.Parser which prints additional debug output to the standard output stream.
final <U> Parsing<I>.Parser<U>	map(Function<T,U> function)	Maps this Parsing.Parser by applying the provided Function to the Parsing.Results it produces.
final Parsing<I>.Parser<Void>	not()	Creates a Parsing.Parser which attempts to not parse this Parsing.Parser.
final Parsing<I>.Parser<Optional<T>>	optional()	Creates a Parsing.Parser which attempts to parse this Parsing.Parser and only fails if this Parsing.Parser aborts with an Parsing.Abort.
final Parsing<I>.Parser<T>	or(Parsing<I>.Parser<? extends T> parser)	Creates a Parsing.Parser which first attempts to parse this Parsing.Parser and, if this Parsing.Parser fails with an Parsing.Error, attempts to parse the exact same Input with the provided Parsing.Parser.
final Parsing<I>.Parser<List<T>>	repeat()	Creates a Parsing.Parser which applies this Parsing.Parser arbitrarily many, including zero, times.
final Parsing<I>.Parser<List<T>>	repeat1()	Creates a Parsing.Parser which applies this Parsing.Parser arbitrarily many times but at least one time.
final Parsing<I>.Parser<List<T>>	separate(Parsing<I>.Parser<?> separator)	Creates a Parsing.Parser which parses this Parsing.Parser (possibly zero times) interleaved with the provided separator Parsing.Parser, only returning the values returned by this Parsing.Parser.
final Parsing<I>.Parser<List<T>>	separate1(Parsing<I>.Parser<?> separator)	Creates a Parsing.Parser which parses this Parsing.Parser (at least one time) interleaved with the provided separator Parsing.Parser, only returning the values returned by this Parsing.Parser.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.Function

andThen, compose

Constructor Details

Parser

public Parser()

Method Details

apply

public abstract Parsing<I>.Result<T> apply(Input<I> input)

Applies this Parsing.Parser to the provided Input, returning a Parsing.Result.

Specified by:

apply in interface Function<Input<I>,Parsing<I>.Result<T>>

Parameters:

input - The Input which this Parsing.Parser shall parse.

Returns:

The Parsing.Result of the parsing operation.

See Also:

• Parsing.Result

description

public Description description()

This method shall return a Description for this Parsing.Parser which provides details about the shape of the Input this Parsing.Parser expects. By default, this method returns an Empty Description and must hence be overwritten if required.

Returns:

A Description of this Parsing.Parser.

See Also:

• Description

map

public final <U> Parsing<I>.Parser<U> map(Function<T,U> function)

Maps this Parsing.Parser by applying the provided Function to the Parsing.Results it produces.

Type Parameters:

U - The type of the transformed Parsing.Parser.

Parameters:

function - The Function which shall be applied to the Parsing.Results of this parser.

Returns:

A Parsing.Parser that parses the exact same language as this one, but with a transformed Parsing.Result.

See Also:

• flatMap(java.util.function.Function<T, jjparse.Parsing.Parser<U>>)

flatMap

public final <U> Parsing<I>.Parser<U> flatMap(Function<T,Parsing<I>.Parser<U>> function)

Maps this Parsing.Parser by applying the provided Function to the Parsing.Results it produces. On success, the Parsing.Parser returned by this Function is immediately applied to the rest of the input. In this way, this method also behaves like a concatenation of this Parsing.Parser and the returned one.

Type Parameters:

U - The type of the transformed Parsing.Parser.

Parameters:

function - The Function which shall be applied to the Parsing.Results of this parser.

Returns:

A Parsing.Parser that first applies this and then the one returned by the provided Function.

See Also:

• map(java.util.function.Function<T, U>)
• and(jjparse.Parsing.Parser<U>)

and

public final <U> Parsing<I>.Parser<Product<T,U>> and(Parsing<I>.Parser<U> right)

Concatenates this and the provided Parsing.Parser and returns a Product of the corresponding values on Parsing.Success.

Type Parameters:

U - The type of the second Parsing.Parser's Parsing.Result.

Parameters:

right - The second Parsing.Parser which shall be appended to this Parsing.Parser.

Returns:

A Parsing.Parser which first parses this and then the provided one, returning the Product of their returned values on Parsing.Success.

See Also:

• andl(jjparse.Parsing.Parser<U>)
• andr(jjparse.Parsing.Parser<U>)
• flatMap(java.util.function.Function<T, jjparse.Parsing.Parser<U>>)
• or(jjparse.Parsing.Parser<? extends T>)
• Parsing.sequence(jjparse.Parsing.Parser<? extends T>...)

andl

public final <U> Parsing<I>.Parser<T> andl(Parsing<I>.Parser<U> right)

Concatenates this and the provided Parsing.Parser but returns only the value parsed by this Parsing.Parser.

Type Parameters:

U - The type of the second Parsing.Parser's Parsing.Result.

Parameters:

right - The second Parsing.Parser which shall be appended to this Parsing.Parser.

Returns:

A Parsing.Parser which first parses this and then the provided one, returning the value of this Parsing.Parser only.

See Also:

• andr(jjparse.Parsing.Parser<U>)
• and(jjparse.Parsing.Parser<U>)

andr

public final <U> Parsing<I>.Parser<U> andr(Parsing<I>.Parser<U> right)

Concatenates this and the provided Parsing.Parser but returns only the value parsed by the provided one.

Type Parameters:

U - The type of the second Parsing.Parser's Parsing.Result.

Parameters:

right - The second Parsing.Parser which shall be appended to this Parsing.Parser.

Returns:

A Parsing.Parser which first parses this and then the provided one, returning the value of the provided Parsing.Parser only.

See Also:

• andl(jjparse.Parsing.Parser<U>)
• and(jjparse.Parsing.Parser<U>)

or

public final Parsing<I>.Parser<T> or(Parsing<I>.Parser<? extends T> parser)

Creates a Parsing.Parser which first attempts to parse this Parsing.Parser and, if this Parsing.Parser fails with an Parsing.Error, attempts to parse the exact same Input with the provided Parsing.Parser.

Parameters:

parser - The alternative Parsing.Parser.

Returns:

A Parsing.Parser which first attempts to parse the Input with this and only then with the provided Parsing.Parser.

See Also:

• Parsing.choice(jjparse.Parsing.Parser<? extends T>...)
• and(jjparse.Parsing.Parser<U>)

optional

public final Parsing<I>.Parser<Optional<T>> optional()

Creates a Parsing.Parser which attempts to parse this Parsing.Parser and only fails if this Parsing.Parser aborts with an Parsing.Abort.

Returns:

A Parsing.Parser which optionally parses this Parsing.Parser.

See Also:

• Optional
• repeat()

repeat

public final Parsing<I>.Parser<List<T>> repeat()

Creates a Parsing.Parser which applies this Parsing.Parser arbitrarily many, including zero, times.

Returns:

A Parsing.Parser which repeats this Parsing.Parser arbitrarily many, including zero, times.

See Also:

• optional()
• repeat1()
• separate(jjparse.Parsing.Parser<?>)
• separate1(jjparse.Parsing.Parser<?>)

repeat1

public final Parsing<I>.Parser<List<T>> repeat1()

Creates a Parsing.Parser which applies this Parsing.Parser arbitrarily many times but at least one time.

Returns:

A Parsing.Parser which repeats this Parsing.Parser arbitrarily many times but at least one time.

See Also:

• optional()
• repeat()
• separate(jjparse.Parsing.Parser<?>)
• separate1(jjparse.Parsing.Parser<?>)

separate1

public final Parsing<I>.Parser<List<T>> separate1(Parsing<I>.Parser<?> separator)

Creates a Parsing.Parser which parses this Parsing.Parser (at least one time) interleaved with the provided separator Parsing.Parser, only returning the values returned by this Parsing.Parser. This is especially useful for Inputs like comma separated values.

Parameters:

separator - The separator Parsing.Parser.

Returns:

A Parsing.Parser which parses this Parsing.Parser interleaved with the provided separator Parsing.Parser.

See Also:

• repeat()
• repeat1()
• separate(jjparse.Parsing.Parser<?>)
• chainl(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>, T)
• chainl1(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>)
• chainr(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>, T)
• chainr1(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>)

separate

public final Parsing<I>.Parser<List<T>> separate(Parsing<I>.Parser<?> separator)

Creates a Parsing.Parser which parses this Parsing.Parser (possibly zero times) interleaved with the provided separator Parsing.Parser, only returning the values returned by this Parsing.Parser. This is especially useful for Inputs like comma separated values.

Parameters:

separator - The separator Parsing.Parser.

Returns:

A Parsing.Parser which parses this Parsing.Parser interleaved with the provided separator Parsing.Parser.

See Also:

• repeat()
• repeat1()
• separate1(jjparse.Parsing.Parser<?>)
• chainl(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>, T)
• chainl1(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>)
• chainr(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>, T)
• chainr1(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>)

between

public final Parsing<I>.Parser<T> between(Parsing<I>.Parser<?> left,
 Parsing<I>.Parser<?> right)

Creates a Parsing.Parser which parses this Parsing.Parser in between the two provided Parsing.Parsers, only returning the value of this Parsing.Parser.

Parameters:

left - The left of the two enclosing Parsing.Parsers.

right - The right of the two enclosing Parsing.Parsers.

Returns:

A Parsing.Parser which parses this Parsing.Parser in between the two provided Parsing.Parsers.

See Also:

• and(jjparse.Parsing.Parser<U>)

commit

public final Parsing<I>.Parser<T> commit()

Creates a Parsing.Parser which behaves like this Parsing.Parser except that the created Parsing.Parser aborts with an Parsing.Abort when this Parsing.Parser fails with an Parsing.Error. The effect of this is that backtracking does not extend over the created Parsing.Parser. This is especially useful for the Parsing.Parser right after a keyword Parsing.Parser, to prevent backtracking over the keyword.

Returns:

A Parsing.Parser which behaves like this Parsing.Parser, but with backtracking disabled.

See Also:

• not()

not

public final Parsing<I>.Parser<Void> not()

Creates a Parsing.Parser which attempts to not parse this Parsing.Parser. That is to say, every Parsing.Failure of this Parsing.Parser is transformed into a Parsing.Success and vice versa. The created Parsing.Parser never consumes any Input.

Returns:

A Parsing.Parser which ensures that this Parsing.Parser is not applicable.

See Also:

• commit()

log

public final Parsing<I>.Parser<T> log(String name)

Creates a Parsing.Parser which prints additional debug output to the standard output stream.

Parameters:

name - A human-readable name for this Parsing.Parser.

Returns:

A Parsing.Parser which behaves like this Parsing.Parser but prints additional debug output.

chainl1

public final Parsing<I>.Parser<T> chainl1(Parsing<I>.Parser<BiFunction<T,T,T>> separator)

Just like separate1(jjparse.Parsing.Parser<?>), this method separates this Parsing.Parser using the separator Parsing.Parser. However, instead of returning a List of the parsed elements, the elements are folded from left to right into a single element using the BiFunctions returned by the separator Parsing.Parser. This is especially useful for parsing left-associative chains of operators such as 1 + 2 + 3.

Parameters:

separator - The separator Parsing.Parser which must return a BiFunction that combines any two elements.

Returns:

A Parsing.Parser which behaves similar to separate1(jjparse.Parsing.Parser<?>) but combines all elements into a single one.

See Also:

• separate1(jjparse.Parsing.Parser<?>)
• chainl(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>, T)
• chainr(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>, T)
• chainr1(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>)
• BiFunction

chainl

public final Parsing<I>.Parser<T> chainl(Parsing<I>.Parser<BiFunction<T,T,T>> separator,
 T otherwise)

Just like separate(jjparse.Parsing.Parser<?>), this method separates this Parsing.Parser using the separator Parsing.Parser. However, instead of returning a List of the parsed elements, the elements are folded from left to right into a single element using the BiFunctions returned by the separator Parsing.Parser. This is especially useful for parsing left-associative chains of operators such as 1 + 2 + 3.

Parameters:

separator - The separator Parsing.Parser which must return a BiFunction that combines any two elements.

otherwise - The element that should be returned when there is no single element in the chain.

Returns:

A Parsing.Parser which behaves similar to separate(jjparse.Parsing.Parser<?>) but combines all elements into a single one.

See Also:

• separate(jjparse.Parsing.Parser<?>)
• chainl1(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>)
• chainr(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>, T)
• chainr1(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>)
• BiFunction

chainr1

public final Parsing<I>.Parser<T> chainr1(Parsing<I>.Parser<BiFunction<T,T,T>> separator)

Just like separate1(jjparse.Parsing.Parser<?>), this method separates this Parsing.Parser using the separator Parsing.Parser. However, instead of returning a List of the parsed elements, the elements are folded from right to left into a single element using the BiFunctions returned by the separator Parsing.Parser. This is especially useful for parsing right-associative chains of operators such as a = b = c.

Parameters:

separator - The separator Parsing.Parser which must return a BiFunction that combines any two elements.

Returns:

A Parsing.Parser which behaves similar to separate1(jjparse.Parsing.Parser<?>) but combines all elements into a single one.

See Also:

• separate1(jjparse.Parsing.Parser<?>)
• chainl(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>, T)
• chainl1(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>)
• chainr(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>, T)
• BiFunction

chainr

public final Parsing<I>.Parser<T> chainr(Parsing<I>.Parser<BiFunction<T,T,T>> separator,
 T otherwise)

Just like separate(jjparse.Parsing.Parser<?>), this method separates this Parsing.Parser using the separator Parsing.Parser. However, instead of returning a List of the parsed elements, the elements are folded from right to left into a single element using the BiFunctions returned by the separator Parsing.Parser. This is especially useful for parsing right-associative chains of operators such as a = b = c.

Parameters:

separator - The separator Parsing.Parser which must return a BiFunction that combines any two elements.

otherwise - The element that should be returned when there is no single element in the chain.

Returns:

A Parsing.Parser which behaves similar to separate(jjparse.Parsing.Parser<?>) but combines all elements into a single one.

See Also:

• separate(jjparse.Parsing.Parser<?>)
• chainl(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>, T)
• chainl1(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>)
• chainr1(jjparse.Parsing.Parser<java.util.function.BiFunction<T, T, T>>)
• BiFunction