Class PythonTokenMaker
- java.lang.Object
- 
- org.fife.ui.rsyntaxtextarea.TokenMakerBase
- 
- org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker
- 
- org.fife.ui.rsyntaxtextarea.modes.PythonTokenMaker
 
 
 
- 
- All Implemented Interfaces:
- TokenMaker
 
 public class PythonTokenMaker extends AbstractJFlexTokenMaker Scanner for the Python programming language.
- 
- 
Field SummaryFields Modifier and Type Field Description static intLONG_STRING_1static intLONG_STRING_2static intYYEOFThis character denotes the end of filestatic intYYINITIALlexical states- 
Fields inherited from class org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMakeroffsetShift, s, start
 - 
Fields inherited from class org.fife.ui.rsyntaxtextarea.TokenMakerBasecurrentToken, firstToken, previousToken
 
- 
 - 
Constructor SummaryConstructors Constructor Description PythonTokenMaker()Constructor.PythonTokenMaker(InputStream in)Creates a new scanner.PythonTokenMaker(Reader in)Creates a new scanner There is also a java.io.InputStream version of this constructor.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddToken(char[] array, int start, int end, int tokenType, int startOffset)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.TokengetTokenList(Segment text, int initialTokenType, int startOffset)Returns the first token in the linked list of tokens generated fromtext.voidyybegin(int newState)Enters a new lexical statecharyycharat(int pos)Returns the character at position pos from the matched text.voidyyclose()Closes the input stream.intyylength()Returns the length of the matched text region.Tokenyylex()Resumes scanning until the next regular expression is matched, the end of input is encountered or an I/O-Error occurs.voidyypushback(int number)Pushes the specified amount of characters back into the input stream.voidyyreset(Reader reader)Resets the scanner to read from a new input stream.intyystate()Returns the current lexical state.Stringyytext()Returns the text matched by the current regular expression.- 
Methods inherited from class org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMakeryybegin
 - 
Methods inherited from class org.fife.ui.rsyntaxtextarea.TokenMakerBaseaddNullToken, addToken, addToken, createOccurrenceMarker, getClosestStandardTokenTypeForInternalType, getCurlyBracesDenoteCodeBlocks, getInsertBreakAction, getLanguageIndex, getLastTokenTypeOnLine, getMarkOccurrencesOfTokenType, getOccurrenceMarker, getShouldIndentNextLineAfter, isIdentifierChar, isMarkupLanguage, resetTokenList, setLanguageIndex
 
- 
 
- 
- 
- 
Field Detail- 
YYEOFpublic static final int YYEOF This character denotes the end of file- See Also:
- Constant Field Values
 
 - 
YYINITIALpublic static final int YYINITIAL lexical states- See Also:
- Constant Field Values
 
 - 
LONG_STRING_2public static final int LONG_STRING_2 - See Also:
- Constant Field Values
 
 - 
LONG_STRING_1public static final int LONG_STRING_1 - See Also:
- Constant Field Values
 
 
- 
 - 
Constructor Detail- 
PythonTokenMakerpublic PythonTokenMaker() Constructor. This must be here because JFlex does not generate a no-parameter constructor.
 - 
PythonTokenMakerpublic PythonTokenMaker(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.
 
 - 
PythonTokenMakerpublic PythonTokenMaker(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- 
addTokenpublic void addToken(char[] array, int start, int end, int tokenType, int startOffset)Adds the token specified to the current linked list of tokens.- Specified by:
- addTokenin interface- TokenMaker
- Overrides:
- addTokenin class- 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.
 
 - 
getLineCommentStartAndEndpublic 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:
- getLineCommentStartAndEndin interface- TokenMaker
- Overrides:
- getLineCommentStartAndEndin class- 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- TokenMakerwhat sub-language to look at.
- Returns:
- The start and end strings to add to a line to "comment"
         it out.  A nullvalue for either means there is no string to add for that part. A value ofnullfor the array means this language does not support commenting/uncommenting lines.
 
 - 
getTokenListpublic Token getTokenList(Segment text, int initialTokenType, int startOffset) Returns the first token in the linked list of tokens generated fromtext. 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- textstarts.
- Returns:
- The first Tokenin a linked list representing the syntax highlighted text.
 
 - 
yyresetpublic 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
 
 - 
yyclosepublic final void yyclose() throws IOExceptionCloses the input stream.- Throws:
- IOException
 
 - 
yystatepublic final int yystate() Returns the current lexical state.
 - 
yybeginpublic final void yybegin(int newState) Enters a new lexical state- Specified by:
- yybeginin class- AbstractJFlexTokenMaker
- Parameters:
- newState- the new lexical state
 
 - 
yytextpublic final String yytext() Returns the text matched by the current regular expression.
 - 
yycharatpublic 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
 
 - 
yylengthpublic final int yylength() Returns the length of the matched text region.
 - 
yypushbackpublic 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()!
 
 - 
yylexpublic 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
 
 
- 
 
-