Changes
add a "wrappers" option and fix bug when frame:getParent() returns nil, per protected edit request by User:Jackmcbarn
-- #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 {}
--[[
-- 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.parentOnly 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 pargs local parent = frame:getParent() pargs = parent and parent.argsor nil end if options.parentFirst then fargs, pargs = pargs, fargs end
end
else
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
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)
local function mergeArgs(iterator, tables)
--[[
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)
--[[
return nil
end
metatable.__newindex = function (t, key, val)
-- This function is called when a module tries to add a new value to the
--]]
metaArgs[key] = nil
nilArgs[key] = true -- Memoize nils.
else
metaArgs[key] = val
end
end
metatable.__pairs = function ()
-- Called when pairs is run on the args table.
return pairs(metaArgs)
end
metatable.__ipairs = function ()
-- Called when ipairs is run on the args table.
return ipairs(metaArgs)
end
return args
end
return arguments