luci-0.11: merge outstanding trunk changes

[project/luci.git] / libs / web / luasrc / i18n.lua

diff --git a/libs/web/luasrc/i18n.lua b/libs/web/luasrc/i18n.lua
index 546429933b050067fd39138da53bb6b26e720328..545a8aed939bfd13880b4adaeeb921a28660f73a 100644 (file)
--- a/libs/web/luasrc/i18n.lua
+++ b/libs/web/luasrc/i18n.lua
@@ -12,9 +12,9 @@ Copyright 2008 Steven Barth <steven@midlink.org>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
-You may obtain a copy of the License at 
+You may obtain a copy of the License at
 
-       http://www.apache.org/licenses/LICENSE-2.0 
+       http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
@@ -24,46 +24,81 @@ limitations under the License.
 
 ]]--
 
+--- LuCI translation library.
 module("luci.i18n", package.seeall)
-require("luci.sys")
+require("luci.util")
+
+local tparser = require "luci.template.parser"
 
 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
-function load(file, force)
-       if force or not loaded[file] then
-               local f = loadfile(i18ndir..file..".lua") or loadfile(i18ndir..file)
-               if f then
-                       setfenv(f, table)
-                       f()
-                       loaded[file] = true
-                       return true
-               else
-                       return false
+--- 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])_"))
+       if not tparser.load_catalog(context.lang, i18ndir) then
+               if context.parent then
+                       tparser.load_catalog(context.parent, i18ndir)
+                       return context.parent
                end
-       else
-               return true
        end
+       return context.lang
 end
 
--- Same as load but autocompletes the filename with .LANG from config.lang
-function loadc(file, force)
-       return load(file .. "." .. require("luci.config").main.lang, force)
+--- 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
 
--- Returns the i18n-value defined by "key" or if there is no such: "default"
-function translate(key, default)
-       return table[key] or default
+--- 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
 
--- Translate shourtcut with sprintf/string.format inclusion
-function translatef(key, default, ...)
-       return translate(key, default):format(...)
-end
\ No newline at end of file
+--- 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