Allow markdown in message format (#740)

* adds a new function get_content_as_message_markdown * passes an as_message argument through calls to functions that render the model as markdown
matrix-org · Jul 14, 2023 · 69e0e48 · 69e0e48
1 parent 61cdc44
commit 69e0e48
Show file tree

Hide file tree

Showing 14 changed files with 343 additions and 130 deletions.
diff --git a/bindings/wysiwyg-ffi/src/ffi_composer_model.rs b/bindings/wysiwyg-ffi/src/ffi_composer_model.rs
@@ -65,6 +65,14 @@ impl ComposerModel {
             .to_string()
     }
 
+    pub fn get_content_as_message_markdown(self: &Arc<Self>) -> String {
+        self.inner
+            .lock()
+            .unwrap()
+            .get_content_as_message_markdown()
+            .to_string()
+    }
+
     pub fn get_content_as_plain_text(self: &Arc<Self>) -> String {
         self.inner
             .lock()

diff --git a/bindings/wysiwyg-ffi/src/wysiwyg_composer.udl b/bindings/wysiwyg-ffi/src/wysiwyg_composer.udl
@@ -24,6 +24,7 @@ interface ComposerModel {
     string get_content_as_html();
     string get_content_as_message_html();
     string get_content_as_markdown();
+    string get_content_as_message_markdown();
     string get_content_as_plain_text();
     ComposerUpdate clear();
     ComposerUpdate select(u32 start_utf16_codeunit, u32 end_utf16_codeunit);

diff --git a/bindings/wysiwyg-wasm/src/lib.rs b/bindings/wysiwyg-wasm/src/lib.rs
@@ -128,6 +128,10 @@ impl ComposerModel {
         self.inner.get_content_as_markdown().to_string()
     }
 
+    pub fn get_content_as_message_markdown(&self) -> String {
+        self.inner.get_content_as_message_markdown().to_string()
+    }
+
     pub fn get_content_as_plain_text(&self) -> String {
         self.inner.get_content_as_plain_text().to_string()
     }

diff --git a/crates/wysiwyg/src/composer_model/base.rs b/crates/wysiwyg/src/composer_model/base.rs
@@ -203,6 +203,10 @@ where
         self.state.dom.to_markdown().unwrap()
     }
 
+    pub fn get_content_as_message_markdown(&self) -> S {
+        self.state.dom.to_message_markdown().unwrap()
+    }
+
     pub fn get_content_as_plain_text(&self) -> S {
         self.state.dom.to_plain_text()
     }

diff --git a/crates/wysiwyg/src/dom/dom_struct.rs b/crates/wysiwyg/src/dom/dom_struct.rs
@@ -669,8 +669,9 @@ where
         &self,
         buffer: &mut S,
         options: &MarkdownOptions,
+        as_message: bool,
     ) -> Result<(), MarkdownError<S>> {
-        self.document.fmt_markdown(buffer, options)
+        self.document.fmt_markdown(buffer, options, as_message)
     }
 }
 

diff --git a/crates/wysiwyg/src/dom/nodes/container_node.rs b/crates/wysiwyg/src/dom/nodes/container_node.rs
@@ -906,6 +906,7 @@ where
         &self,
         buffer: &mut S,
         options: &MarkdownOptions,
+        as_message: bool,
     ) -> Result<(), MarkdownError<S>> {
         use ContainerNodeKind::*;
         use InlineFormatType::*;
@@ -914,53 +915,53 @@ where
 
         match self.kind() {
             Generic => {
-                fmt_children(self, buffer, &options)?;
+                fmt_children(self, buffer, &options, as_message)?;
             }
 
             // Simple emphasis.
             Formatting(Italic) => {
-                fmt_italic(self, buffer, &options)?;
+                fmt_italic(self, buffer, &options, as_message)?;
             }
 
             // Strong emphasis.
             Formatting(Bold) => {
-                fmt_bold(self, buffer, &options)?;
+                fmt_bold(self, buffer, &options, as_message)?;
             }
 
             Formatting(StrikeThrough) => {
-                fmt_strikethrough(self, buffer, &options)?;
+                fmt_strikethrough(self, buffer, &options, as_message)?;
             }
 
             Formatting(Underline) => {
-                fmt_underline(self, buffer, &options)?;
+                fmt_underline(self, buffer, &options, as_message)?;
             }
 
             Formatting(InlineCode) => {
-                fmt_inline_code(self, buffer, &mut options)?;
+                fmt_inline_code(self, buffer, &mut options, as_message)?;
             }
 
             Link(url) => {
-                fmt_link(self, buffer, &options, url)?;
+                fmt_link(self, buffer, &options, url, as_message)?;
             }
 
             List(_) => {
-                fmt_list(self, buffer, &options)?;
+                fmt_list(self, buffer, &options, as_message)?;
             }
 
             ListItem => {
-                fmt_list_item(self, buffer, &options)?;
+                fmt_list_item(self, buffer, &options, as_message)?;
             }
 
             CodeBlock => {
-                fmt_code_block(self, buffer, &options)?;
+                fmt_code_block(self, buffer, &options, as_message)?;
             }
 
             Quote => {
-                fmt_quote(self, buffer, &options)?;
+                fmt_quote(self, buffer, &options, as_message)?;
             }
 
             Paragraph => {
-                fmt_paragraph(self, buffer, &options)?;
+                fmt_paragraph(self, buffer, &options, as_message)?;
             }
         };
 
@@ -974,6 +975,7 @@ where
             this: &ContainerNode<S>,
             buffer: &mut S,
             options: &MarkdownOptions,
+            as_message: bool,
         ) -> Result<(), MarkdownError<S>>
         where
             S: UnicodeString,
@@ -983,7 +985,7 @@ where
                     buffer.push("\n");
                 }
 
-                child.fmt_markdown(buffer, options)?;
+                child.fmt_markdown(buffer, options, as_message)?;
             }
 
             Ok(())
@@ -994,6 +996,7 @@ where
             this: &ContainerNode<S>,
             buffer: &mut S,
             options: &MarkdownOptions,
+            as_message: bool,
         ) -> Result<(), MarkdownError<S>>
         where
             S: UnicodeString,
@@ -1005,7 +1008,7 @@ where
             // trend to avoid unexpected behaviours for our users.
 
             buffer.push("*");
-            fmt_children(this, buffer, options)?;
+            fmt_children(this, buffer, options, as_message)?;
             buffer.push("*");
 
             Ok(())
@@ -1016,6 +1019,7 @@ where
             this: &ContainerNode<S>,
             buffer: &mut S,
             options: &MarkdownOptions,
+            as_message: bool,
         ) -> Result<(), MarkdownError<S>>
         where
             S: UnicodeString,
@@ -1031,7 +1035,7 @@ where
             // there. Instead, it will produce `*__…__*`.
 
             buffer.push("__");
-            fmt_children(this, buffer, options)?;
+            fmt_children(this, buffer, options, as_message)?;
             buffer.push("__");
 
             Ok(())
@@ -1042,6 +1046,7 @@ where
             this: &ContainerNode<S>,
             buffer: &mut S,
             options: &MarkdownOptions,
+            as_message: bool,
         ) -> Result<(), MarkdownError<S>>
         where
             S: UnicodeString,
@@ -1053,7 +1058,7 @@ where
             // do not support this format extension.
 
             buffer.push("~~");
-            fmt_children(this, buffer, options)?;
+            fmt_children(this, buffer, options, as_message)?;
             buffer.push("~~");
 
             Ok(())
@@ -1064,6 +1069,7 @@ where
             this: &ContainerNode<S>,
             buffer: &mut S,
             options: &MarkdownOptions,
+            as_message: bool,
         ) -> Result<(), MarkdownError<S>>
         where
             S: UnicodeString,
@@ -1072,7 +1078,7 @@ where
             // use raw HTML.
 
             buffer.push("<u>");
-            fmt_children(this, buffer, options)?;
+            fmt_children(this, buffer, options, as_message)?;
             buffer.push("</u>");
 
             Ok(())
@@ -1083,6 +1089,7 @@ where
             this: &ContainerNode<S>,
             buffer: &mut S,
             options: &mut MarkdownOptions,
+            as_message: bool,
         ) -> Result<(), MarkdownError<S>>
         where
             S: UnicodeString,
@@ -1102,7 +1109,7 @@ where
             buffer.push("`` ");
 
             options.insert(MarkdownOptions::IGNORE_LINE_BREAK);
-            fmt_children(this, buffer, options)?;
+            fmt_children(this, buffer, options, as_message)?;
 
             buffer.push(" ``");
 
@@ -1115,13 +1122,14 @@ where
             buffer: &mut S,
             options: &MarkdownOptions,
             url: &S,
+            as_message: bool,
         ) -> Result<(), MarkdownError<S>>
         where
             S: UnicodeString,
         {
             buffer.push('[');
 
-            fmt_children(this, buffer, options)?;
+            fmt_children(this, buffer, options, as_message)?;
 
             // A link destination can be delimited by `<` and
             // `>`.
@@ -1150,6 +1158,7 @@ where
             this: &ContainerNode<S>,
             buffer: &mut S,
             options: &MarkdownOptions,
+            as_message: bool,
         ) -> Result<(), MarkdownError<S>>
         where
             S: UnicodeString,
@@ -1240,7 +1249,11 @@ where
                 {
                     // Let's create a new buffer for the child formatting.
                     let mut child_buffer = S::default();
-                    child.fmt_markdown(&mut child_buffer, options)?;
+                    child.fmt_markdown(
+                        &mut child_buffer,
+                        options,
+                        as_message,
+                    )?;
 
                     // Generate the indentation of form `\n` followed by
                     // $x$ spaces where $x$ is `indentation`.
@@ -1279,11 +1292,12 @@ where
             this: &ContainerNode<S>,
             buffer: &mut S,
             options: &MarkdownOptions,
+            as_message: bool,
         ) -> Result<(), MarkdownError<S>>
         where
             S: UnicodeString,
         {
-            fmt_children(this, buffer, options)?;
+            fmt_children(this, buffer, options, as_message)?;
 
             Ok(())
         }
@@ -1293,12 +1307,13 @@ where
             this: &ContainerNode<S>,
             buffer: &mut S,
             options: &MarkdownOptions,
+            as_message: bool,
         ) -> Result<(), MarkdownError<S>>
         where
             S: UnicodeString,
         {
             buffer.push("```\n");
-            fmt_children(this, buffer, options)?;
+            fmt_children(this, buffer, options, as_message)?;
             buffer.push("\n```\n");
 
             Ok(())
@@ -1309,12 +1324,13 @@ where
             this: &ContainerNode<S>,
             buffer: &mut S,
             options: &MarkdownOptions,
+            as_message: bool,
         ) -> Result<(), MarkdownError<S>>
         where
             S: UnicodeString,
         {
             buffer.push("> ");
-            fmt_children(this, buffer, options)?;
+            fmt_children(this, buffer, options, as_message)?;
             buffer.push("\n");
 
             Ok(())
@@ -1325,11 +1341,12 @@ where
             this: &ContainerNode<S>,
             buffer: &mut S,
             options: &MarkdownOptions,
+            as_message: bool,
         ) -> Result<(), MarkdownError<S>>
         where
             S: UnicodeString,
         {
-            fmt_children(this, buffer, options)?;
+            fmt_children(this, buffer, options, as_message)?;
 
             Ok(())
         }

diff --git a/crates/wysiwyg/src/dom/nodes/dom_node.rs b/crates/wysiwyg/src/dom/nodes/dom_node.rs
@@ -485,14 +485,21 @@ where
         &self,
         buffer: &mut S,
         options: &MarkdownOptions,
+        as_message: bool,
     ) -> Result<(), MarkdownError<S>> {
         match self {
             DomNode::Container(container) => {
-                container.fmt_markdown(buffer, options)
+                container.fmt_markdown(buffer, options, as_message)
+            }
+            DomNode::Text(text) => {
+                text.fmt_markdown(buffer, options, as_message)
+            }
+            DomNode::LineBreak(node) => {
+                node.fmt_markdown(buffer, options, as_message)
+            }
+            DomNode::Mention(node) => {
+                node.fmt_markdown(buffer, options, as_message)
             }
-            DomNode::Text(text) => text.fmt_markdown(buffer, options),
-            DomNode::LineBreak(node) => node.fmt_markdown(buffer, options),
-            DomNode::Mention(node) => node.fmt_markdown(buffer, options),
         }
     }
 }

diff --git a/crates/wysiwyg/src/dom/nodes/line_break_node.rs b/crates/wysiwyg/src/dom/nodes/line_break_node.rs
@@ -128,6 +128,7 @@ where
         &self,
         buffer: &mut S,
         options: &MarkdownOptions,
+        _as_message: bool,
     ) -> Result<(), MarkdownError<S>> {
         if options.contains(MarkdownOptions::IGNORE_LINE_BREAK) {
             // Replace the line break by a single space.