Module:Lyrics

Documentation for this module may be created at Module:Lyrics/doc

local getArgs   = require('Module:Arguments').getArgs
local stringToArray = require('Module:ProcessingFunctions').stringToArray
local VariablesLua = mw.ext.VariablesLua

local data = mw.loadData('Module:Lyrics/data')

local p = {}

local tableIdKey = 'lyrics_table_id'
local columnVariableKey = 'lyrics_columns'


function p.head(frame)
	local args = getArgs(frame)
	
	local previousId = tonumber(VariablesLua.var(tableIdKey)) or 0
	
	local id = args['id'] or tostring(previousId + 1)
	local columnsStr = args['columns'] or ''
	
	local splitColumns = stringToArray(',')(columnsStr)
	local definedColumns = {}
	local columns = {}
	local languages = {}
	
	for _,column in ipairs(splitColumns) do
		local columnTrimmed = mw.text.trim(column)
		
		if columnTrimmed ~= '' then
			if definedColumns[columnTrimmed] then
				error(string.format(
					'Column "%s" already defined',
					columnTrimmed
				))
			end
			
			table.insert(columns, columnTrimmed)
			
			local formattedCol = columnTrimmed:gsub(' ', '-')
			table.insert(languages, formattedCol)
			
			definedColumns[columnTrimmed] = true
		end
	end
	
	local labels = {}
	for _,column in ipairs(columns) do
		local label = args[column]
		
		if label and label ~= '' then
			local formattedCol = column:gsub(' ', '-')
			labels[formattedCol] = label
		else
			error(string.format(
				'Column "%s" needs a header',
				column
			))
		end
	end
	
	local lyricsOptions = mw.html.create('div')
		:addClass('lyrics-options')
		:attr('data-id', id)
		:attr('data-languages', table.concat(languages, ','))
		:attr('data-labels', mw.text.jsonEncode(labels))
	
	local row = mw.html.create('tr')
		:addClass('lyrics-row')
        :addClass('lyrics-header-row')
	for _,column in ipairs(columns) do
		local formattedCol = column:gsub(' ', '-')
		
		row:tag('th')
			:addClass('lyrics-' .. formattedCol)
			:attr('width', math.floor(100 / #columns) .. '%')
			:css('min-width', '150px')
			:wikitext(args[column])
	end
	
	if tonumber(id) ~= nil then
		VariablesLua.vardefine(tableIdKey, id)
	end
	VariablesLua.vardefine(columnVariableKey, table.concat(columns, ','))
	return '<div>' ..
		tostring(lyricsOptions) ..
		string.format('<table class="wikitable" id="lyrics-%s">', id) ..
		tostring(row)
end

function p.line(frame)
	local function formatArg(arg)
		if arg and arg ~= '' then
			return table.concat(stringToArray('\n')(arg), '<br>')
		else
			return '<br>'
		end
	end

	local args = getArgs(frame)
	
	local root = mw.html.create('tr'):addClass('lyrics-row')
	
	local columnOrder = VariablesLua.var(columnVariableKey, '')
	local columns = stringToArray(',')(columnOrder)
	
	for _,column in ipairs(columns) do
		local formattedCol = column:gsub(' ', '-')
		
		root:tag('td')
			:addClass('lyrics-' .. formattedCol)
			:wikitext(formatArg(args[column]))
			:css('background-color', 'oklch(14% 0.9733 0 0)')
			:css('color', 'oklch(80% 0 0 0)')
	end
	
	return tostring(root)
end

function p.color(frame)
	local args = getArgs(frame)
	
	local singers = args[1] or ''
	local lyrics = args[2] or ''
	
	local splitSingers = stringToArray(',')(singers)
	local expandedSingers = {}
	
	for _,singer in ipairs(splitSingers) do
		local key = mw.text.trim(singer):lower()
		local mappedValue = data.singerMap[key] or {}
		
		for _,value in ipairs(mappedValue) do
			table.insert(expandedSingers, value)
		end
	end
	
	local singerData = {}
	
	singerData['v-1'] = expandedSingers
	
	local text = mw.html.create('span')
		:wikitext(lyrics)
		:attr('data-singers', mw.text.jsonEncode(singerData))
	
	return tostring(text)
end

function p.tail(frame)
	local args = getArgs(frame)
	
	if args[1] then
		local columnOrder = VariablesLua.var(columnVariableKey, '')
		local columns = stringToArray(',')(columnOrder)
		
		local row = mw.html.create('tr')
			:tag('th')
			:attr('colspan', #columns)
			:wikitext(args[1])
	
		return tostring(row) .. '</table>' .. '</div>'
	end
	
	return '</table></div>'
end

return p