classPreprocessor

packages/lemon-parser/src/Preprocessor/Preprocessor.php:25

final class Preprocessor

Public API: explicitly declared with @visibility public.

Settles %if, %ifdef, %ifndef, %else and %endif before the file is scanned.

As in Lemon's preprocess_input, a directive counts only at the start of a line, the directive lines and the excluded lines are blanked rather than removed, so every position in the result is a position in the original, and an excluded region may nest further directives.

Blanking a region that is not defineddoctest

$preprocessor = new \LemonParser\Preprocessor\Preprocessor();
    $preprocessor->preprocess("a ::= B.\n%ifdef X\na ::= C.\n%endif\na ::= D.\n", []) // => "a ::= B.\n        \n        \n      \na ::= D.\n"
    $preprocessor->preprocess("%ifndef X || Y\na ::= C.\n%endif\n", ['Y']) // => "              \n        \n      \n"

Methods§

public function preprocess(string $source, list<string> $defines): string

source §

Replaces excluded regions and directive lines with spaces.

Parameters

`$source`	`string`	The grammar file
`$defines`	`list<string>`	The names defined on the command line

Returns

string The file with the same line breaks and directives settled

Throws

SyntaxException When a region is not closed or an expression is not well formed

Test cases 6

Called from 1

method-call LemonParser\Parser::parse() packages/lemon-parser/src/Parser.php:60

Calls 11

new Condition line 39
new Exclusion line 40
function-call strlen line 42
method-call Preprocessor::directive() line 50
method-call Preprocessor::settle() line 54
new Location line 54
method-call Preprocessor::blank() line 55
method-call Preprocessor::lineEnd() line 55
method-call Exclusion::depth() line 57
new SyntaxException line 58
method-call Exclusion::startLine() line 58

public function settle(
    string $source,
    int $index,
    string $directive,
    Exclusion $exclusion,
    Condition $condition,
    Location $location,
): string

source §

Applies one directive to the excluded region and blanks the region it closes.

Parameters

`$source`	`string`	The file
`$index`	`int`	Where the `%` is
`$directive`	`string`	`endif`, `else`, `if`, `ifdef` or `ifndef`
`$exclusion`	`Exclusion`	The region being excluded, if any
`$condition`	`Condition`	Evaluates expressions
`$location`	`Location`	Where the directive is

Returns

string The file with a closed region blanked

Test cases 2

Called from 1

method-call LemonParser\Preprocessor\Preprocessor::preprocess() packages/lemon-parser/src/Preprocessor/Preprocessor.php:54

Calls 7

method-call Exclusion::depth() line 79
method-call Exclusion::leave() line 79
method-call Preprocessor::blank() line 79
method-call Exclusion::start() line 79
method-call Exclusion::enter() line 88
method-call Exclusion::nest() line 94
method-call Preprocessor::opens() line 95

public function directive(string $source, int $index): string|null

source §

Recognises the directive at a % as Lemon does.

Parameters

`$source`	`string`	The file
`$index`	`int`	Where the `%` is

Returns

string|null `endif`, `else`, `ifdef`, `if`, `ifndef`, or null for anything else

Test cases 1

PreprocessorTest::testDirective calls

Called from 1

method-call LemonParser\Preprocessor\Preprocessor::preprocess() packages/lemon-parser/src/Preprocessor/Preprocessor.php:50

Calls 3

function-call substr line 113
function-call ctype_space line 113
function-call strlen line 118

public function opens(
    Condition $condition,
    string $source,
    int $index,
    string $directive,
    Location $location,
): bool

source §

Evaluates an opening directive and says whether it excludes what follows.

Parameters

`$condition`	`Condition`	Evaluates expressions
`$source`	`string`	The file
`$index`	`int`	Where the `%` is
`$directive`	`string`	`if`, `ifdef` or `ifndef`
`$location`	`Location`	Where the directive is

Returns

bool True when the region is excluded

Test cases 1

PreprocessorTest::testOpens calls

Called from 1

method-call LemonParser\Preprocessor\Preprocessor::settle() packages/lemon-parser/src/Preprocessor/Preprocessor.php:95

Calls 4

method-call Preprocessor::lineEnd() line 139
function-call strcspn line 140
method-call Condition::evaluate() line 141
function-call substr line 141

public function lineEnd(string $source, int $index): int

source §

Finds where the line holding an index ends.

Parameters

`$source`	`string`	The file
`$index`	`int`	An index in the line

Returns

int The index of the newline, or the length of the file

Test cases 1

PreprocessorTest::testLineEnd calls

Called from 2

Calls 2

function-call strpos line 156
function-call strlen line 158

public function blank(string $source, int $from, int $to): string

source §

Replaces every byte but newlines with a space.

Parameters

`$source`	`string`	The file
`$from`	`int`	The first index to blank
`$to`	`int`	The index after the last one

Returns

string The file with the region blanked

Test cases 1

PreprocessorTest::testBlank calls

Called from 3

Calls 2

function-call substr line 172
function-call preg_replace line 174

Test cases 15§

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

Dedicated tests 12

Other tests reaching this symbol 3

Relations§

Instantiated in 1

new LemonParser\Parser::__construct() packages/lemon-parser/src/Parser.php:42

Method calls 1

method-call LemonParser\Parser::parse() packages/lemon-parser/src/Parser.php:60

Type declarations 1

type LemonParser\Parser packages/lemon-parser/src/Parser.php:42