path: root/src/ste/Parser.php

<?php

namespace kch42\ste;

use LogicException;

/**
 * The class, where the parser lives in. Can not be constructed manually.
 * Use the static method parse.
 */
class Parser
{
    /** @var string */
    private $text;

    /** @var string */
    private $name;

    /** @var int */
    private $off;

    /** @var int */
    private $len;

    private const PARSE_SHORT = 1;
    private const PARSE_TAG   = 2;

    private const ESCAPES_DEFAULT = '$?~{}|\\';

    /**
     * @param string $text
     * @param string $name
     */
    private function __construct(string $text, string $name)
    {
        $this->text = $text;
        $this->name = $name;
        $this->off  = 0;
        $this->len  = mb_strlen($text);
    }

    /**
     * @param int $n
     * @return string
     */
    private function peek(int $n = 1): string
    {
        if ($n <= 0) {
            throw new \InvalidArgumentException("\$n must be > 0");
        }
        return mb_substr($this->text, $this->off, $n);
    }

    /**
     * @param int $n
     * @return string
     */
    private function next(int $n = 1): string
    {
        $c = $this->peek($n);
        $this->off = min($this->off + $n, $this->len);
        return $c;
    }

    /**
     * @return bool
     */
    private function eof(): bool
    {
        return ($this->off == $this->len);
    }

    /**
     * @param int $n
     */
    private function back(int $n = 1): void
    {
        if ($n <= 0) {
            throw new \InvalidArgumentException("\$n must be > 0");
        }
        $this->off = max($this->off - $n, 0);
    }

    /**
     * @param string $needle
     * @return false|int
     */
    private function search_off(string $needle)
    {
        return mb_strpos($this->text, $needle, $this->off);
    }

    /**
     * @param string[] $needles
     * @return array 4-tuple of found key, offset, text preceding offset, old offset
     */
    private function search_multi(array $needles): array
    {
        $oldoff = $this->off;

        $minoff = $this->len;
        $which = null;

        foreach ($needles as $key => $needle) {
            if (($off = $this->search_off($needle)) === false) {
                continue;
            }

            if ($off < $minoff) {
                $minoff = $off;
                $which = $key;
            }
        }

        $this->off = $minoff + (($which === null) ? 0 : mb_strlen((string) $needles[$which]));

        return [$which, $minoff, mb_substr($this->text, $oldoff, $minoff - $oldoff), $oldoff];
    }

    /**
     * @param string $needle
     * @return array 3-tuple of offset (or false), text preceding offset, old offset
     */
    private function search(string $needle): array
    {
        $oldoff = $this->off;

        $off = $this->search_off($needle);
        if ($off === false) {
            $this->off = $this->len;
            return [false, mb_substr($this->text, $oldoff), $oldoff];
        }

        $this->off = $off + mb_strlen($needle);
        return [$off, mb_substr($this->text, $oldoff, $off - $oldoff), $oldoff];
    }

    /**
     * @param callable $cb
     * @return string
     */
    private function take_while(callable $cb): string
    {
        $s = "";
        while (($c = $this->next()) !== "") {
            if (!call_user_func($cb, $c)) {
                $this->back();
                return $s;
            }
            $s .= $c;
        }
        return $s;
    }

    private function skip_ws(): void
    {
        $this->take_while("ctype_space");
    }

    /**
     * @return string
     * @throws ParseCompileError
     */
    private function get_name(): string
    {
        $off = $this->off;
        $name = $this->take_while(function ($c) {
            return ctype_alnum($c) || ($c == "_");
        });
        if (mb_strlen($name) == 0) {
            throw new ParseCompileError("Expected a name (alphanumeric chars + '_', at least one char)", $this->name, $off);
        }
        return $name;
    }

    /**
     * Parses the input into an AST.
     *
     * You only need this function, if you want to manually compile a template.
     *
     * @param string $text The input code.
     * @param string $name The name of the template.
     *
     * @return ASTNode[]
     * @throws ParseCompileError
     */
    public static function parse(string $text, string $name): array
    {
        $obj = new self($text, $name);
        $res = $obj->parse_text(
            self::ESCAPES_DEFAULT, /* Escapes */
            self::PARSE_SHORT | self::PARSE_TAG /* Flags */
        );
        return self::tidyup_ast($res[0]);
    }

    /**
     * @param ASTNode[] $ast
     * @return ASTNode[]
     */
    private static function combine_consecutive_text(array $ast): array
    {
        $out = [];

        /** @var TextNode|null $last_text */
        $last_text = null;

        $put_last_text = static function () use (&$out, &$last_text) {
            if ($last_text === null) {
                return;
            }

            if ($last_text->text !== "") {
                $out[] = $last_text;
            }

            $last_text = null;
        };

        foreach ($ast as $node) {
            if ($node instanceof TextNode) {
                if ($last_text !== null) {
                    $last_text->text .= $node->text;
                } else {
                    $last_text = $node;
                }
            } else {
                $put_last_text();
                $out[] = $node;
            }
        }

        $put_last_text();

        return $out;
    }

    /**
     * @param ASTNode[] $ast
     * @return ASTNode[]
     */
    private static function tidyup_ast(array $ast): array
    {
        foreach ($ast as $node) {
            if ($node instanceof TagNode) {
                $node->sub = self::tidyup_ast($node->sub);
                $node->params = array_map([__CLASS__, 'tidyup_ast'], $node->params);
            } elseif ($node instanceof VariableNode) {
                $node->arrayfields = array_map([__CLASS__, 'tidyup_ast'], $node->arrayfields);
            }
        }

        $ast = self::combine_consecutive_text($ast);

        return $ast;
    }

    /**
     * @param string $escapes
     * @param int $flags
     * @param string|null $breakon
     * @param string|null $separator
     * @param null $nullaction
     * @param string|null $opentag
     * @param int $openedat
     * @return ASTNode[][]
     * @throws ParseCompileError
     */
    private function parse_text(string $escapes, int $flags, $breakon = null, $separator = null, $nullaction = null, $opentag = null, $openedat = -1): array
    {
        $elems = [];
        $astlist = [];

        $needles = [
            "commentopen" => "<ste:comment>",
            "rawopen" => "<ste:rawtext>",
            "escape" => '\\',
            "varcurlyopen" => '${',
            "var" => '$',
        ];

        if ($flags & self::PARSE_TAG) {
            $needles["tagopen"] = '<ste:';
            $needles["closetagopen"] = '</ste:';
        }
        if ($flags & self::PARSE_SHORT) {
            $needles["shortifopen"] = '?{';
            $needles["shortcompopen"] = '~{';
        }

        if ($separator !== null) {
            $needles["sep"] = $separator;
        }
        if ($breakon !== null) {
            $needles["break"] = $breakon;
        }

        for (;;) {
            list($which, $off, $before, $offbefore) = $this->search_multi($needles);

            $astlist[] = new TextNode($this->name, $offbefore, $before);

            switch ($which) {
            case null:
                if ($nullaction === null) {
                    $elems[] = $astlist;
                    return $elems;
                } else {
                    call_user_func($nullaction);
                }
                break;
            case "commentopen":
                list($off, , $offbefore) = $this->search("</ste:comment>");
                if ($off === false) {
                    throw new ParseCompileError("ste:comment was not closed", $this->name, $offbefore);
                }
                break;
            case "rawopen":
                $off_start = $off;
                list($off, $before, ) = $this->search("</ste:rawtext>");
                if ($off === false) {
                    throw new ParseCompileError("ste:rawtext was not closed", $this->name, $off_start);
                }
                $astlist[] = new TextNode($this->name, $off_start, $before);
                break;
            case "tagopen":
                $astlist[] = $this->parse_tag($off);
                break;
            case "closetagopen":
                $off_start = $off;
                $name = $this->get_name();
                $this->skip_ws();
                $off = $this->off;
                if ($this->next() != ">") {
                    throw new ParseCompileError("Expected '>' in closing ste-Tag", $this->name, $off);
                }

                if ($opentag === null) {
                    throw new ParseCompileError("Found closing ste:$name tag, but no tag was opened", $this->name, $off_start);
                }
                if ($opentag != $name) {
                    throw new ParseCompileError("Open ste:$opentag was not closed", $this->name, $openedat);
                }

                $elems[] = $astlist;
                return $elems;
            case "escape":
                $c = $this->next();
                if (mb_strpos($escapes, $c) !== false) {
                    $astlist[] = new TextNode($this->name, $off, $c);
                } else {
                    $astlist[] = new TextNode($this->name, $off, '\\');
                    $this->back();
                }
                break;
            case "shortifopen":
                $shortelems = $this->parse_short("?{", $off);
                if (count($shortelems) != 3) {
                    throw new ParseCompileError("A short if tag must have the form ?{..|..|..}", $this->name, $off);
                }

                list($cond, $then, $else) = $shortelems;
                $thentag = new TagNode($this->name, $off);
                $thentag->name = "then";
                $thentag->sub = $then;

                $elsetag = new TagNode($this->name, $off);
                $elsetag->name = "else";
                $elsetag->sub = $else;

                $iftag = new TagNode($this->name, $off);
                $iftag->name = "if";
                $iftag->sub = $cond;
                $iftag->sub[] = $thentag;
                $iftag->sub[] = $elsetag;

                $astlist[] = $iftag;
                break;
            case "shortcompopen":
                $shortelems = $this->parse_short("~{", $off);
                if (count($shortelems) != 3) {
                    throw new ParseCompileError("A short comparasion tag must have the form ~{..|..|..}", $this->name, $off);
                }

                // TODO: What will happen, if a tag was in one of the elements?
                list($a, $op, $b) = $shortelems;
                $cmptag = new TagNode($this->name, $off);
                $cmptag->name = "cmp";
                $cmptag->params["text_a"] = $a;
                $cmptag->params["op"] = $op;
                $cmptag->params["text_b"] = $b;

                $astlist[] = $cmptag;
                break;
            case "sep":
                $elems[] = $astlist;
                $astlist = [];
                break;
            case "varcurlyopen":
                $astlist[] = $this->parse_var($off, true);
                break;
            case "var":
                $astlist[] = $this->parse_var($off, false);
                break;
            case "break":
                $elems[] = $astlist;
                return $elems;
            }
        }

        $elems[] = $astlist;
        return $elems;
    }

    /**
     * @param string $shortname
     * @param int $openedat
     * @return ASTNode[][]
     * @throws ParseCompileError
     */
    private function parse_short(string $shortname, int $openedat): array
    {
        $tplname = $this->name;

        return $this->parse_text(
            self::ESCAPES_DEFAULT, /* Escapes */
            self::PARSE_SHORT | self::PARSE_TAG, /* Flags */
            '}', /* Break on */
            '|', /* Separator */
            function () use ($shortname, $tplname, $openedat) { /* NULL action */
                throw new ParseCompileError("Unclosed $shortname", $tplname, $openedat);
            },
            null, /* Open tag */
            $openedat /* Opened at */
        );
    }

    /**
     * @param int $openedat
     * @param bool $curly
     * @return VariableNode
     * @throws ParseCompileError
     */
    private function parse_var(int $openedat, bool $curly): VariableNode
    {
        $varnode = new VariableNode($this->name, $openedat);
        $varnode->name = $this->get_name();
        if (!$this->eof()) {
            $varnode->arrayfields = $this->parse_array();
        }

        if ($curly && ($this->next() != "}")) {
            throw new ParseCompileError("Unclosed '\${'", $this->name, $openedat);
        }
        return $varnode;
    }

    /**
     * @return ASTNode[]
     * @throws ParseCompileError
     */
    private function parse_array()
    {
        $tplname = $this->name;

        $arrayfields = [];

        while ($this->peek() == "[") {
            $this->next();

            $openedat = $this->off - 1;
            $res = $this->parse_text(
                self::ESCAPES_DEFAULT, /* Escapes */
                0, /* Flags */
                ']', /* Break on */
                null, /* Separator */
                function () use ($tplname, $openedat) { /* NULL action */
                    throw new ParseCompileError("Unclosed array access '[...]'", $tplname, $openedat);
                },
                null, /* Open tag */
                $openedat /* Opened at */
            );
            $arrayfields[] = $res[0];
        }

        return $arrayfields;
    }

    /**
     * @param int $openedat
     * @return TagNode
     * @throws ParseCompileError
     */
    private function parse_tag(int $openedat)
    {
        $tplname = $this->name;

        $this->skip_ws();
        $tag = new TagNode($this->name, $openedat);
        $name = $tag->name = $this->get_name();
        $tag->params = [];
        $tag->sub = [];

        for (;;) {
            $this->skip_ws();

            switch ($this->next()) {
            case '/': /* Self-closing tag */
                $this->skip_ws();
                if ($this->next() != '>') {
                    throw new ParseCompileError("Unclosed opening <ste: tag (expected >)", $this->name, $openedat);
                }

                return $tag;
            case '>':
                $sub = $this->parse_text(
                    self::ESCAPES_DEFAULT, /* Escapes */
                    self::PARSE_SHORT | self::PARSE_TAG, /* Flags */
                    null, /* Break on */
                    null, /* Separator */
                    function () use ($name, $tplname, $openedat) { /* NULL action */
                        throw new ParseCompileError("Open ste:$name tag was not closed", $tplname, $openedat);
                    },
                    $tag->name, /* Open tag */
                    $openedat /* Opened at */
                );
                $tag->sub = $sub[0];
                return $tag;
            default:
                $this->back();

                $param = $this->get_name();

                $this->skip_ws();
                if ($this->next() != '=') {
                    throw new ParseCompileError("Expected '=' after tag parameter name", $this->name, $this->off - 1);
                }
                $this->skip_ws();

                $quot = $this->next();
                if (($quot != '"') && ($quot != "'")) {
                    throw new ParseCompileError("Expected ' or \" after '=' of tag parameter", $this->name, $this->off - 1);
                }

                $off = $this->off - 1;
                $paramval = $this->parse_text(
                    self::ESCAPES_DEFAULT . $quot, /* Escapes */
                    0, /* Flags */
                    $quot, /* Break on */
                    null, /* Separator */
                    function () use ($quot, $tplname, $off) { /* NULL action */
                        throw new ParseCompileError("Open tag parameter value ($quot) was not closed", $tplname, $off);
                    },
                    null, /* Open tag */
                    $off /* Opened at */
                );
                $tag->params[$param] = $paramval[0];
            }
        }

        // Help PhpStorm detect that we shouldn't be here
        throw new LogicException("Somehow we left the infinite loop?");
    }
}