org.typemeta.funcj.parser

Class Ref<I,A>

java.lang.Object

org.typemeta.funcj.parser.Ref<I,A>

Type Parameters:

I - input stream symbol type

A - parser result type

All Implemented Interfaces:

Parser<I,A>

public class Ref<I,A>
extends Object
implements Parser<I,A>

A reference to a Parser.

At creation the reference is typically uninitialised. Any of the Parser methods will throw if invoked on an uninitialised Ref. It is subsequently initialised (via the set(Parser) method) with a Parser Ref is typically used to allow parsers for grammars with circular dependencies to be constructed.

Method Summary

Modifier and Type	Method and Description
Lazy<Boolean>	acceptsEmpty() Indicate whether this parser accepts the empty symbol.
Result<I,A>	apply(Input<I> in, SymSet<I> follow) Apply this parser to the input stream.
Lazy<SymSet<I>>	firstSet() The First Set for this parser.
Parser<I,A>	set(Parser<I,A> impl) Initialise this reference

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.typemeta.funcj.parser.Parser

and, andL, andR, ap, ap, apply, between, cast, chainl, chainl1, chainr, chainr1, choice, choice, many, many1, manyTill, map, optional, or, parse, pure, ref, ref, sepBy, sepBy1, sequence, sequence, skipMany, traverse

Method Detail

set

public Parser<I,A> set(Parser<I,A> impl)

Initialise this reference

Parameters:

impl - the parser

Returns:

this parser

acceptsEmpty

public Lazy<Boolean> acceptsEmpty()

Description copied from interface: Parser

Indicate whether this parser accepts the empty symbol.

Specified by:

acceptsEmpty in interface Parser<I,A>

Returns:

a lazy wrapper for true iff the parser accepts the empty symbol

firstSet

public Lazy<SymSet<I>> firstSet()

Description copied from interface: Parser

The First Set for this parser.

Specified by:

firstSet in interface Parser<I,A>

Returns:

a lazy symbol set

apply

public Result<I,A> apply(Input<I> in,
                         SymSet<I> follow)

Description copied from interface: Parser

Apply this parser to the input stream. Note: If this parser is being used as a standalone parser, then call Parser.parse(Input) to parse an input.

Specified by:

apply in interface Parser<I,A>

Parameters:

in - the input stream

follow - the dynamic follow set

Returns:

the parse result