Module:Arguments - Revision history

Abinash: 21 revisions

2016-04-08T12:23:06Z

21 revisions

Xaosflux: Changed protection level of Module:Arguments: used in the mediawiki interface ex: MediaWiki:Watchlist-details ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2015-12-23T16:07:27Z

Changed protection level of Module:Arguments: used in the mediawiki interface ex: MediaWiki:Watchlist-details ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

New page

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

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

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

--[[
-- 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(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;
-- tables listed earlier have precedence. We are also memoizing nil
-- 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

--[[
-- Define metatable behaviour. Arguments are memoized in the metaArgs table,
-- and are only fetched from the argument tables once. Fetching arguments
-- from the argument tables is the most resource-intensive step in this
-- module, so we try and avoid 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 the argument tables 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)
--[[
-- 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
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
-- 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(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

Jackmcbarn: add argument translation from sandbox - all tests pass

2015-06-26T22:53:15Z

add argument translation from sandbox - all tests pass

Jackmcbarn: apply changes from sandbox - all tests pass

2015-01-31T22:31:40Z

apply changes from sandbox - all tests pass

Mr. Stradivarius: fix bug where explicitly deleted args were still appearing when iterated over with pairs or ipairs - code courtesy of User:Jackmcbarn

2014-12-11T04:32:27Z

fix bug where explicitly deleted args were still appearing when iterated over with pairs or ipairs - code courtesy of User:Jackmcbarn

Mr. Stradivarius: allow using both the frame and parent frame arguments with the wrappers option if specifically requested, per protected edit request by User:Jackmcbarn

2014-07-05T03:52:56Z

allow using both the frame and parent frame arguments with the wrappers option if specifically requested, per protected edit request by User:Jackmcbarn

Mr. Stradivarius: add a "wrappers" option and fix bug when frame:getParent() returns nil, per protected edit request by User:Jackmcbarn

2014-06-06T14:24:47Z

add a "wrappers" option and fix bug when frame:getParent() returns nil, per protected edit request by User:Jackmcbarn

Mr. Stradivarius: memoize nils using a separate nilArgs table; this fixes a bug where nil values were being iterated over with pairs()

2014-04-18T10:30:10Z

memoize nils using a separate nilArgs table; this fixes a bug where nil values were being iterated over with pairs()

Show changes

Mr. Stradivarius: fix undefined next() behaviour bug by checking for metatable.donePairs in the __index metamethod; also, format the module so it fits into 80 characters

2014-04-15T08:10:43Z

fix undefined next() behaviour bug by checking for metatable.donePairs in the __index metamethod; also, format the module so it fits into 80 characters

Mr. Stradivarius: tweak one of the comments and make some beautification fixes, now that this is in the job queue

2014-01-13T05:40:58Z

tweak one of the comments and make some beautification fixes, now that this is in the job queue

← Older revision	Revision as of 12:23, 8 April 2016
(One intermediate revision by one other user not shown)
(No difference)

@@ Line 1: / Line 1: @@
--- This module provides easy processing of arguments passed to Scribunto from #invoke.
+-- This module provides easy processing of arguments passed to Scribunto from
--- It is intended for use by other Lua modules, and should not be called from #invoke directly.
+-- #invoke. It is intended for use by other Lua modules, and should not be
 local libraryUtil = require('libraryUtil')
@@ Line 9: / Line 10: @@
 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.
+-- Generate four different tidyVal functions, so that we don't have to check the
 local function tidyValDefault(key, val)
@@ Line 54: / Line 56: @@
 	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 arguments from the frame object if available. If the frame object
 	local fargs, pargs, luaArgs
 	if type(frame.args) == 'table' and type(frame.getParent) == 'function' then
@@ Line 71: / Line 77: @@
 	end
-	-- Set up the args and metaArgs tables. args will be the one accessed from functions, and metaArgs will hold the actual arguments.
+	-- Set up the args and metaArgs tables. args will be the one accessed from
-	-- The metatable connects the two together.
+	-- functions, and metaArgs will hold the actual arguments. The metatable
 	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.
+	-- Generate the tidyVal function. If it has been specified by the user, we
 	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)
+			error(
 		end
 	elseif options.trim ~= false then
@@ Line 98: / Line 115: @@
 	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.
+		-- Accepts multiple tables as input and merges their keys and values
-		-- We are also memoizing nil values, but those values can be overwritten.
+		-- into one table using the specified iterator. If a value is already
 		for _, t in ipairs(tables) do
 			for key, val in iterator(t) do
@@ Line 116: / Line 137: @@
 	end
-	-- Set the order of precedence of the argument tables. If the variables are nil, nothing will be added to the table,
+	-- Set the order of precedence of the argument tables. If the variables are
-	-- which is how we avoid clashes between the frame/parent args and the Lua args.
+	-- nil, nothing will be added to the table, which is how we avoid clashes
 	local argTables = {fargs}
 	argTables[#argTables + 1] = pargs
@@ Line 123: / Line 145: @@
 	--[[
-	-- Define metatable behaviour. Arguments are memoized in the metaArgs table, and are only fetched from the
+	-- Define metatable behaviour. Arguments are memoized in the metaArgs table,
-	-- argument tables once. Nil arguments are also memoized using the nilArg variable in order to increase
+	-- and are only fetched from the argument tables once. Nil arguments are
-	-- performance. Also, we keep a record in the metatable of when pairs and ipairs have been called, so we
+	-- also memoized using the nilArg variable in order to increase performance.
-	-- do not run pairs and ipairs on fargs and pargs more than once. We also do not run ipairs on fargs and
+	-- Also, we keep a record in the metatable of when pairs and ipairs have
-	-- pargs if pairs has already been run, as all the arguments will already have been copied over.
+	-- been called, so we do not run pairs and ipairs on fargs and pargs more
 	--]]
 	metatable.__index = function (t, key)
 		local val = metaArgs[key]
-		if val ~= nil then
+		if metatable.donePairs or val ~= nil then
 			if val == nilArg then
 				return nil
@@ Line 153: / Line 187: @@
 	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)
+			error(
 		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)
+			error(
 		elseif val == nil then
 			metaArgs[key] = nilArg -- Memoize nils.

@@ Line 99: / Line 99: @@
 	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 precendence.
+		-- 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
@@ Line 169: / Line 169: @@
 			metatable.doneIpairs = true
 		end
-		return function ( t, k )
+		return function (t, k)
-			local nk, val = next( metaArgs, k )
+			local nk, val = next(metaArgs, k)
 			if val == nilArg then
 				val = nil
@@ Line 183: / Line 183: @@
 			metatable.doneIpairs = true
 		end
-		return function ( t, i )
+		return function (t, i)
 			local val = metaArgs[i + 1]
 			if val == nil then

@@ Line 52: / Line 52: @@
 	return (tp == 'string' or tp == 'number') and mw.title.new( given ).prefixedText == title
 end
 function arguments.getArgs(frame, options)
@@ Line 58: / Line 60: @@
 	frame = frame or {}
 	options = options or {}
 	--[[
@@ Line 97: / Line 124: @@
 					end
 				end
-−
 				-- We test for false specifically here so that nil (the default) acts like true.
 				if found or options.frameOnly == false then
@@ Line 122: / Line 149: @@
 		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
@@ Line 215: / Line 242: @@
 		-- must be nil.
 		--]]
 		local val = metaArgs[key]
 		if val ~= nil then
@@ Line 235: / Line 265: @@
 		-- 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 options.readOnly then
 			error(
@@ Line 261: / Line 294: @@
 		else
 			metaArgs[key] = val
 		end
 	end
@@ Line 270: / Line 321: @@
 			metatable.donePairs = true
 		end
-		return pairs(metaArgs)
+		return translatenext, { t = metaArgs }
 	end
-−
 	local function inext(t, i)
 		-- This uses our __index metamethod

@@ Line 46: / Line 46: @@
 local function tidyValNoChange(key, val)
 	return val
 end
@@ Line 82: / Line 87: @@
 				local title = parent:getTitle():gsub('/sandbox$', '')
 				local found = false
-				if type(options.wrappers) == 'table' then
+				if matchesTitle(options.wrappers, title) then
 					for _,v in pairs(options.wrappers) do
-						if v == title then
+						if matchesTitle(v, title) then
 							found = true
 							break
 						end
 					end
 				end
@@ Line 165: / Line 170: @@
 	setmetatable(args, metatable)
-	local function mergeArgs(iterator, tables)
+	local function mergeArgs(tables)
 		--[[
 		-- Accepts multiple tables as input and merges their keys and values
-		-- into one table using the specified iterator. If a value is already
+		-- into one table. If a value is already present it is not overwritten;
-		-- present it is not overwritten; tables listed earlier have precedence.
+		-- tables listed earlier have precedence. We are also memoizing nil
-		-- We are also memoizing nil values, which can be overwritten if they
+		-- values, which can be overwritten if they are 's' (soft).
-		-- are 's' (soft).
 		--]]
 		for _, t in ipairs(tables) do
-			for key, val in iterator(t) do
+			for key, val in pairs(t) do
 				if metaArgs[key] == nil and nilArgs[key] ~= 'h' then
 					local tidiedVal = tidyVal(key, val)
@@ Line 263: / Line 267: @@
 		-- Called when pairs is run on the args table.
 		if not metatable.donePairs then
-			mergeArgs(pairs, argTables)
+			mergeArgs(argTables)
 			metatable.donePairs = true
 		end
 		return pairs(metaArgs)
 	end
-	metatable.__ipairs = function ()
+	metatable.__ipairs = function (t)
 		-- Called when ipairs is run on the args table.
-		if not metatable.doneIpairs then
+		return inext, t, 0
-			mergeArgs(ipairs, argTables)
-			metatable.doneIpairs = true
-		end
-		return ipairs(metaArgs)
 	end

@@ Line 170: / Line 170: @@
 		-- 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
+		-- We are also memoizing nil values, which can be overwritten if they
-		-- overwritten.
+		-- are 's' (soft).
 		--]]
 		for _, t in ipairs(tables) do
 			for key, val in iterator(t) do
-				if metaArgs[key] == nil then
+				if metaArgs[key] == nil and nilArgs[key] ~= 'h' then
 					local tidiedVal = tidyVal(key, val)
 					if tidiedVal == nil then
-						nilArgs[key] = true
+						nilArgs[key] = 's'
 					else
 						metaArgs[key] = tidiedVal
@@ Line 219: / Line 219: @@
 		for _, argTable in ipairs(argTables) do
 			local argTableVal = tidyVal(key, argTable[key])
-			if argTableVal == nil then
+			if argTableVal ~= nil then
-				nilArgs[key] = true
-			else
 				metaArgs[key] = argTableVal
 				return argTableVal
 			end
 		end
 		return nil
 	end
@@ Line 255: / Line 254: @@
 			--]]
 			metaArgs[key] = nil
-			nilArgs[key] = true
+			nilArgs[key] = 'h'
 		else
 			metaArgs[key] = val

@@ Line 92: / Line 92: @@
 					found = true
 				end
 				if found then
 					pargs = parent.args
-				else
+				end
 					fargs = frame.args
 				end
@@ Line 107: / Line 110: @@
 				pargs = parent and parent.args or nil
 			end
-			if options.parentFirst then
+		end
-				fargs, pargs = pargs, fargs
+		if options.parentFirst then
-			end
+			fargs, pargs = pargs, fargs
 		end
 	else

@@ Line 55: / Line 55: @@
 	--[[
-	-- Get the arguments from the frame object if available. If the frame object
+	-- Get the argument tables. If we were passed a valid frame object, get the
-	-- is not available, we are being called from another Lua module or from the
+	-- frame arguments (fargs) and the parent frame arguments (pargs), depending
-	-- debug console, so assign the args to a new variable so we can
+	-- on the options set and on the parent frame's availability. If we weren't
-	-- differentiate them.
+	-- passed a valid frame object, we are being called from another Lua module
 	--]]
 	local fargs, pargs, luaArgs
 	if type(frame.args) == 'table' and type(frame.getParent) == 'function' then
-		if not options.parentOnly then
+		if options.wrappers then
-			fargs = frame.args
+			--[[
-		end
+			-- The wrappers option makes Module:Arguments look up arguments in
-		if not options.frameOnly then
+			-- either the frame argument table or the parent argument table, but
-			pargs = frame:getParent().args
+			-- not both. This means that users can use either the #invoke syntax
-		end
+			-- or a wrapper template without the loss of performance associated
-		if options.parentFirst then
+			-- with looking arguments up in both the frame and the parent frame.
-			fargs, pargs = pargs, fargs
+			-- Module:Arguments will look up arguments in the parent frame
 		end
 	else
@@ Line 212: / Line 252: @@
 			--]]
 			metaArgs[key] = nil
-			nilArgs[key] = true -- Memoize nils.
+			nilArgs[key] = true
 		else
 			metaArgs[key] = val