src/Main/locale.cxx

   1 // locale.cxx -- FlightGear Localization Support
   2 //
   3 // Written by Thorsten Brehm, started April 2012.
   4 //
   5 // Copyright (C) 2012 Thorsten Brehm - brehmt (at) gmail com
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA.
  20
  21 #ifdef HAVE_WINDOWS_H
  22 #include <windows.h>
  23 #endif
  24
  25 #include <simgear/props/props_io.hxx>
  26 #include <simgear/structure/exception.hxx>
  27
  28 #include "fg_props.hxx"
  29 #include "locale.hxx"
  30
  31 using std::vector;
  32 using std::string;
  33
  34 FGLocale::FGLocale(SGPropertyNode* root) :
  35     _intl(root->getNode("/sim/intl",0, true)),
  36     _defaultLocale(_intl->getChild("locale",0, true))
  37 {
  38 }
  39
  40 FGLocale::~FGLocale()
  41 {
  42 }
  43
  44 #ifdef _WIN32
  45 /**
  46  * Determine locale/language settings on Windows.
  47  *
  48  * Copyright (C) 1997, 2002, 2003 Martin von Loewis
  49  *
  50  * Permission to use, copy, modify, and distribute this software and its
  51  * documentation for any purpose and without fee is hereby granted,
  52  * provided that the above copyright notice appear in all copies.
  53  *
  54  * This software comes with no warranty. Use at your own risk.
  55  */
  56 const char*
  57 FGLocale::getUserLanguage()
  58 {
  59     static char locale[100] = {0};
  60
  61     if (GetLocaleInfo(LOCALE_USER_DEFAULT,
  62                       LOCALE_SISO639LANGNAME,
  63                       locale, sizeof(locale)))
  64     {
  65         SG_LOG(SG_GENERAL, SG_DEBUG, "Detected locale's language setting: " << locale);
  66         size_t i = strlen(locale);
  67         locale[i++] = '_';
  68         if (GetLocaleInfo(LOCALE_USER_DEFAULT,
  69                           LOCALE_SISO3166CTRYNAME,
  70                           locale+i, (int)(sizeof(locale)-i)))
  71             return locale;
  72
  73         locale[--i] = 0;
  74         SG_LOG(SG_GENERAL, SG_WARN, "Failed to detected locale's country setting.");
  75         return locale;
  76     }
  77
  78     return NULL;
  79 }
  80 #else
  81 /**
  82  * Determine locale/language settings on Linux (and Mac?).
  83  */
  84 const char*
  85 FGLocale::getUserLanguage()
  86 {
  87     return ::getenv("LANG");
  88 }
  89 #endif
  90
  91 // Search property tree for matching locale description
  92 SGPropertyNode*
  93 FGLocale::findLocaleNode(const string& language)
  94 {
  95     SGPropertyNode* node = NULL;
  96
  97     // remove character encoding from the locale spec, i.e. "de_DE.utf8" => "de_DE"
  98     size_t pos = language.find(".");
  99     if ((pos != string::npos)&&(pos>0))
 100     {
 101         node = findLocaleNode(language.substr(0, pos));
 102         if (node)
 103             return node;
 104     }
 105
 106     SG_LOG(SG_GENERAL, SG_DEBUG, "Searching language resource for locale: " << language);
 107     // search locale using full string
 108     vector<SGPropertyNode_ptr> localeList = _intl->getChildren("locale");
 109
 110     for (size_t i = 0; i < localeList.size(); i++)
 111     {
 112        vector<SGPropertyNode_ptr> langList = localeList[i]->getChildren("lang");
 113
 114        for (size_t j = 0; j < langList.size(); j++)
 115        {
 116            if (!language.compare(langList[j]->getStringValue()))
 117            {
 118                SG_LOG(SG_GENERAL, SG_INFO, "Found language resource for: " << language);
 119                return localeList[i];
 120            }
 121        }
 122     }
 123
 124     // try country's default resource, i.e. "de_DE" => "de"
 125     pos = language.find("_");
 126     if ((pos != string::npos)&&(pos>0))
 127     {
 128         node = findLocaleNode(language.substr(0, pos));
 129         if (node)
 130             return node;
 131     }
 132
 133     return NULL;
 134 }
 135
 136 // Select the language. When no language is given (NULL),
 137 // a default is determined matching the system locale.
 138 bool
 139 FGLocale::selectLanguage(const char *language)
 140 {
 141     // Use system setting when no language is given.
 142     if ((language == NULL)||(language[0]==0))
 143     {
 144         language = getUserLanguage();
 145         SG_LOG(SG_GENERAL, SG_INFO, "System language: " << ((language) ? language : "<unavailable>"));
 146     }
 147
 148     // Use plain C locale if nothing is available.
 149     if ((language == NULL)||(language[0]==0))
 150     {
 151         SG_LOG(SG_GENERAL, SG_WARN, "Unable to detect system language" );
 152         language = "C";
 153     }
 154
 155     SGPropertyNode *locale = findLocaleNode(language);
 156     if (!locale)
 157     {
 158        SG_LOG(SG_GENERAL, SG_ALERT,
 159               "No internationalization settings specified in preferences.xml" );
 160        return false;
 161     }
 162
 163     _currentLocale = locale;
 164     return true;
 165 }
 166
 167 // Load strings for requested resource and locale.
 168 // Result is stored below "strings" in the property tree of the given locale.
 169 bool
 170 FGLocale::loadResource(SGPropertyNode* localeNode, const char* resource)
 171 {
 172     SGPath path( globals->get_fg_root() );
 173
 174     SGPropertyNode* stringNode = localeNode->getNode("strings", 0, true);
 175
 176     const char *path_str = stringNode->getStringValue(resource, NULL);
 177     if (!path_str)
 178     {
 179         SG_LOG(SG_GENERAL, SG_WARN, "No path in " << stringNode->getPath() << "/" << resource << ".");
 180         return NULL;
 181     }
 182
 183     path.append(path_str);
 184     SG_LOG(SG_GENERAL, SG_INFO, "Reading localized strings for '" <<
 185            localeNode->getStringValue("lang", "<none>")
 186            <<"' from " << path.str());
 187
 188     // load the actual file
 189     try
 190     {
 191         readProperties(path.str(), stringNode->getNode(resource, 0, true));
 192     } catch (const sg_exception &e)
 193     {
 194         SG_LOG(SG_GENERAL, SG_ALERT, "Unable to read the localized strings from " << path.str() <<
 195                ". Error: " << e.getFormattedMessage());
 196         return false;
 197     }
 198
 199    return true;
 200 }
 201
 202 // Load strings for requested resource (for current and default locale).
 203 // Result is stored below "strings" in the property tree of the locales.
 204 bool
 205 FGLocale::loadResource(const char* resource)
 206 {
 207     // load defaults first
 208     bool Ok = loadResource(_defaultLocale, resource);
 209
 210     // also load language specific resource, unless identical
 211     if ((_currentLocale!=0)&&
 212         (_defaultLocale != _currentLocale))
 213     {
 214         Ok &= loadResource(_currentLocale, resource);
 215     }
 216
 217     return Ok;
 218 }
 219
 220 const char*
 221 FGLocale::getLocalizedString(SGPropertyNode *localeNode, const char* id, const char* context)
 222 {
 223     SGPropertyNode *n = localeNode->getNode("strings",0, true)->getNode(context);
 224     if (n)
 225         return n->getStringValue(id, NULL);
 226     return NULL;
 227 }
 228
 229 const char*
 230 FGLocale::getLocalizedString(const char* id, const char* resource, const char* Default)
 231 {
 232     if (id && resource)
 233     {
 234         const char* s = NULL;
 235         if (_currentLocale)
 236             s = getLocalizedString(_currentLocale, id, resource);
 237         if (s && s[0]!=0)
 238             return s;
 239
 240         if (_defaultLocale)
 241             s = getLocalizedString(_defaultLocale, id, resource);
 242         if (s && s[0]!=0)
 243             return s;
 244     }
 245     return Default;
 246 }
 247
 248 simgear::PropertyList
 249 FGLocale::getLocalizedStrings(SGPropertyNode *localeNode, const char* id, const char* context)
 250 {
 251     SGPropertyNode *n = localeNode->getNode("strings",0, true)->getNode(context);
 252     if (n)
 253     {
 254         return n->getChildren(id);
 255     }
 256     return simgear::PropertyList();
 257 }
 258
 259 simgear::PropertyList
 260 FGLocale::getLocalizedStrings(const char* id, const char* resource)
 261 {
 262     if (id && resource)
 263     {
 264         if (_currentLocale)
 265         {
 266             simgear::PropertyList s = getLocalizedStrings(_currentLocale, id, resource);
 267             if (s.size())
 268                 return s;
 269         }
 270
 271         if (_defaultLocale)
 272         {
 273             simgear::PropertyList s = getLocalizedStrings(_defaultLocale, id, resource);
 274             if (s.size())
 275                 return s;
 276         }
 277     }
 278     return simgear::PropertyList();
 279 }
 280
 281 // Check for localized font
 282 const char*
 283 FGLocale::getDefaultFont(const char* fallbackFont)
 284 {
 285     const char* font = NULL;
 286     if (_currentLocale)
 287     {
 288         font = _currentLocale->getStringValue("font", "");
 289         if (font[0] != 0)
 290             return font;
 291     }
 292     if (_defaultLocale)
 293     {
 294         font = _defaultLocale->getStringValue("font", "");
 295         if (font[0] != 0)
 296             return font;
 297     }
 298
 299     return fallbackFont;
 300 }
 301
 302 // Simple UTF8 to Latin1 encoder.
 303 void FGLocale::utf8toLatin1(string& s)
 304 {
 305     size_t pos = 0;
 306
 307     // map '0xc3..' utf8 characters to Latin1
 308     while ((string::npos != (pos = s.find('\xc3',pos)))&&
 309            (pos+1 < s.size()))
 310     {
 311         char c='*';
 312         unsigned char p = s[pos+1];
 313         if ((p>=0x80)&&(p<0xc0))
 314             c = 0x40 + p;
 315         char v[2];
 316         v[0]=c;
 317         v[1]=0;
 318         s.replace(pos, 2, v);
 319         pos++;
 320     }
 321
 322 #ifdef DEBUG_ENCODING
 323     printf("'%s': ", s.c_str());
 324     for (pos = 0;pos<s.size();pos++)
 325         printf("%02x ", (unsigned char) s[pos]);
 326     printf("\n");
 327 #endif
 328
 329     // hack: also map some Latin2 characters to plain-text ASCII
 330     pos = 0;
 331     while ((string::npos != (pos = s.find('\xc5',pos)))&&
 332            (pos+1 < s.size()))
 333     {
 334         char c='*';
 335         unsigned char p = s[pos+1];
 336         switch(p)
 337         {
 338             case 0x82:c='l';break;
 339             case 0x9a:c='S';break;
 340             case 0x9b:c='s';break;
 341             case 0xba:c='z';break;
 342             case 0xbc:c='z';break;
 343         }
 344         char v[2];
 345         v[0]=c;
 346         v[1]=0;
 347         s.replace(pos, 2, v);
 348         pos++;
 349     }
 350 }