Module:Arguments and Module:Check for unknown parameters: Difference between pages

From Frontierpedia, the Microsoft Agent encyclopedia
(Difference between pages)
frontierpediav5>WikiSysop
(Created page with "local libraryUtil = require('libraryUtil') local checkType = libraryUtil.checkType local arguments = {} -- Generate four different tidyVal functions, so that we don't have t...")
 
frontierpediav5>WikiSysop
m (1 revision imported)
 
Line 1: Line 1:
local libraryUtil = require('libraryUtil')
-- This module may be used to compare the arguments passed to the parent
local checkType = libraryUtil.checkType
-- with a list of arguments, returning a specified result if an argument is
-- not on the list
local p = {}


local arguments = {}
local function trim(s)
 
return s:match('^%s*(.-)%s*$')
-- Generate four different tidyVal functions, so that we don't have to check the
-- options every time we call it.
 
local function tidyValDefault(key, val)
if type(val) == 'string' then
val = val:match('^%s*(.-)%s*$')
if val == '' then
return nil
else
return val
end
else
return val
end
end
end


local function tidyValTrimOnly(key, val)
local function isnotempty(s)
if type(val) == 'string' then
return s and s:match('%S')
return val:match('^%s*(.-)%s*$')
else
return val
end
end
end


local function tidyValRemoveBlanksOnly(key, val)
local function clean(text)
if type(val) == 'string' then
-- Return text cleaned for display and truncated if too long.
if val:find('%S') then
-- Strip markers are replaced with dummy text representing the original wikitext.
return val
local pos, truncated
else
local function truncate(text)
return nil
if truncated then
return ''
end
end
else
if mw.ustring.len(text) > 25 then
return val
truncated = true
end
text = mw.ustring.sub(text, 1, 25) .. '...'
end
 
local function tidyValNoChange(key, val)
return val
end
 
local function matchesTitle(given, title)
local tp = type( given )
return (tp == 'string' or tp == 'number') and mw.title.new( given ).prefixedText == title
end
 
local translate_mt = { __index = function(t, k) return k end }
 
function arguments.getArgs(frame, options)
checkType('getArgs', 1, frame, 'table', true)
checkType('getArgs', 2, options, 'table', true)
frame = frame or {}
options = options or {}
 
--[[
-- Set up argument translation.
--]]
options.translate = options.translate or {}
if getmetatable(options.translate) == nil then
setmetatable(options.translate, translate_mt)
end
if options.backtranslate == nil then
options.backtranslate = {}
for k,v in pairs(options.translate) do
options.backtranslate[v] = k
end
end
return mw.text.nowiki(text)
end
end
if options.backtranslate and getmetatable(options.backtranslate) == nil then
local parts = {}
setmetatable(options.backtranslate, {
for before, tag, remainder in text:gmatch('([^\127]*)\127[^\127]*%-(%l+)%-[^\127]*\127()') do
__index = function(t, k)
pos = remainder
if options.translate[k] ~= k then
table.insert(parts, truncate(before) .. '<' .. tag .. '>...</' .. tag .. '>')
return nil
else
return k
end
end
})
end
end
table.insert(parts, truncate(text:sub(pos or 1)))
return table.concat(parts)
end


--[[
function p._check(args, pargs)
-- Get the argument tables. If we were passed a valid frame object, get the
if type(args) ~= "table" or type(pargs) ~= "table" then
-- frame arguments (fargs) and the parent frame arguments (pargs), depending
-- TODO: error handling
-- on the options set and on the parent frame's availability. If we weren't
return
-- passed a valid frame object, we are being called from another Lua module
-- or from the debug console, so assume that we were passed a table of args
-- directly, and assign it to a new variable (luaArgs).
--]]
local fargs, pargs, luaArgs
if type(frame.args) == 'table' and type(frame.getParent) == 'function' then
if options.wrappers then
--[[
-- The wrappers option makes Module:Arguments look up arguments in
-- either the frame argument table or the parent argument table, but
-- not both. This means that users can use either the #invoke syntax
-- or a wrapper template without the loss of performance associated
-- with looking arguments up in both the frame and the parent frame.
-- Module:Arguments will look up arguments in the parent frame
-- if it finds the parent frame's title in options.wrapper;
-- otherwise it will look up arguments in the frame object passed
-- to getArgs.
--]]
local parent = frame:getParent()
if not parent then
fargs = frame.args
else
local title = parent:getTitle():gsub('/sandbox$', '')
local found = false
if matchesTitle(options.wrappers, title) then
found = true
elseif type(options.wrappers) == 'table' then
for _,v in pairs(options.wrappers) do
if matchesTitle(v, title) then
found = true
break
end
end
end
 
-- We test for false specifically here so that nil (the default) acts like true.
if found or options.frameOnly == false then
pargs = parent.args
end
if not found or options.parentOnly == false then
fargs = frame.args
end
end
else
-- options.wrapper isn't set, so check the other options.
if not options.parentOnly then
fargs = frame.args
end
if not options.frameOnly then
local parent = frame:getParent()
pargs = parent and parent.args or nil
end
end
if options.parentFirst then
fargs, pargs = pargs, fargs
end
else
luaArgs = frame
end
end


-- Set the order of precedence of the argument tables. If the variables are
-- create the list of known args, regular expressions, and the return string
-- nil, nothing will be added to the table, which is how we avoid clashes
local knownargs = {}
-- between the frame/parent args and the Lua args.
local regexps = {}
local argTables = {fargs}
for k, v in pairs(args) do
argTables[#argTables + 1] = pargs
if type(k) == 'number' then
argTables[#argTables + 1] = luaArgs
v = trim(v)
 
knownargs[v] = 1
--[[
elseif k:find('^regexp[1-9][0-9]*$') then
-- Generate the tidyVal function. If it has been specified by the user, we
table.insert(regexps, '^' .. v .. '$')
-- use that; if not, we choose one of four functions depending on the
-- options chosen. This is so that we don't have to call the options table
-- every time the function is called.
--]]
local tidyVal = options.valueFunc
if tidyVal then
if type(tidyVal) ~= 'function' then
error(
"bad value assigned to option 'valueFunc'"
.. '(function expected, got '
.. type(tidyVal)
.. ')',
2
)
end
elseif options.trim ~= false then
if options.removeBlanks ~= false then
tidyVal = tidyValDefault
else
tidyVal = tidyValTrimOnly
end
else
if options.removeBlanks ~= false then
tidyVal = tidyValRemoveBlanksOnly
else
tidyVal = tidyValNoChange
end
end
end
end


--[[
-- loop over the parent args, and make sure they are on the list
-- Set up the args, metaArgs and nilArgs tables. args will be the one
local ignoreblank = isnotempty(args['ignoreblank'])
-- accessed from functions, and metaArgs will hold the actual arguments. Nil
local showblankpos = isnotempty(args['showblankpositional'])
-- arguments are memoized in nilArgs, and the metatable connects all of them
local values = {}
-- together.
for k, v in pairs(pargs) do
--]]
if type(k) == 'string' and knownargs[k] == nil then
local args, metaArgs, nilArgs, metatable = {}, {}, {}, {}
local knownflag = false
setmetatable(args, metatable)
for _, regexp in ipairs(regexps) do
 
if mw.ustring.match(k, regexp) then
local function mergeArgs(tables)
knownflag = true
--[[
break
-- Accepts multiple tables as input and merges their keys and values
-- into one table. If a value is already present it is not overwritten;
-- tables listed earlier have precedence. We are also memoizing nil
-- values, which can be overwritten if they are 's' (soft).
--]]
for _, t in ipairs(tables) do
for key, val in pairs(t) do
if metaArgs[key] == nil and nilArgs[key] ~= 'h' then
local tidiedVal = tidyVal(key, val)
if tidiedVal == nil then
nilArgs[key] = 's'
else
metaArgs[key] = tidiedVal
end
end
end
end
end
end
if not knownflag and ( not ignoreblank or isnotempty(v) ) then
end
table.insert(values, clean(k))
 
--[[
-- Define metatable behaviour. Arguments are memoized in the metaArgs table,
-- and are only fetched from the argument tables once. Fetching arguments
-- from the argument tables is the most resource-intensive step in this
-- module, so we try and avoid it where possible. For this reason, nil
-- arguments are also memoized, in the nilArgs table. Also, we keep a record
-- in the metatable of when pairs and ipairs have been called, so we do not
-- run pairs and ipairs on the argument tables more than once. We also do
-- not run ipairs on fargs and pargs if pairs has already been run, as all
-- the arguments will already have been copied over.
--]]
 
metatable.__index = function (t, key)
--[[
-- Fetches an argument when the args table is indexed. First we check
-- to see if the value is memoized, and if not we try and fetch it from
-- the argument tables. When we check memoization, we need to check
-- metaArgs before nilArgs, as both can be non-nil at the same time.
-- If the argument is not present in metaArgs, we also check whether
-- pairs has been run yet. If pairs has already been run, we return nil.
-- This is because all the arguments will have already been copied into
-- metaArgs by the mergeArgs function, meaning that any other arguments
-- must be nil.
--]]
if type(key) == 'string' then
key = options.translate[key]
end
local val = metaArgs[key]
if val ~= nil then
return val
elseif metatable.donePairs or nilArgs[key] then
return nil
end
for _, argTable in ipairs(argTables) do
local argTableVal = tidyVal(key, argTable[key])
if argTableVal ~= nil then
metaArgs[key] = argTableVal
return argTableVal
end
end
elseif type(k) == 'number' and
knownargs[tostring(k)] == nil and
( showblankpos or isnotempty(v) )
then
table.insert(values, k .. ' = ' .. clean(v))
end
end
nilArgs[key] = 'h'
return nil
end
end


metatable.__newindex = function (t, key, val)
-- add results to the output tables
-- This function is called when a module tries to add a new value to the
local res = {}
-- args table, or tries to change an existing value.
if #values > 0 then
if type(key) == 'string' then
local unknown_text = args['unknown'] or 'Found _VALUE_, '
key = options.translate[key]
end
if options.readOnly then
error(
'could not write to argument table key "'
.. tostring(key)
.. '"; the table is read-only',
2
)
elseif options.noOverwrite and args[key] ~= nil then
error(
'could not write to argument table key "'
.. tostring(key)
.. '"; overwriting existing arguments is not permitted',
2
)
elseif val == nil then
--[[
-- If the argument is to be overwritten with nil, we need to erase
-- the value in metaArgs, so that __index, __pairs and __ipairs do
-- not use a previous existing value, if present; and we also need
-- to memoize the nil in nilArgs, so that the value isn't looked
-- up in the argument tables if it is accessed again.
--]]
metaArgs[key] = nil
nilArgs[key] = 'h'
else
metaArgs[key] = val
end
end


local function translatenext(invariant)
if mw.getCurrentFrame():preprocess( "{{REVISIONID}}" ) == "" then
local k, v = next(invariant.t, invariant.k)
local preview_text = args['preview']
invariant.k = k
if isnotempty(preview_text) then
if k == nil then
preview_text = require('Module:If preview')._warning({preview_text})
return nil
elseif preview == nil then
elseif type(k) ~= 'string' or not options.backtranslate then
preview_text = unknown_text
return k, v
else
local backtranslate = options.backtranslate[k]
if backtranslate == nil then
-- Skip this one. This is a tail call, so this won't cause stack overflow
return translatenext(invariant)
else
return backtranslate, v
end
end
unknown_text = preview_text
end
end
end
for _, v in pairs(values) do
-- Fix odd bug for | = which gets stripped to the empty string and
-- breaks category links
if v == '' then v = ' ' end


metatable.__pairs = function ()
-- avoid error with v = 'example%2' ("invalid capture index")
-- Called when pairs is run on the args table.
local r = unknown_text:gsub('_VALUE_', {_VALUE_ = v})
if not metatable.donePairs then
table.insert(res, r)
mergeArgs(argTables)
metatable.donePairs = true
end
end
return translatenext, { t = metaArgs }
end
end


local function inext(t, i)
return table.concat(res)
-- This uses our __index metamethod
end
local v = t[i + 1]
if v ~= nil then
return i + 1, v
end
end
 
metatable.__ipairs = function (t)
-- Called when ipairs is run on the args table.
return inext, t, 0
end


return args
function p.check(frame)
local args = frame.args
local pargs = frame:getParent().args
return p._check(args, pargs)
end
end


return arguments
return p

Revision as of 20:33, 19 September 2021

Documentation for this module may be created at Module:Check for unknown parameters/doc 

-- This module may be used to compare the arguments passed to the parent
-- with a list of arguments, returning a specified result if an argument is
-- not on the list
local p = {}

local function trim(s)
	return s:match('^%s*(.-)%s*$')
end

local function isnotempty(s)
	return s and s:match('%S')
end

local function clean(text)
	-- Return text cleaned for display and truncated if too long.
	-- Strip markers are replaced with dummy text representing the original wikitext.
	local pos, truncated
	local function truncate(text)
		if truncated then
			return ''
		end
		if mw.ustring.len(text) > 25 then
			truncated = true
			text = mw.ustring.sub(text, 1, 25) .. '...'
		end
		return mw.text.nowiki(text)
	end
	local parts = {}
	for before, tag, remainder in text:gmatch('([^\127]*)\127[^\127]*%-(%l+)%-[^\127]*\127()') do
		pos = remainder
		table.insert(parts, truncate(before) .. '<' .. tag .. '>...</' .. tag .. '>')
	end
	table.insert(parts, truncate(text:sub(pos or 1)))
	return table.concat(parts)
end

function p._check(args, pargs)
	if type(args) ~= "table" or type(pargs) ~= "table" then
		-- TODO: error handling
		return
	end

	-- create the list of known args, regular expressions, and the return string
	local knownargs = {}
	local regexps = {}
	for k, v in pairs(args) do
		if type(k) == 'number' then
			v = trim(v)
			knownargs[v] = 1
		elseif k:find('^regexp[1-9][0-9]*$') then
			table.insert(regexps, '^' .. v .. '$')
		end
	end

	-- loop over the parent args, and make sure they are on the list
	local ignoreblank = isnotempty(args['ignoreblank'])
	local showblankpos = isnotempty(args['showblankpositional'])
	local values = {}
	for k, v in pairs(pargs) do
		if type(k) == 'string' and knownargs[k] == nil then
			local knownflag = false
			for _, regexp in ipairs(regexps) do
				if mw.ustring.match(k, regexp) then
					knownflag = true
					break
				end
			end
			if not knownflag and ( not ignoreblank or isnotempty(v) )  then
				table.insert(values, clean(k))
			end
		elseif type(k) == 'number' and
			knownargs[tostring(k)] == nil and
			( showblankpos or isnotempty(v) )
		then
			table.insert(values, k .. ' = ' .. clean(v))
		end
	end

	-- add results to the output tables
	local res = {}
	if #values > 0 then
		local unknown_text = args['unknown'] or 'Found _VALUE_, '

		if mw.getCurrentFrame():preprocess( "{{REVISIONID}}" ) == "" then
			local preview_text = args['preview']
			if isnotempty(preview_text) then
				preview_text = require('Module:If preview')._warning({preview_text})
			elseif preview == nil then
				preview_text = unknown_text
			end
			unknown_text = preview_text
		end
		for _, v in pairs(values) do
			-- Fix odd bug for | = which gets stripped to the empty string and
			-- breaks category links
			if v == '' then v = ' ' end

			-- avoid error with v = 'example%2' ("invalid capture index")
			local r = unknown_text:gsub('_VALUE_', {_VALUE_ = v})
			table.insert(res, r)
		end
	end

	return table.concat(res)
end

function p.check(frame)
	local args = frame.args
	local pargs = frame:getParent().args
	return p._check(args, pargs)
end

return p
Retrieved from "https://frontierpedia.tmafe.com/index.php?title=Module:Arguments&oldid=558"