ref & docs: update README and update setHl and pre_leftcol

Author: shellRaining

README.md

@@ -75,7 +75,7 @@ One picture to understand what these mods do
 
 ## Requirements
 
-neovim version `>= 0.9.0`
+neovim version `>= 0.10.0`
 
 ## Installation (with lazy.nvim)
 

README.zh-CN.md

@@ -72,7 +72,7 @@
 
 ## 需求
 
-neovim 版本 `>= 0.9.0`
+neovim 版本 `>= 0.10.0`
 
 ## 安装（使用 lazy.nvim）
 

lua/hlchunk/mods/base_mod/init.lua

@@ -148,7 +148,31 @@ end
 
 function BaseMod:createAutocmd()
     api.nvim_create_augroup(self.meta.augroup_name, { clear = true })
-
+    api.nvim_create_autocmd("WinScrolled", {
+        group = self.meta.augroup_name,
+        callback = function()
+            local data = vim.v.event
+
+            for winid, changes in pairs(data) do
+                if winid ~= "all" then
+                    winid = tonumber(winid) --[[@as number]]
+                    local bufnr = api.nvim_win_get_buf(winid)
+                    if changes.topline ~= 0 then
+                        api.nvim_exec_autocmds("User", {
+                            pattern = "WinScrolledY",
+                            data = { winid = winid, buf = bufnr },
+                        })
+                    end
+                    if changes.leftcol ~= 0 then
+                        api.nvim_exec_autocmds("User", {
+                            pattern = "WinScrolledX",
+                            data = { winid = winid, buf = bufnr },
+                        })
+                    end
+                end
+            end
+        end,
+    })
     api.nvim_create_autocmd({ "ColorScheme" }, {
         group = self.meta.augroup_name,
         pattern = "*",
@@ -163,45 +187,33 @@ function BaseMod:clearAutocmd()
 end
 
 function BaseMod:setHl()
-    local hl_conf = self.conf.style
-    self.meta.hl_name_list = {}
-
-    -- such as style = "#abcabc"
-    if type(hl_conf) == "string" then
-        api.nvim_set_hl(0, self.meta.hl_base_name .. "1", { fg = hl_conf })
-        self.meta.hl_name_list = { self.meta.hl_base_name .. "1" }
-        return
-    end
-
-    for idx, val in ipairs(hl_conf) do
-        local value_type = type(val)
-        if value_type == "table" then
-            if type(val.fg) == "function" or type(val.bg) == "function" then
-                --[[
-                such as style = {
-                    { fg = fg1cb, bg = bg1cb },
-                    { fg = "#abcabc", bg = "#cdefef"},
-                }
-                --]]
-                local value_tmp = vim.deepcopy(val)
-                value_tmp.fg = type(val.fg) == "function" and val.fg() or val.fg
-                value_tmp.bg = type(val.bg) == "function" and val.bg() or val.bg
-                api.nvim_set_hl(0, self.meta.hl_base_name .. idx, value_tmp)
-            else
-                --[[
-                such as style = {
-                    { fg = "#abcabc", bg = "#cdefef" },
-                    { fg = "#abcabc", bg = "#cdefef" },
-                }
-                --]]
-                api.nvim_set_hl(0, self.meta.hl_base_name .. idx, val)
+    local function inner(hl_entry)
+        local res = {}
+        hl_entry = hl_entry or self.conf.style
+        if type(hl_entry) == "string" then
+            local hl_name = self.meta.hl_base_name .. "1"
+            api.nvim_set_hl(0, hl_name, { fg = hl_entry })
+            res[1] = hl_name
+        elseif type(hl_entry) == "table" and type(hl_entry[1]) == "string" then
+            for idx, val in ipairs(hl_entry) do
+                local hl_name = self.meta.hl_base_name .. idx
+                api.nvim_set_hl(0, hl_name, { fg = val })
+                res[idx] = hl_name
+            end
+        elseif type(hl_entry) == "table" and type(hl_entry[1]) == "table" then
+            for idx, val in ipairs(hl_entry) do
+                local hl_name = self.meta.hl_base_name .. idx
+                api.nvim_set_hl(0, hl_name, val --[[@as vim.api.keyset.highlight]])
+                res[idx] = hl_name
             end
-        elseif value_type == "string" then
-            -- such as style = {"#abcabc", "#cdefef"}
-            api.nvim_set_hl(0, self.meta.hl_base_name .. idx, { fg = val })
+        elseif type(hl_entry) == "function" then
+            res = inner(hl_entry())
         end
-        table.insert(self.meta.hl_name_list, self.meta.hl_base_name .. idx)
+        return res
     end
+
+    local res = inner()
+    self.meta.hl_name_list = res
 end
 
 function BaseMod:clearHl()

lua/hlchunk/mods/indent/init.lua

@@ -12,7 +12,6 @@ local fn = vim.fn
 local ROWS_INDENT_RETCODE = indentHelper.ROWS_INDENT_RETCODE
 
 ---@class HlChunk.IndentMetaInfo : HlChunk.MetaInfo
----@field pre_leftcol number
 
 local constructor = function(self, conf, meta)
     local default_meta = {
@@ -21,7 +20,6 @@ local constructor = function(self, conf, meta)
         hl_base_name = "HLIndent",
         ns_id = api.nvim_create_namespace("indent"),
         shiftwidth = fn.shiftwidth(),
-        pre_leftcol = 0,
         leftcol = fn.winsaveview().leftcol,
     }
 
@@ -157,8 +155,21 @@ function IndentMod:render(range, opts)
     self:setmark(bufnr, render_info)
 end
 
-function IndentMod:createRenderCallback()
+function IndentMod:createThrottledCallback(callback)
+    local throttledCallback = throttle(callback, self.conf.delay)
     return 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
+            return
+        end
+        throttledCallback(event, opts)
+    end
+end
+
+function IndentMod:createAutocmd()
+    BaseMod.createAutocmd(self)
+    local throttledCallback = self:createThrottledCallback(function(event, opts)
         opts = opts or { lazy = false }
         local bufnr = event.buf
         if not self:shouldRender(bufnr) then
@@ -167,45 +178,23 @@ function IndentMod:createRenderCallback()
 
         local wins = fn.win_findbuf(bufnr) or {}
         for _, winid in ipairs(wins) do
-            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 range = Scope(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(win_bufnr) - 1, range.finish + ahead_lines)
+            range.finish = math.min(api.nvim_buf_line_count(bufnr) - 1, range.finish + ahead_lines)
             api.nvim_win_call(winid, function()
-                self.meta.shiftwidth = cFunc.get_sw(win_bufnr)
-                self.meta.pre_leftcol = self.meta.leftcol
+                self.meta.shiftwidth = cFunc.get_sw(bufnr)
                 self.meta.leftcol = fn.winsaveview().leftcol
-                if self.meta.pre_leftcol ~= self.meta.leftcol then
-                    opts.lazy = false
-                end
                 self:render(range, opts)
             end)
         end
-    end
-end
-
-function IndentMod:createThrottledCallback(callback)
-    local throttledCallback = throttle(callback, self.conf.delay)
-    return 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
-            return
-        end
-        throttledCallback(event, opts)
-    end
-end
-
-function IndentMod:createAutocmd()
-    BaseMod.createAutocmd(self)
-    local renderCallback = self:createRenderCallback()
-    local throttledCallback = self:createThrottledCallback(renderCallback)
+    end)
 
     local autocommands = {
-        { events = { "WinScrolled" }, opts = { lazy = true } },
+        { events = { "User" }, pattern = "WinScrolledX", opts = { lazy = false } },
+        { events = { "User" }, pattern = "WinScrolledY", opts = { lazy = true } },
         { events = { "TextChanged", "TextChangedI", "BufWinEnter" }, opts = { lazy = false } },
-        { events = { "OptionSet" }, pattern = "list,listchars,shiftwidth,tabstop,expandtab", opts = {} },
+        { events = { "OptionSet" }, pattern = "list,shiftwidth,tabstop,expandtab", opts = { lazy = false } },
     }
 
     for _, cmd in ipairs(autocommands) do