classCursor

packages/lemon-parser/src/Scanner/Cursor.php:14

final class Cursor

Restricted visibility: declared "@visibility root". Code outside that scope must not name this declaration.

A position in the text being scanned, with the line and column it is at.

Properties§

public string $source

source §

Methods§

public function __construct(public string $source)

source §

Parameters

$source string The text

public function eof(): bool

source §

Reports whether the end has been reached.

Returns

bool True at the end

Test cases 5

CodeReaderTest::testComment calls
CodeReaderTest::testLiteral calls
CursorTest::testEof calls
ScannerTest::testSkipTrivia calls
ScannerTest::testSkipTriviaRunsAnOpenCommentToTheEnd calls

Called from 4

Calls 1

function-call strlen line 36

public function peek(int $ahead = 0): string

source §

Looks at a byte without moving.

Parameters

$ahead int How many bytes past the current one

Returns

string The byte, or an empty string past the end

Test cases 1

CursorTest::testPeek calls

Called from 5

public function offset(): int

source §

Answers the byte offset.

Returns

int The offset from the start of the text

Test cases 3

Called from 2

public function location(): Location

source §

Answers the position.

Returns

Location Line and column of the current byte

Test cases 2

CursorTest::testLocation calls
CursorTest::testTakeUntil calls

Called from 3

Calls 1

new Location line 68

public function startsWith(string $prefix): bool

source §

Reports whether the text continues with a prefix.

Parameters

$prefix string What to look for

Returns

bool True when it follows

Test cases 1

CursorTest::testStartsWith calls

Called from 1

method-call LemonParser\Scanner\Scanner::skipTrivia() packages/lemon-parser/src/Scanner/Scanner.php:61

Calls 2

function-call substr_compare line 80
function-call strlen line 80

public function take(int $length): string

source §

Moves past a number of bytes.

Parameters

$length int How many bytes, cut short at the end

Returns

string The bytes moved past

Test cases 11

Called from 14

Calls 4

function-call substr line 92
function-call strlen line 93
function-call substr_count line 94
function-call strrpos line 97

public function match(string $pattern): string|null

source §

Moves past a pattern when it matches here.

Parameters

$pattern string A regular expression body without delimiters

Returns

string|null The match, or null when it does not match here

Test cases 1

CursorTest::testMatch calls

Called from 5

Calls 4

function-call preg_match line 114
function-call str_replace line 114
method-call Cursor::take() line 118
function-call strlen line 118

public function takeUntil(string $needle): string|null

source §

Moves past everything up to and including a needle.

Parameters

$needle string What to look for

Returns

string|null The text before the needle, or null when it is absent

Test cases 1

CursorTest::testTakeUntil calls

Called from 3

Calls 3

function-call strpos line 130
method-call Cursor::take() line 134
function-call strlen line 135

Private surface 3§

Implementation details, listed for orientation only.

private int $offset = 0

private int $line = 1

private int $column = 1

Test cases 23§

Test cases that cover or call this symbol, from the coverage report and from the analyzed test sources.

Dedicated tests 8

Other tests reaching this symbol 15

LemonGrammarCompilerTest calls
LemonGrammarReaderTest calls
ParserTest calls
CodeReaderTest::testComment calls
CodeReaderTest::testLiteral calls
CodeReaderTest::testRead calls
CodeReaderTest::testReadRejectsAnUnterminatedBlock calls
ScannerTest::testNext calls
ScannerTest::testNextRejectsAnUnterminatedString calls
ScannerTest::testSkipTrivia calls
ScannerTest::testSkipTriviaRunsAnOpenCommentToTheEnd calls
DeclarationReaderTest calls
GrammarReaderTest calls
RuleReaderTest calls
SymbolListReaderTest calls

Relations§

Instantiated in 1

new LemonParser\Scanner\Scanner::scan() packages/lemon-parser/src/Scanner/Scanner.php:37

Method calls 34

Type declarations 5