Bureaucrats, confirmed, Administrators
4,558
edits
Changes
m
local function matchesTitle(given, title) local tp = type( given ) return (tp == 'string' or tp == 'number') and mw.title.new( given ).prefixedText == titleend local translate_mt = { __index = function(t, k) return k end }
local function mergeArgs(iterator, tables)
local function translatenext(invariant) local k, v = next(invariant.t, invariant.k) invariant.k = k if k == nil then return nil elseif type(k) ~= 'string' or not options.backtranslate then 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 end
metatable.doneIpairs = true
metatable.__ipairs = function (t)
if not metatable.doneIpairs then mergeArgs(ipairsreturn inext, argTables) metatable.doneIpairs = true end return ipairs(metaArgs)t, 0
1 revision imported: Category:Infobox
-- #invoke. It is intended for use by other Lua modules, and should not be
-- called from #invoke directly.
local libraryUtil = require('libraryUtil')
local checkType = libraryUtil.checkType
local arguments = {}
-- 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
end
end
local function tidyValTrimOnly(key, val)
if type(val) == 'string' then
end
end
local function tidyValRemoveBlanksOnly(key, val)
if type(val) == 'string' then
end
end
local function tidyValNoChange(key, val)
return val
end
function arguments.getArgs(frame, options)
checkType('getArgs', 1, frame, '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 if options.backtranslate and getmetatable(options.backtranslate) == nil then setmetatable(options.backtranslate, { __index = function(t, k) if options.translate[k] ~= k then return nil else return k end end }) end --[[ -- Get the argument tables. If we were passed a valid frame object, get the -- frame arguments from (fargs) and the parent frame arguments (pargs), depending -- on the options set and on the parent frame object if available's availability. If the frame objectwe weren't -- is not availablepassed a valid frame object, we are being called from another Lua module -- or from thedebug console, so assume that we were passed a table of args -- debug consoledirectly, so and assign the args it to a new variable so we can -- differentiate them(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 pargs local parent = frame:getParent() pargs = parent and parent.argsor nil end
end
if options.parentFirst then
luaArgs = frame
end
-- Set the order of precedence of the argument tables. If the variables are
-- nil, nothing will be added to the table, which is how we avoid clashes
-- between the frame/parent args and the Lua args.
local argTables = {fargs}
argTables[#argTables + 1] = pargs
argTables[#argTables + 1] = luaArgs
--[[
-- Generate the tidyVal function. If it has been specified by the user, we
end
end
--[[
-- Set up the args, metaArgs and nilArgs tables. args will be the one
local args, metaArgs, nilArgs, metatable = {}, {}, {}, {}
setmetatable(args, metatable)
--[[
-- Accepts multiple tables as input and merges their keys and values
-- into one table using the specified iterator. If a value is already -- present it is not overwritten; -- tables listed earlier have precedence. -- We are also memoizing nil -- values, but those values which can be -- overwrittenif they are 's' (soft).
--]]
for _, t in ipairs(tables) do
for key, val in iteratorpairs(t) do if metaArgs[key] == nil and nilArgs[key] ~= 'h' then
local tidiedVal = tidyVal(key, val)
if tidiedVal == nil then
nilArgs[key] = true's'
else
metaArgs[key] = tidiedVal
end
end
--[[
-- Define metatable behaviour. Arguments are memoized in the metaArgs table,
-- the arguments will already have been copied over.
--]]
metatable.__index = function (t, key)
--[[
-- must be nil.
--]]
if type(key) == 'string' then
key = options.translate[key]
end
local val = metaArgs[key]
if val ~= nil then
for _, argTable in ipairs(argTables) do
local argTableVal = tidyVal(key, argTable[key])
if argTableVal =~= nil then nilArgs[key] = true else
metaArgs[key] = argTableVal
return argTableVal
end
end
nilArgs[key] = 'h'
return nil
end
metatable.__newindex = function (t, key, val)
-- This function is called when a module tries to add a new value to the
-- args table, or tries to change an existing value.
if type(key) == 'string' then
key = options.translate[key]
end
if options.readOnly then
error(
--]]
metaArgs[key] = nil
nilArgs[key] = true -- Memoize nils.'h'
else
metaArgs[key] = val
end
end
metatable.__pairs = function ()
-- Called when pairs is run on the args table.
if not metatable.donePairs then
mergeArgs(pairs, argTables)
metatable.donePairs = true
end
return pairstranslatenext, { t = metaArgs } end local function inext(metaArgst, i) -- This uses our __index metamethod local v = t[i + 1] if v ~= nil then return i + 1, v end
end
-- Called when ipairs is run on the args table.
end
return args
end
return arguments