Module:File link: Difference between revisions

Jump to navigation Jump to search
imported>Mr. Stradivarius
(move duplicate size error checks to the setting functions, fix the alignment error message)
m (Protected "Module:File link": Important page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
 
(20 intermediate revisions by 3 users not shown)
Line 1: Line 1:
-- This module provides a library for formatting image wikilinks.
-- This module provides a library for formatting file wikilinks.


local libraryUtil = require('libraryUtil')
local yesno = require('Module:Yesno')
local checkType = require('libraryUtil').checkType


local image = {}
local p = {}


function image.new()
function p._main(args)
local obj, data = {}, {}
checkType('_main', 1, args, 'table')
 
local checkSelf = libraryUtil.makeCheckSelfFunction('image', 'image', obj, 'image object')
-- This is basically libraryUtil.checkTypeForNamedArg, but we are rolling our
local checkType = libraryUtil.checkType
-- own function to get the right error level.
local function checkArg(key, val, level)
function data:name(s)
if type(val) ~= 'string' then
checkSelf(self, 'name')
error(string.format(
checkType('name', 1, s, 'string')
"type error in '%s' parameter of '_main' (expected string, got %s)",
data.theName = s
key, type(val)
end
), level)
function data:format(s, filename)
checkSelf(self, 'format')
checkType('format', 1, s, 'string')
checkType('format', 2, format, 'string', true)
local validFormats = {
thumb = true,
thumbnail = true,
frame = true,
framed = true,
frameless = true
}
if validFormats[s] then
data.theFormat = s
data.theFormatFilename = filename
else
error('invalid format')
end
end
end
end


local function sizeError(methodName)
local ret = {}
-- Used for formatting duplication errors in size-related methods.
 
error(string.format(
-- Adds a positional parameter to the buffer.
"duplicate size argument detected in '%s'"
local function addPositional(key)
.. " ('upright' cannot be used in conjunction with height or width)",
local val = args[key]
methodName
if not val then
), 3)
return nil
end
function data:width(px)
checkSelf(self, 'width')
checkType('width', 1, px, 'number')
if data.isUpright then
sizeError('width')
end
end
data.theWidth = px
checkArg(key, val, 4)
ret[#ret + 1] = val
end
end
 
function data:height(px)
-- Adds a named parameter to the buffer. We assume that the parameter name
checkSelf(self, 'height')
-- is the same as the argument key.
checkType('height', 1, px, 'number')
local function addNamed(key)
if data.isUpright then
local val = args[key]
sizeError('height')
if not val then
return nil
end
end
data.theHeight = px
checkArg(key, val, 4)
ret[#ret + 1] = key .. '=' .. val
end
end
 
function data:upright(factor)
-- Filename
checkSelf(self, 'upright')
checkArg('file', args.file, 3)
checkType('upright', 1, factor, 'number', true)
ret[#ret + 1] = 'File:' .. args.file
if data.theWidth or data.theHeight then
 
sizeError('upright')
-- Format
end
if args.format then
data.isUpright = true
checkArg('format', args.format)
data.uprightFactor = factor
if args.formatfile then
end
checkArg('formatfile', args.formatfile)
ret[#ret + 1] = args.format .. '=' .. args.formatfile
function data:resetSize()
checkSelf(self, 'resetSize')
for i, field in ipairs{'theWidth', 'theHeight', 'isUpright', 'uprightFactor'} do
data[field] = nil
end
end
function data:location(s)
checkSelf(self, 'location')
checkType('location', 1, s, 'string')
local validLocations = {
right = true,
left = true,
center = true,
none = true
}
if validLocations[s] then
data.theLocation = s
else
else
error(string.format(
ret[#ret + 1] = args.format
"bad argument #1 to 'location' ('%s' is not a valid location)",
s
))
end
end
end
end
 
function data:alignment(s)
-- Border
checkSelf(self, 'alignment')
if yesno(args.border) then
checkType('alignment', 1, s, 'string')
ret[#ret + 1] = 'border'
local validAlignments = {
baseline = true,
middle = true,
sub = true,
super = true,
['text-top'] = true,
['text-bottom'] = true,
top = true,
bottom = true
}
if validAlignments[s] then
data.theAlignment = s
else
error(string.format(
"bad argument #1 to 'alignment' ('%s' is not a valid alignment)",
s
))
end
end
end
 
function data:border()
addPositional('location')
checkSelf(self, 'border')
addPositional('alignment')
data.hasBorder = true
addPositional('size')
end
addNamed('upright')
addNamed('link')
function data:link(s)
addNamed('alt')
checkSelf(self, 'link')
addNamed('page')
checkType('link', 1, s, 'string')
addNamed('class')
data.theLink = s
addNamed('lang')
end
addNamed('start')
addNamed('end')
function data:alt(s)
addNamed('thumbtime')
checkSelf(self, 'alt')
addPositional('caption')
checkType('alt', 1, s, 'string')
 
data.theAlt = s
return string.format('[[%s]]', table.concat(ret, '|'))
end
 
function p.main(frame)
local origArgs = require('Module:Arguments').getArgs(frame, {
wrappers = 'Template:File link'
})
if not origArgs.file then
error("'file' parameter missing from [[Template:File link]]", 0)
end
end
function data:caption(s)
checkSelf(self, 'caption')
checkType('caption', 1, s, 'string')
data.theCaption = s
end
function data:render()
checkSelf(self, 'render')
local ret = {}
-- Image name.
if not data.theName then
error('image:render: no image name was found')
end
ret[#ret + 1] = 'File:' .. data.theName
-- Image format
if data.theFormat and data.theFormatFilename then
ret[#ret + 1] = data.theFormat .. '=' .. data.theFormatFilename
elseif data.theFormat then
ret[#ret + 1] = data.theFormat
end
-- Border
if data.hasBorder then
ret[#ret + 1] = 'border'
end
-- Location
ret[#ret + 1] = data.theLocation


-- Alignment
-- Copy the arguments that were passed to a new table to avoid looking up
ret[#ret + 1] = data.theAlignment
-- every possible parameter in the frame object.
local args = {}
-- Size
for k, v in pairs(origArgs) do
if data.isUpright and data.uprightFactor then
-- Make _BLANK a special argument to add a blank parameter. For use in
ret[#ret + 1] = 'upright=' .. tostring(data.uprightFactor)
-- conditional templates etc. it is useful for blank arguments to be
elseif data.isUpright then
-- ignored, but we still need a way to specify them so that we can do
ret[#ret + 1] = 'upright'
-- things like [[File:Example.png|link=]].
elseif data.theWidth and data.theHeight then
if v == '_BLANK' then
ret[#ret + 1] = string.format('%dx%dpx', data.theWidth, data.theHeight)
v = ''
elseif data.theWidth then
ret[#ret + 1] = tostring(data.theWidth) .. 'px'
elseif data.theHeight then
ret[#ret + 1] = string.format('x%dpx', data.theHeight)
end
-- Link
if data.theLink then
ret[#ret + 1] = 'link=' .. data.theLink
end
-- Alt
if data.theAlt then
ret[#ret + 1] = 'alt=' .. data.theAlt
end
end
args[k] = v
-- Caption
ret[#ret + 1] = data.theCaption
return string.format('[[%s]]', table.concat(ret, '|'))
end
local readOnlyFields = {
theName = true,
theFormat = true,
theFormatFilename = true,
theWidth = true,
theHeight = true,
isUpright = true,
uprightFactor = true,
theLocation = true,
theAlignment = true,
hasBorder = true,
theLink = true,
theAlt = true,
theCaption = true
}
for field in pairs(data) do
readOnlyFields[field] = true
end
end
return p._main(args)
setmetatable(obj, {
__index = data,
__newindex = function (t, key, value)
if readOnlyFields[key] then
error(string.format(
"field '%s' is read-only",
tostring(key)
), 2)
else
data[key] = value
end
end,
__tostring = function (t)
return t:render()
end
})
return obj
end
end


return image
return p

Latest revision as of 03:29, 15 September 2023

Documentation for this module may be created at Module:File link/doc

-- This module provides a library for formatting file wikilinks.

local yesno = require('Module:Yesno')
local checkType = require('libraryUtil').checkType

local p = {}

function p._main(args)
	checkType('_main', 1, args, 'table')

	-- This is basically libraryUtil.checkTypeForNamedArg, but we are rolling our
	-- own function to get the right error level.
	local function checkArg(key, val, level)
		if type(val) ~= 'string' then
			error(string.format(
				"type error in '%s' parameter of '_main' (expected string, got %s)",
				key, type(val)
			), level)
		end
	end

	local ret = {}

	-- Adds a positional parameter to the buffer.
	local function addPositional(key)
		local val = args[key]
		if not val then
			return nil
		end
		checkArg(key, val, 4)
		ret[#ret + 1] = val
	end

	-- Adds a named parameter to the buffer. We assume that the parameter name
	-- is the same as the argument key.
	local function addNamed(key)
		local val = args[key]
		if not val then
			return nil
		end
		checkArg(key, val, 4)
		ret[#ret + 1] = key .. '=' .. val
	end

	-- Filename
	checkArg('file', args.file, 3)
	ret[#ret + 1] = 'File:' .. args.file

	-- Format
	if args.format then
		checkArg('format', args.format)
		if args.formatfile then
			checkArg('formatfile', args.formatfile)
			ret[#ret + 1] = args.format .. '=' .. args.formatfile
		else
			ret[#ret + 1] = args.format
		end
	end

	-- Border
	if yesno(args.border) then
		ret[#ret + 1] = 'border'
	end

	addPositional('location')
	addPositional('alignment')
	addPositional('size')
	addNamed('upright')
	addNamed('link')
	addNamed('alt')
	addNamed('page')
	addNamed('class')
	addNamed('lang')
	addNamed('start')
	addNamed('end')
	addNamed('thumbtime')
	addPositional('caption')

	return string.format('[[%s]]', table.concat(ret, '|'))
end

function p.main(frame)
	local origArgs = require('Module:Arguments').getArgs(frame, {
		wrappers = 'Template:File link'
	})
	if not origArgs.file then
		error("'file' parameter missing from [[Template:File link]]", 0)
	end

	-- Copy the arguments that were passed to a new table to avoid looking up
	-- every possible parameter in the frame object.
	local args = {}
	for k, v in pairs(origArgs) do
		-- Make _BLANK a special argument to add a blank parameter. For use in
		-- conditional templates etc. it is useful for blank arguments to be
		-- ignored, but we still need a way to specify them so that we can do
		-- things like [[File:Example.png|link=]].
		if v == '_BLANK' then
			v = ''
		end
		args[k] = v
	end
	return p._main(args)
end

return p