hSimulator.simulator.gui
Class CustomToken

java.lang.Object
  extended by org.fife.ui.rsyntaxtextarea.TokenMakerBase
      extended by org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker
          extended by hSimulator.simulator.gui.CustomToken
All Implemented Interfaces:
org.fife.ui.rsyntaxtextarea.TokenMaker

public class CustomToken
extends org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker

This object is part of the HSimulator GUI. These classes are internal classes not documented according to the Javadoc standard.

Version:
1.0
Author:
Luca Marchetti, Alessandro Pozzer

Field Summary
static int EOL_COMMENT
          lexical states
static int YYEOF
          This character denotes the end of file
static int YYINITIAL
           
 
Constructor Summary
CustomToken()
          Constructor.
CustomToken(InputStream in)
          Creates a new scanner.
CustomToken(Reader in)
          Creates a new scanner There is also a java.io.InputStream version of this constructor.
 
Method Summary
 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.
 String[] getLineCommentStartAndEnd(int languageIndex)
          Returns the text to place at the beginning and end of a line to "comment" it in this programming language.
 org.fife.ui.rsyntaxtextarea.Token getTokenList(Segment text, int initialTokenType, int startOffset)
          Returns the first token in the linked list of tokens generated from text.
 void yybegin(int newState)
          Enters a new lexical state
 char yycharat(int pos)
          Returns the character at position pos from the matched text.
 void yyclose()
          Closes the input stream.
 int yylength()
          Returns the length of the matched text region.
 org.fife.ui.rsyntaxtextarea.Token yylex()
          Resumes scanning until the next regular expression is matched, the end of input is encountered or an I/O-Error occurs.
 void yypushback(int number)
          Pushes the specified amount of characters back into the input stream.
 void yyreset(Reader reader)
          Resets the scanner to read from a new input stream.
 int yystate()
          Returns the current lexical state.
 String yytext()
          Returns the text matched by the current regular expression.
 
Methods inherited from class org.fife.ui.rsyntaxtextarea.TokenMakerBase
addNullToken, addToken, addToken, getClosestStandardTokenTypeForInternalType, getCurlyBracesDenoteCodeBlocks, getInsertBreakAction, getLastTokenTypeOnLine, getMarkOccurrencesOfTokenType, getOccurrenceMarker, getShouldIndentNextLineAfter, isIdentifierChar, isMarkupLanguage
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

YYEOF

public static final int YYEOF
This character denotes the end of file

See Also:
Constant Field Values

EOL_COMMENT

public static final int EOL_COMMENT
lexical states

See Also:
Constant Field Values

YYINITIAL

public static final int YYINITIAL
See Also:
Constant Field Values
Constructor Detail

CustomToken

public CustomToken()
Constructor. This must be here because JFlex does not generate a no-parameter constructor.


CustomToken

public CustomToken(Reader in)
Creates a new scanner There is also a java.io.InputStream version of this constructor.

Parameters:
in - the java.io.Reader to read input from.

CustomToken

public CustomToken(InputStream in)
Creates a new scanner. There is also java.io.Reader version of this constructor.

Parameters:
in - the java.io.Inputstream to read input from.
Method Detail

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.

Overrides:
addToken in class org.fife.ui.rsyntaxtextarea.TokenMakerBase
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.

getLineCommentStartAndEnd

public String[] getLineCommentStartAndEnd(int languageIndex)
Returns the text to place at the beginning and end of a line to "comment" it in this programming language.

Specified by:
getLineCommentStartAndEnd in interface org.fife.ui.rsyntaxtextarea.TokenMaker
Overrides:
getLineCommentStartAndEnd in class org.fife.ui.rsyntaxtextarea.TokenMakerBase
Parameters:
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.
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 of null for the array means this language does not support commenting/uncommenting lines.

getTokenList

public org.fife.ui.rsyntaxtextarea.Token getTokenList(Segment text,
                                                      int initialTokenType,
                                                      int startOffset)
Returns the first token in the linked list of tokens generated from text. This method must be implemented by subclasses so they can correctly implement syntax highlighting.

Parameters:
text - The text from which to get tokens.
initialTokenType - The token type we should start with.
startOffset - The offset into the document at which text starts.
Returns:
The first Token in a linked list representing the syntax highlighted text.

yyreset

public final void yyreset(Reader reader)
Resets the scanner to read from a new input stream. Does not close the old reader. All internal variables are reset, the old input stream cannot be reused (internal buffer is discarded and lost). Lexical state is set to YY_INITIAL.

Parameters:
reader - the new input stream

yyclose

public final void yyclose()
                   throws IOException
Closes the input stream.

Throws:
IOException

yystate

public final int yystate()
Returns the current lexical state.


yybegin

public final void yybegin(int newState)
Enters a new lexical state

Specified by:
yybegin in class org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker
Parameters:
newState - the new lexical state

yytext

public final String yytext()
Returns the text matched by the current regular expression.


yycharat

public final char yycharat(int pos)
Returns the character at position pos from the matched text. It is equivalent to yytext().charAt(pos), but faster

Parameters:
pos - the position of the character to fetch. A value from 0 to yylength()-1.
Returns:
the character at position pos

yylength

public final int yylength()
Returns the length of the matched text region.


yypushback

public void yypushback(int number)
Pushes the specified amount of characters back into the input stream. They will be read again by then next call of the scanning method

Parameters:
number - the number of characters to be read again. This number must not be greater than yylength()!

yylex

public org.fife.ui.rsyntaxtextarea.Token yylex()
                                        throws IOException
Resumes scanning until the next regular expression is matched, the end of input is encountered or an I/O-Error occurs.

Returns:
the next token
Throws:
IOException - if any I/O-Error occurs