Add support for footnotes

samwilson · Sep 15, 2023 · 6c9c43b · 6c9c43b
1 parent 230edb6
commit 6c9c43b
Show file tree

Hide file tree

Showing 11 changed files with 166 additions and 1 deletion.
diff --git a/src/Footnotes/FootnoteBackrefRenderer.php b/src/Footnotes/FootnoteBackrefRenderer.php
@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Samwilson\CommonMarkLatex\Footnotes;
+
+use League\CommonMark\Extension\Footnote\Node\FootnoteBackref;
+use League\CommonMark\Node\Node;
+use League\CommonMark\Renderer\ChildNodeRendererInterface;
+use League\CommonMark\Renderer\NodeRendererInterface;
+
+final class FootnoteBackrefRenderer implements NodeRendererInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function render(Node $node, ChildNodeRendererInterface $childRenderer)
+    {
+        FootnoteBackref::assertInstanceOf($node);
+
+        return '';
+    }
+}
diff --git a/src/Footnotes/FootnoteContainerRenderer.php b/src/Footnotes/FootnoteContainerRenderer.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Samwilson\CommonMarkLatex\Footnotes;
+
+use League\CommonMark\Extension\Footnote\Node\FootnoteContainer;
+use League\CommonMark\Node\Node;
+use League\CommonMark\Renderer\ChildNodeRendererInterface;
+use League\CommonMark\Renderer\NodeRendererInterface;
+
+final class FootnoteContainerRenderer implements NodeRendererInterface
+{
+    public function render(Node $node, ChildNodeRendererInterface $childRenderer): string
+    {
+        FootnoteContainer::assertInstanceOf($node);
+
+        return '';
+    }
+}
diff --git a/src/Footnotes/FootnoteRefRenderer.php b/src/Footnotes/FootnoteRefRenderer.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Samwilson\CommonMarkLatex\Footnotes;
+
+use League\CommonMark\Extension\Footnote\Node\FootnoteRef;
+use League\CommonMark\Node\Node;
+use League\CommonMark\Renderer\ChildNodeRendererInterface;
+use League\CommonMark\Renderer\NodeRendererInterface;
+
+final class FootnoteRefRenderer implements NodeRendererInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function render(Node $node, ChildNodeRendererInterface $childRenderer)
+    {
+        FootnoteRef::assertInstanceOf($node);
+
+        $footnote = GatherFootnotesListener::$footnotes[$node->getReference()->getTitle()];
+
+        return '\\footnote{' . $childRenderer->renderNodes($footnote->children()) . '}';
+    }
+}
diff --git a/src/Footnotes/FootnoteRenderer.php b/src/Footnotes/FootnoteRenderer.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Samwilson\CommonMarkLatex\Footnotes;
+
+use League\CommonMark\Extension\Footnote\Node\Footnote;
+use League\CommonMark\Node\Node;
+use League\CommonMark\Renderer\ChildNodeRendererInterface;
+use League\CommonMark\Renderer\NodeRendererInterface;
+
+final class FootnoteRenderer implements NodeRendererInterface
+{
+    public function render(Node $node, ChildNodeRendererInterface $childRenderer): string
+    {
+        Footnote::assertInstanceOf($node);
+
+        return '';
+    }
+}
diff --git a/src/Footnotes/GatherFootnotesListener.php b/src/Footnotes/GatherFootnotesListener.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Samwilson\CommonMarkLatex\Footnotes;
+
+use League\CommonMark\Event\DocumentParsedEvent;
+use League\CommonMark\Extension\Footnote\Node\Footnote;
+use League\CommonMark\Node\NodeIterator;
+
+final class GatherFootnotesListener
+{
+    /** @var Node[] */
+    public static array $footnotes;
+
+    public function onDocumentParsed(DocumentParsedEvent $event): void
+    {
+        $document = $event->getDocument();
+
+        foreach ($document->iterator(NodeIterator::FLAG_BLOCKS_ONLY) as $node) {
+            if (! $node instanceof Footnote) {
+                continue;
+            }
+
+            $ref = $document->getReferenceMap()->get($node->getReference()->getLabel());
+            if ($ref !== null) {
+                self::$footnotes[$ref->getTitle()] = $node;
+            }
+        }
+    }
+}
diff --git a/src/LatexRendererExtension.php b/src/LatexRendererExtension.php
@@ -5,6 +5,7 @@
 namespace Samwilson\CommonMarkLatex;
 
 use League\CommonMark\Environment\EnvironmentBuilderInterface;
+use League\CommonMark\Event\DocumentParsedEvent;
 use League\CommonMark\Extension\CommonMark\Node\Block\BlockQuote;
 use League\CommonMark\Extension\CommonMark\Node\Block\FencedCode;
 use League\CommonMark\Extension\CommonMark\Node\Block\Heading;
@@ -18,8 +19,18 @@
 use League\CommonMark\Extension\CommonMark\Node\Inline\Link;
 use League\CommonMark\Extension\CommonMark\Node\Inline\Strong;
 use League\CommonMark\Extension\ExtensionInterface;
+use League\CommonMark\Extension\Footnote\FootnoteExtension;
+use League\CommonMark\Extension\Footnote\Node\Footnote;
+use League\CommonMark\Extension\Footnote\Node\FootnoteBackref;
+use League\CommonMark\Extension\Footnote\Node\FootnoteContainer;
+use League\CommonMark\Extension\Footnote\Node\FootnoteRef;
 use League\CommonMark\Node\Block\Paragraph;
 use League\CommonMark\Node\Inline\Text;
+use Samwilson\CommonMarkLatex\Footnotes\FootnoteBackrefRenderer;
+use Samwilson\CommonMarkLatex\Footnotes\FootnoteContainerRenderer;
+use Samwilson\CommonMarkLatex\Footnotes\FootnoteRefRenderer;
+use Samwilson\CommonMarkLatex\Footnotes\FootnoteRenderer;
+use Samwilson\CommonMarkLatex\Footnotes\GatherFootnotesListener;
 
 final class LatexRendererExtension implements ExtensionInterface
 {
@@ -44,5 +55,18 @@ public function register(EnvironmentBuilderInterface $environment): void
             ->addRenderer(Image::class, new ImageRenderer(), 10)
             ->addRenderer(Link::class, new LinkRenderer(), 10)
             ->addRenderer(Strong::class, new StrongRenderer(), 10);
+
+        foreach ($environment->getExtensions() as $ext) {
+            if ($ext instanceof FootnoteExtension) {
+                $environment
+                    ->addRenderer(FootnoteBackref::class, new FootnoteBackrefRenderer(), 15)
+                    ->addRenderer(FootnoteContainer::class, new FootnoteContainerRenderer(), 15)
+                    ->addRenderer(FootnoteRef::class, new FootnoteRefRenderer(), 15)
+                    ->addRenderer(Footnote::class, new FootnoteRenderer(), 15)
+                    ->addEventListener(DocumentParsedEvent::class, [new GatherFootnotesListener(), 'onDocumentParsed'], 15);
+
+                return;
+            }
+        }
     }
 }
diff --git a/src/LatexSpecialCharsParser.php b/src/LatexSpecialCharsParser.php
@@ -13,7 +13,7 @@ final class LatexSpecialCharsParser implements InlineParserInterface
 {
     public function getMatchDefinition(): InlineParserMatch
     {
-        return InlineParserMatch::oneOf('\\\\', '&', '%', '$', '#', '_', '{', '}', '~', '^');
+        return InlineParserMatch::regex('(\\\\|&|%|\$|\#|_|\{|\}|~|(?<!\[)(\^)(?=\s*\]?))');
     }
 
     public function parse(InlineParserContext $inlineContext): bool

diff --git a/tests/data/foonotes.md b/tests/data/foonotes.md
@@ -0,0 +1,9 @@
+Lorem[^fnlabel] ipsum.
+
+And[^1] another.
+
+[^1]: A multi-
+
+    -paragraph footnote.
+
+[^fnlabel]: Footnote *text*.
diff --git a/tests/data/foonotes.tex b/tests/data/foonotes.tex
@@ -0,0 +1,9 @@
+Lorem\footnote{Footnote \emph{text}.
+} ipsum.
+
+And\footnote{A multi-
+
+-paragraph footnote.
+} another.
+
+
diff --git a/tests/integration/CompileTest.php b/tests/integration/CompileTest.php
@@ -7,6 +7,7 @@
 use League\CommonMark\Environment\Environment;
 use League\CommonMark\Extension\Autolink\AutolinkExtension;
 use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
+use League\CommonMark\Extension\Footnote\FootnoteExtension;
 use League\CommonMark\MarkdownConverter;
 use PHPUnit\Framework\TestCase;
 use Samwilson\CommonMarkLatex\LatexRendererExtension;
@@ -19,6 +20,7 @@ public function testDataFiles(): void
         $environment = new Environment(['html_input' => 'allow']);
         $environment->addExtension(new CommonMarkCoreExtension());
         $environment->addExtension(new AutolinkExtension());
+        $environment->addExtension(new FootnoteExtension());
         $environment->addExtension(new LatexRendererExtension());
         $converter     = new MarkdownConverter($environment);
         $markdownFiles = \glob(\dirname(__DIR__) . '/data/*.md');

diff --git a/tests/unit/RendererTest.php b/tests/unit/RendererTest.php
@@ -7,6 +7,7 @@
 use League\CommonMark\Environment\Environment;
 use League\CommonMark\Extension\Autolink\AutolinkExtension;
 use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
+use League\CommonMark\Extension\Footnote\FootnoteExtension;
 use League\CommonMark\MarkdownConverter;
 use PHPUnit\Framework\TestCase;
 use Samwilson\CommonMarkLatex\LatexRendererExtension;
@@ -18,6 +19,7 @@ public function testDataFiles(): void
         $environment = new Environment(['html_input' => 'allow']);
         $environment->addExtension(new CommonMarkCoreExtension());
         $environment->addExtension(new AutolinkExtension());
+        $environment->addExtension(new FootnoteExtension());
         $environment->addExtension(new LatexRendererExtension());
         $converter     = new MarkdownConverter($environment);
         $markdownFiles = \glob(\dirname(__DIR__) . '/data/*.md');