Class CSSTokenMaker

All Implemented Interfaces:
TokenMaker
Direct Known Subclasses:
LessTokenMaker

public class CSSTokenMaker extends AbstractJFlexCTokenMaker
This class splits up text into tokens representing a CSS 3 file. It's written with a few extra internal states so that it can easily be copy and pasted into HTML, PHP, and JSP TokenMarkers when it is updated.

This implementation was created using JFlex 1.4.1; however, the generated file was modified for performance. Memory allocation needs to be almost completely removed to be competitive with the handwritten lexers (subclasses of AbstractTokenMaker), so this class has been modified so that Strings are never allocated (via yytext()), and the scanner never has to worry about refilling its buffer (needlessly copying chars around). We can achieve this because RText always scans exactly 1 line of tokens at a time, and hands the scanner this line as an array of characters (a Segment really). Since tokens contain pointers to char arrays instead of Strings holding their contents, there is no need for allocating new memory for Strings.

The actual algorithm generated for scanning has, of course, not been modified.

If you wish to regenerate this file yourself, keep in mind the following:

  • The generated CSSTokenMaker.java file will contain 2 definitions of both zzRefill and yyreset. You should hand-delete the second of each definition (the ones generated by the lexer), as these generated methods modify the input buffer, which we'll never have to do.
  • You should also change the declaration/definition of zzBuffer to NOT be initialized. This is a needless memory allocation for us since we will be pointing the array somewhere else anyway.
  • You should NOT call yylex() on the generated scanner directly; rather, you should use getTokenList as you would with any other TokenMaker instance.
Version:
0.5
  • Field Details

    • YYEOF

      public static final int YYEOF
      This character denotes the end of file
      See Also:
    • CSS_C_STYLE_COMMENT

      public static final int CSS_C_STYLE_COMMENT
      lexical states
      See Also:
    • LESS_EOL_COMMENT

      public static final int LESS_EOL_COMMENT
      See Also:
    • YYINITIAL

      public static final int YYINITIAL
      See Also:
    • CSS_STRING

      public static final int CSS_STRING
      See Also:
    • CSS_VALUE

      public static final int CSS_VALUE
      See Also:
    • CSS_PROPERTY

      public static final int CSS_PROPERTY
      See Also:
    • CSS_CHAR_LITERAL

      public static final int CSS_CHAR_LITERAL
      See Also:
    • ZZ_CMAP_PACKED

      private static final String ZZ_CMAP_PACKED
      Translates characters to character classes
      See Also:
    • 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 String ZZ_ACTION_PACKED_0
      See Also:
    • 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 String ZZ_ROWMAP_PACKED_0
      See Also:
    • ZZ_TRANS

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

      private static final String ZZ_TRANS_PACKED_0
      See Also:
    • ZZ_UNKNOWN_ERROR

      private static final int ZZ_UNKNOWN_ERROR
      See Also:
    • ZZ_NO_MATCH

      private static final int ZZ_NO_MATCH
      See Also:
    • ZZ_PUSHBACK_2BIG

      private static final int ZZ_PUSHBACK_2BIG
      See Also:
    • ZZ_ERROR_MSG

      private static final 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 String ZZ_ATTRIBUTE_PACKED_0
      See Also:
    • zzReader

      private 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
    • zzAtEOF

      private boolean zzAtEOF
      zzAtEOF == true invalid input: '<'=> the scanner is at the EOF
    • INTERNAL_CSS_PROPERTY

      public static final int INTERNAL_CSS_PROPERTY
      Internal type denoting a line ending in a CSS property.
      See Also:
    • INTERNAL_CSS_VALUE

      public static final int INTERNAL_CSS_VALUE
      Internal type denoting a line ending in a CSS property value.
      See Also:
    • INTERNAL_CSS_STRING

      public static final int INTERNAL_CSS_STRING
      Internal type denoting line ending in a CSS double-quote string. The state to return to is embedded in the actual end token type.
      See Also:
    • INTERNAL_CSS_CHAR

      public static final int INTERNAL_CSS_CHAR
      Internal type denoting line ending in a CSS single-quote string. The state to return to is embedded in the actual end token type.
      See Also:
    • INTERNAL_CSS_MLC

      public static final int INTERNAL_CSS_MLC
      Internal type denoting line ending in a CSS multi-line comment. The state to return to is embedded in the actual end token type.
      See Also:
    • cssPrevState

      private int cssPrevState
      The state previous CSS-related state we were in before going into a CSS string, multi-line comment, etc.
    • highlightingLess

      private boolean highlightingLess
      Whether we are highlighting less instead of CSS.
  • Constructor Details

    • CSSTokenMaker

      public CSSTokenMaker()
      Constructor. This must be here because JFlex does not generate a no-parameter constructor.
    • CSSTokenMaker

      public CSSTokenMaker(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.
    • CSSTokenMaker

      public CSSTokenMaker(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 Details

    • zzUnpackAction

      private static int[] zzUnpackAction()
    • zzUnpackAction

      private static int zzUnpackAction(String packed, int offset, int[] result)
    • zzUnpackRowMap

      private static int[] zzUnpackRowMap()
    • zzUnpackRowMap

      private static int zzUnpackRowMap(String packed, int offset, int[] result)
    • zzUnpackTrans

      private static int[] zzUnpackTrans()
    • zzUnpackTrans

      private static int zzUnpackTrans(String packed, int offset, int[] result)
    • zzUnpackAttribute

      private static int[] zzUnpackAttribute()
    • zzUnpackAttribute

      private static int zzUnpackAttribute(String packed, int offset, int[] result)
    • addEndToken

      private void addEndToken(int tokenType)
      Adds the token specified to the current linked list of tokens as an "end token;" that is, at zzMarkedPos.
      Parameters:
      tokenType - The token's type.
    • addHyperlinkToken

      private void addHyperlinkToken(int start, int end, int tokenType)
      Adds the token specified to the current linked list of tokens.
      Parameters:
      tokenType - The token's type.
      See Also:
    • addToken

      private void addToken(int tokenType)
      Adds the token specified to the current linked list of tokens.
      Parameters:
      tokenType - The token's type.
    • addToken

      private void addToken(int start, int end, int tokenType)
      Adds the token specified to the current linked list of tokens.
      Parameters:
      tokenType - The token's type.
    • addToken

      public void addToken(char[] array, int start, int end, int tokenType, int startOffset)
      Adds the token specified to the current linked list of tokens.
      Specified by:
      addToken in interface TokenMaker
      Overrides:
      addToken in class TokenMakerBase
      Parameters:
      array - The character array.
      start - The starting offset in the array.
      end - The ending offset in the array.
      tokenType - The token's type.
      startOffset - The offset in the document at which this token occurs.
    • getClosestStandardTokenTypeForInternalType

      public int getClosestStandardTokenTypeForInternalType(int type)
      Returns the closest "standard" token type for a given "internal" token type (e.g. one whose value is < 0).
      Specified by:
      getClosestStandardTokenTypeForInternalType in interface TokenMaker
      Overrides:
      getClosestStandardTokenTypeForInternalType in class TokenMakerBase
      Parameters:
      type - The token type.
      Returns:
      The closest "standard" token type.
    • getCurlyBracesDenoteCodeBlocks

      public boolean getCurlyBracesDenoteCodeBlocks()
      Returns true since CSS uses curly braces.
      Returns:
      true always.
    • getLineCommentStartAndEnd

      public String[] getLineCommentStartAndEnd(int languageIndex)
      Description copied from interface: TokenMaker
      Returns the text to place at the beginning and end of a line to "comment" it in this programming language.
      Specified by:
      getLineCommentStartAndEnd in interface TokenMaker
      Overrides:
      getLineCommentStartAndEnd in class TokenMakerBase
      Parameters:
      languageIndex - The language index at the offset in question. Since some TokenMakers effectively have nested languages (such as JavaScript in HTML), this parameter tells the TokenMaker what sub-language to look at.
      Returns:
      The start and end strings to add to a line to "comment" it out. A null value for either means there is no string to add for that part. A value of null for the array means this language does not support commenting/uncommenting lines.
    • getMarkOccurrencesOfTokenType

      public boolean getMarkOccurrencesOfTokenType(int type)
      Description copied from class: TokenMakerBase
      Returns whether tokens of the specified type should have "mark occurrences" enabled for the current programming language. The default implementation returns true if type is TokenTypes.IDENTIFIER. Subclasses can override this method to support other token types, such as TokenTypes.VARIABLE.
      Specified by:
      getMarkOccurrencesOfTokenType in interface TokenMaker
      Overrides:
      getMarkOccurrencesOfTokenType in class AbstractJFlexCTokenMaker
      Parameters:
      type - The token type.
      Returns:
      Whether tokens of this type should have "mark occurrences" enabled.
    • getShouldIndentNextLineAfter

      public boolean getShouldIndentNextLineAfter(Token t)
      Description copied from class: TokenMakerBase
      The default implementation returns false always. Languages that wish to better support auto-indentation can override this method.
      Specified by:
      getShouldIndentNextLineAfter in interface TokenMaker
      Overrides:
      getShouldIndentNextLineAfter in class AbstractJFlexCTokenMaker
      Parameters:
      t - The token the previous line ends with.
      Returns:
      Whether the next line should be indented.
    • getTokenList

      public Token getTokenList(Segment text, int initialTokenType, int startOffset)
      Returns the first token in the linked list of tokens generated from text. This method must be implemented by subclasses so they can correctly implement syntax highlighting.
      Parameters:
      text - The text from which to get tokens.
      initialTokenType - The token type we should start with.
      startOffset - The offset into the document at which text starts.
      Returns:
      The first Token in a linked list representing the syntax highlighted text.
    • isIdentifierChar

      public boolean isIdentifierChar(int languageIndex, char ch)
      Overridden to accept letters, digits, underscores, and hyphens.
      Specified by:
      isIdentifierChar in interface TokenMaker
      Overrides:
      isIdentifierChar in class TokenMakerBase
      Parameters:
      languageIndex - The language index the character was found in.
      ch - The character.
      Returns:
      Whether the character could be part of an "identifier" token.
    • setHighlightingLess

      public void setHighlightingLess(boolean highlightingLess)
      Toggles whether we're highlighting less instead of just CSS.
      Parameters:
      highlightingLess - Whether we're highlighting less.
    • zzRefill

      private boolean zzRefill()
      Refills the input buffer.
      Returns:
      true if EOF was reached, otherwise false.
    • yyreset

      public final void yyreset(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 YY_INITIAL.
      Parameters:
      reader - the new input stream
    • zzUnpackCMap

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

      public final void yyclose() throws IOException
      Closes the input stream.
      Specified by:
      yyclose in class AbstractJFlexTokenMaker
      Throws:
      IOException - If an IO error occurs.
    • yystate

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

      public final void yybegin(int newState)
      Enters a new lexical state
      Specified by:
      yybegin in class AbstractJFlexTokenMaker
      Parameters:
      newState - the new lexical state
    • yytext

      public final String yytext()
      Returns the text matched by the current regular expression.
      Specified by:
      yytext in class AbstractJFlexTokenMaker
    • 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 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:
      IOException - if any I/O-Error occurs