detach after config.highlight.max_lines

Author: xzbdmw

README.md

@@ -198,11 +198,11 @@ require("quicker").setup({
   -- Keep the cursor to the right of the filename and lnum columns
   constrain_cursor = true,
   highlight = {
-    -- Attach parser to qf buffer, highlight text in real time as you edit.
-    attach_parser = true,
-    -- Additionally query treesitter highlight groups using string parser,
-    -- those highlights only update when you save or refresh.
+    -- Attach treesitter parser to qf buffer, highlight text in real time as you edit.
     treesitter = true,
+    -- Do not register callbacks when buffer line counts exceed this limit. In other words,
+    -- highlight won't get updated as you edit.
+    max_lines = 10000,
     -- Use LSP semantic token highlighting
     lsp = true,
     -- Load the referenced buffers to apply more accurate highlights (may be slow)

lua/quicker/config.lua

@@ -26,8 +26,11 @@ local default_config = {
   -- Keep the cursor to the right of the filename and lnum columns
   constrain_cursor = true,
   highlight = {
-    -- Use treesitter highlighting
+    -- Attach treesitter parser to qf buffer, highlight text in real time as you edit.
     treesitter = true,
+    -- Do not register callbacks when buffer line counts exceed this limit. In other words,
+    -- highlight won't get updated as you edit.
+    max_lines = 10000,
     -- Use LSP semantic token highlighting
     lsp = true,
     -- Load the referenced buffers to apply more accurate highlights (may be slow)
@@ -154,8 +157,8 @@ end
 ---@field soft_end? string
 
 ---@class (exact) quicker.HighlightConfig
----@field attach_parser boolean
 ---@field treesitter boolean
+---@field max_lines integer
 ---@field lsp boolean
 ---@field load_buffers boolean
 

lua/quicker/display.lua

@@ -216,27 +216,6 @@ local function add_item_highlights_from_buf(qfbufnr, item, line, lnum)
       offset = offset - item_space
     end
 
-    -- Add treesitter highlights
-    if config.highlight.treesitter then
-      for _, hl in ipairs(highlight.buf_get_ts_highlights(item.bufnr, item.lnum)) do
-        local start_col, end_col, hl_group = hl[1], hl[2], hl[3]
-        if end_col == -1 then
-          end_col = src_line:len()
-        end
-        -- If the highlight starts at the beginning of the source line, then it might be off the
-        -- buffer in the quickfix because we've removed leading whitespace. If so, clamp the value
-        -- to 0. Except, for some reason 0 gives incorrect results, but -1 works properly even
-        -- though -1 should indicate the *end* of the line. Not sure why this work, but it does.
-        local hl_start = math.max(-1, start_col + offset)
-        vim.api.nvim_buf_set_extmark(qfbufnr, ns, lnum - 1, hl_start, {
-          hl_group = hl_group,
-          end_col = end_col + offset,
-          priority = 100,
-          strict = false,
-        })
-      end
-    end
-
     -- Add LSP semantic token highlights
     if config.highlight.lsp then
       for _, hl in ipairs(highlight.buf_get_lsp_highlights(item.bufnr, item.lnum)) do
@@ -342,7 +321,7 @@ add_qf_highlights = function(info)
       end
 
       local ft = vim.filetype.match({ buf = item.bufnr })
-      if config.highlight.attach_parser and ft then
+      if config.highlight.treesitter 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]
@@ -370,21 +349,6 @@ add_qf_highlights = function(info)
           })
         end
         info.previous_item = item
-      elseif config.highlight.treesitter then
-        local filename = vim.split(line, EM_QUAD, { plain = true })[1]
-        local offset = filename:len() + EM_QUAD_LEN
-        local text = line:sub(offset + 1)
-        for _, hl in ipairs(highlight.get_heuristic_ts_highlights(item, text)) do
-          local start_col, end_col, hl_group = hl[1], hl[2], hl[3]
-          start_col = start_col + offset
-          end_col = end_col + offset
-          vim.api.nvim_buf_set_extmark(qfbufnr, ns, i - 1, start_col, {
-            hl_group = hl_group,
-            end_col = end_col,
-            priority = 100,
-            strict = false,
-          })
-        end
       end
       if loaded then
         add_item_highlights_from_buf(qfbufnr, item, line, i)
@@ -415,7 +379,7 @@ add_qf_highlights = function(info)
       return
     end
   end
-  if config.highlight.attach_parser then
+  if config.highlight.treesitter 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)

lua/quicker/highlight.lua

@@ -19,71 +19,6 @@ local function get_highlight_query(lang)
   end
 end
 
----@param bufnr integer
----@param lnum integer
----@return quicker.TSHighlight[]
-function M.buf_get_ts_highlights(bufnr, lnum)
-  local filetype = vim.bo[bufnr].filetype
-  if not filetype or filetype == "" then
-    filetype = vim.filetype.match({ buf = bufnr }) or ""
-  end
-  local lang = vim.treesitter.language.get_lang(filetype) or filetype
-  if lang == "" then
-    return {}
-  end
-  local ok, parser = pcall(vim.treesitter.get_parser, bufnr, lang)
-  if not ok or not parser then
-    return {}
-  end
-
-  local row = lnum - 1
-  if not parser:is_valid() then
-    parser:parse(true)
-  end
-
-  local highlights = {}
-  parser:for_each_tree(function(tstree, tree)
-    if not tstree then
-      return
-    end
-
-    local root_node = tstree:root()
-    local root_start_row, _, root_end_row, _ = root_node:range()
-
-    -- Only worry about trees within the line range
-    if root_start_row > row or root_end_row < row then
-      return
-    end
-
-    local query = get_highlight_query(tree:lang())
-
-    -- Some injected languages may not have highlight queries.
-    if not query then
-      return
-    end
-
-    for capture, node, metadata in query:iter_captures(root_node, bufnr, row, root_end_row + 1) do
-      if capture == nil then
-        break
-      end
-
-      local range = vim.treesitter.get_range(node, bufnr, metadata[capture])
-      local start_row, start_col, _, end_row, end_col, _ = unpack(range)
-      if start_row > row then
-        break
-      end
-      local capture_name = query.captures[capture]
-      local hl = string.format("@%s.%s", capture_name, tree:lang())
-      if end_row > start_row then
-        end_col = -1
-      end
-      table.insert(highlights, { start_col, end_col, hl })
-    end
-  end)
-
-  return highlights
-end
-
 ---@class quicker.LSPHighlight
 ---@field [1] integer start_col
 ---@field [2] integer end_col
@@ -157,50 +92,6 @@ function M.buf_get_lsp_highlights(bufnr, lnum)
   return lsp_highlights
 end
 
----@param item QuickFixItem
----@param line string
----@return quicker.TSHighlight[]
-M.get_heuristic_ts_highlights = function(item, line)
-  local filetype = vim.filetype.match({ buf = item.bufnr })
-  if not filetype then
-    return {}
-  end
-
-  local lang = vim.treesitter.language.get_lang(filetype)
-  if not lang then
-    return {}
-  end
-
-  local has_parser, parser = pcall(vim.treesitter.get_string_parser, line, lang)
-  if not has_parser then
-    return {}
-  end
-
-  local root = parser:parse(true)[1]:root()
-  local query = vim.treesitter.query.get(lang, "highlights")
-  if not query then
-    return {}
-  end
-
-  local highlights = {}
-  for capture, node, metadata in query:iter_captures(root, line) do
-    if capture == nil then
-      break
-    end
-
-    local range = vim.treesitter.get_range(node, line, metadata[capture])
-    local start_row, start_col, _, end_row, end_col, _ = unpack(range)
-    local capture_name = query.captures[capture]
-    local hl = string.format("@%s.%s", capture_name, lang)
-    if end_row > start_row then
-      end_col = -1
-    end
-    table.insert(highlights, { start_col, end_col, hl })
-  end
-
-  return highlights
-end
-
 function M.set_highlight_groups()
   if vim.tbl_isempty(vim.api.nvim_get_hl(0, { name = "QuickFixHeaderHard" })) then
     vim.api.nvim_set_hl(0, "QuickFixHeaderHard", { link = "Delimiter", default = true })

lua/quicker/treesitter.lua

@@ -1,4 +1,4 @@
----@alias quicker.LangRegions table<string, Range4[][]>
+local config = require("quicker.config")
 
 local M = {}
 
@@ -42,6 +42,8 @@ function M.setup()
   })
 end
 
+---@alias quicker.LangRegions table<string, Range4[][]>
+
 ---@param buf number
 ---@param regions quicker.LangRegions
 function M.attach(buf, regions)
@@ -51,35 +53,40 @@ function M.attach(buf, regions)
     cache[buf][lang].enabled = regions[lang] ~= nil
   end
 
+  local counts = 0
+  for _, region in pairs(regions) do
+    counts = counts + #vim.iter(region):flatten():totable()
+  end
+
   for lang in pairs(regions) do
-    M._attach_lang(buf, lang, regions[lang])
+    M._attach_lang(buf, lang, regions[lang], counts > config.highlight.max_lines)
   end
 end
 
 ---@param buf number
----@param lang? string
+---@param lang string
 ---@param regions quicker.LangRegions
-function M._attach_lang(buf, lang, regions)
-  lang = lang or "markdown"
-  lang = lang == "markdown" and "markdown_inline" or lang
-
+---@param detach boolean detach callbacks after the full parse
+function M._attach_lang(buf, lang, regions, detach)
   cache[buf] = cache[buf] or {}
 
-  if not 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))
-    cache[buf][lang] = {
-      parser = parser,
-      highlighter = TSHighlighter.new(parser),
-    }
+  local ok, parser
+  if detach then
+    -- This avoids registering callbacks on the languagetree.
+    ok, parser = pcall(vim.treesitter.languagetree.new, buf, lang)
+  else
+    ok, parser = pcall(vim.treesitter.get_parser, buf, lang)
+  end
+  if not ok then
+    return
   end
+  parser:set_included_regions(vim.deepcopy(regions))
+  cache[buf][lang] = {
+    parser = parser,
+    highlighter = TSHighlighter.new(parser),
+  }
   cache[buf][lang].enabled = true
-  local parser = 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.