Modul:TableTools: Unterschied zwischen den Versionen

Permanently protected module
IMT HilfeWiki - das Wiki
K (Schützte „Modul:TableTools“ ([Bearbeiten=Nur Administratoren erlauben] (unbeschränkt) [Verschieben=Nur Administratoren erlauben] (unbeschränkt)))
Zeile 293: Zeile 293:
 
return t
 
return t
 
end
 
end
 
 
if not indent then
 
if not indent then
 
indent = ''
 
indent = ''
else
+
elseif indent ~= 'inline' then
 
indent = indent .. '\t'
 
indent = indent .. '\t'
 
end
 
end
 
+
ret = '{' .. (indent == 'inline' and ' ' or '\n')
ret = '{\n'
 
 
for k, v in pairs(t) do
 
for k, v in pairs(t) do
ret = ret .. indent .. '\t' .. k .. ' = '
+
-- print key part
if type(v) ~= 'table' then
+
ret = ret .. (indent ~= 'inline' and indent .. '\t' or '' ) ..  
ret = ret .. "'" .. v .. "'\n"
+
(type(k) ~= 'number' and tostring(k) .. ' = ' or '')
 +
-- print value part
 +
if type(v) == 'boolean' then
 +
ret = ret .. (v and 'true' or 'false') .. ""
 +
elseif type(v) ~= 'table' then
 +
if type(v) == 'function' then
 +
ret = ret .. "FUNCTION"
 +
elseif type(v) == 'number' or mw.ustring.match(v, '^[0-9]+$') then
 +
ret = ret .. v .. ""
 +
else
 +
local valMangled = mw.text.trim(v)
 +
--- here see to it, that ' are escapged
 +
valMangled = mw.ustring.gsub(mw.ustring.gsub(valMangled, "\\'", "'"), "'", "\\'")
 +
if indet ~= 'inline' then
 +
valMangled = mw.ustring.gsub(valMangled, '\n', '\\n\' ..\n' .. indent .. '\t\'')
 +
end
 +
ret = ret .. "'" .. valMangled .. "'"
 +
end
 
else
 
else
 
ret = ret .. p.printTable(v, indent)
 
ret = ret .. p.printTable(v, indent)
 +
end
 +
if indent ~= 'inline' then
 +
ret = ret .. ',\n'
 +
else
 +
ret = ret .. ', '
 
end
 
end
 
end
 
end
+
return ret .. (indent ~= 'inline' and indent or '') .. '}'
return ret .. indent .. '}\n'
 
 
end
 
end
  
  
 
return p
 
return p

Version vom 8. Januar 2016, 09:51 Uhr

Documentation icon Module documentation

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.

Loading the module[Quelltext bearbeiten]

To use any of the functions, first you must load the module.

local TableTools = require('Module:TableTools')

isPositiveInteger[Quelltext bearbeiten]

TableTools.isPositiveInteger(value)

Returns true if 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.

isNan[Quelltext bearbeiten]

TableTools.isNan(value)

Returns true if value 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 value is used as a table key.)

shallowClone[Quelltext bearbeiten]

TableTools.shallowClone(t)

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. If you want to make a new table with no shared subtables and with metatables transferred, you can use mw.clone instead. If you want to make a new table with no shared subtables and without metatables transferred, use deepCopy with the noMetatable option.

removeDuplicates[Quelltext bearbeiten]

TableTools.removeDuplicates(t)

Removes duplicate values from an array. This function is only designed to work with standard arrays: keys that are not positive integers are ignored, as are all values after the first nil value. (For arrays containing nil values, you can use compressSparseArray first.) The function tries to preserve the order of the array: the earliest non-unique value is kept, and all subsequent duplicate values are removed. For example, for the table {5, 4, 4, 3, 4, 2, 2, 1}, removeDuplicates will return {5, 4, 3, 2, 1}.

numKeys[Quelltext bearbeiten]

TableTools.numKeys(t)

Takes a table t and returns an array containing the numbers of any positive integer keys that have non-nil values, sorted in numerical order. For example, for the table {'foo', nil, 'bar', 'baz', a = 'b'}, numKeys will return {1, 3, 4}.

affixNums[Quelltext bearbeiten]

TableTools.affixNums(t, prefix, suffix)

Takes a table t and returns an array containing the numbers of keys with the optional prefix prefix and the optional suffix suffix. For example, for the table {a1 = 'foo', a3 = 'bar', a6 = 'baz'} and the prefix 'a', affixNums will return {1, 3, 6}. All characters in prefix and suffix are interpreted literally.

numData[Quelltext bearbeiten]

TableTools.numData(t, compress)

Given a table with keys like "foo1", "bar1", "foo2", and "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.

compressSparseArray[Quelltext bearbeiten]

TableTools.compressSparseArray(t)

Takes an array t 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. Any keys that are not positive integers are removed. For example, for the table {1, nil, foo = 'bar', 3, 2}, compressSparseArray will return {1, 3, 2}.

sparseIpairs[Quelltext bearbeiten]

TableTools.sparseIpairs(t)

This is an iterator function for traversing a sparse array t. It is similar to ipairs, but will continue to iterate until the highest numerical key, whereas ipairs may stop after the first nil value. Any keys that are not positive integers are ignored.

Usually sparseIpairs is used in a generic for loop.

for i, v in TableTools.sparseIpairs(t) do
   -- code block
end

Note that sparseIpairs uses the pairs function in its implementation. Although some table keys appear to be ignored, all table keys are accessed when it is run.

size[Quelltext bearbeiten]

TableTools.size(t)

Finds the size of a key/value pair table. For example, for the table {foo = 'foo', bar = 'bar'}, size will return 2. The function will also work on arrays, but for arrays it is more efficient to use the # operator. Note that to find the table size, this function uses the pairs function to iterate through all of the table keys.

keysToList[Quelltext bearbeiten]

TableTools.keysToList(t, keySort, checked)

Returns a list of the keys in a table, sorted using either a default comparison function or a custom keySort function, which follows the same rules as the comp function supplied to table.sort. If keySort is false, no sorting is done. Set checked to true to skip the internal type checking.

sortedPairs[Quelltext bearbeiten]

TableTools.sortedPairs(t, keySort)

Iterates through a table, with the keys sorted using the keysToList function. If there are only numerical keys, sparseIpairs is probably more efficient.

isArray[Quelltext bearbeiten]

TableTools.isArray(value)

Returns true if value is a table and all keys are consecutive integers starting at 1.

isArrayLike[Quelltext bearbeiten]

TableTools.isArrayLike(value)

Returns true if value is iterable and all keys are consecutive integers starting at 1.

invert[Quelltext bearbeiten]

TableTools.invert(arr)

Transposes the keys and values in an array. For example, lua yields { a=1, b=2, c=3 }.

listToSet[Quelltext bearbeiten]

TableTools.listToSet(arr)

Creates a set from the array part of the table arr. Indexing the set by any of the values of the array returns true. For example, lua yields { a=true, b=true, c=true }. See also Module:Lua set for more advanced ways to create a set.

deepCopy[Quelltext bearbeiten]

TableTools.deepCopy(orig, noMetatable, alreadySeen)

Creates a copy of the table orig. As with mw.clone, all values that are not functions are duplicated and the identity of tables is preserved. If noMetatable is true, then the metatable (if any) is not copied. Can copy tables loaded with mw.loadData.

Similar to mw.clone, but mw.clone cannot copy tables loaded with mw.loadData and does not allow metatables not to be copied.

sparseConcat[Quelltext bearbeiten]

TableTools.sparseConcat(t, sep, i, j)

Concatenates all values in the table that are indexed by a positive integer, in order. For example, lua yields lua and lua yields lua.

length[Quelltext bearbeiten]

TableTools.length(t, prefix)

Finds the length of an array or of a quasi-array with keys with an optional prefix such as "data1", "data2", etc. It uses an exponential search algorithm to find the length, so as to use as few table lookups as possible.

This algorithm is useful for arrays that use metatables (e.g. frame.args) and for quasi-arrays. For normal arrays, just use the # operator, as it is implemented in C and will be quicker.

inArray[Quelltext bearbeiten]

TableTools.inArray(arr, valueToFind)

Returns true if valueToFind is a member of the array arr, and false otherwise.


inTable[Quelltext bearbeiten]

TableTools.inTable(t, val)

Returns true (more precise: the corresponding key), if val is found in table t, false otherwise. Does no type or case mangling (aka if 'a' is in table and val is 'A', return false).

printTable[Quelltext bearbeiten]

TableTools.printTable(t)

Returns a string representation of table t. This is best put between <pre>...</pre> and normally used for debug purposes.

--[[
------------------------------------------------------------------------------------
--                               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

--[[
------------------------------------------------------------------------------------
-- inTable
--
-- This returns true (the key), if the value is found in the table, false otherwise
------------------------------------------------------------------------------------
--]]
function p.inTable(t, val)
	
	for k, v in pairs(t) do
		if val == v then
			return k
		end
	end

	return false
end

--[[
------------------------------------------------------------------------------------
-- printTable
--
-- This returns a string representation of a table, best printed within
-- <pre>..</pre> tags
-- Useful for debug purposes
------------------------------------------------------------------------------------
--]]
function p.printTable(t, indent)

	local ret
	if type(t) ~= 'table' then
		return t
	end
	if not indent then
		indent = ''
	elseif indent ~= 'inline' then
		indent = indent .. '\t'
	end
	ret = '{' .. (indent == 'inline' and ' ' or '\n')
	for k, v in pairs(t) do
		-- print key part
		ret = ret .. (indent ~= 'inline' and indent .. '\t' or '' ) .. 
			(type(k) ~= 'number' and tostring(k) .. ' = ' or '')
		-- print value part
		if type(v) == 'boolean' then
			ret = ret .. (v and 'true' or 'false') .. ""
		elseif type(v) ~= 'table' then
			if type(v) == 'function' then
				ret = ret .. "FUNCTION"
			elseif type(v) == 'number' or mw.ustring.match(v, '^[0-9]+$') then
				ret = ret .. v .. ""
			else
				local valMangled = mw.text.trim(v)
				--- here see to it, that ' are escapged
				valMangled = mw.ustring.gsub(mw.ustring.gsub(valMangled, "\\'", "'"), "'", "\\'")
				if indet ~= 'inline' then
					valMangled = mw.ustring.gsub(valMangled, '\n', '\\n\' ..\n' .. indent .. '\t\'')
				end
				ret = ret .. "'" .. valMangled .. "'"
			end
		else
			ret = ret .. p.printTable(v, indent)
		end
		if indent ~= 'inline' then
			ret = ret .. ',\n'
		else
			ret = ret .. ', '
		end
	end
	return ret .. (indent ~= 'inline' and indent or '') .. '}'
end


return p
Cookies helfen uns bei der Bereitstellung des IMT HilfeWikis. Bei der Nutzung vom IMT HilfeWiki werden die in der Datenschutzerklärung beschriebenen Cookies gespeichert.