1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Internationalization and localisation for wxWindows
4 // Author: Vadim Zeitlin
5 // Modified by: Michael N. Filippov <michael@idisys.iae.nsk.su>
6 // (2003/09/30 - plural forms support)
9 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
16 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
17 #pragma interface "intl.h"
21 #include "wx/string.h"
25 #include "wx/fontenc.h"
27 // ============================================================================
29 // ============================================================================
31 // ----------------------------------------------------------------------------
33 // ----------------------------------------------------------------------------
35 // gettext() style macros (notice that xgettext should be invoked with
36 // --keyword="_" --keyword="_N:1,2" --keyword="N_" options
37 // to extract the strings from the sources)
38 #ifndef WXINTL_NO_GETTEXT_MACRO
39 #define _(s) wxGetTranslation(_T(s))
40 #define _N(s1, s2, n) wxGetTranslation(_T(s1), _T(s2), n)
44 // another one which just marks the strings for extraction, but doesn't
45 // perform the translation (use -kwxTRANSLATE with xgettext!)
46 #define wxTRANSLATE(str) _T(str)
48 // ----------------------------------------------------------------------------
50 // ----------------------------------------------------------------------------
52 class WXDLLIMPEXP_BASE wxLocale
;
53 class WXDLLIMPEXP_BASE wxMsgCatalog
;
54 class WXDLLIMPEXP_BASE wxLanguageInfoArray
;
56 // ============================================================================
58 // ============================================================================
60 // ----------------------------------------------------------------------------
61 // wxLanguage: defines all supported languages
62 // ----------------------------------------------------------------------------
64 // --- --- --- generated code begins here --- --- ---
66 // This enum is generated by misc/languages/genlang.py
67 // When making changes, please put them into misc/languages/langtabl.txt
70 // user's default/preffered language as got from OS:
72 // unknown language, if wxLocale::GetSystemLanguage fails:
81 wxLANGUAGE_ARABIC_ALGERIA
,
82 wxLANGUAGE_ARABIC_BAHRAIN
,
83 wxLANGUAGE_ARABIC_EGYPT
,
84 wxLANGUAGE_ARABIC_IRAQ
,
85 wxLANGUAGE_ARABIC_JORDAN
,
86 wxLANGUAGE_ARABIC_KUWAIT
,
87 wxLANGUAGE_ARABIC_LEBANON
,
88 wxLANGUAGE_ARABIC_LIBYA
,
89 wxLANGUAGE_ARABIC_MOROCCO
,
90 wxLANGUAGE_ARABIC_OMAN
,
91 wxLANGUAGE_ARABIC_QATAR
,
92 wxLANGUAGE_ARABIC_SAUDI_ARABIA
,
93 wxLANGUAGE_ARABIC_SUDAN
,
94 wxLANGUAGE_ARABIC_SYRIA
,
95 wxLANGUAGE_ARABIC_TUNISIA
,
96 wxLANGUAGE_ARABIC_UAE
,
97 wxLANGUAGE_ARABIC_YEMEN
,
102 wxLANGUAGE_AZERI_CYRILLIC
,
103 wxLANGUAGE_AZERI_LATIN
,
106 wxLANGUAGE_BELARUSIAN
,
112 wxLANGUAGE_BULGARIAN
,
114 wxLANGUAGE_CAMBODIAN
,
117 wxLANGUAGE_CHINESE_SIMPLIFIED
,
118 wxLANGUAGE_CHINESE_TRADITIONAL
,
119 wxLANGUAGE_CHINESE_HONGKONG
,
120 wxLANGUAGE_CHINESE_MACAU
,
121 wxLANGUAGE_CHINESE_SINGAPORE
,
122 wxLANGUAGE_CHINESE_TAIWAN
,
128 wxLANGUAGE_DUTCH_BELGIAN
,
130 wxLANGUAGE_ENGLISH_UK
,
131 wxLANGUAGE_ENGLISH_US
,
132 wxLANGUAGE_ENGLISH_AUSTRALIA
,
133 wxLANGUAGE_ENGLISH_BELIZE
,
134 wxLANGUAGE_ENGLISH_BOTSWANA
,
135 wxLANGUAGE_ENGLISH_CANADA
,
136 wxLANGUAGE_ENGLISH_CARIBBEAN
,
137 wxLANGUAGE_ENGLISH_DENMARK
,
138 wxLANGUAGE_ENGLISH_EIRE
,
139 wxLANGUAGE_ENGLISH_JAMAICA
,
140 wxLANGUAGE_ENGLISH_NEW_ZEALAND
,
141 wxLANGUAGE_ENGLISH_PHILIPPINES
,
142 wxLANGUAGE_ENGLISH_SOUTH_AFRICA
,
143 wxLANGUAGE_ENGLISH_TRINIDAD
,
144 wxLANGUAGE_ENGLISH_ZIMBABWE
,
145 wxLANGUAGE_ESPERANTO
,
152 wxLANGUAGE_FRENCH_BELGIAN
,
153 wxLANGUAGE_FRENCH_CANADIAN
,
154 wxLANGUAGE_FRENCH_LUXEMBOURG
,
155 wxLANGUAGE_FRENCH_MONACO
,
156 wxLANGUAGE_FRENCH_SWISS
,
161 wxLANGUAGE_GERMAN_AUSTRIAN
,
162 wxLANGUAGE_GERMAN_BELGIUM
,
163 wxLANGUAGE_GERMAN_LIECHTENSTEIN
,
164 wxLANGUAGE_GERMAN_LUXEMBOURG
,
165 wxLANGUAGE_GERMAN_SWISS
,
167 wxLANGUAGE_GREENLANDIC
,
173 wxLANGUAGE_HUNGARIAN
,
174 wxLANGUAGE_ICELANDIC
,
175 wxLANGUAGE_INDONESIAN
,
176 wxLANGUAGE_INTERLINGUA
,
177 wxLANGUAGE_INTERLINGUE
,
178 wxLANGUAGE_INUKTITUT
,
182 wxLANGUAGE_ITALIAN_SWISS
,
187 wxLANGUAGE_KASHMIRI_INDIA
,
190 wxLANGUAGE_KINYARWANDA
,
200 wxLANGUAGE_LITHUANIAN
,
201 wxLANGUAGE_MACEDONIAN
,
204 wxLANGUAGE_MALAYALAM
,
205 wxLANGUAGE_MALAY_BRUNEI_DARUSSALAM
,
206 wxLANGUAGE_MALAY_MALAYSIA
,
211 wxLANGUAGE_MOLDAVIAN
,
212 wxLANGUAGE_MONGOLIAN
,
215 wxLANGUAGE_NEPALI_INDIA
,
216 wxLANGUAGE_NORWEGIAN_BOKMAL
,
217 wxLANGUAGE_NORWEGIAN_NYNORSK
,
223 wxLANGUAGE_PORTUGUESE
,
224 wxLANGUAGE_PORTUGUESE_BRAZILIAN
,
227 wxLANGUAGE_RHAETO_ROMANCE
,
230 wxLANGUAGE_RUSSIAN_UKRAINE
,
234 wxLANGUAGE_SCOTS_GAELIC
,
236 wxLANGUAGE_SERBIAN_CYRILLIC
,
237 wxLANGUAGE_SERBIAN_LATIN
,
238 wxLANGUAGE_SERBO_CROATIAN
,
243 wxLANGUAGE_SINHALESE
,
246 wxLANGUAGE_SLOVENIAN
,
249 wxLANGUAGE_SPANISH_ARGENTINA
,
250 wxLANGUAGE_SPANISH_BOLIVIA
,
251 wxLANGUAGE_SPANISH_CHILE
,
252 wxLANGUAGE_SPANISH_COLOMBIA
,
253 wxLANGUAGE_SPANISH_COSTA_RICA
,
254 wxLANGUAGE_SPANISH_DOMINICAN_REPUBLIC
,
255 wxLANGUAGE_SPANISH_ECUADOR
,
256 wxLANGUAGE_SPANISH_EL_SALVADOR
,
257 wxLANGUAGE_SPANISH_GUATEMALA
,
258 wxLANGUAGE_SPANISH_HONDURAS
,
259 wxLANGUAGE_SPANISH_MEXICAN
,
260 wxLANGUAGE_SPANISH_MODERN
,
261 wxLANGUAGE_SPANISH_NICARAGUA
,
262 wxLANGUAGE_SPANISH_PANAMA
,
263 wxLANGUAGE_SPANISH_PARAGUAY
,
264 wxLANGUAGE_SPANISH_PERU
,
265 wxLANGUAGE_SPANISH_PUERTO_RICO
,
266 wxLANGUAGE_SPANISH_URUGUAY
,
267 wxLANGUAGE_SPANISH_US
,
268 wxLANGUAGE_SPANISH_VENEZUELA
,
269 wxLANGUAGE_SUNDANESE
,
272 wxLANGUAGE_SWEDISH_FINLAND
,
287 wxLANGUAGE_UKRAINIAN
,
289 wxLANGUAGE_URDU_INDIA
,
290 wxLANGUAGE_URDU_PAKISTAN
,
292 wxLANGUAGE_UZBEK_CYRILLIC
,
293 wxLANGUAGE_UZBEK_LATIN
,
294 wxLANGUAGE_VIETNAMESE
,
304 // for custom, user-defined languages:
305 wxLANGUAGE_USER_DEFINED
308 // --- --- --- generated code ends here --- --- ---
310 // ----------------------------------------------------------------------------
311 // wxLanguageInfo: encapsulates wxLanguage to OS native lang.desc.
312 // translation information
313 // ----------------------------------------------------------------------------
315 struct WXDLLIMPEXP_BASE wxLanguageInfo
317 int Language
; // wxLanguage id
318 wxString CanonicalName
; // Canonical name, e.g. fr_FR
320 wxUint32 WinLang
, // Win32 language identifiers
323 wxString Description
; // human-readable name of the language
326 // ----------------------------------------------------------------------------
327 // wxLocaleCategory: the category of locale settings
328 // ----------------------------------------------------------------------------
330 enum wxLocaleCategory
344 // ----------------------------------------------------------------------------
345 // wxLocaleInfo: the items understood by wxLocale::GetInfo()
346 // ----------------------------------------------------------------------------
350 // the thounsands separator
351 wxLOCALE_THOUSANDS_SEP
,
353 // the character used as decimal point
354 wxLOCALE_DECIMAL_POINT
358 // ----------------------------------------------------------------------------
359 // wxLocale: encapsulates all language dependent settings, including current
360 // message catalogs, date, time and currency formats (TODO) &c
361 // ----------------------------------------------------------------------------
363 enum wxLocaleInitFlags
365 wxLOCALE_LOAD_DEFAULT
= 0x0001, // load wxwin.mo?
366 wxLOCALE_CONV_ENCODING
= 0x0002 // convert encoding on the fly?
369 class WXDLLIMPEXP_BASE wxLocale
375 // call Init() if you use this ctor
377 // the ctor has a side effect of changing current locale
378 wxLocale(const wxChar
*szName
, // name (for messages)
379 const wxChar
*szShort
= (const wxChar
*) NULL
, // dir prefix (for msg files)
380 const wxChar
*szLocale
= (const wxChar
*) NULL
, // locale (for setlocale)
381 bool bLoadDefault
= TRUE
, // preload wxstd.mo?
382 bool bConvertEncoding
= FALSE
) // convert Win<->Unix if neccessary?
384 Init(szName
, szShort
, szLocale
, bLoadDefault
, bConvertEncoding
);
387 wxLocale(int language
, // wxLanguage id or custom language
388 int flags
= wxLOCALE_LOAD_DEFAULT
| wxLOCALE_CONV_ENCODING
)
389 { Init(language
, flags
); }
391 // the same as a function (returns TRUE on success)
392 bool Init(const wxChar
*szName
,
393 const wxChar
*szShort
= (const wxChar
*) NULL
,
394 const wxChar
*szLocale
= (const wxChar
*) NULL
,
395 bool bLoadDefault
= TRUE
,
396 bool bConvertEncoding
= FALSE
);
398 // same as second ctor (returns TRUE on success)
399 bool Init(int language
= wxLANGUAGE_DEFAULT
,
400 int flags
= wxLOCALE_LOAD_DEFAULT
| wxLOCALE_CONV_ENCODING
);
402 // restores old locale
405 // Try to get user's (or OS's) prefered language setting.
406 // Return wxLANGUAGE_UNKNOWN if language-guessing algorithm failed
407 static int GetSystemLanguage();
409 // get the encoding used by default for text on this system, returns
410 // wxFONTENCODING_SYSTEM if it couldn't be determined
411 static wxFontEncoding
GetSystemEncoding();
413 // get the string describing the system encoding, return empty string if
414 // couldn't be determined
415 static wxString
GetSystemEncodingName();
417 // get the values of the given locale-dependent datum: the current locale
418 // is used, the US default value is returned if everything else fails
419 static wxString
GetInfo(wxLocaleInfo index
, wxLocaleCategory cat
);
421 // return TRUE if the locale was set successfully
422 bool IsOk() const { return m_pszOldLocale
!= NULL
; }
424 // returns locale name
425 const wxChar
*GetLocale() const { return m_strLocale
; }
427 // return current locale wxLanguage value
428 int GetLanguage() const { return m_language
; }
430 // return locale name to be passed to setlocale()
431 wxString
GetSysName() const;
433 // return 'canonical' name, i.e. in the form of xx[_YY], where xx is
434 // language code according to ISO 639 and YY is country name
435 // as specified by ISO 3166.
436 wxString
GetCanonicalName() const { return m_strShort
; }
438 // add a prefix to the catalog lookup path: the message catalog files will be
439 // looked up under prefix/<lang>/LC_MESSAGES, prefix/LC_MESSAGES and prefix
442 // This only applies to subsequent invocations of AddCatalog()!
443 static void AddCatalogLookupPathPrefix(const wxString
& prefix
);
445 // add a catalog: it's searched for in standard places (current directory
446 // first, system one after), but the you may prepend additional directories to
447 // the search path with AddCatalogLookupPathPrefix().
449 // The loaded catalog will be used for message lookup by GetString().
451 // Returns 'true' if it was successfully loaded
452 bool AddCatalog(const wxChar
*szDomain
);
454 // check if the given catalog is loaded
455 bool IsLoaded(const wxChar
*szDomain
) const;
457 // Retrieve the language info struct for the given language
459 // Returns NULL if no info found, pointer must *not* be deleted by caller
460 static const wxLanguageInfo
*GetLanguageInfo(int lang
);
462 // Returns language name in English or empty string if the language
463 // is not in database
464 static wxString
GetLanguageName(int lang
);
466 // Find the language for the given locale string which may be either a
467 // canonical ISO 2 letter language code ("xx"), a language code followed by
468 // the country code ("xx_XX") or a Windows full language name ("Xxxxx...")
470 // Returns NULL if no info found, pointer must *not* be deleted by caller
471 static const wxLanguageInfo
*FindLanguageInfo(const wxString
& locale
);
473 // Add custom language to the list of known languages.
474 // Notes: 1) wxLanguageInfo contains platform-specific data
475 // 2) must be called before Init to have effect
476 static void AddLanguage(const wxLanguageInfo
& info
);
478 // retrieve the translation for a string in all loaded domains unless
479 // the szDomain parameter is specified (and then only this domain is
481 // n - additional parameter for PluralFormsParser
483 // return original string if translation is not available
484 // (in this case an error message is generated the first time
485 // a string is not found; use wxLogNull to suppress it)
487 // domains are searched in the last to first order, i.e. catalogs
488 // added later override those added before.
489 const wxChar
*GetString(const wxChar
*szOrigString
,
490 const wxChar
*szDomain
= (const wxChar
*) NULL
) const;
491 // plural form version of the same:
492 const wxChar
*GetString(const wxChar
*szOrigString
,
493 const wxChar
*szOrigString2
,
495 const wxChar
*szDomain
= (const wxChar
*) NULL
) const;
497 // Returns the current short name for the locale
498 const wxString
& GetName() const { return m_strShort
; }
500 // These two methods are for internal use only. First one creates
501 // ms_languagesDB if it doesn't already exist, second one destroys
503 static void CreateLanguagesDB();
504 static void DestroyLanguagesDB();
507 // find catalog by name in a linked list, return NULL if !found
508 wxMsgCatalog
*FindCatalog(const wxChar
*szDomain
) const;
510 // copy default table of languages from global static array to
511 // m_langugagesInfo, called by InitLanguagesDB
512 static void InitLanguagesDB();
514 wxString m_strLocale
, // this locale name
515 m_strShort
; // short name for the locale
516 int m_language
; // this locale wxLanguage value
518 const wxChar
*m_pszOldLocale
; // previous locale from setlocale()
519 wxLocale
*m_pOldLocale
; // previous wxLocale
521 wxMsgCatalog
*m_pMsgCat
; // pointer to linked list of catalogs
523 bool m_bConvertEncoding
;
525 static wxLanguageInfoArray
*ms_languagesDB
;
527 DECLARE_NO_COPY_CLASS(wxLocale
)
530 // ----------------------------------------------------------------------------
532 // ----------------------------------------------------------------------------
534 // get the current locale object (note that it may be NULL!)
535 extern WXDLLIMPEXP_BASE wxLocale
* wxGetLocale();
537 // get the translation of the string in the current locale
538 inline const wxChar
*wxGetTranslation(const wxChar
*sz
)
540 wxLocale
*pLoc
= wxGetLocale();
542 return pLoc
->GetString(sz
);
546 inline const wxChar
*wxGetTranslation(const wxChar
*sz1
, const wxChar
*sz2
,
549 wxLocale
*pLoc
= wxGetLocale();
551 return pLoc
->GetString(sz1
, sz2
, n
);
553 return n
== 1 ? sz1
: sz2
;
558 // the macros should still be defined - otherwise compilation would fail
560 #if !defined(WXINTL_NO_GETTEXT_MACRO) && !defined(_)
562 #define _N(s1, s2, n) ((n) == 1 ? _T(s1) : _T(s2))
566 #define wxTRANSLATE(str) _T(str)
568 // Note: use of 'inline' here can cause this symbol not to be found when compiled with gcc
569 //const wxChar *wxGetTranslation(const wxChar *sz);
570 #define wxGetTranslation(sz) (sz)
572 #endif // wxUSE_INTL/!wxUSE_INTL
574 // define this one just in case it occurs somewhere (instead of preferred
576 #if !defined(WXINTL_NO_GETTEXT_MACRO) && !defined(gettext_noop)
577 #define gettext_noop(str) _T(str)
580 #endif // _WX_INTL_H_