token-parser/dev.kordex.parser/Cursor

Cursor

class Cursor(val input: String)

Class representing an iteration position over a given string, with convenience functions. This is intended for use with the token parsing system, but you can use it for other things too.

Parameters

input

Input string to iterate over. Never modified.

Constructors

Cursor

constructor(input: String)

Properties

hasNext

val hasNext: Boolean

Returns true if there are more characters left to iterate over.

hasPrevious

val hasPrevious: Boolean

Returns true if there are characters to iterate backwards to.

index

var index: Int

Current iteration index, starting at -1.

input

val input: String

Functions

consumeNumber

fun consumeNumber(amount: Int): String

Consume amount characters from this cursor, returning them as a String. Will stop consuming and return when the cursor runs out of characters, instead of throwing.

consumeRemaining

fun consumeRemaining(): String

Iterate over the rest of the string, returning the result.

consumeWhile

fun consumeWhile(predicate: (Char) -> Boolean): String?

Iterate over the rest of the string as long as the predicate returns true, returning the result.

fun next(): Char

Increment the index and return the character found there, throwing if we're at the end of the string.

nextOrNull

fun nextOrNull(): Char?

Increment the index and return the character found there, or null if we're at the end of the string.

peek

fun peek(): Char

Return the character at the current index.

peekNext

fun peekNext(): Char?

Return the character at the next index, or null if we're at the end of the string.

peekPrevious

fun peekPrevious(): Char?

Return the character at the previous index, or null if we're at the start of the string.

fun previous(): Char

Decrement the index and return the character found there, throwing if we're at the start of the string.

previousOrNull

fun previousOrNull(): Char?

Decrement the index and return the character found there, or null if we're at the start of the string.

skipWhitespace

fun skipWhitespace(): Boolean

Skip any immediate whitespace, updating the index.