Jump to content

Module:Wikt-lang/sandbox

From Wikipedia, the free encyclopedia
This is an old revision of this page, as edited by Gonnym (talk | contribs) at 11:24, 3 December 2024. The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.
require('strict')
local m_data = mw.loadData("Module:Wikt-lang/data/sandbox")
local langData = m_data.languages or m_data

local p = {}

local error_msgs = {
	internal = {
		["language_code_missing"] = "Name for the language code %q could not be retrieved. Add it to [[Module:Wikt-lang/data]].",
		["make_entry_name"] = "The function make_entry_name requires a link string.",
		["make_Wiktionary_link"] = "The function make_Wiktionary_link needs a Wiktionary link, display text and language code.",
	},
	["no_text"] = "A Wiktionary entry is required.",
}

local cfg = {
	template = "Wikt-lang",
	error_msg = '<span style="color: #d33;">Error: {{%s}}: %s</span>[[Category:%s]]',
	category = "Wikt-lang template errors",
	appendix = "Appendix:%s/%s",
	reconstruction = "Reconstruction:%s/%s",
	types = {
		appendix = "appendix",
		reconstructed = "reconstructed",
	},
}


--[[--------------------------< M A K E _ E R R O R >--------------------------------------------------

]]

local function make_error(msg)
	return string.format(cfg.error_msg, cfg.template, msg, cfg.category)
end


--[[--------------------------< M A K E _ E N T R Y _ N A M E >--------------------------------------------------

]]

local function make_entry_name(link_text, language_code)
	link_text = tostring(link_text)
	if link_text == nil or link_text == "" then
		return nil, make_error(error_msgs.internal.make_entry_name)
	end

	-- Remove bold and italics, so that words that contain bolding or emphasis can be linked without piping.
	link_text = link_text:gsub("\'\'\'", "")
	link_text = link_text:gsub("\'\'", "")

	local data = langData[language_code]
	if data == nil then
		-- No language specific data in module; use text as is.
		return link_text
	end

	local replacements = data and data["replacements"]
	if replacements == nil then
		-- No replacements needed; use text as is.
		return link_text
	end

	-- Decompose so that the diacritics of characters such
	-- as á can be removed in one go.
	-- No need to compose at the end, because the MediaWiki software
	-- will handle that.
	if replacements.decompose then
		link_text = mw.ustring.toNFD(link_text)
		for i, from in ipairs(replacements.from) do
			link_text = mw.ustring.gsub(
				link_text,
				from,
				replacements.to and replacements.to[i] or "")
		end
	else
		for regex, replacement in pairs(replacements) do
			link_text = mw.ustring.gsub(link_text, regex, replacement)
		end
	end
	return link_text
end

--TODO: doc
local function get_prefix(language_name, link_text, data)
	if link_text:sub(1, 1) == "*" then
		return string.format(cfg.reconstruction, language_name, link_text:sub(2))
	end
	if data and data.type then
		if data.type == cfg.types.reconstructed then
			-- TODO: if this is an error, replace with category
			--return nil, make_error("Reconstructed language without asterisk")
	
			local frame = mw.getCurrentFrame()
			mw.log("Reconstructed language without asterisk:", language_name, link_text)
			pcall(frame.expandTemplate, frame, {title = 'tracking/wikt-lang/reconstructed with no asterisk'})
			return string.format(cfg.reconstruction, language_name, link_text)
		elseif data_type == cfg.types.appendix then
			return string.format(cfg.appendix, language_name, link_text)
		end
	end
	
	-- If for any reason this reaches here, return the unaltered link_text.
	return link_text
end

--TODO: doc. If the code reaches this point and data.name does not have a name, this is an internal error.
local function get_language_name(language_code, language_name)
	local data = langData[language_code]
	if data and data.name then
		return data.name
	end
	return language_name
end
		
--[[--------------------------< M A K E _ W I K T I O N A R Y _ L I N K >--------------------------------------------------
	
	A link_text and display_text are always needed. Error if they are missing.
	A language name can sometimes be nil if the private code is only listed at Module:Wikt-lang/data and not on Module:Lang/data.
	A languge code should never be nil, but only needed if language_name is nil.
]]

local function make_Wiktionary_link(link_text, display_text, language_code, language_name)
	if not link_text and not display_text and not language_code then
		return nil, make_error(error_msgs.internal.make_Wiktionary_link)
	end

	language_name = get_language_name(language_code, language_name)
	if not language_name then
		return make_error(error_msgs.language_code_missing)
	end

	if link_text:sub(1, 1) == "*" or (data and data.type) then
		link_text = get_prefix(language_name, link_text, data)
	end
	return "[[wikt:" .. link_text .. "#" .. language_name .. "|" .. display_text .. "]]"
end


--[[--------------------------< W I K T L A N G >--------------------------------------------------------------------

Entry point for {{Wikt-lang}}.

Parameters are received from the template's frame (parent frame).

* 1 – language code
* 2 – link text
* 3 – display text
* italic – "no" to disable

]]

function p.wiktlang(frame)
	local getArgs = require('Module:Arguments').getArgs
	local args = getArgs(frame)

	-- Handle the display text.
	local lang = require("Module:Lang/sandbox2")

	if not args[2] then
		-- A Wiktionary entry is required.
		return make_error(error_msgs.no_text)
	end

	-- The display text should be the text wrapped in the language tag.
	args[2] = args[3] or args[2]

	-- To allow the errors to be associated with this template.
	args.template = cfg.template
	args.error_category = cfg.category

	local result = lang._lang(args)

	-- An error returned, stop here.
	if type(result) == "string" and string.find(result, "Error") then
		return result
	end

	--TODO: we need the result to return without a <span title=""> tag which probably should be removed.

	local entry, error_msg = make_entry_name(args[2], result.code)
	if error_msg then
		return error_msg
	end

	local link
	if result.code then
		link, error_msg = make_Wiktionary_link(entry, result.html, result.code, result.name)
	else
		link, error_msg = make_Wiktionary_link(entry, result.html)
	end

	if error_msg then
		return error_msg
	end

	return link .. result.language_categories .. result.maintenance  
end

return p