IDocGenerator (parser-generator-cc 1.0.2 API)

All Known Implementing Classes:

BNFGenerator, HTMLGenerator, TextGenerator, XTextGenerator
```
public interface IDocGenerator
```
A report generator for a grammar.

Since:

11-Dec-2006

Author:

timp

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`cppcode(CodeProductionCpp cp)` Output comment from a production.
`default void`	`debug(String message)` Log debug messages.
`void`	`documentEnd()` Output document footer.
`void`	`documentStart()` Output document header.
`default void`	`doNothing(Object o)` Dummy method to ensure parameters are used...
`default void`	`error(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)`
`default void`	`info(String message)` Log informational messages.
`void`	`javacode(CodeProductionJava jp)` Output comment from a production.
`void`	`nonTerminalEnd(ExpNonTerminal nt)` Output end of non-terminal.
`void`	`nonterminalsEnd()` Output end of non-terminal.
`void`	`nonterminalsStart()` Output start of non-terminal.
`void`	`nonTerminalStart(ExpNonTerminal nt)` Output start of non-terminal.
`void`	`print(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(AbstractExpRegularExpression re)` Output end of regular expression.
`void`	`reStart(AbstractExpRegularExpression re)` Output start of regular expression.
`void`	`specialTokens(String s)` Output Special Tokens.
`void`	`text(String s)` Output string with entity substitution for brackets and ampersands.
`void`	`tokensEnd()` Output end of tokens.
`void`	`tokensStart()` Output start of tokens.
`default void`	`warn(String message)` Log warning messages.

- Method Detail
  - text
```
void text(String s)
```
    Output string with entity substitution for brackets and ampersands.
    
    Parameters:
    
    s - the String to output
  - print
```
void print(String s)
```
    Output String.
    
    Parameters:
    
    s - String to output
  - documentStart
```
void documentStart()
```
    Output document header.
  - documentEnd
```
void documentEnd()
```
    Output document footer.
  - specialTokens
```
void specialTokens(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(CodeProductionJava jp)
```
    Output comment from a production.
    
    Parameters:
    
    jp - the JavaCodeProduction to output
  - cppcode
```
void cppcode(CodeProductionCpp 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 output
    
    first - whether this is the first expansion
  - expansionEnd
```
void expansionEnd(Expansion e,
                  boolean first)
```
    Output end of Expansion.
    
    Parameters:
    
    e - Expansion being output
    
    first - whether this is the first expansion
  - nonTerminalStart
```
void nonTerminalStart(ExpNonTerminal nt)
```
    Output start of non-terminal.
    
    Parameters:
    
    nt - the NonTerminal being output
  - nonTerminalEnd
```
void nonTerminalEnd(ExpNonTerminal nt)
```
    Output end of non-terminal.
    
    Parameters:
    
    nt - the NonTerminal being output
  - reStart
```
void reStart(AbstractExpRegularExpression re)
```
    Output start of regular expression.
    
    Parameters:
    
    re - the RegularExpression being output
  - reEnd
```
void reEnd(AbstractExpRegularExpression re)
```
    Output end of regular expression.
    
    Parameters:
    
    re - the RegularExpression being output
  - debug
```
default void debug(String message)
```
    Log debug messages.
    
    Parameters:
    
    message - the string to log
  - info
```
default void info(String message)
```
    Log informational messages.
    
    Parameters:
    
    message - the string to log
  - warn
```
default void warn(String message)
```
    Log warning messages.
    
    Parameters:
    
    message - the string to log
  - error
```
default void error(String message)
```
    Log error messages.
    
    Parameters:
    
    message - the string to log
  - doNothing
```
default void doNothing(Object o)
```
    Dummy method to ensure parameters are used...
    
    Parameters:
    
    o - anything

Interface IDocGenerator

Method Summary

Method Detail

text

print

documentStart

documentEnd

specialTokens

handleTokenProduction

nonterminalsStart

nonterminalsEnd

tokensStart

tokensEnd

javacode

cppcode

productionStart

productionEnd

expansionStart

expansionEnd

nonTerminalStart

nonTerminalEnd

reStart

reEnd

debug

info

warn

error

doNothing