Package org.opengrok.indexer.analysis

Interface JFlexLexer

All Known Subinterfaces:
JFlexJointLexer, JFlexStackingLexer, ScanningSymbolMatcher
All Known Implementing Classes:
AdaSymbolTokenizer, AdaXref, AsmSymbolTokenizer, AsmXref, ClojureSymbolTokenizer, ClojureXref, CSharpSymbolTokenizer, CSharpXref, CSymbolTokenizer, CXref, CxxSymbolTokenizer, CxxXref, EiffelSymbolTokenizer, EiffelXref, ErlangSymbolTokenizer, ErlangXref, FortranSymbolTokenizer, FortranXref, GolangSymbolTokenizer, GolangXref, HaskellSymbolTokenizer, HaskellXref, HCLLexer, HCLSymbolTokenizer, HCLXref, JavaScriptLexer, JavaScriptSymbolTokenizer, JavaScriptXref, JavaSymbolTokenizer, JavaXref, JFlexNonXref, JFlexStateStacker, JFlexSymbolMatcher, JsonSymbolTokenizer, JsonXref, KotlinSymbolTokenizer, KotlinXref, LispSymbolTokenizer, LispXref, LuaSymbolTokenizer, LuaXref, MandocXref, OCamlSymbolTokenizer, OCamlXref, PascalSymbolTokenizer, PascalXref, PerlSymbolTokenizer, PerlXref, PhpSymbolTokenizer, PhpXref, PlainFullTokenizer, PlainSymbolTokenizer, PlainXref, PLSQLSymbolTokenizer, PLSQLXref, PoshSymbolTokenizer, PoshXref, PythonSymbolTokenizer, PythonXref, RLexer, RSymbolTokenizer, RubySymbolTokenizer, RubyXref, RustSymbolTokenizer, RustXref, RXref, ScalaSymbolTokenizer, ScalaXref, ShSymbolTokenizer, ShXref, SQLSymbolTokenizer, SQLXref, SwiftSymbolTokenizer, SwiftXref, TclSymbolTokenizer, TclXref, TerraformSymbolTokenizer, TerraformXref, TroffFullTokenizer, TroffXref, TypeScriptSymbolTokenizer, TypeScriptXref, UuencodeFullTokenizer, UuencodeXref, VBSymbolTokenizer, VBXref, VerilogSymbolTokenizer, VerilogXref, XMLXref, YamlSymbolTokenizer, YamlXref
public interface JFlexLexer
Represents an API for lexers created by JFlex for %type int.

http://jflex.de

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    yybegin(int lexicalState)
    Enters the lexical state lexicalState [as documented by JFlex].
    char
    yycharat(int pos)
    Gets a character from the matched input text as documented by JFlex.
    void
    yyclose()
    Closes the input stream [as documented by JFlex].
    int
    yylength()
    Gets the matched input text length as documented by JFlex.
    int
    yylex()
    "Runs the scanner [as documented by JFlex].
    void
    yypushback(int number)
    "Pushes number characters of the matched text back into the input stream [as documented by JFlex].
    void
    yyreset(Reader reader)
    Closes the current input stream [as documented by JFlex], and resets the scanner to read from a new Reader.
    int
    yystate()
    Gets the current lexical state as documented by JFlex.
    String
    yytext()
    Gets the matched input text as documented by JFlex.

  • Method Details

    • yytext

      String yytext()
      Gets the matched input text as documented by JFlex.
      Returns:
      "the matched input text region"

    • yylength

      int yylength()
      Gets the matched input text length as documented by JFlex.
      Returns:
      "the length of the matched input text region (does not require a String object to be created)"

    • yycharat

      char yycharat(int pos)
      Gets a character from the matched input text as documented by JFlex.
      Parameters:
      pos - "a value from 0 to yylength()-1"
      Returns:
      "the character at position pos from the matched text. It is equivalent to yytext() then String.charAt(int) -- but faster."

    • yyclose

      void yyclose() throws IOException
      Closes the input stream [as documented by JFlex]. All subsequent calls to the scanning method will return the end of file value.
      Throws:
      IOException - if an error occurs while closing

    • yyreset

      void yyreset(Reader reader)
      Closes the current input stream [as documented by JFlex], and resets the scanner to read from a new Reader.
      Parameters:
      reader - the new reader

    • yystate

      int yystate()
      Gets the current lexical state as documented by JFlex.
      Returns:
      "the current lexical state of the scanner."

    • yybegin

      void yybegin(int lexicalState)
      Enters the lexical state lexicalState [as documented by JFlex].
      Parameters:
      lexicalState - the new state

    • yypushback

      void yypushback(int number)
      "Pushes number characters of the matched text back into the input stream [as documented by JFlex].

      [The characters] will be read again in the next call of the scanning method.

      The number of characters to be read again must not be greater than the length of the matched text. The pushed back characters will not be included in yylength() and yytext()."

      Parameters:
      number - the [constrained] number of characters

    • yylex

      int yylex() throws IOException
      "Runs the scanner [as documented by JFlex].

      [The method] can be used to get the next token from the input."

      "Consume[s] input until one of the expressions in the specification is matched or an error occurs."

      Returns:
      a value returned by the lexer specification if defined or the EOF value upon reading end-of-file
      Throws:
      IOException - if an error occurs reading the input