refactor: move manager to a different file

Author: haorenW1025

autoload/completion.vim

@@ -1,6 +1,6 @@
 " Perform a Hack to confirm completion
 function! completion#completion_confirm() abort
-    lua require'completion'.toggleConfirm()
+    lua require'completion'.confirmCompletion()
     call nvim_feedkeys("\<C-Y>", "n", v:true)
 endfunction
 

lua/completion.lua

@@ -5,38 +5,54 @@ local source = require 'completion.source'
 local signature = require'completion.signature_help'
 local hover = require'completion.hover'
 local opt = require'completion.option'
+local manager = require'completion.manager'
 local M = {}
 
+
 ------------------------------------------------------------------------
---                           local function                           --
+--                          external commands                         --
 ------------------------------------------------------------------------
 
-M.completionConfirm = false
-
--- Manager variable to keep all state accross completion
-local manager = {
-  -- Handle insertCharPre event, turn off imediately when preforming completion
-  insertChar = false,
-  -- Handle insertLeave event
-  insertLeave = false,
-  -- Handle auto hover
-  textHover = false,
-  -- Handle selected items in v:complete-items for auto hover
-  selected = -1,
-  -- Handle changeTick
-  changedTick = 0,
-  -- handle auto changing source
-  changeSource = false,
-  autoChange = false
-}
+M.insertCompletionItems = function(completed_items, prefix, item)
+  match.matching(completed_items, prefix, item)
+end
+
+M.addCompletionSource = function(key, completed_item)
+  source.addCompleteItems(key, completed_item)
+end
+
+M.nextSource = function()
+  source.nextCompletion()
+end
+
+M.prevSource = function()
+  source.prevCompletion()
+end
+
+M.triggerCompletion = function()
+  source.triggerCompletion(true, manager)
+end
+
+M.completionToggle = function()
+  local enable = api.nvim_call_function('completion#get_buffer_variable', {'completion_enable'})
+  if enable == nil then
+    M.on_attach()
+  elseif enable == 0 then
+    api.nvim_buf_set_var(0, 'completion_enable', 1)
+  else
+    api.nvim_buf_set_var(0, 'completion_enable', 0)
+  end
+end
+
 
 ------------------------------------------------------------------------
---                          member function                           --
+--                         confirm completion                         --
 ------------------------------------------------------------------------
 
-function M.autoAddParens(complete_item)
-  if complete_item.kind == nil then return end
-  if string.match(complete_item.kind, '.*Function.*') ~= nil or string.match(complete_item.kind, '.*Method.*') then
+-- I want to deprecate this...
+local function autoAddParens(completed_item)
+  if completed_item.kind == nil then return end
+  if string.match(completed_item.kind, '.*Function.*') ~= nil or string.match(completed_item.kind, '.*Method.*') then
     api.nvim_input("()<left>")
   end
 end
@@ -45,86 +61,89 @@ end
 -- confirmCompletion is now triggered by CompleteDone autocmd to solve issue with noselect
 -- Will cause snippets to expand with not pressing confirm key
 -- Add a flag completionConfirm to avoid this issue
-function M.toggleConfirm()
-  M.completionConfirm = true
+function M.confirmCompletion(completed_item)
+  manager.confirmedCompletion = true
 end
 
-function M.confirmCompletion()
-  if M.completionConfirm == true then
-    local complete_item = api.nvim_get_vvar('completed_item')
-    local lnum, _ = unpack(api.nvim_win_get_cursor(0))
-    if complete_item.user_data.lsp ~= nil then
-      local item = complete_item.user_data.lsp.completion_item
-      if vim.fn.exists('g:loaded_vsnip_integ') == 1 then
-        api.nvim_call_function('vsnip_integ#do_complete_done', {
-          {
-            completed_item = complete_item,
-            completion_item = item,
-            apply_additional_text_edits = true
-          }
-        })
-      else
-        if item.additionalTextEdits then
-          local bufnr = api.nvim_get_current_buf()
-          local edits = vim.tbl_filter(
-            function(x) return x.range.start.line ~= (lnum - 1) end,
-            item.additionalTextEdits
-          )
-          vim.lsp.util.apply_text_edits(edits, bufnr)
-        end
+-- apply additionalTextEdits in LSP specs
+local function applyAddtionalTextEdits(completed_item)
+  local lnum = api.nvim_win_get_cursor(0)[0]
+  if completed_item.user_data.lsp ~= nil then
+    local item = completed_item.user_data.lsp.completion_item
+    -- vim-vsnip have better additional text edits...
+    if vim.fn.exists('g:loaded_vsnip_integ') == 1 then
+      api.nvim_call_function('vsnip_integ#do_complete_done', {
+        {
+          completed_item = completed_item,
+          completion_item = item,
+          apply_additional_text_edits = true
+        }
+      })
+    else
+      if item.additionalTextEdits then
+        local bufnr = api.nvim_get_current_buf()
+        local edits = vim.tbl_filter(
+          function(x) return x.range.start.line ~= (lnum - 1) end,
+          item.additionalTextEdits
+        )
+        vim.lsp.util.apply_text_edits(edits, bufnr)
       end
     end
+  end
+end
 
-    if opt.get_option('enable_auto_paren') == 1 then
-      M.autoAddParens(complete_item)
-    end
-    if complete_item.kind == 'UltiSnips' then
-      api.nvim_call_function('UltiSnips#ExpandSnippet', {})
-    elseif complete_item.kind == 'Neosnippet' then
-      api.nvim_input("<c-r>".."=neosnippet#expand('"..complete_item.word.."')".."<CR>")
-    elseif complete_item.kind == 'vim-vsnip' then
-      api.nvim_call_function('vsnip#expand', {})
-    end
-    M.completionConfirm = false
+-- handle completeDone stuff here
+local function hasConfirmedCompletion()
+  local completed_item = api.nvim_get_vvar('completed_item')
+  if completed_item.user_data.lsp ~= nil then
+    applyAddtionalTextEdits(completed_item)
   end
-  if hover.winnr ~= nil and api.nvim_win_is_valid(hover.winnr) then
-    api.nvim_win_close(hover.winnr, true)
+  if opt.get_option('enable_auto_paren') == 1 then
+    autoAddParens(completed_item)
+  end
+  if completed_item.kind == 'UltiSnips' then
+    api.nvim_call_function('UltiSnips#ExpandSnippet', {})
+  elseif completed_item.kind == 'Neosnippet' then
+    api.nvim_input("<c-r>".."=neosnippet#expand('"..completed_item.word.."')".."<CR>")
+  elseif completed_item.kind == 'vim-vsnip' then
+    api.nvim_call_function('vsnip#expand', {})
   end
 end
 
+------------------------------------------------------------------------
+--                            autocommands                            --
+------------------------------------------------------------------------
 
 function M.on_InsertCharPre()
   manager.insertChar = true
   manager.textHover = true
   manager.selected = -1
-  if opt.get_option('auto_change_source') == 1 then
-    manager.autoChange = true
-  end
 end
 
 function M.on_InsertLeave()
   manager.insertLeave = true
 end
 
+-- TODO: need further refactor, very messy now:(
 function M.on_InsertEnter()
   local enable = api.nvim_call_function('completion#get_buffer_variable', {'completion_enable'})
   if enable == nil or enable == 0 then
     return
   end
   local timer = vim.loop.new_timer()
   -- setup variable
-  manager.changedTick = api.nvim_buf_get_changedtick(0)
-  manager.insertLeave = false
-  manager.insertChar = false
-  manager.changeSource = false
+  manager.init()
+
+  -- TODO: remove this
+  local autoChange = false
   if opt.get_option('auto_change_source') == 1 then
-    manager.autoChange = true
+    autoChange = true
   end
 
   -- reset source
-  source.chain_complete_index = 1
+  manager.chainIndex = 1
   source.stop_complete = false
-  local l_complete_index = source.chain_complete_index
+  local l_complete_index = manager.chainIndex
   local timer_cycle = opt.get_option('timer_cycle')
 
   timer:start(100, timer_cycle, vim.schedule_wrap(function()
@@ -133,7 +152,7 @@ function M.on_InsertEnter()
     if l_changedTick ~= manager.changedTick then
       manager.changedTick = l_changedTick
       if opt.get_option('enable_auto_popup') == 1 then
-        source.autoCompletion(manager)
+        source.autoCompletion()
       end
       if opt.get_option('enable_auto_hover') == 1 then
         hover.autoOpenHoverInPopup(manager)
@@ -143,25 +162,25 @@ function M.on_InsertEnter()
       end
     end
     -- change source if no item is available
-    if manager.changeSource and manager.autoChange then
+    if manager.changeSource and autoChange then
       manager.changeSource = false
-      if source.chain_complete_index ~= source.chain_complete_length then
-        source.chain_complete_index = source.chain_complete_index + 1
-        l_complete_index = source.chain_complete_index
+      if manager.chainIndex ~= source.chain_complete_length then
+        manager.chainIndex = manager.chainIndex + 1
+        l_complete_index = manager.chainIndex
         manager.insertChar = true
         source.triggerCompletion(false, manager)
       else
         source.stop_complete = true
       end
     end
     -- force trigger completion when manaully chaging source
-    if l_complete_index ~= source.chain_complete_index then
+    if l_complete_index ~= manager.chainIndex then
       -- force clear completion
       if vim.api.nvim_get_mode()['mode'] == 'i' or vim.api.nvim_get_mode()['mode'] == 'ic' then
         vim.fn.complete(vim.api.nvim_win_get_cursor(0)[2], {})
       end
       source.triggerCompletion(false, manager)
-      l_complete_index = source.chain_complete_index
+      l_complete_index = manager.chainIndex
     end
     -- closing timer if leaving insert mode
     if manager.insertLeave == true and timer:is_closing() == false then
@@ -171,40 +190,15 @@ function M.on_InsertEnter()
   end))
 end
 
-M.triggerCompletion = function()
-  source.triggerCompletion(true, manager)
-end
-
-M.completionToggle = function()
-  local enable = api.nvim_call_function('completion#get_buffer_variable', {'completion_enable'})
-  if enable == nil then
-    M.on_attach()
-  elseif enable == 0 then
-    api.nvim_buf_set_var(0, 'completion_enable', 1)
-  else
-    api.nvim_buf_set_var(0, 'completion_enable', 0)
+-- handle completion confirmation and dismiss hover popup
+function M.on_CompleteDone()
+  if manager.confirmedCompletion then
+    manager.confirmedCompletion = false
+    hasConfirmedCompletion()
+  end
+  if hover.winnr ~= nil and api.nvim_win_is_valid(hover.winnr) then
+    api.nvim_win_close(hover.winnr, true)
   end
-end
-
--- Deprecated
-M.customize_buf_label = function(label)
-  api.nvim_buf_set_var(0, "completion_buf_customize_lsp_label", label)
-end
-
-M.insertCompletionItems = function(complete_items, prefix, item)
-  match.matching(complete_items, prefix, item)
-end
-
-M.addCompletionSource = function(key, complete_item)
-  source.addCompleteItems(key, complete_item)
-end
-
-M.nextSource = function()
-  source.nextCompletion()
-end
-
-M.prevSource = function()
-  source.prevCompletion()
 end
 
 M.on_attach = function(option)
@@ -217,7 +211,7 @@ M.on_attach = function(option)
     api.nvim_command("autocmd InsertEnter <buffer> lua require'completion'.on_InsertEnter()")
     api.nvim_command("autocmd InsertLeave <buffer> lua require'completion'.on_InsertLeave()")
     api.nvim_command("autocmd InsertCharPre <buffer> lua require'completion'.on_InsertCharPre()")
-    api.nvim_command("autocmd CompleteDone <buffer> lua require'completion'.confirmCompletion()")
+    api.nvim_command("autocmd CompleteDone <buffer> lua require'completion'.on_CompleteDone()")
   api.nvim_command("augroup end")
   if string.len(opt.get_option('confirm_key')) ~= 0 then
     api.nvim_buf_set_keymap(0, 'i', opt.get_option('confirm_key'),

lua/completion/complete.lua

@@ -5,6 +5,7 @@ local ins = require 'completion.source.ins_complete'
 local match = require'completion.matching'
 local lsp = require'completion.source.lsp'
 local opt = require 'completion.option'
+local manager = require 'completion.manager'
 
 local M = {}
 
@@ -34,12 +35,12 @@ M.clearCache = function()
 end
 
 -- perform completion
-M.performComplete = function(complete_source, complete_items_map, manager, params)
+M.performComplete = function(complete_source, complete_items_map, params)
 
   manager.insertChar = false
   if vim.fn.has_key(complete_source, "mode") > 0 then
     -- ins-complete source
-    ins.triggerCompletion(manager, complete_source.mode)
+    ins.triggerCompletion(complete_source.mode)
   elseif vim.fn.has_key(complete_source, "complete_items") > 0 then
     local callback_array = {}
     local items_array = {}
@@ -57,6 +58,8 @@ M.performComplete = function(complete_source, complete_items_map, manager, param
           table.insert(callback_array, true)
         else
           table.insert(callback_array, complete_items.callback)
+          -- TODO: still pass in manager here because there's external sources using it
+          -- will remove it when refactoring aysnc sources
           complete_items.trigger(manager, params)
         end
         table.insert(items_array, complete_items.item)

lua/completion/hover.lua

@@ -3,6 +3,7 @@ local vim = vim
 local validate = vim.validate
 local api = vim.api
 local opt = require 'completion.option'
+local manager = require 'completion.manager'
 
 local M = {}
 
@@ -298,7 +299,7 @@ local function callback_function(_, method, result)
   end
 end
 
-M.autoOpenHoverInPopup = function(manager)
+M.autoOpenHoverInPopup = function()
   if vim.fn.pumvisible() ~= 1 then return end
   for _, client in pairs(vim.lsp.buf_get_clients(0)) do
     local default_callback = client.config.callbacks['textDocument/hover'] or vim.lsp.callbacks['textDocument/hover']