fix: component level render modes

## Details

Similar to the problem around anti-conceal ignore modes. Individual
component render modes are checked once at creation time and used until
a recompute is necessary. This can potentially include various mode
changes, and since the results are not updated the rendering will be
incorrect.

To fix this add an optional `modes` field to the `render.md.Mark` class.
This gets populated based on the `render_modes` value for the relevant
component and stored as part of the mark metadata. We then use this
information to check for each `mark` if it should be rendered based on
either being in the top level mode or the mark level mode. Custom
handlers can use this feature as well, though with some edge cases like
potentially not identifying the specified mode as a render mode.

This does have a performance drawback compared to the old approach.
Before we would avoid creating / processing nodes if they didn't match any
of the mode values. Now if any mode value is matched in any component we
will compute the marks for all components, even if they're not needed
right now. That way if a mode change happens without a text change we'll
have all the marks we might potentially need to show, and show the ones
relevant to the current mode.

For most users who do not use this feature this should essentially have
no impact on performance.

Author: MeanderingProgrammer

doc/custom-handlers.md

@@ -21,6 +21,7 @@ Each handler must conform to the following interface:
 ---@field root TSNode
 
 ---@class (exact) render.md.Mark
+---@field modes? render.md.Modes
 ---@field conceal render.md.mark.Conceal
 ---@field start_row integer
 ---@field start_col integer
@@ -58,6 +59,7 @@ to use patterns from the builtin handlers.
 
 For each `mark` in the return value the fields mean:
 
+- `modes`: additional modes the `mark` should be shown in
 - `conceal`: determines if the mark should be hidden when cursor enters
 - `start_row`: only value used to check whether cursor is inside the `mark`
 - `start_col`: passed to `nvim_buf_set_extmark` as the 3rd argument
@@ -92,7 +94,7 @@ This will require a treesitter query and using the range values of nodes.
 -- Parse query outside of the function to avoid doing it for each call
 local query = vim.treesitter.query.parse('python', '(function_definition) @def')
 local function parse_python(ctx)
-    local marks = {}
+    local marks = {} ---@type render.md.Mark[]
     for id, node in query:iter_captures(ctx.root, ctx.buf) do
         local capture = query.captures[id]
         local start_row = node:range()

lua/render-markdown/core/ui.lua

@@ -163,7 +163,7 @@ function Updater:parse(callback)
     local ok, parser = pcall(vim.treesitter.get_parser, self.buf)
     if ok and parser then
         -- reset buffer context
-        local context = Context.new(self.buf, self.win, self.config, self.mode)
+        local context = Context.new(self.buf, self.win, self.config)
         if context then
             -- make sure injections are processed
             context.view:parse(parser, function()
@@ -185,7 +185,7 @@ function Updater:display()
     local range = self:hidden()
     local extmarks = self.decorator:get()
     for _, extmark in ipairs(extmarks) do
-        if self:conceal(extmark, range) then
+        if self:hide(extmark, range) then
             extmark:hide(M.ns, self.buf)
         else
             extmark:show(M.ns, self.buf)
@@ -222,19 +222,29 @@ end
 ---@param extmark render.md.Extmark
 ---@param range? render.md.Range
 ---@return boolean
-function Updater:conceal(extmark, range)
-    local conceal = extmark:get().conceal
+function Updater:hide(extmark, range)
+    local mark = extmark:get()
+
+    -- not in top level or mark level modes -> hide
+    local show = env.mode.join(self.config.render_modes, mark.modes)
+    if not env.mode.is(self.mode, show) then
+        return true
+    end
+
+    -- does not overlap with hidden range -> show
+    if not extmark:overlaps(range) then
+        return false
+    end
+
+    local conceal = mark.conceal
     if type(conceal) == 'boolean' then
-        if not conceal then
-            return false
-        end
+        -- mark has conceal value -> respect
+        return conceal
     else
-        local modes = self.config.anti_conceal.ignore[conceal]
-        if modes and env.mode.is(self.mode, modes) then
-            return false
-        end
+        -- mark has conceal element -> show if anti-conceal is ignored
+        local ignore = self.config.anti_conceal.ignore[conceal]
+        return not (ignore and env.mode.is(self.mode, ignore))
     end
-    return extmark:overlaps(range)
 end
 
 ---@private

lua/render-markdown/debug/marks.lua

@@ -3,20 +3,23 @@
 ---@field [2]? integer
 
 ---@class render.md.debug.Mark
+---@field modes? render.md.Modes
 ---@field conceal render.md.mark.Conceal
----@field opts render.md.mark.Opts
 ---@field row render.md.debug.Range
 ---@field col render.md.debug.Range
+---@field opts render.md.mark.Opts
 local Mark = {}
 Mark.__index = Mark
 
 ---@param mark render.md.Mark
 ---@return render.md.debug.Mark
 function Mark.new(mark)
     local self = setmetatable({}, Mark)
-    self.conceal, self.opts = mark.conceal, mark.opts
+    self.modes = mark.modes
+    self.conceal = mark.conceal
     self.row = { mark.start_row, mark.opts.end_row }
     self.col = { mark.start_col, mark.opts.end_col }
+    self.opts = mark.opts
     return self
 end
 
@@ -57,9 +60,10 @@ end
 function Mark:__tostring()
     local lines = {} ---@type string[]
     lines[#lines + 1] = ('='):rep(vim.o.columns - 1)
+    lines[#lines + 1] = ('modes: %s'):format(vim.inspect(self.modes))
+    lines[#lines + 1] = ('conceal: %s'):format(vim.inspect(self.conceal))
     lines[#lines + 1] = ('row: %s'):format(Mark.collapse(self.row))
     lines[#lines + 1] = ('column: %s'):format(Mark.collapse(self.col))
-    lines[#lines + 1] = ('hide: %s'):format(vim.inspect(self.conceal))
 
     ---@param name string
     ---@param f fun(value: any): string

lua/render-markdown/handler/html.lua

@@ -21,7 +21,7 @@ function M.parse(ctx)
         tag = require('render-markdown.render.html.tag'),
     }
     local context = Context.get(ctx.buf)
-    if context:skip(context.config.html) then
+    if not context.config.html.enabled then
         return {}
     end
     local marks = Marks.new(context, true)

lua/render-markdown/handler/latex.lua

@@ -28,7 +28,7 @@ end
 ---@param root TSNode
 ---@return render.md.Mark[]
 function Handler:run(root)
-    if self.context:skip(self.config) then
+    if not self.config.enabled then
         return {}
     end
     if vim.fn.executable(self.config.converter) ~= 1 then
@@ -50,7 +50,7 @@ function Handler:run(root)
     local row = above and node.start_row or node.end_row
 
     local marks = Marks.new(self.context, true)
-    marks:add('virtual_lines', row, 0, {
+    marks:add(self.config, 'virtual_lines', row, 0, {
         virt_lines = lines,
         virt_lines_above = above,
     })

lua/render-markdown/handler/yaml.lua

@@ -23,7 +23,7 @@ function M.parse(ctx)
         link = require('render-markdown.render.common.wiki'),
     }
     local context = Context.get(ctx.buf)
-    if context:skip(context.config.yaml) then
+    if not context.config.yaml.enabled then
         return {}
     end
     local marks = Marks.new(context, true)

lua/render-markdown/health.lua

@@ -5,7 +5,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '8.7.11'
+M.version = '8.7.12'
 
 function M.check()
     M.start('versions')

lua/render-markdown/lib/env.lua

@@ -98,11 +98,34 @@ function M.mode.get()
     return vim.fn.mode(true)
 end
 
+---@param v1 render.md.Modes
+---@param v2? render.md.Modes
+---@return render.md.Modes
+function M.mode.join(v1, v2)
+    if type(v1) == 'boolean' and type(v2) == 'boolean' then
+        return v1 or v2
+    elseif type(v1) == 'boolean' and type(v2) == 'table' then
+        return v1 or v2
+    elseif type(v1) == 'table' and type(v2) == 'boolean' then
+        return v2 or v1
+    elseif type(v1) == 'table' and type(v2) == 'table' then
+        -- copy to avoid modifying inputs
+        local result = {} ---@type string[]
+        vim.list_extend(result, v1)
+        vim.list_extend(result, v2)
+        return result
+    else
+        return v1 -- should only occur if v2 is nil, keep v1
+    end
+end
+
 ---@param mode string
----@param modes render.md.Modes
+---@param modes? render.md.Modes
 ---@return boolean
 function M.mode.is(mode, modes)
-    if type(modes) == 'boolean' then
+    if modes == nil then
+        return false
+    elseif type(modes) == 'boolean' then
         return modes
     else
         return vim.tbl_contains(modes, mode)

lua/render-markdown/lib/indent.lua

@@ -52,7 +52,7 @@ end
 ---@param level? integer
 ---@return integer
 function Indent:level(level)
-    if self.context:skip(self.config) then
+    if not self.config.enabled then
         return 0
     end
     if not level then

lua/render-markdown/lib/marks.lua

@@ -3,6 +3,7 @@ local log = require('render-markdown.core.log')
 local str = require('render-markdown.lib.str')
 
 ---@class (exact) render.md.Mark
+---@field modes? render.md.Modes
 ---@field conceal render.md.mark.Conceal
 ---@field start_row integer
 ---@field start_col integer
@@ -47,20 +48,22 @@ function Marks:get()
     return self.marks
 end
 
+---@param config render.md.base.Config
 ---@param conceal render.md.mark.Conceal
 ---@param node render.md.Node
 ---@param opts render.md.mark.Opts
 ---@return boolean
-function Marks:start(conceal, node, opts)
-    return self:add(conceal, node.start_row, node.start_col, opts)
+function Marks:start(config, conceal, node, opts)
+    return self:add(config, conceal, node.start_row, node.start_col, opts)
 end
 
+---@param config render.md.base.Config
 ---@param conceal render.md.mark.Conceal
 ---@param node? render.md.Node
 ---@param opts render.md.mark.Opts
 ---@param offset? Range4
 ---@return boolean
-function Marks:over(conceal, node, opts, offset)
+function Marks:over(config, conceal, node, opts, offset)
     if not node then
         return false
     end
@@ -69,23 +72,25 @@ function Marks:over(conceal, node, opts, offset)
     local start_col = node.start_col + offset[2]
     opts.end_row = node.end_row + offset[3]
     opts.end_col = node.end_col + offset[4]
-    return self:add(conceal, start_row, start_col, opts)
+    return self:add(config, conceal, start_row, start_col, opts)
 end
 
+---@param config render.md.base.Config
 ---@param conceal render.md.mark.Conceal
 ---@param start_row integer
 ---@param start_col integer
 ---@param opts render.md.mark.Opts
 ---@return boolean
-function Marks:add(conceal, start_row, start_col, opts)
+function Marks:add(config, conceal, start_row, start_col, opts)
     ---@type render.md.Mark
     local mark = {
+        modes = config.render_modes,
         conceal = conceal,
         start_row = start_row,
         start_col = start_col,
         opts = opts,
     }
-    local valid, feature, min_version = self:validate(opts)
+    local valid, feature, min_version = self:validate(mark.opts)
     if not valid then
         local message = feature .. ' requires neovim >= ' .. min_version
         log.add('error', 'Mark', message, mark)