org.fife.ui.rsyntaxtextarea.modes
Class CSSTokenMaker

java.lang.Object
  org.fife.ui.rsyntaxtextarea.TokenMakerBase
      org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker
          org.fife.ui.rsyntaxtextarea.AbstractJFlexCTokenMaker
              org.fife.ui.rsyntaxtextarea.modes.CSSTokenMaker

All Implemented Interfaces:

TokenMaker

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 TokenMakres 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.

Nested Class Summary

Nested classes/interfaces inherited from class org.fife.ui.rsyntaxtextarea.AbstractJFlexCTokenMaker

AbstractJFlexCTokenMaker.CStyleInsertBreakAction

Field Summary

static int	CSS_C_STYLE_COMMENT lexical states
static int	CSS_CHAR_LITERAL
static int	CSS_PROPERTY
static int	CSS_STRING
static int	CSS_VALUE
static int	INTERNAL_CSS_CHAR Internal type denoting line ending in a CSS single-quote string.
static int	INTERNAL_CSS_MLC Internal type denoting line ending in a CSS multi-line comment.
static int	INTERNAL_CSS_PROPERTY Internal type denoting a line ending in a CSS property.
static int	INTERNAL_CSS_STRING Internal type denoting line ending in a CSS double-quote string.
static int	INTERNAL_CSS_VALUE Internal type denoting a line ending in a CSS property value.
static int	YYEOF This character denotes the end of file
static int	YYINITIAL

Fields inherited from class org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker

offsetShift, s, start

Fields inherited from class org.fife.ui.rsyntaxtextarea.TokenMakerBase

currentToken, firstToken, previousToken

Constructor Summary

CSSTokenMaker()
Constructor.

CSSTokenMaker(java.io.InputStream in)
Creates a new scanner.

CSSTokenMaker(java.io.Reader in)
Creates a new scanner There is also a java.io.InputStream version of this constructor.

Method Summary

void	addToken(char[] array, int start, int end, int tokenType, int startOffset) Adds the token specified to the current linked list of tokens.
int	getClosestStandardTokenTypeForInternalType(int type) Returns the closest "standard" token type for a given "internal" token type (e.g.
boolean	getCurlyBracesDenoteCodeBlocks() Returns true since CSS uses curly braces.
boolean	getMarkOccurrencesOfTokenType(int type) Returns whether tokens of the specified type should have "mark occurrences" enabled for the current programming language.
boolean	getShouldIndentNextLineAfter(Token t) The default implementation returns false always.
Token	getTokenList(javax.swing.text.Segment text, int initialTokenType, int startOffset) Returns the first token in the linked list of tokens generated from text.
boolean	isIdentifierChar(int languageIndex, char ch) Overridden to accept letters, digits, underscores, and hyphens.
void	yybegin(int newState) Enters a new lexical state
char	yycharat(int pos) Returns the character at position pos from the matched text.
void	yyclose() Closes the input stream.
int	yylength() Returns the length of the matched text region.
Token	yylex() Resumes scanning until the next regular expression is matched, the end of input is encountered or an I/O-Error occurs.
void	yypushback(int number) Pushes the specified amount of characters back into the input stream.
void	yyreset(java.io.Reader reader) Resets the scanner to read from a new input stream.
int	yystate() Returns the current lexical state.
java.lang.String	yytext() Returns the text matched by the current regular expression.

Methods inherited from class org.fife.ui.rsyntaxtextarea.AbstractJFlexCTokenMaker

createInsertBreakAction, getCurlyBracesDenoteCodeBlocks, getInsertBreakAction

Methods inherited from class org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker

yybegin

Methods inherited from class org.fife.ui.rsyntaxtextarea.TokenMakerBase

addNullToken, addToken, addToken, createOccurrenceMarker, getLanguageIndex, getLastTokenTypeOnLine, getLineCommentStartAndEnd, getOccurrenceMarker, isMarkupLanguage, resetTokenList, setLanguageIndex

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

YYEOF

public static final int YYEOF

This character denotes the end of file

See Also:

Constant Field Values

CSS_C_STYLE_COMMENT

public static final int CSS_C_STYLE_COMMENT

lexical states

See Also:

Constant Field Values

YYINITIAL

public static final int YYINITIAL

See Also:

Constant Field Values

CSS_STRING

public static final int CSS_STRING

See Also:

Constant Field Values

CSS_VALUE

public static final int CSS_VALUE

See Also:

Constant Field Values

CSS_PROPERTY

public static final int CSS_PROPERTY

See Also:

Constant Field Values

CSS_CHAR_LITERAL

public static final int CSS_CHAR_LITERAL

See Also:

Constant Field Values

INTERNAL_CSS_PROPERTY

public static final int INTERNAL_CSS_PROPERTY

Internal type denoting a line ending in a CSS property.

See Also:

Constant Field Values

INTERNAL_CSS_VALUE

public static final int INTERNAL_CSS_VALUE

Internal type denoting a line ending in a CSS property value.

See Also:

Constant Field Values

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:

Constant Field Values

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:

Constant Field Values

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:

Constant Field Values

Constructor Detail

CSSTokenMaker

public CSSTokenMaker()

Constructor. This must be here because JFlex does not generate a no-parameter constructor.

CSSTokenMaker

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

CSSTokenMaker

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

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.

getMarkOccurrencesOfTokenType

public boolean getMarkOccurrencesOfTokenType(int type)

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)

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(javax.swing.text.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.

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 YY_INITIAL.

Parameters:

reader - the new input stream

yyclose

public final void yyclose()
                   throws java.io.IOException

Closes the input stream.

Throws:

java.io.IOException

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 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.

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