Module:Toolbar

This module implements {{toolbar}}. Please see the template page for documentation.

See also

• {{toolbar}}, {{toolbar/sandbox}}, /testcases

---

local p = {}
local args = {}

-- Create concatenator object.
local Concatenator = {result = ''}

function Concatenator:new()
    local o = {}
    setmetatable(o, self)
    self.__index = self
    return o
end

function Concatenator:add(s)
    if type(s) ~= 'string' then
        error('Attempt to concatenate non-string value', 2)
    end
    self.result = self.result .. s
end

-- Get the keys of the numerical arguments that are present.
local function getArgNums()
    local nums = {}
    for k, v in pairs(args) do
        local num = tostring(k):match('^([1-9]%d*)$')
        if num then table.insert(nums, tonumber(num)) end
    end
    table.sort(nums)
    return nums
end

local function makeToolbarItems()
    -- Get numerical argument keys.
    local nums = getArgNums()
    -- Get the separator text.
    local sep = (args.separator or 'pipe') .. '-separator'
    sep = mw.message.new(sep):plain()
    
    -- Generate the toolbar items.
    local ti = Concatenator:new()
    for i, v in ipairs(nums) do
        ti:add(args[v])
        if nums[i + 1] then
            ti:add(sep)
        end
    end
    return ti.result
end

local function makeToolbar()
    local class = args.class or ''
    local style = (args.style and ('style="' .. args.style .. '"')) or ''
    local t = Concatenator:new()
    
    -- Generate opening span tag.
    t:add('<span class="plainlinks ')
    t:add(class)
    t:add('" ')
    t:add(style)
    t:add('>')
    
    -- Generate toolbar items.
    t:add('(')
    t:add(makeToolbarItems())
    t:add(')')
    
    -- Generate closing span tag.
    t:add('</span>')
    
    return t.result 
end

function p.main(frame)
    -- If called via #invoke, use the args passed into the invoking template.
    -- Otherwise, for testing purposes, assume args are being passed directly in.
    local origArgs
    if frame == mw.getCurrentFrame() then
        origArgs = frame:getParent().args
    else
        origArgs = frame
    end
    
    -- Strip whitespace and remove nil values
    for k, v in pairs(origArgs) do
        v = mw.text.trim(v)
        if v ~= '' then
            args[k] = v
        end
    end
    
    return makeToolbar()
end
 
return p