/** * @file lltrans.cpp * @brief LLTrans implementation * * $LicenseInfo:firstyear=2000&license=viewerlgpl$ * Second Life Viewer Source Code * Copyright (C) 2010, Linden Research, Inc. * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; * version 2.1 of the License only. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * * Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA * $/LicenseInfo$ */ #include "linden_common.h" #include "lltrans.h" #include "llfasttimer.h" // for call count statistics #include "llxuiparser.h" #include "llsd.h" #include "llxmlnode.h" #include <map> LLTrans::template_map_t LLTrans::sStringTemplates; LLTrans::template_map_t LLTrans::sDefaultStringTemplates; LLStringUtil::format_map_t LLTrans::sDefaultArgs; struct StringDef : public LLInitParam::Block<StringDef> { Mandatory<std::string> name; Mandatory<std::string> value; StringDef() : name("name"), value("value") {} }; struct StringTable : public LLInitParam::Block<StringTable> { Multiple<StringDef> strings; StringTable() : strings("string") {} }; //static bool LLTrans::parseStrings(LLXMLNodePtr &root, const std::set<std::string>& default_args) { std::string xml_filename = "(strings file)"; if (!root->hasName("strings")) { LL_ERRS() << "Invalid root node name in " << xml_filename << ": was " << root->getName() << ", expected \"strings\"" << LL_ENDL; } StringTable string_table; LLXUIParser parser; parser.readXUI(root, string_table, xml_filename); if (!string_table.validateBlock()) { LL_ERRS() << "Problem reading strings: " << xml_filename << LL_ENDL; return false; } static bool default_strings_init = false; sStringTemplates.clear(); sDefaultArgs.clear(); for(LLInitParam::ParamIterator<StringDef>::const_iterator it = string_table.strings.begin(); it != string_table.strings.end(); ++it) { LLTransTemplate xml_template(it->name, it->value); sStringTemplates[xml_template.mName] = xml_template; if (!default_strings_init) { sDefaultStringTemplates[xml_template.mName] = xml_template; } std::set<std::string>::const_iterator iter = default_args.find(xml_template.mName); if (iter != default_args.end()) { std::string name = *iter; if (name[0] != '[') name = llformat("[%s]",name.c_str()); sDefaultArgs[name] = xml_template.mText; } } default_strings_init = true; return true; } //static bool LLTrans::parseLanguageStrings(LLXMLNodePtr &root) { std::string xml_filename = "(language strings file)"; if (!root->hasName("strings")) { LL_ERRS() << "Invalid root node name in " << xml_filename << ": was " << root->getName() << ", expected \"strings\"" << LL_ENDL; } StringTable string_table; LLXUIParser parser; parser.readXUI(root, string_table, xml_filename); if (!string_table.validateBlock()) { LL_ERRS() << "Problem reading strings: " << xml_filename << LL_ENDL; return false; } for(LLInitParam::ParamIterator<StringDef>::const_iterator it = string_table.strings.begin(); it != string_table.strings.end(); ++it) { // share the same map with parseStrings() so we can search the strings using the same getString() function.- angela LLTransTemplate xml_template(it->name, it->value); sStringTemplates[xml_template.mName] = xml_template; } return true; } static LLTrace::BlockTimerStatHandle FTM_GET_TRANS("Translate string"); //static std::string LLTrans::getString(const std::string &xml_desc, const LLStringUtil::format_map_t& msg_args, bool def_string) { // Don't care about time as much as call count. Make sure we're not // calling LLTrans::getString() in an inner loop. JC LL_PROFILE_ZONE_SCOPED_CATEGORY_UI; if (def_string) { return getDefString(xml_desc, msg_args); } template_map_t::iterator iter = sStringTemplates.find(xml_desc); if (iter != sStringTemplates.end()) { std::string text = iter->second.mText; LLStringUtil::format_map_t args = sDefaultArgs; args.insert(msg_args.begin(), msg_args.end()); LLStringUtil::format(text, args); return text; } else { LL_WARNS_ONCE("configuration") << "Missing String in strings.xml: [" << xml_desc << "]" << LL_ENDL; return "MissingString("+xml_desc+")"; } } //static std::string LLTrans::getDefString(const std::string &xml_desc, const LLStringUtil::format_map_t& msg_args) { template_map_t::iterator iter = sDefaultStringTemplates.find(xml_desc); if (iter != sDefaultStringTemplates.end()) { std::string text = iter->second.mText; LLStringUtil::format_map_t args = sDefaultArgs; args.insert(msg_args.begin(), msg_args.end()); LLStringUtil::format(text, args); return text; } else { LL_WARNS_ONCE("configuration") << "Missing String in strings.xml: [" << xml_desc << "]" << LL_ENDL; return "MissingString(" + xml_desc + ")"; } } //static std::string LLTrans::getString(const std::string &xml_desc, const LLSD& msg_args, bool def_string) { // Don't care about time as much as call count. Make sure we're not // calling LLTrans::getString() in an inner loop. JC LL_PROFILE_ZONE_SCOPED_CATEGORY_UI; if (def_string) { return getDefString(xml_desc, msg_args); } template_map_t::iterator iter = sStringTemplates.find(xml_desc); if (iter != sStringTemplates.end()) { std::string text = iter->second.mText; LLStringUtil::format(text, msg_args); return text; } else { LL_WARNS_ONCE("configuration") << "Missing String in strings.xml: [" << xml_desc << "]" << LL_ENDL; return "MissingString("+xml_desc+")"; } } //static std::string LLTrans::getDefString(const std::string &xml_desc, const LLSD& msg_args) { template_map_t::iterator iter = sDefaultStringTemplates.find(xml_desc); if (iter != sDefaultStringTemplates.end()) { std::string text = iter->second.mText; LLStringUtil::format(text, msg_args); return text; } else { LL_WARNS_ONCE("configuration") << "Missing String in strings.xml: [" << xml_desc << "]" << LL_ENDL; return "MissingString(" + xml_desc + ")"; } } //static bool LLTrans::findString(std::string &result, const std::string &xml_desc, const LLStringUtil::format_map_t& msg_args) { LL_PROFILE_ZONE_SCOPED_CATEGORY_UI; template_map_t::iterator iter = sStringTemplates.find(xml_desc); if (iter != sStringTemplates.end()) { std::string text = iter->second.mText; LLStringUtil::format_map_t args = sDefaultArgs; args.insert(msg_args.begin(), msg_args.end()); LLStringUtil::format(text, args); result = text; return true; } else { LL_WARNS_ONCE("configuration") << "Missing String in strings.xml: [" << xml_desc << "]" << LL_ENDL; return false; } } //static bool LLTrans::findString(std::string &result, const std::string &xml_desc, const LLSD& msg_args) { LL_PROFILE_ZONE_SCOPED_CATEGORY_UI; template_map_t::iterator iter = sStringTemplates.find(xml_desc); if (iter != sStringTemplates.end()) { std::string text = iter->second.mText; LLStringUtil::format(text, msg_args); result = text; return true; } else { LL_WARNS_ONCE("configuration") << "Missing String in strings.xml: [" << xml_desc << "]" << LL_ENDL; return false; } } //static std::string LLTrans::getCountString(const std::string& language, const std::string& xml_desc, S32 count) { // Compute which string identifier to use const char* form = ""; if (language == "ru") // Russian { // From GNU ngettext() // Plural-Forms: nplurals=3; plural=n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2; if (count % 10 == 1 && count % 100 != 11) { // singular, "1 item" form = "A"; } else if (count % 10 >= 2 && count % 10 <= 4 && (count % 100 < 10 || count % 100 >= 20) ) { // special case "2 items", "23 items", but not "13 items" form = "B"; } else { // English-style plural, "5 items" form = "C"; } } else if (language == "fr" || language == "pt") // French, Brazilian Portuguese { // French and Portuguese treat zero as a singular "0 item" not "0 items" if (count == 0 || count == 1) { form = "A"; } else { // English-style plural form = "B"; } } else // default { // languages like English with 2 forms, singular and plural if (count == 1) { // "1 item" form = "A"; } else { // "2 items", also use plural for "0 items" form = "B"; } } // Translate that string LLStringUtil::format_map_t args; args["[COUNT]"] = llformat("%d", count); // Look up "AgeYearsB" or "AgeWeeksC" including the "form" std::string key = llformat("%s%s", xml_desc.c_str(), form); return getString(key, args); } void LLTrans::setDefaultArg(const std::string& name, const std::string& value) { sDefaultArgs[name] = value; }