Move everything to buf & default_callbacks

- Rename builtin_callbacks to default_callbacks and slightly change its
semantics:
  - No longer contains the default implementations. Instead, any
  default_callbacks will be used in preference for our .buf methods.
  - Add this to the docs.

1 files changed, 0 insertions, 344 deletions

diff --git a/runtime/lua/vim/lsp/builtin_callbacks.lua b/runtime/lua/vim/lsp/builtin_callbacks.lua
deleted file mode 100644
index 2229547f20..0000000000
--- a/runtime/lua/vim/lsp/builtin_callbacks.lua
+++ /dev/null
@@ -1,344 +0,0 @@
---- Implements the following default callbacks:
---
--- vim.api.nvim_buf_set_lines(0, 0, 0, false, vim.tbl_keys(vim.lsp.builtin_callbacks))
---
-
--- textDocument/completion
--- textDocument/declaration
--- textDocument/definition
--- textDocument/hover
--- textDocument/implementation
--- textDocument/publishDiagnostics
--- textDocument/rename
--- textDocument/signatureHelp
--- textDocument/typeDefinition
--- TODO codeLens/resolve
--- TODO completionItem/resolve
--- TODO documentLink/resolve
--- TODO textDocument/codeAction
--- TODO textDocument/codeLens
--- TODO textDocument/documentHighlight
--- TODO textDocument/documentLink
--- TODO textDocument/documentSymbol
--- TODO textDocument/formatting
--- TODO textDocument/onTypeFormatting
--- TODO textDocument/rangeFormatting
--- TODO textDocument/references
--- window/logMessage
--- window/showMessage
-
-local log = require 'vim.lsp.log'
-local protocol = require 'vim.lsp.protocol'
-local util = require 'vim.lsp.util'
-local api = vim.api
-
-local function split_lines(value)
-  return vim.split(value, '\n', true)
-end
-
-local builtin_callbacks = {}
-
--- textDocument/completion
--- https://microsoft.github.io/language-server-protocol/specification#textDocument_completion
-builtin_callbacks['textDocument/completion'] = function(_, _, result)
-  if not result or vim.tbl_isempty(result) then
-    return
-  end
-  local pos = api.nvim_win_get_cursor(0)
-  local row, col = pos[1], pos[2]
-  local line = assert(api.nvim_buf_get_lines(0, row-1, row, false)[1])
-  local line_to_cursor = line:sub(col+1)
-
-  local matches = util.text_document_completion_list_to_complete_items(result, line_to_cursor)
-  local match_result = vim.fn.matchstrpos(line_to_cursor, '\\k\\+$')
-  local match_start, match_finish = match_result[2], match_result[3]
-
-  vim.fn.complete(col + 1 - (match_finish - match_start), matches)
-end
-
--- textDocument/rename
-builtin_callbacks['textDocument/rename'] = function(_, _, result)
-  if not result then return end
-  util.workspace_apply_workspace_edit(result)
-end
-
-builtin_callbacks['textDocument/publishDiagnostics'] = function(_, _, result)
-  if not result then return end
-  local uri = result.uri
-  local bufnr = vim.uri_to_bufnr(uri)
-  if not bufnr then
-    api.nvim_err_writeln(string.format("LSP.publishDiagnostics: Couldn't find buffer for %s", uri))
-    return
-  end
-  util.buf_clear_diagnostics(bufnr)
-  util.buf_diagnostics_save_positions(bufnr, result.diagnostics)
-  util.buf_diagnostics_underline(bufnr, result.diagnostics)
-  util.buf_diagnostics_virtual_text(bufnr, result.diagnostics)
-  -- util.buf_loclist(bufnr, result.diagnostics)
-end
-
-local function focusable_popup()
-  local popup_win
-  return function(winnr)
-    if popup_win and api.nvim_win_is_valid(popup_win) then
-      if api.nvim_get_current_win() == popup_win then
-        api.nvim_command("wincmd p")
-      else
-        api.nvim_set_current_win(popup_win)
-      end
-      return
-    end
-    popup_win = winnr
-  end
-end
-
-local hover_popup = focusable_popup()
-
-local function trim_empty_lines(lines)
-  local result = {}
-  for _, line in ipairs(lines) do
-    if #line > 0 then
-      table.insert(result, line)
-    end
-  end
-  return result
-end
-
--- Accepts markdown lines and tries to reduce it to a filetype if it is
--- just a single code block.
-local function try_trim_code_blocks(lines)
-  local language_id = lines[1]:match("^```(.*)")
-  if language_id then
-    local has_inner_code_fence = false
-    for i = 2, (#lines - 1) do
-      local line = lines[i]
-      if line:sub(1,3) == '```' then
-        has_inner_code_fence = true
-        break
-      end
-    end
-    -- No inner code fences + starting with code fence = hooray.
-    if not has_inner_code_fence then
-      table.remove(lines, 1)
-      table.remove(lines)
-      return lines, language_id
-    end
-  end
-  return lines, 'markdown'
-end
-
--- textDocument/hover
--- https://microsoft.github.io/language-server-protocol/specification#textDocument_hover
--- @params MarkedString | MarkedString[] | MarkupContent
-builtin_callbacks['textDocument/hover'] = function(_, _, result)
-  if result == nil or vim.tbl_isempty(result) then
-    return
-  end
-
-  if result.contents ~= nil then
-    local markdown_lines = util.convert_input_to_markdown_lines(result.contents)
-    markdown_lines = trim_empty_lines(markdown_lines)
-    if vim.tbl_isempty(markdown_lines) then
-      markdown_lines = { 'No information available' }
-    end
-    local _, winnr = util.open_floating_preview(try_trim_code_blocks(markdown_lines))
-    hover_popup(winnr)
-  end
-end
-
-builtin_callbacks['textDocument/peekDefinition'] = function(_, _, result)
-  if result == nil or vim.tbl_isempty(result) then return end
-  -- TODO(ashkan) what to do with multiple locations?
-  result = result[1]
-  local bufnr = vim.uri_to_bufnr(result.uri)
-  assert(bufnr)
-  local start = result.range.start
-  local finish = result.range["end"]
-  util.open_floating_peek_preview(bufnr, start, finish, { offset_x = 1 })
-  util.open_floating_preview({"*Peek:*", string.rep(" ", finish.character - start.character + 1) }, 'markdown', { offset_y = -(finish.line - start.line) })
-end
-
---- Convert SignatureHelp response to preview contents.
--- https://microsoft.github.io/language-server-protocol/specifications/specification-3-14/#textDocument_signatureHelp
-local function signature_help_to_preview_contents(input)
-  if not input.signatures then
-    return
-  end
-  --The active signature. If omitted or the value lies outside the range of
-  --`signatures` the value defaults to zero or is ignored if `signatures.length
-  --=== 0`. Whenever possible implementors should make an active decision about
-  --the active signature and shouldn't rely on a default value.
-  local contents = {}
-  local active_signature = input.activeSignature or 0
-  -- If the activeSignature is not inside the valid range, then clip it.
-  if active_signature >= #input.signatures then
-    active_signature = 0
-  end
-  local signature = input.signatures[active_signature + 1]
-  if not signature then
-    return
-  end
-  vim.list_extend(contents, split_lines(signature.label))
-  if signature.documentation then
-    util.convert_input_to_markdown_lines(signature.documentation, contents)
-  end
-  if input.parameters then
-    local active_parameter = input.activeParameter or 0
-    -- If the activeParameter is not inside the valid range, then clip it.
-    if active_parameter >= #input.parameters then
-      active_parameter = 0
-    end
-    local parameter = signature.parameters and signature.parameters[active_parameter]
-    if parameter then
-      --[=[
-      --Represents a parameter of a callable-signature. A parameter can
-      --have a label and a doc-comment.
-      interface ParameterInformation {
-        --The label of this parameter information.
-        --
-        --Either a string or an inclusive start and exclusive end offsets within its containing
-        --signature label. (see SignatureInformation.label). The offsets are based on a UTF-16
-        --string representation as `Position` and `Range` does.
-        --
-        --*Note*: a label of type string should be a substring of its containing signature label.
-        --Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`.
-        label: string | [number, number];
-        --The human-readable doc-comment of this parameter. Will be shown
-        --in the UI but can be omitted.
-        documentation?: string | MarkupContent;
-      }
-      --]=]
-      -- TODO highlight parameter
-      if parameter.documentation then
-        util.convert_input_to_markdown_lines(parameter.documentation, contents)
-      end
-    end
-  end
-  return contents
-end
-
--- textDocument/signatureHelp
--- https://microsoft.github.io/language-server-protocol/specification#textDocument_signatureHelp
-builtin_callbacks['textDocument/signatureHelp'] = function(_, _, result)
-  if result == nil or vim.tbl_isempty(result) then
-    return
-  end
-
-  -- TODO show empty popup when signatures is empty?
-  if #result.signatures > 0 then
-    local markdown_lines = signature_help_to_preview_contents(result)
-    if vim.tbl_isempty(markdown_lines) then
-      markdown_lines = { 'No signature available' }
-    end
-    util.open_floating_preview(markdown_lines, 'markdown')
-  end
-end
-
-local function update_tagstack()
-  local bufnr = api.nvim_get_current_buf()
-  local line = vim.fn.line('.')
-  local col = vim.fn.col('.')
-  local tagname = vim.fn.expand('<cWORD>')
-  local item = { bufnr = bufnr, from = { bufnr, line, col, 0 }, tagname = tagname }
-  local winid = vim.fn.win_getid()
-  local tagstack = vim.fn.gettagstack(winid)
-
-  local action
-
-  if tagstack.length == tagstack.curidx then
-    action = 'r'
-    tagstack.items[tagstack.curidx] = item
-  elseif tagstack.length > tagstack.curidx then
-    action = 'r'
-    if tagstack.curidx > 1 then
-      tagstack.items = table.insert(tagstack.items[tagstack.curidx - 1], item)
-    else
-      tagstack.items = { item }
-    end
-  else
-    action = 'a'
-    tagstack.items = { item }
-  end
-
-  tagstack.curidx = tagstack.curidx + 1
-  vim.fn.settagstack(winid, tagstack, action)
-end
-
-local function handle_location(result)
-  -- We can sometimes get a list of locations, so set the first value as the
-  -- only value we want to handle
-  -- TODO(ashkan) was this correct^? We could use location lists.
-  if result[1] ~= nil then
-    result = result[1]
-  end
-  if result.uri == nil then
-    api.nvim_err_writeln('[LSP] Could not find a valid location')
-    return
-  end
-  local result_file = vim.uri_to_fname(result.uri)
-  local bufnr = vim.fn.bufadd(result_file)
-  update_tagstack()
-  api.nvim_set_current_buf(bufnr)
-  local start = result.range.start
-  api.nvim_win_set_cursor(0, {start.line + 1, start.character})
-end
-
-local function location_callback(_, method, result)
-  if result == nil or vim.tbl_isempty(result) then
-    local _ = log.info() and log.info(method, 'No location found')
-    return nil
-  end
-  handle_location(result)
-  return true
-end
-
-local location_callbacks = {
-  -- https://microsoft.github.io/language-server-protocol/specification#textDocument_declaration
-  'textDocument/declaration';
-  -- https://microsoft.github.io/language-server-protocol/specification#textDocument_definition
-  'textDocument/definition';
-  -- https://microsoft.github.io/language-server-protocol/specification#textDocument_implementation
-  'textDocument/implementation';
-  -- https://microsoft.github.io/language-server-protocol/specification#textDocument_typeDefinition
-  'textDocument/typeDefinition';
-}
-
-for _, location_method in ipairs(location_callbacks) do
-  builtin_callbacks[location_method] = location_callback
-end
-
-local function log_message(_, _, result, client_id)
-  local message_type = result.type
-  local message = result.message
-  local client = vim.lsp.get_client_by_id(client_id)
-  local client_name = client and client.name or string.format("id=%d", client_id)
-  if not client then
-    api.nvim_err_writeln(string.format("LSP[%s] client has shut down after sending the message", client_name))
-  end
-  if message_type == protocol.MessageType.Error then
-    -- Might want to not use err_writeln,
-    -- but displaying a message with red highlights or something
-    api.nvim_err_writeln(string.format("LSP[%s] %s", client_name, message))
-  else
-    local message_type_name = protocol.MessageType[message_type]
-    api.nvim_out_write(string.format("LSP[%s][%s] %s\n", client_name, message_type_name, message))
-  end
-  return result
-end
-
-builtin_callbacks['window/showMessage'] = log_message
-builtin_callbacks['window/logMessage'] = log_message
-
--- Add boilerplate error validation and logging for all of these.
-for k, fn in pairs(builtin_callbacks) do
-  builtin_callbacks[k] = function(err, method, params, client_id)
-    local _ = log.debug() and log.debug('builtin_callback', method, { params = params, client_id = client_id, err = err })
-    if err then
-      error(tostring(err))
-    end
-    return fn(err, method, params, client_id)
-  end
-end
-
-return builtin_callbacks
--- vim:sw=2 ts=2 et