feat: add basic event trigger API (#31)

* Add basic event trigger API

* Update to check cmp.windows.autocomplete for if the menu is open or closed.

* Revert trigger changes

Author: dsully

README.md

@@ -348,9 +348,9 @@ The plugin use a 4 stage pipeline: trigger -> sources -> fuzzy -> render
 
     **Filtering:** The fuzzy matching uses smith-waterman, same as FZF, but implemented in SIMD for ~6x the performance of FZF (todo: add benchmarks). Due to the SIMD's performance, the prefiltering phase on FZF was dropped to allow for typos. Similar to fzy/fzf, additional points are given to prefix matches, characters with capitals (to promote camelCase/PascalCase first char matching) and matches after delimiters (to promote snake_case first char matching)
 
-    **Sorting:** Combines fuzzy matching score with frecency and proximity bonus. Each completion item may also include a `score_offset` which will be added to this score to demote certain sources. The `snippets` source takes advantage of this to avoid taking presedence over the LSP source. The paramaters here still need to be tuned, so please let me know if you find some magical parameters!
+    **Sorting:** Combines fuzzy matching score with frecency and proximity bonus. Each completion item may also include a `score_offset` which will be added to this score to demote certain sources. The `snippets` source takes advantage of this to avoid taking precedence over the LSP source. The parameters here still need to be tuned, so please let me know if you find some magical parameters!
 
-**Windows:** Responsible for placing the autocomplete, documentation and function parameters windows. All of the rendering can be overriden following a syntax similar to incline.nvim. It uses the neovim window decoration provider to provide next to no overhead from highlighting.
+**Windows:** Responsible for placing the autocomplete, documentation and function parameters windows. All of the rendering can be overridden following a syntax similar to incline.nvim. It uses the neovim window decoration provider to provide next to no overhead from highlighting.
 
 ## Compared to nvim-cmp
 

lua/blink/cmp/fuzzy/init.lua

@@ -1,29 +1,42 @@
 local config = require('blink.cmp.config').fuzzy
 
 local fuzzy = {
+  ---@type blink.cmp.Context?
+  last_context = nil,
+  ---@type blink.cmp.CompletionItem[]?
+  last_items = nil,
   rust = require('blink.cmp.fuzzy.ffi'),
 }
 
+---@param db_path string
 function fuzzy.init_db(db_path)
   fuzzy.rust.init_db(db_path)
 
   vim.api.nvim_create_autocmd('VimLeavePre', {
-    callback = function() fuzzy.rust.destroy_db() end,
+    callback = fuzzy.rust.destroy_db,
   })
 
   return fuzzy
 end
 
+---@param item blink.cmp.CompletionItem
 function fuzzy.access(item) fuzzy.rust.access(item) end
 
+---@param lines string
 function fuzzy.get_words(lines) return fuzzy.rust.get_words(lines) end
 
+---@param needle string
+---@param items blink.cmp.CompletionItem[]?
+---@return blink.cmp.CompletionItem[]
 function fuzzy.filter_items(needle, items)
   -- convert to table of strings
   local haystack_labels = {}
   local haystack_score_offsets = {}
   local haystack_kinds = {}
   local haystack_sources = {}
+
+  items = items or {}
+
   for _, item in ipairs(items) do
     table.insert(haystack_labels, item.label)
     table.insert(haystack_score_offsets, item.score_offset or 0)
@@ -60,6 +73,9 @@ function fuzzy.filter_items(needle, items)
   return filtered_items
 end
 
+---@param needle string
+---@param context blink.cmp.Context
+---@param items blink.cmp.CompletionItem[]?
 function fuzzy.filter_items_with_cache(needle, context, items)
   if items == nil then
     if fuzzy.last_context == nil or fuzzy.last_context.id ~= context.id then return {} end

lua/blink/cmp/init.lua

@@ -129,6 +129,12 @@ cmp.hide = function()
   return true
 end
 
+--- @param callback fun(context: blink.cmp.Context)
+cmp.on_open = function(callback) cmp.windows.autocomplete.listen_on_open(callback) end
+
+--- @param callback fun()
+cmp.on_close = function(callback) cmp.windows.autocomplete.listen_on_close(callback) end
+
 cmp.accept = function()
   local item = cmp.windows.autocomplete.get_selected_item()
   if item == nil then return end

lua/blink/cmp/sources/buffer.lua

@@ -4,6 +4,7 @@
 
 local uv = vim.uv
 
+---@return string
 local function get_buf_text()
   local bufnr = vim.api.nvim_get_current_buf()
   local lines = vim.api.nvim_buf_get_lines(bufnr, 0, -1, false)
@@ -45,6 +46,8 @@ local function words_to_items(words)
   return items
 end
 
+--- @param buf_text string
+--- @param callback fun(items: blink.cmp.CompletionItem[])
 local function run_sync(buf_text, callback) callback(words_to_items(require('blink.cmp.fuzzy').get_words(buf_text))) end
 
 local function run_async(buf_text, callback)

lua/blink/cmp/trigger/completion.lua

@@ -154,6 +154,7 @@ function trigger.hide()
   if not trigger.context then return end
 
   trigger.context = nil
+
   trigger.event_targets.on_hide()
 end
 

lua/blink/cmp/windows/autocomplete.lua

@@ -9,13 +9,19 @@ local config = require('blink.cmp.config')
 local renderer = require('blink.cmp.windows.lib.render')
 local autocmp_config = config.windows.autocomplete
 local autocomplete = {
+  ---@type blink.cmp.CompletionItem[]
   items = {},
   has_selected = nil,
+  ---@type blink.cmp.Context?
   context = nil,
   event_targets = {
     on_position_update = {},
+    --- @type fun(item: blink.cmp.CompletionItem?, context: blink.cmp.Context)
     on_select = function() end,
-    on_close = function() end,
+    --- @type table<fun()>
+    on_close = {},
+    --- @type table<fun()>
+    on_open = {},
   },
 }
 
@@ -55,11 +61,15 @@ end
 
 ---------- Visibility ----------
 
+--- @param context blink.cmp.Context
+--- @param items blink.cmp.CompletionItem[]
 function autocomplete.open_with_items(context, items)
   autocomplete.context = context
   autocomplete.items = items
   autocomplete.draw()
 
+  vim.iter(autocomplete.event_targets.on_open):each(function(callback) callback() end)
+
   autocomplete.win:open()
 
   autocomplete.context = context
@@ -73,6 +83,7 @@ end
 
 function autocomplete.open()
   if autocomplete.win:is_open() then return end
+  vim.iter(autocomplete.event_targets.on_open):each(function(callback) callback() end)
   autocomplete.win:open()
   autocomplete.set_has_selected(autocmp_config.preselect)
 end
@@ -81,9 +92,19 @@ function autocomplete.close()
   if not autocomplete.win:is_open() then return end
   autocomplete.win:close()
   autocomplete.has_selected = autocmp_config.preselect
-  autocomplete.event_targets.on_close()
+
+  vim.iter(autocomplete.event_targets.on_close):each(function(callback) callback() end)
 end
-function autocomplete.listen_on_close(callback) autocomplete.event_targets.on_close = callback end
+
+--- Add a listener for when the autocomplete window closes
+--- @param callback fun()
+function autocomplete.listen_on_close(callback) table.insert(autocomplete.event_targets.on_close, callback) end
+
+--- Add a listener for when the autocomplete window opens
+--- This is useful for hiding GitHub Copilot ghost text and similar functionality.
+---
+--- @param callback fun()
+function autocomplete.listen_on_open(callback) table.insert(autocomplete.event_targets.on_open, callback) end
 
 --- @param context blink.cmp.Context
 --- TODO: Don't switch directions if the context is the same
@@ -203,7 +224,7 @@ function autocomplete.draw()
         kind = kind,
         kind_icon = kind_icon,
         icon_gap = icon_gap,
-        deprecated = item.deprecated or (item.tags and vim.tbl_contains(item.tags, 1)),
+        deprecated = item.deprecated or (item.tags and vim.tbl_contains(item.tags, 1)) or false,
       })
     )
   end
@@ -264,6 +285,7 @@ function autocomplete.render_item_reversed(ctx)
   }
 end
 
+---@return blink.cmp.CompletionItem?
 function autocomplete.get_selected_item()
   if not autocomplete.win:is_open() then return end
   if not autocomplete.has_selected then return end