xref: /dokuwiki/inc/Parsing/ParserMode/Preformatted.php (revision 13a62f810fbd091d15ab734b467eaec0a6bf829a)
1be906b56SAndreas Gohr<?php
2be906b56SAndreas Gohr
3be906b56SAndreas Gohrnamespace dokuwiki\Parsing\ParserMode;
4be906b56SAndreas Gohr
571096e46SAndreas Gohruse dokuwiki\Parsing\Handler;
671096e46SAndreas Gohruse dokuwiki\Parsing\Handler\Preformatted as PreformattedHandler;
77958e698SAndreas Gohr
8be906b56SAndreas Gohrclass Preformatted extends AbstractMode
9be906b56SAndreas Gohr{
10be906b56SAndreas Gohr    /** @inheritdoc */
1171096e46SAndreas Gohr    public function getSort()
1271096e46SAndreas Gohr    {
1371096e46SAndreas Gohr        return 20;
1471096e46SAndreas Gohr    }
1571096e46SAndreas Gohr
16b1c59bedSAndreas Gohr    /**
17b1c59bedSAndreas Gohr     * Number of leading spaces that trigger a preformatted block.
18b1c59bedSAndreas Gohr     *
19b1c59bedSAndreas Gohr     * DokuWiki's historical value is 2 spaces; Markdown uses 4. When
20*13a62f81SAndreas Gohr     * `$conf['syntax']` is `md` or `md+dw` (Markdown preferred),
21b1c59bedSAndreas Gohr     * we flip to 4 so indented code blocks match GFM. A single tab is
22b1c59bedSAndreas Gohr     * always a trigger regardless of the space threshold.
23b1c59bedSAndreas Gohr     */
24b1c59bedSAndreas Gohr    protected function getIndentWidth(): int
25b1c59bedSAndreas Gohr    {
26b1c59bedSAndreas Gohr        global $conf;
27*13a62f81SAndreas Gohr        return in_array($conf['syntax'], ['md', 'md+dw'], true) ? 4 : 2;
28b1c59bedSAndreas Gohr    }
29b1c59bedSAndreas Gohr
3071096e46SAndreas Gohr    /** @inheritdoc */
31be906b56SAndreas Gohr    public function connectTo($mode)
32be906b56SAndreas Gohr    {
33b1c59bedSAndreas Gohr        $indent = str_repeat(' ', $this->getIndentWidth());
34b1c59bedSAndreas Gohr
3596d096f1SAndreas Gohr        $this->Lexer->addEntryPattern('\n' . $indent, $mode, 'preformatted');
3696d096f1SAndreas Gohr        $this->Lexer->addEntryPattern('\n\t', $mode, 'preformatted');
37be906b56SAndreas Gohr
38259e91d9SAndreas Gohr        // match continuation lines inside the preformatted block
39b1c59bedSAndreas Gohr        $this->Lexer->addPattern('\n' . $indent, 'preformatted');
40be906b56SAndreas Gohr        $this->Lexer->addPattern('\n\t', 'preformatted');
41be906b56SAndreas Gohr    }
42be906b56SAndreas Gohr
43be906b56SAndreas Gohr    /** @inheritdoc */
44be906b56SAndreas Gohr    public function postConnect()
45be906b56SAndreas Gohr    {
46be906b56SAndreas Gohr        $this->Lexer->addExitPattern('\n', 'preformatted');
47be906b56SAndreas Gohr    }
48be906b56SAndreas Gohr
49be906b56SAndreas Gohr    /** @inheritdoc */
5071096e46SAndreas Gohr    public function handle($match, $state, $pos, Handler $handler)
51be906b56SAndreas Gohr    {
5271096e46SAndreas Gohr        switch ($state) {
5371096e46SAndreas Gohr            case DOKU_LEXER_ENTER:
5471096e46SAndreas Gohr                $handler->setCallWriter(new PreformattedHandler($handler->getCallWriter()));
5571096e46SAndreas Gohr                $handler->addCall('preformatted_start', [], $pos);
5671096e46SAndreas Gohr                break;
5771096e46SAndreas Gohr            case DOKU_LEXER_EXIT:
5871096e46SAndreas Gohr                $handler->addCall('preformatted_end', [], $pos);
5971096e46SAndreas Gohr                /** @var PreformattedHandler $reWriter */
6071096e46SAndreas Gohr                $reWriter = $handler->getCallWriter();
6171096e46SAndreas Gohr                $handler->setCallWriter($reWriter->process());
6271096e46SAndreas Gohr                break;
6371096e46SAndreas Gohr            case DOKU_LEXER_MATCHED:
6471096e46SAndreas Gohr                $handler->addCall('preformatted_newline', [], $pos);
6571096e46SAndreas Gohr                break;
6671096e46SAndreas Gohr            case DOKU_LEXER_UNMATCHED:
6771096e46SAndreas Gohr                $handler->addCall('preformatted_content', [$match], $pos);
6871096e46SAndreas Gohr                break;
6971096e46SAndreas Gohr        }
7071096e46SAndreas Gohr
7171096e46SAndreas Gohr        return true;
72be906b56SAndreas Gohr    }
73be906b56SAndreas Gohr}
74