Parse run highlights

mwilliamson · Jun 13, 2024 · 9b1601c · 9b1601c
1 parent c63abd5
commit 9b1601c
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 0 deletions.
diff --git a/NEWS b/NEWS
@@ -1,3 +1,7 @@
+# 1.8.0
+
+* Support parsing of run highlights.
+
 # 1.7.1
 
 * Switch the precedence of numbering properties in paragraph properties and the

diff --git a/src/main/java/org/zwobble/mammoth/internal/documents/Run.java b/src/main/java/org/zwobble/mammoth/internal/documents/Run.java
@@ -4,6 +4,7 @@
 import java.util.Optional;
 
 public class Run implements DocumentElement, HasChildren {
+    private final Optional<String> highlight;
     private final boolean isBold;
     private final boolean isItalic;
     private final boolean isUnderline;
@@ -15,6 +16,7 @@ public class Run implements DocumentElement, HasChildren {
     private final List<DocumentElement> children;
 
     public Run(
+        Optional<String> highlight,
         boolean isBold,
         boolean isItalic,
         boolean isUnderline,
@@ -25,6 +27,7 @@ public Run(
         Optional<Style> style,
         List<DocumentElement> children
     ) {
+        this.highlight = highlight;
         this.isBold = isBold;
         this.isItalic = isItalic;
         this.isUnderline = isUnderline;
@@ -36,6 +39,10 @@ public Run(
         this.children = children;
     }
 
+    public Optional<String> getHighlight() {
+        return highlight;
+    }
+
     public boolean isBold() {
         return isBold;
     }

diff --git a/src/main/java/org/zwobble/mammoth/internal/docx/StatefulBodyXmlReader.java b/src/main/java/org/zwobble/mammoth/internal/docx/StatefulBodyXmlReader.java
@@ -183,6 +183,7 @@ private ReadResult readRun(XmlElement element) {
                 }
 
                 return new Run(
+                    readHighlight(properties),
                     isBold(properties),
                     isItalic(properties),
                     isUnderline(properties),
@@ -201,6 +202,10 @@ private Optional<HyperlinkComplexField> currentHyperlinkComplexField() {
         return tryGetLast(lazyFilter(this.complexFieldStack, HyperlinkComplexField.class));
     }
 
+    private Optional<String> readHighlight(XmlElementLike properties) {
+        return readVal(properties, "w:highlight");
+    }
+
     private boolean isBold(XmlElementLike properties) {
         return readBooleanElement(properties, "w:b");
     }

diff --git a/src/test/java/org/zwobble/mammoth/tests/documents/DocumentElementMakers.java b/src/test/java/org/zwobble/mammoth/tests/documents/DocumentElementMakers.java
@@ -15,6 +15,7 @@
 public class DocumentElementMakers {
     private static final ArgumentKey<Optional<Style>> STYLE = new ArgumentKey<>("style");
     private static final ArgumentKey<Optional<NumberingLevel>> NUMBERING = new ArgumentKey<>("numbering");
+    private static final ArgumentKey<Optional<String>> HIGHLIGHT = new ArgumentKey<>("highlight");
     private static final ArgumentKey<Boolean> BOLD = new ArgumentKey<>("bold");
     private static final ArgumentKey<Boolean> ITALIC = new ArgumentKey<>("italic");
     private static final ArgumentKey<Boolean> UNDERLINE = new ArgumentKey<>("underline");
@@ -118,6 +119,7 @@ public static Paragraph paragraphWithText(String text) {
     public static Run run(Object... args) {
         Arguments arguments = new Arguments(args);
         return new Run(
+            arguments.get(HIGHLIGHT, Optional.empty()),
             arguments.get(BOLD, false),
             arguments.get(ITALIC, false),
             arguments.get(UNDERLINE, false),

diff --git a/src/test/java/org/zwobble/mammoth/tests/docx/BodyXmlTests.java b/src/test/java/org/zwobble/mammoth/tests/docx/BodyXmlTests.java
@@ -859,6 +859,26 @@ public void runIsSubscriptIfVerticalAlignmentPropertyIsSetToSubscript() {
             hasProperty("verticalAlignment", equalTo(VerticalAlignment.SUBSCRIPT)));
     }
 
+    @Test
+    public void runHasNoHighlightByDefault() {
+        XmlElement element = runXmlWithProperties();
+
+        DocumentElement result = readSuccess(bodyReader(), element);
+
+        assertThat(result, hasProperty("highlight", equalTo(Optional.empty())));
+    }
+
+    @Test
+    public void runHasHighlightReadFromProperties() {
+        XmlElement element = runXmlWithProperties(
+            element("w:highlight", map("w:val", "yellow"))
+        );
+
+        DocumentElement result = readSuccess(bodyReader(), element);
+
+        assertThat(result, hasProperty("highlight", equalTo(Optional.of("yellow"))));
+    }
+
     @Test
     public void canReadTabElement() {
         XmlElement element = element("w:tab");