org.fife.ui.rsyntaxtextarea.modes
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

public class UnixShellTokenMaker

extends AbstractTokenMaker

A token maker that turns text into a linked list of Tokens for syntax highlighting UNIX shell scripts.

Version:

0.1

Author:

Robert Futrell

Field Summary

protected java.lang.String	operators
protected java.lang.String	separators
protected java.lang.String	separators2
protected java.lang.String	shellVariables

Fields inherited from class org.fife.ui.rsyntaxtextarea.AbstractTokenMaker

currentToken, firstToken, previousToken, wordsToHighlight

Constructor Summary

UnixShellTokenMaker()
Constructor.

Method Summary

void	addToken(javax.swing.text.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.
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.
Token	getTokenList(javax.swing.text.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.

Methods inherited from class org.fife.ui.rsyntaxtextarea.AbstractTokenMaker

addNullToken, addToken, addToken, getCurlyBracesDenoteCodeBlocks, getInsertBreakAction, getLastTokenTypeOnLine, getShouldIndentNextLineAfter, isMarkupLanguage, isWhitespaceVisible, removeLastToken, resetTokenList, setWhitespaceVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

operators

protected final java.lang.String operators

See Also:

Constant Field Values

separators

protected final java.lang.String separators

See Also:

Constant Field Values

separators2

protected final java.lang.String separators2

See Also:

Constant Field Values

shellVariables

protected final java.lang.String shellVariables

See Also:

Constant Field Values

Constructor Detail

UnixShellTokenMaker

public UnixShellTokenMaker()

Constructor.

Method Detail

addToken

public void addToken(javax.swing.text.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.

Parameters:

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.

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.

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.

getWordsToHighlight

public TokenMap getWordsToHighlight()

Returns the words to highlight for UNIX shell scripts.

Specified by:

getWordsToHighlight in class AbstractTokenMaker

Returns:

A TokenMap containing the words to highlight for UNIX shell scripts.

See Also:

AbstractTokenMaker.getWordsToHighlight()

getTokenList

public Token getTokenList(javax.swing.text.Segment text,
                          int startTokenType,
                          int startOffset)

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.