Package org.javacc.jjdoc

Class TextGenerator

java.lang.Object

org.javacc.jjdoc.TextGenerator

All Implemented Interfaces:

Generator

Direct Known Subclasses:

HTMLGenerator, XTextGenerator

public class TextGenerator
extends Object
implements Generator

Output BNF in text format.

Field Summary

Fields

Modifier and Type	Field	Description
protected PrintWriter	ostr

Constructor Summary

Constructors

Constructor	Description
TextGenerator()

Method Summary

Modifier and Type	Method	Description
void	cppcode(CppCodeProduction cp)	Output comment from a production.
protected PrintWriter	create_output_stream()	Create an output stream for the generated Jack code.
void	debug(String message)	Log debug messages.
void	documentEnd()	Output document footer.
void	documentStart()	Output document header.
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)
void	info(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(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 r)	Output end of regular expression.
void	reStart(RegularExpression r)	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.
void	warn(String message)	Log warning messages.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ostr

protected PrintWriter ostr

Constructor Details

TextGenerator

public TextGenerator()

Method Details

text

public void text(String s)

Output string with entity substitution for brackets and ampersands.

Specified by:

text in interface Generator

Parameters:

s - the String to output

See Also:

• Generator.text(java.lang.String)

print

public void print(String s)

Output String.

Specified by:

print in interface Generator

Parameters:

s - String to output

See Also:

• Generator.print(java.lang.String)

documentStart

public void documentStart()

Output document header.

Specified by:

documentStart in interface Generator

See Also:

• Generator.documentStart()

documentEnd

public void documentEnd()

Output document footer.

Specified by:

documentEnd in interface Generator

See Also:

• Generator.documentEnd()

specialTokens

public void specialTokens(String s)

Output Special Tokens.

Specified by:

specialTokens in interface Generator

Parameters:

s - tokens to output

See Also:

• Generator.specialTokens(java.lang.String)

nonterminalsStart

public void nonterminalsStart()

Output start of non-terminal.

Specified by:

nonterminalsStart in interface Generator

See Also:

• Generator.nonterminalsStart()

nonterminalsEnd

public void nonterminalsEnd()

Output end of non-terminal.

Specified by:

nonterminalsEnd in interface Generator

See Also:

• Generator.nonterminalsEnd()

tokensStart

public void tokensStart()

Output start of tokens.

Specified by:

tokensStart in interface Generator

See Also:

• Generator.tokensStart()

handleTokenProduction

public void handleTokenProduction(TokenProduction tp)

Specified by:

handleTokenProduction in interface Generator

tokensEnd

public void tokensEnd()

Output end of tokens.

Specified by:

tokensEnd in interface Generator

See Also:

• Generator.tokensEnd()

javacode

public void javacode(JavaCodeProduction jp)

Output comment from a production.

Specified by:

javacode in interface Generator

Parameters:

jp - the JavaCodeProduction to output

See Also:

• Generator.javacode(org.javacc.parser.JavaCodeProduction)

cppcode

public void cppcode(CppCodeProduction cp)

Output comment from a production.

Specified by:

cppcode in interface Generator

Parameters:

cp - the CppCodeProduction to output

See Also:

• Generator.cppcode(org.javacc.parser.CppCodeProduction)

productionStart

public void productionStart(NormalProduction np)

Output start of a normal production.

Specified by:

productionStart in interface Generator

Parameters:

np - the NormalProduction being output

See Also:

• Generator.productionStart(org.javacc.parser.NormalProduction)

productionEnd

public void productionEnd(NormalProduction np)

Output end of a normal production.

Specified by:

productionEnd in interface Generator

Parameters:

np - the NormalProduction being output

See Also:

• Generator.productionEnd(org.javacc.parser.NormalProduction)

expansionStart

public void expansionStart(Expansion e,
 boolean first)

Output start of an Expansion.

Specified by:

expansionStart in interface Generator

Parameters:

e - Expansion being output

first - whether this is the first expansion

See Also:

• Generator.expansionStart(org.javacc.parser.Expansion, boolean)

expansionEnd

public void expansionEnd(Expansion e,
 boolean first)

Output end of Expansion.

Specified by:

expansionEnd in interface Generator

Parameters:

e - Expansion being output

first - whether this is the first expansion

See Also:

• Generator.expansionEnd(org.javacc.parser.Expansion, boolean)

nonTerminalStart

public void nonTerminalStart(NonTerminal nt)

Output start of non-terminal.

Specified by:

nonTerminalStart in interface Generator

Parameters:

nt - the NonTerminal being output

See Also:

• Generator.nonTerminalStart(org.javacc.parser.NonTerminal)

nonTerminalEnd

public void nonTerminalEnd(NonTerminal nt)

Output end of non-terminal.

Specified by:

nonTerminalEnd in interface Generator

Parameters:

nt - the NonTerminal being output

See Also:

• Generator.nonTerminalEnd(org.javacc.parser.NonTerminal)

reStart

public void reStart(RegularExpression r)

Output start of regular expression.

Specified by:

reStart in interface Generator

Parameters:

r - the RegularExpression being output

See Also:

• Generator.reStart(org.javacc.parser.RegularExpression)

reEnd

public void reEnd(RegularExpression r)

Output end of regular expression.

Specified by:

reEnd in interface Generator

Parameters:

r - the RegularExpression being output

See Also:

• Generator.reEnd(org.javacc.parser.RegularExpression)

create_output_stream

protected PrintWriter create_output_stream()

Create an output stream for the generated Jack code. Try to open a file based on the name of the parser, but if that fails use the standard output stream.

debug

public void debug(String message)

Log debug messages.

Specified by:

debug in interface Generator

Parameters:

message - the string to log

See Also:

• Generator.debug(java.lang.String)

info

public void info(String message)

Log informational messages.

Specified by:

info in interface Generator

Parameters:

message - the string to log

See Also:

• Generator.info(java.lang.String)

warn

public void warn(String message)

Log warning messages.

Specified by:

warn in interface Generator

Parameters:

message - the string to log

See Also:

• Generator.warn(java.lang.String)

error

public void error(String message)

Log error messages.

Specified by:

error in interface Generator

Parameters:

message - the string to log

See Also:

• Generator.error(java.lang.String)