View Javadoc
1   /*
2    * Portions of this software was developed by employees of the National Institute
3    * of Standards and Technology (NIST), an agency of the Federal Government and is
4    * being made available as a public service. Pursuant to title 17 United States
5    * Code Section 105, works of NIST employees are not subject to copyright
6    * protection in the United States. This software may be subject to foreign
7    * copyright. Permission in the United States and in foreign countries, to the
8    * extent that NIST may hold copyright, to use, copy, modify, create derivative
9    * works, and distribute this software and its documentation without fee is hereby
10   * granted on a non-exclusive basis, provided that this notice and disclaimer
11   * of warranty appears in all copies.
12   *
13   * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14   * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15   * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17   * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18   * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
19   * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20   * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21   * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22   * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23   * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24   * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25   */
26  
27  package gov.nist.secauto.metaschema.core.datatype.markup.flexmark;
28  
29  import com.vladsch.flexmark.ext.typographic.TypographicQuotes;
30  import com.vladsch.flexmark.html.HtmlRenderer;
31  import com.vladsch.flexmark.html.HtmlWriter;
32  import com.vladsch.flexmark.html.renderer.NodeRenderer;
33  import com.vladsch.flexmark.html.renderer.NodeRendererContext;
34  import com.vladsch.flexmark.html.renderer.NodeRendererFactory;
35  import com.vladsch.flexmark.html.renderer.NodeRenderingHandler;
36  import com.vladsch.flexmark.html2md.converter.FlexmarkHtmlConverter;
37  import com.vladsch.flexmark.html2md.converter.HtmlMarkdownWriter;
38  import com.vladsch.flexmark.html2md.converter.HtmlNodeConverterContext;
39  import com.vladsch.flexmark.html2md.converter.HtmlNodeRenderer;
40  import com.vladsch.flexmark.html2md.converter.HtmlNodeRendererFactory;
41  import com.vladsch.flexmark.html2md.converter.HtmlNodeRendererHandler;
42  import com.vladsch.flexmark.parser.Parser;
43  import com.vladsch.flexmark.parser.block.NodePostProcessor;
44  import com.vladsch.flexmark.parser.block.NodePostProcessorFactory;
45  import com.vladsch.flexmark.util.ast.DoNotDecorate;
46  import com.vladsch.flexmark.util.ast.Document;
47  import com.vladsch.flexmark.util.ast.Node;
48  import com.vladsch.flexmark.util.ast.NodeTracker;
49  import com.vladsch.flexmark.util.data.DataHolder;
50  import com.vladsch.flexmark.util.data.MutableDataHolder;
51  
52  import org.jsoup.nodes.Element;
53  
54  import java.util.Collections;
55  import java.util.Set;
56  
57  import edu.umd.cs.findbugs.annotations.NonNull;
58  import edu.umd.cs.findbugs.annotations.Nullable;
59  
60  public class HtmlQuoteTagExtension
61      implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension,
62      FlexmarkHtmlConverter.HtmlConverterExtension {
63  
64    public static HtmlQuoteTagExtension create() {
65      return new HtmlQuoteTagExtension();
66    }
67  
68    @Override
69    public void rendererOptions(MutableDataHolder options) {
70      // do nothing
71    }
72  
73    @Override
74    public void parserOptions(MutableDataHolder options) {
75      // do nothing
76    }
77  
78    @Override
79    public void extend(HtmlRenderer.Builder rendererBuilder, String rendererType) {
80      rendererBuilder.nodeRendererFactory(new QTagNodeRenderer.Factory());
81    }
82  
83    @Override
84    public void extend(Parser.Builder parserBuilder) {
85      parserBuilder.postProcessorFactory(new QuoteReplacingPostProcessor.Factory());
86    }
87  
88    @Override
89    public void extend(FlexmarkHtmlConverter.Builder builder) {
90      builder.htmlNodeRendererFactory(new QTagHtmlNodeRenderer.Factory());
91    }
92  
93    static class QTagNodeRenderer implements NodeRenderer {
94  
95      @Override
96      public @Nullable Set<NodeRenderingHandler<?>> getNodeRenderingHandlers() {
97        return Collections.singleton(
98            new NodeRenderingHandler<>(DoubleQuoteNode.class, this::render));
99      }
100 
101     protected void render(@NonNull DoubleQuoteNode node, @NonNull NodeRendererContext context,
102         @NonNull HtmlWriter html) {
103       html.withAttr().tag("q");
104       context.renderChildren(node);
105       html.tag("/q");
106     }
107 
108     public static class Factory implements NodeRendererFactory {
109 
110       @Override
111       public NodeRenderer apply(DataHolder options) {
112         return new QTagNodeRenderer();
113       }
114 
115     }
116   }
117 
118   static class QuoteReplacingPostProcessor
119       extends NodePostProcessor {
120 
121     @Override
122     public void process(NodeTracker state, Node node) {
123       if (node instanceof TypographicQuotes) {
124         TypographicQuotes typographicQuotes = (TypographicQuotes) node;
125         if (typographicQuotes.getOpeningMarker().matchChars("\"")) {
126           DoubleQuoteNode quoteNode = new DoubleQuoteNode(typographicQuotes);
127           node.insertAfter(quoteNode);
128           state.nodeAdded(quoteNode);
129           node.unlink();
130           state.nodeRemoved(node);
131         }
132       }
133     }
134 
135     public static class Factory
136         extends NodePostProcessorFactory {
137       public Factory() {
138         super(false);
139         addNodeWithExclusions(TypographicQuotes.class, DoNotDecorate.class);
140       }
141 
142       @NonNull
143       @Override
144       public NodePostProcessor apply(Document document) {
145         return new QuoteReplacingPostProcessor();
146       }
147     }
148   }
149 
150   static class QTagHtmlNodeRenderer implements HtmlNodeRenderer {
151 
152     @Override
153     public Set<HtmlNodeRendererHandler<?>> getHtmlNodeRendererHandlers() {
154       return Collections.singleton(new HtmlNodeRendererHandler<>("q", Element.class, this::renderMarkdown));
155     }
156 
157     protected void renderMarkdown(Element element, HtmlNodeConverterContext context,
158         @SuppressWarnings("unused") HtmlMarkdownWriter out) {
159       context.wrapTextNodes(element, "\"", element.nextElementSibling() != null);
160     }
161 
162     public static class Factory implements HtmlNodeRendererFactory {
163 
164       @Override
165       public HtmlNodeRenderer apply(DataHolder options) {
166         return new QTagHtmlNodeRenderer();
167       }
168     }
169 
170   }
171 
172   public static class DoubleQuoteNode
173       extends TypographicQuotes {
174 
175     public DoubleQuoteNode(TypographicQuotes node) {
176       super(node.getOpeningMarker(), node.getText(), node.getClosingMarker());
177       setTypographicOpening(node.getTypographicOpening());
178       setTypographicClosing(node.getTypographicClosing());
179       for (Node child : node.getChildren()) {
180         appendChild(child);
181       }
182     }
183   }
184 }