Module:hil-pron

-- Based on ] by TagaSanPedroAko, in turn based on ] by Benwing2. 
-- Adaptation by TagaSanPedroAko.

local export = {}

local pron_utilities_module = "Module:pron utilities"

local lang = require("Module:languages").getByCode("hil")

local u = mw.ustring.char
local rfind = mw.ustring.find
local rsubn = mw.ustring.gsub
local rsplit = mw.text.split
local ulower = mw.ustring.lower

local AC = u(0x0301) -- acute =  ́
local GR = u(0x0300) -- grave =  ̀
local CFLEX = u(0x0302) -- circumflex =  ̂
local TILDE = u(0x0303) -- tilde =  ̃
local DIA = u(0x0308) -- diaeresis =  ̈
local MACRON = u(0x0304) -- macron 

local vowel = "aeəiouàèìòù" -- vowel
local V = ""
local accent = AC .. GR .. CFLEX .. MACRON 
local accent_c = ""
local stress_c = ""
local ipa_stress = "ˈˌ"
local ipa_stress_c = ""
local separator = accent .. ipa_stress .. "# ."
local separator_c = ""
local C = "" -- consonant

local unstressed_words = require("Module:table").listToSet({
	"ang", "sa", "sang", "si", "sing", "ni", "kay", -- case markers. 
	"ko", "ta", "mi", "mo", "ka", --single-syllable personal pronouns
	"nga", -- also temporal particle
    "daw", "ga", "gid", "ha", "pa", -- particles
	"pag", "kon", -- subordinating conjunctions
	"kag", "o", -- coordinating conjunctions
	"hay", -- interjections
	"de", "del", "el", "la", "las", "los", "sur", -- in some Spanish-derived terms and names
	"-an", "-han", "gin-", "hi-", "-hin", "hin-", "hing-", "-hon", "-in-", "mag-", "mang-", "-on", "pa-", "pag-", "pang-"-- affixes
})

-- version of rsubn() that discards all but the first return value
local function rsub(term, foo, bar)
	local retval = rsubn(term, foo, bar)
	return retval
end

-- version of rsubn() that returns a 2nd argument boolean indicating whether
-- a substitution was made.
local function rsubb(term, foo, bar)
	local retval, nsubs = rsubn(term, foo, bar)
	return retval, nsubs > 0
end

-- apply rsub() repeatedly until no change
local function rsub_repeatedly(term, foo, bar)
	while true do
		local new_term = rsub(term, foo, bar)
		if new_term == term then
			return term
		end
		term = new_term
	end
end

-- ɟ is used internally to represent 
--

function export.IPA(text, phonetic)
	local debug = {}

	text = ulower(text)
	-- decompose everything but ñ and ü
	text = mw.ustring.toNFD(text)
	text = rsub(text, "." .. "", {
		 = "à",
		 = "è",
		 = "ì",
		 = "ò",
		 = "ù",
		 = "ñ",
		 = "ü",
		 = "ë",
	})
	-- convert commas and en/en dashes to IPA foot boundaries
	text = rsub(text, "%s*%s*", " | ")
	-- question mark or exclamation point in the middle of a sentence -> IPA foot boundary
	text = rsub(text, "()%s*%s*()", "%1 | %2")

	-- canonicalize multiple spaces and remove leading and trailing spaces
	local function canon_spaces(text)
		text = rsub(text, "%s+", " ")
		text = rsub(text, "^ ", "")
		text = rsub(text, " $", "")
		return text
	end

	text = canon_spaces(text)

	-- Make prefixes unstressed unless they have an explicit stress marker; also make certain
	-- monosyllabic words (e.g. ], ], ], ], etc.) without stress marks be
	-- unstressed.
	local words = rsplit(text, " ")
	for i, word in ipairs(words) do
		if rfind(word, "%-$") and not rfind(word, accent_c) or unstressed_words then
			-- add macron to the last vowel not the first one
			-- adding the macron after the 'u'
			words = rsub(word, "^(.*" .. V .. ")", "%1" .. MACRON)
		end
	end
	text = table.concat(words, " ")
	-- Convert hyphens to spaces
	text = rsub(text, "%-", " ")
	-- canonicalize multiple spaces again, which may have been introduced by hyphens
	text = canon_spaces(text)
	-- now eliminate punctuation
	text = rsub(text, "", "")
	-- put # at word beginning and end and double ## at text/foot boundary beginning/end
	text = rsub(text, " | ", "# | #")
	text = "##" .. rsub(text, " ", "# #") .. "##"

	table.insert(debug, text)

	-- handle certain combinations; ch, ly ng and sh handling needs to go first
	text = rsub(text, "(?)ch", "ts")
	text = rsub(text, "(?)g̃", "ŋ") -- Spanish spelling support
	text = rsub(text, "ng", "ŋ")
	text = rsub(text, "sh", "sy")

	--x
	text = rsub(text, "()x()", "%1s%2")
	text = rsub(text, "x", "ks")
	
	--ll
	text = rsub(text, "ll(?)()", "ly%2")

	--c, gü/gu+e or i, q
	text = rsub(text, "c()", "s%1")
	text = rsub(text, "()gü()", "%1ɡw%2")
	text = rsub(text, "gü()", "ɡuw%1")
	text = rsub(text, "gu()", "ɡ%1")
	text = rsub(text, "qu()", "k%1")
	text = rsub(text, "ü", "u") 
	text = rsub(text, "ë", "ə") 
	

	--alphabet-to-phoneme
	text = rsub(text, "",
	--="ɡ":  U+0067 LATIN SMALL LETTER G → U+0261 LATIN SMALL LETTER SCRIPT G
		{  = "k",  = "p",  = "ɡ",  = "dy",  = "ny",  = "k",  = "ɾ",  = "b",  = "s",  = "ʔ"})

	-- trill in rr
	text = rsub(text, "ɾɾ", "r")

	table.insert(debug, text)

	--determining whether "y" is a consonant or a vowel
	text = rsub(text, "y(" .. V .. ")", "ɟ%1") -- not the real sound
	text = rsub(text,"y(*)()","i%1%2")
	text = rsub(text, "y#", "i")
	text = rsub(text, "w(" .. V .. ")","w%1")
	text = rsub(text,"w(?)()","u%1%2")
	text = rsub(text, "w#","u")

	table.insert(debug, text)
	
	-- Add glottal stop for words starting with vowel
	text = rsub(text, "()()", "%1ʔ%2")

	text = rsub_repeatedly(text, "(" .. V .. accent_c .. "*)(" .. C .. V .. ")", "%1.%2")
	text = rsub_repeatedly(text, "(" .. V .. accent_c .. "*" .. C .. ")(" .. C .. V .. ")", "%1.%2")
	text = rsub_repeatedly(text, "(" .. V .. accent_c .. "*" .. C .. "+)(" .. C .. C .. V .. ")", "%1.%2")
	text = rsub_repeatedly(text, "(" .. C .. ")%.s(" .. C .. ")", "%1s.%2")
	-- Any aeo, or stressed iu, should be syllabically divided from a following aeo or stressed iu.
	text = rsub_repeatedly(text, "(" .. accent_c .. "*)()", "%1.%2")
	text = rsub_repeatedly(text, "(" .. accent_c .. "*)(" .. V .. stress_c .. ")", "%1.%2")
	text = rsub(text, "(" .. stress_c .. ")()", "%1.%2")
	text = rsub_repeatedly(text, "(" .. stress_c .. ")(" .. V .. stress_c .. ")", "%1.%2")
	text = rsub_repeatedly(text, "i(" .. accent_c .. "*)i", "i%1.i")
	text = rsub_repeatedly(text, "u(" .. accent_c .. "*)u", "u%1.u")

	table.insert(debug, text)

	local accent_to_stress_mark = {  = "ˈ",  = "ˈʔ",  = ""}

	local function accent_word(word, syllables)
		-- Now stress the word. If any accent exists in the word (including macron indicating an unaccented word),
		-- put the stress mark(s) at the beginning of the indicated syllable(s). Otherwise, apply the default
		-- stress rule.
		if rfind(word, accent_c) then
			for i = 1, #syllables do
				syllables = rsub(syllables, "^(.*)(" .. accent_c .. ")(.*)$",
						function(pre, accent, post)
							return accent_to_stress_mark .. pre .. post
						end
				)
			end
		else
			-- Default stress rule. Words without vowels (e.g. IPA foot boundaries) don't get stress.
			if #syllables > 1 and rfind(word, "#") or #syllables == 1 and rfind(word, "") 		then
				syllables = "ˈ" .. syllables
			elseif #syllables >= 2 then
				syllables = "ˈ" .. syllables
			end
		end
	end

	local words = rsplit(text, " ")
	for j, word in ipairs(words) do
		-- accentuation
		local syllables = rsplit(word, "%.")

			accent_word(word, syllables)

		-- Reconstruct the word.
		words = table.concat(syllables, phonetic and "." or "")
	end

	text = table.concat(words, " ")

	-- suppress syllable mark before IPA stress indicator
	text = rsub(text, "%.(" .. ipa_stress_c .. ")", "%1")
	--make all primary stresses but the last one be secondary
	text = rsub_repeatedly(text, "ˈ(.+)ˈ", "ˌ%1ˈ")

    table.insert(debug,text)
   
    --correct final glottal stop placement
    text = rsub(text,"()ʔ(*)()()","%1%2%3%4ʔ")

    --vowels with grave to vowel+glottal stop
    text = rsub(text,"à","aʔ")
    text = rsub(text,"è","eʔ")
    text = rsub(text,"ì","iʔ")
    text = rsub(text,"ò","oʔ")
    text = rsub(text,"ù","uʔ")

    table.insert(debug,text)

    --add temporary macron for /o/ in stressed syllables so they don't get replaced by unstressed form

	text = rsub(text,"()(*)(?)(?)()(?)(?)","%1%2%3%4ō%6%7")

    table.insert(debug, text)

      --Corrections for diphthongs
    text = rsub(text,"()i","%1j") --ay and oy
    text = rsub(text,"()u","%1w") --aw, ew, iw and ow

    table.insert(debug, text)
    
    --remove "ɟ" and "w" inserted on vowel pair starting with "i" and "u"
    text = rsub(text,"()(?)ɟ()","%1%2%3")
    text = rsub(text,"()(?)w()","%1%2%3")

    table.insert(debug, text)

	--phonetic transcription
	if phonetic then

       	table.insert(debug, text)

        --Turn phonemic diphthongs to phonetic diphthongs

		text = rsub(text, "()j", "%1ɪ̯")
		text = rsub(text, "()w", "%1ʊ̯")

        table.insert(debug, text)

        --change unstressed u to unstressed allophone
	    text = rsub(text,"o","ʊ")

table.insert(debug,text)
        
        --remove "j" and "w" inserted on vowel pair starting with "i" and "u"
        text = rsub(text,"()(?)j()","%1%2%3")
        text = rsub(text,"()(?)w()","%1%2%3")

        table.insert(debug, text)

        --Combine consonants (except H) followed by I/U and certain stressed vowels
	    text = rsub(text,"()i()()","%2%1ɟ%3")
	    text = rsub(text,"()u()()","%2%1w%3")
	    text = rsub(text,"()u()()","%2%1w%3") -- only for hu with (ei) combination

       	table.insert(debug, text)
       	
       	-- foreign s consonant clusters
	    text = rsub(text,"(?)(*)(?)()()(?)()","%2.ʔi%4%1%5%6%7")
	    
		text = rsub(text,"()(?)(?)()","%1%2%3ō")
	    
	    table.insert(debug, text)

    	text = rsub(text,"()(*)","m%2")
    	text = rsub(text,"()(*)","n%2")
        text = rsub(text,"n()k","ŋ%1k") -- /n/ before /k/ (some proper nouns)
        text = rsub(text,"n()ɡ","ŋ%1ɡ") -- /n/ before /ɡ/ (some proper nouns and loanwords)
        text = rsub(text,"n()h","ŋ%1h") -- /n/ before /h/ (some proper nouns)
        --text = rsub(text,"n()m","m%1m") -- /n/ before /m/
        text = rsub(text,"t()s()","%1ć%2") -- /t/ before /s/
        text = rsub(text,"t()s","ts") -- /t/ before /s/
        -- text = rsub(text,"()()(?)(?)()","u%2%3%4%5") -- /o/ before /mb/ or /mp/

        --final fix for phonetic diphthongs

	    text = rsub(text,"()ɪ̯","oɪ̯") --oy or uy


       	table.insert(debug, text)

        --delete temporary macron in /u/

	    text = rsub(text,"ō","o")

       	table.insert(debug, text)

       	--Change /ʊ/ to /o/ depending on surrounding phonemes
	    text = rsub(text,"()(?)ʊ(?)()","%1%2o%3%4")

    end

	table.insert(debug, text)

    --delete temporary macron in /u/

	    text = rsub(text,"ō","o")

	-- convert fake symbols to real ones
    local final_conversions = {
		 =  "j", -- fake "y" to real "y"
	}

    local final_conversions_phonetic = {
		 =  "j", -- fake "y" to real "y"
		 =  "t͡s", -- fake "y" to real "y"
	}

	if phonetic then
	text = rsub(text, "", final_conversions_phonetic)
    	end
	text = rsub(text, "", final_conversions)

	-- remove # symbols at word and text boundaries
	text = rsub(text, "#(?)", "")
	
	-- resuppress syllable mark before IPA stress indicator
	text = rsub(text, "%.(" .. ipa_stress_c .. ")", "%1")

	-- Do not have multiple syllable break consecutively
	text = rsub_repeatedly(text, "(+)", ".")
	text = rsub_repeatedly(text, "(?)(" .. ipa_stress_c .. ")(?)", "%2")

	return mw.ustring.toNFC(text)
end

local function respelling_to_IPA(data)
	return ("/%s/ "):format(export.IPA(data.respelling, false), export.IPA(data.respelling, true))
end

function export.show(frame)
	local parent_args = frame:getParent().args
	return require(pron_utilities_module).format_prons {
		lang = lang,
		respelling_to_IPA = respelling_to_IPA,
		raw_args = parent_args,
		track_module = "hil-pron",
	}
end

return export