mixinafPegger::RuleCtx

Returns the current position in the underlying input stream.

Returns true if at the End-Of-Stream.

Returns any previously set, user-defined meta from the last Rule processed.

Logs the given message to debug. It is formatted to be the same as the other Pegger debug messages.

Returns a PEG specific ParseErr to be thrown.

Peeks a character relative to the current position (Does not consume any characters). For example:

• peekChar(2) - returns char at currentPos + 2
• peekChar(-1) - returns char at currentPos - 1

Returns null if out of bounds.

Peeks and returns as a string, the next XX characters. peekChar() is much more performant (creates less objects), but use peekStr() for a quick win!

Returns null if out of bounds.

Call to process a sub-rule. Returns true if it matched successfully.

Consumes 1 character from the underlying input stream.

Retuns 0 if out of bounds.

Consumes and returns as a string, the next XX characters. readChar() is much more performant (creates less objects), but use readStr() for a quick win!

Returns null if out of bounds.

Rolls back the underlying input stream to the given position.

Sets user-defined meta to be returned in the resultant Match. This should be called by Rule subclasses during their doProcess() method, should they expect to return true.

Returns true if at the Start-Of-Stream.

Returns the string we are matching against.