org.stekikun.dolmen.unparam

Class Grammar

java.lang.Object

org.stekikun.dolmen.unparam.Grammar

public final class Grammar
extends Object

A parser description is a set of grammar rules along with arbitrary header and footer sections. The rules come in no particular order, as every rule can theoretically be used as an entry point to the generated parser. When only one entry point really makes sense, it is conventionally the first rule.

The rules use a set of terminals which are provided before the header section in the source file. Each terminal can optionally be associated to a value of some Java type at run-time.

Rule names are identifiers which start with a lower-case letter. Terminal names are identifiers all in upper case.

Author:

Stéphane Lescuyer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Grammar.Builder A builder class for Grammar, where rules can be added incrementally, and which takes care of collecting problem reports along the way
static class	Grammar.IllFormedException Exception raised by the grammar builder class when trying to construct an ill-formed grammar description.

Field Summary

Fields

Modifier and Type	Field and Description
Extent	footer The extent of this parser class' footer
Extent	header The extent of this parser class' header
List<Located<String>>	imports The Java imports to be added to the generated parser
List<Option>	options The configuration options specified in this grammar
Map<String,GrammarRule>	rules The map of all grammar rules in the parser, indexed by their name
List<TokenDecl>	tokenDecls The declarations for all terminals of this grammar

Method Summary

Modifier and Type	Method and Description
GrammarRule	rule(String name)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

options

public final List<Option> options

The configuration options specified in this grammar

imports

public final List<Located<String>> imports

The Java imports to be added to the generated parser

tokenDecls

public final List<TokenDecl> tokenDecls

The declarations for all terminals of this grammar

header

public final Extent header

The extent of this parser class' header

rules

public final Map<String,GrammarRule> rules

The map of all grammar rules in the parser, indexed by their name

footer

public final Extent footer

The extent of this parser class' footer

Method Detail

rule

public GrammarRule rule(String name)

Parameters:

name -

Returns:

the rule with the given name in this grammar

Throws:

IllegalArgumentException - if no such rule exists

toString

public String toString()

Overrides:

toString in class Object