luci-base: break circular luci.config <> luci.model.uci dependency
[project/luci.git] / modules / luci-base / luasrc / i18n.lua
index dd84a59..bcb16d5 100644 (file)
@@ -1,7 +1,6 @@
 -- Copyright 2008 Steven Barth <steven@midlink.org>
 -- Licensed to the public under the Apache License 2.0.
 
---- LuCI translation library.
 module("luci.i18n", package.seeall)
 require("luci.util")
 
@@ -13,27 +12,16 @@ loaded  = {}
 context = luci.util.threadlocal()
 default = "en"
 
---- Clear the translation table.
 function clear()
 end
 
---- 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)
 end
 
---- 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)
 end
 
---- Set the context default translation language.
--- @param lang Two-letter language code
 function setlanguage(lang)
        context.lang   = lang:gsub("_", "-")
        context.parent = (context.lang:match("^([a-z][a-z])_"))
@@ -46,36 +34,22 @@ function setlanguage(lang)
        return context.lang
 end
 
---- Return the translated value for a specific translation key.
--- @param key  Default translation text
--- @return             Translated string
 function translate(key)
        return tparser.translate(key) or key
 end
 
---- Return the translated value for a specific translation key and use it as sprintf pattern.
--- @param key          Default translation text
--- @param ...          Format parameters
--- @return                     Translated and formatted string
 function translatef(key, ...)
        return tostring(translate(key)):format(...)
 end
 
---- Return the translated value for a specific translation key
 -- and ensure that the returned value is a Lua string value.
 -- This is the same as calling <code>tostring(translate(...))</code>
--- @param key          Default translation text
--- @return                     Translated string
 function string(key)
        return tostring(translate(key))
 end
 
---- Return the translated value for a specific translation key and use it as sprintf pattern.
 -- Ensure that the returned value is a Lua string value.
 -- This is the same as calling <code>tostring(translatef(...))</code>
--- @param key          Default translation text
--- @param ...          Format parameters
--- @return                     Translated and formatted string
 function stringf(key, ...)
        return tostring(translate(key)):format(...)
 end