Jalopy 1.0b11

de.hunsicker.jalopy.language
Class JavadocParser

java.lang.Object
  extended byde.hunsicker.antlr.Parser
      extended byde.hunsicker.antlr.LLkParser
          extended byde.hunsicker.jalopy.language.JavadocParser
All Implemented Interfaces:
Parser

public final class JavadocParser
extends de.hunsicker.antlr.LLkParser
implements Parser

Parser for Javadoc comments.

Sample Usage:

 
// an input source Reader in = new BufferedReader(new FileReader(new File(argv[0]))); // create a lexer Lexer lexer = new JavadocLexer(); // set up the lexer to read from the input source lexer.setInputBuffer(in); // get the corresponding parser Parser parser = lexer.getParser(); // and start the parsing process parser.parse();

This is an ANTLR automated generated file. DO NOT EDIT but rather change the associated grammar (java.doc.g) and rebuild.

Version:
1.0
Author:
Marco Hunsicker
See Also:
JavadocLexer, Recognizer

Field Summary
static java.lang.String[] _tokenNames
           
static Node EMPTY_JAVADOC_COMMENT
          The empty Javadoc comment.
 
Fields inherited from class de.hunsicker.antlr.Parser
astFactory, inputState, returnAST, tokenNames, traceDepth
 
Constructor Summary
  JavadocParser(de.hunsicker.antlr.ParserSharedInputState state)
           
  JavadocParser(de.hunsicker.antlr.TokenBuffer tokenBuf)
           
protected JavadocParser(de.hunsicker.antlr.TokenBuffer tokenBuf, int k)
           
  JavadocParser(de.hunsicker.antlr.TokenStream lexer)
           
protected JavadocParser(de.hunsicker.antlr.TokenStream lexer, int k)
           
 
Method Summary
 void acronym()
           
 void address()
           
 void anchor_content()
           
 void anchor()
           
 void big()
           
 void block()
           
 void blockquote()
           
 void body_content()
           
 void body_tag()
           
 void bold()
           
 void caption()
           
 void center()
           
 void citation()
           
 void code()
           
 void dd()
           
 void def_list_item()
           
 void def_list()
           
 void definition()
           
 void dir()
           
 void div()
           
 void dt()
           
 void emphasize()
           
 void font_dfn()
           
 void font()
           
 de.hunsicker.antlr.collections.AST getParseTree()
          Returns the root node of the generated parse tree.
 void h1()
           
 void h2()
           
 void h3()
           
 void h4()
           
 void h5()
           
 void h6()
           
 void handleRecoverableError(de.hunsicker.antlr.RecognitionException ex)
          Handler for recoverable errors.
 void heading_content()
           
 void heading()
           
 void inline_tag()
           
 void italic()
           
 void keyboard()
           
 void list_item()
           
 void list()
           
 void ordered_list()
           
 void paragraph()
           
 void parse()
          Start parsing.
 void phrase()
           
 void preformatted()
           
 void reportError(de.hunsicker.antlr.RecognitionException ex)
          Reports the given error.
 void reportError(java.lang.String message)
          Reports the given error.
 void reportWarning(java.lang.String message)
          Reports the given warning.
 void reset()
          Resets the parser.
 void sample()
           
 void setCustomInlineTags(java.util.Collection tags)
          Sets the custom Javadoc in-line tags to recognize.
 void setCustomStandardTags(java.util.Collection tags)
          Sets the custom Javadoc standard tags to recognize.
 void setLexer(JavadocLexer lexer)
          Sets the corresponding Javadoc lexer for the parser.
 void small()
           
 void special()
           
 void standard_tag()
           
 void strike()
           
 void strong()
           
 void subscript()
           
 void superscript()
           
 void table()
           
 void teletype()
           
 void text_tag()
           
 void text()
           
 void th_or_td()
           
 void tr()
           
 void underline()
           
 void unordered_list()
           
 void variable()
           
 
Methods inherited from class de.hunsicker.antlr.LLkParser
consume, LA, LT, traceIn, traceOut
 
Methods inherited from class de.hunsicker.antlr.Parser
addMessageListener, addParserListener, addParserMatchListener, addParserTokenListener, addSemanticPredicateListener, addSyntacticPredicateListener, addTraceListener, consumeUntil, consumeUntil, defaultDebuggingSetup, getAST, getASTFactory, getFilename, getInputState, getTokenName, getTokenNames, isDebugMode, mark, match, match, matchNot, panic, removeMessageListener, removeParserListener, removeParserMatchListener, removeParserTokenListener, removeSemanticPredicateListener, removeSyntacticPredicateListener, removeTraceListener, rewind, setASTFactory, setASTNodeClass, setASTNodeType, setDebugMode, setFilename, setIgnoreInvalidDebugCalls, setInputState, setTokenBuffer, traceIndent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface de.hunsicker.jalopy.language.Parser
getASTFactory, getFilename, getTokenNames, setASTFactory, setFilename, setTokenBuffer
 

Field Detail

EMPTY_JAVADOC_COMMENT

public static final Node EMPTY_JAVADOC_COMMENT
The empty Javadoc comment.


_tokenNames

public static final java.lang.String[] _tokenNames
Constructor Detail

JavadocParser

protected JavadocParser(de.hunsicker.antlr.TokenBuffer tokenBuf,
                        int k)

JavadocParser

public JavadocParser(de.hunsicker.antlr.TokenBuffer tokenBuf)

JavadocParser

protected JavadocParser(de.hunsicker.antlr.TokenStream lexer,
                        int k)

JavadocParser

public JavadocParser(de.hunsicker.antlr.TokenStream lexer)

JavadocParser

public JavadocParser(de.hunsicker.antlr.ParserSharedInputState state)
Method Detail

setLexer

public void setLexer(JavadocLexer lexer)
Sets the corresponding Javadoc lexer for the parser.

Parameters:
lexer - corresponding Javadoc lexer.

setCustomStandardTags

public void setCustomStandardTags(java.util.Collection tags)
Sets the custom Javadoc standard tags to recognize.

Parameters:
tags - tags.

setCustomInlineTags

public void setCustomInlineTags(java.util.Collection tags)
Sets the custom Javadoc in-line tags to recognize.

Parameters:
tags - tags.

reset

public void reset()
Resets the parser.

Specified by:
reset in interface Parser

getParseTree

public de.hunsicker.antlr.collections.AST getParseTree()
Description copied from interface: Parser
Returns the root node of the generated parse tree.

Specified by:
getParseTree in interface Parser
Returns:
root node of the generated parse tree.

reportError

public void reportError(de.hunsicker.antlr.RecognitionException ex)
Reports the given error.

Parameters:
ex - encountered exception.

reportError

public void reportError(java.lang.String message)
Reports the given error.

Parameters:
message - error message.

reportWarning

public void reportWarning(java.lang.String message)
Reports the given warning.

Parameters:
message - warning message.

handleRecoverableError

public void handleRecoverableError(de.hunsicker.antlr.RecognitionException ex)
Handler for recoverable errors. If the error can't be handled it will be rethrown.

Parameters:
ex - the input violation exception.

parse

public final void parse()
                 throws de.hunsicker.antlr.RecognitionException,
                        de.hunsicker.antlr.TokenStreamException
Description copied from interface: Parser
Start parsing.

Specified by:
parse in interface Parser
Throws:
de.hunsicker.antlr.RecognitionException - if a problem with the input occured.
de.hunsicker.antlr.TokenStreamException - if something went wrong while generating the stream of tokens.

body_content

public final void body_content()
                        throws de.hunsicker.antlr.RecognitionException,
                               de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

standard_tag

public final void standard_tag()
                        throws de.hunsicker.antlr.RecognitionException,
                               de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

body_tag

public final void body_tag()
                    throws de.hunsicker.antlr.RecognitionException,
                           de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

text

public final void text()
                throws de.hunsicker.antlr.RecognitionException,
                       de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

block

public final void block()
                 throws de.hunsicker.antlr.RecognitionException,
                        de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

address

public final void address()
                   throws de.hunsicker.antlr.RecognitionException,
                          de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

heading

public final void heading()
                   throws de.hunsicker.antlr.RecognitionException,
                          de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

h1

public final void h1()
              throws de.hunsicker.antlr.RecognitionException,
                     de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

h2

public final void h2()
              throws de.hunsicker.antlr.RecognitionException,
                     de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

h3

public final void h3()
              throws de.hunsicker.antlr.RecognitionException,
                     de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

h4

public final void h4()
              throws de.hunsicker.antlr.RecognitionException,
                     de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

h5

public final void h5()
              throws de.hunsicker.antlr.RecognitionException,
                     de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

h6

public final void h6()
              throws de.hunsicker.antlr.RecognitionException,
                     de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

paragraph

public final void paragraph()
                     throws de.hunsicker.antlr.RecognitionException,
                            de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

list

public final void list()
                throws de.hunsicker.antlr.RecognitionException,
                       de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

preformatted

public final void preformatted()
                        throws de.hunsicker.antlr.RecognitionException,
                               de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

div

public final void div()
               throws de.hunsicker.antlr.RecognitionException,
                      de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

center

public final void center()
                  throws de.hunsicker.antlr.RecognitionException,
                         de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

blockquote

public final void blockquote()
                      throws de.hunsicker.antlr.RecognitionException,
                             de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

table

public final void table()
                 throws de.hunsicker.antlr.RecognitionException,
                        de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

font

public final void font()
                throws de.hunsicker.antlr.RecognitionException,
                       de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

teletype

public final void teletype()
                    throws de.hunsicker.antlr.RecognitionException,
                           de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

italic

public final void italic()
                  throws de.hunsicker.antlr.RecognitionException,
                         de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

bold

public final void bold()
                throws de.hunsicker.antlr.RecognitionException,
                       de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

underline

public final void underline()
                     throws de.hunsicker.antlr.RecognitionException,
                            de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

strike

public final void strike()
                  throws de.hunsicker.antlr.RecognitionException,
                         de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

big

public final void big()
               throws de.hunsicker.antlr.RecognitionException,
                      de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

small

public final void small()
                 throws de.hunsicker.antlr.RecognitionException,
                        de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

subscript

public final void subscript()
                     throws de.hunsicker.antlr.RecognitionException,
                            de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

superscript

public final void superscript()
                       throws de.hunsicker.antlr.RecognitionException,
                              de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

phrase

public final void phrase()
                  throws de.hunsicker.antlr.RecognitionException,
                         de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

emphasize

public final void emphasize()
                     throws de.hunsicker.antlr.RecognitionException,
                            de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

strong

public final void strong()
                  throws de.hunsicker.antlr.RecognitionException,
                         de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

definition

public final void definition()
                      throws de.hunsicker.antlr.RecognitionException,
                             de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

code

public final void code()
                throws de.hunsicker.antlr.RecognitionException,
                       de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

sample

public final void sample()
                  throws de.hunsicker.antlr.RecognitionException,
                         de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

keyboard

public final void keyboard()
                    throws de.hunsicker.antlr.RecognitionException,
                           de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

variable

public final void variable()
                    throws de.hunsicker.antlr.RecognitionException,
                           de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

citation

public final void citation()
                    throws de.hunsicker.antlr.RecognitionException,
                           de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

acronym

public final void acronym()
                   throws de.hunsicker.antlr.RecognitionException,
                          de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

special

public final void special()
                   throws de.hunsicker.antlr.RecognitionException,
                          de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

anchor

public final void anchor()
                  throws de.hunsicker.antlr.RecognitionException,
                         de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

font_dfn

public final void font_dfn()
                    throws de.hunsicker.antlr.RecognitionException,
                           de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

text_tag

public final void text_tag()
                    throws de.hunsicker.antlr.RecognitionException,
                           de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

inline_tag

public final void inline_tag()
                      throws de.hunsicker.antlr.RecognitionException,
                             de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

heading_content

public final void heading_content()
                           throws de.hunsicker.antlr.RecognitionException,
                                  de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

unordered_list

public final void unordered_list()
                          throws de.hunsicker.antlr.RecognitionException,
                                 de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

ordered_list

public final void ordered_list()
                        throws de.hunsicker.antlr.RecognitionException,
                               de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

def_list

public final void def_list()
                    throws de.hunsicker.antlr.RecognitionException,
                           de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

list_item

public final void list_item()
                     throws de.hunsicker.antlr.RecognitionException,
                            de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

def_list_item

public final void def_list_item()
                         throws de.hunsicker.antlr.RecognitionException,
                                de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

dt

public final void dt()
              throws de.hunsicker.antlr.RecognitionException,
                     de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

dd

public final void dd()
              throws de.hunsicker.antlr.RecognitionException,
                     de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

dir

public final void dir()
               throws de.hunsicker.antlr.RecognitionException,
                      de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

caption

public final void caption()
                   throws de.hunsicker.antlr.RecognitionException,
                          de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

tr

public final void tr()
              throws de.hunsicker.antlr.RecognitionException,
                     de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

th_or_td

public final void th_or_td()
                    throws de.hunsicker.antlr.RecognitionException,
                           de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

anchor_content

public final void anchor_content()
                          throws de.hunsicker.antlr.RecognitionException,
                                 de.hunsicker.antlr.TokenStreamException
Throws:
de.hunsicker.antlr.RecognitionException
de.hunsicker.antlr.TokenStreamException

Jalopy 1.0b11

Submit a bug or feature.

For further information and documentation, visit the official Jalopy website.
This page generated: November 13 2003