This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-doxia.git
The following commit(s) were added to refs/heads/master by this push:
new 6b65b733 Emit list items matching the innermost list in XHTML-based
parsers
6b65b733 is described below
commit 6b65b733bd39e1427e0707f5b96c408326bedece
Author: Sylwester Lachiewicz <[email protected]>
AuthorDate: Sat Nov 14 10:34:11 2026 +0000
Emit list items matching the innermost list in XHTML-based parsers
A <ul> nested in an <ol> reported its <li> elements as numberedListItem,
because only the ordered list depth was tracked. Track the open lists
and pick the item event from the innermost one.
---
.../maven/doxia/parser/Xhtml5BaseParser.java | 31 +++++++++-----
.../maven/doxia/module/xdoc/XdocParserTest.java | 50 ++++++++++++++++++++++
2 files changed, 70 insertions(+), 11 deletions(-)
diff --git
a/doxia-core/src/main/java/org/apache/maven/doxia/parser/Xhtml5BaseParser.java
b/doxia-core/src/main/java/org/apache/maven/doxia/parser/Xhtml5BaseParser.java
index c1972598..3828e701 100644
---
a/doxia-core/src/main/java/org/apache/maven/doxia/parser/Xhtml5BaseParser.java
+++
b/doxia-core/src/main/java/org/apache/maven/doxia/parser/Xhtml5BaseParser.java
@@ -21,6 +21,8 @@ package org.apache.maven.doxia.parser;
import java.io.Reader;
import java.text.CharacterIterator;
import java.text.StringCharacterIterator;
+import java.util.ArrayDeque;
+import java.util.Deque;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.Set;
@@ -117,8 +119,8 @@ public class Xhtml5BaseParser extends AbstractXmlParser
implements HtmlMarkup {
/** Used to distinguish <a href=""> from <a name="">. */
private boolean isAnchor;
- /** Used for nested lists. */
- private int orderedListDepth = 0;
+ /** The currently open lists, innermost first: {@code true} for an ordered
list, {@code false} for an unordered one. */
+ private final Deque<Boolean> openLists = new ArrayDeque<>();
/** Counts section nesting level of the sections manually set in the HTML
document */
private int sectionLevel;
@@ -401,6 +403,7 @@ public class Xhtml5BaseParser extends AbstractXmlParser
implements HtmlMarkup {
break;
case "ul":
sink.list(attribs);
+ openLists.push(Boolean.FALSE);
break;
case "ol":
handleOLStart(sink, attribs);
@@ -534,10 +537,11 @@ public class Xhtml5BaseParser extends AbstractXmlParser
implements HtmlMarkup {
break;
case "ul":
sink.list_();
+ openLists.poll();
break;
case "ol":
sink.numberedList_();
- orderedListDepth--;
+ openLists.poll();
break;
case "li":
handleListItemEnd(sink);
@@ -995,7 +999,7 @@ public class Xhtml5BaseParser extends AbstractXmlParser
implements HtmlMarkup {
this.scriptBlock = false;
this.isLink = false;
this.isAnchor = false;
- this.orderedListDepth = 0;
+ this.openLists.clear();
this.headingLevel = 0;
this.inVerbatim = false;
}
@@ -1085,21 +1089,26 @@ public class Xhtml5BaseParser extends AbstractXmlParser
implements HtmlMarkup {
}
private void handleLIStart(Sink sink, SinkEventAttributeSet attribs) {
- if (orderedListDepth == 0) {
- sink.listItem(attribs);
- } else {
+ if (isInOrderedList()) {
sink.numberedListItem(attribs);
+ } else {
+ sink.listItem(attribs);
}
}
private void handleListItemEnd(Sink sink) {
- if (orderedListDepth == 0) {
- sink.listItem_();
- } else {
+ if (isInOrderedList()) {
sink.numberedListItem_();
+ } else {
+ sink.listItem_();
}
}
+ /** Returns whether the innermost open list is an ordered one, which
decides the type of list item events. */
+ private boolean isInOrderedList() {
+ return Boolean.TRUE.equals(openLists.peek());
+ }
+
private void handleOLStart(Sink sink, SinkEventAttributeSet attribs) {
int numbering = Sink.NUMBERING_DECIMAL;
// this will have to be generalized if we handle styles
@@ -1128,7 +1137,7 @@ public class Xhtml5BaseParser extends AbstractXmlParser
implements HtmlMarkup {
}
sink.numberedList(numbering, attribs);
- orderedListDepth++;
+ openLists.push(Boolean.TRUE);
}
private void handlePStart(Sink sink, SinkEventAttributeSet attribs) {
diff --git
a/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocParserTest.java
b/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocParserTest.java
index 231bb06b..6fb1285e 100644
---
a/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocParserTest.java
+++
b/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocParserTest.java
@@ -439,6 +439,56 @@ class XdocParserTest extends AbstractParserTest {
assertFalse(it.hasNext());
}
+ @Test
+ void listItemsInUnorderedListNestedInOrderedList() throws Exception {
+ assertEventNames(
+ "<ol><li>one<ul><li>a</li></ul></li><li>two</li></ol>",
+ "numberedList",
+ "numberedListItem",
+ "text",
+ "list",
+ "listItem",
+ "text",
+ "listItem_",
+ "list_",
+ "numberedListItem_",
+ "numberedListItem",
+ "text",
+ "numberedListItem_",
+ "numberedList_");
+ }
+
+ @Test
+ void listItemsInOrderedListNestedInUnorderedList() throws Exception {
+ assertEventNames(
+ "<ul><li>x<ol><li>y</li></ol></li><li>z</li></ul>",
+ "list",
+ "listItem",
+ "text",
+ "numberedList",
+ "numberedListItem",
+ "text",
+ "numberedListItem_",
+ "numberedList_",
+ "listItem_",
+ "listItem",
+ "text",
+ "listItem_",
+ "list_");
+ }
+
+ private void assertEventNames(String text, String... expected) throws
Exception {
+ SinkEventTestingSink sink = new SinkEventTestingSink();
+
+ parser.parse(text, sink);
+
+ Iterator<SinkEventElement> it = sink.getEventList().iterator();
+ for (String name : expected) {
+ assertEquals(name, it.next().getName());
+ }
+ assertFalse(it.hasNext());
+ }
+
@Override
protected String getVerbatimSource() {
return "<pre><![CDATA[<>{}=#*]]></pre>";