SourceCursor

Represents the state and context of a parsing operation, containing the input string as well as positional information.

Companion:
object
class Object
trait Matchable
class Any

Type members

Types

Value members

Abstract methods

def atEnd: Boolean

Indicates whether this contexts offset is behind the last character of the input string

Indicates whether this contexts offset is behind the last character of the input string

def capture(numChars: Int): String

Captures a string containing the specified number of characters from the current offset. If the number of remaining characters is less than the specified number, all remaining characters will be returned.

Captures a string containing the specified number of characters from the current offset. If the number of remaining characters is less than the specified number, all remaining characters will be returned.

def consume(numChars: Int): Self

Consumes the specified number of characters, returning a new SourceCursor with the new offset.

Consumes the specified number of characters, returning a new SourceCursor with the new offset.

def input: String

The full input string, containing the string portions before and after the current offset.

The full input string, containing the string portions before and after the current offset.

def nestLevel: Int

The nest level of this cursor in case of recursive parsing.

The nest level of this cursor in case of recursive parsing.

Create a new instance of this cursor with the nestLevel incremented.

Create a new instance of this cursor with the nestLevel incremented.

def offset: Int

The offset of this cursor from the start of the source.

The offset of this cursor from the start of the source.

The current position in the input string.

The current position in the input string.

def remaining: Int

Indicates the number of characters remaining in the input string after the current offset.

Indicates the number of characters remaining in the input string after the current offset.

Returns a new SourceCursor with the input string being reversed, but pointing to the same character as this context.

Returns a new SourceCursor with the input string being reversed, but pointing to the same character as this context.

This is a low-level optimization for parsers that look for strings like email addresses where the first character is not significant, so that parsing backwards from any @ encountered in the input provided better performance.

The source for the root input, positioned to match the offset of this (potentially nested) source.

The source for the root input, positioned to match the offset of this (potentially nested) source.

Concrete methods

def char: Char

The character at the current offset.

The character at the current offset.

def charAt(relativeOffset: Int): Char

The character at the specified offset, relative from the current offset.

The character at the specified offset, relative from the current offset.

def length: Int

The length of the input of this cursor.

The length of the input of this cursor.

def path: Option[Path]

The (virtual) path of the document this input originates from; may be empty in case of generated sources.

The (virtual) path of the document this input originates from; may be empty in case of generated sources.