org.nineml.coffeegrinder.parser

Class ParserGrammar

java.lang.Object

org.nineml.coffeegrinder.parser.Grammar

org.nineml.coffeegrinder.parser.ParserGrammar

public class ParserGrammar
extends Grammar

A grammar for the parser.

A grammar is a list of rules. Each rule defines a non-terminal symbol as a sequence of zero or more symbols (terminal or nonterminal).

A grammar can be used to create a parser for that grammar. The ParserGrammar is derived from a SourceGrammar. The ParserGrammar is immutable.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	usesRegex

Fields inherited from class org.nineml.coffeegrinder.parser.Grammar

logcategory

Method Summary

Modifier and Type	Method and Description
java.util.Set<Symbol>	getFirst(Symbol symbol)
java.util.Set<Symbol>	getFollow(Symbol symbol)
HygieneReport	getHygieneReport() Get a hygiene report for this compiled grammar.
GearleyParser	getParser(ParserOptions options) Get a parser for this grammar.
ParserOptions	getParserOptions()
NonterminalSymbol	getSeed()
boolean	isNullable(Symbol symbol) Is a symbol nullable?

Methods inherited from class org.nineml.coffeegrinder.parser.Grammar

getMetadataProperies, getMetadataProperty, getRules, getRulesBySymbol, getRulesForSymbol, getSymbols

Methods inherited from class java.lang.Object

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

Field Detail

usesRegex

public final boolean usesRegex

Method Detail

getSeed

public NonterminalSymbol getSeed()

getParserOptions

public ParserOptions getParserOptions()

getParser

public GearleyParser getParser(ParserOptions options)

Get a parser for this grammar.

Returns a parser that will parse an input against the rules that define this grammar.

Parameters:

options - the parser options.

Returns:

the parser

isNullable

public boolean isNullable(Symbol symbol)

Is a symbol nullable?

Specified by:

isNullable in class Grammar

Parameters:

symbol - the symbol

Returns:

true if the symbol is nullable

Throws:

java.lang.UnsupportedOperationException - if the grammar is open

getHygieneReport

public HygieneReport getHygieneReport()

Get a hygiene report for this compiled grammar.

Returns:

the report.

getFirst

public java.util.Set<Symbol> getFirst(Symbol symbol)

getFollow

public java.util.Set<Symbol> getFollow(Symbol symbol)