classDeclarationParser

packages/bison-parser/src/Syntax/DeclarationParser.php:36

final class DeclarationParser

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

Reads one declaration, following the prologue_declaration and grammar_declaration rules of parse-gram.y.

Methods§

public function __construct(private SymbolListParser $symbols = new \BisonParser\Syntax\SymbolListParser())

source §

Parameters

$symbols SymbolListParser Reads the symbol lists of declarations

Calls 1

new SymbolListParser line 41

public function starts(Token $token): bool

source §

Reports whether a token begins a declaration.

Parameters

$token Token Token to look at

Returns

bool True for a prologue or a directive that is not a rule modifier

Test cases 1

DeclarationParserTest::testStarts calls

Called from 2

Calls 5

method-call Token::is() line 54
class-const TokenKind::Prologue() line 54
class-const TokenKind::Line() line 55
class-const TokenKind::Directive() line 56
function-call in_array line 56

public function parse(TokenStream $tokens): Declaration

source §

Reads the declaration that begins at the current token.

Parameters

$tokens TokenStream Tokens positioned on a prologue or directive

Returns

Declaration The declaration

Throws

SyntaxException When the directive lacks its argument or is not a declaration

Test cases 3

Called from 3

Calls 8

method-call TokenStream::next() line 70
class-const TokenKind::Prologue() line 71
new Prologue line 72
class-const TokenKind::Line() line 74
method-call DeclarationParser::line() line 75
class-const TokenKind::Directive() line 77
static-call SyntaxException::unexpected() line 78
method-call DeclarationParser::directive() line 81

public function line(Token $token): Line

source §

Turns a #line token into its node.

Parameters

$token Token The token, whose text is the directive as written

Returns

Line The node

Test cases 1

DeclarationParserTest::testLine calls

Called from 2

Calls 2

function-call preg_match line 93
new Line line 95

public function directive(Token $token, TokenStream $tokens): Declaration

source §

Reads the arguments of a directive whose name token was just consumed.

Parameters

`$token`	`Token`	The directive token
`$tokens`	`TokenStream`	Tokens positioned after the directive

Returns

Declaration The declaration

Throws

SyntaxException When the directive lacks its argument or is not a declaration

Test cases 5

Called from 1

method-call BisonParser\Syntax\DeclarationParser::parse() packages/bison-parser/src/Syntax/DeclarationParser.php:81

Calls 34

function-call in_array line 112
class-const Directives::FLAGS() line 112
new Flag line 113
class-const Directives::OPTIONS() line 115
method-call TokenStream::accept() line 116
class-const TokenKind::String() line 116
method-call TokenStream::expect() line 116
new Option line 118
method-call DeclarationParser::define() line 122
new Expect line 123
class-const TokenKind::Integer() line 123
new InitialAction line 124
class-const TokenKind::Code() line 124
new Param line 125
static-call ParamKind::from() line 125
method-call DeclarationParser::codes() line 125
new UnionDeclaration line 126
class-const TokenKind::Identifier() line 126
new Start line 127
method-call SymbolListParser::symbols() line 127
new CodeProps line 128
method-call SymbolListParser::targets() line 128
new Code line 129
new SymbolDeclaration line 130
class-const SymbolClass::Token() line 130
method-call SymbolListParser::tokenDeclarations() line 130
class-const SymbolClass::Nonterminal() line 131
method-call SymbolListParser::ntermDeclarations() line 131
class-const SymbolClass::Type() line 132
method-call SymbolListParser::typeDeclarations() line 132
new PrecedenceDeclaration line 133
static-call Associativity::from() line 133
method-call SymbolListParser::precedenceDeclarations() line 133
static-call SyntaxException::unexpected() line 134

public function define(TokenStream $tokens, Location $at): Define

source §

Reads the variable and optional value of a %define.

Parameters

`$tokens`	`TokenStream`	Tokens positioned after the directive
`$at`	`Location`	Where the directive is written

Returns

Define The declaration

Throws

SyntaxException When no variable follows

Test cases 2

Called from 1

method-call BisonParser\Syntax\DeclarationParser::directive() packages/bison-parser/src/Syntax/DeclarationParser.php:122

Calls 12

method-call TokenStream::expect() line 150
class-const TokenKind::Identifier() line 150
method-call TokenStream::accept() line 151
class-const TokenKind::Equal() line 151
method-call TokenStream::is() line 153
class-const DefineForm::Keyword() line 154
class-const TokenKind::String() line 155
class-const DefineForm::String() line 156
class-const TokenKind::Code() line 157
class-const DefineForm::Code() line 158
new Define line 161
method-call TokenStream::next() line 164

public function codes(TokenStream $tokens, string $name): list<string>

source §

Reads the one or more braced arguments of a %param directive.

Parameters

`$tokens`	`TokenStream`	Tokens positioned after the directive
`$name`	`string`	Directive name, for the error

Returns

list<string> Each argument's code without its braces

Throws

SyntaxException When no braced argument follows

Test cases 2

Called from 1

method-call BisonParser\Syntax\DeclarationParser::directive() packages/bison-parser/src/Syntax/DeclarationParser.php:125

Calls 3

method-call TokenStream::expect() line 179
class-const TokenKind::Code() line 179
method-call TokenStream::accept() line 180

Private surface 1§

Implementation details, listed for orientation only.

private SymbolListParser $symbols = new \BisonParser\Syntax\SymbolListParser()

Test cases 19§

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

Dedicated tests 14

Other tests reaching this symbol 5

Relations§

Instantiated in 2

Method calls 6

Type declarations 2