antlr.preprocessor.Grammar Class Reference

List of all members.

Public Member Functions
	Grammar (antlr.Tool tool, String name, String superGrammar, IndexedVector rules)
void	addOption (Option o)
void	addRule (Rule r)
void	expandInPlace ()
String	getFileName ()
String	getName ()
IndexedVector	getOptions ()
IndexedVector	getRules ()
Grammar	getSuperGrammar ()
String	getSuperGrammarName ()
String	getType ()
void	inherit (Option o, Grammar superG)
void	inherit (Rule r, Grammar superG)
void	inherit (String memberAction, Grammar superG)
boolean	isPredefined ()
void	setFileName (String f)
void	setHierarchy (Hierarchy hier)
void	setMemberAction (String a)
void	setOptions (IndexedVector options)
void	setPreambleAction (String a)
void	setPredefined (boolean b)
void	setTokenSection (String tk)
void	setType (String t)
String	toString ()
Protected Attributes
String	name
String	fileName
String	superGrammar
String	type
IndexedVector	rules
IndexedVector	options
String	tokenSection
String	preambleAction
String	memberAction
Hierarchy	hier
boolean	predefined = false
boolean	alreadyExpanded = false
boolean	specifiedVocabulary = false
String	superClass = null
String	importVocab = null
String	exportVocab = null
antlr.Tool	antlrTool

---

Constructor & Destructor Documentation

antlr.preprocessor.Grammar.Grammar	(	antlr.Tool	tool,
		String	name,
		String	superGrammar,
		IndexedVector	rules
	)

References antlr.preprocessor.Grammar.antlrTool.

---

Member Function Documentation

void antlr.preprocessor.Grammar.addOption

(

Option

o

)

References antlr.collections.impl.IndexedVector.appendElement(), antlr.preprocessor.Option.getName(), and antlr.preprocessor.Grammar.options.

Referenced by antlr.preprocessor.Grammar.expandInPlace(), and antlr.preprocessor.Grammar.inherit().

void antlr.preprocessor.Grammar.addRule

(

Rule

r

)

References antlr.collections.impl.IndexedVector.appendElement(), antlr.preprocessor.Rule.getName(), and antlr.preprocessor.Grammar.rules.

Referenced by antlr.preprocessor.Grammar.inherit().

void antlr.preprocessor.Grammar.expandInPlace

(

)

Copy all nonoverridden rules, vocabulary, and options into this grammar from supergrammar chain. The change is made in place; e.g., this grammar's vector of rules gets bigger. This has side-effects: all grammars on path to root of hierarchy are expanded also.

References antlr.preprocessor.Grammar.addOption(), antlr.preprocessor.Grammar.alreadyExpanded, antlr.preprocessor.Grammar.antlrTool, antlr.collections.impl.IndexedVector.elements, antlr.preprocessor.Grammar.expandInPlace(), antlr.preprocessor.Grammar.exportVocab, antlr.collections.impl.IndexedVector.getElement(), antlr.preprocessor.Hierarchy.getFile(), antlr.preprocessor.Grammar.getFileName(), antlr.preprocessor.Grammar.getName(), antlr.preprocessor.Grammar.getOptions(), antlr.preprocessor.Grammar.getRules(), antlr.preprocessor.Grammar.getSuperGrammar(), antlr.preprocessor.Grammar.hier, antlr.preprocessor.Grammar.inherit(), antlr.preprocessor.Grammar.isPredefined(), antlr.preprocessor.Grammar.memberAction, antlr.preprocessor.Grammar.options, and antlr.preprocessor.GrammarFile.setExpanded().

Referenced by antlr.preprocessor.Hierarchy.expandGrammarsInFile(), and antlr.preprocessor.Grammar.expandInPlace().

String antlr.preprocessor.Grammar.getFileName

(

)

References antlr.preprocessor.Grammar.fileName.

Referenced by antlr.preprocessor.Hierarchy.addGrammar(), and antlr.preprocessor.Grammar.expandInPlace().

String antlr.preprocessor.Grammar.getName

(

)

References antlr.preprocessor.Grammar.name.

Referenced by antlr.preprocessor.Hierarchy.addGrammar(), antlr.preprocessor.GrammarFile.addGrammar(), antlr.preprocessor.Grammar.expandInPlace(), antlr.preprocessor.Hierarchy.Hierarchy(), antlr.preprocessor.Grammar.inherit(), antlr.preprocessor.Grammar.toString(), and antlr.preprocessor.Hierarchy.verifyThatHierarchyIsComplete().

IndexedVector antlr.preprocessor.Grammar.getOptions

(

)

References antlr.preprocessor.Grammar.options.

Referenced by antlr.preprocessor.Grammar.expandInPlace().

IndexedVector antlr.preprocessor.Grammar.getRules

(

)

References antlr.preprocessor.Grammar.rules.

Referenced by antlr.preprocessor.Grammar.expandInPlace().

Grammar antlr.preprocessor.Grammar.getSuperGrammar

(

)

References antlr.preprocessor.Hierarchy.getGrammar(), antlr.preprocessor.Grammar.hier, and antlr.preprocessor.Grammar.superGrammar.

Referenced by antlr.preprocessor.Grammar.expandInPlace(), antlr.preprocessor.Hierarchy.findRoot(), and antlr.preprocessor.Hierarchy.verifyThatHierarchyIsComplete().

String antlr.preprocessor.Grammar.getSuperGrammarName

(

)

References antlr.preprocessor.Grammar.superGrammar.

Referenced by antlr.preprocessor.Hierarchy.findRoot(), and antlr.preprocessor.Hierarchy.verifyThatHierarchyIsComplete().

String antlr.preprocessor.Grammar.getType

(

)

References antlr.preprocessor.Grammar.type.

void antlr.preprocessor.Grammar.inherit	(	Option	o,
		Grammar	superG
	)

References antlr.preprocessor.Grammar.addOption(), antlr.collections.impl.IndexedVector.getElement(), antlr.preprocessor.Option.getName(), and antlr.preprocessor.Grammar.options.

Referenced by antlr.preprocessor.Grammar.expandInPlace().

void antlr.preprocessor.Grammar.inherit	(	Rule	r,
		Grammar	superG
	)

References antlr.preprocessor.Grammar.addRule(), antlr.preprocessor.Grammar.antlrTool, antlr.collections.impl.IndexedVector.getElement(), antlr.preprocessor.Grammar.getName(), antlr.preprocessor.Rule.getName(), antlr.preprocessor.Grammar.rules, and antlr.preprocessor.Rule.sameSignature().

void antlr.preprocessor.Grammar.inherit	(	String	memberAction,
		Grammar	superG
	)

boolean antlr.preprocessor.Grammar.isPredefined

(

)

References antlr.preprocessor.Grammar.predefined.

Referenced by antlr.preprocessor.Grammar.expandInPlace().

void antlr.preprocessor.Grammar.setFileName

(

String

f

)

References antlr.preprocessor.Grammar.fileName.

Referenced by antlr.preprocessor.Preprocessor.grammarFile().

void antlr.preprocessor.Grammar.setHierarchy

(

Hierarchy

hier

)

Referenced by antlr.preprocessor.Hierarchy.addGrammar().

void antlr.preprocessor.Grammar.setMemberAction

(

String

a

)

References antlr.preprocessor.Grammar.memberAction.

Referenced by antlr.preprocessor.Preprocessor.class_def().

void antlr.preprocessor.Grammar.setOptions

(

IndexedVector

options

)

Referenced by antlr.preprocessor.Preprocessor.class_def().

void antlr.preprocessor.Grammar.setPreambleAction

(

String

a

)

References antlr.preprocessor.Grammar.preambleAction.

Referenced by antlr.preprocessor.Preprocessor.class_def().

void antlr.preprocessor.Grammar.setPredefined

(

boolean

b

)

References antlr.preprocessor.Grammar.predefined.

Referenced by antlr.preprocessor.Hierarchy.Hierarchy().

void antlr.preprocessor.Grammar.setTokenSection

(

String

tk

)

References antlr.preprocessor.Grammar.tokenSection.

Referenced by antlr.preprocessor.Preprocessor.class_def().

void antlr.preprocessor.Grammar.setType

(

String

t

)

References antlr.preprocessor.Grammar.type.

Referenced by antlr.preprocessor.Hierarchy.verifyThatHierarchyIsComplete().

String antlr.preprocessor.Grammar.toString

(

)

References antlr.collections.impl.IndexedVector.elementAt(), antlr.preprocessor.Rule.enclosingGrammar, antlr.preprocessor.Grammar.getName(), antlr.preprocessor.Grammar.memberAction, antlr.preprocessor.Grammar.name, antlr.preprocessor.Grammar.options, antlr.preprocessor.Grammar.preambleAction, antlr.preprocessor.Grammar.rules, antlr.collections.impl.IndexedVector.size(), antlr.preprocessor.Grammar.superClass, antlr.preprocessor.Grammar.superGrammar, antlr.preprocessor.Grammar.tokenSection, and antlr.preprocessor.Grammar.type.

Referenced by antlr.preprocessor.GrammarFile.toString().

---

Member Data Documentation

boolean antlr.preprocessor.Grammar.alreadyExpanded = false [protected]

Referenced by antlr.preprocessor.Grammar.expandInPlace().

antlr.Tool antlr.preprocessor.Grammar.antlrTool [protected]

Referenced by antlr.preprocessor.Grammar.expandInPlace(), antlr.preprocessor.Grammar.Grammar(), and antlr.preprocessor.Grammar.inherit().

String antlr.preprocessor.Grammar.exportVocab = null [protected]

Referenced by antlr.preprocessor.Grammar.expandInPlace().

String antlr.preprocessor.Grammar.fileName [protected]

Referenced by antlr.preprocessor.Grammar.getFileName(), and antlr.preprocessor.Grammar.setFileName().

Hierarchy antlr.preprocessor.Grammar.hier [protected]

Referenced by antlr.preprocessor.Grammar.expandInPlace(), and antlr.preprocessor.Grammar.getSuperGrammar().

String antlr.preprocessor.Grammar.importVocab = null [protected]

String antlr.preprocessor.Grammar.memberAction [protected]

Referenced by antlr.preprocessor.Grammar.expandInPlace(), antlr.preprocessor.Grammar.setMemberAction(), and antlr.preprocessor.Grammar.toString().

String antlr.preprocessor.Grammar.name [protected]

Referenced by antlr.preprocessor.Grammar.getName(), and antlr.preprocessor.Grammar.toString().

IndexedVector antlr.preprocessor.Grammar.options [protected]

Referenced by antlr.preprocessor.Grammar.addOption(), antlr.preprocessor.Grammar.expandInPlace(), antlr.preprocessor.Grammar.getOptions(), antlr.preprocessor.Grammar.inherit(), and antlr.preprocessor.Grammar.toString().

String antlr.preprocessor.Grammar.preambleAction [protected]

Referenced by antlr.preprocessor.Grammar.setPreambleAction(), and antlr.preprocessor.Grammar.toString().

boolean antlr.preprocessor.Grammar.predefined = false [protected]

Referenced by antlr.preprocessor.Grammar.isPredefined(), and antlr.preprocessor.Grammar.setPredefined().

IndexedVector antlr.preprocessor.Grammar.rules [protected]

Referenced by antlr.preprocessor.Grammar.addRule(), antlr.preprocessor.Grammar.getRules(), antlr.preprocessor.Grammar.inherit(), and antlr.preprocessor.Grammar.toString().

boolean antlr.preprocessor.Grammar.specifiedVocabulary = false [protected]

String antlr.preprocessor.Grammar.superClass = null [protected]

if not derived from another grammar, might still specify a non-ANTLR class to derive from like this "class T extends Parser(MyParserClass);"

Referenced by antlr.preprocessor.Preprocessor.class_def(), and antlr.preprocessor.Grammar.toString().

String antlr.preprocessor.Grammar.superGrammar [protected]

Referenced by antlr.preprocessor.Grammar.getSuperGrammar(), antlr.preprocessor.Grammar.getSuperGrammarName(), and antlr.preprocessor.Grammar.toString().

String antlr.preprocessor.Grammar.tokenSection [protected]

Referenced by antlr.preprocessor.Grammar.setTokenSection(), and antlr.preprocessor.Grammar.toString().

String antlr.preprocessor.Grammar.type [protected]

Referenced by antlr.preprocessor.Grammar.getType(), antlr.preprocessor.Grammar.setType(), and antlr.preprocessor.Grammar.toString().

---

The documentation for this class was generated from the following file:

• preprocessor/Grammar.java