neovim

bufremove.lua (6532B)

---

 -- MIT License Copyright (c) 2021 Evgeni Chasnovski
 ---@brief [[
 --- Lua module for minimal buffer removing (unshow, delete, wipeout), which
 --- saves window layout (opposite to builtin Neovim's commands). This is mostly
 --- a Lua implementation of
 --- [bclose.vim](https://vim.fandom.com/wiki/Deleting_a_buffer_without_closing_the_window).
 --- Other alternatives:
 --- - [vim-bbye](https://github.com/moll/vim-bbye)
 --- - [vim-sayonara](https://github.com/mhinz/vim-sayonara)
 ---
 --- # Notes
 --- 1. Which buffer to show in window(s) after its current buffer is removed is
 ---    decided by the algorithm:
 ---    - If alternate buffer (see |CTRL-^|) is listed (see |buflisted()|), use it.
 ---    - If previous listed buffer (see |bprevious|) is different, use it.
 ---    - Otherwise create a scratch one with `nvim_create_buf(true, true)` and use
 ---      it.
 ---
 ---@brief ]]
 ---@tag Bufremove bufremove
 -- Module and its helper
 local BufRemove = {}
 local H = {}
 
 -- Module functionality
 --- Delete buffer `buf_id` with |:bdelete| after unshowing it.
 ---
 ---@param buf_id number: Buffer identifier (see |bufnr()|) to use. Default: 0 for current.
 ---@param force boolean: Whether to ignore unsaved changes (using `!` version of command). Default: `false`.
 ---@return boolean: Whether operation was successful.
 function BufRemove.delete(buf_id, force)
   return H.unshow_and_cmd(buf_id, force, 'bdelete')
 end
 
 --- Wipeout buffer `buf_id` with |:bwipeout| after unshowing it.
 ---
 ---@param buf_id number: Buffer identifier (see |bufnr()|) to use. Default: 0 for current.
 ---@param force boolean: Whether to ignore unsaved changes (using `!` version of command). Default: `false`.
 ---@return boolean: Whether operation was successful.
 function BufRemove.wipeout(buf_id, force)
   return H.unshow_and_cmd(buf_id, force, 'bwipeout')
 end
 
 --- Stop showing buffer `buf_id` in all windows
 ---
 ---@param buf_id number: Buffer identifier (see |bufnr()|) to use. Default: 0 for current.
 ---@return boolean: Whether operation was successful.
 function BufRemove.unshow(buf_id)
   buf_id = H.normalize_buf_id(buf_id)
 
   if not H.is_valid_id(buf_id, 'buffer') then
     return false
   end
 
   vim.tbl_map(BufRemove.unshow_in_window, vim.fn.win_findbuf(buf_id))
 
   return true
 end
 
 --- Stop showing current buffer of window `win_id`
 ---@param win_id number: Window identifier (see |win_getid()|) to use. Default: 0 for current.
 ---@return boolean: Whether operation was successful.
 function BufRemove.unshow_in_window(win_id)
   win_id = (win_id == nil) and 0 or win_id
 
   if not H.is_valid_id(win_id, 'window') then
     return false
   end
 
   local cur_buf = vim.api.nvim_win_get_buf(win_id)
 
   -- Temporary use window `win_id` as current to have Vim's functions working
   vim.api.nvim_win_call(win_id, function()
     -- Try using alternate buffer
     local alt_buf = vim.fn.bufnr('#')
     if alt_buf ~= cur_buf and vim.fn.buflisted(alt_buf) == 1 then
       vim.api.nvim_win_set_buf(win_id, alt_buf)
       return
     end
 
     -- Try using previous buffer
     vim.cmd.bprevious()
     if cur_buf ~= vim.api.nvim_win_get_buf(win_id) then
       return
     end
 
     -- Create new listed scratch buffer
     local new_buf = vim.api.nvim_create_buf(true, true)
     vim.api.nvim_win_set_buf(win_id, new_buf)
   end)
 
   return true
 end
 
 -- Removing implementation
 function H.unshow_and_cmd(buf_id, force, cmd)
   buf_id = H.normalize_buf_id(buf_id)
   force = (force == nil) and false or force
 
   if not H.is_valid_id(buf_id, 'buffer') then
     return false
   end
 
   local fun_name = ({ ['bdelete'] = 'delete', ['bwipeout'] = 'wipeout' })[cmd]
   if not H.can_remove(buf_id, force, fun_name) then
     return false
   end
 
   -- Unshow buffer from all windows
   BufRemove.unshow(buf_id)
 
   -- Execute command
   local command = string.format('%s%s %d', cmd, force and '!' or '', buf_id)
   ---- Use `pcall` here to take care of case where `unshow()` was enough.
   ---- This can happen with 'bufhidden' option values:
   ---- - If `delete` then `unshow()` already `bdelete`d buffer. Without `pcall`
   ----   it gives E516 for `Bufremove.delete()` (`wipeout` works).
   ---- - If `wipe` then `unshow()` already `bwipeout`ed buffer. Without `pcall`
   ----   it gives E517 for module's `wipeout()` (still E516 for `delete()`).
   local ok, result = pcall(vim.cmd, command)
   if not (ok or result:find('E516') or result:find('E517')) then
     vim.notify('(bufremove) ' .. result)
     return false
   end
 
   return true
 end
 
 -- Utilities
 function H.is_valid_id(x, type)
   local is_valid = false
   if type == 'buffer' then
     is_valid = vim.api.nvim_buf_is_valid(x)
   elseif type == 'window' then
     is_valid = vim.api.nvim_win_is_valid(x)
   end
 
   if not is_valid then
     H.notify(string.format('%s is not a valid %s id.', tostring(x), type))
   end
   return is_valid
 end
 
 ---- Check if buffer can be removed with `Bufremove.fun_name` function
 function H.can_remove(buf_id, force, fun_name)
   if force then
     return true
   end
 
   if vim.api.nvim_get_option_value('modified', { buf = buf_id }) then
     H.notify(string.format('Buffer %d has unsaved changes. Use `Bufremove.%s(%d, true)` to force.', buf_id, fun_name,
       buf_id))
     return false
   end
   return true
 end
 
 ---- Compute 'true' buffer id (strictly positive integer). Treat `nil` and 0 as
 ---- current buffer.
 function H.normalize_buf_id(buf_id)
   if buf_id == nil or buf_id == 0 or buf_id == '' then
     return vim.api.nvim_get_current_buf()
   end
   return buf_id
 end
 
 function H.notify(msg)
   vim.notify(string.format('(bufremove) %s', msg))
 end
 
 vim.api.nvim_create_user_command('BufDelete', function(data)
   BufRemove.delete(data.args, data.bang)
 end, { nargs = '?', bang = true })
 vim.api.nvim_create_user_command('BufWipeout', function(data)
   BufRemove.wipeout(data.args, data.bang)
 end, { nargs = '?', bang = true })
 vim.api.nvim_create_user_command('BufUnshow', function(data)
   BufRemove.unshow(data.args)
 end, { nargs = '?' })
 vim.api.nvim_create_user_command('BufWinUnshow', function(data)
   BufRemove.unshow_in_window(data.args)
 end, { nargs = '?' })
 
 vim.keymap.set('n', '<leader>bd', BufRemove.delete, { desc = 'Buffer Delete' })
 vim.keymap.set('n', '<leader>bD', function()
   BufRemove.delete(0, true)
 end, { desc = 'Buffer Force Delete' })
 vim.keymap.set('n', '<leader>bw', BufRemove.wipeout, { desc = 'Buffer Wipeout' })
 vim.keymap.set('n', '<leader>bu', BufRemove.unshow, { desc = 'Buffer Unshow' })
 vim.keymap.set('n', '<leader>bU', BufRemove.unshow_in_window, { desc = 'Buffer Window Unshow' })