/* 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 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;

/**
 * A report generator for a grammar.
 * @author timp
 * @since 11-Dec-2006
 *
 */
public interface Generator {

  /**
   * Output string with entity substitution for brackets and ampersands.
   * @param s the String to output
   */
  public abstract void text(String s);

  /**
   * Output String.
   * @param s String to output
   */
  public abstract void print(String s);

  /**
   * Output document header.
   */
  public abstract void documentStart();

  /**
   * Output document footer.
   */
  public abstract void documentEnd();

  /**
   * Output Special Tokens. 
   * @param s tokens to output 
   */
  public abstract void specialTokens(String s);

  /**
   * Output start of a TokenProduction.
   * @param tp the TokenProduction being output
   */
  public abstract void tokenStart(TokenProduction tp);

  /**
   * Output end of a TokenProduction.
   * @param tp the TokenProduction being output
   */
  public abstract void tokenEnd(TokenProduction tp);

  /**
   * Output start of non-terminal. 
   */
  public abstract void nonterminalsStart();

  /**
   * Output end of non-terminal. 
   */
  public abstract void nonterminalsEnd();

  /**
   * Output start of tokens.
   */
  public abstract void tokensStart();

  /**
   * Output end of tokens.
   */
  public abstract void tokensEnd();

  /**
   * Output comment from a production. 
   * @param jp the JavaCodeProduction to output
   */
  public abstract void javacode(JavaCodeProduction jp);

  /**
   * Output start of a normal production.
   * @param np the NormalProduction being output
   */
  public abstract void productionStart(NormalProduction np);

  /**
   * Output end of a normal production.
   * @param np the NormalProduction being output
   */
  public abstract void productionEnd(NormalProduction np);

  /**
   * Output start of an Expansion.
   * @param e Expansion being output
   * @param first whether this is the first expansion
   */
  public abstract void expansionStart(Expansion e, boolean first);

  /**
   * Output end of Expansion.
   * @param e Expansion being output
   * @param first whether this is the first expansion
   */
  public abstract void expansionEnd(Expansion e, boolean first);

  /**
   * Output start of non-terminal.
   * @param nt the NonTerminal being output
   */
  public abstract void nonTerminalStart(NonTerminal nt);

  /**
   * Output end of non-terminal.
   * @param nt the NonTerminal being output
   */
  public abstract void nonTerminalEnd(NonTerminal nt);

  /**
   * Output start of regular expression.
   * @param re the RegularExpression being output
   */
  public abstract void reStart(RegularExpression re);

  /**
   * Output end of regular expression.
   * @param re the RegularExpression being output
   */
  public abstract void reEnd(RegularExpression re);

}

@@ -2123,32 +2123,16 @@
    */%0A  
-public abstract 
 void tex
@@ -2136,32 +2136,32 @@
 text(String s);%0A
+
 %0A  /**%0A   * Outp
@@ -2210,32 +2210,16 @@
    */%0A  
-public abstract 
 void pri
@@ -2276,32 +2276,16 @@
    */%0A  
-public abstract 
 void doc
@@ -2342,32 +2342,16 @@
    */%0A  
-public abstract 
 void doc
@@ -2438,32 +2438,16 @@
    */%0A  
-public abstract 
 void spe
@@ -2571,32 +2571,16 @@
    */%0A  
-public abstract 
 void tok
@@ -2709,32 +2709,16 @@
    */%0A  
-public abstract 
 void tok
@@ -2795,32 +2795,16 @@
    */%0A  
-public abstract 
 void non
@@ -2870,32 +2870,16 @@
    */%0A  
-public abstract 
 void non
@@ -2938,32 +2938,16 @@
    */%0A  
-public abstract 
 void tok
@@ -3000,32 +3000,16 @@
    */%0A  
-public abstract 
 void tok
@@ -3121,32 +3121,16 @@
    */%0A  
-public abstract 
 void jav
@@ -3265,32 +3265,16 @@
    */%0A  
-public abstract 
 void pro
@@ -3412,32 +3412,16 @@
    */%0A  
-public abstract 
 void pro
@@ -3594,32 +3594,16 @@
    */%0A  
-public abstract 
 void exp
@@ -3779,32 +3779,16 @@
    */%0A  
-public abstract 
 void exp
@@ -3920,32 +3920,16 @@
    */%0A  
-public abstract 
 void non
@@ -4051,32 +4051,16 @@
    */%0A  
-public abstract 
 void non
@@ -4194,32 +4194,16 @@
    */%0A  
-public abstract 
 void reS
@@ -4336,26 +4336,10 @@
  */%0A
+
   
-public abstract 
 void

Remove redundant public abstract