Editing Module:File link
From MINR.ORG WIKI
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
− | -- This module provides a library for formatting | + | -- This module provides a library for formatting image wikilinks. |
− | local | + | local libraryUtil = require('libraryUtil') |
− | |||
− | local | + | local image = {} |
− | function | + | 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 | ||
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 | ||
− | |||
− | |||
end | end | ||
− | + | ||
− | + | function data:location(s) | |
− | + | checkSelf(self, 'location') | |
− | + | checkType('location', 1, s, 'string') | |
− | local | + | 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 | ||
− | |||
− | |||
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 | else | ||
− | + | error(string.format( | |
+ | "bad argument #1 to 'alignment' ('%s' is not a valid alignment)" | ||
+ | )) | ||
end | end | ||
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 | end | ||
− | + | ||
− | + | function data:caption(s) | |
− | + | checkSelf(self, 'caption') | |
− | + | checkType('caption', 1, s, 'string') | |
− | + | data.theCaption = s | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
end | 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 | 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 | end | ||
− | return | + | |
+ | 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 | end | ||
− | return | + | return image |