영어 위키백과>Quiddity (WMF) m (1 revision from w:en:Module:Arguments: attempt import of uptodate version) |
위키백과>콩가루 m (사용자가 "모듈:Arguments" 문서를 보호했습니다: 훼손시 영향이 큰 틀 문서: 훼손시 이 모듈을 사용하는 모든 문서가 훼손됨 ([편집=관리자만 허용] (무기한) [옮기기=관리자만 허용] (무기한))) |
||
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) | ||
54번째 줄: | 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 | |||
-- Get the | -- from another Lua module or from the debug console, so assign the args to a new variable so we can differentiate them. | ||
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 | ||
117번째 줄: | 70번째 줄: | ||
luaArgs = frame | luaArgs = frame | ||
end | end | ||
-- | -- Set up the args and metaArgs tables. args will be the one accessed from functions, and metaArgs will hold the actual arguments. | ||
-- Generate the tidyVal function. If it has been specified by the user, we | -- The metatable connects the two together. | ||
local args, metaArgs, metatable = {}, {}, {} | |||
-- options chosen. This is so that we don't have to call the options table | 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. | |||
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 | ||
155번째 줄: | 96번째 줄: | ||
end | end | ||
end | end | ||
local function mergeArgs(iterator, tables) | local function mergeArgs(iterator, tables) | ||
-- Accepts multiple tables as input and merges their keys and values into one table using the specified iterator. | |||
-- Accepts multiple tables as input and merges their keys and values | -- 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. | |||
-- We are also memoizing nil values, but those values can be | |||
for _, t in ipairs(tables) do | for _, t in ipairs(tables) do | ||
for key, val in iterator(t) do | 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 | ||
186번째 줄: | 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 == nil then | if argTableVal == nil then | ||
metaArgs[key] = nilArg | |||
else | else | ||
metaArgs[key] = argTableVal | metaArgs[key] = argTableVal | ||
230번째 줄: | 152번째 줄: | ||
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 | ||
262번째 줄: | 164번째 줄: | ||
metatable.__pairs = function () | metatable.__pairs = function () | ||
if not metatable.donePairs then | if not metatable.donePairs then | ||
mergeArgs(pairs, argTables) | mergeArgs(pairs, argTables) | ||
268번째 줄: | 169번째 줄: | ||
metatable.doneIpairs = true | metatable.doneIpairs = true | ||
end | end | ||
return | return function (t, k) | ||
local nk, val = next(metaArgs, k) | |||
if val == nilArg then | |||
val = nil | |||
end | |||
return nk, val | |||
end | |||
end | end | ||
metatable.__ipairs = function () | metatable.__ipairs = function () | ||
if not metatable.doneIpairs then | if not metatable.doneIpairs then | ||
mergeArgs(ipairs, argTables) | mergeArgs(ipairs, argTables) | ||
metatable.doneIpairs = true | metatable.doneIpairs = true | ||
end | end | ||
return | 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 | ||
2014년 11월 2일 (일) 15:43 판
이 모듈은 #invoke로부터 전달된 인수를 쉽게 처리할 수 있게 합니다. 다른 모듈에 의해 사용되는 메타 모듈이며 #invoke를 통해 직접 호출하지 않는 것이 좋습니다. 다음의 기능을 제공합니다:
- 인수의 공백을 쉽게 제거하고 비어있는 인수를 제거합니다.
- 인수는 현재의 프레임 및 부모 프레임에 의해 동시에 전달받을 수 있습니다.
- 인수는 다른 루아 모듈로부터 직접, 또는 디버그 콘솔로부터 전달받을 수 있습니다.
- 인수는 필요하면 페치(fetch)되며
<ref>...</ref>
태그로 (일부) 문제를 예방하는데 도움을 줍니다. - 대부분의 기능은 사용자 지정이 가능합니다.
기본 사용법
먼저 모듈을 불러와야 합니다. getArgs
라는 이름의 함수를 하나 포함합니다.
local getArgs = require('Module:Arguments').getArgs
더 자세한 사용법은 en:Module:Arguments를 참고하십시오.
-- 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
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
function arguments.getArgs(frame, options)
checkType('getArgs', 1, frame, 'table', true)
checkType('getArgs', 2, options, '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.
local fargs, pargs, luaArgs
if type(frame.args) == 'table' and type(frame.getParent) == 'function' then
if not options.parentOnly then
fargs = frame.args
end
if not options.frameOnly then
pargs = frame:getParent().args
end
if options.parentFirst then
fargs, pargs = pargs, fargs
end
else
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.
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
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.
for _, t in ipairs(tables) do
for key, val in iterator(t) do
local metaArgsVal = metaArgs[key]
if metaArgsVal == nil or metaArgsVal == nilArg then
local tidiedVal = tidyVal(key, val)
if tidiedVal == nil then
metaArgs[key] = nilArg
else
metaArgs[key] = tidiedVal
end
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, 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.
--]]
metatable.__index = function (t, key)
local val = metaArgs[key]
if val ~= nil then
if val == nilArg then
return nil
else
return val
end
end
for _, argTable in ipairs(argTables) do
local argTableVal = tidyVal(key, argTable[key])
if argTableVal == nil then
metaArgs[key] = nilArg
else
metaArgs[key] = argTableVal
return argTableVal
end
end
return nil
end
metatable.__newindex = function (t, key, val)
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
metaArgs[key] = nilArg -- Memoize nils.
else
metaArgs[key] = val
end
end
metatable.__pairs = function ()
if not metatable.donePairs then
mergeArgs(pairs, argTables)
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
metatable.__ipairs = function ()
if not metatable.doneIpairs then
mergeArgs(ipairs, argTables)
metatable.doneIpairs = true
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
return args
end
return arguments