Jump to content

Module:File link: Difference between revisions

Module:File link (edit)

Revision as of 01:49, 30 May 2014

3,295 bytes added ,  10 years ago
add type checks and write the render function; read-only code not working yet
(beginnings of an image library)
 
(add type checks and write the render function; read-only code not working yet)
Line 1: Line 1:
-- This module provides a library for formatting image wikilinks.
local libraryUtil = require('libraryUtil')
local image = {}
local image = {}


function image.new()
function image.new()
local obj, data = {}, {}
local obj, data = {}, {}
local checkSelf = libraryUtil.makeCheckSelfFunction('image', 'image', obj, 'image object')
local checkType = libraryUtil.checkType
function data:name(s)
function data:name(s)
checkSelf(self, 'name')
checkType('name', 1, s, 'string')
self.theName = s
self.theName = s
end
end
function data:format(s, filename)
function data:format(s, filename)
checkSelf(self, 'format')
checkType('format', 1, s, 'string')
checkType('format', 2, format, 'string', true)
local validFormats = {
local validFormats = {
thumb = true,
thumb = true,
Line 25: Line 37:
function data:width(px)
function data:width(px)
checkSelf(self, 'width')
checkType('width', 1, px, 'number')
self.theWidth = px
self.theWidth = px
end
end
function data:height(px)
function data:height(px)
checkSelf(self, 'height')
checkType('height', 1, px, 'number')
self.theHeight = px
self.theHeight = px
end
end
function data:upright(factor)
function data:upright(factor)
checkSelf(self, 'upright')
checkType('upright', 1, factor, 'number', true)
self.isUpright = true
self.isUpright = true
self.uprightFactor = factor
self.uprightFactor = factor
Line 38: Line 56:
function data:resetSize()
function data:resetSize()
checkSelf(self, 'resetSize')
for i, field in ipairs{'theWidth', 'theHeight', 'isUpright', 'uprightFactor'} do
for i, field in ipairs{'theWidth', 'theHeight', 'isUpright', 'uprightFactor'} do
self[field] = nil
self[field] = nil
Line 44: Line 63:
function data:location(s)
function data:location(s)
checkSelf(self, 'location')
checkType('location', 1, s, 'string')
local validLocations = {
local validLocations = {
right = true,
right = true,
Line 50: Line 71:
none = true
none = true
}
}
if s and validLocations[s] then
if validLocations[s] then
self.theLocation = s
self.theLocation = s
else
else
error(string.format(
error(string.format(
"bad argument #1 to 'image:location'"
"bad argument #1 to 'image:location' ('%s' is not a valid location)",
.. " (must be one of 'right', 'left', 'center' or 'none'; got '%s').",
s
tostring(s)
))
))
end
end
Line 62: Line 82:
function data:alignment(s)
function data:alignment(s)
checkSelf(self, 'alignment')
checkType('alignment', 1, s, 'string')
local validAlignments = {
local validAlignments = {
baseline = true,
baseline = true,
Line 72: Line 94:
bottom = true
bottom = true
}
}
if s and validAlignments[s] then
if validAlignments[s] then
self.theAlignment = s
self.theAlignment = s
else
else
error(string.format(
error(string.format(
"bad argument #1 to 'data:alignment'"
"bad argument #1 to 'image:alignment' ('%s' is not a valid alignment)"
))
))
end
end
Line 82: Line 104:
function data:border()
function data:border()
checkSelf(self, 'border')
self.hasBorder = true
self.hasBorder = true
end
end
function data:link(s)
function data:link(s)
checkSelf(self, 'link')
checkType('link', 1, s, 'string')
self.theLink = s
self.theLink = s
end
end
function data:alt(s)
function data:alt(s)
checkSelf(self, 'alt')
checkType('alt', 1, s, 'string')
self.theAlt = s
self.theAlt = s
end
end
function data:caption(s)
function data:caption(s)
checkSelf(self, 'caption')
checkType('caption', 1, s, 'string')
self.theCaption = s
self.theCaption = s
end
end
function data:render()
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
ret[#ret + 1] = self.theAlignment
-- Size
if self.isUpright and (self.theWidth or self.theHeight) then
error("duplicate size value detected in 'render' (height/width cannot be used at the same time as 'upright')")
elseif self.isUpright and self.uprightFactor then
ret[#ret + 1] = 'upright=' .. tostring(self.uprightFactor)
elseif self.isUpright then
ret[#ret + 1] = 'upright'
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
-- Caption
ret[#ret + 1] = self.theCaption
return string.format('[[%s]]', table.concat(ret, '|'))
end
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
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
return obj
end
end


return image
-- return image
 
local p = {}
 
function p.test()
local myImage = image.new()
myImage:name('Foo')
return myImage:render()
end
 
return p
Retrieved from "https://nonbinary.wiki/wiki/Special:MobileDiff/30328"
Cookies help us deliver our services. By using our services, you agree to our use of cookies.
More information