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;
28  
29  import com.vladsch.flexmark.html.HtmlRenderer;
30  import com.vladsch.flexmark.parser.Parser;
31  import com.vladsch.flexmark.util.ast.Block;
32  import com.vladsch.flexmark.util.ast.Document;
33  import com.vladsch.flexmark.util.ast.Node;
34  import com.vladsch.flexmark.util.data.DataSet;
35  import com.vladsch.flexmark.util.data.MutableDataSet;
36  import com.vladsch.flexmark.util.misc.Extension;
37  
38  import gov.nist.secauto.metaschema.core.datatype.markup.flexmark.FlexmarkConfiguration;
39  import gov.nist.secauto.metaschema.core.datatype.markup.flexmark.FlexmarkFactory;
40  import gov.nist.secauto.metaschema.core.datatype.markup.flexmark.SuppressPTagExtension;
41  
42  import java.util.Collection;
43  import java.util.LinkedList;
44  import java.util.List;
45  
46  import edu.umd.cs.findbugs.annotations.NonNull;
47  
48  public class MarkupLine
49      extends AbstractMarkupString<MarkupLine> {
50  
51    @NonNull
52    private static final DataSet FLEXMARK_CONFIG = newParserOptions();
53  
54    @NonNull
55    private static final FlexmarkFactory FLEXMARK_FACTORY = new FlexmarkFactory(FLEXMARK_CONFIG);
56  
57    @SuppressWarnings("null")
58    @NonNull
59    protected static DataSet newParserOptions() {
60      MutableDataSet options = new MutableDataSet();
61      // disable inline HTML
62      options.set(Parser.HTML_BLOCK_PARSER, false);
63      // disable list processing
64      options.set(Parser.LIST_BLOCK_PARSER, false);
65      options.set(HtmlRenderer.SUPPRESS_HTML_BLOCKS, true);
66  
67      Collection<Extension> currentExtensions = Parser.EXTENSIONS.get(FlexmarkConfiguration.FLEXMARK_CONFIG);
68      List<Extension> extensions = new LinkedList<>(currentExtensions);
69      extensions.add(SuppressPTagExtension.create());
70      Parser.EXTENSIONS.set(options, extensions);
71  
72      return FlexmarkConfiguration.newFlexmarkConfig(options);
73    }
74  
75    @NonNull
76    public static MarkupLine fromHtml(@NonNull String html) {
77      return new MarkupLine(
78          parseHtml(html, FLEXMARK_FACTORY.getFlexmarkHtmlConverter(), FLEXMARK_FACTORY.getMarkdownParser()));
79    }
80  
81    @NonNull
82    public static MarkupLine fromMarkdown(@NonNull String markdown) {
83      return new MarkupLine(parseMarkdown(markdown, FLEXMARK_FACTORY.getMarkdownParser()));
84    }
85  
86    @Override
87    public FlexmarkFactory getFlexmarkFactory() {
88      return FLEXMARK_FACTORY;
89    }
90  
91    protected MarkupLine(@NonNull Document astNode) {
92      super(astNode);
93      Node child = astNode.getFirstChild();
94      if (child instanceof Block && child.getNext() != null) {
95        throw new IllegalStateException("multiple blocks not allowed");
96      } // else empty markdown
97    }
98  
99    @Override
100   public MarkupLine copy() {
101     // TODO: find a way to do a deep copy
102     // this is a shallow copy that uses the same underlying Document object
103     return new MarkupLine(getDocument());
104   }
105 
106   @Override
107   public boolean isBlock() {
108     return false;
109   }
110 }