Module:he-utilities

local export = {}

local m_str_utils = require("Module:string utilities")

local codepoint = m_str_utils.codepoint
local gsub = m_str_utils.gsub
local u = m_str_utils.char

local export = {}

local sc = require("Module:scripts").getByCode("Hebr")

local lang = require("Module:languages").getByCode("he")
local m_utilities = require("Module:utilities")
local m_links = require("Module:links")
local m_headword = require("Module:headword")
local rsplit = mw.text.split

-- A wrapper function allowing the contents of this module to be called from
-- templates. For example, '{{#invoke:he-utilities|main|otSofit|כ}}' produces
-- 'ך', as does '{{#invoke:he-utilities|main|letters|kafSofit}}'.
function export.main(frame)
	if type(export]) == 'function' then
		return export](frame.args)
	else
		return export]]
	end
end

-- A mapping from strings containing letter-names, e.g. "alef", to strings
-- containing letters, e.g. "\215\144". (The latter is a UTF-8-encoded string
-- containing the single Unicode character U+05D0 HEBREW LETTER ALEF.)
export.letters = {}
for i, name in ipairs({ 'alef', 'bet', 'gimel', 'dalet', 'hei', 'vav', 'zayen',
	'khet', 'tet', 'yud', 'kafSofit', 'kaf', 'lamed',
	'memSofit', 'mem', 'nunSofit', 'nun', 'samekh', 'ayin',
	'peiSofit', 'pei', 'tsadiSofit', 'tsadi', 'kuf', 'resh',
	'shin', 'tav' }) do
	export.letters = u(0x05D0 + i - 1)
end
export.letters.sin = export.letters.shin

-- Same as previous, but for vowels instead of letters. (It also includes a few
-- marks and diacritics that aren't quite "vowels", but are in the same sequence
-- of Unicode characters.)
export.vowels = {}
for i, name in ipairs({ 'shva', 'khatafSegol', 'khatafPatakh', 'khatafKamats',
	'khirik', 'tseirei', 'segol', 'patakh', 'kamats',
	'kholam', 'ignoreMe', 'kubuts', 'dagesh', 'meteg',
	'makaf', 'rafe', 'pasek', 'shinDot', 'sinDot',
	'sofPasuk', 'upperDot' }) do
	export.vowels = u(0x05B0 + i - 1)
end
export.vowels.ignoreMe = nil
export.vowels.mapik = export.vowels.dagesh

-- If letter is kaf, mem, nun, pei, or tsadi, returns kaf sofit, mem sofit,
-- etc., respectively; otherwise, just returns letter.
function export.otSofit(letter)
	if letter == export.letters.kaf or letter == export.letters.mem
		or letter == export.letters.nun or letter == export.letters.pei
		or letter == export.letters.tsadi then
		return u(codepoint(letter) - 1)
	else
		return letter
	end
end

-- Same as previous, except that if letter is kaf or kaf sofit, also tacks on
-- a sh'va (since kaf sofit is written with a sh'va when it has no other vowel).
function export.otSofitShva(letter)
	letter = export.otSofit(letter)
	if letter == export.letters.kafSofit then
		return letter .. export.vowels.shva
	else
		return letter
	end
end

-- If letter is kaf sofit, mem sofit, etc., returns kaf, mem, etc.; otherwise,
-- just returns letter.
function export.otLoSofit(letter)
	if letter == export.letters.kafSofit or letter == export.letters.memSofit
		or letter == export.letters.nunSofit or letter == export.letters.peiSofit
		or letter == export.letters.tsadiSofit then
		return u(codepoint(letter) + 1)
	else
		return letter
	end
end

-- If letter is bet, gimel, dalet, kaf, pei, or tav, returns letter plus a
-- dagesh; otherwise, just returns letter.
function export.dageshKal(letter)
	if letter == export.letters.bet or letter == export.letters.gimel
		or letter == export.letters.dalet or letter == export.letters.kaf
		or letter == export.letters.pei or letter == export.letters.tav then
		return letter .. export.vowels.dagesh
	else
		return letter
	end
end

-- If letter is shin plus a shin or sin dot, returns shin (without the dot);
-- otherwise, just returns letter.
function export.dotlessShin(letter)
	if letter == export.letters.shin .. export.letters.shinDot
		or letter == export.letters.sin .. export.letters.sinDot then
		return export.letters.shin
	else
		return letter
	end
end

local letters               = ""
local modifiers             = "?"
local separators            = "?"
local regex                 = "(" .. letters .. modifiers .. ")" .. separators

local medial_radicals       = {
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = false,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
}
local initial_radicals      = medial_radicals
local final_radicals        = {
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = false,
	 = true,
	 = true,
	 = true,
	 = false,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
	 = true,
}

local radical_romanizations = {
	 = "ʾ",
	 = "b",
	 = "g",
	 = "d",
	 = "h",
	 = "w",
	 = "z",
	 = "kh",
	 = "ṭ",
	 = "y",
	"] = "k",
	 = "l",
	"] = "m",
	"] = "n",
	 = "s",
	 = "ʿ",
	"] = "p",
	"] = "ts",
	 = "q",
	 = "r",
	 = "sh",
	 = "s",
	 = "t",
}

local function transliterate_root(root_string)
	local romanized_root = root_string:gsub("־", "-")
	for k, v in pairs(radical_romanizations) do
		romanized_root = gsub(romanized_root, k, v)
	end
	return romanized_root
end

function export.plain_root(frame)
	local radicals = {}
	local len = 0
	local subber = function(radical)
		table.insert(radicals, radical)
		len = len + 1
		return ""
	end
	local scraps = gsub(frame.args, regex, subber)
	if scraps ~= "" then
		error("Unrecognized characters in root.")
	end
	if len < 2 then
		error("Root must have at least two radicals separated by ־.")
	end
	for i, radical in ipairs(radicals) do
		if i == 1 then -- initial
			if not initial_radicals then
				error("Unrecognized initial radical " .. radical .. ".")
			end
		elseif i == len then -- final
			if not final_radicals then
				error("Unrecognized final radical " .. radical .. ".")
			end
		else -- medial
			if not medial_radicals then
				error("Unrecognized medial radical " .. radical .. ".")
			end
		end
	end
	return table.concat(radicals, "־")
end

function export.romanized_root(frame)
	local root = export.plain_root(frame)
	return transliterate_root(root)
end

local function link(term, alt, tr, id)
	if term == "" or term == "&mdash;" then
		return term
	else
		return m_links.full_link({
			term = term,
			alt = alt,
			tr = tr,
			lang = lang,
			id = id,
		})
	end
end

local function validateRoot(rootTable, joined_root)
	if type(rootTable) ~= "table" then
		error("rootTable is not a table", 2)
	end

	local len = #rootTable

	if len < 2 then
		error("Root must have at least two radicals separated by ־.")
	end

	for i, radical in ipairs(rootTable) do
		if i == 1 then -- initial
			if not initial_radicals then
				error("Unrecognized initial radical " .. radical .. " in " .. joined_root)
			end
		elseif i == #rootTable then -- final
			if not final_radicals then
				error("Unrecognized final radical " .. radical .. " in " .. joined_root)
			end
		else -- medial
			if not medial_radicals then
				error("Unrecognized medial radical " .. radical .. " in " .. joined_root)
			end
		end
	end
end

function export.root(frame)
	local output = {}
	local categories = {}
	local title = mw.title.getCurrentTitle()
	local namespace = title.nsText
	local fulltitle = title.fullText

	local params = {
		 = { list = true },
		 = {},
		 = { type = "boolean" },
		 = { type = "boolean" },
		 = { type = "boolean" },
		 = {}
	}

	local args = require("Module:parameters").process(frame:getParent().args, params)
	local rootLetters = {}
	local roots = args

	local plain = args
	if frame.args then
		plain = true
	end
	
	local head = frame.args

	local langCode = lang:getCode()

	local separator = "־"

	local roots_len = #roots

	if #roots == 0 and namespace == "Template" then
		table.insert(rootLetters, rsplit("כ־ת־ב", separator))
	elseif #roots ~= 0 then
		for _, root in ipairs(roots) do
			table.insert(rootLetters, rsplit(root, separator))
		end
	else
		if args ~= nil and fulltitle ~= lang:makeEntryName(args) then
			error("Root is different from the pagename.")
		end
			
		if head and args ~= nil then
			fulltitle = args
		end
		table.insert(rootLetters, rsplit(fulltitle, separator))
	end

	local joined_roots = {}
	for i, rootLetter in ipairs(rootLetters) do
		table.insert(joined_roots, table.concat(rootLetter, separator))
		validateRoot(rootLetter, joined_roots)
	end

	local sense = args
	local sense_formatted = ""
	if sense ~= nil then
		sense_formatted = " (" .. sense .. ") "
	end

	if fulltitle == joined_roots then
		if roots_len > 1 then
			error("There should be only one root.")
		end

		table.insert(output,
			m_headword.full_headword({ lang = lang, pos_category = "roots", categories = {}, heads = { fulltitle }, translits = {transliterate_root(fulltitle) }, nomultiwordcat = true }))

		if args then
			return table.concat(output)
		else
			return table.concat(output) .. table.concat(categories)
		end
	else
		local link_texts = {}
		local term_counts = {}

		for i, joined_root in ipairs(joined_roots) do
			local link_text = joined_root
			table.insert(link_texts, link(link_text, joined_root .. sense_formatted, transliterate_root(joined_root), sense))
			table.insert(
				categories,
				m_utilities.format_categories(
					{ lang:getCanonicalName() .. " terms belonging to the root " .. joined_root .. sense_formatted },
					lang)
			)
			table.insert(term_counts,
				mw.site.stats.pagesInCategory(
					lang:getCanonicalName() .. " terms belonging to the root " .. joined_root .. sense_formatted, "pages")
			)
		end

		if args or plain then
			if args then 
				return table.concat(link_texts, ", ")
			else
				return table.concat(link_texts, ", ") .. table.concat(categories)
			end
		else
			local link_text_output = ""
			for i, link_text in ipairs(link_texts) do
				link_text_output = link_text_output ..
					"\n|-\n| " .. link_text ..
					"\n|-\n| [[:Category:" ..
					lang:getCanonicalName() ..
					" terms belonging to the root " ..
					joined_roots ..
					sense_formatted .. "|" .. term_counts .. " term" .. (term_counts == 1 and "" or "s") .. "]]\n"
			end

			local wikicode = mw.getCurrentFrame():expandTemplate {
				title = 'inflection-table-top',
				args = {
					title = "-",
					palette = "grey",
					class = "floatright tr-alongside"
				}
			}

			wikicode = wikicode .. [=[
! =] .. (#term_counts == 1 and "" or "s") .. ]]=]

			wikicode = wikicode .. link_text_output

			wikicode = wikicode .. mw.getCurrentFrame():expandTemplate {
				title = 'inflection-table-bottom',
			}
			return wikicode .. table.concat(categories)
		end
	end
end

return export