summaryrefslogtreecommitdiffstats
path: root/library/Icinga/Cli/Documentation/CommentParser.php
blob: 41048489707e3a6e901d4ca8b23953326d989444 (plain)
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
<?php
/* Icinga Web 2 | (c) 2013 Icinga Development Team | GPLv2+ */

namespace Icinga\Cli\Documentation;

use Icinga\Cli\Screen;

class CommentParser
{
    protected $raw;
    protected $plain;
    protected $title;
    protected $paragraphs = array();

    public function __construct($raw)
    {
        $this->raw = $raw;
        if ($raw) {
            $this->parse();
        }
    }

    public function getTitle()
    {
        return $this->title;
    }

    protected function parse()
    {
        $plain = $this->raw;

        // Strip comment start /**
        $plain = preg_replace('~^/\s*\*\*\n~s', '', $plain);

        // Strip comment end */
        $plain = preg_replace('~\n\s*\*/\s*~s', "\n", $plain);
        $p = null;
        foreach (preg_split('~\n~', $plain) as $line) {
            // Strip * at line start
            $line = preg_replace('~^\s*\*\s?~', '', $line);
            $line = rtrim($line);
            if ($this->title === null) {
                $this->title = $line;
                continue;
            }
            if ($p === null && empty($this->paragraphs)) {
                $p = & $this->paragraphs[];
            }

            if ($line === '') {
                if ($p !== null) {
                    $p = & $this->paragraphs[];
                }
                continue;
            }
            if ($p === null) {
                $p = $line;
            } else {
                if (substr($line, 0, 2) === '  ') {
                    $p .= "\n" . $line;
                } else {
                    $p .= ' ' . $line;
                }
            }
        }
        if ($p === null) {
            array_pop($this->paragraphs);
        }
    }

    public function dump()
    {
        if ($this->title) {
            $res = $this->title . "\n" . str_repeat('=', strlen($this->title)) . "\n\n";
        } else {
            $res = '';
        }

        foreach ($this->paragraphs as $p) {
            $res .= wordwrap($p, Screen::instance()->getColumns()) . "\n\n";
        }

        return $res;
    }
}