More actions
Content deleted Content added
add type checks and write the render function; read-only code not working yet |
fix read-only behaviour and remove the test function |
||
Line 14: | Line 14: | ||
checkSelf(self, 'name') |
checkSelf(self, 'name') |
||
checkType('name', 1, s, 'string') |
checkType('name', 1, s, 'string') |
||
data.theName = s |
|||
end |
end |
||
Line 29: | Line 29: | ||
} |
} |
||
if validFormats[s] then |
if validFormats[s] then |
||
data.theFormat = s |
|||
data.theFormatFilename = filename |
|||
else |
else |
||
error('invalid format') |
error('invalid format') |
||
Line 39: | Line 39: | ||
checkSelf(self, 'width') |
checkSelf(self, 'width') |
||
checkType('width', 1, px, 'number') |
checkType('width', 1, px, 'number') |
||
data.theWidth = px |
|||
end |
end |
||
Line 45: | Line 45: | ||
checkSelf(self, 'height') |
checkSelf(self, 'height') |
||
checkType('height', 1, px, 'number') |
checkType('height', 1, px, 'number') |
||
data.theHeight = px |
|||
end |
end |
||
Line 51: | Line 51: | ||
checkSelf(self, 'upright') |
checkSelf(self, 'upright') |
||
checkType('upright', 1, factor, 'number', true) |
checkType('upright', 1, factor, 'number', true) |
||
data.isUpright = true |
|||
data.uprightFactor = factor |
|||
end |
end |
||
Line 58: | Line 58: | ||
checkSelf(self, 'resetSize') |
checkSelf(self, 'resetSize') |
||
for i, field in ipairs{'theWidth', 'theHeight', 'isUpright', 'uprightFactor'} do |
for i, field in ipairs{'theWidth', 'theHeight', 'isUpright', 'uprightFactor'} do |
||
data[field] = nil |
|||
end |
end |
||
end |
end |
||
Line 72: | Line 72: | ||
} |
} |
||
if validLocations[s] then |
if validLocations[s] then |
||
data.theLocation = s |
|||
else |
else |
||
error(string.format( |
error(string.format( |
||
"bad argument #1 to ' |
"bad argument #1 to 'location' ('%s' is not a valid location)", |
||
s |
s |
||
)) |
)) |
||
Line 95: | Line 95: | ||
} |
} |
||
if validAlignments[s] then |
if validAlignments[s] then |
||
data.theAlignment = s |
|||
else |
else |
||
error(string.format( |
error(string.format( |
||
"bad argument #1 to ' |
"bad argument #1 to 'alignment' ('%s' is not a valid alignment)" |
||
)) |
)) |
||
end |
end |
||
Line 105: | Line 105: | ||
function data:border() |
function data:border() |
||
checkSelf(self, 'border') |
checkSelf(self, 'border') |
||
data.hasBorder = true |
|||
end |
end |
||
Line 111: | Line 111: | ||
checkSelf(self, 'link') |
checkSelf(self, 'link') |
||
checkType('link', 1, s, 'string') |
checkType('link', 1, s, 'string') |
||
data.theLink = s |
|||
end |
end |
||
Line 117: | Line 117: | ||
checkSelf(self, 'alt') |
checkSelf(self, 'alt') |
||
checkType('alt', 1, s, 'string') |
checkType('alt', 1, s, 'string') |
||
data.theAlt = s |
|||
end |
end |
||
Line 123: | Line 123: | ||
checkSelf(self, 'caption') |
checkSelf(self, 'caption') |
||
checkType('caption', 1, s, 'string') |
checkType('caption', 1, s, 'string') |
||
data.theCaption = s |
|||
end |
end |
||
function data:render() |
function data:render() |
||
checkSelf(self, 'render') |
checkSelf(self, 'render') |
||
local ret = {} |
local ret = {} |
||
-- Image name. |
-- Image name. |
||
if not |
if not data.theName then |
||
error('image:render: no image name was found') |
error('image:render: no image name was found') |
||
end |
end |
||
ret[#ret + 1] = 'File:' .. |
ret[#ret + 1] = 'File:' .. data.theName |
||
-- Image format |
-- Image format |
||
if |
if data.theFormat and data.theFormatFilename then |
||
ret[#ret + 1] = |
ret[#ret + 1] = data.theFormat .. '=' .. data.theFormatFilename |
||
elseif |
elseif data.theFormat then |
||
ret[#ret + 1] = |
ret[#ret + 1] = data.theFormat |
||
end |
end |
||
-- Border |
-- Border |
||
if |
if data.hasBorder then |
||
ret[#ret + 1] = 'border' |
ret[#ret + 1] = 'border' |
||
end |
end |
||
-- Location |
-- Location |
||
ret[#ret + 1] = |
ret[#ret + 1] = data.theLocation |
||
-- Alignment |
-- Alignment |
||
ret[#ret + 1] = |
ret[#ret + 1] = data.theAlignment |
||
-- Size |
-- Size |
||
if |
if data.isUpright and (data.theWidth or data.theHeight) then |
||
error("duplicate size value detected in 'render' (height/width cannot be used at the same time as 'upright')") |
error("duplicate size value detected in 'render' (height/width cannot be used at the same time as 'upright')") |
||
elseif |
elseif data.isUpright and data.uprightFactor then |
||
ret[#ret + 1] = 'upright=' .. tostring( |
ret[#ret + 1] = 'upright=' .. tostring(data.uprightFactor) |
||
elseif |
elseif data.isUpright then |
||
ret[#ret + 1] = 'upright' |
ret[#ret + 1] = 'upright' |
||
elseif |
elseif data.theWidth and data.theHeight then |
||
ret[#ret + 1] = string.format('%dx%dpx', |
ret[#ret + 1] = string.format('%dx%dpx', data.theWidth, data.theHeight) |
||
elseif |
elseif data.theWidth then |
||
ret[#ret + 1] = tostring( |
ret[#ret + 1] = tostring(data.theWidth) .. 'px' |
||
elseif |
elseif data.theHeight then |
||
ret[#ret + 1] = string.format('x%dpx', |
ret[#ret + 1] = string.format('x%dpx', data.theHeight) |
||
end |
end |
||
-- Link |
-- Link |
||
if |
if data.theLink then |
||
ret[#ret + 1] = 'link=' .. |
ret[#ret + 1] = 'link=' .. data.theLink |
||
end |
end |
||
-- Alt |
-- Alt |
||
if |
if data.theAlt then |
||
ret[#ret + 1] = 'alt=' .. |
ret[#ret + 1] = 'alt=' .. data.theAlt |
||
end |
end |
||
-- Caption |
-- Caption |
||
ret[#ret + 1] = |
ret[#ret + 1] = data.theCaption |
||
return string.format('[[%s]]', table.concat(ret, '|')) |
return string.format('[[%s]]', table.concat(ret, '|')) |
||
Line 225: | Line 224: | ||
end |
end |
||
return image |
|||
local p = {} |
|||
function p.test() |
|||
local myImage = image.new() |
|||
myImage:name('Foo') |
|||
return myImage:render() |
|||
end |
|||
return p |
Revision as of 03:01, 30 May 2014
Documentation for this module may be created at Module:File link/doc
-- This module provides a library for formatting image wikilinks.
local libraryUtil = require('libraryUtil')
local image = {}
function image.new()
local obj, data = {}, {}
local checkSelf = libraryUtil.makeCheckSelfFunction('image', 'image', obj, 'image object')
local checkType = libraryUtil.checkType
function data:name(s)
checkSelf(self, 'name')
checkType('name', 1, s, 'string')
data.theName = s
end
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
function data:width(px)
checkSelf(self, 'width')
checkType('width', 1, px, 'number')
data.theWidth = px
end
function data:height(px)
checkSelf(self, 'height')
checkType('height', 1, px, 'number')
data.theHeight = px
end
function data:upright(factor)
checkSelf(self, 'upright')
checkType('upright', 1, factor, 'number', true)
data.isUpright = true
data.uprightFactor = factor
end
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
error(string.format(
"bad argument #1 to 'location' ('%s' is not a valid location)",
s
))
end
end
function data:alignment(s)
checkSelf(self, 'alignment')
checkType('alignment', 1, s, 'string')
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)"
))
end
end
function data:border()
checkSelf(self, 'border')
data.hasBorder = true
end
function data:link(s)
checkSelf(self, 'link')
checkType('link', 1, s, 'string')
data.theLink = s
end
function data:alt(s)
checkSelf(self, 'alt')
checkType('alt', 1, s, 'string')
data.theAlt = s
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
ret[#ret + 1] = data.theAlignment
-- Size
if data.isUpright and (data.theWidth or data.theHeight) then
error("duplicate size value detected in 'render' (height/width cannot be used at the same time as 'upright')")
elseif data.isUpright and data.uprightFactor then
ret[#ret + 1] = 'upright=' .. tostring(data.uprightFactor)
elseif data.isUpright then
ret[#ret + 1] = 'upright'
elseif data.theWidth and data.theHeight then
ret[#ret + 1] = string.format('%dx%dpx', data.theWidth, data.theHeight)
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
-- 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
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