Module:Arguments: Difference between revisions

-- 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 = {}

local nilArg = {} -- Used for memoizing nil arguments in metaArgs.

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

end

end

local function tidyValTrimOnly(key, val)

if type(val) == 'string' then

end

end

local function tidyValRemoveBlanksOnly(key, val)

if type(val) == 'string' then

end

end

local function tidyValNoChange(key, val)

return val

end

function arguments.getArgs(frame, options)

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

frame = frame or {}

options = options or {}

-- 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 assign the args to a new variable so we can differentiate them.

luaArgs = frame

end

-- Set up the args and metaArgs tables. args will be the one accessed from functions, and metaArgs will hold the actual arguments.

-- The metatable connects the two together.

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

setmetatable(args, metatable)

-- Generate the tidyVal function. If it has been specified by the user, we use that; if not, we choose one of four functions

-- depending on the options chosen. This is so that we don't have to call the options table every time the function is called.

end

end

local function mergeArgs(iterator, tables)

-- Accepts multiple tables as input and merges their keys and values into one table using the specified iterator.

end

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.

argTables[#argTables + 1] = pargs

argTables[#argTables + 1] = luaArgs

--[[

-- Define metatable behaviour. Arguments are memoized in the metaArgs table, and are only fetched from the

-- pargs if pairs has already been run, as all the arguments will already have been copied over.

--]]

metatable.__index = function (t, key)

local val = metaArgs[key]

return nil

end

metatable.__newindex = function (t, key, val)

if options.readOnly then

end

end

metatable.__pairs = function ()

if not metatable.donePairs then

end

end

metatable.__ipairs = function ()

if not metatable.doneIpairs then

end, nil, 0

end

return args

end

return arguments