public class UnixShellTokenMaker extends AbstractTokenMaker
Token
s
for syntax highlighting UNIX shell scripts.Modifier and Type | Field and Description |
---|---|
protected Token |
currentToken
Used in the creation of the linked list.
|
protected Token |
firstToken
The first token in the returned linked list.
|
protected String |
operators |
protected Token |
previousToken
Used in the creation of the linked list.
|
protected String |
separators |
protected String |
separators2 |
protected String |
shellVariables |
wordsToHighlight
Constructor and Description |
---|
UnixShellTokenMaker()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
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(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 whether this programming language uses curly braces
('{' and '}') to denote code blocks.
|
Action |
getInsertBreakAction()
Returns an action to handle "insert break" key presses (i.e.
|
int |
getLastTokenTypeOnLine(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. |
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)
The default implementation returns
false always. |
Token |
getTokenList(Segment text,
int startTokenType,
int startOffset)
Returns a list of tokens representing the given text.
|
TokenMap |
getWordsToHighlight()
Returns the words to highlight for UNIX shell scripts.
|
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.
|
removeLastToken
protected final String operators
protected final String separators
protected final String separators2
protected final String shellVariables
protected Token firstToken
protected Token currentToken
protected Token previousToken
public void addToken(Segment segment, int start, int end, int tokenType, int startOffset)
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.public String[] getLineCommentStartAndEnd()
getLineCommentStartAndEnd
in interface TokenMaker
public boolean getMarkOccurrencesOfTokenType(int type)
getMarkOccurrencesOfTokenType
in interface TokenMaker
type
- The token type.public TokenMap getWordsToHighlight()
getWordsToHighlight
in class AbstractTokenMaker
TokenMap
containing the words to highlight for
UNIX shell scripts.AbstractTokenMaker.getWordsToHighlight()
public Token getTokenList(Segment text, int startTokenType, int startOffset)
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.text
.public void addNullToken()
addNullToken
in interface TokenMaker
public void addToken(char[] array, int start, int end, int tokenType, int startOffset)
addToken
in interface TokenMaker
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.public void addToken(char[] array, int start, int end, int tokenType, int startOffset, boolean hyperlink)
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.public boolean getCurlyBracesDenoteCodeBlocks()
The default implementation returns false
; subclasses can
override this method if necessary.
getCurlyBracesDenoteCodeBlocks
in interface TokenMaker
public Action getInsertBreakAction()
null
. Subclasses
can override.getInsertBreakAction
in interface TokenMaker
null
.public int getLastTokenTypeOnLine(Segment text, int initialTokenType)
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.getLastTokenTypeOnLine
in interface TokenMaker
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
).Token.NULL
if the line was completed.public boolean getShouldIndentNextLineAfter(Token token)
false
always. Languages
that wish to better support auto-indentation can override this method.getShouldIndentNextLineAfter
in interface TokenMaker
token
- The token the previous line ends with.public boolean isMarkupLanguage()
false
always.
Subclasses that are highlighting a markup language should override this
method to return true
.isMarkupLanguage
in interface TokenMaker
false
always.protected void resetTokenList()
getLastTokenTypeOnLine(Segment, int)
or
TokenMaker.getTokenList(Segment, int, int)
.public void setWhitespaceVisible(boolean visible, RSyntaxTextArea textArea)
setWhitespaceVisible
in interface TokenMaker
visible
- Whether whitespace should be visible.