org.javacc.jjdoc.TextGenerator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-javacc-maven-plugin Show documentation
Show all versions of ph-javacc-maven-plugin Show documentation
Maven 3 Plugin for processing JavaCC grammar files.
/* Copyright (c) 2006, Sun Microsystems, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the Sun Microsystems, Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.javacc.jjdoc;
import java.io.PrintWriter;
import org.javacc.parser.Expansion;
import org.javacc.parser.JavaCodeProduction;
import org.javacc.parser.NonTerminal;
import org.javacc.parser.NormalProduction;
import org.javacc.parser.RegularExpression;
import org.javacc.parser.TokenProduction;
/**
* Output BNF in text format.
*/
public class TextGenerator implements Generator
{
protected PrintWriter ostr;
public TextGenerator ()
{}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#text(java.lang.String)
*/
public void text (final String s)
{
print (s);
}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#print(java.lang.String)
*/
public void print (final String s)
{
ostr.print (s);
}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#documentStart()
*/
public void documentStart ()
{
ostr = create_output_stream ();
ostr.print ("\nDOCUMENT START\n");
}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#documentEnd()
*/
public void documentEnd ()
{
ostr.print ("\nDOCUMENT END\n");
ostr.close ();
}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#specialTokens(java.lang.String)
*/
public void specialTokens (final String s)
{
ostr.print (s);
}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#nonterminalsStart()
*/
public void nonterminalsStart ()
{
text ("NON-TERMINALS\n");
}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#nonterminalsEnd()
*/
public void nonterminalsEnd ()
{}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#tokensStart()
*/
public void tokensStart ()
{
text ("TOKENS\n");
}
public void handleTokenProduction (final TokenProduction tp)
{
final String text = JJDoc.getStandardTokenProductionText (tp);
text (text);
}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#tokensEnd()
*/
public void tokensEnd ()
{}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#javacode(org.javacc.parser.JavaCodeProduction)
*/
public void javacode (final JavaCodeProduction jp)
{
productionStart (jp);
text ("java code");
productionEnd (jp);
}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#productionStart(org.javacc.parser.NormalProduction)
*/
public void productionStart (final NormalProduction np)
{
ostr.print ("\t" + np.getLhs () + "\t:=\t");
}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#productionEnd(org.javacc.parser.NormalProduction)
*/
public void productionEnd (final NormalProduction np)
{
ostr.print ("\n");
}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#expansionStart(org.javacc.parser.Expansion,
* boolean)
*/
public void expansionStart (final Expansion e, final boolean first)
{
if (!first)
{
ostr.print ("\n\t\t|\t");
}
}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#expansionEnd(org.javacc.parser.Expansion,
* boolean)
*/
public void expansionEnd (final Expansion e, final boolean first)
{}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#nonTerminalStart(org.javacc.parser.NonTerminal)
*/
public void nonTerminalStart (final NonTerminal nt)
{}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#nonTerminalEnd(org.javacc.parser.NonTerminal)
*/
public void nonTerminalEnd (final NonTerminal nt)
{}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#reStart(org.javacc.parser.RegularExpression)
*/
public void reStart (final RegularExpression r)
{}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#reEnd(org.javacc.parser.RegularExpression)
*/
public void reEnd (final RegularExpression r)
{}
/**
* 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.
*/
protected PrintWriter create_output_stream ()
{
if (JJDocOptions.getOutputFile ().equals (""))
{
if (JJDocGlobals.input_file.equals ("standard input"))
{
return new java.io.PrintWriter (new java.io.OutputStreamWriter (System.out));
}
else
{
String ext = ".html";
if (JJDocOptions.getText ())
{
ext = ".txt";
}
else
if (JJDocOptions.getXText ())
{
ext = ".xtext";
}
final int i = JJDocGlobals.input_file.lastIndexOf ('.');
if (i == -1)
{
JJDocGlobals.output_file = JJDocGlobals.input_file + ext;
}
else
{
final String suffix = JJDocGlobals.input_file.substring (i);
if (suffix.equals (ext))
{
JJDocGlobals.output_file = JJDocGlobals.input_file + ext;
}
else
{
JJDocGlobals.output_file = JJDocGlobals.input_file.substring (0, i) + ext;
}
}
}
}
else
{
JJDocGlobals.output_file = JJDocOptions.getOutputFile ();
}
try
{
ostr = new java.io.PrintWriter (new java.io.FileWriter (JJDocGlobals.output_file));
}
catch (final java.io.IOException e)
{
error ("JJDoc: can't open output stream on file " + JJDocGlobals.output_file + ". Using standard output.");
ostr = new java.io.PrintWriter (new java.io.OutputStreamWriter (System.out));
}
return ostr;
}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#debug(java.lang.String)
*/
public void debug (final String message)
{
System.err.println (message);
}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#info(java.lang.String)
*/
public void info (final String message)
{
System.err.println (message);
}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#warn(java.lang.String)
*/
public void warn (final String message)
{
System.err.println (message);
}
/**
* {@inheritDoc}
*
* @see org.javacc.jjdoc.Generator#error(java.lang.String)
*/
public void error (final String message)
{
System.err.println (message);
}
}