Module:Arguments: Difference between revisions
Jump to navigation
Jump to search
add a "wrappers" option and fix bug when frame:getParent() returns nil, per protected edit request by User:Jackmcbarn
>Mr. Stradivarius (memoize nils using a separate nilArgs table; this fixes a bug where nil values were being iterated over with pairs()) |
>Mr. Stradivarius (add a "wrappers" option and fix bug when frame:getParent() returns nil, per protected edit request by User:Jackmcbarn) |
||
Line 55: | Line 55: | ||
--[[ | --[[ | ||
-- 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. | if options.wrappers then | ||
fargs = frame.args | --[[ | ||
end | -- 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 type(options.wrappers) == 'table' then | |||
for _,v in pairs(options.wrappers) do | |||
if v == title then | |||
found = true | |||
break | |||
end | |||
end | |||
elseif options.wrappers == title then | |||
found = true | |||
end | |||
if found then | |||
pargs = parent.args | |||
else | |||
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 | |||
if options.parentFirst then | |||
fargs, pargs = pargs, fargs | |||
end | |||
end | end | ||
else | else | ||
Line 212: | Line 252: | ||
--]] | --]] | ||
metaArgs[key] = nil | metaArgs[key] = nil | ||
nilArgs[key] = true | nilArgs[key] = true | ||
else | else | ||
metaArgs[key] = val | metaArgs[key] = val |