Module:File link: Difference between revisions

Jump to navigation Jump to search
imported>Mr. Stradivarius
(add type checks and write the render function; read-only code not working yet)
m (Protected "Module:File link": Important page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
 
(22 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)",
self.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
self.theFormat = s
self.theFormatFilename = filename
else
error('invalid format')
end
end
end
end
 
function data:width(px)
local ret = {}
checkSelf(self, 'width')
 
checkType('width', 1, px, 'number')
-- Adds a positional parameter to the buffer.
self.theWidth = px
local function addPositional(key)
end
local val = args[key]
if not val then
function data:height(px)
return nil
checkSelf(self, 'height')
checkType('height', 1, px, 'number')
self.theHeight = px
end
function data:upright(factor)
checkSelf(self, 'upright')
checkType('upright', 1, factor, 'number', true)
self.isUpright = true
self.uprightFactor = factor
end
function data:resetSize()
checkSelf(self, 'resetSize')
for i, field in ipairs{'theWidth', 'theHeight', 'isUpright', 'uprightFactor'} do
self[field] = nil
end
end
checkArg(key, val, 4)
ret[#ret + 1] = val
end
end
 
function data:location(s)
-- Adds a named parameter to the buffer. We assume that the parameter name
checkSelf(self, 'location')
-- is the same as the argument key.
checkType('location', 1, s, 'string')
local function addNamed(key)
local validLocations = {
local val = args[key]
right = true,
if not val then
left = true,
return nil
center = true,
none = true
}
if validLocations[s] then
self.theLocation = s
else
error(string.format(
"bad argument #1 to 'image:location' ('%s' is not a valid location)",
s
))
end
end
checkArg(key, val, 4)
ret[#ret + 1] = key .. '=' .. val
end
end
 
function data:alignment(s)
-- Filename
checkSelf(self, 'alignment')
checkArg('file', args.file, 3)
checkType('alignment', 1, s, 'string')
ret[#ret + 1] = 'File:' .. args.file
local validAlignments = {
 
baseline = true,
-- Format
middle = true,
if args.format then
sub = true,
checkArg('format', args.format)
super = true,
if args.formatfile then
['text-top'] = true,
checkArg('formatfile', args.formatfile)
['text-bottom'] = true,
ret[#ret + 1] = args.format .. '=' .. args.formatfile
top = true,
bottom = true
}
if validAlignments[s] then
self.theAlignment = s
else
else
error(string.format(
ret[#ret + 1] = args.format
"bad argument #1 to 'image:alignment' ('%s' is not a valid alignment)"
))
end
end
end
end
 
function data:border()
-- Border
checkSelf(self, 'border')
if yesno(args.border) then
self.hasBorder = true
ret[#ret + 1] = 'border'
end
end
 
function data:link(s)
addPositional('location')
checkSelf(self, 'link')
addPositional('alignment')
checkType('link', 1, s, 'string')
addPositional('size')
self.theLink = s
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
end
function data:alt(s)
checkSelf(self, 'alt')
checkType('alt', 1, s, 'string')
self.theAlt = s
end
function data:caption(s)
checkSelf(self, 'caption')
checkType('caption', 1, s, 'string')
self.theCaption = s
end
function data:render()
checkSelf(self, 'render')
local ret = {}
-- Image name.
if not self.theName then
error('image:render: no image name was found')
end
ret[#ret + 1] = 'File:' .. self.theName
-- Image format
if self.theFormat and self.theFormatFilename then
ret[#ret + 1] = self.theFormat .. '=' .. self.theFormatFilename
elseif self.theFormat then
ret[#ret + 1] = self.theFormat
end
-- Border
if self.hasBorder then
ret[#ret + 1] = 'border'
end
-- Location
ret[#ret + 1] = self.theLocation


-- Alignment
-- Copy the arguments that were passed to a new table to avoid looking up
ret[#ret + 1] = self.theAlignment
-- every possible parameter in the frame object.
local args = {}
-- Size
for k, v in pairs(origArgs) do
if self.isUpright and (self.theWidth or self.theHeight) then
-- Make _BLANK a special argument to add a blank parameter. For use in
error("duplicate size value detected in 'render' (height/width cannot be used at the same time as 'upright')")
-- conditional templates etc. it is useful for blank arguments to be
elseif self.isUpright and self.uprightFactor then
-- ignored, but we still need a way to specify them so that we can do
ret[#ret + 1] = 'upright=' .. tostring(self.uprightFactor)
-- things like [[File:Example.png|link=]].
elseif self.isUpright then
if v == '_BLANK' then
ret[#ret + 1] = 'upright'
v = ''
elseif self.theWidth and self.theHeight then
ret[#ret + 1] = string.format('%dx%dpx', self.theWidth, self.theHeight)
elseif self.theWidth then
ret[#ret + 1] = tostring(self.theWidth) .. 'px'
elseif self.theHeight then
ret[#ret + 1] = string.format('x%dpx', self.theHeight)
end
-- Link
if self.theLink then
ret[#ret + 1] = 'link=' .. self.theLink
end
-- Alt
if self.theAlt then
ret[#ret + 1] = 'alt=' .. self.theAlt
end
end
args[k] = v
-- Caption
ret[#ret + 1] = self.theCaption
return string.format('[[%s]]', table.concat(ret, '|'))
end
end
return p._main(args)
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
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
 
-- return image
 
local p = {}
 
function p.test()
local myImage = image.new()
myImage:name('Foo')
return myImage:render()
end
end


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