classBisonAlternativeReader

Compiler packages/sql-faker/src/Compiler/Bison/Rule/BisonAlternativeReader.php:23

final class BisonAlternativeReader

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

Reads the alternatives on the right-hand side of one rule.

Bison lets the final semicolon be left out, so an alternative list also ends where the next rule begins — an identifier followed by a colon — or at the end of the section. All three endings complete the alternative in hand, which is why the reader looks two tokens ahead before it consumes anything.

Methods§

public function readAll(BisonTokenStream $stream): list<BisonAlternativeNode>

100%source §

Reads every alternative of the current rule.

Parameters

$stream BisonTokenStream Stream positioned on the first symbol after the colon

Returns

list<BisonAlternativeNode> The alternatives, always at least one

Test cases 6

BisonAlternativeReaderTest::testReadAllDoesNotCarryAnActionIntoTheNextAlternative covers and calls
BisonAlternativeReaderTest::testReadAllKeepsEachAlternativesOwnAction covers and calls
BisonAlternativeReaderTest::testReadAllSplitsAlternativesOnThePipe covers and calls
BisonAlternativeReaderTest::testReadAllStopsAtTheEndOfTheSection covers and calls
BisonAlternativeReaderTest::testReadAllStopsWhereTheNextRuleBegins covers and calls
BisonAlternativeReaderTest::testReadAllTakesTheSymbolsUpToTheSemicolon covers and calls

Called from 1

method-call SqlFaker\Compiler\Bison\Rule\BisonRuleReader::read() packages/sql-faker/src/Compiler/Bison/Rule/BisonRuleReader.php:81

Calls 8

new BisonAlternativeDraft line 34
method-call BisonAlternativeReader::endsTheRule() line 38
method-call BisonAlternativeDraft::complete() line 39
method-call BisonTokenStream::peek() line 44
class-const BisonLexeme::Semicolon() line 45
method-call BisonTokenStream::next() line 46
class-const BisonLexeme::Pipe() line 52
method-call BisonAlternativeReader::readPart() line 58

public function endsTheRule(BisonTokenStream $stream): bool

100%source §

Reports whether the alternative list is over without consuming anything.

Parameters

$stream BisonTokenStream Stream to look ahead in

Returns

bool True at the end of the section or at the start of the next rule

Test cases 10

Called from 1

method-call SqlFaker\Compiler\Bison\Rule\BisonAlternativeReader::readAll() packages/sql-faker/src/Compiler/Bison/Rule/BisonAlternativeReader.php:38

Calls 6

method-call BisonTokenStream::peek() line 71
class-const BisonLexeme::Eof() line 73
class-const BisonLexeme::PercentPercent() line 73
class-const BisonLexeme::Identifier() line 77
method-call BisonTokenStream::peekN() line 77
class-const BisonLexeme::Colon() line 77

public function readPart(BisonTokenStream $stream, BisonAlternativeDraft $draft): void

100%source §

Reads one symbol, action or inline directive into the alternative.

Parameters

`$stream`	`BisonTokenStream`	Stream positioned on the part to read
`$draft`	`BisonAlternativeDraft`	Alternative being assembled

Test cases 9

Called from 1

method-call SqlFaker\Compiler\Bison\Rule\BisonAlternativeReader::readAll() packages/sql-faker/src/Compiler/Bison/Rule/BisonAlternativeReader.php:58

Calls 22

method-call BisonTokenStream::peek() line 88
class-const BisonLexeme::Action() line 89
method-call BisonAlternativeDraft::setAction() line 89
method-call BisonTokenStream::nextString() line 89
class-const BisonLexeme::Identifier() line 90
method-call BisonAlternativeDraft::addSymbol() line 90
new BisonSymbolNode line 91
class-const BisonSymbolForm::Identifier() line 91
class-const BisonLexeme::CharLiteral() line 93
class-const BisonSymbolForm::CharLiteral() line 94
class-const BisonLexeme::Directive() line 96
method-call BisonAlternativeReader::readInlineDirective() line 96
class-const BisonLexeme::Number() line 97
class-const BisonLexeme::StringLiteral() line 98
class-const BisonLexeme::TypeTag() line 99
class-const BisonLexeme::Colon() line 100
class-const BisonLexeme::Semicolon() line 101
class-const BisonLexeme::Pipe() line 102
class-const BisonLexeme::PercentPercent() line 103
class-const BisonLexeme::Prologue() line 104
class-const BisonLexeme::Eof() line 105
method-call BisonTokenStream::next() line 105

public function readInlineDirective(
    BisonTokenStream $stream,
    BisonAlternativeDraft $draft,
): void

67%source §

Applies %prec, %dprec or %merge to the alternative being read.

Parameters

`$stream`	`BisonTokenStream`	Stream positioned on the directive
`$draft`	`BisonAlternativeDraft`	Alternative being assembled

Test cases 2

BisonAlternativeReaderTest::testReadInlineDirectiveAppliesPrecedence covers and calls
BisonAlternativeReaderTest::testReadInlineDirectiveIgnoresADirectiveItDoesNotModel covers and calls

Called from 1

method-call SqlFaker\Compiler\Bison\Rule\BisonAlternativeReader::readPart() packages/sql-faker/src/Compiler/Bison/Rule/BisonAlternativeReader.php:96

Calls 7

method-call BisonTokenStream::nextString() line 117
method-call BisonAlternativeDraft::setPrecedenceSymbol() line 118
method-call BisonAlternativeReader::readPrecedenceSymbol() line 118
method-call BisonAlternativeDraft::setDynamicPrecedence() line 119
method-call BisonAlternativeReader::readDynamicPrecedence() line 119
method-call BisonAlternativeDraft::setMergeFunction() line 120
method-call BisonAlternativeReader::readMergeFunction() line 120

public function readPrecedenceSymbol(BisonTokenStream $stream): string|null

100%source §

Reads the terminal whose precedence %prec borrows.

Parameters

$stream BisonTokenStream Stream positioned just after `%prec`

Returns

string|null The terminal, or null when the directive named none

Test cases 3

BisonAlternativeReaderTest::testReadInlineDirectiveAppliesPrecedence covers
BisonAlternativeReaderTest::testReadPrecedenceSymbolReportsNothingWhenNoneIsNamed covers and calls
BisonAlternativeReaderTest::testReadPrecedenceSymbolTakesANameOrACharacter covers and calls

Called from 1

method-call SqlFaker\Compiler\Bison\Rule\BisonAlternativeReader::readInlineDirective() packages/sql-faker/src/Compiler/Bison/Rule/BisonAlternativeReader.php:118

Calls 3

method-call BisonTokenStream::nextIf() line 134
class-const BisonLexeme::Identifier() line 134
class-const BisonLexeme::CharLiteral() line 134

public function readDynamicPrecedence(BisonTokenStream $stream): int|null

100%source §

Reads the rank %dprec assigns to this alternative.

Parameters

$stream BisonTokenStream Stream positioned just after `%dprec`

Returns

int|null The rank, or null when the directive named none

Test cases 2

BisonAlternativeReaderTest::testReadDynamicPrecedenceReportsNothingWhenNoneIsNamed covers and calls
BisonAlternativeReaderTest::testReadDynamicPrecedenceTakesTheRank covers and calls

Called from 1

method-call SqlFaker\Compiler\Bison\Rule\BisonAlternativeReader::readInlineDirective() packages/sql-faker/src/Compiler/Bison/Rule/BisonAlternativeReader.php:119

Calls 2

method-call BisonTokenStream::nextIf() line 146
class-const BisonLexeme::Number() line 146

public function readMergeFunction(BisonTokenStream $stream): string|null

100%source §

Reads the merge function %merge names for this alternative.

Parameters

$stream BisonTokenStream Stream positioned just after `%merge`

Returns

string|null The function name, or null when the directive named none

Test cases 2

BisonAlternativeReaderTest::testReadMergeFunctionReportsNothingWhenNoneIsNamed covers and calls
BisonAlternativeReaderTest::testReadMergeFunctionTakesTheTaggedName covers and calls

Called from 1

method-call SqlFaker\Compiler\Bison\Rule\BisonAlternativeReader::readInlineDirective() packages/sql-faker/src/Compiler/Bison/Rule/BisonAlternativeReader.php:120

Calls 2

method-call BisonTokenStream::nextIf() line 158
class-const BisonLexeme::TypeTag() line 158

Test cases 23§

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

Dedicated tests 21

BisonAlternativeReaderTest::testEndsTheRuleConsumesNothing covers and calls
BisonAlternativeReaderTest::testEndsTheRuleReportsTheEndOfTheSection covers and calls
BisonAlternativeReaderTest::testEndsTheRuleReportsTheStartOfTheNextRule covers and calls
BisonAlternativeReaderTest::testEndsTheRuleTreatsALoneNameAsPartOfTheAlternative covers and calls
BisonAlternativeReaderTest::testReadAllDoesNotCarryAnActionIntoTheNextAlternative covers and calls
BisonAlternativeReaderTest::testReadAllKeepsEachAlternativesOwnAction covers and calls
BisonAlternativeReaderTest::testReadAllSplitsAlternativesOnThePipe covers and calls
BisonAlternativeReaderTest::testReadAllStopsAtTheEndOfTheSection covers and calls
BisonAlternativeReaderTest::testReadAllStopsWhereTheNextRuleBegins covers and calls
BisonAlternativeReaderTest::testReadAllTakesTheSymbolsUpToTheSemicolon covers and calls
BisonAlternativeReaderTest::testReadDynamicPrecedenceReportsNothingWhenNoneIsNamed covers and calls
BisonAlternativeReaderTest::testReadDynamicPrecedenceTakesTheRank covers and calls
BisonAlternativeReaderTest::testReadInlineDirectiveAppliesPrecedence covers and calls
BisonAlternativeReaderTest::testReadInlineDirectiveIgnoresADirectiveItDoesNotModel covers and calls
BisonAlternativeReaderTest::testReadMergeFunctionReportsNothingWhenNoneIsNamed covers and calls
BisonAlternativeReaderTest::testReadMergeFunctionTakesTheTaggedName covers and calls
BisonAlternativeReaderTest::testReadPartAddsACharacterSymbol covers and calls
BisonAlternativeReaderTest::testReadPartAddsANamedSymbol covers and calls
BisonAlternativeReaderTest::testReadPartSkipsWhatBelongsToNoAlternative covers and calls
BisonAlternativeReaderTest::testReadPrecedenceSymbolReportsNothingWhenNoneIsNamed covers and calls
BisonAlternativeReaderTest::testReadPrecedenceSymbolTakesANameOrACharacter covers and calls

Other tests reaching this symbol 2

BisonParserTest calls
BisonRuleReaderTest calls

Relations§

Instantiated in 1

new SqlFaker\Compiler\Bison\Rule\BisonRuleReader::__construct() packages/sql-faker/src/Compiler/Bison/Rule/BisonRuleReader.php:29

Method calls 1

method-call SqlFaker\Compiler\Bison\Rule\BisonRuleReader::read() packages/sql-faker/src/Compiler/Bison/Rule/BisonRuleReader.php:81

Type declarations 2