treesitter

Author: xzbdmw

README.md

@@ -198,7 +198,10 @@ require("quicker").setup({
   -- Keep the cursor to the right of the filename and lnum columns
   constrain_cursor = true,
   highlight = {
-    -- Use treesitter highlighting
+    -- Attach parser to qf buffer, highlight text in real time as you edit.
+    -- If this is true, other highlight options are ignored.
+    attach_parser = true,
+    -- Query treesitter highlight groups using string parser, only update after you save or refresh.
     treesitter = true,
     -- Use LSP semantic token highlighting
     lsp = true,

lua/quicker/config.lua

@@ -154,6 +154,7 @@ end
 ---@field soft_end? string
 
 ---@class (exact) quicker.HighlightConfig
+---@field attach_parser boolean
 ---@field treesitter boolean
 ---@field lsp boolean
 ---@field load_buffers boolean

lua/quicker/display.lua

@@ -267,6 +267,8 @@ local function highlight_buffer_when_entered(qfbufnr, info)
       vim.b[qfbufnr].pending_highlight = nil
       info.start_idx = 1
       info.end_idx = vim.api.nvim_buf_line_count(qfbufnr)
+      info.regions = {}
+      info.empty_regions = {}
       schedule_highlights(info)
     end,
   })
@@ -339,7 +341,22 @@ add_qf_highlights = function(info)
         loaded = true
       end
 
-      if loaded then
+      local ft = vim.filetype.match({ buf = item.bufnr })
+      -- If attach_parser is true, we should not apply lsp highlight or query ts highlights
+      -- from loaded buffers, as they will overwrite each other.
+      if config.highlight.attach_parser and ft then
+        info.regions[ft] = info.regions[ft] or {}
+        info.empty_regions[ft] = info.empty_regions[ft] or {}
+        local filename = vim.split(line, EM_QUAD, { plain = true })[1]
+        table.insert(info.regions[ft], {
+          {
+            i - 1,
+            filename:len() + EM_QUAD_LEN - 1, -- skip EM_QUAD
+            i - 1,
+            #line,
+          },
+        })
+      elseif loaded then
         add_item_highlights_from_buf(qfbufnr, item, line, i)
       elseif config.highlight.treesitter then
         local filename = vim.split(line, EM_QUAD, { plain = true })[1]
@@ -383,6 +400,11 @@ add_qf_highlights = function(info)
       return
     end
   end
+  if config.highlight.attach_parser then
+    -- cleanup previous regions each time we call setqflist.
+    require("quicker.treesitter").attach(qf_list.qfbufnr, info.empty_regions)
+    require("quicker.treesitter").attach(qf_list.qfbufnr, info.regions)
+  end
 
   vim.api.nvim_buf_clear_namespace(qf_list.qfbufnr, ns, info.end_idx, -1)
 end
@@ -425,6 +447,8 @@ end
 ---@field id integer
 ---@field start_idx integer
 ---@field end_idx integer
+---@field regions table<string, number[][][]>
+---@field empty_regions table<string, number[][][]>
 ---@field winid integer
 ---@field quickfix 1|0
 ---@field force_bufload? boolean field injected by us to control if we're forcing a bufload for the syntax highlighting
@@ -588,6 +612,8 @@ function M.quickfixtextfunc(info)
 
   -- If we just rendered the last item, add highlights
   if info.end_idx == #items then
+    info.regions = {}
+    info.empty_regions = {}
     schedule_highlights(info)
 
     if qf_list.qfbufnr > 0 then

lua/quicker/treesitter.lua

@@ -0,0 +1,91 @@
+---@alias trouble.LangRegions table<string, number[][][]>
+
+local M = {}
+
+M.cache = {} ---@type table<number, table<string,{parser: vim.treesitter.LanguageTree, highlighter:vim.treesitter.highlighter, enabled:boolean}>>
+local ns = vim.api.nvim_create_namespace("quicker.treesitter")
+
+local TSHighlighter = vim.treesitter.highlighter
+
+local function wrap(name)
+  return function(_, win, buf, ...)
+    if not M.cache[buf] then
+      return false
+    end
+    for _, hl in pairs(M.cache[buf] or {}) do
+      if hl.enabled then
+        TSHighlighter.active[buf] = hl.highlighter
+        TSHighlighter[name](_, win, buf, ...)
+      end
+    end
+    TSHighlighter.active[buf] = nil
+  end
+end
+
+M.did_setup = false
+function M.setup()
+  if M.did_setup then
+    return
+  end
+  M.did_setup = true
+
+  vim.api.nvim_set_decoration_provider(ns, {
+    on_win = wrap("_on_win"),
+    on_line = wrap("_on_line"),
+  })
+
+  vim.api.nvim_create_autocmd("QuickFixCmdPost", {
+    group = vim.api.nvim_create_augroup("quicker.treesitter.hl", { clear = true }),
+    callback = function(ev)
+      M.cache[ev.buf] = nil
+    end,
+  })
+end
+
+---@param buf number
+---@param regions trouble.LangRegions
+function M.attach(buf, regions)
+  M.setup()
+  M.cache[buf] = M.cache[buf] or {}
+  for lang in pairs(M.cache[buf]) do
+    M.cache[buf][lang].enabled = regions[lang] ~= nil
+  end
+
+  for lang in pairs(regions) do
+    M._attach_lang(buf, lang, regions[lang])
+  end
+end
+
+---@param buf number
+---@param lang? string
+function M._attach_lang(buf, lang, regions)
+  lang = lang or "markdown"
+  lang = lang == "markdown" and "markdown_inline" or lang
+
+  M.cache[buf] = M.cache[buf] or {}
+
+  if not M.cache[buf][lang] then
+    local ok, parser = pcall(vim.treesitter.get_parser, buf, lang)
+    if not ok then
+      return
+    end
+    parser:set_included_regions(vim.deepcopy(regions))
+    M.cache[buf][lang] = {
+      parser = parser,
+      highlighter = TSHighlighter.new(parser),
+    }
+  end
+  M.cache[buf][lang].enabled = true
+  local parser = M.cache[buf][lang].parser
+
+  parser:set_included_regions(vim.deepcopy(regions))
+  -- Run a full parse for all included regions. There are two reasons:
+  -- 1. When we call `vim.treesitter.get_parser`, we have not set any
+  --    injection ranges.
+  -- 2. If this is not called, the highlighter will do incremental parsing,
+  --    which means it only parses visible areas (the on_win and on_line callback),
+  --    so if we modify the buffer, unvisited area's state get unsynced.
+  pcall(parser.parse, parser, true)
+end
+
+return M