Merge branch 'dev'

Author: shellRaining

docs/en/indent.md

@@ -40,6 +40,24 @@ When rendering, the first level will use the first character, the second level w
 
 - `delay` is a number that presents a millisecond value, because rendering is very time-consuming in some cases, a throttle function is used to limit the rendering frequency, the larger the value, the smoother the screen scrolling, but at the same time, a larger part of the content will not be rendered (until after delay milliseconds), which defaults to 100
 
+- `filter_list` is a `Lua` list where you can define some `filter` functions to filter the rendered characters. The functions defined here must accept one parameter, `render_char_info`, which contains the following fields:
+  - `level`: indicates the current indentation level
+  - `lnum`: indicates the line number where the current indented character is located (starting from 0)
+  - `virt_text_win_col`: represents the column on the screen where the current indented character is located (starting from 0). For more information, refer to [nvim_buf_set_extmark function](https://neovim.io/doc/user/api.html#nvim_buf_set_extmark())
+  - `virt_text`: same as above, this is a parameter of the `nvim_buf_set_extmark` function; generally, you do not need to set this field.
+  
+  let's look an example here, if you don't want to show the first level of indent line, you can set like this:
+  
+  ```lua
+  filter_list = {
+      function(v)
+          return v.level ~= 1
+      end,
+  },
+  ```
+  
+
+
 Like chunk, we also need to pay extra attention to the common configuration style:
 
 - Here, style is a RGB string or a table. If it is a string, all indent lines will be rendered in this color. If it is a table, it can be written in two ways:

docs/zh_CN/indent.md

@@ -40,6 +40,23 @@ local default_conf = {
 
 - `delay` 是一个用来表示毫秒值的数字，这是由于某些情况下渲染非常耗时，采用节流函数对渲染频率进行了限制，数值越大，滚动屏幕时越流畅，但同时也会看到较大部分的内容未被渲染（直到 delay 毫秒后），默认为 100
 
+- `filter_list` 是一个 `Lua` 列表，其中可以定义一些 `filter` 函数，用来对渲染的字符进行过滤。你在这里定义的函数必须接受一个参数 `render_char_info`，这个参数包含如下字段
+  - `level` 表示当前缩进层级
+  - `lnum` 表示当前缩进字符所在行（0 为起始行）
+  - `virt_text_win_col` 当前缩进字符在屏幕上的所在列（0 为起始列）具体信息可以看 [nvim_buf_set_extmark 函数](https://neovim.io/doc/user/api.html#nvim_buf_set_extmark())的介绍信息
+  - `virt_text` 同上，这是 `nvim_buf_set_extmark` 函数的一个参数，一般来说你不需要设置这个字段。
+  
+  比如，如果你不希望渲染第一个 `level` 的字符，你可以按照如下方法设置
+  
+  ```lua
+  filter_list = {
+      function(v)
+          return v.level ~= 1
+      end,
+  },
+  ```
+
+
 和 chunk 一样，我们需要额外注意 style 这个通用配置：
 
 - 这里的 `style` 是一个 RGB 字符串或者一个表。如果是字符串，那么所有的缩进线将会采用这一种颜色来渲染，如果是表，可以有这两种写法：

lua/hlchunk/mods/chunk/init.lua

@@ -3,6 +3,7 @@ local ChunkConf = require("hlchunk.mods.chunk.chunk_conf")
 local chunkHelper = require("hlchunk.utils.chunkHelper")
 local LoopTask = require("hlchunk.utils.loopTask")
 local debounce = require("hlchunk.utils.timer").debounce
+local debounce_throttle = require("hlchunk.utils.timer").debounce_throttle
 local Pos = require("hlchunk.utils.position")
 local Scope = require("hlchunk.utils.scope")
 local cFunc = require("hlchunk.utils.cFunc")
@@ -156,7 +157,7 @@ function ChunkMod:render(range, opts)
             row_opts.virt_text = { { vt, text_hl } }
             row_opts.virt_text_win_col = virt_text_win_col_list[i]
             local row = row_list[i]
-            if api.nvim_buf_is_valid(range.bufnr) and api.nvim_buf_line_count(range.bufnr) > row then
+            if row and api.nvim_buf_is_valid(range.bufnr) and api.nvim_buf_line_count(range.bufnr) > row then
                 api.nvim_buf_set_extmark(range.bufnr, self.meta.ns_id, row, 0, row_opts)
             end
         end
@@ -202,11 +203,11 @@ function ChunkMod:createAutocmd()
         end
     end
     local db_render_cb = debounce(render_cb, self.conf.delay, false)
-    local db_render_cb_imm = debounce(render_cb, self.conf.delay, true)
+    local db_render_cb_imm = debounce_throttle(render_cb, self.conf.delay)
     local db_render_cb_with_pre_hook = function(event, opts)
         opts = opts or { lazy = false }
         local bufnr = event.buf
-        if not (api.nvim_buf_is_valid(bufnr) and self:shouldRender(bufnr)) then
+        if not self:shouldRender(bufnr) then
             return
         end
         if opts.lazy then

lua/hlchunk/mods/indent/indent_conf.lua

@@ -12,6 +12,7 @@ local BaseConf = require("hlchunk.mods.base_mod.base_conf")
 ---@field chars table<string, string>
 ---@field ahead_lines number
 ---@field delay number default 50ms
+---@field filter_list table<number, function>
 ---@overload fun(conf?: UserIndentConf): IndentConf
 local IndentConf = class(BaseConf, function(self, conf)
     local default_conf = {
@@ -21,6 +22,7 @@ local IndentConf = class(BaseConf, function(self, conf)
         chars = { "│" },
         ahead_lines = 5,
         delay = 100,
+        filter_list = {},
     }
     conf = vim.tbl_deep_extend("force", default_conf, conf or {}) --[[@as IndentConf]]
     BaseConf.init(self, conf)
@@ -31,6 +33,7 @@ local IndentConf = class(BaseConf, function(self, conf)
     self.chars = conf.chars
     self.ahead_lines = conf.ahead_lines
     self.delay = conf.delay
+    self.filter_list = conf.filter_list
 end)
 
 return IndentConf

lua/hlchunk/mods/indent/init.lua

@@ -13,7 +13,6 @@ local ROWS_INDENT_RETCODE = indentHelper.ROWS_INDENT_RETCODE
 
 ---@class IndentMetaInfo : MetaInfo
 ---@field pre_leftcol number
----@field cache Cache
 
 local constructor = function(self, conf, meta)
     local default_meta = {
@@ -24,24 +23,29 @@ local constructor = function(self, conf, meta)
         shiftwidth = fn.shiftwidth(),
         pre_leftcol = 0,
         leftcol = fn.winsaveview().leftcol,
-        cache = Cache("bufnr", "line"),
     }
 
     BaseMod.init(self, conf, meta)
     self.meta = vim.tbl_deep_extend("force", default_meta, meta or {})
     self.conf = IndentConf(conf)
 end
 
+---@class RenderInfo
+---@field lnum number
+---@field virt_text_win_col number
+---@field virt_text table
+---@field level number
+
 ---@class IndentMod : BaseMod
 ---@field conf IndentConf
 ---@field meta IndentMetaInfo
 ---@field render fun(self: IndentMod, range: Scope, opts: {lazy: boolean})
----@field narrowRange fun(self: IndentMod, range: Scope): Scope
----@field calcRenderInfo fun(self: IndentMod, range: Scope): table<number, string>
+---@field calcRenderInfo fun(self: IndentMod, range: Scope): RenderInfo
 ---@field setmark function
 ---@overload fun(conf?: UserIndentConf, meta?: MetaInfo): IndentMod
 local IndentMod = class(BaseMod, constructor)
 
+local indent_cache = Cache("bufnr", "line")
 local pos2info = Cache("bufnr", "line", "col")
 local pos2id = Cache("bufnr", "line", "col")
 
@@ -51,17 +55,17 @@ function IndentMod:disable()
     BaseMod.disable(self)
 end
 
-function IndentMod:narrowRange(range)
+local function narrowRange(range)
     local start = range.start
     local finish = range.finish
     for i = start, finish do
-        if not self.meta.cache:has(range.bufnr, i) then
+        if not indent_cache:has(range.bufnr, i) then
             start = i
             break
         end
     end
     for i = finish, start, -1 do
-        if not self.meta.cache:has(range.bufnr, i) then
+        if not indent_cache:has(range.bufnr, i) then
             finish = i
             break
         end
@@ -70,7 +74,6 @@ function IndentMod:narrowRange(range)
 end
 
 function IndentMod:calcRenderInfo(range)
-    -- calc render info
     local conf = self.conf
     local meta = self.meta
     local char_num = #conf.chars
@@ -79,7 +82,7 @@ function IndentMod:calcRenderInfo(range)
     local sw = meta.shiftwidth
     local render_info = {}
     for lnum = range.start, range.finish do
-        local blankLen = meta.cache:get(range.bufnr, lnum) --[[@as string]]
+        local blankLen = indent_cache:get(range.bufnr, lnum) --[[@as string]]
         local render_char_num, offset, shadow_char_num = indentHelper.calc(blankLen, leftcol, sw)
         for i = 1, render_char_num do
             local win_col = offset + (i - 1) * sw
@@ -89,8 +92,8 @@ function IndentMod:calcRenderInfo(range)
                 lnum = lnum,
                 virt_text_win_col = win_col,
                 virt_text = { { char, style } },
+                level = i,
             })
-            pos2info:set(range.bufnr, lnum, win_col, { char, style })
         end
     end
 
@@ -118,16 +121,17 @@ function IndentMod:render(range, opts)
     opts = opts or { lazy = false }
     local bufnr = range.bufnr
     local conf = self.conf
-    local meta = self.meta
 
     if not opts.lazy then
-        self:clear(Scope(bufnr, 0, api.nvim_buf_line_count(bufnr)))
-        meta.cache:clear(bufnr)
-        pos2id:clear(bufnr)
-        pos2info:clear(bufnr)
+        self:clear(range)
+        for i = range.start, range.finish do
+            indent_cache:clear(bufnr, i)
+            pos2id:clear(bufnr, i)
+            pos2info:clear(bufnr, i)
+        end
     end
 
-    local narrowed_range = self:narrowRange(range)
+    local narrowed_range = narrowRange(range)
     local retcode, rows_indent = indentHelper.get_rows_indent(narrowed_range, {
         use_treesitter = conf.use_treesitter,
         virt_indent = true,
@@ -139,10 +143,19 @@ function IndentMod:render(range, opts)
         return
     end
 
+    -- get render_info and process it
     for lnum, indent in pairs(rows_indent) do
-        meta.cache:set(bufnr, lnum, indent)
+        indent_cache:set(bufnr, lnum, indent)
     end
     local render_info = self:calcRenderInfo(narrowed_range)
+    for _, v in pairs(render_info) do
+        pos2info:set(range.bufnr, v.lnum, v.virt_text_win_col, v.virt_text)
+    end
+    for _, filter in ipairs(self.conf.filter_list) do
+        render_info = vim.tbl_filter(filter, render_info)
+    end
+
+    -- render
     self:setmark(bufnr, render_info)
 end
 
@@ -151,17 +164,18 @@ function IndentMod:createAutocmd()
     local render_cb = function(event, opts)
         opts = opts or { lazy = false }
         local bufnr = event.buf
-        if not (api.nvim_buf_is_valid(bufnr) and self:shouldRender(bufnr)) then
+        if not self:shouldRender(bufnr) then
             return
         end
         local wins = fn.win_findbuf(bufnr) or {}
         for _, winid in ipairs(wins) do
-            local range = Scope(api.nvim_win_get_buf(winid), fn.line("w0", winid) - 1, fn.line("w$", winid) - 1)
+            local win_bufnr = api.nvim_win_get_buf(winid)
+            local range = Scope(win_bufnr, fn.line("w0", winid) - 1, fn.line("w$", winid) - 1)
             local ahead_lines = self.conf.ahead_lines
             range.start = math.max(0, range.start - ahead_lines)
-            range.finish = math.min(api.nvim_buf_line_count(bufnr) - 1, range.finish + ahead_lines)
+            range.finish = math.min(api.nvim_buf_line_count(win_bufnr) - 1, range.finish + ahead_lines)
             api.nvim_win_call(winid, function()
-                self.meta.shiftwidth = cFunc.get_sw(bufnr)
+                self.meta.shiftwidth = cFunc.get_sw(win_bufnr)
                 self.meta.pre_leftcol = self.meta.leftcol
                 self.meta.leftcol = fn.winsaveview().leftcol
                 if self.meta.pre_leftcol ~= self.meta.leftcol then
@@ -187,16 +201,12 @@ function IndentMod:createAutocmd()
             throttle_render_cb_with_pre_hook(e, { lazy = true })
         end,
     })
-    api.nvim_create_autocmd({ "TextChanged", "TextChangedI" }, {
+    api.nvim_create_autocmd({ "TextChanged", "TextChangedI", "BufWinEnter" }, {
         group = self.meta.augroup_name,
         callback = function(e)
             throttle_render_cb_with_pre_hook(e, { lazy = false })
         end,
     })
-    api.nvim_create_autocmd({ "BufWinEnter" }, {
-        group = self.meta.augroup_name,
-        callback = throttle_render_cb_with_pre_hook,
-    })
     api.nvim_create_autocmd({ "OptionSet" }, {
         group = self.meta.augroup_name,
         pattern = "list,listchars,shiftwidth,tabstop,expandtab",

lua/hlchunk/utils/cache.lua

@@ -9,7 +9,7 @@ local Cache = class(function(self, ...)
     self.cache = {}
 end)
 
-local function navigateCache(cache, values, createIfMissing, setValue)
+local function navigateCache(cache, values, createIfMissing, isSetValue, setValue)
     local tableRef = cache
     local searchSteps = #values
     for i = 1, searchSteps - 1 do
@@ -24,9 +24,8 @@ local function navigateCache(cache, values, createIfMissing, setValue)
         tableRef = tableRef[key]
     end
 
-    if setValue then
+    if isSetValue then
         tableRef[values[searchSteps]] = setValue
-        return setValue
     else
         return tableRef[values[searchSteps]]
     end
@@ -46,7 +45,7 @@ function Cache:set(...)
         error("The number of keys passed to set() must be one more than the number of keys passed to the constructor")
     end
     local value = table.remove(values) -- 将最后一个参数作为要设置的值
-    navigateCache(self.cache, values, true, value)
+    navigateCache(self.cache, values, true, true, value)
 end
 
 function Cache:has(...)
@@ -62,8 +61,16 @@ function Cache:clear(...)
     if #values == 0 then
         self.cache = {}
     else
-        navigateCache(self.cache, values, false, {})
+        navigateCache(self.cache, values, false, true, {})
     end
 end
 
+function Cache:remove(...)
+    local values = { ... }
+    if #values ~= #self.keys then
+        error("The number of keys passed to remove() must match the number of keys passed to the constructor")
+    end
+    navigateCache(self.cache, values, false, true, nil)
+end
+
 return Cache

lua/hlchunk/utils/filetype.lua

@@ -12,6 +12,7 @@ M.exclude_filetypes = {
     mason = true,
     NvimTree = true,
     ["neo-tree"] = true,
+    ["neo-tree-popup"] = true,
     plugin = true,
     lazy = true,
     TelescopePrompt = true,
@@ -48,6 +49,7 @@ M.exclude_filetypes = {
     startify = true,
     oil = true,
     glowpreview = true,
+    fzf = true,
 }
 
 return M

lua/hlchunk/utils/timer.lua

@@ -66,6 +66,30 @@ function M.debounce(fn, delay, first)
     end
 end
 
+function M.debounce_throttle(fn, delay)
+    local timer = nil
+    local called = false
+
+    return function(...)
+        local args = { ... }
+        if timer then
+            timer:stop()
+        end
+
+        if not called then
+            fn(unpack(args))
+            called = true
+            M.setTimeout(function()
+                called = false
+            end, delay)
+        else
+            timer = M.setTimeout(function()
+                fn(unpack(args))
+            end, delay)
+        end
+    end
+end
+
 ---throttle function, assume we call a throttled func every 300ms for 9 times, and interval set to 1000ms
 ---then will actually call 3 times, and timeline as follow:
 ---`0ms` 300ms 600ms 900ms call throttled func, 0ms will tigger the timer, other 3 will be ignored

test/features/cache_spec.lua

@@ -68,4 +68,15 @@ describe("cache", function()
         assert.equal(nil, cache:get(0, 0, 0))
         assert.equal(nil, cache:get(1, 0, 0))
     end)
+    it("cache remove", function()
+        local cache = Cache("bufnr", "line", "col")
+        cache:set(0, 0, 0, "a")
+        cache:set(0, 0, 1, "b")
+        cache:set(0, 1, 0, "c")
+
+        cache:remove(0, 0, 0)
+        assert.equal(nil, cache:get(0, 0, 0))
+        assert.equal("b", cache:get(0, 0, 1))
+        assert.equal("c", cache:get(0, 1, 0))
+    end)
 end)