gl-website-deployer/vendor/doctrine/rst-parser/lib/Directives/Directive.php

<?php

declare(strict_types=1);

namespace Doctrine\RST\Directives;

use Doctrine\RST\Nodes\DocumentNode;
use Doctrine\RST\Nodes\Node;
use Doctrine\RST\Parser;

/**
 * A directive is like a function you can call or apply to a block
 * Il looks like:
 *
 * .. function:: main
 *     :arg1: value
 *     :arg2: otherValue
 *
 *     Some block !
 *
 *  The directive can define variables, create special nodes or change
 *  the node that directly follows it
 */
abstract class Directive
{
    /**
     * Get the directive name
     */
    abstract public function getName(): string;

    /**
     * This is the function called by the parser to process the directive, it can be overloaded
     * to do anything with the document, like tweaking nodes or change the environment
     *
     * The node that directly follows the directive is also passed to it
     *
     * @param Parser    $parser   the calling parser
     * @param Node|null $node     the node that follows the directive
     * @param string    $variable the variable name of the directive
     * @param string    $data     the data of the directive (following ::)
     * @param string[]  $options  the array of options for this directive
     */
    public function process(Parser $parser, ?Node $node, string $variable, string $data, array $options): void
    {
        $document = $parser->getDocument();

        $processNode = $this->processNode($parser, $variable, $data, $options);

        if ($processNode !== null) {
            if ($variable !== '') {
                $environment = $parser->getEnvironment();
                $environment->setVariable($variable, $processNode);
            } else {
                $document->addNode($processNode);
            }
        }

        if ($node === null) {
            return;
        }

        $document->addNode($node);
    }

    /**
     * This can be overloaded to write a directive that just create one node for the
     * document, which is common
     *
     * The arguments are the same that process
     *
     * @param string[] $options
     */
    public function processNode(Parser $parser, string $variable, string $data, array $options): ?Node
    {
        $this->processAction($parser, $variable, $data, $options);

        return null;
    }

    /**
     * This can be overloaded to write a directive that just do an action without changing
     * the nodes of the document
     *
     * The arguments are the same that process
     *
     * @param string[] $options
     */
    public function processAction(Parser $parser, string $variable, string $data, array $options): void
    {
    }

    /**
     * Called at the end of the parsing to finalize the document (add something or tweak nodes)
     */
    public function finalize(DocumentNode $document): void
    {
    }

    /**
     * Should the following block be passed as a CodeNode?
     *
     * You should probably return false from this. If you do,
     * in most cases (unless you directive allows for some fancy
     * syntax), you will receive a BlockNode object in processNode().
     *
     * @see CodeNode
     */
    public function wantCode(): bool
    {
        return false;
    }

    /**
     * Can this directive apply to content that is not indented under it?
     *
     * Most directives that allow content require that content to be
     * indented under it. For example:
     *
     *      .. note::
     *
     *          This is my note! It must be indented.
     *
     * But some are allowed to apply to content that is *not* indented:
     *
     *      .. class:: align-center
     *
     *      I will be a "p" tag with an align-center class
     *
     * If your directive allows the "class" directive functionality,
     * return true from this function. The result is that your
     * directive's process() method will be called for the next
     * node after your directive (e.g. a ParagraphNode, ListNode, etc)
     */
    public function appliesToNonBlockContent(): bool
    {
        return false;
    }
}