X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9d1e1be46360ddf5b3e8d3379f273ac939cccc5a..60dd3c0916772e3e64fde7c83d359daae02b40a6:/include/wx/intl.h diff --git a/include/wx/intl.h b/include/wx/intl.h index 379ff977ba..4a996c086b 100644 --- a/include/wx/intl.h +++ b/include/wx/intl.h @@ -1,24 +1,31 @@ ///////////////////////////////////////////////////////////////////////////// // Name: wx/intl.h -// Purpose: Internationalization and localisation for wxWindows +// 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 _WX_INTL_H_ #define _WX_INTL_H_ -#if defined(__GNUG__) && !defined(__APPLE__) - #pragma interface "intl.h" -#endif - #include "wx/defs.h" #include "wx/string.h" +// Make wxLayoutDirection enum available without need for wxUSE_INTL so wxWindow, wxApp +// and other classes are not distrubed by wxUSE_INTL + +enum wxLayoutDirection +{ + wxLayout_Default, + wxLayout_LeftToRight, + wxLayout_RightToLeft +}; + #if wxUSE_INTL #include "wx/fontenc.h" @@ -31,23 +38,25 @@ // 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="wxPLURAL:1,2" options +// to extract the strings from the sources) #ifndef WXINTL_NO_GETTEXT_MACRO - #define _(str) wxGetTranslation(_T(str)) + #define _(s) wxGetTranslation((s)) + #define wxPLURAL(sing, plur, n) wxGetTranslation((sing), (plur), n) #endif // another one which just marks the strings for extraction, but doesn't // perform the translation (use -kwxTRANSLATE with xgettext!) -#define wxTRANSLATE(str) _T(str) +#define wxTRANSLATE(str) (str) // ---------------------------------------------------------------------------- // forward decls // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxLocale; -class WXDLLEXPORT wxMsgCatalog; -class WXDLLEXPORT wxLanguageInfoArray; +class WXDLLIMPEXP_FWD_BASE wxLocale; +class WXDLLIMPEXP_FWD_BASE wxLanguageInfoArray; +class wxMsgCatalog; // ============================================================================ // locale support @@ -308,7 +317,7 @@ enum wxLanguage // translation information // ---------------------------------------------------------------------------- -struct WXDLLEXPORT wxLanguageInfo +struct WXDLLIMPEXP_BASE wxLanguageInfo { int Language; // wxLanguage id wxString CanonicalName; // Canonical name, e.g. fr_FR @@ -317,6 +326,7 @@ struct WXDLLEXPORT wxLanguageInfo WinSublang; #endif // __WIN32__ wxString Description; // human-readable name of the language + wxLayoutDirection LayoutDirection; }; // ---------------------------------------------------------------------------- @@ -362,43 +372,50 @@ 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? + wxLocale(const wxString& name, // name (for messages) + const wxString& shortName = wxEmptyString, // dir prefix (for msg files) + const wxString& locale = wxEmptyString, // locale (for setlocale) + bool bLoadDefault = true, // preload wxstd.mo? + bool bConvertEncoding = false) // convert Win<->Unix if necessary? { - Init(szName, szShort, szLocale, bLoadDefault, bConvertEncoding); + DoCommonInit(); + + Init(name, shortName, locale, 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) - bool Init(const wxChar *szName, - const wxChar *szShort = (const wxChar *) NULL, - const wxChar *szLocale = (const wxChar *) NULL, - bool bLoadDefault = TRUE, - bool bConvertEncoding = FALSE); + // the same as a function (returns true on success) + bool Init(const wxString& name, + const wxString& shortName = wxEmptyString, + const wxString& locale = wxEmptyString, + 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(); + virtual ~wxLocale(); - // Try to get user's (or OS's) prefered language setting. + // Try to get user's (or OS's) preferred language setting. // Return wxLANGUAGE_UNKNOWN if language-guessing algorithm failed static int GetSystemLanguage(); @@ -414,11 +431,11 @@ public: // 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; } + const wxString& GetLocale() const { return m_strLocale; } // return current locale wxLanguage value int GetLanguage() const { return m_language; } @@ -445,16 +462,25 @@ public: // The loaded catalog will be used for message lookup by GetString(). // // Returns 'true' if it was successfully loaded - bool AddCatalog(const wxChar *szDomain); + bool AddCatalog(const wxString& domain); + bool AddCatalog(const wxString& domain, + wxLanguage msgIdLanguage, const wxString& msgIdCharset); + + // check if the given locale is provided by OS and C run time + static bool IsAvailable(int lang); // check if the given catalog is loaded - bool IsLoaded(const wxChar *szDomain) const; + bool IsLoaded(const wxString& domain) 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...") @@ -470,6 +496,7 @@ public: // 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 @@ -477,12 +504,26 @@ public: // // domains are searched in the last to first order, i.e. catalogs // added later override those added before. - const wxChar *GetString(const wxChar *szOrigString, - const wxChar *szDomain = (const wxChar *) NULL) const; + virtual const wxString& GetString(const wxString& origString, + const wxString& domain = wxEmptyString) const; + // plural form version of the same: + virtual const wxString& GetString(const wxString& origString, + const wxString& origString2, + size_t n, + const wxString& domain = wxEmptyString) const; + + // this is hack to work around a problem with wxGetTranslation() which + // returns const wxString& and not wxString, so when it returns untranslated + // string, it needs to have a copy of it somewhere + static const wxString& GetUntranslatedString(const wxString& str); // 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 wxString& header, + const wxString& domain = wxEmptyString) const; + // These two methods are for internal use only. First one creates // ms_languagesDB if it doesn't already exist, second one destroys // it. @@ -491,23 +532,28 @@ public: private: // find catalog by name in a linked list, return NULL if !found - wxMsgCatalog *FindCatalog(const wxChar *szDomain) const; + wxMsgCatalog *FindCatalog(const wxString& domain) const; // copy default table of languages from global static array to // 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 int m_language; // this locale wxLanguage value - const wxChar *m_pszOldLocale; // previous locale from setlocale() + const char *m_pszOldLocale; // previous locale from setlocale() wxLocale *m_pOldLocale; // previous wxLocale wxMsgCatalog *m_pMsgCat; // pointer to linked list of catalogs bool m_bConvertEncoding; + bool m_initialized; + static wxLanguageInfoArray *ms_languagesDB; DECLARE_NO_COPY_CLASS(wxLocale) @@ -518,39 +564,82 @@ 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 wxChar *wxGetTranslation(const wxChar *sz) +inline const wxString& wxGetTranslation(const wxString& str, + const wxString& domain = wxEmptyString) { wxLocale *pLoc = wxGetLocale(); if (pLoc) - return pLoc->GetString(sz); + return pLoc->GetString(str, domain); else - return sz; + // NB: this function returns reference to a string, so we have to keep + // a copy of it somewhere + return wxLocale::GetUntranslatedString(str); +} +inline const wxString& wxGetTranslation(const wxString& str1, + const wxString& str2, + size_t n, + const wxString& domain = wxEmptyString) +{ + wxLocale *pLoc = wxGetLocale(); + if (pLoc) + return pLoc->GetString(str1, str2, n, domain); + else + // NB: this function returns reference to a string, so we have to keep + // a copy of it somewhere + return n == 1 + ? wxLocale::GetUntranslatedString(str1) + : wxLocale::GetUntranslatedString(str2); } #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) (s) + #endif + #define wxPLURAL(sing, plur, n) ((n) == 1 ? (sing) : (plur)) #endif -#define wxTRANSLATE(str) _T(str) +#define wxTRANSLATE(str) (str) + +// NB: we use a template here in order to avoid using +// wxLocale::GetUntranslatedString() above, which would be required if +// we returned const wxString&; this way, the compiler should be able to +// optimize wxGetTranslation() away + +template +inline TString wxGetTranslation(TString str) + { return str; } -// 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) +template +inline TString wxGetTranslation(TString str, TDomain WXUNUSED(domain)) + { return str; } + +template +inline TString wxGetTranslation(TString str1, TString str2, size_t n) + { return n == 1 ? str1 : str2; } + +template +inline TString wxGetTranslation(TString str1, TString str2, size_t n, + TDomain WXUNUSED(domain)) + { return n == 1 ? str1 : str2; } #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) (str) + #endif + #if !defined(N_) + #define N_(s) (s) + #endif #endif #endif // _WX_INTL_H_ -