org.fife.ui.rsyntaxtextarea.modes
Class RubyTokenMaker

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

public class RubyTokenMaker
extends AbstractJFlexTokenMaker

Scanner for Ruby.

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 BACKTICKS
           
static int CHAR_LITERAL
           
protected  Token currentToken
          Used in the creation of the linked list.
static int DOCCOMMENT
           
protected  Token firstToken
          The first token in the returned linked list.
static int HEREDOC_EOF_DOUBLE_QUOTED
           
static int HEREDOC_EOF_SINGLE_QUOTED
          lexical states
static int HEREDOC_EOF_UNQUOTED
           
static int HEREDOC_EOT_DOUBLE_QUOTED
           
static int HEREDOC_EOT_SINGLE_QUOTED
           
static int HEREDOC_EOT_UNQUOTED
           
static int INTERNAL_HEREDOC_EOF_DOUBLE_QUOTED
          Token type specific to RubyTokenMaker; this signals that we are inside an double quoted EOF heredoc.
static int INTERNAL_HEREDOC_EOF_SINGLE_QUOTED
          Token type specific to RubyTokenMaker; this signals that we are inside an single quoted EOF heredoc.
static int INTERNAL_HEREDOC_EOF_UNQUOTED
          Token type specific to RubyTokenMaker; this signals that we are inside an unquoted/double quoted/backtick EOF heredoc.
static int INTERNAL_HEREDOC_EOT_DOUBLE_QUOTED
          Token type specific to RubyTokenMaker; this signals that we are inside an double quoted EOT heredoc.
static int INTERNAL_HEREDOC_EOT_SINGLE_QUOTED
          Token type specific to RubyTokenMaker; this signals that we are inside an single quoted EOT heredoc.
static int INTERNAL_HEREDOC_EOT_UNQUOTED
          Token type specific to RubyTokenMaker; this signals that we are inside an unquoted/double quoted/backtick EOT heredoc.
static int INTERNAL_STRING_Q_BANG
          Token type specific to RubyTokenMaker; this signals that we are inside a %Q!...!
static int INTERNAL_STRING_Q_CURLY_BRACE
          Token type specific to RubyTokenMaker; this signals that we are inside a %Q{...} style double quoted string.
static int INTERNAL_STRING_Q_LT
          Token type specific to RubyTokenMaker; this signals that we are inside a %Q<...
static int INTERNAL_STRING_Q_PAREN
          Token type specific to RubyTokenMaker; this signals that we are inside a %Q(...) style double quoted string.
static int INTERNAL_STRING_Q_SLASH
          Token type specific to RubyTokenMaker; this signals that we are inside a %Q/.../ style double quoted string.
static int INTERNAL_STRING_Q_SQUARE_BRACKET
          Token type specific to RubyTokenMaker; this signals that we are inside a %Q[...] style double quoted string.
protected  Token previousToken
          Used in the creation of the linked list.
static int STRING
           
static int STRING_Q_BANG
           
static int STRING_Q_CURLY_BRACE
           
static int STRING_Q_LT
           
static int STRING_Q_PAREN
           
static int STRING_Q_SLASH
           
static int STRING_Q_SQUARE_BRACKET
           
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
RubyTokenMaker()
          Constructor.
RubyTokenMaker(InputStream in)
          Creates a new scanner.
RubyTokenMaker(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(Segment segment, int start, int end, int tokenType, int startOffset)
          Adds the token specified to the current linked list of tokens.
 boolean getCurlyBracesDenoteCodeBlocks()
          Returns whether this programming language uses curly braces ('{' and '}') to denote code blocks.
 Action getInsertBreakAction()
          Returns an action to handle "insert break" key presses (i.e.
 int getLastTokenTypeOnLine(Segment text, int initialTokenType)
          Returns the last token on this line's type if the token is "unfinished", or Token.NULL if it was finished.
 String[] getLineCommentStartAndEnd()
          Returns the text to place at the beginning and end of a line to "comment" it in a this programming language.
 boolean getMarkOccurrencesOfTokenType(int type)
          Returns whether tokens of the specified type should have "mark occurrences" enabled for the current programming language.
 boolean getShouldIndentNextLineAfter(Token token)
          The default implementation returns false always.
 Token getTokenList(Segment text, int initialTokenType, int startOffset)
          Returns the first token in the linked list of tokens generated from text.
 boolean isMarkupLanguage()
          The default implementation returns false always.
protected  void resetTokenList()
          Deletes the linked list of tokens so we can begin anew.
 void setWhitespaceVisible(boolean visible, RSyntaxTextArea textArea)
          Sets whether tokens are generated that "show" whitespace.
 void yybegin(int newState)
          Enters a new lexical state
 char yycharat(int pos)
          Returns the character at position pos from the matched text.
 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(Reader reader)
          Resets the scanner to read from a new input stream.
 int yystate()
          Returns the current lexical state.
 String yytext()
          Returns the text matched by the current regular expression.
 
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

HEREDOC_EOF_SINGLE_QUOTED

public static final int HEREDOC_EOF_SINGLE_QUOTED
lexical states

See Also:
Constant Field Values

DOCCOMMENT

public static final int DOCCOMMENT
See Also:
Constant Field Values

HEREDOC_EOT_SINGLE_QUOTED

public static final int HEREDOC_EOT_SINGLE_QUOTED
See Also:
Constant Field Values

HEREDOC_EOT_UNQUOTED

public static final int HEREDOC_EOT_UNQUOTED
See Also:
Constant Field Values

STRING_Q_SLASH

public static final int STRING_Q_SLASH
See Also:
Constant Field Values

STRING_Q_BANG

public static final int STRING_Q_BANG
See Also:
Constant Field Values

STRING_Q_LT

public static final int STRING_Q_LT
See Also:
Constant Field Values

STRING

public static final int STRING
See Also:
Constant Field Values

BACKTICKS

public static final int BACKTICKS
See Also:
Constant Field Values

YYINITIAL

public static final int YYINITIAL
See Also:
Constant Field Values

HEREDOC_EOF_UNQUOTED

public static final int HEREDOC_EOF_UNQUOTED
See Also:
Constant Field Values

STRING_Q_CURLY_BRACE

public static final int STRING_Q_CURLY_BRACE
See Also:
Constant Field Values

STRING_Q_PAREN

public static final int STRING_Q_PAREN
See Also:
Constant Field Values

HEREDOC_EOF_DOUBLE_QUOTED

public static final int HEREDOC_EOF_DOUBLE_QUOTED
See Also:
Constant Field Values

CHAR_LITERAL

public static final int CHAR_LITERAL
See Also:
Constant Field Values

HEREDOC_EOT_DOUBLE_QUOTED

public static final int HEREDOC_EOT_DOUBLE_QUOTED
See Also:
Constant Field Values

STRING_Q_SQUARE_BRACKET

public static final int STRING_Q_SQUARE_BRACKET
See Also:
Constant Field Values

INTERNAL_HEREDOC_EOF_UNQUOTED

public static final int INTERNAL_HEREDOC_EOF_UNQUOTED
Token type specific to RubyTokenMaker; this signals that we are inside an unquoted/double quoted/backtick EOF heredoc.

See Also:
Constant Field Values

INTERNAL_HEREDOC_EOF_SINGLE_QUOTED

public static final int INTERNAL_HEREDOC_EOF_SINGLE_QUOTED
Token type specific to RubyTokenMaker; this signals that we are inside an single quoted EOF heredoc.

See Also:
Constant Field Values

INTERNAL_HEREDOC_EOF_DOUBLE_QUOTED

public static final int INTERNAL_HEREDOC_EOF_DOUBLE_QUOTED
Token type specific to RubyTokenMaker; this signals that we are inside an double quoted EOF heredoc.

See Also:
Constant Field Values

INTERNAL_HEREDOC_EOT_UNQUOTED

public static final int INTERNAL_HEREDOC_EOT_UNQUOTED
Token type specific to RubyTokenMaker; this signals that we are inside an unquoted/double quoted/backtick EOT heredoc.

See Also:
Constant Field Values

INTERNAL_HEREDOC_EOT_SINGLE_QUOTED

public static final int INTERNAL_HEREDOC_EOT_SINGLE_QUOTED
Token type specific to RubyTokenMaker; this signals that we are inside an single quoted EOT heredoc.

See Also:
Constant Field Values

INTERNAL_HEREDOC_EOT_DOUBLE_QUOTED

public static final int INTERNAL_HEREDOC_EOT_DOUBLE_QUOTED
Token type specific to RubyTokenMaker; this signals that we are inside an double quoted EOT heredoc.

See Also:
Constant Field Values

INTERNAL_STRING_Q_BANG

public static final int INTERNAL_STRING_Q_BANG
Token type specific to RubyTokenMaker; this signals that we are inside a %Q!...! style double quoted string.

See Also:
Constant Field Values

INTERNAL_STRING_Q_CURLY_BRACE

public static final int INTERNAL_STRING_Q_CURLY_BRACE
Token type specific to RubyTokenMaker; this signals that we are inside a %Q{...} style double quoted string.

See Also:
Constant Field Values

INTERNAL_STRING_Q_LT

public static final int INTERNAL_STRING_Q_LT
Token type specific to RubyTokenMaker; this signals that we are inside a %Q<...> style double quoted string.

See Also:
Constant Field Values

INTERNAL_STRING_Q_PAREN

public static final int INTERNAL_STRING_Q_PAREN
Token type specific to RubyTokenMaker; this signals that we are inside a %Q(...) style double quoted string.

See Also:
Constant Field Values

INTERNAL_STRING_Q_SLASH

public static final int INTERNAL_STRING_Q_SLASH
Token type specific to RubyTokenMaker; this signals that we are inside a %Q/.../ style double quoted string.

See Also:
Constant Field Values

INTERNAL_STRING_Q_SQUARE_BRACKET

public static final int INTERNAL_STRING_Q_SQUARE_BRACKET
Token type specific to RubyTokenMaker; this signals that we are inside a %Q[...] style double quoted string.

See Also:
Constant Field Values

firstToken

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


currentToken

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


previousToken

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

Constructor Detail

RubyTokenMaker

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


RubyTokenMaker

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

RubyTokenMaker

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

getLineCommentStartAndEnd

public String[] getLineCommentStartAndEnd()
Returns the text to place at the beginning and end of a line to "comment" it in a this programming language.

Specified by:
getLineCommentStartAndEnd in interface TokenMaker
Returns:
The start and end strings to add to a line to "comment" it out.

getMarkOccurrencesOfTokenType

public boolean getMarkOccurrencesOfTokenType(int type)
Returns whether tokens of the specified type should have "mark occurrences" enabled for the current programming language.

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

yyreset

public final void yyreset(Reader reader)
                   throws IOException
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
Throws:
IOException

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

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

Specified by:
addNullToken in interface TokenMaker

addToken

public void addToken(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,
                     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.

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 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(Segment text,
                                  int initialTokenType)
Returns the last token on this line's type if the token is "unfinished", or Token.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 Token.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 Token.NULL if the line was completed.

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.

isMarkupLanguage

public boolean isMarkupLanguage()
The default implementation returns false always. Subclasses that are highlighting a markup language should override this method to return true.

Specified by:
isMarkupLanguage in interface TokenMaker
Returns:
false always.

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


setWhitespaceVisible

public void setWhitespaceVisible(boolean visible,
                                 RSyntaxTextArea textArea)
Sets whether tokens are generated that "show" whitespace.

Specified by:
setWhitespaceVisible in interface TokenMaker
Parameters:
visible - Whether whitespace should be visible.