X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ec37df5776f89de888cdef2ac1445896d283590a..09d8cc190df922a72d7dc9f9fdc3a51c037a3ca2:/include/wx/intl.h diff --git a/include/wx/intl.h b/include/wx/intl.h index a4468a948c..87c60ae32f 100644 --- a/include/wx/intl.h +++ b/include/wx/intl.h @@ -1,18 +1,19 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: intl.h -// Purpose: Internationalization and localisation for wxWindows +// Name: wx/intl.h +// Purpose: Internationalization and localisation for wxWidgets // Author: Vadim Zeitlin -// Modified by: +// Modified by: Michael N. Filippov +// (2003/09/30 - plural forms support) // Created: 29/01/98 // RCS-ID: $Id$ // Copyright: (c) 1998 Vadim Zeitlin -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifndef __INTLH__ -#define __INTLH__ +#ifndef _WX_INTL_H_ +#define _WX_INTL_H_ -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "intl.h" #endif @@ -21,6 +22,8 @@ #if wxUSE_INTL +#include "wx/fontenc.h" + // ============================================================================ // global decls // ============================================================================ @@ -29,10 +32,11 @@ // macros // ---------------------------------------------------------------------------- -// gettext() style macro (notice that xgettext should be invoked with "-k_" -// option to extract the strings inside _() from the sources) +// gettext() style macros (notice that xgettext should be invoked with +// --keyword="_" --keyword="wxGetTranslation:1,2" options +// to extract the strings from the sources) #ifndef WXINTL_NO_GETTEXT_MACRO - #define _(str) wxGetTranslation(_T(str)) + #define _(s) wxGetTranslation(_T(s)) #endif // another one which just marks the strings for extraction, but doesn't @@ -43,9 +47,9 @@ // forward decls // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxLocale; -class WXDLLEXPORT wxMsgCatalog; -class WXDLLEXPORT wxLanguageInfoArray; +class WXDLLIMPEXP_BASE wxLocale; +class WXDLLIMPEXP_BASE wxLanguageInfoArray; +class wxMsgCatalog; // ============================================================================ // locale support @@ -55,17 +59,17 @@ class WXDLLEXPORT wxLanguageInfoArray; // wxLanguage: defines all supported languages // ---------------------------------------------------------------------------- +// --- --- --- generated code begins here --- --- --- // This enum is generated by misc/languages/genlang.py // When making changes, please put them into misc/languages/langtabl.txt enum wxLanguage { // user's default/preffered language as got from OS: - wxLANGUAGE_DEFAULT, - + wxLANGUAGE_DEFAULT, // unknown language, if wxLocale::GetSystemLanguage fails: - wxLANGUAGE_UNKNOWN, - + wxLANGUAGE_UNKNOWN, + wxLANGUAGE_ABKHAZIAN, wxLANGUAGE_AFAR, wxLANGUAGE_AFRIKAANS, @@ -299,21 +303,56 @@ enum wxLanguage wxLANGUAGE_USER_DEFINED }; +// --- --- --- generated code ends here --- --- --- + // ---------------------------------------------------------------------------- // wxLanguageInfo: encapsulates wxLanguage to OS native lang.desc. // translation information // ---------------------------------------------------------------------------- -struct WXDLLEXPORT wxLanguageInfo +struct WXDLLIMPEXP_BASE wxLanguageInfo { int Language; // wxLanguage id wxString CanonicalName; // Canonical name, e.g. fr_FR #ifdef __WIN32__ - wxUint32 WinLang, WinSublang; // Win32 language identifiers -#endif + wxUint32 WinLang, // Win32 language identifiers + WinSublang; +#endif // __WIN32__ wxString Description; // human-readable name of the language }; +// ---------------------------------------------------------------------------- +// wxLocaleCategory: the category of locale settings +// ---------------------------------------------------------------------------- + +enum wxLocaleCategory +{ + // (any) numbers + wxLOCALE_CAT_NUMBER, + + // date/time + wxLOCALE_CAT_DATE, + + // monetary value + wxLOCALE_CAT_MONEY, + + wxLOCALE_CAT_MAX +}; + +// ---------------------------------------------------------------------------- +// wxLocaleInfo: the items understood by wxLocale::GetInfo() +// ---------------------------------------------------------------------------- + +enum wxLocaleInfo +{ + // the thounsands separator + wxLOCALE_THOUSANDS_SEP, + + // the character used as decimal point + wxLOCALE_DECIMAL_POINT + +}; + // ---------------------------------------------------------------------------- // wxLocale: encapsulates all language dependent settings, including current // message catalogs, date, time and currency formats (TODO) &c @@ -325,65 +364,82 @@ enum wxLocaleInitFlags wxLOCALE_CONV_ENCODING = 0x0002 // convert encoding on the fly? }; - -class WXDLLEXPORT wxLocale +class WXDLLIMPEXP_BASE wxLocale { public: // ctor & dtor // ----------- // call Init() if you use this ctor - wxLocale(); + wxLocale() { DoCommonInit(); } + // the ctor has a side effect of changing current locale wxLocale(const wxChar *szName, // name (for messages) const wxChar *szShort = (const wxChar *) NULL, // dir prefix (for msg files) const wxChar *szLocale = (const wxChar *) NULL, // locale (for setlocale) - bool bLoadDefault = TRUE, // preload wxstd.mo? - bool bConvertEncoding = FALSE) // convert Win<->Unix if neccessary? - { - m_languagesDB = NULL; - Init(szName, szShort, szLocale, bLoadDefault, bConvertEncoding); + bool bLoadDefault = true, // preload wxstd.mo? + bool bConvertEncoding = false) // convert Win<->Unix if neccessary? + { + DoCommonInit(); + + Init(szName, szShort, szLocale, bLoadDefault, bConvertEncoding); } wxLocale(int language, // wxLanguage id or custom language int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING) - { Init(language, flags); } + { + DoCommonInit(); + + Init(language, flags); + } - // the same as a function (returns TRUE on success) + // the same as a function (returns true on success) bool Init(const wxChar *szName, const wxChar *szShort = (const wxChar *) NULL, const wxChar *szLocale = (const wxChar *) NULL, - bool bLoadDefault = TRUE, - bool bConvertEncoding = FALSE); + bool bLoadDefault = true, + bool bConvertEncoding = false); - // same as second ctor (returns TRUE on success) + // same as second ctor (returns true on success) bool Init(int language = wxLANGUAGE_DEFAULT, int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING); // restores old locale ~wxLocale(); - + // Try to get user's (or OS's) prefered language setting. // Return wxLANGUAGE_UNKNOWN if language-guessing algorithm failed - int GetSystemLanguage() const; + static int GetSystemLanguage(); + + // get the encoding used by default for text on this system, returns + // wxFONTENCODING_SYSTEM if it couldn't be determined + static wxFontEncoding GetSystemEncoding(); + + // get the string describing the system encoding, return empty string if + // couldn't be determined + static wxString GetSystemEncodingName(); + + // get the values of the given locale-dependent datum: the current locale + // is used, the US default value is returned if everything else fails + static wxString GetInfo(wxLocaleInfo index, wxLocaleCategory cat); - // return TRUE if the locale was set successfully + // return true if the locale was set successfully bool IsOk() const { return m_pszOldLocale != NULL; } // returns locale name const wxChar *GetLocale() const { return m_strLocale; } - + // return current locale wxLanguage value int GetLanguage() const { return m_language; } - // return locale name to be passed to setlocale() + // return locale name to be passed to setlocale() wxString GetSysName() const; - // return 'canonical' name, i.e. in the form of xx[_YY], where xx is + // return 'canonical' name, i.e. in the form of xx[_YY], where xx is // language code according to ISO 639 and YY is country name // as specified by ISO 3166. wxString GetCanonicalName() const { return m_strShort; } - + // add a prefix to the catalog lookup path: the message catalog files will be // looked up under prefix//LC_MESSAGES, prefix/LC_MESSAGES and prefix // (in this order). @@ -399,18 +455,37 @@ public: // // Returns 'true' if it was successfully loaded bool AddCatalog(const wxChar *szDomain); + bool AddCatalog(const wxChar *szDomain, + wxLanguage msgIdLanguage, const wxChar *msgIdCharset); // check if the given catalog is loaded bool IsLoaded(const wxChar *szDomain) const; - + + // Retrieve the language info struct for the given language + // + // Returns NULL if no info found, pointer must *not* be deleted by caller + static const wxLanguageInfo *GetLanguageInfo(int lang); + + // Returns language name in English or empty string if the language + // is not in database + static wxString GetLanguageName(int lang); + + // Find the language for the given locale string which may be either a + // canonical ISO 2 letter language code ("xx"), a language code followed by + // the country code ("xx_XX") or a Windows full language name ("Xxxxx...") + // + // Returns NULL if no info found, pointer must *not* be deleted by caller + static const wxLanguageInfo *FindLanguageInfo(const wxString& locale); + // Add custom language to the list of known languages. // Notes: 1) wxLanguageInfo contains platform-specific data // 2) must be called before Init to have effect - void AddLanguage(const wxLanguageInfo& info); + static void AddLanguage(const wxLanguageInfo& info); // retrieve the translation for a string in all loaded domains unless // the szDomain parameter is specified (and then only this domain is // searched) + // n - additional parameter for PluralFormsParser // // return original string if translation is not available // (in this case an error message is generated the first time @@ -418,19 +493,37 @@ public: // // domains are searched in the last to first order, i.e. catalogs // added later override those added before. - const wxMB2WXbuf GetString(const wxChar *szOrigString, - const wxChar *szDomain = (const wxChar *) NULL) const; + const wxChar *GetString(const wxChar *szOrigString, + const wxChar *szDomain = NULL) const; + // plural form version of the same: + const wxChar *GetString(const wxChar *szOrigString, + const wxChar *szOrigString2, + size_t n, + const wxChar *szDomain = NULL) const; // Returns the current short name for the locale const wxString& GetName() const { return m_strShort; } + // return the contents of .po file header + wxString GetHeaderValue( const wxChar* szHeader, + const wxChar* szDomain = NULL ) const; + + // These two methods are for internal use only. First one creates + // ms_languagesDB if it doesn't already exist, second one destroys + // it. + static void CreateLanguagesDB(); + static void DestroyLanguagesDB(); + private: // find catalog by name in a linked list, return NULL if !found wxMsgCatalog *FindCatalog(const wxChar *szDomain) const; - + // copy default table of languages from global static array to - // m_langugagesInfo - void InitLanguagesDB(); + // m_langugagesInfo, called by InitLanguagesDB + static void InitLanguagesDB(); + + // initialize the member fields to default values + void DoCommonInit(); wxString m_strLocale, // this locale name m_strShort; // short name for the locale @@ -440,10 +533,14 @@ private: wxLocale *m_pOldLocale; // previous wxLocale wxMsgCatalog *m_pMsgCat; // pointer to linked list of catalogs - + bool m_bConvertEncoding; - wxLanguageInfoArray *m_languagesDB; + bool m_initialized; + + static wxLanguageInfoArray *ms_languagesDB; + + DECLARE_NO_COPY_CLASS(wxLocale) }; // ---------------------------------------------------------------------------- @@ -451,37 +548,55 @@ private: // ---------------------------------------------------------------------------- // get the current locale object (note that it may be NULL!) -extern WXDLLEXPORT wxLocale* wxGetLocale(); +extern WXDLLIMPEXP_BASE wxLocale* wxGetLocale(); // get the translation of the string in the current locale -inline const wxMB2WXbuf wxGetTranslation(const wxChar *sz) +inline const wxChar *wxGetTranslation(const wxChar *sz) { wxLocale *pLoc = wxGetLocale(); if (pLoc) return pLoc->GetString(sz); else - return (const wxMB2WXbuf)sz; + return sz; +} +inline const wxChar *wxGetTranslation(const wxChar *sz1, const wxChar *sz2, + size_t n) +{ + wxLocale *pLoc = wxGetLocale(); + if (pLoc) + return pLoc->GetString(sz1, sz2, n); + else + return n == 1 ? sz1 : sz2; } #else // !wxUSE_INTL // the macros should still be defined - otherwise compilation would fail -#if !defined(WXINTL_NO_GETTEXT_MACRO) && !defined(_) - #define _(str) (str) +#if !defined(WXINTL_NO_GETTEXT_MACRO) + #if !defined(_) + #define _(s) (_T(s)) + #endif #endif #define wxTRANSLATE(str) _T(str) -inline const wxChar *wxGetTranslation(const wxChar *sz) { return sz; } +// Note: use of 'inline' here can cause this symbol not to be found when compiled with gcc +//const wxChar *wxGetTranslation(const wxChar *sz); +#define wxGetTranslation(sz) (sz) #endif // wxUSE_INTL/!wxUSE_INTL // define this one just in case it occurs somewhere (instead of preferred // wxTRANSLATE) too -#if !defined(WXINTL_NO_GETTEXT_MACRO) && !defined(gettext_noop) - #define gettext_noop(str) _T(str) +#if !defined(WXINTL_NO_GETTEXT_MACRO) + #if !defined(gettext_noop) + #define gettext_noop(str) _T(str) + #endif + #if !defined(N_) + #define N_(s) _T(s) + #endif #endif -#endif - // _WX_INTLH__ +#endif // _WX_INTL_H_ +