com.helger.pgcc.jjdoc

Interface IDocGenerator

All Superinterfaces:

Serializable

All Known Implementing Classes:

BNFGenerator, HTMLGenerator, TextGenerator, XTextGenerator

public interface IDocGenerator
extends Serializable

A report generator for a grammar.

Since:

11-Dec-2006

Author:

timp

Method Summary

Modifier and Type	Method and Description
void	cppcode(CodeProductionCpp cp) Output comment from a production.
void	documentEnd() Output document footer.
void	documentStart() Output document header.
default void	doNothing(Object o) Dummy method to ensure parameters are used...
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	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.

Method Detail

text

void text(String s)
   throws IOException

Output string with entity substitution for brackets and ampersands.

Parameters:

s - the String to output

Throws:

IOException - on IO error

print

void print(String s)
    throws IOException

Output String.

Parameters:

s - String to output

Throws:

IOException - on IO error

documentStart

void documentStart()
            throws IOException

Output document header.

Throws:

IOException - on IO error

documentEnd

void documentEnd()
          throws IOException

Output document footer.

Throws:

IOException - on IO error

specialTokens

void specialTokens(String s)
            throws IOException

Output Special Tokens.

Parameters:

s - tokens to output

Throws:

IOException - on IO error

handleTokenProduction

void handleTokenProduction(TokenProduction tp)
                    throws IOException

Throws:

IOException

nonterminalsStart

void nonterminalsStart()
                throws IOException

Output start of non-terminal.

Throws:

IOException - on IO error

nonterminalsEnd

void nonterminalsEnd()
              throws IOException

Output end of non-terminal.

Throws:

IOException - on IO error

tokensStart

void tokensStart()
          throws IOException

Output start of tokens.

Throws:

IOException - on IO error

tokensEnd

void tokensEnd()
        throws IOException

Output end of tokens.

Throws:

IOException - on IO error

javacode

void javacode(CodeProductionJava jp)
       throws IOException

Output comment from a production.

Parameters:

jp - the JavaCodeProduction to output

Throws:

IOException - on IO error

cppcode

void cppcode(CodeProductionCpp cp)
      throws IOException

Output comment from a production.

Parameters:

cp - the CppCodeProduction to output

Throws:

IOException - on IO error

productionStart

void productionStart(NormalProduction np)
              throws IOException

Output start of a normal production.

Parameters:

np - the NormalProduction being output

Throws:

IOException - on IO error

productionEnd

void productionEnd(NormalProduction np)
            throws IOException

Output end of a normal production.

Parameters:

np - the NormalProduction being output

Throws:

IOException - on IO error

expansionStart

void expansionStart(Expansion e,
                    boolean first)
             throws IOException

Output start of an Expansion.

Parameters:

e - Expansion being output

first - whether this is the first expansion

Throws:

IOException - on IO error

expansionEnd

void expansionEnd(Expansion e,
                  boolean first)
           throws IOException

Output end of Expansion.

Parameters:

e - Expansion being output

first - whether this is the first expansion

Throws:

IOException - on IO error

nonTerminalStart

void nonTerminalStart(ExpNonTerminal nt)
               throws IOException

Output start of non-terminal.

Parameters:

nt - the NonTerminal being output

Throws:

IOException - on IO error

nonTerminalEnd

void nonTerminalEnd(ExpNonTerminal nt)
             throws IOException

Output end of non-terminal.

Parameters:

nt - the NonTerminal being output

Throws:

IOException - on IO error

reStart

void reStart(AbstractExpRegularExpression re)
      throws IOException

Output start of regular expression.

Parameters:

re - the RegularExpression being output

Throws:

IOException - on IO error

reEnd

void reEnd(AbstractExpRegularExpression re)
    throws IOException

Output end of regular expression.

Parameters:

re - the RegularExpression being output

Throws:

IOException - on IO error

doNothing

default void doNothing(Object o)

Dummy method to ensure parameters are used...

Parameters:

o - anything