Anonymous user
Module:Arguments: Difference between revisions
add a "wrappers" option and fix bug when frame:getParent() returns nil, per protected edit request by User:Jackmcbarn
No edit summary |
(add a "wrappers" option and fix bug when frame:getParent() returns nil, per protected edit request by User:Jackmcbarn) |
||
Line 2:
-- #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
Line 23:
end
end
local function tidyValTrimOnly(key, val)
if type(val) == 'string' then
Line 31:
end
end
local function tidyValRemoveBlanksOnly(key, val)
if type(val) == 'string' then
Line 43:
end
end
local function tidyValNoChange(key, val)
return val
end
function arguments.getArgs(frame, options)
checkType('getArgs', 1, frame, 'table', true)
Line 53:
frame = frame or {}
options = options or {}
--[[
-- Get the
-- frame arguments (fargs) and the parent frame arguments (pargs), depending
-- is not available, we are being called from another Lua module or from the▼
--
▲ --
-- 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
--[[
fargs = frame.args▼
-- The wrappers option makes Module:Arguments look up arguments in
end▼
-- either the frame argument table or the parent argument table, but
if not options.frameOnly then▼
-- not both. This means that users can use either the #invoke syntax
pargs = frame:getParent().args▼
-- or a wrapper template without the loss of performance associated
end▼
-- with looking arguments up in both the frame and the parent frame.
if options.parentFirst then▼
-- Module:Arguments will look up arguments in the parent frame
fargs, pargs = pargs, fargs▼
-- if it finds the parent frame's title in options.wrapper;
-- otherwise it will look up arguments in the frame object passed
-- to getArgs.
--]]
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
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
Line 81 ⟶ 121:
argTables[#argTables + 1] = pargs
argTables[#argTables + 1] = luaArgs
--[[
-- Generate the tidyVal function. If it has been specified by the user, we
Line 112 ⟶ 152:
end
end
--[[
-- Set up the args, metaArgs and nilArgs tables. args will be the one
Line 121 ⟶ 161:
local args, metaArgs, nilArgs, metatable = {}, {}, {}, {}
setmetatable(args, metatable)
local function mergeArgs(iterator, tables)
--[[
Line 143 ⟶ 183:
end
end
--[[
-- Define metatable behaviour. Arguments are memoized in the metaArgs table,
Line 155 ⟶ 195:
-- the arguments will already have been copied over.
--]]
metatable.__index = function (t, key)
--[[
Line 185 ⟶ 225:
return nil
end
metatable.__newindex = function (t, key, val)
-- This function is called when a module tries to add a new value to the
Line 212 ⟶ 252:
--]]
metaArgs[key] = nil
nilArgs[key] = true
else
metaArgs[key] = val
end
end
metatable.__pairs = function ()
-- Called when pairs is run on the args table.
Line 227 ⟶ 267:
return pairs(metaArgs)
end
metatable.__ipairs = function ()
-- Called when ipairs is run on the args table.
Line 236 ⟶ 276:
return ipairs(metaArgs)
end
return args
end
return arguments
| |||