classCondition

packages/lemon-parser/src/Preprocessor/Condition.php:19

final class Condition

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

Evaluates the expression after %if, %ifdef or %ifndef.

Lemon reads the expression left to right with no precedence: a name is true when it is defined, ! negates the next term, parentheses group, and || and && stop as soon as the answer is known.

Methods§

public function __construct(private list<string> $defines)

source §

Parameters

$defines list<string> The names defined on the command line

public function evaluate(string $text, Location $location): bool

source §

Evaluates an expression as eval_preprocessor_boolean does.

Parameters

`$text`	`string`	The expression
`$location`	`Location`	Where the directive is, for errors

Returns

bool The value

Throws

SyntaxException When the expression is not well formed

Test cases 8

Called from 2

Calls 4

function-call strlen line 43
function-call ctype_space line 46
method-call Condition::guard() line 50
method-call Condition::term() line 73

public function term(string $text, int $index, Location $location): array{bool, int}

source §

Evaluates a parenthesised group or a name.

Parameters

`$text`	`string`	The whole expression
`$index`	`int`	Where the term begins
`$location`	`Location`	Where the directive is, for errors

Returns

array{bool, int} The value and the index of the term's last byte

Throws

SyntaxException When the term is not a group or a name

Test cases 3

Called from 1

method-call LemonParser\Preprocessor\Condition::evaluate() packages/lemon-parser/src/Preprocessor/Condition.php:73

Calls 6

function-call strlen line 97
method-call Condition::evaluate() line 101
function-call substr line 101
method-call Condition::error() line 104
function-call preg_match line 106
function-call in_array line 110

public function guard(bool $condition, string $text, int $index, Location $location): void

source §

Raises the error unless a condition holds.

Parameters

`$condition`	`bool`	What must hold
`$text`	`string`	The whole expression
`$index`	`int`	Where the problem is
`$location`	`Location`	Where the directive is

Throws

SyntaxException When the condition does not hold

Test cases 1

ConditionTest::testGuard calls

Called from 4

Calls 1

method-call Condition::error() line 126

public function error(string $text, int $index, Location $location): SyntaxException

source §

Words the error as Lemon does.

Parameters

`$text`	`string`	The whole expression
`$index`	`int`	Where the problem is
`$location`	`Location`	Where the directive is

Returns

SyntaxException The error

Test cases 1

ConditionTest::testError calls

Called from 3

Calls 2

new SyntaxException line 141
function-call substr line 141

Private surface 1§

Implementation details, listed for orientation only.

private list<string> $defines

Test cases 19§

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 6

LemonGrammarCompilerTest calls
LemonGrammarReaderTest calls
ParserTest calls
PreprocessorTest::testOpens calls
PreprocessorTest::testSettle calls
PreprocessorTest::testSettleNestsInsideAnExcludedRegion calls

Relations§

Instantiated in 1

new LemonParser\Preprocessor\Preprocessor::preprocess() packages/lemon-parser/src/Preprocessor/Preprocessor.php:39

Method calls 1

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

Type declarations 2