001/*
002 * Portions of this software was developed by employees of the National Institute
003 * of Standards and Technology (NIST), an agency of the Federal Government and is
004 * being made available as a public service. Pursuant to title 17 United States
005 * Code Section 105, works of NIST employees are not subject to copyright
006 * protection in the United States. This software may be subject to foreign
007 * copyright. Permission in the United States and in foreign countries, to the
008 * extent that NIST may hold copyright, to use, copy, modify, create derivative
009 * works, and distribute this software and its documentation without fee is hereby
010 * granted on a non-exclusive basis, provided that this notice and disclaimer
011 * of warranty appears in all copies.
012 *
013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
025 */
026
027package gov.nist.secauto.metaschema.core.datatype.markup;
028
029import com.vladsch.flexmark.html.HtmlRenderer;
030import com.vladsch.flexmark.parser.Parser;
031import com.vladsch.flexmark.util.ast.Block;
032import com.vladsch.flexmark.util.ast.Document;
033import com.vladsch.flexmark.util.ast.Node;
034import com.vladsch.flexmark.util.data.DataSet;
035import com.vladsch.flexmark.util.data.MutableDataSet;
036import com.vladsch.flexmark.util.misc.Extension;
037
038import gov.nist.secauto.metaschema.core.datatype.markup.flexmark.FlexmarkConfiguration;
039import gov.nist.secauto.metaschema.core.datatype.markup.flexmark.FlexmarkFactory;
040import gov.nist.secauto.metaschema.core.datatype.markup.flexmark.SuppressPTagExtension;
041
042import java.util.Collection;
043import java.util.LinkedList;
044import java.util.List;
045
046import edu.umd.cs.findbugs.annotations.NonNull;
047
048public class MarkupLine
049    extends AbstractMarkupString<MarkupLine> {
050
051  @NonNull
052  private static final DataSet FLEXMARK_CONFIG = newParserOptions();
053
054  @NonNull
055  private static final FlexmarkFactory FLEXMARK_FACTORY = new FlexmarkFactory(FLEXMARK_CONFIG);
056
057  @SuppressWarnings("null")
058  @NonNull
059  protected static DataSet newParserOptions() {
060    MutableDataSet options = new MutableDataSet();
061    // disable inline HTML
062    options.set(Parser.HTML_BLOCK_PARSER, false);
063    // disable list processing
064    options.set(Parser.LIST_BLOCK_PARSER, false);
065    options.set(HtmlRenderer.SUPPRESS_HTML_BLOCKS, true);
066
067    Collection<Extension> currentExtensions = Parser.EXTENSIONS.get(FlexmarkConfiguration.FLEXMARK_CONFIG);
068    List<Extension> extensions = new LinkedList<>(currentExtensions);
069    extensions.add(SuppressPTagExtension.create());
070    Parser.EXTENSIONS.set(options, extensions);
071
072    return FlexmarkConfiguration.newFlexmarkConfig(options);
073  }
074
075  @NonNull
076  public static MarkupLine fromHtml(@NonNull String html) {
077    return new MarkupLine(
078        parseHtml(html, FLEXMARK_FACTORY.getFlexmarkHtmlConverter(), FLEXMARK_FACTORY.getMarkdownParser()));
079  }
080
081  @NonNull
082  public static MarkupLine fromMarkdown(@NonNull String markdown) {
083    return new MarkupLine(parseMarkdown(markdown, FLEXMARK_FACTORY.getMarkdownParser()));
084  }
085
086  @Override
087  public FlexmarkFactory getFlexmarkFactory() {
088    return FLEXMARK_FACTORY;
089  }
090
091  protected MarkupLine(@NonNull Document astNode) {
092    super(astNode);
093    Node child = astNode.getFirstChild();
094    if (child instanceof Block && child.getNext() != null) {
095      throw new IllegalStateException("multiple blocks not allowed");
096    } // else empty markdown
097  }
098
099  @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}