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