feat(enhancement): support nearest parent

Fixes #453

Author: isakbm

README.md

@@ -404,9 +404,13 @@ hi TreesitterContextLineNumberBottom gui=underline guisp=Grey
 ## Jumping to context (upwards)
 
 ```lua
-vim.keymap.set("n", "[c", function()
+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_parent(vim.v.count1)
+end, { silent = true })
 ```
 
 ## Adding support for other languages

doc/nvim-treesitter-context.txt

@@ -116,18 +116,41 @@ enable()                                      *nvim-treesitter-context-enable()*
 
 go_to_context({depth})                 *nvim-treesitter-context-go_to_context()*
 
-    Jump to the context at {depth}.
+    Jump to parent scope within the context
+    window at {depth}.
+
+    A depth of 1 implies nearest, 2 second
+    nearest and so on. Set to `vim.v.count1`
+    to support motions with counts as depth.
 
     Example use in a keymap:
 >lua
-        vim.keymap.set("n", "[c", function()
+        vim.keymap.set("n", "[C", function()
           require("treesitter-context").go_to_context(vim.v.count1)
         end, { silent = true })
 <
 
     Parameters: ~
         {depth} (`integer`, default: `1`) Depth to jump to.
 
+go_to_parent({depth})                 *nvim-treesitter-context-go_to_parent()*
+
+    Jump to parent scope at {depth}.
+
+    A depth of 1 implies nearest, 2 second
+    nearest and so on. Set to `vim.v.count1`
+    to support motions with counts as depth.
+
+    Example use in a keymap:
+>lua
+        vim.keymap.set("n", "[c", function()
+          require("treesitter-context").go_to_parent(vim.v.count1)
+        end, { silent = true })
+<
+
+    Parameters: ~
+        {depth} (`integer`, default: `1`) Depth to jump to.
+
 
 setup({config})                                *nvim-treesitter-context-setup()*
 

lua/treesitter-context.lua

@@ -301,30 +301,60 @@ function M.setup(options)
   end
 end
 
---- @param depth integer? default 1
-function M.go_to_context(depth)
-  depth = depth or 1
+--- @param depth integer
+--- @param ranges Range4[]
+local function go_to(depth, ranges)
   local line = api.nvim_win_get_cursor(0)[1]
-  local context = nil
-  local contexts = require('treesitter-context.context').get() or {}
+  local range = nil
 
-  for idx = #contexts, 1, -1 do
-    local c = contexts[idx]
+  for idx = #ranges, 1, -1 do
+    local c = ranges[idx]
     if depth == 0 then
       break
     end
     if c[1] + 1 < line then
-      context = c
+      range = c
       depth = depth - 1
     end
   end
 
-  if not context then
+  if not range then
     return
   end
 
-  vim.cmd([[ normal! m' ]]) -- add current cursor position to the jump list
-  api.nvim_win_set_cursor(0, { context[1] + 1, context[2] })
+  vim.cmd([[normal! m']]) -- add current cursor position to the jump list
+  api.nvim_win_set_cursor(0, { range[1] + 1, range[2] })
+end
+
+--- Jump to parent scope at depth.
+---
+--- A depth of 1 implies nearest, 2 second
+--- nearest and so on. Set to `vim.v.count1`
+--- to support motions with counts as depth.
+---
+--- @param depth integer? default 1
+function M.go_to_parent(depth)
+  depth = depth or 1
+
+  --- @type table, table, table
+  local _, _, ranges = require('treesitter-context.context').get()
+  ranges = ranges or {}
+
+  go_to(depth, ranges)
+end
+
+--- Jump to parent scope within the context
+--- window at depth.
+---
+--- A depth of 1 implies nearest, 2 second
+--- nearest and so on. Set to `vim.v.count1`
+--- to support motions with counts as depth.
+---
+--- @param depth integer? default 1
+function M.go_to_context(depth)
+  depth = depth or 1
+  local ranges = require('treesitter-context.context').get() or {}
+  go_to(depth, ranges)
 end
 
 return M

lua/treesitter-context/context.lua

@@ -190,7 +190,7 @@ end
 --- @param bufnr integer
 --- @return Range4, string[]
 local function get_text_for_range(range, bufnr)
-  local start_row, end_row, end_col = range[1], range[3], range[4]
+  local start_row, start_col, end_row, end_col = range[1], range[2], range[3], range[4]
 
   if end_col == 0 then
     end_row = end_row - 1
@@ -218,7 +218,7 @@ local function get_text_for_range(range, bufnr)
     end_row = end_row + 1
   end
 
-  return { start_row, 0, end_row, end_col }, lines
+  return { start_row, start_col, end_row, end_col }, lines
 end
 
 local M = {}
@@ -272,6 +272,11 @@ local function iter_context_parents(bufnr, line_range)
         return
       end
       parents = get_parent_nodes(tree, line_range)
+
+      --- NOTE: because for some reason the get_parent_nodes returns a
+      ---  repeated node at the very end
+      table.remove(parents)
+
       query = get_context_query(tree:lang())
     until parents and query
     return parents, query
@@ -313,7 +318,7 @@ local function range_is_valid(range)
 end
 
 --- @param winid? integer
---- @return Range4[]?, string[]?
+--- @return Range4[]?, string[]?, Range4[]?
 function M.get(winid)
   winid = winid or api.nvim_get_current_win()
   local bufnr = api.nvim_win_get_buf(winid)
@@ -345,6 +350,7 @@ function M.get(winid)
   end
 
   local context_ranges = {} --- @type Range4[]
+  local parent_ranges = {} --- @type Range4[]
   local context_lines = {} --- @type string[][]
   local contexts_height = 0
 
@@ -354,6 +360,7 @@ function M.get(winid)
     local line_range = { node_row, col0, node_row, col0 + 1 }
 
     context_ranges = {}
+    parent_ranges = {}
     context_lines = {}
     contexts_height = 0
 
@@ -369,7 +376,7 @@ function M.get(winid)
 
         local contexts_end_row = top_row + separator_offset + num_context_lines
 
-        -- Only process the parent if it is not in view.
+        -- context_ranges: Only process the parent if it is not in view.
         if parent_start_row < contexts_end_row then
           local range0 = context_range(parent, bufnr, query)
           if range0 and range_is_valid(range0) then
@@ -389,6 +396,15 @@ function M.get(winid)
             end
           end
         end
+
+        -- parent_ranges: Process all
+        local range0 = context_range(parent, bufnr, query)
+        if range0 and range_is_valid(range0) then
+          local range, _lines = get_text_for_range(range0, bufnr)
+          if range_is_valid(range) then
+            parent_ranges[#parent_ranges + 1] = range
+          end
+        end
       end
     end
 
@@ -404,7 +420,7 @@ function M.get(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), parent_ranges
 end
 
 return M