Diff: Module:Unsubst
Comparing revision #1 (2021-10-08 18:22:16) with revision #2 (2023-02-02 06:54:19).
| Old | New |
|---|---|
local checkType = require('libraryUtil').checkType |
local checkType = require('libraryUtil').checkType |
local p = {} |
local p = {} |
local BODY_PARAM = '$B' |
local BODY_PARAM = '$B' |
local specialParams = { |
local specialParams = { |
['$params'] = 'parameter list', |
['$params'] = 'parameter list', |
['$aliases'] = 'parameter aliases', |
['$aliases'] = 'parameter aliases', |
['$flags'] = 'flags', |
['$flags'] = 'flags', |
['$B'] = 'template content', |
['$B'] = 'template content', |
['$template-name'] = 'template invocation name override', |
['$template-name'] = 'template invocation name override', |
} |
} |
function p.main(frame, body) |
function p.main(frame, body) |
-- If we are substing, this function returns a template invocation, and if |
-- 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 |
-- not, it returns the template body. The template body can be specified in |
-- the body parameter, or in the template parameter defined in the |
-- the body parameter, or in the template parameter defined in the |
-- BODY_PARAM variable. This function can be called from Lua or from |
-- BODY_PARAM variable. This function can be called from Lua or from |
-- #invoke. |
-- #invoke. |
-- Return the template body if we aren't substing. |
-- Return the template body if we aren't substing. |
if not mw.isSubsting() then |
if not mw.isSubsting() then |
if body ~= nil then |
if body ~= nil then |
return body |
return body |
elseif frame.args[BODY_PARAM] ~= nil then |
elseif frame.args[BODY_PARAM] ~= nil then |
return frame.args[BODY_PARAM] |
return frame.args[BODY_PARAM] |
else |
else |
error(string.format( |
error(string.format( |
"no template content specified (use parameter '%s' from #invoke)", |
"no template content specified (use parameter '%s' from #invoke)", |
BODY_PARAM |
BODY_PARAM |
), 2) |
), 2) |
end |
end |
end |
end |
-- Sanity check for the frame object. |
-- Sanity check for the frame object. |
if type(frame) ~= 'table' |
if type(frame) ~= 'table' |
or type(frame.getParent) ~= 'function' |
or type(frame.getParent) ~= 'function' |
or not frame:getParent() |
or not frame:getParent() |
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", |
"frame available", |
2 |
2 |
) |
) |
end |
end |
-- Find the invocation name. |
-- Find the invocation name. |
local mTemplateInvocation = require('Module:Template invocation') |
local mTemplateInvocation = require('Module:Template invocation') |
local name |
local name |
if frame.args['$template-name'] and '' ~= frame.args['$template-name'] then |
if frame.args['$template-name'] and '' ~= frame.args['$template-name'] then |
name = frame.args['$template-name'] -- override whatever the template name is with this name |
name = frame.args['$template-name'] -- override whatever the template name is with this name |
else |
else |
name = mTemplateInvocation.name(frame:getParent():getTitle()) |
name = mTemplateInvocation.name(frame:getParent():getTitle()) |
end |
end |
-- Combine passed args with passed defaults |
-- Combine passed args with passed defaults |
local args = {} |
local args = {} |
if string.find( ','..(frame.args['$flags'] or '')..',', ',%s*override%s*,' ) then |
if string.find( ','..(frame.args['$flags'] or '')..',', ',%s*override%s*,' ) then |
for k, v in pairs( frame:getParent().args ) do |
for k, v in pairs( frame:getParent().args ) do |
args[k] = v |
args[k] = v |
end |
end |
for k, v in pairs( frame.args ) do |
for k, v in pairs( frame.args ) do |
if not specialParams[k] then |
if not specialParams[k] then |
if v == '__DATE__' then |
if v == '__DATE__' then |
v = mw.getContentLanguage():formatDate( 'F Y' ) |
v = mw.getContentLanguage():formatDate( 'F Y' ) |
end |
end |
args[k] = v |
args[k] = v |
end |
end |
end |
end |
else |
else |
for k, v in pairs( frame.args ) do |
for k, v in pairs( frame.args ) do |
if not specialParams[k] then |
if not specialParams[k] then |
if v == '__DATE__' then |
if v == '__DATE__' then |
v = mw.getContentLanguage():formatDate( 'F Y' ) |
v = mw.getContentLanguage():formatDate( 'F Y' ) |
end |
end |
args[k] = v |
args[k] = v |
end |
end |
end |
end |
for k, v in pairs( frame:getParent().args ) do |
for k, v in pairs( frame:getParent().args ) do |
args[k] = v |
args[k] = v |
end |
end |
end |
end |
-- Trim parameters, if not specified otherwise |
-- Trim parameters, if not specified otherwise |
if not string.find( ','..(frame.args['$flags'] or '')..',', ',%s*keep%-whitespace%s*,' ) then |
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 |
for k, v in pairs( args ) do args[k] = mw.ustring.match(v, '^%s*(.*)%s*$') or '' end |
end |
end |
-- Pull information from parameter aliases |
-- Pull information from parameter aliases |
local aliases = {} |
local aliases = {} |
if frame.args['$aliases'] then |
if frame.args['$aliases'] then |
local list = mw.text.split( frame.args['$aliases'], '%s*,%s*' ) |
local list = mw.text.split( frame.args['$aliases'], '%s*,%s*' ) |
for k, v in ipairs( list ) do |
for k, v in ipairs( list ) do |
local tmp = mw.text.split( v, '%s*>%s*' ) |
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]) |
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 |
end |
end |
for k, v in pairs( aliases ) do |
for k, v in pairs( aliases ) do |
if args[k] and ( not args[v] or args[v] == '' ) then |
if args[k] and ( not args[v] or args[v] == '' ) then |
args[v] = args[k] |
args[v] = args[k] |
end |
end |
args[k] = nil |
args[k] = nil |
end |
end |
-- Remove empty parameters, if specified |
-- Remove empty parameters, if specified |
if string.find( ','..(frame.args['$flags'] or '')..',', ',%s*remove%-empty%s*,' ) then |
if string.find( ','..(frame.args['$flags'] or '')..',', ',%s*remove%-empty%s*,' ) then |
local tmp = 0 |
local tmp = 0 |
for k, v in ipairs( args ) do |
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 |
if v ~= '' or ( args[k+1] and args[k+1] ~= '' ) or ( args[k+2] and args[k+2] ~= '' ) then |
tmp = k |
tmp = k |
else |
else |
break |
break |
end |
end |
end |
end |
for k, v in pairs( args ) do |
for k, v in pairs( args ) do |
if v == '' then |
if v == '' then |
if not (type(k) == 'number' and k < tmp) then args[k] = nil end |
if not (type(k) == 'number' and k < tmp) then args[k] = nil end |
end |
end |
end |
end |
end |
end |
-- Order parameters |
-- Order parameters |
if frame.args['$params'] then |
if frame.args['$params'] then |
local params, tmp = mw.text.split( frame.args['$params'], '%s*,%s*' ), {} |
local params, tmp = mw.text.split( frame.args['$params'], '%s*,%s*' ), {} |
for k, v in ipairs(params) do |
for k, v in ipairs(params) do |
v = tonumber(mw.ustring.match(v, '^[1-9][0-9]*$')) or v |
v = tonumber(mw.ustring.match(v, '^[1-9][0-9]*$')) or v |
if args[v] then tmp[v], args[v] = args[v], nil end |
if args[v] then tmp[v], args[v] = args[v], nil end |
end |
end |
for k, v in pairs(args) do tmp[k], args[k] = args[k], nil end |
for k, v in pairs(args) do tmp[k], args[k] = args[k], nil end |
args = tmp |
args = tmp |
end |
end |
return mTemplateInvocation.invocation(name, args) |
return mTemplateInvocation.invocation(name, args) |
end |
end |
p[''] = p.main -- For backwards compatibility |
p[''] = p.main -- For backwards compatibility |
return p |
return p |