Module:Track listing

Module documentation[view] [edit] [history] [purge]

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

The above documentation is transcluded from Module:Track listing/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Subpages of this module.

-- This module implements [[Template:Track listing]]

local yesno = require('Module:Yesno')

--------------------------------------------------------------------------------
-- Track class
--------------------------------------------------------------------------------

local Track = {}
Track.__index = Track

Track.fields = {
	number = true,
	title = true,
	note = true,
	length = true,
	lyrics = true,
	music = true,
	writer = true,
	extra = true,
}

function Track.new(data)
	local self = setmetatable({}, Track)
	for field in pairs(Track.fields) do
		self[field] = data[field]
	end
	self.number = assert(tonumber(self.number))
	return self
end

function Track:getLyricsCredit()
	return this.lyrics
end

function Track:getMusicCredit()
	return this.music
end

function Track:getExtraField()
	return this.extra
end

function Track:getWriterCredit()
	return this.writer
end

function Track:exportHtml()
	local row = mw.html.create('tr')
	row:css('background-color', data.color)

	-- Track number
	row:tag('td')
		:css('padding-right', '10px')
		:css('text-align', 'right')
		:css('vertical-align', 'top')
		:wikitext(self.number .. '.')

	-- Title
	do 
		local title_cell = row:tag('td')
		title_cell
			:css('text-align', 'left')
			:css('vertical-align', 'top')
			:wikitext(self.title and string.format('"%s"', self.title) or 'Untitled')
			:wikitext(' ')
		if self.note then
			title_cell:tag('span')
				:css('font-size', '85%')
				:wikitext(string.format('(%s)', self.note))
		else
			title_cell:wikitext(' ')
		end
	end

	if self.writing_credits then
		local wc_cell = row:tag('td')
		wc_cell
			:css('vertical-align', 'top')
			:wikitext()
	end

	return row
end

--------------------------------------------------------------------------------
-- TrackListing class
--------------------------------------------------------------------------------

local TrackListing = {}
TrackListing.__index = TrackListing

function TrackListing.new(data)
	local self = setmetatable({}, TrackListing)
	return self
end

--------------------------------------------------------------------------------
-- Exports
--------------------------------------------------------------------------------

local p = {}

function p._main(args)
	-- Process numerical args so that we can iterate through them.
	local data, tracks = {}, {}
	for k, v in pairs(args) do
		if type(k) == 'string' then
			local prefix, num = k:match('^(%D.-)(%d+)$')
			if prefix and Track.fields[prefix] and (num == '0' or num:sub(1, 1) ~= '0') then
				-- Allow numbers like 0, 1, 2 ..., but not 00, 01, 02...,
				-- 000, 001, 002... etc.
				num = tonumber(num)
				tracks[num] = tracks[num] or {}
				tracks[num][prefix] = v
			else
				data[k] = v
			end
		end
	end
	data.tracks = (function (t)
		-- Compress sparse array
		local ret = {}
		for num, trackData in pairs(t) do
			trackData.number = num
			table.insert(ret, trackData) 
		end
		table.sort(ret, function (t1, t2)
			return t1.number < t2.number
		end)
		return ret
	end)(tracks)

	return tostring(TrackListing.new(data))
end

function p.main(frame)
	local args = require('Module:Arguments').getArgs(frame, {
		wrappers = 'Template:Track listing'
	})
	return p._main(args)
end

return p