Module:Arguments: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m>Mr. Stradivarius add a "wrappers" option and fix bug when frame:getParent() returns nil, per protected edit request by User:Jackmcbarn |
||
Line 2: | Line 2: | ||
-- #invoke. It is intended for use by other Lua modules, and should not be | -- #invoke. It is intended for use by other Lua modules, and should not be | ||
-- called from #invoke directly. | -- called from #invoke directly. | ||
local libraryUtil = require('libraryUtil') | local libraryUtil = require('libraryUtil') | ||
local checkType = libraryUtil.checkType | local checkType = libraryUtil.checkType | ||
local arguments = {} | local arguments = {} | ||
-- Generate four different tidyVal functions, so that we don't have to check the | -- Generate four different tidyVal functions, so that we don't have to check the | ||
-- options every time we call it. | -- options every time we call it. | ||
local function tidyValDefault(key, val) | local function tidyValDefault(key, val) | ||
if type(val) == 'string' then | if type(val) == 'string' then | ||
Line 23: | Line 23: | ||
end | end | ||
end | end | ||
local function tidyValTrimOnly(key, val) | local function tidyValTrimOnly(key, val) | ||
if type(val) == 'string' then | if type(val) == 'string' then | ||
Line 31: | Line 31: | ||
end | end | ||
end | end | ||
local function tidyValRemoveBlanksOnly(key, val) | local function tidyValRemoveBlanksOnly(key, val) | ||
if type(val) == 'string' then | if type(val) == 'string' then | ||
Line 43: | Line 43: | ||
end | end | ||
end | end | ||
local function tidyValNoChange(key, val) | local function tidyValNoChange(key, val) | ||
return val | return val | ||
end | end | ||
function arguments.getArgs(frame, options) | function arguments.getArgs(frame, options) | ||
checkType('getArgs', 1, frame, 'table', true) | checkType('getArgs', 1, frame, 'table', true) | ||
Line 53: | Line 53: | ||
frame = frame or {} | frame = frame or {} | ||
options = options or {} | options = options or {} | ||
--[[ | --[[ | ||
-- 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 | ||
luaArgs = frame | luaArgs = frame | ||
end | end | ||
-- Set the order of precedence of the argument tables. If the variables are | -- 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 | -- nil, nothing will be added to the table, which is how we avoid clashes | ||
Line 81: | Line 121: | ||
argTables[#argTables + 1] = pargs | argTables[#argTables + 1] = pargs | ||
argTables[#argTables + 1] = luaArgs | argTables[#argTables + 1] = luaArgs | ||
--[[ | --[[ | ||
-- Generate the tidyVal function. If it has been specified by the user, we | -- Generate the tidyVal function. If it has been specified by the user, we | ||
Line 112: | Line 152: | ||
end | end | ||
end | end | ||
--[[ | --[[ | ||
-- Set up the args, metaArgs and nilArgs tables. args will be the one | -- Set up the args, metaArgs and nilArgs tables. args will be the one | ||
Line 121: | Line 161: | ||
local args, metaArgs, nilArgs, metatable = {}, {}, {}, {} | local args, metaArgs, nilArgs, metatable = {}, {}, {}, {} | ||
setmetatable(args, metatable) | setmetatable(args, metatable) | ||
local function mergeArgs(iterator, tables) | local function mergeArgs(iterator, tables) | ||
--[[ | --[[ | ||
Line 143: | Line 183: | ||
end | end | ||
end | end | ||
--[[ | --[[ | ||
-- Define metatable behaviour. Arguments are memoized in the metaArgs table, | -- Define metatable behaviour. Arguments are memoized in the metaArgs table, | ||
Line 155: | Line 195: | ||
-- the arguments will already have been copied over. | -- the arguments will already have been copied over. | ||
--]] | --]] | ||
metatable.__index = function (t, key) | metatable.__index = function (t, key) | ||
--[[ | --[[ | ||
Line 185: | Line 225: | ||
return nil | return nil | ||
end | end | ||
metatable.__newindex = function (t, key, val) | metatable.__newindex = function (t, key, val) | ||
-- This function is called when a module tries to add a new value to the | -- This function is called when a module tries to add a new value to the | ||
Line 212: | Line 252: | ||
--]] | --]] | ||
metaArgs[key] = nil | metaArgs[key] = nil | ||
nilArgs[key] = true | nilArgs[key] = true | ||
else | else | ||
metaArgs[key] = val | metaArgs[key] = val | ||
end | end | ||
end | end | ||
metatable.__pairs = function () | metatable.__pairs = function () | ||
-- Called when pairs is run on the args table. | -- Called when pairs is run on the args table. | ||
Line 227: | Line 267: | ||
return pairs(metaArgs) | return pairs(metaArgs) | ||
end | end | ||
metatable.__ipairs = function () | metatable.__ipairs = function () | ||
-- Called when ipairs is run on the args table. | -- Called when ipairs is run on the args table. | ||
Line 236: | Line 276: | ||
return ipairs(metaArgs) | return ipairs(metaArgs) | ||
end | end | ||
return args | return args | ||
end | end | ||
return arguments | return arguments |