chore(refactor): share overlap logic between debug & render

## Details

Moves top level render method in Extmark out into ui module which
decides based on overlap whether to show or hide each mark.

Moves namespace and buf out of Extmark, instead passing it in to methods
as needed.

Updates debug method to use the same overlap method as the main update
call that does rendering. Effectively means that everything hidden on
the current line is what gets returned when debugging + those marks
which are not concealable and would be hidden based on range overlap.

Author: MeanderingProgrammer

lua/render-markdown/api.lua

@@ -33,8 +33,8 @@ function M.contract()
 end
 
 function M.debug()
-    local buf = vim.api.nvim_get_current_buf()
-    local row, marks = require('render-markdown.core.ui').get_row_marks(buf)
+    local buf, win = vim.api.nvim_get_current_buf(), vim.api.nvim_get_current_win()
+    local row, marks = require('render-markdown.core.ui').get_row_marks(buf, win)
     require('render-markdown.debug.marks').debug(row, marks)
 end
 

lua/render-markdown/core/extmark.lua

@@ -1,76 +1,45 @@
 ---@class render.md.Extmark
----@field private namespace integer
----@field private buf integer
 ---@field private id? integer
 ---@field mark render.md.Mark
 local Extmark = {}
 Extmark.__index = Extmark
 
----@param namespace integer
----@param buf integer
 ---@param mark render.md.Mark
 ---@return render.md.Extmark
-function Extmark.new(namespace, buf, mark)
+function Extmark.new(mark)
     local self = setmetatable({}, Extmark)
-    self.namespace = namespace
-    self.buf = buf
     self.id = nil
     self.mark = mark
     return self
 end
 
----@param row integer
----@return boolean
-function Extmark:overlaps(row)
-    local start_row = self.mark.start_row
-    local end_row = self.mark.opts.end_row or start_row
-    if start_row == end_row then
-        end_row = end_row + 1
-    end
-    return not (start_row > row or end_row <= row)
-end
-
 ---@param hidden Range2?
-function Extmark:render(hidden)
-    if self:should_show(hidden) then
-        self:show()
-    else
-        self:hide()
+---@return boolean
+function Extmark:overlaps(hidden)
+    if hidden == nil then
+        return false
     end
+    local row = self.mark.start_row
+    return row >= hidden[1] and row <= hidden[2]
 end
 
----@private
-function Extmark:show()
+---@param ns_id integer
+---@param buf integer
+function Extmark:show(ns_id, buf)
     if self.id == nil then
-        self.mark.opts.strict = false
-        self.id = vim.api.nvim_buf_set_extmark(
-            self.buf,
-            self.namespace,
-            self.mark.start_row,
-            self.mark.start_col,
-            self.mark.opts
-        )
+        local mark = self.mark
+        mark.opts.strict = false
+        self.id = vim.api.nvim_buf_set_extmark(buf, ns_id, mark.start_row, mark.start_col, mark.opts)
     end
 end
 
----@private
-function Extmark:hide()
+---@param ns_id integer
+---@param buf integer
+function Extmark:hide(ns_id, buf)
     if self.id ~= nil then
-        vim.api.nvim_buf_del_extmark(self.buf, self.namespace, self.id)
+        vim.api.nvim_buf_del_extmark(buf, ns_id, self.id)
         self.id = nil
     end
 end
 
----@private
----@param hidden Range2?
----@return boolean
-function Extmark:should_show(hidden)
-    if hidden == nil or not self.mark.conceal then
-        return true
-    end
-    -- Show mark if it is outside hidden range
-    local row = self.mark.start_row
-    return row < hidden[1] or row > hidden[2]
-end
-
 return Extmark

lua/render-markdown/core/ui.lua

@@ -42,15 +42,17 @@ function M.invalidate_cache()
 end
 
 ---@param buf integer
+---@param win integer
 ---@return integer, render.md.Mark[]
-function M.get_row_marks(buf)
-    local row = util.cursor_row(buf)
-    if row == nil then
-        return 0, {}
-    end
-    local marks, buffer_state = {}, Cache.get(buf)
+function M.get_row_marks(buf, win)
+    local config, buffer_state = state.get(buf), Cache.get(buf)
+    local mode, row = util.mode(), util.row(buf, win)
+    local hidden = config:hidden(mode, row)
+    assert(row ~= nil and hidden ~= nil, 'Row & range must be known to get marks')
+
+    local marks = {}
     for _, extmark in ipairs(buffer_state.marks or {}) do
-        if extmark:overlaps(row) then
+        if extmark:overlaps(hidden) then
             table.insert(marks, extmark.mark)
         end
     end
@@ -98,7 +100,7 @@ function M.update(buf, win, parse)
     end
 
     local config, buffer_state = state.get(buf), Cache.get(buf)
-    local mode = vim.fn.mode(true)
+    local mode, row = util.mode(), util.row(buf, win)
 
     local next_state = M.next_state(config, win, mode)
     if next_state ~= buffer_state.state then
@@ -113,10 +115,13 @@ function M.update(buf, win, parse)
             M.clear(buf, buffer_state)
             buffer_state.marks = M.parse_buffer(buf, win)
         end
-        local row = util.cursor_row(buf, win)
         local hidden = config:hidden(mode, row)
-        for _, mark in ipairs(buffer_state.marks) do
-            mark:render(hidden)
+        for _, extmark in ipairs(buffer_state.marks) do
+            if extmark.mark.conceal and extmark:overlaps(hidden) then
+                extmark:hide(M.namespace, buf)
+            else
+                extmark:show(M.namespace, buf)
+            end
         end
     else
         M.clear(buf, buffer_state)
@@ -171,9 +176,7 @@ function M.parse_buffer(buf, win)
     for _, root in ipairs(markdown_roots) do
         vim.list_extend(marks, M.parse_tree(buf, 'markdown', root))
     end
-    return vim.tbl_map(function(mark)
-        return Extmark.new(M.namespace, buf, mark)
-    end, marks)
+    return vim.tbl_map(Extmark.new, marks)
 end
 
 ---Run user & builtin handlers when available. User handler is always executed,

lua/render-markdown/core/util.lua

@@ -10,14 +10,18 @@ function M.valid(buf, win)
     return vim.api.nvim_buf_is_valid(buf) and vim.api.nvim_win_is_valid(win)
 end
 
+---@return string
+function M.mode()
+    return vim.fn.mode(true)
+end
+
 ---@param buf integer
----@param win? integer
+---@param win integer
 ---@return integer?
-function M.cursor_row(buf, win)
+function M.row(buf, win)
     if vim.api.nvim_get_current_buf() ~= buf then
         return nil
     end
-    win = win or vim.api.nvim_get_current_win()
     return vim.api.nvim_win_get_cursor(win)[1] - 1
 end
 

lua/render-markdown/health.lua

@@ -4,7 +4,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '7.1.0'
+M.version = '7.1.1'
 
 function M.check()
     M.start('version')