Модуль:Arguments: различия между версиями

Содержимое удалено Содержимое добавлено
Новая страница: «-- This module provides easy processing of arguments passed to Scribunto from -- #invoke. It is intended for use by other Lua modules, and should…»
 
обновление с w:Module:Arguments
Строка 47:
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
 
local translate_mt = { __index = function(t, k) return k end }
 
function arguments.getArgs(frame, options)
Строка 55 ⟶ 62 :
 
--[[
-- Set up argument translation.
-- Get the arguments from the frame object if available. If the frame object
--]]
-- is not available, we are being called from another Lua module or from the
options.translate = options.translate or {}
-- debug console, so assign the args to a new variable so we can
if getmetatable(options.translate) == nil then
-- differentiate them.
setmetatable(options.translate, translate_mt)
end
if options.backtranslate == nil then
options.backtranslate = {}
for k,v in pairs(options.translate) do
options.backtranslate[v] = k
end
end
if options.backtranslate and getmetatable(options.backtranslate) == nil then
setmetatable(options.backtranslate, {
__index = function(t, k)
if options.translate[k] ~= k then
return nil
else
return k
end
end
})
end
 
--[[
-- 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
if type(frame.args) == 'table' and type(frame.getParent) == 'function' then
if not options.parentOnlywrappers then
--[[
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
-- 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
if options.parentFirst then
Строка 74 ⟶ 149 :
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
-- between the frame/parent args and the Lua args.
local argTables = {fargs}
argTables[#argTables + 1] = pargs
Строка 122 ⟶ 197 :
setmetatable(args, metatable)
 
local function mergeArgs(iterator, tables)
--[[
-- Accepts multiple tables as input and merges their keys and values
-- into one table using the specified iterator. If a value is already present it is not overwritten;
-- 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).
-- We are also memoizing nil values, but those values can be
-- overwritten.
--]]
for _, t in ipairs(tables) do
for key, val in iteratorpairs(t) do
if metaArgs[key] == nil and nilArgs[key] ~= 'h' then
local tidiedVal = tidyVal(key, val)
if tidiedVal == nil then
nilArgs[key] = true's'
else
metaArgs[key] = tidiedVal
Строка 168 ⟶ 242 :
-- must be nil.
--]]
if type(key) == 'string' then
key = options.translate[key]
end
local val = metaArgs[key]
if val ~= nil then
Строка 176 ⟶ 253 :
for _, argTable in ipairs(argTables) do
local argTableVal = tidyVal(key, argTable[key])
if argTableVal =~= nil then
nilArgs[key] = true
else
metaArgs[key] = argTableVal
return argTableVal
end
end
nilArgs[key] = 'h'
return nil
end
Строка 189 ⟶ 265 :
-- This function is called when a module tries to add a new value to the
-- args table, or tries to change an existing value.
if type(key) == 'string' then
key = options.translate[key]
end
if options.readOnly then
error(
Строка 212 ⟶ 291 :
--]]
metaArgs[key] = nil
nilArgs[key] = true -- Memoize nils.'h'
else
metaArgs[key] = val
end
end
 
local function translatenext(invariant)
local k, v = next(invariant.t, invariant.k)
invariant.k = k
if k == nil then
return nil
elseif type(k) ~= 'string' or not options.backtranslate then
return k, v
else
local backtranslate = options.backtranslate[k]
if backtranslate == nil then
-- Skip this one. This is a tail call, so this won't cause stack overflow
return translatenext(invariant)
else
return backtranslate, v
end
end
end
Строка 221 ⟶ 318 :
-- Called when pairs is run on the args table.
if not metatable.donePairs then
mergeArgs(pairs, argTables)
metatable.donePairs = true
metatable.doneIpairs = true
end
return pairs(translatenext, { t = metaArgs) }
end
 
metatable.__ipairs =local function inext(t, i)
-- This uses our __index metamethod
-- Called when ipairs is run on the args table.
local v = t[i + 1]
if not metatable.doneIpairs then
if v ~= nil then
mergeArgs(ipairs, argTables)
return i + 1, v
metatable.doneIpairs = true
end
end
return ipairs(metaArgs)
 
metatable.__ipairs = function (t)
-- Called when ipairs is run on the args table.
return inext, t, 0
end