]]--
+--- LuCI translation library.
module("luci.i18n", package.seeall)
-require("luci.sys")
+require("luci.util")
table = {}
-i18ndir = luci.sys.libpath() .. "/i18n/"
+i18ndir = luci.util.libpath() .. "/i18n/"
loaded = {}
context = luci.util.threadlocal()
default = "en"
--- Clears the translation table
+--- Clear the translation table.
function clear()
table = {}
end
--- Loads a translation and copies its data into the global translation table
+--- Load a translation and copy its data into the translation table.
+-- @param file Language file
+-- @param lang Two-letter language code
+-- @param force Force reload even if already loaded (optional)
+-- @return Success status
function load(file, lang, force)
lang = lang or ""
if force or not loaded[lang] or not loaded[lang][file] then
local f = loadfile(i18ndir .. file .. "." .. lang .. ".lua")
- or loadfile(i18ndir .. file .. "." .. lang)
if f then
table[lang] = table[lang] or {}
setfenv(f, table[lang])
end
end
--- Same as load but autocompletes the filename with .LANG from config.lang
+--- Load a translation file using the default translation language.
+-- Alternatively load the translation of the fallback language.
+-- @param file Language file
+-- @param force Force reload even if already loaded (optional)
function loadc(file, force)
load(file, default, force)
return load(file, context.lang, force)
end
--- Sets the context language
+--- Set the context default translation language.
+-- @param lang Two-letter language code
function setlanguage(lang)
context.lang = lang
end
--- Returns the i18n-value defined by "key" or if there is no such: "default"
-function translate(key, default)
+--- Return the translated value for a specific translation key.
+-- @param key Translation key
+-- @param def Default translation
+-- @return Translated string
+function translate(key, def)
return (table[context.lang] and table[context.lang][key])
or (table[default] and table[default][key])
- or default
+ or def
end
--- Translate shourtcut with sprintf/string.format inclusion
+--- Return the translated value for a specific translation key and use it as sprintf pattern.
+-- @param key Translation key
+-- @param default Default translation
+-- @param ... Format parameters
+-- @return Translated and formatted string
function translatef(key, default, ...)
return translate(key, default):format(...)
end
\ No newline at end of file