classToken

packages/bison-parser/src/Scanner/Token.php:18

final class Token

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

One token of a grammar file.

The text is what the token stands for: a directive without its percent sign, a literal decoded, code without its braces, a tag without its angle brackets. The raw spelling is kept only where a directive has several.

Properties§

public TokenKind $kind

source §

public string $text

source §

public Location $location

source §

public string $raw = ''

source §

Methods§

public function __construct(
    public TokenKind $kind,
    public string $text,
    public Location $location,
    public string $raw = '',
)

source §

Parameters

`$kind`	`TokenKind`	What the token is
`$text`	`string`	What it stands for
`$location`	`Location`	Where it begins
`$raw`	`string`	The directive, number or literal as written; empty for other tokens

public function is(TokenKind $kind): bool

source §

Reports whether the token is of a given kind.

Parameters

$kind TokenKind Kind to compare with

Returns

bool True when the kinds match

Test cases 1

TokenTest::testIs calls

Called from 7

public function isDirective(string $name): bool

source §

Reports whether the token is a given directive.

Parameters

$name string Canonical directive name without the percent sign

Returns

bool True for that directive

Test cases 1

TokenTest::testIsDirective calls

Calls 1

class-const TokenKind::Directive() line 55

public function describe(): string

source §

Describes the token for an error message.

Returns

string The kind, and the text when it helps

Test cases 1

TokenTest::testDescribe calls

Called from 1

method-call BisonParser\Syntax\SymbolListParser::symbol() packages/bison-parser/src/Syntax/SymbolListParser.php:253

Calls 9

class-const TokenKind::Directive() line 65
class-const TokenKind::Identifier() line 68
class-const TokenKind::IdentifierColon() line 68
function-call in_array line 71
class-const TokenKind::Colon() line 71
class-const TokenKind::Equal() line 71
class-const TokenKind::Pipe() line 71
class-const TokenKind::Semicolon() line 71
class-const TokenKind::Section() line 71

Test cases 25§

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

Dedicated tests 3

Other tests reaching this symbol 22

BisonGrammarCompilerTest calls
BisonGrammarReaderTest calls
ParserTest calls
ScannerTest::testScan calls
ScannerTest::testScanEndsWithoutAnEpilogue calls
ScannerTest::testScanKeepsLineDirectivesAtTheStartOfALine calls
DeclarationParserTest::testDirectiveRejectsARuleModifier calls
DeclarationParserTest::testLine calls
DeclarationParserTest::testStarts calls
GrammarParserTest calls
RuleParserTest::testParseRejectsAMissingColon calls
SymbolListParserTest::testKind calls
SymbolListParserTest::testStartsSymbol calls
SymbolListParserTest::testSymbol calls
SymbolListParserTest::testSymbolRejectsAnotherToken calls
TokenStreamTest::testAccept calls
TokenStreamTest::testExpect calls
TokenStreamTest::testExpectRejectsAnotherToken calls
TokenStreamTest::testIs calls
TokenStreamTest::testIsDirective calls
TokenStreamTest::testNext calls
TokenStreamTest::testPeek calls

Relations§

Instantiated in 18

Method calls 8

Type declarations 17