Refactor move parsing into a setup function per renderer

Author: MeanderingProgrammer

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*          For 0.10.0          Last change: 2024 August 26
+*render-markdown.txt*          For 0.10.0          Last change: 2024 August 27
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*

lua/render-markdown/core/component.lua

@@ -1,13 +1,11 @@
-local state = require('render-markdown.state')
-
 ---@class render.md.ComponentHelper
 local M = {}
 
----@param buf integer
+---@param config render.md.BufferConfig
 ---@param text string
 ---@param comparison 'exact'|'contains'
 ---@return render.md.CustomComponent?
-function M.callout(buf, text, comparison)
+function M.callout(config, text, comparison)
     ---@param callout render.md.CustomComponent
     ---@return boolean
     local function matches(callout)
@@ -19,19 +17,19 @@ function M.callout(buf, text, comparison)
             error(string.format('Unhandled comparison: %s', comparison))
         end
     end
-    for _, callout in pairs(state.get_config(buf).callout) do
+    for _, callout in pairs(config.callout) do
         if matches(callout) then
             return callout
         end
     end
     return nil
 end
 
----@param buf integer
+---@param config render.md.BufferConfig
 ---@param text string
 ---@param comparison 'exact'|'starts'
 ---@return render.md.CustomComponent?
-function M.checkbox(buf, text, comparison)
+function M.checkbox(config, text, comparison)
     ---@param checkbox render.md.CustomComponent
     ---@return boolean
     local function matches(checkbox)
@@ -43,7 +41,7 @@ function M.checkbox(buf, text, comparison)
             error(string.format('Unhandled comparison: %s', comparison))
         end
     end
-    for _, checkbox in pairs(state.get_config(buf).checkbox.custom) do
+    for _, checkbox in pairs(config.checkbox.custom) do
         if matches(checkbox) then
             return checkbox
         end

lua/render-markdown/core/context.lua

@@ -1,3 +1,5 @@
+local NodeInfo = require('render-markdown.core.node_info')
+local logger = require('render-markdown.core.logger')
 local str = require('render-markdown.core.str')
 local util = require('render-markdown.core.util')
 
@@ -99,11 +101,13 @@ end
 
 ---@param root TSNode
 ---@param query vim.treesitter.Query
----@param callback fun(capture: string, node: TSNode, metadata: vim.treesitter.query.TSMetadata)
+---@param callback fun(capture: string, node: render.md.NodeInfo)
 function Context:query(root, query, callback)
-    for id, node, metadata in query:iter_captures(root, self.buf, self.top, self.bottom) do
+    for id, node in query:iter_captures(root, self.buf, self.top, self.bottom) do
         local capture = query.captures[id]
-        callback(capture, node, metadata)
+        local info = NodeInfo.new(self.buf, node)
+        logger.debug_node_info(capture, info)
+        callback(capture, info)
     end
 end
 
@@ -188,11 +192,11 @@ function Context:compute_conceal_nodes(language, root)
         return {}
     end
     local nodes = {}
-    self:query(root, query, function(_, node, metadata)
+    for _, node, metadata in query:iter_captures(root, self.buf, self.top, self.bottom) do
         if metadata.conceal ~= nil then
             table.insert(nodes, node)
         end
-    end)
+    end
     return nodes
 end
 

lua/render-markdown/handler/markdown.lua

@@ -1,17 +1,11 @@
 local Context = require('render-markdown.core.context')
-local NodeInfo = require('render-markdown.core.node_info')
-local RenderCode = require('render-markdown.render.code')
-local RenderHeading = require('render-markdown.render.heading')
-local RenderQuote = require('render-markdown.render.quote')
-local RenderTable = require('render-markdown.render.table')
 local component = require('render-markdown.core.component')
 local list = require('render-markdown.core.list')
 local logger = require('render-markdown.core.logger')
 local state = require('render-markdown.state')
 local str = require('render-markdown.core.str')
 
 ---@class render.md.handler.buf.Markdown
----@field private buf integer
 ---@field private marks render.md.Marks
 ---@field private config render.md.BufferConfig
 ---@field private context render.md.Context
@@ -23,29 +17,28 @@ Handler.__index = Handler
 ---@return render.md.handler.buf.Markdown
 function Handler.new(buf)
     local self = setmetatable({}, Handler)
-    self.buf = buf
     self.marks = list.new_marks()
     self.config = state.get_config(buf)
     self.context = Context.get(buf)
     self.renderers = {
-        code = RenderCode.new(buf, self.marks, self.config, self.context),
-        heading = RenderHeading.new(buf, self.marks, self.config, self.context),
-        quote = RenderQuote.new(buf, self.marks, self.config, self.context),
-        table = RenderTable.new(buf, self.marks, self.config, self.context),
+        code = require('render-markdown.render.code'),
+        heading = require('render-markdown.render.heading'),
+        quote = require('render-markdown.render.quote'),
+        table = require('render-markdown.render.table'),
     }
     return self
 end
 
 ---@param root TSNode
 ---@return render.md.Mark[]
 function Handler:parse(root)
-    self.context:query(root, state.markdown_query, function(capture, node)
-        local info = NodeInfo.new(self.buf, node)
-        logger.debug_node_info(capture, info)
-
+    self.context:query(root, state.markdown_query, function(capture, info)
         local renderer = self.renderers[capture]
         if renderer ~= nil then
-            renderer:render(info)
+            local render = renderer.new(self.marks, self.config, self.context, info)
+            if render:setup() then
+                render:render()
+            end
         elseif capture == 'section' then
             self:section(info)
         elseif capture == 'dash' then
@@ -120,7 +113,7 @@ function Handler:list_marker(info)
             return true
         end
         local paragraph = info:sibling('paragraph')
-        return paragraph ~= nil and component.checkbox(self.buf, paragraph.text, 'starts') ~= nil
+        return paragraph ~= nil and component.checkbox(self.config, paragraph.text, 'starts') ~= nil
     end
     if sibling_checkbox() then
         -- Hide the list marker for checkboxes rather than replacing with a bullet point

lua/render-markdown/handler/markdown_inline.lua

@@ -1,13 +1,11 @@
 local Context = require('render-markdown.core.context')
-local NodeInfo = require('render-markdown.core.node_info')
 local component = require('render-markdown.core.component')
 local list = require('render-markdown.core.list')
 local logger = require('render-markdown.core.logger')
 local state = require('render-markdown.state')
 local str = require('render-markdown.core.str')
 
 ---@class render.md.handler.buf.MarkdownInline
----@field private buf integer
 ---@field private marks render.md.Marks
 ---@field private config render.md.BufferConfig
 ---@field private context render.md.Context
@@ -18,7 +16,6 @@ Handler.__index = Handler
 ---@return render.md.handler.buf.MarkdownInline
 function Handler.new(buf)
     local self = setmetatable({}, Handler)
-    self.buf = buf
     self.marks = list.new_marks()
     self.config = state.get_config(buf)
     self.context = Context.get(buf)
@@ -28,10 +25,7 @@ end
 ---@param root TSNode
 ---@return render.md.Mark[]
 function Handler:parse(root)
-    self.context:query(root, state.inline_query, function(capture, node)
-        local info = NodeInfo.new(self.buf, node)
-        logger.debug_node_info(capture, info)
-
+    self.context:query(root, state.inline_query, function(capture, info)
         if capture == 'code' then
             self:code(info)
         elseif capture == 'shortcut' then
@@ -62,13 +56,13 @@ end
 ---@private
 ---@param info render.md.NodeInfo
 function Handler:shortcut(info)
-    local callout = component.callout(self.buf, info.text, 'exact')
+    local callout = component.callout(self.config, info.text, 'exact')
     if callout ~= nil then
         self:callout(info, callout)
         return
     end
 
-    local checkbox = component.checkbox(self.buf, info.text, 'exact')
+    local checkbox = component.checkbox(self.config, info.text, 'exact')
     if checkbox ~= nil then
         self:checkbox(info, checkbox)
         return

lua/render-markdown/health.lua

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