BlockStart.php
2.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
<?php
declare(strict_types=1);
/*
* This file is part of the league/commonmark package.
*
* (c) Colin O'Dell <colinodell@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace League\CommonMark\Parser\Block;
use League\CommonMark\Parser\Cursor;
use League\CommonMark\Parser\CursorState;
/**
* Result object for starting parsing of a block; see static methods for constructors
*/
final class BlockStart
{
/**
* @var BlockContinueParserInterface[]
*
* @psalm-readonly
*/
private array $blockParsers;
/** @psalm-readonly-allow-private-mutation */
private ?CursorState $cursorState = null;
/** @psalm-readonly-allow-private-mutation */
private bool $replaceActiveBlockParser = false;
private bool $isAborting = false;
private function __construct(BlockContinueParserInterface ...$blockParsers)
{
$this->blockParsers = $blockParsers;
}
/**
* @return BlockContinueParserInterface[]
*/
public function getBlockParsers(): iterable
{
return $this->blockParsers;
}
public function getCursorState(): ?CursorState
{
return $this->cursorState;
}
public function isReplaceActiveBlockParser(): bool
{
return $this->replaceActiveBlockParser;
}
/**
* @internal
*/
public function isAborting(): bool
{
return $this->isAborting;
}
/**
* Signal that we want to parse at the given cursor position
*
* @return $this
*/
public function at(Cursor $cursor): self
{
$this->cursorState = $cursor->saveState();
return $this;
}
/**
* Signal that we want to replace the active block parser with this one
*
* @return $this
*/
public function replaceActiveBlockParser(): self
{
$this->replaceActiveBlockParser = true;
return $this;
}
/**
* Signal that we cannot parse whatever is here
*
* @return null
*/
public static function none(): ?self
{
return null;
}
/**
* Signal that we'd like to register the given parser(s) so they can parse the current block
*/
public static function of(BlockContinueParserInterface ...$blockParsers): self
{
return new self(...$blockParsers);
}
/**
* Signal that the block parsing process should be aborted (no other block starts should be checked)
*
* @internal
*/
public static function abort(): self
{
$ret = new self();
$ret->isAborting = true;
return $ret;
}
}