편집을 취소할 수 있습니다. 이 편집을 되돌리려면 아래의 바뀐 내용을 확인한 후 게시해주세요.
최신판 | 당신의 편집 | ||
1번째 줄: | 1번째 줄: | ||
-- This module provides easy processing of arguments passed to Scribunto from | -- 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 libraryUtil = require('libraryUtil') | ||
8번째 줄: | 7번째 줄: | ||
local arguments = {} | local arguments = {} | ||
-- Generate four different tidyVal functions, so that we don't have to check the | 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) | local function tidyValDefault(key, val) | ||
47번째 줄: | 47번째 줄: | ||
return val | return val | ||
end | end | ||
function arguments.getArgs(frame, options) | function arguments.getArgs(frame, options) | ||
61번째 줄: | 54번째 줄: | ||
options = options 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. | |||
-- Get the | |||
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 | if not options.parentOnly then | ||
fargs = frame.args | |||
end | |||
if not options.frameOnly then | |||
pargs = frame:getParent().args | |||
end | end | ||
if options.parentFirst then | if options.parentFirst then | ||
150번째 줄: | 71번째 줄: | ||
end | end | ||
-- Set the | -- 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 = {}, {}, {} | ||
local | 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 | |||
-- Generate the tidyVal function. If it has been specified by the user, we | -- depending on the options chosen. This is so that we don't have to call the options table every time the function is called. | ||
-- options chosen. This is so that we don't have to call the options table | |||
local tidyVal = options.valueFunc | local tidyVal = options.valueFunc | ||
if tidyVal then | if tidyVal then | ||
if type(tidyVal) ~= 'function' then | if type(tidyVal) ~= 'function' then | ||
error( | error("bad value assigned to option 'valueFunc' (function expected, got " .. type(tidyVal) .. ')', 2) | ||
end | end | ||
elseif options.trim ~= false then | elseif options.trim ~= false then | ||
188번째 줄: | 97번째 줄: | ||
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. | |||
-- If a value is already present it is not overwritten; tables listed earlier have precedence. | |||
-- We are also memoizing nil values, but those values can be overwritten. | |||
local function mergeArgs(tables) | |||
-- Accepts multiple tables as input and merges their keys and values | |||
-- | |||
for _, t in ipairs(tables) do | for _, t in ipairs(tables) do | ||
for key, val in | for key, val in iterator(t) do | ||
local metaArgsVal = metaArgs[key] | |||
if metaArgsVal == nil or metaArgsVal == nilArg then | |||
local tidiedVal = tidyVal(key, val) | local tidiedVal = tidyVal(key, val) | ||
if tidiedVal == nil then | if tidiedVal == nil then | ||
metaArgs[key] = nilArg | |||
else | else | ||
metaArgs[key] = tidiedVal | metaArgs[key] = tidiedVal | ||
217번째 줄: | 115번째 줄: | ||
end | end | ||
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. | |||
local argTables = {fargs} | |||
argTables[#argTables + 1] = pargs | |||
argTables[#argTables + 1] = luaArgs | |||
--[[ | --[[ | ||
-- Define metatable behaviour. Arguments are memoized in the metaArgs table, | -- Define metatable behaviour. Arguments are memoized in the metaArgs table, and are only fetched from the | ||
-- argument tables once. Nil arguments are also memoized using the nilArg variable in order to increase | |||
-- | -- performance. 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 more than once. We also do not run ipairs on fargs and | ||
-- pargs if pairs has already been run, as all the arguments will already have been copied over. | |||
-- run pairs and ipairs on | |||
--]] | --]] | ||
metatable.__index = function (t, key) | metatable.__index = function (t, key) | ||
local val = metaArgs[key] | local val = metaArgs[key] | ||
if val ~= nil then | if val ~= nil then | ||
if val == nilArg then | |||
return nil | |||
return | else | ||
return val | |||
end | |||
end | end | ||
for _, argTable in ipairs(argTables) do | for _, argTable in ipairs(argTables) do | ||
local argTableVal = tidyVal(key, argTable[key]) | local argTableVal = tidyVal(key, argTable[key]) | ||
if argTableVal | if argTableVal == nil then | ||
metaArgs[key] = nilArg | |||
else | |||
metaArgs[key] = argTableVal | metaArgs[key] = argTableVal | ||
return argTableVal | return argTableVal | ||
end | end | ||
end | end | ||
return nil | return nil | ||
end | end | ||
metatable.__newindex = function (t, key, val) | metatable.__newindex = function (t, key, val) | ||
if options.readOnly then | if options.readOnly then | ||
error( | error('could not write to argument table key "' .. tostring(key) .. '"; the table is read-only', 2) | ||
elseif options.noOverwrite and args[key] ~= nil then | elseif options.noOverwrite and args[key] ~= nil then | ||
error( | error('could not write to argument table key "' .. tostring(key) .. '"; overwriting existing arguments is not permitted', 2) | ||
elseif val == nil then | elseif val == nil then | ||
metaArgs[key] = nilArg -- Memoize nils. | |||
metaArgs[key] = | |||
else | else | ||
metaArgs[key] = val | metaArgs[key] = val | ||
end | end | ||
end | end | ||
metatable.__pairs = function () | metatable.__pairs = function () | ||
if not metatable.donePairs then | if not metatable.donePairs then | ||
mergeArgs(argTables) | mergeArgs(pairs, argTables) | ||
metatable.donePairs = true | metatable.donePairs = true | ||
metatable.doneIpairs = true | |||
end | |||
return function (t, k) | |||
local nk, val = next(metaArgs, k) | |||
if val == nilArg then | |||
val = nil | |||
end | |||
return nk, val | |||
end | end | ||
end | end | ||
metatable.__ipairs = function () | |||
if not metatable.doneIpairs then | |||
mergeArgs(ipairs, argTables) | |||
if | metatable.doneIpairs = true | ||
end | end | ||
return function (t, i) | |||
local val = metaArgs[i + 1] | |||
if val == nil then | |||
return nil | |||
elseif val == nilArg then | |||
val = nil | |||
end | |||
return i + 1, val | |||
end, nil, 0 | |||
end | end | ||