mini.nvim/lua/mini/misc.lua at main · yilisharcs/mini.nvim

Repository navigation

--- *mini.misc* Miscellaneous functions
--- MIT License Copyright (c) 2021 Evgeni Chasnovski
--- Features the following functions:
--- - |MiniMisc.bench_time()| to benchmark function execution time.
---   Useful in combination with `stat_summary()`.
--- - |MiniMisc.log_add()|, |MiniMisc.log_show()| and other helper functions to work
---   with a special in-memory log array. Useful when debugging Lua code.
--- - |MiniMisc.put()| and |MiniMisc.put_text()| to pretty print its arguments
---   into command line and current buffer respectively.
--- - |MiniMisc.resize_window()| to resize current window to its editable width.
--- - |MiniMisc.safely()| to execute a function on a condition and warn on error.
---   Useful to organize |init.lua| in fail-safe sections with simple lazy loading.
--- - |MiniMisc.setup_auto_root()| to set up automated change of current directory.
--- - |MiniMisc.setup_termbg_sync()| to set up terminal background synchronization
---   (removes possible "frame" around current Neovim instance).
--- - |MiniMisc.setup_restore_cursor()| to set up automated restoration of
---   cursor position on file reopen.
--- - |MiniMisc.stat_summary()| to compute summary statistics of numerical array.
---   Useful in combination with `bench_time()`.
--- - |MiniMisc.tbl_head()| and |MiniMisc.tbl_tail()| to return "first" and "last"
---   elements of table.
--- - |MiniMisc.zoom()| to zoom in and out of a buffer, making it full screen
---   in a floating window.
--- - And more.
--- # 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.*`).
--- See |MiniMisc.config| for `config` structure and default values.
--- This module doesn't have runtime options, so using `vim.b.minimisc_config`
--- will have no effect here.
---@tag MiniMisc
-- Module definition ==========================================================
local MiniMisc = {}
local H = {}
--- Module setup
---@param config table|nil Module config table. See |MiniMisc.config|.
---@usage >lua
---   require('mini.misc').setup() -- use default config
---   -- OR
---   require('mini.misc').setup({}) -- replace {} with your config table
MiniMisc.setup = function(config)
  -- Export module
  _G.MiniMisc = MiniMisc
  -- Setup config
  config = H.setup_config(config)
  -- Apply config
  H.apply_config(config)
--- Defaults ~
---@eval return MiniDoc.afterlines_to_code(MiniDoc.current.eval_section)
MiniMisc.config = {
  -- Array of fields to make global (to be used as independent variables)
  make_global = { 'put', 'put_text' },
--minidoc_afterlines_end
-- Module functionality =======================================================
--- Execute `f` several times and time how long it took
---@param f function Function which execution to benchmark.
---@param n number|nil Number of times to execute `f(...)`. Default: 1.
---@param ... any Arguments when calling `f`.
---@return ... Table with durations (in seconds; up to nanoseconds) and
---   output of (last) function execution.
MiniMisc.bench_time = function(f, n, ...)
  n = n or 1
  local durations, output = {}, nil
  for _ = 1, n do
    local start_time = vim.loop.hrtime()
    output = f(...)
    local end_time = vim.loop.hrtime()
    table.insert(durations, 0.000000001 * (end_time - start_time))
  return durations, output
--- Compute width of gutter (info column on the left of the window)
---@param win_id number|nil Window identifier (see |win_getid()|) for which gutter
---   width is computed. Default: 0 for current.
MiniMisc.get_gutter_width = function(win_id)
  win_id = (win_id == nil or win_id == 0) and vim.api.nvim_get_current_win() or win_id
  return vim.fn.getwininfo(win_id)[1].textoff
--- Add an entry to the in-memory log array
--- Useful when trying to debug a Lua code (like Neovim config or plugin).
--- Use this instead of ad-hoc `print()` statements.
--- Each entry is a table with the following fields:
--- - <desc> `(any)` - entry description. Usually a string describing a place
---   in the code.
--- - <state> `(any)` - data about current state. Usually a table.
--- - <timestamp> `(number)` - a timestamp of when the entry was added. A number of
---   milliseconds since the in-memory log was initiated (after |MiniMisc.setup()|
---   or |MiniMisc.log_clear()|). Useful during profiling.
---@param desc any Entry description.
---@param state any Data about current state.
---@param opts table|nil Options. Possible fields:
---   - <deepcopy> - (boolean) Whether to create a copy of tables in {state}.
---     Usually helpful to record the exact state during code execution and avoid
---     side effects of tables being changed in-place. Default `true`.
---@usage >lua
---   local t = { a = 1 }
---   MiniMisc.log_add('before', { t = t }) -- Will show `t = { a = 1 }` state
---   t.a = t.a + 1
---   MiniMisc.log_add('after', { t = t })  -- Will show `t = { a = 2 }` state
---   -- Use `:lua MiniMisc.log_show()` or `:=MiniMisc.log_get()` to see the log
---@seealso - |MiniMisc.log_get()| to get log array
--- - |MiniMisc.log_show()| to show log array in the dedicated buffer
--- - |MiniMisc.log_clear()| to clear the log array
MiniMisc.log_add = function(desc, state, opts)
  opts = vim.tbl_extend('force', { deepcopy = true }, opts or {})
  local entry = {
    desc = desc,
    state = opts.deepcopy and H.copy_tables(state) or state,
    timestamp = 0.000001 * (vim.loop.hrtime() - H.log_cache.start_htime),
  table.insert(H.log_cache.log, entry)
--- Get log array
---@return table[] Log array. Returned as is, without |vim.deepcopy()|.
---@seealso - |MiniMisc.log_add()| to add to the log array
MiniMisc.log_get = function() return H.log_cache.log end
--- Show log array in a scratch buffer
---@seealso - |MiniMisc.log_add()| to add to the log array
MiniMisc.log_show = function()
  local buf_id = H.log_cache.buf_id
  if buf_id == nil or not vim.api.nvim_buf_is_valid(buf_id) then
    buf_id = vim.api.nvim_create_buf(true, true)
    vim.api.nvim_buf_set_name(buf_id, 'minimisc://' .. buf_id .. '/log')
    vim.bo[buf_id].modifiable = true
    H.log_cache.buf_id = buf_id
  local lines = vim.split(vim.inspect(H.log_cache.log), '\n')
  vim.api.nvim_buf_set_lines(buf_id, 0, -1, false, lines)
  local buf_wins = vim.fn.win_findbuf(buf_id)
  if buf_wins[1] == nil then return vim.api.nvim_win_set_buf(0, buf_id) end
  vim.api.nvim_set_current_win(buf_wins[1])
--- Clear log array
--- This also sets a new starting point for entry timestamps.
---@seealso - |MiniMisc.log_add()| to add to the log array
MiniMisc.log_clear = function()
  H.log_cache.log = {}
  H.log_cache.start_htime = vim.loop.hrtime()
  H.notify('Cleared log')
H.log_cache = { log = {}, start_htime = vim.loop.hrtime(), buf_id = nil }
--- Print Lua objects in command line
---@param ... any Any number of objects to be printed each on separate line.
MiniMisc.put = function(...)
  local objects = {}
  -- Not using `{...}` because it removes `nil` input
  for i = 1, select('#', ...) do
    local v = select(i, ...)
    table.insert(objects, vim.inspect(v))
  print(table.concat(objects, '\n'))
  return ...
--- Print Lua objects in current buffer
---@param ... any Any number of objects to be printed each on separate line.
MiniMisc.put_text = function(...)
  local objects = {}
  -- Not using `{...}` because it removes `nil` input
  for i = 1, select('#', ...) do
    local v = select(i, ...)
    table.insert(objects, vim.inspect(v))
  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 ...
--- Resize window to have exact number of editable columns
---@param win_id number|nil Window identifier (see |win_getid()|) to be resized.
---   Default: 0 for current.
---@param text_width number|nil 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).
MiniMisc.resize_window = function(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))
H.default_text_width = function(win_id)
  local buf = vim.api.nvim_win_get_buf(win_id)
  local textwidth = vim.bo[buf].textwidth
  textwidth = (textwidth == 0) and math.min(vim.o.columns, 79) or textwidth
  local colorcolumn = vim.wo[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)
      return tonumber(cc)
    return textwidth
--- Execute a function on a condition and warn on error
--- Input function is executed exactly once. Its possible error is captured and is
--- shown as a |vim.notify()| warning.
--- Useful to organize |init.lua| in fail-safe sections with simple lazy loading.
---@param when string When to execute a function. One of:
---   - `'now'` - immediately.
---   - `'later'` - queue to be executed soon without blocking the execution of next
---     code in file. Queued functions are executed in order they are added.
---   - `'delay:<number>'` - after a specified delay with |vim.defer_fn()|.
---   - `'event:<events>'` - on whichever specified event is triggered first.
---   - `'event:<events>~<patterns>` - same as above, but events must match
---     specified |autocmd-pattern|.
---   - `'filetype:<filetypes>'` - same as `'event:FileType~<filetypes>'`, but follow
---     successful function execution with |filetype-detect| for all normal buffers
---     (if new |ftdetect| scripts were added) and sourcing |ftplugin| (for buffers
---     matching `<filetypes>`). Intended to be used for loading "language plugins".
---@param f function Function to execute (without arguments).
---@usage >lua
---   MiniMisc.safely('later', function()
---     vim.notify('This will be executed after the next "now" call')
---   MiniMisc.safely('now', function() error('This will be a warning') end)
---   MiniMisc.safely('event:InsertEnter', function()
---     require('mini.completion').setup()
---   MiniMisc.safely('event:CmdlineEnter~/', function()
---     vim.notify('Start searching for the first time')
---   MiniMisc.safely('filetype:tex,plaintex', function()
---     -- Load plugin to improve writing LaTeX
MiniMisc.safely = function(when, f)
  H.check_type('when', when, 'string', false)
  H.check_type('f', f, 'callable', false)
  if when == 'now' then
    H.execute_now(f)
  -- Compute traceback before delaying execution to provide more info
  local trace = debug.traceback('', 2)
  if when == 'later' then
    if #H.safely_cache.later == 0 then vim.schedule(H.execute_later) end
    table.insert(H.safely_cache.later, { f = f, trace = trace })
  local delay = tonumber(when:match('^delay:(%d+)$'))
  if delay ~= nil then
    vim.defer_fn(function() H.execute_now(f, trace) end, delay)
  local events = when:match('^event:(.+)$')
  if events then
    local ev, patt = events:match('^(.+)~(.+)$')
    local event = vim.split(ev or events, ',', { trimempty = true })
    local pattern = vim.split(patt or '', ',', { trimempty = true })
    H.make_defer_autocmd(event, pattern, f, trace)
  local filetypes = when:match('^filetype:(.+)$')
  if filetypes then
    local ft_arr = vim.split(filetypes, ',')
    -- NOTE: Needs `vim.schedule_wrap()` for a correct redetect. This also
    -- prompts using `H.execute_now` and not rely on `H.make_defer_autocmd`.
    local f_and_redetect = vim.schedule_wrap(function()
      -- Look out for new 'ftdetect' scripts by comparing before and after
      local ftdetect_scripts_before = vim.api.nvim_get_runtime_file('ftdetect/*.{vim,lua}', true)
      local ok = H.execute_now(f, trace)
      -- Skip redetect if there was error or detection is disabled
      if not (ok and vim.g.did_load_filetypes == 1) then return end
      local ftdetect_scripts_after = vim.api.nvim_get_runtime_file('ftdetect/*.{vim,lua}', true)
      local needs_redetect = not vim.deep_equal(ftdetect_scripts_before, ftdetect_scripts_after)
      for _, buf_id in ipairs(vim.api.nvim_list_bufs()) do
        H.redetect_filetypes(buf_id, ft_arr, needs_redetect)
    return H.make_defer_autocmd('FileType', ft_arr, f_and_redetect)
  H.error('Could not parse `when` in `safely`')
H.execute_now = function(f, init_trace)
  local ok, err = xpcall(f, function(e) return debug.traceback(e .. '\n', 2) end)
  if ok then return true end
  init_trace = init_trace == nil and '' or ('\n\nTraceback of `MiniMisc.safely()` call:\n' .. init_trace)
  H.notify('Error during safe execution: ' .. err .. init_trace, 'WARN')
  return false
H.safely_cache = { later = {} }
H.execute_later = function()
  local timer = assert(vim.loop.new_timer())
  f = vim.schedule_wrap(function()
    local cb = H.safely_cache.later[1]
    if cb == nil then
      if not timer:is_closing() then timer:close() end
      return
    table.remove(H.safely_cache.later, 1)
    H.execute_now(cb.f, cb.trace)
    timer:start(1, 0, f)
  -- Space out "later" executions to be sure that they don't block anything
  timer:start(1, 0, f)
H.make_defer_autocmd = function(event, pattern, f, trace)
  if type(pattern) == 'table' and #pattern == 0 then pattern = nil end
  local au_id
  local function cb()
    -- Execute exactly once, not once per event or pattern match
    -- Delete before executing `f` to account for nested events
    vim.api.nvim_del_autocmd(au_id)
    H.execute_now(f, trace)
  local group = vim.api.nvim_create_augroup('MiniMiscSafely', { clear = false })
  local opts = { group = group, pattern = pattern, callback = cb, nested = true }
  au_id = vim.api.nvim_create_autocmd(event, opts)
H.redetect_filetypes = function(buf_id, ft_arr, needs_redetect)
  if not vim.api.nvim_buf_is_loaded(buf_id) then return end
  vim.api.nvim_buf_call(buf_id, function()
    -- Try detecting new filetypes
    if needs_redetect and vim.bo.buftype == '' then vim.cmd('filetype detect') end
    -- Force execution of 'ftplugin' scripts for matched filetypes
    if vim.tbl_contains(ft_arr, vim.bo.filetype) then vim.bo.filetype = vim.bo.filetype end
--- Set up automated change of current directory
--- What it does:
--- - Creates autocommand which on every |BufEnter| event with |MiniMisc.find_root()|
---   finds root directory for current buffer file and sets |current-directory|
---   to it (using |chdir()|).
--- - Resets |'autochdir'| to `false`.
---@param names table|function|nil Forwarded to |MiniMisc.find_root()|.
---@param fallback function|nil Forwarded to |MiniMisc.find_root()|.
---@usage >lua
---   require('mini.misc').setup()
---   MiniMisc.setup_auto_root()
MiniMisc.setup_auto_root = function(names, fallback)
  names = names or { '.git', 'Makefile' }
  if not (H.is_array_of(names, H.is_string) or vim.is_callable(names)) then
    H.error('Argument `names` of `setup_auto_root()` should be array of string file names or a callable.')
  fallback = fallback or function() return nil end
  if not vim.is_callable(fallback) then H.error('Argument `fallback` of `setup_auto_root()` should be callable.') end
  -- Disable conflicting option
  vim.o.autochdir = false
  -- Create autocommand
  local set_root = vim.schedule_wrap(function(data)
    if data.buf ~= vim.api.nvim_get_current_buf() then return end
    local root = MiniMisc.find_root(data.buf, names, fallback)
    if root == nil then return end
    vim.fn.chdir(root)
  local augroup = vim.api.nvim_create_augroup('MiniMiscAutoRoot', {})
  local opts = { group = augroup, nested = true, callback = set_root, desc = 'Find root and change current directory' }
  vim.api.nvim_create_autocmd('BufEnter', opts)
--- Find root directory
--- Based on a buffer name (full path to file opened in a buffer) find a root
--- directory. If buffer is not associated with file, returns `nil`.
--- Root directory is a directory containing at least one of pre-defined files.
--- It is searched using |vim.fs.find()| with `upward = true` starting from
--- directory of current buffer file until first occurrence of root file(s).
--- - Uses directory path caching to speed up computations. This means that no
---   changes in root directory will be detected after directory path was already
---   used in this function. Reload Neovim to account for that.
---@param buf_id number|nil Buffer identifier (see |bufnr()|) to use.
---   Default: 0 for current.
---@param names table|function|nil Array of file names or a callable used to
---   identify a root directory. Forwarded to |vim.fs.find()|.
---   Default: `{ '.git', 'Makefile' }`.
---@param fallback function|nil Callable fallback to use if no root is found
---   with |vim.fs.find()|. Will be called with a buffer path and should return
---   a valid directory path.
MiniMisc.find_root = function(buf_id, names, fallback)
  buf_id = buf_id or 0
  names = names or { '.git', 'Makefile' }
  fallback = fallback or function() return nil end
  if not H.is_valid_buf(buf_id) then H.error('Argument `buf_id` of `find_root()` should be valid buffer id.') end
  if not (H.is_array_of(names, H.is_string) or vim.is_callable(names)) then
    H.error('Argument `names` of `find_root()` should be array of string file names or a callable.')
  if not vim.is_callable(fallback) then H.error('Argument `fallback` of `find_root()` should be callable.') end
  -- Compute directory to start search from. NOTEs on why not using file path:
  -- - This has better performance because `vim.fs.find()` is called less.
  -- - *Needs* to be a directory for callable `names` to work.
  -- - Later search is done including initial `path` if directory, so this
  --   should work for detecting buffer directory as root.
  local path = vim.api.nvim_buf_get_name(buf_id)
  if path == '' then return end
  local dir_path = vim.fs.dirname(path)
  -- Try using cache
  local res = H.root_cache[dir_path]
  if res ~= nil then return res end
  -- Find root
  local root_file = vim.fs.find(names, { path = dir_path, upward = true })[1]
  if root_file ~= nil then
    res = vim.fs.dirname(root_file)
    res = fallback(path)
  -- Use absolute path to an existing directory
  if type(res) ~= 'string' then return end
  res = vim.fs.normalize(vim.fn.fnamemodify(res, ':p'))
  if vim.fn.isdirectory(res) == 0 then return end
  -- Cache result per directory path
  H.root_cache[dir_path] = res
  return res
H.root_cache = {}
--- Set up terminal background synchronization
--- What it does:
--- - Checks if terminal emulator supports OSC 11 control sequence through
---   appropriate `stdout`. Stops if not.
--- - Creates autocommands for |ColorScheme| and |VimResume| events, which
---   change terminal background to have same color as |guibg| of |hl-Normal|.
--- - Creates autocommands for |VimLeavePre| and |VimSuspend| events which set
---   terminal background back to its original color.
--- - Synchronizes background immediately to allow not depend on loading order.
--- Primary use case is to remove possible "frame" around current Neovim instance
--- which appears if Neovim's |hl-Normal| background color differs from what is
--- used by terminal emulator itself.
---@param opts table|nil Options. Possible fields:
---   - <explicit_reset> `(boolean)` - whether to reset terminal background by
---     explicitly setting it to the color it had when this function was called.
---     Set to `true` if terminal emulator doesn't support OSC 111 control sequence.
---     Default: `false`.
MiniMisc.setup_termbg_sync = function(opts)
  -- Proceed only if there is a valid stdout to use
  local has_stdout_tty = false
  for _, ui in ipairs(vim.api.nvim_list_uis()) do
    has_stdout_tty = has_stdout_tty or ui.stdout_tty
  if not has_stdout_tty then return end
  opts = vim.tbl_extend('force', { explicit_reset = false }, opts or {})
  -- Choose a method for how terminal emulator background is reset
  local reset = function() io.stdout:write('\027]111\027\\') end
  if opts.explicit_reset then reset = function() io.stdout:write('\027]11;' .. H.termbg_init .. '\007') end end
  local augroup = vim.api.nvim_create_augroup('MiniMiscTermbgSync', { clear = true })
  local track_au_id, bad_responses, had_proper_response = nil, {}, false
  local f = function(args)
    -- Process proper response only once
    if had_proper_response then return end
    -- Neovim=0.10 uses string sequence as response, while Neovim>=0.11 sets it
    -- in `sequence` table field
    local seq = type(args.data) == 'table' and args.data.sequence or args.data
    local ok, termbg = pcall(H.parse_osc11, seq)
    if not (ok and type(termbg) == 'string') then return table.insert(bad_responses, seq) end
    had_proper_response = true
    pcall(vim.api.nvim_del_autocmd, track_au_id)
    -- Set up reset to the color returned from the very first call
    H.termbg_init = H.termbg_init or termbg
    vim.api.nvim_create_autocmd({ 'VimLeavePre', 'VimSuspend' }, { group = augroup, callback = reset })
    -- Set up sync
    local sync = function()
      local normal = vim.api.nvim_get_hl_by_name('Normal', true)
      if normal.background == nil then return reset() end
      -- NOTE: use `io.stdout` instead of `io.write` to ensure correct target
      -- Otherwise after `io.output(file); file:close()` there is an error
      io.stdout:write(string.format('\027]11;#%06x\007', normal.background))
    vim.api.nvim_create_autocmd({ 'VimResume', 'ColorScheme' }, { group = augroup, callback = sync })
    -- Sync immediately
  -- Ask about current background color and process the proper response.
  -- NOTE: do not use ` as Neovim itself triggers `TermResponse`
  -- events during startup, so this should wait until the proper one.
  track_au_id = vim.api.nvim_create_autocmd('TermResponse', { group = augroup, callback = f, nested = true })
  io.stdout:write('\027]11;?\007')
  vim.defer_fn(function()
    if had_proper_response then return end
    pcall(vim.api.nvim_del_augroup_by_id, augroup)
    local bad_suffix = #bad_responses == 0 and '' or (', only these: ' .. vim.inspect(bad_responses))
    local msg = '`setup_termbg_sync()` did not get proper response from terminal emulator' .. bad_suffix
    H.notify(msg, 'WARN')
  end, 1000)
-- Source: 'runtime/lua/vim/_defaults.lua' in Neovim source
H.parse_osc11 = function(x)
  local r, g, b = x:match('^\027%]11;rgb:(%x+)/(%x+)/(%x+)$')
  if not (r and g and b) then
    local a
    r, g, b, a = x:match('^\027%]11;rgba:(%x+)/(%x+)/(%x+)/(%x+)$')
    if not (a and a:len() <= 4) then return end
  if not (r and g and b) then return end
  if not (r:len() <= 4 and g:len() <= 4 and b:len() <= 4) then return end
  local parse_osc_hex = function(c) return c:len() == 1 and (c .. c) or c:sub(1, 2) end
  return '#' .. parse_osc_hex(r) .. parse_osc_hex(g) .. parse_osc_hex(b)
--- Restore cursor position on file open
--- When reopening a file this will make sure the cursor is placed back to the
--- position where you left before. This implements |restore-cursor| in a nicer way.
--- File should have a recognized file type (see |'filetype'|) and be opened in
--- a normal buffer (see |'buftype'|).
--- Note: it relies on file mark data stored in |'shadafile'| (see |shada-f|).
--- Be sure to enable it.
---@param opts table|nil Options. Possible fields:
---   - <center> - (boolean) Center the window after we restored the cursor.
---     Default: `true`.
---   - <ignore_filetype> - Array with file types to be ignored (see |'filetype'|).
---     Default: `{ "gitcommit", "gitrebase" }`.
---@usage >lua
---   require('mini.misc').setup_restore_cursor()
MiniMisc.setup_restore_cursor = function(opts)
  opts = opts or {}
  opts.ignore_filetype = opts.ignore_filetype or { 'gitcommit', 'gitrebase' }
  if not H.is_array_of(opts.ignore_filetype, H.is_string) then
    H.error('In `setup_restore_cursor()` `opts.ignore_filetype` should be an array of strings.')
  if opts.center == nil then opts.center = true end
  if type(opts.center) ~= 'boolean' then H.error('In `setup_restore_cursor()` `opts.center` should be a boolean.') end
  -- Create autocommand which runs once on `FileType` for every new buffer
  local augroup = vim.api.nvim_create_augroup('MiniMiscRestoreCursor', {})
  vim.api.nvim_create_autocmd('BufReadPre', {
    group = augroup,
    callback = function(data)
      vim.api.nvim_create_autocmd('FileType', {
        buffer = data.buf,
        callback = function() H.restore_cursor(opts) end,
H.restore_cursor = function(opts)
  -- Stop if not a normal buffer
  if vim.bo.buftype ~= '' then return end
  -- Stop if filetype is ignored
  if vim.tbl_contains(opts.ignore_filetype, vim.bo.filetype) then return end
  -- Stop if line is already specified (like during start with `nvim file +num`)
  local cursor_line = vim.api.nvim_win_get_cursor(0)[1]
  if cursor_line > 1 then return end
  -- Stop if can't restore proper line for some reason
  local mark_line = vim.api.nvim_buf_get_mark(0, [["]])[1]
  local n_lines = vim.api.nvim_buf_line_count(0)
  if not (1 <= mark_line and mark_line <= n_lines) then return end
  -- Restore cursor and open just enough folds
  vim.cmd([[normal! g`"zv]])
  -- Center window
  if opts.center then vim.cmd('normal! zz') 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).
MiniMisc.stat_summary = function(t)
  if not H.is_array_of(t, H.is_number) then
    H.error('Input of `MiniMisc.stat_summary()` should be an array of numbers.')
  -- 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
    maximum = maximum,
    mean = m1,
    median = H.compute_median(t),
    minimum = minimum,
    sd = math.sqrt(n > 1 and m2 / (n - 1) or 0),
H.compute_median = function(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))])
--- Return "first" elements of table as decided by `pairs`
--- Note: order of elements might vary.
---@param t table Input table.
---@param n number|nil Maximum number of first elements. Default: 5.
---@return table Table with at most `n` first elements of `t` (with same keys).
MiniMisc.tbl_head = function(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
  return res
--- 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 Input table.
---@param n number|nil Maximum number of last elements. Default: 5.
---@return table Table with at most `n` last elements of `t` (with same keys).
MiniMisc.tbl_tail = function(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
  -- 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
  return res
--- 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|: >lua
---   local use_nested_comments = function() MiniMisc.use_nested_comments() end
---   vim.api.nvim_create_autocmd('BufEnter', { callback = 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|nil Buffer identifier (see |bufnr()|) in which function
---   will operate. Default: 0 for current.
MiniMisc.use_nested_comments = function(buf_id)
  buf_id = buf_id or 0
  local commentstring = vim.bo[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 by removing whitespace
  local leader = vim.trim(comment_parts[1])
  local comments = vim.bo[buf_id].comments
  vim.bo[buf_id].comments = string.format('n:%s,%s', leader, comments)
--- 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|nil Buffer identifier (see |bufnr()|) to be zoomed.
---   Default: 0 for current.
---@param config table|nil Optional config for window (as for |nvim_open_win()|).
---@return boolean Whether current buffer is zoomed in.
MiniMisc.zoom = function(buf_id, config)
  if H.zoom_winid and vim.api.nvim_win_is_valid(H.zoom_winid) then
    pcall(vim.api.nvim_del_augroup_by_name, 'MiniMiscZoom')
    vim.api.nvim_win_close(H.zoom_winid, true)
    H.zoom_winid = nil
    return false
  local compute_config = function()
    -- Use precise dimensions for no Command line interactions (better scroll)
    local max_width, max_height = vim.o.columns, vim.o.lines - vim.o.cmdheight
    local default_border = (vim.fn.exists('+winborder') == 0 or vim.o.winborder == '') and 'none' or nil
    --stylua: ignore
    local default_config = {
      relative = 'editor', row = 0, col = 0,
      width = max_width, height = max_height,
      title = ' Zoom ', border = default_border,
    local res = vim.tbl_deep_extend('force', default_config, config or {})
    -- Adjust dimensions to fit actually present border parts
    local bor = res.border == 'none' and { '' } or res.border
    local n = type(bor) == 'table' and #bor or 0
    local height_offset = n == 0 and 2 or ((bor[1 % n + 1] == '' and 0 or 1) + (bor[5 % n + 1] == '' and 0 or 1))
    local width_offset = n == 0 and 2 or ((bor[3 % n + 1] == '' and 0 or 1) + (bor[7 % n + 1] == '' and 0 or 1))
    res.height = math.min(res.height, max_height - height_offset)
    res.width = math.min(res.width, max_width - width_offset)
    -- Ensure proper title
    if type(res.title) == 'string' then res.title = H.fit_to_width(res.title, res.width) end
    return res
  H.zoom_winid = vim.api.nvim_open_win(buf_id or 0, true, compute_config())
  vim.wo[H.zoom_winid].winblend = 0
  vim.cmd('normal! zz')
  -- - Make sure zoom window is adjusting to changes in its hyperparameters
  local gr = vim.api.nvim_create_augroup('MiniMiscZoom', { clear = true })
  local adjust_config = function()
    if not (type(H.zoom_winid) == 'number' and vim.api.nvim_win_is_valid(H.zoom_winid)) then
      pcall(vim.api.nvim_del_augroup_by_name, 'MiniMiscZoom')
      return
    vim.api.nvim_win_set_config(H.zoom_winid, compute_config())
  vim.api.nvim_create_autocmd('VimResized', { group = gr, callback = adjust_config })
  vim.api.nvim_create_autocmd('OptionSet', { group = gr, pattern = 'cmdheight', callback = adjust_config })
  return true
-- Helper data ================================================================
-- Module default config
H.default_config = vim.deepcopy(MiniMisc.config)
-- Window identifier of current zoom (for `zoom()`)
H.zoom_winid = nil
-- Helper functionality =======================================================
-- Settings -------------------------------------------------------------------
H.setup_config = function(config)
  H.check_type('config', config, 'table', true)
  -- NOTE: Don't use `tbl_deep_extend` to prefer full input `make_global` array
  -- Needs adjusting if there is a new setting with nested tables
  config = vim.tbl_extend('force', vim.deepcopy(H.default_config), config or {})
  H.check_type('make_global', config.make_global, 'table')
  for _, v in pairs(config.make_global) do
    if MiniMisc[v] == nil then H.error("`make_global` should be a table with exported 'mini.misc' methods") end
  return config
H.apply_config = function(config)
  MiniMisc.config = config
  for _, v in pairs(config.make_global) do
    _G[v] = MiniMisc[v]
-- Utilities ------------------------------------------------------------------
H.error = function(msg) error('(mini.misc) ' .. msg) end
H.check_type = function(name, val, ref, allow_nil)
  if type(val) == ref or (ref == 'callable' and vim.is_callable(val)) or (allow_nil and val == nil) then return end
  H.error(string.format('`%s` should be %s, not %s', name, ref, type(val)))
H.notify = function(msg, level) vim.notify('(mini.misc) ' .. msg, vim.log.levels[level]) end
H.is_valid_buf = function(buf_id) return type(buf_id) == 'number' and vim.api.nvim_buf_is_valid(buf_id) end
H.is_array_of = function(x, predicate)
  if not vim.islist(x) then return false end
  for _, v in ipairs(x) do
    if not predicate(v) then return false end
  return true
H.is_number = function(x) return type(x) == 'number' end
H.is_string = function(x) return type(x) == 'string' end
H.fit_to_width = function(text, width)
  local t_width = vim.fn.strchars(text)
  return t_width <= width and text or ('…' .. vim.fn.strcharpart(text, t_width - width + 1, width - 1))
H.copy_tables = function(x)
  return type(x) == 'table' and setmetatable(vim.tbl_map(H.copy_tables, x), getmetatable(x)) or x
return MiniMisc

FilesExpand file tree

misc.lua

Latest commit

History

misc.lua

File metadata and controls