Segment to get text from.
* @param start Start offset in segment of token.
* @param end End offset in segment of token.
* @param tokenType The token's type.
* @param startOffset The offset in the document at which this token occurs.
*/
public void addToken(Segment segment, int start, int end, int tokenType, int startOffset) {
addToken(segment.array, start, end, tokenType, startOffset);
}
/**
* {@inheritDoc}
*/
@Override
public void addToken(char[] array, int start, int end, int tokenType, int startOffset) {
addToken(array, start, end, tokenType, startOffset, false);
}
/**
* Adds the token specified to the current linked list of tokens.
*
* @param array The character array.
* @param start The starting offset in the array.
* @param end The ending offset in the array.
* @param tokenType The token's type.
* @param startOffset The offset in the document at which this token occurs.
* @param hyperlink Whether this token is a hyperlink.
*/
public void addToken(char[] array, int start, int end, int tokenType, int startOffset, boolean hyperlink) {
if (firstToken == null) {
firstToken = tokenFactory.createToken(array, start, end, startOffset, tokenType);
currentToken = firstToken; // previous token is still null.
} else {
TokenImpl next = tokenFactory.createToken(array, start, end, startOffset, tokenType);
if (currentToken == null || next == null)
return;
currentToken.setNextToken(next);
previousToken = currentToken;
currentToken = next;
}
currentToken.setLanguageIndex(languageIndex);
currentToken.setHyperlink(hyperlink);
}
/**
* Returns the occurrence marker to use for this token maker. Subclasses can
* override to use different implementations.
*
* @return The occurrence marker to use.
*/
protected OccurrenceMarker createOccurrenceMarker() {
return new DefaultOccurrenceMarker();
}
/**
* Returns the closest {@link TokenTypes "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.
*
* @param type The token type.
* @return The closest "standard" token type.
*/
@Override
public int getClosestStandardTokenTypeForInternalType(int type) {
return type;
}
/**
* 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.
*
* @param languageIndex The language index at the offset in question. Since some
* TokenMakers effectively have nested
* languages (such as JavaScript in HTML), this parameter
* tells the TokenMaker what sub-language to
* look at.
* @return Whether curly braces denote code blocks.
*/
@Override
public boolean getCurlyBracesDenoteCodeBlocks(int languageIndex) {
return false;
}
/**
* Returns an action to handle "insert break" key presses (i.e. Enter). The
* default implementation returns null. Subclasses can override.
*
* @return The default implementation always returns null.
*/
@Override
public Action getInsertBreakAction() {
return null;
}
/**
* Returns the current language index.
*
* @return The current language index.
* @see #setLanguageIndex(int)
*/
protected int getLanguageIndex() {
return languageIndex;
}
/**
* {@inheritDoc}
*/
@Override
public int getLastTokenTypeOnLine(Segment text, int initialTokenType) {
// Last parameter doesn't matter if we're not painting.
Token t = getTokenList(text, initialTokenType, 0);
while (t.getNextToken() != null) {
t = t.getNextToken();
}
return t.getType();
}
/**
* {@inheritDoc}
*/
@Override
public String[] getLineCommentStartAndEnd(int languageIndex) {
return null;
}
/**
* 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 {@link Token#IDENTIFIER}. Subclasses can
* override this method to support other token types, such as
* {@link Token#VARIABLE}.
*
* @param type The token type.
* @return Whether tokens of this type should have "mark occurrences" enabled.
*/
@Override
public boolean getMarkOccurrencesOfTokenType(int type) {
return type == Token.IDENTIFIER;
}
/**
* {@inheritDoc}
*/
@Override
public OccurrenceMarker getOccurrenceMarker() {
if (occurrenceMarker == null) {
occurrenceMarker = createOccurrenceMarker();
}
return occurrenceMarker;
}
/**
* The default implementation returns false always. Languages that
* wish to better support auto-indentation can override this method.
*
* @param token The token the previous line ends with.
* @return Whether the next line should be indented.
*/
@Override
public boolean getShouldIndentNextLineAfter(Token token) {
return false;
}
/**
* Returns whether a character could be part of an "identifier" token in a
* specific language. The default implementation returns true for
* letters, numbers, and certain symbols.
*/
@Override
public boolean isIdentifierChar(int languageIndex, char ch) {
return Character.isLetterOrDigit(ch) || ch == '_' || ch == '$';
}
/**
* The default implementation returns false always. Subclasses that
* are highlighting a markup language should override this method to return
* true.
*
* @return false always.
*/
@Override
public boolean isMarkupLanguage() {
return false;
}
/**
* 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 {@link #getLastTokenTypeOnLine(Segment, int)} or
* {@link #getTokenList(Segment, int, int)}.
*/
protected void resetTokenList() {
firstToken = currentToken = previousToken = null;
tokenFactory.resetAllTokens();
}
/**
* 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).
*
* @param 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.
* @see #getLanguageIndex()
*/
protected void setLanguageIndex(int languageIndex) {
this.languageIndex = Math.max(0, languageIndex);
}
}