Changes

Jump to navigation Jump to search

Module:Arguments

6,515 bytes added, 12:19, 6 April 2020
m
1 revision imported
-- This module provides easy processing of arguments passed to Scribunto from -- #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 argumentstidyValDefault(key, val) if type(val) == 'string' then val = val:match('^%s*(.getArgs-)%s*$') if val == '' then return nil else return val end else return val endend local function tidyValTrimOnly(framekey, optionsval) options = if type(optionsval) == 'tablestring' then return val:match('^%s*(.-)%s*$' and options or {}) else return val endend
-- 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 debug console, so assume arguments are passed directly in. local fargsfunction tidyValRemoveBlanksOnly(key, pargsval) if frame type(val) == mw.getCurrentFrame'string' then if val:find('%S') then return val fargs = frame.argselse return nil pargs = frame:getParent().argsend
else
fargs = type(frame) == 'table' and frame or {} pargs = {}return val
end
end
 
local function tidyValNoChange(key, val)
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) local argscheckType('getArgs', metaArgs1, metatable = {}frame, {}'table', {}true) setmetatablecheckType(args'getArgs', 2, options, 'table', metatabletrue) frame = frame or {} options = options or {}
local function tidyVal--[[ -- Set up argument translation. --]] options.translate = options.translate or {} if getmetatable(options.translate) == nil then setmetatable(keyoptions.translate, valtranslate_mt) end if options.backtranslate == nil then -- Processes a value according to the options given to getArguments. Can trim whitespace and remove blanks.backtranslate = {} -- Keys are not used herefor k, but they can be used by user-generated functions, so defining it here to avoid breakagev in pairs(options.translate) do options.backtranslate[v] = k end end if typeoptions.backtranslate and getmetatable(valoptions.backtranslate) == 'string' nil then setmetatable(options.backtranslate, { __index = function(t, k) if options.trim translate[k] ~= false k then return nil else return k val = mw.text.trim(val)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 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.removeBlanks 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 or mw if matchesTitle(options.ustringwrappers, title) then found = true elseif type(options.findwrappers) == 'table' then for _,v in pairs(valoptions.wrappers) do if matchesTitle(v, '%S'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 return valend
end
else
return val-- 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 fargs, pargs = pargs, fargs
end
else
luaArgs = frame
end
-- Use a 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 argTables[#argTables + 1] = luaArgs  --[[ -- Generate the tidyVal function. If it has been specified by the user, we --generated use that; if not, we choose one of four functions depending on the -- options chosen. This is so that we don't have to tidy call the values if specifiedoptions table -- every time the function is called. --]] local valueFunc tidyVal = options.valueFunc if valueFunc tidyVal then local valueFuncType if type(tidyVal) ~= 'function' then error( "bad value assigned to option 'valueFunc'" .. '(function expected, got ' .. type(valueFunctidyVal) .. ')', 2 ) end elseif options.trim ~= false then if valueFuncType =options.removeBlanks ~= 'function' false then tidyVal = valueFunctidyValDefault
else
error('type error in option "valueFunc": expected function, got ' tidyVal = tidyValTrimOnly end else if options.. valueFuncType, 2)removeBlanks ~= false then tidyVal = tidyValRemoveBlanksOnly else tidyVal = tidyValNoChange
end
end
--[[ -- Set up the args, metaArgs and nilArgs tables. args will be the one -- accessed from functions, and metaArgs will hold the actual arguments. Nil -- arguments are memoized in nilArgs, and the metatable connects all of them -- together. --]] local args, metaArgs, nilArgs, metatable = {}, {}, {}, {} 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; -- tables listed earlier have precendenceprecedence.We are also memoizing nil local tables = {-- values, which can be overwritten if they are 's' (soft)...} --]]
for _, t in ipairs(tables) do
for key, val in iteratorpairs(t) do if metaArgs[key] == nil and nilArgs[key] ~= 'h' then metaArgs[key] local tidiedVal = tidyVal(key, val) if tidiedVal == nil then nilArgs[key] = 's' else metaArgs[key] = tidiedVal end
end
end
end
end
 
-- Set the order of precedence of frame args and parent args.
local firstArgs, secondArgs = fargs, pargs
if options.parentFirst then
firstArgs, secondArgs = pargs, fargs
end
--[[
-- Define metatable behaviour. Arguments are stored memoized in the metaArgs table, -- and are only fetched from theargument tables once. Fetching arguments -- from the argument tables is the most resource-intensive step in this -- fargs module, so we try and pargs tables onceavoid it where possible. For this reason, nil -- arguments are also memoized, in the nilArgs table. Also, we keep a record -- in the metatable of when pairs and ipairs have -- been called, so we do not -- run pairs and ipairs on fargs and pargs the argument tables more than once. We also do not run -- not run ipairs on fargs and pargs if pairs has already been run, as all -- the arguments will already have been -- copied over.
--]]
 
metatable.__index = function (t, key)
--[[
-- Fetches an argument when the args table is indexed. First we check
-- to see if the value is memoized, and if not we try and fetch it from
-- the argument tables. When we check memoization, we need to check
-- metaArgs before nilArgs, as both can be non-nil at the same time.
-- If the argument is not present in metaArgs, we also check whether
-- pairs has been run yet. If pairs has already been run, we return nil.
-- This is because all the arguments will have already been copied into
-- metaArgs by the mergeArgs function, meaning that any other arguments
-- must be nil.
--]]
if type(key) == 'string' then
key = options.translate[key]
end
local val = metaArgs[key]
if val ~= nil then
return val
elseelseif metatable.donePairs or nilArgs[key] then return nil end for _, argTable in ipairs(argTables) do local firstVal argTableVal = tidyVal(key, firstArgsargTable[key]) if firstVal argTableVal ~= nil then return firstVal elsemetaArgs[key] = argTableVal return tidyVal(key, secondArgs[key])argTableVal
end
end
nilArgs[key] = 'h'
return nil
end
metatable.__newindex = function (t, key, val)
-- 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 not options.readOnly and then error( 'could not write to argument table key "' .. tostring(key) .. '"; the table is read-only', 2 ) elseif options.noOverwrite or and args[key] ~= nil then error( 'could not write to argument table key "' .. tostring(key) .. '"; overwriting existing arguments is not permitted', 2 ) elseif val == nil) then --[[ -- If the argument is to be overwritten with nil, we need to erase -- the value in metaArgs, so that __index, __pairs and __ipairs do -- not use a previous existing value, if present; and we also need -- to memoize the nil in nilArgs, so that the value isn't looked -- up in the argument tables if it is accessed again. --]] metaArgs[key] = nil nilArgs[key] = '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
metatable.__pairs = function ()
-- Called when pairs is run on the args table.
if not metatable.donePairs then
mergeArgs(pairs, firstArgs, secondArgsargTables)
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 local v = t[i + 1] if not metatable.doneIpairs v ~= nil then mergeArgs(ipairs, firstArgsreturn i + 1, secondArgs) metatable.doneIpairs = truev
end
return ipairs(metaArgs)
end
  metatable.__ipairs = function (t) -- Called when ipairs is run on the args table. return inext, t, 0 end 
return args
end
return arguments

Navigation menu