classExclusion

packages/lemon-parser/src/Preprocessor/Exclusion.php:15

final class Exclusion

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

How deep the preprocessor is inside an excluded region, and where the region began.

Lemon counts nested %ifdef directives inside an excluded region so that only the matching %endif ends it.

Methods§

public function depth(): int

source §

Answers how many directives deep the excluded region is.

Returns

int Zero outside an excluded region

Test cases 6

ExclusionTest::testDepth calls
ExclusionTest::testEnter calls
ExclusionTest::testLeave calls
ExclusionTest::testNest calls
PreprocessorTest::testSettle calls
PreprocessorTest::testSettleNestsInsideAnExcludedRegion calls

Called from 5

public function start(): int

source §

Answers where the excluded region began.

Returns

int The byte offset of its directive

Test cases 2

ExclusionTest::testEnter calls
ExclusionTest::testStart calls

Called from 2

public function startLine(): int

source §

Answers the line the excluded region began on.

Returns

int The line number

Test cases 2

ExclusionTest::testEnter calls
ExclusionTest::testStartLine calls

Called from 1

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

public function enter(int $start, int $line): void

source §

Begins an excluded region.

Parameters

`$start`	`int`	The byte offset of its directive
`$line`	`int`	The line of its directive

Test cases 7

ExclusionTest::testDepth calls
ExclusionTest::testEnter calls
ExclusionTest::testLeave calls
ExclusionTest::testNest calls
ExclusionTest::testStart calls
ExclusionTest::testStartLine calls
PreprocessorTest::testSettleNestsInsideAnExcludedRegion calls

Called from 2

public function nest(): void

source §

Notes a further opening directive inside the excluded region.

Test cases 3

Called from 1

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

public function leave(): bool

source §

Notes a closing directive.

Returns

bool True when it ends the excluded region

Test cases 1

ExclusionTest::testLeave calls

Called from 2

Private surface 3§

Implementation details, listed for orientation only.

private int $depth = 0

private int $start = 0

private int $startLine = 1

Test cases 11§

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

Dedicated tests 6

Other tests reaching this symbol 5

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

Relations§

Instantiated in 1

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

Method calls 13

Type declarations 1

type LemonParser\Preprocessor\Preprocessor packages/lemon-parser/src/Preprocessor/Preprocessor.php:76