GrammarEngine (ANTLRWorks 1.5 API)

All Known Implementing Classes:

GrammarEngineImpl
```
public interface GrammarEngine
```

Method Summary

Methods
Modifier and Type	Method and Description
`GrammarResult`	`analyze()`
`void`	`antlrGrammarEngineAnalyzeCompleted()`
`void`	`cancelAnalyze()`
`void`	`close()`
`void`	`computeRuleErrors(ElementRule rule)`
`List<ElementAction>`	`getActions()`
`List<String>`	`getAllGeneratedNames()`
`ANTLRGrammarEngine`	`getANTLRGrammarEngine()`
`org.antlr.Tool`	`getANTLRTool()`
`List<ElementBlock>`	`getBlocks()`
`List<ATEToken>`	`getDecls()`
`List<ElementRule>`	`getDuplicateRules()`
`ElementGrammarName`	`getElementName()`
`int`	`getFirstDeclarationPosition(String name)`
`String`	`getGeneratedClassName(int type)`
`String`	`getGrammarFileName()`
`String`	`getGrammarLanguage()`
`String`	`getGrammarName()`
`GrammarProperties`	`getGrammarProperties()`
`List<String>`	`getGrammarsOverriddenByRule(String name)`
`List<String>`	`getGrammarsOverridingRule(String name)`
`String`	`getGrammarText()`
`List<ElementGroup>`	`getGroups()`
`List<ElementImport>`	`getImports()`
`int`	`getNumberOfErrors()`
`int`	`getNumberOfLines()`
`int`	`getNumberOfRules()`
`GrammarEngine`	`getParent()`
`List<ElementReference>`	`getReferences()`
`GrammarEngine`	`getRootEngine()`
`ElementRule`	`getRuleAtIndex(int index)`
`List<String>`	`getRuleNames()`
`List<ElementRule>`	`getRules()`
`ElementRule`	`getRuleWithName(String name)`
`GrammarSyntaxEngine`	`getSyntaxEngine()`
`List<ATEToken>`	`getTokens()`
`String`	`getTokenVocab()`
`String`	`getTokenVocabFile(String name)`
`int`	`getType()`
`List<ElementImport>`	`getUndefinedImports()`
`List<ElementReference>`	`getUndefinedReferences()`
`void`	`gotoToRule(String grammar, String name)`
`boolean`	`isCombinedGrammar()`
`boolean`	`isTreeParserGrammar()`
`void`	`markDirty()`
`void`	`parserCompleted()`
`void`	`reportError(String error)`
`void`	`reset()`
`void`	`setParent(GrammarEngine parent)`
`void`	`updateAll()`
`void`	`updateHierarchy(Map<String,GrammarEngine> engines, Set<GrammarEngine> alreadyVisitedEngines)`

Method Detail

setParent
```
void setParent(GrammarEngine parent)
```

getParent
```
GrammarEngine getParent()
```

getRootEngine
```
GrammarEngine getRootEngine()
```

close
```
void close()
```

getGrammarProperties

GrammarProperties getGrammarProperties()

getANTLRGrammarEngine

ANTLRGrammarEngine getANTLRGrammarEngine()

getSyntaxEngine
```
GrammarSyntaxEngine getSyntaxEngine()
```

getType
```
int getType()
```

getElementName
```
ElementGrammarName getElementName()
```

getGrammarName
```
String getGrammarName()
```

getGrammarLanguage
```
String getGrammarLanguage()
```

getRules
```
List<ElementRule> getRules()
```

getDuplicateRules
```
List<ElementRule> getDuplicateRules()
```

getRuleWithName

ElementRule getRuleWithName(String name)

getRuleAtIndex
```
ElementRule getRuleAtIndex(int index)
```

getRuleNames
```
List<String> getRuleNames()
```

getReferences
```
List<ElementReference> getReferences()
```

getUndefinedReferences

List<ElementReference> getUndefinedReferences()

getImports
```
List<ElementImport> getImports()
```

getUndefinedImports

List<ElementImport> getUndefinedImports()

getActions
```
List<ElementAction> getActions()
```

getGroups
```
List<ElementGroup> getGroups()
```

getBlocks
```
List<ElementBlock> getBlocks()
```

getDecls
```
List<ATEToken> getDecls()
```

getNumberOfLines
```
int getNumberOfLines()
```

getNumberOfRules
```
int getNumberOfRules()
```

getNumberOfErrors
```
int getNumberOfErrors()
```

getTokenVocab
```
String getTokenVocab()
```

getAllGeneratedNames

List<String> getAllGeneratedNames()
                                  throws Exception

Throws:: Exception

getGeneratedClassName

String getGeneratedClassName(int type)
                             throws Exception

Throws:: Exception

getFirstDeclarationPosition

int getFirstDeclarationPosition(String name)

getGrammarsOverriddenByRule

List<String> getGrammarsOverriddenByRule(String name)

getGrammarsOverridingRule

List<String> getGrammarsOverridingRule(String name)

getTokens
```
List<ATEToken> getTokens()
```

updateHierarchy

void updateHierarchy(Map<String,GrammarEngine> engines,
                   Set<GrammarEngine> alreadyVisitedEngines)

analyze

GrammarResult analyze()
                      throws Exception

Throws:: Exception

cancelAnalyze
```
void cancelAnalyze()
```

computeRuleErrors

void computeRuleErrors(ElementRule rule)

parserCompleted
```
void parserCompleted()
```

updateAll
```
void updateAll()
```

markDirty
```
void markDirty()
```

reset
```
void reset()
```

isCombinedGrammar
```
boolean isCombinedGrammar()
```

isTreeParserGrammar
```
boolean isTreeParserGrammar()
```

antlrGrammarEngineAnalyzeCompleted

void antlrGrammarEngineAnalyzeCompleted()

getGrammarFileName
```
String getGrammarFileName()
```

getGrammarText
```
String getGrammarText()
```

getTokenVocabFile
```
String getTokenVocabFile(String name)
```

getANTLRTool
```
org.antlr.Tool getANTLRTool()
```

reportError
```
void reportError(String error)
```

gotoToRule

void gotoToRule(String grammar,
              String name)

Interface GrammarEngine

Method Summary

Method Detail

setParent

getParent

getRootEngine

close

getGrammarProperties

getANTLRGrammarEngine

getSyntaxEngine

getType

getElementName

getGrammarName

getGrammarLanguage

getRules

getDuplicateRules

getRuleWithName

getRuleAtIndex

getRuleNames

getReferences

getUndefinedReferences

getImports

getUndefinedImports

getActions

getGroups

getBlocks

getDecls

getNumberOfLines

getNumberOfRules

getNumberOfErrors

getTokenVocab

getAllGeneratedNames

getGeneratedClassName

getFirstDeclarationPosition

getGrammarsOverriddenByRule

getGrammarsOverridingRule

getTokens

updateHierarchy

analyze

cancelAnalyze

computeRuleErrors

parserCompleted

updateAll

markDirty

reset

isCombinedGrammar

isTreeParserGrammar

antlrGrammarEngineAnalyzeCompleted

getGrammarFileName

getGrammarText

getTokenVocabFile

getANTLRTool

reportError

gotoToRule