Support carriage return runs (#887)

* Support carriage return runs

* Update snapshot for carriage return runs

Author: yuntara

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

@@ -0,0 +1,34 @@
+use serde::ser::{Serialize, SerializeStruct, Serializer};
+use serde::Deserialize;
+use std::io::Write;
+
+use crate::documents::BuildXML;
+use crate::xml_builder::*;
+
+#[derive(Debug, Clone, Deserialize, PartialEq)]
+pub struct CarriageReturn {}
+
+impl CarriageReturn {
+    pub fn new() -> CarriageReturn {
+        CarriageReturn {}
+    }
+}
+
+impl BuildXML for CarriageReturn {
+    fn build_to<W: Write>(
+        &self,
+        stream: crate::xml::writer::EventWriter<W>,
+    ) -> crate::xml::writer::Result<crate::xml::writer::EventWriter<W>> {
+        XMLBuilder::from(stream).cr()?.into_inner()
+    }
+}
+
+impl Serialize for CarriageReturn {
+    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: Serializer,
+    {
+        let t = serializer.serialize_struct("CarriageReturn", 0)?;
+        t.end()
+    }
+}

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

@@ -17,6 +17,7 @@ mod comment;
 mod comment_extended;
 mod comment_range_end;
 mod comment_range_start;
+mod cr;
 mod data_binding;
 mod default_tab_stop;
 mod delete;
@@ -158,6 +159,7 @@ pub use comment::*;
 pub use comment_extended::*;
 pub use comment_range_end::*;
 pub use comment_range_start::*;
+pub use cr::*;
 pub use data_binding::*;
 pub use default_tab_stop::*;
 pub use delete::*;

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

@@ -32,6 +32,7 @@ pub enum RunChild {
     Tab(Tab),
     PTab(PositionalTab),
     Break(Break),
+    CarriageReturn(CarriageReturn),
     Drawing(Box<Drawing>),
     Shape(Box<Shape>),
     CommentStart(Box<CommentRangeStart>),
@@ -86,6 +87,11 @@ impl Serialize for RunChild {
                 t.serialize_field("data", s)?;
                 t.end()
             }
+            RunChild::CarriageReturn(_) => {
+                let mut t = serializer.serialize_struct("CarriageReturn", 1)?;
+                t.serialize_field("type", "carriageReturn")?;
+                t.end()
+            }
             RunChild::Drawing(ref s) => {
                 let mut t = serializer.serialize_struct("Drawing", 2)?;
                 t.serialize_field("type", "drawing")?;
@@ -243,6 +249,12 @@ impl Run {
         self
     }
 
+    pub fn add_carriage_return(mut self) -> Run {
+        self.children
+            .push(RunChild::CarriageReturn(CarriageReturn::new()));
+        self
+    }
+
     pub fn add_sym(mut self, sym: Sym) -> Run {
         self.children.push(RunChild::Sym(sym));
         self
@@ -358,6 +370,7 @@ impl BuildXML for RunChild {
             RunChild::Tab(t) => t.build_to(stream),
             RunChild::PTab(t) => t.build_to(stream),
             RunChild::Break(t) => t.build_to(stream),
+            RunChild::CarriageReturn(t) => t.build_to(stream),
             RunChild::Drawing(t) => t.build_to(stream),
             RunChild::Shape(_t) => {
                 todo!("Support shape writer.")
@@ -439,6 +452,7 @@ mod tests {
                 RunChild::Tab(Tab::new()),
                 RunChild::Text(Text::new("Hello")),
                 RunChild::Break(Break::new(BreakType::Page)),
+                RunChild::CarriageReturn(CarriageReturn::new()),
                 RunChild::DeleteText(DeleteText::new("deleted")),
             ],
             run_property: RunProperty {
@@ -458,7 +472,7 @@ mod tests {
         };
         assert_eq!(
             serde_json::to_string(&run).unwrap(),
-            r#"{"runProperty":{"sz":30,"szCs":30,"color":"C9211E","highlight":"yellow","underline":"single","bold":true,"boldCs":true,"italic":true,"italicCs":true,"vanish":true,"characterSpacing":100},"children":[{"type":"tab"},{"type":"text","data":{"preserveSpace":true,"text":"Hello"}},{"type":"break","data":{"breakType":"page"}},{"type":"deleteText","data":{"text":"deleted","preserveSpace":true}}]}"#,
+            r#"{"runProperty":{"sz":30,"szCs":30,"color":"C9211E","highlight":"yellow","underline":"single","bold":true,"boldCs":true,"italic":true,"italicCs":true,"vanish":true,"characterSpacing":100},"children":[{"type":"tab"},{"type":"text","data":{"preserveSpace":true,"text":"Hello"}},{"type":"break","data":{"breakType":"page"}},{"type":"carriageReturn"},{"type":"deleteText","data":{"text":"deleted","preserveSpace":true}}]}"#,
         );
     }
 

docx-core/src/reader/run.rs

@@ -94,6 +94,9 @@ impl ElementReader for Run {
                                         run = run.add_break(BreakType::TextWrapping)
                                     }
                                 }
+                                XMLElement::CarriageReturn => {
+                                    run = run.add_carriage_return();
+                                }
                                 XMLElement::Drawing => {
                                     if let Ok(drawing) = Drawing::read(r, &attributes) {
                                         run = run.add_drawing(drawing);
@@ -262,6 +265,22 @@ mod tests {
         );
     }
 
+    #[test]
+    fn test_read_cr() {
+        let c = r#"<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+  <w:r><w:cr /></w:r>
+</w:document>"#;
+        let mut parser = EventReader::new(c.as_bytes());
+        let run = Run::read(&mut parser, &[]).unwrap();
+        assert_eq!(
+            run,
+            Run {
+                children: vec![RunChild::CarriageReturn(CarriageReturn::new())],
+                run_property: RunProperty::default(),
+            }
+        );
+    }
+
     #[test]
     fn test_read_italic_false() {
         let c = r#"<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">

docx-core/src/reader/xml_element.rs

@@ -35,6 +35,7 @@ pub enum XMLElement {
     RunStyle,
     BoldCs,
     Break,
+    CarriageReturn,
     Tab,
     Tabs,
     PTab,
@@ -293,6 +294,7 @@ impl FromStr for XMLElement {
             "tabs" => Ok(XMLElement::Tabs),
             "ptab" => Ok(XMLElement::PTab),
             "br" => Ok(XMLElement::Break),
+            "cr" => Ok(XMLElement::CarriageReturn),
             "ind" => Ok(XMLElement::Indent),
             "numPr" => Ok(XMLElement::NumberingProperty),
             "ilvl" => Ok(XMLElement::IndentLevel),

docx-core/src/xml_builder/elements.rs

@@ -403,6 +403,7 @@ impl<W: Write> XMLBuilder<W> {
     closed!(tab_with_pos, "w:tab", "w:val", "w:pos");
 
     closed!(br, "w:br", "w:type");
+    closed!(cr, "w:cr");
     closed!(sym, "w:sym", "w:font", "w:char");
     closed!(zoom, "w:zoom", "w:percent");
     closed_with_usize!(default_tab_stop, "w:defaultTabStop");

docx-wasm/js/carriage-return.ts

@@ -0,0 +1 @@
+export class CarriageReturn {}

docx-wasm/js/index.ts

@@ -716,6 +716,7 @@ export * from "./abstract-numbering";
 export * from "./bookmark-start";
 export * from "./bookmark-end";
 export * from "./break";
+export * from "./carriage-return";
 export * from "./delete-text";
 export * from "./level";
 export * from "./tab";

docx-wasm/js/json/run.ts

@@ -71,6 +71,7 @@ export type RunChildJSON =
   | SymJSON
   | DeleteTextJSON
   | TabJSON
+  | CarriageReturnJSON
   | BreakJSON
   | DrawingJSON
   | PtabJSON
@@ -117,6 +118,10 @@ export type TabJSON = {
   type: "tab";
 };
 
+export type CarriageReturnJSON = {
+  type: "carriageReturn";
+};
+
 export type BreakJSON = {
   type: "break";
   data: {

docx-wasm/js/run.ts

@@ -4,6 +4,7 @@ import { Text } from "./text";
 import { DeleteText } from "./delete-text";
 import { Tab } from "./tab";
 import { Break, BreakType } from "./break";
+import { CarriageReturn } from "./carriage-return";
 import { BorderType } from "./border";
 import { Image } from "./image";
 import { PositionalTab } from "./positional-tab";
@@ -20,6 +21,7 @@ export type RunChild =
   | Text
   | DeleteText
   | Tab
+  | CarriageReturn
   | Break
   | Image
   | PositionalTab
@@ -59,6 +61,11 @@ export class Run {
     return this;
   }
 
+  addCarriageReturn() {
+    this.children.push(new CarriageReturn());
+    return this;
+  }
+
   addTc(tc: Tc) {
     this.children.push(tc);
     return this;
@@ -187,6 +194,8 @@ export class Run {
         run = run.add_delete_text(child.text);
       } else if (child instanceof Tab) {
         run = run.add_tab();
+      } else if (child instanceof CarriageReturn) {
+        run = run.add_carriage_return();
       } else if (child instanceof PositionalTab) {
         run = run.add_ptab(child.buildWasmObject());
       } else if (child instanceof Break) {