perf(markup): filter out nodes before matching and do not highlight empty range

Author: kristijanhusak

lua/orgmode/colors/highlighter/markup/_meta.lua

@@ -30,7 +30,7 @@
 ---@field url? string
 
 ---@class OrgMarkupHighlighter
----@field parse_node fun(self: OrgMarkupHighlighter, node: TSNode): OrgMarkupNode | false
+---@field parse_node fun(self: OrgMarkupHighlighter, node: TSNode, capture_name: string): OrgMarkupNode | false
 ---@field is_valid_start_node fun(self: OrgMarkupHighlighter, entry: OrgMarkupNode, bufnr: number): boolean
 ---@field is_valid_end_node fun(self: OrgMarkupHighlighter, entry: OrgMarkupNode, bufnr: number): boolean
 ---@field highlight fun(self: OrgMarkupHighlighter, highlights: OrgMarkupHighlight[], bufnr: number)

lua/orgmode/colors/highlighter/markup/dates.lua

@@ -1,6 +1,13 @@
 ---@class OrgDatesHighlighter : OrgMarkupHighlighter
 ---@field private markup OrgMarkupHighlighter
-local OrgDates = {}
+local OrgDates = {
+  valid_capture_names = {
+    ['date_active.start'] = true,
+    ['date_active.end'] = true,
+    ['date_inactive.start'] = true,
+    ['date_inactive.end'] = true,
+  },
+}
 
 ---@param opts { markup: OrgMarkupHighlighter }
 function OrgDates:new(opts)
@@ -13,8 +20,12 @@ function OrgDates:new(opts)
 end
 
 ---@param node TSNode
+---@param name string
 ---@return OrgMarkupNode | false
-function OrgDates:parse_node(node)
+function OrgDates:parse_node(node, name)
+  if not self.valid_capture_names[name] then
+    return false
+  end
   local type = node:type()
   if type == '[' or type == '<' then
     return self:_parse_start_node(node)
@@ -93,8 +104,9 @@ function OrgDates:_parse_end_node(node)
   local prev_sibling = node:prev_sibling()
   local next_sibling = node:next_sibling()
   local is_prev_sibling_valid = not prev_sibling or prev_sibling:type() == 'str' or prev_sibling:type() == 'num'
-  -- Ensure it's not a link
-  local is_next_sibling_valid = not next_sibling or (node_type == ']' and next_sibling:type() ~= ']')
+  -- Ensure it's not a link or a link alias
+  local is_next_sibling_valid = not next_sibling
+    or (node_type == ']' and next_sibling:type() ~= ']' and next_sibling:type() ~= '[')
   if is_prev_sibling_valid and is_next_sibling_valid then
     local id = table.concat({ 'date', node_type }, '_')
     local seek_id = table.concat({ 'date', node_type == ']' and '[' or '<' }, '_')

lua/orgmode/colors/highlighter/markup/emphasis.lua

@@ -3,7 +3,16 @@ local ts_utils = require('orgmode.utils.treesitter')
 
 ---@class OrgEmphasisHighlighter : OrgMarkupHighlighter
 ---@field private markup OrgMarkupHighlighter
-local OrgEmphasis = {}
+local OrgEmphasis = {
+  valid_capture_names = {
+    ['bold'] = true,
+    ['italic'] = true,
+    ['underline'] = true,
+    ['strikethrough'] = true,
+    ['code'] = true,
+    ['verbatim'] = true,
+  },
+}
 
 local valid_pre_marker_chars = { ' ', '(', '-', "'", '"', '{', '*', '/', '_', '+' }
 local valid_post_marker_chars =
@@ -137,12 +146,26 @@ function OrgEmphasis:prepare_highlights(highlights)
 end
 
 ---@param node TSNode
+---@param name string
 ---@return OrgMarkupNode | false
-function OrgEmphasis:parse_node(node)
+function OrgEmphasis:parse_node(node, name)
+  if not self.valid_capture_names[name] then
+    return false
+  end
   local node_type = node:type()
   if not markers[node_type] then
     return false
   end
+  local prev_node = node:prev_sibling()
+  local next_node = node:next_sibling()
+
+  if prev_node and prev_node:type() == node_type then
+    return false
+  end
+
+  if next_node and next_node:type() == node_type then
+    return false
+  end
 
   local id = table.concat({ 'emphasis', node_type }, '_')
 

lua/orgmode/colors/highlighter/markup/init.lua

@@ -78,10 +78,10 @@ function OrgMarkup:get_node_highlights(root_node, source, line)
   ---@type OrgMarkupNode[]
   local entries = {}
 
-  for _, node in self.query:iter_captures(root_node, source, line, line + 1) do
+  for capture_id, node in self.query:iter_captures(root_node, source, line, line + 1) do
     local entry = nil
     for _, parser in pairs(self.parsers) do
-      entry = parser:parse_node(node)
+      entry = parser:parse_node(node, self.query.captures[capture_id])
       if entry then
         table.insert(entries, entry)
         break

lua/orgmode/colors/highlighter/markup/latex.lua

@@ -1,8 +1,16 @@
-local ts_utils = require('orgmode.utils.treesitter')
-
 ---@class OrgLatexHighlighter : OrgMarkupHighlighter
 ---@field private markup OrgMarkupHighlighter
-local OrgLatex = {}
+local OrgLatex = {
+  valid_capture_names = {
+    ['latex.plain'] = true,
+    ['latex.bracket.start'] = true,
+    ['latex.bracket.end'] = true,
+    ['latex.curly.start'] = true,
+    ['latex.curly.end'] = true,
+    ['latex.square.start'] = true,
+    ['latex.square.end'] = true,
+  },
+}
 
 local latex_pairs = {
   ['('] = ')',
@@ -50,7 +58,10 @@ end
 
 ---@param node TSNode
 ---@return OrgMarkupNode | false
-function OrgLatex:parse_node(node)
+function OrgLatex:parse_node(node, name)
+  if not self.valid_capture_names[name] then
+    return false
+  end
   local node_type = node:type()
   if node_type ~= 'str' and not latex_pairs[node_type] then
     return false

lua/orgmode/colors/highlighter/markup/link.lua

@@ -1,7 +1,12 @@
 ---@class OrgLinkHighlighter : OrgMarkupHighlighter
 ---@field private markup OrgMarkupHighlighter
 ---@field private has_extmark_url_support boolean
-local OrgLink = {}
+local OrgLink = {
+  valid_capture_names = {
+    ['link.start'] = true,
+    ['link.end'] = true,
+  },
+}
 
 ---@param opts { markup: OrgMarkupHighlighter }
 function OrgLink:new(opts)
@@ -15,8 +20,12 @@ function OrgLink:new(opts)
 end
 
 ---@param node TSNode
+---@param name string
 ---@return OrgMarkupNode | false
-function OrgLink:parse_node(node)
+function OrgLink:parse_node(node, name)
+  if not self.valid_capture_names[name] then
+    return false
+  end
   local type = node:type()
   if type == '[' then
     return self:_parse_start_node(node)

tests/plenary/colors/highlighter_spec.lua

@@ -125,6 +125,33 @@ describe('highlighter', function()
       assert_extmark(extmarks[9], { line = 0, start_col = 35, end_col = 36, hl_group = '@org.bold.delimiter' })
     end)
 
+    it('should not highlight two same emphasis one beside another', function()
+      local extmarks = get_extmarks({
+        'I am not italic // text',
+      })
+      assert.are.same(0, #extmarks)
+      extmarks = get_extmarks({
+        'I am not italic / / text',
+      })
+      assert.are.same(0, #extmarks)
+      extmarks = get_extmarks({
+        'I am not bold ** text',
+      })
+      assert.are.same(0, #extmarks)
+      extmarks = get_extmarks({
+        'I am not bold * * text',
+      })
+      assert.are.same(0, #extmarks)
+      extmarks = get_extmarks({
+        'I am not verbatim == text',
+      })
+      assert.are.same(0, #extmarks)
+      extmarks = get_extmarks({
+        'I am not verbatim = = text',
+      })
+      assert.are.same(0, #extmarks)
+    end)
+
     it('should conceal markers if org_hide_emphasis_markers is true', function()
       config.opts.org_hide_emphasis_markers = true
       local extmarks = get_extmarks({