org.fife.ui.rsyntaxtextarea.modes
Class JavaScriptTokenMaker

java.lang.Object
  org.fife.ui.rsyntaxtextarea.AbstractTokenMaker
      org.fife.ui.rsyntaxtextarea.modes.JavaScriptTokenMaker

All Implemented Interfaces:

TokenMaker

public class JavaScriptTokenMaker
extends AbstractTokenMaker

A token maker that turns text into a linked list of Tokens for syntax highlighting in the JavaScript programming language.

Version:

0.1

Author:

Robert Futrell

Field Summary

protected Token	currentToken Used in the creation of the linked list.
protected Token	firstToken The first token in the returned linked list.
protected java.lang.String	hexCharacters
protected java.lang.String	numberEndChars
protected java.lang.String	operators
protected Token	previousToken Used in the creation of the linked list.
protected java.lang.String	separators
protected java.lang.String	separators2

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

wordsToHighlight

Constructor Summary

JavaScriptTokenMaker()
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) Checks the token to give it the exact ID it deserves before being passed up to the super method.
boolean	getCurlyBracesDenoteCodeBlocks() Returns true always as JavaScript uses curly braces to denote code blocks.
int	getLastTokenTypeOnLine(javax.swing.text.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.
java.lang.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 t) Returns true if the specified token is a '{' or '(' separator.
Token	getTokenList(javax.swing.text.Segment text, int initialTokenType, int startOffset) Returns the first token in the linked list of tokens generated from text.
TokenMap	getWordsToHighlight() Returns the words to highlight for the JavaScript programming language.
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.

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

removeLastToken

Methods inherited from class java.lang.Object

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

Field Detail

operators

protected final java.lang.String operators

See Also:

Constant Field Values

separators

protected final java.lang.String separators

See Also:

Constant Field Values

separators2

protected final java.lang.String separators2

See Also:

Constant Field Values

hexCharacters

protected final java.lang.String hexCharacters

See Also:

Constant Field Values

numberEndChars

protected final java.lang.String numberEndChars

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

JavaScriptTokenMaker

public JavaScriptTokenMaker()

Constructor.

Method Detail

addToken

public void addToken(javax.swing.text.Segment segment,
                     int start,
                     int end,
                     int tokenType,
                     int startOffset)

Checks the token to give it the exact ID it deserves before being passed up to the super method.

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 the token occurs.

getLineCommentStartAndEnd

public java.lang.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.

getWordsToHighlight

public TokenMap getWordsToHighlight()

Returns the words to highlight for the JavaScript programming language.

Specified by:

getWordsToHighlight in class AbstractTokenMaker

Returns:

A TokenMap containing the words to highlight for the JavaScript programming language.

See Also:

AbstractTokenMaker.getWordsToHighlight()

getCurlyBracesDenoteCodeBlocks

public boolean getCurlyBracesDenoteCodeBlocks()

Returns true always as JavaScript uses curly braces to denote code blocks.

Specified by:

getCurlyBracesDenoteCodeBlocks in interface TokenMaker

Returns:

true always.

getShouldIndentNextLineAfter

public boolean getShouldIndentNextLineAfter(Token t)

Returns true if the specified token is a '{' or '(' separator.

Specified by:

getShouldIndentNextLineAfter in interface TokenMaker

Parameters:

t - The token the previous line ends with.

Returns:

Whether the next line should be indented after this token.

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.

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

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.

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

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 Token.IDENTIFIER. Subclasses can override this method to support other token types, such as Token.VARIABLE.

Specified by:

getMarkOccurrencesOfTokenType in interface TokenMaker

Parameters:

type - The token type.

Returns:

Whether tokens of this type should have "mark occurrences" enabled.

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.