classLexicalException

Generation packages/sql-faker/src/Generation/Exception/LexicalException.php:22

final class LexicalException
    extends RuntimeException

Public API: explicitly declared with @visibility public.

Reports missing lexical definitions, incompatible candidates and diagnostic tokenizer failures.

Generation checks source-derived lexical and spacing conditions before serialization. Tokenizer diagnostics remain available separately; token equality is not the acceptance oracle.

Catch this failure as a runtime exceptiondoctest

$failure = new \SqlFaker\Generation\Exception\LexicalException('SQL generation failed');
    $failure instanceof \RuntimeException // => true
    $failure->getMessage() // => 'SQL generation failed'

Methods§

public static function unsupportedTerminal(
    string $dialect,
    string $version,
    string $terminal,
): self

100%source §

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

Reports a terminal without an applicable lexical generator.

Parameters

`$dialect`	`string`	Dialect label supplied by the calling implementation
`$version`	`string`	Lexical profile version in use
`$terminal`	`string`	Terminal that was asked for

Returns

self Exception naming the terminal and the profile

Test cases 2

Called from 1

static-call SqlFaker\Generation\Output\ReverseLexemeGenerator::select() packages/sql-faker/src/Generation/Output/ReverseLexemeGenerator.php:84

Calls 1

new self line 36

public static function unsupportedInput(string $dialect, int $offset, string $sql): self

100%source §

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

Reports SQL text the tokenizer cannot read at all.

Parameters

`$dialect`	`string`	Dialect name as it appears in messages
`$offset`	`int`	Where the tokenizer stopped
`$sql`	`string`	The text being read

Returns

self Exception naming the offset and the text

Test cases 2

Called from 3

Calls 1

new self line 51

public static function noProgress(string $dialect, int $offset, string $sql): self

100%source §

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

Reports a read that did not get past where it started.

A scanner that stays where it is has not read anything, and the loop around it would run forever. Saying so at the point it happens turns a hang into a failure that names the offset it happened at.

Parameters

`$dialect`	`string`	Dialect name as it appears in messages
`$offset`	`int`	Offset the read started and ended at
`$sql`	`string`	The text being read

Returns

self Exception naming the offset and the text

Test cases 1

LexicalExceptionTest::testNoProgressNamesTheOffsetTheReadGotStuckAt covers and calls

Called from 6

Calls 1

new self line 70

public static function unterminatedQuotedToken(string $dialect, string $sql): self

100%source §

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

Reports a quoted run that never closes.

Parameters

`$dialect`	`string`	Dialect name as it appears in messages
`$sql`	`string`	The text being read

Returns

self Exception naming the text

Test cases 1

LexicalExceptionTest::testUnterminatedQuotedTokenNamesTheText covers and calls

Called from 3

Calls 1

new self line 84

public static function unterminatedBracketIdentifier(string $dialect): self

100%source §

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

Reports a bracketed identifier that never closes.

Parameters

$dialect string Dialect name as it appears in messages

Returns

self Exception describing the truncation

Test cases 1

LexicalExceptionTest::testUnterminatedBracketIdentifierNamesTheDialect covers and calls

Called from 1

static-call SqlFaker\Sqlite\Generation\Tokenization\SqliteTokenizer::quotedTokenAt() packages/sql-faker/src/Sqlite/Generation/Tokenization/SqliteTokenizer.php:152

Calls 1

new self line 97

public static function unterminatedBlockComment(string $dialect): self

100%source §

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

Reports a block comment that never closes.

Parameters

$dialect string Dialect name as it appears in messages

Returns

self Exception describing the truncation

Test cases 1

LexicalExceptionTest::testUnterminatedBlockCommentNamesTheDialect covers and calls

Called from 3

Calls 1

new self line 110

public static function unterminatedDollarQuotedString(string $dialect): self

100%source §

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

Reports a dollar-quoted string that never closes.

Parameters

$dialect string Dialect name as it appears in messages

Returns

self Exception describing the truncation

Test cases 1

LexicalExceptionTest::testUnterminatedDollarQuotedStringNamesTheDialect covers and calls

Called from 2

Calls 1

new self line 123

public static function lexemeDoesNotRealizeTerminal(
    string $dialect,
    string $terminal,
    string $lexeme,
): self

100%source §

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

Reports a caller-supplied lexeme that does not tokenize to the terminal it was given for.

Parameters

`$dialect`	`string`	Dialect name as it appears in messages
`$terminal`	`string`	Terminal the lexeme was meant to realize
`$lexeme`	`string`	The text the caller asked for

Returns

self Exception naming the terminal and the text

Test cases 1

LexicalExceptionTest::testLexemeDoesNotRealizeTerminalNamesBoth covers and calls

Calls 1

new self line 138

public static function noWitnessForLexeme(
    string $dialect,
    string $terminal,
    string $lexeme,
): self

100%source §

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

Formats a legacy lexical-catalog diagnostic for callers retaining such reports.

Parameters

`$dialect`	`string`	Dialect name as it appears in messages
`$terminal`	`string`	Terminal the lexeme was meant to realize
`$lexeme`	`string`	The text the caller asked for

Returns

self Exception naming the terminal and the text

Test cases 1

LexicalExceptionTest::testNoWitnessForLexemeNamesBoth covers and calls

Calls 1

new self line 153

public static function roundTripMismatch(
    string $dialect,
    string $version,
    list<string> $expected,
    list<string> $actual,
    string $sql,
): self

100%source §

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

Reports SQL that did not tokenize back to the terminals it was generated from.

This diagnostic compares a generated token sequence with a local tokenizer. It does not determine whether the target database accepts the SQL.

Parameters

`$dialect`	`string`	Dialect name as it appears in messages
`$version`	`string`	Lexical profile version in use
`$expected`	`list<string>`	Tokens the terminals were meant to produce
`$actual`	`list<string>`	Tokens the text actually produced
`$sql`	`string`	The generated text

Returns

self Exception carrying both sequences and the text

Test cases 1

LexicalExceptionTest::testRoundTripMismatchCarriesBothSequencesAndTheText covers and calls

Calls 3

new self line 178
function-call sprintf line 178
static-call LexicalException::rendered() line 182

public static function rendered(list<string> $tokens): string

100%source §

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

Renders a token sequence for a failure message.

The sequences being compared came out of arbitrary generated bytes, so rendering them can meet input JSON has no encoding for. Substituting those bytes keeps the round-trip failure reportable: a message that could itself fail would hide the thing worth reporting behind an encoding error.

Parameters

$tokens list<string> Tokens to render

Returns

string The sequence as JSON, or a placeholder when it cannot be rendered

Test cases 3

LexicalExceptionTest::testRenderedSubstitutesBytesJsonHasNoEncodingFor covers and calls
LexicalExceptionTest::testRenderedWritesAnOrdinarySequenceAsJson covers and calls
LexicalExceptionTest::testRoundTripMismatchCarriesBothSequencesAndTheText covers

Called from 2

Calls 2

function-call json_encode line 204
function-call is_string line 206

Test cases 61§

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

Dedicated tests 14

LexicalExceptionTest::testLexemeDoesNotRealizeTerminalNamesBoth covers and calls
LexicalExceptionTest::testNoProgressNamesTheOffsetTheReadGotStuckAt covers and calls
LexicalExceptionTest::testNoWitnessForLexemeNamesBoth covers and calls
LexicalExceptionTest::testRealizingAnUnknownTerminalReportsTheTerminal covers and calls
LexicalExceptionTest::testRenderedSubstitutesBytesJsonHasNoEncodingFor covers and calls
LexicalExceptionTest::testRenderedWritesAnOrdinarySequenceAsJson covers and calls
LexicalExceptionTest::testRoundTripMismatchCarriesBothSequencesAndTheText covers and calls
LexicalExceptionTest::testTokenizingUnsupportedInputReportsTheOffsetAndTheInput covers and calls
LexicalExceptionTest::testUnsupportedInputNamesTheOffsetAndTheText covers and calls
LexicalExceptionTest::testUnsupportedTerminalNamesTheTerminalAndTheProfile covers and calls
LexicalExceptionTest::testUnterminatedBlockCommentNamesTheDialect covers and calls
LexicalExceptionTest::testUnterminatedBracketIdentifierNamesTheDialect covers and calls
LexicalExceptionTest::testUnterminatedDollarQuotedStringNamesTheDialect covers and calls
LexicalExceptionTest::testUnterminatedQuotedTokenNamesTheText covers and calls

Other tests reaching this symbol 47

Relations§

Instantiated in 7

Static calls 19