token-parser/dev.kordex.parser/StringParser

StringParser

open class StringParser(val input: String)

String parser, tokenizing the input as requested by the function calls. Intended for command argument parsing, but can be used for other things too if needed.

This parser supports:

Keyword arguments at any position (key=value)
Flag arguments at any position (--key value)
Quoted arguments with spaces ("value value value")
Unquoted arguments without spaces (value)

The recommended workflow is as follows:

Call parseNamed to parse out the keyword/flag arguments, removing them from the cursor
Call parseNext as required to parse out single or quoted tokens sequentially
Use the other functions to parse in more specific ways

Parameters

input

Input string to parse.

Constructors

StringParser

constructor(input: String)

Properties

cursor

var cursor: Cursor

Cursor object, representing the current parsing state. Initially, this will contain a Cursor that iterates over the entire input, but functions (eg parseNamed) may reassign it to change the iteration target.

hasNext

val hasNext: Boolean

Returns true if the cursor has more parsing to do.

input

open val input: String

Functions

consumeRemaining

fun consumeRemaining(): String

Consume whatever is left in the cursor, setting it to the end of its input string.

consumeWhile

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

Consume characters from the cursor while the predicate returns true, and return those characters joined into a String. If the predicate fails on the first character, null will be returned instead.

parseNamed

fun parseNamed(): List<NamedArgumentToken>

Parse all of the flag and keyword arguments out of the cursor, creating a new Cursor containing only the positional arguments and returning a list of parsed NamedArgumentTokens.

parseNext

fun parseNext(): PositionalArgumentToken?

Attempt to parse a single or quoted positional argument token from the cursor, returning it if there was a token, or null if there wasn't anything left to parse.

peekNext

fun peekNext(): PositionalArgumentToken?

Attempt to parse the next token and reset the cursor's index to what it was before parsing, before returning the result.

peekRemaining

fun peekRemaining(): String

Return whatever remains in the cursor's string, without consuming it'.

peekWhile

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

Collect characters from the cursor while the predicate returns true, and return those characters joined into a String. If the predicate fails on the first character, null will be returned instead. After characters have been collected, the cursor's index is reset, so the characters won't be consumed.