org.fife.ui.rsyntaxtextarea.modes
Class MxmlTokenMaker

java.lang.Object
  extended by org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker
      extended by org.fife.ui.rsyntaxtextarea.modes.AbstractMarkupTokenMaker
          extended by org.fife.ui.rsyntaxtextarea.modes.MxmlTokenMaker
All Implemented Interfaces:
TokenMaker

public class MxmlTokenMaker
extends AbstractMarkupTokenMaker

Scanner for MXML. 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:

Version:
0.5
Author:
Robert Futrell

Field Summary
static int AS
           
static int AS_EOL_COMMENT
          lexical states
static int AS_MLC
           
static int CDATA
           
static int COMMENT
           
protected  TokenImpl currentToken
          Used in the creation of the linked list.
static int DTD
           
protected  TokenImpl firstToken
          The first token in the returned linked list.
static int INATTR_DOUBLE
           
static int INATTR_DOUBLE_SCRIPT
           
static int INATTR_SINGLE
           
static int INATTR_SINGLE_SCRIPT
           
static int INTAG
           
static int INTAG_SCRIPT
           
static int INTERNAL_ATTR_DOUBLE
          Type specific to JSPTokenMaker denoting a line ending with an unclosed double-quote attribute.
static int INTERNAL_ATTR_DOUBLE_QUOTE_SCRIPT
          Token type specific to this class; this signals that the user has ended a line in the middle of a double-quoted attribute in a Script tag.
static int INTERNAL_ATTR_SINGLE
          Type specific to JSPTokenMaker denoting a line ending with an unclosed single-quote attribute.
static int INTERNAL_ATTR_SINGLE_QUOTE_SCRIPT
          Token type specific to this class; this signals that the user has ended a line in the middle of a single-quoted attribute in a Script tag.
static int INTERNAL_IN_AS
          Token type specific to this class; this signals that the user has ended a line in an ActionScript code block (text content inside a Script tag).
static int INTERNAL_IN_AS_MLC
          Token type specific to this class; this signals that the user has ended a line in an MLC in an ActionScript code block (text content inside a Script tag).
static int INTERNAL_INTAG
          Token type specific to this class; this signals that the user has ended a line with an unclosed XML tag; thus a new line is beginning still inside of the tag.
static int INTERNAL_INTAG_SCRIPT
          Token type specific to this class; this signals that the user has ended a line with an unclosed Script tag; thus a new line is beginning still inside of the tag.
static int PI
           
protected  TokenImpl previousToken
          Used in the creation of the linked list.
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
 
Constructor Summary
MxmlTokenMaker()
          Constructor.
MxmlTokenMaker(java.io.InputStream in)
          Creates a new scanner.
MxmlTokenMaker(java.io.Reader in)
          Creates a new scanner There is also a java.io.InputStream version of this constructor.
 
Method Summary
 void addNullToken()
          Adds a null token to the end of the current linked list of tokens.
 void addToken(char[] array, int start, int end, int tokenType, int startOffset)
          Adds the token specified to the current linked list of tokens.
 void addToken(char[] array, int start, int end, int tokenType, int startOffset, boolean hyperlink)
          Adds the token specified to the current linked list of tokens.
 void addToken(javax.swing.text.Segment segment, int start, int end, int tokenType, int startOffset)
          Adds the token specified to the current linked list of tokens.
protected  OccurrenceMarker createOccurrenceMarker()
          Returns the occurrence marker to use for this token maker.
 int getClosestStandardTokenTypeForInternalType(int type)
          Returns the closest "standard" token type for a given "internal" token type (e.g. one whose value is < 0).
static boolean getCompleteCloseMarkupTags()
          Static version of getCompleteCloseTags().
 boolean getCompleteCloseTags()
          Returns whether markup close tags should be completed.
 boolean getCurlyBracesDenoteCodeBlocks()
          Returns whether this programming language uses curly braces ('{' and '}') to denote code blocks.
 javax.swing.Action getInsertBreakAction()
          Returns an action to handle "insert break" key presses (i.e.
 int getLastTokenTypeOnLine(javax.swing.text.Segment text, int initialTokenType)
          Returns the last token on this line's type if the token is "unfinished", or TokenTypes.NULL if it was finished.
 boolean getMarkOccurrencesOfTokenType(int type)
          Always returns false, as you never want "mark occurrences" working in XML files.
 OccurrenceMarker getOccurrenceMarker()
          Returns the object in charge of marking all occurrences of the token at the current caret position, if it is a relevant token.
 boolean getShouldIndentNextLineAfter(Token token)
          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.
protected  void resetTokenList()
          Deletes the linked list of tokens so we can begin anew.
static void setCompleteCloseTags(boolean complete)
          Sets whether markup close tags should be completed.
 void setLanguageIndex(int languageIndex)
          Sets the language index to assign to tokens moving forward.
 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.modes.AbstractMarkupTokenMaker
getLineCommentStartAndEnd, isMarkupLanguage
 
Methods inherited from class org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker
yybegin
 
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

AS_EOL_COMMENT

public static final int AS_EOL_COMMENT
lexical states

See Also:
Constant Field Values

AS_MLC

public static final int AS_MLC
See Also:
Constant Field Values

INTAG_SCRIPT

public static final int INTAG_SCRIPT
See Also:
Constant Field Values

INATTR_DOUBLE_SCRIPT

public static final int INATTR_DOUBLE_SCRIPT
See Also:
Constant Field Values

CDATA

public static final int CDATA
See Also:
Constant Field Values

INATTR_SINGLE_SCRIPT

public static final int INATTR_SINGLE_SCRIPT
See Also:
Constant Field Values

DTD

public static final int DTD
See Also:
Constant Field Values

INATTR_SINGLE

public static final int INATTR_SINGLE
See Also:
Constant Field Values

INATTR_DOUBLE

public static final int INATTR_DOUBLE
See Also:
Constant Field Values

YYINITIAL

public static final int YYINITIAL
See Also:
Constant Field Values

AS

public static final int AS
See Also:
Constant Field Values

INTAG

public static final int INTAG
See Also:
Constant Field Values

COMMENT

public static final int COMMENT
See Also:
Constant Field Values

PI

public static final int PI
See Also:
Constant Field Values

INTERNAL_ATTR_DOUBLE

public static final int INTERNAL_ATTR_DOUBLE
Type specific to JSPTokenMaker denoting a line ending with an unclosed double-quote attribute.

See Also:
Constant Field Values

INTERNAL_ATTR_SINGLE

public static final int INTERNAL_ATTR_SINGLE
Type specific to JSPTokenMaker denoting a line ending with an unclosed single-quote attribute.

See Also:
Constant Field Values

INTERNAL_INTAG

public static final int INTERNAL_INTAG
Token type specific to this class; this signals that the user has ended a line with an unclosed XML tag; thus a new line is beginning still inside of the tag.

See Also:
Constant Field Values

INTERNAL_INTAG_SCRIPT

public static final int INTERNAL_INTAG_SCRIPT
Token type specific to this class; this signals that the user has ended a line with an unclosed Script tag; thus a new line is beginning still inside of the tag.

See Also:
Constant Field Values

INTERNAL_ATTR_DOUBLE_QUOTE_SCRIPT

public static final int INTERNAL_ATTR_DOUBLE_QUOTE_SCRIPT
Token type specific to this class; this signals that the user has ended a line in the middle of a double-quoted attribute in a Script tag.

See Also:
Constant Field Values

INTERNAL_ATTR_SINGLE_QUOTE_SCRIPT

public static final int INTERNAL_ATTR_SINGLE_QUOTE_SCRIPT
Token type specific to this class; this signals that the user has ended a line in the middle of a single-quoted attribute in a Script tag.

See Also:
Constant Field Values

INTERNAL_IN_AS

public static final int INTERNAL_IN_AS
Token type specific to this class; this signals that the user has ended a line in an ActionScript code block (text content inside a Script tag).

See Also:
Constant Field Values

INTERNAL_IN_AS_MLC

public static final int INTERNAL_IN_AS_MLC
Token type specific to this class; this signals that the user has ended a line in an MLC in an ActionScript code block (text content inside a Script tag).

See Also:
Constant Field Values

firstToken

protected TokenImpl firstToken
The first token in the returned linked list.


currentToken

protected TokenImpl currentToken
Used in the creation of the linked list.


previousToken

protected TokenImpl previousToken
Used in the creation of the linked list.

Constructor Detail

MxmlTokenMaker

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


MxmlTokenMaker

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

MxmlTokenMaker

public MxmlTokenMaker(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,
                     boolean hyperlink)
Adds the token specified to the current linked list of tokens.

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.
hyperlink - Whether this token is a hyperlink.

getCompleteCloseTags

public boolean getCompleteCloseTags()
Returns whether markup close tags should be completed. For XML, the default value is true.

Specified by:
getCompleteCloseTags in class AbstractMarkupTokenMaker
Returns:
Whether closing markup tags are completed.
See Also:
setCompleteCloseTags(boolean)

getCompleteCloseMarkupTags

public static boolean getCompleteCloseMarkupTags()
Static version of getCompleteCloseTags(). This hack is unfortunately needed for applications to be able to query this value without instantiating this class.

Returns:
Whether closing markup tags are completed.
See Also:
setCompleteCloseTags(boolean)

getMarkOccurrencesOfTokenType

public boolean getMarkOccurrencesOfTokenType(int type)
Always returns false, as you never want "mark occurrences" working in XML files.

Specified by:
getMarkOccurrencesOfTokenType in interface TokenMaker
Parameters:
type - The token type.
Returns:
Whether tokens of this type should have "mark occurrences" enabled.

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.

setCompleteCloseTags

public static void setCompleteCloseTags(boolean complete)
Sets whether markup close tags should be completed.

Parameters:
complete - Whether closing markup tags are completed.
See Also:
getCompleteCloseTags()

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

addNullToken

public void addNullToken()
Adds a null token to the end of the current linked list of tokens. This should be put at the end of the linked list whenever the last token on the current line is NOT a multi-line token.

Specified by:
addNullToken in interface TokenMaker

addToken

public void addToken(javax.swing.text.Segment segment,
                     int start,
                     int end,
                     int tokenType,
                     int startOffset)
Adds the token specified to the current linked list of tokens.

Parameters:
segment - Segment to get text from.
start - Start offset in segment of token.
end - End offset in segment of token.
tokenType - The token's type.
startOffset - The offset in the document at which this token occurs.

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
Parameters:
array - The character array from which to get the text.
start - Start offset in segment of token.
end - End offset in segment of token.
tokenType - The token's type.
startOffset - The offset in the document at which this token occurs.

createOccurrenceMarker

protected OccurrenceMarker createOccurrenceMarker()
Returns the occurrence marker to use for this token maker. Subclasses can override to use different implementations.

Returns:
The occurrence marker to use.

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

The default implementation returns type always, which denotes that a mapping from internal token types to standard token types is not defined; subclasses can override.

Specified by:
getClosestStandardTokenTypeForInternalType in interface TokenMaker
Parameters:
type - The token type.
Returns:
The closest "standard" token type.

getCurlyBracesDenoteCodeBlocks

public boolean getCurlyBracesDenoteCodeBlocks()
Returns whether this programming language uses curly braces ('{' and '}') to denote code blocks.

The default implementation returns false; subclasses can override this method if necessary.

Specified by:
getCurlyBracesDenoteCodeBlocks in interface TokenMaker
Returns:
Whether curly braces denote code blocks.

getInsertBreakAction

public javax.swing.Action getInsertBreakAction()
Returns an action to handle "insert break" key presses (i.e. Enter). The default implementation returns null. Subclasses can override.

Specified by:
getInsertBreakAction in interface TokenMaker
Returns:
The default implementation always returns null.

getLastTokenTypeOnLine

public int getLastTokenTypeOnLine(javax.swing.text.Segment text,
                                  int initialTokenType)
Returns the last token on this line's type if the token is "unfinished", or TokenTypes.NULL if it was finished. For example, if C-style syntax highlighting is being implemented, and text contained a line of code that contained the beginning of a comment but no end-comment marker ("*\/"), then this method would return TokenTypes.COMMENT_MULTILINE for that line. This is useful for doing syntax highlighting.

Specified by:
getLastTokenTypeOnLine in interface TokenMaker
Parameters:
text - The line of tokens to examine.
initialTokenType - The token type to start with (i.e., the value of getLastTokenTypeOnLine for the line before text).
Returns:
The last token on this line's type, or TokenTypes.NULL if the line was completed.

getOccurrenceMarker

public OccurrenceMarker getOccurrenceMarker()
Returns the object in charge of marking all occurrences of the token at the current caret position, if it is a relevant token. If null is returned, a default OccurrenceMarker is used.

Specified by:
getOccurrenceMarker in interface TokenMaker
Returns:
The occurrence marker for this language, or null for none.

getShouldIndentNextLineAfter

public boolean getShouldIndentNextLineAfter(Token token)
The default implementation returns false always. Languages that wish to better support auto-indentation can override this method.

Specified by:
getShouldIndentNextLineAfter in interface TokenMaker
Parameters:
token - The token the previous line ends with.
Returns:
Whether the next line should be indented.

resetTokenList

protected void resetTokenList()
Deletes the linked list of tokens so we can begin anew. This should never have to be called by the programmer, as it is automatically called whenever the user calls getLastTokenTypeOnLine(Segment, int) or TokenMaker.getTokenList(Segment, int, int).


setLanguageIndex

public void setLanguageIndex(int languageIndex)
Sets the language index to assign to tokens moving forward. This property is used to designate tokens as being in "secondary" languages (such as CSS or JavaScript in HTML).

Parameters:
languageIndex - The new language index. A value of 0 denotes the "main" language, any positive value denotes a specific secondary language. Negative values will be treated as 0.