Files
ashlar/lib/lua/tableHelper.lua
T

397 lines
10 KiB
Lua

local tableHelper = {}
-- Swap keys with their values in a table, allowing for the easy creation of tables similar to enums
function tableHelper.enum(inputTable)
local newTable = {}
for key, value in ipairs(inputTable) do
newTable[value] = key
end
return newTable
end
function tableHelper.getCount(inputTable)
local count = 0
for key in pairs(inputTable) do count = count + 1 end
return count
end
-- Iterate through comma-separated values in a string and turn them into table values
function tableHelper.getTableFromCommaSplit(inputString)
local newTable = {}
for value in string.gmatch(inputString, patterns.commaSplit) do
table.insert(newTable, value)
end
return newTable
end
-- Concatenate the indexes in a table, useful for printing out all the valid
-- indexes
function tableHelper.concatenateTableIndexes(inputTable, delimiter)
local resultString = ""
local tableCount = tableHelper.getCount(inputTable)
local indexesSoFar = 1
if delimiter == nil then
delimiter = " "
end
for index, value in pairs(inputTable) do
resultString = resultString .. index
if indexesSoFar < tableCount then
resultString = resultString .. delimiter
end
indexesSoFar = indexesSoFar + 1
end
return resultString
end
-- Concatenate the values in an array, useful for printing out the array's
-- contents, with an optional delimiter between values
function tableHelper.concatenateArrayValues(inputTable, startIndex, delimiter)
local resultString = ""
if startIndex == nil then
startIndex = 1
end
if delimiter == nil then
delimiter = " "
end
for i = startIndex, #inputTable do
resultString = resultString .. inputTable[i]
if i ~= #inputTable then
resultString = resultString .. delimiter
end
end
return resultString
end
function tableHelper.concatenateFromIndex(inputTable, startIndex, delimiter)
return tableHelper.concatenateArrayValues(inputTable, startIndex, delimiter)
end
-- Check whether a table contains a key/value pair, optionally checking inside
-- nested tables
function tableHelper.containsKeyValue(inputTable, keyToFind, valueToFind, checkNestedTables)
if inputTable[keyToFind] ~= nil then
if inputTable[keyToFind] == valueToFind then
return true
end
elseif checkNestedTables == true then
for key, value in pairs(inputTable) do
if type(value) == "table" and tableHelper.containsKeyValue(value, keyToFind, valueToFind, true) then
return true
end
end
end
return false
end
-- Check whether a table contains a certain value, optionally checking inside
-- nested tables
function tableHelper.containsValue(inputTable, valueToFind, checkNestedTables)
for key, value in pairs(inputTable) do
if checkNestedTables == true and type(value) == "table" then
if tableHelper.containsValue(value, valueToFind, true) == true then
return true
end
elseif value == valueToFind then
return true
end
end
return false
end
function tableHelper.insertValueIfMissing(inputTable, value)
if tableHelper.containsValue(inputTable, value, false) == false then
table.insert(inputTable, value)
end
end
function tableHelper.getAnyValue(inputTable)
for key, value in pairs(inputTable) do
return value
end
end
function tableHelper.getUnusedNumericalIndex(inputTable)
local i = 1
while inputTable[i] ~= nil do
i = i + 1
end
return i
end
function tableHelper.getIndexByPattern(inputTable, patternToFind)
for key, value in pairs(inputTable) do
if string.match(value, patternToFind) ~= nil then
return key
end
end
return nil
end
function tableHelper.getIndexByNestedKeyValue(inputTable, keyToFind, valueToFind)
for key, value in pairs(inputTable) do
if type(value) == "table" then
if tableHelper.containsKeyValue(value, keyToFind, valueToFind) == true then
return key
end
end
end
return nil
end
function tableHelper.getIndexByValue(inputTable, valueToFind)
for key, value in pairs(inputTable) do
if value == valueToFind then
return key
end
end
end
-- Iterate through a table and return a new table based on it that has no nil values
-- (useful for numerical arrays because they retain nil values)
--
-- Based on http://stackoverflow.com/a/28302975
function tableHelper.cleanNils(inputTable)
local newTable = {}
for key, value in pairs(inputTable) do
if type(value) == "table" then
tableHelper.cleanNils(value)
end
if type(key) == "number" then
newTable[#newTable + 1] = value
inputTable[key] = nil
end
end
tableHelper.merge(inputTable, newTable)
end
-- Set values to nil here instead of using table.remove(), so this method can be used on
-- a table while iterating through it
function tableHelper.removeValue(inputTable, valueToFind)
tableHelper.replaceValue(inputTable, valueToFind, nil)
end
function tableHelper.replaceValue(inputTable, valueToFind, newValue)
for key, value in pairs(inputTable) do
if type(value) == "table" then
tableHelper.replaceValue(value, valueToFind, newValue)
elseif value == valueToFind then
inputTable[key] = newValue
end
end
end
-- Add a 2nd table's key/value pairs to the 1st table
--
-- Based on http://stackoverflow.com/a/1283608
function tableHelper.merge(mainTable, addedTable)
for key, value in pairs(addedTable) do
if type(value) == "table" then
if type(mainTable[key] or false) == "table" then
tableHelper.merge(mainTable[key] or {}, addedTable[key] or {})
else
mainTable[key] = value
end
else
mainTable[key] = value
end
end
end
-- Converts string keys containing numbers into numerical keys,
-- useful for JSON tables
--
-- Because Lua arrays start from index 1, the fixZeroStart argument
-- can be set to true to increment all of the keys by 1 in tables that
-- start from 0
function tableHelper.fixNumericalKeys(inputTable, fixZeroStart)
local newTable = {}
local incrementKeys = false
if inputTable["0"] ~= nil and fixZeroStart then
incrementKeys = true
end
for key, value in pairs(inputTable) do
if type(value) == "table" then
tableHelper.fixNumericalKeys(value)
end
if type(key) ~= "number" and type(tonumber(key)) == "number" then
local newKey = tonumber(key)
if incrementKeys then
newKey = newKey + 1
end
newTable[newKey] = value
inputTable[key] = nil
end
end
tableHelper.merge(inputTable, newTable)
end
-- Checks whether the table contains only numerical keys, though they
-- don't have to be consecutive
function tableHelper.usesNumericalKeys(inputTable)
if tableHelper.getCount(inputTable) == 0 then
return false
end
for key, value in pairs(inputTable) do
if type(key) ~= "number" then
return false
end
end
return true
end
-- Checks whether the table contains only numerical values
function tableHelper.usesNumericalValues(inputTable)
if tableHelper.getCount(inputTable) == 0 then
return false
end
for key, value in pairs(inputTable) do
if type(value) ~= "number" then
return false
end
end
return true
end
-- Checks whether there are any items in the table
function tableHelper.isEmpty(inputTable)
if next(inputTable) == nil then
return true
end
return false
end
-- Checks whether the table is an array with only consecutive numerical keys,
-- i.e. without any gaps between keys
-- Based on http://stackoverflow.com/a/6080274
function tableHelper.isArray(inputTable)
local index = 0
for _ in pairs(inputTable) do
index = index + 1
if inputTable[index] == nil then return false end
end
return true
end
-- Based on http://lua-users.org/wiki/CopyTable
function tableHelper.shallowCopy(inputTable)
local inputType = type(inputTable)
local newTable
if inputType == 'table' then
newTable = {}
for key, value in pairs(inputTable) do
newTable[key] = value
end
else -- number, string, boolean, etc
newTable = inputTable
end
return newTable
end
function tableHelper.getSimplePrintableTable(inputTable)
local text = ""
local shouldPrintComma = false
for index, value in pairs(inputTable) do
if shouldPrintComma then
text = text .. ", "
end
if type(value) == "table" then
text = text .. "[" .. tableHelper.getSimplePrintableTable(value) .. "]"
else
text = text .. index .. ": " .. value
end
shouldPrintComma = true
end
return text
end
-- Based on http://stackoverflow.com/a/13398936
function tableHelper.getPrintableTable(inputTable, indentStr, indentLevel)
local str = ""
local currentIndent = ""
if indentStr == nil then
indentStr = "\t"
end
if (inputTable == nil) then
return
end
if (indentLevel == nil) then
return tableHelper.getPrintableTable(inputTable, indentStr, 0)
end
for i = 0, indentLevel do
currentIndent = currentIndent .. indentStr
end
for index, value in pairs(inputTable) do
str = str .. currentIndent .. index
if type(value) == "boolean" then
value = tostring(value)
end
if type(value) == "table" then
str = str .. ": \n" .. tableHelper.getPrintableTable(value, indentStr, (indentLevel + 1))
else
str = str .. ": " .. value .. "\n"
end
end
return str
end
function tableHelper.print(inputTable, indentStr, indentLevel)
local text = tableHelper.getPrintableTable(inputTable, indentStr, indentLevel)
tes3mp.LogMessage(2, text)
end
return tableHelper