Module:TableTools - Revision history

Sanctaria: 7 revisions imported

2021-12-22T19:36:41Z

7 revisions imported

← Older revision		Revision as of 14:36, 22 December 2021
(No difference)

en>MSGJ: improved module formatting; improved isArray; added isArrayLike; fixed _deepCopy; and improved defaultKeySort, code by User:Alexiscoutinho

2021-10-04T10:40:18Z

improved module formatting; improved isArray; added isArrayLike; fixed _deepCopy; and improved defaultKeySort, code by User:Alexiscoutinho

Show changes

en>GorillaWarfare: Changed protection level for "Module:TableTools": High-risk Lua module: bumping protection level due to high usage, plus the stability of the module. See https://en.wikipedia.org/w/index.php?title=Wikipedia:Requests_for_page_protection&oldid=983044034#Module:TableTools ([Edit=Require administrator access] (indefinite) [Move=Require administrator access] (indefinite))

2020-10-11T22:22:43Z

Changed protection level for "Module:TableTools": High-risk Lua module: bumping protection level due to high usage, plus the stability of the module. See https://en.wikipedia.org/w/index.php?title=Wikipedia:Requests_for_page_protection&oldid=983044034#Module:TableTools ([Edit=Require administrator access] (indefinite) [Move=Require administrator access] (indefinite))

← Older revision		Revision as of 17:22, 11 October 2020
(No difference)

en>Dinoguy1000: from sandbox: another slight code simplification and a couple comment fixes

2020-05-23T15:51:01Z

from sandbox: another slight code simplification and a couple comment fixes

← Older revision		Revision as of 10:51, 23 May 2020
Line 129:		Line 129:
	local function cleanPattern(s)		local function cleanPattern(s)
	-- Cleans a pattern so that the magic characters ()%.[]*+-?^$ are interpreted literally.		-- Cleans a pattern so that the magic characters ()%.[]*+-?^$ are interpreted literally.
	~~s =~~ s:gsub('([%(%)%%%.%[%]%*%+%-%?%^%$])', '%%%1')		return s:gsub('([%(%)%%%.%[%]%*%+%-%?%^%$])', '%%%1')
	~~return s~~
	end		end

Line 415:		Line 414:
	--[[		--[[
	-- Finds the length of an array, or of a quasi-array with keys such		-- Finds the length of an array, or of a quasi-array with keys such
	-- as "data1", "data2", etc., using an ~~exponental~~ search algorithm.		-- as "data1", "data2", etc., using an exponential search algorithm.
	-- It is similar to the operator #, but may return		-- It is similar to the operator #, but may return
	-- a different value when there are gaps in the array portion of the table.		-- a different value when there are gaps in the array portion of the table.
Line 425:		Line 424:

	function p.length(t, prefix)		function p.length(t, prefix)
	-- requiring module inline so that [[Module:~~Exponental~~ search]]		-- requiring module inline so that [[Module:Exponential search]]
	-- which is only needed by this one function		-- which is only needed by this one function
	-- doesn't get millions of transclusions		-- doesn't get millions of transclusions

en>Pppery: Finally getting around to merging in Module:Array length (originally written by Mr. Stradivarius) over six months after writing the merged code, also minor code simplify per Dinoguy1000 on talk page

2019-12-21T03:39:49Z

Finally getting around to merging in Module:Array length (originally written by Mr. Stradivarius) over six months after writing the merged code, also minor code simplify per Dinoguy1000 on talk page

← Older revision		Revision as of 22:39, 20 December 2019
Line 30:		Line 30:
	--]]		--]]
	function p.isPositiveInteger(v)		function p.isPositiveInteger(v)
	if type(v) == 'number' and v >= 1 and floor(v) == v and v < infinity ~~then~~		return type(v) == 'number' and v >= 1 and floor(v) == v and v < infinity
	~~return true~~
	~~else~~
	~~return false~~
	~~end~~
	end		end

Line 48:		Line 44:
	--]]		--]]
	function p.isNan(v)		function p.isNan(v)
	if type(v) == 'number' and tostring(v) == '-nan' ~~then~~		return type(v) == 'number' and tostring(v) == '-nan'
	~~return true~~
	~~else~~
	~~return false~~
	~~end~~
	end		end

Line 422:		Line 414:

	--[[		--[[
	-- ~~This returns~~ the length of ~~a table~~, or ~~the first integer key n counting from~~		-- Finds the length of an array, or of a quasi-array with keys such
	-- ~~1 such that t[n + 1] is nil~~. It is similar to the operator #, but may return		-- as "data1", "data2", etc., using an exponental 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.		-- 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 #.		-- Intended to be used on data loaded with mw.loadData. For other tables, use #.
Line 430:		Line 423:
	-- frame.args.		-- frame.args.
	--]]		--]]
	function p.length(t)
	local i = 1		function p.length(t, prefix)
	~~while t[~~i~~] ~~~= ~~nil do~~		-- requiring module inline so that [[Module:Exponental search]]
	i = i ~~+ 1~~		-- which is only needed by this one function
	end		-- doesn't get millions of transclusions
	~~return i - 1~~		local expSearch = require("Module:Exponential search")
			checkType('length', 1, t, 'table')
			checkType('length', 2, prefix, 'string', true)
			return expSearch(function(i)
			local key
			if prefix then
			key = prefix .. tostring(i)
			else
			key = i
			end
			return t[key] ~= nil
			end) or 0
	end		end

	function p.inArray(arr, valueToFind)		function p.inArray(arr, valueToFind)
	checkType("inArray", 1, arr, "table")		checkType("inArray", 1, arr, "table")

en>Alex 21: Implementing talk page edit requested

2019-03-12T13:06:11Z

Implementing talk page edit requested

← Older revision		Revision as of 08:06, 12 March 2019
Line 426:		Line 426:
	-- a different value when there are gaps in the array portion of the table.		-- 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 #.		-- 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)		function p.length(t)
	local i = 0		local i = 1
	~~repeat~~		while t[i] ~= nil do
	i = i + 1		i = i + 1
	~~until t[i] == nil~~		end
	return i - 1		return i - 1
	end		end

en>Pppery at 21:35, 19 February 2019

2019-02-19T21:35:25Z

← Older revision		Revision as of 16:35, 19 February 2019
Line 304:		Line 304:
	]]		]]
	function p.sortedPairs(t, keySort)		function p.sortedPairs(t, keySort)
	~~local check = _check('keysToList')~~
	checkType('sortedPairs', 1, t, 'table')		checkType('sortedPairs', 1, t, 'table')
	checkType('sortedPairs', 2, keySort, 'function', true)		checkType('sortedPairs', 2, keySort, 'function', true)

en>Pppery: Implementing merger with Module:Table

2019-02-19T21:28:24Z

Implementing merger with Module:Table

Show changes

Sanctaria: 41 revisions imported

2018-06-12T07:34:19Z

41 revisions imported

← Older revision		Revision as of 02:34, 12 June 2018
(No difference)

Sanctaria: 1 revision imported

2018-06-11T08:51:01Z

1 revision imported

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