classCursor

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

final class Cursor

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

Reads a grammar file byte by byte, keeping the line and column.

Properties§

public string $source

source §

Methods§

public function __construct(public string $source)

source §

Parameters

$source string The whole file

public function eof(): bool

source §

Reports whether everything has been read.

Returns

bool True at the end of the file

Test cases 2

CursorTest::testEof calls
ScannerTest::testSkipTrivia calls

Called from 6

Calls 1

function-call strlen line 36

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

source §

Answers the byte at a distance ahead without consuming it.

Parameters

$ahead int Distance from the current position

Returns

string The byte, or an empty string past the end

Test cases 1

CursorTest::testPeek calls

Called from 8

public function offset(): int

source §

Answers the current byte offset.

Returns

int Offset from the start of the file

Test cases 4

public function location(): Location

source §

Answers the current position as a line and column.

Returns

Location The position

Test cases 2

CursorTest::testLocation calls
CursorTest::testTakeUntil calls

Called from 11

Calls 1

new Location line 68

public function startsWith(string $prefix): bool

source §

Reports whether the unread text starts with a string.

Parameters

$prefix string Text to look for

Returns

bool True when the next bytes spell the prefix

Test cases 1

CursorTest::testStartsWith calls

Called from 8

Calls 2

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

public function take(int $length): string

source §

Consumes a number of bytes and answers them, counting the lines they hold.

Parameters

$length int How many bytes to consume

Returns

string The consumed bytes

Test cases 14

CodeReaderTest::testBraced calls
CodeReaderTest::testBracedClosesOnTheBraceThatBalancesADigraph calls
CodeReaderTest::testBracedSplicesBackslashNewlines calls
CodeReaderTest::testPrologue calls
CursorTest::testEof calls
CursorTest::testLocation calls
CursorTest::testMatch calls
CursorTest::testOffset calls
CursorTest::testStartsWith calls
CursorTest::testTake calls
CursorTest::testTakeUntil calls
ScannerTest::testBracketed calls
ScannerTest::testPercent calls
ScannerTest::testSkipTrivia calls

Called from 16

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 §

Consumes what a pattern matches at the current position.

Parameters

$pattern string Regular expression without anchors or delimiters

Returns

string|null The matched text, or null when nothing matches here

Test cases 1

CursorTest::testMatch calls

Called from 17

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 lookingAt(string $pattern): bool

source §

Reports whether a pattern matches at the current position, without consuming it.

Parameters

$pattern string Regular expression without anchors or delimiters

Returns

bool True when it matches here

Test cases 1

CursorTest::testLookingAt calls

Called from 1

method-call BisonParser\Scanner\Scanner::integer() packages/bison-parser/src/Scanner/Scanner.php:239

Calls 2

function-call preg_match line 130
function-call str_replace line 130

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

source §

Consumes everything up to and including a delimiter.

Parameters

$needle string Text that ends the run

Returns

string|null The consumed text without the delimiter, or null when the file ends first

Test cases 1

CursorTest::testTakeUntil calls

Called from 1

method-call BisonParser\Scanner\Scanner::skipTrivia() packages/bison-parser/src/Scanner/Scanner.php:87

Calls 3

function-call strpos line 142
method-call Cursor::take() line 146
function-call strlen line 147

Private surface 3§

Implementation details, listed for orientation only.

private int $offset = 0

private int $line = 1

private int $column = 1

Test cases 53§

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

Dedicated tests 9

Other tests reaching this symbol 44

Relations§

Instantiated in 1

new BisonParser\Scanner\Scanner::scan() packages/bison-parser/src/Scanner/Scanner.php:48

Method calls 65

Type declarations 12