Module:Arguments/sandbox: Difference between revisions

Revision as of 08:25, 21 April 2021

Latest revision as of 09:30, 21 April 2021

Line 3:

-- 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

-- val = val:match('^%s*(.-)%s*$')

-- if val == '' then

return nil

-- else

-- return val

-- end

-- else

-- return val

-- end

-- end

-- local function tidyValTrimOnly(key, val)

-- if type(val) == 'string' then

-- return val:match('^%s*(.-)%s*$')

-- else

-- return val

-- end

-- end

-- local function tidyValRemoveBlanksOnly(key, val)

-- if type(val) == 'string' then

-- if val:find('%S') then

-- return val

-- else

-- return nil

-- end

-- else

-- 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)

-- checkType('getArgs', 1, frame, 'table', true)

-- checkType('getArgs', 2, options, 'table', true)

-- frame = frame or {}

-- options = options or {}

--[[

-- Set up argument translation.

--]]

-- options.translate = options.translate or {}

-- if getmetatable(options.translate) == nil then

-- 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

--[[

Line 94:

-- 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

Line 108:

-- 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

-- fargs, pargs = pargs, fargs

-- 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

-- between the frame/parent args and the Lua args.

-- local argTables = {fargs}

-- argTables[#argTables + 1] = pargs

-- argTables[#argTables + 1] = luaArgs

--[[

Line 163:

-- every time the function is called.

--]]

-- local tidyVal = options.valueFunc

-- if tidyVal then

-- if type(tidyVal) ~= 'function' then

-- error(

-- "bad value assigned to option 'valueFunc'"

.. '(function expected, got '

.. type(tidyVal)

.. ')',

2

-- )

-- end

-- elseif options.trim ~= false then

-- if options.removeBlanks ~= false then

-- tidyVal = tidyValDefault

-- else

-- tidyVal = tidyValTrimOnly

-- end

-- else

-- if options.removeBlanks ~= false then

-- tidyVal = tidyValRemoveBlanksOnly

-- else

-- tidyVal = tidyValNoChange

-- end

-- end

--[[

Line 194:

-- together.

--]]

-- local args, metaArgs, nilArgs, metatable = {}, {}, {}, {}

-- setmetatable(args, metatable)

-- local function mergeArgs(tables)

-- --[[

-- Accepts multiple tables as input and merges their keys and values

-- into one table. If a value is already present it is not overwritten;

Line 204:

-- values, which can be overwritten if they are 's' (soft).

--]]

-- for _, t in ipairs(tables) do

-- for key, val in pairs(t) do

-- if metaArgs[key] == nil and nilArgs[key] ~= 'h' then

-- local tidiedVal = tidyVal(key, val)

-- if tidiedVal == nil then

-- nilArgs[key] = 's'

-- else

-- metaArgs[key] = tidiedVal

-- end

-- end

-- end

-- end

-- end

--[[

Line 230:

--]]

-- metatable.__index = function (t, key)

--[[

-- Fetches an argument when the args table is indexed. First we check

Line 242:

-- must be nil.

--]]

-- if type(key) == 'string' then

-- key = options.translate[key]

-- end

-- local val = metaArgs[key]

-- if val ~= nil then

-- return val

-- elseif metatable.donePairs or nilArgs[key] then

-- return nil

-- end

-- for _, argTable in ipairs(argTables) do

-- local argTableVal = tidyVal(key, argTable[key])

-- if argTableVal ~= nil then

-- metaArgs[key] = argTableVal

-- return 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 options.readOnly then

-- error(

-- 'could not write to argument table key "'

.. tostring(key)

.. '"; the table is read-only',

2

-- )

-- elseif options.noOverwrite 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

Line 290:

-- 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(argTables)

-- metatable.donePairs = true

-- end

-- return translatenext, { t = metaArgs }

-- end

-- local function inext(t, i)

-- This uses our __index metamethod

-- local v = t[i + 1]

-- if v ~= nil then

-- return i + 1, v

-- end

-- end

-- metatable.__ipairs = function (t)

-- Called when ipairs is run on the args table.

-- return inext, t, 0

-- end

-- return args

-- end

-- return arguments