Module:MOS scalesig

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

Note: Do not invoke this module directly; use the corresponding template instead: Template:MOS scalesig.

This module depends on the following other modules: Module: Arguments Module: MOS Module: Utils Module: Yesno

This module formats a string into a mos scale signature, with non-breaking spaces. Scale signatures can optionally be formatted as a link to the scale's wiki page.

To include this module in other modules, use local mos_scalesig = require("Module:MOS scalesig")._mos_scalesig.

---

local mos = require("Module:MOS")
local yesno = require("Module:Yesno")
local getArgs = require("Module:Arguments").getArgs
local p = {}

-- Preprocess unparsed scalesig; if it's raw text, then it's a scalesig to be
-- parsed into a mos; if it's a mos as defined by the mos module, return it.
function p.preprocess_unparsed_scalesig(unparsed)
	if unparsed.nL ~= nil and unparsed.ns ~= nil and unparsed.equave ~= nil then
		return unparsed
	else
		return mos.parse(unparsed)
	end
end

-- Function to format a string into a mos scalesig, with nonbreaking spaces.
-- Options are:
-- - is_long - Whether to use "xL ys<p/q>" or "xL ys (p/q-equivalent)". Only
--   applies for nonoctave mosses, as a scalesig without an equave is assumed to
--   be 2/1-equivalent.
-- - is_link - Whether the scalesig is a link to its wiki page.
-- NOTE: args are passed in individually rather than as a table as expected use
-- includes formatting scalesig text/links for other mos-related modules.
function p._mos_scalesig(unparsed, is_link, is_long)
	local input_mos = p.preprocess_unparsed_scalesig(unparsed)
	local is_link = yesno(is_link, false)
	local is_long = yesno(is_long, false)
	
	-- Link is the article name, if to be used
	-- Text is the parsed scalesig
	local link = mos.as_long_string(input_mos)
	local text = is_long and mos.as_long_string(input_mos) or mos.as_string(input_mos)
	if is_link then
		if link == text then
			return string.format("[[%s]]", link)
		else
			return string.format("[[%s | %s]]", link, text)
		end
	else
		return text
	end
end

-- Wrapper function for use with a template
function p.mos_scalesig(frame)
	local args = getArgs(frame)
	
	local unparsed = args["scalesig"]
	local is_link = yesno(args["link"], false)
	local is_long = yesno(args["long"], false)
	
	return p._mos_scalesig(unparsed, is_link, is_long)
end

function p.tester()
	local input_mos = mos.new(5,2)
	return p._mos_scalesig(input_mos, true, true)
end

return p