chore(refactor): add view module

MeanderingProgrammer · MeanderingProgrammer · commit b2d857c848c2 · 2025-05-02T21:21:04.000-07:00
## Details

Moves list of Range associated with a buffer and its windows into a new
`View` module. Stores the various overlap, contain, and each methods
within `View`. Store an instance of `View` in the top level `Context`.

Store `Context`, `Conceal`, &amp; `View` in new request directory, meant to
encapsulate the state of a render cycle.

Add string representations for `Range` &amp; `View`.
diff --git a/lua/render-markdown/core/ui.lua b/lua/render-markdown/core/ui.lua
@@ -1,6 +1,6 @@
 local Buffer = require('render-markdown.lib.buffer')
 local Compat = require('render-markdown.lib.compat')
-local Context = require('render-markdown.lib.context')
+local Context = require('render-markdown.request.context')
 local Env = require('render-markdown.lib.env')
 local Extmark = require('render-markdown.lib.extmark')
 local Iter = require('render-markdown.lib.iter')
@@ -108,19 +108,15 @@ function M.run_update(buf, win, change)
         local initial = buffer:initial()
         if initial or parse then
             M.clear_buffer(buf, buffer)
-            buffer:set_marks(M.parse_buffer({
-                buf = buf,
-                win = win,
-                config = config,
-                mode = mode,
-            }))
+            local extmarks = M.parse_buffer(buf, win, config, mode)
+            buffer:set_marks(extmarks)
+            if initial then
+                Compat.fix_lsp_window(buf, win, extmarks)
+                M.config.on.initial({ buf = buf, win = win })
+            end
         end
         local range = config:hidden(mode, row)
         local extmarks = buffer:get_marks()
-        if initial then
-            Compat.fix_lsp_window(buf, win, extmarks)
-            M.config.on.initial({ buf = buf, win = win })
-        end
         for _, extmark in ipairs(extmarks) do
             if extmark:get().conceal and extmark:overlaps(range) then
                 extmark:hide(M.ns, buf)
@@ -154,19 +150,21 @@ function M.clear_buffer(buf, buffer)
 end
 
 ---@private
----@param props render.md.context.Props
+---@param buf integer
+---@param win integer
+---@param config render.md.main.Config
+---@param mode string
 ---@return render.md.Extmark[]
-function M.parse_buffer(props)
-    local buf = props.buf
+function M.parse_buffer(buf, win, config, mode)
     local has_parser, parser = pcall(vim.treesitter.get_parser, buf)
     if not has_parser or not parser then
         log.buf('error', 'fail', buf, 'no treesitter parser found')
         return {}
     end
     -- reset buffer context
-    local context = Context.reset(props)
+    local context = Context.start(buf, win, config, mode)
     -- make sure injections are processed
-    context:parse(parser)
+    context.view:parse(parser)
     -- parse markdown after other nodes to get accurate state
     local marks = {} ---@type render.md.Mark[]
     local markdown = {} ---@type render.md.handler.Context[]
@@ -189,13 +187,13 @@ end
 ---Run user & builtin handlers when available. User handler is always executed,
 ---builtin handler is skipped if user handler does not specify extends.
 ---@private
----@param context render.md.Context
+---@param context render.md.request.Context
 ---@param ctx render.md.handler.Context
 ---@param language string
 ---@return render.md.Mark[]
 function M.parse_tree(context, ctx, language)
     log.buf('debug', 'language', ctx.buf, language)
-    if not context:overlaps(ctx.root) then
+    if not context.view:overlaps(ctx.root) then
         return {}
     end
 
diff --git a/lua/render-markdown/handler/html.lua b/lua/render-markdown/handler/html.lua
@@ -1,11 +1,11 @@
-local Context = require('render-markdown.lib.context')
+local Context = require('render-markdown.request.context')
 local Marks = require('render-markdown.lib.marks')
 local ts = require('render-markdown.core.ts')
 
 ---@class render.md.handler.buf.Html
 ---@field private query vim.treesitter.Query
 ---@field private renderers table<string, render.md.Render>
----@field private context render.md.Context
+---@field private context render.md.request.Context
 local Handler = {}
 Handler.__index = Handler
 
@@ -35,7 +35,7 @@ function Handler:parse(root)
         return {}
     end
     local marks = Marks.new(self.context, true)
-    self.context:query(root, self.query, function(capture, node)
+    self.context.view:query(root, self.query, function(capture, node)
         local renderer = self.renderers[capture]
         assert(renderer ~= nil, 'unhandled html capture: ' .. capture)
         local render = renderer:new(self.context, marks, node)
diff --git a/lua/render-markdown/handler/latex.lua b/lua/render-markdown/handler/latex.lua
@@ -1,4 +1,4 @@
-local Context = require('render-markdown.lib.context')
+local Context = require('render-markdown.request.context')
 local Iter = require('render-markdown.lib.iter')
 local Marks = require('render-markdown.lib.marks')
 local Node = require('render-markdown.lib.node')
diff --git a/lua/render-markdown/handler/markdown.lua b/lua/render-markdown/handler/markdown.lua
@@ -1,11 +1,11 @@
-local Context = require('render-markdown.lib.context')
+local Context = require('render-markdown.request.context')
 local Marks = require('render-markdown.lib.marks')
 local ts = require('render-markdown.core.ts')
 
 ---@class render.md.handler.buf.Markdown
 ---@field private query vim.treesitter.Query
 ---@field private renderers table<string, render.md.Render>
----@field private context render.md.Context
+---@field private context render.md.request.Context
 local Handler = {}
 Handler.__index = Handler
 
@@ -67,7 +67,7 @@ end
 ---@return render.md.Mark[]
 function Handler:parse(root)
     local marks = Marks.new(self.context, false)
-    self.context:query(root, self.query, function(capture, node)
+    self.context.view:query(root, self.query, function(capture, node)
         local renderer = self.renderers[capture]
         assert(renderer ~= nil, 'unhandled markdown capture: ' .. capture)
         local render = renderer:new(self.context, marks, node)
diff --git a/lua/render-markdown/handler/markdown_inline.lua b/lua/render-markdown/handler/markdown_inline.lua
@@ -1,11 +1,11 @@
-local Context = require('render-markdown.lib.context')
+local Context = require('render-markdown.request.context')
 local Marks = require('render-markdown.lib.marks')
 local ts = require('render-markdown.core.ts')
 
 ---@class render.md.handler.buf.MarkdownInline
 ---@field private query vim.treesitter.Query
 ---@field private renderers table<string, render.md.Render>
----@field private context render.md.Context
+---@field private context render.md.request.Context
 local Handler = {}
 Handler.__index = Handler
 
@@ -46,7 +46,7 @@ end
 ---@return render.md.Mark[]
 function Handler:parse(root)
     local marks = Marks.new(self.context, true)
-    self.context:query(root, self.query, function(capture, node)
+    self.context.view:query(root, self.query, function(capture, node)
         local renderer = self.renderers[capture]
         assert(renderer ~= nil, 'unhandled inline capture: ' .. capture)
         local render = renderer:new(self.context, marks, node)
diff --git a/lua/render-markdown/health.lua b/lua/render-markdown/health.lua
@@ -5,7 +5,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '8.3.23'
+M.version = '8.3.24'
 
 function M.check()
     M.start('version')
diff --git a/lua/render-markdown/lib/indent.lua b/lua/render-markdown/lib/indent.lua
@@ -1,13 +1,13 @@
 local Str = require('render-markdown.lib.str')
 
 ---@class render.md.Indent
----@field private context render.md.Context
+---@field private context render.md.request.Context
 ---@field private config render.md.indent.Config
 ---@field private node render.md.Node
 local Indent = {}
 Indent.__index = Indent
 
----@param context render.md.Context
+---@param context render.md.request.Context
 ---@param node render.md.Node
 ---@return render.md.Indent
 function Indent.new(context, node)
diff --git a/lua/render-markdown/lib/marks.lua b/lua/render-markdown/lib/marks.lua
@@ -26,14 +26,14 @@ local log = require('render-markdown.core.log')
 ---@alias render.md.mark.Element boolean|render.md.Element
 
 ---@class render.md.Marks
----@field private context render.md.Context
+---@field private context render.md.request.Context
 ---@field private ignore render.md.conceal.Ignore
 ---@field private update boolean
 ---@field private marks render.md.Mark[]
 local Marks = {}
 Marks.__index = Marks
 
----@param context render.md.Context
+---@param context render.md.request.Context
 ---@param update boolean
 ---@return render.md.Marks
 function Marks.new(context, update)
diff --git a/lua/render-markdown/lib/range.lua b/lua/render-markdown/lib/range.lua
@@ -25,6 +25,11 @@ function Range.__lt(a, b)
     end
 end
 
+---@return string
+function Range:__tostring()
+    return ('%d->%d'):format(self.top, self.bottom)
+end
+
 ---@param top integer
 ---@param bottom integer
 ---@return boolean
diff --git a/lua/render-markdown/render/base.lua b/lua/render-markdown/render/base.lua
@@ -3,7 +3,7 @@ local Str = require('render-markdown.lib.str')
 local colors = require('render-markdown.core.colors')
 
 ---@class render.md.Render
----@field protected context render.md.Context
+---@field protected context render.md.request.Context
 ---@field protected config render.md.main.Config
 ---@field protected marks render.md.Marks
 ---@field protected node render.md.Node
@@ -12,7 +12,7 @@ local colors = require('render-markdown.core.colors')
 local Base = {}
 Base.__index = Base
 
----@param context render.md.Context
+---@param context render.md.request.Context
 ---@param marks render.md.Marks
 ---@param node render.md.Node
 ---@return render.md.Render
diff --git a/lua/render-markdown/render/quote.lua b/lua/render-markdown/render/quote.lua
@@ -41,7 +41,8 @@ function Render:setup()
 end
 
 function Render:render()
-    self.context:query(self.node:get(), self.data.query, function(capture, node)
+    local root = self.node:get()
+    self.context.view:query(root, self.data.query, function(capture, node)
         if capture == 'marker' then
             -- marker nodes are a single '>' at the start of a block quote
             -- overlay the only range if it is at the current level
diff --git a/lua/render-markdown/render/table.lua b/lua/render-markdown/render/table.lua
@@ -63,7 +63,7 @@ function Render:setup()
     self.node:for_each_child(function(row)
         if row.type == 'pipe_table_delimiter_row' then
             delim = self:parse_delim(row)
-        elseif self.context:overlaps(row:get()) then
+        elseif self.context.view:overlaps(row:get()) then
             local row_types = { 'pipe_table_header', 'pipe_table_row' }
             if vim.tbl_contains(row_types, row.type) then
                 table_rows[#table_rows + 1] = row
diff --git a/lua/render-markdown/request/conceal.lua b/lua/render-markdown/request/conceal.lua
@@ -2,31 +2,31 @@ local Compat = require('render-markdown.lib.compat')
 local Env = require('render-markdown.lib.env')
 local Str = require('render-markdown.lib.str')
 
----@class render.md.conceal.Section
+---@class render.md.request.conceal.Section
 ---@field start_col integer
 ---@field end_col integer
 ---@field width integer
 ---@field character? string
 
----@class render.md.conceal.Line
+---@class render.md.request.conceal.Line
 ---@field hidden boolean
----@field sections render.md.conceal.Section[]
+---@field sections render.md.request.conceal.Section[]
 
----@class render.md.Conceal
----@field private context render.md.Context
+---@class render.md.request.Conceal
 ---@field private buf integer
+---@field private view render.md.request.View
 ---@field private level integer
 ---@field private computed boolean
----@field private lines table<integer, render.md.conceal.Line>
+---@field private lines table<integer, render.md.request.conceal.Line>
 local Conceal = {}
 Conceal.__index = Conceal
 
----@param context render.md.Context
----@return render.md.Conceal
+---@param context render.md.request.Context
+---@return render.md.request.Conceal
 function Conceal.new(context)
     local self = setmetatable({}, Conceal)
-    self.context = context
     self.buf = context.buf
+    self.view = context.view
     self.level = Env.win.get(context.win, 'conceallevel')
     self.computed = false
     self.lines = {}
@@ -39,7 +39,7 @@ function Conceal:enabled()
 end
 
 ---@param row integer
----@param entry boolean|render.md.conceal.Section
+---@param entry boolean|render.md.request.conceal.Section
 function Conceal:add(row, entry)
     if not self:enabled() then
         return
@@ -59,8 +59,8 @@ function Conceal:add(row, entry)
 end
 
 ---@private
----@param line render.md.conceal.Line
----@param entry render.md.conceal.Section
+---@param line render.md.request.conceal.Line
+---@param entry render.md.request.conceal.Section
 ---@return boolean
 function Conceal:has(line, entry)
     for _, section in ipairs(line.sections) do
@@ -112,7 +112,7 @@ end
 
 ---@private
 ---@param node render.md.Node
----@return render.md.conceal.Line
+---@return render.md.request.conceal.Line
 function Conceal:line(node)
     if not self.computed then
         self.computed = true
@@ -147,7 +147,7 @@ end
 ---@param language string
 ---@param root TSNode
 function Conceal:compute_tree(language, root)
-    if not self.context:overlaps(root) then
+    if not self.view:overlaps(root) then
         return
     end
     if not vim.tbl_contains({ 'markdown', 'markdown_inline' }, language) then
@@ -157,7 +157,7 @@ function Conceal:compute_tree(language, root)
     if not query then
         return
     end
-    self.context:for_each(function(range)
+    self.view:for_each(function(range)
         local top, bottom = range.top, range.bottom
         for id, node, data in query:iter_captures(root, self.buf, top, bottom) do
             if data.conceal_lines then
diff --git a/lua/render-markdown/request/context.lua b/lua/render-markdown/request/context.lua
diff --git a/lua/render-markdown/request/view.lua b/lua/render-markdown/request/view.lua
diff --git a/tests/range_spec.lua b/tests/range_spec.lua
diff --git a/tests/view_spec.lua b/tests/view_spec.lua

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-local Context = require('render-markdown.lib.context')`
	`1`	`+local Context = require('render-markdown.request.context')`
`2`	`2`	`local Iter = require('render-markdown.lib.iter')`
`3`	`3`	`local Marks = require('render-markdown.lib.marks')`
`4`	`4`	`local Node = require('render-markdown.lib.node')`