Class Lexer

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__

(inherited documentation)

reset the parser's state; subclasses must rewinds the input stream

Overrides: BaseRecognizer.reset

(inherited documentation)

Return a token from this source; i.e., match a token on the char stream.

Overrides: TokenSource.nextToken

Instruct the lexer to skip creating a token for current lexer rule and look for another token. nextToken() knows to keep looking when a lexer rule finishes with token set to SKIP_TOKEN. Recall that if token==null at end of any token rule, it creates one for you and emits it.

Overrides: BaseRecognizer.getSourceName

The standard method called to automatically emit a token at the outermost lexical rule. The token object should point into the char buffer start..stop. If there is a text override in 'text', use that to set the token's text. Override this method to emit custom Token objects.

If you are building trees, then you should also override Parser or TreeParser.getMissingSymbol().

Match current input symbol against ttype. Attempt single token insertion or deletion error recovery. If that fails, throw MismatchedTokenException.

To turn off single token insertion or deletion error recovery, override recoverFromMismatchedToken() and have it throw an exception. See TreeParser.recoverFromMismatchedToken(). This way any error in a rule will cause an exception and immediate exit from rule. Rule would recover by resynchronizing to the set of symbols that can follow rule ref.

Overrides: BaseRecognizer.match

(inherited documentation)

Match the wildcard: in a symbol

Overrides: BaseRecognizer.matchAny

(inherited documentation)

Report a recognition problem.
    
This method sets errorRecovery to indicate the parser is recovering
not parsing.  Once in recovery mode, no errors are generated.
To get out of recovery mode, the parser must successfully match
a token (after a resync).  So it will go:

1. error occurs
2. enter recovery mode, report error
3. consume until token found in resynch set
4. try to resume parsing
5. next match() will reset errorRecovery mode

If you override, make sure to update syntaxErrors if you care about
that.

Overrides: BaseRecognizer.reportError

(inherited documentation)

What error message should be generated for the various exception types?

Not very object-oriented code, but I like having all error message generation within one method rather than spread among all of the exception classes. This also makes it much easier for the exception handling because the exception classes do not have to have pointers back to this object to access utility routines and so on. Also, changing the message for an exception type would be difficult because you would have to subclassing exception, but then somehow get ANTLR to make those kinds of exception objects instead of the default. This looks weird, but trust me--it makes the most sense in terms of flexibility.

For grammar debugging, you will want to override this to add more information such as the stack frame with getRuleInvocationStack(e, this.getClass().getName()) and, for no viable alts, the decision description and state etc...

Override this to change the message generated for one or more exception types.

Overrides: BaseRecognizer.getErrorMessage

(inherited documentation)

Lexers can normally match any char in it's vocabulary after matching a token, so do the easy thing and just kill a character and hope it all works out. You can instead use the rule invocation stack to do sophisticated error recovery if you are in a fragment rule.

Overrides: BaseRecognizer.recover

Overrides: BaseRecognizer.traceIn

Overrides: BaseRecognizer.traceOut

text

Return the text matched so far for the current token or any text override.

Get Method:

getText(self) - Return the text matched so far for the current token or any text override.

Set Method:

setText(self, text) - Set the complete text of this token; it wipes any previous changes to the text.