14,061
edits
Module:Arguments: Difference between revisions
Jump to navigation
Jump to search
m
1 revision
(test) |
m (1 revision) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 46: | Line 46: | ||
local function tidyValNoChange(key, val) | local function tidyValNoChange(key, val) | ||
return 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 | end | ||
| Line 55: | Line 60: | ||
--[[ | --[[ | ||
-- Get the arguments | -- Get the argument tables. If we were passed a valid frame object, get the | ||
-- | -- frame arguments (fargs) and the parent frame arguments (pargs), depending | ||
-- | -- on the options set and on the parent frame's availability. If we weren't | ||
-- 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 | local fargs, pargs, luaArgs | ||
if type(frame.args) == 'table' and type(frame.getParent) == 'function' then | if type(frame.args) == 'table' and type(frame.getParent) == 'function' then | ||
if not options.parentOnly then | if options.wrappers then | ||
fargs = frame.args | --[[ | ||
-- 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 | end | ||
if options.parentFirst then | if options.parentFirst then | ||
| Line 122: | Line 170: | ||
setmetatable(args, metatable) | setmetatable(args, metatable) | ||
local function mergeArgs( | local function mergeArgs(tables) | ||
--[[ | --[[ | ||
-- Accepts multiple tables as input and merges their keys and values | -- Accepts multiple tables as input and merges their keys and values | ||
-- into one table | -- 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 _, t in ipairs(tables) do | ||
for key, val in | for key, val in pairs(t) do | ||
if metaArgs[key] == nil then | if metaArgs[key] == nil and nilArgs[key] ~= 'h' then | ||
local tidiedVal = tidyVal(key, val) | local tidiedVal = tidyVal(key, val) | ||
if tidiedVal == nil then | if tidiedVal == nil then | ||
nilArgs[key] = | nilArgs[key] = 's' | ||
else | else | ||
metaArgs[key] = tidiedVal | metaArgs[key] = tidiedVal | ||
| Line 176: | Line 223: | ||
for _, argTable in ipairs(argTables) do | for _, argTable in ipairs(argTables) do | ||
local argTableVal = tidyVal(key, argTable[key]) | local argTableVal = tidyVal(key, argTable[key]) | ||
if argTableVal | if argTableVal ~= nil then | ||
metaArgs[key] = argTableVal | metaArgs[key] = argTableVal | ||
return argTableVal | return argTableVal | ||
end | end | ||
end | end | ||
nilArgs[key] = 'h' | |||
return nil | return nil | ||
end | end | ||
| Line 212: | Line 258: | ||
--]] | --]] | ||
metaArgs[key] = nil | metaArgs[key] = nil | ||
nilArgs[key] = | nilArgs[key] = 'h' | ||
else | else | ||
metaArgs[key] = val | metaArgs[key] = val | ||
| Line 221: | Line 267: | ||
-- Called when pairs is run on the args table. | -- Called when pairs is run on the args table. | ||
if not metatable.donePairs then | if not metatable.donePairs then | ||
mergeArgs( | mergeArgs(argTables) | ||
metatable.donePairs = true | metatable.donePairs = true | ||
end | end | ||
return pairs(metaArgs) | return pairs(metaArgs) | ||
end | |||
local function inext(t, i) | |||
-- This uses our __index metamethod | |||
local v = t[i + 1] | |||
if v ~= nil then | |||
return i + 1, v | |||
end | |||
end | end | ||
metatable.__ipairs = function () | metatable.__ipairs = function (t) | ||
-- Called when ipairs is run on the args table. | -- Called when ipairs is run on the args table. | ||
return inext, t, 0 | |||
end | end | ||