classEscapes

packages/bison-parser/src/Scanner/Escapes.php:20

final class Escapes

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

Decodes the escape sequences of Bison's character and string literals, and writes them back.

Bison decodes octal \NNN, hexadecimal \xHH, the C escapes \a \b \f \n \r \t \v, the quoted \" \' \? \\, and universal characters \uXXXX and \UXXXXXXXX that name a single byte. Anything else after a backslash is an error.

Methods§

public function decode(string $body, Location $location): string

source §

Decodes the body of a literal.

Parameters

`$body`	`string`	Text between the quotes
`$location`	`Location`	Where the literal begins, for the error

Returns

string The bytes the body stands for

Throws

SyntaxException When an escape is not one Bison accepts

Test cases 3

Called from 2

Calls 3

function-call strlen line 35
function-call substr line 42
method-call Escapes::escape() line 43

public function escape(string $rest, Location $location): array{string, int}

source §

Decodes the escape that starts right after a backslash.

Parameters

`$rest`	`string`	Text after the backslash
`$location`	`Location`	Where the literal begins, for the error

Returns

array{string, int} The bytes and how many bytes of the text were used

Throws

SyntaxException When the escape is not one Bison accepts

Test cases 7

Called from 1

method-call BisonParser\Scanner\Escapes::decode() packages/bison-parser/src/Scanner/Escapes.php:43

Calls 8

function-call preg_match line 63
method-call Escapes::byte() line 64
function-call octdec line 64
function-call strlen line 64
function-call hexdec line 67
function-call ltrim line 67
function-call substr line 67
static-call SyntaxException::invalid() line 78

public function byte(int $code, string $escape, Location $location): string

source §

Turns the number of an octal or hexadecimal escape into its byte, refusing what does not fit one.

Parameters

`$code`	`int`	The number
`$escape`	`string`	The escape as written, for the message
`$location`	`Location`	Where the literal is, for the message

Returns

string The byte

Throws

SyntaxException When the number is above 255, which Bison rejects

Test cases 2

EscapesTest::testByte calls
EscapesTest::testByteRejectsZero calls

Called from 3

Calls 2

static-call SyntaxException::invalid() line 95
function-call chr line 98

public function encode(string $bytes, string $quote): string

source §

Writes bytes as the body of a literal, escaping what must be escaped.

Parameters

`$bytes`	`string`	The bytes
`$quote`	`string`	The quote the literal uses

Returns

string Text to write between the quotes

Test cases 1

EscapesTest::testEncode calls

Called from 2

Calls 3

function-call str_split line 112
function-call ord line 119
function-call sprintf line 119

Test cases 25§

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 12

Relations§

Instantiated in 2

Method calls 4

Type declarations 2