[vnotex] support mark

Author: tamlok

.gitignore

@@ -37,3 +37,6 @@ cmark
 # Visual Studio CMake support
 /.vs/
 /out/
+
+# Clangd
+.cache/*

parser_test/CMakeLists.txt

@@ -1,16 +1,15 @@
-add_executable(heading_tests
-    heading_tests.c
-    test_utils.c)
-target_link_libraries(heading_tests cmark)
-target_include_directories(heading_tests PRIVATE
-    ${CMAKE_SOURCE_DIR}/src
-    ${CMAKE_BINARY_DIR}/src)
+set(TEST_TARGETS
+    heading_tests
+    strikethrough_tests
+    mark_tests)
 
-add_executable(strikethrough_tests strikethrough_tests.c test_utils.c)
-target_link_libraries(strikethrough_tests cmark)
-target_include_directories(heading_tests PRIVATE
-    ${CMAKE_SOURCE_DIR}/src
-    ${CMAKE_BINARY_DIR}/src)
+foreach(TARGET ${TEST_TARGETS})
+    add_executable(${TARGET} ${TARGET}.c test_utils.c)
+    target_link_libraries(${TARGET} cmark)
+    add_test(NAME ${TARGET} COMMAND ${TARGET})
 
-add_test(NAME heading_tests COMMAND heading_tests)
-add_test(NAME strikethrough_tests COMMAND strikethrough_tests)
+    if(WIN32 AND BUILD_SHARED_LIBS)
+        set_tests_properties(${TARGET} PROPERTIES
+            ENVIRONMENT "PATH=$<TARGET_FILE_DIR:cmark>$<SEMICOLON>$ENV{PATH}")
+    endif()
+endforeach()

parser_test/mark_tests.c

@@ -0,0 +1,85 @@
+#include <cmark.h>
+
+#include "test_utils.h"
+
+int test_mark_simple() {
+  return test_xml("==mark==",
+      "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+      "<!DOCTYPE document SYSTEM \"CommonMark.dtd\">\n"
+      "<document sourcepos=\"1:1-1:8\" xmlns=\"http://commonmark.org/xml/1.0\">\n"
+      "  <paragraph sourcepos=\"1:1-1:8\">\n"
+      "    <mark sourcepos=\"1:1-1:8\">\n"
+      "      <text sourcepos=\"1:3-1:6\" xml:space=\"preserve\">mark</text>\n"
+      "    </mark>\n"
+      "  </paragraph>\n"
+      "</document>\n",
+      CMARK_OPT_SOURCEPOS);
+}
+
+int test_mark_multiple() {
+  return test_xml("==mark== and ==another==",
+      "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+      "<!DOCTYPE document SYSTEM \"CommonMark.dtd\">\n"
+      "<document xmlns=\"http://commonmark.org/xml/1.0\">\n"
+      "  <paragraph>\n"
+      "    <mark>\n"
+      "      <text xml:space=\"preserve\">mark</text>\n"
+      "    </mark>\n"
+      "    <text xml:space=\"preserve\"> and </text>\n"
+      "    <mark>\n"
+      "      <text xml:space=\"preserve\">another</text>\n"
+      "    </mark>\n"
+      "  </paragraph>\n"
+      "</document>\n",
+      CMARK_OPT_DEFAULT);
+}
+
+int test_mark_nested() {
+  return test_xml("==mark *with emphasis*==",
+      "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+      "<!DOCTYPE document SYSTEM \"CommonMark.dtd\">\n"
+      "<document xmlns=\"http://commonmark.org/xml/1.0\">\n"
+      "  <paragraph>\n"
+      "    <mark>\n"
+      "      <text xml:space=\"preserve\">mark </text>\n"
+      "      <emph>\n"
+      "        <text xml:space=\"preserve\">with emphasis</text>\n"
+      "      </emph>\n"
+      "    </mark>\n"
+      "  </paragraph>\n"
+      "</document>\n",
+      CMARK_OPT_DEFAULT);
+}
+
+int test_mark_incomplete() {
+  return test_xml("~mark~",
+      "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+      "<!DOCTYPE document SYSTEM \"CommonMark.dtd\">\n"
+      "<document xmlns=\"http://commonmark.org/xml/1.0\">\n"
+      "  <paragraph>\n"
+      "    <text xml:space=\"preserve\">~mark~</text>\n"
+      "  </paragraph>\n"
+      "</document>\n",
+      CMARK_OPT_DEFAULT);
+}
+
+int test_mark_not_closed() {
+  return test_xml("==mark",
+      "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+      "<!DOCTYPE document SYSTEM \"CommonMark.dtd\">\n"
+      "<document xmlns=\"http://commonmark.org/xml/1.0\">\n"
+      "  <paragraph>\n"
+      "    <text xml:space=\"preserve\">==mark</text>\n"
+      "  </paragraph>\n"
+      "</document>\n",
+      CMARK_OPT_DEFAULT);
+}
+
+int main() {
+  CASE(test_mark_simple);
+  CASE(test_mark_multiple);
+  CASE(test_mark_nested);
+  CASE(test_mark_incomplete);
+  CASE(test_mark_not_closed);
+  return 0;
+}

src/cmark.h

@@ -60,6 +60,7 @@ typedef enum {
   CMARK_NODE_EMPH,
   CMARK_NODE_STRONG,
   CMARK_NODE_STRIKETHROUGH,
+  CMARK_NODE_MARK,
   CMARK_NODE_LINK,
   CMARK_NODE_IMAGE,
 

src/html.c

@@ -277,6 +277,14 @@ static int S_render_node(cmark_node *node, cmark_event_type ev_type,
     }
     break;
 
+  case CMARK_NODE_MARK:
+    if (entering) {
+      cmark_strbuf_puts(html, "<mark>");
+    } else {
+      cmark_strbuf_puts(html, "</mark>");
+    }
+    break;
+
   case CMARK_NODE_EMPH:
     if (entering) {
       cmark_strbuf_puts(html, "<em>");

src/inlines.c

@@ -74,11 +74,8 @@ static inline bool S_is_line_end_char(char c) {
   return (c == '\n' || c == '\r');
 }
 
-static delimiter *S_insert_emph(subject *subj, delimiter *opener,
-                                delimiter *closer);
-
-static delimiter *S_insert_strikethrough(subject *subj, delimiter *opener,
-                                         delimiter *closer);
+static delimiter *S_insert_emph_like_inline(subject *subj, delimiter *opener,
+                                            delimiter *closer);
 
 static int parse_inline(subject *subj, cmark_node *parent, int options);
 
@@ -658,7 +655,8 @@ static void process_emphasis(subject *subj, bufsize_t stack_bottom) {
   delimiter *old_closer;
   bool opener_found;
   int openers_bottom_index = 0;
-  bufsize_t openers_bottom[18] = {stack_bottom, stack_bottom, stack_bottom,
+  bufsize_t openers_bottom[21] = {stack_bottom, stack_bottom, stack_bottom,
+                                  stack_bottom, stack_bottom, stack_bottom,
                                   stack_bottom, stack_bottom, stack_bottom,
                                   stack_bottom, stack_bottom, stack_bottom,
                                   stack_bottom, stack_bottom, stack_bottom,
@@ -694,6 +692,10 @@ static void process_emphasis(subject *subj, bufsize_t stack_bottom) {
         openers_bottom_index = 14 +
                 (closer->can_open ? 2 : 0) + (closer->length % 2);
         break;
+      case '=':
+        openers_bottom_index = 17 +
+                (closer->can_open ? 2 : 0) + (closer->length % 2);
+        break;
       default:
         assert(false);
       }
@@ -718,13 +720,13 @@ static void process_emphasis(subject *subj, bufsize_t stack_bottom) {
       old_closer = closer;
       if (closer->delim_char == '*' || closer->delim_char == '_') {
         if (opener_found) {
-          closer = S_insert_emph(subj, opener, closer);
+          closer = S_insert_emph_like_inline(subj, opener, closer);
         } else {
           closer = closer->next;
         }
-      } else if (closer->delim_char == '~') {
+      } else if (closer->delim_char == '~' || closer->delim_char == '=') {
         if (opener_found && opener->length >= 2 && closer->length >= 2) {
-          closer = S_insert_strikethrough(subj, opener, closer);
+          closer = S_insert_emph_like_inline(subj, opener, closer);
         } else {
           closer = closer->next;
         }
@@ -766,15 +768,16 @@ static void process_emphasis(subject *subj, bufsize_t stack_bottom) {
   }
 }
 
-static delimiter *S_insert_emph(subject *subj, delimiter *opener,
-                                delimiter *closer) {
+static delimiter *S_insert_emph_like_inline(subject *subj, delimiter *opener,
+                                            delimiter *closer) {
   delimiter *delim, *tmp_delim;
   bufsize_t use_delims;
   cmark_node *opener_inl = opener->inl_text;
   cmark_node *closer_inl = closer->inl_text;
   bufsize_t opener_num_chars = opener_inl->len;
   bufsize_t closer_num_chars = closer_inl->len;
   cmark_node *tmp, *tmpnext, *emph;
+  const char delim_char = closer->delim_char;
 
   // calculate the actual number of characters used from this closer
   use_delims = (closer_num_chars >= 2 && opener_num_chars >= 2) ? 2 : 1;
@@ -799,7 +802,17 @@ static delimiter *S_insert_emph(subject *subj, delimiter *opener,
 
   // create new emph or strong, and splice it in to our inlines
   // between the opener and closer
-  emph = use_delims == 1 ? make_emph(subj->mem) : make_strong(subj->mem);
+  switch (delim_char) {
+  case '~':
+    emph = make_simple(subj->mem, CMARK_NODE_STRIKETHROUGH);
+    break;
+  case '=':
+    emph = make_simple(subj->mem, CMARK_NODE_MARK);
+    break;
+  default:
+    emph = use_delims == 1 ? make_emph(subj->mem) : make_strong(subj->mem);
+    break;
+  }
 
   tmp = opener_inl->next;
   if (tmp && tmp != closer_inl) {
@@ -847,86 +860,6 @@ static delimiter *S_insert_emph(subject *subj, delimiter *opener,
   return closer;
 }
 
-static delimiter *S_insert_strikethrough(subject *subj, delimiter *opener,
-                                delimiter *closer) {
-  delimiter *delim, *tmp_delim;
-  bufsize_t use_delims;
-  cmark_node *opener_inl = opener->inl_text;
-  cmark_node *closer_inl = closer->inl_text;
-  bufsize_t opener_num_chars = opener_inl->len;
-  bufsize_t closer_num_chars = closer_inl->len;
-  cmark_node *tmp, *tmpnext, *strike;
-
-  // calculate the actual number of characters used from this closer
-  use_delims = 2;
-
-  // remove used characters from associated inlines.
-  opener_num_chars -= use_delims;
-  closer_num_chars -= use_delims;
-  opener_inl->len = opener_num_chars;
-  opener_inl->data[opener_num_chars] = 0;
-  opener_inl->end_column -= use_delims;
-  closer_inl->len = closer_num_chars;
-  closer_inl->data[closer_num_chars] = 0;
-  closer_inl->start_column += use_delims;
-
-  // free delimiters between opener and closer
-  delim = closer->previous;
-  while (delim != NULL && delim != opener) {
-    tmp_delim = delim->previous;
-    remove_delimiter(subj, delim);
-    delim = tmp_delim;
-  }
-
-  // create new strike node
-  strike = make_simple(subj->mem, CMARK_NODE_STRIKETHROUGH);
-
-  tmp = opener_inl->next;
-  if (tmp && tmp != closer_inl) {
-    strike->first_child = tmp;
-    tmp->prev = NULL;
-
-    while (tmp && tmp != closer_inl) {
-      tmpnext = tmp->next;
-      tmp->parent = strike;
-      if (tmpnext == closer_inl) {
-        strike->last_child = tmp;
-        tmp->next = NULL;
-      }
-      tmp = tmpnext;
-    }
-  }
-
-  opener_inl->next = strike;
-  closer_inl->prev = strike;
-  strike->prev = opener_inl;
-  strike->next = closer_inl;
-  strike->parent = opener_inl->parent;
-
-  strike->start_line = opener_inl->start_line;
-  strike->end_line = closer_inl->end_line;
-  strike->start_column = opener_inl->start_column + opener_inl->len;
-  strike->end_column = closer_inl->end_column - closer_inl->len;
-
-  // if opener has 0 characters, remove it and its associated inline
-  if (opener_num_chars == 0) {
-    cmark_node_free(opener_inl);
-    remove_delimiter(subj, opener);
-  }
-
-  // if closer has 0 characters, remove it and its associated inline
-  if (closer_num_chars == 0) {
-    // remove empty closer inline
-    cmark_node_free(closer_inl);
-    // remove closer from list
-    tmp_delim = closer->next;
-    remove_delimiter(subj, closer);
-    closer = tmp_delim;
-  }
-
-  return closer;
-}
-
 // Parse backslash-escape or just a backslash, returning an inline.
 static cmark_node *handle_backslash(subject *subj) {
   advance(subj);
@@ -1380,11 +1313,11 @@ static cmark_node *handle_newline(subject *subj) {
 
 static bufsize_t subject_find_special_char(subject *subj, int options) {
   // "\r\n\\`&_*[]<!"
-  // + "~"
+  // Add '~', '='.
   static const int8_t SPECIAL_CHARS[256] = {
       0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
       0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 0, 0,
-      0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+      0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
       0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 0, 1,
       1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
       0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
@@ -1455,6 +1388,7 @@ static int parse_inline(subject *subj, cmark_node *parent, int options) {
   case '\'':
   case '"':
   case '~':
+  case '=':
     new_inl = handle_delim(subj, c, (options & CMARK_OPT_SMART) != 0);
     break;
   case '-':

src/node.c

@@ -217,6 +217,8 @@ const char *cmark_node_get_type_string(cmark_node *node) {
     return "strong";
   case CMARK_NODE_STRIKETHROUGH:
     return "strikethrough";
+  case CMARK_NODE_MARK:
+    return "mark";
   case CMARK_NODE_LINK:
     return "link";
   case CMARK_NODE_IMAGE:

src/xml.c

@@ -177,17 +177,9 @@ static int S_render_node(cmark_node *node, cmark_event_type ev_type,
     case CMARK_NODE_STRONG:
     case CMARK_NODE_EMPH:
     case CMARK_NODE_STRIKETHROUGH:
+    case CMARK_NODE_MARK:
       break;
     case CMARK_NODE_LINK:
-      cmark_strbuf_puts(xml, " destination=\"");
-      escape_xml_str(xml, node->as.link.url);
-      cmark_strbuf_putc(xml, '"');
-      if (node->as.link.title) {
-        cmark_strbuf_puts(xml, " title=\"");
-        escape_xml_str(xml, node->as.link.title);
-        cmark_strbuf_putc(xml, '"');
-      }
-      break;
     case CMARK_NODE_IMAGE:
       cmark_strbuf_puts(xml, " destination=\"");
       escape_xml_str(xml, node->as.link.url);