feat: Support underline

docx-core/src/documents/elements/mod.rs

@@ -42,6 +42,7 @@ mod table_row;
 mod table_row_property;
 mod table_width;
 mod text;
+mod underline;
 mod vertical_merge;
 mod zoom;
 
@@ -89,5 +90,6 @@ pub use table_row::*;
 pub use table_row_property::*;
 pub use table_width::*;
 pub use text::*;
+pub use underline::*;
 pub use vertical_merge::*;
 pub use zoom::*;

docx-core/src/documents/elements/run.rs

@@ -78,6 +78,11 @@ impl Run {
         self.run_property = self.run_property.italic();
         self
     }
+
+    pub fn underline(mut self, line_type: &str) -> Run {
+        self.run_property = self.run_property.underline(line_type);
+        self
+    }
 }
 
 impl BuildXML for Run {
@@ -112,4 +117,13 @@ mod tests {
             r#"<w:r><w:rPr /><w:t xml:space="preserve">Hello</w:t></w:r>"#
         );
     }
+
+    #[test]
+    fn test_underline() {
+        let b = Run::new().add_text("Hello").underline("single").build();
+        assert_eq!(
+            str::from_utf8(&b).unwrap(),
+            r#"<w:r><w:rPr><w:u w:val="single" /></w:rPr><w:t xml:space="preserve">Hello</w:t></w:r>"#
+        );
+    }
 }

docx-core/src/documents/elements/run_property.rs

@@ -1,4 +1,4 @@
-use super::{Bold, BoldCs, Color, Highlight, Italic, ItalicCs, Sz, SzCs};
+use super::{Bold, BoldCs, Color, Highlight, Italic, ItalicCs, Sz, SzCs, Underline};
 use crate::documents::BuildXML;
 use crate::xml_builder::*;
 
@@ -8,6 +8,7 @@ pub struct RunProperty {
     sz_cs: Option<SzCs>,
     color: Option<Color>,
     highlight: Option<Highlight>,
+    underline: Option<Underline>,
     bold: Option<Bold>,
     bold_cs: Option<BoldCs>,
     italic: Option<Italic>,
@@ -46,6 +47,11 @@ impl RunProperty {
         self.italic_cs = Some(ItalicCs::new());
         self
     }
+
+    pub fn underline(mut self, line_type: &str) -> RunProperty {
+        self.underline = Some(Underline::new(line_type));
+        self
+    }
 }
 
 impl Default for RunProperty {
@@ -55,6 +61,7 @@ impl Default for RunProperty {
             sz: None,
             sz_cs: None,
             highlight: None,
+            underline: None,
             bold: None,
             bold_cs: None,
             italic: None,
@@ -75,6 +82,7 @@ impl BuildXML for RunProperty {
             .add_optional_child(&self.italic)
             .add_optional_child(&self.italic_cs)
             .add_optional_child(&self.highlight)
+            .add_optional_child(&self.underline)
             .close()
             .build()
     }
@@ -117,4 +125,14 @@ mod tests {
             r#"<w:rPr><w:b /><w:bCs /></w:rPr>"#
         );
     }
+
+    #[test]
+    fn test_underline() {
+        let c = RunProperty::new().underline("single");
+        let b = c.build();
+        assert_eq!(
+            str::from_utf8(&b).unwrap(),
+            r#"<w:rPr><w:u w:val="single" /></w:rPr>"#
+        );
+    }
 }

docx-core/src/documents/elements/underline.rs

@@ -0,0 +1,35 @@
+use crate::documents::BuildXML;
+use crate::xml_builder::*;
+
+#[derive(Debug, Clone)]
+pub struct Underline {
+    val: String,
+}
+
+impl Underline {
+    pub fn new(val: impl Into<String>) -> Underline {
+        Underline { val: val.into() }
+    }
+}
+
+impl BuildXML for Underline {
+    fn build(&self) -> Vec<u8> {
+        XMLBuilder::new().underline(&self.val).build()
+    }
+}
+
+#[cfg(test)]
+mod tests {
+
+    use super::*;
+    #[cfg(test)]
+    use pretty_assertions::assert_eq;
+    use std::str;
+
+    #[test]
+    fn test_underline() {
+        let c = Underline::new("single");
+        let b = c.build();
+        assert_eq!(str::from_utf8(&b).unwrap(), r#"<w:u w:val="single" />"#);
+    }
+}

docx-core/src/xml_builder/elements.rs

@@ -83,6 +83,9 @@ impl XMLBuilder {
     // i.e. <w:highlight ... >
     only_str_val_el!(highlight, "w:highlight");
 
+    // i.e. <w:u ... >
+    only_str_val_el!(underline, "w:u");
+
     // i.e. <w:ind ... >
     pub(crate) fn indent(mut self, left: usize, special_indent: Option<SpecialIndentType>) -> Self {
         let left = &format!("{}", left);

docx-core/tests/lib.rs

@@ -230,3 +230,29 @@ pub fn history() -> Result<(), DocxError> {
     .pack(file)?;
   Ok(())
 }
+
+#[test]
+pub fn underline() -> Result<(), DocxError> {
+  let path = std::path::Path::new("./tests/output/underline.docx");
+  let file = std::fs::File::create(&path).unwrap();
+  Docx::new()
+    .add_paragraph(Paragraph::new().add_run(Run::new().add_text("Hello").underline("single")))
+    .build()
+    .pack(file)?;
+  Ok(())
+}
+
+#[test]
+pub fn highlight() -> Result<(), DocxError> {
+  let path = std::path::Path::new("./tests/output/highlight.docx");
+  let file = std::fs::File::create(&path).unwrap();
+  Docx::new()
+    .add_paragraph(
+      Paragraph::new()
+        .add_run(Run::new().add_text("Hello").highlight("cyan"))
+        .add_run(Run::new().add_text(" World!").highlight("yellow")),
+    )
+    .build()
+    .pack(file)?;
+  Ok(())
+}

fixtures/highlight_and_underline/[Content_Types].xml

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types"><Override PartName="/_rels/.rels" ContentType="application/vnd.openxmlformats-package.relationships+xml"/><Override PartName="/docProps/app.xml" ContentType="application/vnd.openxmlformats-officedocument.extended-properties+xml"/><Override PartName="/docProps/core.xml" ContentType="application/vnd.openxmlformats-package.core-properties+xml"/><Override PartName="/word/_rels/document.xml.rels" ContentType="application/vnd.openxmlformats-package.relationships+xml"/><Override PartName="/word/settings.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.settings+xml"/><Override PartName="/word/fontTable.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.fontTable+xml"/><Override PartName="/word/document.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml"/><Override PartName="/word/styles.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.styles+xml"/>
+</Types>

fixtures/highlight_and_underline/_rels/.rels

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Id="rId1" Type="http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties" Target="docProps/core.xml"/><Relationship Id="rId2" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties" Target="docProps/app.xml"/><Relationship Id="rId3" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="word/document.xml"/>
+</Relationships>

fixtures/highlight_and_underline/docProps/app.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<Properties xmlns="http://schemas.openxmlformats.org/officeDocument/2006/extended-properties" xmlns:vt="http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes"><Template></Template><TotalTime>36</TotalTime><Application>LibreOffice/6.0.7.3$Linux_X86_64 LibreOffice_project/00m0$Build-3</Application><Pages>1</Pages><Words>6</Words><Characters>6</Characters><CharactersWithSpaces>8</CharactersWithSpaces><Paragraphs>1</Paragraphs></Properties>

fixtures/highlight_and_underline/docProps/core.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<cp:coreProperties xmlns:cp="http://schemas.openxmlformats.org/package/2006/metadata/core-properties" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:dcterms="http://purl.org/dc/terms/" xmlns:dcmitype="http://purl.org/dc/dcmitype/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><dcterms:created xsi:type="dcterms:W3CDTF">2019-11-22T13:53:22Z</dcterms:created><dc:creator></dc:creator><dc:description></dc:description><dc:language>ja-JP</dc:language><cp:lastModifiedBy></cp:lastModifiedBy><dcterms:modified xsi:type="dcterms:W3CDTF">2019-11-22T15:50:33Z</dcterms:modified><cp:revision>1</cp:revision><dc:subject></dc:subject><dc:title></dc:title></cp:coreProperties>

fixtures/highlight_and_underline/word/_rels/document.xml.rels

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles" Target="styles.xml"/><Relationship Id="rId2" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/fontTable" Target="fontTable.xml"/><Relationship Id="rId3" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings" Target="settings.xml"/>
+</Relationships>

fixtures/highlight_and_underline/word/document.xml

@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<w:document xmlns:o="urn:schemas-microsoft-com:office:office" 
+    xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" 
+    xmlns:v="urn:schemas-microsoft-com:vml" 
+    xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" 
+    xmlns:w10="urn:schemas-microsoft-com:office:word" 
+    xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing" 
+    xmlns:wps="http://schemas.microsoft.com/office/word/2010/wordprocessingShape" 
+    xmlns:wpg="http://schemas.microsoft.com/office/word/2010/wordprocessingGroup" 
+    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
+    xmlns:wp14="http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing" 
+    xmlns:w14="http://schemas.microsoft.com/office/word/2010/wordml" mc:Ignorable="w14 wp14">
+    <w:body>
+        <w:p>
+            <w:pPr>
+                <w:pStyle w:val="Normal"/>
+                <w:rPr></w:rPr>
+            </w:pPr>
+            <w:r>
+                <w:rPr>
+                    <w:highlight w:val="yellow"/>
+                </w:rPr>
+                <w:t>マーカー</w:t>
+            </w:r>
+            <w:r>
+                <w:rPr></w:rPr>
+                <w:t xml:space="preserve"></w:t>
+            </w:r>
+            <w:r>
+                <w:rPr>
+                    <w:u w:val="single"/>
+                </w:rPr>
+                <w:t>下線</w:t>
+            </w:r>
+        </w:p>
+        <w:sectPr>
+            <w:type w:val="nextPage"/>
+            <w:pgSz w:w="11906" w:h="16838"/>
+            <w:pgMar w:left="1134" w:right="1134" w:header="0" w:top="1134" w:footer="0" w:bottom="1134" w:gutter="0"/>
+            <w:pgNumType w:fmt="decimal"/>
+            <w:formProt w:val="false"/>
+            <w:textDirection w:val="lrTb"/>
+        </w:sectPr>
+    </w:body>
+</w:document>

fixtures/highlight_and_underline/word/fontTable.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<w:fonts xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships"><w:font w:name="Times New Roman"><w:charset w:val="00"/><w:family w:val="roman"/><w:pitch w:val="variable"/></w:font><w:font w:name="Symbol"><w:charset w:val="02"/><w:family w:val="roman"/><w:pitch w:val="variable"/></w:font><w:font w:name="Arial"><w:charset w:val="00"/><w:family w:val="swiss"/><w:pitch w:val="variable"/></w:font><w:font w:name="Liberation Serif"><w:altName w:val="Times New Roman"/><w:charset w:val="01"/><w:family w:val="roman"/><w:pitch w:val="variable"/></w:font><w:font w:name="Liberation Sans"><w:altName w:val="Arial"/><w:charset w:val="01"/><w:family w:val="swiss"/><w:pitch w:val="variable"/></w:font></w:fonts>

fixtures/highlight_and_underline/word/settings.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<w:settings xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"><w:zoom w:percent="100"/><w:defaultTabStop w:val="709"/><w:compat><w:doNotExpandShiftReturn/></w:compat></w:settings>

fixtures/highlight_and_underline/word/styles.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<w:styles xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" xmlns:w14="http://schemas.microsoft.com/office/word/2010/wordml" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" mc:Ignorable="w14"><w:docDefaults><w:rPrDefault><w:rPr><w:rFonts w:ascii="Liberation Serif" w:hAnsi="Liberation Serif" w:eastAsia="Noto Sans CJK JP" w:cs="Lohit Devanagari"/><w:kern w:val="2"/><w:sz w:val="24"/><w:szCs w:val="24"/><w:lang w:val="en-US" w:eastAsia="ja-JP" w:bidi="hi-IN"/></w:rPr></w:rPrDefault><w:pPrDefault><w:pPr><w:widowControl/></w:pPr></w:pPrDefault></w:docDefaults><w:style w:type="paragraph" w:styleId="Normal"><w:name w:val="Normal"/><w:qFormat/><w:pPr><w:widowControl/></w:pPr><w:rPr><w:rFonts w:ascii="Liberation Serif" w:hAnsi="Liberation Serif" w:eastAsia="Noto Sans CJK JP" w:cs="Lohit Devanagari"/><w:color w:val="auto"/><w:kern w:val="2"/><w:sz w:val="24"/><w:szCs w:val="24"/><w:lang w:val="en-US" w:eastAsia="ja-JP" w:bidi="hi-IN"/></w:rPr></w:style><w:style w:type="paragraph" w:styleId="Style14"><w:name w:val="見出し"/><w:basedOn w:val="Normal"/><w:next w:val="Style15"/><w:qFormat/><w:pPr><w:keepNext w:val="true"/><w:spacing w:before="240" w:after="120"/></w:pPr><w:rPr><w:rFonts w:ascii="Liberation Sans" w:hAnsi="Liberation Sans" w:eastAsia="Noto Sans CJK JP" w:cs="Lohit Devanagari"/><w:sz w:val="28"/><w:szCs w:val="28"/></w:rPr></w:style><w:style w:type="paragraph" w:styleId="Style15"><w:name w:val="Body Text"/><w:basedOn w:val="Normal"/><w:pPr><w:spacing w:lineRule="auto" w:line="276" w:before="0" w:after="140"/></w:pPr><w:rPr></w:rPr></w:style><w:style w:type="paragraph" w:styleId="Style16"><w:name w:val="List"/><w:basedOn w:val="Style15"/><w:pPr></w:pPr><w:rPr><w:rFonts w:cs="Lohit Devanagari"/></w:rPr></w:style><w:style w:type="paragraph" w:styleId="Style17"><w:name w:val="Caption"/><w:basedOn w:val="Normal"/><w:qFormat/><w:pPr><w:suppressLineNumbers/><w:spacing w:before="120" w:after="120"/></w:pPr><w:rPr><w:rFonts w:cs="Lohit Devanagari"/><w:i/><w:iCs/><w:sz w:val="24"/><w:szCs w:val="24"/></w:rPr></w:style><w:style w:type="paragraph" w:styleId="Style18"><w:name w:val="索引"/><w:basedOn w:val="Normal"/><w:qFormat/><w:pPr><w:suppressLineNumbers/></w:pPr><w:rPr><w:rFonts w:cs="Lohit Devanagari"/></w:rPr></w:style></w:styles>