Difference between revisions of "Module:Unsubst/sandbox"

From blackwiki
Jump to navigation Jump to search
blackwiki>Mr. Stradivarius
(split this up into three different functions, to allow other Lua modules to use the invocation-building algorithm and the full unsubst functionality without having to play around with frame objects)
m (19 revisions imported)
 
(11 intermediate revisions by 2 users not shown)
Line 5: Line 5:
 
local BODY_PARAM = '$B'
 
local BODY_PARAM = '$B'
  
function p.invocation(name, args)
+
local specialParams = {
-- This function makes a template invocation from the name and the arguments
+
['$params'] = 'parameter list',
-- given. The arguments are not altered.
+
['$aliases'] = 'parameter aliases',
checkType('p.invocation', 1, name, 'string')
+
['$flags'] = 'flags',
checkType('p.invocation', 2, args, 'table')
+
['$B'] = 'template content'
+
}
-- Copy the invocation args and convert magic words.
 
-- We need to make a copy of the table rather than just using the original,
 
-- as some of the values may be erased when building the invocation.
 
local invArgs = {}
 
for k, v in pairs(args) do
 
invArgs[k] = v
 
end
 
 
 
-- Build the invocation body with numbered args first, then named.
 
local ret = {}
 
ret[#ret + 1] = '{{'
 
ret[#ret + 1] = name
 
for k, v in ipairs(invArgs) do
 
if string.find(v, '=', 1, true) then
 
-- Likely something like 1=foo=bar, we need to do it as a named arg
 
break
 
end
 
ret[#ret + 1] = '|'
 
ret[#ret + 1] = v
 
invArgs[k] = nil -- Erase the key so that we don't add the value twice
 
end
 
for k, v in pairs(invArgs) do
 
ret[#ret + 1] = '|'
 
ret[#ret + 1] = k
 
ret[#ret + 1] = '='
 
ret[#ret + 1] = v
 
end
 
ret[#ret + 1] = '}}'
 
 
 
return table.concat(ret)
 
end
 
  
function p._main(frame, body)
+
function p.main(frame, body)
-- If we are substing, this function returns a template invocation. The
+
-- If we are substing, this function returns a template invocation, and if
-- invocation substitutes the magic word "__DATE__" for the current month
+
-- not, it returns the template body. The template body can be specified in
-- and year in "Month YYYY" format. If we are not substing, the function
+
-- the body parameter, or in the template parameter defined in the
-- returns the body parameter, without any type checking. This function
+
-- BODY_PARAM variable. This function can be called from Lua or from
-- is intended to be called from Lua modules.
+
-- #invoke.
--
 
-- Params:
 
-- @frame - the current frame object. Requires a parent frame to be available.
 
-- @body - the template body, returned as-is if not substing.
 
  
 +
-- Return the template body if we aren't substing.
 
if not mw.isSubsting() then
 
if not mw.isSubsting() then
return body
+
if body ~= nil then
 +
return body
 +
elseif frame.args[BODY_PARAM] ~= nil then
 +
return frame.args[BODY_PARAM]
 +
else
 +
error(string.format(
 +
"no template content specified (use parameter '%s' from #invoke)",
 +
BODY_PARAM
 +
), 2)
 +
end
 
end
 
end
  
Line 64: Line 39:
 
then
 
then
 
error(
 
error(
"argument #1 to '_main' must be a frame object with a parent " ..
+
"argument #1 to 'main' must be a frame object with a parent " ..
"frame available", 2
+
"frame available",
 +
2
 
)
 
)
 
end
 
end
  
 
-- Find the invocation name.
 
-- Find the invocation name.
local titleobj = mw.title.new(frame:getParent():getTitle())
+
local mTemplateInvocation = require('Module:Template invocation')
local name
+
local name = mTemplateInvocation.name(frame:getParent():getTitle())
if titleobj.namespace == 10 then -- NS_TEMPLATE
+
 
name = titleobj.text
+
-- Combine passed args with passed defaults
elseif titleobj.namespace == 0 then -- NS_MAIN
+
local args = {}
name = ':' .. titleobj.text
+
if string.find( ','..(frame.args['$flags'] or '')..',', ',%s*override%s*,' ) then
 +
for k, v in pairs( frame:getParent().args ) do
 +
args[k] = v
 +
end
 +
for k, v in pairs( frame.args ) do
 +
if not specialParams[k] then
 +
if v == '__DATE__' then
 +
v = mw.getContentLanguage():formatDate( 'F Y' )
 +
end
 +
args[k] = v
 +
end
 +
end
 
else
 
else
name = titleobj.prefixedText
+
for k, v in pairs( frame.args ) do
 +
if not specialParams[k] then
 +
if v == '__DATE__' then
 +
v = mw.getContentLanguage():formatDate( 'F Y' )
 +
end
 +
args[k] = v
 +
end
 +
end
 +
for k, v in pairs( frame:getParent().args ) do
 +
args[k] = v
 +
end
 +
end
 +
 
 +
-- Trim parameters, if not specified otherwise
 +
if not string.find( ','..(frame.args['$flags'] or '')..',', ',%s*keep%-whitespace%s*,' ) then
 +
for k, v in pairs( args ) do args[k] = mw.ustring.match(v, '^%s*(.*)%s*$') or '' end
 
end
 
end
  
-- Combine passed args with passed defaults, and substitute magic words.
+
-- Pull information from parameter aliases
local args = {}
+
local aliases = {}
for k, v in pairs(frame.args) do
+
if frame.args['$aliases'] then
if v == '__DATE__' then
+
local list = mw.text.split( frame.args['$aliases'], '%s*,%s*' )
v = mw.getContentLanguage():formatDate('F Y')
+
for k, v in ipairs( list ) do
 +
local tmp = mw.text.split( v, '%s*>%s*' )
 +
aliases[tonumber(mw.ustring.match(tmp[1], '^[1-9][0-9]*$')) or tmp[1]] = ((tonumber(mw.ustring.match(tmp[2], '^[1-9][0-9]*$'))) or tmp[2])
 
end
 
end
args[k] = v
 
 
end
 
end
for k, v in pairs(frame:getParent().args) do
+
for k, v in pairs( aliases ) do
args[k] = v
+
if args[k] and ( not args[v] or args[v] == '' ) then
 +
args[v] = args[k]
 +
end
 +
args[k] = nil
 
end
 
end
  
return p.invocation(name, args)
+
-- Remove empty parameters, if specified
end
+
if string.find( ','..(frame.args['$flags'] or '')..',', ',%s*remove%-empty%s*,' ) then
 +
local tmp = 0
 +
for k, v in ipairs( args ) do
 +
if v ~= '' or ( args[k+1] and args[k+1] ~= '' ) or ( args[k+2] and args[k+2] ~= '' ) then
 +
tmp = k
 +
else
 +
break
 +
end
 +
end
 +
for k, v in pairs( args ) do
 +
if v == '' then
 +
if not (type(k) == 'number' and k < tmp) then args[k] = nil end
 +
end
 +
end
 +
end
  
function p.main(frame)
+
-- Order parameters
-- This function is called from #invoke. It uses the parameter defined in
+
if frame.args['$params'] then
-- BODY_PARAM for the template content.
+
local params, tmp = mw.text.split( frame.args['$params'], '%s*,%s*' ), {}
local body = frame.args[BODY_PARAM]
+
for k, v in ipairs(params) do
if not body then
+
v = tonumber(mw.ustring.match(v, '^[1-9][0-9]*$')) or v
error(string.format(
+
if args[v] then tmp[v], args[v] = args[v], nil end
"no template content provided (use parameter '%s')",
+
end
BODY_PARAM
+
for k, v in pairs(args) do tmp[k], args[k] = args[k], nil end
), 2)
+
args = tmp
 
end
 
end
frame.args[BODY_PARAM] = nil
+
 
return p._main(frame, body)
+
return mTemplateInvocation.invocation(name, args)
 
end
 
end
  
p[''] = p.main -- Alias for p.main, for backwards compatibility.
+
p[''] = p.main -- For backwards compatibility
  
 
return p
 
return p

Latest revision as of 04:55, 30 September 2020

Documentation for this module may be created at Module:Unsubst/sandbox/doc

local checkType = require('libraryUtil').checkType

local p = {}

local BODY_PARAM = '$B'

local specialParams = {
	['$params'] = 'parameter list',
	['$aliases'] = 'parameter aliases',
	['$flags'] = 'flags',
	['$B'] = 'template content'
}

function p.main(frame, body)
	-- If we are substing, this function returns a template invocation, and if
	-- not, it returns the template body. The template body can be specified in
	-- the body parameter, or in the template parameter defined in the
	-- BODY_PARAM variable. This function can be called from Lua or from
	-- #invoke.

	-- Return the template body if we aren't substing.
	if not mw.isSubsting() then
		if body ~= nil then
			return body
		elseif frame.args[BODY_PARAM] ~= nil then
			return frame.args[BODY_PARAM]
		else
			error(string.format(
				"no template content specified (use parameter '%s' from #invoke)",
				BODY_PARAM
			), 2)
		end
	end

	-- Sanity check for the frame object.
	if type(frame) ~= 'table'
		or type(frame.getParent) ~= 'function'
		or not frame:getParent()
	then
		error(
			"argument #1 to 'main' must be a frame object with a parent " ..
			"frame available",
			2
		)
	end

	-- Find the invocation name.
	local mTemplateInvocation = require('Module:Template invocation')
	local name = mTemplateInvocation.name(frame:getParent():getTitle())

	-- Combine passed args with passed defaults
	local args = {}
	if string.find( ','..(frame.args['$flags'] or '')..',', ',%s*override%s*,' ) then
		for k, v in pairs( frame:getParent().args ) do
			args[k] = v
		end
		for k, v in pairs( frame.args ) do
			if not specialParams[k] then
				if v == '__DATE__' then
					v = mw.getContentLanguage():formatDate( 'F Y' )
				end
				args[k] = v
			end
		end
	else
		for k, v in pairs( frame.args ) do
			if not specialParams[k] then
				if v == '__DATE__' then
					v = mw.getContentLanguage():formatDate( 'F Y' )
				end
				args[k] = v
			end
		end
		for k, v in pairs( frame:getParent().args ) do
			args[k] = v
		end
	end

	-- Trim parameters, if not specified otherwise
	if not string.find( ','..(frame.args['$flags'] or '')..',', ',%s*keep%-whitespace%s*,' ) then
		for k, v in pairs( args ) do args[k] = mw.ustring.match(v, '^%s*(.*)%s*$') or '' end
	end

	-- Pull information from parameter aliases
	local aliases = {}
	if frame.args['$aliases'] then
		local list = mw.text.split( frame.args['$aliases'], '%s*,%s*' )
		for k, v in ipairs( list ) do
			local tmp = mw.text.split( v, '%s*>%s*' )
			aliases[tonumber(mw.ustring.match(tmp[1], '^[1-9][0-9]*$')) or tmp[1]] = ((tonumber(mw.ustring.match(tmp[2], '^[1-9][0-9]*$'))) or tmp[2])
		end
	end
	for k, v in pairs( aliases ) do
		if args[k] and ( not args[v] or args[v] == '' ) then
			args[v] = args[k]
		end
		args[k] = nil
	end

	-- Remove empty parameters, if specified
	if string.find( ','..(frame.args['$flags'] or '')..',', ',%s*remove%-empty%s*,' ) then
		local tmp = 0
		for k, v in ipairs( args ) do
			if v ~= '' or ( args[k+1] and args[k+1] ~= '' ) or ( args[k+2] and args[k+2] ~= '' ) then
				tmp = k
			else
				break
			end
		end
		for k, v in pairs( args ) do
			if v == '' then
				if not (type(k) == 'number' and k < tmp) then args[k] = nil end
			end
		end
	end

	-- Order parameters
	if frame.args['$params'] then
		local params, tmp = mw.text.split( frame.args['$params'], '%s*,%s*' ), {}
		for k, v in ipairs(params) do
			v = tonumber(mw.ustring.match(v, '^[1-9][0-9]*$')) or v
			if args[v] then tmp[v], args[v] = args[v], nil end
		end
		for k, v in pairs(args) do tmp[k], args[k] = args[k], nil end
		args = tmp
	end

	return mTemplateInvocation.invocation(name, args)
end

p[''] = p.main -- For backwards compatibility

return p