Module:TableTools - Revision history

Timothy: 1 revision imported

2025-08-05T14:21:30Z

1 revision imported

← Older revision	Revision as of 10:21, 5 August 2025
(No difference)

wikipedia>Pppery: Update from sandbox per request

2024-08-18T04:19:07Z

Update from sandbox per request

← Older revision		Revision as of 00:19, 18 August 2024
Line 72:		Line 72:
	-- 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
Line 380:		Line 378:
	------------------------------------------------------------------------------------		------------------------------------------------------------------------------------
	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
	return copy		return copy
	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
	end		copy[_deepCopy(orig_key, includeMetatable, already_seen)] = _deepCopy(orig_value, includeMetatable, already_seen)
	~~already_seen[orig] = copy~~		end

	if includeMetatable then		if includeMetatable then
	local mt = getmetatable(orig)		local mt = getmetatable(orig)
	if mt ~= nil then		if mt ~= nil then
	~~local mt_copy =~~ _deepCopy(mt, ~~includeMetatable~~, already_seen)		setmetatable(copy, _deepCopy(mt, true, already_seen))
	~~setmetatable(copy, mt_copy~~)
	~~already_seen[mt] = mt_copy~~
	~~end~~
	end		end
	~~else -- number, string, boolean, etc~~
	~~copy = orig~~
	end		end

	return copy		return copy
	end		end
Line 411:		Line 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)		return _deepCopy(orig, not noMetatable, already_seen or {})
	end		end

Line 464:		Line 460:
	-- inArray		-- inArray
	--		--
	-- Returns true if ~~valueToFind~~ is a member of the array, and false otherwise.		-- 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(~~arr~~, ~~valueToFind~~)		function p.inArray(array, searchElement, fromIndex)
	checkType("inArray", 1, ~~arr~~, "table")		checkType("inArray", 1, array, "table")
	-- if ~~valueToFind~~ is nil, error?		-- if searchElement is nil, error?

	for _, v in ipairs(~~arr~~) do		fromIndex = tonumber(fromIndex)
	if v == ~~valueToFind~~ then		if fromIndex then
	return true		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
	end		end
	return false		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		end

	return p		return p

Timothy: 1 revision imported

2023-06-12T15:53:33Z

1 revision imported

← Older revision	Revision as of 11:53, 12 June 2023
(No difference)

Timothy: 1 revision imported

2022-03-23T22:18:15Z

1 revision imported

← Older revision	Revision as of 18:18, 23 March 2022
(No difference)

wikipedia>MSGJ: updates/fixes requested by User:Uzume

2022-01-31T13:08:18Z

updates/fixes requested by User:Uzume

Show changes

wikimedia>4nn1l2: Changed protection level for "Module:TableTools": downgraded protection level per consensus ([Move=Allow only template editors and administrators] (indefinite) [Edit=Allow only template editors and administrators] (indefinite))

2019-07-16T11:22:04Z

Changed protection level for "Module:TableTools": downgraded protection level per consensus ([Move=Allow only template editors and administrators] (indefinite) [Edit=Allow only template editors and administrators] (indefinite))

New page

--[[
------------------------------------------------------------------------------------
-- TableTools --
-- --
-- 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 --
-- not be called directly from #invoke. --
------------------------------------------------------------------------------------
--]]

local libraryUtil = require('libraryUtil')

local p = {}

-- Define often-used variables and functions.
local floor = math.floor
local infinity = math.huge
local checkType = libraryUtil.checkType

--[[
------------------------------------------------------------------------------------
-- isPositiveInteger
--
-- This function returns true if the given value is a positive integer, and false
-- if not. Although it doesn't operate on tables, it is included here as it is
-- useful for determining whether a given table key is in the array part or the
-- hash part of a table.
------------------------------------------------------------------------------------
--]]
function p.isPositiveInteger(v)
if type(v) == 'number' and v >= 1 and floor(v) == v and v < infinity then
return true
else
return false
end
end

--[[
------------------------------------------------------------------------------------
-- isNan
--
-- This function returns true if the given number is a NaN value, and false
-- if not. Although it doesn't operate on tables, it is included here as it is
-- useful for determining whether a value can be a valid table key. Lua will
-- generate an error if a NaN is used as a table key.
------------------------------------------------------------------------------------
--]]
function p.isNan(v)
if type(v) == 'number' and tostring(v) == '-nan' then
return true
else
return false
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)
local ret = {}
for k, v in pairs(t) do
ret[k] = v
end
return ret
end

--[[
------------------------------------------------------------------------------------
-- removeDuplicates
--
-- This removes duplicate values from an array. Non-positive-integer keys are
-- ignored. The earliest value is kept, and all subsequent duplicate values are
-- removed, but otherwise the array order is unchanged.
------------------------------------------------------------------------------------
--]]
function p.removeDuplicates(t)
checkType('removeDuplicates', 1, t, 'table')
local isNan = p.isNan
local ret, exists = {}, {}
for i, v in ipairs(t) do
if isNan(v) then
-- NaNs can't be table keys, and they are also unique, so we don't need to check existence.
ret[#ret + 1] = v
else
if not exists[v] then
ret[#ret + 1] = v
exists[v] = true
end
end
end
return ret
end

--[[
------------------------------------------------------------------------------------
-- 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)
checkType('numKeys', 1, t, 'table')
local isPositiveInteger = p.isPositiveInteger
local nums = {}
for k, v in pairs(t) do
if isPositiveInteger(k) then
nums[#nums + 1] = k
end
end
table.sort(nums)
return nums
end

--[[
------------------------------------------------------------------------------------
-- affixNums
--
-- This takes a table and returns an array containing the numbers of keys with the
-- specified prefix and suffix. For example, for the table
-- {a1 = 'foo', a3 = 'bar', a6 = 'baz'} and the prefix "a", affixNums will
-- return {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.
s = s:gsub('([%(%)%%%.%[%]%*%+%-%?%^%$])', '%%%1')
return s
end

prefix = prefix or ''
suffix = suffix or ''
prefix = cleanPattern(prefix)
suffix = cleanPattern(suffix)
local pattern = '^' .. prefix .. '([1-9]%d*)' .. suffix .. '$'

local nums = {}
for k, v in pairs(t) do
if type(k) == 'string' then
local num = mw.ustring.match(k, pattern)
if num then
nums[#nums + 1] = tonumber(num)
end
end
end
table.sort(nums)
return nums
end

--[[
------------------------------------------------------------------------------------
-- numData
--
-- Given a table with keys like ("foo1", "bar1", "foo2", "baz2"), returns a table
-- of subtables in the format
-- { [1] = {foo = 'text', bar = 'text'}, [2] = {foo = 'text', baz = 'text'} }
-- Keys that don't end with an integer are stored in a subtable named "other".
-- The compress option compresses the table so that it can be iterated over with
-- ipairs.
------------------------------------------------------------------------------------
--]]
function p.numData(t, compress)
checkType('numData', 1, t, 'table')
checkType('numData', 2, compress, 'boolean', true)
local ret = {}
for k, v in pairs(t) do
local prefix, num = mw.ustring.match(tostring(k), '^([^0-9]*)([1-9][0-9]*)$')
if num then
num = tonumber(num)
local subtable = ret[num] or {}
if prefix == '' then
-- Positional parameters match the blank string; put them at the start of the subtable instead.
prefix = 1
end
subtable[prefix] = v
ret[num] = subtable
else
local subtable = ret.other or {}
subtable[k] = v
ret.other = subtable
end
end
if compress then
local other = ret.other
ret = p.compressSparseArray(ret)
ret.other = other
end
return ret
end

--[[
------------------------------------------------------------------------------------
-- compressSparseArray
--
-- This takes an array with one or more nil values, and removes the nil values
-- while preserving the order, so that the array can be safely traversed with
-- ipairs.
------------------------------------------------------------------------------------
--]]
function p.compressSparseArray(t)
checkType('compressSparseArray', 1, t, 'table')
local ret = {}
local nums = p.numKeys(t)
for _, num in ipairs(nums) do
ret[#ret + 1] = t[num]
end
return ret
end

--[[
------------------------------------------------------------------------------------
-- sparseIpairs
--
-- This is an iterator for sparse arrays. It can be used like ipairs, but can
-- handle nil values.
------------------------------------------------------------------------------------
--]]
function p.sparseIpairs(t)
checkType('sparseIpairs', 1, t, 'table')
local nums = p.numKeys(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

--[[
------------------------------------------------------------------------------------
-- size
--
-- This returns the size of a key/value pair table. It will also work on arrays,
-- but for arrays it is more efficient to use the # operator.
------------------------------------------------------------------------------------
--]]
function p.size(t)
checkType('size', 1, t, 'table')
local i = 0
for k in pairs(t) do
i = i + 1
end
return i
end

return p