feat: consolidate context table

Author: Saghen

lua/blink/cmp/sources/buffer.lua

@@ -66,7 +66,7 @@ local buffer = {}
 
 function buffer.new(config) return setmetatable(config, { __index = buffer }) end
 
-function buffer:get_completions(context, callback)
+function buffer:get_completions(_, callback)
   local transformed_callback = function(items)
     callback({ is_incomplete_forward = false, is_incomplete_backward = false, items = items })
   end

lua/blink/cmp/sources/lib/context.lua

@@ -1,9 +1,9 @@
 local async = require('blink.cmp.sources.lib.async')
 local sources_context = {}
 
---- @param context blink.cmp.ShowContext
+--- @param context blink.cmp.Context
 --- @param sources_groups blink.cmp.Source[][]
---- @param on_completions_callback fun(context: blink.cmp.ShowContext, items: blink.cmp.CompletionItem[])
+--- @param on_completions_callback fun(context: blink.cmp.Context, items: blink.cmp.CompletionItem[])
 function sources_context.new(context, sources_groups, on_completions_callback)
   local self = setmetatable({}, { __index = sources_context })
   self.id = context.id
@@ -12,7 +12,7 @@ function sources_context.new(context, sources_groups, on_completions_callback)
   self.active_request = nil
   self.queued_request_context = nil
   self.last_successful_completions = nil
-  --- @type fun(context: blink.cmp.ShowContext, items: blink.cmp.CompletionItem[])
+  --- @type fun(context: blink.cmp.Context, items: blink.cmp.CompletionItem[])
   self.on_completions_callback = on_completions_callback
 
   return self
@@ -21,16 +21,14 @@ end
 --- @return blink.cmp.CompletionItem[]
 function sources_context:get_last_successful_completions() return self.last_successful_completions end
 
---- @param context blink.cmp.ShowContext
+--- @param context blink.cmp.Context
 function sources_context:get_completions(context)
   assert(context.id == self.id, 'Requested completions on a sources context with a different context ID')
 
   if self.active_request ~= nil and self.active_request.status == async.STATUS.RUNNING then
-    -- vim.print(tostring(context.id) .. ': queued request | col: ' .. context.bounds.end_col)
     self.queued_request_context = context
     return
   end
-  -- vim.print(tostring(context.id) .. ': running request | col: ' .. context.bounds.end_col)
 
   -- Create a task to get the completions for the first sources group,
   -- falling back to the next sources group iteratively if there are no items
@@ -62,19 +60,19 @@ function sources_context:get_completions(context)
 end
 
 --- @param sources_group blink.cmp.Source[]
---- @param context blink.cmp.ShowContext
+--- @param context blink.cmp.Context
 --- @return blink.cmp.Task
 function sources_context:get_completions_for_group(sources_group, context)
   -- get completions for each source in the group
   local tasks = vim.tbl_map(function(source)
     -- the source indicates we should refetch when this character is typed
-    local trigger_character = context.trigger_character
-      and vim.tbl_contains(source:get_trigger_characters(), context.trigger_character)
+    local trigger_character = context.trigger.character
+      and vim.tbl_contains(source:get_trigger_characters(), context.trigger.character)
 
     -- The TriggerForIncompleteCompletions kind is handled by the source itself
     local source_context = vim.fn.deepcopy(context)
     source_context.trigger = trigger_character
-        and { kind = vim.lsp.protocol.CompletionTriggerKind.TriggerCharacter, character = context.trigger_character }
+        and { kind = vim.lsp.protocol.CompletionTriggerKind.TriggerCharacter, character = context.trigger.character }
       or { kind = vim.lsp.protocol.CompletionTriggerKind.Invoked }
 
     return source:get_completions(source_context):catch(function(err)

lua/blink/cmp/sources/lib/source.lua

@@ -3,7 +3,6 @@ local async = require('blink.cmp.sources.lib.async')
 local source = {}
 
 --- @param config blink.cmp.SourceProviderConfig
---- @return blink.cmp.SourceProvider
 function source.new(config)
   local self = setmetatable({}, { __index = source })
   self.name = config[1]
@@ -22,18 +21,16 @@ function source:get_trigger_characters()
   return self.module:get_trigger_characters()
 end
 
---- @param context blink.cmp.CompletionContext
+--- @param context blink.cmp.Context
 --- @return blink.cmp.Task
 function source:get_completions(context)
   -- Return the previous successful completions if the context is the same
   -- and the data doesn't need to be updated
   if self.last_response ~= nil and self.last_response.context.id == context.id then
     if utils.should_run_request(context, self.last_response) == false then
-      -- vim.print(self.name .. ': returning cached completions')
       return async.task.new(function(resolve) resolve(self.last_response) end)
     end
   end
-  -- vim.print(self.name .. ': running completions request')
 
   return async.task
     .new(function(resolve) return self.module:get_completions(context, resolve) end)

lua/blink/cmp/sources/lib/types.lua

@@ -2,9 +2,6 @@
 --- @field kind number
 --- @field character string | nil
 ---
---- @class blink.cmp.CompletionContext : blink.cmp.TriggerContext
---- @field trigger blink.cmp.CompletionTriggerContext | nil
----
 --- @class blink.cmp.CompletionResponse
 --- @field is_incomplete_forward boolean
 --- @field is_incomplete_backward boolean
@@ -14,19 +11,7 @@
 --- @class blink.cmp.Source
 --- @field new fun(opts: table): blink.cmp.Source
 --- @field get_trigger_characters (fun(self: blink.cmp.Source): string[]) | nil
---- @field get_completions fun(self: blink.cmp.Source, context: blink.cmp.CompletionContext, callback: fun(response: blink.cmp.CompletionResponse)): (fun(): nil) | nil
+--- @field get_completions fun(self: blink.cmp.Source, context: blink.cmp.Context, callback: fun(response: blink.cmp.CompletionResponse)): (fun(): nil) | nil
 --- @field filter_completions (fun(self: blink.cmp.Source, response: blink.cmp.CompletionResponse): blink.cmp.CompletionItem[]) | nil
 --- @field should_show_completions (fun(self: blink.cmp.Source, response: blink.cmp.CompletionResponse): boolean) | nil
 --- @field resolve (fun(self: blink.cmp.Source, item: blink.cmp.CompletionItem, callback: fun(resolved_item: lsp.CompletionItem | nil)): ((fun(): nil) | nil)) | nil
----
---- @class blink.cmp.SourceProvider
---- @field module blink.cmp.Source
---- @field config blink.cmp.SourceProviderConfig
---- @field last_context blink.cmp.CompletionContext | nil
---- @field last_response blink.cmp.CompletionResponse | nil
---- @field new fun(config: blink.cmp.SourceProviderConfig): blink.cmp.SourceProvider
---- @field get_trigger_characters (fun(self: blink.cmp.Source): string[]) | nil
---- @field get_completions fun(self: blink.cmp.Source, context: blink.cmp.CompletionContext): blink.cmp.Task
---- @field filter_completions (fun(self: blink.cmp.Source, context: blink.cmp.CompletionContext, source_responses: table<string, blink.cmp.CompletionResponse>): blink.cmp.CompletionItem[]) | nil
---- @field should_show_completions (fun(self: blink.cmp.Source, context: blink.cmp.CompletionContext, source_responses: table<string, blink.cmp.CompletionResponse>): boolean) | nil
---- @field resolve fun(self: blink.cmp.Source, item: blink.cmp.CompletionItem, callback: fun(resolved_item: lsp.CompletionItem | nil)): blink.cmp.Task

lua/blink/cmp/sources/lib/utils.lua

@@ -11,8 +11,8 @@ local utils = {}
 function utils.should_run_request(new_context, response)
   local old_context = response.context
   -- get the text for the current and queued context
-  local context_query = old_context.bounds.line:sub(old_context.bounds.start_col, old_context.bounds.end_col)
-  local queued_context_query = new_context.bounds.line:sub(new_context.bounds.start_col, new_context.bounds.end_col)
+  local context_query = old_context.line:sub(old_context.bounds.start_col, old_context.bounds.end_col)
+  local queued_context_query = new_context.line:sub(new_context.bounds.start_col, new_context.bounds.end_col)
 
   -- check if the texts are overlapping
   local is_before = vim.startswith(context_query, queued_context_query)

lua/blink/cmp/sources/lsp.lua

@@ -73,7 +73,7 @@ function lsp:get_completions(context, callback)
   local trigger_characters = self:get_trigger_characters()
   local trigger_character_block_list = { ' ', '\n', '\t' }
   local bounds = context.bounds
-  local trigger_character_before_context = bounds.line:sub(bounds.start_col - 1, bounds.start_col - 1)
+  local trigger_character_before_context = context.line:sub(bounds.start_col - 1, bounds.start_col - 1)
   if
     vim.tbl_contains(trigger_characters, trigger_character_before_context)
     and not vim.tbl_contains(trigger_character_block_list, trigger_character_before_context)

lua/blink/cmp/trigger.lua

@@ -8,29 +8,28 @@
 --- @field start_col number
 --- @field end_col number
 ---
---- @class blink.cmp.TriggerContext
+--- @class blink.cmp.Context
 --- @field id number
 --- @field bounds blink.cmp.TriggerBounds
+--- @field bufnr number
 --- @field treesitter_node table | nil
----
---- @class blink.cmp.ShowContext : blink.cmp.TriggerContext
---- @field trigger_character string | nil
+--- @field trigger { kind: number, character: string | nil }
 ---
 --- @class blink.cmp.TriggerEventTargets
---- @field on_show fun(context: blink.cmp.ShowContext)
+--- @field on_show fun(context: blink.cmp.Context)
 --- @field on_hide fun()
 ---
 --- @class blink.cmp.Trigger
---- @field context blink.cmp.TriggerContext | nil
---- @field context_last_id number
+--- @field context blink.cmp.Context | nil
+--- @field current_context_id number
 --- @field context_regex string
 --- @field event_targets blink.cmp.TriggerEventTargets
 
 local sources = require('blink.cmp.sources.lib')
 
 --- @class blink.cmp.Trigger
 local trigger = {
-  context_last_id = -1,
+  current_context_id = -1,
   context = nil,
   context_regex = '[%w_\\-]',
 
@@ -108,15 +107,23 @@ end
 function trigger.show(opts)
   opts = opts or {}
 
-  -- update context (to update bounds and treesitter node)
-  -- todo: this behavior isn't obvious
-  trigger.context = trigger.get_context()
-
-  trigger.event_targets.on_show({
-    id = trigger.context.id,
-    bounds = trigger.context.bounds,
-    trigger_character = opts.trigger_character,
-  })
+  -- update context
+  local cursor = vim.api.nvim_win_get_cursor(0)
+  if trigger.context == nil then trigger.current_context_id = trigger.current_context_id + 1 end
+  trigger.context = {
+    id = trigger.current_context_id,
+    bufnr = vim.api.nvim_get_current_buf(),
+    cursor = cursor,
+    line = vim.api.nvim_buf_get_lines(0, cursor[1] - 1, cursor[1], false)[1],
+    bounds = helpers.get_context_bounds(trigger.context_regex),
+    trigger = {
+      kind = opts.trigger_character and vim.lsp.protocol.CompletionTriggerKind.TriggerCharacter
+        or vim.lsp.protocol.CompletionTriggerKind.Invoked,
+      character = opts.trigger_character,
+    },
+  }
+
+  trigger.event_targets.on_show(trigger.context)
 end
 
 function trigger.listen_on_show(callback) trigger.event_targets.on_show = callback end
@@ -130,19 +137,7 @@ end
 
 function trigger.listen_on_hide(callback) trigger.event_targets.on_hide = callback end
 
------- Context ------
--- Gets the current context, always updating the bounds to the current position
---- @return blink.cmp.TriggerContext
-function trigger.get_context()
-  local bounds = helpers.get_query(trigger.context_regex)
-  -- local treesitter_node = helpers.get_treesitter_node_at_cursor()
-  if not trigger.context then
-    trigger.context_last_id = trigger.context_last_id + 1
-    trigger.context = { id = trigger.context_last_id, bounds = bounds }
-  end
-  return { id = trigger.context.id, bounds = bounds }
-end
-
+--- @param context blink.cmp.ShowContext | nil
 --- @param cursor number[]
 --- @return boolean
 function trigger.within_query_bounds(cursor)
@@ -163,12 +158,11 @@ end
 -- Moves forward and backwards around the cursor looking for word boundaries
 --- @param regex string
 --- @return blink.cmp.TriggerBounds
-function helpers.get_query(regex)
-  local bufnr = vim.api.nvim_get_current_buf()
+function helpers.get_context_bounds(regex)
   local cursor_line = vim.api.nvim_win_get_cursor(0)[1]
   local cursor_col = vim.api.nvim_win_get_cursor(0)[2]
 
-  local line = vim.api.nvim_buf_get_lines(bufnr, cursor_line - 1, cursor_line, false)[1]
+  local line = vim.api.nvim_buf_get_lines(0, cursor_line - 1, cursor_line, false)[1]
   local start_col = cursor_col
   while start_col > 1 do
     local char = line:sub(start_col, start_col)
@@ -186,7 +180,7 @@ function helpers.get_query(regex)
     end_col = end_col + 1
   end
 
-  return { line = line, line_number = cursor_line, start_col = start_col, end_col = end_col }
+  return { line_number = cursor_line, start_col = start_col, end_col = end_col }
 end
 
 --- @return TSNode | nil