/home/mip/www/img/credit/datatables/Renderer.tar
MarkdownRendererInterface.php 0000644 00000001330 15152066046 0012351 0 ustar 00 <?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\Renderer;
use League\CommonMark\Node\Block\Document;
use League\CommonMark\Output\RenderedContentInterface;
/**
* Renders a parsed Document AST
*
* @deprecated since 2.3; use {@link DocumentRendererInterface} instead
*/
interface MarkdownRendererInterface
{
/**
* Render the given Document node (and all of its children)
*/
public function renderDocument(Document $document): RenderedContentInterface;
}
ChildNodeRendererInterface.php 0000644 00000001275 15152066046 0012430 0 ustar 00 <?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\Renderer;
use League\CommonMark\Node\Node;
/**
* Renders multiple nodes by delegating to the individual node renderers and adding spacing where needed
*/
interface ChildNodeRendererInterface
{
/**
* @param Node[] $nodes
*/
public function renderNodes(iterable $nodes): string;
public function getBlockSeparator(): string;
public function getInnerSeparator(): string;
}
Inline/TextRenderer.php 0000644 00000002473 15152066046 0011121 0 ustar 00 <?php
declare(strict_types=1);
/*
* This file is part of the league/commonmark package.
*
* (c) Colin O'Dell <colinodell@gmail.com>
*
* Original code based on the CommonMark JS reference parser (https://bitly.com/commonmark-js)
* - (c) John MacFarlane
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace League\CommonMark\Renderer\Inline;
use League\CommonMark\Node\Inline\Text;
use League\CommonMark\Node\Node;
use League\CommonMark\Renderer\ChildNodeRendererInterface;
use League\CommonMark\Renderer\NodeRendererInterface;
use League\CommonMark\Util\Xml;
use League\CommonMark\Xml\XmlNodeRendererInterface;
final class TextRenderer implements NodeRendererInterface, XmlNodeRendererInterface
{
/**
* @param Text $node
*
* {@inheritDoc}
*
* @psalm-suppress MoreSpecificImplementedParamType
*/
public function render(Node $node, ChildNodeRendererInterface $childRenderer): string
{
Text::assertInstanceOf($node);
return Xml::escape($node->getLiteral());
}
public function getXmlTagName(Node $node): string
{
return 'text';
}
/**
* {@inheritDoc}
*/
public function getXmlAttributes(Node $node): array
{
return [];
}
}
Inline/NewlineRenderer.php 0000644 00000003734 15152066046 0011577 0 ustar 00 <?php
declare(strict_types=1);
/*
* This file is part of the league/commonmark package.
*
* (c) Colin O'Dell <colinodell@gmail.com>
*
* Original code based on the CommonMark JS reference parser (https://bitly.com/commonmark-js)
* - (c) John MacFarlane
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace League\CommonMark\Renderer\Inline;
use League\CommonMark\Node\Inline\Newline;
use League\CommonMark\Node\Node;
use League\CommonMark\Renderer\ChildNodeRendererInterface;
use League\CommonMark\Renderer\NodeRendererInterface;
use League\CommonMark\Xml\XmlNodeRendererInterface;
use League\Config\ConfigurationAwareInterface;
use League\Config\ConfigurationInterface;
final class NewlineRenderer implements NodeRendererInterface, XmlNodeRendererInterface, ConfigurationAwareInterface
{
/** @psalm-readonly-allow-private-mutation */
private ConfigurationInterface $config;
public function setConfiguration(ConfigurationInterface $configuration): void
{
$this->config = $configuration;
}
/**
* @param Newline $node
*
* {@inheritDoc}
*
* @psalm-suppress MoreSpecificImplementedParamType
*/
public function render(Node $node, ChildNodeRendererInterface $childRenderer): string
{
Newline::assertInstanceOf($node);
if ($node->getType() === Newline::HARDBREAK) {
return "<br />\n";
}
return $this->config->get('renderer/soft_break');
}
/**
* @param Newline $node
*
* {@inheritDoc}
*
* @psalm-suppress MoreSpecificImplementedParamType
*/
public function getXmlTagName(Node $node): string
{
Newline::assertInstanceOf($node);
return $node->getType() === Newline::SOFTBREAK ? 'softbreak' : 'linebreak';
}
/**
* {@inheritDoc}
*/
public function getXmlAttributes(Node $node): array
{
return [];
}
}
Block/DocumentRenderer.php 0000644 00000002673 15152066046 0011571 0 ustar 00 <?php
declare(strict_types=1);
/*
* This file is part of the league/commonmark package.
*
* (c) Colin O'Dell <colinodell@gmail.com>
*
* Original code based on the CommonMark JS reference parser (https://bitly.com/commonmark-js)
* - (c) John MacFarlane
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace League\CommonMark\Renderer\Block;
use League\CommonMark\Node\Block\Document;
use League\CommonMark\Node\Node;
use League\CommonMark\Renderer\ChildNodeRendererInterface;
use League\CommonMark\Renderer\NodeRendererInterface;
use League\CommonMark\Xml\XmlNodeRendererInterface;
final class DocumentRenderer implements NodeRendererInterface, XmlNodeRendererInterface
{
/**
* @param Document $node
*
* {@inheritDoc}
*
* @psalm-suppress MoreSpecificImplementedParamType
*/
public function render(Node $node, ChildNodeRendererInterface $childRenderer): string
{
Document::assertInstanceOf($node);
$wholeDoc = $childRenderer->renderNodes($node->children());
return $wholeDoc === '' ? '' : $wholeDoc . "\n";
}
public function getXmlTagName(Node $node): string
{
return 'document';
}
/**
* {@inheritDoc}
*/
public function getXmlAttributes(Node $node): array
{
return [
'xmlns' => 'http://commonmark.org/xml/1.0',
];
}
}
Block/ParagraphRenderer.php 0000644 00000003672 15152066046 0011720 0 ustar 00 <?php
declare(strict_types=1);
/*
* This file is part of the league/commonmark package.
*
* (c) Colin O'Dell <colinodell@gmail.com>
*
* Original code based on the CommonMark JS reference parser (https://bitly.com/commonmark-js)
* - (c) John MacFarlane
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace League\CommonMark\Renderer\Block;
use League\CommonMark\Node\Block\Paragraph;
use League\CommonMark\Node\Block\TightBlockInterface;
use League\CommonMark\Node\Node;
use League\CommonMark\Renderer\ChildNodeRendererInterface;
use League\CommonMark\Renderer\NodeRendererInterface;
use League\CommonMark\Util\HtmlElement;
use League\CommonMark\Xml\XmlNodeRendererInterface;
final class ParagraphRenderer implements NodeRendererInterface, XmlNodeRendererInterface
{
/**
* @param Paragraph $node
*
* {@inheritDoc}
*
* @psalm-suppress MoreSpecificImplementedParamType
*/
public function render(Node $node, ChildNodeRendererInterface $childRenderer)
{
Paragraph::assertInstanceOf($node);
if ($this->inTightList($node)) {
return $childRenderer->renderNodes($node->children());
}
$attrs = $node->data->get('attributes');
return new HtmlElement('p', $attrs, $childRenderer->renderNodes($node->children()));
}
public function getXmlTagName(Node $node): string
{
return 'paragraph';
}
/**
* {@inheritDoc}
*/
public function getXmlAttributes(Node $node): array
{
return [];
}
private function inTightList(Paragraph $node): bool
{
// Only check up to two (2) levels above this for tightness
$i = 2;
while (($node = $node->parent()) && $i--) {
if ($node instanceof TightBlockInterface) {
return $node->isTight();
}
}
return false;
}
}
DocumentRendererInterface.php 0000644 00000001257 15152066046 0012355 0 ustar 00 <?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\Renderer;
use League\CommonMark\Node\Block\Document;
use League\CommonMark\Output\RenderedContentInterface;
/**
* Renders a parsed Document AST
*/
interface DocumentRendererInterface extends MarkdownRendererInterface
{
/**
* Render the given Document node (and all of its children)
*/
public function renderDocument(Document $document): RenderedContentInterface;
}
NoMatchingRendererException.php 0000644 00000000645 15152066046 0012664 0 ustar 00 <?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\Renderer;
use League\CommonMark\Exception\LogicException;
class NoMatchingRendererException extends LogicException
{
}
HtmlDecorator.php 0000644 00000002357 15152066046 0010040 0 ustar 00 <?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\Renderer;
use League\CommonMark\Node\Node;
use League\CommonMark\Util\HtmlElement;
final class HtmlDecorator implements NodeRendererInterface
{
private NodeRendererInterface $inner;
private string $tag;
/** @var array<string, string|string[]|bool> */
private array $attributes;
private bool $selfClosing;
/**
* @param array<string, string|string[]|bool> $attributes
*/
public function __construct(NodeRendererInterface $inner, string $tag, array $attributes = [], bool $selfClosing = false)
{
$this->inner = $inner;
$this->tag = $tag;
$this->attributes = $attributes;
$this->selfClosing = $selfClosing;
}
/**
* {@inheritDoc}
*/
public function render(Node $node, ChildNodeRendererInterface $childRenderer)
{
return new HtmlElement($this->tag, $this->attributes, $this->inner->render($node, $childRenderer), $this->selfClosing);
}
}
NodeRendererInterface.php 0000644 00000001226 15152066046 0011460 0 ustar 00 <?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\Renderer;
use League\CommonMark\Exception\InvalidArgumentException;
use League\CommonMark\Node\Node;
interface NodeRendererInterface
{
/**
* @return \Stringable|string|null
*
* @throws InvalidArgumentException if the wrong type of Node is provided
*/
public function render(Node $node, ChildNodeRendererInterface $childRenderer);
}
HtmlRenderer.php 0000644 00000005465 15152066046 0007667 0 ustar 00 <?php
declare(strict_types=1);
/*
* This file is part of the league/commonmark package.
*
* (c) Colin O'Dell <colinodell@gmail.com>
*
* Original code based on the CommonMark JS reference parser (https://bitly.com/commonmark-js)
* - (c) John MacFarlane
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace League\CommonMark\Renderer;
use League\CommonMark\Environment\EnvironmentInterface;
use League\CommonMark\Event\DocumentPreRenderEvent;
use League\CommonMark\Event\DocumentRenderedEvent;
use League\CommonMark\Node\Block\AbstractBlock;
use League\CommonMark\Node\Block\Document;
use League\CommonMark\Node\Node;
use League\CommonMark\Output\RenderedContent;
use League\CommonMark\Output\RenderedContentInterface;
final class HtmlRenderer implements DocumentRendererInterface, ChildNodeRendererInterface
{
/** @psalm-readonly */
private EnvironmentInterface $environment;
public function __construct(EnvironmentInterface $environment)
{
$this->environment = $environment;
}
public function renderDocument(Document $document): RenderedContentInterface
{
$this->environment->dispatch(new DocumentPreRenderEvent($document, 'html'));
$output = new RenderedContent($document, (string) $this->renderNode($document));
$event = new DocumentRenderedEvent($output);
$this->environment->dispatch($event);
return $event->getOutput();
}
/**
* {@inheritDoc}
*/
public function renderNodes(iterable $nodes): string
{
$output = '';
$isFirstItem = true;
foreach ($nodes as $node) {
if (! $isFirstItem && $node instanceof AbstractBlock) {
$output .= $this->getBlockSeparator();
}
$output .= $this->renderNode($node);
$isFirstItem = false;
}
return $output;
}
/**
* @return \Stringable|string
*
* @throws NoMatchingRendererException
*/
private function renderNode(Node $node)
{
$renderers = $this->environment->getRenderersForClass(\get_class($node));
foreach ($renderers as $renderer) {
\assert($renderer instanceof NodeRendererInterface);
if (($result = $renderer->render($node, $this)) !== null) {
return $result;
}
}
throw new NoMatchingRendererException('Unable to find corresponding renderer for node type ' . \get_class($node));
}
public function getBlockSeparator(): string
{
return $this->environment->getConfiguration()->get('renderer/block_separator');
}
public function getInnerSeparator(): string
{
return $this->environment->getConfiguration()->get('renderer/inner_separator');
}
}
