Merge pull request #672 from pferreir/add-highlight

Add a Highlight Extension ==for highlights==

Author: kivikakk

src/cm.rs

@@ -397,6 +397,7 @@ impl<'a, 'o, 'c> CommonMarkFormatter<'a, 'o, 'c> {
             NodeValue::Emph => self.format_emph(node)?,
             NodeValue::TaskItem(symbol) => self.format_task_item(symbol, node, entering)?,
             NodeValue::Strikethrough => self.format_strikethrough()?,
+            NodeValue::Highlight => self.format_highlight()?,
             NodeValue::Superscript => self.format_superscript()?,
             NodeValue::Link(ref nl) => return self.format_link(node, nl, entering),
             NodeValue::Image(ref nl) => self.format_image(nl, allow_wrap, entering)?,
@@ -783,6 +784,11 @@ impl<'a, 'o, 'c> CommonMarkFormatter<'a, 'o, 'c> {
         Ok(())
     }
 
+    fn format_highlight(&mut self) -> fmt::Result {
+        write!(self, "==")?;
+        Ok(())
+    }
+
     fn format_superscript(&mut self) -> fmt::Result {
         write!(self, "^")?;
         Ok(())

src/html.rs

@@ -440,6 +440,7 @@ pub fn format_node_default<'a, T>(
             render_footnote_reference(context, node, entering, nfr)
         }
         NodeValue::Strikethrough => render_strikethrough(context, node, entering),
+        NodeValue::Highlight => render_highlight(context, node, entering),
         NodeValue::Table(_) => render_table(context, node, entering),
         NodeValue::TableCell => render_table_cell(context, node, entering),
         NodeValue::TableRow(thead) => render_table_row(context, node, entering, thead),
@@ -1034,6 +1035,22 @@ fn render_strikethrough<'a, T>(
     Ok(ChildRendering::HTML)
 }
 
+fn render_highlight<'a, T>(
+    context: &mut Context<T>,
+    node: Node<'a>,
+    entering: bool,
+) -> Result<ChildRendering, fmt::Error> {
+    if entering {
+        context.write_str("<mark")?;
+        render_sourcepos(context, node)?;
+        context.write_str(">")?;
+    } else {
+        context.write_str("</mark>")?;
+    }
+
+    Ok(ChildRendering::HTML)
+}
+
 fn render_table<'a, T>(
     context: &mut Context<T>,
     node: Node<'a>,

src/main.rs

@@ -196,6 +196,7 @@ enum Extension {
     Alerts,
     CjkFriendlyEmphasis,
     Subtext,
+    Highlight,
 }
 
 #[derive(Clone, Copy, Debug, ValueEnum)]
@@ -284,7 +285,8 @@ fn main() -> Result<(), Box<dyn Error>> {
         .alerts(exts.contains(&Extension::Alerts))
         .maybe_front_matter_delimiter(cli.front_matter_delimiter)
         .cjk_friendly_emphasis(exts.contains(&Extension::CjkFriendlyEmphasis))
-        .subtext(exts.contains(&Extension::Subtext));
+        .subtext(exts.contains(&Extension::Subtext))
+        .highlight(exts.contains(&Extension::Highlight));
 
     #[cfg(feature = "shortcodes")]
     let extension = extension.shortcodes(cli.gemoji);

src/nodes.rs

@@ -159,6 +159,9 @@ pub enum NodeValue {
     /// per the GFM spec.
     Strikethrough,
 
+    /// ***Inline**. [Highlight](https://www.markdownlang.com/extended/highlight.html) / mark text
+    Highlight,
+
     /// **Inline**.  Superscript.  Enabled with `ext_superscript` option.
     Superscript,
 
@@ -646,6 +649,7 @@ impl NodeValue {
             NodeValue::HtmlInline(..) => "html_inline",
             NodeValue::Raw(..) => "raw",
             NodeValue::Strikethrough => "strikethrough",
+            NodeValue::Highlight => "highlight",
             NodeValue::FrontMatter(_) => "frontmatter",
             NodeValue::TaskItem { .. } => "taskitem",
             NodeValue::Superscript => "superscript",
@@ -925,6 +929,7 @@ impl<'a> arena_tree::Node<'a, RefCell<Ast>> {
             | NodeValue::Image(..)
             | NodeValue::WikiLink(..)
             | NodeValue::Strikethrough
+            | NodeValue::Highlight
             | NodeValue::Superscript
             | NodeValue::SpoileredText
             | NodeValue::Underline
@@ -947,6 +952,7 @@ impl<'a> arena_tree::Node<'a, RefCell<Ast>> {
                     | NodeValue::Link(..)
                     | NodeValue::Image(..)
                     | NodeValue::Strikethrough
+                    | NodeValue::Highlight
                     | NodeValue::HtmlInline(..)
                     | NodeValue::Math(..)
                     | NodeValue::WikiLink(..)
@@ -969,6 +975,7 @@ impl<'a> arena_tree::Node<'a, RefCell<Ast>> {
                 | NodeValue::Link(..)
                 | NodeValue::Image(..)
                 | NodeValue::Strikethrough
+                | NodeValue::Highlight
                 | NodeValue::HtmlInline(..)
                 | NodeValue::Math(..)
                 | NodeValue::WikiLink(..)

src/parser/inlines.rs

@@ -107,6 +107,11 @@ impl<'a, 'r, 'o, 'd, 'c, 'p> Subject<'a, 'r, 'o, 'd, 'c, 'p> {
             s.skip_char_bytes[b'~' as usize] = true;
             s.emph_delim_bytes[b'~' as usize] = true;
         }
+        if options.extension.highlight {
+            s.special_char_bytes[b'=' as usize] = true;
+            s.skip_char_bytes[b'=' as usize] = true;
+            s.emph_delim_bytes[b'=' as usize] = true;
+        }
         if options.extension.superscript || options.extension.inline_footnotes {
             s.special_char_bytes[b'^' as usize] = true;
         }
@@ -198,6 +203,7 @@ impl<'a, 'r, 'o, 'd, 'c, 'p> Subject<'a, 'r, 'o, 'd, 'c, 'p> {
         let new_inl: Option<Node<'a>> = match b {
             b'\r' | b'\n' => Some(self.handle_newline()),
             b'`' => Some(self.handle_backticks(&ast.line_offsets)),
+            b'=' if self.options.extension.highlight => Some(self.handle_delim(b'=')),
             b'\\' => Some(self.handle_backslash()),
             b'&' => Some(self.handle_entity()),
             b'<' => Some(self.handle_pointy_brace(&ast.line_offsets)),
@@ -684,15 +690,18 @@ impl<'a, 'r, 'o, 'd, 'c, 'p> Subject<'a, 'r, 'o, 'd, 'c, 'p> {
             self.scanner.pos - 1,
         );
 
-        let is_valid_strikethrough_delim = if b == b'~' && self.options.extension.strikethrough {
+        let is_valid_double_delim_if_required = if b == b'~' && self.options.extension.strikethrough
+        {
             numdelims <= 2
+        } else if b == b'=' && self.options.extension.highlight {
+            numdelims == 2
         } else {
             true
         };
 
         if (can_open || can_close)
             && (!(b == b'\'' || b == b'"') || self.options.parse.smart)
-            && is_valid_strikethrough_delim
+            && is_valid_double_delim_if_required
         {
             self.push_delimiter(b, can_open, can_close, inl);
         }
@@ -1202,7 +1211,7 @@ impl<'a, 'r, 'o, 'd, 'c, 'p> Subject<'a, 'r, 'o, 'd, 'c, 'p> {
         // This array is an important optimization that prevents searching down
         // the stack for openers we've previously searched for and know don't
         // exist, preventing exponential blowup on pathological cases.
-        let mut openers_bottom: [usize; 12] = [stack_bottom; 12];
+        let mut openers_bottom: [usize; 13] = [stack_bottom; 13];
 
         // This is traversing the stack from the top to the bottom, setting `closer` to
         // the delimiter directly above `stack_bottom`. In the case where we are processing
@@ -1233,6 +1242,7 @@ impl<'a, 'r, 'o, 'd, 'c, 'p> Subject<'a, 'r, 'o, 'd, 'c, 'p> {
                     b'\'' => 4,
                     b'_' => 5,
                     b'*' => 6 + (if c.can_open { 3 } else { 0 }) + (c.length % 3),
+                    b'=' => 12,
                     _ => unreachable!(),
                 };
 
@@ -1459,6 +1469,12 @@ impl<'a, 'r, 'o, 'd, 'c, 'p> Subject<'a, 'r, 'o, 'd, 'c, 'p> {
                 }
             } else if self.options.extension.superscript && opener_byte == b'^' {
                 NodeValue::Superscript
+            } else if opener_byte == b'=' {
+                if self.options.extension.highlight {
+                    NodeValue::Highlight
+                } else {
+                    NodeValue::EscapedTag("==".to_owned())
+                }
             } else if self.options.extension.spoiler && opener_byte == b'|' {
                 if use_delims == 2 {
                     NodeValue::SpoileredText

src/parser/options.rs

@@ -526,6 +526,23 @@ pub struct Extension<'c> {
     /// ```
     #[cfg_attr(feature = "bon", builder(default))]
     pub subtext: bool,
+
+    /// Enables highlighting (mark) using `==`.
+    ///
+    /// ```md
+    /// Hey, ==this is important!==
+    /// ```
+    ///
+    /// ```rust
+    /// # use comrak::{markdown_to_html, Options};
+    /// let mut options = Options::default();
+    /// options.extension.highlight = true;
+    ///
+    /// assert_eq!(markdown_to_html("Hey, ==this is important!==", &options),
+    ///           "<p>Hey, <mark>this is important!</mark></p>\n");
+    /// ```
+    #[cfg_attr(feature = "bon", builder(default))]
+    pub highlight: bool,
 }
 
 impl<'c> Extension<'c> {

src/tests.rs

@@ -21,6 +21,7 @@ mod front_matter;
 mod fuzz;
 mod greentext;
 mod header_ids;
+mod highlight;
 #[path = "tests/html.rs"]
 mod html_;
 mod inline_footnotes;

src/tests/highlight.rs

@@ -0,0 +1,26 @@
+use super::*;
+
+#[test]
+fn highlight() {
+    html_opts!(
+        [extension.highlight],
+        concat!(
+            "This is ==important!==.\n",
+            "\n",
+            "This is ==very important== OK?\n",
+            "\n",
+            "==It is a \n shrubbery==\n",
+            "\n",
+            "Vendo ==Opel Corsa **em bom estado**==\n",
+            "\n",
+            "Ceci n'est pas =important=\n"
+        ),
+        concat!(
+            "<p>This is <mark>important!</mark>.</p>\n",
+            "<p>This is <mark>very important</mark> OK?</p>\n",
+            "<p><mark>It is a\nshrubbery</mark></p>\n",
+            "<p>Vendo <mark>Opel Corsa <strong>em bom estado</strong></mark></p>\n",
+            "<p>Ceci n'est pas =important=</p>\n"
+        ),
+    );
+}

src/tests/sourcepos.rs

@@ -298,6 +298,11 @@ const STRIKETHROUGH: TestCase = (
     "hello ~~world~~ between ~~wo\nrld~~ after",
 );
 
+const HIGHLIGHT: TestCase = (
+    &[sourcepos!((1:7-1:15)), sourcepos!((1:25-2:5))],
+    "hello ==world== between ==wo\nrld== after",
+);
+
 const SUPERSCRIPT: TestCase = (
     &[sourcepos!((1:7-1:13)), sourcepos!((1:23-2:4))],
     "hello ^world^ between ^wo\nrld^ after",
@@ -475,6 +480,7 @@ fn node_values() -> HashMap<NodeValueDiscriminants, TestCase> {
                 Emph => EMPH,
                 Strong => STRONG,
                 Strikethrough => STRIKETHROUGH,
+                Highlight => HIGHLIGHT,
                 Superscript => SUPERSCRIPT,
                 Subscript => SUBSCRIPT,
                 Link => LINK,
@@ -508,6 +514,7 @@ fn sourcepos() {
     options.extension.table = true;
     options.extension.tasklist = true;
     options.extension.strikethrough = true;
+    options.extension.highlight = true;
     options.extension.superscript = true;
     options.extension.subscript = true;
     options.extension.autolink = true;

src/xml.rs

@@ -223,6 +223,7 @@ impl<'o, 'c> XmlFormatter<'o, 'c> {
                 NodeValue::Strong => {}
                 NodeValue::Emph => {}
                 NodeValue::Strikethrough => {}
+                NodeValue::Highlight => {}
                 NodeValue::Superscript => {}
                 NodeValue::Link(ref nl) | NodeValue::Image(ref nl) => {
                     self.output.write_str(" destination=\"")?;