Repository navigation
Expand file tree
/
Copy pathmisc.lua
More file actions
370 lines (322 loc) · 11.6 KB
/
Copy pathmisc.lua
File metadata and controls
370 lines (322 loc) · 11.6 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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
-- MIT License Copyright (c) 2021 Evgeni Chasnovski
-- Documentation ==============================================================
---@brief [[
--- Lua module with miscellaneous useful functions (can be used independently).
---
--- # Setup
---
--- This module doesn't need setup, but it can be done to improve usability.
--- Setup with `require('mini.misc').setup({})` (replace `{}` with your
--- `config` table). It will create global Lua table `MiniMisc` which you can
--- use for scripting or manually (with `:lua MiniMisc.*`).
---
--- Default `config`:
--- <code>
--- {
--- -- Array of fields to make global (to be used as independent variables)
--- make_global = { 'put', 'put_text' },
--- }
--- </code>
---@brief ]]
---@tag MiniMisc mini.misc
-- Module definition ==========================================================
local MiniMisc = {}
local H = {}
--- Module setup
---
---@param config table: Module config table.
---@usage `require('mini.misc').setup({})` (replace `{}` with your `config` table)
function MiniMisc.setup(config)
-- Export module
_G.MiniMisc = MiniMisc
-- Setup config
config = H.setup_config(config)
-- Apply config
H.apply_config(config)
end
MiniMisc.config = {
-- Array of fields to make global (to be used as independent variables)
make_global = { 'put', 'put_text' },
}
-- Module functionality =======================================================
--- Execute `f` several times and time how long it took
---
---@param f function: Function which execution to benchmark.
---@param n number: Number of times to execute `f(...)`. Default: 1.
---@param ... vararg: Arguments when calling `f`.
---@return tuple: Table with durations (in seconds; up to microseconds) and output of (last) function execution.
function MiniMisc.bench_time(f, n, ...)
n = n or 1
local durations, output = {}, nil
for _ = 1, n do
local start_sec, start_usec = vim.loop.gettimeofday()
output = f(...)
local end_sec, end_usec = vim.loop.gettimeofday()
table.insert(durations, (end_sec - start_sec) + 0.000001 * (end_usec - start_usec))
end
return durations, output
end
--- Compute width of gutter (info column on the left of the window)
---
---@param win_id number: Window identifier (see |win_getid()|) for which gutter width is computed. Default: 0 for current.
function MiniMisc.get_gutter_width(win_id)
-- Compute number of 'editable' columns in current window
-- Store current window metadata
local virtualedit = vim.opt.virtualedit
local curpos = vim.api.nvim_win_get_cursor(win_id)
-- Move cursor to the last visible column
local last_col = vim.api.nvim_win_call(win_id, function()
vim.opt.virtualedit = 'all'
vim.cmd([[normal! g$]])
return vim.fn.virtcol('.')
end)
-- Restore current window metadata
vim.opt.virtualedit = virtualedit
vim.api.nvim_win_set_cursor(win_id, curpos)
-- Compute result
return vim.api.nvim_win_get_width(win_id) - last_col
end
--- Print Lua objects in command line
---
---@param ... vararg: Any number of objects to be printed each on separate line.
function MiniMisc.put(...)
local objects = {}
-- Not using `{...}` because it removes `nil` input
for i = 1, select('#', ...) do
local v = select(i, ...)
table.insert(objects, vim.inspect(v))
end
print(table.concat(objects, '\n'))
return ...
end
--- Print Lua objects in current buffer
---
---@param ... vararg: Any number of objects to be printed each on separate line.
function MiniMisc.put_text(...)
local objects = {}
-- Not using `{...}` because it removes `nil` input
for i = 1, select('#', ...) do
local v = select(i, ...)
table.insert(objects, vim.inspect(v))
end
local lines = vim.split(table.concat(objects, '\n'), '\n')
local lnum = vim.api.nvim_win_get_cursor(0)[1]
vim.fn.append(lnum, lines)
return ...
end
--- Resize window to have exact number of editable columns
---
---@param win_id number: Window identifier (see |win_getid()|) to be resized. Default: 0 for current.
---@param text_width number: Number of editable columns resized window will display. Default: first element of 'colorcolumn' or otherwise 'textwidth' (using screen width as its default but not more than 79).
function MiniMisc.resize_window(win_id, text_width)
win_id = win_id or 0
text_width = text_width or H.default_text_width(win_id)
vim.api.nvim_win_set_width(win_id, text_width + MiniMisc.get_gutter_width(win_id))
end
function H.default_text_width(win_id)
local buf = vim.api.nvim_win_get_buf(win_id)
local textwidth = vim.api.nvim_buf_get_option(buf, 'textwidth')
textwidth = (textwidth == 0) and math.min(vim.o.columns, 79) or textwidth
local colorcolumn = vim.api.nvim_win_get_option(win_id, 'colorcolumn')
if colorcolumn ~= '' then
local cc = vim.split(colorcolumn, ',')[1]
local is_cc_relative = vim.tbl_contains({ '-', '+' }, cc:sub(1, 1))
if is_cc_relative then
return textwidth + tonumber(cc)
else
return tonumber(cc)
end
else
return textwidth
end
end
--- Compute summary statistics of numerical array
---
--- This might be useful to compute summary of time benchmarking with
--- |MiniMisc.bench_time|.
---
---@param t table: Array (table suitable for `ipairs`) of numbers.
---@return table: Table with summary values under following keys (may be extended in the future): `maximum`, `mean`, `median`, `minimum`, `n` (number of elements), `sd` (sample standard deviation).
function MiniMisc.stat_summary(t)
if type(t) ~= 'table' then
vim.notify([[(mini.misc) Input of `MiniMisc.stat_summary` should be an array of numbers.]])
return
end
-- Welford algorithm of computing variance
-- Source: https://www.johndcook.com/blog/skewness_kurtosis/
local n = #t
local delta, m1, m2 = 0, 0, 0
local minimum, maximum = math.huge, -math.huge
for i, x in ipairs(t) do
delta = x - m1
m1 = m1 + delta / i
m2 = m2 + delta * (x - m1)
-- Extremums
minimum = x < minimum and x or minimum
maximum = x > maximum and x or maximum
end
return {
maximum = maximum,
mean = m1,
median = H.compute_median(t),
minimum = minimum,
n = n,
sd = math.sqrt(n > 1 and m2 / (n - 1) or 0),
}
end
function H.compute_median(t)
local n = #t
if n == 0 then
return 0
end
local t_sorted = vim.deepcopy(t)
table.sort(t_sorted)
return 0.5 * (t_sorted[math.ceil(0.5 * n)] + t_sorted[math.ceil(0.5 * (n + 1))])
end
--- Return "first" elements of table as decided by `pairs`
---
--- Note: order of elements might vary.
---
---@param t table
---@param n number: Maximum number of first elements. Default: 5.
---@return table: Table with at most `n` first elements of `t` (with same keys).
function MiniMisc.tbl_head(t, n)
n = n or 5
local res, n_res = {}, 0
for k, val in pairs(t) do
if n_res >= n then
return res
end
res[k] = val
n_res = n_res + 1
end
return res
end
--- Return "last" elements of table as decided by `pairs`
---
--- This function makes two passes through elements of `t`:
--- - First to count number of elements.
--- - Second to construct result.
---
--- Note: order of elements might vary.
---
---@param t table
---@param n number: Maximum number of last elements. Default: 5.
---@return table: Table with at most `n` last elements of `t` (with same keys).
function MiniMisc.tbl_tail(t, n)
n = n or 5
-- Count number of elements on first pass
local n_all = 0
for _, _ in pairs(t) do
n_all = n_all + 1
end
-- Construct result on second pass
local res = {}
local i, start_i = 0, n_all - n + 1
for k, val in pairs(t) do
i = i + 1
if i >= start_i then
res[k] = val
end
end
return res
end
--- Add possibility of nested comment leader.
---
--- This works by parsing 'commentstring' buffer option, extracting
--- non-whitespace comment leader (symbols on the left of commented line), and
--- locally modifying 'comments' option (by prepending `n:<leader>`). Does
--- nothing if 'commentstring' is empty or has comment symbols both in front
--- and back (like "/*%s*/").
---
--- Nested comment leader added with this function is useful for formatting
--- nested comments. For example, have in Lua "first-level" comments with '--'
--- and "second-level" comments with '----'. With nested comment leader second
--- type can be formatted with `gq` in the same way as first one.
---
--- Recommended usage is with |autocmd|:<br>
--- `autocmd BufEnter * lua pcall(require('mini.misc').use_nested_comments)`
---
--- Note: for most filetypes 'commentstring' option is added only when buffer
--- with this filetype is entered, so using non-current `buf_id` can not lead
--- to desired effect.
---
---@param buf_id number: Buffer identifier (see |bufnr()|) in which function will operate. Default: 0 for current.
function MiniMisc.use_nested_comments(buf_id)
buf_id = buf_id or 0
local commentstring = vim.api.nvim_buf_get_option(buf_id, 'commentstring')
if commentstring == '' then
return
end
-- Extract raw comment leader from 'commentstring' option
local comment_parts = vim.tbl_filter(function(x)
return x ~= ''
end, vim.split(commentstring, '%s', true))
-- Don't do anything if 'commentstring' is like '/*%s*/' (as in 'json')
if #comment_parts > 1 then
return
end
-- Get comment leader. Remove whitespace and escape 'dangerous' characters
local leader = vim.trim(comment_parts[1])
local comments = vim.api.nvim_buf_get_option(buf_id, 'comments')
local new_comments = string.format('n:%s,%s', leader, comments)
vim.api.nvim_buf_set_option(buf_id, 'comments', new_comments)
end
--- Zoom in and out of a buffer, making it full screen in a floating window
---
--- This function is useful when working with multiple windows but temporarily
--- needing to zoom into one to see more of the code from that buffer. Call it
--- again (without arguments) to zoom out.
---
---@param buf_id number: Buffer identifier (see |bufnr()|) to be zoomed. Default: 0 for current.
---@param config table: Optional config for window (as for |nvim_open_win()|).
function MiniMisc.zoom(buf_id, config)
if H.zoom_winid and vim.api.nvim_win_is_valid(H.zoom_winid) then
vim.api.nvim_win_close(H.zoom_winid, true)
H.zoom_winid = nil
else
-- Currently very big `width` and `height` get truncated to maximum allowed
local default_config = { relative = 'editor', row = 0, col = 0, width = 1000, height = 1000 }
config = vim.tbl_deep_extend('force', default_config, config or {})
H.zoom_winid = vim.api.nvim_open_win(buf_id, true, config)
vim.cmd([[normal! zz]])
end
end
-- Helper data ================================================================
-- Module default config
H.default_config = MiniMisc.config
-- Window identifier of current zoom (for `zoom()`)
H.zoom_winid = nil
-- 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({
make_global = {
config.make_global,
function(x)
if type(x) ~= 'table' then
return false
end
local present_fields = vim.tbl_keys(MiniMisc)
for _, v in pairs(x) do
if not vim.tbl_contains(present_fields, v) then
return false
end
end
return true
end,
'`make_global` should be a table with `MiniMisc` actual fields',
},
})
return config
end
function H.apply_config(config)
for _, v in pairs(config.make_global) do
_G[v] = MiniMisc[v]
end
end
return MiniMisc