Class SourceCodeScanner

  • All Implemented Interfaces:
    TokenTypes

    class SourceCodeScanner
    extends java.lang.Object
    implements TokenTypes
    Scanner for the Java programming language.

    Version:
    0.1
    • Field Detail

      • YYEOF

        public static final int YYEOF
        This character denotes the end of file
        See Also:
        Constant Field Values
      • ZZ_BUFFERSIZE

        private static final int ZZ_BUFFERSIZE
        initial size of the lookahead buffer
        See Also:
        Constant Field Values
      • ZZ_CMAP_PACKED

        private static final java.lang.String ZZ_CMAP_PACKED
        Translates characters to character classes
        See Also:
        Constant Field Values
      • ZZ_CMAP

        private static final char[] ZZ_CMAP
        Translates characters to character classes
      • ZZ_ACTION

        private static final int[] ZZ_ACTION
        Translates DFA states to action switch labels.
      • ZZ_ACTION_PACKED_0

        private static final java.lang.String ZZ_ACTION_PACKED_0
        See Also:
        Constant Field Values
      • ZZ_ROWMAP

        private static final int[] ZZ_ROWMAP
        Translates a state to a row index in the transition table
      • ZZ_ROWMAP_PACKED_0

        private static final java.lang.String ZZ_ROWMAP_PACKED_0
        See Also:
        Constant Field Values
      • ZZ_TRANS

        private static final int[] ZZ_TRANS
        The transition table of the DFA
      • ZZ_TRANS_PACKED_0

        private static final java.lang.String ZZ_TRANS_PACKED_0
        See Also:
        Constant Field Values
      • ZZ_ERROR_MSG

        private static final java.lang.String[] ZZ_ERROR_MSG
      • ZZ_ATTRIBUTE

        private static final int[] ZZ_ATTRIBUTE
        ZZ_ATTRIBUTE[aState] contains the attributes of state aState
      • ZZ_ATTRIBUTE_PACKED_0

        private static final java.lang.String ZZ_ATTRIBUTE_PACKED_0
        See Also:
        Constant Field Values
      • zzReader

        private java.io.Reader zzReader
        the input device
      • zzState

        private int zzState
        the current state of the DFA
      • zzLexicalState

        private int zzLexicalState
        the current lexical state
      • zzBuffer

        private char[] zzBuffer
        this buffer contains the current text to be matched and is the source of the yytext() string
      • zzMarkedPos

        private int zzMarkedPos
        the textposition at the last accepting state
      • zzCurrentPos

        private int zzCurrentPos
        the current text position in the buffer
      • zzStartRead

        private int zzStartRead
        startRead marks the beginning of the yytext() string in the buffer
      • zzEndRead

        private int zzEndRead
        endRead marks the last character in the buffer, that has been read from input
      • yyline

        private int yyline
        number of newlines encountered up to the start of the matched text
      • yychar

        private int yychar
        the number of characters up to the start of the matched text
      • yycolumn

        private int yycolumn
        the number of characters from the last newline up to the start of the matched text
      • zzAtEOF

        private boolean zzAtEOF
        zzAtEOF == true <=> the scanner is at the EOF
      • returnComments

        private boolean returnComments
        Whether comments should be returned as tokens.
      • returnWhitespace

        private boolean returnWhitespace
        Whether whitespace should be returned as tokens.
      • keepLastDocComment

        private boolean keepLastDocComment
        Whether the last documentation comment parsed should be kept.
      • lastDocComment

        private java.lang.String lastDocComment
        The last documentation comment parsed, if that feature is enabled.
    • Constructor Detail

      • SourceCodeScanner

        SourceCodeScanner​(java.io.Reader in)
        Creates a new scanner There is also a java.io.InputStream version of this constructor.
        Parameters:
        in - the java.io.Reader to read input from.
      • SourceCodeScanner

        SourceCodeScanner​(java.io.InputStream in)
        Creates a new scanner. There is also java.io.Reader version of this constructor.
        Parameters:
        in - the java.io.Inputstream to read input from.
    • Method Detail

      • zzUnpackAction

        private static int[] zzUnpackAction()
      • zzUnpackAction

        private static int zzUnpackAction​(java.lang.String packed,
                                          int offset,
                                          int[] result)
      • zzUnpackRowMap

        private static int[] zzUnpackRowMap()
      • zzUnpackRowMap

        private static int zzUnpackRowMap​(java.lang.String packed,
                                          int offset,
                                          int[] result)
      • zzUnpackTrans

        private static int[] zzUnpackTrans()
      • zzUnpackTrans

        private static int zzUnpackTrans​(java.lang.String packed,
                                         int offset,
                                         int[] result)
      • zzUnpackAttribute

        private static int[] zzUnpackAttribute()
      • zzUnpackAttribute

        private static int zzUnpackAttribute​(java.lang.String packed,
                                             int offset,
                                             int[] result)
      • createToken

        private Token createToken​(int type)
      • createToken

        private Token createToken​(int type,
                                  boolean invalid)
      • getColumn

        public int getColumn()
        Returns the current column into the current line.
        Returns:
        The current column.
      • getLastDocComment

        public java.lang.String getLastDocComment()
        Returns the last documentation comment parsed, if this feature is enabled. The "last documentation comment" is cleared when this method returns.
        Returns:
        The last documentation comment parsed, or null if the feature is disabled.
        See Also:
        setKeepLastDocComment(boolean)
      • getLine

        public int getLine()
        Returns the current line into the document.
        Returns:
        The current line.
      • getOffset

        public int getOffset()
        Returns the current offset into the document.
        Returns:
        The offset.
      • getReturnComments

        public boolean getReturnComments()
        Returns whether comments are returned as tokens.
        Returns:
        Whether comments are returned as tokens.
        See Also:
        getReturnWhitespace()
      • getReturnWhitespace

        public boolean getReturnWhitespace()
        Returns whether whitespace is returned as tokens.
        Returns:
        Whether whitespace is returned as tokens.
        See Also:
        getReturnComments()
      • setKeepLastDocComment

        public void setKeepLastDocComment​(boolean keep)
        Sets whether the last documentation comment should be kept.
        Parameters:
        keep - Whether to keep the last documentation comment.
        See Also:
        getLastDocComment()
      • setReturnComments

        public void setReturnComments​(boolean returnComments)
        Sets whether comments are returned as tokens.
        Parameters:
        returnComments - Whether comments should be returned as tokens.
        See Also:
        getReturnComments(), setReturnWhitespace(boolean)
      • setReturnWhitespace

        public void setReturnWhitespace​(boolean returnWhitespace)
        Sets whether whitespace is returned as tokens.
        Parameters:
        returnWhitespace - Whether whitespace should be returned as tokens.
        See Also:
        getReturnWhitespace(), setReturnComments(boolean)
      • zzUnpackCMap

        private static char[] zzUnpackCMap​(java.lang.String packed)
        Unpacks the compressed character translation table.
        Parameters:
        packed - the packed character translation table
        Returns:
        the unpacked character translation table
      • zzRefill

        private boolean zzRefill()
                          throws java.io.IOException
        Refills the input buffer.
        Returns:
        false, iff there was new input.
        Throws:
        java.io.IOException - if any I/O-Error occurs
      • yyclose

        public final void yyclose()
                           throws java.io.IOException
        Closes the input stream.
        Throws:
        java.io.IOException
      • yyreset

        public final void yyreset​(java.io.Reader reader)
        Resets the scanner to read from a new input stream. Does not close the old reader. All internal variables are reset, the old input stream cannot be reused (internal buffer is discarded and lost). Lexical state is set to ZZ_INITIAL.
        Parameters:
        reader - the new input stream
      • yystate

        public final int yystate()
        Returns the current lexical state.
      • yybegin

        public final void yybegin​(int newState)
        Enters a new lexical state
        Parameters:
        newState - the new lexical state
      • yytext

        public final java.lang.String yytext()
        Returns the text matched by the current regular expression.
      • yycharat

        public final char yycharat​(int pos)
        Returns the character at position pos from the matched text. It is equivalent to yytext().charAt(pos), but faster
        Parameters:
        pos - the position of the character to fetch. A value from 0 to yylength()-1.
        Returns:
        the character at position pos
      • yylength

        public final int yylength()
        Returns the length of the matched text region.
      • zzScanError

        private void zzScanError​(int errorCode)
        Reports an error that occured while scanning. In a wellformed scanner (no or only correct usage of yypushback(int) and a match-all fallback rule) this method will only be called with things that "Can't Possibly Happen". If this method is called, something is seriously wrong (e.g. a JFlex bug producing a faulty scanner etc.). Usual syntax/scanner level error handling should be done in error fallback rules.
        Parameters:
        errorCode - the code of the errormessage to display
      • yypushback

        public void yypushback​(int number)
        Pushes the specified amount of characters back into the input stream. They will be read again by then next call of the scanning method
        Parameters:
        number - the number of characters to be read again. This number must not be greater than yylength()!
      • yylex

        public Token yylex()
                    throws java.io.IOException
        Resumes scanning until the next regular expression is matched, the end of input is encountered or an I/O-Error occurs.
        Returns:
        the next token
        Throws:
        java.io.IOException - if any I/O-Error occurs