Module:Table

Module documentation[view][edit][history][purge]
This documentation is transcluded from Module:Table/doc. Changes can be proposed in the talk page.
Function list
L 15 — union L 34 — getArgNums L 44 — addRow L 72 — renderTitle L 86 — renderRows L 99 — _table L 138 — preprocessSingleArg L 151 — preprocessArgs L 206 — parseDataParameters L 217 — p.table L 230 — p.tableTemplate
Module:Table allows the creation of simple collapsible tables styled to the Citizen skin. It implements the {{table}} template.
------------------------------------------------------------------------------------------------------------
-- Module: table
-- Description: Creates a table that can be collapsed in the same style as headers in the Citizen theme
-- Based on Module:Infobox and https://starcitizen.tools/Module:Navplate
------------------------------------------------------------------------------------------------------------

local p = {}
local args = {}
local origArgs = {}
local root
local header
local content

-- Returns the union of the values of two tables, as a sequence.
local function union(t1, t2)

	local vals = {}
	for k, v in pairs(t1) do
		vals[v] = true
	end
	for k, v in pairs(t2) do
		vals[v] = true
	end
	local ret = {}
	for k, v in pairs(vals) do
		table.insert(ret, k)
	end
	return ret
end

-- Returns a table containing the numbers of the arguments that exist
-- for the specified prefix. For example, if the prefix was 'data', and
-- 'data1', 'data2', and 'data5' exist, it would return {1, 2, 5}.
local function getArgNums(prefix)
	local nums = {}
	for k, v in pairs(args) do
		local num = tostring(k):match('^' .. prefix .. '([1-9]%d*)$')
		if num then table.insert(nums, tonumber(num)) end
	end
	table.sort(nums)
	return nums
end

local function addRow(rowArgs)
	if rowArgs.header then
		content
			:tag('div')
				:addClass('template-table-row-header')
				:wikitext(rowArgs.header)
	elseif rowArgs.list then
		local row
		if rowArgs.label then
			row = content
				:tag('div')
					:addClass('template-table-row')
			row
				:tag('div')
					:addClass('template-table-row-label')
					:wikitext(rowArgs.label)
		else
			row = content
				:tag('div')
					:addClass('template-table-row-nogrid')
		end
		row
			:tag('div')
				:addClass('template-table-row-content')
				:wikitext(rowArgs.list)
	end
end

local function renderTitle()
	if not args.title then return end

	local headerContent = mw.html.create('div')
		:addClass('template-table-header-content')
	
	headerContent
		:tag('div')
			:addClass('template-table-title')
			:wikitext(args.title)

	header:node(headerContent)
end

local function renderRows()

	local rownums = union(getArgNums('header'), getArgNums('list'))
	table.sort(rownums)
	for k, num in ipairs(rownums) do
		addRow({
			header = args['header' .. tostring(num)],
			label = args['label' .. tostring(num)],
			list = args['list' .. tostring(num)]
		})
	end
end

local function _table()
	root = mw.html.create('div')
	header = mw.html.create('div')
	content = mw.html.create('div')
	
	header
		:addClass('template-table-header')

	content
		:addClass('template-table-content')
		
	if args.collapsible then 
		header
			:addClass('mw-collapsible-toggle')
			:tag('div')
			:addClass('citizen-ui-icon mw-ui-icon-wikimedia-collapse')
			:done()

		content
			:addClass('mw-collapsible-content')

		root:addClass('mw-collapsible')
	end

	renderTitle()
	renderRows()

	root
		:addClass('template-table')
		:node(header)
		:node(content)

	return mw.getCurrentFrame():extensionTag{
		name = 'templatestyles', args = { src = 'Module:Table/styles.css' }
	} .. tostring(root)
end

-- If the argument exists and isn't blank, add it to the argument table.
-- Blank arguments are treated as nil to match the behaviour of ParserFunctions.
local function preprocessSingleArg(argName)
	if origArgs[argName] and origArgs[argName] ~= '' then
		args[argName] = origArgs[argName]
	end
end

-- Assign the parameters with the given prefixes to the args table, in order, in
-- batches of the step size specified. This is to prevent references etc. from
-- appearing in the wrong order. The prefixTable should be an array containing
-- tables, each of which has two possible fields, a "prefix" string and a
-- "depend" table. The function always parses parameters containing the "prefix"
-- string, but only parses parameters in the "depend" table if the prefix
-- parameter is present and non-blank.
local function preprocessArgs(prefixTable, step)
	if type(prefixTable) ~= 'table' then
		error("Non-table value detected for the prefix table", 2)
	end
	if type(step) ~= 'number' then
		error("Invalid step value detected", 2)
	end

	-- Get arguments without a number suffix, and check for bad input.
	for i,v in ipairs(prefixTable) do
		if type(v) ~= 'table' or type(v.prefix) ~= "string" or
			(v.depend and type(v.depend) ~= 'table') then
			error('Invalid input detected to preprocessArgs prefix table', 2)
		end
		preprocessSingleArg(v.prefix)
		-- Only parse the depend parameter if the prefix parameter is present
		-- and not blank.
		if args[v.prefix] and v.depend then
			for j, dependValue in ipairs(v.depend) do
				if type(dependValue) ~= 'string' then
					error('Invalid "depend" parameter value detected in preprocessArgs')
				end
				preprocessSingleArg(dependValue)
			end
		end
	end

	-- Get arguments with number suffixes.
	local a = 1 -- Counter variable.
	local moreArgumentsExist = true
	while moreArgumentsExist == true do
		moreArgumentsExist = false
		for i = a, a + step - 1 do
			for j,v in ipairs(prefixTable) do
				local prefixArgName = v.prefix .. tostring(i)
				if origArgs[prefixArgName] then
					-- Do another loop if any arguments are found, even blank ones.
					moreArgumentsExist = true
					preprocessSingleArg(prefixArgName)
				end
				-- Process the depend table if the prefix argument is present
				-- and not blank, or we are processing "prefix1" and "prefix" is
				-- present and not blank, and if the depend table is present.
				if v.depend and (args[prefixArgName] or (i == 1 and args[v.prefix])) then
					for j,dependValue in ipairs(v.depend) do
						local dependArgName = dependValue .. tostring(i)
						preprocessSingleArg(dependArgName)
					end
				end
			end
		end
		a = a + step
	end
end

local function parseDataParameters()
	preprocessSingleArg('title')
	preprocessSingleArg('collapsible')
	preprocessArgs({
		{prefix = 'header'},
		{prefix = 'list', depend = {'label'}},
	}, 50)
end

-- If called via #invoke, use the args passed into the invoking template.
-- Otherwise, for testing purposes, assume args are being passed directly in.
function p.table(frame)
	if frame == mw.getCurrentFrame() then
		origArgs = frame:getParent().args
	else
		origArgs = frame
	end
	
	parseDataParameters()
	
	return _table()
end

-- For calling via #invoke within a template
function p.tableTemplate(frame)
	origArgs = {}
	for k,v in pairs(frame.args) do origArgs[k] = mw.text.trim(v) end
	
	parseDataParameters()
	
	return _infobox()
end

return p