classGrammarCompiler

packages/sql-faker/src/Generation/Plan/Compilation/GrammarCompiler.php:21

final class GrammarCompiler

Specializes grammar subtrees before making choices; every alternative retains its source production.

Methods§

public function __construct(private Grammar $grammar)

source §

Keeps the dialect grammar immutable across different plans.

Parameters

$grammar Grammar

public function compile(string $root, array<string, RulePlan> $plans): PreparedGrammar

source §

Parameters

`$root`	`string`
`$plans`	`array<string, RulePlan>`

Returns

PreparedGrammar

Throws

InvalidArgumentException When a declaration names an unknown rule

GenerationException When no finite derivation satisfies the conditions

Test cases 9

Called from 1

method-call SqlFaker\Generation\Derivation\TokenGenerator::prepare() packages/sql-faker/src/Generation/Derivation/TokenGenerator.php:110

Calls 8

method-call GrammarCompiler::validate() line 46
method-call GrammarCompiler::rule() line 47
new Scope line 47
new Grammar line 48
method-call TerminationAnalyzer::getMinLength() line 49
new TerminationAnalyzer line 49
static-call GenerationException::noAlternativeMatchingPlan() line 50
new PreparedGrammar line 52

public function validate(array<string, RulePlan> $plans): void

source §

Checks all declarations, including conditionally visited branches.

Parameters

$plans array<string, RulePlan>

Throws

InvalidArgumentException When a planned rule is absent from this grammar

Test cases 1

GrammarCompilerTest::testValidateAcceptsNestedChildAndListDeclarations calls

Called from 4

Calls 2

new InvalidArgumentException line 64
method-call GrammarCompiler::validate() line 66

public function rule(
    string $name,
    Scope $scope,
    non-empty-list<RulePlan>|null $items = null,
): string

source §

Memoizes recursive scopes before visiting their descendants.

Parameters

`$name`	`string`
`$scope`	`Scope`
`$items`	`non-empty-list<RulePlan>\|null`	Remaining items of a planned list

Returns

string

Test cases 2

Called from 3

Calls 10

static-call RulePlan::any() line 84
function-call serialize line 87
function-call count line 91
new ProductionRule line 94
function-call array_map line 97
method-call Symbol::value() line 97
method-call GrammarCompiler::item() line 101
method-call GrammarCompiler::hasChildren() line 106
method-call GrammarCompiler::symbols() line 110
new Production line 112

public function item(
    string $name,
    Production $production,
    non-empty-list<RulePlan>|null $items,
): RulePlan|false|null

source §

Lists may recurse at either end; item order always means output order.

Parameters

`$name`	`string`
`$production`	`Production`
`$items`	`non-empty-list<RulePlan>\|null`

Returns

RulePlan|false|null

Test cases 2

Called from 1

method-call SqlFaker\Generation\Plan\Compilation\GrammarCompiler::rule() packages/sql-faker/src/Generation/Plan/Compilation/GrammarCompiler.php:101

Calls 1

function-call count line 133

public function hasChildren(
    Production $production,
    array<string, array<int, RulePlan>> $children,
): bool

source §

Required child roles prune incompatible alternatives before generation.

Parameters

`$production`	`Production`
`$children`	`array<string, array<int, RulePlan>>`

Returns

bool

Test cases 1

GrammarCompilerTest::testHasChildrenRejectsARequiredRoleAbsentFromTheProduction calls

Called from 1

method-call SqlFaker\Generation\Plan\Compilation\GrammarCompiler::rule() packages/sql-faker/src/Generation/Plan/Compilation/GrammarCompiler.php:106

public function symbols(
    string $name,
    Production $production,
    Scope $scope,
    Scope $inner,
    non-empty-list<RulePlan>|null $items,
    array<string, array<int, RulePlan>> $children,
): list<Symbol>

source §

Compiles list tails in the list scope and each item's fields in its own scope.

Parameters

`$name`	`string`
`$production`	`Production`
`$scope`	`Scope`
`$inner`	`Scope`
`$items`	`non-empty-list<RulePlan>\|null`
`$children`	`array<string, array<int, RulePlan>>`

Returns

list<Symbol>

Throws

InvalidArgumentException When a recursive list tail has no items

Test cases 1

GrammarCompilerTest::testSymbolsPreserveInheritedRulesWhenSelectingAnOperand calls

Called from 1

method-call SqlFaker\Generation\Plan\Compilation\GrammarCompiler::rule() packages/sql-faker/src/Generation/Plan/Compilation/GrammarCompiler.php:110

Calls 7

function-call count line 187
function-call array_slice line 188
new InvalidArgumentException line 190
new Scope line 192
function-call array_replace line 192
new NonTerminal line 193
method-call GrammarCompiler::rule() line 193

Private surface 5§

Implementation details, listed for orientation only.

private array<string, string> $names = []

private array<string, string> $aliases = []

private array<string, ProductionRule> $rules = []

private array<string, array<int, array<string, LexemeConstraint>>> $lexemes = []

private Grammar $grammar

Test cases 17§

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

Dedicated tests 13

Other tests reaching this symbol 4

Relations§

Instantiated in 1

new SqlFaker\Generation\Derivation\TokenGenerator::prepare() packages/sql-faker/src/Generation/Derivation/TokenGenerator.php:110

Method calls 1

method-call SqlFaker\Generation\Derivation\TokenGenerator::prepare() packages/sql-faker/src/Generation/Derivation/TokenGenerator.php:110