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.ast.Emphasis;
30  import com.vladsch.flexmark.ast.StrongEmphasis;
31  import com.vladsch.flexmark.parser.core.delimiter.AsteriskDelimiterProcessor;
32  import com.vladsch.flexmark.parser.core.delimiter.Delimiter;
33  import com.vladsch.flexmark.parser.core.delimiter.EmphasisDelimiterProcessor;
34  import com.vladsch.flexmark.parser.delimiter.DelimiterRun;
35  import com.vladsch.flexmark.util.ast.DelimitedNode;
36  import com.vladsch.flexmark.util.misc.Utils;
37  import com.vladsch.flexmark.util.sequence.BasedSequence;
38  
39  /**
40   * Provides a temporary fix for the broken {@link EmphasisDelimiterProcessor} in
41   * Flexmark.
42   */
43  public class FixedEmphasisDelimiterProcessor
44      extends AsteriskDelimiterProcessor {
45    // TODO: remove this class once vsch/flexmark-java#580 is merged
46    private final int multipleUse;
47  
48    public FixedEmphasisDelimiterProcessor(boolean strongWrapsEmphasis) {
49      super(strongWrapsEmphasis);
50      this.multipleUse = strongWrapsEmphasis ? 1 : 2;
51    }
52  
53    @SuppressWarnings("PMD.OnlyOneReturn") // for readability
54    @Override
55    public int getDelimiterUse(DelimiterRun opener, DelimiterRun closer) {
56      // "multiple of 3" rule for internal delimiter runs
57      if ((opener.canClose() || closer.canOpen()) && (opener.length() + closer.length()) % 3 == 0) {
58        if (opener.length() % 3 == 0 && closer.length() % 3 == 0) {
59          return this.multipleUse; // if they are each a multiple of 3, then emphasis can be created
60        }
61        return 0;
62      }
63  
64      // calculate actual number of delimiters used from this closer
65      if (opener.length() < 3 || closer.length() < 3) {
66        return Utils.min(closer.length(), opener.length());
67      }
68      // default to latest spec
69      return closer.length() % 2 == 0 ? 2 : multipleUse;
70    }
71  
72    @Override
73    public void process(Delimiter opener, Delimiter closer, int delimitersUsed) {
74      DelimitedNode emphasis = delimitersUsed == 1
75          ? new Emphasis(opener.getTailChars(delimitersUsed), BasedSequence.NULL, closer.getLeadChars(delimitersUsed))
76          : new StrongEmphasis(opener.getTailChars(delimitersUsed), BasedSequence.NULL,
77              closer.getLeadChars(delimitersUsed));
78  
79      opener.moveNodesBetweenDelimitersTo(emphasis, closer);
80    }
81  
82  }