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