nvim-cmp/lua/cmp/entry.lua

local cache = require('cmp.utils.cache')
local char = require('cmp.utils.char')
local misc = require('cmp.utils.misc')
local str = require('cmp.utils.str')
local config = require('cmp.config')
local types = require('cmp.types')

---@class cmp.Entry
---@field public id number
---@field public cache cmp.Cache
---@field public score number
---@field public exact boolean
---@field public context cmp.Context
---@field public source cmp.Source
---@field public source_offset number
---@field public source_insert_range lsp.Range
---@field public source_replace_range lsp.Range
---@field public completion_item lsp.CompletionItem
---@field public resolved_completion_item lsp.CompletionItem|nil
---@field public resolved_callbacks fun()[]
---@field public resolving boolean
---@field public confirmed boolean
local entry = {}

---Create new entry
---@param ctx cmp.Context
---@param source cmp.Source
---@param completion_item lsp.CompletionItem
---@return cmp.Entry
entry.new = function(ctx, source, completion_item)
  local self = setmetatable({}, { __index = entry })
  self.id = misc.id('entry')
  self.cache = cache.new()
  self.score = 0
  self.context = ctx
  self.source = source
  self.source_offset = source.offset
  self.source_insert_range = source:get_default_insert_range()
  self.source_replace_range = source:get_default_replace_range()
  self.completion_item = completion_item
  self.resolved_completion_item = nil
  self.resolved_callbacks = {}
  self.resolving = false
  self.confirmed = false
  return self
end

---Make offset value
---@return number
entry.get_offset = function(self)
  return self.cache:ensure('get_offset', function()
    local offset = self.source_offset
    if misc.safe(self.completion_item.textEdit) then
      local range = misc.safe(self.completion_item.textEdit.insert) or misc.safe(self.completion_item.textEdit.range)
      if range then
        local c = vim.str_byteindex(self.context.cursor_line, range.start.character) + 1
        for idx = c, self.source_offset do
          if not char.is_white(string.byte(self.context.cursor_line, idx)) then
            offset = math.min(offset, idx)
            break
          end
        end
      end
    else
      -- NOTE
      -- The VSCode does not implement this but it's useful if the server does not care about word patterns.
      -- We should care about this performance.
      local word = self:get_word()
      for idx = self.source_offset - 1, self.source_offset - #word, -1 do
        if char.is_semantic_index(self.context.cursor_line, idx) then
          local c = string.byte(self.context.cursor_line, idx)
          if char.is_white(c) then
            break
          end
          local match = true
          for i = 1, self.source_offset - idx do
            local c1 = string.byte(word, i)
            local c2 = string.byte(self.context.cursor_line, idx + i - 1)
            if not c1 or not c2 or c1 ~= c2 then
              match = false
              break
            end
          end
          if match then
            offset = math.min(offset, idx)
          end
        end
      end
    end
    return offset
  end)
end

---Create word for vim.CompletedItem
---@return string
entry.get_word = function(self)
  return self.cache:ensure('get_word', function()
    --NOTE: This is nvim-cmp specific implementation.
    if misc.safe(self.completion_item.word) then
      return self.completion_item.word
    end

    local word
    if misc.safe(self.completion_item.textEdit) then
      word = str.trim(self.completion_item.textEdit.newText)
      local _, after = self:get_overwrite()
      if 0 < after or self.completion_item.insertTextFormat == types.lsp.InsertTextFormat.Snippet then
        word = str.get_word(word, string.byte(self.context.cursor_after_line, 1))
      end
    elseif misc.safe(self.completion_item.insertText) then
      word = str.trim(self.completion_item.insertText)
      if self.completion_item.insertTextFormat == types.lsp.InsertTextFormat.Snippet then
        word = str.get_word(word)
      end
    else
      word = str.trim(self.completion_item.label)
    end
    return word
  end)
end

---Get overwrite information
---@return number, number
entry.get_overwrite = function(self)
  return self.cache:ensure('get_overwrite', function()
    if misc.safe(self.completion_item.textEdit) then
      local r = misc.safe(self.completion_item.textEdit.insert) or misc.safe(self.completion_item.textEdit.range)
      local s = vim.str_byteindex(self.context.cursor_line, r.start.character) + 1
      local e = vim.str_byteindex(self.context.cursor_line, r['end'].character) + 1
      local before = self.context.cursor.col - s
      local after = e - self.context.cursor.col
      return before, after
    end
    return 0, 0
  end)
end

---Create filter text
---@return string
entry.get_filter_text = function(self)
  return self.cache:ensure('get_filter_text', function()
    local word
    if misc.safe(self.completion_item.filterText) then
      word = self.completion_item.filterText
    else
      word = str.trim(self.completion_item.label)
    end

    -- @see https://github.com/clangd/clangd/issues/815
    if misc.safe(self.completion_item.textEdit) then
      local diff = self.source_offset - self:get_offset()
      if diff > 0 then
        if char.is_symbol(string.byte(self.context.cursor_line, self:get_offset())) then
          local prefix = string.sub(self.context.cursor_line, self:get_offset(), self:get_offset() + diff)
          if string.find(word, prefix, 1, true) ~= 1 then
            word = prefix .. word
          end
        end
      end
    end

    return word
  end)
end

---Get LSP's insert text
---@return string
entry.get_insert_text = function(self)
  return self.cache:ensure('get_insert_text', function()
    local word
    if misc.safe(self.completion_item.textEdit) then
      word = str.trim(self.completion_item.textEdit.newText)
      if self.completion_item.insertTextFormat == types.lsp.InsertTextFormat.Snippet then
        word = str.remove_suffix(str.remove_suffix(word, '$0'), '${0}')
      end
    elseif misc.safe(self.completion_item.insertText) then
      word = str.trim(self.completion_item.insertText)
      if self.completion_item.insertTextFormat == types.lsp.InsertTextFormat.Snippet then
        word = str.remove_suffix(str.remove_suffix(word, '$0'), '${0}')
      end
    else
      word = str.trim(self.completion_item.label)
    end
    return word
  end)
end

---Make vim.CompletedItem
---@param suggest_offset number
---@return vim.CompletedItem
entry.get_vim_item = function(self, suggest_offset)
  return self.cache:ensure({ 'get_vim_item', suggest_offset, self.resolved_completion_item and 1 or 0 }, function()
    local completion_item = self:get_completion_item()
    local word = self:get_word()
    local abbr = str.trim(completion_item.label)

    -- ~ indicator
    if #(misc.safe(completion_item.additionalTextEdits) or {}) > 0 then
      abbr = abbr .. '~'
    elseif completion_item.insertTextFormat == types.lsp.InsertTextFormat.Snippet then
      local insert_text = self:get_insert_text()
      if word ~= insert_text then
        abbr = abbr .. '~'
      end
    end

    -- deprecated
    if completion_item.deprecated or vim.tbl_contains(completion_item.tags or {}, types.lsp.CompletionItemTag.Deprecated) then
      abbr = str.strikethrough(abbr)
    end

    -- append delta text
    if suggest_offset < self:get_offset() then
      word = string.sub(self.context.cursor_before_line, suggest_offset, self:get_offset() - 1) .. word
    end

    -- labelDetails.
    local menu = nil
    if misc.safe(completion_item.labelDetails) then
      menu = ''
      if misc.safe(completion_item.labelDetails.parameters) then
        menu = menu .. completion_item.labelDetails.parameters
      end
      if misc.safe(completion_item.labelDetails.type) then
        menu = menu .. completion_item.labelDetails.type
      end
      if misc.safe(completion_item.labelDetails.qualifier) then
        menu = menu .. completion_item.labelDetails.qualifier
      end
    end

    -- remove duplicated string.
    for i = 1, #word - 1 do
      if str.has_prefix(self.context.cursor_after_line, string.sub(word, i, #word)) then
        word = string.sub(word, 1, i - 1)
        break
      end
    end

    local vim_item = {
      word = word,
      abbr = abbr,
      kind = types.lsp.CompletionItemKind[self:get_kind()] or types.lsp.CompletionItemKind[1],
      menu = menu,
    }
    if config.get().formatting.format then
      vim_item = config.get().formatting.format(self, vim_item)
    end
    vim_item.equal = 1
    vim_item.empty = 1
    vim_item.dup = self.completion_item.dup or 1
    vim_item.user_data = { cmp = self.id }

    return vim_item
  end)
end

---Get commit characters
---@return string[]
entry.get_commit_characters = function(self)
  return misc.safe(self:get_completion_item().commitCharacters) or {}
end

---Return insert range
---@return lsp.Range|nil
entry.get_insert_range = function(self)
  local insert_range
  if misc.safe(self.completion_item.textEdit) then
    if misc.safe(self.completion_item.textEdit.insert) then
      insert_range = self.completion_item.textEdit.insert
    else
      insert_range = self.completion_item.textEdit.range
    end
  else
    insert_range = {
      start = {
        line = self.context.cursor.row - 1,
        character = math.min(vim.str_utfindex(self.context.cursor_line, self:get_offset() - 1), self.source_insert_range.start.character),
      },
      ['end'] = self.source_insert_range['end'],
    }
  end
  return insert_range
end

---Return replace range
---@return lsp.Range|nil
entry.get_replace_range = function(self)
  return self.cache:ensure('get_replace_range', function()
    local replace_range
    if misc.safe(self.completion_item.textEdit) then
      if misc.safe(self.completion_item.textEdit.replace) then
        replace_range = self.completion_item.textEdit.replace
      else
        replace_range = self.completion_item.textEdit.range
      end
    else
      replace_range = {
        start = {
          line = self.source_replace_range.start.line,
          character = math.min(vim.str_utfindex(self.context.cursor_line, self:get_offset() - 1), self.source_replace_range.start.character),
        },
        ['end'] = self.source_replace_range['end'],
      }
    end
    return replace_range
  end)
end

---Get resolved completion item if possible.
---@return lsp.CompletionItem
entry.get_completion_item = function(self)
  if self.resolved_completion_item then
    return self.resolved_completion_item
  end
  return self.completion_item
end

---Create documentation
---@return string
entry.get_documentation = function(self)
  local item = self:get_completion_item()

  local documents = {}

  -- detail
  if misc.safe(item.detail) and item.detail ~= '' then
    table.insert(documents, {
      kind = types.lsp.MarkupKind.Markdown,
      value = ('```%s\n%s\n```'):format(self.context.filetype, str.trim(item.detail)),
    })
  end

  if type(item.documentation) == 'string' and item.documentation ~= '' then
    table.insert(documents, {
      kind = types.lsp.MarkupKind.PlainText,
      value = str.trim(item.documentation),
    })
  elseif type(item.documentation) == 'table' and item.documentation.value ~= '' then
    table.insert(documents, item.documentation)
  end

  return vim.lsp.util.convert_input_to_markdown_lines(documents)
end

---Get completion item kind
---@return lsp.CompletionItemKind
entry.get_kind = function(self)
  return misc.safe(self.completion_item.kind) or types.lsp.CompletionItemKind.Text
end

---Execute completion item's command.
---@param callback fun()
entry.execute = function(self, callback)
  self.source:execute(self:get_completion_item(), callback)
end

---Resolve completion item.
---@param callback fun()
entry.resolve = function(self, callback)
  if self.resolved_completion_item then
    return callback()
  end
  table.insert(self.resolved_callbacks, callback)

  if not self.resolving then
    self.resolving = true
    self.source:resolve(self.completion_item, function(completion_item)
      self.resolved_completion_item = misc.safe(completion_item) or self.completion_item
      for _, c in ipairs(self.resolved_callbacks) do
        c()
      end
    end)
  end
end

return entry