org.fife.ui.rsyntaxtextarea
Interface TokenMaker

All Known Implementing Classes:

AssemblerX86TokenMaker, CSSTokenMaker, FortranTokenMaker, LuaTokenMaker, PropertiesFileTokenMaker, PythonTokenMaker, TclTokenMaker, org.fife.ui.rsyntaxtextarea.TokenMakerBase

public interface TokenMaker

An implementation of TokenMaker is a class that turns text into a linked list of Tokens for syntax highlighting in a particular language.

Version:

0.2

Author:

Robert Futrell

See Also:

Token, AbstractTokenMaker

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.
boolean	getCurlyBracesDenoteCodeBlocks() Returns whether this programming language uses curly braces ('{' and '}') 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 token) If a line ends in the specified token, this method returns whether a new line inserted after that line should be indented.
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	isMarkupLanguage() Returns whether this language is a markup language.
void	setWhitespaceVisible(boolean visible, RSyntaxTextArea textArea) Sets whether tokens are generated that "show" whitespace.

Method Detail

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.

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.

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.

getCurlyBracesDenoteCodeBlocks

public boolean getCurlyBracesDenoteCodeBlocks()

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

Returns:

Whether curly braces denote code blocks.

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.

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.

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.

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)

Returns whether tokens of the specified type should have "mark occurrences" enabled for the current programming language.

Parameters:

type - The token type.

Returns:

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

getShouldIndentNextLineAfter

public boolean getShouldIndentNextLineAfter(Token token)

If a line ends in the specified token, this method returns whether a new line inserted after that line should be indented.

Parameters:

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

isMarkupLanguage

public boolean isMarkupLanguage()

Returns whether this language is a markup language.

Returns:

Whether this language is markup.

setWhitespaceVisible

public void setWhitespaceVisible(boolean visible,
                                 RSyntaxTextArea textArea)

Sets whether tokens are generated that "show" whitespace.

Parameters:

visible - Whether whitespace should be visible.