quarkdown-core/com.quarkdown.core.lexer.scan/LineCursor

LineCursor

class LineCursor(lines: List<Line>, val index: Int)

An immutable view over the lines of a source, positioned at one of them. Recognizers receive a cursor and never mutate it, so no state is shared between them.

Parameters

lines

every line of the source

index

index of the line the cursor points at

Constructors

LineCursor

constructor(lines: List<Line>, index: Int)

Properties

current

val current: Line

The line the cursor points at.

index

val index: Int

remaining

val remaining: Int

Amount of lines from the cursor to the end of the source, the current one included.

Functions

fun at(offset: Int): LineCursor?

blankLinesAfter

fun LineCursor.blankLinesAfter(lineCount: Int): Int

emptyLinesAfter

fun LineCursor.emptyLinesAfter(lineCount: Int): Int

extendThrough

fun <T : Any> LineCursor.extendThrough(from: Int = 1, end: BlockEnd = BlockEnd.BEFORE_TERMINATOR, closes: (Line) -> T?): Pair<BlockExtent, T>?

Resolves an extent that grows up to and including the first line closes accepts, which is the shape of every fenced block.

extendToEnd

fun LineCursor.extendToEnd(end: BlockEnd = BlockEnd.BEFORE_TERMINATOR): BlockExtent

Covers every line left, which is where a block that never closes ends.

extendWhile

fun LineCursor.extendWhile(from: Int = 1, end: BlockEnd = BlockEnd.BEFORE_TERMINATOR, continues: (LineCursor) -> Boolean): BlockExtent

Resolves an extent that grows for as long as continues accepts the line after it. Paragraphs, block quotes, footnote definitions, table rows and blank runs differ only in the predicate and in end.

extent

fun LineCursor.extent(lineCount: Int = 1, end: BlockEnd = BlockEnd.BEFORE_TERMINATOR): BlockExtent

Resolves an extent of a known amount of lines.

lineCountThrough

fun lineCountThrough(index: Int): Int?

match

fun LineCursor.match(extent: BlockExtent, wrap: (TokenData) -> Token): BlockMatch

Builds a match from a resolved BlockExtent.

fun LineCursor.match(lineCount: Int, endIndex: Int, wrap: (TokenData) -> Token): BlockMatch

Builds a match whose token covers the source from the cursor's line up to endIndex. Prefer the BlockExtent overload, which resolves the line count and the end together. This one serves the kinds whose text is not line-aligned: the comment, the page break and the zero-width function call flag.

peek

fun peek(offset: Int): Line?

spanTo

fun spanTo(lineCount: Int): Int