gitsigns.nvim/lua/gitsigns/attach.lua

local async = require('gitsigns.async')
local git = require('gitsigns.git')

local log = require('gitsigns.debug.log')
local dprintf = log.dprintf
local dprint = log.dprint

local manager = require('gitsigns.manager')
local hl = require('gitsigns.highlight')

local gs_cache = require('gitsigns.cache')
local cache = gs_cache.cache
local CacheEntry = gs_cache.CacheEntry
local Status = require('gitsigns.status')

local gs_config = require('gitsigns.config')
local config = gs_config.config

local void = require('gitsigns.async').void
local util = require('gitsigns.util')

local throttle_by_id = require('gitsigns.debounce').throttle_by_id

local api = vim.api
local uv = vim.loop

local M = {}

local vimgrep_running = false

--- @param name string
--- @return string? buffer
--- @return string? commit
local function parse_fugitive_uri(name)
  if vim.fn.exists('*FugitiveReal') == 0 then
    dprint('Fugitive not installed')
    return
  end

  ---@type string
  local path = vim.fn.FugitiveReal(name)
  ---@type string?
  local commit = vim.fn.FugitiveParse(name)[1]:match('([^:]+):.*')
  if commit == '0' then
    -- '0' means the index so clear commit so we attach normally
    commit = nil
  end
  return path, commit
end

--- @param name string
--- @return string? buffer
--- @return string? commit
local function parse_gitsigns_uri(name)
  -- TODO(lewis6991): Support submodules
  --- @type any, any, string?, string?, string
  local _, _, root_path, commit, rel_path = name:find([[^gitsigns://(.*)/%.git/(.*):(.*)]])
  if commit == ':0' then
    -- ':0' means the index so clear commit so we attach normally
    commit = nil
  end
  if root_path then
    name = root_path .. '/' .. rel_path
  end
  return name, commit
end

--- @param bufnr integer
--- @return string, string?
local function get_buf_path(bufnr)
  local file = uv.fs_realpath(api.nvim_buf_get_name(bufnr))
    or api.nvim_buf_call(bufnr, function()
      return vim.fn.expand('%:p')
    end)

  if not vim.wo.diff then
    if vim.startswith(file, 'fugitive://') then
      local path, commit = parse_fugitive_uri(file)
      dprintf("Fugitive buffer for file '%s' from path '%s'", path, file)
      path = uv.fs_realpath(path)
      if path then
        return path, commit
      end
    end

    if vim.startswith(file, 'gitsigns://') then
      local path, commit = parse_gitsigns_uri(file)
      dprintf("Gitsigns buffer for file '%s' from path '%s'", path, file)
      path = uv.fs_realpath(path)
      if path then
        return path, commit
      end
    end
  end

  return file
end

local function on_lines(_, bufnr, _, first, last_orig, last_new, byte_count)
  if first == last_orig and last_orig == last_new and byte_count == 0 then
    -- on_lines can be called twice for undo events; ignore the second
    -- call which indicates no changes.
    return
  end
  return manager.on_lines(bufnr, first, last_orig, last_new)
end

--- @param bufnr integer
local function on_reload(_, bufnr)
  local __FUNC__ = 'on_reload'
  dprint('Reload')
  manager.update_debounced(bufnr)
end

--- @param bufnr integer
local function on_detach(_, bufnr)
  M.detach(bufnr, true)
end

--- @param bufnr integer
--- @return string?
--- @return string?
local function on_attach_pre(bufnr)
  --- @type string?, string?
  local gitdir, toplevel
  if config._on_attach_pre then
    --- @type {gitdir: string?, toplevel: string?}
    local res = async.wrap(config._on_attach_pre, 2)(bufnr)
    dprintf('ran on_attach_pre with result %s', vim.inspect(res))
    if type(res) == 'table' then
      if type(res.gitdir) == 'string' then
        gitdir = res.gitdir
      end
      if type(res.toplevel) == 'string' then
        toplevel = res.toplevel
      end
    end
  end
  return gitdir, toplevel
end

--- @param _bufnr integer
--- @param file string
--- @param encoding string
--- @return Gitsigns.GitObj?
local function try_worktrees(_bufnr, file, encoding)
  if not config.worktrees then
    return
  end

  for _, wt in ipairs(config.worktrees) do
    local git_obj = git.Obj.new(file, encoding, wt.gitdir, wt.toplevel)
    if git_obj and git_obj.object_name then
      dprintf('Using worktree %s', vim.inspect(wt))
      return git_obj
    end
  end
end

local done_setup = false

function M._setup()
  if done_setup then
    return
  end

  done_setup = true

  manager.setup()

  hl.setup_highlights()
  api.nvim_create_autocmd('ColorScheme', {
    group = 'gitsigns',
    callback = hl.setup_highlights,
  })

  api.nvim_create_autocmd('OptionSet', {
    group = 'gitsigns',
    pattern = 'fileformat',
    callback = function()
      require('gitsigns.actions').refresh()
    end,
  })

  -- vimpgrep creates and deletes lots of buffers so attaching to each one will
  -- waste lots of resource and even slow down vimgrep.
  api.nvim_create_autocmd('QuickFixCmdPre', {
    group = 'gitsigns',
    pattern = '*vimgrep*',
    callback = function()
      vimgrep_running = true
    end,
  })

  api.nvim_create_autocmd('QuickFixCmdPost', {
    group = 'gitsigns',
    pattern = '*vimgrep*',
    callback = function()
      vimgrep_running = false
    end,
  })

  require('gitsigns.current_line_blame').setup()

  api.nvim_create_autocmd('VimLeavePre', {
    group = 'gitsigns',
    callback = M.detach_all,
  })
end

--- @class Gitsigns.GitContext
--- @field toplevel string
--- @field gitdir string
--- @field file string
--- @field commit string
--- @field base string

-- Ensure attaches cannot be interleaved.
-- Since attaches are asynchronous we need to make sure an attach isn't
-- performed whilst another one is in progress.
--- @param cbuf integer
--- @param ctx Gitsigns.GitContext
--- @param aucmd string
local attach_throttled = throttle_by_id(function(cbuf, ctx, aucmd)
  local __FUNC__ = 'attach'

  M._setup()

  if vimgrep_running then
    dprint('attaching is disabled')
    return
  end

  if cache[cbuf] then
    dprint('Already attached')
    return
  end

  if aucmd then
    dprintf('Attaching (trigger=%s)', aucmd)
  else
    dprint('Attaching')
  end

  if not api.nvim_buf_is_loaded(cbuf) then
    dprint('Non-loaded buffer')
    return
  end

  local encoding = vim.bo[cbuf].fileencoding
  if encoding == '' then
    encoding = 'utf-8'
  end
  local file --- @type string
  local commit --- @type string?
  local gitdir_oap --- @type string?
  local toplevel_oap --- @type string?

  if ctx then
    gitdir_oap = ctx.gitdir
    toplevel_oap = ctx.toplevel
    file = ctx.toplevel .. util.path_sep .. ctx.file
    commit = ctx.commit
  else
    if api.nvim_buf_line_count(cbuf) > config.max_file_length then
      dprint('Exceeds max_file_length')
      return
    end

    if vim.bo[cbuf].buftype ~= '' then
      dprint('Non-normal buffer')
      return
    end

    file, commit = get_buf_path(cbuf)
    local file_dir = util.dirname(file)

    if not file_dir or not util.path_exists(file_dir) then
      dprint('Not a path')
      return
    end

    gitdir_oap, toplevel_oap = on_attach_pre(cbuf)
  end

  local git_obj = git.Obj.new(file, encoding, gitdir_oap, toplevel_oap)

  if not git_obj and not ctx then
    git_obj = try_worktrees(cbuf, file, encoding)
    async.scheduler()
  end

  if not git_obj then
    dprint('Empty git obj')
    return
  end
  local repo = git_obj.repo

  async.scheduler()
  Status:update(cbuf, {
    head = repo.abbrev_head,
    root = repo.toplevel,
    gitdir = repo.gitdir,
  })

  if vim.startswith(file, repo.gitdir .. util.path_sep) then
    dprint('In non-standard git dir')
    return
  end

  if not ctx and (not util.path_exists(file) or uv.fs_stat(file).type == 'directory') then
    dprint('Not a file')
    return
  end

  if not git_obj.relpath then
    dprint('Cannot resolve file in repo')
    return
  end

  if not config.attach_to_untracked and git_obj.object_name == nil then
    dprint('File is untracked')
    return
  end

  -- On windows os.tmpname() crashes in callback threads so initialise this
  -- variable on the main thread.
  async.scheduler()

  if config.on_attach and config.on_attach(cbuf) == false then
    dprint('User on_attach() returned false')
    return
  end

  cache[cbuf] = CacheEntry.new({
    base = ctx and ctx.base or config.base,
    file = file,
    commit = commit,
    git_obj = git_obj,
  })

  if config.watch_gitdir.enable then
    local watcher = require'gitsigns.watcher'
    cache[cbuf].gitdir_watcher = watcher.watch_gitdir(cbuf, repo.gitdir)
  end

  if not api.nvim_buf_is_loaded(cbuf) then
    dprint('Un-loaded buffer')
    return
  end

  -- Make sure to attach before the first update (which is async) so we pick up
  -- changes from BufReadCmd.
  api.nvim_buf_attach(cbuf, false, {
    on_lines = on_lines,
    on_reload = on_reload,
    on_detach = on_detach,
  })

  -- Initial update
  manager.update(cbuf, cache[cbuf])
end)

--- Detach Gitsigns from all buffers it is attached to.
function M.detach_all()
  for k, _ in pairs(cache) do
    M.detach(k)
  end
end

--- Detach Gitsigns from the buffer {bufnr}. If {bufnr} is not
--- provided then the current buffer is used.
---
--- Parameters: ~
---     {bufnr}  (number): Buffer number
function M.detach(bufnr, _keep_signs)
  -- When this is called interactively (with no arguments) we want to remove all
  -- the signs, however if called via a detach event (due to nvim_buf_attach)
  -- then we don't want to clear the signs in case the buffer is just being
  -- updated due to the file externally changing. When this happens a detach and
  -- attach event happen in sequence and so we keep the old signs to stop the
  -- sign column width moving about between updates.
  bufnr = bufnr or api.nvim_get_current_buf()
  dprint('Detached')
  local bcache = cache[bufnr]
  if not bcache then
    dprint('Cache was nil')
    return
  end

  manager.detach(bufnr, _keep_signs)

  -- Clear status variables
  Status:clear(bufnr)

  gs_cache.destroy(bufnr)
end

--- Attach Gitsigns to the buffer.
---
--- Attributes: ~
---     {async}
---
--- Parameters: ~
---     {bufnr}  (number): Buffer number
---     {ctx}    (table|nil):
---              Git context data that may optionally be used to attach to any
---              buffer that represents a real git object.
---              • {file}: (string)
---                Path to the file represented by the buffer, relative to the
---                top-level.
---              • {toplevel}: (string)
---                Path to the top-level of the parent git repository.
---              • {gitdir}: (string)
---                Path to the git directory of the parent git repository
---                (typically the ".git/" directory).
---              • {commit}: (string)
---                The git revision that the file belongs to.
---              • {base}: (string|nil)
---                The git revision that the file should be compared to.
M.attach = void(function(bufnr, ctx, _trigger)
  attach_throttled(bufnr or api.nvim_get_current_buf(), ctx, _trigger)
end)

return M