diff --git a/.idea/google-java-format.xml b/.idea/google-java-format.xml
new file mode 100644
index 000000000..05946a82a
--- /dev/null
+++ b/.idea/google-java-format.xml
@@ -0,0 +1,7 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/commonmark-ext-autolink/src/main/java/org/commonmark/ext/autolink/AutolinkExtension.java b/commonmark-ext-autolink/src/main/java/org/commonmark/ext/autolink/AutolinkExtension.java
index 7d5a74f30..14222121c 100644
--- a/commonmark-ext-autolink/src/main/java/org/commonmark/ext/autolink/AutolinkExtension.java
+++ b/commonmark-ext-autolink/src/main/java/org/commonmark/ext/autolink/AutolinkExtension.java
@@ -2,7 +2,6 @@
import java.util.EnumSet;
import java.util.Set;
-
import org.commonmark.Extension;
import org.commonmark.ext.autolink.internal.AutolinkPostProcessor;
import org.commonmark.parser.Parser;
@@ -10,14 +9,12 @@
/**
* Extension for automatically turning plain URLs and email addresses into links.
- *
- * Create it with {@link #create()} and then configure it on the builders
- * ({@link org.commonmark.parser.Parser.Builder#extensions(Iterable)},
- * {@link HtmlRenderer.Builder#extensions(Iterable)}).
- *
- *
- * The parsed links are turned into normal {@link org.commonmark.node.Link} nodes.
- *
+ *
+ *
Create it with {@link #create()} and then configure it on the builders ({@link
+ * org.commonmark.parser.Parser.Builder#extensions(Iterable)}, {@link
+ * HtmlRenderer.Builder#extensions(Iterable)}).
+ *
+ *
The parsed links are turned into normal {@link org.commonmark.node.Link} nodes.
*/
public class AutolinkExtension implements Parser.ParserExtension {
@@ -51,8 +48,8 @@ public static class Builder {
private Set linkTypes = EnumSet.allOf(AutolinkType.class);
/**
- * @param linkTypes the link types that should be converted. By default,
- * all {@link AutolinkType}s are converted.
+ * @param linkTypes the link types that should be converted. By default, all {@link
+ * AutolinkType}s are converted.
* @return {@code this}
*/
public Builder linkTypes(AutolinkType... linkTypes) {
@@ -64,8 +61,8 @@ public Builder linkTypes(AutolinkType... linkTypes) {
}
/**
- * @param linkTypes the link types that should be converted. By default,
- * all {@link AutolinkType}s are converted.
+ * @param linkTypes the link types that should be converted. By default, all {@link
+ * AutolinkType}s are converted.
* @return {@code this}
*/
public Builder linkTypes(Set linkTypes) {
diff --git a/commonmark-ext-autolink/src/main/java/org/commonmark/ext/autolink/AutolinkType.java b/commonmark-ext-autolink/src/main/java/org/commonmark/ext/autolink/AutolinkType.java
index 2c8c6574f..24249ef88 100644
--- a/commonmark-ext-autolink/src/main/java/org/commonmark/ext/autolink/AutolinkType.java
+++ b/commonmark-ext-autolink/src/main/java/org/commonmark/ext/autolink/AutolinkType.java
@@ -1,19 +1,11 @@
package org.commonmark.ext.autolink;
-/**
- * The types of strings that can be automatically turned into links.
- */
+/** The types of strings that can be automatically turned into links. */
public enum AutolinkType {
- /**
- * URL such as {@code http://example.com}
- */
+ /** URL such as {@code http://example.com} */
URL,
- /**
- * Email address such as {@code foo@example.com}
- */
+ /** Email address such as {@code foo@example.com} */
EMAIL,
- /**
- * URL such as {@code www.example.com}
- */
+ /** URL such as {@code www.example.com} */
WWW
}
diff --git a/commonmark-ext-autolink/src/main/java/org/commonmark/ext/autolink/internal/AutolinkPostProcessor.java b/commonmark-ext-autolink/src/main/java/org/commonmark/ext/autolink/internal/AutolinkPostProcessor.java
index a381c2f19..124870fd2 100644
--- a/commonmark-ext-autolink/src/main/java/org/commonmark/ext/autolink/internal/AutolinkPostProcessor.java
+++ b/commonmark-ext-autolink/src/main/java/org/commonmark/ext/autolink/internal/AutolinkPostProcessor.java
@@ -1,5 +1,6 @@
package org.commonmark.ext.autolink.internal;
+import java.util.*;
import org.commonmark.ext.autolink.AutolinkType;
import org.commonmark.node.*;
import org.commonmark.parser.PostProcessor;
@@ -8,8 +9,6 @@
import org.nibor.autolink.LinkType;
import org.nibor.autolink.Span;
-import java.util.*;
-
public class AutolinkPostProcessor implements PostProcessor {
private final LinkExtractor linkExtractor;
@@ -38,9 +37,7 @@ public AutolinkPostProcessor(Set linkTypes) {
}
}
- this.linkExtractor = LinkExtractor.builder()
- .linkTypes(types)
- .build();
+ this.linkExtractor = LinkExtractor.builder().linkTypes(types).build();
}
@Override
diff --git a/commonmark-ext-autolink/src/test/java/org/commonmark/ext/autolink/AutolinkTest.java b/commonmark-ext-autolink/src/test/java/org/commonmark/ext/autolink/AutolinkTest.java
index 82c3899fc..fb79dfd60 100644
--- a/commonmark-ext-autolink/src/test/java/org/commonmark/ext/autolink/AutolinkTest.java
+++ b/commonmark-ext-autolink/src/test/java/org/commonmark/ext/autolink/AutolinkTest.java
@@ -1,5 +1,9 @@
package org.commonmark.ext.autolink;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.util.List;
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.node.*;
import org.commonmark.parser.IncludeSourceSpans;
@@ -8,64 +12,69 @@
import org.commonmark.testutil.RenderingTestCase;
import org.junit.jupiter.api.Test;
-import java.util.List;
-import java.util.Set;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
public class AutolinkTest extends RenderingTestCase {
private static final Set EXTENSIONS = Set.of(AutolinkExtension.create());
private static final Parser PARSER = Parser.builder().extensions(EXTENSIONS).build();
- private static final HtmlRenderer RENDERER = HtmlRenderer.builder().extensions(EXTENSIONS).build();
-
- private static final Set NO_WWW_EXTENSIONS = Set.of(AutolinkExtension.builder()
- .linkTypes(AutolinkType.URL, AutolinkType.EMAIL)
- .build());
- private static final Parser NO_WWW_PARSER = Parser.builder().extensions(NO_WWW_EXTENSIONS).build();
- private static final HtmlRenderer NO_WWW_RENDERER = HtmlRenderer.builder().extensions(NO_WWW_EXTENSIONS).build();
+ private static final HtmlRenderer RENDERER =
+ HtmlRenderer.builder().extensions(EXTENSIONS).build();
+
+ private static final Set NO_WWW_EXTENSIONS =
+ Set.of(
+ AutolinkExtension.builder()
+ .linkTypes(AutolinkType.URL, AutolinkType.EMAIL)
+ .build());
+ private static final Parser NO_WWW_PARSER =
+ Parser.builder().extensions(NO_WWW_EXTENSIONS).build();
+ private static final HtmlRenderer NO_WWW_RENDERER =
+ HtmlRenderer.builder().extensions(NO_WWW_EXTENSIONS).build();
@Test
public void oneTextNode() {
- assertRendering("foo http://one.org/ bar http://two.org/",
+ assertRendering(
+ "foo http://one.org/ bar http://two.org/",
"
\n");
}
@Test
public void tricky() {
- assertRendering("http://example.com/one. Example 2 (see http://example.com/two). Example 3: http://example.com/foo_(bar)",
- "
- * The {@link #getLabel() label} is the text in brackets after {@code ^}, so {@code foo} in the example. The contents
- * of the footnote are child nodes of the definition, a {@link org.commonmark.node.Paragraph} in the example.
- *
- * Footnote definitions are parsed even if there's no corresponding {@link FootnoteReference}.
+ *
+ * The {@link #getLabel() label} is the text in brackets after {@code ^}, so {@code foo} in the
+ * example. The contents of the footnote are child nodes of the definition, a {@link
+ * org.commonmark.node.Paragraph} in the example.
+ *
+ *
Footnote definitions are parsed even if there's no corresponding {@link FootnoteReference}.
*/
public class FootnoteDefinition extends CustomBlock {
@@ -24,4 +27,3 @@ public String getLabel() {
return label;
}
}
-
diff --git a/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/FootnoteReference.java b/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/FootnoteReference.java
index 61dcf8626..c0382fff1 100644
--- a/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/FootnoteReference.java
+++ b/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/FootnoteReference.java
@@ -4,9 +4,10 @@
/**
* A footnote reference, e.g. [^foo] in Some text with a footnote[^foo]
- *
- * The {@link #getLabel() label} is the text within brackets after {@code ^}, so {@code foo} in the example. It needs to
- * match the label of a corresponding {@link FootnoteDefinition} for the footnote to be parsed.
+ *
+ *
The {@link #getLabel() label} is the text within brackets after {@code ^}, so {@code foo} in
+ * the example. It needs to match the label of a corresponding {@link FootnoteDefinition} for the
+ * footnote to be parsed.
*/
public class FootnoteReference extends CustomNode {
private String label;
diff --git a/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/FootnotesExtension.java b/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/FootnotesExtension.java
index dd532fa34..4517d14d6 100644
--- a/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/FootnotesExtension.java
+++ b/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/FootnotesExtension.java
@@ -1,5 +1,6 @@
package org.commonmark.ext.footnotes;
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.ext.footnotes.internal.*;
import org.commonmark.parser.Parser;
@@ -9,32 +10,37 @@
import org.commonmark.renderer.markdown.MarkdownNodeRendererFactory;
import org.commonmark.renderer.markdown.MarkdownRenderer;
-import java.util.Set;
-
/**
* Extension for footnotes with syntax like GitHub Flavored Markdown:
+ *
*
* Some text with a footnote[^1].
*
* [^1]: The text of the footnote.
*
+ *
* The [^1] is a {@link FootnoteReference}, with "1" being the label.
- *
- * The line with [^1]: ... is a {@link FootnoteDefinition}, with the contents as child nodes (can be a
- * paragraph like in the example, or other blocks like lists).
- *
- * All the footnotes (definitions) will be rendered in a list at the end of a document, no matter where they appear in
- * the source. The footnotes will be numbered starting from 1, then 2, etc, depending on the order in which they appear
- * in the text (and not dependent on the label). The footnote reference is a link to the footnote, and from the footnote
- * there is a link back to the reference (or multiple).
- *
- * There is also optional support for inline footnotes, use {@link #builder()} and then set {@link Builder#inlineFootnotes}.
*
- * @see GitHub docs for footnotes
+ *
The line with [^1]: ... is a {@link FootnoteDefinition}, with the contents as
+ * child nodes (can be a paragraph like in the example, or other blocks like lists).
+ *
+ *
All the footnotes (definitions) will be rendered in a list at the end of a document, no matter
+ * where they appear in the source. The footnotes will be numbered starting from 1, then 2, etc,
+ * depending on the order in which they appear in the text (and not dependent on the label). The
+ * footnote reference is a link to the footnote, and from the footnote there is a link back to the
+ * reference (or multiple).
+ *
+ *
There is also optional support for inline footnotes, use {@link #builder()} and then set
+ * {@link Builder#inlineFootnotes}.
+ *
+ * @see GitHub
+ * docs for footnotes
*/
-public class FootnotesExtension implements Parser.ParserExtension,
- HtmlRenderer.HtmlRendererExtension,
- MarkdownRenderer.MarkdownRendererExtension {
+public class FootnotesExtension
+ implements Parser.ParserExtension,
+ HtmlRenderer.HtmlRendererExtension,
+ MarkdownRenderer.MarkdownRendererExtension {
private final boolean inlineFootnotes;
@@ -42,9 +48,7 @@ private FootnotesExtension(boolean inlineFootnotes) {
this.inlineFootnotes = inlineFootnotes;
}
- /**
- * The extension with the default configuration (no support for inline footnotes).
- */
+ /** The extension with the default configuration (no support for inline footnotes). */
public static Extension create() {
return builder().build();
}
@@ -70,17 +74,18 @@ public void extend(HtmlRenderer.Builder rendererBuilder) {
@Override
public void extend(MarkdownRenderer.Builder rendererBuilder) {
- rendererBuilder.nodeRendererFactory(new MarkdownNodeRendererFactory() {
- @Override
- public NodeRenderer create(MarkdownNodeRendererContext context) {
- return new FootnoteMarkdownNodeRenderer(context);
- }
+ rendererBuilder.nodeRendererFactory(
+ new MarkdownNodeRendererFactory() {
+ @Override
+ public NodeRenderer create(MarkdownNodeRendererContext context) {
+ return new FootnoteMarkdownNodeRenderer(context);
+ }
- @Override
- public Set getSpecialCharacters() {
- return Set.of();
- }
- });
+ @Override
+ public Set getSpecialCharacters() {
+ return Set.of();
+ }
+ });
}
public static class Builder {
@@ -89,6 +94,7 @@ public static class Builder {
/**
* Enable support for inline footnotes without definitions, e.g.:
+ *
*
* Some text^[this is an inline footnote]
*
diff --git a/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/InlineFootnote.java b/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/InlineFootnote.java
index 665d01936..cb16c45f6 100644
--- a/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/InlineFootnote.java
+++ b/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/InlineFootnote.java
@@ -2,5 +2,4 @@
import org.commonmark.node.CustomNode;
-public class InlineFootnote extends CustomNode {
-}
+public class InlineFootnote extends CustomNode {}
diff --git a/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteBlockParser.java b/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteBlockParser.java
index 110bdef20..db11b906a 100644
--- a/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteBlockParser.java
+++ b/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteBlockParser.java
@@ -1,16 +1,13 @@
package org.commonmark.ext.footnotes.internal;
+import java.util.List;
import org.commonmark.ext.footnotes.FootnoteDefinition;
import org.commonmark.node.Block;
import org.commonmark.node.DefinitionMap;
import org.commonmark.parser.block.*;
import org.commonmark.text.Characters;
-import java.util.List;
-
-/**
- * Parser for a single {@link FootnoteDefinition} block.
- */
+/** Parser for a single {@link FootnoteDefinition} block. */
public class FootnoteBlockParser extends AbstractBlockParser {
private final FootnoteDefinition block;
@@ -37,16 +34,18 @@ public boolean canContain(Block childBlock) {
@Override
public BlockContinue tryContinue(ParserState parserState) {
if (parserState.getIndent() >= 4) {
- // It looks like content needs to be indented by 4 so that it's part of a footnote (instead of starting a new block).
+ // It looks like content needs to be indented by 4 so that it's part of a footnote
+ // (instead of starting a new block).
return BlockContinue.atColumn(4);
} else if (parserState.isBlank()) {
- // A blank line doesn't finish a footnote yet. If there's another line with indent >= 4 after it,
- // that should result in another paragraph in this footnote definition.
+ // A blank line doesn't finish a footnote yet. If there's another line with indent >= 4
+ // after it, that should result in another paragraph in this footnote definition.
return BlockContinue.atIndex(parserState.getIndex());
} else {
- // We're not continuing to give other block parsers a chance to interrupt this definition.
- // But if no other block parser applied (including another FootnotesBlockParser), we will
- // accept the line via lazy continuation (same as a block quote).
+ // We're not continuing to give other block parsers a chance to interrupt this
+ // definition. But if no other block parser applied (including another
+ // FootnotesBlockParser), we will accept the line via lazy continuation (same as a block
+ // quote).
return BlockContinue.none();
}
}
@@ -82,11 +81,16 @@ public BlockStart tryStart(ParserState state, MatchedBlockParser matchedBlockPar
var c = content.charAt(index);
switch (c) {
case ']':
- if (index > labelStart && index + 1 < content.length() && content.charAt(index + 1) == ':') {
+ if (index > labelStart
+ && index + 1 < content.length()
+ && content.charAt(index + 1) == ':') {
var label = content.subSequence(labelStart, index).toString();
- // After the colon, any number of spaces is skipped (not part of the content)
- var afterSpaces = Characters.skipSpaceTab(content, index + 2, content.length());
- return BlockStart.of(new FootnoteBlockParser(label)).atIndex(afterSpaces);
+ // After the colon, any number of spaces is skipped (not part of the
+ // content)
+ var afterSpaces =
+ Characters.skipSpaceTab(content, index + 2, content.length());
+ return BlockStart.of(new FootnoteBlockParser(label))
+ .atIndex(afterSpaces);
} else {
return BlockStart.none();
}
diff --git a/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteHtmlNodeRenderer.java b/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteHtmlNodeRenderer.java
index 70eb048a3..db88a8269 100644
--- a/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteHtmlNodeRenderer.java
+++ b/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteHtmlNodeRenderer.java
@@ -1,5 +1,7 @@
package org.commonmark.ext.footnotes.internal;
+import java.util.*;
+import java.util.function.Consumer;
import org.commonmark.ext.footnotes.FootnoteDefinition;
import org.commonmark.ext.footnotes.FootnoteReference;
import org.commonmark.ext.footnotes.InlineFootnote;
@@ -8,64 +10,68 @@
import org.commonmark.renderer.html.HtmlNodeRendererContext;
import org.commonmark.renderer.html.HtmlWriter;
-import java.util.*;
-import java.util.function.Consumer;
-
/**
* HTML rendering for footnotes.
- *
- * Aims to match the rendering of cmark-gfm (which is slightly different from GitHub's when it comes to class
- * attributes, not sure why).
- *
- * Some notes on how rendering works:
+ *
+ *
Aims to match the rendering of cmark-gfm (which is slightly different from GitHub's when it
+ * comes to class attributes, not sure why).
+ *
+ *
Some notes on how rendering works:
+ *
*
- *
Footnotes are numbered according to the order of references, starting at 1
- *
Definitions are rendered at the end of the document, regardless of where the definition was in the source
- *
Definitions are ordered by number
- *
Definitions have links back to their references (one or more)
+ *
Footnotes are numbered according to the order of references, starting at 1
+ *
Definitions are rendered at the end of the document, regardless of where the definition was
+ * in the source
+ *
Definitions are ordered by number
+ *
Definitions have links back to their references (one or more)
*
*
*
Nested footnotes
- * Text in footnote definitions can reference other footnotes, even ones that aren't referenced in the main text.
- * This makes them tricky because it's not enough to just go through the main text for references.
- * And before we can render a definition, we need to know all references (because we add links back to references).
- *
- * In other words, footnotes form a directed graph. Footnotes can reference each other so cycles are possible too.
- *
- * One way to implement it, which is what cmark-gfm does, is to go through the whole document (including definitions)
- * and find all references in order. That guarantees that all definitions are found, but it has strange results for
- * ordering or when the reference is in an unreferenced definition, see tests. In graph terms, it renders all
- * definitions that have an incoming edge, no matter whether they are connected to the main text or not.
- *
- * The way we implement it:
+ *
+ * Text in footnote definitions can reference other footnotes, even ones that aren't referenced in
+ * the main text. This makes them tricky because it's not enough to just go through the main text
+ * for references. And before we can render a definition, we need to know all references (because we
+ * add links back to references).
+ *
+ *
In other words, footnotes form a directed graph. Footnotes can reference each other so cycles
+ * are possible too.
+ *
+ *
One way to implement it, which is what cmark-gfm does, is to go through the whole document
+ * (including definitions) and find all references in order. That guarantees that all definitions
+ * are found, but it has strange results for ordering or when the reference is in an unreferenced
+ * definition, see tests. In graph terms, it renders all definitions that have an incoming edge, no
+ * matter whether they are connected to the main text or not.
+ *
+ *
The way we implement it:
+ *
*
- *
Start with the references in the main text; we can render them as we go
- *
After the main text is rendered, we have the referenced definitions, but there might be more from definition text
- *
To find the remaining definitions, we visit the definitions from before to look at references
- *
Repeat (breadth-first search) until we've found all definitions (note that we can't render before that's done because of backrefs)
- *
Now render the definitions (and any references inside)
+ *
Start with the references in the main text; we can render them as we go
+ *
After the main text is rendered, we have the referenced definitions, but there might be
+ * more from definition text
+ *
To find the remaining definitions, we visit the definitions from before to look at
+ * references
+ *
Repeat (breadth-first search) until we've found all definitions (note that we can't render
+ * before that's done because of backrefs)
+ *
Now render the definitions (and any references inside)
*
- * This means we only render definitions whose references are actually rendered, and in a meaningful order (all main
- * text footnotes first, then any nested ones).
+ *
+ * This means we only render definitions whose references are actually rendered, and in a meaningful
+ * order (all main text footnotes first, then any nested ones).
*/
public class FootnoteHtmlNodeRenderer implements NodeRenderer {
private final HtmlWriter html;
private final HtmlNodeRendererContext context;
- /**
- * All definitions (even potentially unused ones), for looking up references
- */
+ /** All definitions (even potentially unused ones), for looking up references */
private DefinitionMap definitionMap;
- /**
- * Definitions that were referenced, in order in which they should be rendered.
- */
+ /** Definitions that were referenced, in order in which they should be rendered. */
private final Map referencedDefinitions = new LinkedHashMap<>();
/**
- * Information about references that should be rendered as footnotes. This doesn't contain all references, just the
- * ones from inside definitions.
+ * Information about references that should be rendered as footnotes. This doesn't contain all
+ * references, just the ones from inside definitions.
*/
private final Map references = new HashMap<>();
@@ -81,7 +87,8 @@ public Set> getNodeTypes() {
@Override
public void beforeRoot(Node rootNode) {
- // Collect all definitions first, so we can look them up when encountering a reference later.
+ // Collect all definitions first, so we can look them up when encountering a reference
+ // later.
var visitor = new DefinitionVisitor();
rootNode.accept(visitor);
definitionMap = visitor.definitions;
@@ -90,11 +97,12 @@ public void beforeRoot(Node rootNode) {
@Override
public void render(Node node) {
if (node instanceof FootnoteReference) {
- // This is called for all references, even ones inside definitions that we render at the end.
- // Inside definitions, we have registered the reference already.
+ // This is called for all references, even ones inside definitions that we render at the
+ // end. Inside definitions, we have registered the reference already.
var ref = (FootnoteReference) node;
// Use containsKey because if value is null, we don't need to try registering again.
- var info = references.containsKey(ref) ? references.get(ref) : tryRegisterReference(ref);
+ var info =
+ references.containsKey(ref) ? references.get(ref) : tryRegisterReference(ref);
if (info != null) {
renderReference(ref, info);
} else {
@@ -126,26 +134,30 @@ public void afterRoot(Node rootNode) {
html.tag("ol");
html.line();
- // Check whether there are any footnotes inside the definitions that we're about to render. For those, we might
- // need to render more definitions. So do a breadth-first search to find all relevant definitions.
+ // Check whether there are any footnotes inside the definitions that we're about to render.
+ // For those, we might need to render more definitions. So do a breadth-first search to find
+ // all relevant definitions.
var check = new LinkedList<>(referencedDefinitions.keySet());
while (!check.isEmpty()) {
var def = check.removeFirst();
- def.accept(new ShallowReferenceVisitor(def, node -> {
- if (node instanceof FootnoteReference) {
- var ref = (FootnoteReference) node;
- var d = definitionMap.get(ref.getLabel());
- if (d != null) {
- if (!referencedDefinitions.containsKey(d)) {
- check.addLast(d);
- }
- references.put(ref, registerReference(d, d.getLabel()));
- }
- } else if (node instanceof InlineFootnote) {
- check.addLast(node);
- references.put(node, registerReference(node, null));
- }
- }));
+ def.accept(
+ new ShallowReferenceVisitor(
+ def,
+ node -> {
+ if (node instanceof FootnoteReference) {
+ var ref = (FootnoteReference) node;
+ var d = definitionMap.get(ref.getLabel());
+ if (d != null) {
+ if (!referencedDefinitions.containsKey(d)) {
+ check.addLast(d);
+ }
+ references.put(ref, registerReference(d, d.getLabel()));
+ }
+ } else if (node instanceof InlineFootnote) {
+ check.addLast(node);
+ references.put(node, registerReference(node, null));
+ }
+ }));
}
for (var entry : referencedDefinitions.entrySet()) {
@@ -169,15 +181,19 @@ private ReferenceInfo tryRegisterReference(FootnoteReference ref) {
private ReferenceInfo registerReference(Node node, String label) {
// The first referenced definition gets number 1, second one 2, etc.
- var referencedDef = referencedDefinitions.computeIfAbsent(node, k -> {
- var num = referencedDefinitions.size() + 1;
- var key = definitionKey(label, num);
- return new ReferencedDefinition(num, key);
- });
+ var referencedDef =
+ referencedDefinitions.computeIfAbsent(
+ node,
+ k -> {
+ var num = referencedDefinitions.size() + 1;
+ var key = definitionKey(label, num);
+ return new ReferencedDefinition(num, key);
+ });
var definitionNumber = referencedDef.definitionNumber;
- // The reference number for that particular definition. E.g. if there's two references for the same definition,
- // the first one is 1, the second one 2, etc. This is needed to give each reference a unique ID so that each
- // reference can get its own backlink from the definition.
+ // The reference number for that particular definition. E.g. if there's two references for
+ // the same definition, the first one is 1, the second one 2, etc. This is needed to give
+ // each reference a unique ID so that each reference can get its own backlink from the
+ // definition.
var refNumber = referencedDef.references.size() + 1;
var definitionKey = referencedDef.definitionKey;
var id = referenceId(definitionKey, refNumber);
@@ -212,8 +228,9 @@ private void renderDefinition(Node def, ReferencedDefinition referencedDefinitio
var node = def.getFirstChild();
while (node != lastParagraph) {
if (node instanceof Paragraph) {
- // Because we're manually rendering the
for the last paragraph, do the same for all other
- // paragraphs for consistency (Paragraph rendering might be overwritten by a custom renderer).
+ // Because we're manually rendering the
for the last paragraph, do the same
+ // for all other paragraphs for consistency (Paragraph rendering might be
+ // overwritten by a custom renderer).
html.tag("p", context.extendAttributes(node, "p", Map.of()));
renderChildren(node);
html.tag("/p");
@@ -252,7 +269,9 @@ private void renderBackrefs(Node def, ReferencedDefinition referencedDefinition)
for (int i = 0; i < refs.size(); i++) {
var ref = refs.get(i);
var refNumber = i + 1;
- var idx = referencedDefinition.definitionNumber + (refNumber > 1 ? ("-" + refNumber) : "");
+ var idx =
+ referencedDefinition.definitionNumber
+ + (refNumber > 1 ? ("-" + refNumber) : "");
var attrs = new LinkedHashMap();
attrs.put("href", "#" + ref);
@@ -262,7 +281,9 @@ private void renderBackrefs(Node def, ReferencedDefinition referencedDefinition)
attrs.put("aria-label", "Back to reference " + idx);
html.tag("a", context.extendAttributes(def, "a", attrs));
if (refNumber > 1) {
- html.tag("sup", context.extendAttributes(def, "sup", Map.of("class", "footnote-ref")));
+ html.tag(
+ "sup",
+ context.extendAttributes(def, "sup", Map.of("class", "footnote-ref")));
html.raw(String.valueOf(refNumber));
html.tag("/sup");
}
@@ -280,8 +301,9 @@ private String referenceId(String definitionKey, int number) {
}
private String definitionKey(String label, int number) {
- // Named definitions use the pattern "fn-{name}" and inline definitions use "fn{number}" so as not to conflict.
- // "fn{number}" is also what pandoc uses (for all types), starting with number 1.
+ // Named definitions use the pattern "fn-{name}" and inline definitions use "fn{number}" so
+ // as not to conflict. "fn{number}" is also what pandoc uses (for all types), starting with
+ // number 1.
if (label != null) {
return "-" + label;
} else {
@@ -304,7 +326,8 @@ private void renderChildren(Node parent) {
private static class DefinitionVisitor extends AbstractVisitor {
- private final DefinitionMap definitions = new DefinitionMap<>(FootnoteDefinition.class);
+ private final DefinitionMap definitions =
+ new DefinitionMap<>(FootnoteDefinition.class);
@Override
public void visit(CustomBlock customBlock) {
@@ -318,8 +341,8 @@ public void visit(CustomBlock customBlock) {
}
/**
- * Visit footnote references/inline footnotes inside the parent (but not the parent itself). We want a shallow visit
- * because the caller wants to control when to descend.
+ * Visit footnote references/inline footnotes inside the parent (but not the parent itself). We
+ * want a shallow visit because the caller wants to control when to descend.
*/
private static class ShallowReferenceVisitor extends AbstractVisitor {
private final Node parent;
@@ -349,17 +372,16 @@ public void visit(CustomNode customNode) {
}
private static class ReferencedDefinition {
- /**
- * The definition number, starting from 1, and in order in which they're referenced.
- */
+ /** The definition number, starting from 1, and in order in which they're referenced. */
final int definitionNumber;
+
/**
- * The unique key of the definition. Together with a static prefix it forms the ID used in the HTML.
+ * The unique key of the definition. Together with a static prefix it forms the ID used in
+ * the HTML.
*/
final String definitionKey;
- /**
- * The IDs of references for this definition, for backrefs.
- */
+
+ /** The IDs of references for this definition, for backrefs. */
final List references = new ArrayList<>();
ReferencedDefinition(int definitionNumber, String definitionKey) {
@@ -370,16 +392,15 @@ private static class ReferencedDefinition {
private static class ReferenceInfo {
/**
- * The ID of the reference; in the corresponding definition, a link back to this reference will be rendered.
+ * The ID of the reference; in the corresponding definition, a link back to this reference
+ * will be rendered.
*/
private final String id;
- /**
- * The ID of the definition, for linking to the definition.
- */
+
+ /** The ID of the definition, for linking to the definition. */
private final String definitionId;
- /**
- * The definition number, rendered in superscript.
- */
+
+ /** The definition number, rendered in superscript. */
private final int definitionNumber;
private ReferenceInfo(String id, String definitionId, int definitionNumber) {
diff --git a/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteLinkProcessor.java b/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteLinkProcessor.java
index 07b008576..66a889855 100644
--- a/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteLinkProcessor.java
+++ b/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteLinkProcessor.java
@@ -11,17 +11,18 @@
import org.commonmark.parser.beta.Scanner;
/**
- * For turning e.g. [^foo] into a {@link FootnoteReference},
- * and ^[foo] into an {@link InlineFootnote}.
+ * For turning e.g. [^foo] into a {@link FootnoteReference}, and ^[foo]
+ * into an {@link InlineFootnote}.
*/
public class FootnoteLinkProcessor implements LinkProcessor {
@Override
public LinkResult process(LinkInfo linkInfo, Scanner scanner, InlineParserContext context) {
if (linkInfo.marker() != null && linkInfo.marker().getLiteral().equals("^")) {
- // An inline footnote like ^[footnote text]. Note that we only get the marker here if the option is enabled
- // on the extension.
- return LinkResult.wrapTextIn(new InlineFootnote(), linkInfo.afterTextBracket()).includeMarker();
+ // An inline footnote like ^[footnote text]. Note that we only get the marker here if
+ // the option is enabled on the extension.
+ return LinkResult.wrapTextIn(new InlineFootnote(), linkInfo.afterTextBracket())
+ .includeMarker();
}
if (linkInfo.destination() != null) {
@@ -35,21 +36,25 @@ public LinkResult process(LinkInfo linkInfo, Scanner scanner, InlineParserContex
return LinkResult.none();
}
- if (linkInfo.label() != null && context.getDefinition(LinkReferenceDefinition.class, linkInfo.label()) != null) {
- // If there's a label after the text and the label has a definition -> it's a link, and it should take
- // preference, e.g. in `[^foo][bar]` if `[bar]` has a definition, `[^foo]` won't be a footnote reference.
+ if (linkInfo.label() != null
+ && context.getDefinition(LinkReferenceDefinition.class, linkInfo.label()) != null) {
+ // If there's a label after the text and the label has a definition -> it's a link, and
+ // it should take preference, e.g. in `[^foo][bar]` if `[bar]` has a definition,
+ // `[^foo]` won't be a footnote reference.
return LinkResult.none();
}
var label = text.substring(1);
- // Check if we have a definition, otherwise ignore (same behavior as for link reference definitions).
- // Note that the definition parser already checked the syntax of the label, we don't need to check again.
+ // Check if we have a definition, otherwise ignore (same behavior as for link reference
+ // definitions). Note that the definition parser already checked the syntax of the label, we
+ // don't need to check again.
var def = context.getDefinition(FootnoteDefinition.class, label);
if (def == null) {
return LinkResult.none();
}
- // For footnotes, we only ever consume the text part of the link, not the label part (if any)
+ // For footnotes, we only ever consume the text part of the link, not the label part (if
+ // any)
var position = linkInfo.afterTextBracket();
// If the marker is `![`, we don't want to include the `!`, so start from bracket
return LinkResult.replaceWith(new FootnoteReference(label), position);
diff --git a/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteMarkdownNodeRenderer.java b/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteMarkdownNodeRenderer.java
index 3dcf4fc83..0e654cf5e 100644
--- a/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteMarkdownNodeRenderer.java
+++ b/commonmark-ext-footnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteMarkdownNodeRenderer.java
@@ -1,5 +1,6 @@
package org.commonmark.ext.footnotes.internal;
+import java.util.Set;
import org.commonmark.ext.footnotes.FootnoteDefinition;
import org.commonmark.ext.footnotes.FootnoteReference;
import org.commonmark.ext.footnotes.InlineFootnote;
@@ -8,8 +9,6 @@
import org.commonmark.renderer.markdown.MarkdownNodeRendererContext;
import org.commonmark.renderer.markdown.MarkdownWriter;
-import java.util.Set;
-
public class FootnoteMarkdownNodeRenderer implements NodeRenderer {
private final MarkdownWriter writer;
diff --git a/commonmark-ext-footnotes/src/test/java/org/commonmark/ext/footnotes/FootnoteHtmlRendererTest.java b/commonmark-ext-footnotes/src/test/java/org/commonmark/ext/footnotes/FootnoteHtmlRendererTest.java
index bc7d4f74c..1a89693b4 100644
--- a/commonmark-ext-footnotes/src/test/java/org/commonmark/ext/footnotes/FootnoteHtmlRendererTest.java
+++ b/commonmark-ext-footnotes/src/test/java/org/commonmark/ext/footnotes/FootnoteHtmlRendererTest.java
@@ -1,5 +1,7 @@
package org.commonmark.ext.footnotes;
+import java.util.List;
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.node.Document;
import org.commonmark.node.Paragraph;
@@ -10,40 +12,40 @@
import org.commonmark.testutil.RenderingTestCase;
import org.junit.jupiter.api.Test;
-import java.util.List;
-import java.util.Set;
-
public class FootnoteHtmlRendererTest extends RenderingTestCase {
private static final Set EXTENSIONS = Set.of(FootnotesExtension.create());
private static final Parser PARSER = Parser.builder().extensions(EXTENSIONS).build();
- private static final HtmlRenderer RENDERER = HtmlRenderer.builder().extensions(EXTENSIONS).build();
+ private static final HtmlRenderer RENDERER =
+ HtmlRenderer.builder().extensions(EXTENSIONS).build();
@Test
public void testOne() {
- assertRendering("Test [^foo]\n\n[^foo]: note\n",
- "
\n"
+ + "\n"
+ + "\n");
}
@Test
public void testLabelNormalization() {
- // Labels match via their normalized form. For the href and IDs to match, rendering needs to use the
- // label from the definition consistently.
- assertRendering("Test [^bar]\n\n[^BAR]: note\n",
- "
\n" +
- "\n" +
- "\n");
+ // Labels match via their normalized form. For the href and IDs to match, rendering needs to
+ // use the label from the definition consistently.
+ assertRendering(
+ "Test [^bar]\n\n[^BAR]: note\n",
+ "
\n"
+ + "\n"
+ + "\n");
}
@Test
@@ -52,254 +54,251 @@ public void testMultipleReferences() {
// - Numbering is based on the reference order, not the definition order
// - The same number is used when a definition is referenced multiple times
// - Multiple backrefs are rendered
- assertRendering("First [^foo]\n\nThen [^bar]\n\nThen [^foo] again\n\n[^bar]: b\n[^foo]: f\n",
- "
\n"
+ + "\n"
+ + "\n");
}
@Test
public void testNestedFootnotesOrder() {
// GitHub has a strange result here, the definitions are in order: 1. bar, 2. foo.
- // The reason is that the number is done based on all references in document order, including references in
- // definitions. So [^bar] from the first line is first.
- assertRendering("[^foo]: foo [^bar]\n" +
- "\n" +
- "[^foo]\n" +
- "\n" +
- "[^bar]: bar\n", "
\n" +
- "\n" +
- "\n");
+ // The reason is that the number is done based on all references in document order,
+ // including references in definitions. So [^bar] from the first line is first.
+ assertRendering(
+ "[^foo]: foo [^bar]\n" + "\n" + "[^foo]\n" + "\n" + "[^bar]: bar\n",
+ "
\n"
+ + "\n"
+ + "\n");
}
@Test
public void testNestedFootnotesUnreferenced() {
// This should not result in any footnotes, as baz itself isn't referenced.
// But GitHub renders bar only, with a broken backref, because bar is referenced from foo.
- assertRendering("[^foo]: foo[^bar]\n" +
- "[^bar]: bar\n", "");
+ assertRendering("[^foo]: foo[^bar]\n" + "[^bar]: bar\n", "");
// And here only 1 is rendered.
- assertRendering("[^1]\n" +
- "\n" +
- "[^1]: one\n" +
- "[^foo]: foo[^bar]\n" +
- "[^bar]: bar\n", "
\n"
+ + "\n"
+ + "\n");
}
@Test
public void testInlineFootnoteWithReference() {
// This is a bit tricky because the IDs need to be unique.
- assertRenderingInline("Test ^[inline [^1]]\n" +
- "\n" +
- "[^1]: normal",
- "
\n"
+ + "\n"
+ + "\n");
}
-
@Test
public void testRenderNodesDirectly() {
// Everything should work as expected when rendering from nodes directly (no parsing step).
@@ -314,14 +313,15 @@ public void testRenderNodesDirectly() {
doc.appendChild(p);
doc.appendChild(def);
- var expected = "
\n"
+ + "\n"
+ + "\n";
Asserts.assertRendering("", expected, RENDERER.render(doc));
}
diff --git a/commonmark-ext-footnotes/src/test/java/org/commonmark/ext/footnotes/FootnoteMarkdownRendererTest.java b/commonmark-ext-footnotes/src/test/java/org/commonmark/ext/footnotes/FootnoteMarkdownRendererTest.java
index 2f1125a02..3c6febe7b 100644
--- a/commonmark-ext-footnotes/src/test/java/org/commonmark/ext/footnotes/FootnoteMarkdownRendererTest.java
+++ b/commonmark-ext-footnotes/src/test/java/org/commonmark/ext/footnotes/FootnoteMarkdownRendererTest.java
@@ -1,19 +1,20 @@
package org.commonmark.ext.footnotes;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.node.Node;
import org.commonmark.parser.Parser;
import org.commonmark.renderer.markdown.MarkdownRenderer;
import org.junit.jupiter.api.Test;
-import java.util.Set;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
public class FootnoteMarkdownRendererTest {
- private static final Set EXTENSIONS = Set.of(FootnotesExtension.builder().inlineFootnotes(true).build());
+ private static final Set EXTENSIONS =
+ Set.of(FootnotesExtension.builder().inlineFootnotes(true).build());
private static final Parser PARSER = Parser.builder().extensions(EXTENSIONS).build();
- private static final MarkdownRenderer RENDERER = MarkdownRenderer.builder().extensions(EXTENSIONS).build();
+ private static final MarkdownRenderer RENDERER =
+ MarkdownRenderer.builder().extensions(EXTENSIONS).build();
@Test
public void testSimple() {
@@ -22,7 +23,8 @@ public void testSimple() {
@Test
public void testUnreferenced() {
- // Whether a reference has a corresponding definition or vice versa shouldn't matter for Markdown rendering.
+ // Whether a reference has a corresponding definition or vice versa shouldn't matter for
+ // Markdown rendering.
assertRoundTrip("Test [^foo]\n\n[^foo]: one\n\n[^bar]: two\n");
}
@@ -43,8 +45,8 @@ public void testMultipleLines() {
@Test
public void testMultipleParagraphs() {
- // Note that the line between p1 and p2 could be blank too (instead of 4 spaces), but we currently don't
- // preserve that information.
+ // Note that the line between p1 and p2 could be blank too (instead of 4 spaces), but we
+ // currently don't preserve that information.
assertRoundTrip("Test [^1]\n\n[^1]: footnote p1\n \n footnote p2\n");
}
diff --git a/commonmark-ext-footnotes/src/test/java/org/commonmark/ext/footnotes/FootnotesTest.java b/commonmark-ext-footnotes/src/test/java/org/commonmark/ext/footnotes/FootnotesTest.java
index 7763cedb4..ca76e47cd 100644
--- a/commonmark-ext-footnotes/src/test/java/org/commonmark/ext/footnotes/FootnotesTest.java
+++ b/commonmark-ext-footnotes/src/test/java/org/commonmark/ext/footnotes/FootnotesTest.java
@@ -1,17 +1,16 @@
package org.commonmark.ext.footnotes;
-import org.commonmark.Extension;
-import org.commonmark.node.*;
-import org.commonmark.parser.IncludeSourceSpans;
-import org.commonmark.parser.Parser;
-import org.junit.jupiter.api.Test;
+import static org.assertj.core.api.Assertions.assertThat;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.Set;
-
-import static org.assertj.core.api.Assertions.assertThat;
+import org.commonmark.Extension;
+import org.commonmark.node.*;
+import org.commonmark.parser.IncludeSourceSpans;
+import org.commonmark.parser.Parser;
+import org.junit.jupiter.api.Test;
public class FootnotesTest {
@@ -35,7 +34,8 @@ public void testDefBlockStart() {
@Test
public void testDefBlockStartInterrupts() {
- // This is different from a link reference definition, which can only be at the start of paragraphs.
+ // This is different from a link reference definition, which can only be at the start of
+ // paragraphs.
var doc = PARSER.parse("test\n[^1]: footnote\n");
var paragraph = find(doc, Paragraph.class);
var def = find(doc, FootnoteDefinition.class);
@@ -172,7 +172,8 @@ public void testRefWithEmphasisInside() {
@Test
public void testRefWithEmphasisAround() {
- // Emphasis around footnote reference, the * inside needs to be removed from emphasis processing
+ // Emphasis around footnote reference, the * inside needs to be removed from emphasis
+ // processing
var doc = PARSER.parse("Test *abc [^foo*] def*\n\n[^foo*]: def\n");
var ref = find(doc, FootnoteReference.class);
assertThat(ref.getLabel()).isEqualTo("foo*");
@@ -193,8 +194,9 @@ public void testRefAfterBang() {
@Test
public void testRefAsLabelOnly() {
- // [^bar] is a footnote but [foo] is just text, because full reference links (text `foo`, label `^bar`) don't
- // resolve as footnotes. If `[foo][^bar]` fails to parse as a bracket, `[^bar]` by itself needs to be tried.
+ // [^bar] is a footnote but [foo] is just text, because full reference links (text `foo`,
+ // label `^bar`) don't resolve as footnotes. If `[foo][^bar]` fails to parse as a bracket,
+ // `[^bar]` by itself needs to be tried.
var doc = PARSER.parse("Test [foo][^bar]\n\n[^bar]: footnote\n");
var ref = find(doc, FootnoteReference.class);
assertThat(ref.getLabel()).isEqualTo("bar");
@@ -204,7 +206,8 @@ public void testRefAsLabelOnly() {
@Test
public void testRefWithEmptyLabel() {
- // [^bar] is a footnote but [] is just text, because collapsed reference links don't resolve as footnotes
+ // [^bar] is a footnote but [] is just text, because collapsed reference links don't resolve
+ // as footnotes
var doc = PARSER.parse("Test [^bar][]\n\n[^bar]: footnote\n");
var ref = find(doc, FootnoteReference.class);
assertThat(ref.getLabel()).isEqualTo("bar");
@@ -237,8 +240,8 @@ public void testPreferInlineLink() {
@Test
public void testPreferReferenceLink() {
- // This is tricky because `[^*foo*][foo]` is a valid link already. If `[foo]` was not defined, the first bracket
- // would be a footnote.
+ // This is tricky because `[^*foo*][foo]` is a valid link already. If `[foo]` was not
+ // defined, the first bracket would be a footnote.
var doc = PARSER.parse("Test [^*foo*][foo]\n\n[^*foo*]: /url\n\n[foo]: /url");
assertNone(doc, FootnoteReference.class);
}
@@ -256,10 +259,13 @@ public void testReferenceLinkWithoutDefinition() {
@Test
public void testFootnoteInLink() {
- // Expected to behave the same way as a link within a link, see https://spec.commonmark.org/0.31.2/#example-518
- // i.e. the first (inner) link is parsed, which means the outer one becomes plain text, as nesting links is not
- // allowed.
- var doc = PARSER.parse("[link with footnote ref [^1]](https://example.com)\n\n[^1]: footnote\n");
+ // Expected to behave the same way as a link within a link, see
+ // https://spec.commonmark.org/0.31.2/#example-518
+ // i.e. the first (inner) link is parsed, which means the outer one becomes plain text, as
+ // nesting links is not allowed.
+ var doc =
+ PARSER.parse(
+ "[link with footnote ref [^1]](https://example.com)\n\n[^1]: footnote\n");
var ref = find(doc, FootnoteReference.class);
assertThat(ref.getLabel()).isEqualTo("1");
var paragraph = doc.getFirstChild();
@@ -269,7 +275,9 @@ public void testFootnoteInLink() {
@Test
public void testFootnoteWithMarkerInLink() {
- var doc = PARSER.parse("[link with footnote ref ![^1]](https://example.com)\n\n[^1]: footnote\n");
+ var doc =
+ PARSER.parse(
+ "[link with footnote ref ![^1]](https://example.com)\n\n[^1]: footnote\n");
var ref = find(doc, FootnoteReference.class);
assertThat(ref.getLabel()).isEqualTo("1");
var paragraph = doc.getFirstChild();
@@ -325,7 +333,11 @@ public void testInlineFootnote() {
@Test
public void testSourcePositions() {
- var parser = Parser.builder().extensions(EXTENSIONS).includeSourceSpans(IncludeSourceSpans.BLOCKS_AND_INLINES).build();
+ var parser =
+ Parser.builder()
+ .extensions(EXTENSIONS)
+ .includeSourceSpans(IncludeSourceSpans.BLOCKS_AND_INLINES)
+ .build();
var doc = parser.parse("Test [^foo]\n\n[^foo]: /url\n");
var ref = find(doc, FootnoteReference.class);
@@ -336,11 +348,15 @@ public void testSourcePositions() {
}
private static void assertNone(Node parent, Class nodeClass) {
- assertThat(tryFind(parent, nodeClass)).as(() -> "Node " + parent + " containing " + nodeClass).isNull();
+ assertThat(tryFind(parent, nodeClass))
+ .as(() -> "Node " + parent + " containing " + nodeClass)
+ .isNull();
}
private static T find(Node parent, Class nodeClass) {
- return Objects.requireNonNull(tryFind(parent, nodeClass), "Could not find a " + nodeClass.getSimpleName() + " node in " + parent);
+ return Objects.requireNonNull(
+ tryFind(parent, nodeClass),
+ "Could not find a " + nodeClass.getSimpleName() + " node in " + parent);
}
private static T tryFind(Node parent, Class nodeClass) {
diff --git a/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/Alert.java b/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/Alert.java
index 71c35d24d..5725d53cd 100644
--- a/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/Alert.java
+++ b/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/Alert.java
@@ -21,31 +21,32 @@ public String getType() {
/**
* @return Whether this alert has any body content (not including the title).
- *
+ *
- Examples where this would be {@code true}:
+ *
{@code
+ * > [!NOTE]
+ * > Body text
*
- * - Examples where this would be {@code true}:
- *
{@code
- * > [!NOTE]
- * > Body text
- * }
- *
{@code
- * > [!NOTE] Custom title
- * > Body text
- * }
+ * }
+ *
{@code
+ * > [!NOTE] Custom title
+ * > Body text
*
- * - Examples where this would be {@code false}:
+ * }
+ * - Examples where this would be {@code false}:
+ *
{@code
+ * > [!NOTE]
*
- *
{@code
- * > [!NOTE]
- * }
- *
{@code
- * > [!NOTE]
- * >
- * >
- * }
- *
{@code
- * > [!NOTE] Custom title
- * }
+ * }
+ *
{@code
+ * > [!NOTE]
+ * >
+ * >
+ *
+ * }
+ *
{@code
+ * > [!NOTE] Custom title
+ *
+ * }
*/
public boolean hasBody() {
var first = this.getFirstChild();
diff --git a/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/AlertTitle.java b/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/AlertTitle.java
index c085af746..fc537759c 100644
--- a/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/AlertTitle.java
+++ b/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/AlertTitle.java
@@ -5,20 +5,18 @@
/**
* Inline content container for the optional custom title of an {@link Alert}.
*
- *
- * When present, an {@code AlertTitle} is always the first child of an {@link Alert}.
- * Its own children are the parsed inline nodes of the title (i.e., the text after
- * the {@code [!TYPE]} marker on the same line). For example, in
+ *
When present, an {@code AlertTitle} is always the first child of an {@link Alert}. Its own
+ * children are the parsed inline nodes of the title (i.e., the text after the {@code [!TYPE]}
+ * marker on the same line). For example, in
*
*
{@code
* > [!NOTE] Custom _title_
* > Body text
* }
*
- * the {@code AlertTitle} contains a {@code Text} node ({@code "Custom "}) followed
- * by an {@code Emphasis} node wrapping {@code "title"}.
+ * the {@code AlertTitle} contains a {@code Text} node ({@code "Custom "}) followed by an {@code
+ * Emphasis} node wrapping {@code "title"}.
*
* @see AlertsExtension.Builder#allowCustomTitles(boolean)
*/
-public class AlertTitle extends CustomNode {
-}
+public class AlertTitle extends CustomNode {}
diff --git a/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/AlertsExtension.java b/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/AlertsExtension.java
index ed81a2c3f..3035c9952 100644
--- a/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/AlertsExtension.java
+++ b/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/AlertsExtension.java
@@ -1,5 +1,11 @@
package org.commonmark.ext.gfm.alerts;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Objects;
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.ext.gfm.alerts.internal.AlertBlockParser;
import org.commonmark.ext.gfm.alerts.internal.AlertHtmlNodeRenderer;
@@ -13,61 +19,60 @@
import org.commonmark.renderer.markdown.MarkdownRenderer;
import org.commonmark.renderer.text.TextContentRenderer;
-import java.util.HashMap;
-import java.util.Locale;
-import java.util.HashSet;
-import java.util.Map;
-import java.util.Objects;
-import java.util.Set;
-
/**
* Extension for GFM alerts using {@code [!TYPE]} syntax (GitHub Flavored Markdown).
- *
- * Create with {@link #create()} or {@link #builder()} and configure on builders
- * ({@link Parser.Builder#extensions(Iterable)}, {@link HtmlRenderer.Builder#extensions(Iterable)}).
- * Parsed alerts become {@link Alert} blocks. If custom alert titles are allowed
- * via {@link Builder#allowCustomTitles(boolean)}, the inline formatting of those
- * titles will be parsed into {@link AlertTitle} nodes.
*
- * The {@link #create() default configuration} of this extension will match GFM
- * exactly, with the following exceptions:
+ *
Create with {@link #create()} or {@link #builder()} and configure on builders ({@link
+ * Parser.Builder#extensions(Iterable)}, {@link HtmlRenderer.Builder#extensions(Iterable)}). Parsed
+ * alerts become {@link Alert} blocks. If custom alert titles are allowed via {@link
+ * Builder#allowCustomTitles(boolean)}, the inline formatting of those titles will be parsed into
+ * {@link AlertTitle} nodes.
+ *
+ *
The {@link #create() default configuration} of this extension will match GFM exactly, with the
+ * following exceptions:
*
- * - Alert markers take precedence over shortcut reference links.
+ *
- Alert markers take precedence over shortcut reference links.
* - Alerts with no content are allowed. Example:
*
- *
* - Lazy continuation is not allowed between the marker and the body text. Example:
*
- *
{@code
- * > [!NOTE]
- * Lazy body text will be parsed as a new paragraph
- * }
+ *
{@code
+ * > [!NOTE]
+ * Lazy body text will be parsed as a new paragraph
+ *
+ * }
*/
-public class AlertsExtension implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension,
- TextContentRenderer.TextContentRendererExtension, MarkdownRenderer.MarkdownRendererExtension {
-
- /**
- * The standard GitHub Flavored Markdown (GFM) types that the extension
- * enables by default. These can be overwritten with {@link Builder#setAllowedTypes(Map)}.
- */
- public static final Map STANDARD_TYPES = Map.ofEntries(
- Map.entry("NOTE", "Note"),
- Map.entry("TIP", "Tip"),
- Map.entry("IMPORTANT", "Important"),
- Map.entry("WARNING", "Warning"),
- Map.entry("CAUTION", "Caution")
- );
+public class AlertsExtension
+ implements Parser.ParserExtension,
+ HtmlRenderer.HtmlRendererExtension,
+ TextContentRenderer.TextContentRendererExtension,
+ MarkdownRenderer.MarkdownRendererExtension {
/**
- * A map of alert marker ({@code [!TYPE]}) to the default title for that marker.
+ * The standard GitHub Flavored Markdown (GFM) types that the extension enables by default.
+ * These can be overwritten with {@link Builder#setAllowedTypes(Map)}.
*/
+ public static final Map STANDARD_TYPES =
+ Map.ofEntries(
+ Map.entry("NOTE", "Note"),
+ Map.entry("TIP", "Tip"),
+ Map.entry("IMPORTANT", "Important"),
+ Map.entry("WARNING", "Warning"),
+ Map.entry("CAUTION", "Caution"));
+
+ /** A map of alert marker ({@code [!TYPE]}) to the default title for that marker. */
private final Map allowedTypes;
+
private final boolean customTitlesAllowed;
private final boolean nestedAlertsAllowed;
@@ -89,37 +94,39 @@ public static Builder builder() {
public void extend(Parser.Builder parserBuilder) {
var allowedTypesSet = new HashSet<>(allowedTypes.keySet());
parserBuilder.customBlockParserFactory(
- new AlertBlockParser.Factory(allowedTypesSet, customTitlesAllowed, nestedAlertsAllowed));
+ new AlertBlockParser.Factory(
+ allowedTypesSet, customTitlesAllowed, nestedAlertsAllowed));
}
@Override
public void extend(HtmlRenderer.Builder rendererBuilder) {
- rendererBuilder.nodeRendererFactory(context -> new AlertHtmlNodeRenderer(context, allowedTypes));
+ rendererBuilder.nodeRendererFactory(
+ context -> new AlertHtmlNodeRenderer(context, allowedTypes));
}
@Override
public void extend(TextContentRenderer.Builder rendererBuilder) {
- rendererBuilder.nodeRendererFactory(context -> new AlertTextContentNodeRenderer(context, allowedTypes));
+ rendererBuilder.nodeRendererFactory(
+ context -> new AlertTextContentNodeRenderer(context, allowedTypes));
}
@Override
public void extend(MarkdownRenderer.Builder rendererBuilder) {
- rendererBuilder.nodeRendererFactory(new MarkdownNodeRendererFactory() {
- @Override
- public NodeRenderer create(MarkdownNodeRendererContext context) {
- return new AlertMarkdownNodeRenderer(context);
- }
-
- @Override
- public Set getSpecialCharacters() {
- return Set.of();
- }
- });
+ rendererBuilder.nodeRendererFactory(
+ new MarkdownNodeRendererFactory() {
+ @Override
+ public NodeRenderer create(MarkdownNodeRendererContext context) {
+ return new AlertMarkdownNodeRenderer(context);
+ }
+
+ @Override
+ public Set getSpecialCharacters() {
+ return Set.of();
+ }
+ });
}
- /**
- * Builder for configuring the alerts extension.
- */
+ /** Builder for configuring the alerts extension. */
public static class Builder {
private Map allowedTypes = new HashMap<>(STANDARD_TYPES);
private boolean customTitlesAllowed = false;
@@ -128,12 +135,12 @@ public static class Builder {
/**
* Sets which alert types will be recognized and parsed into {@link Alert} blocks,
* completely overwriting any previous configuration.
- *
- * By default, {@link AlertsExtension#STANDARD_TYPES} are used.
*
- * @param allowedTypes A map of alert type to the default title for that type.
- * Must not be null/empty or contain any null/empty keys or
- * values. Additionally, all alert types must be uppercase.
+ *
By default, {@link AlertsExtension#STANDARD_TYPES} are used.
+ *
+ * @param allowedTypes A map of alert type to the default title for that type. Must not be
+ * null/empty or contain any null/empty keys or values. Additionally, all alert types
+ * must be uppercase.
* @return {@code this}
* @see Builder#addCustomType(String, String)
*/
@@ -153,9 +160,9 @@ public Builder setAllowedTypes(Map allowedTypes) {
/**
* Adds a custom alert type with a default title.
- *
- * This can also be used to override the default title of standard GFM types
- * (e.g., for localization).
+ *
+ *
This can also be used to override the default title of standard GFM types (e.g., for
+ * localization).
*
* @param type the alert type (must be uppercase)
* @param title the default title for this alert type
@@ -169,8 +176,8 @@ public Builder addCustomType(String type, String title) {
}
/**
- * Allows or disallows custom titles on alerts. Inline formatting is supported
- * within these titles.
+ * Allows or disallows custom titles on alerts. Inline formatting is supported within these
+ * titles.
*
* @param allow Whether to allow or disallow custom titles on alerts.
* @return {@code this}
@@ -183,11 +190,11 @@ public Builder allowCustomTitles(boolean allow) {
/**
* Allows or disallows parsing alerts within non-root blocks ({@code Document}).
- *
- * When disallowed, if an alert appears within another block, it will be parsed as
- * a regular {@code BlockQuote}.
- *
- * Note that even when this is allowed, {@link Parser.Builder#maxOpenBlockParsers(int)}
+ *
+ *
When disallowed, if an alert appears within another block, it will be parsed as a
+ * regular {@code BlockQuote}.
+ *
+ *
Note that even when this is allowed, {@link Parser.Builder#maxOpenBlockParsers(int)}
* will be respected.
*
* @param allow Whether to allow or disallow parsing alerts within non-root blocks.
@@ -208,10 +215,7 @@ public Extension build() {
/**
* Checks whether an alert type and default title are valid.
*
- * @param type The type to validate:
- *
- * - Must not be null or empty
- * - Must be uppercase
+ * @param type The type to validate. Must be uppercase.
* @param title The default title to validate. Must not be null or empty.
*/
private void validateTypeAndTitle(String type, String title) {
diff --git a/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/internal/AlertBlockParser.java b/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/internal/AlertBlockParser.java
index e7a9f402e..67acbe475 100644
--- a/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/internal/AlertBlockParser.java
+++ b/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/internal/AlertBlockParser.java
@@ -4,7 +4,6 @@
import java.util.Locale;
import java.util.Set;
import java.util.regex.Pattern;
-
import org.commonmark.ext.gfm.alerts.Alert;
import org.commonmark.ext.gfm.alerts.AlertTitle;
import org.commonmark.node.Block;
@@ -23,8 +22,10 @@
public class AlertBlockParser extends AbstractBlockParser {
- private static final Pattern ALERT_PATTERN_NO_CUSTOM_TITLE = Pattern.compile("^\\[!([a-zA-Z]+)]\\s*$");
- private static final Pattern ALERT_PATTERN_CUSTOM_TITLE = Pattern.compile("^\\[!([a-zA-Z]+)](.*)$");
+ private static final Pattern ALERT_PATTERN_NO_CUSTOM_TITLE =
+ Pattern.compile("^\\[!([a-zA-Z]+)]\\s*$");
+ private static final Pattern ALERT_PATTERN_CUSTOM_TITLE =
+ Pattern.compile("^\\[!([a-zA-Z]+)](.*)$");
private final Alert block;
private final SourceLine titleLine;
@@ -103,7 +104,10 @@ public static class Factory extends AbstractBlockParserFactory {
private final boolean customTitlesAllowed;
private final boolean nestedAlertsAllowed;
- public Factory(Set allowedTypes, boolean customTitlesAllowed, boolean nestedAlertsAllowed) {
+ public Factory(
+ Set allowedTypes,
+ boolean customTitlesAllowed,
+ boolean nestedAlertsAllowed) {
this.allowedTypes = allowedTypes;
this.customTitlesAllowed = customTitlesAllowed;
this.nestedAlertsAllowed = nestedAlertsAllowed;
@@ -116,7 +120,8 @@ public BlockStart tryStart(ParserState state, MatchedBlockParser matchedBlockPar
return BlockStart.none();
}
- if (!nestedAlertsAllowed && !isAtRoot(matchedBlockParser.getMatchedBlockParser().getBlock())) {
+ if (!nestedAlertsAllowed
+ && !isAtRoot(matchedBlockParser.getMatchedBlockParser().getBlock())) {
return BlockStart.none();
}
@@ -176,7 +181,10 @@ private BlockStart tryStartFresh(CharSequence line, int nextNonSpace, ParserStat
afterGt = state.getIndex();
}
- var pattern = customTitlesAllowed ? ALERT_PATTERN_CUSTOM_TITLE : ALERT_PATTERN_NO_CUSTOM_TITLE;
+ var pattern =
+ customTitlesAllowed
+ ? ALERT_PATTERN_CUSTOM_TITLE
+ : ALERT_PATTERN_NO_CUSTOM_TITLE;
var matcher = pattern.matcher(line.subSequence(afterGt, line.length()));
if (!matcher.matches()) {
@@ -215,7 +223,8 @@ private BlockStart tryStartFresh(CharSequence line, int nextNonSpace, ParserStat
// If we got here via the promotion path, replace the empty BlockQuote.
var matched = state.getActiveBlockParser().getBlock();
- if (matched instanceof BlockQuote && matched.getFirstChild() == null
+ if (matched instanceof BlockQuote
+ && matched.getFirstChild() == null
&& (nextNonSpace >= line.length() || line.charAt(nextNonSpace) != '>')) {
start = start.replaceActiveBlockParser();
}
diff --git a/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/internal/AlertHtmlNodeRenderer.java b/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/internal/AlertHtmlNodeRenderer.java
index 6b9ba6da9..30aea6f04 100644
--- a/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/internal/AlertHtmlNodeRenderer.java
+++ b/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/internal/AlertHtmlNodeRenderer.java
@@ -1,21 +1,21 @@
package org.commonmark.ext.gfm.alerts.internal;
+import java.util.LinkedHashMap;
+import java.util.Map;
import org.commonmark.ext.gfm.alerts.Alert;
import org.commonmark.ext.gfm.alerts.AlertTitle;
import org.commonmark.node.Node;
import org.commonmark.renderer.html.HtmlNodeRendererContext;
import org.commonmark.renderer.html.HtmlWriter;
-import java.util.LinkedHashMap;
-import java.util.Map;
-
public class AlertHtmlNodeRenderer extends AlertNodeRenderer {
private final HtmlWriter htmlWriter;
private final HtmlNodeRendererContext context;
private final Map allowedTypes;
- public AlertHtmlNodeRenderer(HtmlNodeRendererContext context, Map allowedTypes) {
+ public AlertHtmlNodeRenderer(
+ HtmlNodeRendererContext context, Map allowedTypes) {
this.htmlWriter = context.getWriter();
this.context = context;
this.allowedTypes = allowedTypes;
@@ -39,7 +39,8 @@ protected void renderAlert(Alert alert) {
htmlWriter.line();
// Render alert title
- htmlWriter.tag("p", context.extendAttributes(alert, "p", Map.of("class", "markdown-alert-title")));
+ htmlWriter.tag(
+ "p", context.extendAttributes(alert, "p", Map.of("class", "markdown-alert-title")));
var first = alert.getFirstChild();
if (first instanceof AlertTitle) {
renderChildren(first);
diff --git a/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/internal/AlertNodeRenderer.java b/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/internal/AlertNodeRenderer.java
index 42e505cb7..ff4bdf6ad 100644
--- a/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/internal/AlertNodeRenderer.java
+++ b/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/internal/AlertNodeRenderer.java
@@ -1,12 +1,11 @@
package org.commonmark.ext.gfm.alerts.internal;
+import java.util.Set;
import org.commonmark.ext.gfm.alerts.Alert;
import org.commonmark.ext.gfm.alerts.AlertTitle;
import org.commonmark.node.Node;
import org.commonmark.renderer.NodeRenderer;
-import java.util.Set;
-
public abstract class AlertNodeRenderer implements NodeRenderer {
@Override
@@ -23,8 +22,8 @@ public void render(Node node) {
protected abstract void renderAlert(Alert alert);
/**
- * Renders the children of a parent node, excluding {@link AlertTitle} nodes.
- * {@link AlertTitle} is rendered separately from other content.
+ * Renders the children of a parent node, excluding {@link AlertTitle} nodes. {@link AlertTitle}
+ * is rendered separately from other content.
*
* @param parent the parent node whose children should be rendered
*/
@@ -42,8 +41,8 @@ protected final void renderChildren(Node parent) {
}
/**
- * Renders a single node. Subclasses must implement this to delegate
- * to their context's render method.
+ * Renders a single node. Subclasses must implement this to delegate to their context's render
+ * method.
*
* @param node the node to render
*/
diff --git a/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/internal/AlertTextContentNodeRenderer.java b/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/internal/AlertTextContentNodeRenderer.java
index c14ea36a4..f494f5812 100644
--- a/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/internal/AlertTextContentNodeRenderer.java
+++ b/commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/internal/AlertTextContentNodeRenderer.java
@@ -1,5 +1,6 @@
package org.commonmark.ext.gfm.alerts.internal;
+import java.util.Map;
import org.commonmark.ext.gfm.alerts.Alert;
import org.commonmark.ext.gfm.alerts.AlertTitle;
import org.commonmark.node.Node;
@@ -7,15 +8,14 @@
import org.commonmark.renderer.text.TextContentNodeRendererContext;
import org.commonmark.renderer.text.TextContentWriter;
-import java.util.Map;
-
public class AlertTextContentNodeRenderer extends AlertNodeRenderer {
private final TextContentNodeRendererContext context;
private final TextContentWriter textContent;
private final Map allowedTypes;
- public AlertTextContentNodeRenderer(TextContentNodeRendererContext context, Map allowedTypes) {
+ public AlertTextContentNodeRenderer(
+ TextContentNodeRendererContext context, Map allowedTypes) {
this.context = context;
this.textContent = context.getWriter();
this.allowedTypes = allowedTypes;
diff --git a/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/AlertsMarkdownRendererTest.java b/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/AlertsMarkdownRendererTest.java
index e31059ed2..f8e73cc06 100644
--- a/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/AlertsMarkdownRendererTest.java
+++ b/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/AlertsMarkdownRendererTest.java
@@ -1,27 +1,26 @@
package org.commonmark.ext.gfm.alerts;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.parser.Parser;
import org.commonmark.renderer.markdown.MarkdownRenderer;
import org.junit.jupiter.api.Test;
-import java.util.Set;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
public class AlertsMarkdownRendererTest {
private static final Set EXTENSIONS = Set.of(AlertsExtension.create());
private static final Parser PARSER = Parser.builder().extensions(EXTENSIONS).build();
- private static final MarkdownRenderer RENDERER = MarkdownRenderer.builder().extensions(EXTENSIONS).build();
+ private static final MarkdownRenderer RENDERER =
+ MarkdownRenderer.builder().extensions(EXTENSIONS).build();
- private static final Set EXTENSIONS_CUSTOM_TITLES = Set.of(AlertsExtension.builder().allowCustomTitles(true).build());
- private static final Parser PARSER_CUSTOM_TITLES = Parser.builder()
- .extensions(EXTENSIONS_CUSTOM_TITLES)
- .build();
- private static final MarkdownRenderer RENDERER_CUSTOM_TITLES = MarkdownRenderer.builder()
- .extensions(EXTENSIONS_CUSTOM_TITLES)
- .build();
+ private static final Set EXTENSIONS_CUSTOM_TITLES =
+ Set.of(AlertsExtension.builder().allowCustomTitles(true).build());
+ private static final Parser PARSER_CUSTOM_TITLES =
+ Parser.builder().extensions(EXTENSIONS_CUSTOM_TITLES).build();
+ private static final MarkdownRenderer RENDERER_CUSTOM_TITLES =
+ MarkdownRenderer.builder().extensions(EXTENSIONS_CUSTOM_TITLES).build();
@Test
public void alertRoundTrip() {
@@ -61,9 +60,7 @@ public void alertWithMultipleParagraphs() {
@Test
public void customTypeRoundTrip() {
- var extension = AlertsExtension.builder()
- .addCustomType("INFO", "Information")
- .build();
+ var extension = AlertsExtension.builder().addCustomType("INFO", "Information").build();
var parser = Parser.builder().extensions(Set.of(extension)).build();
var renderer = MarkdownRenderer.builder().extensions(Set.of(extension)).build();
@@ -99,14 +96,17 @@ public void customTitleRoundTrip() {
@Test
public void customTitleWithFormattingRoundTrip() {
- assertRoundTripCustomTitles("> [!WARNING] Custom _title **with `formatting`**_\n> Be careful\n");
+ assertRoundTripCustomTitles(
+ "> [!WARNING] Custom _title **with `formatting`**_\n> Be careful\n");
}
@Test
public void customTitleWithMultipleBlocks() {
- var input = "> [!NOTE]Title\n> First paragraph\n>\n> Second paragraph\n>\n> - > Nested blocks\n";
+ var input =
+ "> [!NOTE]Title\n> First paragraph\n>\n> Second paragraph\n>\n> - > Nested blocks\n";
// MarkdownWriter always writes the prefix including trailing space
- var expected = "> [!NOTE] Title\n> First paragraph\n> \n> Second paragraph\n> \n> - > Nested blocks\n";
+ var expected =
+ "> [!NOTE] Title\n> First paragraph\n> \n> Second paragraph\n> \n> - > Nested blocks\n";
var rendered = RENDERER_CUSTOM_TITLES.render(PARSER_CUSTOM_TITLES.parse(input));
assertThat(rendered).isEqualTo(expected);
}
diff --git a/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/AlertsSpecTest.java b/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/AlertsSpecTest.java
index d85aa1d2a..2836db3ac 100644
--- a/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/AlertsSpecTest.java
+++ b/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/AlertsSpecTest.java
@@ -1,5 +1,8 @@
package org.commonmark.ext.gfm.alerts;
+import java.net.URL;
+import java.util.List;
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.parser.Parser;
import org.commonmark.renderer.html.HtmlRenderer;
@@ -11,16 +14,12 @@
import org.junit.jupiter.params.ParameterizedClass;
import org.junit.jupiter.params.provider.MethodSource;
-import java.net.URL;
-import java.util.List;
-import java.util.Set;
-
/**
- * Tests the default configuration of {@link AlertsExtension} against how
- * GitHub Flavored Markdown (GFM) parses and renders {@link Alert}s.
- *
- * This test should only be used for the default configuration of
- * {@link AlertsExtension}. Other configurations cause deviation from GFM.
+ * Tests the default configuration of {@link AlertsExtension} against how GitHub Flavored Markdown
+ * (GFM) parses and renders {@link Alert}s.
+ *
+ *
This test should only be used for the default configuration of {@link AlertsExtension}. Other
+ * configurations cause deviation from GFM.
*/
@ParameterizedClass
@MethodSource("data")
@@ -28,11 +27,12 @@ public class AlertsSpecTest extends RenderingTestCase {
private static final Set EXTENSIONS = Set.of(AlertsExtension.create());
private static final Parser PARSER = Parser.builder().extensions(EXTENSIONS).build();
- // Use softbreak(" ") to match GitHub's rendering for easier comparison with GitHub API output.
- private static final HtmlRenderer RENDERER = HtmlRenderer.builder().extensions(EXTENSIONS).softbreak(" \n").build();
+ // Use softbreak(" ") to match GitHub's rendering for easier comparison with GitHub API
+ // output.
+ private static final HtmlRenderer RENDERER =
+ HtmlRenderer.builder().extensions(EXTENSIONS).softbreak(" \n").build();
- @Parameter
- Example example;
+ @Parameter Example example;
static List data() {
URL spec = AlertsSpecTest.class.getResource("/alerts-spec.txt");
diff --git a/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/AlertsTest.java b/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/AlertsTest.java
index d98e0e2cf..99c0e8d7a 100644
--- a/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/AlertsTest.java
+++ b/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/AlertsTest.java
@@ -1,5 +1,11 @@
package org.commonmark.ext.gfm.alerts;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.node.Emphasis;
import org.commonmark.node.SourceSpan;
@@ -11,27 +17,26 @@
import org.commonmark.testutil.RenderingTestCase;
import org.junit.jupiter.api.Test;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-
-import static org.assertj.core.api.Assertions.assertThat;
-import static org.junit.jupiter.api.Assertions.assertThrows;
-
public class AlertsTest extends RenderingTestCase {
private static final Set EXTENSIONS = Set.of(AlertsExtension.create());
- private static final Parser PARSER = Parser.builder().extensions(EXTENSIONS).includeSourceSpans(IncludeSourceSpans.BLOCKS_AND_INLINES).build();
- private static final HtmlRenderer HTML_RENDERER = HtmlRenderer.builder().extensions(EXTENSIONS).build();
-
- private static final Set EXTENSIONS_CUSTOM_TITLES = Set.of(AlertsExtension.builder().allowCustomTitles(true).build());
- private static final Parser PARSER_CUSTOM_TITLES = Parser.builder()
- .extensions(EXTENSIONS_CUSTOM_TITLES)
- .includeSourceSpans(IncludeSourceSpans.BLOCKS_AND_INLINES)
- .build();
- private static final HtmlRenderer HTML_RENDERER_CUSTOM_TITLES = HtmlRenderer.builder()
- .extensions(EXTENSIONS_CUSTOM_TITLES)
- .build();
+ private static final Parser PARSER =
+ Parser.builder()
+ .extensions(EXTENSIONS)
+ .includeSourceSpans(IncludeSourceSpans.BLOCKS_AND_INLINES)
+ .build();
+ private static final HtmlRenderer HTML_RENDERER =
+ HtmlRenderer.builder().extensions(EXTENSIONS).build();
+
+ private static final Set EXTENSIONS_CUSTOM_TITLES =
+ Set.of(AlertsExtension.builder().allowCustomTitles(true).build());
+ private static final Parser PARSER_CUSTOM_TITLES =
+ Parser.builder()
+ .extensions(EXTENSIONS_CUSTOM_TITLES)
+ .includeSourceSpans(IncludeSourceSpans.BLOCKS_AND_INLINES)
+ .build();
+ private static final HtmlRenderer HTML_RENDERER_CUSTOM_TITLES =
+ HtmlRenderer.builder().extensions(EXTENSIONS_CUSTOM_TITLES).build();
@Override
protected String render(String source) {
@@ -39,103 +44,109 @@ protected String render(String source) {
}
private void assertRenderingCustomTitles(String source, String expectedResult) {
- assertThat(HTML_RENDERER_CUSTOM_TITLES.render(PARSER_CUSTOM_TITLES.parse(source))).isEqualTo(expectedResult);
+ assertThat(HTML_RENDERER_CUSTOM_TITLES.render(PARSER_CUSTOM_TITLES.parse(source)))
+ .isEqualTo(expectedResult);
}
// Custom types
@Test
public void customType() {
- var extension = AlertsExtension.builder()
- .addCustomType("INFO", "Information")
- .build();
+ var extension = AlertsExtension.builder().addCustomType("INFO", "Information").build();
var parser = Parser.builder().extensions(Set.of(extension)).build();
var renderer = HtmlRenderer.builder().extensions(Set.of(extension)).build();
- assertThat(renderer.render(parser.parse("> [!INFO]\n> Custom alert"))).isEqualTo(
- "
\n");
+ assertRenderingCustomTitles(
+ "> [!NOTE] Custom title\n> Note with a custom title",
+ "
\n"
+ + "
Custom title
\n"
+ + "
Note with a custom title
\n"
+ + "
\n");
}
@Test
public void customTitleNoSpace() {
- assertRenderingCustomTitles("> [!NOTE]Custom title\n> Note with a custom title",
- "
\n" +
- "
Custom title
\n" +
- "
Note with a custom title
\n" +
- "
\n");
+ assertRenderingCustomTitles(
+ "> [!NOTE]Custom title\n> Note with a custom title",
+ "
\n"
+ + "
Custom title
\n"
+ + "
Note with a custom title
\n"
+ + "
\n");
}
@Test
public void customTitleExtraSpace() {
- assertRenderingCustomTitles("> [!NOTE] Custom title \n> Note with a custom title",
- "
\n" +
- "
Custom title
\n" +
- "
Note with a custom title
\n" +
- "
\n");
+ assertRenderingCustomTitles(
+ "> [!NOTE] Custom title \n> Note with a custom title",
+ "
\n"
+ + "
Custom title
\n"
+ + "
Note with a custom title
\n"
+ + "
\n");
}
@Test
public void customTitleNoHardLineBreak() {
- assertRenderingCustomTitles("> [!NOTE] Custom title\\\n> Note with a custom title",
- "
\n" +
- "
Custom title\\
\n" +
- "
Note with a custom title
\n" +
- "
\n");
+ assertRenderingCustomTitles(
+ "> [!NOTE] Custom title\\\n> Note with a custom title",
+ "
\n"
+ + "
Custom title\\
\n"
+ + "
Note with a custom title
\n"
+ + "
\n");
}
@Test
public void customTitleWithComment() {
- assertRenderingCustomTitles("> [!NOTE] Custom title \n> Note with a custom title",
- "
\n" +
- "
Custom title
\n" +
- "
Note with a custom title
\n" +
- "
\n");
+ assertRenderingCustomTitles(
+ "> [!NOTE] Custom title \n> Note with a custom title",
+ "
\n"
+ + "
Custom title
\n"
+ + "
Note with a custom title
\n"
+ + "
\n");
}
@Test
public void customTitleWithInlineFormatting() {
- assertRenderingCustomTitles("> [!NOTE] Custom _title with **formatting**_\n> Note with a custom title",
- "
\n" +
- "
Custom title with formatting
\n" +
- "
Note with a custom title
\n" +
- "
\n");
+ assertRenderingCustomTitles(
+ "> [!NOTE] Custom _title with **formatting**_\n> Note with a custom title",
+ "
\n"
+ + "
Custom title with formatting
\n"
+ + "
Note with a custom title
\n"
+ + "
\n");
}
@Test
public void customTitleWithLinkAndCode() {
- assertRenderingCustomTitles("> [!IMPORTANT] See [docs](https://example.com) or `run()`\n> Note with a custom title",
- "
\n");
}
@Test
public void customTitleIgnoresBlockContent() {
- assertRenderingCustomTitles("> [!NOTE] ## Custom title looks like an ATX heading\n>But it's not",
- "
\n" +
- "
## Custom title looks like an ATX heading
\n" +
- "
But it's not
\n" +
- "
\n");
+ assertRenderingCustomTitles(
+ "> [!NOTE] ## Custom title looks like an ATX heading\n>But it's not",
+ "
\n"
+ + "
## Custom title looks like an ATX heading
\n"
+ + "
But it's not
\n"
+ + "
\n");
}
@Test
public void customTitleNoBody() {
// Alerts with no body are allowed.
- assertRenderingCustomTitles("> [!NOTE] Custom _title_\n> \n>\n>",
- "
\n");
}
// Alert markers take precedence over link reference definitions
@Test
public void alertTakesPrecedence() {
- assertRenderingCustomTitles("> [!NOTE]: https://example.com\n> Body text\n\n[!NOTE]",
- "
\n");
assertThat(renderer.render(parser.parse(source))).isEqualTo(expected);
}
@@ -465,9 +508,7 @@ public void alertParsedAsAlertNode() {
@Test
public void customTypeParsedAsAlertNode() {
- var extension = AlertsExtension.builder()
- .addCustomType("INFO", "Information")
- .build();
+ var extension = AlertsExtension.builder().addCustomType("INFO", "Information").build();
var parser = Parser.builder().extensions(Set.of(extension)).build();
@@ -578,5 +619,4 @@ public void titleWithNestedInlineFormattingSourcePosition() {
assertThat(((Text) italicText).getLiteral()).isEqualTo("and italic");
assertThat(italicText.getSourceSpans()).isEqualTo(List.of(SourceSpan.of(0, 28, 28, 10)));
}
-
}
diff --git a/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/AlertsTextContentRendererTest.java b/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/AlertsTextContentRendererTest.java
index 9bc69677c..3979b0488 100644
--- a/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/AlertsTextContentRendererTest.java
+++ b/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/AlertsTextContentRendererTest.java
@@ -1,5 +1,6 @@
package org.commonmark.ext.gfm.alerts;
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.parser.Parser;
import org.commonmark.renderer.text.LineBreakRendering;
@@ -7,33 +8,45 @@
import org.commonmark.testutil.Asserts;
import org.junit.jupiter.api.Test;
-import java.util.Set;
-
public class AlertsTextContentRendererTest {
private static final Set EXTENSIONS = Set.of(AlertsExtension.create());
private static final Parser PARSER = Parser.builder().extensions(EXTENSIONS).build();
- private static final TextContentRenderer COMPACT_RENDERER = TextContentRenderer.builder()
- .extensions(EXTENSIONS).build();
- private static final TextContentRenderer SEPARATE_RENDERER = TextContentRenderer.builder()
- .extensions(EXTENSIONS).lineBreakRendering(LineBreakRendering.SEPARATE_BLOCKS).build();
- private static final TextContentRenderer STRIPPED_RENDERER = TextContentRenderer.builder()
- .extensions(EXTENSIONS).lineBreakRendering(LineBreakRendering.STRIP).build();
-
- private static final Set EXTENSIONS_CUSTOM_TITLES = Set.of(
- AlertsExtension.builder().allowCustomTitles(true).allowNestedAlerts(true).build());
- private static final Parser PARSER_CUSTOM_TITLES = Parser.builder()
- .extensions(EXTENSIONS_CUSTOM_TITLES).build();
-
- private static final TextContentRenderer COMPACT_RENDERER_CUSTOM = TextContentRenderer.builder()
- .extensions(EXTENSIONS_CUSTOM_TITLES).build();
- private static final TextContentRenderer SEPARATE_RENDERER_CUSTOM = TextContentRenderer.builder()
- .extensions(EXTENSIONS_CUSTOM_TITLES)
- .lineBreakRendering(LineBreakRendering.SEPARATE_BLOCKS).build();
- private static final TextContentRenderer STRIPPED_RENDERER_CUSTOM = TextContentRenderer.builder()
- .extensions(EXTENSIONS_CUSTOM_TITLES)
- .lineBreakRendering(LineBreakRendering.STRIP).build();
+ private static final TextContentRenderer COMPACT_RENDERER =
+ TextContentRenderer.builder().extensions(EXTENSIONS).build();
+ private static final TextContentRenderer SEPARATE_RENDERER =
+ TextContentRenderer.builder()
+ .extensions(EXTENSIONS)
+ .lineBreakRendering(LineBreakRendering.SEPARATE_BLOCKS)
+ .build();
+ private static final TextContentRenderer STRIPPED_RENDERER =
+ TextContentRenderer.builder()
+ .extensions(EXTENSIONS)
+ .lineBreakRendering(LineBreakRendering.STRIP)
+ .build();
+
+ private static final Set EXTENSIONS_CUSTOM_TITLES =
+ Set.of(
+ AlertsExtension.builder()
+ .allowCustomTitles(true)
+ .allowNestedAlerts(true)
+ .build());
+ private static final Parser PARSER_CUSTOM_TITLES =
+ Parser.builder().extensions(EXTENSIONS_CUSTOM_TITLES).build();
+
+ private static final TextContentRenderer COMPACT_RENDERER_CUSTOM =
+ TextContentRenderer.builder().extensions(EXTENSIONS_CUSTOM_TITLES).build();
+ private static final TextContentRenderer SEPARATE_RENDERER_CUSTOM =
+ TextContentRenderer.builder()
+ .extensions(EXTENSIONS_CUSTOM_TITLES)
+ .lineBreakRendering(LineBreakRendering.SEPARATE_BLOCKS)
+ .build();
+ private static final TextContentRenderer STRIPPED_RENDERER_CUSTOM =
+ TextContentRenderer.builder()
+ .extensions(EXTENSIONS_CUSTOM_TITLES)
+ .lineBreakRendering(LineBreakRendering.STRIP)
+ .build();
@Test
public void alertNoBody() {
@@ -123,7 +136,8 @@ public void alertWithinBlockQuote() {
public void alertWithinAlert() {
var source = "> [!NOTE] Custom title\n> Body text\n> > [!WARNING]\n> > Nested body text";
assertCompactCustomTitles(source, "Custom title\nBody text\nWarning\nNested body text");
- assertSeparateCustomTitles(source, "Custom title\n\nBody text\n\nWarning\n\nNested body text");
+ assertSeparateCustomTitles(
+ source, "Custom title\n\nBody text\n\nWarning\n\nNested body text");
assertStrippedCustomTitles(source, "Custom title: Body text Warning: Nested body text");
}
diff --git a/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/examples/AlertsExample.java b/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/examples/AlertsExample.java
index 34b78385c..26b348016 100644
--- a/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/examples/AlertsExample.java
+++ b/commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/examples/AlertsExample.java
@@ -1,14 +1,11 @@
package org.commonmark.ext.gfm.alerts.examples;
+import java.util.List;
import org.commonmark.ext.gfm.alerts.AlertsExtension;
import org.commonmark.parser.Parser;
import org.commonmark.renderer.html.HtmlRenderer;
-import java.util.List;
-
-/**
- * Example demonstrating the use of the GFM Alerts extension.
- */
+/** Example demonstrating the use of the GFM Alerts extension. */
public class AlertsExample {
public static void main(String[] args) {
@@ -23,25 +20,22 @@ private static void standardTypesExample() {
var extension = AlertsExtension.create();
- var parser = Parser.builder()
- .extensions(List.of(extension))
- .build();
-
- var renderer = HtmlRenderer.builder()
- .extensions(List.of(extension))
- .build();
-
- var markdown = "# GFM Alerts Demo\n\n" +
- "> [!NOTE]\n" +
- "> Highlights information that users should take into account.\n\n" +
- "> [!TIP]\n" +
- "> Helpful advice for doing things better.\n\n" +
- "> [!IMPORTANT]\n" +
- "> Key information users need to know.\n\n" +
- "> [!WARNING]\n" +
- "> Urgent info that needs immediate attention.\n\n" +
- "> [!CAUTION]\n" +
- "> Advises about risks or negative outcomes.\n";
+ var parser = Parser.builder().extensions(List.of(extension)).build();
+
+ var renderer = HtmlRenderer.builder().extensions(List.of(extension)).build();
+
+ var markdown =
+ "# GFM Alerts Demo\n\n"
+ + "> [!NOTE]\n"
+ + "> Highlights information that users should take into account.\n\n"
+ + "> [!TIP]\n"
+ + "> Helpful advice for doing things better.\n\n"
+ + "> [!IMPORTANT]\n"
+ + "> Key information users need to know.\n\n"
+ + "> [!WARNING]\n"
+ + "> Urgent info that needs immediate attention.\n\n"
+ + "> [!CAUTION]\n"
+ + "> Advises about risks or negative outcomes.\n";
var html = renderer.render(parser.parse(markdown));
@@ -55,25 +49,20 @@ private static void customTypesExample() {
System.out.println("CUSTOM ALERT TYPES");
System.out.println("=".repeat(60));
- var extension = AlertsExtension.builder()
- .addCustomType("BUG", "Known Bug")
- .build();
-
- var parser = Parser.builder()
- .extensions(List.of(extension))
- .build();
-
- var renderer = HtmlRenderer.builder()
- .extensions(List.of(extension))
- .build();
-
- var markdown = "# Custom Alert Types\n\n" +
- "> [!NOTE]\n" +
- "> Useful information that users should know.\n\n" +
- "> [!TIP]\n" +
- "> Helpful advice for doing things better.\n\n" +
- "> [!BUG]\n" +
- "> This feature has a known issue with large files (see #42).\n";
+ var extension = AlertsExtension.builder().addCustomType("BUG", "Known Bug").build();
+
+ var parser = Parser.builder().extensions(List.of(extension)).build();
+
+ var renderer = HtmlRenderer.builder().extensions(List.of(extension)).build();
+
+ var markdown =
+ "# Custom Alert Types\n\n"
+ + "> [!NOTE]\n"
+ + "> Useful information that users should know.\n\n"
+ + "> [!TIP]\n"
+ + "> Helpful advice for doing things better.\n\n"
+ + "> [!BUG]\n"
+ + "> This feature has a known issue with large files (see #42).\n";
var html = renderer.render(parser.parse(markdown));
diff --git a/commonmark-ext-gfm-strikethrough/src/main/java/org/commonmark/ext/gfm/strikethrough/Strikethrough.java b/commonmark-ext-gfm-strikethrough/src/main/java/org/commonmark/ext/gfm/strikethrough/Strikethrough.java
index 0c24642bc..76ce213e8 100644
--- a/commonmark-ext-gfm-strikethrough/src/main/java/org/commonmark/ext/gfm/strikethrough/Strikethrough.java
+++ b/commonmark-ext-gfm-strikethrough/src/main/java/org/commonmark/ext/gfm/strikethrough/Strikethrough.java
@@ -3,9 +3,7 @@
import org.commonmark.node.CustomNode;
import org.commonmark.node.Delimited;
-/**
- * A strikethrough node containing text and other inline nodes as children.
- */
+/** A strikethrough node containing text and other inline nodes as children. */
public class Strikethrough extends CustomNode implements Delimited {
private String delimiter;
diff --git a/commonmark-ext-gfm-strikethrough/src/main/java/org/commonmark/ext/gfm/strikethrough/StrikethroughExtension.java b/commonmark-ext-gfm-strikethrough/src/main/java/org/commonmark/ext/gfm/strikethrough/StrikethroughExtension.java
index 0571aed84..4b18b7d66 100644
--- a/commonmark-ext-gfm-strikethrough/src/main/java/org/commonmark/ext/gfm/strikethrough/StrikethroughExtension.java
+++ b/commonmark-ext-gfm-strikethrough/src/main/java/org/commonmark/ext/gfm/strikethrough/StrikethroughExtension.java
@@ -1,5 +1,6 @@
package org.commonmark.ext.gfm.strikethrough;
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.ext.gfm.strikethrough.internal.StrikethroughDelimiterProcessor;
import org.commonmark.ext.gfm.strikethrough.internal.StrikethroughHtmlNodeRenderer;
@@ -13,38 +14,40 @@
import org.commonmark.renderer.markdown.MarkdownRenderer;
import org.commonmark.renderer.text.TextContentRenderer;
-import java.util.Set;
-
/**
* Extension for GFM strikethrough using {@code ~} or {@code ~~} (GitHub Flavored Markdown).
- *
Example input:
+ *
+ *
Example input:
+ *
*
{@code ~foo~ or ~~bar~~}
- *
Example output (HTML):
+ *
+ *
Example output (HTML):
+ *
*
{@code foo or bar}
- *
- * Create the extension with {@link #create()} and then add it to the parser and renderer builders
- * ({@link org.commonmark.parser.Parser.Builder#extensions(Iterable)},
- * {@link HtmlRenderer.Builder#extensions(Iterable)}).
- *
- *
- * The parsed strikethrough text regions are turned into {@link Strikethrough} nodes.
- *
- *
- * If you have another extension that only uses a single tilde ({@code ~}) syntax, you will have to configure this
- * {@link StrikethroughExtension} to only accept the double tilde syntax, like this:
- *
- * If you don't do that, there's a conflict between the two extensions and you will get an
- * {@link IllegalArgumentException} when constructing the parser.
- *
+ *
+ *
Create the extension with {@link #create()} and then add it to the parser and renderer
+ * builders ({@link org.commonmark.parser.Parser.Builder#extensions(Iterable)}, {@link
+ * HtmlRenderer.Builder#extensions(Iterable)}).
+ *
+ *
The parsed strikethrough text regions are turned into {@link Strikethrough} nodes.
+ *
+ *
If you have another extension that only uses a single tilde ({@code ~}) syntax, you will have
+ * to configure this {@link StrikethroughExtension} to only accept the double tilde syntax, like
+ * this:
+ *
+ *
\n");
}
@@ -96,12 +98,15 @@ public void textContentRenderer() {
@Test
public void requireTwoTildesOption() {
- Parser parser = Parser.builder()
- .extensions(Set.of(StrikethroughExtension.builder()
- .requireTwoTildes(true)
- .build()))
- .customDelimiterProcessor(new SubscriptDelimiterProcessor())
- .build();
+ Parser parser =
+ Parser.builder()
+ .extensions(
+ Set.of(
+ StrikethroughExtension.builder()
+ .requireTwoTildes(true)
+ .build()))
+ .customDelimiterProcessor(new SubscriptDelimiterProcessor())
+ .build();
Node document = parser.parse("~foo~ ~~bar~~");
assertThat(CONTENT_RENDERER.render(document)).isEqualTo("(sub)foo(/sub) /bar/");
@@ -109,10 +114,11 @@ public void requireTwoTildesOption() {
@Test
public void sourceSpans() {
- Parser parser = Parser.builder()
- .extensions(EXTENSIONS)
- .includeSourceSpans(IncludeSourceSpans.BLOCKS_AND_INLINES)
- .build();
+ Parser parser =
+ Parser.builder()
+ .extensions(EXTENSIONS)
+ .includeSourceSpans(IncludeSourceSpans.BLOCKS_AND_INLINES)
+ .build();
Node document = parser.parse("hey ~~there~~\n");
Paragraph block = (Paragraph) document.getFirstChild();
diff --git a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableBlock.java b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableBlock.java
index c46fc27ef..3ad550907 100644
--- a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableBlock.java
+++ b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableBlock.java
@@ -2,8 +2,5 @@
import org.commonmark.node.CustomBlock;
-/**
- * Table block containing a {@link TableHead} and optionally a {@link TableBody}.
- */
-public class TableBlock extends CustomBlock {
-}
+/** Table block containing a {@link TableHead} and optionally a {@link TableBody}. */
+public class TableBlock extends CustomBlock {}
diff --git a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableBody.java b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableBody.java
index ddc80deb3..09f5b45b1 100644
--- a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableBody.java
+++ b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableBody.java
@@ -2,8 +2,5 @@
import org.commonmark.node.CustomNode;
-/**
- * Body part of a {@link TableBlock} containing {@link TableRow TableRows}.
- */
-public class TableBody extends CustomNode {
-}
+/** Body part of a {@link TableBlock} containing {@link TableRow TableRows}. */
+public class TableBody extends CustomNode {}
diff --git a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableCell.java b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableCell.java
index 033c2dd04..d4ad1f171 100644
--- a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableCell.java
+++ b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableCell.java
@@ -2,9 +2,7 @@
import org.commonmark.node.CustomNode;
-/**
- * Table cell of a {@link TableRow} containing inline nodes.
- */
+/** Table cell of a {@link TableRow} containing inline nodes. */
public class TableCell extends CustomNode {
private boolean header;
@@ -34,7 +32,8 @@ public void setAlignment(Alignment alignment) {
}
/**
- * @return the cell width (the number of dash and colon characters in the delimiter row of the table for this column)
+ * @return the cell width (the number of dash and colon characters in the delimiter row of the
+ * table for this column)
*/
public int getWidth() {
return width;
@@ -44,11 +43,10 @@ public void setWidth(int width) {
this.width = width;
}
- /**
- * How the cell is aligned horizontally.
- */
+ /** How the cell is aligned horizontally. */
public enum Alignment {
- LEFT, CENTER, RIGHT
+ LEFT,
+ CENTER,
+ RIGHT
}
-
}
diff --git a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableHead.java b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableHead.java
index 96a95e620..fa771f8f7 100644
--- a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableHead.java
+++ b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableHead.java
@@ -2,8 +2,5 @@
import org.commonmark.node.CustomNode;
-/**
- * Head part of a {@link TableBlock} containing {@link TableRow TableRows}.
- */
-public class TableHead extends CustomNode {
-}
+/** Head part of a {@link TableBlock} containing {@link TableRow TableRows}. */
+public class TableHead extends CustomNode {}
diff --git a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableRow.java b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableRow.java
index 1325875d0..19b31b9bc 100644
--- a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableRow.java
+++ b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TableRow.java
@@ -5,5 +5,4 @@
/**
* Table row of a {@link TableHead} or {@link TableBody} containing {@link TableCell TableCells}.
*/
-public class TableRow extends CustomNode {
-}
+public class TableRow extends CustomNode {}
diff --git a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TablesExtension.java b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TablesExtension.java
index 4740e9aad..582c30aae 100644
--- a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TablesExtension.java
+++ b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/TablesExtension.java
@@ -1,5 +1,6 @@
package org.commonmark.ext.gfm.tables;
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.ext.gfm.tables.internal.TableBlockParser;
import org.commonmark.ext.gfm.tables.internal.TableHtmlNodeRenderer;
@@ -13,26 +14,25 @@
import org.commonmark.renderer.markdown.MarkdownRenderer;
import org.commonmark.renderer.text.TextContentRenderer;
-import java.util.Set;
-
/**
* Extension for GFM tables using "|" pipes (GitHub Flavored Markdown).
- *
- * Create it with {@link #create()} and then configure it on the builders
- * ({@link org.commonmark.parser.Parser.Builder#extensions(Iterable)},
- * {@link HtmlRenderer.Builder#extensions(Iterable)}).
- *
- *
- * The parsed tables are turned into {@link TableBlock} blocks.
- *
Create it with {@link #create()} and then configure it on the builders ({@link
+ * org.commonmark.parser.Parser.Builder#extensions(Iterable)}, {@link
+ * HtmlRenderer.Builder#extensions(Iterable)}).
+ *
+ *
The parsed tables are turned into {@link TableBlock} blocks.
+ *
+ * @see Tables (extension) in GitHub
+ * Flavored Markdown Spec
*/
-public class TablesExtension implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension,
- TextContentRenderer.TextContentRendererExtension, MarkdownRenderer.MarkdownRendererExtension {
+public class TablesExtension
+ implements Parser.ParserExtension,
+ HtmlRenderer.HtmlRendererExtension,
+ TextContentRenderer.TextContentRendererExtension,
+ MarkdownRenderer.MarkdownRendererExtension {
- private TablesExtension() {
- }
+ private TablesExtension() {}
public static Extension create() {
return new TablesExtension();
@@ -55,16 +55,17 @@ public void extend(TextContentRenderer.Builder rendererBuilder) {
@Override
public void extend(MarkdownRenderer.Builder rendererBuilder) {
- rendererBuilder.nodeRendererFactory(new MarkdownNodeRendererFactory() {
- @Override
- public NodeRenderer create(MarkdownNodeRendererContext context) {
- return new TableMarkdownNodeRenderer(context);
- }
+ rendererBuilder.nodeRendererFactory(
+ new MarkdownNodeRendererFactory() {
+ @Override
+ public NodeRenderer create(MarkdownNodeRendererContext context) {
+ return new TableMarkdownNodeRenderer(context);
+ }
- @Override
- public Set getSpecialCharacters() {
- return Set.of('|');
- }
- });
+ @Override
+ public Set getSpecialCharacters() {
+ return Set.of('|');
+ }
+ });
}
}
diff --git a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableBlockParser.java b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableBlockParser.java
index 49f17194d..5e74e78eb 100644
--- a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableBlockParser.java
+++ b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableBlockParser.java
@@ -1,5 +1,7 @@
package org.commonmark.ext.gfm.tables.internal;
+import java.util.ArrayList;
+import java.util.List;
import org.commonmark.ext.gfm.tables.*;
import org.commonmark.node.Block;
import org.commonmark.node.Node;
@@ -10,9 +12,6 @@
import org.commonmark.parser.block.*;
import org.commonmark.text.Characters;
-import java.util.ArrayList;
-import java.util.List;
-
public class TableBlockParser extends AbstractBlockParser {
private final TableBlock block = new TableBlock();
@@ -42,8 +41,10 @@ public BlockContinue tryContinue(ParserState state) {
int pipe = Characters.find('|', content, state.getNextNonSpaceIndex());
if (pipe != -1) {
if (pipe == state.getNextNonSpaceIndex()) {
- // If we *only* have a pipe character (and whitespace), that is not a valid table row and ends the table.
- if (Characters.skipSpaceTab(content, pipe + 1, content.length()) == content.length()) {
+ // If we *only* have a pipe character (and whitespace), that is not a valid table
+ // row and ends the table.
+ if (Characters.skipSpaceTab(content, pipe + 1, content.length())
+ == content.length()) {
// We also don't want the pipe to be added via lazy continuation.
canHaveLazyContinuationLines = false;
return BlockContinue.none();
@@ -88,7 +89,8 @@ public void parseInlines(InlineParser inlineParser) {
// Body starts at index 2. 0 is header, 1 is separator.
for (int rowIndex = 2; rowIndex < rowLines.size(); rowIndex++) {
SourceLine rowLine = rowLines.get(rowIndex);
- SourceSpan sourceSpan = rowIndex < sourceSpans.size() ? sourceSpans.get(rowIndex) : null;
+ SourceSpan sourceSpan =
+ rowIndex < sourceSpans.size() ? sourceSpans.get(rowIndex) : null;
List cells = split(rowLine);
TableRow row = new TableRow();
if (sourceSpan != null) {
@@ -103,7 +105,8 @@ public void parseInlines(InlineParser inlineParser) {
}
if (body == null) {
- // It's valid to have a table without body. In that case, don't add an empty TableBody node.
+ // It's valid to have a table without body. In that case, don't add an empty
+ // TableBody node.
body = new TableBody();
block.appendChild(body);
}
@@ -152,9 +155,10 @@ private static List split(SourceLine line) {
switch (c) {
case '\\':
if (i + 1 < cellEnd && row.charAt(i + 1) == '|') {
- // Pipe is special for table parsing. An escaped pipe doesn't result in a new cell, but is
- // passed down to inline parsing as an unescaped pipe. Note that that applies even for the `\|`
- // in an input like `\\|` - in other words, table parsing doesn't support escaping backslashes.
+ // Pipe is special for table parsing. An escaped pipe doesn't result in a
+ // new cell, but is passed down to inline parsing as an unescaped pipe. Note
+ // that that applies even for the `\|` in an input like `\\|` - in other
+ // words, table parsing doesn't support escaping backslashes.
sb.append('|');
i++;
} else {
@@ -176,7 +180,10 @@ private static List split(SourceLine line) {
}
if (sb.length() > 0) {
String content = sb.toString();
- cells.add(SourceLine.of(content, line.substring(cellStart, line.getContent().length()).getSourceSpan()));
+ cells.add(
+ SourceLine.of(
+ content,
+ line.substring(cellStart, line.getContent().length()).getSourceSpan()));
}
return cells;
}
@@ -211,7 +218,8 @@ private static List parseSeparator(CharSequence s) {
case '-':
case ':':
if (pipes == 0 && !columns.isEmpty()) {
- // Need a pipe after the first column (first column doesn't need to start with one)
+ // Need a pipe after the first column (first column doesn't need to start
+ // with one)
return null;
}
boolean left = false;
@@ -274,9 +282,14 @@ public static class Factory extends AbstractBlockParserFactory {
@Override
public BlockStart tryStart(ParserState state, MatchedBlockParser matchedBlockParser) {
List paragraphLines = matchedBlockParser.getParagraphLines().getLines();
- if (!paragraphLines.isEmpty() && Characters.find('|', paragraphLines.get(paragraphLines.size() - 1).getContent(), 0) != -1) {
+ if (paragraphLines.isEmpty()) {
+ return BlockStart.none();
+ }
+ var previousLine = paragraphLines.get(paragraphLines.size() - 1).getContent();
+ if (Characters.find('|', previousLine, 0) != -1) {
SourceLine line = state.getLine();
- SourceLine separatorLine = line.substring(state.getIndex(), line.getContent().length());
+ SourceLine separatorLine =
+ line.substring(state.getIndex(), line.getContent().length());
List columns = parseSeparator(separatorLine.getContent());
if (columns != null && !columns.isEmpty()) {
SourceLine paragraph = paragraphLines.get(paragraphLines.size() - 1);
diff --git a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableHtmlNodeRenderer.java b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableHtmlNodeRenderer.java
index 966c4c151..81e584c9d 100644
--- a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableHtmlNodeRenderer.java
+++ b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableHtmlNodeRenderer.java
@@ -1,12 +1,11 @@
package org.commonmark.ext.gfm.tables.internal;
+import java.util.Map;
import org.commonmark.ext.gfm.tables.*;
import org.commonmark.node.Node;
import org.commonmark.renderer.html.HtmlNodeRendererContext;
import org.commonmark.renderer.html.HtmlWriter;
-import java.util.Map;
-
public class TableHtmlNodeRenderer extends TableNodeRenderer {
private final HtmlWriter htmlWriter;
@@ -69,7 +68,8 @@ private Map getAttributes(Node node, String tagName) {
private Map getCellAttributes(TableCell tableCell, String tagName) {
if (tableCell.getAlignment() != null) {
- return context.extendAttributes(tableCell, tagName, Map.of("align", getAlignValue(tableCell.getAlignment())));
+ return context.extendAttributes(
+ tableCell, tagName, Map.of("align", getAlignValue(tableCell.getAlignment())));
} else {
return context.extendAttributes(tableCell, tagName, Map.of());
}
diff --git a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableMarkdownNodeRenderer.java b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableMarkdownNodeRenderer.java
index b0705f579..a9c4f9049 100644
--- a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableMarkdownNodeRenderer.java
+++ b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableMarkdownNodeRenderer.java
@@ -1,16 +1,16 @@
package org.commonmark.ext.gfm.tables.internal;
+import java.util.ArrayList;
+import java.util.List;
import org.commonmark.ext.gfm.tables.*;
import org.commonmark.node.Node;
import org.commonmark.renderer.markdown.MarkdownNodeRendererContext;
import org.commonmark.renderer.markdown.MarkdownWriter;
import org.commonmark.text.AsciiMatcher;
-import java.util.ArrayList;
-import java.util.List;
-
/**
- * The Table node renderer that is needed for rendering GFM tables (GitHub Flavored Markdown) to text content.
+ * The Table node renderer that is needed for rendering GFM tables (GitHub Flavored Markdown) to
+ * text content.
*/
public class TableMarkdownNodeRenderer extends TableNodeRenderer {
private final MarkdownWriter writer;
diff --git a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableNodeRenderer.java b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableNodeRenderer.java
index 2982e1518..4e3a00815 100644
--- a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableNodeRenderer.java
+++ b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableNodeRenderer.java
@@ -1,11 +1,10 @@
package org.commonmark.ext.gfm.tables.internal;
+import java.util.Set;
import org.commonmark.ext.gfm.tables.*;
import org.commonmark.node.Node;
import org.commonmark.renderer.NodeRenderer;
-import java.util.Set;
-
abstract class TableNodeRenderer implements NodeRenderer {
@Override
@@ -15,8 +14,7 @@ public Set> getNodeTypes() {
TableHead.class,
TableBody.class,
TableRow.class,
- TableCell.class
- );
+ TableCell.class);
}
@Override
diff --git a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableTextContentNodeRenderer.java b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableTextContentNodeRenderer.java
index 0ba6894b5..b9e17c1d3 100644
--- a/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableTextContentNodeRenderer.java
+++ b/commonmark-ext-gfm-tables/src/main/java/org/commonmark/ext/gfm/tables/internal/TableTextContentNodeRenderer.java
@@ -10,7 +10,8 @@
import org.commonmark.renderer.text.TextContentWriter;
/**
- * The Table node renderer that is needed for rendering GFM tables (GitHub Flavored Markdown) to text content.
+ * The Table node renderer that is needed for rendering GFM tables (GitHub Flavored Markdown) to
+ * text content.
*/
public class TableTextContentNodeRenderer extends TableNodeRenderer {
diff --git a/commonmark-ext-gfm-tables/src/test/java/org/commonmark/ext/gfm/tables/TableMarkdownRendererTest.java b/commonmark-ext-gfm-tables/src/test/java/org/commonmark/ext/gfm/tables/TableMarkdownRendererTest.java
index 85c11206c..32a8218b2 100644
--- a/commonmark-ext-gfm-tables/src/test/java/org/commonmark/ext/gfm/tables/TableMarkdownRendererTest.java
+++ b/commonmark-ext-gfm-tables/src/test/java/org/commonmark/ext/gfm/tables/TableMarkdownRendererTest.java
@@ -1,19 +1,19 @@
package org.commonmark.ext.gfm.tables;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.parser.Parser;
import org.commonmark.renderer.markdown.MarkdownRenderer;
import org.junit.jupiter.api.Test;
-import java.util.Set;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
public class TableMarkdownRendererTest {
private static final Set EXTENSIONS = Set.of(TablesExtension.create());
private static final Parser PARSER = Parser.builder().extensions(EXTENSIONS).build();
- private static final MarkdownRenderer RENDERER = MarkdownRenderer.builder().extensions(EXTENSIONS).build();
+ private static final MarkdownRenderer RENDERER =
+ MarkdownRenderer.builder().extensions(EXTENSIONS).build();
@Test
public void testHeadNoBody() {
@@ -60,7 +60,8 @@ public void testEscaping() {
@Test
public void testEscaped() {
- // `|` in Text nodes needs to be escaped, otherwise the generated Markdown does not get parsed back as a table
+ // `|` in Text nodes needs to be escaped, otherwise the generated Markdown does not get
+ // parsed back as a table
assertRoundTrip("\\|Abc\\|\n\\|---\\|\n");
}
diff --git a/commonmark-ext-gfm-tables/src/test/java/org/commonmark/ext/gfm/tables/TablesSpecTest.java b/commonmark-ext-gfm-tables/src/test/java/org/commonmark/ext/gfm/tables/TablesSpecTest.java
index e7f3db4d1..81def7c2e 100644
--- a/commonmark-ext-gfm-tables/src/test/java/org/commonmark/ext/gfm/tables/TablesSpecTest.java
+++ b/commonmark-ext-gfm-tables/src/test/java/org/commonmark/ext/gfm/tables/TablesSpecTest.java
@@ -1,5 +1,7 @@
package org.commonmark.ext.gfm.tables;
+import java.util.List;
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.parser.Parser;
import org.commonmark.renderer.html.HtmlRenderer;
@@ -12,19 +14,16 @@
import org.junit.jupiter.params.ParameterizedClass;
import org.junit.jupiter.params.provider.MethodSource;
-import java.util.List;
-import java.util.Set;
-
@ParameterizedClass
@MethodSource("data")
public class TablesSpecTest extends RenderingTestCase {
private static final Set EXTENSIONS = Set.of(TablesExtension.create());
private static final Parser PARSER = Parser.builder().extensions(EXTENSIONS).build();
- private static final HtmlRenderer RENDERER = HtmlRenderer.builder().extensions(EXTENSIONS).build();
+ private static final HtmlRenderer RENDERER =
+ HtmlRenderer.builder().extensions(EXTENSIONS).build();
- @Parameter
- Example example;
+ @Parameter Example example;
static List data() {
return ExampleReader.readExamples(TestResources.getGfmSpec(), "table");
diff --git a/commonmark-ext-gfm-tables/src/test/java/org/commonmark/ext/gfm/tables/TablesTest.java b/commonmark-ext-gfm-tables/src/test/java/org/commonmark/ext/gfm/tables/TablesTest.java
index 98c3ad4d7..f872c0cde 100644
--- a/commonmark-ext-gfm-tables/src/test/java/org/commonmark/ext/gfm/tables/TablesTest.java
+++ b/commonmark-ext-gfm-tables/src/test/java/org/commonmark/ext/gfm/tables/TablesTest.java
@@ -1,5 +1,9 @@
package org.commonmark.ext.gfm.tables;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.util.List;
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.node.*;
import org.commonmark.parser.IncludeSourceSpans;
@@ -9,16 +13,12 @@
import org.commonmark.testutil.RenderingTestCase;
import org.junit.jupiter.api.Test;
-import java.util.List;
-import java.util.Set;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
public class TablesTest extends RenderingTestCase {
private static final Set EXTENSIONS = Set.of(TablesExtension.create());
private static final Parser PARSER = Parser.builder().extensions(EXTENSIONS).build();
- private static final HtmlRenderer RENDERER = HtmlRenderer.builder().extensions(EXTENSIONS).build();
+ private static final HtmlRenderer RENDERER =
+ HtmlRenderer.builder().extensions(EXTENSIONS).build();
@Test
public void mustHaveHeaderAndSeparator() {
@@ -28,22 +28,26 @@ public void mustHaveHeaderAndSeparator() {
@Test
public void separatorMustBeOneOrMore() {
- assertRendering("Abc|Def\n-|-", "
\n" +
- "\n" +
- "
\n" +
- "
Abc
\n" +
- "
Def
\n" +
- "
\n" +
- "\n" +
- "
\n");
- assertRendering("Abc|Def\n--|--", "
\n" +
- "\n" +
- "
\n" +
- "
Abc
\n" +
- "
Def
\n" +
- "
\n" +
- "\n" +
- "
\n");
+ assertRendering(
+ "Abc|Def\n-|-",
+ "
\n"
+ + "\n"
+ + "
\n"
+ + "
Abc
\n"
+ + "
Def
\n"
+ + "
\n"
+ + "\n"
+ + "
\n");
+ assertRendering(
+ "Abc|Def\n--|--",
+ "
\n"
+ + "\n"
+ + "
\n"
+ + "
Abc
\n"
+ + "
Def
\n"
+ + "
\n"
+ + "\n"
+ + "
\n");
}
@Test
@@ -55,14 +59,16 @@ public void separatorMustNotContainInvalidChars() {
@Test
public void separatorCanHaveLeadingSpaceThenPipe() {
- assertRendering("Abc|Def\n |---|---", "
\n");
}
@Test
public void pipesOnOutsideZeroLengthHeaders() {
// This is literally what someone has done IRL - it helped to expose
// an issue with parsing the last header cell correctly
- assertRendering("||center header||\n" +
- "-|-------------|-\n" +
- "1| 2 |3",
- "
\n");
}
@Test
public void escapedBackslash() {
- // This is a bit weird in the GFM spec IMO. `1\\|2` looks like an escaped backslash, followed by a pipe
- // (so two cells). Instead, the `\|` is parsed as an escaped pipe first, so just a single cell. The inline
- // parser then gets `1\|2` which renders as `1|2`.
- assertRendering("Abc|Def\n---|---\n1\\\\|2", "
\n" +
- "\n" +
- "
\n" +
- "
Abc
\n" +
- "
Def
\n" +
- "
\n" +
- "\n" +
- "\n" +
- "
\n" +
- "
1|2
\n" +
- "
\n" +
- "
\n" +
- "\n" +
- "
\n");
+ // This is a bit weird in the GFM spec IMO. `1\\|2` looks like an escaped backslash,
+ // followed by a pipe (so two cells). Instead, the `\|` is parsed as an escaped pipe first,
+ // so just a single cell. The inline parser then gets `1\|2` which renders as `1|2`.
+ assertRendering(
+ "Abc|Def\n---|---\n1\\\\|2",
+ "
\n"
+ + "\n"
+ + "
\n"
+ + "
Abc
\n"
+ + "
Def
\n"
+ + "
\n"
+ + "\n"
+ + "\n"
+ + "
\n"
+ + "
1|2
\n"
+ + "
\n"
+ + "
\n"
+ + "\n"
+ + "
\n");
}
@Test
public void escapedOther() {
- // This is a tricky one. For \`, we don't want to remove the backslash when we parse the table, otherwise
- // inline parsing is wrong. So we have to be careful where we do/don't consume the backslash.
- assertRendering("Abc|Def\n---|---\n1|\\`not code`", "
\n" +
- "\n" +
- "
\n" +
- "
Abc
\n" +
- "
Def
\n" +
- "
\n" +
- "\n" +
- "\n" +
- "
\n" +
- "
1
\n" +
- "
`not code`
\n" +
- "
\n" +
- "\n" +
- "
\n");
+ // This is a tricky one. For \`, we don't want to remove the backslash when we parse the
+ // table, otherwise inline parsing is wrong. So we have to be careful where we do/don't
+ // consume the backslash.
+ assertRendering(
+ "Abc|Def\n---|---\n1|\\`not code`",
+ "
\n"
+ + "\n"
+ + "
\n"
+ + "
Abc
\n"
+ + "
Def
\n"
+ + "
\n"
+ + "\n"
+ + "\n"
+ + "
\n"
+ + "
1
\n"
+ + "
`not code`
\n"
+ + "
\n"
+ + "\n"
+ + "
\n");
}
@Test
public void backslashAtEnd() {
- assertRendering("Abc|Def\n---|---\n1|2\\", "
- * Create it with {@link #create()} or {@link #builder()} and then configure it on the
- * renderer builder ({@link HtmlRenderer.Builder#extensions(Iterable)}).
- *
- * The heading text will be used to create the id. Multiple headings with the
- * same text will result in appending a hyphen and number. For example:
+ *
+ *
Create it with {@link #create()} or {@link #builder()} and then configure it on the renderer
+ * builder ({@link HtmlRenderer.Builder#extensions(Iterable)}).
+ *
+ *
The heading text will be used to create the id. Multiple headings with the same text will
+ * result in appending a hyphen and number. For example:
+ *
*
* # Heading
* # Heading
*
+ *
* will result in
+ *
*
* <h1 id="heading">Heading</h1>
* <h1 id="heading-1">Heading</h1>
@@ -52,7 +55,8 @@ public static Builder builder() {
@Override
public void extend(HtmlRenderer.Builder rendererBuilder) {
- rendererBuilder.attributeProviderFactory(context -> HeadingIdAttributeProvider.create(defaultId, idPrefix, idSuffix));
+ rendererBuilder.attributeProviderFactory(
+ context -> HeadingIdAttributeProvider.create(defaultId, idPrefix, idSuffix));
}
public static class Builder {
@@ -61,7 +65,8 @@ public static class Builder {
private String idSuffix = "";
/**
- * @param value Default value for the id to take if no generated id can be extracted. Default "id"
+ * @param value Default value for the id to take if no generated id can be extracted.
+ * Default "id"
* @return {@code this}
*/
public Builder defaultId(String value) {
diff --git a/commonmark-ext-heading-anchor/src/main/java/org/commonmark/ext/heading/anchor/IdGenerator.java b/commonmark-ext-heading-anchor/src/main/java/org/commonmark/ext/heading/anchor/IdGenerator.java
index 2c37433e2..8ab5b3b32 100644
--- a/commonmark-ext-heading-anchor/src/main/java/org/commonmark/ext/heading/anchor/IdGenerator.java
+++ b/commonmark-ext-heading-anchor/src/main/java/org/commonmark/ext/heading/anchor/IdGenerator.java
@@ -7,8 +7,8 @@
/**
* Generates strings to be used as identifiers.
- *
- * Use {@link #builder()} to create an instance.
+ *
+ *
Use {@link #builder()} to create an instance.
*/
public class IdGenerator {
private final Pattern allowedCharacters;
@@ -33,35 +33,35 @@ public static Builder builder() {
}
/**
- *
* Generate an ID based on the provided text and previously generated IDs.
- *
- * This method is not thread safe, concurrent calls can end up
- * with non-unique identifiers.
- *
- * Note that collision can occur in the case that
+ *
+ *
This method is not thread safe, concurrent calls can end up with non-unique identifiers.
+ *
+ *
Note that collision can occur in the case that
+ *
*
- *
Method called with 'X'
- *
Method called with 'X' again
- *
Method called with 'X-1'
+ *
Method called with 'X'
+ *
Method called with 'X' again
+ *
Method called with 'X-1'
*
- *
- * In that case, the three generated IDs will be:
+ *
+ *
In that case, the three generated IDs will be:
+ *
*
- *
X
- *
X-1
- *
X-1
+ *
X
+ *
X-1
+ *
X-1
*
- *
- * Therefore if collisions are unacceptable you should ensure that
- * numbers are stripped from end of {@code text}.
*
- * @param text Text that the identifier should be based on. Will be normalised, then used to generate the
- * identifier.
- * @return {@code text} if this is the first instance that the {@code text} has been passed
- * to the method. Otherwise, {@code text + "-" + X} will be returned, where X is the number of times
- * that {@code text} has previously been passed in. If {@code text} is empty, the default
- * identifier given in the constructor will be used.
+ *
Therefore if collisions are unacceptable you should ensure that numbers are stripped from
+ * end of {@code text}.
+ *
+ * @param text Text that the identifier should be based on. Will be normalised, then used to
+ * generate the identifier.
+ * @return {@code text} if this is the first instance that the {@code text} has been passed to
+ * the method. Otherwise, {@code text + "-" + X} will be returned, where X is the number of
+ * times that {@code text} has previously been passed in. If {@code text} is empty, the
+ * default identifier given in the constructor will be used.
*/
public String generateId(String text) {
String normalizedIdentity = text != null ? normalizeText(text) : defaultIdentifier;
@@ -85,7 +85,8 @@ private static Pattern compileAllowedCharactersPattern() {
try {
return Pattern.compile(regex, Pattern.UNICODE_CHARACTER_CLASS);
} catch (IllegalArgumentException e) {
- // Android only supports the flag in API level 24. But it actually uses Unicode character classes by
+ // Android only supports the flag in API level 24. But it actually uses Unicode
+ // character classes by
// default, so not specifying the flag is ok. See issue #71.
return Pattern.compile(regex);
}
@@ -119,7 +120,8 @@ public IdGenerator build() {
}
/**
- * @param defaultId the default identifier to use in case the provided text is empty or only contains unusable characters
+ * @param defaultId the default identifier to use in case the provided text is empty or only
+ * contains unusable characters
* @return {@code this}
*/
public Builder defaultId(String defaultId) {
diff --git a/commonmark-ext-heading-anchor/src/main/java/org/commonmark/ext/heading/anchor/internal/HeadingIdAttributeProvider.java b/commonmark-ext-heading-anchor/src/main/java/org/commonmark/ext/heading/anchor/internal/HeadingIdAttributeProvider.java
index 6b8792bd5..f7d1b75a1 100644
--- a/commonmark-ext-heading-anchor/src/main/java/org/commonmark/ext/heading/anchor/internal/HeadingIdAttributeProvider.java
+++ b/commonmark-ext-heading-anchor/src/main/java/org/commonmark/ext/heading/anchor/internal/HeadingIdAttributeProvider.java
@@ -1,26 +1,23 @@
package org.commonmark.ext.heading.anchor.internal;
-import org.commonmark.ext.heading.anchor.IdGenerator;
-import org.commonmark.renderer.html.AttributeProvider;
-import org.commonmark.node.*;
-
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
+import org.commonmark.ext.heading.anchor.IdGenerator;
+import org.commonmark.node.*;
+import org.commonmark.renderer.html.AttributeProvider;
public class HeadingIdAttributeProvider implements AttributeProvider {
private final IdGenerator idGenerator;
private HeadingIdAttributeProvider(String defaultId, String prefix, String suffix) {
- idGenerator = IdGenerator.builder()
- .defaultId(defaultId)
- .prefix(prefix)
- .suffix(suffix)
- .build();
+ idGenerator =
+ IdGenerator.builder().defaultId(defaultId).prefix(prefix).suffix(suffix).build();
}
- public static HeadingIdAttributeProvider create(String defaultId, String prefix, String suffix) {
+ public static HeadingIdAttributeProvider create(
+ String defaultId, String prefix, String suffix) {
return new HeadingIdAttributeProvider(defaultId, prefix, suffix);
}
@@ -31,17 +28,18 @@ public void setAttributes(Node node, String tagName, final Map a
final List wordList = new ArrayList<>();
- node.accept(new AbstractVisitor() {
- @Override
- public void visit(Text text) {
- wordList.add(text.getLiteral());
- }
-
- @Override
- public void visit(Code code) {
- wordList.add(code.getLiteral());
- }
- });
+ node.accept(
+ new AbstractVisitor() {
+ @Override
+ public void visit(Text text) {
+ wordList.add(text.getLiteral());
+ }
+
+ @Override
+ public void visit(Code code) {
+ wordList.add(code.getLiteral());
+ }
+ });
String finalString = "";
for (String word : wordList) {
diff --git a/commonmark-ext-heading-anchor/src/test/java/org/commonmark/ext/heading/anchor/HeadingAnchorConfigurationTest.java b/commonmark-ext-heading-anchor/src/test/java/org/commonmark/ext/heading/anchor/HeadingAnchorConfigurationTest.java
index 438a3a9bd..c78b7c61a 100644
--- a/commonmark-ext-heading-anchor/src/test/java/org/commonmark/ext/heading/anchor/HeadingAnchorConfigurationTest.java
+++ b/commonmark-ext-heading-anchor/src/test/java/org/commonmark/ext/heading/anchor/HeadingAnchorConfigurationTest.java
@@ -1,34 +1,31 @@
package org.commonmark.ext.heading.anchor;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.util.List;
import org.commonmark.Extension;
import org.commonmark.parser.Parser;
import org.commonmark.renderer.html.HtmlRenderer;
import org.junit.jupiter.api.Test;
-import java.util.List;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
public class HeadingAnchorConfigurationTest {
private static final Parser PARSER = Parser.builder().build();
private HtmlRenderer buildRenderer(String defaultId, String prefix, String suffix) {
- Extension ext = HeadingAnchorExtension.builder()
- .defaultId(defaultId)
- .idPrefix(prefix)
- .idSuffix(suffix)
- .build();
- return HtmlRenderer.builder()
- .extensions(List.of(ext))
- .build();
+ Extension ext =
+ HeadingAnchorExtension.builder()
+ .defaultId(defaultId)
+ .idPrefix(prefix)
+ .idSuffix(suffix)
+ .build();
+ return HtmlRenderer.builder().extensions(List.of(ext)).build();
}
@Test
public void testDefaultConfigurationHasNoAdditions() {
- HtmlRenderer renderer = HtmlRenderer.builder()
- .extensions(List.of(HeadingAnchorExtension.create()))
- .build();
+ HtmlRenderer renderer =
+ HtmlRenderer.builder().extensions(List.of(HeadingAnchorExtension.create())).build();
assertThat(doRender(renderer, "# ")).isEqualTo("\n");
}
@@ -53,5 +50,4 @@ public void testSuffixAddedToHeader() {
private String doRender(HtmlRenderer renderer, String text) {
return renderer.render(PARSER.parse(text));
}
-
}
diff --git a/commonmark-ext-heading-anchor/src/test/java/org/commonmark/ext/heading/anchor/HeadingAnchorTest.java b/commonmark-ext-heading-anchor/src/test/java/org/commonmark/ext/heading/anchor/HeadingAnchorTest.java
index 3149542e3..95ee2d7eb 100644
--- a/commonmark-ext-heading-anchor/src/test/java/org/commonmark/ext/heading/anchor/HeadingAnchorTest.java
+++ b/commonmark-ext-heading-anchor/src/test/java/org/commonmark/ext/heading/anchor/HeadingAnchorTest.java
@@ -1,34 +1,35 @@
package org.commonmark.ext.heading.anchor;
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.parser.Parser;
import org.commonmark.renderer.html.HtmlRenderer;
import org.commonmark.testutil.RenderingTestCase;
import org.junit.jupiter.api.Test;
-import java.util.Set;
-
public class HeadingAnchorTest extends RenderingTestCase {
private static final Set EXTENSIONS = Set.of(HeadingAnchorExtension.create());
private static final Parser PARSER = Parser.builder().build();
- private static final HtmlRenderer RENDERER = HtmlRenderer.builder().extensions(EXTENSIONS).build();
+ private static final HtmlRenderer RENDERER =
+ HtmlRenderer.builder().extensions(EXTENSIONS).build();
@Test
public void baseCaseSingleHeader() {
- assertRendering("# Heading here\n",
- "
\n");
}
@Override
diff --git a/commonmark-ext-image-attributes/src/main/java/org/commonmark/ext/image/attributes/ImageAttributes.java b/commonmark-ext-image-attributes/src/main/java/org/commonmark/ext/image/attributes/ImageAttributes.java
index 1ee43958b..1739aae77 100644
--- a/commonmark-ext-image-attributes/src/main/java/org/commonmark/ext/image/attributes/ImageAttributes.java
+++ b/commonmark-ext-image-attributes/src/main/java/org/commonmark/ext/image/attributes/ImageAttributes.java
@@ -1,13 +1,10 @@
package org.commonmark.ext.image.attributes;
+import java.util.Map;
import org.commonmark.node.CustomNode;
import org.commonmark.node.Delimited;
-import java.util.Map;
-
-/**
- * A node containing text and other inline nodes as children.
- */
+/** A node containing text and other inline nodes as children. */
public class ImageAttributes extends CustomNode implements Delimited {
private final Map attributes;
diff --git a/commonmark-ext-image-attributes/src/main/java/org/commonmark/ext/image/attributes/ImageAttributesExtension.java b/commonmark-ext-image-attributes/src/main/java/org/commonmark/ext/image/attributes/ImageAttributesExtension.java
index 9a4de2628..f6becc651 100644
--- a/commonmark-ext-image-attributes/src/main/java/org/commonmark/ext/image/attributes/ImageAttributesExtension.java
+++ b/commonmark-ext-image-attributes/src/main/java/org/commonmark/ext/image/attributes/ImageAttributesExtension.java
@@ -8,18 +8,17 @@
/**
* Extension for adding attributes to image nodes.
- *
- * Create it with {@link #create()} and then configure it on the builders
- * ({@link org.commonmark.parser.Parser.Builder#extensions(Iterable)},
- * {@link HtmlRenderer.Builder#extensions(Iterable)}).
- *
+ *
+ *
Create it with {@link #create()} and then configure it on the builders ({@link
+ * org.commonmark.parser.Parser.Builder#extensions(Iterable)}, {@link
+ * HtmlRenderer.Builder#extensions(Iterable)}).
*
* @since 0.15.0
*/
-public class ImageAttributesExtension implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension {
+public class ImageAttributesExtension
+ implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension {
- private ImageAttributesExtension() {
- }
+ private ImageAttributesExtension() {}
public static Extension create() {
return new ImageAttributesExtension();
@@ -32,6 +31,7 @@ public void extend(Parser.Builder parserBuilder) {
@Override
public void extend(HtmlRenderer.Builder rendererBuilder) {
- rendererBuilder.attributeProviderFactory(context -> ImageAttributesAttributeProvider.create());
+ rendererBuilder.attributeProviderFactory(
+ context -> ImageAttributesAttributeProvider.create());
}
}
diff --git a/commonmark-ext-image-attributes/src/main/java/org/commonmark/ext/image/attributes/internal/ImageAttributesAttributeProvider.java b/commonmark-ext-image-attributes/src/main/java/org/commonmark/ext/image/attributes/internal/ImageAttributesAttributeProvider.java
index bd89738de..c132c9dcd 100644
--- a/commonmark-ext-image-attributes/src/main/java/org/commonmark/ext/image/attributes/internal/ImageAttributesAttributeProvider.java
+++ b/commonmark-ext-image-attributes/src/main/java/org/commonmark/ext/image/attributes/internal/ImageAttributesAttributeProvider.java
@@ -1,5 +1,6 @@
package org.commonmark.ext.image.attributes.internal;
+import java.util.*;
import org.commonmark.ext.image.attributes.ImageAttributes;
import org.commonmark.node.AbstractVisitor;
import org.commonmark.node.CustomNode;
@@ -7,12 +8,9 @@
import org.commonmark.node.Node;
import org.commonmark.renderer.html.AttributeProvider;
-import java.util.*;
-
public class ImageAttributesAttributeProvider implements AttributeProvider {
- private ImageAttributesAttributeProvider() {
- }
+ private ImageAttributesAttributeProvider() {}
public static ImageAttributesAttributeProvider create() {
return new ImageAttributesAttributeProvider();
@@ -21,17 +19,18 @@ public static ImageAttributesAttributeProvider create() {
@Override
public void setAttributes(Node node, String tagName, final Map attributes) {
if (node instanceof Image) {
- node.accept(new AbstractVisitor() {
- @Override
- public void visit(CustomNode node) {
- if (node instanceof ImageAttributes) {
- ImageAttributes imageAttributes = (ImageAttributes) node;
- attributes.putAll(imageAttributes.getAttributes());
- // Now that we have used the image attributes we remove the node.
- imageAttributes.unlink();
- }
- }
- });
+ node.accept(
+ new AbstractVisitor() {
+ @Override
+ public void visit(CustomNode node) {
+ if (node instanceof ImageAttributes) {
+ ImageAttributes imageAttributes = (ImageAttributes) node;
+ attributes.putAll(imageAttributes.getAttributes());
+ // Now that we have used the image attributes we remove the node.
+ imageAttributes.unlink();
+ }
+ }
+ });
}
}
}
diff --git a/commonmark-ext-image-attributes/src/main/java/org/commonmark/ext/image/attributes/internal/ImageAttributesDelimiterProcessor.java b/commonmark-ext-image-attributes/src/main/java/org/commonmark/ext/image/attributes/internal/ImageAttributesDelimiterProcessor.java
index 06a39ba23..53ba882c9 100644
--- a/commonmark-ext-image-attributes/src/main/java/org/commonmark/ext/image/attributes/internal/ImageAttributesDelimiterProcessor.java
+++ b/commonmark-ext-image-attributes/src/main/java/org/commonmark/ext/image/attributes/internal/ImageAttributesDelimiterProcessor.java
@@ -1,5 +1,6 @@
package org.commonmark.ext.image.attributes.internal;
+import java.util.*;
import org.commonmark.ext.image.attributes.ImageAttributes;
import org.commonmark.node.Image;
import org.commonmark.node.Node;
@@ -8,8 +9,6 @@
import org.commonmark.parser.delimiter.DelimiterProcessor;
import org.commonmark.parser.delimiter.DelimiterRun;
-import java.util.*;
-
public class ImageAttributesDelimiterProcessor implements DelimiterProcessor {
// Only allow a defined set of attributes to be used.
@@ -36,8 +35,8 @@ public int process(DelimiterRun openingRun, DelimiterRun closingRun) {
return 0;
}
- // Check if the attributes can be applied - if the previous node is an Image, and if all the attributes are in
- // the set of SUPPORTED_ATTRIBUTES
+ // Check if the attributes can be applied - if the previous node is an Image, and if all the
+ // attributes are in the set of SUPPORTED_ATTRIBUTES
Text opener = openingRun.getOpener();
Node nodeToStyle = opener.getPrevious();
if (!(nodeToStyle instanceof Image)) {
@@ -53,7 +52,8 @@ public int process(DelimiterRun openingRun, DelimiterRun closingRun) {
content.append(((Text) node).getLiteral());
toUnlink.add(node);
} else {
- // This node type is not supported, so stop here (no need to check any further ones).
+ // This node type is not supported, so stop here (no need to check any further
+ // ones).
return 0;
}
}
@@ -65,7 +65,8 @@ public int process(DelimiterRun openingRun, DelimiterRun closingRun) {
if (attribute.length > 1 && SUPPORTED_ATTRIBUTES.contains(attribute[0].toLowerCase())) {
attributesMap.put(attribute[0], attribute[1]);
} else {
- // This attribute is not supported, so stop here (no need to check any further ones).
+ // This attribute is not supported, so stop here (no need to check any further
+ // ones).
return 0;
}
}
diff --git a/commonmark-ext-image-attributes/src/test/java/org/commonmark/ext/image/attributes/ImageAttributesTest.java b/commonmark-ext-image-attributes/src/test/java/org/commonmark/ext/image/attributes/ImageAttributesTest.java
index 3edf8497e..4232646a2 100644
--- a/commonmark-ext-image-attributes/src/test/java/org/commonmark/ext/image/attributes/ImageAttributesTest.java
+++ b/commonmark-ext-image-attributes/src/test/java/org/commonmark/ext/image/attributes/ImageAttributesTest.java
@@ -1,5 +1,9 @@
package org.commonmark.ext.image.attributes;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.util.List;
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.node.Node;
import org.commonmark.node.Paragraph;
@@ -10,44 +14,48 @@
import org.commonmark.testutil.RenderingTestCase;
import org.junit.jupiter.api.Test;
-import java.util.List;
-import java.util.Set;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
public class ImageAttributesTest extends RenderingTestCase {
private static final Set EXTENSIONS = Set.of(ImageAttributesExtension.create());
private static final Parser PARSER = Parser.builder().extensions(EXTENSIONS).build();
- private static final HtmlRenderer RENDERER = HtmlRenderer.builder().extensions(EXTENSIONS).build();
+ private static final HtmlRenderer RENDERER =
+ HtmlRenderer.builder().extensions(EXTENSIONS).build();
@Test
public void baseCase() {
- assertRendering("{height=5}",
+ assertRendering(
+ "{height=5}",
"
\n");
}
@Test
public void sourceSpans() {
- Parser parser = Parser.builder()
- .extensions(EXTENSIONS)
- .includeSourceSpans(IncludeSourceSpans.BLOCKS_AND_INLINES)
- .build();
-
- // This doesn't result in image attributes, so source spans should be for the single (merged) text node.
+ Parser parser =
+ Parser.builder()
+ .extensions(EXTENSIONS)
+ .includeSourceSpans(IncludeSourceSpans.BLOCKS_AND_INLINES)
+ .build();
+
+ // This doesn't result in image attributes, so source spans should be for the single
+ // (merged) text node.
Node document = parser.parse("x{height=3 width=4}\n");
Paragraph block = (Paragraph) document.getFirstChild();
Node text = block.getFirstChild();
diff --git a/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/Ins.java b/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/Ins.java
index 2ebd4f5ca..b6d7a2f2a 100644
--- a/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/Ins.java
+++ b/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/Ins.java
@@ -3,9 +3,7 @@
import org.commonmark.node.CustomNode;
import org.commonmark.node.Delimited;
-/**
- * An ins node containing text and other inline nodes as children.
- */
+/** An ins node containing text and other inline nodes as children. */
public class Ins extends CustomNode implements Delimited {
private static final String DELIMITER = "++";
diff --git a/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/InsExtension.java b/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/InsExtension.java
index 3d2974916..a39b77af8 100644
--- a/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/InsExtension.java
+++ b/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/InsExtension.java
@@ -1,5 +1,6 @@
package org.commonmark.ext.ins;
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.ext.ins.internal.InsDelimiterProcessor;
import org.commonmark.ext.ins.internal.InsHtmlNodeRenderer;
@@ -13,23 +14,22 @@
import org.commonmark.renderer.markdown.MarkdownRenderer;
import org.commonmark.renderer.text.TextContentRenderer;
-import java.util.Set;
-
/**
* Extension for ins using ++
- *
- * Create it with {@link #create()} and then configure it on the builders
- * ({@link org.commonmark.parser.Parser.Builder#extensions(Iterable)},
- * {@link HtmlRenderer.Builder#extensions(Iterable)}).
- *
- *
- * The parsed ins text regions are turned into {@link Ins} nodes.
- *
+ *
+ *
Create it with {@link #create()} and then configure it on the builders ({@link
+ * org.commonmark.parser.Parser.Builder#extensions(Iterable)}, {@link
+ * HtmlRenderer.Builder#extensions(Iterable)}).
+ *
+ *
The parsed ins text regions are turned into {@link Ins} nodes.
*/
-public class InsExtension implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension, TextContentRenderer.TextContentRendererExtension, MarkdownRenderer.MarkdownRendererExtension {
+public class InsExtension
+ implements Parser.ParserExtension,
+ HtmlRenderer.HtmlRendererExtension,
+ TextContentRenderer.TextContentRendererExtension,
+ MarkdownRenderer.MarkdownRendererExtension {
- private InsExtension() {
- }
+ private InsExtension() {}
public static Extension create() {
return new InsExtension();
@@ -52,18 +52,20 @@ public void extend(TextContentRenderer.Builder rendererBuilder) {
@Override
public void extend(MarkdownRenderer.Builder rendererBuilder) {
- rendererBuilder.nodeRendererFactory(new MarkdownNodeRendererFactory() {
- @Override
- public NodeRenderer create(MarkdownNodeRendererContext context) {
- return new InsMarkdownNodeRenderer(context);
- }
+ rendererBuilder.nodeRendererFactory(
+ new MarkdownNodeRendererFactory() {
+ @Override
+ public NodeRenderer create(MarkdownNodeRendererContext context) {
+ return new InsMarkdownNodeRenderer(context);
+ }
- @Override
- public Set getSpecialCharacters() {
- // We technically don't need to escape single occurrences of +, but that's all the extension API
- // exposes currently.
- return Set.of('+');
- }
- });
+ @Override
+ public Set getSpecialCharacters() {
+ // We technically don't need to escape single occurrences of +, but that's
+ // all the extension API
+ // exposes currently.
+ return Set.of('+');
+ }
+ });
}
}
diff --git a/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/internal/InsDelimiterProcessor.java b/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/internal/InsDelimiterProcessor.java
index b0bfb4c6e..a742c70cf 100644
--- a/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/internal/InsDelimiterProcessor.java
+++ b/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/internal/InsDelimiterProcessor.java
@@ -28,7 +28,8 @@ public int getMinLength() {
@Override
public int process(DelimiterRun openingRun, DelimiterRun closingRun) {
if (openingRun.length() >= 2 && closingRun.length() >= 2) {
- // Use exactly two delimiters even if we have more, and don't care about internal openers/closers.
+ // Use exactly two delimiters even if we have more, and don't care about internal
+ // openers/closers.
Text opener = openingRun.getOpener();
diff --git a/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/internal/InsHtmlNodeRenderer.java b/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/internal/InsHtmlNodeRenderer.java
index dcd05fd59..d4defcbdc 100644
--- a/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/internal/InsHtmlNodeRenderer.java
+++ b/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/internal/InsHtmlNodeRenderer.java
@@ -1,11 +1,10 @@
package org.commonmark.ext.ins.internal;
+import java.util.Map;
import org.commonmark.node.Node;
import org.commonmark.renderer.html.HtmlNodeRendererContext;
import org.commonmark.renderer.html.HtmlWriter;
-import java.util.Map;
-
public class InsHtmlNodeRenderer extends InsNodeRenderer {
private final HtmlNodeRendererContext context;
diff --git a/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/internal/InsNodeRenderer.java b/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/internal/InsNodeRenderer.java
index 31f0a64ec..4e8e0283e 100644
--- a/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/internal/InsNodeRenderer.java
+++ b/commonmark-ext-ins/src/main/java/org/commonmark/ext/ins/internal/InsNodeRenderer.java
@@ -1,11 +1,10 @@
package org.commonmark.ext.ins.internal;
+import java.util.Set;
import org.commonmark.ext.ins.Ins;
import org.commonmark.node.Node;
import org.commonmark.renderer.NodeRenderer;
-import java.util.Set;
-
abstract class InsNodeRenderer implements NodeRenderer {
@Override
diff --git a/commonmark-ext-ins/src/test/java/org/commonmark/ext/ins/InsMarkdownRendererTest.java b/commonmark-ext-ins/src/test/java/org/commonmark/ext/ins/InsMarkdownRendererTest.java
index 6fc9ead67..023413121 100644
--- a/commonmark-ext-ins/src/test/java/org/commonmark/ext/ins/InsMarkdownRendererTest.java
+++ b/commonmark-ext-ins/src/test/java/org/commonmark/ext/ins/InsMarkdownRendererTest.java
@@ -1,19 +1,19 @@
package org.commonmark.ext.ins;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.parser.Parser;
import org.commonmark.renderer.markdown.MarkdownRenderer;
import org.junit.jupiter.api.Test;
-import java.util.Set;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
public class InsMarkdownRendererTest {
private static final Set EXTENSIONS = Set.of(InsExtension.create());
private static final Parser PARSER = Parser.builder().extensions(EXTENSIONS).build();
- private static final MarkdownRenderer RENDERER = MarkdownRenderer.builder().extensions(EXTENSIONS).build();
+ private static final MarkdownRenderer RENDERER =
+ MarkdownRenderer.builder().extensions(EXTENSIONS).build();
@Test
public void testStrikethrough() {
diff --git a/commonmark-ext-ins/src/test/java/org/commonmark/ext/ins/InsTest.java b/commonmark-ext-ins/src/test/java/org/commonmark/ext/ins/InsTest.java
index a5c91a395..8687d9a06 100644
--- a/commonmark-ext-ins/src/test/java/org/commonmark/ext/ins/InsTest.java
+++ b/commonmark-ext-ins/src/test/java/org/commonmark/ext/ins/InsTest.java
@@ -1,5 +1,9 @@
package org.commonmark.ext.ins;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.util.List;
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.node.Node;
import org.commonmark.node.Paragraph;
@@ -11,18 +15,14 @@
import org.commonmark.testutil.RenderingTestCase;
import org.junit.jupiter.api.Test;
-import java.util.List;
-import java.util.Set;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
public class InsTest extends RenderingTestCase {
private static final Set EXTENSIONS = Set.of(InsExtension.create());
private static final Parser PARSER = Parser.builder().extensions(EXTENSIONS).build();
- private static final HtmlRenderer RENDERER = HtmlRenderer.builder().extensions(EXTENSIONS).build();
- private static final TextContentRenderer CONTENT_RENDERER = TextContentRenderer.builder()
- .extensions(EXTENSIONS).build();
+ private static final HtmlRenderer RENDERER =
+ HtmlRenderer.builder().extensions(EXTENSIONS).build();
+ private static final TextContentRenderer CONTENT_RENDERER =
+ TextContentRenderer.builder().extensions(EXTENSIONS).build();
@Test
public void onePlusIsNotEnough() {
@@ -68,13 +68,15 @@ public void plusesInside() {
@Test
public void insWholeParagraphWithOtherDelimiters() {
- assertRendering("++Paragraph with *emphasis* and __strong emphasis__++",
+ assertRendering(
+ "++Paragraph with *emphasis* and __strong emphasis__++",
"
\n");
}
@@ -94,10 +96,11 @@ public void textContentRenderer() {
@Test
public void sourceSpans() {
- Parser parser = Parser.builder()
- .extensions(EXTENSIONS)
- .includeSourceSpans(IncludeSourceSpans.BLOCKS_AND_INLINES)
- .build();
+ Parser parser =
+ Parser.builder()
+ .extensions(EXTENSIONS)
+ .includeSourceSpans(IncludeSourceSpans.BLOCKS_AND_INLINES)
+ .build();
Node document = parser.parse("hey ++there++\n");
Paragraph block = (Paragraph) document.getFirstChild();
diff --git a/commonmark-ext-task-list-items/src/main/java/org/commonmark/ext/task/list/items/TaskListItemMarker.java b/commonmark-ext-task-list-items/src/main/java/org/commonmark/ext/task/list/items/TaskListItemMarker.java
index 9eca59bc9..4cfcb73eb 100644
--- a/commonmark-ext-task-list-items/src/main/java/org/commonmark/ext/task/list/items/TaskListItemMarker.java
+++ b/commonmark-ext-task-list-items/src/main/java/org/commonmark/ext/task/list/items/TaskListItemMarker.java
@@ -2,9 +2,7 @@
import org.commonmark.node.CustomNode;
-/**
- * A marker node indicating that a list item contains a task.
- */
+/** A marker node indicating that a list item contains a task. */
public class TaskListItemMarker extends CustomNode {
private final boolean checked;
diff --git a/commonmark-ext-task-list-items/src/main/java/org/commonmark/ext/task/list/items/TaskListItemsExtension.java b/commonmark-ext-task-list-items/src/main/java/org/commonmark/ext/task/list/items/TaskListItemsExtension.java
index 1c89256d3..abddc519a 100644
--- a/commonmark-ext-task-list-items/src/main/java/org/commonmark/ext/task/list/items/TaskListItemsExtension.java
+++ b/commonmark-ext-task-list-items/src/main/java/org/commonmark/ext/task/list/items/TaskListItemsExtension.java
@@ -14,19 +14,19 @@
/**
* Extension for adding task list items.
- *
- * Create it with {@link #create()} and then configure it on the builders
- * ({@link org.commonmark.parser.Parser.Builder#extensions(Iterable)},
- * {@link HtmlRenderer.Builder#extensions(Iterable)}).
- *
+ *
+ *
Create it with {@link #create()} and then configure it on the builders ({@link
+ * org.commonmark.parser.Parser.Builder#extensions(Iterable)}, {@link
+ * HtmlRenderer.Builder#extensions(Iterable)}).
*
* @since 0.15.0
*/
-public class TaskListItemsExtension implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension,
- MarkdownRenderer.MarkdownRendererExtension {
+public class TaskListItemsExtension
+ implements Parser.ParserExtension,
+ HtmlRenderer.HtmlRendererExtension,
+ MarkdownRenderer.MarkdownRendererExtension {
- private TaskListItemsExtension() {
- }
+ private TaskListItemsExtension() {}
public static Extension create() {
return new TaskListItemsExtension();
@@ -44,16 +44,17 @@ public void extend(HtmlRenderer.Builder rendererBuilder) {
@Override
public void extend(MarkdownRenderer.Builder rendererBuilder) {
- rendererBuilder.nodeRendererFactory(new MarkdownNodeRendererFactory() {
- @Override
- public NodeRenderer create(MarkdownNodeRendererContext context) {
- return new TaskListItemMarkdownNodeRenderer(context);
- }
-
- @Override
- public Set getSpecialCharacters() {
- return Set.of();
- }
- });
+ rendererBuilder.nodeRendererFactory(
+ new MarkdownNodeRendererFactory() {
+ @Override
+ public NodeRenderer create(MarkdownNodeRendererContext context) {
+ return new TaskListItemMarkdownNodeRenderer(context);
+ }
+
+ @Override
+ public Set getSpecialCharacters() {
+ return Set.of();
+ }
+ });
}
}
diff --git a/commonmark-ext-task-list-items/src/main/java/org/commonmark/ext/task/list/items/internal/TaskListItemHtmlNodeRenderer.java b/commonmark-ext-task-list-items/src/main/java/org/commonmark/ext/task/list/items/internal/TaskListItemHtmlNodeRenderer.java
index a27b125c8..cb1c275b4 100644
--- a/commonmark-ext-task-list-items/src/main/java/org/commonmark/ext/task/list/items/internal/TaskListItemHtmlNodeRenderer.java
+++ b/commonmark-ext-task-list-items/src/main/java/org/commonmark/ext/task/list/items/internal/TaskListItemHtmlNodeRenderer.java
@@ -1,13 +1,12 @@
package org.commonmark.ext.task.list.items.internal;
+import java.util.LinkedHashMap;
+import java.util.Map;
import org.commonmark.ext.task.list.items.TaskListItemMarker;
import org.commonmark.node.Node;
import org.commonmark.renderer.html.HtmlNodeRendererContext;
import org.commonmark.renderer.html.HtmlWriter;
-import java.util.LinkedHashMap;
-import java.util.Map;
-
public class TaskListItemHtmlNodeRenderer extends TaskListItemNodeRenderer {
private final HtmlNodeRendererContext context;
diff --git a/commonmark-ext-task-list-items/src/main/java/org/commonmark/ext/task/list/items/internal/TaskListItemPostProcessor.java b/commonmark-ext-task-list-items/src/main/java/org/commonmark/ext/task/list/items/internal/TaskListItemPostProcessor.java
index b95c2e30d..2898a8229 100644
--- a/commonmark-ext-task-list-items/src/main/java/org/commonmark/ext/task/list/items/internal/TaskListItemPostProcessor.java
+++ b/commonmark-ext-task-list-items/src/main/java/org/commonmark/ext/task/list/items/internal/TaskListItemPostProcessor.java
@@ -1,12 +1,11 @@
package org.commonmark.ext.task.list.items.internal;
-import org.commonmark.ext.task.list.items.TaskListItemMarker;
-import org.commonmark.node.*;
-import org.commonmark.parser.PostProcessor;
-
import java.util.Objects;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
+import org.commonmark.ext.task.list.items.TaskListItemMarker;
+import org.commonmark.node.*;
+import org.commonmark.parser.PostProcessor;
public class TaskListItemPostProcessor implements PostProcessor {
@@ -31,14 +30,16 @@ public void visit(ListItem listItem) {
Matcher matcher = REGEX_TASK_LIST_ITEM.matcher(textNode.getLiteral());
if (matcher.matches()) {
String checked = matcher.group(1);
- boolean isChecked = Objects.equals(checked, "X") || Objects.equals(checked, "x");
+ boolean isChecked =
+ Objects.equals(checked, "X") || Objects.equals(checked, "x");
// Add the task list item marker node as the first child of the list item.
listItem.prependChild(new TaskListItemMarker(isChecked));
- // Parse the node using the input after the task marker (in other words, group 2 from the matcher).
- // (Note that the String has been trimmed, so we should add a space between the
- // TaskListItemMarker and the text that follows it when we come to render it).
+ // Parse the node using the input after the task marker (in other words,
+ // group 2 from the matcher). (Note that the String has been trimmed, so we
+ // should add a space between the TaskListItemMarker and the text that
+ // follows it when we come to render it).
textNode.setLiteral(matcher.group(2));
}
}
diff --git a/commonmark-ext-task-list-items/src/test/java/org/commonmark/ext/task/list/items/TaskListItemMarkdownRendererTest.java b/commonmark-ext-task-list-items/src/test/java/org/commonmark/ext/task/list/items/TaskListItemMarkdownRendererTest.java
index cf73f434c..e67768f16 100644
--- a/commonmark-ext-task-list-items/src/test/java/org/commonmark/ext/task/list/items/TaskListItemMarkdownRendererTest.java
+++ b/commonmark-ext-task-list-items/src/test/java/org/commonmark/ext/task/list/items/TaskListItemMarkdownRendererTest.java
@@ -1,5 +1,7 @@
package org.commonmark.ext.task.list.items;
+import static org.assertj.core.api.Assertions.assertThat;
+
import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.node.BulletList;
@@ -12,13 +14,12 @@
import org.commonmark.renderer.markdown.MarkdownRenderer;
import org.junit.jupiter.api.Test;
-import static org.assertj.core.api.Assertions.assertThat;
-
public class TaskListItemMarkdownRendererTest {
private static final Set EXTENSIONS = Set.of(TaskListItemsExtension.create());
private static final Parser PARSER = Parser.builder().extensions(EXTENSIONS).build();
- private static final MarkdownRenderer RENDERER = MarkdownRenderer.builder().extensions(EXTENSIONS).build();
+ private static final MarkdownRenderer RENDERER =
+ MarkdownRenderer.builder().extensions(EXTENSIONS).build();
@Test
public void testCheckedRoundTrip() {
diff --git a/commonmark-ext-task-list-items/src/test/java/org/commonmark/ext/task/list/items/TaskListItemsTest.java b/commonmark-ext-task-list-items/src/test/java/org/commonmark/ext/task/list/items/TaskListItemsTest.java
index 0adc615a7..dd9290b6e 100644
--- a/commonmark-ext-task-list-items/src/test/java/org/commonmark/ext/task/list/items/TaskListItemsTest.java
+++ b/commonmark-ext-task-list-items/src/test/java/org/commonmark/ext/task/list/items/TaskListItemsTest.java
@@ -1,87 +1,116 @@
package org.commonmark.ext.task.list.items;
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.parser.Parser;
import org.commonmark.renderer.html.HtmlRenderer;
import org.commonmark.testutil.RenderingTestCase;
import org.junit.jupiter.api.Test;
-import java.util.Set;
-
public class TaskListItemsTest extends RenderingTestCase {
private static final Set EXTENSIONS = Set.of(TaskListItemsExtension.create());
- private static final String HTML_CHECKED = "";
+ private static final String HTML_CHECKED =
+ "";
private static final String HTML_UNCHECKED = "";
private static final Parser PARSER = Parser.builder().extensions(EXTENSIONS).build();
- private static final HtmlRenderer RENDERER = HtmlRenderer.builder().extensions(EXTENSIONS).build();
+ private static final HtmlRenderer RENDERER =
+ HtmlRenderer.builder().extensions(EXTENSIONS).build();
@Test
public void baseCase() {
- assertRendering("- [x] this is *done*\n", "
\n
" + HTML_CHECKED + " this is done
\n
\n");
+ assertRendering(
+ "- [x] this is *done*\n",
+ "
- * Create it with {@link #create()} and then configure it on the builders
- * ({@link org.commonmark.parser.Parser.Builder#extensions(Iterable)},
- * {@link HtmlRenderer.Builder#extensions(Iterable)}).
- *
- *
- * The parsed metadata is turned into {@link YamlFrontMatterNode}. You can access the metadata using {@link YamlFrontMatterVisitor}.
- *
+ *
+ *
Create it with {@link #create()} and then configure it on the builders ({@link
+ * org.commonmark.parser.Parser.Builder#extensions(Iterable)}, {@link
+ * HtmlRenderer.Builder#extensions(Iterable)}).
+ *
+ *
The parsed metadata is turned into {@link YamlFrontMatterNode}. You can access the metadata
+ * using {@link YamlFrontMatterVisitor}.
*/
-public class YamlFrontMatterExtension implements Parser.ParserExtension, MarkdownRenderer.MarkdownRendererExtension {
+public class YamlFrontMatterExtension
+ implements Parser.ParserExtension, MarkdownRenderer.MarkdownRendererExtension {
- private YamlFrontMatterExtension() {
- }
+ private YamlFrontMatterExtension() {}
@Override
public void extend(Parser.Builder parserBuilder) {
@@ -38,16 +37,17 @@ public static Extension create() {
@Override
public void extend(MarkdownRenderer.Builder rendererBuilder) {
- rendererBuilder.nodeRendererFactory(new MarkdownNodeRendererFactory() {
- @Override
- public NodeRenderer create(MarkdownNodeRendererContext context) {
- return new YamlFrontMatterMarkdownNodeRenderer(context);
- }
+ rendererBuilder.nodeRendererFactory(
+ new MarkdownNodeRendererFactory() {
+ @Override
+ public NodeRenderer create(MarkdownNodeRendererContext context) {
+ return new YamlFrontMatterMarkdownNodeRenderer(context);
+ }
- @Override
- public Set getSpecialCharacters() {
- return Set.of();
- }
- });
+ @Override
+ public Set getSpecialCharacters() {
+ return Set.of();
+ }
+ });
}
}
diff --git a/commonmark-ext-yaml-front-matter/src/main/java/org/commonmark/ext/front/matter/YamlFrontMatterNode.java b/commonmark-ext-yaml-front-matter/src/main/java/org/commonmark/ext/front/matter/YamlFrontMatterNode.java
index 20eb3baf7..e5fe473ad 100644
--- a/commonmark-ext-yaml-front-matter/src/main/java/org/commonmark/ext/front/matter/YamlFrontMatterNode.java
+++ b/commonmark-ext-yaml-front-matter/src/main/java/org/commonmark/ext/front/matter/YamlFrontMatterNode.java
@@ -1,8 +1,7 @@
package org.commonmark.ext.front.matter;
-import org.commonmark.node.CustomNode;
-
import java.util.List;
+import org.commonmark.node.CustomNode;
public class YamlFrontMatterNode extends CustomNode {
private String key;
diff --git a/commonmark-ext-yaml-front-matter/src/main/java/org/commonmark/ext/front/matter/YamlFrontMatterVisitor.java b/commonmark-ext-yaml-front-matter/src/main/java/org/commonmark/ext/front/matter/YamlFrontMatterVisitor.java
index 1c23966f5..e49e22c0d 100644
--- a/commonmark-ext-yaml-front-matter/src/main/java/org/commonmark/ext/front/matter/YamlFrontMatterVisitor.java
+++ b/commonmark-ext-yaml-front-matter/src/main/java/org/commonmark/ext/front/matter/YamlFrontMatterVisitor.java
@@ -1,11 +1,10 @@
package org.commonmark.ext.front.matter;
-import org.commonmark.node.AbstractVisitor;
-import org.commonmark.node.CustomNode;
-
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
+import org.commonmark.node.AbstractVisitor;
+import org.commonmark.node.CustomNode;
public class YamlFrontMatterVisitor extends AbstractVisitor {
private Map> data;
@@ -17,7 +16,9 @@ public YamlFrontMatterVisitor() {
@Override
public void visit(CustomNode customNode) {
if (customNode instanceof YamlFrontMatterNode) {
- data.put(((YamlFrontMatterNode) customNode).getKey(), ((YamlFrontMatterNode) customNode).getValues());
+ data.put(
+ ((YamlFrontMatterNode) customNode).getKey(),
+ ((YamlFrontMatterNode) customNode).getValues());
} else {
super.visit(customNode);
}
diff --git a/commonmark-ext-yaml-front-matter/src/main/java/org/commonmark/ext/front/matter/internal/YamlFrontMatterBlockParser.java b/commonmark-ext-yaml-front-matter/src/main/java/org/commonmark/ext/front/matter/internal/YamlFrontMatterBlockParser.java
index f7f03c001..7d14b403b 100644
--- a/commonmark-ext-yaml-front-matter/src/main/java/org/commonmark/ext/front/matter/internal/YamlFrontMatterBlockParser.java
+++ b/commonmark-ext-yaml-front-matter/src/main/java/org/commonmark/ext/front/matter/internal/YamlFrontMatterBlockParser.java
@@ -1,18 +1,18 @@
package org.commonmark.ext.front.matter.internal;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
import org.commonmark.ext.front.matter.YamlFrontMatterBlock;
import org.commonmark.ext.front.matter.YamlFrontMatterNode;
import org.commonmark.node.Block;
import org.commonmark.node.Document;
import org.commonmark.parser.block.*;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-
public class YamlFrontMatterBlockParser extends AbstractBlockParser {
- private static final Pattern REGEX_METADATA = Pattern.compile("^[ ]{0,3}([A-Za-z0-9._-]+):\\s*(.*)");
+ private static final Pattern REGEX_METADATA =
+ Pattern.compile("^[ ]{0,3}([A-Za-z0-9._-]+):\\s*(.*)");
private static final Pattern REGEX_METADATA_LIST = Pattern.compile("^[ ]+-\\s*(.*)");
private static final Pattern REGEX_METADATA_LITERAL = Pattern.compile("^\\s*(.*)");
private static final Pattern REGEX_BEGIN = Pattern.compile("^-{3}(\\s.*)?");
@@ -95,9 +95,7 @@ private static String parseString(String s) {
} else if (s.startsWith("\"") && s.endsWith("\"")) {
String inner = s.substring(1, s.length() - 1);
// Only support escaped `\` and `"`, nothing else.
- return inner
- .replace("\\\"", "\"")
- .replace("\\\\", "\\");
+ return inner.replace("\\\"", "\"").replace("\\\\", "\\");
} else {
return s;
}
@@ -109,9 +107,11 @@ public BlockStart tryStart(ParserState state, MatchedBlockParser matchedBlockPar
CharSequence line = state.getLine().getContent();
BlockParser parentParser = matchedBlockParser.getMatchedBlockParser();
// check whether this line is the first line of whole document or not
- if (parentParser.getBlock() instanceof Document && parentParser.getBlock().getFirstChild() == null &&
- REGEX_BEGIN.matcher(line).matches()) {
- return BlockStart.of(new YamlFrontMatterBlockParser()).atIndex(state.getNextNonSpaceIndex());
+ if (parentParser.getBlock() instanceof Document
+ && parentParser.getBlock().getFirstChild() == null
+ && REGEX_BEGIN.matcher(line).matches()) {
+ return BlockStart.of(new YamlFrontMatterBlockParser())
+ .atIndex(state.getNextNonSpaceIndex());
}
return BlockStart.none();
diff --git a/commonmark-ext-yaml-front-matter/src/test/java/org/commonmark/ext/front/matter/YamlFrontMatterMarkdownRendererTest.java b/commonmark-ext-yaml-front-matter/src/test/java/org/commonmark/ext/front/matter/YamlFrontMatterMarkdownRendererTest.java
index 987513ea4..b5bd06058 100644
--- a/commonmark-ext-yaml-front-matter/src/test/java/org/commonmark/ext/front/matter/YamlFrontMatterMarkdownRendererTest.java
+++ b/commonmark-ext-yaml-front-matter/src/test/java/org/commonmark/ext/front/matter/YamlFrontMatterMarkdownRendererTest.java
@@ -1,5 +1,8 @@
package org.commonmark.ext.front.matter;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.util.List;
import org.commonmark.Extension;
import org.commonmark.node.Document;
import org.commonmark.node.Node;
@@ -9,15 +12,12 @@
import org.commonmark.renderer.markdown.MarkdownRenderer;
import org.junit.jupiter.api.Test;
-import java.util.List;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
public class YamlFrontMatterMarkdownRendererTest {
private static final List EXTENSIONS = List.of(YamlFrontMatterExtension.create());
private static final Parser PARSER = Parser.builder().extensions(EXTENSIONS).build();
- private static final MarkdownRenderer RENDERER = MarkdownRenderer.builder().extensions(EXTENSIONS).build();
+ private static final MarkdownRenderer RENDERER =
+ MarkdownRenderer.builder().extensions(EXTENSIONS).build();
// ===== Round-trip tests (parse string -> render -> compare to input) =====
@@ -43,7 +43,8 @@ public void testRoundTripListValues() {
@Test
public void testRoundTripLiteralBlock() {
- assertRoundTrip("---\ndescription: |\n first line\n second line\n---\n\nMarkdown content\n");
+ assertRoundTrip(
+ "---\ndescription: |\n first line\n second line\n---\n\nMarkdown content\n");
}
@Test
@@ -84,7 +85,9 @@ public void testRoundTripEmptyFrontmatter() {
@Test
public void testProgrammaticallyBuilt() {
- var doc = buildDocumentWithFrontMatter(List.of(new YamlFrontMatterNode("title", List.of("My Document"))));
+ var doc =
+ buildDocumentWithFrontMatter(
+ List.of(new YamlFrontMatterNode("title", List.of("My Document"))));
assertRenderedEquals(doc, "---\ntitle: My Document\n---\n\nMarkdown content\n");
}
@@ -93,29 +96,40 @@ public void testProgrammaticallyBuilt() {
@Test
public void testValueWithColonSpace() {
- var doc = buildDocumentWithFrontMatter(List.of(new YamlFrontMatterNode("key", List.of("value with a: colon inside"))));
+ var doc =
+ buildDocumentWithFrontMatter(
+ List.of(
+ new YamlFrontMatterNode(
+ "key", List.of("value with a: colon inside"))));
- assertRenderedEquals(doc, "---\nkey: 'value with a: colon inside'\n---\n\nMarkdown content\n");
+ assertRenderedEquals(
+ doc, "---\nkey: 'value with a: colon inside'\n---\n\nMarkdown content\n");
}
@Test
public void testValueWithColonNoSpace() {
// Colon without trailing space is fine unquoted (e.g. timestamps, URLs)
- var doc = buildDocumentWithFrontMatter(List.of(new YamlFrontMatterNode("time", List.of("12:30:00"))));
+ var doc =
+ buildDocumentWithFrontMatter(
+ List.of(new YamlFrontMatterNode("time", List.of("12:30:00"))));
assertRenderedEquals(doc, "---\ntime: 12:30:00\n---\n\nMarkdown content\n");
}
@Test
public void testValueStartingWithDash() {
- var doc = buildDocumentWithFrontMatter(List.of(new YamlFrontMatterNode("key", List.of("- not a list"))));
+ var doc =
+ buildDocumentWithFrontMatter(
+ List.of(new YamlFrontMatterNode("key", List.of("- not a list"))));
assertRenderedEquals(doc, "---\nkey: '- not a list'\n---\n\nMarkdown content\n");
}
@Test
public void testValueStartingWithUnmatchedBracket() {
- var doc = buildDocumentWithFrontMatter(List.of(new YamlFrontMatterNode("key", List.of("[broken"))));
+ var doc =
+ buildDocumentWithFrontMatter(
+ List.of(new YamlFrontMatterNode("key", List.of("[broken"))));
assertRenderedEquals(doc, "---\nkey: '[broken'\n---\n\nMarkdown content\n");
}
@@ -123,14 +137,18 @@ public void testValueStartingWithUnmatchedBracket() {
@Test
public void testValueStartingWithMatchedBrackets() {
// Valid flow list - should NOT be quoted
- var doc = buildDocumentWithFrontMatter(List.of(new YamlFrontMatterNode("flowList", List.of("[1, 2, 3]"))));
+ var doc =
+ buildDocumentWithFrontMatter(
+ List.of(new YamlFrontMatterNode("flowList", List.of("[1, 2, 3]"))));
assertRenderedEquals(doc, "---\nflowList: [1, 2, 3]\n---\n\nMarkdown content\n");
}
@Test
public void testValueStartingWithUnmatchedBrace() {
- var doc = buildDocumentWithFrontMatter(List.of(new YamlFrontMatterNode("key", List.of("{broken"))));
+ var doc =
+ buildDocumentWithFrontMatter(
+ List.of(new YamlFrontMatterNode("key", List.of("{broken"))));
assertRenderedEquals(doc, "---\nkey: '{broken'\n---\n\nMarkdown content\n");
}
@@ -138,35 +156,47 @@ public void testValueStartingWithUnmatchedBrace() {
@Test
public void testValueStartingWithMatchedBraces() {
// Valid flow mapping - should NOT be quoted
- var doc = buildDocumentWithFrontMatter(List.of(new YamlFrontMatterNode("flowMapping", List.of("{key: val}"))));
+ var doc =
+ buildDocumentWithFrontMatter(
+ List.of(new YamlFrontMatterNode("flowMapping", List.of("{key: val}"))));
assertRenderedEquals(doc, "---\nflowMapping: {key: val}\n---\n\nMarkdown content\n");
}
@Test
public void testValueContainingHashComment() {
- var doc = buildDocumentWithFrontMatter(List.of(new YamlFrontMatterNode("key", List.of("value # not a comment"))));
+ var doc =
+ buildDocumentWithFrontMatter(
+ List.of(new YamlFrontMatterNode("key", List.of("value # not a comment"))));
assertRenderedEquals(doc, "---\nkey: 'value # not a comment'\n---\n\nMarkdown content\n");
}
@Test
public void testValueContainingApostrophe() {
- var doc = buildDocumentWithFrontMatter(List.of(new YamlFrontMatterNode("key", List.of("it's a test"))));
+ var doc =
+ buildDocumentWithFrontMatter(
+ List.of(new YamlFrontMatterNode("key", List.of("it's a test"))));
assertRenderedEquals(doc, "---\nkey: 'it''s a test'\n---\n\nMarkdown content\n");
}
@Test
public void testEmptyStringValue() {
- var doc = buildDocumentWithFrontMatter(List.of(new YamlFrontMatterNode("empty", List.of(""))));
+ var doc =
+ buildDocumentWithFrontMatter(
+ List.of(new YamlFrontMatterNode("empty", List.of(""))));
assertRenderedEquals(doc, "---\nempty: ''\n---\n\nMarkdown content\n");
}
@Test
public void testValueStartingWithDoubleQuote() {
- var doc = buildDocumentWithFrontMatter(List.of(new YamlFrontMatterNode("key", List.of("\"quotes within value\""))));
+ var doc =
+ buildDocumentWithFrontMatter(
+ List.of(
+ new YamlFrontMatterNode(
+ "key", List.of("\"quotes within value\""))));
assertRenderedEquals(doc, "---\nkey: '\"quotes within value\"'\n---\n\nMarkdown content\n");
}
diff --git a/commonmark-ext-yaml-front-matter/src/test/java/org/commonmark/ext/front/matter/YamlFrontMatterTest.java b/commonmark-ext-yaml-front-matter/src/test/java/org/commonmark/ext/front/matter/YamlFrontMatterTest.java
index e0555dc0a..71da8a936 100644
--- a/commonmark-ext-yaml-front-matter/src/test/java/org/commonmark/ext/front/matter/YamlFrontMatterTest.java
+++ b/commonmark-ext-yaml-front-matter/src/test/java/org/commonmark/ext/front/matter/YamlFrontMatterTest.java
@@ -1,5 +1,10 @@
package org.commonmark.ext.front.matter;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
import org.commonmark.Extension;
import org.commonmark.node.CustomNode;
import org.commonmark.node.Node;
@@ -8,24 +13,15 @@
import org.commonmark.testutil.RenderingTestCase;
import org.junit.jupiter.api.Test;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
public class YamlFrontMatterTest extends RenderingTestCase {
private static final Set EXTENSIONS = Set.of(YamlFrontMatterExtension.create());
private static final Parser PARSER = Parser.builder().extensions(EXTENSIONS).build();
- private static final HtmlRenderer RENDERER = HtmlRenderer.builder().extensions(EXTENSIONS).build();
+ private static final HtmlRenderer RENDERER =
+ HtmlRenderer.builder().extensions(EXTENSIONS).build();
@Test
public void simpleValue() {
- final String input = "---" +
- "\nhello: world" +
- "\n..." +
- "\n" +
- "\ngreat";
+ final String input = "---" + "\nhello: world" + "\n..." + "\n" + "\ngreat";
final String rendered = "
great
\n";
Map> data = getFrontMatter(input);
@@ -40,11 +36,7 @@ public void simpleValue() {
@Test
public void emptyValue() {
- final String input = "---" +
- "\nkey:" +
- "\n---" +
- "\n" +
- "\ngreat";
+ final String input = "---" + "\nkey:" + "\n---" + "\n" + "\ngreat";
final String rendered = "
\n");
// YAML front matter block
m.put("---\nFoo\n---\nBar\n---\nBaz\n", "
Bar
\n
Baz
\n");
@@ -60,5 +75,4 @@ private static Map getOverriddenExamples() {
return m;
}
-
}
diff --git a/commonmark-integration-test/src/test/java/org/commonmark/ui/DingusApp.java b/commonmark-integration-test/src/test/java/org/commonmark/ui/DingusApp.java
index d8132fe25..e7870f411 100644
--- a/commonmark-integration-test/src/test/java/org/commonmark/ui/DingusApp.java
+++ b/commonmark-integration-test/src/test/java/org/commonmark/ui/DingusApp.java
@@ -1,18 +1,17 @@
package org.commonmark.ui;
-import org.commonmark.parser.Parser;
-import org.commonmark.renderer.html.HtmlRenderer;
-import org.commonmark.renderer.text.TextContentRenderer;
-
import java.awt.*;
import javax.swing.*;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
+import org.commonmark.parser.Parser;
+import org.commonmark.renderer.html.HtmlRenderer;
+import org.commonmark.renderer.text.TextContentRenderer;
/**
- * Simple UI to quickly test out different rendering of CommonMark inputs.
- * Similar to commonmark.js dingus.
- **/
+ * Simple UI to quickly test out different rendering of CommonMark inputs. Similar to commonmark.js dingus.
+ */
public class DingusApp {
private final Parser parser = Parser.builder().build();
@@ -57,21 +56,22 @@ private void run() {
input.setLineWrap(true);
input.setFont(new Font(Font.MONOSPACED, Font.PLAIN, 12));
- input.getDocument().addDocumentListener(new DocumentListener() {
- @Override
- public void insertUpdate(DocumentEvent e) {
- updateOutput(input.getText());
- }
+ input.getDocument()
+ .addDocumentListener(
+ new DocumentListener() {
+ @Override
+ public void insertUpdate(DocumentEvent e) {
+ updateOutput(input.getText());
+ }
- @Override
- public void removeUpdate(DocumentEvent e) {
- updateOutput(input.getText());
- }
+ @Override
+ public void removeUpdate(DocumentEvent e) {
+ updateOutput(input.getText());
+ }
- @Override
- public void changedUpdate(DocumentEvent e) {
- }
- });
+ @Override
+ public void changedUpdate(DocumentEvent e) {}
+ });
tabbedPane.addTab("HTML rendered", htmlVisualRendererOutput);
tabbedPane.addTab("HTML source", htmlSourceRendererOutput);
@@ -79,10 +79,11 @@ public void changedUpdate(DocumentEvent e) {
tabbedPane.addChangeListener(e -> updateOutput(input.getText()));
- input.setText("# Example\n" +
- "Enter text *here* and see how it renders on the right.\n\n" +
- "* Try\n* this\n\n" +
- "```\nor this\n```");
+ input.setText(
+ "# Example\n"
+ + "Enter text *here* and see how it renders on the right.\n\n"
+ + "* Try\n* this\n\n"
+ + "```\nor this\n```");
updateOutput(input.getText());
frame.setLayout(new GridLayout());
diff --git a/commonmark-test-util/src/main/java/org/commonmark/testutil/Asserts.java b/commonmark-test-util/src/main/java/org/commonmark/testutil/Asserts.java
index 971a1b4ea..89cfdac38 100644
--- a/commonmark-test-util/src/main/java/org/commonmark/testutil/Asserts.java
+++ b/commonmark-test-util/src/main/java/org/commonmark/testutil/Asserts.java
@@ -3,7 +3,8 @@
import static org.assertj.core.api.Assertions.assertThat;
public class Asserts {
- public static void assertRendering(String source, String expectedRendering, String actualRendering) {
+ public static void assertRendering(
+ String source, String expectedRendering, String actualRendering) {
// include source for better assertion errors
String expected = showTabs(expectedRendering + "\n\n" + source);
String actual = showTabs(actualRendering + "\n\n" + source);
diff --git a/commonmark-test-util/src/main/java/org/commonmark/testutil/SpecTestCase.java b/commonmark-test-util/src/main/java/org/commonmark/testutil/SpecTestCase.java
index d61afbc4a..ca2f85042 100644
--- a/commonmark-test-util/src/main/java/org/commonmark/testutil/SpecTestCase.java
+++ b/commonmark-test-util/src/main/java/org/commonmark/testutil/SpecTestCase.java
@@ -1,19 +1,17 @@
package org.commonmark.testutil;
+import java.util.List;
import org.commonmark.testutil.example.Example;
import org.commonmark.testutil.example.ExampleReader;
import org.junit.jupiter.params.Parameter;
import org.junit.jupiter.params.ParameterizedClass;
import org.junit.jupiter.params.provider.MethodSource;
-import java.util.List;
-
@ParameterizedClass
@MethodSource("data")
public abstract class SpecTestCase {
- @Parameter
- protected Example example;
+ @Parameter protected Example example;
static List data() {
return ExampleReader.readExamples(TestResources.getSpec());
diff --git a/commonmark-test-util/src/main/java/org/commonmark/testutil/TestResources.java b/commonmark-test-util/src/main/java/org/commonmark/testutil/TestResources.java
index 5af649a86..1ef86461e 100644
--- a/commonmark-test-util/src/main/java/org/commonmark/testutil/TestResources.java
+++ b/commonmark-test-util/src/main/java/org/commonmark/testutil/TestResources.java
@@ -20,13 +20,14 @@ public static URL getGfmSpec() {
public static List getRegressions() {
return List.of(
TestResources.class.getResource("/cmark-regression.txt"),
- TestResources.class.getResource("/commonmark.js-regression.txt")
- );
+ TestResources.class.getResource("/commonmark.js-regression.txt"));
}
public static String readAsString(URL url) {
StringBuilder sb = new StringBuilder();
- try (BufferedReader reader = new BufferedReader(new InputStreamReader(url.openStream(), StandardCharsets.UTF_8))) {
+ try (BufferedReader reader =
+ new BufferedReader(
+ new InputStreamReader(url.openStream(), StandardCharsets.UTF_8))) {
String line;
while ((line = reader.readLine()) != null) {
sb.append(line);
diff --git a/commonmark-test-util/src/main/java/org/commonmark/testutil/example/Example.java b/commonmark-test-util/src/main/java/org/commonmark/testutil/example/Example.java
index 11e87d0aa..39c9f1b63 100644
--- a/commonmark-test-util/src/main/java/org/commonmark/testutil/example/Example.java
+++ b/commonmark-test-util/src/main/java/org/commonmark/testutil/example/Example.java
@@ -9,7 +9,13 @@ public class Example {
private final String source;
private final String html;
- public Example(String filename, String section, String info, int exampleNumber, String source, String html) {
+ public Example(
+ String filename,
+ String section,
+ String info,
+ int exampleNumber,
+ String source,
+ String html) {
this.filename = filename;
this.section = section;
this.info = info;
diff --git a/commonmark-test-util/src/main/java/org/commonmark/testutil/example/ExampleReader.java b/commonmark-test-util/src/main/java/org/commonmark/testutil/example/ExampleReader.java
index d40a10f63..b6ba8b9c1 100644
--- a/commonmark-test-util/src/main/java/org/commonmark/testutil/example/ExampleReader.java
+++ b/commonmark-test-util/src/main/java/org/commonmark/testutil/example/ExampleReader.java
@@ -10,7 +10,8 @@
import java.util.stream.Collectors;
/**
- * Reader for files containing examples of CommonMark source and the expected HTML rendering (e.g. spec.txt).
+ * Reader for files containing examples of CommonMark source and the expected HTML rendering (e.g.
+ * spec.txt).
*/
public class ExampleReader {
@@ -45,11 +46,15 @@ public static List readExamples(URL url) {
public static List readExamples(URL url, String info) {
var examples = readExamples(url);
- return examples.stream().filter(e -> e.getInfo().contains(info)).collect(Collectors.toList());
+ return examples.stream()
+ .filter(e -> e.getInfo().contains(info))
+ .collect(Collectors.toList());
}
public static List readExampleObjects(URL url, String info) {
- return readExamples(url, info).stream().map(e -> new Object[]{e}).collect(Collectors.toList());
+ return readExamples(url, info).stream()
+ .map(e -> new Object[] {e})
+ .collect(Collectors.toList());
}
public static List readExampleSources(URL url) {
@@ -64,8 +69,8 @@ public static List readExampleSources(URL url) {
private List read() throws IOException {
resetContents();
- try (BufferedReader reader = new BufferedReader(
- new InputStreamReader(inputStream, StandardCharsets.UTF_8))) {
+ try (BufferedReader reader =
+ new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8))) {
String line;
while ((line = reader.readLine()) != null) {
processLine(line);
@@ -101,8 +106,15 @@ private void processLine(String line) {
case HTML:
if (line.equals("````````````````````````````````")) {
state = State.BEFORE;
- examples.add(new Example(filename, section, info, exampleNumber,
- source.toString(), html.toString()));
+ var example =
+ new Example(
+ filename,
+ section,
+ info,
+ exampleNumber,
+ source.toString(),
+ html.toString());
+ examples.add(example);
resetContents();
} else {
html.append(line).append('\n');
@@ -117,6 +129,8 @@ private void resetContents() {
}
private enum State {
- BEFORE, SOURCE, HTML
+ BEFORE,
+ SOURCE,
+ HTML
}
}
diff --git a/commonmark/src/main/java/org/commonmark/Extension.java b/commonmark/src/main/java/org/commonmark/Extension.java
index b0e37456e..d233ca3f4 100644
--- a/commonmark/src/main/java/org/commonmark/Extension.java
+++ b/commonmark/src/main/java/org/commonmark/Extension.java
@@ -2,10 +2,9 @@
/**
* Base interface for a parser/renderer extension.
- *
- * Doesn't have any methods itself, but has specific sub interfaces to
- * configure parser/renderer. This base interface is for convenience, so that a list of extensions can be built and then
- * used for configuring both the parser and renderer in the same way.
+ *
+ *
Doesn't have any methods itself, but has specific sub interfaces to configure parser/renderer.
+ * This base interface is for convenience, so that a list of extensions can be built and then used
+ * for configuring both the parser and renderer in the same way.
*/
-public interface Extension {
-}
+public interface Extension {}
diff --git a/commonmark/src/main/java/org/commonmark/internal/BlockContent.java b/commonmark/src/main/java/org/commonmark/internal/BlockContent.java
index 9a9ce6f44..aa9306280 100644
--- a/commonmark/src/main/java/org/commonmark/internal/BlockContent.java
+++ b/commonmark/src/main/java/org/commonmark/internal/BlockContent.java
@@ -25,5 +25,4 @@ public void add(CharSequence line) {
public String getString() {
return sb.toString();
}
-
}
diff --git a/commonmark/src/main/java/org/commonmark/internal/BlockContinueImpl.java b/commonmark/src/main/java/org/commonmark/internal/BlockContinueImpl.java
index 6410c2c2d..c34562933 100644
--- a/commonmark/src/main/java/org/commonmark/internal/BlockContinueImpl.java
+++ b/commonmark/src/main/java/org/commonmark/internal/BlockContinueImpl.java
@@ -25,5 +25,4 @@ public int getNewColumn() {
public boolean isFinalize() {
return finalize;
}
-
}
diff --git a/commonmark/src/main/java/org/commonmark/internal/BlockQuoteParser.java b/commonmark/src/main/java/org/commonmark/internal/BlockQuoteParser.java
index 572c491f8..b3f473527 100644
--- a/commonmark/src/main/java/org/commonmark/internal/BlockQuoteParser.java
+++ b/commonmark/src/main/java/org/commonmark/internal/BlockQuoteParser.java
@@ -42,7 +42,9 @@ public BlockContinue tryContinue(ParserState state) {
private static boolean isMarker(ParserState state, int index) {
CharSequence line = state.getLine().getContent();
- return state.getIndent() < Parsing.CODE_BLOCK_INDENT && index < line.length() && line.charAt(index) == '>';
+ return state.getIndent() < Parsing.CODE_BLOCK_INDENT
+ && index < line.length()
+ && line.charAt(index) == '>';
}
public static class Factory extends AbstractBlockParserFactory {
diff --git a/commonmark/src/main/java/org/commonmark/internal/Bracket.java b/commonmark/src/main/java/org/commonmark/internal/Bracket.java
index c04b6ecda..b4dbb0e9a 100644
--- a/commonmark/src/main/java/org/commonmark/internal/Bracket.java
+++ b/commonmark/src/main/java/org/commonmark/internal/Bracket.java
@@ -3,65 +3,81 @@
import org.commonmark.node.Text;
import org.commonmark.parser.beta.Position;
-/**
- * Opening bracket for links ({@code [}), images ({@code ![}), or links with other markers.
- */
+/** Opening bracket for links ({@code [}), images ({@code ![}), or links with other markers. */
public class Bracket {
- /**
- * The node of a marker such as {@code !} if present, null otherwise.
- */
+ /** The node of a marker such as {@code !} if present, null otherwise. */
public final Text markerNode;
- /**
- * The position of the marker if present, null otherwise.
- */
+ /** The position of the marker if present, null otherwise. */
public final Position markerPosition;
- /**
- * The node of {@code [}.
- */
+ /** The node of {@code [}. */
public final Text bracketNode;
- /**
- * The position of {@code [}.
- */
+ /** The position of {@code [}. */
public final Position bracketPosition;
- /**
- * The position of the content (after the opening bracket)
- */
+ /** The position of the content (after the opening bracket) */
public final Position contentPosition;
- /**
- * Previous bracket.
- */
+ /** Previous bracket. */
public final Bracket previous;
- /**
- * Previous delimiter (emphasis, etc) before this bracket.
- */
+ /** Previous delimiter (emphasis, etc) before this bracket. */
public final Delimiter previousDelimiter;
- /**
- * Whether this bracket is allowed to form a link/image (also known as "active").
- */
+ /** Whether this bracket is allowed to form a link/image (also known as "active"). */
public boolean allowed = true;
/**
- * Whether there is an unescaped bracket (opening or closing) after this opening bracket in the text parsed so far.
+ * Whether there is an unescaped bracket (opening or closing) after this opening bracket in the
+ * text parsed so far.
*/
public boolean bracketAfter = false;
- static public Bracket link(Text bracketNode, Position bracketPosition, Position contentPosition, Bracket previous, Delimiter previousDelimiter) {
- return new Bracket(null, null, bracketNode, bracketPosition, contentPosition, previous, previousDelimiter);
+ public static Bracket link(
+ Text bracketNode,
+ Position bracketPosition,
+ Position contentPosition,
+ Bracket previous,
+ Delimiter previousDelimiter) {
+ return new Bracket(
+ null,
+ null,
+ bracketNode,
+ bracketPosition,
+ contentPosition,
+ previous,
+ previousDelimiter);
}
- static public Bracket withMarker(Text markerNode, Position markerPosition, Text bracketNode, Position bracketPosition, Position contentPosition, Bracket previous, Delimiter previousDelimiter) {
- return new Bracket(markerNode, markerPosition, bracketNode, bracketPosition, contentPosition, previous, previousDelimiter);
+ public static Bracket withMarker(
+ Text markerNode,
+ Position markerPosition,
+ Text bracketNode,
+ Position bracketPosition,
+ Position contentPosition,
+ Bracket previous,
+ Delimiter previousDelimiter) {
+ return new Bracket(
+ markerNode,
+ markerPosition,
+ bracketNode,
+ bracketPosition,
+ contentPosition,
+ previous,
+ previousDelimiter);
}
- private Bracket(Text markerNode, Position markerPosition, Text bracketNode, Position bracketPosition, Position contentPosition, Bracket previous, Delimiter previousDelimiter) {
+ private Bracket(
+ Text markerNode,
+ Position markerPosition,
+ Text bracketNode,
+ Position bracketPosition,
+ Position contentPosition,
+ Bracket previous,
+ Delimiter previousDelimiter) {
this.markerNode = markerNode;
this.markerPosition = markerPosition;
this.bracketNode = bracketNode;
diff --git a/commonmark/src/main/java/org/commonmark/internal/Definitions.java b/commonmark/src/main/java/org/commonmark/internal/Definitions.java
index 0377842c9..ad77ef6dc 100644
--- a/commonmark/src/main/java/org/commonmark/internal/Definitions.java
+++ b/commonmark/src/main/java/org/commonmark/internal/Definitions.java
@@ -1,9 +1,8 @@
package org.commonmark.internal;
-import org.commonmark.node.DefinitionMap;
-
import java.util.HashMap;
import java.util.Map;
+import org.commonmark.node.DefinitionMap;
public class Definitions {
diff --git a/commonmark/src/main/java/org/commonmark/internal/Delimiter.java b/commonmark/src/main/java/org/commonmark/internal/Delimiter.java
index 9083ce3cb..e652e373d 100644
--- a/commonmark/src/main/java/org/commonmark/internal/Delimiter.java
+++ b/commonmark/src/main/java/org/commonmark/internal/Delimiter.java
@@ -1,13 +1,10 @@
package org.commonmark.internal;
+import java.util.List;
import org.commonmark.node.Text;
import org.commonmark.parser.delimiter.DelimiterRun;
-import java.util.List;
-
-/**
- * Delimiter (emphasis, strong emphasis or custom emphasis).
- */
+/** Delimiter (emphasis, strong emphasis or custom emphasis). */
public class Delimiter implements DelimiterRun {
public final List characters;
@@ -23,7 +20,12 @@ public class Delimiter implements DelimiterRun {
public Delimiter previous;
public Delimiter next;
- public Delimiter(List characters, char delimiterChar, boolean canOpen, boolean canClose, Delimiter previous) {
+ public Delimiter(
+ List characters,
+ char delimiterChar,
+ boolean canOpen,
+ boolean canClose,
+ Delimiter previous) {
this.characters = characters;
this.delimiterChar = delimiterChar;
this.canOpen = canOpen;
@@ -65,7 +67,8 @@ public Text getCloser() {
@Override
public Iterable getOpeners(int length) {
if (!(length >= 1 && length <= length())) {
- throw new IllegalArgumentException("length must be between 1 and " + length() + ", was " + length);
+ throw new IllegalArgumentException(
+ "length must be between 1 and " + length() + ", was " + length);
}
return characters.subList(characters.size() - length, characters.size());
@@ -74,7 +77,8 @@ public Iterable getOpeners(int length) {
@Override
public Iterable getClosers(int length) {
if (!(length >= 1 && length <= length())) {
- throw new IllegalArgumentException("length must be between 1 and " + length() + ", was " + length);
+ throw new IllegalArgumentException(
+ "length must be between 1 and " + length() + ", was " + length);
}
return characters.subList(0, length);
diff --git a/commonmark/src/main/java/org/commonmark/internal/DocumentBlockParser.java b/commonmark/src/main/java/org/commonmark/internal/DocumentBlockParser.java
index 4b51275ee..2d52c5080 100644
--- a/commonmark/src/main/java/org/commonmark/internal/DocumentBlockParser.java
+++ b/commonmark/src/main/java/org/commonmark/internal/DocumentBlockParser.java
@@ -29,5 +29,4 @@ public Document getBlock() {
public BlockContinue tryContinue(ParserState state) {
return BlockContinue.atIndex(state.getIndex());
}
-
}
diff --git a/commonmark/src/main/java/org/commonmark/internal/DocumentParser.java b/commonmark/src/main/java/org/commonmark/internal/DocumentParser.java
index 17e7b9c84..6565cec4f 100644
--- a/commonmark/src/main/java/org/commonmark/internal/DocumentParser.java
+++ b/commonmark/src/main/java/org/commonmark/internal/DocumentParser.java
@@ -1,5 +1,8 @@
package org.commonmark.internal;
+import java.io.IOException;
+import java.io.Reader;
+import java.util.*;
import org.commonmark.internal.util.LineReader;
import org.commonmark.internal.util.Parsing;
import org.commonmark.node.*;
@@ -7,26 +10,24 @@
import org.commonmark.parser.InlineParserFactory;
import org.commonmark.parser.SourceLine;
import org.commonmark.parser.SourceLines;
-import org.commonmark.parser.beta.LinkProcessor;
import org.commonmark.parser.beta.InlineContentParserFactory;
+import org.commonmark.parser.beta.LinkProcessor;
import org.commonmark.parser.block.*;
import org.commonmark.parser.delimiter.DelimiterProcessor;
import org.commonmark.text.Characters;
-import java.io.IOException;
-import java.io.Reader;
-import java.util.*;
-
public class DocumentParser implements ParserState {
- private static final Set> CORE_FACTORY_TYPES = new LinkedHashSet<>(List.of(
- BlockQuote.class,
- Heading.class,
- FencedCodeBlock.class,
- HtmlBlock.class,
- ThematicBreak.class,
- ListBlock.class,
- IndentedCodeBlock.class));
+ private static final Set> CORE_FACTORY_TYPES =
+ new LinkedHashSet<>(
+ List.of(
+ BlockQuote.class,
+ Heading.class,
+ FencedCodeBlock.class,
+ HtmlBlock.class,
+ ThematicBreak.class,
+ ListBlock.class,
+ IndentedCodeBlock.class));
private static final Map, BlockParserFactory> NODES_TO_CORE_FACTORIES;
@@ -44,24 +45,16 @@ public class DocumentParser implements ParserState {
private SourceLine line;
- /**
- * Line index (0-based)
- */
+ /** Line index (0-based) */
private int lineIndex = -1;
- /**
- * current index (offset) in input line (0-based)
- */
+ /** current index (offset) in input line (0-based) */
private int index = 0;
- /**
- * current column of input line (tab causes column to go to next 4-space tab stop) (0-based)
- */
+ /** current column of input line (tab causes column to go to next 4-space tab stop) (0-based) */
private int column = 0;
- /**
- * if the current column is within a tab character (partially consumed tab)
- */
+ /** if the current column is within a tab character (partially consumed tab) */
private boolean columnIsInTab;
private int nextNonSpace = 0;
@@ -83,10 +76,15 @@ public class DocumentParser implements ParserState {
private final List openBlockParsers = new ArrayList<>();
private final List allBlockParsers = new ArrayList<>();
- public DocumentParser(List blockParserFactories, InlineParserFactory inlineParserFactory,
- List inlineContentParserFactories, List delimiterProcessors,
- List linkProcessors, Set linkMarkers,
- IncludeSourceSpans includeSourceSpans, int maxOpenBlockParsers) {
+ public DocumentParser(
+ List blockParserFactories,
+ InlineParserFactory inlineParserFactory,
+ List inlineContentParserFactories,
+ List delimiterProcessors,
+ List linkProcessors,
+ Set linkMarkers,
+ IncludeSourceSpans includeSourceSpans,
+ int maxOpenBlockParsers) {
this.blockParserFactories = blockParserFactories;
this.inlineParserFactory = inlineParserFactory;
this.inlineContentParserFactories = inlineContentParserFactories;
@@ -104,8 +102,11 @@ public static Set> getDefaultBlockParserTypes() {
return CORE_FACTORY_TYPES;
}
- public static List calculateBlockParserFactories(List customBlockParserFactories, Set> enabledBlockTypes) {
- // By having the custom factories come first, extensions are able to change behavior of core syntax.
+ public static List calculateBlockParserFactories(
+ List customBlockParserFactories,
+ Set> enabledBlockTypes) {
+ // By having the custom factories come first, extensions are able to change behavior of core
+ // syntax.
List list = new ArrayList<>(customBlockParserFactories);
for (Class blockType : enabledBlockTypes) {
list.add(NODES_TO_CORE_FACTORIES.get(blockType));
@@ -116,21 +117,25 @@ public static List calculateBlockParserFactories(List> enabledBlockTypes) {
for (Class enabledBlockType : enabledBlockTypes) {
if (!NODES_TO_CORE_FACTORIES.containsKey(enabledBlockType)) {
- throw new IllegalArgumentException("Can't enable block type " + enabledBlockType + ", possible options are: " + NODES_TO_CORE_FACTORIES.keySet());
+ throw new IllegalArgumentException(
+ "Can't enable block type "
+ + enabledBlockType
+ + ", possible options are: "
+ + NODES_TO_CORE_FACTORIES.keySet());
}
}
}
- /**
- * The main parsing function. Returns a parsed document AST.
- */
+ /** The main parsing function. Returns a parsed document AST. */
public Document parse(String input) {
int lineStart = 0;
int lineBreak;
while ((lineBreak = Characters.findLineBreak(input, lineStart)) != -1) {
String line = input.substring(lineStart, lineBreak);
parseLine(line, lineStart);
- if (lineBreak + 1 < input.length() && input.charAt(lineBreak) == '\r' && input.charAt(lineBreak + 1) == '\n') {
+ if (lineBreak + 1 < input.length()
+ && input.charAt(lineBreak) == '\r'
+ && input.charAt(lineBreak + 1) == '\n') {
lineStart = lineBreak + 2;
} else {
lineStart = lineBreak + 1;
@@ -196,14 +201,15 @@ public BlockParser getActiveBlockParser() {
}
/**
- * Analyze a line of text and update the document appropriately. We parse markdown text by calling this on each
- * line of input, then finalizing the document.
+ * Analyze a line of text and update the document appropriately. We parse markdown text by
+ * calling this on each line of input, then finalizing the document.
*/
private void parseLine(String ln, int inputIndex) {
setLine(ln, inputIndex);
// For each containing block, try to parse the associated line start.
- // The document will always match, so we can skip the first block parser and start at 1 matches
+ // The document will always match, so we can skip the first block parser and start at 1
+ // matches
int matches = 1;
for (int i = 1; i < openBlockParsers.size(); i++) {
OpenBlockParser openBlockParser = openBlockParsers.get(i);
@@ -239,13 +245,16 @@ private void parseLine(String ln, int inputIndex) {
// Unless last matched container is a code block, try new container starts,
// adding children to the last matched container:
- boolean tryBlockStarts = blockParser.getBlock() instanceof Paragraph || blockParser.isContainer();
+ boolean tryBlockStarts =
+ blockParser.getBlock() instanceof Paragraph || blockParser.isContainer();
while (tryBlockStarts) {
lastIndex = index;
findNextNonSpace();
// this is a little performance optimization:
- if (isBlank() || (indent < Parsing.CODE_BLOCK_INDENT && Characters.isLetter(this.line.getContent(), nextNonSpace))) {
+ if (isBlank()
+ || (indent < Parsing.CODE_BLOCK_INDENT
+ && Characters.isLetter(this.line.getContent(), nextNonSpace))) {
setNewIndex(nextNonSpace);
break;
}
@@ -259,7 +268,8 @@ private void parseLine(String ln, int inputIndex) {
startedNewBlock = true;
int sourceIndex = getIndex();
- // We're starting a new block. If we have any previous blocks that need to be closed, we need to do it now.
+ // We're starting a new block. If we have any previous blocks that need to be closed, we
+ // need to do it now.
if (unmatchedBlocks > 0) {
closeBlockParsers(unmatchedBlocks);
unmatchedBlocks = 0;
@@ -272,11 +282,15 @@ private void parseLine(String ln, int inputIndex) {
}
List replacedSourceSpans = null;
- if (blockStart.getReplaceParagraphLines() >= 1 || blockStart.isReplaceActiveBlockParser()) {
+ if (blockStart.getReplaceParagraphLines() >= 1
+ || blockStart.isReplaceActiveBlockParser()) {
var activeBlockParser = getActiveBlockParser();
if (activeBlockParser instanceof ParagraphParser) {
var paragraphParser = (ParagraphParser) activeBlockParser;
- var lines = blockStart.isReplaceActiveBlockParser() ? Integer.MAX_VALUE : blockStart.getReplaceParagraphLines();
+ var lines =
+ blockStart.isReplaceActiveBlockParser()
+ ? Integer.MAX_VALUE
+ : blockStart.getReplaceParagraphLines();
replacedSourceSpans = replaceParagraphLines(lines, paragraphParser);
} else if (blockStart.isReplaceActiveBlockParser()) {
replacedSourceSpans = prepareActiveBlockParserForReplacement(activeBlockParser);
@@ -297,8 +311,9 @@ private void parseLine(String ln, int inputIndex) {
// appropriate block.
// First check for a lazy continuation line
- if (!startedNewBlock && !isBlank() &&
- getActiveBlockParser().canHaveLazyContinuationLines()) {
+ if (!startedNewBlock
+ && !isBlank()
+ && getActiveBlockParser().canHaveLazyContinuationLines()) {
openBlockParsers.get(openBlockParsers.size() - 1).sourceIndex = lastIndex;
// lazy paragraph continuation
addLine();
@@ -324,7 +339,8 @@ private void parseLine(String ln, int inputIndex) {
// list item
// ```
//
- // The first line does not start a paragraph yet, but we still want to record source positions.
+ // The first line does not start a paragraph yet, but we still want to record source
+ // positions.
addSourceSpans();
}
}
@@ -416,13 +432,14 @@ private void advance() {
}
/**
- * Add line content to the active block parser. We assume it can accept lines -- that check should be done before
- * calling this.
+ * Add line content to the active block parser. We assume it can accept lines -- that check
+ * should be done before calling this.
*/
private void addLine() {
CharSequence content;
if (columnIsInTab) {
- // Our column is in a partially consumed tab. Expand the remaining columns (to the next tab stop) to spaces.
+ // Our column is in a partially consumed tab. Expand the remaining columns (to the next
+ // tab stop) to spaces.
int afterTab = index + 1;
CharSequence rest = line.getContent().subSequence(afterTab, line.getContent().length());
int spaces = Parsing.columnsToNextTabStop(column);
@@ -438,8 +455,10 @@ private void addLine() {
content = line.getContent().subSequence(index, line.getContent().length());
}
SourceSpan sourceSpan = null;
- if (includeSourceSpans == IncludeSourceSpans.BLOCKS_AND_INLINES && index < line.getSourceSpan().getLength()) {
- // Note that if we're in a partially-consumed tab the length of the source span and the content don't match.
+ if (includeSourceSpans == IncludeSourceSpans.BLOCKS_AND_INLINES
+ && index < line.getSourceSpan().getLength()) {
+ // Note that if we're in a partially-consumed tab the length of the source span and the
+ // content don't match.
sourceSpan = line.getSourceSpan().subSpan(index);
}
getActiveBlockParser().addLine(SourceLine.of(content, sourceSpan));
@@ -448,15 +467,17 @@ private void addLine() {
private void addSourceSpans() {
if (includeSourceSpans != IncludeSourceSpans.NONE) {
- // Don't add source spans for Document itself (it would get the whole source text), so start at 1, not 0
+ // Don't add source spans for Document itself (it would get the whole source text), so
+ // start at 1, not 0
for (int i = 1; i < openBlockParsers.size(); i++) {
var openBlockParser = openBlockParsers.get(i);
- // In case of a lazy continuation line, the index is less than where the block parser would expect the
- // contents to start, so let's use whichever is smaller.
+ // In case of a lazy continuation line, the index is less than where the block
+ // parser would expect the contents to start, so let's use whichever is smaller.
int blockIndex = Math.min(openBlockParser.sourceIndex, index);
int length = line.getContent().length() - blockIndex;
if (length != 0) {
- openBlockParser.blockParser.addSourceSpan(line.getSourceSpan().subSpan(blockIndex));
+ openBlockParser.blockParser.addSourceSpan(
+ line.getSourceSpan().subSpan(blockIndex));
}
}
}
@@ -477,10 +498,17 @@ private BlockStartImpl findBlockStart(BlockParser blockParser) {
}
/**
- * Walk through a block & children recursively, parsing string content into inline content where appropriate.
+ * Walk through a block & children recursively, parsing string content into inline content where
+ * appropriate.
*/
private void processInlines() {
- var context = new InlineParserContextImpl(inlineContentParserFactories, delimiterProcessors, linkProcessors, linkMarkers, definitions);
+ var context =
+ new InlineParserContextImpl(
+ inlineContentParserFactories,
+ delimiterProcessors,
+ linkProcessors,
+ linkMarkers,
+ definitions);
var inlineParser = inlineParserFactory.create(context);
for (var blockParser : allBlockParsers) {
@@ -489,8 +517,8 @@ private void processInlines() {
}
/**
- * Add block of type tag as a child of the tip. If the tip can't accept children, close and finalize it and try
- * its parent, and so on until we find a block that can accept children.
+ * Add block of type tag as a child of the tip. If the tip can't accept children, close and
+ * finalize it and try its parent, and so on until we find a block that can accept children.
*/
private void addChild(OpenBlockParser openBlockParser) {
while (!getActiveBlockParser().canContain(openBlockParser.blockParser.getBlock())) {
@@ -522,7 +550,8 @@ private List prepareActiveBlockParserForReplacement(BlockParser bloc
// Note that we don't want to parse inlines here, as it's getting replaced.
deactivateBlockParser();
- // Do this so that source positions are calculated, which we will carry over to the replacing block.
+ // Do this so that source positions are calculated, which we will carry over to the
+ // replacing block.
blockParser.closeBlock();
blockParser.getBlock().unlink();
return blockParser.getBlock().getSourceSpans();
@@ -538,16 +567,16 @@ private void closeBlockParsers(int count) {
for (int i = 0; i < count; i++) {
BlockParser blockParser = deactivateBlockParser().blockParser;
finalize(blockParser);
- // Remember for inline parsing. Note that a lot of blocks don't need inline parsing. We could have a
- // separate interface (e.g. BlockParserWithInlines) so that we only have to remember those that actually
- // have inlines to parse.
+ // Remember for inline parsing. Note that a lot of blocks don't need inline parsing. We
+ // could have a separate interface (e.g. BlockParserWithInlines) so that we only have to
+ // remember those that actually have inlines to parse.
allBlockParsers.add(blockParser);
}
}
/**
- * Finalize a block. Close it and do any necessary postprocessing, e.g. setting the content of blocks and
- * collecting link reference definitions from paragraphs.
+ * Finalize a block. Close it and do any necessary postprocessing, e.g. setting the content of
+ * blocks and collecting link reference definitions from paragraphs.
*/
private void finalize(BlockParser blockParser) {
addDefinitionsFrom(blockParser);
@@ -560,9 +589,7 @@ private void addDefinitionsFrom(BlockParser blockParser) {
}
}
- /**
- * Prepares the input line replacing {@code \0}
- */
+ /** Prepares the input line replacing {@code \0} */
private static String prepareLine(String line) {
if (line.indexOf('\0') == -1) {
return line;
diff --git a/commonmark/src/main/java/org/commonmark/internal/FencedCodeBlockParser.java b/commonmark/src/main/java/org/commonmark/internal/FencedCodeBlockParser.java
index d550f1d25..042e08f6b 100644
--- a/commonmark/src/main/java/org/commonmark/internal/FencedCodeBlockParser.java
+++ b/commonmark/src/main/java/org/commonmark/internal/FencedCodeBlockParser.java
@@ -1,5 +1,7 @@
package org.commonmark.internal;
+import static org.commonmark.internal.util.Escaping.unescapeString;
+
import org.commonmark.internal.util.Parsing;
import org.commonmark.node.Block;
import org.commonmark.node.FencedCodeBlock;
@@ -7,8 +9,6 @@
import org.commonmark.parser.block.*;
import org.commonmark.text.Characters;
-import static org.commonmark.internal.util.Escaping.unescapeString;
-
public class FencedCodeBlockParser extends AbstractBlockParser {
private final FencedCodeBlock block = new FencedCodeBlock();
@@ -36,7 +36,9 @@ public BlockContinue tryContinue(ParserState state) {
int nextNonSpace = state.getNextNonSpaceIndex();
int newIndex = state.getIndex();
CharSequence line = state.getLine().getContent();
- if (state.getIndent() < Parsing.CODE_BLOCK_INDENT && nextNonSpace < line.length() && tryClosing(line, nextNonSpace)) {
+ if (state.getIndent() < Parsing.CODE_BLOCK_INDENT
+ && nextNonSpace < line.length()
+ && tryClosing(line, nextNonSpace)) {
// closing fence - we're at end of line, so we can finalize now
return BlockContinue.finished();
} else {
@@ -78,17 +80,19 @@ public BlockStart tryStart(ParserState state, MatchedBlockParser matchedBlockPar
}
int nextNonSpace = state.getNextNonSpaceIndex();
- FencedCodeBlockParser blockParser = checkOpener(state.getLine().getContent(), nextNonSpace, indent);
+ FencedCodeBlockParser blockParser =
+ checkOpener(state.getLine().getContent(), nextNonSpace, indent);
if (blockParser != null) {
- return BlockStart.of(blockParser).atIndex(nextNonSpace + blockParser.block.getOpeningFenceLength());
+ return BlockStart.of(blockParser)
+ .atIndex(nextNonSpace + blockParser.block.getOpeningFenceLength());
} else {
return BlockStart.none();
}
}
}
- // spec: A code fence is a sequence of at least three consecutive backtick characters (`) or tildes (~). (Tildes and
- // backticks cannot be mixed.)
+ // spec: A code fence is a sequence of at least three consecutive backtick characters (`) or
+ // tildes (~). (Tildes and backticks cannot be mixed.)
private static FencedCodeBlockParser checkOpener(CharSequence line, int index, int indent) {
int backticks = 0;
int tildes = 0;
@@ -107,7 +111,8 @@ private static FencedCodeBlockParser checkOpener(CharSequence line, int index, i
}
}
if (backticks >= 3 && tildes == 0) {
- // spec: If the info string comes after a backtick fence, it may not contain any backtick characters.
+ // spec: If the info string comes after a backtick fence, it may not contain any
+ // backtick characters.
if (Characters.find('`', line, index + backticks) != -1) {
return null;
}
@@ -120,8 +125,9 @@ private static FencedCodeBlockParser checkOpener(CharSequence line, int index, i
}
}
- // spec: The content of the code block consists of all subsequent lines, until a closing code fence of the same type
- // as the code block began with (backticks or tildes), and with at least as many backticks or tildes as the opening
+ // spec: The content of the code block consists of all subsequent lines, until a closing code
+ // fence of the same type as the code block began with (backticks or tildes), and with at least
+ // as many backticks or tildes as the opening
// code fence.
private boolean tryClosing(CharSequence line, int index) {
int fences = Characters.skip(fenceChar, line, index, line.length()) - index;
diff --git a/commonmark/src/main/java/org/commonmark/internal/HeadingParser.java b/commonmark/src/main/java/org/commonmark/internal/HeadingParser.java
index 05f070137..402647e0f 100644
--- a/commonmark/src/main/java/org/commonmark/internal/HeadingParser.java
+++ b/commonmark/src/main/java/org/commonmark/internal/HeadingParser.java
@@ -28,7 +28,8 @@ public Block getBlock() {
@Override
public BlockContinue tryContinue(ParserState parserState) {
- // In both ATX and Setext headings, once we have the heading markup, there's nothing more to parse.
+ // In both ATX and Setext headings, once we have the heading markup, there's nothing more to
+ // parse.
return BlockContinue.none();
}
@@ -48,7 +49,8 @@ public BlockStart tryStart(ParserState state, MatchedBlockParser matchedBlockPar
SourceLine line = state.getLine();
int nextNonSpace = state.getNextNonSpaceIndex();
if (line.getContent().charAt(nextNonSpace) == '#') {
- HeadingParser atxHeading = getAtxHeading(line.substring(nextNonSpace, line.getContent().length()));
+ HeadingParser atxHeading =
+ getAtxHeading(line.substring(nextNonSpace, line.getContent().length()));
if (atxHeading != null) {
return BlockStart.of(atxHeading).atIndex(line.getContent().length());
}
@@ -68,10 +70,11 @@ public BlockStart tryStart(ParserState state, MatchedBlockParser matchedBlockPar
}
}
- // spec: An ATX heading consists of a string of characters, parsed as inline content, between an opening sequence of
- // 1-6 unescaped # characters and an optional closing sequence of any number of unescaped # characters. The opening
- // sequence of # characters must be followed by a space or by the end of line. The optional closing sequence of #s
- // must be preceded by a space and may be followed by spaces only.
+ // spec: An ATX heading consists of a string of characters, parsed as inline content, between an
+ // opening sequence of 1-6 unescaped # characters and an optional closing sequence of any number
+ // of unescaped # characters. The opening sequence of # characters must be followed by a space
+ // or by the end of line. The optional closing sequence of #s must be preceded by a space and
+ // may be followed by spaces only.
private static HeadingParser getAtxHeading(SourceLine line) {
Scanner scanner = Scanner.of(SourceLines.of(line));
int level = scanner.matchMultiple('#');
@@ -102,7 +105,8 @@ private static HeadingParser getAtxHeading(SourceLine line) {
if (hashCanEnd) {
scanner.matchMultiple('#');
int whitespace = scanner.whitespace();
- // If there's other characters, the hashes and spaces were part of the heading
+ // If there's other characters, the hashes and spaces were part of the
+ // heading
if (scanner.hasNext()) {
end = scanner.position();
}
@@ -132,8 +136,8 @@ private static HeadingParser getAtxHeading(SourceLine line) {
return new HeadingParser(level, source);
}
- // spec: A setext heading underline is a sequence of = characters or a sequence of - characters, with no more than
- // 3 spaces indentation and any number of trailing spaces.
+ // spec: A setext heading underline is a sequence of = characters or a sequence of - characters,
+ // with no more than 3 spaces indentation and any number of trailing spaces.
private static int getSetextHeadingLevel(CharSequence line, int index) {
switch (line.charAt(index)) {
case '=':
diff --git a/commonmark/src/main/java/org/commonmark/internal/HtmlBlockParser.java b/commonmark/src/main/java/org/commonmark/internal/HtmlBlockParser.java
index 123d9ec1f..68848de6b 100644
--- a/commonmark/src/main/java/org/commonmark/internal/HtmlBlockParser.java
+++ b/commonmark/src/main/java/org/commonmark/internal/HtmlBlockParser.java
@@ -1,13 +1,12 @@
package org.commonmark.internal;
+import java.util.regex.Pattern;
import org.commonmark.node.Block;
import org.commonmark.node.HtmlBlock;
import org.commonmark.node.Paragraph;
import org.commonmark.parser.SourceLine;
import org.commonmark.parser.block.*;
-import java.util.regex.Pattern;
-
public class HtmlBlockParser extends AbstractBlockParser {
private static final String TAGNAME = "[A-Za-z][A-Za-z0-9-]*";
@@ -15,63 +14,56 @@ public class HtmlBlockParser extends AbstractBlockParser {
private static final String UNQUOTEDVALUE = "[^\"'=<>`\\x00-\\x20]+";
private static final String SINGLEQUOTEDVALUE = "'[^']*'";
private static final String DOUBLEQUOTEDVALUE = "\"[^\"]*\"";
- private static final String ATTRIBUTEVALUE = "(?:" + UNQUOTEDVALUE + "|" + SINGLEQUOTEDVALUE
- + "|" + DOUBLEQUOTEDVALUE + ")";
- private static final String ATTRIBUTEVALUESPEC = "(?:" + "\\s*=" + "\\s*" + ATTRIBUTEVALUE
- + ")";
- private static final String ATTRIBUTE = "(?:" + "\\s+" + ATTRIBUTENAME + ATTRIBUTEVALUESPEC
- + "?)";
+ private static final String ATTRIBUTEVALUE =
+ "(?:" + UNQUOTEDVALUE + "|" + SINGLEQUOTEDVALUE + "|" + DOUBLEQUOTEDVALUE + ")";
+ private static final String ATTRIBUTEVALUESPEC =
+ "(?:" + "\\s*=" + "\\s*" + ATTRIBUTEVALUE + ")";
+ private static final String ATTRIBUTE =
+ "(?:" + "\\s+" + ATTRIBUTENAME + ATTRIBUTEVALUESPEC + "?)";
private static final String OPENTAG = "<" + TAGNAME + ATTRIBUTE + "*" + "\\s*/?>";
private static final String CLOSETAG = "]";
- private static final Pattern[][] BLOCK_PATTERNS = new Pattern[][]{
- {null, null}, // not used (no type 0)
- {
- Pattern.compile("^<(?:script|pre|style|textarea)(?:\\s|>|$)", Pattern.CASE_INSENSITIVE),
+ private static final Pattern[][] BLOCK_PATTERNS =
+ new Pattern[][] {
+ {null, null}, // not used (no type 0)
+ {
+ Pattern.compile(
+ "^<(?:script|pre|style|textarea)(?:\\s|>|$)", Pattern.CASE_INSENSITIVE),
Pattern.compile("", Pattern.CASE_INSENSITIVE)
- },
- {
- Pattern.compile("^")
- },
- {
- Pattern.compile("^<[?]"),
- Pattern.compile("\\?>")
- },
- {
- Pattern.compile("^")
- },
- {
- Pattern.compile("^")
- },
- {
- Pattern.compile("^]|$)", Pattern.CASE_INSENSITIVE),
+ },
+ {Pattern.compile("^")},
+ {Pattern.compile("^<[?]"), Pattern.compile("\\?>")},
+ {Pattern.compile("^")},
+ {Pattern.compile("^")},
+ {
+ Pattern.compile(
+ "^]|$)",
+ Pattern.CASE_INSENSITIVE),
null // terminated by blank line
- },
- {
- Pattern.compile("^(?:" + OPENTAG + '|' + CLOSETAG + ")\\s*$", Pattern.CASE_INSENSITIVE),
+ },
+ {
+ Pattern.compile(
+ "^(?:" + OPENTAG + '|' + CLOSETAG + ")\\s*$", Pattern.CASE_INSENSITIVE),
null // terminated by blank line
- }
- };
+ }
+ };
private final HtmlBlock block = new HtmlBlock();
private final Pattern closingPattern;
@@ -127,14 +119,17 @@ public BlockStart tryStart(ParserState state, MatchedBlockParser matchedBlockPar
if (state.getIndent() < 4 && line.charAt(nextNonSpace) == '<') {
for (int blockType = 1; blockType <= 7; blockType++) {
// Type 7 can not interrupt a paragraph (not even a lazy one)
- if (blockType == 7 && (
- matchedBlockParser.getMatchedBlockParser().getBlock() instanceof Paragraph ||
- state.getActiveBlockParser().canHaveLazyContinuationLines())) {
+ if (blockType == 7
+ && (matchedBlockParser.getMatchedBlockParser().getBlock()
+ instanceof Paragraph
+ || state.getActiveBlockParser()
+ .canHaveLazyContinuationLines())) {
continue;
}
Pattern opener = BLOCK_PATTERNS[blockType][0];
Pattern closer = BLOCK_PATTERNS[blockType][1];
- boolean matches = opener.matcher(line.subSequence(nextNonSpace, line.length())).find();
+ boolean matches =
+ opener.matcher(line.subSequence(nextNonSpace, line.length())).find();
if (matches) {
return BlockStart.of(new HtmlBlockParser(closer)).atIndex(state.getIndex());
}
diff --git a/commonmark/src/main/java/org/commonmark/internal/IndentedCodeBlockParser.java b/commonmark/src/main/java/org/commonmark/internal/IndentedCodeBlockParser.java
index 3598f5615..b05b0a456 100644
--- a/commonmark/src/main/java/org/commonmark/internal/IndentedCodeBlockParser.java
+++ b/commonmark/src/main/java/org/commonmark/internal/IndentedCodeBlockParser.java
@@ -1,5 +1,7 @@
package org.commonmark.internal;
+import java.util.ArrayList;
+import java.util.List;
import org.commonmark.internal.util.Parsing;
import org.commonmark.node.Block;
import org.commonmark.node.IndentedCodeBlock;
@@ -8,9 +10,6 @@
import org.commonmark.parser.block.*;
import org.commonmark.text.Characters;
-import java.util.ArrayList;
-import java.util.List;
-
public class IndentedCodeBlockParser extends AbstractBlockParser {
private final IndentedCodeBlock block = new IndentedCodeBlock();
@@ -62,12 +61,14 @@ public static class Factory extends AbstractBlockParserFactory {
@Override
public BlockStart tryStart(ParserState state, MatchedBlockParser matchedBlockParser) {
// An indented code block cannot interrupt a paragraph.
- if (state.getIndent() >= Parsing.CODE_BLOCK_INDENT && !state.isBlank() && !(state.getActiveBlockParser().getBlock() instanceof Paragraph)) {
- return BlockStart.of(new IndentedCodeBlockParser()).atColumn(state.getColumn() + Parsing.CODE_BLOCK_INDENT);
+ if (state.getIndent() >= Parsing.CODE_BLOCK_INDENT
+ && !state.isBlank()
+ && !(state.getActiveBlockParser().getBlock() instanceof Paragraph)) {
+ return BlockStart.of(new IndentedCodeBlockParser())
+ .atColumn(state.getColumn() + Parsing.CODE_BLOCK_INDENT);
} else {
return BlockStart.none();
}
}
}
}
-
diff --git a/commonmark/src/main/java/org/commonmark/internal/InlineParserContextImpl.java b/commonmark/src/main/java/org/commonmark/internal/InlineParserContextImpl.java
index 233041f62..9b87896fc 100644
--- a/commonmark/src/main/java/org/commonmark/internal/InlineParserContextImpl.java
+++ b/commonmark/src/main/java/org/commonmark/internal/InlineParserContextImpl.java
@@ -1,14 +1,13 @@
package org.commonmark.internal;
+import java.util.List;
+import java.util.Set;
import org.commonmark.node.LinkReferenceDefinition;
import org.commonmark.parser.InlineParserContext;
-import org.commonmark.parser.beta.LinkProcessor;
import org.commonmark.parser.beta.InlineContentParserFactory;
+import org.commonmark.parser.beta.LinkProcessor;
import org.commonmark.parser.delimiter.DelimiterProcessor;
-import java.util.List;
-import java.util.Set;
-
public class InlineParserContextImpl implements InlineParserContext {
private final List inlineContentParserFactories;
@@ -17,11 +16,12 @@ public class InlineParserContextImpl implements InlineParserContext {
private final Set linkMarkers;
private final Definitions definitions;
- public InlineParserContextImpl(List inlineContentParserFactories,
- List delimiterProcessors,
- List linkProcessors,
- Set linkMarkers,
- Definitions definitions) {
+ public InlineParserContextImpl(
+ List inlineContentParserFactories,
+ List delimiterProcessors,
+ List linkProcessors,
+ Set linkMarkers,
+ Definitions definitions) {
this.inlineContentParserFactories = inlineContentParserFactories;
this.delimiterProcessors = delimiterProcessors;
this.linkProcessors = linkProcessors;
diff --git a/commonmark/src/main/java/org/commonmark/internal/InlineParserImpl.java b/commonmark/src/main/java/org/commonmark/internal/InlineParserImpl.java
index 44422f421..17ecd6d31 100644
--- a/commonmark/src/main/java/org/commonmark/internal/InlineParserImpl.java
+++ b/commonmark/src/main/java/org/commonmark/internal/InlineParserImpl.java
@@ -1,5 +1,6 @@
package org.commonmark.internal;
+import java.util.*;
import org.commonmark.internal.inline.*;
import org.commonmark.internal.util.Escaping;
import org.commonmark.internal.util.LinkScanner;
@@ -7,13 +8,11 @@
import org.commonmark.parser.InlineParser;
import org.commonmark.parser.InlineParserContext;
import org.commonmark.parser.SourceLines;
-import org.commonmark.parser.beta.Scanner;
import org.commonmark.parser.beta.*;
+import org.commonmark.parser.beta.Scanner;
import org.commonmark.parser.delimiter.DelimiterProcessor;
import org.commonmark.text.Characters;
-import java.util.*;
-
public class InlineParserImpl implements InlineParser, InlineParserState {
private final InlineParserContext context;
@@ -29,27 +28,34 @@ public class InlineParserImpl implements InlineParser, InlineParserState {
private int trailingSpaces;
/**
- * Top delimiter (emphasis, strong emphasis or custom emphasis). (Brackets are on a separate stack, different
- * from the algorithm described in the spec.)
+ * Top delimiter (emphasis, strong emphasis or custom emphasis). (Brackets are on a separate
+ * stack, different from the algorithm described in the spec.)
*/
private Delimiter lastDelimiter;
- /**
- * Top opening bracket ([ or ` or with optional title `[foo](/uri "title")`
// - Reference links
- // - Full: `[foo][bar]` (foo is the text and bar is the label that needs to match a reference)
+ // - Full: `[foo][bar]` (foo is the text and bar is the label that needs to match a
+ // reference)
// - Collapsed: `[foo][]` (foo is both the text and label)
// - Shortcut: `[foo]` (foo is both the text and label)
@@ -390,14 +409,21 @@ private LinkInfo parseLinkInfo(Bracket opener, Position beforeClose) {
var destinationTitle = parseInlineDestinationTitle(scanner);
if (destinationTitle != null) {
var text = scanner.getSource(opener.contentPosition, beforeClose).getContent();
- return new LinkInfoImpl(opener.markerNode, opener.bracketNode, text, null, destinationTitle.destination, destinationTitle.title, afterClose);
+ return new LinkInfoImpl(
+ opener.markerNode,
+ opener.bracketNode,
+ text,
+ null,
+ destinationTitle.destination,
+ destinationTitle.title,
+ afterClose);
}
// Not an inline link/image, rewind back to after `]`.
scanner.setPosition(afterClose);
// Maybe a reference link/image like `[foo][bar]`, `[foo][]` or `[foo]`.
- // Note that even `[foo](` could be a valid link if foo is a reference, which is why we try this even if the `(`
- // failed to be parsed as an inline link/image before.
+ // Note that even `[foo](` could be a valid link if foo is a reference, which is why we try
+ // this even if the `(` failed to be parsed as an inline link/image before.
// See if there's a link label like `[bar]` or `[]`
var label = parseLinkLabel(scanner);
@@ -407,17 +433,20 @@ private LinkInfo parseLinkInfo(Bracket opener, Position beforeClose) {
}
var textIsReference = label == null || label.isEmpty();
if (opener.bracketAfter && textIsReference && opener.markerNode == null) {
- // In case of shortcut or collapsed links, the text is used as the reference. But the reference is not allowed to
- // contain an unescaped bracket, so if that's the case we don't need to continue. This is an optimization.
+ // In case of shortcut or collapsed links, the text is used as the reference. But the
+ // reference is not allowed to contain an unescaped bracket, so if that's the case we
+ // don't need to continue. This is an optimization.
return null;
}
var text = scanner.getSource(opener.contentPosition, beforeClose).getContent();
- return new LinkInfoImpl(opener.markerNode, opener.bracketNode, text, label, null, null, afterClose);
+ return new LinkInfoImpl(
+ opener.markerNode, opener.bracketNode, text, label, null, null, afterClose);
}
private Node wrapBracket(Bracket opener, Node wrapperNode, boolean includeMarker) {
- // Add all nodes between the opening bracket and now (closing bracket) as child nodes of the link
+ // Add all nodes between the opening bracket and now (closing bracket) as child nodes of the
+ // link
Node n = opener.bracketNode.getNext();
while (n != null) {
Node next = n.getNext();
@@ -426,8 +455,12 @@ private Node wrapBracket(Bracket opener, Node wrapperNode, boolean includeMarker
}
if (includeSourceSpans) {
- var startPosition = includeMarker && opener.markerPosition != null ? opener.markerPosition : opener.bracketPosition;
- wrapperNode.setSourceSpans(scanner.getSource(startPosition, scanner.position()).getSourceSpans());
+ var startPosition =
+ includeMarker && opener.markerPosition != null
+ ? opener.markerPosition
+ : opener.bracketPosition;
+ wrapperNode.setSourceSpans(
+ scanner.getSource(startPosition, scanner.position()).getSourceSpans());
}
// Process delimiters such as emphasis inside link/image
@@ -440,7 +473,8 @@ private Node wrapBracket(Bracket opener, Node wrapperNode, boolean includeMarker
opener.bracketNode.unlink();
removeLastBracket();
- // Links within links are not allowed. We found this link, so there can be no other links around it.
+ // Links within links are not allowed. We found this link, so there can be no other links
+ // around it.
if (opener.markerNode == null) {
disallowPreviousLinks();
}
@@ -455,24 +489,30 @@ private Node replaceBracket(Bracket opener, Node node, boolean includeMarker) {
}
if (includeSourceSpans) {
- var startPosition = includeMarker && opener.markerPosition != null ? opener.markerPosition : opener.bracketPosition;
- node.setSourceSpans(scanner.getSource(startPosition, scanner.position()).getSourceSpans());
+ var startPosition =
+ includeMarker && opener.markerPosition != null
+ ? opener.markerPosition
+ : opener.bracketPosition;
+ node.setSourceSpans(
+ scanner.getSource(startPosition, scanner.position()).getSourceSpans());
}
removeLastBracket();
// Remove nodes that we added since the opener, because we're replacing them
- Node n = includeMarker && opener.markerNode != null ? opener.markerNode : opener.bracketNode;
+ Node n =
+ includeMarker && opener.markerNode != null ? opener.markerNode : opener.bracketNode;
while (n != null) {
var next = n.getNext();
n.unlink();
n = next;
}
- // Links within links are not allowed. We found this link, so there can be no other links around it.
- // Note that this makes any syntax like `[foo]` behave the same as built-in links, which is probably a good
- // default (it works for footnotes). It might be useful for a `LinkProcessor` to be able to specify the
- // behavior; something we could add to `LinkResult` in the future if requested.
+ // Links within links are not allowed. We found this link, so there can be no other links
+ // around it. Note that this makes any syntax like `[foo]` behave the same as built-in
+ // links, which is probably a good default (it works for footnotes). It might be useful for
+ // a `LinkProcessor` to be able to specify the behavior; something we could add to
+ // `LinkResult` in the future if requested.
if (opener.markerNode == null || !includeMarker) {
disallowPreviousLinks();
}
@@ -502,9 +542,7 @@ private void disallowPreviousLinks() {
}
}
- /**
- * Try to parse the destination and an optional title for an inline link/image.
- */
+ /** Try to parse the destination and an optional title for an inline link/image. */
private static DestinationTitle parseInlineDestinationTitle(Scanner scanner) {
if (!scanner.next('(')) {
return null;
@@ -531,9 +569,7 @@ private static DestinationTitle parseInlineDestinationTitle(Scanner scanner) {
return new DestinationTitle(dest, title);
}
- /**
- * Attempt to parse link destination, returning the string or null if no match.
- */
+ /** Attempt to parse link destination, returning the string or null if no match. */
private static String parseLinkDestination(Scanner scanner) {
char delimiter = scanner.peek();
Position start = scanner.position();
@@ -553,9 +589,7 @@ private static String parseLinkDestination(Scanner scanner) {
return Escaping.unescapeString(dest);
}
- /**
- * Attempt to parse link title (sans quotes), returning the string or null if no match.
- */
+ /** Attempt to parse link title (sans quotes), returning the string or null if no match. */
private static String parseLinkTitle(Scanner scanner) {
Position start = scanner.position();
if (!LinkScanner.scanLinkTitle(scanner)) {
@@ -568,9 +602,7 @@ private static String parseLinkTitle(Scanner scanner) {
return Escaping.unescapeString(title);
}
- /**
- * Attempt to parse a link label, returning the label between the brackets or null.
- */
+ /** Attempt to parse a link label, returning the label between the brackets or null. */
static String parseLinkLabel(Scanner scanner) {
if (!scanner.next('[')) {
return null;
@@ -608,7 +640,8 @@ private Node parseLineBreak() {
}
/**
- * Parse the next character as plain text, and possibly more if the following characters are non-special.
+ * Parse the next character as plain text, and possibly more if the following characters are
+ * non-special.
*/
private Node parseText() {
Position start = scanner.position();
@@ -626,12 +659,14 @@ private Node parseText() {
String content = source.getContent();
if (c == '\n') {
- // We parsed until the end of the line. Trim any trailing spaces and remember them (for hard line breaks).
+ // We parsed until the end of the line. Trim any trailing spaces and remember them (for
+ // hard line breaks).
int end = Characters.skipBackwards(' ', content, content.length() - 1, 0) + 1;
trailingSpaces = content.length() - end;
content = content.substring(0, end);
} else if (c == Scanner.END) {
- // For the last line, both tabs and spaces are trimmed for some reason (checked with commonmark.js).
+ // For the last line, both tabs and spaces are trimmed for some reason (checked with
+ // commonmark.js).
int end = Characters.skipSpaceTabBackwards(content, content.length() - 1, 0) + 1;
content = content.substring(0, end);
}
@@ -642,12 +677,14 @@ private Node parseText() {
}
/**
- * Scan a sequence of characters with code delimiterChar, and return information about the number of delimiters
- * and whether they are positioned such that they can open and/or close emphasis or strong emphasis.
+ * Scan a sequence of characters with code delimiterChar, and return information about the
+ * number of delimiters and whether they are positioned such that they can open and/or close
+ * emphasis or strong emphasis.
*
* @return information about delimiter run, or {@code null}
*/
- private DelimiterData scanDelimiters(DelimiterProcessor delimiterProcessor, char delimiterChar) {
+ private DelimiterData scanDelimiters(
+ DelimiterProcessor delimiterProcessor, char delimiterChar) {
int before = scanner.peekPreviousCodePoint();
Position start = scanner.position();
@@ -670,15 +707,20 @@ private DelimiterData scanDelimiters(DelimiterProcessor delimiterProcessor, char
int after = scanner.peekCodePoint();
// We could be more lazy here, in most cases we don't need to do every match case.
- boolean beforeIsPunctuation = before == Scanner.END || Characters.isPunctuationCodePoint(before);
- boolean beforeIsWhitespace = before == Scanner.END || Characters.isWhitespaceCodePoint(before);
- boolean afterIsPunctuation = after == Scanner.END || Characters.isPunctuationCodePoint(after);
+ boolean beforeIsPunctuation =
+ before == Scanner.END || Characters.isPunctuationCodePoint(before);
+ boolean beforeIsWhitespace =
+ before == Scanner.END || Characters.isWhitespaceCodePoint(before);
+ boolean afterIsPunctuation =
+ after == Scanner.END || Characters.isPunctuationCodePoint(after);
boolean afterIsWhitespace = after == Scanner.END || Characters.isWhitespaceCodePoint(after);
- boolean leftFlanking = !afterIsWhitespace &&
- (!afterIsPunctuation || beforeIsWhitespace || beforeIsPunctuation);
- boolean rightFlanking = !beforeIsWhitespace &&
- (!beforeIsPunctuation || afterIsWhitespace || afterIsPunctuation);
+ boolean leftFlanking =
+ !afterIsWhitespace
+ && (!afterIsPunctuation || beforeIsWhitespace || beforeIsPunctuation);
+ boolean rightFlanking =
+ !beforeIsWhitespace
+ && (!beforeIsPunctuation || afterIsWhitespace || afterIsPunctuation);
boolean canOpen;
boolean canClose;
if (delimiterChar == '_') {
@@ -718,7 +760,9 @@ private void processDelimiters(Delimiter stackBottom) {
boolean openerFound = false;
boolean potentialOpenerFound = false;
Delimiter opener = closer.previous;
- while (opener != null && opener != stackBottom && opener != openersBottom.get(delimiterChar)) {
+ while (opener != null
+ && opener != stackBottom
+ && opener != openersBottom.get(delimiterChar)) {
if (opener.canOpen() && opener.delimiterChar == openingDelimiterChar) {
potentialOpenerFound = true;
usedDelims = delimiterProcessor.process(opener, closer);
@@ -762,7 +806,8 @@ private void processDelimiters(Delimiter stackBottom) {
removeDelimitersBetween(opener, closer);
- // No delimiter characters left to process, so we can remove delimiter and the now empty node.
+ // No delimiter characters left to process, so we can remove delimiter and the now empty
+ // node.
if (opener.length() == 0) {
removeDelimiterAndNodes(opener);
}
@@ -790,14 +835,16 @@ private void removeDelimitersBetween(Delimiter opener, Delimiter closer) {
}
/**
- * Remove the delimiter and the corresponding text node. For used delimiters, e.g. `*` in `*foo*`.
+ * Remove the delimiter and the corresponding text node. For used delimiters, e.g. `*` in
+ * `*foo*`.
*/
private void removeDelimiterAndNodes(Delimiter delim) {
removeDelimiter(delim);
}
/**
- * Remove the delimiter but keep the corresponding node as text. For unused delimiters such as `_` in `foo_bar`.
+ * Remove the delimiter but keep the corresponding node as text. For unused delimiters such as
+ * `_` in `foo_bar`.
*/
private void removeDelimiterKeepNode(Delimiter delim) {
removeDelimiter(delim);
@@ -897,9 +944,7 @@ private static class DelimiterData {
}
}
- /**
- * A destination and optional title for a link or image.
- */
+ /** A destination and optional title for a link or image. */
private static class DestinationTitle {
final String destination;
final String title;
@@ -920,8 +965,14 @@ private static class LinkInfoImpl implements LinkInfo {
private final String title;
private final Position afterTextBracket;
- private LinkInfoImpl(Text marker, Text openingBracket, String text, String label,
- String destination, String title, Position afterTextBracket) {
+ private LinkInfoImpl(
+ Text marker,
+ Text openingBracket,
+ String text,
+ String label,
+ String destination,
+ String title,
+ Position afterTextBracket) {
this.marker = marker;
this.openingBracket = openingBracket;
this.text = text;
diff --git a/commonmark/src/main/java/org/commonmark/internal/LinkReferenceDefinitionParser.java b/commonmark/src/main/java/org/commonmark/internal/LinkReferenceDefinitionParser.java
index 637d3b111..8725a0612 100644
--- a/commonmark/src/main/java/org/commonmark/internal/LinkReferenceDefinitionParser.java
+++ b/commonmark/src/main/java/org/commonmark/internal/LinkReferenceDefinitionParser.java
@@ -1,5 +1,8 @@
package org.commonmark.internal;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
import org.commonmark.internal.util.Escaping;
import org.commonmark.internal.util.LinkScanner;
import org.commonmark.node.LinkReferenceDefinition;
@@ -9,14 +12,11 @@
import org.commonmark.parser.beta.Position;
import org.commonmark.parser.beta.Scanner;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.List;
-
/**
* Parser for link reference definitions at the beginning of a paragraph.
*
- * @see Link reference definitions
+ * @see Link reference
+ * definitions
*/
public class LinkReferenceDefinitionParser {
@@ -35,8 +35,8 @@ public class LinkReferenceDefinitionParser {
public void parse(SourceLine line) {
paragraphLines.add(line);
if (state == State.PARAGRAPH) {
- // We're in a paragraph now. Link reference definitions can only appear at the beginning, so once
- // we're in a paragraph, there's no going back.
+ // We're in a paragraph now. Link reference definitions can only appear at the
+ // beginning, so once we're in a paragraph, there's no going back.
return;
}
@@ -44,35 +44,41 @@ public void parse(SourceLine line) {
while (scanner.hasNext()) {
boolean success;
switch (state) {
- case START_DEFINITION: {
- success = startDefinition(scanner);
- break;
- }
- case LABEL: {
- success = label(scanner);
- break;
- }
- case DESTINATION: {
- success = destination(scanner);
- break;
- }
- case START_TITLE: {
- success = startTitle(scanner);
- break;
- }
- case TITLE: {
- success = title(scanner);
- break;
- }
- default: {
- throw new IllegalStateException("Unknown parsing state: " + state);
- }
+ case START_DEFINITION:
+ {
+ success = startDefinition(scanner);
+ break;
+ }
+ case LABEL:
+ {
+ success = label(scanner);
+ break;
+ }
+ case DESTINATION:
+ {
+ success = destination(scanner);
+ break;
+ }
+ case START_TITLE:
+ {
+ success = startTitle(scanner);
+ break;
+ }
+ case TITLE:
+ {
+ success = title(scanner);
+ break;
+ }
+ default:
+ {
+ throw new IllegalStateException("Unknown parsing state: " + state);
+ }
}
// Parsing failed, which means we fall back to treating text as a paragraph.
if (!success) {
state = State.PARAGRAPH;
- // If parsing of the title part failed, we still have a valid reference that we can add, and we need to
- // do it before the source span for this line is added.
+ // If parsing of the title part failed, we still have a valid reference that we can
+ // add, and we need to do it before the source span for this line is added.
finishReference();
return;
}
@@ -104,16 +110,20 @@ State getState() {
}
List removeLines(int lines) {
- var removedSpans = Collections.unmodifiableList(new ArrayList<>(
- sourceSpans.subList(Math.max(sourceSpans.size() - lines, 0), sourceSpans.size())));
+ var removedSpans =
+ Collections.unmodifiableList(
+ new ArrayList<>(
+ sourceSpans.subList(
+ Math.max(sourceSpans.size() - lines, 0),
+ sourceSpans.size())));
removeLast(lines, paragraphLines);
removeLast(lines, sourceSpans);
return removedSpans;
}
private boolean startDefinition(Scanner scanner) {
- // Finish any outstanding references now. We don't do this earlier because we need addSourceSpan to have been
- // called before we do it.
+ // Finish any outstanding references now. We don't do this earlier because we need
+ // addSourceSpan to have been called before we do it.
finishReference();
scanner.whitespace();
@@ -175,14 +185,15 @@ private boolean destination(Scanner scanner) {
}
String rawDestination = scanner.getSource(start, scanner.position()).getContent();
- destination = rawDestination.startsWith("<") ?
- rawDestination.substring(1, rawDestination.length() - 1) :
- rawDestination;
+ destination =
+ rawDestination.startsWith("<")
+ ? rawDestination.substring(1, rawDestination.length() - 1)
+ : rawDestination;
int whitespace = scanner.whitespace();
if (!scanner.hasNext()) {
- // Destination was at end of line, so this is a valid reference for sure (and maybe a title).
- // If not at end of line, wait for title to be valid first.
+ // Destination was at end of line, so this is a valid reference for sure (and maybe a
+ // title). If not at end of line, wait for title to be valid first.
referenceValid = true;
paragraphLines.clear();
} else if (whitespace == 0) {
@@ -238,7 +249,8 @@ private boolean title(Scanner scanner) {
title.append(scanner.getSource(start, scanner.position()).getContent());
if (!scanner.hasNext()) {
- // Title ran until the end of line, so continue on next line (until we find the delimiter)
+ // Title ran until the end of line, so continue on next line (until we find the
+ // delimiter)
title.append('\n');
return true;
}
diff --git a/commonmark/src/main/java/org/commonmark/internal/ListBlockParser.java b/commonmark/src/main/java/org/commonmark/internal/ListBlockParser.java
index fbf034757..f160b10ff 100644
--- a/commonmark/src/main/java/org/commonmark/internal/ListBlockParser.java
+++ b/commonmark/src/main/java/org/commonmark/internal/ListBlockParser.java
@@ -1,11 +1,10 @@
package org.commonmark.internal;
+import java.util.Objects;
import org.commonmark.internal.util.Parsing;
import org.commonmark.node.*;
import org.commonmark.parser.block.*;
-import java.util.Objects;
-
public class ListBlockParser extends AbstractBlockParser {
private final ListBlock block;
@@ -25,10 +24,11 @@ public boolean isContainer() {
@Override
public boolean canContain(Block childBlock) {
if (childBlock instanceof ListItem) {
- // Another list item is added to this list block. If the previous line was blank, that means this list block
- // is "loose" (not tight).
+ // Another list item is added to this list block. If the previous line was blank, that
+ // means this list block is "loose" (not tight).
//
- // spec: A list is loose if any of its constituent list items are separated by blank lines
+ // spec: A list is loose if any of its constituent list items are separated by blank
+ // lines
if (hadBlankLine && linesAfterBlank == 1) {
block.setTight(false);
hadBlankLine = false;
@@ -52,16 +52,18 @@ public BlockContinue tryContinue(ParserState state) {
} else if (hadBlankLine) {
linesAfterBlank++;
}
- // List blocks themselves don't have any markers, only list items. So try to stay in the list.
- // If there is a block start other than list item, canContain makes sure that this list is closed.
+ // List blocks themselves don't have any markers, only list items. So try to stay in the
+ // list. If there is a block start other than list item, canContain makes sure that this
+ // list is closed.
return BlockContinue.atIndex(state.getIndex());
}
- /**
- * Parse a list marker and return data on the marker or null.
- */
- private static ListData parseList(CharSequence line, final int markerIndex, final int markerColumn,
- final boolean inParagraph) {
+ /** Parse a list marker and return data on the marker or null. */
+ private static ListData parseList(
+ CharSequence line,
+ final int markerIndex,
+ final int markerColumn,
+ final boolean inParagraph) {
ListMarkerData listMarker = parseListMarker(line, markerIndex);
if (listMarker == null) {
return null;
@@ -92,7 +94,8 @@ private static ListData parseList(CharSequence line, final int markerIndex, fina
if (inParagraph) {
// If the list item is ordered, the start number must be 1 to interrupt a paragraph.
- if (listBlock instanceof OrderedList && ((OrderedList) listBlock).getMarkerStartNumber() != 1) {
+ if (listBlock instanceof OrderedList
+ && ((OrderedList) listBlock).getMarkerStartNumber() != 1) {
return null;
}
// Empty list item can not interrupt a paragraph.
@@ -128,8 +131,8 @@ private static ListMarkerData parseListMarker(CharSequence line, int index) {
}
}
- // spec: An ordered list marker is a sequence of 1-9 arabic digits (0-9), followed by either a `.` character or a
- // `)` character.
+ // spec: An ordered list marker is a sequence of 1-9 arabic digits (0-9), followed by either a
+ // `.` character or a `)` character.
private static ListMarkerData parseOrderedList(CharSequence line, int index) {
int digits = 0;
int length = line.length();
@@ -184,15 +187,15 @@ private static boolean isSpaceTabOrEnd(CharSequence line, int index) {
}
/**
- * Returns true if the two list items are of the same type,
- * with the same delimiter and bullet character. This is used
- * in agglomerating list items into lists.
+ * Returns true if the two list items are of the same type, with the same delimiter and bullet
+ * character. This is used in agglomerating list items into lists.
*/
private static boolean listsMatch(ListBlock a, ListBlock b) {
if (a instanceof BulletList && b instanceof BulletList) {
return Objects.equals(((BulletList) a).getMarker(), ((BulletList) b).getMarker());
} else if (a instanceof OrderedList && b instanceof OrderedList) {
- return Objects.equals(((OrderedList) a).getMarkerDelimiter(), ((OrderedList) b).getMarkerDelimiter());
+ return Objects.equals(
+ ((OrderedList) a).getMarkerDelimiter(), ((OrderedList) b).getMarkerDelimiter());
}
return false;
}
@@ -209,20 +212,23 @@ public BlockStart tryStart(ParserState state, MatchedBlockParser matchedBlockPar
int markerIndex = state.getNextNonSpaceIndex();
int markerColumn = state.getColumn() + state.getIndent();
boolean inParagraph = !matchedBlockParser.getParagraphLines().isEmpty();
- ListData listData = parseList(state.getLine().getContent(), markerIndex, markerColumn, inParagraph);
+ ListData listData =
+ parseList(state.getLine().getContent(), markerIndex, markerColumn, inParagraph);
if (listData == null) {
return BlockStart.none();
}
int newColumn = listData.contentColumn;
- ListItemParser listItemParser = new ListItemParser(state.getIndent(), newColumn - state.getColumn());
+ ListItemParser listItemParser =
+ new ListItemParser(state.getIndent(), newColumn - state.getColumn());
// prepend the list block if needed
- if (!(matched instanceof ListBlockParser) ||
- !(listsMatch((ListBlock) matched.getBlock(), listData.listBlock))) {
+ if (!(matched instanceof ListBlockParser)
+ || !(listsMatch((ListBlock) matched.getBlock(), listData.listBlock))) {
ListBlockParser listBlockParser = new ListBlockParser(listData.listBlock);
- // We start out with assuming a list is tight. If we find a blank line, we set it to loose later.
+ // We start out with assuming a list is tight. If we find a blank line, we set it to
+ // loose later.
listData.listBlock.setTight(true);
return BlockStart.of(listBlockParser, listItemParser).atColumn(newColumn);
diff --git a/commonmark/src/main/java/org/commonmark/internal/ListItemParser.java b/commonmark/src/main/java/org/commonmark/internal/ListItemParser.java
index 49722dff2..61549cc4c 100644
--- a/commonmark/src/main/java/org/commonmark/internal/ListItemParser.java
+++ b/commonmark/src/main/java/org/commonmark/internal/ListItemParser.java
@@ -13,8 +13,8 @@ public class ListItemParser extends AbstractBlockParser {
private final ListItem block = new ListItem();
/**
- * Minimum number of columns that the content has to be indented (relative to the containing block) to be part of
- * this list item.
+ * Minimum number of columns that the content has to be indented (relative to the containing
+ * block) to be part of this list item.
*/
private int contentIndent;
@@ -36,8 +36,8 @@ public boolean canContain(Block childBlock) {
if (hadBlankLine) {
// We saw a blank line in this list item, that means the list block is loose.
//
- // spec: if any of its constituent list items directly contain two block-level elements with a blank line
- // between them
+ // spec: if any of its constituent list items directly contain two block-level elements
+ // with a blank line between them
Block parent = block.getParent();
if (parent instanceof ListBlock) {
((ListBlock) parent).setTight(false);
@@ -59,7 +59,8 @@ public BlockContinue tryContinue(ParserState state) {
return BlockContinue.none();
} else {
Block activeBlock = state.getActiveBlockParser().getBlock();
- // If the active block is a code block, blank lines in it should not affect if the list is tight.
+ // If the active block is a code block, blank lines in it should not affect if the
+ // list is tight.
hadBlankLine = activeBlock instanceof Paragraph || activeBlock instanceof ListItem;
return BlockContinue.atIndex(state.getNextNonSpaceIndex());
}
diff --git a/commonmark/src/main/java/org/commonmark/internal/ParagraphParser.java b/commonmark/src/main/java/org/commonmark/internal/ParagraphParser.java
index 27eb1e647..47f69b34a 100644
--- a/commonmark/src/main/java/org/commonmark/internal/ParagraphParser.java
+++ b/commonmark/src/main/java/org/commonmark/internal/ParagraphParser.java
@@ -1,5 +1,6 @@
package org.commonmark.internal;
+import java.util.List;
import org.commonmark.node.*;
import org.commonmark.parser.InlineParser;
import org.commonmark.parser.SourceLine;
@@ -8,12 +9,11 @@
import org.commonmark.parser.block.BlockContinue;
import org.commonmark.parser.block.ParserState;
-import java.util.List;
-
public class ParagraphParser extends AbstractBlockParser {
private final Paragraph block = new Paragraph();
- private final LinkReferenceDefinitionParser linkReferenceDefinitionParser = new LinkReferenceDefinitionParser();
+ private final LinkReferenceDefinitionParser linkReferenceDefinitionParser =
+ new LinkReferenceDefinitionParser();
@Override
public boolean canHaveLazyContinuationLines() {
diff --git a/commonmark/src/main/java/org/commonmark/internal/StaggeredDelimiterProcessor.java b/commonmark/src/main/java/org/commonmark/internal/StaggeredDelimiterProcessor.java
index 2836e346a..98354b8e4 100644
--- a/commonmark/src/main/java/org/commonmark/internal/StaggeredDelimiterProcessor.java
+++ b/commonmark/src/main/java/org/commonmark/internal/StaggeredDelimiterProcessor.java
@@ -1,28 +1,28 @@
package org.commonmark.internal;
-import org.commonmark.parser.delimiter.DelimiterProcessor;
-import org.commonmark.parser.delimiter.DelimiterRun;
-
import java.util.LinkedList;
import java.util.ListIterator;
+import org.commonmark.parser.delimiter.DelimiterProcessor;
+import org.commonmark.parser.delimiter.DelimiterRun;
/**
- * An implementation of DelimiterProcessor that dispatches all calls to two or more other DelimiterProcessors
- * depending on the length of the delimiter run. All child DelimiterProcessors must have different minimum
- * lengths. A given delimiter run is dispatched to the child with the largest acceptable minimum length. If no
- * child is applicable, the one with the largest minimum length is chosen.
+ * An implementation of DelimiterProcessor that dispatches all calls to two or more other
+ * DelimiterProcessors depending on the length of the delimiter run. All child DelimiterProcessors
+ * must have different minimum lengths. A given delimiter run is dispatched to the child with the
+ * largest acceptable minimum length. If no child is applicable, the one with the largest minimum
+ * length is chosen.
*/
class StaggeredDelimiterProcessor implements DelimiterProcessor {
private final char delim;
private int minLength = 0;
- private LinkedList processors = new LinkedList<>(); // in reverse getMinLength order
+ private LinkedList processors =
+ new LinkedList<>(); // in reverse getMinLength order
StaggeredDelimiterProcessor(char delim) {
this.delim = delim;
}
-
@Override
public char getOpeningCharacter() {
return delim;
@@ -51,7 +51,15 @@ void add(DelimiterProcessor dp) {
added = true;
break;
} else if (len == pLen) {
- throw new IllegalArgumentException("Cannot add two delimiter processors for char '" + delim + "' and minimum length " + len + "; conflicting processors: " + p + ", " + dp);
+ throw new IllegalArgumentException(
+ "Cannot add two delimiter processors for char '"
+ + delim
+ + "' and minimum length "
+ + len
+ + "; conflicting processors: "
+ + p
+ + ", "
+ + dp);
}
}
if (!added) {
diff --git a/commonmark/src/main/java/org/commonmark/internal/ThematicBreakParser.java b/commonmark/src/main/java/org/commonmark/internal/ThematicBreakParser.java
index 0f0613221..366a84254 100644
--- a/commonmark/src/main/java/org/commonmark/internal/ThematicBreakParser.java
+++ b/commonmark/src/main/java/org/commonmark/internal/ThematicBreakParser.java
@@ -41,8 +41,9 @@ public BlockStart tryStart(ParserState state, MatchedBlockParser matchedBlockPar
}
}
- // spec: A line consisting of 0-3 spaces of indentation, followed by a sequence of three or more matching -, _, or *
- // characters, each followed optionally by any number of spaces, forms a thematic break.
+ // spec: A line consisting of 0-3 spaces of indentation, followed by a sequence of three or more
+ // matching -, _, or * characters, each followed optionally by any number of spaces, forms a
+ // thematic break.
private static boolean isThematicBreak(CharSequence line, int index) {
int dashes = 0;
int underscores = 0;
@@ -68,8 +69,8 @@ private static boolean isThematicBreak(CharSequence line, int index) {
}
}
- return ((dashes >= 3 && underscores == 0 && asterisks == 0) ||
- (underscores >= 3 && dashes == 0 && asterisks == 0) ||
- (asterisks >= 3 && dashes == 0 && underscores == 0));
+ return ((dashes >= 3 && underscores == 0 && asterisks == 0)
+ || (underscores >= 3 && dashes == 0 && asterisks == 0)
+ || (asterisks >= 3 && dashes == 0 && underscores == 0));
}
}
diff --git a/commonmark/src/main/java/org/commonmark/internal/inline/AutolinkInlineParser.java b/commonmark/src/main/java/org/commonmark/internal/inline/AutolinkInlineParser.java
index a18966e54..4e3e131fe 100644
--- a/commonmark/src/main/java/org/commonmark/internal/inline/AutolinkInlineParser.java
+++ b/commonmark/src/main/java/org/commonmark/internal/inline/AutolinkInlineParser.java
@@ -1,23 +1,21 @@
package org.commonmark.internal.inline;
+import java.util.Set;
+import java.util.regex.Pattern;
import org.commonmark.node.Link;
import org.commonmark.node.Text;
import org.commonmark.parser.SourceLines;
import org.commonmark.parser.beta.*;
-import java.util.Set;
-import java.util.regex.Pattern;
-
-/**
- * Attempt to parse an autolink (URL or email in pointy brackets).
- */
+/** Attempt to parse an autolink (URL or email in pointy brackets). */
public class AutolinkInlineParser implements InlineContentParser {
- private static final Pattern URI = Pattern
- .compile("^[a-zA-Z][a-zA-Z0-9.+-]{1,31}:[^<>\u0000-\u0020]*$");
+ private static final Pattern URI =
+ Pattern.compile("^[a-zA-Z][a-zA-Z0-9.+-]{1,31}:[^<>\u0000-\u0020]*$");
- private static final Pattern EMAIL = Pattern
- .compile("^([a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*)$");
+ private static final Pattern EMAIL =
+ Pattern.compile(
+ "^([a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*)$");
@Override
public ParsedInline tryParse(InlineParserState inlineParserState) {
diff --git a/commonmark/src/main/java/org/commonmark/internal/inline/BackslashInlineParser.java b/commonmark/src/main/java/org/commonmark/internal/inline/BackslashInlineParser.java
index 7baeed4de..c4e8f3aff 100644
--- a/commonmark/src/main/java/org/commonmark/internal/inline/BackslashInlineParser.java
+++ b/commonmark/src/main/java/org/commonmark/internal/inline/BackslashInlineParser.java
@@ -1,16 +1,16 @@
package org.commonmark.internal.inline;
+import java.util.Set;
+import java.util.regex.Pattern;
import org.commonmark.internal.util.Escaping;
import org.commonmark.node.HardLineBreak;
import org.commonmark.node.Text;
import org.commonmark.parser.beta.*;
-import java.util.Set;
-import java.util.regex.Pattern;
-
/**
- * Parse a backslash-escaped special character, adding either the escaped character, a hard line break
- * (if the backslash is followed by a newline), or a literal backslash to the block's children.
+ * Parse a backslash-escaped special character, adding either the escaped character, a hard line
+ * break (if the backslash is followed by a newline), or a literal backslash to the block's
+ * children.
*/
public class BackslashInlineParser implements InlineContentParser {
diff --git a/commonmark/src/main/java/org/commonmark/internal/inline/BackticksInlineParser.java b/commonmark/src/main/java/org/commonmark/internal/inline/BackticksInlineParser.java
index b8e8984e8..f636d31b4 100644
--- a/commonmark/src/main/java/org/commonmark/internal/inline/BackticksInlineParser.java
+++ b/commonmark/src/main/java/org/commonmark/internal/inline/BackticksInlineParser.java
@@ -1,15 +1,15 @@
package org.commonmark.internal.inline;
+import java.util.Set;
import org.commonmark.node.Code;
import org.commonmark.node.Text;
import org.commonmark.parser.SourceLines;
import org.commonmark.parser.beta.*;
import org.commonmark.text.Characters;
-import java.util.Set;
-
/**
- * Attempt to parse backticks, returning either a backtick code span or a literal sequence of backticks.
+ * Attempt to parse backticks, returning either a backtick code span or a literal sequence of
+ * backticks.
*/
public class BackticksInlineParser implements InlineContentParser {
@@ -29,12 +29,13 @@ public ParsedInline tryParse(InlineParserState inlineParserState) {
String content = scanner.getSource(afterOpening, beforeClosing).getContent();
content = content.replace('\n', ' ');
- // spec: If the resulting string both begins and ends with a space character, but does not consist
- // entirely of space characters, a single space character is removed from the front and back.
- if (content.length() >= 3 &&
- content.charAt(0) == ' ' &&
- content.charAt(content.length() - 1) == ' ' &&
- Characters.hasNonSpace(content)) {
+ // spec: If the resulting string both begins and ends with a space character, but
+ // does not consist entirely of space characters, a single space character is
+ // removed from the front and back.
+ if (content.length() >= 3
+ && content.charAt(0) == ' '
+ && content.charAt(content.length() - 1) == ' '
+ && Characters.hasNonSpace(content)) {
content = content.substring(1, content.length() - 1);
}
diff --git a/commonmark/src/main/java/org/commonmark/internal/inline/CoreLinkProcessor.java b/commonmark/src/main/java/org/commonmark/internal/inline/CoreLinkProcessor.java
index 528750aba..3c2efe09b 100644
--- a/commonmark/src/main/java/org/commonmark/internal/inline/CoreLinkProcessor.java
+++ b/commonmark/src/main/java/org/commonmark/internal/inline/CoreLinkProcessor.java
@@ -28,9 +28,11 @@ public LinkResult process(LinkInfo linkInfo, Scanner scanner, InlineParserContex
return LinkResult.none();
}
- private static LinkResult process(LinkInfo linkInfo, Scanner scanner, String destination, String title) {
+ private static LinkResult process(
+ LinkInfo linkInfo, Scanner scanner, String destination, String title) {
if (linkInfo.marker() != null && linkInfo.marker().getLiteral().equals("!")) {
- return LinkResult.wrapTextIn(new Image(destination, title), scanner.position()).includeMarker();
+ return LinkResult.wrapTextIn(new Image(destination, title), scanner.position())
+ .includeMarker();
}
return LinkResult.wrapTextIn(new Link(destination, title), scanner.position());
}
diff --git a/commonmark/src/main/java/org/commonmark/internal/inline/EmphasisDelimiterProcessor.java b/commonmark/src/main/java/org/commonmark/internal/inline/EmphasisDelimiterProcessor.java
index 493e4299c..9fbedf897 100644
--- a/commonmark/src/main/java/org/commonmark/internal/inline/EmphasisDelimiterProcessor.java
+++ b/commonmark/src/main/java/org/commonmark/internal/inline/EmphasisDelimiterProcessor.java
@@ -30,9 +30,9 @@ public int getMinLength() {
@Override
public int process(DelimiterRun openingRun, DelimiterRun closingRun) {
// "multiple of 3" rule for internal delimiter runs
- if ((openingRun.canClose() || closingRun.canOpen()) &&
- closingRun.originalLength() % 3 != 0 &&
- (openingRun.originalLength() + closingRun.originalLength()) % 3 == 0) {
+ if ((openingRun.canClose() || closingRun.canOpen())
+ && closingRun.originalLength() % 3 != 0
+ && (openingRun.originalLength() + closingRun.originalLength()) % 3 == 0) {
return 0;
}
diff --git a/commonmark/src/main/java/org/commonmark/internal/inline/EntityInlineParser.java b/commonmark/src/main/java/org/commonmark/internal/inline/EntityInlineParser.java
index c24e60747..e3ed0c08b 100644
--- a/commonmark/src/main/java/org/commonmark/internal/inline/EntityInlineParser.java
+++ b/commonmark/src/main/java/org/commonmark/internal/inline/EntityInlineParser.java
@@ -1,21 +1,21 @@
package org.commonmark.internal.inline;
+import java.util.Set;
import org.commonmark.internal.util.Html5Entities;
import org.commonmark.node.Text;
import org.commonmark.parser.beta.*;
import org.commonmark.text.AsciiMatcher;
-import java.util.Set;
-
-/**
- * Attempts to parse an HTML entity or numeric character reference.
- */
+/** Attempts to parse an HTML entity or numeric character reference. */
public class EntityInlineParser implements InlineContentParser {
- private static final AsciiMatcher hex = AsciiMatcher.builder().range('0', '9').range('A', 'F').range('a', 'f').build();
+ private static final AsciiMatcher hex =
+ AsciiMatcher.builder().range('0', '9').range('A', 'F').range('a', 'f').build();
private static final AsciiMatcher dec = AsciiMatcher.builder().range('0', '9').build();
- private static final AsciiMatcher entityStart = AsciiMatcher.builder().range('A', 'Z').range('a', 'z').build();
- private static final AsciiMatcher entityContinue = entityStart.newBuilder().range('0', '9').build();
+ private static final AsciiMatcher entityStart =
+ AsciiMatcher.builder().range('A', 'Z').range('a', 'z').build();
+ private static final AsciiMatcher entityContinue =
+ entityStart.newBuilder().range('0', '9').build();
@Override
public ParsedInline tryParse(InlineParserState inlineParserState) {
diff --git a/commonmark/src/main/java/org/commonmark/internal/inline/HtmlInlineParser.java b/commonmark/src/main/java/org/commonmark/internal/inline/HtmlInlineParser.java
index a48ea5022..b359f732b 100644
--- a/commonmark/src/main/java/org/commonmark/internal/inline/HtmlInlineParser.java
+++ b/commonmark/src/main/java/org/commonmark/internal/inline/HtmlInlineParser.java
@@ -1,31 +1,46 @@
package org.commonmark.internal.inline;
+import java.util.Set;
import org.commonmark.node.HtmlInline;
import org.commonmark.parser.beta.*;
import org.commonmark.text.AsciiMatcher;
-import java.util.Set;
-
-/**
- * Attempt to parse inline HTML.
- */
+/** Attempt to parse inline HTML. */
public class HtmlInlineParser implements InlineContentParser {
- private static final AsciiMatcher asciiLetter = AsciiMatcher.builder().range('A', 'Z').range('a', 'z').build();
+ private static final AsciiMatcher asciiLetter =
+ AsciiMatcher.builder().range('A', 'Z').range('a', 'z').build();
- // spec: A tag name consists of an ASCII letter followed by zero or more ASCII letters, digits, or hyphens (-).
+ // spec: A tag name consists of an ASCII letter followed by zero or more ASCII letters, digits,
+ // or hyphens (-).
private static final AsciiMatcher tagNameStart = asciiLetter;
- private static final AsciiMatcher tagNameContinue = tagNameStart.newBuilder().range('0', '9').c('-').build();
+ private static final AsciiMatcher tagNameContinue =
+ tagNameStart.newBuilder().range('0', '9').c('-').build();
- // spec: An attribute name consists of an ASCII letter, _, or :, followed by zero or more ASCII letters, digits,
+ // spec: An attribute name consists of an ASCII letter, _, or :, followed by zero or more ASCII
+ // letters, digits,
// _, ., :, or -. (Note: This is the XML specification restricted to ASCII. HTML5 is laxer.)
- private static final AsciiMatcher attributeStart = asciiLetter.newBuilder().c('_').c(':').build();
- private static final AsciiMatcher attributeContinue = attributeStart.newBuilder().range('0', '9').c('.').c('-').build();
- // spec: An unquoted attribute value is a nonempty string of characters not including whitespace, ", ', =, <, >, or `.
- private static final AsciiMatcher attributeValueEnd = AsciiMatcher.builder()
- .c(' ').c('\t').c('\n').c('\u000B').c('\f').c('\r')
- .c('"').c('\'').c('=').c('<').c('>').c('`')
- .build();
+ private static final AsciiMatcher attributeStart =
+ asciiLetter.newBuilder().c('_').c(':').build();
+ private static final AsciiMatcher attributeContinue =
+ attributeStart.newBuilder().range('0', '9').c('.').c('-').build();
+ // spec: An unquoted attribute value is a nonempty string of characters not including
+ // whitespace, ", ', =, <, >, or `.
+ private static final AsciiMatcher attributeValueEnd =
+ AsciiMatcher.builder()
+ .c(' ')
+ .c('\t')
+ .c('\n')
+ .c('\u000B')
+ .c('\f')
+ .c('\r')
+ .c('"')
+ .c('\'')
+ .c('=')
+ .c('<')
+ .c('>')
+ .c('`')
+ .build();
@Override
public ParsedInline tryParse(InlineParserState inlineParserState) {
@@ -77,16 +92,17 @@ private static ParsedInline htmlInline(Position start, Scanner scanner) {
}
private static boolean tryOpenTag(Scanner scanner) {
- // spec: An open tag consists of a < character, a tag name, zero or more attributes, optional whitespace,
- // an optional / character, and a > character.
+ // spec: An open tag consists of a < character, a tag name, zero or more attributes,
+ // optional whitespace, an optional / character, and a > character.
scanner.next();
scanner.match(tagNameContinue);
boolean whitespace = scanner.whitespace() >= 1;
- // spec: An attribute consists of whitespace, an attribute name, and an optional attribute value specification.
+ // spec: An attribute consists of whitespace, an attribute name, and an optional attribute
+ // value specification.
while (whitespace && scanner.match(attributeStart) >= 1) {
scanner.match(attributeContinue);
- // spec: An attribute value specification consists of optional whitespace, a = character,
- // optional whitespace, and an attribute value.
+ // spec: An attribute value specification consists of optional whitespace, a =
+ // character, optional whitespace, and an attribute value.
whitespace = scanner.whitespace() >= 1;
if (scanner.next('=')) {
scanner.whitespace();
@@ -119,7 +135,8 @@ private static boolean tryOpenTag(Scanner scanner) {
}
private static boolean tryClosingTag(Scanner scanner) {
- // spec: A closing tag consists of the string .
+ // spec: A closing tag consists of the string .
scanner.next();
if (scanner.match(tagNameStart) >= 1) {
scanner.match(tagNameContinue);
@@ -130,8 +147,8 @@ private static boolean tryClosingTag(Scanner scanner) {
}
private static boolean tryProcessingInstruction(Scanner scanner) {
- // spec: A processing instruction consists of the string ,
- // and the string ?>.
+ // spec: A processing instruction consists of the string , and the string ?>.
scanner.next();
while (scanner.find('?') > 0) {
scanner.next();
@@ -144,8 +161,8 @@ private static boolean tryProcessingInstruction(Scanner scanner) {
private static boolean tryComment(Scanner scanner) {
// spec: An [HTML comment](@) consists of ``, ``, or ``, and `-->` (see the
- // [HTML spec](https://html.spec.whatwg.org/multipage/parsing.html#markup-declaration-open-state)).
+ // characters not including the string `-->`, and `-->` (see the [HTML
+ // spec](https://html.spec.whatwg.org/multipage/parsing.html#markup-declaration-open-state)).
// Skip first `-`
scanner.next();
@@ -169,8 +186,8 @@ private static boolean tryComment(Scanner scanner) {
}
private static boolean tryCdata(Scanner scanner) {
- // spec: A CDATA section consists of the string ,
- // and the string ]]>.
+ // spec: A CDATA section consists of the string , and the string ]]>.
// Skip `[`
scanner.next();
@@ -189,8 +206,8 @@ private static boolean tryCdata(Scanner scanner) {
}
private static boolean tryDeclaration(Scanner scanner) {
- // spec: A declaration consists of the string , and the character >.
+ // spec: A declaration consists of the string , and the character >.
scanner.match(asciiLetter);
if (scanner.whitespace() <= 0) {
return false;
diff --git a/commonmark/src/main/java/org/commonmark/internal/renderer/NodeRendererMap.java b/commonmark/src/main/java/org/commonmark/internal/renderer/NodeRendererMap.java
index c74f90758..66f779a91 100644
--- a/commonmark/src/main/java/org/commonmark/internal/renderer/NodeRendererMap.java
+++ b/commonmark/src/main/java/org/commonmark/internal/renderer/NodeRendererMap.java
@@ -1,12 +1,11 @@
package org.commonmark.internal.renderer;
-import org.commonmark.node.Node;
-import org.commonmark.renderer.NodeRenderer;
-
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
+import org.commonmark.node.Node;
+import org.commonmark.renderer.NodeRenderer;
public class NodeRendererMap {
@@ -14,7 +13,8 @@ public class NodeRendererMap {
private final Map, NodeRenderer> renderers = new HashMap<>(32);
/**
- * Set the renderer for each {@link NodeRenderer#getNodeTypes()}, unless there was already a renderer set (first wins).
+ * Set the renderer for each {@link NodeRenderer#getNodeTypes()}, unless there was already a
+ * renderer set (first wins).
*/
public void add(NodeRenderer nodeRenderer) {
nodeRenderers.add(nodeRenderer);
diff --git a/commonmark/src/main/java/org/commonmark/internal/util/Escaping.java b/commonmark/src/main/java/org/commonmark/internal/util/Escaping.java
index caf802a43..a44110500 100644
--- a/commonmark/src/main/java/org/commonmark/internal/util/Escaping.java
+++ b/commonmark/src/main/java/org/commonmark/internal/util/Escaping.java
@@ -16,42 +16,47 @@ public class Escaping {
private static final Pattern ENTITY_OR_ESCAPED_CHAR =
Pattern.compile("\\\\" + ESCAPABLE + '|' + ENTITY, Pattern.CASE_INSENSITIVE);
- // From RFC 3986 (see "reserved", "unreserved") except don't escape '[' or ']' to be compatible with JS encodeURI
+ // From RFC 3986 (see "reserved", "unreserved") except don't escape '[' or ']' to be compatible
+ // with JS encodeURI
private static final Pattern ESCAPE_IN_URI =
Pattern.compile("(%[a-fA-F0-9]{0,2}|[^:/?#@!$&'()*+,;=a-zA-Z0-9\\-._~])");
private static final char[] HEX_DIGITS =
- new char[]{'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'};
+ new char[] {
+ '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
+ };
private static final Pattern WHITESPACE = Pattern.compile("[ \t\r\n]+");
- private static final Replacer UNESCAPE_REPLACER = (input, sb) -> {
- if (input.charAt(0) == '\\') {
- sb.append(input, 1, input.length());
- } else {
- sb.append(Html5Entities.entityToString(input));
- }
- };
-
- private static final Replacer URI_REPLACER = (input, sb) -> {
- if (input.startsWith("%")) {
- if (input.length() == 3) {
- // Already percent-encoded, preserve
- sb.append(input);
- } else {
- // %25 is the percent-encoding for %
- sb.append("%25");
- sb.append(input, 1, input.length());
- }
- } else {
- byte[] bytes = input.getBytes(StandardCharsets.UTF_8);
- for (byte b : bytes) {
- sb.append('%');
- sb.append(HEX_DIGITS[(b >> 4) & 0xF]);
- sb.append(HEX_DIGITS[b & 0xF]);
- }
- }
- };
+ private static final Replacer UNESCAPE_REPLACER =
+ (input, sb) -> {
+ if (input.charAt(0) == '\\') {
+ sb.append(input, 1, input.length());
+ } else {
+ sb.append(Html5Entities.entityToString(input));
+ }
+ };
+
+ private static final Replacer URI_REPLACER =
+ (input, sb) -> {
+ if (input.startsWith("%")) {
+ if (input.length() == 3) {
+ // Already percent-encoded, preserve
+ sb.append(input);
+ } else {
+ // %25 is the percent-encoding for %
+ sb.append("%25");
+ sb.append(input, 1, input.length());
+ }
+ } else {
+ byte[] bytes = input.getBytes(StandardCharsets.UTF_8);
+ for (byte b : bytes) {
+ sb.append('%');
+ sb.append(HEX_DIGITS[(b >> 4) & 0xF]);
+ sb.append(HEX_DIGITS[b & 0xF]);
+ }
+ }
+ };
public static String escapeHtml(String input) {
// Avoid building a new string in the majority of cases (nothing to escape)
@@ -89,9 +94,7 @@ public static String escapeHtml(String input) {
return sb != null ? sb.toString() : input;
}
- /**
- * Replace entities and backslash escapes with literal characters.
- */
+ /** Replace entities and backslash escapes with literal characters. */
public static String unescapeString(String s) {
if (BACKSLASH_OR_AMP.matcher(s).find()) {
return replaceAll(ENTITY_OR_ESCAPED_CHAR, s, UNESCAPE_REPLACER);
diff --git a/commonmark/src/main/java/org/commonmark/internal/util/Html5Entities.java b/commonmark/src/main/java/org/commonmark/internal/util/Html5Entities.java
index d6034ff14..2e92c9be8 100644
--- a/commonmark/src/main/java/org/commonmark/internal/util/Html5Entities.java
+++ b/commonmark/src/main/java/org/commonmark/internal/util/Html5Entities.java
@@ -51,7 +51,8 @@ private static Map readEntities() {
Map entities = new HashMap<>();
InputStream stream = Html5Entities.class.getResourceAsStream(ENTITY_PATH);
Charset charset = StandardCharsets.UTF_8;
- try (BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(stream, charset))) {
+ try (BufferedReader bufferedReader =
+ new BufferedReader(new InputStreamReader(stream, charset))) {
String line;
while ((line = bufferedReader.readLine()) != null) {
if (line.isEmpty()) {
@@ -63,7 +64,8 @@ private static Map readEntities() {
entities.put(key, value);
}
} catch (IOException e) {
- throw new IllegalStateException("Failed reading data for HTML named character references", e);
+ throw new IllegalStateException(
+ "Failed reading data for HTML named character references", e);
}
entities.put("NewLine", "\n");
return entities;
diff --git a/commonmark/src/main/java/org/commonmark/internal/util/LineReader.java b/commonmark/src/main/java/org/commonmark/internal/util/LineReader.java
index b44098257..a37e93c92 100644
--- a/commonmark/src/main/java/org/commonmark/internal/util/LineReader.java
+++ b/commonmark/src/main/java/org/commonmark/internal/util/LineReader.java
@@ -5,12 +5,13 @@
import java.io.Reader;
/**
- * Reads lines from a reader like {@link java.io.BufferedReader} but also returns the line terminators.
- *
- * Line terminators can be either a line feed {@code "\n"}, carriage return {@code "\r"}, or a carriage return followed
- * by a line feed {@code "\r\n"}. Call {@link #getLineTerminator()} after {@link #readLine()} to obtain the
- * corresponding line terminator. If a stream has a line at the end without a terminator, {@link #getLineTerminator()}
- * returns {@code null}.
+ * Reads lines from a reader like {@link java.io.BufferedReader} but also returns the line
+ * terminators.
+ *
+ *
Line terminators can be either a line feed {@code "\n"}, carriage return {@code "\r"}, or a
+ * carriage return followed by a line feed {@code "\r\n"}. Call {@link #getLineTerminator()} after
+ * {@link #readLine()} to obtain the corresponding line terminator. If a stream has a line at the
+ * end without a terminator, {@link #getLineTerminator()} returns {@code null}.
*/
public class LineReader implements Closeable {
@@ -34,7 +35,8 @@ public LineReader(Reader reader) {
/**
* Read a line of text.
*
- * @return the line, or {@code null} when the end of the stream has been reached and no more lines can be read
+ * @return the line, or {@code null} when the end of the stream has been reached and no more
+ * lines can be read
*/
public String readLine() throws IOException {
StringBuilder sb = null;
diff --git a/commonmark/src/main/java/org/commonmark/internal/util/LinkScanner.java b/commonmark/src/main/java/org/commonmark/internal/util/LinkScanner.java
index ffed047e5..b8072ad26 100644
--- a/commonmark/src/main/java/org/commonmark/internal/util/LinkScanner.java
+++ b/commonmark/src/main/java/org/commonmark/internal/util/LinkScanner.java
@@ -5,9 +5,9 @@
public class LinkScanner {
/**
- * Attempt to scan the contents of a link label (inside the brackets), stopping after the content or returning false.
- * The stopped position can bei either the closing {@code ]}, or the end of the line if the label continues on
- * the next line.
+ * Attempt to scan the contents of a link label (inside the brackets), stopping after the
+ * content or returning false. The stopped position can bei either the closing {@code ]}, or the
+ * end of the line if the label continues on the next line.
*/
public static boolean scanLinkLabelContent(Scanner scanner) {
while (scanner.hasNext()) {
@@ -21,8 +21,8 @@ public static boolean scanLinkLabelContent(Scanner scanner) {
case ']':
return true;
case '[':
- // spec: Unescaped square bracket characters are not allowed inside the opening and closing
- // square brackets of link labels.
+ // spec: Unescaped square bracket characters are not allowed inside the opening
+ // and closing square brackets of link labels.
return false;
default:
scanner.next();
@@ -31,9 +31,7 @@ public static boolean scanLinkLabelContent(Scanner scanner) {
return true;
}
- /**
- * Attempt to scan a link destination, stopping after the destination or returning false.
- */
+ /** Attempt to scan a link destination, stopping after the destination or returning false. */
public static boolean scanLinkDestination(Scanner scanner) {
if (!scanner.hasNext()) {
return false;
@@ -115,9 +113,9 @@ public static boolean scanLinkTitleContent(Scanner scanner, char endDelimiter) {
return true;
}
- // spec: a nonempty sequence of characters that does not start with <, does not include ASCII space or control
- // characters, and includes parentheses only if (a) they are backslash-escaped or (b) they are part of a balanced
- // pair of unescaped parentheses
+ // spec: a nonempty sequence of characters that does not start with <, does not include ASCII
+ // space or control characters, and includes parentheses only if (a) they are backslash-escaped
+ // or (b) they are part of a balanced pair of unescaped parentheses
private static boolean scanLinkDestinationWithBalancedParens(Scanner scanner) {
int parens = 0;
boolean empty = true;
diff --git a/commonmark/src/main/java/org/commonmark/node/AbstractVisitor.java b/commonmark/src/main/java/org/commonmark/node/AbstractVisitor.java
index 7edd635d7..d39112e07 100644
--- a/commonmark/src/main/java/org/commonmark/node/AbstractVisitor.java
+++ b/commonmark/src/main/java/org/commonmark/node/AbstractVisitor.java
@@ -2,9 +2,9 @@
/**
* Abstract visitor that visits all children by default.
- *
- * Can be used to only process certain nodes. If you override a method and want visiting to descend into children,
- * call {@link #visitChildren}.
+ *
+ *
Can be used to only process certain nodes. If you override a method and want visiting to
+ * descend into children, call {@link #visitChildren}.
*/
public abstract class AbstractVisitor implements Visitor {
@@ -131,8 +131,8 @@ public void visit(CustomNode customNode) {
protected void visitChildren(Node parent) {
Node node = parent.getFirstChild();
while (node != null) {
- // A subclass of this visitor might modify the node, resulting in getNext returning a different node or no
- // node after visiting it. So get the next node before visiting.
+ // A subclass of this visitor might modify the node, resulting in getNext returning a
+ // different node or no node after visiting it. So get the next node before visiting.
Node next = node.getNext();
node.accept(this);
node = next;
diff --git a/commonmark/src/main/java/org/commonmark/node/Block.java b/commonmark/src/main/java/org/commonmark/node/Block.java
index 332346b0e..2434aec62 100644
--- a/commonmark/src/main/java/org/commonmark/node/Block.java
+++ b/commonmark/src/main/java/org/commonmark/node/Block.java
@@ -1,8 +1,6 @@
package org.commonmark.node;
-/**
- * Block nodes such as paragraphs, list blocks, code blocks etc.
- */
+/** Block nodes such as paragraphs, list blocks, code blocks etc. */
public abstract class Block extends Node {
@Override
@@ -13,7 +11,8 @@ public Block getParent() {
@Override
protected void setParent(Node parent) {
if (!(parent instanceof Block)) {
- throw new IllegalArgumentException("Parent of block must also be block (can not be inline)");
+ throw new IllegalArgumentException(
+ "Parent of block must also be block (can not be inline)");
}
super.setParent(parent);
}
diff --git a/commonmark/src/main/java/org/commonmark/node/BlockQuote.java b/commonmark/src/main/java/org/commonmark/node/BlockQuote.java
index f68252398..935abaf48 100644
--- a/commonmark/src/main/java/org/commonmark/node/BlockQuote.java
+++ b/commonmark/src/main/java/org/commonmark/node/BlockQuote.java
@@ -2,11 +2,12 @@
/**
* A block quote, e.g.:
+ *
*
* > Some quoted text
*
- *
- * Note that child nodes are themselves blocks, e.g. {@link Paragraph}, {@link ListBlock} etc.
+ *
+ *
Note that child nodes are themselves blocks, e.g. {@link Paragraph}, {@link ListBlock} etc.
*
* @see CommonMark Spec
*/
diff --git a/commonmark/src/main/java/org/commonmark/node/BulletList.java b/commonmark/src/main/java/org/commonmark/node/BulletList.java
index 014f4d3b2..b5826f2c9 100644
--- a/commonmark/src/main/java/org/commonmark/node/BulletList.java
+++ b/commonmark/src/main/java/org/commonmark/node/BulletList.java
@@ -2,13 +2,14 @@
/**
* A bullet list, e.g.:
+ *
*
* - One
* - Two
* - Three
*
- *
- * The children are {@link ListItem} blocks, which contain other blocks (or nested lists).
+ *
+ *
The children are {@link ListItem} blocks, which contain other blocks (or nested lists).
*
* @see CommonMark Spec: List items
*/
@@ -22,7 +23,8 @@ public void accept(Visitor visitor) {
}
/**
- * @return the bullet list marker that was used, e.g. {@code -}, {@code *} or {@code +}, if available, or null otherwise
+ * @return the bullet list marker that was used, e.g. {@code -}, {@code *} or {@code +}, if
+ * available, or null otherwise
*/
public String getMarker() {
return marker;
diff --git a/commonmark/src/main/java/org/commonmark/node/Code.java b/commonmark/src/main/java/org/commonmark/node/Code.java
index 3b79e0c9c..4de2bc337 100644
--- a/commonmark/src/main/java/org/commonmark/node/Code.java
+++ b/commonmark/src/main/java/org/commonmark/node/Code.java
@@ -2,6 +2,7 @@
/**
* Inline code span, e.g.:
+ *
*
* Some `inline code`
*
@@ -12,8 +13,7 @@ public class Code extends Node {
private String literal;
- public Code() {
- }
+ public Code() {}
public Code(String literal) {
this.literal = literal;
@@ -25,8 +25,8 @@ public void accept(Visitor visitor) {
}
/**
- * @return the literal text in the code span (note that it's not necessarily the raw text between tildes,
- * e.g. when spaces are stripped)
+ * @return the literal text in the code span (note that it's not necessarily the raw text
+ * between tildes, e.g. when spaces are stripped)
*/
public String getLiteral() {
return literal;
diff --git a/commonmark/src/main/java/org/commonmark/node/CustomBlock.java b/commonmark/src/main/java/org/commonmark/node/CustomBlock.java
index cad88933a..3a167c057 100644
--- a/commonmark/src/main/java/org/commonmark/node/CustomBlock.java
+++ b/commonmark/src/main/java/org/commonmark/node/CustomBlock.java
@@ -1,7 +1,8 @@
package org.commonmark.node;
/**
- * A block that extensions can subclass to define custom blocks (not part of the core specification).
+ * A block that extensions can subclass to define custom blocks (not part of the core
+ * specification).
*/
public abstract class CustomBlock extends Block {
diff --git a/commonmark/src/main/java/org/commonmark/node/DefinitionMap.java b/commonmark/src/main/java/org/commonmark/node/DefinitionMap.java
index 59cb88274..09f2ddf01 100644
--- a/commonmark/src/main/java/org/commonmark/node/DefinitionMap.java
+++ b/commonmark/src/main/java/org/commonmark/node/DefinitionMap.java
@@ -1,15 +1,14 @@
package org.commonmark.node;
-import org.commonmark.internal.util.Escaping;
-
import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;
+import org.commonmark.internal.util.Escaping;
/**
- * A map that can be used to store and look up reference definitions by a label. The labels are case-insensitive and
- * normalized, the same way as for {@link LinkReferenceDefinition} nodes.
+ * A map that can be used to store and look up reference definitions by a label. The labels are
+ * case-insensitive and normalized, the same way as for {@link LinkReferenceDefinition} nodes.
*
* @param the type of value
*/
@@ -35,10 +34,10 @@ public void addAll(DefinitionMap that) {
}
/**
- * Store a new definition unless one is already in the map. If there is no definition for that label yet, return null.
- * Otherwise, return the existing definition.
- *
- * The label is normalized by the definition map before storing.
+ * Store a new definition unless one is already in the map. If there is no definition for that
+ * label yet, return null. Otherwise, return the existing definition.
+ *
+ *
The label is normalized by the definition map before storing.
*/
public D putIfAbsent(String label, D definition) {
String normalizedLabel = Escaping.normalizeLabelContent(label);
diff --git a/commonmark/src/main/java/org/commonmark/node/Delimited.java b/commonmark/src/main/java/org/commonmark/node/Delimited.java
index ef02c84ad..b6f95b1a6 100644
--- a/commonmark/src/main/java/org/commonmark/node/Delimited.java
+++ b/commonmark/src/main/java/org/commonmark/node/Delimited.java
@@ -1,8 +1,6 @@
package org.commonmark.node;
-/**
- * A node that uses delimiters in the source form (e.g. *bold*).
- */
+/** A node that uses delimiters in the source form (e.g. *bold*). */
public interface Delimited {
/**
diff --git a/commonmark/src/main/java/org/commonmark/node/Document.java b/commonmark/src/main/java/org/commonmark/node/Document.java
index b4968c206..b5ff45f6e 100644
--- a/commonmark/src/main/java/org/commonmark/node/Document.java
+++ b/commonmark/src/main/java/org/commonmark/node/Document.java
@@ -1,8 +1,6 @@
package org.commonmark.node;
-/**
- * The root block of a document, containing the top-level blocks.
- */
+/** The root block of a document, containing the top-level blocks. */
public class Document extends Block {
@Override
diff --git a/commonmark/src/main/java/org/commonmark/node/Emphasis.java b/commonmark/src/main/java/org/commonmark/node/Emphasis.java
index 5efc8c327..57e819a91 100644
--- a/commonmark/src/main/java/org/commonmark/node/Emphasis.java
+++ b/commonmark/src/main/java/org/commonmark/node/Emphasis.java
@@ -2,18 +2,19 @@
/**
* Emphasis, e.g.:
+ *
*
* Some *emphasis* or _emphasis_
*
*
- * @see CommonMark Spec: Emphasis and strong emphasis
+ * @see CommonMark Spec:
+ * Emphasis and strong emphasis
*/
public class Emphasis extends Node implements Delimited {
private String delimiter;
- public Emphasis() {
- }
+ public Emphasis() {}
public Emphasis(String delimiter) {
this.delimiter = delimiter;
diff --git a/commonmark/src/main/java/org/commonmark/node/FencedCodeBlock.java b/commonmark/src/main/java/org/commonmark/node/FencedCodeBlock.java
index 0e279a470..22922cf33 100644
--- a/commonmark/src/main/java/org/commonmark/node/FencedCodeBlock.java
+++ b/commonmark/src/main/java/org/commonmark/node/FencedCodeBlock.java
@@ -2,12 +2,14 @@
/**
* A fenced code block, e.g.:
+ *
*
* ```
* foo
* bar
* ```
*
+ *
*
*
* @see CommonMark Spec
@@ -28,7 +30,8 @@ public void accept(Visitor visitor) {
}
/**
- * @return the fence character that was used, e.g. {@code `} or {@code ~}, if available, or null otherwise
+ * @return the fence character that was used, e.g. {@code `} or {@code ~}, if available, or null
+ * otherwise
*/
public String getFenceCharacter() {
return fenceCharacter;
@@ -39,8 +42,8 @@ public void setFenceCharacter(String fenceCharacter) {
}
/**
- * @return the length of the opening fence (how many of {{@link #getFenceCharacter()}} were used to start the code
- * block) if available, or null otherwise
+ * @return the length of the opening fence (how many of {{@link #getFenceCharacter()}} were used
+ * to start the code block) if available, or null otherwise
*/
public Integer getOpeningFenceLength() {
return openingFenceLength;
@@ -55,8 +58,8 @@ public void setOpeningFenceLength(Integer openingFenceLength) {
}
/**
- * @return the length of the closing fence (how many of {@link #getFenceCharacter()} were used to end the code
- * block) if available, or null otherwise
+ * @return the length of the closing fence (how many of {@link #getFenceCharacter()} were used
+ * to end the code block) if available, or null otherwise
*/
public Integer getClosingFenceLength() {
return closingFenceLength;
@@ -102,7 +105,9 @@ public void setLiteral(String literal) {
*/
@Deprecated
public char getFenceChar() {
- return fenceCharacter != null && !fenceCharacter.isEmpty() ? fenceCharacter.charAt(0) : '\0';
+ return fenceCharacter != null && !fenceCharacter.isEmpty()
+ ? fenceCharacter.charAt(0)
+ : '\0';
}
/**
@@ -132,7 +137,8 @@ public void setFenceLength(int fenceLength) {
private static void checkFenceLengths(Integer openingFenceLength, Integer closingFenceLength) {
if (openingFenceLength != null && closingFenceLength != null) {
if (closingFenceLength < openingFenceLength) {
- throw new IllegalArgumentException("fence lengths required to be: closingFenceLength >= openingFenceLength");
+ throw new IllegalArgumentException(
+ "fence lengths required to be: closingFenceLength >= openingFenceLength");
}
}
}
diff --git a/commonmark/src/main/java/org/commonmark/node/HardLineBreak.java b/commonmark/src/main/java/org/commonmark/node/HardLineBreak.java
index 28874ec01..9d1c059b9 100644
--- a/commonmark/src/main/java/org/commonmark/node/HardLineBreak.java
+++ b/commonmark/src/main/java/org/commonmark/node/HardLineBreak.java
@@ -2,10 +2,12 @@
/**
* A hard line break, e.g.:
+ *
*
@@ -13,8 +14,7 @@ public class Image extends Node {
private String destination;
private String title;
- public Image() {
- }
+ public Image() {}
public Image(String destination, String title) {
this.destination = destination;
diff --git a/commonmark/src/main/java/org/commonmark/node/IndentedCodeBlock.java b/commonmark/src/main/java/org/commonmark/node/IndentedCodeBlock.java
index 97642b7f3..25d01c29e 100644
--- a/commonmark/src/main/java/org/commonmark/node/IndentedCodeBlock.java
+++ b/commonmark/src/main/java/org/commonmark/node/IndentedCodeBlock.java
@@ -2,12 +2,14 @@
/**
* An indented code block, e.g.:
+ *
*
* Code follows:
*
* foo
* bar
*
+ *
*
*
* @see CommonMark Spec
diff --git a/commonmark/src/main/java/org/commonmark/node/Link.java b/commonmark/src/main/java/org/commonmark/node/Link.java
index 4edc7f676..f4390a151 100644
--- a/commonmark/src/main/java/org/commonmark/node/Link.java
+++ b/commonmark/src/main/java/org/commonmark/node/Link.java
@@ -2,21 +2,24 @@
/**
* A link with a destination and an optional title; the link text is in child nodes.
- *
- * Example for an inline link in a CommonMark document:
+ *
+ *
Example for an inline link in a CommonMark document:
+ *
*
* [link](/uri "title")
*
- *
- * The corresponding Link node would look like this:
+ *
+ *
The corresponding Link node would look like this:
+ *
*
A {@link Text} child node with {@link Text#getLiteral() getLiteral} that returns {@code
+ * "link"}
*
- *
- * Note that the text in the link can contain inline formatting, so it could also contain an {@link Image} or
- * {@link Emphasis}, etc.
+ *
+ *
Note that the text in the link can contain inline formatting, so it could also contain an
+ * {@link Image} or {@link Emphasis}, etc.
*
* @see CommonMark Spec
*/
@@ -25,8 +28,7 @@ public class Link extends Node {
private String destination;
private String title;
- public Link() {
- }
+ public Link() {}
public Link(String destination, String title) {
this.destination = destination;
diff --git a/commonmark/src/main/java/org/commonmark/node/LinkReferenceDefinition.java b/commonmark/src/main/java/org/commonmark/node/LinkReferenceDefinition.java
index b866781f0..54321cb63 100644
--- a/commonmark/src/main/java/org/commonmark/node/LinkReferenceDefinition.java
+++ b/commonmark/src/main/java/org/commonmark/node/LinkReferenceDefinition.java
@@ -2,12 +2,13 @@
/**
* A link reference definition, e.g.:
+ *
*
* [foo]: /url "title"
*
- *
- * They can be referenced anywhere else in the document to produce a link using [foo]. The definitions
- * themselves are usually not rendered in the final output.
+ *
+ *
They can be referenced anywhere else in the document to produce a link using [foo]
+ * . The definitions themselves are usually not rendered in the final output.
*
* @see CommonMark Spec
*/
@@ -17,8 +18,7 @@ public class LinkReferenceDefinition extends Block {
private String destination;
private String title;
- public LinkReferenceDefinition() {
- }
+ public LinkReferenceDefinition() {}
public LinkReferenceDefinition(String label, String destination, String title) {
this.label = label;
diff --git a/commonmark/src/main/java/org/commonmark/node/ListBlock.java b/commonmark/src/main/java/org/commonmark/node/ListBlock.java
index 1290bc622..d210a6b27 100644
--- a/commonmark/src/main/java/org/commonmark/node/ListBlock.java
+++ b/commonmark/src/main/java/org/commonmark/node/ListBlock.java
@@ -1,8 +1,6 @@
package org.commonmark.node;
-/**
- * A list block like {@link BulletList} or {@link OrderedList}.
- */
+/** A list block like {@link BulletList} or {@link OrderedList}. */
public abstract class ListBlock extends Block {
private boolean tight;
@@ -18,5 +16,4 @@ public boolean isTight() {
public void setTight(boolean tight) {
this.tight = tight;
}
-
}
diff --git a/commonmark/src/main/java/org/commonmark/node/ListItem.java b/commonmark/src/main/java/org/commonmark/node/ListItem.java
index c4d1214e7..a53cbbe74 100644
--- a/commonmark/src/main/java/org/commonmark/node/ListItem.java
+++ b/commonmark/src/main/java/org/commonmark/node/ListItem.java
@@ -1,11 +1,12 @@
package org.commonmark.node;
/**
- * A child of a {@link ListBlock}, containing other blocks (e.g. {@link Paragraph}, other lists, etc).
- *
- * Note that a list item can't directly contain {@link Text}, it needs to be:
- * {@link ListItem} : {@link Paragraph} : {@link Text}.
- * If you want a list that is rendered tightly, create a list with {@link ListBlock#setTight(boolean)}.
+ * A child of a {@link ListBlock}, containing other blocks (e.g. {@link Paragraph}, other lists,
+ * etc).
+ *
+ *
Note that a list item can't directly contain {@link Text}, it needs to be: {@link ListItem} :
+ * {@link Paragraph} : {@link Text}. If you want a list that is rendered tightly, create a list with
+ * {@link ListBlock#setTight(boolean)}.
*
* @see CommonMark Spec: List items
*/
@@ -20,15 +21,21 @@ public void accept(Visitor visitor) {
}
/**
- * Returns the indent of the marker such as "-" or "1." in columns (spaces or tab stop of 4) if available, or null
- * otherwise.
- *
- * Some examples and their marker indent:
+ * Returns the indent of the marker such as "-" or "1." in columns (spaces or tab stop of 4) if
+ * available, or null otherwise.
+ *
+ *
Some examples and their marker indent:
+ *
*
- Foo
+ *
* Marker indent: 0
+ *
*
- Foo
+ *
* Marker indent: 1
+ *
*
1. Foo
+ *
* Marker indent: 2
*/
public Integer getMarkerIndent() {
@@ -40,19 +47,26 @@ public void setMarkerIndent(Integer markerIndent) {
}
/**
- * Returns the indent of the content in columns (spaces or tab stop of 4) if available, or null otherwise.
- * The content indent is counted from the beginning of the line and includes the marker on the first line.
- *
- * Some examples and their content indent:
+ * Returns the indent of the content in columns (spaces or tab stop of 4) if available, or null
+ * otherwise. The content indent is counted from the beginning of the line and includes the
+ * marker on the first line.
+ *
+ *
Some examples and their content indent:
+ *
*
- Foo
+ *
* Content indent: 2
+ *
*
- Foo
+ *
* Content indent: 3
+ *
*
1. Foo
+ *
* Content indent: 5
- *
- * Note that subsequent lines in the same list item need to be indented by at least the content indent to be counted
- * as part of the list item.
+ *
+ *
Note that subsequent lines in the same list item need to be indented by at least the
+ * content indent to be counted as part of the list item.
*/
public Integer getContentIndent() {
return contentIndent;
@@ -63,8 +77,8 @@ public void setContentIndent(Integer contentIndent) {
}
/**
- * @deprecated list items should only contain block nodes; if you're trying to create a list that is rendered
- * without paragraphs, use {@link ListBlock#setTight(boolean)} instead.
+ * @deprecated list items should only contain block nodes; if you're trying to create a list
+ * that is rendered without paragraphs, use {@link ListBlock#setTight(boolean)} instead.
*/
@Override
@Deprecated
diff --git a/commonmark/src/main/java/org/commonmark/node/Node.java b/commonmark/src/main/java/org/commonmark/node/Node.java
index abbda67f2..adc64838c 100644
--- a/commonmark/src/main/java/org/commonmark/node/Node.java
+++ b/commonmark/src/main/java/org/commonmark/node/Node.java
@@ -6,8 +6,8 @@
/**
* The base class of all CommonMark AST nodes ({@link Block} and inlines).
- *
- * A node can have multiple children, and a parent (except for the root node).
+ *
+ *
A node can have multiple children, and a parent (except for the root node).
*/
public abstract class Node {
@@ -85,9 +85,7 @@ public void unlink() {
this.prev = null;
}
- /**
- * Inserts the {@code sibling} node after {@code this} node.
- */
+ /** Inserts the {@code sibling} node after {@code this} node. */
public void insertAfter(Node sibling) {
sibling.unlink();
sibling.next = this.next;
@@ -102,9 +100,7 @@ public void insertAfter(Node sibling) {
}
}
- /**
- * Inserts the {@code sibling} node before {@code this} node.
- */
+ /** Inserts the {@code sibling} node before {@code this} node. */
public void insertBefore(Node sibling) {
sibling.unlink();
sibling.prev = this.prev;
diff --git a/commonmark/src/main/java/org/commonmark/node/Nodes.java b/commonmark/src/main/java/org/commonmark/node/Nodes.java
index 22d5932af..71e0925db 100644
--- a/commonmark/src/main/java/org/commonmark/node/Nodes.java
+++ b/commonmark/src/main/java/org/commonmark/node/Nodes.java
@@ -9,12 +9,9 @@
*/
public class Nodes {
- private Nodes() {
- }
+ private Nodes() {}
- /**
- * The nodes between (not including) start and end.
- */
+ /** The nodes between (not including) start and end. */
public static Iterable between(Node start, Node end) {
return new NodeIterable(start.getNext(), end);
}
@@ -63,4 +60,3 @@ public void remove() {
}
}
}
-
diff --git a/commonmark/src/main/java/org/commonmark/node/OrderedList.java b/commonmark/src/main/java/org/commonmark/node/OrderedList.java
index 61f8902c0..70cfd62c2 100644
--- a/commonmark/src/main/java/org/commonmark/node/OrderedList.java
+++ b/commonmark/src/main/java/org/commonmark/node/OrderedList.java
@@ -2,13 +2,14 @@
/**
* An ordered list, e.g.:
+ *
*
* 1. One
* 2. Two
* 3. Three
*
- *
- * The children are {@link ListItem} blocks, which contain other blocks (or nested lists).
+ *
+ *
The children are {@link ListItem} blocks, which contain other blocks (or nested lists).
*
* @see CommonMark Spec: List items
*/
@@ -34,7 +35,8 @@ public void setMarkerStartNumber(Integer markerStartNumber) {
}
/**
- * @return the delimiter used in the marker, e.g. {@code .} or {@code )}, if available, or null otherwise
+ * @return the delimiter used in the marker, e.g. {@code .} or {@code )}, if available, or null
+ * otherwise
*/
public String getMarkerDelimiter() {
return markerDelimiter;
@@ -65,7 +67,9 @@ public void setStartNumber(int startNumber) {
*/
@Deprecated
public char getDelimiter() {
- return markerDelimiter != null && !markerDelimiter.isEmpty() ? markerDelimiter.charAt(0) : '\0';
+ return markerDelimiter != null && !markerDelimiter.isEmpty()
+ ? markerDelimiter.charAt(0)
+ : '\0';
}
/**
diff --git a/commonmark/src/main/java/org/commonmark/node/SoftLineBreak.java b/commonmark/src/main/java/org/commonmark/node/SoftLineBreak.java
index 87445db56..21ba09411 100644
--- a/commonmark/src/main/java/org/commonmark/node/SoftLineBreak.java
+++ b/commonmark/src/main/java/org/commonmark/node/SoftLineBreak.java
@@ -2,6 +2,7 @@
/**
* A soft line break (as opposed to a {@link HardLineBreak}), e.g. between:
+ *
*
* foo
* bar
diff --git a/commonmark/src/main/java/org/commonmark/node/SourceSpan.java b/commonmark/src/main/java/org/commonmark/node/SourceSpan.java
index 6558cc84a..ab797cb18 100644
--- a/commonmark/src/main/java/org/commonmark/node/SourceSpan.java
+++ b/commonmark/src/main/java/org/commonmark/node/SourceSpan.java
@@ -4,22 +4,26 @@
/**
* A source span references a snippet of text from the source input.
- *
- * It has a starting position (line and column index) and a length of how many characters it spans.
- *
- * For example, this CommonMark source text:
+ *
+ *
It has a starting position (line and column index) and a length of how many characters it
+ * spans.
+ *
+ *
For example, this CommonMark source text:
+ *
*
* > foo
*
+ *
* The {@link BlockQuote} node would have this source span: line 0, column 0, length 5.
- *
- * The {@link Paragraph} node inside it would have: line 0, column 2, length 3.
- *
- * If a block has multiple lines, it will have a source span for each line.
- *
- * Note that the column index and length are measured in Java characters (UTF-16 code units). If you're outputting them
- * to be consumed by another programming language, e.g. one that uses UTF-8 strings, you will need to translate them,
- * otherwise characters such as emojis will result in incorrect positions.
+ *
+ *
The {@link Paragraph} node inside it would have: line 0, column 2, length 3.
+ *
+ *
If a block has multiple lines, it will have a source span for each line.
+ *
+ *
Note that the column index and length are measured in Java characters (UTF-16 code units). If
+ * you're outputting them to be consumed by another programming language, e.g. one that uses UTF-8
+ * strings, you will need to translate them, otherwise characters such as emojis will result in
+ * incorrect positions.
*
* @since 0.16.0
*/
@@ -35,8 +39,8 @@ public static SourceSpan of(int line, int col, int input, int length) {
}
/**
- * @deprecated Use {{@link #of(int, int, int, int)}} instead to also specify input index. Using the deprecated one
- * will set {@link #inputIndex} to 0.
+ * @deprecated Use {{@link #of(int, int, int, int)}} instead to also specify input index. Using
+ * the deprecated one will set {@link #inputIndex} to 0.
*/
@Deprecated
public static SourceSpan of(int lineIndex, int columnIndex, int length) {
@@ -70,8 +74,8 @@ public int getLineIndex() {
}
/**
- * @return 0-based index of column (character on line) in source, e.g. 0 for the first character of a line, 1 for
- * the second character, etc
+ * @return 0-based index of column (character on line) in source, e.g. 0 for the first character
+ * of a line, 1 for the second character, etc
*/
public int getColumnIndex() {
return columnIndex;
@@ -101,21 +105,28 @@ public SourceSpan subSpan(int beginIndex, int endIndex) {
throw new IndexOutOfBoundsException("beginIndex " + beginIndex + " + must be >= 0");
}
if (beginIndex > length) {
- throw new IndexOutOfBoundsException("beginIndex " + beginIndex + " must be <= length " + length);
+ throw new IndexOutOfBoundsException(
+ "beginIndex " + beginIndex + " must be <= length " + length);
}
if (endIndex < 0) {
throw new IndexOutOfBoundsException("endIndex " + endIndex + " + must be >= 0");
}
if (endIndex > length) {
- throw new IndexOutOfBoundsException("endIndex " + endIndex + " must be <= length " + length);
+ throw new IndexOutOfBoundsException(
+ "endIndex " + endIndex + " must be <= length " + length);
}
if (beginIndex > endIndex) {
- throw new IndexOutOfBoundsException("beginIndex " + beginIndex + " must be <= endIndex " + endIndex);
+ throw new IndexOutOfBoundsException(
+ "beginIndex " + beginIndex + " must be <= endIndex " + endIndex);
}
if (beginIndex == 0 && endIndex == length) {
return this;
}
- return new SourceSpan(lineIndex, columnIndex + beginIndex, inputIndex + beginIndex, endIndex - beginIndex);
+ return new SourceSpan(
+ lineIndex,
+ columnIndex + beginIndex,
+ inputIndex + beginIndex,
+ endIndex - beginIndex);
}
@Override
@@ -127,10 +138,10 @@ public boolean equals(Object o) {
return false;
}
SourceSpan that = (SourceSpan) o;
- return lineIndex == that.lineIndex &&
- columnIndex == that.columnIndex &&
- inputIndex == that.inputIndex &&
- length == that.length;
+ return lineIndex == that.lineIndex
+ && columnIndex == that.columnIndex
+ && inputIndex == that.inputIndex
+ && length == that.length;
}
@Override
@@ -140,11 +151,15 @@ public int hashCode() {
@Override
public String toString() {
- return "SourceSpan{" +
- "line=" + lineIndex +
- ", column=" + columnIndex +
- ", input=" + inputIndex +
- ", length=" + length +
- "}";
+ return "SourceSpan{"
+ + "line="
+ + lineIndex
+ + ", column="
+ + columnIndex
+ + ", input="
+ + inputIndex
+ + ", length="
+ + length
+ + "}";
}
}
diff --git a/commonmark/src/main/java/org/commonmark/node/SourceSpans.java b/commonmark/src/main/java/org/commonmark/node/SourceSpans.java
index 975d7fbdb..945f1c19a 100644
--- a/commonmark/src/main/java/org/commonmark/node/SourceSpans.java
+++ b/commonmark/src/main/java/org/commonmark/node/SourceSpans.java
@@ -42,7 +42,13 @@ public void addAll(List other) {
SourceSpan a = sourceSpans.get(lastIndex);
SourceSpan b = other.get(0);
if (a.getInputIndex() + a.getLength() == b.getInputIndex()) {
- sourceSpans.set(lastIndex, SourceSpan.of(a.getLineIndex(), a.getColumnIndex(), a.getInputIndex(), a.getLength() + b.getLength()));
+ sourceSpans.set(
+ lastIndex,
+ SourceSpan.of(
+ a.getLineIndex(),
+ a.getColumnIndex(),
+ a.getInputIndex(),
+ a.getLength() + b.getLength()));
sourceSpans.addAll(other.subList(1, other.size()));
} else {
sourceSpans.addAll(other);
diff --git a/commonmark/src/main/java/org/commonmark/node/StrongEmphasis.java b/commonmark/src/main/java/org/commonmark/node/StrongEmphasis.java
index 0dbeed3df..f09786f84 100644
--- a/commonmark/src/main/java/org/commonmark/node/StrongEmphasis.java
+++ b/commonmark/src/main/java/org/commonmark/node/StrongEmphasis.java
@@ -2,18 +2,19 @@
/**
* Strong emphasis, e.g.:
+ *
*
* Some **strong emphasis** or __strong emphasis__
*
*
- * @see CommonMark Spec: Emphasis and strong emphasis
+ * @see CommonMark Spec:
+ * Emphasis and strong emphasis
*/
public class StrongEmphasis extends Node implements Delimited {
private String delimiter;
- public StrongEmphasis() {
- }
+ public StrongEmphasis() {}
public StrongEmphasis(String delimiter) {
this.delimiter = delimiter;
diff --git a/commonmark/src/main/java/org/commonmark/node/Text.java b/commonmark/src/main/java/org/commonmark/node/Text.java
index 9a04c41c1..5367f2f3f 100644
--- a/commonmark/src/main/java/org/commonmark/node/Text.java
+++ b/commonmark/src/main/java/org/commonmark/node/Text.java
@@ -2,11 +2,13 @@
/**
* A text node, e.g. in:
+ *
*
* foo *bar*
*
- *
- * The foo is a text node, and the bar inside the emphasis is also a text node.
+ *
+ *
The foo is a text node, and the bar inside the emphasis is also a
+ * text node.
*
* @see CommonMark Spec
*/
@@ -14,8 +16,7 @@ public class Text extends Node {
private String literal;
- public Text() {
- }
+ public Text() {}
public Text(String literal) {
this.literal = literal;
diff --git a/commonmark/src/main/java/org/commonmark/node/ThematicBreak.java b/commonmark/src/main/java/org/commonmark/node/ThematicBreak.java
index a31131e07..e2391f57d 100644
--- a/commonmark/src/main/java/org/commonmark/node/ThematicBreak.java
+++ b/commonmark/src/main/java/org/commonmark/node/ThematicBreak.java
@@ -2,6 +2,7 @@
/**
* A thematic break, e.g. between text:
+ *
*
* Some text
*
diff --git a/commonmark/src/main/java/org/commonmark/node/Visitor.java b/commonmark/src/main/java/org/commonmark/node/Visitor.java
index a155296f0..0e3fc9f84 100644
--- a/commonmark/src/main/java/org/commonmark/node/Visitor.java
+++ b/commonmark/src/main/java/org/commonmark/node/Visitor.java
@@ -2,8 +2,8 @@
/**
* Node visitor.
- *
- * Implementations should subclass {@link AbstractVisitor} instead of implementing this directly.
+ *
+ *
Implementations should subclass {@link AbstractVisitor} instead of implementing this directly.
*/
public interface Visitor {
diff --git a/commonmark/src/main/java/org/commonmark/node/package-info.java b/commonmark/src/main/java/org/commonmark/node/package-info.java
index e9fee1aba..3408d2e72 100644
--- a/commonmark/src/main/java/org/commonmark/node/package-info.java
+++ b/commonmark/src/main/java/org/commonmark/node/package-info.java
@@ -1,4 +1,5 @@
/**
- * AST node types (see {@link org.commonmark.node.Node}) and visitors (see {@link org.commonmark.node.AbstractVisitor})
+ * AST node types (see {@link org.commonmark.node.Node}) and visitors (see {@link
+ * org.commonmark.node.AbstractVisitor})
*/
package org.commonmark.node;
diff --git a/commonmark/src/main/java/org/commonmark/package-info.java b/commonmark/src/main/java/org/commonmark/package-info.java
index b683017f6..9ff3301e9 100644
--- a/commonmark/src/main/java/org/commonmark/package-info.java
+++ b/commonmark/src/main/java/org/commonmark/package-info.java
@@ -1,10 +1,11 @@
/**
* Root package of commonmark-java
+ *
*
- *
{@link org.commonmark.parser} for parsing input text to AST nodes
- *
{@link org.commonmark.node} for AST node types and visitors
- *
{@link org.commonmark.renderer.html} for HTML rendering
- *
{@link org.commonmark.renderer.markdown} for Markdown rendering
+ *
{@link org.commonmark.parser} for parsing input text to AST nodes
+ *
{@link org.commonmark.node} for AST node types and visitors
+ *
{@link org.commonmark.renderer.html} for HTML rendering
+ *
{@link org.commonmark.renderer.markdown} for Markdown rendering
*
*/
package org.commonmark;
diff --git a/commonmark/src/main/java/org/commonmark/parser/IncludeSourceSpans.java b/commonmark/src/main/java/org/commonmark/parser/IncludeSourceSpans.java
index 91d2b4e00..f53378c2f 100644
--- a/commonmark/src/main/java/org/commonmark/parser/IncludeSourceSpans.java
+++ b/commonmark/src/main/java/org/commonmark/parser/IncludeSourceSpans.java
@@ -1,22 +1,16 @@
package org.commonmark.parser;
/**
- * Whether to include {@link org.commonmark.node.SourceSpan} or not while parsing,
- * see {@link Parser.Builder#includeSourceSpans(IncludeSourceSpans)}.
+ * Whether to include {@link org.commonmark.node.SourceSpan} or not while parsing, see {@link
+ * Parser.Builder#includeSourceSpans(IncludeSourceSpans)}.
*
* @since 0.16.0
*/
public enum IncludeSourceSpans {
- /**
- * Do not include source spans.
- */
+ /** Do not include source spans. */
NONE,
- /**
- * Include source spans on {@link org.commonmark.node.Block} nodes.
- */
+ /** Include source spans on {@link org.commonmark.node.Block} nodes. */
BLOCKS,
- /**
- * Include source spans on block nodes and inline nodes.
- */
+ /** Include source spans on block nodes and inline nodes. */
BLOCKS_AND_INLINES,
}
diff --git a/commonmark/src/main/java/org/commonmark/parser/InlineParser.java b/commonmark/src/main/java/org/commonmark/parser/InlineParser.java
index 49043a64f..1c6714686 100644
--- a/commonmark/src/main/java/org/commonmark/parser/InlineParser.java
+++ b/commonmark/src/main/java/org/commonmark/parser/InlineParser.java
@@ -2,9 +2,7 @@
import org.commonmark.node.Node;
-/**
- * Parser for inline content (text, links, emphasized text, etc).
- */
+/** Parser for inline content (text, links, emphasized text, etc). */
public interface InlineParser {
/**
diff --git a/commonmark/src/main/java/org/commonmark/parser/InlineParserContext.java b/commonmark/src/main/java/org/commonmark/parser/InlineParserContext.java
index 12007610b..774773273 100644
--- a/commonmark/src/main/java/org/commonmark/parser/InlineParserContext.java
+++ b/commonmark/src/main/java/org/commonmark/parser/InlineParserContext.java
@@ -1,32 +1,30 @@
package org.commonmark.parser;
+import java.util.List;
+import java.util.Set;
import org.commonmark.node.LinkReferenceDefinition;
-import org.commonmark.parser.beta.LinkProcessor;
import org.commonmark.parser.beta.InlineContentParserFactory;
+import org.commonmark.parser.beta.LinkProcessor;
import org.commonmark.parser.delimiter.DelimiterProcessor;
-import java.util.List;
-import java.util.Set;
-
-/**
- * Context for inline parsing.
- */
+/** Context for inline parsing. */
public interface InlineParserContext {
/**
- * @return custom inline content parsers that have been configured with
- * {@link Parser.Builder#customInlineContentParserFactory(InlineContentParserFactory)}
+ * @return custom inline content parsers that have been configured with {@link
+ * Parser.Builder#customInlineContentParserFactory(InlineContentParserFactory)}
*/
List getCustomInlineContentParserFactories();
/**
- * @return custom delimiter processors that have been configured with
- * {@link Parser.Builder#customDelimiterProcessor(DelimiterProcessor)}
+ * @return custom delimiter processors that have been configured with {@link
+ * Parser.Builder#customDelimiterProcessor(DelimiterProcessor)}
*/
List getCustomDelimiterProcessors();
/**
- * @return custom link processors that have been configured with {@link Parser.Builder#linkProcessor}.
+ * @return custom link processors that have been configured with {@link
+ * Parser.Builder#linkProcessor}.
*/
List getCustomLinkProcessors();
@@ -37,9 +35,9 @@ public interface InlineParserContext {
/**
* Look up a {@link LinkReferenceDefinition} for a given label.
- *
- * Note that the passed in label does not need to be normalized; implementations are responsible for doing the
- * normalization before lookup.
+ *
+ *
Note that the passed in label does not need to be normalized; implementations are
+ * responsible for doing the normalization before lookup.
*
* @param label the link label to look up
* @return the definition if one exists, {@code null} otherwise
@@ -50,9 +48,9 @@ public interface InlineParserContext {
/**
* Look up a definition of a type for a given label.
- *
- * Note that the passed in label does not need to be normalized; implementations are responsible for doing the
- * normalization before lookup.
+ *
+ *
Note that the passed in label does not need to be normalized; implementations are
+ * responsible for doing the normalization before lookup.
*
* @return the definition if one exists, null otherwise
*/
diff --git a/commonmark/src/main/java/org/commonmark/parser/InlineParserFactory.java b/commonmark/src/main/java/org/commonmark/parser/InlineParserFactory.java
index c1640e9d8..0eaac3c30 100644
--- a/commonmark/src/main/java/org/commonmark/parser/InlineParserFactory.java
+++ b/commonmark/src/main/java/org/commonmark/parser/InlineParserFactory.java
@@ -1,12 +1,11 @@
package org.commonmark.parser;
-/**
- * Factory for custom inline parser.
- */
+/** Factory for custom inline parser. */
public interface InlineParserFactory {
/**
- * Create an {@link InlineParser} to use for parsing inlines. This is called once per parsed document.
+ * Create an {@link InlineParser} to use for parsing inlines. This is called once per parsed
+ * document.
*/
InlineParser create(InlineParserContext inlineParserContext);
}
diff --git a/commonmark/src/main/java/org/commonmark/parser/Parser.java b/commonmark/src/main/java/org/commonmark/parser/Parser.java
index 8faac789b..23fd75f68 100644
--- a/commonmark/src/main/java/org/commonmark/parser/Parser.java
+++ b/commonmark/src/main/java/org/commonmark/parser/Parser.java
@@ -1,27 +1,26 @@
package org.commonmark.parser;
+import java.io.IOException;
+import java.io.Reader;
+import java.util.*;
import org.commonmark.Extension;
import org.commonmark.internal.Definitions;
import org.commonmark.internal.DocumentParser;
import org.commonmark.internal.InlineParserContextImpl;
import org.commonmark.internal.InlineParserImpl;
import org.commonmark.node.*;
+import org.commonmark.parser.beta.InlineContentParserFactory;
import org.commonmark.parser.beta.LinkInfo;
import org.commonmark.parser.beta.LinkProcessor;
-import org.commonmark.parser.beta.InlineContentParserFactory;
import org.commonmark.parser.beta.LinkResult;
import org.commonmark.parser.block.BlockParserFactory;
import org.commonmark.parser.delimiter.DelimiterProcessor;
-import java.io.IOException;
-import java.io.Reader;
-import java.util.*;
-
-
/**
* Parses input text to a tree of nodes.
- *
- * Start with the {@link #builder} method, configure the parser and build it. Example:
+ *
+ *
Start with the {@link #builder} method, configure the parser and build it. Example:
+ *
*
* Parser parser = Parser.builder().build();
* Node document = parser.parse("input text");
@@ -40,7 +39,9 @@ public class Parser {
private final int maxOpenBlockParsers;
private Parser(Builder builder) {
- this.blockParserFactories = DocumentParser.calculateBlockParserFactories(builder.blockParserFactories, builder.enabledBlockTypes);
+ this.blockParserFactories =
+ DocumentParser.calculateBlockParserFactories(
+ builder.blockParserFactories, builder.enabledBlockTypes);
this.inlineParserFactory = builder.getInlineParserFactory();
this.postProcessors = builder.postProcessors;
this.inlineContentParserFactories = builder.inlineContentParserFactories;
@@ -50,10 +51,15 @@ private Parser(Builder builder) {
this.includeSourceSpans = builder.includeSourceSpans;
this.maxOpenBlockParsers = builder.maxOpenBlockParsers;
- // Try to construct an inline parser. Invalid configuration might result in an exception, which we want to
- // detect as soon as possible.
- var context = new InlineParserContextImpl(
- inlineContentParserFactories, delimiterProcessors, linkProcessors, linkMarkers, new Definitions());
+ // Try to construct an inline parser. Invalid configuration might result in an exception,
+ // which we want to detect as soon as possible.
+ var context =
+ new InlineParserContextImpl(
+ inlineContentParserFactories,
+ delimiterProcessors,
+ linkProcessors,
+ linkMarkers,
+ new Definitions());
this.inlineParserFactory.create(context);
}
@@ -68,8 +74,8 @@ public static Builder builder() {
/**
* Parse the specified input text into a tree of nodes.
- *
- * This method is thread-safe (a new parser state is used for each invocation).
+ *
+ *
This method is thread-safe (a new parser state is used for each invocation).
*
* @param input the text to parse - must not be null
* @return the root node
@@ -82,7 +88,9 @@ public Node parse(String input) {
}
/**
- * Parse the specified reader into a tree of nodes. The caller is responsible for closing the reader.
+ * Parse the specified reader into a tree of nodes. The caller is responsible for closing the
+ * reader.
+ *
*
- * Note that if you have a file with a byte order mark (BOM), you need to skip it before handing the reader to this
- * library. There's existing classes that do that, e.g. see {@code BOMInputStream} in Commons IO.
- *
- * This method is thread-safe (a new parser state is used for each invocation).
+ *
+ * Note that if you have a file with a byte order mark (BOM), you need to skip it before handing
+ * the reader to this library. There's existing classes that do that, e.g. see {@code
+ * BOMInputStream} in Commons IO.
+ *
+ *
This method is thread-safe (a new parser state is used for each invocation).
*
* @param input the reader to parse - must not be null
* @return the root node
@@ -107,8 +117,15 @@ public Node parseReader(Reader input) throws IOException {
}
private DocumentParser createDocumentParser() {
- return new DocumentParser(blockParserFactories, inlineParserFactory, inlineContentParserFactories,
- delimiterProcessors, linkProcessors, linkMarkers, includeSourceSpans, maxOpenBlockParsers);
+ return new DocumentParser(
+ blockParserFactories,
+ inlineParserFactory,
+ inlineContentParserFactories,
+ delimiterProcessors,
+ linkProcessors,
+ linkMarkers,
+ includeSourceSpans,
+ maxOpenBlockParsers);
}
private Node postProcess(Node document) {
@@ -118,17 +135,17 @@ private Node postProcess(Node document) {
return document;
}
- /**
- * Builder for configuring a {@link Parser}.
- */
+ /** Builder for configuring a {@link Parser}. */
public static class Builder {
private final List blockParserFactories = new ArrayList<>();
- private final List inlineContentParserFactories = new ArrayList<>();
+ private final List inlineContentParserFactories =
+ new ArrayList<>();
private final List delimiterProcessors = new ArrayList<>();
private final List linkProcessors = new ArrayList<>();
private final List postProcessors = new ArrayList<>();
private final Set linkMarkers = new HashSet<>();
- private Set> enabledBlockTypes = DocumentParser.getDefaultBlockParserTypes();
+ private Set> enabledBlockTypes =
+ DocumentParser.getDefaultBlockParserTypes();
private InlineParserFactory inlineParserFactory;
private IncludeSourceSpans includeSourceSpans = IncludeSourceSpans.NONE;
private int maxOpenBlockParsers = Integer.MAX_VALUE;
@@ -157,29 +174,31 @@ public Builder extensions(Iterable extensions) {
/**
* Describe the list of markdown features the parser will recognize and parse.
- *
- * By default, CommonMark will recognize and parse the following set of "block" elements:
+ *
+ *
By default, CommonMark will recognize and parse the following set of "block" elements:
+ *
*
*
- * @param enabledBlockTypes A list of block nodes the parser will parse.
- * If this list is empty, the parser will not recognize any CommonMark core features.
+ *
To parse only a subset of the features listed above, pass a list of each feature's
+ * associated {@link Block} class.
+ *
+ *
+ *
+ * @param enabledBlockTypes A list of block nodes the parser will parse. If this list is
+ * empty, the parser will not recognize any CommonMark core features.
* @return {@code this}
*/
public Builder enabledBlockTypes(Set> enabledBlockTypes) {
@@ -190,9 +209,10 @@ public Builder enabledBlockTypes(Set> enabledBlockTypes)
}
/**
- * Whether to calculate source positions for parsed {@link Node Nodes}, see {@link Node#getSourceSpans()}.
- *
- * By default, source spans are disabled.
+ * Whether to calculate source positions for parsed {@link Node Nodes}, see {@link
+ * Node#getSourceSpans()}.
+ *
+ *
By default, source spans are disabled.
*
* @param includeSourceSpans which kind of source spans should be included
* @return {@code this}
@@ -205,12 +225,12 @@ public Builder includeSourceSpans(IncludeSourceSpans includeSourceSpans) {
/**
* Limit how many block parsers may be open at once while parsing.
- *
- * Once the limit is reached, additional block starts are treated as plain text instead of
- * creating deeper nested block structure.
- *
- * The document root parser is not counted. The default is unlimited, so callers that keep
- * using {@code Parser.builder().build()} preserve behavior.
+ *
+ *
Once the limit is reached, additional block starts are treated as plain text instead
+ * of creating deeper nested block structure.
+ *
+ *
The document root parser is not counted. The default is unlimited, so callers that
+ * keep using {@code Parser.builder().build()} preserve behavior.
*
* @param maxOpenBlockParsers maximum number of open non-document block parsers, must be
* zero or greater
@@ -226,10 +246,10 @@ public Builder maxOpenBlockParsers(int maxOpenBlockParsers) {
/**
* Add a custom block parser factory.
- *
- * Note that custom factories are applied before the built-in factories. This is so that
- * extensions can change how some syntax is parsed that would otherwise be handled by built-in factories.
- * "With great power comes great responsibility."
+ *
+ *
Note that custom factories are applied before the built-in factories. This is
+ * so that extensions can change how some syntax is parsed that would otherwise be handled
+ * by built-in factories. "With great power comes great responsibility."
*
* @param blockParserFactory a block parser factory implementation
* @return {@code this}
@@ -241,28 +261,33 @@ public Builder customBlockParserFactory(BlockParserFactory blockParserFactory) {
}
/**
- * Add a factory for a custom inline content parser, for extending inline parsing or overriding built-in parsing.
- *
- * Note that parsers are triggered based on a special character as specified by
- * {@link InlineContentParserFactory#getTriggerCharacters()}. It is possible to register multiple parsers for the same
- * character, or even for some built-in special character such as {@code `}. The custom parsers are tried first
- * in order in which they are registered, and then the built-in ones.
+ * Add a factory for a custom inline content parser, for extending inline parsing or
+ * overriding built-in parsing.
+ *
+ *
Note that parsers are triggered based on a special character as specified by {@link
+ * InlineContentParserFactory#getTriggerCharacters()}. It is possible to register multiple
+ * parsers for the same character, or even for some built-in special character such as
+ * {@code `}. The custom parsers are tried first in order in which they are registered, and
+ * then the built-in ones.
*/
- public Builder customInlineContentParserFactory(InlineContentParserFactory inlineContentParserFactory) {
- Objects.requireNonNull(inlineContentParserFactory, "inlineContentParser must not be null");
+ public Builder customInlineContentParserFactory(
+ InlineContentParserFactory inlineContentParserFactory) {
+ Objects.requireNonNull(
+ inlineContentParserFactory, "inlineContentParser must not be null");
inlineContentParserFactories.add(inlineContentParserFactory);
return this;
}
/**
* Add a custom delimiter processor for inline parsing.
- *
- * Note that multiple delimiter processors with the same characters can be added, as long as they have a
- * different minimum length. In that case, the processor with the shortest matching length is used. Adding more
- * than one delimiter processor with the same character and minimum length is invalid.
- *
- * If you want more control over how parsing is done, you might want to use
- * {@link #customInlineContentParserFactory} instead.
+ *
+ *
Note that multiple delimiter processors with the same characters can be added, as long
+ * as they have a different minimum length. In that case, the processor with the shortest
+ * matching length is used. Adding more than one delimiter processor with the same character
+ * and minimum length is invalid.
+ *
+ *
If you want more control over how parsing is done, you might want to use {@link
+ * #customInlineContentParserFactory} instead.
*
* @param delimiterProcessor a delimiter processor implementation
* @return {@code this}
@@ -275,9 +300,10 @@ public Builder customDelimiterProcessor(DelimiterProcessor delimiterProcessor) {
/**
* Add a custom link/image processor for inline parsing.
- *
- * Multiple link processors can be added, and will be tried in order in which they were added. If no link
- * processor applies, the normal behavior applies. That means these can override built-in link parsing.
+ *
+ *
Multiple link processors can be added, and will be tried in order in which they were
+ * added. If no link processor applies, the normal behavior applies. That means these can
+ * override built-in link parsing.
*
* @param linkProcessor a link processor implementation
* @return {@code this}
@@ -289,12 +315,14 @@ public Builder linkProcessor(LinkProcessor linkProcessor) {
}
/**
- * Add a custom link marker for link processing. A link marker is a character like {@code !} which, if it
- * appears before the {@code [} of a link, changes the meaning of the link.
- *
- * If a link marker followed by a valid link is parsed, the {@link org.commonmark.parser.beta.LinkInfo}
- * that is passed to {@link LinkProcessor} will have its {@link LinkInfo#marker()} set. A link processor should
- * check the {@link Text#getLiteral()} and then do any processing, and will probably want to use {@link LinkResult#includeMarker()}.
+ * Add a custom link marker for link processing. A link marker is a character like {@code !}
+ * which, if it appears before the {@code [} of a link, changes the meaning of the link.
+ *
+ *
If a link marker followed by a valid link is parsed, the {@link
+ * org.commonmark.parser.beta.LinkInfo} that is passed to {@link LinkProcessor} will have
+ * its {@link LinkInfo#marker()} set. A link processor should check the {@link
+ * Text#getLiteral()} and then do any processing, and will probably want to use {@link
+ * LinkResult#includeMarker()}.
*
* @param linkMarker a link marker character
* @return {@code this}
@@ -313,18 +341,13 @@ public Builder postProcessor(PostProcessor postProcessor) {
/**
* Overrides the parser used for inline markdown processing.
- *
- * Provide an implementation of InlineParserFactory which provides a custom inline parser
- * to modify how the following are parsed:
- * bold (**)
- * italic (*)
- * strikethrough (~~)
- * backtick quote (`)
- * link ([title](http://))
- * image ()
- *
- * Note that if this method is not called or the inline parser factory is set to null, then the default
- * implementation will be used.
+ *
+ *
Provide an implementation of InlineParserFactory which provides a custom inline parser
+ * to modify how the following are parsed: bold (**) italic (*) strikethrough (~~) backtick
+ * quote (`) link ([title](http://)) image ()
+ *
+ *
Note that if this method is not called or the inline parser factory is set to null,
+ * then the default implementation will be used.
*
* @param inlineParserFactory an inline parser factory implementation
* @return {@code this}
@@ -343,9 +366,7 @@ private InlineParserFactory getInlineParserFactory() {
}
}
- /**
- * Extension for {@link Parser}.
- */
+ /** Extension for {@link Parser}. */
public interface ParserExtension extends Extension {
void extend(Builder parserBuilder);
}
diff --git a/commonmark/src/main/java/org/commonmark/parser/PostProcessor.java b/commonmark/src/main/java/org/commonmark/parser/PostProcessor.java
index be00347ca..ffa79370a 100644
--- a/commonmark/src/main/java/org/commonmark/parser/PostProcessor.java
+++ b/commonmark/src/main/java/org/commonmark/parser/PostProcessor.java
@@ -9,5 +9,4 @@ public interface PostProcessor {
* @return the result of post-processing, may be a modified {@code node} argument
*/
Node process(Node node);
-
}
diff --git a/commonmark/src/main/java/org/commonmark/parser/SourceLine.java b/commonmark/src/main/java/org/commonmark/parser/SourceLine.java
index 92a8cdfaf..da7fe71f4 100644
--- a/commonmark/src/main/java/org/commonmark/parser/SourceLine.java
+++ b/commonmark/src/main/java/org/commonmark/parser/SourceLine.java
@@ -1,8 +1,7 @@
package org.commonmark.parser;
-import org.commonmark.node.SourceSpan;
-
import java.util.Objects;
+import org.commonmark.node.SourceSpan;
/**
* A line or part of a line from the input source.
@@ -39,7 +38,8 @@ public SourceLine substring(int beginIndex, int endIndex) {
if (length != 0) {
int columnIndex = sourceSpan.getColumnIndex() + beginIndex;
int inputIndex = sourceSpan.getInputIndex() + beginIndex;
- newSourceSpan = SourceSpan.of(sourceSpan.getLineIndex(), columnIndex, inputIndex, length);
+ newSourceSpan =
+ SourceSpan.of(sourceSpan.getLineIndex(), columnIndex, inputIndex, length);
}
}
return SourceLine.of(newContent, newSourceSpan);
diff --git a/commonmark/src/main/java/org/commonmark/parser/SourceLines.java b/commonmark/src/main/java/org/commonmark/parser/SourceLines.java
index 0b4290341..b21236281 100644
--- a/commonmark/src/main/java/org/commonmark/parser/SourceLines.java
+++ b/commonmark/src/main/java/org/commonmark/parser/SourceLines.java
@@ -1,9 +1,8 @@
package org.commonmark.parser;
-import org.commonmark.node.SourceSpan;
-
import java.util.ArrayList;
import java.util.List;
+import org.commonmark.node.SourceSpan;
/**
* A set of lines ({@link SourceLine}) from the input source.
diff --git a/commonmark/src/main/java/org/commonmark/parser/beta/InlineContentParser.java b/commonmark/src/main/java/org/commonmark/parser/beta/InlineContentParser.java
index bc5c9a54f..83941e76c 100644
--- a/commonmark/src/main/java/org/commonmark/parser/beta/InlineContentParser.java
+++ b/commonmark/src/main/java/org/commonmark/parser/beta/InlineContentParser.java
@@ -1,21 +1,23 @@
package org.commonmark.parser.beta;
/**
- * Parser for a type of inline content. Registered via a {@link InlineContentParserFactory} and created by its
- * {@link InlineContentParserFactory#create() create} method. The lifetime of this is tied to each inline content
- * snippet that is parsed, as a new instance is created for each.
+ * Parser for a type of inline content. Registered via a {@link InlineContentParserFactory} and
+ * created by its {@link InlineContentParserFactory#create() create} method. The lifetime of this is
+ * tied to each inline content snippet that is parsed, as a new instance is created for each.
*/
public interface InlineContentParser {
/**
- * Try to parse inline content starting from the current position. Note that the character at the current position
- * is one of {@link InlineContentParserFactory#getTriggerCharacters()} of the factory that created this parser.
- *
- * For a given inline content snippet that is being parsed, this method can be called multiple times: each time a
- * trigger character is encountered.
+ * Try to parse inline content starting from the current position. Note that the character at
+ * the current position is one of {@link InlineContentParserFactory#getTriggerCharacters()} of
+ * the factory that created this parser.
+ *
+ *
For a given inline content snippet that is being parsed, this method can be called
+ * multiple times: each time a trigger character is encountered.
*
* @param inlineParserState the current state of the inline parser
- * @return the result of parsing; can indicate that this parser is not interested, or that parsing was successful
+ * @return the result of parsing; can indicate that this parser is not interested, or that
+ * parsing was successful
*/
ParsedInline tryParse(InlineParserState inlineParserState);
}
diff --git a/commonmark/src/main/java/org/commonmark/parser/beta/InlineContentParserFactory.java b/commonmark/src/main/java/org/commonmark/parser/beta/InlineContentParserFactory.java
index c86f93a41..c52abab2a 100644
--- a/commonmark/src/main/java/org/commonmark/parser/beta/InlineContentParserFactory.java
+++ b/commonmark/src/main/java/org/commonmark/parser/beta/InlineContentParserFactory.java
@@ -4,21 +4,24 @@
/**
* A factory for extending inline content parsing.
- *
- * See {@link org.commonmark.parser.Parser.Builder#customInlineContentParserFactory} for how to register it.
+ *
+ *
See {@link org.commonmark.parser.Parser.Builder#customInlineContentParserFactory} for how to
+ * register it.
*/
public interface InlineContentParserFactory {
/**
- * An inline content parser needs to have a special "trigger" character which activates it. When this character is
- * encountered during inline parsing, {@link InlineContentParser#tryParse} is called with the current parser state.
- * It can also register for more than one trigger character.
+ * An inline content parser needs to have a special "trigger" character which activates it. When
+ * this character is encountered during inline parsing, {@link InlineContentParser#tryParse} is
+ * called with the current parser state. It can also register for more than one trigger
+ * character.
*/
Set getTriggerCharacters();
/**
- * Create an {@link InlineContentParser} that will do the parsing. Create is called once per text snippet of inline
- * content inside block structures, and then called each time a trigger character is encountered.
+ * Create an {@link InlineContentParser} that will do the parsing. Create is called once per
+ * text snippet of inline content inside block structures, and then called each time a trigger
+ * character is encountered.
*/
InlineContentParser create();
}
diff --git a/commonmark/src/main/java/org/commonmark/parser/beta/InlineParserState.java b/commonmark/src/main/java/org/commonmark/parser/beta/InlineParserState.java
index e434d45d6..246aec043 100644
--- a/commonmark/src/main/java/org/commonmark/parser/beta/InlineParserState.java
+++ b/commonmark/src/main/java/org/commonmark/parser/beta/InlineParserState.java
@@ -3,10 +3,10 @@
public interface InlineParserState {
/**
- * Return a scanner for the input for the current position (on the trigger character that the inline parser was
- * added for).
- *
- * Note that this always returns the same instance, if you want to backtrack you need to use
+ * Return a scanner for the input for the current position (on the trigger character that the
+ * inline parser was added for).
+ *
+ *
Note that this always returns the same instance, if you want to backtrack you need to use
* {@link Scanner#position()} and {@link Scanner#setPosition(Position)}.
*/
Scanner scanner();
diff --git a/commonmark/src/main/java/org/commonmark/parser/beta/LinkInfo.java b/commonmark/src/main/java/org/commonmark/parser/beta/LinkInfo.java
index b2fda57e4..210ca9ddb 100644
--- a/commonmark/src/main/java/org/commonmark/parser/beta/LinkInfo.java
+++ b/commonmark/src/main/java/org/commonmark/parser/beta/LinkInfo.java
@@ -4,62 +4,64 @@
/**
* A parsed link/image. There are different types of links.
- *
- * Reference links, which have different subtypes. Full::
+ *
+ *
Reference links, which have different subtypes. Full::
+ *
*
* [text][label]
*
+ *
* Collapsed (label is ""):
+ *
*
* [text][]
*
+ *
* Shortcut (label is null):
+ *
*
* [text]
*
- * Images use the same syntax as links but with a {@code !} {@link #marker()} front, e.g. {@code }.
+ *
+ * Images use the same syntax as links but with a {@code !} {@link #marker()} front, e.g. {@code
+ * }.
*/
public interface LinkInfo {
/**
- * The marker if present, or null. A marker is e.g. {@code !} for an image, or a custom marker as specified in
- * {@link org.commonmark.parser.Parser.Builder#linkMarker}.
+ * The marker if present, or null. A marker is e.g. {@code !} for an image, or a custom marker
+ * as specified in {@link org.commonmark.parser.Parser.Builder#linkMarker}.
*/
Text marker();
- /**
- * The text node of the opening bracket {@code [}.
- */
+ /** The text node of the opening bracket {@code [}. */
Text openingBracket();
- /**
- * The text between the first brackets, e.g. `foo` in `[foo][bar]`.
- */
+ /** The text between the first brackets, e.g. `foo` in `[foo][bar]`. */
String text();
/**
- * The label, or null for inline links or for shortcut links (in which case {@link #text()} should be used as the label).
+ * The label, or null for inline links or for shortcut links (in which case {@link #text()}
+ * should be used as the label).
*/
String label();
- /**
- * The destination if available, e.g. in `[foo](destination)`, or null
- */
+ /** The destination if available, e.g. in `[foo](destination)`, or null */
String destination();
- /**
- * The title if available, e.g. in `[foo](destination "title")`, or null
- */
+ /** The title if available, e.g. in `[foo](destination "title")`, or null */
String title();
/**
* The position after the closing text bracket, e.g.:
+ *
*
* [foo][bar]
* ^
diff --git a/commonmark/src/main/java/org/commonmark/parser/beta/LinkProcessor.java b/commonmark/src/main/java/org/commonmark/parser/beta/LinkProcessor.java
index 3e448fd91..595e8d73d 100644
--- a/commonmark/src/main/java/org/commonmark/parser/beta/LinkProcessor.java
+++ b/commonmark/src/main/java/org/commonmark/parser/beta/LinkProcessor.java
@@ -4,37 +4,43 @@
/**
* An interface to decide how links/images are handled.
+ *
+ *
Implementations need to be registered with a parser via {@link
+ * org.commonmark.parser.Parser.Builder#linkProcessor}. Then, when inline parsing is run, each
+ * parsed link/image is passed to the processor. This includes links like these:
+ *
*
- * Implementations need to be registered with a parser via {@link org.commonmark.parser.Parser.Builder#linkProcessor}.
- * Then, when inline parsing is run, each parsed link/image is passed to the processor. This includes links like these:
- *
+ *
* See {@link LinkInfo} for accessing various parts of the parsed link/image.
- *
- * The processor can then inspect the link/image and decide what to do with it by returning the appropriate
- * {@link LinkResult}. If it returns {@link LinkResult#none()}, the next registered processor is tried. If none of them
- * apply, the link is handled as it normally would.
+ *
+ *
The processor can then inspect the link/image and decide what to do with it by returning the
+ * appropriate {@link LinkResult}. If it returns {@link LinkResult#none()}, the next registered
+ * processor is tried. If none of them apply, the link is handled as it normally would.
*/
public interface LinkProcessor {
/**
* @param linkInfo information about the parsed link/image
- * @param scanner the scanner at the current position after the parsed link/image
- * @param context context for inline parsing
- * @return what to do with the link/image, e.g. do nothing (try the next processor), wrap the text in a node, or
- * replace the link/image with a node
+ * @param scanner the scanner at the current position after the parsed link/image
+ * @param context context for inline parsing
+ * @return what to do with the link/image, e.g. do nothing (try the next processor), wrap the
+ * text in a node, or replace the link/image with a node
*/
LinkResult process(LinkInfo linkInfo, Scanner scanner, InlineParserContext context);
}
diff --git a/commonmark/src/main/java/org/commonmark/parser/beta/LinkResult.java b/commonmark/src/main/java/org/commonmark/parser/beta/LinkResult.java
index 43bc82af8..6becc0cb7 100644
--- a/commonmark/src/main/java/org/commonmark/parser/beta/LinkResult.java
+++ b/commonmark/src/main/java/org/commonmark/parser/beta/LinkResult.java
@@ -3,26 +3,24 @@
import org.commonmark.internal.inline.LinkResultImpl;
import org.commonmark.node.Node;
-/**
- * What to do with a link/image processed by {@link LinkProcessor}.
- */
+/** What to do with a link/image processed by {@link LinkProcessor}. */
public interface LinkResult {
- /**
- * Link not handled by processor.
- */
+ /** Link not handled by processor. */
static LinkResult none() {
return null;
}
/**
* Wrap the link text in a node. This is the normal behavior for links, e.g. for this:
+ *
*
* [my *text*](destination)
*
- * The text is {@code my *text*}, a text node and emphasis. The text is wrapped in a
- * {@link org.commonmark.node.Link} node, which means the text is added as child nodes to it.
*
- * @param node the node to which the link text nodes will be added as child nodes
+ * The text is {@code my *text*}, a text node and emphasis. The text is wrapped in a {@link
+ * org.commonmark.node.Link} node, which means the text is added as child nodes to it.
+ *
+ * @param node the node to which the link text nodes will be added as child nodes
* @param position the position to continue parsing from
*/
static LinkResult wrapTextIn(Node node, Position position) {
@@ -31,12 +29,15 @@ static LinkResult wrapTextIn(Node node, Position position) {
/**
* Replace the link with a node. E.g. for this:
+ *
*
* [^foo]
*
- * The processor could decide to create a {@code FootnoteReference} node instead which replaces the link.
*
- * @param node the node to replace the link with
+ * The processor could decide to create a {@code FootnoteReference} node instead which replaces
+ * the link.
+ *
+ * @param node the node to replace the link with
* @param position the position to continue parsing from
*/
static LinkResult replaceWith(Node node, Position position) {
@@ -44,7 +45,8 @@ static LinkResult replaceWith(Node node, Position position) {
}
/**
- * If a {@link LinkInfo#marker()} is present, include it in processing (i.e. treat it the same way as the brackets).
+ * If a {@link LinkInfo#marker()} is present, include it in processing (i.e. treat it the same
+ * way as the brackets).
*/
LinkResult includeMarker();
}
diff --git a/commonmark/src/main/java/org/commonmark/parser/beta/ParsedInline.java b/commonmark/src/main/java/org/commonmark/parser/beta/ParsedInline.java
index 5d1402cae..c07a260fc 100644
--- a/commonmark/src/main/java/org/commonmark/parser/beta/ParsedInline.java
+++ b/commonmark/src/main/java/org/commonmark/parser/beta/ParsedInline.java
@@ -1,14 +1,13 @@
package org.commonmark.parser.beta;
+import java.util.Objects;
import org.commonmark.internal.inline.ParsedInlineImpl;
import org.commonmark.node.Node;
-import java.util.Objects;
-
/**
* The result of a single inline parser. Use the static methods to create instances.
- *
- * This interface is not intended to be implemented by clients.
+ *
+ *
This interface is not intended to be implemented by clients.
*/
public interface ParsedInline {
diff --git a/commonmark/src/main/java/org/commonmark/parser/beta/Position.java b/commonmark/src/main/java/org/commonmark/parser/beta/Position.java
index 3dbb4870f..5f45ef7f0 100644
--- a/commonmark/src/main/java/org/commonmark/parser/beta/Position.java
+++ b/commonmark/src/main/java/org/commonmark/parser/beta/Position.java
@@ -1,8 +1,8 @@
package org.commonmark.parser.beta;
/**
- * Position within a {@link Scanner}. This is intentionally kept opaque so as not to expose the internal structure of
- * the Scanner.
+ * Position within a {@link Scanner}. This is intentionally kept opaque so as not to expose the
+ * internal structure of the Scanner.
*/
public class Position {
diff --git a/commonmark/src/main/java/org/commonmark/parser/beta/Scanner.java b/commonmark/src/main/java/org/commonmark/parser/beta/Scanner.java
index 324639493..1acf39ced 100644
--- a/commonmark/src/main/java/org/commonmark/parser/beta/Scanner.java
+++ b/commonmark/src/main/java/org/commonmark/parser/beta/Scanner.java
@@ -1,29 +1,29 @@
package org.commonmark.parser.beta;
+import java.util.List;
import org.commonmark.node.SourceSpan;
import org.commonmark.parser.SourceLine;
import org.commonmark.parser.SourceLines;
import org.commonmark.text.CharMatcher;
-import java.util.List;
-
public class Scanner {
/**
- * Character representing the end of input source (or outside of the text in case of the "previous" methods).
- *
- * Note that we can use NULL to represent this because CommonMark does not allow those in the input (we replace them
- * in the beginning of parsing).
+ * Character representing the end of input source (or outside of the text in case of the
+ * "previous" methods).
+ *
+ *
Note that we can use NULL to represent this because CommonMark does not allow those in the
+ * input (we replace them in the beginning of parsing).
*/
public static final char END = '\0';
- // Lines without newlines at the end. The scanner will yield `\n` between lines because they're significant for
- // parsing and the final output. There is no `\n` after the last line.
+ // Lines without newlines at the end. The scanner will yield `\n` between lines because they're
+ // significant for parsing and the final output. There is no `\n` after the last line.
private final List lines;
// Which line we're at.
private int lineIndex;
- // The index within the line. If index == length(), we pretend that there's a `\n` and only advance after we yield
- // that.
+ // The index within the line. If index == length(), we pretend that there's a `\n` and only
+ // advance after we yield that.
private int index;
// Current line or "" if at the end of the lines (using "" instead of null saves a null check)
@@ -135,8 +135,8 @@ public boolean next(char c) {
}
/**
- * Check if we have the specified content on the line and advanced the position. Note that if you want to match
- * newline characters, use {@link #next(char)}.
+ * Check if we have the specified content on the line and advanced the position. Note that if
+ * you want to match newline characters, use {@link #next(char)}.
*
* @param content the text content to match on a single line (excluding newline characters)
* @return true if matched and position was advanced, false otherwise
@@ -221,8 +221,8 @@ public int find(CharMatcher matcher) {
}
}
- // Don't expose the int index, because it would be good if we could switch input to a List of lines later
- // instead of one contiguous String.
+ // Don't expose the int index, because it would be good if we could switch input to a
+ // List of lines later instead of one contiguous String.
public Position position() {
return new Position(lineIndex, index);
}
@@ -234,8 +234,8 @@ public void setPosition(Position position) {
setLine(lines.get(this.lineIndex));
}
- // For cases where the caller appends the result to a StringBuilder, we could offer another method to avoid some
- // unnecessary copying.
+ // For cases where the caller appends the result to a StringBuilder, we could offer another
+ // method to avoid some unnecessary copying.
public SourceLines getSource(Position begin, Position end) {
if (begin.lineIndex == end.lineIndex) {
// Shortcut for common case of text from a single line
@@ -271,11 +271,13 @@ private void setLine(SourceLine line) {
private void checkPosition(int lineIndex, int index) {
if (lineIndex < 0 || lineIndex >= lines.size()) {
- throw new IllegalArgumentException("Line index " + lineIndex + " out of range, number of lines: " + lines.size());
+ throw new IllegalArgumentException(
+ "Line index " + lineIndex + " out of range, number of lines: " + lines.size());
}
SourceLine line = lines.get(lineIndex);
if (index < 0 || index > line.getContent().length()) {
- throw new IllegalArgumentException("Index " + index + " out of range, line length: " + line.getContent().length());
+ throw new IllegalArgumentException(
+ "Index " + index + " out of range, line length: " + line.getContent().length());
}
}
}
diff --git a/commonmark/src/main/java/org/commonmark/parser/beta/package-info.java b/commonmark/src/main/java/org/commonmark/parser/beta/package-info.java
index 029d80507..f77deb1c9 100644
--- a/commonmark/src/main/java/org/commonmark/parser/beta/package-info.java
+++ b/commonmark/src/main/java/org/commonmark/parser/beta/package-info.java
@@ -1,4 +1,2 @@
-/**
- * Experimental APIs to use for extensions. APIs are subject to change if necessary.
- */
+/** Experimental APIs to use for extensions. APIs are subject to change if necessary. */
package org.commonmark.parser.beta;
diff --git a/commonmark/src/main/java/org/commonmark/parser/block/AbstractBlockParser.java b/commonmark/src/main/java/org/commonmark/parser/block/AbstractBlockParser.java
index 4fb1a05ac..69610a664 100644
--- a/commonmark/src/main/java/org/commonmark/parser/block/AbstractBlockParser.java
+++ b/commonmark/src/main/java/org/commonmark/parser/block/AbstractBlockParser.java
@@ -1,13 +1,12 @@
package org.commonmark.parser.block;
+import java.util.List;
import org.commonmark.node.Block;
import org.commonmark.node.DefinitionMap;
import org.commonmark.node.SourceSpan;
import org.commonmark.parser.InlineParser;
import org.commonmark.parser.SourceLine;
-import java.util.List;
-
public abstract class AbstractBlockParser implements BlockParser {
@Override
@@ -26,8 +25,7 @@ public boolean canContain(Block childBlock) {
}
@Override
- public void addLine(SourceLine line) {
- }
+ public void addLine(SourceLine line) {}
@Override
public void addSourceSpan(SourceSpan sourceSpan) {
@@ -40,11 +38,8 @@ public List> getDefinitions() {
}
@Override
- public void closeBlock() {
- }
+ public void closeBlock() {}
@Override
- public void parseInlines(InlineParser inlineParser) {
- }
-
+ public void parseInlines(InlineParser inlineParser) {}
}
diff --git a/commonmark/src/main/java/org/commonmark/parser/block/AbstractBlockParserFactory.java b/commonmark/src/main/java/org/commonmark/parser/block/AbstractBlockParserFactory.java
index e297ac831..1f19d59b8 100644
--- a/commonmark/src/main/java/org/commonmark/parser/block/AbstractBlockParserFactory.java
+++ b/commonmark/src/main/java/org/commonmark/parser/block/AbstractBlockParserFactory.java
@@ -1,4 +1,3 @@
package org.commonmark.parser.block;
-public abstract class AbstractBlockParserFactory implements BlockParserFactory {
-}
+public abstract class AbstractBlockParserFactory implements BlockParserFactory {}
diff --git a/commonmark/src/main/java/org/commonmark/parser/block/BlockContinue.java b/commonmark/src/main/java/org/commonmark/parser/block/BlockContinue.java
index dc2616065..d57656102 100644
--- a/commonmark/src/main/java/org/commonmark/parser/block/BlockContinue.java
+++ b/commonmark/src/main/java/org/commonmark/parser/block/BlockContinue.java
@@ -2,13 +2,10 @@
import org.commonmark.internal.BlockContinueImpl;
-/**
- * Result object for continuing parsing of a block, see static methods for constructors.
- */
+/** Result object for continuing parsing of a block, see static methods for constructors. */
public class BlockContinue {
- protected BlockContinue() {
- }
+ protected BlockContinue() {}
public static BlockContinue none() {
return null;
@@ -25,5 +22,4 @@ public static BlockContinue atColumn(int newColumn) {
public static BlockContinue finished() {
return new BlockContinueImpl(-1, -1, true);
}
-
}
diff --git a/commonmark/src/main/java/org/commonmark/parser/block/BlockParser.java b/commonmark/src/main/java/org/commonmark/parser/block/BlockParser.java
index 32ff2a474..e18105529 100644
--- a/commonmark/src/main/java/org/commonmark/parser/block/BlockParser.java
+++ b/commonmark/src/main/java/org/commonmark/parser/block/BlockParser.java
@@ -1,33 +1,34 @@
package org.commonmark.parser.block;
+import java.util.List;
import org.commonmark.node.Block;
import org.commonmark.node.DefinitionMap;
import org.commonmark.node.SourceSpan;
import org.commonmark.parser.InlineParser;
import org.commonmark.parser.SourceLine;
-import java.util.List;
-
/**
* Parser for a specific block node.
- *
- * Implementations should subclass {@link AbstractBlockParser} instead of implementing this directly.
+ *
+ *
Implementations should subclass {@link AbstractBlockParser} instead of implementing this
+ * directly.
*/
public interface BlockParser {
/**
- * Return true if the block that is parsed is a container (contains other blocks), or false if it's a leaf.
+ * Return true if the block that is parsed is a container (contains other blocks), or false if
+ * it's a leaf.
*/
boolean isContainer();
/**
* Return true if the block can have lazy continuation lines.
- *
- * Lazy continuation lines are lines that were rejected by this {@link #tryContinue(ParserState)} but didn't match
- * any other block parsers either.
- *
- * If true is returned here, those lines will get added via {@link #addLine(SourceLine)}. For false, the block is
- * closed instead.
+ *
+ *
Lazy continuation lines are lines that were rejected by this {@link
+ * #tryContinue(ParserState)} but didn't match any other block parsers either.
+ *
+ *
If true is returned here, those lines will get added via {@link #addLine(SourceLine)}. For
+ * false, the block is closed instead.
*/
boolean canHaveLazyContinuationLines();
@@ -38,28 +39,28 @@ public interface BlockParser {
BlockContinue tryContinue(ParserState parserState);
/**
- * Add the part of a line that belongs to this block parser to parse (i.e. without any container block markers).
- * Note that the line will only include a {@link SourceLine#getSourceSpan()} if source spans are enabled for inlines.
+ * Add the part of a line that belongs to this block parser to parse (i.e. without any container
+ * block markers). Note that the line will only include a {@link SourceLine#getSourceSpan()} if
+ * source spans are enabled for inlines.
*/
void addLine(SourceLine line);
/**
- * Add a source span of the currently parsed block. The default implementation in {@link AbstractBlockParser} adds
- * it to the block. Unless you have some complicated parsing where you need to check source positions, you don't
- * need to override this.
+ * Add a source span of the currently parsed block. The default implementation in {@link
+ * AbstractBlockParser} adds it to the block. Unless you have some complicated parsing where you
+ * need to check source positions, you don't need to override this.
*
* @since 0.16.0
*/
void addSourceSpan(SourceSpan sourceSpan);
/**
- * Return definitions parsed by this parser. The definitions returned here can later be accessed during inline
- * parsing via {@link org.commonmark.parser.InlineParserContext#getDefinition}.
+ * Return definitions parsed by this parser. The definitions returned here can later be accessed
+ * during inline parsing via {@link org.commonmark.parser.InlineParserContext#getDefinition}.
*/
List> getDefinitions();
void closeBlock();
void parseInlines(InlineParser inlineParser);
-
}
diff --git a/commonmark/src/main/java/org/commonmark/parser/block/BlockParserFactory.java b/commonmark/src/main/java/org/commonmark/parser/block/BlockParserFactory.java
index 729224761..ced38633b 100644
--- a/commonmark/src/main/java/org/commonmark/parser/block/BlockParserFactory.java
+++ b/commonmark/src/main/java/org/commonmark/parser/block/BlockParserFactory.java
@@ -2,11 +2,11 @@
/**
* Parser factory for a block node for determining when a block starts.
- *
![\"text\"](\"/url.png\")
![\"Android](\"/contrib/android-sdk-manager.png\")