Module:TableTools:修订间差异

IdleTap-bot​(留言 | 贡献)
导入自求闻百科
 
CaelLab-import​(留言 | 贡献)
补回 2026-09-03 换版时丢掉的 allNumKeys / extendedSparseIpairs(Module:Navbox 依赖)
 
(未显示另一用户的1个中间版本)
第1行: 第1行:
--[[
------------------------------------------------------------------------------------
------------------------------------------------------------------------------------
--                               TableTools                                       --
--                                   TableTools                                   --
--                                                                                --
--                                                                                --
-- This module includes a number of functions for dealing with Lua tables.        --
-- This module includes a number of functions for dealing with Lua tables.        --
-- It is a meta-module, meant to be called from other Lua modules, and should     --
-- It is a meta-module, meant to be called from other Lua modules, and should not --
-- not be called directly from #invoke.                                           --
-- be called directly from #invoke.                                               --
------------------------------------------------------------------------------------
------------------------------------------------------------------------------------
--]]


local libraryUtil = require('libraryUtil')
local libraryUtil = require('libraryUtil')
第19行: 第17行:
local checkTypeMulti = libraryUtil.checkTypeMulti
local checkTypeMulti = libraryUtil.checkTypeMulti


--[[
------------------------------------------------------------------------------------
------------------------------------------------------------------------------------
-- isPositiveInteger
-- isPositiveInteger
第28行: 第25行:
-- hash part of a table.
-- hash part of a table.
------------------------------------------------------------------------------------
------------------------------------------------------------------------------------
--]]
function p.isPositiveInteger(v)
function p.isPositiveInteger(v)
return type(v) == 'number' and v >= 1 and floor(v) == v and v < infinity
return type(v) == 'number' and v >= 1 and floor(v) == v and v < infinity
end
end


--[[
------------------------------------------------------------------------------------
------------------------------------------------------------------------------------
-- isNan
-- isNan
--
--
-- This function returns true if the given number is a NaN value, and false
-- This function returns true if the given number is a NaN value, and false if
-- if not. Although it doesn't operate on tables, it is included here as it is
-- not. Although it doesn't operate on tables, it is included here as it is useful
-- useful for determining whether a value can be a valid table key. Lua will
-- for determining whether a value can be a valid table key. Lua will generate an
-- generate an error if a NaN is used as a table key.
-- error if a NaN is used as a table key.
------------------------------------------------------------------------------------
------------------------------------------------------------------------------------
--]]
function p.isNan(v)
function p.isNan(v)
return not rawequal(v,v)
return type(v) == 'number' and v ~= v
end
end


-- 浅复制一个表。
------------------------------------------------------------------------------------
-- shallowClone
--
-- This returns a clone of a table. The value returned is a new table, but all
-- subtables and functions are shared. Metamethods are respected, but the returned
-- table will have no metatable of its own.
------------------------------------------------------------------------------------
function p.shallowClone(t)
function p.shallowClone(t)
checkType('shallowClone', 1, t, 'table')
local ret = {}
local ret = {}
for k, v in pairs(t) do
for k, v in pairs(t) do
第56行: 第57行:
end
end


function p.shallowCloneArray(t)
------------------------------------------------------------------------------------
local ret = {}
-- removeDuplicates
for k, v in ipairs(t) do
--
ret[k] = v
-- This removes duplicate values from an array. Non-positive-integer keys are
end
-- ignored. The earliest value is kept, and all subsequent duplicate values are
return ret
-- removed, but otherwise the array order is unchanged.
end
------------------------------------------------------------------------------------
 
function p.removeDuplicates(arr)
-- 浅复制一个表,但是忽略元表。
checkType('removeDuplicates', 1, arr, 'table')
function p.rawShallowClone(t)
local isNan = p.isNan
local ret
for _, v in next, t do
ret[t] = v
end
return ret
end
 
-- 往数组追加另一个数组的值。
function p.appendAll(t, another)
for _, v in ipairs(another) do
t[#t + 1] = v
end
end
 
-- 从数组中移除重复值。
function p.removeDuplicates(t)
local ret, exists = {}, {}
local ret, exists = {}, {}
for i, v in ipairs(t) do
for _, v in ipairs(arr) do
if not rawequal(v, v) then
if isNan(v) then
-- NaNs can't be table keys, and they are also unique, so we don't need to check existence.
-- NaNs can't be table keys, and they are also unique, so we don't need to check existence.
ret[#ret + 1] = v
ret[#ret + 1] = v
else
elseif not exists[v] then
if not exists[v] then
ret[#ret + 1] = v
ret[#ret + 1] = v
exists[v] = true
exists[v] = true
end
end
end
end
end
return ret
return ret
end
end


-- 返回有非nil值的数字键的表。
------------------------------------------------------------------------------------
-- numKeys
--
-- This takes a table and returns an array containing the numbers of any numerical
-- keys that have non-nil values, sorted in numerical order.
------------------------------------------------------------------------------------
function p.numKeys(t)
function p.numKeys(t)
checkType('numKeys', 1, t, 'table')
local isPositiveInteger = p.isPositiveInteger
local isPositiveInteger = p.isPositiveInteger
local nums = {}
local nums = {}
for k, v in pairs(t) do
for k in pairs(t) do
if isPositiveInteger(k) then
if isPositiveInteger(k) then
nums[#nums + 1] = k
nums[#nums + 1] = k
第110行: 第99行:
end
end


-- 返回含有所有数字键的表,包括小数、负数。
------------------------------------------------------------------------------------
function p.allNumKeys(t)
-- affixNums
local nums = {}
--
for k, v in pairs(t) do
-- This takes a table and returns an array containing the numbers of keys with the
if type(k)=='number' then
-- specified prefix and suffix. For example, for the table
nums[#nums + 1] = k
-- {a1 = 'foo', a3 = 'bar', a6 = 'baz'} and the prefix "a", affixNums will return
end
-- {1, 3, 6}.
------------------------------------------------------------------------------------
function p.affixNums(t, prefix, suffix)
checkType('affixNums', 1, t, 'table')
checkType('affixNums', 2, prefix, 'string', true)
checkType('affixNums', 3, suffix, 'string', true)
 
local function cleanPattern(s)
-- Cleans a pattern so that the magic characters ()%.[]*+-?^$ are interpreted literally.
return s:gsub('([%(%)%%%.%[%]%*%+%-%?%^%$])', '%%%1')
end
end
table.sort(nums)
return nums
end
local function cleanPattern(s)
-- Cleans a pattern so that the magic characters ()%.[]*+-?^$ are interpreted literally.
return s:gsub('([%(%)%%%.%[%]%*%+%-%?%^%$])', '%%%1')
end


-- 搜索指定前后缀的整数键。
function p.affixNums(t, prefix, suffix)
prefix = prefix or ''
prefix = prefix or ''
suffix = suffix or ''
suffix = suffix or ''
第134行: 第122行:
suffix = cleanPattern(suffix)
suffix = cleanPattern(suffix)
local pattern = '^' .. prefix .. '([1-9]%d*)' .. suffix .. '$'
local pattern = '^' .. prefix .. '([1-9]%d*)' .. suffix .. '$'
local nums = {}
local nums = {}
for k, v in pairs(t) do
for k in pairs(t) do
if type(k) == 'string' then
if type(k) == 'string' then
local num = mw.ustring.match(k, pattern)
local num = mw.ustring.match(k, pattern)
if num then
if num then
第147行: 第136行:
end
end


--搜索指定前后缀的所有数字键,不限于整数。
------------------------------------------------------------------------------------
function p.allAffixNums(t, prefix, suffix)
-- numData
prefix = cleanPattern(prefix or '')
--
suffix = cleanPattern(suffix or '')
-- Given a table with keys like {"foo1", "bar1", "foo2", "baz2"}, returns a table
local pattern = string.format('^%s(.-)%s$', prefix, suffix)
-- of subtables in the format
local nums = {}
-- {[1] = {foo = 'text', bar = 'text'}, [2] = {foo = 'text', baz = 'text'}}.
for k, v in pairs(t) do
-- Keys that don't end with an integer are stored in a subtable named "other". The
if type(k) == 'string' then
-- compress option compresses the table so that it can be iterated over with
nums[#nums + 1] = tonumber(mw.ustring.match(k, pattern))
-- ipairs.
end
------------------------------------------------------------------------------------
end
table.sort(nums)
end
 
-- 将有("foo1", "bar1", "foo2", "baz2")这样键的表转换成
-- { [1] = {foo = 'text', bar = 'text'}, [2] = {foo = 'text', baz = 'text'} }
-- compress函数用来压实表以便用ipairs迭代。
function p.numData(t, compress)
function p.numData(t, compress)
checkType('numData', 1, t, 'table')
checkType('numData', 1, t, 'table')
checkType('numData', 2, compress, 'boolean', true)
local ret = {}
local ret = {}
for k, v in pairs(t) do
for k, v in pairs(t) do
第192行: 第175行:
end
end


-- 将像{a1='a1',b1='b1',a2='a2'}这样的表转换成
------------------------------------------------------------------------------------
-- {a = {'a1', 'a2'}, b = {'b1'}}
-- compressSparseArray
-- 注意可能是稀疏数组。
--
-- pattern是正则表达式,匹配前缀和数字。
-- This takes an array with one or more nil values, and removes the nil values
function p.allPrefixedNumKeys(t, pattern)
-- while preserving the order, so that the array can be safely traversed with
local ret = {}
-- ipairs.
for k, v in pairs(t) do
------------------------------------------------------------------------------------
local prefix, num = mw.ustring.match(tostring(k), pattern or '^([^0-9]*)([1-9][0-9]*)$')
num = tonumber(num)
if prefix and num then
local subtable = ret[prefix] or {}
subtable[num] = v
ret[prefix] = subtable
end
end
return ret
end
 
-- 将稀疏数组压实,移除nil值。
function p.compressSparseArray(t)
function p.compressSparseArray(t)
checkType('compressSparseArray', 1, t, 'table')
checkType('compressSparseArray', 1, t, 'table')
第222行: 第192行:
end
end


-- 将所有键为数字的字段转化成按数字大小排序的数组。
------------------------------------------------------------------------------------
function p.compressExtendedSparseArray(t)
-- sparseIpairs
checkType('compressExtendedSparseArray', 1, t, 'table')
--
local ret = {}
-- This is an iterator for sparse arrays. It can be used like ipairs, but can
local nums = p.allNumKeys(t)
-- handle nil values.
for _, num in ipairs(nums) do
------------------------------------------------------------------------------------
ret[#ret + 1] = t[num]
end
return ret
end
 
function p.sparseIpairs(t)
function p.sparseIpairs(t)
checkType('sparseIpairs', 1, t, 'table')
checkType('sparseIpairs', 1, t, 'table')
第249行: 第214行:
end
end


function p.extendedSparseIpairs(t)
------------------------------------------------------------------------------------
checkType('extendedSparseIpairs', 1, t, 'table')
-- size
local nums = p.allNumKeys(t)
--
local i = 0
-- This returns the size of a key/value pair table. It will also work on arrays,
local lim = #nums
-- but for arrays it is more efficient to use the # operator.
return function ()
------------------------------------------------------------------------------------
i = i + 1
if i <= lim then
local key = nums[i]
return key, t[key]
else
return nil, nil
end
end
end
 
-- 返回表中字段的数量。
function p.size(t)
function p.size(t)
checkType('size', 1, t, 'table')
checkType('size', 1, t, 'table')
local i = 0
local i = 0
for k in pairs(t) do
for _ in pairs(t) do
i = i + 1
i = i + 1
end
end
return i
return i
end
end
-- 返回表中字段的数量,但是忽略元表。
function p.rawSize(t)
checkType('rawSize', 1, t, 'table')
local i = 0
for k in next, t do
i = i + 1
end
return i
end


local function defaultKeySort(item1, item2)
local function defaultKeySort(item1, item2)
第291行: 第234行:
if type1 ~= type2 then
if type1 ~= type2 then
return type1 < type2
return type1 < type2
else -- This will fail with table, boolean, function.
elseif type1 == 'table' or type1 == 'boolean' or type1 == 'function' then
return tostring(item1) < tostring(item2)
else
return item1 < item2
return item1 < item2
end
end
end
end
 
------------------------------------------------------------------------------------
-- 返回表中的键的列表,并使用默认比较函数或者自定义keySort函数比较。
-- keysToList
--
-- Returns an array of the keys in a table, sorted using either a default
-- comparison function or a custom keySort function.
------------------------------------------------------------------------------------
function p.keysToList(t, keySort, checked)
function p.keysToList(t, keySort, checked)
if not checked then
if not checked then
checkType('keysToList', 1, t, 'table')
checkType('keysToList', 1, t, 'table')
checkTypeMulti('keysToList', 2, keySort, { 'function', 'boolean', 'nil' })
checkTypeMulti('keysToList', 2, keySort, {'function', 'boolean', 'nil'})
end
end
 
local list = {}
local arr = {}
local index = 1
local index = 1
for key, value in pairs(t) do
for k in pairs(t) do
list[index] = key
arr[index] = k
index = index + 1
index = index + 1
end
end
 
if keySort ~= false then
if keySort ~= false then
keySort = type(keySort) == 'function' and keySort or defaultKeySort
keySort = type(keySort) == 'function' and keySort or defaultKeySort
table.sort(arr, keySort)
table.sort(list, keySort)
end
end
return list
end


-- 返回表中的键的列表,并使用默认比较函数或者自定义keySort函数比较,但是忽略元表。
return arr
function p.rawKeysToList(t, keySort, checked)
if not checked then
checkType('keysToList', 1, t, 'table')
checkTypeMulti('keysToList', 2, keySort, { 'function', 'boolean', 'nil' })
end
local list = {}
local index = 1
for key, value in next, t do
list[index] = key
index = index + 1
end
if keySort ~= false then
keySort = type(keySort) == 'function' and keySort or defaultKeySort
table.sort(list, keySort)
end
return list
end
end


-- 排序后迭代。
------------------------------------------------------------------------------------
-- sortedPairs
--
-- Iterates through a table, with the keys sorted using the keysToList function.
-- If there are only numerical keys, sparseIpairs is probably more efficient.
------------------------------------------------------------------------------------
function p.sortedPairs(t, keySort)
function p.sortedPairs(t, keySort)
checkType('sortedPairs', 1, t, 'table')
checkType('sortedPairs', 1, t, 'table')
checkType('sortedPairs', 2, keySort, 'function', true)
checkType('sortedPairs', 2, keySort, 'function', true)
 
local list = p.keysToList(t, keySort, true)
local arr = p.keysToList(t, keySort, true)
 
local i = 0
local i = 0
return function()
return function ()
i = i + 1
i = i + 1
local key = list[i]
local key = arr[i]
if key ~= nil then
if key ~= nil then
return key, t[key]
return key, t[key]
第361行: 第291行:
end
end


-- 排序后迭代,但是忽略元表。
------------------------------------------------------------------------------------
function p.rawSortedPairs(t, keySort)
-- isArray
checkType('sortedPairs', 1, t, 'table')
--
checkType('sortedPairs', 2, keySort, 'function', true)
-- Returns true if the given value is a table and all keys are consecutive
-- integers starting at 1.
local list = p.rawKeysToList(t, keySort, true)
------------------------------------------------------------------------------------
function p.isArray(v)
if type(v) ~= 'table' then
return false
end
local i = 0
local i = 0
return function()
for _ in pairs(v) do
i = i + 1
i = i + 1
local key = list[i]
if v[i] == nil then
if key ~= nil then
return false
return key, t[key]
else
return nil, nil
end
end
end
end
return true
end
end


-- 判断一个表是否为严格的数组。
------------------------------------------------------------------------------------
function p.isArray(t)
-- isArrayLike
checkType("isArray", 1, t, "table")
--
-- Returns true if the given value is iterable and all keys are consecutive
-- integers starting at 1.
------------------------------------------------------------------------------------
function p.isArrayLike(v)
if not pcall(pairs, v) then
return false
end
local i = 0
local i = 0
for k, v in pairs(t) do
for _ in pairs(v) do
i = i + 1
i = i + 1
if t[i] == nil then
if v[i] == nil then
return false
return false
end
end
第394行: 第331行:
end
end


-- { "a", "b", "c" } -> { a = 1, b = 2, c = 3 }
------------------------------------------------------------------------------------
function p.invert(array)
-- invert
checkType("invert", 1, array, "table")
--
-- Transposes the keys and values in an array. For example, {"a", "b", "c"} ->
-- {a = 1, b = 2, c = 3}. Duplicates are not supported (result values refer to
-- the index of the last duplicate) and NaN values are ignored.
------------------------------------------------------------------------------------
function p.invert(arr)
checkType("invert", 1, arr, "table")
local isNan = p.isNan
local map = {}
local map = {}
for i, v in ipairs(array) do
for i, v in ipairs(arr) do
map[v] = i
if not isNan(v) then
map[v] = i
end
end
end
 
return map
return map
end
end


--[[
------------------------------------------------------------------------------------
{ "a", "b", "c" } -> { ["a"] = true, ["b"] = true, ["c"] = true }
-- listToSet
--]]
--
function p.listToSet(t)
-- Creates a set from the array part of the table. Indexing the set by any of the
checkType("listToSet", 1, t, "table")
-- values of the array returns true. For example, {"a", "b", "c"} ->
-- {a = true, b = true, c = true}. NaN values are ignored as Lua considers them
-- never equal to any value (including other NaNs or even themselves).
------------------------------------------------------------------------------------
function p.listToSet(arr)
checkType("listToSet", 1, arr, "table")
local isNan = p.isNan
local set = {}
local set = {}
for _, item in ipairs(t) do
for _, v in ipairs(arr) do
set[item] = true
if not isNan(v) then
set[v] = true
end
end
end
 
return set
return set
end
end


-- 递归深度拷贝,保护标识和子表。
------------------------------------------------------------------------------------
-- deepCopy
--
-- Recursive deep copy function. Preserves identities of subtables.
------------------------------------------------------------------------------------
local function _deepCopy(orig, includeMetatable, already_seen)
local function _deepCopy(orig, includeMetatable, already_seen)
-- Stores copies of tables indexed by the original table.
if type(orig) ~= "table" then
already_seen = already_seen or {}
return orig
end
-- already_seen stores copies of tables indexed by the original table.
local copy = already_seen[orig]
local copy = already_seen[orig]
if copy ~= nil then
if copy ~= nil then
第430行: 第388行:
end
end
if type(orig) == 'table' then
copy = {}
copy = {}
already_seen[orig] = copy -- memoize before any recursion, to avoid infinite loops
for orig_key, orig_value in pairs(orig) do
copy[_deepCopy(orig_key, includeMetatable, already_seen)] = _deepCopy(orig_value, includeMetatable, already_seen)
for orig_key, orig_value in pairs(orig) do
copy[_deepCopy(orig_key, includeMetatable, already_seen)] = _deepCopy(orig_value, includeMetatable, already_seen)
end
if includeMetatable then
local mt = getmetatable(orig)
if mt ~= nil then
setmetatable(copy, _deepCopy(mt, true, already_seen))
end
end
already_seen[orig] = copy
if includeMetatable then
local mt = getmetatable(orig)
if mt ~= nil then
local mt_copy = _deepCopy(mt, includeMetatable, already_seen)
setmetatable(copy, mt_copy)
already_seen[mt] = mt_copy
end
end
else -- number, string, boolean, etc
copy = orig
end
end
return copy
return copy
end
end
第453行: 第407行:
function p.deepCopy(orig, noMetatable, already_seen)
function p.deepCopy(orig, noMetatable, already_seen)
checkType("deepCopy", 3, already_seen, "table", true)
checkType("deepCopy", 3, already_seen, "table", true)
return _deepCopy(orig, not noMetatable, already_seen or {})
return _deepCopy(orig, not noMetatable, already_seen)
end
end


-- sparseConcat{ a, nil, c, d }  =>  "acd"
------------------------------------------------------------------------------------
-- sparseConcat{ nil, b, c, d }  =>  "bcd"
-- sparseConcat
--
-- Concatenates all values in the table that are indexed by a number, in order.
-- sparseConcat{a, nil, c, d}  =>  "acd"
-- sparseConcat{nil, b, c, d}  =>  "bcd"
------------------------------------------------------------------------------------
function p.sparseConcat(t, sep, i, j)
function p.sparseConcat(t, sep, i, j)
local list = {}
local arr = {}
 
local list_i = 0
local arr_i = 0
for _, v in p.sparseIpairs(t) do
for _, v in p.sparseIpairs(t) do
list_i = list_i + 1
arr_i = arr_i + 1
list[list_i] = v
arr[arr_i] = v
end
end
return table.concat(list, sep, i, j)
end


function p.inArray(arr, valueToFind)
return table.concat(arr, sep, i, j)
checkType("inArray", 1, arr, "table")
for _, v in ipairs(arr) do
if v == valueToFind then
return true
end
end
return false
end
 
function p.visit(t,notNum)
local keys = {}
for k, v in pairs(t) do
if type(k)=="number" then
table.insert(keys,k)
else
if notNum then
    notNum(k,v,keys,t)
end
end
end
local i = 0
return function()
i = i+1
return keys[i],key[i] and t[keys[i]]
end
end
end


------------------------------------------------------------------------------------
-- length
--
-- Finds the length of an array, or of a quasi-array with keys such as "data1",
-- "data2", etc., using an exponential search algorithm. It is similar to the
-- operator #, but may return a different value when there are gaps in the array
-- portion of the table. Intended to be used on data loaded with mw.loadData. For
-- other tables, use #.
-- Note: #frame.args in frame object always be set to 0, regardless of  the number
-- of unnamed template parameters, so use this function for frame.args.
------------------------------------------------------------------------------------
function p.length(t, prefix)
function p.length(t, prefix)
-- requiring module inline so that [[Module:Exponential search]]
-- requiring module inline so that [[Module:Exponential search]] which is
-- which is only needed by this one function
-- only needed by this one function doesn't get millions of transclusions
-- doesn't get millions of transclusions
local expSearch = require("Module:Exponential search")
local expSearch = require("Module:Exponential search")
checkType('length', 1, t, 'table')
checkType('length', 1, t, 'table')
checkType('length', 2, prefix, 'string', true)
checkType('length', 2, prefix, 'string', true)
return expSearch(function(i)
return expSearch(function (i)
local key
local key
if prefix then
if prefix then
第518行: 第456行:
end) or 0
end) or 0
end
end
------------------------------------------------------------------------------------
-- inArray
--
-- Returns true if searchElement is a member of the array, and false otherwise.
-- Equivalent to JavaScript array.includes(searchElement) or
-- array.includes(searchElement, fromIndex), except fromIndex is 1 indexed
------------------------------------------------------------------------------------
function p.inArray(array, searchElement, fromIndex)
checkType("inArray", 1, array, "table")
-- if searchElement is nil, error?
fromIndex = tonumber(fromIndex)
if fromIndex then
if (fromIndex < 0) then
fromIndex = #array + fromIndex + 1
end
if fromIndex < 1 then fromIndex = 1 end
for _, v in ipairs({unpack(array, fromIndex)}) do
if v == searchElement then
return true
end
end
else
for _, v in pairs(array) do
if v == searchElement then
return true
end
end
end
return false
end
------------------------------------------------------------------------------------
-- merge
--
-- Given the arrays, returns an array containing the elements of each input array
-- in sequence.
------------------------------------------------------------------------------------
function p.merge(...)
local arrays = {...}
local ret = {}
for i, arr in ipairs(arrays) do
checkType('merge', i, arr, 'table')
for _, v in ipairs(arr) do
ret[#ret + 1] = v
end
end
return ret
end
------------------------------------------------------------------------------------
-- extend
--
-- Extends the first array in place by appending all elements from the second
-- array.
------------------------------------------------------------------------------------
function p.extend(arr1, arr2)
checkType('extend', 1, arr1, 'table')
checkType('extend', 2, arr2, 'table')
for _, v in ipairs(arr2) do
arr1[#arr1 + 1] = v
end
end
function p.allNumKeys(t)
local nums = {}
for k, v in pairs(t) do
if type(k)=='number' then
nums[#nums + 1] = k
end
end
table.sort(nums)
return nums
end
local function cleanPattern(s)
-- Cleans a pattern so that the magic characters ()%.[]*+-?^$ are interpreted literally.
return s:gsub('([%(%)%%%.%[%]%*%+%-%?%^%$])', '%%%1')
end
-- 搜索指定前后缀的整数键。
function p.extendedSparseIpairs(t)
checkType('extendedSparseIpairs', 1, t, 'table')
local nums = p.allNumKeys(t)
local i = 0
local lim = #nums
return function ()
i = i + 1
if i <= lim then
local key = nums[i]
return key, t[key]
else
return nil, nil
end
end
end
-- 返回表中字段的数量。
return p
return p