Repository navigation
Expand file tree
/
Copy pathbufremove.lua
More file actions
286 lines (243 loc) · 8.51 KB
/
Copy pathbufremove.lua
File metadata and controls
286 lines (243 loc) · 8.51 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
-- MIT License Copyright (c) 2021 Evgeni Chasnovski
-- Documentation ==============================================================
--- 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)
---
--- # Setup~
---
--- This module doesn't need setup, but it can be done to improve usability.
--- Setup with `require('mini.bufremove').setup({})` (replace `{}` with your
--- `config` table). It will create global Lua table `MiniBufremove` which you
--- can use for scripting or manually (with `:lua MiniBufremove.*`).
---
--- See |MiniBufremove.config| for `config` structure and default values.
---
--- # 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.
---
--- # Disabling~
---
--- To disable core functionality, set `g:minibufremove_disable` (globally) or
--- `b:minibufremove_disable` (for a buffer) to `v:true`. Considering high
--- number of different scenarios and customization intentions, writing exact
--- rules for disabling module's functionality is left to user. See
--- |mini.nvim-disabling-recipes| for common recipes.
---@tag mini.bufremove
---@tag MiniBufremove
---@toc_entry Remove buffers
-- Module definition ==========================================================
local MiniBufremove = {}
local H = {}
--- Module setup
---
---@param config table Module config table. See |MiniBufremove.config|.
---
---@usage `require('mini.bufremove').setup({})` (replace `{}` with your `config` table)
function MiniBufremove.setup(config)
-- Export module
_G.MiniBufremove = MiniBufremove
-- Setup config
config = H.setup_config(config)
-- Apply config
H.apply_config(config)
end
--- Module config
---
--- Default values:
---@eval return MiniDoc.afterlines_to_code(MiniDoc.current.eval_section)
MiniBufremove.config = {
-- Whether to set Vim's settings for buffers (allow hidden buffers)
set_vim_settings = true,
}
--minidoc_afterlines_end
-- 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 MiniBufremove.delete(buf_id, force)
if H.is_disabled() then
return
end
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 MiniBufremove.wipeout(buf_id, force)
if H.is_disabled() then
return
end
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 MiniBufremove.unshow(buf_id)
if H.is_disabled() then
return
end
buf_id = H.normalize_buf_id(buf_id)
if not H.is_valid_id(buf_id, 'buffer') then
return false
end
vim.tbl_map(MiniBufremove.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 MiniBufremove.unshow_in_window(win_id)
if H.is_disabled() then
return nil
end
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
-- Helper data ================================================================
-- Module default config
H.default_config = MiniBufremove.config
-- Helper functionality =======================================================
-- Settings -------------------------------------------------------------------
function H.setup_config(config)
-- General idea: if some table elements are not present in user-supplied
-- `config`, take them from default config
vim.validate({ config = { config, 'table', true } })
config = vim.tbl_deep_extend('force', H.default_config, config or {})
vim.validate({ set_vim_settings = { config.set_vim_settings, 'boolean' } })
return config
end
function H.apply_config(config)
MiniBufremove.config = config
if config.set_vim_settings then
vim.o.hidden = true -- Allow hidden buffers
end
end
function H.is_disabled()
return vim.g.minibufremove_disable == true or vim.b.minibufremove_disable == true
end
-- Removing implementation ----------------------------------------------------
function H.unshow_and_cmd(buf_id, force, cmd)
buf_id = H.normalize_buf_id(buf_id)
if not H.is_valid_id(buf_id, 'buffer') then
H.notify(buf_id .. ' is not a valid buffer id.')
return false
end
if force == nil then
force = false
end
if type(force) ~= 'boolean' then
H.notify('`force` should be boolean.')
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
MiniBufremove.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 `MiniBufremove.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
H.notify(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 `MiniBufremove.fun_name` function
function H.can_remove(buf_id, force, fun_name)
if force then
return true
end
if vim.api.nvim_buf_get_option(buf_id, 'modified') then
H.notify(
string.format(
'Buffer %d has unsaved changes. Use `MiniBufremove.%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 then
return vim.api.nvim_get_current_buf()
end
return buf_id
end
function H.notify(msg)
vim.notify(string.format('(mini.bufremove) %s', msg))
end
return MiniBufremove