From bba75eb184cee3d96264a392e2083f5b50732214 Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Fri, 18 Jan 2019 00:44:35 +0100 Subject: lua/stdlib: Introduce vim.shared This is where "pure functions" can live, which can be shared by Nvim and test logic which may not have a running Nvim instance available. If in the future we use Nvim itself as the Lua engine for tests, then these functions could be moved directly onto the `vim` Lua module. closes #6580 --- runtime/lua/vim/shared.lua | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 runtime/lua/vim/shared.lua (limited to 'runtime/lua/vim') diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua new file mode 100644 index 0000000000..9c49d93596 --- /dev/null +++ b/runtime/lua/vim/shared.lua @@ -0,0 +1,39 @@ +--- Shared functions +-- - Used by Nvim and tests +-- - Can run in vanilla Lua (do not require a running instance of Nvim) + + +--- Merge map-like tables. +-- +--@see |extend()| +-- +-- behavior: Decides what to do if a key is found in more than one map: +-- "error": raise an error +-- "keep": skip +-- "force": set the item again +local function tbl_extend(behavior, ...) + if (behavior ~= 'error' and behavior ~= 'keep' and behavior ~= 'force') then + error('invalid "behavior": '..tostring(behavior)) + end + local ret = {} + for i = 1, select('#', ...) do + local tbl = select(i, ...) + if tbl then + for k, v in pairs(tbl) do + if behavior ~= 'force' and ret[k] ~= nil then + if behavior == 'error' then + error('key found in more than one map: '..k) + end -- Else behavior is "keep". + else + ret[k] = v + end + end + end + end + return ret +end + +local module = { + tbl_extend = tbl_extend, +} +return module -- cgit From 9d7aaf7149a5543b1ddfc89fb506a1019bec3ffb Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Sat, 18 May 2019 16:00:06 +0200 Subject: lua/shared: move table util funcs to vim.shared Use `tbl_` prefix for all table-util functions. Specify in the function docstring if it expects a list-like or map-like table. --- runtime/lua/vim/shared.lua | 40 +++++++++++++++++++++++++++++++++++++--- 1 file changed, 37 insertions(+), 3 deletions(-) (limited to 'runtime/lua/vim') diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua index 9c49d93596..9dca51ce9a 100644 --- a/runtime/lua/vim/shared.lua +++ b/runtime/lua/vim/shared.lua @@ -3,14 +3,27 @@ -- - Can run in vanilla Lua (do not require a running instance of Nvim) ---- Merge map-like tables. +-- Checks if a list-like (vector) table contains `value`. +local function tbl_contains(t, value) + if type(t) ~= 'table' then + error('t must be a table') + end + for _,v in ipairs(t) do + if v == value then + return true + end + end + return false +end + +--- Merges two or more map-like tables. -- --@see |extend()| -- -- behavior: Decides what to do if a key is found in more than one map: -- "error": raise an error --- "keep": skip --- "force": set the item again +-- "keep": use value from the leftmost map +-- "force": use value from the rightmost map local function tbl_extend(behavior, ...) if (behavior ~= 'error' and behavior ~= 'keep' and behavior ~= 'force') then error('invalid "behavior": '..tostring(behavior)) @@ -33,7 +46,28 @@ local function tbl_extend(behavior, ...) return ret end +-- Flattens a list-like table: unrolls and appends nested tables to table `t`. +local function tbl_flatten(t) + -- From https://github.com/premake/premake-core/blob/master/src/base/table.lua + local result = {} + local function _tbl_flatten(_t) + local n = #_t + for i = 1, n do + local v = _t[i] + if type(v) == "table" then + _tbl_flatten(v) + elseif v then + table.insert(result, v) + end + end + end + _tbl_flatten(t) + return result +end + local module = { + tbl_contains = tbl_contains, tbl_extend = tbl_extend, + tbl_flatten = tbl_flatten, } return module -- cgit