Dave Jarvis' Repositories
git clone https://repo.autonoma.ca/repo/keenwrite.git
Finish export to HTML or Markdown
| Author | DaveJarvis <email> |
|---|---|
| Date | 2020-09-23 23:09:44 GMT-0700 |
| Commit | cdd41261108266f8bd8215c44df6ff7c35d3cbed |
| Parent | 3043936 |
| Delta | 178 lines added, 106 lines removed, 72-line increase |
src/main/resources/com/keenwrite/messages.properties
| Main.menu.file.save_as=Save _As | ||
| Main.menu.file.save_all=Save A_ll | ||
| -Main.menu.file.export=_Export | ||
| +Main.menu.file.export=_Export As | ||
| Main.menu.file.export.html_svg=HTML and S_VG | ||
| Main.menu.file.export.html_tex=HTML and _TeX | ||
 | ||
| Main.status.line=Line {0} of {1}, ${Main.status.text.offset} {2} | ||
| Main.status.state.default=OK | ||
| +Main.status.export.success=Saved as {0} | ||
| + | ||
| Main.status.error.parse={0} (near ${Main.status.text.offset} {1}) | ||
| Main.status.error.def.blank=Move the caret to a word before inserting a definition. | ||
| ||
| Dialog.file.choose.open.title=Open File | ||
| Dialog.file.choose.save.title=Save File | ||
| +Dialog.file.choose.export.title=Export File | ||
| Dialog.file.choose.filter.title.source=Source Files | ||
src/main/java/com/keenwrite/processors/markdown/tex/TeXNode.java
| -/* | ||
| - * Copyright 2020 White Magic Software, Ltd. | ||
| - * | ||
| - * All rights reserved. | ||
| - * | ||
| - * Redistribution and use in source and binary forms, with or without | ||
| - * modification, are permitted provided that the following conditions are met: | ||
| - * | ||
| - * o Redistributions of source code must retain the above copyright | ||
| - * notice, this list of conditions and the following disclaimer. | ||
| - * | ||
| - * o Redistributions in binary form must reproduce the above copyright | ||
| - * notice, this list of conditions and the following disclaimer in the | ||
| - * documentation and/or other materials provided with the distribution. | ||
| - * | ||
| - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
| - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
| - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
| - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
| - * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
| - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
| - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
| - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| - */ | ||
| -package com.keenwrite.processors.markdown.tex; | ||
| - | ||
| -import com.vladsch.flexmark.ast.DelimitedNodeImpl; | ||
| - | ||
| -public class TeXNode extends DelimitedNodeImpl { | ||
| - /** | ||
| - * TeX expression wrapped in a {@code <tex>} element. | ||
| - */ | ||
| - public static final String HTML_TEX = "tex"; | ||
| - | ||
| - public TeXNode() { | ||
| - } | ||
| -} | ||
src/main/java/com/keenwrite/processors/markdown/tex/TeXNodeRenderer.java
| -/* | ||
| - * Copyright 2020 White Magic Software, Ltd. | ||
| - * | ||
| - * All rights reserved. | ||
| - * | ||
| - * Redistribution and use in source and binary forms, with or without | ||
| - * modification, are permitted provided that the following conditions are met: | ||
| - * | ||
| - * o Redistributions of source code must retain the above copyright | ||
| - * notice, this list of conditions and the following disclaimer. | ||
| - * | ||
| - * o Redistributions in binary form must reproduce the above copyright | ||
| - * notice, this list of conditions and the following disclaimer in the | ||
| - * documentation and/or other materials provided with the distribution. | ||
| - * | ||
| - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
| - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
| - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
| - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
| - * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
| - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
| - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
| - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| - */ | ||
| -package com.keenwrite.processors.markdown.tex; | ||
| - | ||
| -import com.vladsch.flexmark.html.HtmlWriter; | ||
| -import com.vladsch.flexmark.html.renderer.NodeRenderer; | ||
| -import com.vladsch.flexmark.html.renderer.NodeRendererContext; | ||
| -import com.vladsch.flexmark.html.renderer.NodeRendererFactory; | ||
| -import com.vladsch.flexmark.html.renderer.NodeRenderingHandler; | ||
| -import com.vladsch.flexmark.util.data.DataHolder; | ||
| -import org.jetbrains.annotations.NotNull; | ||
| -import org.jetbrains.annotations.Nullable; | ||
| - | ||
| -import java.util.Set; | ||
| - | ||
| -import static com.keenwrite.processors.markdown.tex.TeXNode.HTML_TEX; | ||
| - | ||
| -public class TeXNodeRenderer implements NodeRenderer { | ||
| - | ||
| - public static class Factory implements NodeRendererFactory { | ||
| - @NotNull | ||
| - @Override | ||
| - public NodeRenderer apply( @NotNull DataHolder options ) { | ||
| - return new TeXNodeRenderer(); | ||
| - } | ||
| - } | ||
| - | ||
| - @Override | ||
| - public @Nullable Set<NodeRenderingHandler<?>> getNodeRenderingHandlers() { | ||
| - return Set.of( new NodeRenderingHandler<>( TeXNode.class, this::render ) ); | ||
| - } | ||
| - | ||
| - private void render( final TeXNode node, | ||
| - final NodeRendererContext context, | ||
| - final HtmlWriter html ) { | ||
| - html.tag( HTML_TEX ); | ||
| - html.raw( node.getText() ); | ||
| - html.closeTag( HTML_TEX ); | ||
| - } | ||
| -} | ||
src/main/java/com/keenwrite/processors/markdown/tex/TexNode.java
| +/* | ||
| + * Copyright 2020 White Magic Software, Ltd. | ||
| + * | ||
| + * All rights reserved. | ||
| + * | ||
| + * Redistribution and use in source and binary forms, with or without | ||
| + * modification, are permitted provided that the following conditions are met: | ||
| + * | ||
| + * o Redistributions of source code must retain the above copyright | ||
| + * notice, this list of conditions and the following disclaimer. | ||
| + * | ||
| + * o Redistributions in binary form must reproduce the above copyright | ||
| + * notice, this list of conditions and the following disclaimer in the | ||
| + * documentation and/or other materials provided with the distribution. | ||
| + * | ||
| + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
| + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
| + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
| + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
| + * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
| + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
| + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
| + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| + */ | ||
| +package com.keenwrite.processors.markdown.tex; | ||
| + | ||
| +import com.vladsch.flexmark.ast.DelimitedNodeImpl; | ||
| + | ||
| +public class TexNode extends DelimitedNodeImpl { | ||
| + /** | ||
| + * TeX expression wrapped in a {@code <tex>} element. | ||
| + */ | ||
| + public static final String HTML_TEX = "tex"; | ||
| + | ||
| + public static final String TOKEN_OPEN = "$"; | ||
| + public static final String TOKEN_CLOSE = "$"; | ||
| + | ||
| + public TexNode() { | ||
| + } | ||
| +} | ||
src/main/java/com/keenwrite/processors/markdown/tex/TexNodeRenderer.java
| +/* | ||
| + * Copyright 2020 White Magic Software, Ltd. | ||
| + * | ||
| + * All rights reserved. | ||
| + * | ||
| + * Redistribution and use in source and binary forms, with or without | ||
| + * modification, are permitted provided that the following conditions are met: | ||
| + * | ||
| + * o Redistributions of source code must retain the above copyright | ||
| + * notice, this list of conditions and the following disclaimer. | ||
| + * | ||
| + * o Redistributions in binary form must reproduce the above copyright | ||
| + * notice, this list of conditions and the following disclaimer in the | ||
| + * documentation and/or other materials provided with the distribution. | ||
| + * | ||
| + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
| + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
| + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
| + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
| + * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
| + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
| + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
| + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| + */ | ||
| +package com.keenwrite.processors.markdown.tex; | ||
| + | ||
| +import com.keenwrite.ExportFormat; | ||
| +import com.keenwrite.preview.SvgRasterizer; | ||
| +import com.keenwrite.preview.SvgReplacedElementFactory; | ||
| +import com.vladsch.flexmark.html.HtmlWriter; | ||
| +import com.vladsch.flexmark.html.renderer.NodeRenderer; | ||
| +import com.vladsch.flexmark.html.renderer.NodeRendererContext; | ||
| +import com.vladsch.flexmark.html.renderer.NodeRendererFactory; | ||
| +import com.vladsch.flexmark.html.renderer.NodeRenderingHandler; | ||
| +import com.vladsch.flexmark.util.ast.Node; | ||
| +import com.vladsch.flexmark.util.data.DataHolder; | ||
| +import org.jetbrains.annotations.NotNull; | ||
| +import org.jetbrains.annotations.Nullable; | ||
| + | ||
| +import java.util.Set; | ||
| + | ||
| +import static com.keenwrite.processors.markdown.tex.TexNode.*; | ||
| + | ||
| +public class TexNodeRenderer { | ||
| + | ||
| + public static class Factory implements NodeRendererFactory { | ||
| + private final ExportFormat mExportFormat; | ||
| + | ||
| + public Factory( final ExportFormat exportFormat ) { | ||
| + mExportFormat = exportFormat; | ||
| + } | ||
| + | ||
| + @NotNull | ||
| + @Override | ||
| + public NodeRenderer apply( @NotNull DataHolder options ) { | ||
| + return switch( mExportFormat ) { | ||
| + case HTML_TEX_SVG -> new TexSvgNodeRenderer(); | ||
| + case HTML_TEX_DELIMITED, MARKDOWN_PLAIN -> new TexDelimNodeRenderer(); | ||
| + case NONE -> new TexElementNodeRenderer(); | ||
| + }; | ||
| + } | ||
| + } | ||
| + | ||
| + private static abstract class AbstractTexNodeRenderer | ||
| + implements NodeRenderer { | ||
| + | ||
| + @Override | ||
| + public @Nullable Set<NodeRenderingHandler<?>> getNodeRenderingHandlers() { | ||
| + final var h = new NodeRenderingHandler<>( TexNode.class, this::render ); | ||
| + return Set.of( h ); | ||
| + } | ||
| + | ||
| + /** | ||
| + * Subclasses implement this method to render the content of {@link TexNode} | ||
| + * instances as per their associated {@link ExportFormat}. | ||
| + * | ||
| + * @param node {@link Node} containing text content of a math formula. | ||
| + * @param context Configuration information (unused). | ||
| + * @param html Where to write the rendered output. | ||
| + */ | ||
| + abstract void render( final TexNode node, | ||
| + final NodeRendererContext context, | ||
| + final HtmlWriter html ); | ||
| + } | ||
| + | ||
| + /** | ||
| + * Responsible for rendering a TeX node as an HTML {@code <tex>} | ||
| + * element. This is the default behaviour. | ||
| + */ | ||
| + private static class TexElementNodeRenderer extends AbstractTexNodeRenderer { | ||
| + void render( final TexNode node, | ||
| + final NodeRendererContext context, | ||
| + final HtmlWriter html ) { | ||
| + html.tag( HTML_TEX ); | ||
| + html.raw( node.getText() ); | ||
| + html.closeTag( HTML_TEX ); | ||
| + } | ||
| + } | ||
| + | ||
| + /** | ||
| + * Responsible for rendering a TeX node as an HTML {@code <svg>} | ||
| + * element. | ||
| + */ | ||
| + private static class TexSvgNodeRenderer extends AbstractTexNodeRenderer { | ||
| + void render( final TexNode node, | ||
| + final NodeRendererContext context, | ||
| + final HtmlWriter html ) { | ||
| + final var renderer = SvgReplacedElementFactory.getInstance(); | ||
| + final var tex = node.getText().toStringOrNull(); | ||
| + final var doc = renderer.render( tex == null ? "" : tex ); | ||
| + final var svg = SvgRasterizer.toSvg( doc.getDocumentElement() ); | ||
| + html.raw( svg ); | ||
| + } | ||
| + } | ||
| + | ||
| + /** | ||
| + * Responsible for rendering a TeX node as text bracketed by $ tokens. | ||
| + */ | ||
| + private static class TexDelimNodeRenderer extends AbstractTexNodeRenderer { | ||
| + void render( final TexNode node, | ||
| + final NodeRendererContext context, | ||
| + final HtmlWriter html ) { | ||
| + html.raw( TOKEN_OPEN ); | ||
| + html.raw( node.getText() ); | ||
| + html.raw( TOKEN_CLOSE ); | ||
| + } | ||
| + } | ||
| +} | ||