The wiki has moved!

Visit the new wiki at stationeers-wiki.com The old wiki here at legacy.stationeers-wiki.com will sunset eventually.

Edits made after the 7th of March 6PM EST were NOT carried over to the new server as previously announced right here in this box.

 Actions

Module

Difference between revisions of "Parameters"

From Unofficial Stationeers Wiki

(Add padding option to code method)
m (33 revisions imported)
 
(One intermediate revision by one other user not shown)
Line 54: Line 54:
 
end
 
end
  
−
local function strMap(iter, transform, sort)
+
local function map(tbl, transform)
 
local returnTable = {}
 
local returnTable = {}
−
for _, v in pairs(iter) do
+
for k, v in pairs(tbl) do
−
table.insert(returnTable, transform(v))
+
returnTable[k] = transform(v)
−
end
 
−
if sort then
 
−
table.sort(returnTable)
 
 
end
 
end
 +
return returnTable
 +
end
 +
 +
local function strMap(tbl, transform)
 +
local returnTable = map(tbl, transform)
 
return table.concat(returnTable)
 
return table.concat(returnTable)
 
end
 
end
Line 80: Line 82:
 
-- Space-pad the parameters to align the equal signs vertically
 
-- Space-pad the parameters to align the equal signs vertically
 
if pad then
 
if pad then
−
local lengthPerPara = {}
+
local lengthPerPara = map(parameters, function (parameter)
−
for _, parameter in pairs(parameters) do
+
return string.len(parameter) end)
−
table.insert(lengthPerPara, string.len(parameter))
 
−
end
 
 
-- Lua doesn't support printf's <*> to specify the width, apparently
 
-- Lua doesn't support printf's <*> to specify the width, apparently
 
local fs = string.format('%%-%ss', math.max(unpack(lengthPerPara)))
 
local fs = string.format('%%-%ss', math.max(unpack(lengthPerPara)))
Line 147: Line 147:
 
%s]],
 
%s]],
 
strMap(Set.valueIntersection(baseParams, otherParams),
 
strMap(Set.valueIntersection(baseParams, otherParams),
−
function(v) return string.format('* %s\n', v) end, true),
+
function(v) return string.format('* %s\n', v) end),
 
strMap(Set.valueIntersection(baseNormParams, otherNormParams),
 
strMap(Set.valueIntersection(baseNormParams, otherNormParams),
 
function(v) return string.format('* %s < %s [%s]\n',
 
function(v) return string.format('* %s < %s [%s]\n',
Line 153: Line 153:
 
table.concat(otherNormParams[v], '; '),
 
table.concat(otherNormParams[v], '; '),
 
v)
 
v)
−
end, true),
+
end),
 
strMap(Set.valueComplement(otherNormParams, baseNormParams),
 
strMap(Set.valueComplement(otherNormParams, baseNormParams),
 
function(v) return strMap(baseNormParams[v],
 
function(v) return strMap(baseNormParams[v],
−
function(s) return string.format('* %s\n', s) end, true)
+
function(s) return string.format('* %s\n', s) end)
−
end, true))
+
end))
 
end
 
end
  

Latest revision as of 15:00, 14 July 2018

-- This module implements [[Template:Parameters]].
-- [SublimeLinter luacheck-globals:mw]

local DEFINITIONS = {
	alt = {
		code = '<!-- text alternative for image; see WP:ALT -->',
		dlist = 'text alternative for image; see [[WP:ALT]]'},
	coordinates = {
		code = '<!-- use {{Coord}} -->',
		dlist = 'using {{tl|Coord}}'},
	coords = {
		code = '<!-- use {{Coord}} -->',
		dlist = 'using {{tl|Coord}}'},
	native_name = {
		code = '<!-- name in local language; if more than one, separate ' ..
			'using {{Plainlist}} use {{lang}}, and omit native_name_lang -->',
		dlist = 'name in local language; if more than one, separate ' ..
			'using {{tl|Plainlist}}, use {{tl|lang}}, and omit {{para|native_name_lang}}'},
	native_name_lang = {
		code = '<!-- language two- or three-letter ISO code -->',
		dlist = 'language two- or three-letter ISO code'},
	start_date = {
		code = '<!-- {{Start date|YYYY|MM|DD|df=y}} -->',
		dlist = 'use {{tlx|Start date|YYYY|MM|DD|df=y}}'},
	end_date = {
		code = '<!-- {{End date|YYYY|MM|DD|df=y}} -->',
		dlist = 'use {{tlx|Start date|YYYY|MM|DD|df=y}}'},
	url = {
		code = '<!-- use {{URL|example.com}} -->',
		dlist = 'using {{tl|URL}}'},
	website = {
		code = '<!-- use {{URL|example.com}} -->',
		dlist = 'using {{tls|URL|example.com}}'},}

local p = {}
local removeDuplicates = require('Module:TableTools').removeDuplicates
local yesno = require('Module:Yesno')

local function makeInvokeFunction(funcName)
	return function(frame)
		local getArgs = require('Module:Arguments').getArgs
		return p[funcName](getArgs(frame, {removeBlanks = false}))
	end
end

local function extractParams(page)
	local source = mw.title.new(page, 'Template'):getContent()

	local parameters = {}
	for parameter in string.gmatch(source, '{{{(.-)%f[}|<>]') do
		table.insert(parameters, parameter)
	end
	return removeDuplicates(parameters)
end

local function map(tbl, transform)
	local returnTable = {}
	for k, v in pairs(tbl) do
		returnTable[k] = transform(v)
	end
	return returnTable
end

local function strMap(tbl, transform)
	local returnTable = map(tbl, transform)
	return table.concat(returnTable)
end

function p._check(args)
	local title = args._base or mw.title.getCurrentTitle().fullText
	return string.format(
		'{{#invoke:Check for unknown parameters|check|unknown=' ..
		'[[Category:Pages using %s with unknown parameters]]|%s}}', title,
		table.concat(extractParams(args.base), '|'))
end

function p._code(args)
	local definitions = yesno(args.definitions)
	local pad = yesno(args.pad)

	local parameters = extractParams(args.base)
	-- Space-pad the parameters to align the equal signs vertically
	if pad then
		local lengthPerPara = map(parameters, function (parameter)
			return string.len(parameter) end)
		-- Lua doesn't support printf's <*> to specify the width, apparently
		local fs = string.format('%%-%ss', math.max(unpack(lengthPerPara)))
		for i, parameter in pairs(parameters) do
			parameters[i] = string.format(fs, parameter)
		end
	end

	local title = args._base or mw.title.getCurrentTitle().baseText
	return string.format([[{{%s
%s}}]], title, strMap(parameters,
		function(s)
			if definitions then
				return string.format('| %s = %s\n', s,
					DEFINITIONS[s] and DEFINITIONS[s].code or '')
			else
				return string.format('| %s = \n', s)
			end
		end))
end

function p._compare(args)
	local Set = require('Module:Set')

	local function normaliseParams(parameters)
		local paramsNorm = {}
		-- Prepare a key lookup metatable, which will hold the original
		-- parameter names for each normalised parameter, e.g.
		-- [test] = {TEST, Test}. paramIndex functions like a Python
		-- defaultdict, where the default is a table.
		local paramIndex = setmetatable({}, {__index = function(t, k)
			if not rawget(t, k) then
				rawset(t, k, {})
			end
			return rawget(t, k)
		end})
		for _, parameter in pairs(parameters) do
			table.insert(paramsNorm,
				string.lower(string.gsub(parameter, '%A', '')))
			table.insert(paramIndex[
				string.lower(string.gsub(parameter, '%A', ''))], parameter)
		end

		paramsNorm = removeDuplicates(paramsNorm)
		-- Overload key lookup in paramsNorm. While [[Module:Set]] will
		-- operate on the table (which is to say, the normalised parameters
		-- array), key access will be by way of the paramIndex metatable.
		setmetatable(paramsNorm, {__index = paramIndex})
		return paramsNorm
	end

	local baseParams = extractParams(args.base)
	local otherParams = extractParams(args.other)
	local baseNormParams = normaliseParams(Set.valueComplement(
			otherParams, baseParams))
	local otherNormParams = normaliseParams(otherParams)

	return string.format([[Identical:
%s
Similar:
%s
Disparate:
%s]],
	strMap(Set.valueIntersection(baseParams, otherParams),
		function(v) return string.format('* %s\n', v) end),
	strMap(Set.valueIntersection(baseNormParams, otherNormParams),
		function(v) return string.format('* %s < %s [%s]\n',
			table.concat(baseNormParams[v], '; '),
			table.concat(otherNormParams[v], '; '),
			v)
		end),
	strMap(Set.valueComplement(otherNormParams, baseNormParams),
		function(v) return strMap(baseNormParams[v],
			function(s) return string.format('* %s\n', s) end)
		end))
end

function p._demo(args)
	local title = args._base and ('|_template=' .. args._base) or ''
	return string.format('{{Parameter names example%s|%s}}', title,
		table.concat(extractParams(args.base), '|'))
end

function p._dlist(args)
	local definitions = yesno(args.definitions, true)
	return strMap(extractParams(args.base),
		function(s)
			if definitions then
				return string.format('; %s: %s\n', s,
					DEFINITIONS[s] and DEFINITIONS[s].dlist or '')
			else
				return string.format('; %s: \n', s)
			end
		end)
end

function p._list(args)
	return strMap(extractParams(args.base),
		function(s) return string.format('* %s\n', s) end)
end

p.check = makeInvokeFunction('_check')
p.code = makeInvokeFunction('_code')
p.compare = makeInvokeFunction('_compare')
p.demo = makeInvokeFunction('_demo')
p.dlist = makeInvokeFunction('_dlist')
p.list = makeInvokeFunction('_list')

return p
Retrieved from "https://legacy.stationeers-wiki.com/index.php?title=Module:Parameters&oldid=4682"