feat(enhancement): support nearest parent

Fixes #453

Author: isakbm

README.md

@@ -407,6 +407,11 @@ hi TreesitterContextLineNumberBottom gui=underline guisp=Grey
 vim.keymap.set("n", "[c", function()
   require("treesitter-context").go_to_context(vim.v.count1)
 end, { silent = true })
+
+
+vim.keymap.set("n", "[C", function()
+  require("treesitter-context").go_to_context(vim.v.count1, "entire window")
+end, { silent = true })
 ```
 
 ## Adding support for other languages

lua/treesitter-context.lua

@@ -26,6 +26,9 @@ local Render = defer_require('treesitter-context.render')
 --- @type table<integer, Range4[]>
 local all_contexts = {}
 
+--- @type table<integer, Range4[]>
+local all_visible_contexts = {}
+
 --- Schedule a function to run on the next event loop iteration.
 --- If the function is called again within 150ms, it will be scheduled
 --- again to run on the next event loop iteration. This means that
@@ -115,8 +118,10 @@ local update_single_context = throttle_by_id(function(winid)
     return
   end
 
-  local context_ranges, context_lines = require('treesitter-context.context').get(bufnr, winid)
+  local context_ranges, context_lines, visible_context_ranges =
+    require('treesitter-context.context').get(bufnr, winid)
   all_contexts[bufnr] = context_ranges
+  all_visible_contexts[bufnr] = visible_context_ranges
 
   if not context_ranges or #context_ranges == 0 then
     Render.close(winid)
@@ -310,14 +315,23 @@ function M.setup(options)
   end
 end
 
+--- jump to the nearest context parent
+---
 --- @param depth integer? default 1
-function M.go_to_context(depth)
+--- @param mode? 'context window' | 'entire window' default 'context window', the parents to pick from when jumping
+function M.go_to_context(depth, mode)
   depth = depth or 1
+  mode = mode or 'context window'
   local line = api.nvim_win_get_cursor(0)[1]
   local context = nil
   local bufnr = api.nvim_get_current_buf()
   local contexts = all_contexts[bufnr] or {}
 
+  -- add all visible if that is wanted
+  if mode == 'entire window' then
+    vim.list_extend(contexts, all_visible_contexts[bufnr])
+  end
+
   for idx = #contexts, 1, -1 do
     local c = contexts[idx]
     if depth == 0 then

lua/treesitter-context/context.lua

@@ -297,7 +297,7 @@ end
 
 --- @param bufnr integer
 --- @param winid integer
---- @return Range4[]?, string[]?
+--- @return Range4[]?, string[]?, Range4[]?
 function M.get(bufnr, winid)
   -- vim.treesitter.get_parser() calls bufload(), but we don't actually want to load the buffer:
   -- this method is called during plugin init, before other plugins or the user's config
@@ -326,6 +326,7 @@ function M.get(bufnr, winid)
   end
 
   local context_ranges = {} --- @type Range4[]
+  local visible_context_ranges = {} --- @type Range4[]
   local context_lines = {} --- @type string[][]
   local contexts_height = 0
 
@@ -335,6 +336,7 @@ function M.get(bufnr, winid)
     local line_range = { node_row, col0, node_row, col0 + 1 }
 
     context_ranges = {}
+    visible_context_ranges = {}
     context_lines = {}
     contexts_height = 0
 
@@ -366,6 +368,15 @@ function M.get(bufnr, winid)
               context_lines[#context_lines + 1] = lines
             end
           end
+        else
+          local range0 = context_range(parent, bufnr, query)
+          if range0 and range_is_valid(range0) then
+            local range, _lines = get_text_for_range(range0, bufnr)
+            -- TODO: consider printing lines here for debug purposes
+            if range_is_valid(range) then
+              visible_context_ranges[#visible_context_ranges + 1] = range
+            end
+          end
         end
       end
     end
@@ -382,7 +393,7 @@ function M.get(bufnr, winid)
     trim_contexts(context_ranges, context_lines, trim, config.trim_scope == 'outer')
   end
 
-  return context_ranges, tbl_flatten(context_lines)
+  return context_ranges, tbl_flatten(context_lines), visible_context_ranges
 end
 
 return M