refactor: general tidy up

- Remove `getcmdwintype()` check in Render.close().

  Check is already done in `close()` which was added with
  multiwindow support. Should no longer be needed higher
  up.

- Combine `Render.close_other_contexts()` and
  `Render.close_leaked_contexts()` into
  `Render.close_contexts()`.

- Remove unnecessary tables in `is_after()`.

- Inline `delete_excess_buffers()`.

- Collapse some code.

- Rename `update_single_context()` to `update_win()`.

- Fix typing of config module.

Author: lewis6991

lua/treesitter-context.lua

@@ -74,17 +74,14 @@ local attached = {} --- @type table<integer,true>
 
 --- @param args table
 local function au_close(args)
-  if args.event == 'WinClosed' then
-    -- Closing current window instead of intended window may lead to context window flickering.
-    Render.close(tonumber(args.match))
-  else
-    Render.close(api.nvim_get_current_win())
-  end
+  -- Closing current window instead of intended window may lead to context window flickering.
+  local winid = args.event == 'WinClosed' and tonumber(args.match) or api.nvim_get_current_win()
+  Render.close(winid)
 end
 
---- @param bufnr integer
 --- @param winid integer
-local function cannot_open(bufnr, winid)
+local function cannot_open(winid)
+  local bufnr = api.nvim_win_get_buf(winid)
   return not attached[bufnr]
     or vim.bo[bufnr].filetype == ''
     or vim.bo[bufnr].buftype ~= ''
@@ -93,28 +90,28 @@ local function cannot_open(bufnr, winid)
 end
 
 --- @param winid integer
-local update_single_context = throttle_by_id(function(winid)
+local update_win = throttle_by_id(function(winid)
   -- Remove leaked contexts firstly.
-  local current_win = api.nvim_get_current_win()
-  if config.multiwindow then
-    Render.close_leaked_contexts()
-  else
-    Render.close_other_contexts(current_win)
-  end
+  -- Contexts may sometimes leak due to reasons like the use of 'noautocmd'.
+  -- In these cases, affected windows might remain visible, and even ToggleContext
+  -- won't resolve the issue, as contexts are identified using parent windows.
+  -- Therefore, it's essential to occasionally perform garbage collection to
+  -- clean up these leaked contexts.
+  Render.close_contexts(config.multiwindow and api.nvim_list_wins() or { winid })
 
   -- Since the update is performed asynchronously, the window may be closed at this moment.
   -- Therefore, we need to check if it is still valid.
   if not api.nvim_win_is_valid(winid) or vim.fn.getcmdtype() ~= '' then
     return
   end
 
-  local bufnr = api.nvim_win_get_buf(winid)
-
-  if cannot_open(bufnr, winid) or not config.multiwindow and winid ~= current_win then
+  if cannot_open(winid) or not config.multiwindow and winid ~= api.nvim_get_current_win() then
     Render.close(winid)
     return
   end
 
+  local bufnr = api.nvim_win_get_buf(winid)
+
   local context_ranges, context_lines = require('treesitter-context.context').get(bufnr, winid)
   all_contexts[bufnr] = context_ranges
 
@@ -133,14 +130,13 @@ local multiwindow_events = {
 
 --- @param event? string
 local function update(event)
-  if config.multiwindow and multiwindow_events[event] then
-    -- Resizing a single window may cause many resizes in different windows,
-    -- so it is necessary to iterate over all windows when a WinResized event is received.
-    for _, winid in pairs(api.nvim_list_wins()) do
-      update_single_context(winid)
-    end
-  else
-    update_single_context(api.nvim_get_current_win())
+  -- Resizing a single window may cause many resizes in different windows,
+  -- so it is necessary to iterate over all windows when a WinResized event is received.
+  local wins = (config.multiwindow and multiwindow_events[event]) and api.nvim_list_wins()
+    or { api.nvim_get_current_win() }
+
+  for _, win in ipairs(wins) do
+    update_win(win)
   end
 end
 
@@ -295,6 +291,7 @@ local did_init = false
 function M.setup(options)
   -- NB: setup  may be called several times.
   if options then
+    --- @diagnostic disable-next-line: undefined-field
     config.update(options)
   end
 

lua/treesitter-context/config.lua

@@ -68,11 +68,10 @@ function M.update(cfg)
   config = vim.tbl_deep_extend('force', config, cfg)
 end
 
---- @type TSContext.Config
 setmetatable(M, {
   __index = function(_, k)
     return config[k]
   end,
 })
 
-return M
+return M --[[@as TSContext.Config]]

lua/treesitter-context/context.lua

@@ -51,19 +51,17 @@ end
 local function max_lines_from_string(winid, percent)
   local win_height = api.nvim_win_get_height(winid)
   local percent_s = percent:match('^(%d+)%%$')
-  local percent = percent_s and tonumber(percent_s, 10) or 0
-  return math.ceil((percent / 100.0) * win_height)
+  local percent1 = percent_s and tonumber(percent_s, 10) or 0
+  return math.ceil((percent1 / 100) * win_height)
 end
 
 --- @param winid integer
 --- @return integer
 local function calc_max_lines(winid)
-  local max_lines --- @type integer
+  local max_lines = config.max_lines
 
-  if type(config.max_lines) == 'string' then
-    max_lines = max_lines_from_string(winid, config.max_lines)
-  else
-    max_lines = config.max_lines --- @type integer
+  if type(max_lines) == 'string' then
+    max_lines = max_lines_from_string(winid, max_lines)
   end
 
   -- ensure we never have zero as max lines

lua/treesitter-context/render.lua

@@ -37,20 +37,6 @@ local function create_or_get_buf()
   return buf
 end
 
-local function delete_excess_buffers()
-  if fn.getcmdwintype() ~= '' then
-    -- Can't delete buffers when the command-line window is open.
-    return
-  end
-
-  while #buffer_pool > MAX_BUFFER_POOL_SIZE do
-    local buf = table.remove(buffer_pool, #buffer_pool)
-    if api.nvim_buf_is_valid(buf) then
-      api.nvim_buf_delete(buf, { force = true })
-    end
-  end
-end
-
 --- @param winid integer
 --- @param context_winid integer?
 --- @param width integer
@@ -138,11 +124,13 @@ local function get_hl(buf_query, capture)
 end
 
 --- Is a position a after another position b?
---- @param a [integer, integer] [row, col]
---- @param b [integer, integer] [row, col]
+--- @param arow integer
+--- @param acol integer
+--- @param brow integer
+--- @param bcol integer
 --- @return boolean
-local function is_after(a, b)
-  return a[1] > b[1] or (a[1] == b[1] and a[2] > b[2])
+local function is_after(arow, acol, brow, bcol)
+  return arow > brow or (arow == brow and acol > bcol)
 end
 
 --- @param bufnr integer
@@ -182,10 +170,10 @@ local function highlight_contexts(bufnr, ctx_bufnr, contexts)
         local nsrow, nscol, nerow, necol = range[1], range[2], range[4], range[5]
 
         if nsrow >= start_row then
-          if is_after({ nsrow, nscol }, { end_row, end_col }) then
+          if is_after(nsrow, nscol, end_row, end_col) then
             -- Node range begins after the context range, skip it
             break
-          elseif is_after({ nerow, necol }, { end_row, end_col }) then
+          elseif is_after(nerow, necol, end_row, end_col) then
             -- Node range extends beyond the context range, clip it
             nerow, necol = end_row, end_col
           end
@@ -355,18 +343,28 @@ end
 --- @param context_winid? integer
 local function close(context_winid)
   vim.schedule(function()
-    if context_winid == nil or not api.nvim_win_is_valid(context_winid) then
+    if not context_winid or not api.nvim_win_is_valid(context_winid) then
       return
     end
 
     local bufnr = api.nvim_win_get_buf(context_winid)
     api.nvim_win_close(context_winid, true)
-    if bufnr ~= nil and api.nvim_buf_is_valid(bufnr) then
-      -- We can't delete the buffer in-place if the pool is full and the command-line window is open.
-      -- Instead, add the buffer to the pool and let delete_excess_buffers() address this situation.
-      table.insert(buffer_pool, bufnr)
+
+    -- Add the buffer back to the pool for reuse.
+    if bufnr and api.nvim_buf_is_valid(bufnr) then
+      buffer_pool[#buffer_pool + 1] = bufnr
+    end
+
+    -- Delete excess buffers in the pool.
+    -- Can't delete buffers when the command-line window is open.
+    if fn.getcmdwintype() == '' then
+      while #buffer_pool > MAX_BUFFER_POOL_SIZE do
+        local buf = table.remove(buffer_pool, #buffer_pool)
+        if api.nvim_buf_is_valid(buf) then
+          api.nvim_buf_delete(buf, { force = true })
+        end
+      end
     end
-    delete_excess_buffers()
   end)
 end
 
@@ -400,18 +398,15 @@ local function copy_extmarks(bufnr, ctx_bufnr, contexts)
     )
 
     for _, m in ipairs(extmarks) do
-      local id = m[1]
-      local row = m[2]
-      local col = m[3] --[[@as integer]]
+      local id, row, col = m[1], m[2], m[3]
       local opts = m[4] --[[@as vim.api.keyset.extmark_details]]
-
       local start_row = offset + (row - ctx_srow)
 
       local end_row --- @type integer?
       local end_col = opts.end_col
       local mend_row = opts.end_row
       if mend_row then
-        if is_after({ mend_row, end_col }, { ctx_erow, ctx_ecol }) then
+        if is_after(mend_row, assert(end_col), ctx_erow, ctx_ecol) then
           mend_row = ctx_erow
           end_col = ctx_ecol
         end
@@ -454,34 +449,6 @@ end
 
 local M = {}
 
--- Contexts may sometimes leak due to reasons like the use of 'noautocmd'.
--- In these cases, affected windows might remain visible, and even ToggleContext
--- won't resolve the issue, as contexts are identified using parent windows.
--- Therefore, it's essential to occasionally perform garbage collection to
--- clean up these leaked contexts.
-function M.close_leaked_contexts()
-  local all_wins = api.nvim_list_wins()
-
-  for parent_winid, window_context in pairs(window_contexts) do
-    if not vim.tbl_contains(all_wins, parent_winid) then
-      close(window_context.context_winid)
-      close(window_context.gutter_winid)
-      window_contexts[parent_winid] = nil
-    end
-  end
-end
-
---- @param winid integer The only window for which the context should be displayed.
-function M.close_other_contexts(winid)
-  for parent_winid, window_context in pairs(window_contexts) do
-    if parent_winid ~= winid then
-      close(window_context.context_winid)
-      close(window_context.gutter_winid)
-      window_contexts[parent_winid] = nil
-    end
-  end
-end
-
 --- @param bufnr integer
 --- @param winid integer
 --- @param ctx_ranges Range4[]
@@ -544,24 +511,23 @@ function M.open(bufnr, winid, ctx_ranges, ctx_lines)
   horizontal_scroll_contexts(winid, window_context.context_winid)
 end
 
---- @param winid? integer
-function M.close(winid)
-  -- Can't close other windows when the command-line window is open
-  if fn.getcmdwintype() ~= '' then
-    return
-  end
-
-  if winid == nil then
-    return
+--- @param exclude_winids integer[] The only window for which the context should be displayed.
+function M.close_contexts(exclude_winids)
+  for winid in pairs(window_contexts) do
+    if not vim.tbl_contains(exclude_winids, winid) then
+      M.close(winid)
+    end
   end
+end
 
+--- @param winid integer
+function M.close(winid)
   local window_context = window_contexts[winid]
   if window_context then
     close(window_context.context_winid)
     close(window_context.gutter_winid)
+    window_contexts[winid] = nil
   end
-
-  window_contexts[winid] = nil
 end
 
 return M