chore: refactor various node computations into the context that stores needed information

Author: MeanderingProgrammer

lua/render-markdown/context.lua

@@ -1,3 +1,4 @@
+local str = require('render-markdown.str')
 local util = require('render-markdown.util')
 
 ---@class render.md.Context
@@ -38,10 +39,16 @@ function Context:add_link(info, icon)
     table.insert(self.links[row], { info.start_col, info.end_col, icon })
 end
 
----@param row integer
----@return [integer, integer, string][]
-function Context:get_links(row)
-    return self.links[row] or {}
+---@param info render.md.NodeInfo
+---@return integer
+function Context:link_width(info)
+    local result = 0
+    for _, icon_range in ipairs(self.links[info.start_row] or {}) do
+        if info.start_col < icon_range[2] and info.end_col > icon_range[1] then
+            result = result + str.width(icon_range[3])
+        end
+    end
+    return result
 end
 
 ---@return integer
@@ -64,7 +71,7 @@ end
 ---@return boolean
 function Context:contains_node(node)
     local top, _, bottom, _ = node:range()
-    return top <= self.bottom and bottom >= self.top
+    return top < self.bottom and bottom >= self.top
 end
 
 ---@param root TSNode
@@ -77,6 +84,38 @@ function Context:query(root, query, callback)
     end
 end
 
+---@param info? render.md.NodeInfo
+---@return boolean
+function Context:hidden(info)
+    if info == nil then
+        return true
+    end
+    return str.width(info.text) == self:concealed(info)
+end
+
+---@param info render.md.NodeInfo
+---@return integer
+function Context:concealed(info)
+    local ranges = self:get_conceal(info.start_row)
+    if #ranges == 0 then
+        return 0
+    end
+    local result = 0
+    local col = info.start_col
+    for _, index in ipairs(vim.fn.str2list(info.text)) do
+        local ch = vim.fn.nr2char(index)
+        for _, range in ipairs(ranges) do
+            -- Essentially vim.treesitter.is_in_node_range but only care about column
+            if col >= range[1] and col + 1 <= range[2] then
+                result = result + str.width(ch)
+            end
+        end
+        col = col + #ch
+    end
+    return result
+end
+
+---@private
 ---@param row integer
 ---@return [integer, integer][]
 function Context:get_conceal(row)

lua/render-markdown/handler/markdown.lua

@@ -1,8 +1,8 @@
+local Context = require('render-markdown.context')
 local NodeInfo = require('render-markdown.node_info')
 local code_block_parser = require('render-markdown.parser.code_block')
 local colors = require('render-markdown.colors')
 local component = require('render-markdown.component')
-local context = require('render-markdown.context')
 local icons = require('render-markdown.icons')
 local list = require('render-markdown.list')
 local logger = require('render-markdown.logger')
@@ -13,6 +13,7 @@ local str = require('render-markdown.str')
 ---@class render.md.handler.buf.Markdown
 ---@field private buf integer
 ---@field private config render.md.BufferConfig
+---@field private context render.md.Context
 ---@field private last_heading_border integer
 ---@field private marks render.md.Mark[]
 local Handler = {}
@@ -24,6 +25,7 @@ function Handler.new(buf)
     local self = setmetatable({}, Handler)
     self.buf = buf
     self.config = state.get_config(buf)
+    self.context = Context.get(buf)
     self.last_heading_border = -1
     self.marks = {}
     return self
@@ -32,7 +34,7 @@ end
 ---@param root TSNode
 ---@return render.md.Mark[]
 function Handler:parse(root)
-    context.get(self.buf):query(root, state.markdown_query, function(capture, node)
+    self.context:query(root, state.markdown_query, function(capture, node)
         local info = NodeInfo.new(self.buf, node)
         logger.debug_node_info(capture, info)
         if capture == 'heading' then
@@ -48,7 +50,7 @@ function Handler:parse(root)
         elseif capture == 'checkbox_checked' then
             self:checkbox(info, self.config.checkbox.checked)
         elseif capture == 'quote' then
-            context.get(self.buf):query(node, state.markdown_quote_query, function(nested_capture, nested_node)
+            self.context:query(node, state.markdown_quote_query, function(nested_capture, nested_node)
                 local nested_info = NodeInfo.new(self.buf, nested_node)
                 logger.debug_node_info(nested_capture, nested_info)
                 if nested_capture == 'quote_marker' then
@@ -135,7 +137,7 @@ function Handler:heading_icon(info, level, foreground, background)
     -- Available width is level + 1 - concealed, where level = number of `#` characters, one
     -- is added to account for the space after the last `#` but before the heading title,
     -- and concealed text is subtracted since that space is not usable
-    local width = level + 1 - info:concealed()
+    local width = level + 1 - self.context:concealed(info)
     if icon == nil then
         return width
     end
@@ -171,11 +173,11 @@ function Handler:heading_width(info, icon_width)
         local width = heading.left_pad + icon_width + heading.right_pad
         local content = info:sibling('inline')
         if content ~= nil then
-            width = width + str.width(content.text) + self:added_width(content) - content:concealed()
+            width = width + str.width(content.text) + self.context:link_width(content) - self.context:concealed(content)
         end
         return math.max(width, heading.min_width)
     else
-        return context.get(self.buf):get_width()
+        return self.context:get_width()
     end
 end
 
@@ -234,7 +236,7 @@ function Handler:dash(info)
 
     local width
     if dash.width == 'full' then
-        width = context.get(self.buf):get_width()
+        width = self.context:get_width()
     else
         ---@type integer
         width = dash.width
@@ -253,7 +255,7 @@ function Handler:code(info)
     if not code.enabled or code.style == 'none' then
         return
     end
-    local code_block = code_block_parser.parse(code, self.buf, info)
+    local code_block = code_block_parser.parse(code, self.context, info)
     if code_block == nil then
         return
     end
@@ -294,7 +296,7 @@ function Handler:language(code_block, add_background)
     end
     if code.position == 'left' then
         local icon_text = icon .. ' '
-        if info:hidden() then
+        if self.context:hidden(info) then
             -- Code blocks will pick up varying amounts of leading white space depending on the
             -- context they are in. This gets lumped into the delimiter node and as a result,
             -- after concealing, the extmark will be left shifted. Logic below accounts for this.
@@ -657,21 +659,7 @@ end
 ---@param info render.md.NodeInfo
 ---@return integer
 function Handler:table_visual_offset(info)
-    return info:concealed() - self:added_width(info)
-end
-
----@private
----@param info render.md.NodeInfo
----@return integer
-function Handler:added_width(info)
-    local result = 0
-    local icon_ranges = context.get(self.buf):get_links(info.start_row)
-    for _, icon_range in ipairs(icon_ranges) do
-        if info.start_col < icon_range[2] and info.end_col > icon_range[1] then
-            result = result + str.width(icon_range[3])
-        end
-    end
-    return result
+    return self.context:concealed(info) - self.context:link_width(info)
 end
 
 ---@class render.md.handler.Markdown: render.md.Handler

lua/render-markdown/handler/markdown_inline.lua

@@ -1,6 +1,6 @@
+local Context = require('render-markdown.context')
 local NodeInfo = require('render-markdown.node_info')
 local component = require('render-markdown.component')
-local context = require('render-markdown.context')
 local list = require('render-markdown.list')
 local logger = require('render-markdown.logger')
 local state = require('render-markdown.state')
@@ -9,6 +9,7 @@ local str = require('render-markdown.str')
 ---@class render.md.handler.buf.MarkdownInline
 ---@field private buf integer
 ---@field private config render.md.BufferConfig
+---@field private context render.md.Context
 ---@field private marks render.md.Mark[]
 local Handler = {}
 Handler.__index = Handler
@@ -19,14 +20,15 @@ function Handler.new(buf)
     local self = setmetatable({}, Handler)
     self.buf = buf
     self.config = state.get_config(buf)
+    self.context = Context.get(buf)
     self.marks = {}
     return self
 end
 
 ---@param root TSNode
 ---@return render.md.Mark[]
 function Handler:parse(root)
-    context.get(self.buf):query(root, state.inline_query, function(capture, node)
+    self.context:query(root, state.inline_query, function(capture, node)
         local info = NodeInfo.new(self.buf, node)
         logger.debug_node_info(capture, info)
         if capture == 'code' then
@@ -167,7 +169,7 @@ function Handler:link(info)
         virt_text_pos = 'inline',
     })
     if added then
-        context.get(self.buf):add_link(info, icon)
+        self.context:add_link(info, icon)
     end
 end
 

lua/render-markdown/health.lua

@@ -5,7 +5,7 @@ local M = {}
 
 ---@private
 ---@type string
-M.version = '6.0.9'
+M.version = '6.0.10'
 
 function M.check()
     vim.health.start('render-markdown.nvim [version]')

lua/render-markdown/node_info.lua

@@ -1,6 +1,3 @@
-local context = require('render-markdown.context')
-local str = require('render-markdown.str')
-
 ---@param node TSNode
 ---@return boolean
 local function in_section(node)
@@ -129,30 +126,4 @@ function NodeInfo:lines()
     return vim.api.nvim_buf_get_lines(self.buf, self.start_row, self.end_row, false)
 end
 
----@return boolean
-function NodeInfo:hidden()
-    return str.width(self.text) == self:concealed()
-end
-
----@return integer
-function NodeInfo:concealed()
-    local ranges = context.get(self.buf):get_conceal(self.start_row)
-    if #ranges == 0 then
-        return 0
-    end
-    local result = 0
-    local col = self.start_col
-    for _, index in ipairs(vim.fn.str2list(self.text)) do
-        local ch = vim.fn.nr2char(index)
-        for _, range in ipairs(ranges) do
-            -- Essentially vim.treesitter.is_in_node_range but only care about column
-            if col >= range[1] and col + 1 <= range[2] then
-                result = result + str.width(ch)
-            end
-        end
-        col = col + #ch
-    end
-    return result
-end
-
 return NodeInfo

lua/render-markdown/parser/code_block.lua

@@ -1,4 +1,3 @@
-local context = require('render-markdown.context')
 local str = require('render-markdown.str')
 
 ---@class render.md.parser.CodeBlock
@@ -18,10 +17,10 @@ local M = {}
 ---@field end_delim_hidden boolean
 
 ---@param config render.md.Code
----@param buf integer
+---@param context render.md.Context
 ---@param info render.md.NodeInfo
 ---@return render.md.parsed.CodeBlock?
-function M.parse(config, buf, info)
+function M.parse(config, context, info)
     -- Do not attempt to render single line code block
     if info.end_row - info.start_row <= 1 then
         return nil
@@ -31,7 +30,7 @@ function M.parse(config, buf, info)
     if code_info ~= nil then
         language_info = code_info:child('language', info.start_row)
     end
-    local longest_line, width = M.get_width(config, buf, info)
+    local longest_line, width = M.get_width(config, context, info)
     ---@type render.md.parsed.CodeBlock
     return {
         col = info.start_col,
@@ -40,39 +39,29 @@ function M.parse(config, buf, info)
         leading_spaces = str.leading_spaces(info.text),
         longest_line = longest_line,
         width = width,
-        code_info_hidden = M.hidden(code_info),
+        code_info_hidden = context:hidden(code_info),
         language_info = language_info,
         language = (language_info or {}).text,
-        start_delim_hidden = M.hidden(info:child('fenced_code_block_delimiter', info.start_row)),
-        end_delim_hidden = M.hidden(info:child('fenced_code_block_delimiter', info.end_row - 1)),
+        start_delim_hidden = context:hidden(info:child('fenced_code_block_delimiter', info.start_row)),
+        end_delim_hidden = context:hidden(info:child('fenced_code_block_delimiter', info.end_row - 1)),
     }
 end
 
 ---@private
 ---@param config render.md.Code
----@param buf integer
+---@param context render.md.Context
 ---@param info render.md.NodeInfo
 ---@return integer, integer
-function M.get_width(config, buf, info)
+function M.get_width(config, context, info)
     local lines = info:lines()
     local code_width = vim.fn.max(vim.tbl_map(str.width, lines))
     local longest_line = config.left_pad + code_width + config.right_pad
     local width = math.max(longest_line, config.min_width)
     if config.width == 'block' then
         return width, width
     else
-        return width, context.get(buf):get_width()
+        return width, context:get_width()
     end
 end
 
----@private
----@param info? render.md.NodeInfo
----@return boolean
-function M.hidden(info)
-    if info == nil then
-        return true
-    end
-    return info:hidden()
-end
-
 return M

lua/render-markdown/ui.lua

@@ -1,6 +1,6 @@
 local BufferState = require('render-markdown.buffer_state')
+local Context = require('render-markdown.context')
 local Extmark = require('render-markdown.extmark')
-local context = require('render-markdown.context')
 local logger = require('render-markdown.logger')
 local state = require('render-markdown.state')
 local util = require('render-markdown.util')
@@ -48,7 +48,7 @@ function M.debounce_update(buf, win, change)
     local buffer_state = cache[buf] or BufferState.new(buf)
     cache[buf] = buffer_state
 
-    if not change and context.contains_range(buf, win) then
+    if not change and Context.contains_range(buf, win) then
         vim.schedule(function()
             M.update(buf, win, false)
         end)
@@ -122,9 +122,9 @@ function M.parse_buffer(buf, win)
         return {}
     end
     -- Reset buffer context
-    context.reset(buf, win)
+    Context.reset(buf, win)
     -- Make sure injections are processed
-    parser:parse(context.get(buf):range())
+    parser:parse(Context.get(buf):range())
     -- Parse marks
     local marks = {}
     -- Parse markdown after all other nodes to take advantage of state
@@ -154,7 +154,7 @@ end
 ---@return render.md.Mark[]
 function M.parse_tree(buf, language, root)
     logger.debug('language', language)
-    if not context.get(buf):contains_node(root) then
+    if not Context.get(buf):contains_node(root) then
         return {}
     end