classSyntaxException

packages/bison-parser/src/SyntaxException.php:20

final class SyntaxException
    extends RuntimeException

Public API: explicitly declared with @visibility public.

The grammar file is not written the way Bison would accept it.

Reporting where a file is wrongdoctest

$exception = \BisonParser\SyntaxException::unexpected("a rule or ';'", "'|'", new \BisonParser\Ast\Location(3, 1));
    $exception->getMessage() // => "Expected a rule or ';' but found '|' at 3:1"
    (string) $exception->location // => "3:1"

Properties§

public Location $location

source §

Methods§

public function __construct(string $message, public Location $location)

source §

Parameters

`$message`	`string`	What is wrong
`$location`	`Location`	Where it is wrong

Calls 1

static-call RuntimeException::__construct() line 28

public static function unexpected(string $expected, string $found, Location $location): self

source §

Describes something other than what the grammar language allows at a position.

Parameters

`$expected`	`string`	What was expected
`$found`	`string`	What was met instead
`$location`	`Location`	Where it was met

Returns

self The exception

Test cases 1

SyntaxExceptionTest::testUnexpected calls

Called from 14

Calls 1

new self line 42

public static function unterminated(string $construct, string $closer, Location $location): self

source §

Describes a construct that never closes.

Parameters

`$construct`	`string`	What was opened
`$closer`	`string`	What should have closed it
`$location`	`Location`	Where it was opened

Returns

self The exception

Test cases 1

SyntaxExceptionTest::testUnterminated calls

Called from 8

Calls 1

new self line 56

public static function invalid(string $what, Location $location): self

source §

Describes text that is not part of the grammar language.

Parameters

`$what`	`string`	The problem, as Bison would word it
`$location`	`Location`	Where it is

Returns

self The exception

Test cases 1

SyntaxExceptionTest::testInvalid calls

Called from 10

Calls 2

new self line 69
function-call ucfirst line 69

Test cases 71§

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

Dedicated tests 4

SyntaxExceptionTest::testGetMessage calls
SyntaxExceptionTest::testInvalid calls
SyntaxExceptionTest::testUnexpected calls
SyntaxExceptionTest::testUnterminated calls

Other tests reaching this symbol 67

Relations§

Static calls 32