Package org.javacc.jjdoc
Interface Generator
-
- All Known Implementing Classes:
BNFGenerator
,HTMLGenerator
,TextGenerator
,XTextGenerator
public interface Generator
A report generator for a grammar.- Since:
- 11-Dec-2006
- Author:
- timp
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
cppcode(CppCodeProduction cp)
Output comment from a production.void
debug(java.lang.String message)
Log debug messages.void
documentEnd()
Output document footer.void
documentStart()
Output document header.void
error(java.lang.String message)
Log error messages.void
expansionEnd(Expansion e, boolean first)
Output end of Expansion.void
expansionStart(Expansion e, boolean first)
Output start of an Expansion.void
handleTokenProduction(TokenProduction tp)
void
info(java.lang.String message)
Log informational messages.void
javacode(JavaCodeProduction jp)
Output comment from a production.void
nonTerminalEnd(NonTerminal nt)
Output end of non-terminal.void
nonterminalsEnd()
Output end of non-terminal.void
nonterminalsStart()
Output start of non-terminal.void
nonTerminalStart(NonTerminal nt)
Output start of non-terminal.void
print(java.lang.String s)
Output String.void
productionEnd(NormalProduction np)
Output end of a normal production.void
productionStart(NormalProduction np)
Output start of a normal production.void
reEnd(RegularExpression re)
Output end of regular expression.void
reStart(RegularExpression re)
Output start of regular expression.void
specialTokens(java.lang.String s)
Output Special Tokens.void
text(java.lang.String s)
Output string with entity substitution for brackets and ampersands.void
tokensEnd()
Output end of tokens.void
tokensStart()
Output start of tokens.void
warn(java.lang.String message)
Log warning messages.
-
-
-
Method Detail
-
text
void text(java.lang.String s)
Output string with entity substitution for brackets and ampersands.- Parameters:
s
- the String to output
-
print
void print(java.lang.String s)
Output String.- Parameters:
s
- String to output
-
documentStart
void documentStart()
Output document header.
-
documentEnd
void documentEnd()
Output document footer.
-
specialTokens
void specialTokens(java.lang.String s)
Output Special Tokens.- Parameters:
s
- tokens to output
-
handleTokenProduction
void handleTokenProduction(TokenProduction tp)
-
nonterminalsStart
void nonterminalsStart()
Output start of non-terminal.
-
nonterminalsEnd
void nonterminalsEnd()
Output end of non-terminal.
-
tokensStart
void tokensStart()
Output start of tokens.
-
tokensEnd
void tokensEnd()
Output end of tokens.
-
javacode
void javacode(JavaCodeProduction jp)
Output comment from a production.- Parameters:
jp
- the JavaCodeProduction to output
-
cppcode
void cppcode(CppCodeProduction cp)
Output comment from a production.- Parameters:
cp
- the CppCodeProduction to output
-
productionStart
void productionStart(NormalProduction np)
Output start of a normal production.- Parameters:
np
- the NormalProduction being output
-
productionEnd
void productionEnd(NormalProduction np)
Output end of a normal production.- Parameters:
np
- the NormalProduction being output
-
expansionStart
void expansionStart(Expansion e, boolean first)
Output start of an Expansion.- Parameters:
e
- Expansion being outputfirst
- whether this is the first expansion
-
expansionEnd
void expansionEnd(Expansion e, boolean first)
Output end of Expansion.- Parameters:
e
- Expansion being outputfirst
- whether this is the first expansion
-
nonTerminalStart
void nonTerminalStart(NonTerminal nt)
Output start of non-terminal.- Parameters:
nt
- the NonTerminal being output
-
nonTerminalEnd
void nonTerminalEnd(NonTerminal nt)
Output end of non-terminal.- Parameters:
nt
- the NonTerminal being output
-
reStart
void reStart(RegularExpression re)
Output start of regular expression.- Parameters:
re
- the RegularExpression being output
-
reEnd
void reEnd(RegularExpression re)
Output end of regular expression.- Parameters:
re
- the RegularExpression being output
-
debug
void debug(java.lang.String message)
Log debug messages.- Parameters:
message
- the string to log
-
info
void info(java.lang.String message)
Log informational messages.- Parameters:
message
- the string to log
-
warn
void warn(java.lang.String message)
Log warning messages.- Parameters:
message
- the string to log
-
error
void error(java.lang.String message)
Log error messages.- Parameters:
message
- the string to log
-
-