Package org.fife.ui.rsyntaxtextarea
Class TokenMakerBase
java.lang.Object
org.fife.ui.rsyntaxtextarea.TokenMakerBase
- All Implemented Interfaces:
TokenMaker
- Direct Known Subclasses:
AbstractJFlexTokenMaker
,AbstractTokenMaker
Base class for token makers.
- Version:
- 1.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected TokenImpl
Used in the creation of the linked list.protected TokenImpl
The first token in the returned linked list.private int
"0" implies this is the "main" language being highlighted.private OccurrenceMarker
Highlights occurrences of the current token in the editor, if it is relevant.protected TokenImpl
Used in the creation of the linked list.private TokenFactory
The factory that gives us our tokens to use. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
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
Adds the token specified to the current linked list of tokens.protected OccurrenceMarker
Returns the occurrence marker to use for this token maker.int
Returns the closest"standard" token type
for a given "internal" token type (e.g.boolean
getCurlyBracesDenoteCodeBlocks
(int languageIndex) Returns whether this programming language uses curly braces ('{
' and '}
') to denote code blocks.Returns an action to handle "insert break" key presses (i.e.protected int
Returns the current language index.int
getLastTokenTypeOnLine
(Segment text, int initialTokenType) Returns the last token on this line's type if the token is "unfinished", orTokenTypes.NULL
if it was finished.String[]
getLineCommentStartAndEnd
(int languageIndex) Returns the text to place at the beginning and end of a line to "comment" it in this programming language.boolean
getMarkOccurrencesOfTokenType
(int type) Returns whether tokens of the specified type should have "mark occurrences" enabled for the current programming language.protected boolean
Returns whether no tokens have been identified yet.Returns the object in charge of marking all occurrences of the token at the current caret position, if it is a relevant token.boolean
The default implementation returnsfalse
always.boolean
isIdentifierChar
(int languageIndex, char ch) Returns whether a character could be part of an "identifier" token in a specific language.boolean
The default implementation returnsfalse
always.protected void
Deletes the linked list of tokens so we can begin anew.protected void
setLanguageIndex
(int languageIndex) Sets the language index to assign to tokens moving forward.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.fife.ui.rsyntaxtextarea.TokenMaker
getTokenList
-
Field Details
-
firstToken
The first token in the returned linked list. -
currentToken
Used in the creation of the linked list. -
previousToken
Used in the creation of the linked list. -
tokenFactory
The factory that gives us our tokens to use. -
occurrenceMarker
Highlights occurrences of the current token in the editor, if it is relevant. -
languageIndex
private int languageIndex"0" implies this is the "main" language being highlighted. Positive values imply various "secondary" or "embedded" languages, such as CSS or JavaScript in HTML. While this value is non-zero, tokens will be generated with this language index so they can (possibly) be painted differently, so "embedded" languages can be rendered with a special background.
-
-
Constructor Details
-
TokenMakerBase
public TokenMakerBase()Constructor.
-
-
Method Details
-
addNullToken
public void addNullToken()Description copied from interface:TokenMaker
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 interfaceTokenMaker
-
addToken
Adds the token specified to the current linked list of tokens.- Parameters:
segment
-Segment
to get text from.start
- Start offset insegment
of token.end
- End offset insegment
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) Description copied from interface:TokenMaker
Adds the token specified to the current linked list of tokens.- Specified by:
addToken
in interfaceTokenMaker
- Parameters:
array
- The character array from which to get the text.start
- Start offset insegment
of token.end
- End offset insegment
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.
-
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 interfaceTokenMaker
- Parameters:
type
- The token type.- Returns:
- The closest "standard" token type.
-
getCurlyBracesDenoteCodeBlocks
public boolean getCurlyBracesDenoteCodeBlocks(int languageIndex) Returns whether this programming language uses curly braces ('{
' and '}
') to denote code blocks. The default implementation returnsfalse
; subclasses can override this method if necessary.- Specified by:
getCurlyBracesDenoteCodeBlocks
in interfaceTokenMaker
- Parameters:
languageIndex
- The language index at the offset in question. Since someTokenMaker
s effectively have nested languages (such as JavaScript in HTML), this parameter tells theTokenMaker
what sub-language to look at.- Returns:
- Whether curly braces denote code blocks.
-
getInsertBreakAction
Returns an action to handle "insert break" key presses (i.e. Enter). The default implementation returnsnull
. Subclasses can override.- Specified by:
getInsertBreakAction
in interfaceTokenMaker
- Returns:
- The default implementation always returns
null
.
-
getLanguageIndex
protected int getLanguageIndex()Returns the current language index.- Returns:
- The current language index.
- See Also:
-
getLastTokenTypeOnLine
Description copied from interface:TokenMaker
Returns the last token on this line's type if the token is "unfinished", orTokenTypes.NULL
if it was finished. For example, if C-style syntax highlighting is being implemented, andtext
contained a line of code that contained the beginning of a comment but no end-comment marker ("*\/"), then this method would returnTokenTypes.COMMENT_MULTILINE
for that line. This is useful for doing syntax highlighting.- Specified by:
getLastTokenTypeOnLine
in interfaceTokenMaker
- Parameters:
text
- The line of tokens to examine.initialTokenType
- The token type to start with (i.e., the value ofgetLastTokenTypeOnLine
for the line beforetext
).- Returns:
- The last token on this line's type, or
TokenTypes.NULL
if the line was completed.
-
getLineCommentStartAndEnd
Description copied from interface:TokenMaker
Returns the text to place at the beginning and end of a line to "comment" it in this programming language.- Specified by:
getLineCommentStartAndEnd
in interfaceTokenMaker
- Parameters:
languageIndex
- The language index at the offset in question. Since someTokenMaker
s effectively have nested languages (such as JavaScript in HTML), this parameter tells theTokenMaker
what sub-language to look at.- 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 ofnull
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. The default implementation returns true if type isTokenTypes.IDENTIFIER
. Subclasses can override this method to support other token types, such asTokenTypes.VARIABLE
.- Specified by:
getMarkOccurrencesOfTokenType
in interfaceTokenMaker
- Parameters:
type
- The token type.- Returns:
- Whether tokens of this type should have "mark occurrences" enabled.
-
getNoTokensIdentifiedYet
protected boolean getNoTokensIdentifiedYet()Returns whether no tokens have been identified yet. Should only be called by subclasses that need to identify tokens depending on whether they are the "first" token on the line or not.- Returns:
- Whether no tokens have been identified yet.
-
getOccurrenceMarker
Description copied from interface:TokenMaker
Returns the object in charge of marking all occurrences of the token at the current caret position, if it is a relevant token. Ifnull
is returned, a defaultOccurrenceMarker
is used.- Specified by:
getOccurrenceMarker
in interfaceTokenMaker
- Returns:
- The occurrence marker for this language, or
null
for none.
-
getShouldIndentNextLineAfter
The default implementation returnsfalse
always. Languages that wish to better support auto-indentation can override this method.- Specified by:
getShouldIndentNextLineAfter
in interfaceTokenMaker
- Parameters:
token
- The token the previous line ends with.- Returns:
- Whether the next line should be indented.
-
isIdentifierChar
public boolean isIdentifierChar(int languageIndex, char ch) Returns whether a character could be part of an "identifier" token in a specific language. The default implementation returnstrue
for letters, numbers, and certain symbols.- Specified by:
isIdentifierChar
in interfaceTokenMaker
- Parameters:
languageIndex
- The language index the character was found in.ch
- The character.- Returns:
- Whether the character could be part of an "identifier" token.
-
isMarkupLanguage
public boolean isMarkupLanguage()The default implementation returnsfalse
always. Subclasses that are highlighting a markup language should override this method to returntrue
.- Specified by:
isMarkupLanguage
in interfaceTokenMaker
- 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 callsgetLastTokenTypeOnLine(Segment, int)
orTokenMaker.getTokenList(Segment, int, int)
. -
setLanguageIndex
protected 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 of0
denotes the "main" language, any positive value denotes a specific secondary language. Negative values will be treated as0
.- See Also:
-