မေႃႇၵျူး:scripts

This module is used to retrieve and manage Wiktionary's various writing systems and the information associated with them. See Wiktionary:Scripts for more information.

The information itself is stored in Module:scripts/data. The data module should not be used directly by any other module, the data should only be accessed through the functions provided by Module:scripts.

For functions that allow templates to use this module, see Module:scripts/templates.

Finding and retrieving scripts

The module exports a number of functions that are used to find scripts.

export.makeObject

function export.makeObject(code, data, useRequire)

export.getByCode

function export.getByCode(code, paramForError, disallowNil, useRequire)

Finds the script whose code matches the one provided. If it exists, it returns a Script object representing the script. Otherwise, it returns nil, unless paramForError is given, in which case an error is generated. If paramForError is true, a generic error message mentioning the bad code is generated; otherwise paramForError should be a string or number specifying the parameter that the code came from, and this parameter will be mentioned in the error message along with the bad code.

export.getByCanonicalName

function export.getByCanonicalName(name, useRequire)

export.charToScript

function export.charToScript(char)

Takes a codepoint or a character and finds the script code (if any) that is appropriate for it based on the codepoint, using the data module Module:scripts/recognition data. The data module was generated from the patterns in Module:scripts/data using Module:User:Erutuon/script recognition.

Converts the character to a codepoint. Returns a script code if the codepoint is in the list of individual characters, or if it is in one of the defined ranges in the 4096-character block that it belongs to, else returns "None".

export.findBestScriptWithoutLang

function export.findBestScriptWithoutLang(text, none_is_last_resort_only)

Returns the code for the script that has the greatest number of characters in text. Useful for script tagging text

that is unspecified for language. Uses Module:scripts/recognition data to determine a script code for a character

language-agnostically. Specifically, it works as follows:

Convert each character to a codepoint. Iterate the counter for the script code if the codepoint is in the list

of individual characters, or if it is in one of the defined ranges in the 4096-character block that it belongs to.

Each script has a two-part counter, for primary and secondary matches. Primary matches are when the script is the

first one listed; otherwise, it's a secondary match. When comparing scripts, first the total of both are compared

(i.e. the overall number of matches). If these are the same, the number of primary and then secondary matches are

used as tiebreakers. For example, this is used to ensure that Grek takes priority over Polyt if no characters

which exclusively match Polyt are found, as Grek is a subset of Polyt.

If none_is_last_resort_only is specified, this will never return "None" if any characters in text belong to a

script. Otherwise, it will return "None" if there are more characters that don't belong to a script than belong to

any individual script. (FIXME: This behavior is probably wrong, and none_is_last_resort_only should probably

become the default.)

Script objects

A Script object is returned from one of the functions above. It is a Lua representation of a script and the data associated with it. It has a number of methods that can be called on it, using the : syntax. For example:

local m_scripts = require("Module:scripts")
local sc = m_scripts.getByCode("Latn")
local name = sc:getCanonicalName()
-- "name" will now be "Latin"

Script:getCode

function Script:getCode()

Returns the script code of the language. Example: "Cyrl" for Cyrillic.

Script:getCanonicalName

function Script:getCanonicalName()

Returns the canonical name of the script. This is the name used to represent that script on Wiktionary. Example: "Cyrillic" for Cyrillic.

Script:getDisplayForm

function Script:getDisplayForm()

Returns the display form of the script. For scripts, this is the same as the value returned by :getCategoryName("nocap"), i.e. it reads "NAME script" (e.g. "Arabic script"). For regular and etymology languages, this is the same as the canonical name, and for families, it reads "NAME languages" (e.g. "Indo-Iranian languages"). The displayed text used in :makeCategoryLink is always the same as the display form.

Script:getOtherNames

function Script:getOtherNames(onlyOtherNames)

Script:getAliases

function Script:getAliases()

Script:getVarieties

function Script:getVarieties(flatten)

Script:getParent

function Script:getParent()

Returns the parent of the script. Example: "Arab" for "fa-Arab". It returns "top" for scripts without a parent, like "Latn", "Grek", etc.

Script:getSystemCodes

function Script:getSystemCodes()

Script:getSystems

function Script:getSystems()

Script:isSystem

function Script:isSystem(...)

Check whether the script is of type system, which can be a writing system code or object. If multiple systems are passed, return true if the script is any of the specified systems.

Script:hasType

function Script:hasType(...)

Given a list of types as strings, returns true if the script has all of them.

Currently the only possible type is script; use hasType("script") to determine if an object that

may be a language, family or script is a script.

Script:getCategoryName

function Script:getCategoryName(nocap)

Returns the name of the main category of that script. Example: "Cyrillic script" for Cyrillic, whose category is at Category:Cyrillic script.

Unless optional argument nocap is given, the script name at the beginning of the returned value will be capitalized. This capitalization is correct for category names, but not if the script name is lowercase and the returned value of this function is used in the middle of a sentence. (For example, the script with the code Semap has the name "flag semaphore", which should remain lowercase when used as part of the category name Category:Translingual letters in flag semaphore but should be capitalized in Category:Flag semaphore templates.) If you are considering using getCategoryName("nocap"), use getDisplayForm() instead.

Script:makeCategoryLink

function Script:makeCategoryLink()

Script:getWikipediaArticle

function Script:getWikipediaArticle()

Returns the wikipedia_article item in the language's data file, or else calls Script:getCategoryName().

Script:getCharacters

function Script:getCharacters()

Returns the charset defining the script's characters from the language's data file.

This can be used to search for words consisting only of this script, but see the warning above.

Script:countCharacters

function Script:countCharacters(text)

Returns the number of characters in the text that are part of this script.

Note: You should never assume that text consists entirely of the same script. Strings may contain spaces, punctuation and even wiki markup or HTML tags. HTML tags will skew the counts, as they contain Latin-script characters. So it's best to avoid them.

Script:hasCapitalization

function Script:hasCapitalization()

Script:hasSpaces

function Script:hasSpaces()

Script:isTransliterated

function Script:isTransliterated()

Script:sortByScraping

function Script:sortByScraping()

Returns true if the script is (sometimes) sorted by scraping page content, meaning that it is sensitive to changes in capitalization during sorting.

Script:getDirection

function Script:getDirection()

Returns the text direction. Horizontal scripts return "ltr" (left-to-right) or "rtl" (right-to-left), while vertical scripts return "vertical-ltr" (vertical left-to-right) or "vertical-rtl" (vertical right-to-left).

Script:getRawData

function Script:getRawData()

Script:hasNormalizationFixes

function Script:hasNormalizationFixes()

Returns true if the script contains characters that require fixes to Unicode normalization under certain circumstances, false if it doesn't.

Script:fixDiscouragedSequences

function Script:fixDiscouragedSequences(text)

Corrects discouraged sequences of Unicode characters to the encouraged equivalents.

Script:toFixedNFC

function Script:toFixedNFC(text)

Script:toFixedNFD

function Script:toFixedNFD(text)

Script:toFixedNFKC

function Script:toFixedNFKC(text)

Script:toFixedNFKD

function Script:toFixedNFKD(text)

Script:toJSON

function Script:toJSON()

Subpages

scripts/by name scripts/by name/doc scripts/by name/sandbox scripts/chain scripts/chain/doc scripts/charToScript scripts/charToScript/doc scripts/charToScript/sandbox scripts/code to canonical name scripts/code to canonical name/doc scripts/data scripts/data/combiningClasses scripts/data/doc scripts/data/sandbox scripts/doc scripts/findBestScript scripts/findBestScript/doc scripts/print scripts/print/doc scripts/recognition data scripts/recognition data/doc scripts/sandbox scripts/style.css scripts/templates scripts/templates/doc

See also

• Module:script utilities

---

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

local codepoint = m_str_utils.codepoint
local gsplit = m_str_utils.gsplit
local select = select
local split = m_str_utils.split
local toNFC = mw.ustring.toNFC
local toNFD = mw.ustring.toNFD
local toNFKC = mw.ustring.toNFKC
local toNFKD = mw.ustring.toNFKD
local type = type
local u = m_str_utils.char
local ugsub = m_str_utils.gsub
local umatch = m_str_utils.match

local export = {}

local Script = {}

--[==[Returns the script code of the language. Example: {{code|lua|"Cyrl"}} for Cyrillic.]==]
function Script:getCode()
	return self._code
end

--[==[Returns the canonical name of the script. This is the name used to represent that script on Wiktionary. Example: {{code|lua|"Cyrillic"}} for Cyrillic.]==]
function Script:getCanonicalName()
	return self._rawData[1] or self._rawData.canonicalName
end

--[==[Returns the display form of the script. For scripts, this is the same as the value returned by <code>:getCategoryName("nocap")</code>, i.e. it reads "NAME script" (e.g. {{code|lua|"Arabic script"}}). For regular and etymology languages, this is the same as the canonical name, and for families, it reads "NAME languages" (e.g. {{code|lua|"Indo-Iranian languages"}}). The displayed text used in <code>:makeCategoryLink</code> is always the same as the display form.]==]
function Script:getDisplayForm()
	return self:getCategoryName("nocap")
end

function Script:getOtherNames(onlyOtherNames)
	return require("Module:language-like").getOtherNames(self, onlyOtherNames)
end

function Script:getAliases()
	return self._rawData.aliases or {}
end

function Script:getVarieties(flatten)
	return require("Module:language-like").getVarieties(self, flatten)
end

--[==[Returns the parent of the script. Example: {{code|lua|"Arab"}} for {{code|lua|"fa-Arab"}}. It returns {{code|lua|"top"}} for scripts without a parent, like {{code|lua|"Latn"}}, {{code|lua|"Grek"}}, etc.]==]
function Script:getParent()
	return self._rawData.parent
end

function Script:getSystemCodes()
	if not self._systemCodes then
		if type(self._rawData[2]) == "table" then
			self._systemCodes = self._rawData[2]
		elseif type(self._rawData[2]) == "string" then
			self._systemCodes = split(self._rawData[2], "%s*,%s*", true)
		else
			self._systemCodes = {}
		end
	end
	return self._systemCodes
end

function Script:getSystems()
	if not self._systemObjects then
		local m_systems = require("Module:writing systems")
		self._systemObjects = {}
		
		for _, ws in ipairs(self:getSystemCodes()) do
			table.insert(self._systemObjects, m_systems.getByCode(ws))
		end
	end
	
	return self._systemObjects
end

--[==[Check whether the script is of type `system`, which can be a writing system code or object. If multiple systems are passed, return true if the script is any of the specified systems.]==]
function Script:isSystem(...)
	for _, system in ipairs{...} do
		if type(system) == "table" then
			system = system:getCode()
		end
		for _, s in ipairs(self:getSystemCodes()) do
			if system == s then
				return true
			end
		end
	end
	return false
end

--function Script:getAllNames()
--	return self._rawData.names
--end

--[==[Given a list of types as strings, returns true if the script has all of them. 

Currently the only possible type is {script}; use {{lua|hasType("script")}} to determine if an object that
may be a language, family or script is a script.
]==]	
function Script:hasType(...)
	local types = self._types
	if types == nil then
		types = {script = true}
		local rawtypes = self._rawData.type
		if rawtypes then
			for rawtype in gsplit(rawtypes, "%s*,%s*", true) do
				types[rawtype] = true
			end
		end
		self._types = types
	end
	for i = 1, arg.n do
		if not types[arg[i]] then
			return false
		end
	end
	return true
end

--[==[Returns the name of the main category of that script. Example: {{code|lua|"Cyrillic script"}} for Cyrillic, whose category is at [[:Category:Cyrillic script]].
Unless optional argument <code>nocap</code> is given, the script name at the beginning of the returned value will be capitalized. This capitalization is correct for category names, but not if the script name is lowercase and the returned value of this function is used in the middle of a sentence. (For example, the script with the code <code>Semap</code> has the name <code>"flag semaphore"</code>, which should remain lowercase when used as part of the category name [[:Category:Translingual letters in flag semaphore]] but should be capitalized in [[:Category:Flag semaphore templates]].) If you are considering using <code>getCategoryName("nocap")</code>, use <code>getDisplayForm()</code> instead.]==]
function Script:getCategoryName(nocap)
	local name = self._rawData[1] or self._rawData.canonicalName
	
	-- If the name already has "script", "code" or "semaphore" at the end, don't add it.
	if not (
		name:find("[ %-][Ss]cript$") or
		name:find("[ %-][Cc]ode$") or
		name:find("[ %-][Ss]emaphore$")
	) then
		name = name .. " script"
	end
	if not nocap then
		name = mw.getContentLanguage():ucfirst(name)
	end
	return name
end

function Script:makeCategoryLink()
	return "[[:Category:" .. self:getCategoryName() .. "|" .. self:getDisplayForm() .. "]]"
end

--[==[Returns the {{code|lua|wikipedia_article}} item in the language's data file, or else calls {{code|lua|Script:getCategoryName()}}.]==]
function Script:getWikipediaArticle()
	return self._rawData.wikipedia_article or self:getCategoryName()
end

--[==[Returns the charset defining the script's characters from the language's data file.
This can be used to search for words consisting only of this script, but see the warning above.]==]
function Script:getCharacters()
	return self.characters or nil
end

--[==[Returns the number of characters in the text that are part of this script.
'''Note:''' You should never assume that text consists entirely of the same script. Strings may contain spaces, punctuation and even wiki markup or HTML tags. HTML tags will skew the counts, as they contain Latin-script characters. So it's best to avoid them.]==]
function Script:countCharacters(text)
	local charset = self._rawData.characters
	if charset == nil then
		return 0
	end
	return select(2, ugsub(text, "[" .. charset .. "]", ""))
end

function Script:hasCapitalization()
	return not not self._rawData.capitalized
end

function Script:hasSpaces()
	return self._rawData.spaces ~= false
end

function Script:isTransliterated()
	return self._rawData.translit ~= false
end

--[==[Returns true if the script is (sometimes) sorted by scraping page content, meaning that it is sensitive to changes in capitalization during sorting.]==]
function Script:sortByScraping()
	return not not self._rawData.sort_by_scraping
end

--[==[Returns the text direction. Horizontal scripts return {{code|lua|"ltr"}} (left-to-right) or {{code|lua|"rtl"}} (right-to-left), while vertical scripts return {{code|lua|"vertical-ltr"}} (vertical left-to-right) or {{code|lua|"vertical-rtl"}} (vertical right-to-left).]==]
function Script:getDirection()
	return self._rawData.direction or "ltr"
end

function Script:getRawData()
	return self._rawData
end

--[==[Returns {{code|lua|true}} if the script contains characters that require fixes to Unicode normalization under certain circumstances, {{code|lua|false}} if it doesn't.]==]
function Script:hasNormalizationFixes()
	return not not self._rawData.normalizationFixes
end

--[==[Corrects discouraged sequences of Unicode characters to the encouraged equivalents.]==]
function Script:fixDiscouragedSequences(text)
	if self:hasNormalizationFixes() and self._rawData.normalizationFixes.from then
		for i, from in ipairs(self._rawData.normalizationFixes.from) do
			text = ugsub(text, from, self._rawData.normalizationFixes.to[i] or "")
		end
	end
	return text
end

-- Implements a modified form of Unicode normalization for instances where there are identified deficiencies in the default Unicode combining classes.
local function fixNormalization(text, self)
	if self:hasNormalizationFixes() and self._rawData.normalizationFixes.combiningClasses then
		local combiningClassFixes = self._rawData.normalizationFixes.combiningClasses
		local charsToFix = table.concat(require("Module:table").keysToList(combiningClassFixes))
		if umatch(text, "[" .. charsToFix .. "]") then
			-- Obtain the list of default combining classes.
			local combiningClasses = mw.loadData("Module:scripts/data/combiningClasses")
			-- For each character that needs fixing, find all characters with combining classes equal to or lower than its default class, but greater than its new class (i.e. intermediary characters).
			for charToFix, newCombiningClass in pairs(combiningClassFixes) do
				local intermediaryChars = {}
				for character, combiningClass in pairs(combiningClasses) do
					if newCombiningClass < combiningClass and combiningClass <= combiningClasses[codepoint(charToFix)] then
						table.insert(intermediaryChars, u(character))
					end
				end
				-- Swap the character with any intermediary characters that are immediately before it.
				text = ugsub(text, "([" .. table.concat(intermediaryChars) .. "]+)(" .. charToFix .. ")", "%2%1")
			end
		end
	end
	return text
end

function Script:toFixedNFC(text)
	return fixNormalization(toNFC(text), self)
end

function Script:toFixedNFD(text)
	return fixNormalization(toNFD(text), self)
end

function Script:toFixedNFKC(text)
	return fixNormalization(toNFKC(text), self)
end

function Script:toFixedNFKD(text)
	return fixNormalization(toNFKD(text), self)
end

function Script:toJSON()
	if not self._types then
		self:hasType()
	end
	local types = {}
	for type in pairs(self._types) do
		table.insert(types, type)
	end
	
	local ret = {
		canonicalName = self:getCanonicalName(),
		categoryName = self:getCategoryName("nocap"),
		code = self:getCode(),
		otherNames = self:getOtherNames(true),
		aliases = self:getAliases(),
		varieties = self:getVarieties(),
		type = types,
		direction = self:getDirection(),
		characters = self:getCharacters(),
		parent = self:getParent(),
		systems = self:getSystemCodes(),
		wikipediaArticle = self._rawData.wikipedia_article,
	}
	
	return require("Module:JSON").toJSON(ret)
end

Script.__index = Script
	
function export.makeObject(code, data, useRequire)
	return data and setmetatable({
		_rawData = data,
		_code = code,
		characters = data.characters
	}, Script) or nil
end

-- Track scripts with anomalous names.
local scriptsToTrack = {
	-- scripts already renamed
	["IPAchar"] = true,
	["musical"] = true,
	["Ruminumerals"] = true,
	["polytonic"] = true,
	-- scripts not yet renamed
	["Latinx"] = true,
	["Latnx"] = true,
}

-- Temporary aliases from canonicalized names to (existing) anomalous names. Once we have converted everything we will
-- rename the scripts and remove the alias code.
local scriptAliases = {
	-- scripts already renamed; we now alias the old names to the new ones
	["IPAchar"] = "Ipach",
	["musical"] = "Music",
	["Ruminumerals"] = "Rumin",
	["polytonic"] = "Polyt",
	["Latinx"] = "Latn",
	["Latnx"] = "Latn",
}

--[==[Finds the script whose code matches the one provided. If it exists, it returns a {{code|lua|Script}} object representing the script. Otherwise, it returns {{code|lua|nil}}, unless <span class="n">paramForError</span> is given, in which case an error is generated. If <code class="n">paramForError</code> is {{code|lua|true}}, a generic error message mentioning the bad code is generated; otherwise <code class="n">paramForError</code> should be a string or number specifying the parameter that the code came from, and this parameter will be mentioned in the error message along with the bad code.]==]
function export.getByCode(code, paramForError, disallowNil, useRequire)
	-- Track uses of paramForError, ultimately so it can be removed, as error-handling should be done by [[Module:parameters]], not here.
	if paramForError ~= nil then
		require("Module:debug/track")("scripts/paramForError")
	end
	
	if code == nil and not disallowNil then
		return nil
	end
	if scriptsToTrack[code] then
		require("Module:debug/track")("scripts/" .. code)
	end
	code = scriptAliases[code] or code
	
	local data
	if useRequire then
		data = require("Module:scripts/data")[code]
	else
		data = mw.loadData("Module:scripts/data")[code]
	end
	
	local retval = export.makeObject(code, data, useRequire)
	
	if not retval and paramForError then
		require("Module:languages/error")(code, paramForError, "script code", nil, "not real lang")
	end
	
	return retval
end

function export.getByCanonicalName(name, useRequire)
	local code
	if useRequire then
		code = require("Module:scripts/by name")[name]
	else
		code = mw.loadData("Module:scripts/by name")[name]
	end
	
	return export.getByCode(code, nil, nil, useRequire)
end

--[==[
	Takes a codepoint or a character and finds the script code (if any) that is
	appropriate for it based on the codepoint, using the data module
	[[Module:scripts/recognition data]]. The data module was generated from the
	patterns in [[Module:scripts/data]] using [[Module:User:Erutuon/script recognition]].

	Converts the character to a codepoint. Returns a script code if the codepoint
	is in the list of individual characters, or if it is in one of the defined
	ranges in the 4096-character block that it belongs to, else returns "None".
]==]
function export.charToScript(char)
	return require("Module:scripts/charToScript").charToScript(char)
end

--[==[
Returns the code for the script that has the greatest number of characters in `text`. Useful for script tagging text
that is unspecified for language. Uses [[Module:scripts/recognition data]] to determine a script code for a character
language-agnostically. Specifically, it works as follows:
	
Convert each character to a codepoint. Iterate the counter for the script code if the codepoint is in the list
of individual characters, or if it is in one of the defined ranges in the 4096-character block that it belongs to.
	
Each script has a two-part counter, for primary and secondary matches. Primary matches are when the script is the
first one listed; otherwise, it's a secondary match. When comparing scripts, first the total of both are compared
(i.e. the overall number of matches). If these are the same, the number of primary and then secondary matches are
used as tiebreakers. For example, this is used to ensure that `Grek` takes priority over `Polyt` if no characters
which exclusively match `Polyt` are found, as `Grek` is a subset of `Polyt`.
	
If `none_is_last_resort_only` is specified, this will never return {"None"} if any characters in `text` belong to a
script. Otherwise, it will return {"None"} if there are more characters that don't belong to a script than belong to
any individual script. (FIXME: This behavior is probably wrong, and `none_is_last_resort_only` should probably
become the default.)
]==]
function export.findBestScriptWithoutLang(text, none_is_last_resort_only)
	return require("Module:scripts/charToScript").findBestScriptWithoutLang(text, none_is_last_resort_only)
end

return export