1 /////////////////////////////////////////////////////////////////////////////
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)
9 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
17 #include "wx/string.h"
21 #include "wx/fontenc.h"
23 // ============================================================================
25 // ============================================================================
27 // ----------------------------------------------------------------------------
29 // ----------------------------------------------------------------------------
31 // gettext() style macros (notice that xgettext should be invoked with
32 // --keyword="_" --keyword="wxPLURAL:1,2" options
33 // to extract the strings from the sources)
34 #ifndef WXINTL_NO_GETTEXT_MACRO
35 #define _(s) wxGetTranslation(_T(s))
36 #define wxPLURAL(sing, plur, n) wxGetTranslation(_T(sing), _T(plur), n)
39 // another one which just marks the strings for extraction, but doesn't
40 // perform the translation (use -kwxTRANSLATE with xgettext!)
41 #define wxTRANSLATE(str) _T(str)
43 // ----------------------------------------------------------------------------
45 // ----------------------------------------------------------------------------
47 class WXDLLIMPEXP_BASE wxLocale
;
48 class WXDLLIMPEXP_BASE wxLanguageInfoArray
;
51 // ============================================================================
53 // ============================================================================
55 // ----------------------------------------------------------------------------
56 // wxLanguage: defines all supported languages
57 // ----------------------------------------------------------------------------
59 // --- --- --- generated code begins here --- --- ---
61 // This enum is generated by misc/languages/genlang.py
62 // When making changes, please put them into misc/languages/langtabl.txt
65 // user's default/preffered language as got from OS:
67 // unknown language, if wxLocale::GetSystemLanguage fails:
76 wxLANGUAGE_ARABIC_ALGERIA
,
77 wxLANGUAGE_ARABIC_BAHRAIN
,
78 wxLANGUAGE_ARABIC_EGYPT
,
79 wxLANGUAGE_ARABIC_IRAQ
,
80 wxLANGUAGE_ARABIC_JORDAN
,
81 wxLANGUAGE_ARABIC_KUWAIT
,
82 wxLANGUAGE_ARABIC_LEBANON
,
83 wxLANGUAGE_ARABIC_LIBYA
,
84 wxLANGUAGE_ARABIC_MOROCCO
,
85 wxLANGUAGE_ARABIC_OMAN
,
86 wxLANGUAGE_ARABIC_QATAR
,
87 wxLANGUAGE_ARABIC_SAUDI_ARABIA
,
88 wxLANGUAGE_ARABIC_SUDAN
,
89 wxLANGUAGE_ARABIC_SYRIA
,
90 wxLANGUAGE_ARABIC_TUNISIA
,
91 wxLANGUAGE_ARABIC_UAE
,
92 wxLANGUAGE_ARABIC_YEMEN
,
97 wxLANGUAGE_AZERI_CYRILLIC
,
98 wxLANGUAGE_AZERI_LATIN
,
101 wxLANGUAGE_BELARUSIAN
,
107 wxLANGUAGE_BULGARIAN
,
109 wxLANGUAGE_CAMBODIAN
,
112 wxLANGUAGE_CHINESE_SIMPLIFIED
,
113 wxLANGUAGE_CHINESE_TRADITIONAL
,
114 wxLANGUAGE_CHINESE_HONGKONG
,
115 wxLANGUAGE_CHINESE_MACAU
,
116 wxLANGUAGE_CHINESE_SINGAPORE
,
117 wxLANGUAGE_CHINESE_TAIWAN
,
123 wxLANGUAGE_DUTCH_BELGIAN
,
125 wxLANGUAGE_ENGLISH_UK
,
126 wxLANGUAGE_ENGLISH_US
,
127 wxLANGUAGE_ENGLISH_AUSTRALIA
,
128 wxLANGUAGE_ENGLISH_BELIZE
,
129 wxLANGUAGE_ENGLISH_BOTSWANA
,
130 wxLANGUAGE_ENGLISH_CANADA
,
131 wxLANGUAGE_ENGLISH_CARIBBEAN
,
132 wxLANGUAGE_ENGLISH_DENMARK
,
133 wxLANGUAGE_ENGLISH_EIRE
,
134 wxLANGUAGE_ENGLISH_JAMAICA
,
135 wxLANGUAGE_ENGLISH_NEW_ZEALAND
,
136 wxLANGUAGE_ENGLISH_PHILIPPINES
,
137 wxLANGUAGE_ENGLISH_SOUTH_AFRICA
,
138 wxLANGUAGE_ENGLISH_TRINIDAD
,
139 wxLANGUAGE_ENGLISH_ZIMBABWE
,
140 wxLANGUAGE_ESPERANTO
,
147 wxLANGUAGE_FRENCH_BELGIAN
,
148 wxLANGUAGE_FRENCH_CANADIAN
,
149 wxLANGUAGE_FRENCH_LUXEMBOURG
,
150 wxLANGUAGE_FRENCH_MONACO
,
151 wxLANGUAGE_FRENCH_SWISS
,
156 wxLANGUAGE_GERMAN_AUSTRIAN
,
157 wxLANGUAGE_GERMAN_BELGIUM
,
158 wxLANGUAGE_GERMAN_LIECHTENSTEIN
,
159 wxLANGUAGE_GERMAN_LUXEMBOURG
,
160 wxLANGUAGE_GERMAN_SWISS
,
162 wxLANGUAGE_GREENLANDIC
,
168 wxLANGUAGE_HUNGARIAN
,
169 wxLANGUAGE_ICELANDIC
,
170 wxLANGUAGE_INDONESIAN
,
171 wxLANGUAGE_INTERLINGUA
,
172 wxLANGUAGE_INTERLINGUE
,
173 wxLANGUAGE_INUKTITUT
,
177 wxLANGUAGE_ITALIAN_SWISS
,
182 wxLANGUAGE_KASHMIRI_INDIA
,
185 wxLANGUAGE_KINYARWANDA
,
195 wxLANGUAGE_LITHUANIAN
,
196 wxLANGUAGE_MACEDONIAN
,
199 wxLANGUAGE_MALAYALAM
,
200 wxLANGUAGE_MALAY_BRUNEI_DARUSSALAM
,
201 wxLANGUAGE_MALAY_MALAYSIA
,
206 wxLANGUAGE_MOLDAVIAN
,
207 wxLANGUAGE_MONGOLIAN
,
210 wxLANGUAGE_NEPALI_INDIA
,
211 wxLANGUAGE_NORWEGIAN_BOKMAL
,
212 wxLANGUAGE_NORWEGIAN_NYNORSK
,
218 wxLANGUAGE_PORTUGUESE
,
219 wxLANGUAGE_PORTUGUESE_BRAZILIAN
,
222 wxLANGUAGE_RHAETO_ROMANCE
,
225 wxLANGUAGE_RUSSIAN_UKRAINE
,
229 wxLANGUAGE_SCOTS_GAELIC
,
231 wxLANGUAGE_SERBIAN_CYRILLIC
,
232 wxLANGUAGE_SERBIAN_LATIN
,
233 wxLANGUAGE_SERBO_CROATIAN
,
238 wxLANGUAGE_SINHALESE
,
241 wxLANGUAGE_SLOVENIAN
,
244 wxLANGUAGE_SPANISH_ARGENTINA
,
245 wxLANGUAGE_SPANISH_BOLIVIA
,
246 wxLANGUAGE_SPANISH_CHILE
,
247 wxLANGUAGE_SPANISH_COLOMBIA
,
248 wxLANGUAGE_SPANISH_COSTA_RICA
,
249 wxLANGUAGE_SPANISH_DOMINICAN_REPUBLIC
,
250 wxLANGUAGE_SPANISH_ECUADOR
,
251 wxLANGUAGE_SPANISH_EL_SALVADOR
,
252 wxLANGUAGE_SPANISH_GUATEMALA
,
253 wxLANGUAGE_SPANISH_HONDURAS
,
254 wxLANGUAGE_SPANISH_MEXICAN
,
255 wxLANGUAGE_SPANISH_MODERN
,
256 wxLANGUAGE_SPANISH_NICARAGUA
,
257 wxLANGUAGE_SPANISH_PANAMA
,
258 wxLANGUAGE_SPANISH_PARAGUAY
,
259 wxLANGUAGE_SPANISH_PERU
,
260 wxLANGUAGE_SPANISH_PUERTO_RICO
,
261 wxLANGUAGE_SPANISH_URUGUAY
,
262 wxLANGUAGE_SPANISH_US
,
263 wxLANGUAGE_SPANISH_VENEZUELA
,
264 wxLANGUAGE_SUNDANESE
,
267 wxLANGUAGE_SWEDISH_FINLAND
,
282 wxLANGUAGE_UKRAINIAN
,
284 wxLANGUAGE_URDU_INDIA
,
285 wxLANGUAGE_URDU_PAKISTAN
,
287 wxLANGUAGE_UZBEK_CYRILLIC
,
288 wxLANGUAGE_UZBEK_LATIN
,
289 wxLANGUAGE_VIETNAMESE
,
299 // for custom, user-defined languages:
300 wxLANGUAGE_USER_DEFINED
303 // --- --- --- generated code ends here --- --- ---
305 // ----------------------------------------------------------------------------
306 // wxLanguageInfo: encapsulates wxLanguage to OS native lang.desc.
307 // translation information
308 // ----------------------------------------------------------------------------
310 struct WXDLLIMPEXP_BASE wxLanguageInfo
312 int Language
; // wxLanguage id
313 wxString CanonicalName
; // Canonical name, e.g. fr_FR
315 wxUint32 WinLang
, // Win32 language identifiers
318 wxString Description
; // human-readable name of the language
321 // ----------------------------------------------------------------------------
322 // wxLocaleCategory: the category of locale settings
323 // ----------------------------------------------------------------------------
325 enum wxLocaleCategory
339 // ----------------------------------------------------------------------------
340 // wxLocaleInfo: the items understood by wxLocale::GetInfo()
341 // ----------------------------------------------------------------------------
345 // the thounsands separator
346 wxLOCALE_THOUSANDS_SEP
,
348 // the character used as decimal point
349 wxLOCALE_DECIMAL_POINT
353 // ----------------------------------------------------------------------------
354 // wxLocale: encapsulates all language dependent settings, including current
355 // message catalogs, date, time and currency formats (TODO) &c
356 // ----------------------------------------------------------------------------
358 enum wxLocaleInitFlags
360 wxLOCALE_LOAD_DEFAULT
= 0x0001, // load wxwin.mo?
361 wxLOCALE_CONV_ENCODING
= 0x0002 // convert encoding on the fly?
364 class WXDLLIMPEXP_BASE wxLocale
370 // call Init() if you use this ctor
371 wxLocale() { DoCommonInit(); }
373 // the ctor has a side effect of changing current locale
374 wxLocale(const wxChar
*szName
, // name (for messages)
375 const wxChar
*szShort
= (const wxChar
*) NULL
, // dir prefix (for msg files)
376 const wxChar
*szLocale
= (const wxChar
*) NULL
, // locale (for setlocale)
377 bool bLoadDefault
= true, // preload wxstd.mo?
378 bool bConvertEncoding
= false) // convert Win<->Unix if necessary?
382 Init(szName
, szShort
, szLocale
, bLoadDefault
, bConvertEncoding
);
385 wxLocale(int language
, // wxLanguage id or custom language
386 int flags
= wxLOCALE_LOAD_DEFAULT
| wxLOCALE_CONV_ENCODING
)
390 Init(language
, flags
);
393 // the same as a function (returns true on success)
394 bool Init(const wxChar
*szName
,
395 const wxChar
*szShort
= (const wxChar
*) NULL
,
396 const wxChar
*szLocale
= (const wxChar
*) NULL
,
397 bool bLoadDefault
= true,
398 bool bConvertEncoding
= false);
400 // same as second ctor (returns true on success)
401 bool Init(int language
= wxLANGUAGE_DEFAULT
,
402 int flags
= wxLOCALE_LOAD_DEFAULT
| wxLOCALE_CONV_ENCODING
);
404 // restores old locale
407 // Try to get user's (or OS's) preferred language setting.
408 // Return wxLANGUAGE_UNKNOWN if language-guessing algorithm failed
409 static int GetSystemLanguage();
411 // get the encoding used by default for text on this system, returns
412 // wxFONTENCODING_SYSTEM if it couldn't be determined
413 static wxFontEncoding
GetSystemEncoding();
415 // get the string describing the system encoding, return empty string if
416 // couldn't be determined
417 static wxString
GetSystemEncodingName();
419 // get the values of the given locale-dependent datum: the current locale
420 // is used, the US default value is returned if everything else fails
421 static wxString
GetInfo(wxLocaleInfo index
, wxLocaleCategory cat
);
423 // return true if the locale was set successfully
424 bool IsOk() const { return m_pszOldLocale
!= NULL
; }
426 // returns locale name
427 const wxChar
*GetLocale() const { return m_strLocale
; }
429 // return current locale wxLanguage value
430 int GetLanguage() const { return m_language
; }
432 // return locale name to be passed to setlocale()
433 wxString
GetSysName() const;
435 // return 'canonical' name, i.e. in the form of xx[_YY], where xx is
436 // language code according to ISO 639 and YY is country name
437 // as specified by ISO 3166.
438 wxString
GetCanonicalName() const { return m_strShort
; }
440 // add a prefix to the catalog lookup path: the message catalog files will be
441 // looked up under prefix/<lang>/LC_MESSAGES, prefix/LC_MESSAGES and prefix
444 // This only applies to subsequent invocations of AddCatalog()!
445 static void AddCatalogLookupPathPrefix(const wxString
& prefix
);
447 // add a catalog: it's searched for in standard places (current directory
448 // first, system one after), but the you may prepend additional directories to
449 // the search path with AddCatalogLookupPathPrefix().
451 // The loaded catalog will be used for message lookup by GetString().
453 // Returns 'true' if it was successfully loaded
454 bool AddCatalog(const wxChar
*szDomain
);
455 bool AddCatalog(const wxChar
*szDomain
,
456 wxLanguage msgIdLanguage
, const wxChar
*msgIdCharset
);
458 // check if the given catalog is loaded
459 bool IsLoaded(const wxChar
*szDomain
) const;
461 // Retrieve the language info struct for the given language
463 // Returns NULL if no info found, pointer must *not* be deleted by caller
464 static const wxLanguageInfo
*GetLanguageInfo(int lang
);
466 // Returns language name in English or empty string if the language
467 // is not in database
468 static wxString
GetLanguageName(int lang
);
470 // Find the language for the given locale string which may be either a
471 // canonical ISO 2 letter language code ("xx"), a language code followed by
472 // the country code ("xx_XX") or a Windows full language name ("Xxxxx...")
474 // Returns NULL if no info found, pointer must *not* be deleted by caller
475 static const wxLanguageInfo
*FindLanguageInfo(const wxString
& locale
);
477 // Add custom language to the list of known languages.
478 // Notes: 1) wxLanguageInfo contains platform-specific data
479 // 2) must be called before Init to have effect
480 static void AddLanguage(const wxLanguageInfo
& info
);
482 // retrieve the translation for a string in all loaded domains unless
483 // the szDomain parameter is specified (and then only this domain is
485 // n - additional parameter for PluralFormsParser
487 // return original string if translation is not available
488 // (in this case an error message is generated the first time
489 // a string is not found; use wxLogNull to suppress it)
491 // domains are searched in the last to first order, i.e. catalogs
492 // added later override those added before.
493 virtual const wxChar
*GetString(const wxChar
*szOrigString
,
494 const wxChar
*szDomain
= NULL
) const;
495 // plural form version of the same:
496 virtual const wxChar
*GetString(const wxChar
*szOrigString
,
497 const wxChar
*szOrigString2
,
499 const wxChar
*szDomain
= NULL
) const;
501 // Returns the current short name for the locale
502 const wxString
& GetName() const { return m_strShort
; }
504 // return the contents of .po file header
505 wxString
GetHeaderValue( const wxChar
* szHeader
,
506 const wxChar
* szDomain
= NULL
) const;
508 // These two methods are for internal use only. First one creates
509 // ms_languagesDB if it doesn't already exist, second one destroys
511 static void CreateLanguagesDB();
512 static void DestroyLanguagesDB();
515 // find catalog by name in a linked list, return NULL if !found
516 wxMsgCatalog
*FindCatalog(const wxChar
*szDomain
) const;
518 // copy default table of languages from global static array to
519 // m_langugagesInfo, called by InitLanguagesDB
520 static void InitLanguagesDB();
522 // initialize the member fields to default values
525 wxString m_strLocale
, // this locale name
526 m_strShort
; // short name for the locale
527 int m_language
; // this locale wxLanguage value
529 const wxChar
*m_pszOldLocale
; // previous locale from setlocale()
530 wxLocale
*m_pOldLocale
; // previous wxLocale
532 wxMsgCatalog
*m_pMsgCat
; // pointer to linked list of catalogs
534 bool m_bConvertEncoding
;
538 static wxLanguageInfoArray
*ms_languagesDB
;
540 DECLARE_NO_COPY_CLASS(wxLocale
)
543 // ----------------------------------------------------------------------------
545 // ----------------------------------------------------------------------------
547 // get the current locale object (note that it may be NULL!)
548 extern WXDLLIMPEXP_BASE wxLocale
* wxGetLocale();
550 // get the translation of the string in the current locale
551 inline const wxChar
*wxGetTranslation(const wxChar
*sz
, const wxChar
* domain
=NULL
)
553 wxLocale
*pLoc
= wxGetLocale();
555 return pLoc
->GetString(sz
, domain
);
559 inline const wxChar
*wxGetTranslation(const wxChar
*sz1
, const wxChar
*sz2
,
560 size_t n
, const wxChar
* domain
=NULL
)
562 wxLocale
*pLoc
= wxGetLocale();
564 return pLoc
->GetString(sz1
, sz2
, n
, domain
);
566 return n
== 1 ? sz1
: sz2
;
571 // the macros should still be defined - otherwise compilation would fail
573 #if !defined(WXINTL_NO_GETTEXT_MACRO)
579 #define wxTRANSLATE(str) _T(str)
581 // Note: use of 'inline' here can cause this symbol not to be found when compiled with gcc
582 //const wxChar *wxGetTranslation(const wxChar *sz);
583 #define wxGetTranslation(sz) (sz)
585 #endif // wxUSE_INTL/!wxUSE_INTL
587 // define this one just in case it occurs somewhere (instead of preferred
589 #if !defined(WXINTL_NO_GETTEXT_MACRO)
590 #if !defined(gettext_noop)
591 #define gettext_noop(str) _T(str)
598 #endif // _WX_INTL_H_