vim-settings/neovim/lua/utils.lua

224 lines
6.0 KiB
Lua
Raw Normal View History

-- luacheck: globals packer_plugins
2021-08-24 17:38:14 +00:00
local M = {}
2021-09-30 18:00:09 +00:00
-- Utils taken from https://github.com/zzzeyez/dots/blob/master/nvim/lua/utils.lua
2021-08-24 17:38:14 +00:00
-- Key mapping
function M.map(mode, key, result, opts)
2021-12-15 17:37:51 +00:00
vim.fn.nvim_set_keymap(mode, key, result, {
noremap = true,
silent = opts.silent or false,
expr = opts.expr or false,
script = opts.script or false,
})
2021-08-24 17:38:14 +00:00
end
function M.augroup(group, fn)
2021-12-15 17:37:51 +00:00
vim.api.nvim_command("augroup " .. group)
vim.api.nvim_command("autocmd!")
fn()
vim.api.nvim_command("augroup END")
2021-08-24 17:38:14 +00:00
end
function M.get_color(synID, what, mode)
2021-12-15 17:37:51 +00:00
return vim.fn.synIDattr(vim.fn.synIDtrans(vim.fn.hlID(synID)), what, mode)
2021-08-24 17:38:14 +00:00
end
2021-09-30 18:00:09 +00:00
-- end zzzeyez utils
2021-08-24 17:38:14 +00:00
-- Create an autocmd
function M.autocmd(group, cmds, clear)
clear = clear == nil and false or clear
2021-12-15 17:37:51 +00:00
if type(cmds) == "string" then
cmds = { cmds }
end
2021-08-24 17:38:14 +00:00
vim.cmd("augroup " .. group)
2021-12-15 17:37:51 +00:00
if clear then
vim.cmd([[au!]])
end
for _, cmd in ipairs(cmds) do
vim.cmd("autocmd " .. cmd)
end
vim.cmd([[augroup END]])
2021-08-24 17:38:14 +00:00
end
-- Terminal escape a given string
function M.t(str)
return vim.api.nvim_replace_termcodes(str, true, true, true)
end
-- Get env value or use default, if not present
function M.env_default(name, def)
2021-09-16 01:13:17 +00:00
local val = vim.env[name]
2021-08-24 17:38:14 +00:00
return val == nil and def or val
end
2021-08-24 23:12:16 +00:00
-- Checks to see if a package can be required
function M.can_require(name)
2021-12-15 17:37:51 +00:00
if package.loaded[name] then
return false
else
for _, searcher in ipairs(package.searchers or package.loaders) do
local loader = searcher(name)
if type(loader) == "function" then
package.preload[name] = loader
return true
end
2021-08-24 23:12:16 +00:00
end
2021-12-15 17:37:51 +00:00
return false
2021-08-24 23:12:16 +00:00
end
end
-- Require a package if possible
function M.maybe_require(name)
2021-12-15 17:37:51 +00:00
if M.can_require(name) then
return require(name)
end
2021-08-24 23:12:16 +00:00
2021-12-15 17:37:51 +00:00
return nil
2021-08-24 23:12:16 +00:00
end
-- Require a package and a "_local" suffixed one
function M.require_with_local(name)
2021-12-15 17:37:51 +00:00
-- TODO: Decide if local should completely override the versioned module
-- In that case, the local file would probably start with a `require` for the
-- non-local version. This would allow more control but at the cost of a bit
-- of boiler plate
local rmod = require(name)
local lmod = M.maybe_require(name .. "_local")
if lmod ~= nil then
return lmod
end
2021-12-15 17:37:51 +00:00
return rmod
2021-08-24 23:12:16 +00:00
end
-- Returns whether or not packer plugin is loaded
function M.is_plugin_loaded(name)
2022-01-07 05:15:06 +00:00
return _G["packer_plugins"] and _G["packer_plugins"][name] and _G["packer_plugins"][name].loaded
end
-- Try to require something and perform some action if it was found
function M.try_require(name, on_found, on_notfound)
local status, module = pcall(require, name)
if status then
if on_found ~= nil then
on_found(module)
end
return module
else
if on_notfound ~= nil then
on_notfound(name)
end
return nil
end
end
-- Compare sequenced integers used to compare versions. Eg {0, 6, 0}
function M.cmp_versions(a, b)
for i, part_a in pairs(a) do
local part_b = b[i]
if part_b == nil or part_a > part_b then
return 1
elseif part_a < part_b then
return -1
end
end
return 0
end
-- Checks if a list contains a value
function M.list_contains(list, value)
for _, v in pairs(list) do
if v == value then
return true
end
end
return false
end
-- Materializes an iterator into a list
function M.materialize_list(list, iterator)
if iterator == nil then
iterator = list
list = {}
end
for item in iterator do
table.insert(list, item)
end
return list
end
-- Maps a set of version rules to a value eg. [">0.5.0"] = "has 0.5.0"
-- If more than one rule matches, the one with the greatest version number is used
function M.map_version_rule(rules)
local v = vim.version()
local current_version = { v.major, v.minor, v.patch }
-- Parse a constraint and version of a string
local parse_rule = function(rule_string)
local cmp, major, minor, patch = string.gmatch(rule_string, "([=<>]+)(%d+).(%d+).(%d+)")()
return cmp, tonumber(major), tonumber(minor), tonumber(patch)
end
-- Checks if a constraint matches the current nvim instance
local matches = function(cmp, major, minor, patch)
local c = M.cmp_versions(current_version, { major, minor, patch })
if c == 1 then
if M.list_contains({ ">", ">=" }, cmp) then
return true
end
elseif c == 0 then
if M.list_contains({ "==", ">=", "<=" }, cmp) then
return true
end
elseif c == -1 then
if M.list_contains({ "<", "<=" }, cmp) then
return true
end
end
return false
end
local latest_version, latest_value = nil, nil
for rule, value in pairs(rules) do
local cmp, major, minor, patch = parse_rule(rule)
if matches(cmp, major, minor, patch) then
-- If the rule matches and the version that it matches is greater than the previous matches, save it
if latest_version == nil or M.cmp_versions({ major, minor, patch }, latest_version) == 1 then
latest_version = { major, minor, patch }
latest_value = value
end
end
end
-- Return highest versioned matched value
return latest_value
end
2022-01-12 17:59:29 +00:00
-- Basically the oposite of map
function M.swapped_map(v, func)
func(v)
return func
end
-- Returns a function used to create keymaps with consistent prefixes
function M.keymap_group(mode, prefix, opts, bufnr)
local map_fn = vim.api.nvim_set_keymap
if bufnr ~= nil then
map_fn = function(...)
return vim.api.nvim_buf_set_keymap(bufnr, ...)
end
end
return function(keys, rhs, new_opts)
map_fn(mode, prefix .. keys, rhs, new_opts or opts)
end
end
2021-08-24 17:38:14 +00:00
return M