X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/33046a8283bcb192ffe717dea944cb4ef262e9da..032e024c1c6ab6a20226604baab9d00558620e72:/include/wx/intl.h diff --git a/include/wx/intl.h b/include/wx/intl.h index 5d16e3a3e9..28bb8ce166 100644 --- a/include/wx/intl.h +++ b/include/wx/intl.h @@ -10,6 +10,9 @@ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// +// WARNING: Parts of this file are generated. See misc/languages/README for +// details. + #ifndef _WX_INTL_H_ #define _WX_INTL_H_ @@ -42,20 +45,20 @@ enum wxLayoutDirection // --keyword="_" --keyword="wxPLURAL:1,2" options // to extract the strings from the sources) #ifndef WXINTL_NO_GETTEXT_MACRO - #define _(s) wxGetTranslation(_T(s)) - #define wxPLURAL(sing, plur, n) wxGetTranslation(_T(sing), _T(plur), n) + #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 WXDLLIMPEXP_BASE wxLocale; -class WXDLLIMPEXP_BASE wxLanguageInfoArray; +class WXDLLIMPEXP_FWD_BASE wxLocale; +class WXDLLIMPEXP_FWD_BASE wxLanguageInfoArray; class wxMsgCatalog; // ============================================================================ @@ -68,13 +71,18 @@ class wxMsgCatalog; // --- --- --- generated code begins here --- --- --- -// This enum is generated by misc/languages/genlang.py -// When making changes, please put them into misc/languages/langtabl.txt +/** + The languages supported by wxLocale. + + 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: + /// User's default/preffered language as got from OS. wxLANGUAGE_DEFAULT, - // unknown language, if wxLocale::GetSystemLanguage fails: + + /// Unknown language, returned if wxLocale::GetSystemLanguage fails. wxLANGUAGE_UNKNOWN, wxLANGUAGE_ABKHAZIAN, @@ -102,6 +110,7 @@ enum wxLanguage wxLANGUAGE_ARABIC_YEMEN, wxLANGUAGE_ARMENIAN, wxLANGUAGE_ASSAMESE, + wxLANGUAGE_ASTURIAN, wxLANGUAGE_AYMARA, wxLANGUAGE_AZERI, wxLANGUAGE_AZERI_CYRILLIC, @@ -233,6 +242,7 @@ enum wxLanguage wxLANGUAGE_ROMANIAN, wxLANGUAGE_RUSSIAN, wxLANGUAGE_RUSSIAN_UKRAINE, + wxLANGUAGE_SAMI, wxLANGUAGE_SAMOAN, wxLANGUAGE_SANGHO, wxLANGUAGE_SANSKRIT, @@ -296,6 +306,7 @@ enum wxLanguage wxLANGUAGE_UZBEK, wxLANGUAGE_UZBEK_CYRILLIC, wxLANGUAGE_UZBEK_LATIN, + wxLANGUAGE_VALENCIAN, wxLANGUAGE_VIETNAMESE, wxLANGUAGE_VOLAPUK, wxLANGUAGE_WELSH, @@ -306,7 +317,7 @@ enum wxLanguage wxLANGUAGE_ZHUANG, wxLANGUAGE_ZULU, - // for custom, user-defined languages: + /// For custom, user-defined languages. wxLANGUAGE_USER_DEFINED }; @@ -321,14 +332,29 @@ struct WXDLLIMPEXP_BASE wxLanguageInfo { int Language; // wxLanguage id wxString CanonicalName; // Canonical name, e.g. fr_FR -#ifdef __WIN32__ +#ifdef __WXMSW__ wxUint32 WinLang, // Win32 language identifiers WinSublang; -#endif // __WIN32__ +#endif // __WXMSW__ wxString Description; // human-readable name of the language wxLayoutDirection LayoutDirection; + +#ifdef __WXMSW__ + // return the LCID corresponding to this language + wxUint32 GetLCID() const; +#endif // __WXMSW__ + + // return the locale name corresponding to this language usable with + // setlocale() on the current system + wxString GetLocaleName() const; }; +// for Unix systems GetLocaleName() is trivial so implement it inline here, for +// MSW it's implemented in intl.cpp +#ifndef __WXMSW__ +inline wxString wxLanguageInfo::GetLocaleName() const { return CanonicalName; } +#endif // !__WXMSW__ + // ---------------------------------------------------------------------------- // wxLocaleCategory: the category of locale settings // ---------------------------------------------------------------------------- @@ -344,6 +370,10 @@ enum wxLocaleCategory // monetary value wxLOCALE_CAT_MONEY, + // default category for wxLocaleInfo values which only apply to a single + // category (e.g. wxLOCALE_SHORT_DATE_FMT) + wxLOCALE_CAT_DEFAULT, + wxLOCALE_CAT_MAX }; @@ -353,11 +383,21 @@ enum wxLocaleCategory enum wxLocaleInfo { - // the thounsands separator + // the thousands separator (for wxLOCALE_CAT_NUMBER or MONEY) wxLOCALE_THOUSANDS_SEP, - // the character used as decimal point - wxLOCALE_DECIMAL_POINT + // the character used as decimal point (for wxLOCALE_CAT_NUMBER or MONEY) + wxLOCALE_DECIMAL_POINT, + + // the stftime()-formats used for short/long date and time representations + // (under some platforms short and long date formats are the same) + // + // NB: these elements should appear in this order, code in GetInfo() relies + // on it + wxLOCALE_SHORT_DATE_FMT, + wxLOCALE_LONG_DATE_FMT, + wxLOCALE_DATE_TIME_FMT, + wxLOCALE_TIME_FMT }; @@ -382,15 +422,15 @@ public: 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) + 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? { DoCommonInit(); - Init(szName, szShort, szLocale, bLoadDefault, bConvertEncoding); + Init(name, shortName, locale, bLoadDefault, bConvertEncoding); } wxLocale(int language, // wxLanguage id or custom language @@ -402,9 +442,9 @@ public: } // 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 Init(const wxString& name, + const wxString& shortName = wxEmptyString, + const wxString& locale = wxEmptyString, bool bLoadDefault = true, bool bConvertEncoding = false); @@ -429,13 +469,14 @@ public: // 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); + static wxString GetInfo(wxLocaleInfo index, + wxLocaleCategory cat = wxLOCALE_CAT_DEFAULT); // 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; } @@ -462,15 +503,15 @@ 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 wxChar *szDomain, - wxLanguage msgIdLanguage, const wxChar *msgIdCharset); + 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 // @@ -504,20 +545,25 @@ public: // // domains are searched in the last to first order, i.e. catalogs // added later override those added before. - virtual const wxChar *GetString(const wxChar *szOrigString, - const wxChar *szDomain = NULL) const; + virtual const wxString& GetString(const wxString& origString, + const wxString& domain = wxEmptyString) const; // plural form version of the same: - virtual const wxChar *GetString(const wxChar *szOrigString, - const wxChar *szOrigString2, - size_t n, - const wxChar *szDomain = NULL) const; + 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 wxChar* szHeader, - const wxChar* szDomain = NULL ) const; + 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 @@ -527,7 +573,7 @@ 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 @@ -540,7 +586,7 @@ private: 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 @@ -551,7 +597,7 @@ private: static wxLanguageInfoArray *ms_languagesDB; - DECLARE_NO_COPY_CLASS(wxLocale) + wxDECLARE_NO_COPY_CLASS(wxLocale); }; // ---------------------------------------------------------------------------- @@ -562,22 +608,31 @@ private: extern WXDLLIMPEXP_BASE wxLocale* wxGetLocale(); // get the translation of the string in the current locale -inline const wxChar *wxGetTranslation(const wxChar *sz, const wxChar* domain=NULL) +inline const wxString& wxGetTranslation(const wxString& str, + const wxString& domain = wxEmptyString) { wxLocale *pLoc = wxGetLocale(); if (pLoc) - return pLoc->GetString(sz, domain); + 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 wxChar *wxGetTranslation(const wxChar *sz1, const wxChar *sz2, - size_t n, const wxChar* domain=NULL) +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(sz1, sz2, n, domain); + return pLoc->GetString(str1, str2, n, domain); else - return n == 1 ? sz1 : sz2; + // 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 @@ -586,17 +641,34 @@ inline const wxChar *wxGetTranslation(const wxChar *sz1, const wxChar *sz2, #if !defined(WXINTL_NO_GETTEXT_MACRO) #if !defined(_) - #define _(s) (_T(s)) + #define _(s) (s) #endif + #define wxPLURAL(sing, plur, n) ((n) == 1 ? (sing) : (plur)) #endif -#define wxTRANSLATE(str) _T(str) +#define wxTRANSLATE(str) str -inline const wxChar *wxGetTranslation(const wxChar *sz, - const wxChar *WXUNUSED(domain) = NULL) -{ - return sz; -} +// 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; } + +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 @@ -604,10 +676,10 @@ inline const wxChar *wxGetTranslation(const wxChar *sz, // wxTRANSLATE) too #if !defined(WXINTL_NO_GETTEXT_MACRO) #if !defined(gettext_noop) - #define gettext_noop(str) _T(str) + #define gettext_noop(str) (str) #endif #if !defined(N_) - #define N_(s) _T(s) + #define N_(s) (s) #endif #endif