PythonTokenMaker
Date: 2017-02-11

org.fife.ui.rsyntaxtextarea.modes

## 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 Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static int` | `LONG_STRING_1`
    `static int` | `LONG_STRING_2`
    `static int` | `YYEOF` This character denotes the end of file
    `static int` | `YYINITIAL` lexical states

    - ### Fields inherited from class org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker

      `offsetShift, s, start`

    - ### Fields inherited from class org.fife.ui.rsyntaxtextarea.TokenMakerBase

      `currentToken, firstToken, previousToken`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `PythonTokenMaker()` Constructor.
    `PythonTokenMaker(java.io.InputStream in)` Creates a new scanner.
    `PythonTokenMaker(java.io.Reader in)` Creates a new scanner There is also a java.io.InputStream version of this constructor.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addToken(char[] array, int start, int end, int tokenType, int startOffset)` Adds the token specified to the current linked list of tokens.
    `java.lang.String[]` | `getLineCommentStartAndEnd(int languageIndex)` Returns the text to place at the beginning and end of a line to "comment" it in this programming language.
    `Token` | `getTokenList(javax.swing.text.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.
    `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(java.io.Reader reader)` Resets the scanner to read from a new input stream.
    `int` | `yystate()` Returns the current lexical state.
    `java.lang.String` | `yytext()` Returns the text matched by the current regular expression.

    - ### Methods inherited from class org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker

      `yybegin`

    - ### Methods inherited from class org.fife.ui.rsyntaxtextarea.TokenMakerBase

      `addNullToken, addToken, addToken, createOccurrenceMarker, getClosestStandardTokenTypeForInternalType, getCurlyBracesDenoteCodeBlocks, getInsertBreakAction, getLanguageIndex, getLastTokenTypeOnLine, getMarkOccurrencesOfTokenType, getOccurrenceMarker, getShouldIndentNextLineAfter, isIdentifierChar, isMarkupLanguage, resetTokenList, setLanguageIndex`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, 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

    - #### YYINITIAL

          public static final int YYINITIAL

      lexical states
      See Also:
        Constant Field Values

    - #### LONG_STRING_2

          public static final int LONG_STRING_2

      See Also:
        Constant Field Values

    - #### LONG_STRING_1

          public static final int LONG_STRING_1

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### PythonTokenMaker

          public PythonTokenMaker()

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

    - #### PythonTokenMaker

          public PythonTokenMaker(java.io.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.

    - #### PythonTokenMaker

          public PythonTokenMaker(java.io.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)

      Adds the token specified to the current linked list of tokens.
      Specified by:
        `addToken` in interface `TokenMaker`
      Overrides:
        `addToken` in 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.

    - #### getLineCommentStartAndEnd

          public java.lang.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 `TokenMaker`
      Overrides:
        `getLineCommentStartAndEnd` in class `TokenMakerBase`
      Parameters:
        `languageIndex` - The language index at the offset in question. Since some `TokenMaker`s 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 Token getTokenList(javax.swing.text.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(java.io.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 java.io.IOException

      Closes the input stream.
      Throws:
        `java.io.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 `AbstractJFlexTokenMaker`
      Parameters:
        `newState` - the new lexical state

    - #### yytext

          public final java.lang.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 Token yylex()
                      throws java.io.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:
        `java.io.IOException` - if any I/O-Error occurs