vanilla-wow-addons – Rev 1
?pathlinks?
--[[
Name: AceLocale-2.0
Revision: $Rev: 9151 $
Author(s): ckknight (ckknight@gmail.com)
Website: http://www.wowace.com/
Documentation: http://wiki.wowace.com/index.php/AceLocale-2.0
SVN: http://svn.wowace.com/root/trunk/Ace2/AceLocale-2.0
Description: Localization library for addons to use to handle proper
localization and internationalization.
Dependencies: AceLibrary
]]
local MAJOR_VERSION = "AceLocale-2.0"
local MINOR_VERSION = "$Revision: 9151 $"
if not AceLibrary then error(MAJOR_VERSION .. " requires AceLibrary.") end
if not AceLibrary:IsNewVersion(MAJOR_VERSION, MINOR_VERSION) then return end
local AceLocale = {}
local DEFAULT_LOCALE = "enUS"
local _G = getfenv(0)
local new, del
do
local list = setmetatable({}, {__mode='k'})
function new()
local t = next(list)
if t then
list[t] = nil
return t
else
return {}
end
end
function del(t)
setmetatable(t, nil)
for k in pairs(t) do
t[k] = nil
end
table.setn(t, 0)
list[t] = true
end
end
local __baseTranslations__, __debugging__, __translations__, __baseLocale__, __translationTables__, __reverseTranslations__
local callFunc = function(self, key1, key2)
if key2 then
return self[key1][key2]
else
return self[key1]
end
end
function AceLocale:new(name)
self:argCheck(name, 2, "string")
if self.registry[name] and type(rawget(self.registry[name], 'GetLibraryVersion')) ~= "function" then
return self.registry[name]
end
local self = new()
local mt = new()
mt.__index = AceLocale.prototype
mt.__newindex = function(self, k, v)
if type(v) ~= "function" and type(k) ~= "table" then
local stack = debugstack()
local _,_,line = string.find(stack, "\n(.-)\n")
DEFAULT_CHAT_FRAME:AddMessage(string.format("%s: Cannot change the values of an AceLocale instance. %s", tostring(self), tostring(line)))
end
rawset(self, k, v)
end
mt.__call = callFunc
mt.__tostring = function(self)
if type(rawget(self, 'GetLibraryVersion')) == "function" then
return self:GetLibraryVersion()
else
return "AceLocale(" .. name .. ")"
end
end
setmetatable(self, mt)
AceLocale.registry[name] = self
return self
end
setmetatable(AceLocale, { __call = AceLocale.new })
AceLocale.prototype = {}
AceLocale.prototype.class = AceLocale
function AceLocale.prototype:EnableDebugging()
if rawget(self, __baseTranslations__) then
AceLocale.error(self, "Cannot enable debugging after a translation has been registered.")
end
rawset(self, __debugging__, true)
end
function AceLocale.prototype:RegisterTranslations(locale, func)
AceLocale.argCheck(self, locale, 2, "string")
AceLocale.argCheck(self, func, 3, "function")
if locale == rawget(self, __baseLocale__) then
AceLocale.error(self, "Cannot provide the same locale more than once. %q provided twice.", locale)
end
if rawget(self, __baseTranslations__) and GetLocale() ~= locale then
if rawget(self, __debugging__) then
local t = func()
func = nil
if type(t) ~= "table" then
AceLocale.error(self, "Bad argument #3 to `RegisterTranslations'. function did not return a table. (expected table, got %s)", type(t))
end
self[__translationTables__][locale] = t
t = nil
end
func = nil
return
end
local t = func()
func = nil
if type(t) ~= "table" then
AceLocale.error(self, "Bad argument #3 to `RegisterTranslations'. function did not return a table. (expected table, got %s)", type(t))
end
rawset(self, __translations__, t)
if not rawget(self, __baseTranslations__) then
rawset(self, __baseTranslations__, t)
rawset(self, __baseLocale__, locale)
for key,value in pairs(t) do
if value == true then
t[key] = key
end
end
local mt = getmetatable(self)
local __index = mt.__index
mt.__index = t
local mt2 = new()
mt2.__index = __index
setmetatable(t, mt2)
else
for key, value in pairs(self[__translations__]) do
if not rawget(self[__baseTranslations__], key) then
AceLocale.error(self, "Improper translation exists. %q is likely misspelled for locale %s.", key, locale)
elseif value == true then
AceLocale.error(self, "Can only accept true as a value on the base locale. %q is the base locale, %q is not.", rawget(self, __baseLocale__), locale)
end
end
local mt = getmetatable(self)
local __index = mt.__index
mt.__index = rawget(self, __translations__)
local mt2 = new()
mt2.__index = __index
setmetatable(rawget(self, __translations__), mt2)
end
if rawget(self, __debugging__) then
if not rawget(self, __translationTables__) then
rawset(self, __translationTables__, {})
end
self[__translationTables__][locale] = t
end
t = nil
end
function AceLocale.prototype:SetStrictness(strict)
local mt = getmetatable(self)
if not mt then
AceLocale.error(self, "Cannot call `SetStrictness' without a metatable.")
end
AceLocale.assert(self, rawget(self, __translations__), "No translations registered.")
local mt2 = getmetatable(self[__translations__])
local mt3 = getmetatable(self[__baseTranslations__])
if mt2 then
mt2 = del(mt2)
setmetatable(self[__translations__], nil)
end
if mt3 then
mt3 = del(mt3)
setmetatable(self[__baseTranslations__], nil)
end
getmetatable(self).__index = AceLocale.prototype
if strict then
local mt2 = new()
mt2.__index = AceLocale.prototype
setmetatable(self[__translations__], mt2)
getmetatable(self).__index = self[__translations__]
else
if self[__baseTranslations__] ~= self[__translations__] then
local mt2 = new()
mt2.__index = AceLocale.prototype
setmetatable(self[__baseTranslations__], mt2)
mt.__index = self[__baseTranslations__]
if self[__translations__] then
local mt3 = new()
mt3.__index = self[__baseTranslations__]
setmetatable(self[__translations__], mt3)
mt.__index = self[__translations__]
end
end
end
end
function AceLocale.prototype:GetTranslationStrict(text, sublevel)
AceLocale.argCheck(self, text, 1, "string")
AceLocale.assert(self, rawget(self, __translations__), "No translations registered")
if sublevel then
AceLocale.argCheck(self, sublevel, 2, "string")
local t = rawget(self[__translations__], text)
if type(t) ~= "table" then
if type(rawget(self[__baseTranslations__], text)) == "table" then
AceLocale.error(self, "%q::%q has not been translated into %q", text, sublevel, GetLocale())
return
else
AceLocale.error(self, "Translation for %q::%q does not exist", text, sublevel)
return
end
end
local translation = t[sublevel]
if type(translation) ~= "string" then
if type(rawget(self[__baseTranslations__], text)) == "table" then
if type(self[__baseTranslations__][text][sublevel]) == "string" then
AceLocale.error(self, "%q::%q has not been translated into %q", text, sublevel, GetLocale())
return
else
AceLocale.error(self, "Translation for %q::%q does not exist", text, sublevel)
return
end
else
AceLocale.error(self, "Translation for %q::%q does not exist", text, sublevel)
return
end
end
return translation
end
local translation = rawget(self[__translations__], text)
if type(translation) ~= "string" then
if type(rawget(self[__baseTranslations__], text)) == "string" then
AceLocale.error(self, "%q has not been translated into %q", text, GetLocale())
return
else
AceLocale.error(self, "Translation for %q does not exist", text)
return
end
end
return translation
end
function AceLocale.prototype:GetTranslation(text, sublevel)
AceLocale:argCheck(text, 1, "string")
AceLocale.assert(self, rawget(self, __translations__), "No translations registered")
if sublevel then
AceLocale:argCheck(sublevel, 2, "string", "nil")
local t = self[__translations__][text]
if type(t) == "table" then
local translation = t[sublevel]
if type(translation) == "string" then
return translation
else
t = self[__baseTranslations__][text]
if type(t) ~= "table" then
AceLocale.error(self, "Translation table %q does not exist", text)
return
end
translation = t[sublevel]
if type(translation) ~= "string" then
AceLocale.error(self, "Translation for %q::%q does not exist", text, sublevel)
return
end
return translation
end
else
t = self[__baseTranslations__][text]
if type(t) ~= "table" then
AceLocale.error(self, "Translation table %q does not exist", text)
return
end
local translation = t[sublevel]
if type(translation) ~= "string" then
AceLocale.error(self, "Translation for %q::%q does not exist", text, sublevel)
return
end
return translation
end
end
local translation = self[__translations__][text]
if type(translation) == "string" then
return translation
else
translation = self[__baseTranslations__][text]
if type(translation) ~= "string" then
AceLocale.error(self, "Translation for %q does not exist", text)
return
end
return translation
end
end
local function initReverse(self)
rawset(self, __reverseTranslations__, {})
local alpha = self[__translations__]
local bravo = self[__reverseTranslations__]
for base, localized in pairs(alpha) do
bravo[localized] = base
end
end
function AceLocale.prototype:GetReverseTranslation(text)
AceLocale.argCheck(self, text, 1, "string")
AceLocale.assert(self, rawget(self, __translations__), "No translations registered")
if not rawget(self, __reverseTranslations__) then
initReverse(self)
end
local translation = self[__reverseTranslations__][text]
if type(translation) ~= "string" then
AceLocale.error(self, "Reverse translation for %q does not exist", text)
return
end
return translation
end
function AceLocale.prototype:GetIterator()
AceLocale.assert(self, rawget(self, __translations__), "No translations registered")
return pairs(self[__translations__])
end
function AceLocale.prototype:GetReverseIterator()
AceLocale.assert(self, rawget(self, __translations__), "No translations registered")
if not rawget(self, __reverseTranslations__) then
initReverse(self)
end
return pairs(self[__reverseTranslations__])
end
function AceLocale.prototype:HasTranslation(text, sublevel)
AceLocale.argCheck(self, text, 1, "string")
AceLocale.assert(self, rawget(self, __translations__), "No translations registered")
if sublevel then
AceLocale.argCheck(self, sublevel, 2, "string", "nil")
return type(rawget(self[__translations__], text)) == "table" and self[__translations__][text][sublevel] and true
end
return rawget(self[__translations__], text) and true
end
function AceLocale.prototype:HasReverseTranslation(text)
AceLocale.assert(self, rawget(self, __translations__), "No translations registered")
if not rawget(self, __reverseTranslations__) then
initReverse(self)
end
return self[__reverseTranslations__][text] and true
end
function AceLocale.prototype:GetTableStrict(key, key2)
AceLocale.argCheck(self, key, 1, "string")
AceLocale.assert(self, rawget(self, __translations__), "No translations registered")
if key2 then
AceLocale.argCheck(self, key2, 2, "string")
local t = rawget(self[__translations__], key)
if type(t) ~= "table" then
if type(rawget(self[__baseTranslations__], key)) == "table" then
AceLocale.error(self, "%q::%q has not been translated into %q", key, key2, GetLocale())
return
else
AceLocale.error(self, "Translation table %q::%q does not exist", key, key2)
return
end
end
local translation = t[key2]
if type(translation) ~= "table" then
if type(rawget(self[__baseTranslations__], key)) == "table" then
if type(self[__baseTranslations__][key][key2]) == "table" then
AceLocale.error(self, "%q::%q has not been translated into %q", key, key2, GetLocale())
return
else
AceLocale.error(self, "Translation table %q::%q does not exist", key, key2)
return
end
else
AceLocale.error(self, "Translation table %q::%q does not exist", key, key2)
return
end
end
return translation
end
local translation = rawget(self[__translations__], key)
if type(translation) ~= "table" then
if type(rawget(self[__baseTranslations__], key)) == "table" then
AceLocale.error(self, "%q has not been translated into %q", key, GetLocale())
return
else
AceLocale.error(self, "Translation table %q does not exist", key)
return
end
end
return translation
end
function AceLocale.prototype:GetTable(key, key2)
AceLocale.argCheck(self, key, 1, "string")
AceLocale.assert(self, rawget(self, __translations__), "No translations registered")
if key2 then
AceLocale.argCheck(self, key2, 2, "string", "nil")
local t = rawget(self[__translations__], key)
if type(t) == "table" then
local translation = t[key2]
if type(translation) == "table" then
return translation
else
t = rawget(self[__baseTranslations__], key)
if type(t) ~= "table" then
AceLocale.error(self, "Translation table %q does not exist", key)
return
end
translation = t[key2]
if type(translation) ~= "table" then
AceLocale.error(self, "Translation table %q::%q does not exist", key, key2)
return
end
return translation
end
else
t = rawget(self[__baseTranslations__], key)
if type(t) ~= "table" then
AceLocale.error(self, "Translation table %q does not exist", key)
return
end
local translation = t[key2]
if type(translation) ~= "table" then
AceLocale.error(self, "Translation table %q::%q does not exist", key, key2)
return
end
return translation
end
end
local translation = rawget(self[__translations__], key)
if type(translation) == "table" then
return translation
else
translation = rawget(self[__baseTranslations__], key)
if type(translation) ~= "table" then
AceLocale.error(self, "Translation table %q does not exist", key)
return
end
return translation
end
end
function AceLocale.prototype:Debug()
if not rawget(self, __debugging__) then
return
end
local words = {}
local locales = {"enUS", "deDE", "frFR", "zhCN", "zhTW", "koKR"}
local localizations = {}
DEFAULT_CHAT_FRAME:AddMessage("--- AceLocale Debug ---")
for _,locale in ipairs(locales) do
if not self[__translationTables__][locale] then
DEFAULT_CHAT_FRAME:AddMessage(string.format("Locale %q not found", locale))
else
localizations[locale] = self[__translationTables__][locale]
end
end
local localeDebug = {}
for locale, localization in pairs(localizations) do
localeDebug[locale] = {}
for word in pairs(localization) do
if type(localization[word]) == "table" then
if type(words[word]) ~= "table" then
words[word] = {}
end
for bit in pairs(localization[word]) do
if type(localization[word][bit]) == "string" then
words[word][bit] = true
end
end
elseif type(localization[word]) == "string" then
words[word] = true
end
end
end
for word in pairs(words) do
if type(words[word]) == "table" then
for bit in pairs(words[word]) do
for locale, localization in pairs(localizations) do
if not localization[word] or not localization[word][bit] then
localeDebug[locale][word .. "::" .. bit] = true
end
end
end
else
for locale, localization in pairs(localizations) do
if not localization[word] then
localeDebug[locale][word] = true
end
end
end
end
for locale, t in pairs(localeDebug) do
if not next(t) then
DEFAULT_CHAT_FRAME:AddMessage(string.format("Locale %q complete", locale))
else
DEFAULT_CHAT_FRAME:AddMessage(string.format("Locale %q missing:", locale))
for word in pairs(t) do
DEFAULT_CHAT_FRAME:AddMessage(string.format(" %q", word))
end
end
end
DEFAULT_CHAT_FRAME:AddMessage("--- End AceLocale Debug ---")
end
setmetatable(AceLocale.prototype, {
__index = function(self, k)
if type(k) ~= "table" and k ~= "GetLibraryVersion" and k ~= "error" and k ~= "assert" and k ~= "argCheck" and k ~= "pcall" then -- HACK: remove "GetLibraryVersion" and such later.
local stack = debugstack()
local _,_,line = string.find(stack, "\n(.-)\n")
DEFAULT_CHAT_FRAME:AddMessage(string.format("%s: Translation %q does not exist. %s", tostring(self), tostring(k), tostring(line)))
end
end
})
local function activate(self, oldLib, oldDeactivate)
AceLocale = self
if oldLib then
self.registry = oldLib.registry
self.__baseTranslations__ = oldLib.__baseTranslations__
self.__debugging__ = oldLib.__debugging__
self.__translations__ = oldLib.__translations__
self.__baseLocale__ = oldLib.__baseLocale__
self.__translationTables__ = oldLib.__translationTables__
self.__reverseTranslations__ = oldLib.__reverseTranslations__
end
if not self.registry then
self.registry = {}
end
if not self.__baseTranslations__ then
self.__baseTranslations__ = {}
end
if not self.__debugging__ then
self.__debugging__ = {}
end
if not self.__translations__ then
self.__translations__ = {}
end
if not self.__baseLocale__ then
self.__baseLocale__ = {}
end
if not self.__translationTables__ then
self.__translationTables__ = {}
end
if not self.__reverseTranslations__ then
self.__reverseTranslations__ = {}
end
__baseTranslations__ = self.__baseTranslations__
__debugging__ = self.__debugging__
__translations__ = self.__translations__
__baseLocale__ = self.__baseLocale__
__translationTables__ = self.__translationTables__
__reverseTranslations__ = self.__reverseTranslations__
if oldDeactivate then
oldDeactivate(oldLib)
end
end
AceLibrary:Register(AceLocale, MAJOR_VERSION, MINOR_VERSION, activate)
AceLocale = AceLibrary(MAJOR_VERSION)