Top Description Inners Fields Constructors Methods

org.antlr.tool

public Class GrammarSpelunker

Class Inheritance

extends Object

java.lang.Object
org.antlr.tool.GrammarSpelunker

Imports

java.io.*, java.util.ArrayList, .List

Load a grammar file and scan it just until we learn a few items of interest. Currently: name, type, imports, tokenVocab, language option. GrammarScanner (at bottom of this class) converts grammar to stuff like: grammar Java ; options { backtrack true memoize true } import JavaDecl JavaAnnotations JavaExpr ; ... : ... First ':' or '@' indicates we can stop looking for imports/options. Then we just grab interesting grammar properties.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	GrammarSpelunker.Scanner Strip comments and then return stream of words and tokens {';', ':', '{', '}'}

Field Summary

Modifier and Type	Field and Description
protected String	grammarFileName
protected String	grammarModifier
protected String	grammarName
protected List<String>	importedGrammars
protected String	inputDirectory
protected String	language
protected GrammarSpelunker.Scanner	scanner
protected String	token
protected String	tokenVocab

Constructor Summary

Access	Constructor and Description
public	GrammarSpelunker(String inputDirectory, String grammarFileName)

Method Summary

Modifier and Type	Method and Description
pack-priv void	consume()
public String	getGrammarModifier()
public String	getGrammarName()
public List<String>	getImportedGrammars()
public String	getLanguage()
public String	getTokenVocab()
protected void	grammarHeader()
protected void	imports()
public static void	main(String[] args) Tester; Give grammar filename as arg
protected void	match(String expecting)
protected void	options()
public void	parse()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

grammarFileName	back to summary
protected String grammarFileName

grammarModifier	back to summary
protected String grammarModifier

grammarName	back to summary
protected String grammarName

importedGrammars	back to summary
protected List<String> importedGrammars

inputDirectory	back to summary
protected String inputDirectory

language	back to summary
protected String language

scanner	back to summary
protected GrammarSpelunker.Scanner scanner

token	back to summary
protected String token

tokenVocab	back to summary
protected String tokenVocab

Constructor Detail

GrammarSpelunker	back to summary
public GrammarSpelunker(String inputDirectory, String grammarFileName)

Method Detail

consume	back to summary
pack-priv void consume() throws IOException

getGrammarModifier	back to summary
public String getGrammarModifier()

getGrammarName	back to summary
public String getGrammarName()

getImportedGrammars	back to summary
public List<String> getImportedGrammars()

getLanguage	back to summary
public String getLanguage()

getTokenVocab	back to summary
public String getTokenVocab()

grammarHeader	back to summary
protected void grammarHeader() throws IOException

imports	back to summary
protected void imports() throws IOException

main	back to summary
public static void main(String[] args) throws IOException Tester; Give grammar filename as arg

match	back to summary
protected void match(String expecting) throws IOException

options	back to summary
protected void options() throws IOException

parse	back to summary
public void parse() throws IOException

org.antlr.tool back to summary

public Class GrammarSpelunker.Scanner

Class Inheritance

extends Object

java.lang.Object
org.antlr.tool.GrammarSpelunker.Scanner

Strip comments and then return stream of words and tokens {';', ':', '{', '}'}

Field Summary

Modifier and Type	Field and Description
pack-priv int	c
public static final int	EOF
pack-priv Reader	input

Constructor Summary

Access	Constructor and Description
public	Scanner(Reader input)

Method Summary

Modifier and Type	Method and Description
pack-priv void	COMMENT()
pack-priv void	consume()
pack-priv String	ID() NAME : LETTER+ ; // NAME is sequence of >=1 letter
pack-priv String	INT()
pack-priv boolean	isDIGIT()
pack-priv boolean	isID_LETTER()
pack-priv boolean	isID_START()
public String	nextToken()
pack-priv String	STRING()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

c	back to summary
pack-priv int c

EOF	back to summary
public static final int EOF

input	back to summary
pack-priv Reader input

Constructor Detail

Scanner	back to summary
public Scanner(Reader input) throws IOException

Method Detail

COMMENT	back to summary
pack-priv void COMMENT() throws IOException

consume	back to summary
pack-priv void consume() throws IOException

ID	back to summary
pack-priv String ID() throws IOException NAME : LETTER+ ; // NAME is sequence of >=1 letter

INT	back to summary
pack-priv String INT() throws IOException

isDIGIT	back to summary
pack-priv boolean isDIGIT()

isID_LETTER	back to summary
pack-priv boolean isID_LETTER()

isID_START	back to summary
pack-priv boolean isID_START()

nextToken	back to summary
public String nextToken() throws IOException

STRING	back to summary
pack-priv String STRING() throws IOException