Class UnixShellTokenMaker
java.lang.Object
org.fife.ui.rsyntaxtextarea.TokenMakerBase
org.fife.ui.rsyntaxtextarea.AbstractTokenMaker
org.fife.ui.rsyntaxtextarea.modes.UnixShellTokenMaker
- All Implemented Interfaces:
TokenMaker
A token maker that turns text into a linked list of
Token
s
for syntax highlighting UNIX shell scripts.- Version:
- 0.1
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private int
private static final String
private static final String
private static final String
private static final String
Characters that are part of "$" shell variables; e.g., "$_"
.Fields inherited from class org.fife.ui.rsyntaxtextarea.AbstractTokenMaker
wordsToHighlight
Fields inherited from class org.fife.ui.rsyntaxtextarea.TokenMakerBase
currentToken, firstToken, previousToken
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Checks the token to give it the exact ID it deserves before being passed up to the super method.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.getTokenList
(Segment text, int startTokenType, int startOffset) Returns a list of tokens representing the given text.Returns the words to highlight for UNIX shell scripts.Methods inherited from class org.fife.ui.rsyntaxtextarea.AbstractTokenMaker
removeLastToken
Methods inherited from class org.fife.ui.rsyntaxtextarea.TokenMakerBase
addNullToken, addToken, addToken, createOccurrenceMarker, getClosestStandardTokenTypeForInternalType, getCurlyBracesDenoteCodeBlocks, getInsertBreakAction, getLanguageIndex, getLastTokenTypeOnLine, getNoTokensIdentifiedYet, getOccurrenceMarker, getShouldIndentNextLineAfter, isIdentifierChar, isMarkupLanguage, resetTokenList, setLanguageIndex
-
Field Details
-
OPERATORS
- See Also:
-
SEPARATORS
- See Also:
-
SEPARATORS2
- See Also:
-
shellVariables
Characters that are part of "$" shell variables; e.g., "$_"
.- See Also:
-
currentTokenStart
private int currentTokenStart -
currentTokenType
private int currentTokenType
-
-
Constructor Details
-
UnixShellTokenMaker
public UnixShellTokenMaker()Constructor.
-
-
Method Details
-
addToken
Checks the token to give it the exact ID it deserves before being passed up to the super method.- Overrides:
addToken
in classTokenMakerBase
- 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 the token occurs.
-
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
- Overrides:
getLineCommentStartAndEnd
in classTokenMakerBase
- 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.- Specified by:
getMarkOccurrencesOfTokenType
in interfaceTokenMaker
- Overrides:
getMarkOccurrencesOfTokenType
in classTokenMakerBase
- Parameters:
type
- The token type.- Returns:
- Whether tokens of this type should have "mark occurrences" enabled.
-
getWordsToHighlight
Returns the words to highlight for UNIX shell scripts.- Specified by:
getWordsToHighlight
in classAbstractTokenMaker
- Returns:
- A
TokenMap
containing the words to highlight for UNIX shell scripts. - See Also:
-
getTokenList
Returns a list of tokens representing the given text.- Parameters:
text
- The text to break into tokens.startTokenType
- The token with which to start tokenizing.startOffset
- The offset at which the line of tokens begins.- Returns:
- A linked list of tokens representing
text
.
-