include/wx/intl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/intl.h
   3 // Purpose:     Internationalization and localisation for wxWidgets
   4 // Author:      Vadim Zeitlin
   5 // Modified by: Michael N. Filippov <michael@idisys.iae.nsk.su>
   6 //              (2003/09/30 - plural forms support)
   7 // Created:     29/01/98
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
  10 // Licence:     wxWindows licence
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 #ifndef _WX_INTL_H_
  14 #define _WX_INTL_H_
  15
  16 #include "wx/defs.h"
  17 #include "wx/string.h"
  18
  19 // Make wxLayoutDirection enum available without need for wxUSE_INTL so wxWindow, wxApp
  20 // and other classes are not distrubed by wxUSE_INTL
  21
  22 enum wxLayoutDirection
  23 {
  24     wxLayout_Default,
  25     wxLayout_LeftToRight,
  26     wxLayout_RightToLeft
  27 };
  28
  29 #if wxUSE_INTL
  30
  31 #include "wx/fontenc.h"
  32
  33 // ============================================================================
  34 // global decls
  35 // ============================================================================
  36
  37 // ----------------------------------------------------------------------------
  38 // macros
  39 // ----------------------------------------------------------------------------
  40
  41 // gettext() style macros (notice that xgettext should be invoked with
  42 // --keyword="_" --keyword="wxPLURAL:1,2" options
  43 // to extract the strings from the sources)
  44 #ifndef WXINTL_NO_GETTEXT_MACRO
  45     #define _(s)                     wxGetTranslation((s))
  46     #define wxPLURAL(sing, plur, n)  wxGetTranslation((sing), (plur), n)
  47 #endif
  48
  49 // another one which just marks the strings for extraction, but doesn't
  50 // perform the translation (use -kwxTRANSLATE with xgettext!)
  51 #define wxTRANSLATE(str) str
  52
  53 // ----------------------------------------------------------------------------
  54 // forward decls
  55 // ----------------------------------------------------------------------------
  56
  57 class WXDLLIMPEXP_FWD_BASE wxLocale;
  58 class WXDLLIMPEXP_FWD_BASE wxLanguageInfoArray;
  59 class wxMsgCatalog;
  60
  61 // ============================================================================
  62 // locale support
  63 // ============================================================================
  64
  65 // ----------------------------------------------------------------------------
  66 // wxLanguage: defines all supported languages
  67 // ----------------------------------------------------------------------------
  68
  69 // --- --- --- generated code begins here --- --- ---
  70
  71 // This enum is generated by misc/languages/genlang.py
  72 // When making changes, please put them into misc/languages/langtabl.txt
  73 enum wxLanguage
  74 {
  75     // user's default/preffered language as got from OS:
  76     wxLANGUAGE_DEFAULT,
  77     // unknown language, if wxLocale::GetSystemLanguage fails:
  78     wxLANGUAGE_UNKNOWN,
  79
  80     wxLANGUAGE_ABKHAZIAN,
  81     wxLANGUAGE_AFAR,
  82     wxLANGUAGE_AFRIKAANS,
  83     wxLANGUAGE_ALBANIAN,
  84     wxLANGUAGE_AMHARIC,
  85     wxLANGUAGE_ARABIC,
  86     wxLANGUAGE_ARABIC_ALGERIA,
  87     wxLANGUAGE_ARABIC_BAHRAIN,
  88     wxLANGUAGE_ARABIC_EGYPT,
  89     wxLANGUAGE_ARABIC_IRAQ,
  90     wxLANGUAGE_ARABIC_JORDAN,
  91     wxLANGUAGE_ARABIC_KUWAIT,
  92     wxLANGUAGE_ARABIC_LEBANON,
  93     wxLANGUAGE_ARABIC_LIBYA,
  94     wxLANGUAGE_ARABIC_MOROCCO,
  95     wxLANGUAGE_ARABIC_OMAN,
  96     wxLANGUAGE_ARABIC_QATAR,
  97     wxLANGUAGE_ARABIC_SAUDI_ARABIA,
  98     wxLANGUAGE_ARABIC_SUDAN,
  99     wxLANGUAGE_ARABIC_SYRIA,
 100     wxLANGUAGE_ARABIC_TUNISIA,
 101     wxLANGUAGE_ARABIC_UAE,
 102     wxLANGUAGE_ARABIC_YEMEN,
 103     wxLANGUAGE_ARMENIAN,
 104     wxLANGUAGE_ASSAMESE,
 105     wxLANGUAGE_AYMARA,
 106     wxLANGUAGE_AZERI,
 107     wxLANGUAGE_AZERI_CYRILLIC,
 108     wxLANGUAGE_AZERI_LATIN,
 109     wxLANGUAGE_BASHKIR,
 110     wxLANGUAGE_BASQUE,
 111     wxLANGUAGE_BELARUSIAN,
 112     wxLANGUAGE_BENGALI,
 113     wxLANGUAGE_BHUTANI,
 114     wxLANGUAGE_BIHARI,
 115     wxLANGUAGE_BISLAMA,
 116     wxLANGUAGE_BRETON,
 117     wxLANGUAGE_BULGARIAN,
 118     wxLANGUAGE_BURMESE,
 119     wxLANGUAGE_CAMBODIAN,
 120     wxLANGUAGE_CATALAN,
 121     wxLANGUAGE_CHINESE,
 122     wxLANGUAGE_CHINESE_SIMPLIFIED,
 123     wxLANGUAGE_CHINESE_TRADITIONAL,
 124     wxLANGUAGE_CHINESE_HONGKONG,
 125     wxLANGUAGE_CHINESE_MACAU,
 126     wxLANGUAGE_CHINESE_SINGAPORE,
 127     wxLANGUAGE_CHINESE_TAIWAN,
 128     wxLANGUAGE_CORSICAN,
 129     wxLANGUAGE_CROATIAN,
 130     wxLANGUAGE_CZECH,
 131     wxLANGUAGE_DANISH,
 132     wxLANGUAGE_DUTCH,
 133     wxLANGUAGE_DUTCH_BELGIAN,
 134     wxLANGUAGE_ENGLISH,
 135     wxLANGUAGE_ENGLISH_UK,
 136     wxLANGUAGE_ENGLISH_US,
 137     wxLANGUAGE_ENGLISH_AUSTRALIA,
 138     wxLANGUAGE_ENGLISH_BELIZE,
 139     wxLANGUAGE_ENGLISH_BOTSWANA,
 140     wxLANGUAGE_ENGLISH_CANADA,
 141     wxLANGUAGE_ENGLISH_CARIBBEAN,
 142     wxLANGUAGE_ENGLISH_DENMARK,
 143     wxLANGUAGE_ENGLISH_EIRE,
 144     wxLANGUAGE_ENGLISH_JAMAICA,
 145     wxLANGUAGE_ENGLISH_NEW_ZEALAND,
 146     wxLANGUAGE_ENGLISH_PHILIPPINES,
 147     wxLANGUAGE_ENGLISH_SOUTH_AFRICA,
 148     wxLANGUAGE_ENGLISH_TRINIDAD,
 149     wxLANGUAGE_ENGLISH_ZIMBABWE,
 150     wxLANGUAGE_ESPERANTO,
 151     wxLANGUAGE_ESTONIAN,
 152     wxLANGUAGE_FAEROESE,
 153     wxLANGUAGE_FARSI,
 154     wxLANGUAGE_FIJI,
 155     wxLANGUAGE_FINNISH,
 156     wxLANGUAGE_FRENCH,
 157     wxLANGUAGE_FRENCH_BELGIAN,
 158     wxLANGUAGE_FRENCH_CANADIAN,
 159     wxLANGUAGE_FRENCH_LUXEMBOURG,
 160     wxLANGUAGE_FRENCH_MONACO,
 161     wxLANGUAGE_FRENCH_SWISS,
 162     wxLANGUAGE_FRISIAN,
 163     wxLANGUAGE_GALICIAN,
 164     wxLANGUAGE_GEORGIAN,
 165     wxLANGUAGE_GERMAN,
 166     wxLANGUAGE_GERMAN_AUSTRIAN,
 167     wxLANGUAGE_GERMAN_BELGIUM,
 168     wxLANGUAGE_GERMAN_LIECHTENSTEIN,
 169     wxLANGUAGE_GERMAN_LUXEMBOURG,
 170     wxLANGUAGE_GERMAN_SWISS,
 171     wxLANGUAGE_GREEK,
 172     wxLANGUAGE_GREENLANDIC,
 173     wxLANGUAGE_GUARANI,
 174     wxLANGUAGE_GUJARATI,
 175     wxLANGUAGE_HAUSA,
 176     wxLANGUAGE_HEBREW,
 177     wxLANGUAGE_HINDI,
 178     wxLANGUAGE_HUNGARIAN,
 179     wxLANGUAGE_ICELANDIC,
 180     wxLANGUAGE_INDONESIAN,
 181     wxLANGUAGE_INTERLINGUA,
 182     wxLANGUAGE_INTERLINGUE,
 183     wxLANGUAGE_INUKTITUT,
 184     wxLANGUAGE_INUPIAK,
 185     wxLANGUAGE_IRISH,
 186     wxLANGUAGE_ITALIAN,
 187     wxLANGUAGE_ITALIAN_SWISS,
 188     wxLANGUAGE_JAPANESE,
 189     wxLANGUAGE_JAVANESE,
 190     wxLANGUAGE_KANNADA,
 191     wxLANGUAGE_KASHMIRI,
 192     wxLANGUAGE_KASHMIRI_INDIA,
 193     wxLANGUAGE_KAZAKH,
 194     wxLANGUAGE_KERNEWEK,
 195     wxLANGUAGE_KINYARWANDA,
 196     wxLANGUAGE_KIRGHIZ,
 197     wxLANGUAGE_KIRUNDI,
 198     wxLANGUAGE_KONKANI,
 199     wxLANGUAGE_KOREAN,
 200     wxLANGUAGE_KURDISH,
 201     wxLANGUAGE_LAOTHIAN,
 202     wxLANGUAGE_LATIN,
 203     wxLANGUAGE_LATVIAN,
 204     wxLANGUAGE_LINGALA,
 205     wxLANGUAGE_LITHUANIAN,
 206     wxLANGUAGE_MACEDONIAN,
 207     wxLANGUAGE_MALAGASY,
 208     wxLANGUAGE_MALAY,
 209     wxLANGUAGE_MALAYALAM,
 210     wxLANGUAGE_MALAY_BRUNEI_DARUSSALAM,
 211     wxLANGUAGE_MALAY_MALAYSIA,
 212     wxLANGUAGE_MALTESE,
 213     wxLANGUAGE_MANIPURI,
 214     wxLANGUAGE_MAORI,
 215     wxLANGUAGE_MARATHI,
 216     wxLANGUAGE_MOLDAVIAN,
 217     wxLANGUAGE_MONGOLIAN,
 218     wxLANGUAGE_NAURU,
 219     wxLANGUAGE_NEPALI,
 220     wxLANGUAGE_NEPALI_INDIA,
 221     wxLANGUAGE_NORWEGIAN_BOKMAL,
 222     wxLANGUAGE_NORWEGIAN_NYNORSK,
 223     wxLANGUAGE_OCCITAN,
 224     wxLANGUAGE_ORIYA,
 225     wxLANGUAGE_OROMO,
 226     wxLANGUAGE_PASHTO,
 227     wxLANGUAGE_POLISH,
 228     wxLANGUAGE_PORTUGUESE,
 229     wxLANGUAGE_PORTUGUESE_BRAZILIAN,
 230     wxLANGUAGE_PUNJABI,
 231     wxLANGUAGE_QUECHUA,
 232     wxLANGUAGE_RHAETO_ROMANCE,
 233     wxLANGUAGE_ROMANIAN,
 234     wxLANGUAGE_RUSSIAN,
 235     wxLANGUAGE_RUSSIAN_UKRAINE,
 236     wxLANGUAGE_SAMOAN,
 237     wxLANGUAGE_SANGHO,
 238     wxLANGUAGE_SANSKRIT,
 239     wxLANGUAGE_SCOTS_GAELIC,
 240     wxLANGUAGE_SERBIAN,
 241     wxLANGUAGE_SERBIAN_CYRILLIC,
 242     wxLANGUAGE_SERBIAN_LATIN,
 243     wxLANGUAGE_SERBO_CROATIAN,
 244     wxLANGUAGE_SESOTHO,
 245     wxLANGUAGE_SETSWANA,
 246     wxLANGUAGE_SHONA,
 247     wxLANGUAGE_SINDHI,
 248     wxLANGUAGE_SINHALESE,
 249     wxLANGUAGE_SISWATI,
 250     wxLANGUAGE_SLOVAK,
 251     wxLANGUAGE_SLOVENIAN,
 252     wxLANGUAGE_SOMALI,
 253     wxLANGUAGE_SPANISH,
 254     wxLANGUAGE_SPANISH_ARGENTINA,
 255     wxLANGUAGE_SPANISH_BOLIVIA,
 256     wxLANGUAGE_SPANISH_CHILE,
 257     wxLANGUAGE_SPANISH_COLOMBIA,
 258     wxLANGUAGE_SPANISH_COSTA_RICA,
 259     wxLANGUAGE_SPANISH_DOMINICAN_REPUBLIC,
 260     wxLANGUAGE_SPANISH_ECUADOR,
 261     wxLANGUAGE_SPANISH_EL_SALVADOR,
 262     wxLANGUAGE_SPANISH_GUATEMALA,
 263     wxLANGUAGE_SPANISH_HONDURAS,
 264     wxLANGUAGE_SPANISH_MEXICAN,
 265     wxLANGUAGE_SPANISH_MODERN,
 266     wxLANGUAGE_SPANISH_NICARAGUA,
 267     wxLANGUAGE_SPANISH_PANAMA,
 268     wxLANGUAGE_SPANISH_PARAGUAY,
 269     wxLANGUAGE_SPANISH_PERU,
 270     wxLANGUAGE_SPANISH_PUERTO_RICO,
 271     wxLANGUAGE_SPANISH_URUGUAY,
 272     wxLANGUAGE_SPANISH_US,
 273     wxLANGUAGE_SPANISH_VENEZUELA,
 274     wxLANGUAGE_SUNDANESE,
 275     wxLANGUAGE_SWAHILI,
 276     wxLANGUAGE_SWEDISH,
 277     wxLANGUAGE_SWEDISH_FINLAND,
 278     wxLANGUAGE_TAGALOG,
 279     wxLANGUAGE_TAJIK,
 280     wxLANGUAGE_TAMIL,
 281     wxLANGUAGE_TATAR,
 282     wxLANGUAGE_TELUGU,
 283     wxLANGUAGE_THAI,
 284     wxLANGUAGE_TIBETAN,
 285     wxLANGUAGE_TIGRINYA,
 286     wxLANGUAGE_TONGA,
 287     wxLANGUAGE_TSONGA,
 288     wxLANGUAGE_TURKISH,
 289     wxLANGUAGE_TURKMEN,
 290     wxLANGUAGE_TWI,
 291     wxLANGUAGE_UIGHUR,
 292     wxLANGUAGE_UKRAINIAN,
 293     wxLANGUAGE_URDU,
 294     wxLANGUAGE_URDU_INDIA,
 295     wxLANGUAGE_URDU_PAKISTAN,
 296     wxLANGUAGE_UZBEK,
 297     wxLANGUAGE_UZBEK_CYRILLIC,
 298     wxLANGUAGE_UZBEK_LATIN,
 299     wxLANGUAGE_VIETNAMESE,
 300     wxLANGUAGE_VOLAPUK,
 301     wxLANGUAGE_WELSH,
 302     wxLANGUAGE_WOLOF,
 303     wxLANGUAGE_XHOSA,
 304     wxLANGUAGE_YIDDISH,
 305     wxLANGUAGE_YORUBA,
 306     wxLANGUAGE_ZHUANG,
 307     wxLANGUAGE_ZULU,
 308
 309     // for custom, user-defined languages:
 310     wxLANGUAGE_USER_DEFINED
 311 };
 312
 313 // --- --- --- generated code ends here --- --- ---
 314
 315 // ----------------------------------------------------------------------------
 316 // wxLanguageInfo: encapsulates wxLanguage to OS native lang.desc.
 317 //                 translation information
 318 // ----------------------------------------------------------------------------
 319
 320 struct WXDLLIMPEXP_BASE wxLanguageInfo
 321 {
 322     int Language;                   // wxLanguage id
 323     wxString CanonicalName;         // Canonical name, e.g. fr_FR
 324 #ifdef __WXMSW__
 325     wxUint32 WinLang,               // Win32 language identifiers
 326              WinSublang;
 327 #endif // __WXMSW__
 328     wxString Description;           // human-readable name of the language
 329     wxLayoutDirection LayoutDirection;
 330
 331 #ifdef __WXMSW__
 332     // return the LCID corresponding to this language
 333     wxUint32 GetLCID() const;
 334 #endif // __WXMSW__
 335
 336     // return the locale name corresponding to this language usable with
 337     // setlocale() on the current system
 338     wxString GetLocaleName() const;
 339 };
 340
 341 // for Unix systems GetLocaleName() is trivial so implement it inline here, for
 342 // MSW it's implemented in intl.cpp
 343 #ifndef __WXMSW__
 344 inline wxString wxLanguageInfo::GetLocaleName() const { return CanonicalName; }
 345 #endif // !__WXMSW__
 346
 347 // ----------------------------------------------------------------------------
 348 // wxLocaleCategory: the category of locale settings
 349 // ----------------------------------------------------------------------------
 350
 351 enum wxLocaleCategory
 352 {
 353     // (any) numbers
 354     wxLOCALE_CAT_NUMBER,
 355
 356     // date/time
 357     wxLOCALE_CAT_DATE,
 358
 359     // monetary value
 360     wxLOCALE_CAT_MONEY,
 361
 362     wxLOCALE_CAT_MAX
 363 };
 364
 365 // ----------------------------------------------------------------------------
 366 // wxLocaleInfo: the items understood by wxLocale::GetInfo()
 367 // ----------------------------------------------------------------------------
 368
 369 enum wxLocaleInfo
 370 {
 371     // the thounsands separator
 372     wxLOCALE_THOUSANDS_SEP,
 373
 374     // the character used as decimal point
 375     wxLOCALE_DECIMAL_POINT
 376
 377 };
 378
 379 // ----------------------------------------------------------------------------
 380 // wxLocale: encapsulates all language dependent settings, including current
 381 //           message catalogs, date, time and currency formats (TODO) &c
 382 // ----------------------------------------------------------------------------
 383
 384 enum wxLocaleInitFlags
 385 {
 386     wxLOCALE_LOAD_DEFAULT  = 0x0001,     // load wxwin.mo?
 387     wxLOCALE_CONV_ENCODING = 0x0002      // convert encoding on the fly?
 388 };
 389
 390 class WXDLLIMPEXP_BASE wxLocale
 391 {
 392 public:
 393     // ctor & dtor
 394     // -----------
 395
 396         // call Init() if you use this ctor
 397     wxLocale() { DoCommonInit(); }
 398
 399         // the ctor has a side effect of changing current locale
 400     wxLocale(const wxString& name,                               // name (for messages)
 401              const wxString& shortName = wxEmptyString,      // dir prefix (for msg files)
 402              const wxString& locale = wxEmptyString,     // locale (for setlocale)
 403              bool bLoadDefault = true,                           // preload wxstd.mo?
 404              bool bConvertEncoding = false)                      // convert Win<->Unix if necessary?
 405         {
 406             DoCommonInit();
 407
 408             Init(name, shortName, locale, bLoadDefault, bConvertEncoding);
 409         }
 410
 411     wxLocale(int language, // wxLanguage id or custom language
 412              int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING)
 413         {
 414             DoCommonInit();
 415
 416             Init(language, flags);
 417         }
 418
 419         // the same as a function (returns true on success)
 420     bool Init(const wxString& name,
 421               const wxString& shortName = wxEmptyString,
 422               const wxString& locale = wxEmptyString,
 423               bool bLoadDefault = true,
 424               bool bConvertEncoding = false);
 425
 426         // same as second ctor (returns true on success)
 427     bool Init(int language = wxLANGUAGE_DEFAULT,
 428               int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING);
 429
 430         // restores old locale
 431     virtual ~wxLocale();
 432
 433     // Try to get user's (or OS's) preferred language setting.
 434     // Return wxLANGUAGE_UNKNOWN if language-guessing algorithm failed
 435     static int GetSystemLanguage();
 436
 437     // get the encoding used by default for text on this system, returns
 438     // wxFONTENCODING_SYSTEM if it couldn't be determined
 439     static wxFontEncoding GetSystemEncoding();
 440
 441     // get the string describing the system encoding, return empty string if
 442     // couldn't be determined
 443     static wxString GetSystemEncodingName();
 444
 445     // get the values of the given locale-dependent datum: the current locale
 446     // is used, the US default value is returned if everything else fails
 447     static wxString GetInfo(wxLocaleInfo index, wxLocaleCategory cat);
 448
 449     // return true if the locale was set successfully
 450     bool IsOk() const { return m_pszOldLocale != NULL; }
 451
 452     // returns locale name
 453     const wxString& GetLocale() const { return m_strLocale; }
 454
 455     // return current locale wxLanguage value
 456     int GetLanguage() const { return m_language; }
 457
 458     // return locale name to be passed to setlocale()
 459     wxString GetSysName() const;
 460
 461     // return 'canonical' name, i.e. in the form of xx[_YY], where xx is
 462     // language code according to ISO 639 and YY is country name
 463     // as specified by ISO 3166.
 464     wxString GetCanonicalName() const { return m_strShort; }
 465
 466     // add a prefix to the catalog lookup path: the message catalog files will be
 467     // looked up under prefix/<lang>/LC_MESSAGES, prefix/LC_MESSAGES and prefix
 468     // (in this order).
 469     //
 470     // This only applies to subsequent invocations of AddCatalog()!
 471     static void AddCatalogLookupPathPrefix(const wxString& prefix);
 472
 473     // add a catalog: it's searched for in standard places (current directory
 474     // first, system one after), but the you may prepend additional directories to
 475     // the search path with AddCatalogLookupPathPrefix().
 476     //
 477     // The loaded catalog will be used for message lookup by GetString().
 478     //
 479     // Returns 'true' if it was successfully loaded
 480     bool AddCatalog(const wxString& domain);
 481     bool AddCatalog(const wxString& domain,
 482                     wxLanguage msgIdLanguage, const wxString& msgIdCharset);
 483
 484     // check if the given locale is provided by OS and C run time
 485     static bool IsAvailable(int lang);
 486
 487     // check if the given catalog is loaded
 488     bool IsLoaded(const wxString& domain) const;
 489
 490     // Retrieve the language info struct for the given language
 491     //
 492     // Returns NULL if no info found, pointer must *not* be deleted by caller
 493     static const wxLanguageInfo *GetLanguageInfo(int lang);
 494
 495     // Returns language name in English or empty string if the language
 496     // is not in database
 497     static wxString GetLanguageName(int lang);
 498
 499     // Find the language for the given locale string which may be either a
 500     // canonical ISO 2 letter language code ("xx"), a language code followed by
 501     // the country code ("xx_XX") or a Windows full language name ("Xxxxx...")
 502     //
 503     // Returns NULL if no info found, pointer must *not* be deleted by caller
 504     static const wxLanguageInfo *FindLanguageInfo(const wxString& locale);
 505
 506     // Add custom language to the list of known languages.
 507     // Notes: 1) wxLanguageInfo contains platform-specific data
 508     //        2) must be called before Init to have effect
 509     static void AddLanguage(const wxLanguageInfo& info);
 510
 511     // retrieve the translation for a string in all loaded domains unless
 512     // the szDomain parameter is specified (and then only this domain is
 513     // searched)
 514     // n - additional parameter for PluralFormsParser
 515     //
 516     // return original string if translation is not available
 517     // (in this case an error message is generated the first time
 518     //  a string is not found; use wxLogNull to suppress it)
 519     //
 520     // domains are searched in the last to first order, i.e. catalogs
 521     // added later override those added before.
 522     virtual const wxString& GetString(const wxString& origString,
 523                                       const wxString& domain = wxEmptyString) const;
 524     // plural form version of the same:
 525     virtual const wxString& GetString(const wxString& origString,
 526                                       const wxString& origString2,
 527                                       size_t n,
 528                                       const wxString& domain = wxEmptyString) const;
 529
 530     // this is hack to work around a problem with wxGetTranslation() which
 531     // returns const wxString& and not wxString, so when it returns untranslated
 532     // string, it needs to have a copy of it somewhere
 533     static const wxString& GetUntranslatedString(const wxString& str);
 534
 535     // Returns the current short name for the locale
 536     const wxString& GetName() const { return m_strShort; }
 537
 538     // return the contents of .po file header
 539     wxString GetHeaderValue(const wxString& header,
 540                             const wxString& domain = wxEmptyString) const;
 541
 542     // These two methods are for internal use only. First one creates
 543     // ms_languagesDB if it doesn't already exist, second one destroys
 544     // it.
 545     static void CreateLanguagesDB();
 546     static void DestroyLanguagesDB();
 547
 548 private:
 549     // find catalog by name in a linked list, return NULL if !found
 550     wxMsgCatalog *FindCatalog(const wxString& domain) const;
 551
 552     // copy default table of languages from global static array to
 553     // m_langugagesInfo, called by InitLanguagesDB
 554     static void InitLanguagesDB();
 555
 556     // initialize the member fields to default values
 557     void DoCommonInit();
 558
 559     wxString       m_strLocale,       // this locale name
 560                    m_strShort;        // short name for the locale
 561     int            m_language;        // this locale wxLanguage value
 562
 563     const char  *m_pszOldLocale;      // previous locale from setlocale()
 564     wxLocale      *m_pOldLocale;      // previous wxLocale
 565
 566     wxMsgCatalog  *m_pMsgCat;         // pointer to linked list of catalogs
 567
 568     bool           m_bConvertEncoding;
 569
 570     bool           m_initialized;
 571
 572     static wxLanguageInfoArray *ms_languagesDB;
 573
 574     DECLARE_NO_COPY_CLASS(wxLocale)
 575 };
 576
 577 // ----------------------------------------------------------------------------
 578 // global functions
 579 // ----------------------------------------------------------------------------
 580
 581 // get the current locale object (note that it may be NULL!)
 582 extern WXDLLIMPEXP_BASE wxLocale* wxGetLocale();
 583
 584 // get the translation of the string in the current locale
 585 inline const wxString& wxGetTranslation(const wxString& str,
 586                                         const wxString& domain = wxEmptyString)
 587 {
 588     wxLocale *pLoc = wxGetLocale();
 589     if (pLoc)
 590         return pLoc->GetString(str, domain);
 591     else
 592         // NB: this function returns reference to a string, so we have to keep
 593         //     a copy of it somewhere
 594         return wxLocale::GetUntranslatedString(str);
 595 }
 596 inline const wxString& wxGetTranslation(const wxString& str1,
 597                                         const wxString& str2,
 598                                         size_t n,
 599                                         const wxString& domain = wxEmptyString)
 600 {
 601     wxLocale *pLoc = wxGetLocale();
 602     if (pLoc)
 603         return pLoc->GetString(str1, str2, n, domain);
 604     else
 605         // NB: this function returns reference to a string, so we have to keep
 606         //     a copy of it somewhere
 607         return n == 1
 608                ? wxLocale::GetUntranslatedString(str1)
 609                : wxLocale::GetUntranslatedString(str2);
 610 }
 611
 612 #else // !wxUSE_INTL
 613
 614 // the macros should still be defined - otherwise compilation would fail
 615
 616 #if !defined(WXINTL_NO_GETTEXT_MACRO)
 617     #if !defined(_)
 618         #define _(s)                 (s)
 619     #endif
 620     #define wxPLURAL(sing, plur, n)  ((n) == 1 ? (sing) : (plur))
 621 #endif
 622
 623 #define wxTRANSLATE(str) str
 624
 625 // NB: we use a template here in order to avoid using
 626 //     wxLocale::GetUntranslatedString() above, which would be required if
 627 //     we returned const wxString&; this way, the compiler should be able to
 628 //     optimize wxGetTranslation() away
 629
 630 template<typename TString>
 631 inline TString wxGetTranslation(TString str)
 632     { return str; }
 633
 634 template<typename TString, typename TDomain>
 635 inline TString wxGetTranslation(TString str, TDomain WXUNUSED(domain))
 636     { return str; }
 637
 638 template<typename TString, typename TDomain>
 639 inline TString wxGetTranslation(TString str1, TString str2, size_t n)
 640     { return n == 1 ? str1 : str2; }
 641
 642 template<typename TString, typename TDomain>
 643 inline TString wxGetTranslation(TString str1, TString str2, size_t n,
 644                                 TDomain WXUNUSED(domain))
 645     { return n == 1 ? str1 : str2; }
 646
 647 #endif // wxUSE_INTL/!wxUSE_INTL
 648
 649 // define this one just in case it occurs somewhere (instead of preferred
 650 // wxTRANSLATE) too
 651 #if !defined(WXINTL_NO_GETTEXT_MACRO)
 652     #if !defined(gettext_noop)
 653         #define gettext_noop(str) (str)
 654     #endif
 655     #if !defined(N_)
 656         #define N_(s)             (s)
 657     #endif
 658 #endif
 659
 660 #endif // _WX_INTL_H_