]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/intl.h
wxZipFSHandler does not report non-local zip archives as openable anymore
[wxWidgets.git] / include / wx / intl.h
index 1c8ee18c25aeec825cbdf737afc3c0f2cf1204ff..89128347c7c990168e49c755baa042e64f8764d3 100644 (file)
@@ -19,6 +19,8 @@
 #include "wx/defs.h"
 #include "wx/string.h"
 
+#if wxUSE_INTL
+
 // ============================================================================
 // global decls
 // ============================================================================
 // gettext() style macro (notice that xgettext should be invoked with "-k_"
 // option to extract the strings inside _() from the sources)
 #ifndef WXINTL_NO_GETTEXT_MACRO
-    #define   _(str)  wxGetTranslation(str)
+    #define   _(str)  wxGetTranslation(_T(str))
 #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)
+
 // ----------------------------------------------------------------------------
 // forward decls
 // ----------------------------------------------------------------------------
+
 class WXDLLEXPORT wxLocale;
 class WXDLLEXPORT wxMsgCatalog;
+class WXDLLEXPORT wxLanguageInfoArray;
 
 // ============================================================================
 // locale support
 // ============================================================================
 
+// ----------------------------------------------------------------------------
+// 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, 
+    // unknown language, if wxLocale::GetSystemLanguage fails:
+    wxLANGUAGE_UNKNOWN, 
+    
+    wxLANGUAGE_ABKHAZIAN,
+    wxLANGUAGE_AFAR,
+    wxLANGUAGE_AFRIKAANS,
+    wxLANGUAGE_ALBANIAN,
+    wxLANGUAGE_AMHARIC,
+    wxLANGUAGE_ARABIC,
+    wxLANGUAGE_ARABIC_ALGERIA,
+    wxLANGUAGE_ARABIC_BAHRAIN,
+    wxLANGUAGE_ARABIC_EGYPT,
+    wxLANGUAGE_ARABIC_IRAQ,
+    wxLANGUAGE_ARABIC_JORDAN,
+    wxLANGUAGE_ARABIC_KUWAIT,
+    wxLANGUAGE_ARABIC_LEBANON,
+    wxLANGUAGE_ARABIC_LIBYA,
+    wxLANGUAGE_ARABIC_MOROCCO,
+    wxLANGUAGE_ARABIC_OMAN,
+    wxLANGUAGE_ARABIC_QATAR,
+    wxLANGUAGE_ARABIC_SAUDI_ARABIA,
+    wxLANGUAGE_ARABIC_SUDAN,
+    wxLANGUAGE_ARABIC_SYRIA,
+    wxLANGUAGE_ARABIC_TUNISIA,
+    wxLANGUAGE_ARABIC_UAE,
+    wxLANGUAGE_ARABIC_YEMEN,
+    wxLANGUAGE_ARMENIAN,
+    wxLANGUAGE_ASSAMESE,
+    wxLANGUAGE_AYMARA,
+    wxLANGUAGE_AZERI,
+    wxLANGUAGE_AZERI_CYRILLIC,
+    wxLANGUAGE_AZERI_LATIN,
+    wxLANGUAGE_BASHKIR,
+    wxLANGUAGE_BASQUE,
+    wxLANGUAGE_BELARUSIAN,
+    wxLANGUAGE_BENGALI,
+    wxLANGUAGE_BHUTANI,
+    wxLANGUAGE_BIHARI,
+    wxLANGUAGE_BISLAMA,
+    wxLANGUAGE_BRETON,
+    wxLANGUAGE_BULGARIAN,
+    wxLANGUAGE_BURMESE,
+    wxLANGUAGE_CAMBODIAN,
+    wxLANGUAGE_CATALAN,
+    wxLANGUAGE_CHINESE,
+    wxLANGUAGE_CHINESE_SIMPLIFIED,
+    wxLANGUAGE_CHINESE_TRADITIONAL,
+    wxLANGUAGE_CHINESE_HONGKONG,
+    wxLANGUAGE_CHINESE_MACAU,
+    wxLANGUAGE_CHINESE_SINGAPORE,
+    wxLANGUAGE_CHINESE_TAIWAN,
+    wxLANGUAGE_CORSICAN,
+    wxLANGUAGE_CROATIAN,
+    wxLANGUAGE_CZECH,
+    wxLANGUAGE_DANISH,
+    wxLANGUAGE_DUTCH,
+    wxLANGUAGE_DUTCH_BELGIAN,
+    wxLANGUAGE_ENGLISH,
+    wxLANGUAGE_ENGLISH_UK,
+    wxLANGUAGE_ENGLISH_US,
+    wxLANGUAGE_ENGLISH_AUSTRALIA,
+    wxLANGUAGE_ENGLISH_BELIZE,
+    wxLANGUAGE_ENGLISH_BOTSWANA,
+    wxLANGUAGE_ENGLISH_CANADA,
+    wxLANGUAGE_ENGLISH_CARIBBEAN,
+    wxLANGUAGE_ENGLISH_DENMARK,
+    wxLANGUAGE_ENGLISH_EIRE,
+    wxLANGUAGE_ENGLISH_JAMAICA,
+    wxLANGUAGE_ENGLISH_NEW_ZEALAND,
+    wxLANGUAGE_ENGLISH_PHILIPPINES,
+    wxLANGUAGE_ENGLISH_SOUTH_AFRICA,
+    wxLANGUAGE_ENGLISH_TRINIDAD,
+    wxLANGUAGE_ENGLISH_ZIMBABWE,
+    wxLANGUAGE_ESPERANTO,
+    wxLANGUAGE_ESTONIAN,
+    wxLANGUAGE_FAEROESE,
+    wxLANGUAGE_FARSI,
+    wxLANGUAGE_FIJI,
+    wxLANGUAGE_FINNISH,
+    wxLANGUAGE_FRENCH,
+    wxLANGUAGE_FRENCH_BELGIAN,
+    wxLANGUAGE_FRENCH_CANADIAN,
+    wxLANGUAGE_FRENCH_LUXEMBOURG,
+    wxLANGUAGE_FRENCH_MONACO,
+    wxLANGUAGE_FRENCH_SWISS,
+    wxLANGUAGE_FRISIAN,
+    wxLANGUAGE_GALICIAN,
+    wxLANGUAGE_GEORGIAN,
+    wxLANGUAGE_GERMAN,
+    wxLANGUAGE_GERMAN_AUSTRIAN,
+    wxLANGUAGE_GERMAN_BELGIUM,
+    wxLANGUAGE_GERMAN_LIECHTENSTEIN,
+    wxLANGUAGE_GERMAN_LUXEMBOURG,
+    wxLANGUAGE_GERMAN_SWISS,
+    wxLANGUAGE_GREEK,
+    wxLANGUAGE_GREENLANDIC,
+    wxLANGUAGE_GUARANI,
+    wxLANGUAGE_GUJARATI,
+    wxLANGUAGE_HAUSA,
+    wxLANGUAGE_HEBREW,
+    wxLANGUAGE_HINDI,
+    wxLANGUAGE_HUNGARIAN,
+    wxLANGUAGE_ICELANDIC,
+    wxLANGUAGE_INDONESIAN,
+    wxLANGUAGE_INTERLINGUA,
+    wxLANGUAGE_INTERLINGUE,
+    wxLANGUAGE_INUKTITUT,
+    wxLANGUAGE_INUPIAK,
+    wxLANGUAGE_IRISH,
+    wxLANGUAGE_ITALIAN,
+    wxLANGUAGE_ITALIAN_SWISS,
+    wxLANGUAGE_JAPANESE,
+    wxLANGUAGE_JAVANESE,
+    wxLANGUAGE_KANNADA,
+    wxLANGUAGE_KASHMIRI,
+    wxLANGUAGE_KASHMIRI_INDIA,
+    wxLANGUAGE_KAZAKH,
+    wxLANGUAGE_KERNEWEK,
+    wxLANGUAGE_KINYARWANDA,
+    wxLANGUAGE_KIRGHIZ,
+    wxLANGUAGE_KIRUNDI,
+    wxLANGUAGE_KONKANI,
+    wxLANGUAGE_KOREAN,
+    wxLANGUAGE_KURDISH,
+    wxLANGUAGE_LAOTHIAN,
+    wxLANGUAGE_LATIN,
+    wxLANGUAGE_LATVIAN,
+    wxLANGUAGE_LINGALA,
+    wxLANGUAGE_LITHUANIAN,
+    wxLANGUAGE_MACEDONIAN,
+    wxLANGUAGE_MALAGASY,
+    wxLANGUAGE_MALAY,
+    wxLANGUAGE_MALAYALAM,
+    wxLANGUAGE_MALAY_BRUNEI_DARUSSALAM,
+    wxLANGUAGE_MALAY_MALAYSIA,
+    wxLANGUAGE_MALTESE,
+    wxLANGUAGE_MANIPURI,
+    wxLANGUAGE_MAORI,
+    wxLANGUAGE_MARATHI,
+    wxLANGUAGE_MOLDAVIAN,
+    wxLANGUAGE_MONGOLIAN,
+    wxLANGUAGE_NAURU,
+    wxLANGUAGE_NEPALI,
+    wxLANGUAGE_NEPALI_INDIA,
+    wxLANGUAGE_NORWEGIAN_BOKMAL,
+    wxLANGUAGE_NORWEGIAN_NYNORSK,
+    wxLANGUAGE_OCCITAN,
+    wxLANGUAGE_ORIYA,
+    wxLANGUAGE_OROMO,
+    wxLANGUAGE_PASHTO,
+    wxLANGUAGE_POLISH,
+    wxLANGUAGE_PORTUGUESE,
+    wxLANGUAGE_PORTUGUESE_BRAZILIAN,
+    wxLANGUAGE_PUNJABI,
+    wxLANGUAGE_QUECHUA,
+    wxLANGUAGE_RHAETO_ROMANCE,
+    wxLANGUAGE_ROMANIAN,
+    wxLANGUAGE_RUSSIAN,
+    wxLANGUAGE_RUSSIAN_UKRAINE,
+    wxLANGUAGE_SAMOAN,
+    wxLANGUAGE_SANGHO,
+    wxLANGUAGE_SANSKRIT,
+    wxLANGUAGE_SCOTS_GAELIC,
+    wxLANGUAGE_SERBIAN,
+    wxLANGUAGE_SERBIAN_CYRILLIC,
+    wxLANGUAGE_SERBIAN_LATIN,
+    wxLANGUAGE_SERBO_CROATIAN,
+    wxLANGUAGE_SESOTHO,
+    wxLANGUAGE_SETSWANA,
+    wxLANGUAGE_SHONA,
+    wxLANGUAGE_SINDHI,
+    wxLANGUAGE_SINHALESE,
+    wxLANGUAGE_SISWATI,
+    wxLANGUAGE_SLOVAK,
+    wxLANGUAGE_SLOVENIAN,
+    wxLANGUAGE_SOMALI,
+    wxLANGUAGE_SPANISH,
+    wxLANGUAGE_SPANISH_ARGENTINA,
+    wxLANGUAGE_SPANISH_BOLIVIA,
+    wxLANGUAGE_SPANISH_CHILE,
+    wxLANGUAGE_SPANISH_COLOMBIA,
+    wxLANGUAGE_SPANISH_COSTA_RICA,
+    wxLANGUAGE_SPANISH_DOMINICAN_REPUBLIC,
+    wxLANGUAGE_SPANISH_ECUADOR,
+    wxLANGUAGE_SPANISH_EL_SALVADOR,
+    wxLANGUAGE_SPANISH_GUATEMALA,
+    wxLANGUAGE_SPANISH_HONDURAS,
+    wxLANGUAGE_SPANISH_MEXICAN,
+    wxLANGUAGE_SPANISH_MODERN,
+    wxLANGUAGE_SPANISH_NICARAGUA,
+    wxLANGUAGE_SPANISH_PANAMA,
+    wxLANGUAGE_SPANISH_PARAGUAY,
+    wxLANGUAGE_SPANISH_PERU,
+    wxLANGUAGE_SPANISH_PUERTO_RICO,
+    wxLANGUAGE_SPANISH_URUGUAY,
+    wxLANGUAGE_SPANISH_US,
+    wxLANGUAGE_SPANISH_VENEZUELA,
+    wxLANGUAGE_SUNDANESE,
+    wxLANGUAGE_SWAHILI,
+    wxLANGUAGE_SWEDISH,
+    wxLANGUAGE_SWEDISH_FINLAND,
+    wxLANGUAGE_TAGALOG,
+    wxLANGUAGE_TAJIK,
+    wxLANGUAGE_TAMIL,
+    wxLANGUAGE_TATAR,
+    wxLANGUAGE_TELUGU,
+    wxLANGUAGE_THAI,
+    wxLANGUAGE_TIBETAN,
+    wxLANGUAGE_TIGRINYA,
+    wxLANGUAGE_TONGA,
+    wxLANGUAGE_TSONGA,
+    wxLANGUAGE_TURKISH,
+    wxLANGUAGE_TURKMEN,
+    wxLANGUAGE_TWI,
+    wxLANGUAGE_UIGHUR,
+    wxLANGUAGE_UKRAINIAN,
+    wxLANGUAGE_URDU,
+    wxLANGUAGE_URDU_INDIA,
+    wxLANGUAGE_URDU_PAKISTAN,
+    wxLANGUAGE_UZBEK,
+    wxLANGUAGE_UZBEK_CYRILLIC,
+    wxLANGUAGE_UZBEK_LATIN,
+    wxLANGUAGE_VIETNAMESE,
+    wxLANGUAGE_VOLAPUK,
+    wxLANGUAGE_WELSH,
+    wxLANGUAGE_WOLOF,
+    wxLANGUAGE_XHOSA,
+    wxLANGUAGE_YIDDISH,
+    wxLANGUAGE_YORUBA,
+    wxLANGUAGE_ZHUANG,
+    wxLANGUAGE_ZULU,
+
+    // for custom, user-defined languages:
+    wxLANGUAGE_USER_DEFINED
+};
+
+// --- --- --- generated code ends here --- --- ---
+
+
+
+// ----------------------------------------------------------------------------
+// wxLanguageInfo: encapsulates wxLanguage to OS native lang.desc.
+//                 translation information
+// ----------------------------------------------------------------------------
+
+struct WXDLLEXPORT wxLanguageInfo
+{
+    int Language;                   // wxLanguage id
+    wxString CanonicalName;         // Canonical name, e.g. fr_FR
+#ifdef __WIN32__
+    wxUint32 WinLang, WinSublang;   // Win32 language identifiers
+#endif
+    wxString Description;           // human-readable name of the language
+};
+
 // ----------------------------------------------------------------------------
 // wxLocale: encapsulates all language dependent settings, including current
 //           message catalogs, date, time and currency formats (TODO) &c
 // ----------------------------------------------------------------------------
+
+enum wxLocaleInitFlags
+{
+    wxLOCALE_LOAD_DEFAULT  = 0x0001,     // load wxwin.mo?
+    wxLOCALE_CONV_ENCODING = 0x0002      // convert encoding on the fly?
+};
+
+
 class WXDLLEXPORT wxLocale
 {
 public:
@@ -56,22 +339,54 @@ public:
         // call Init() if you use this ctor
     wxLocale();
         // the ctor has a side effect of changing current locale
-    wxLocale(const char *szName,              // name (for messages)
-             const char *szShort = (const char *) NULL,      // dir prefix (for msg files)
-             const char *szLocale = (const char *) NULL,     // locale (for setlocale)
-             bool bLoadDefault = TRUE)        // preload wxstd.mo?
-        { Init(szName, szShort, szLocale, bLoadDefault); }
+    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?
+        { 
+            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); }
+
         // the same as a function (returns TRUE on success)
-    bool Init(const char *szName,
-              const char *szShort = (const char *) NULL,
-              const char *szLocale = (const char *) NULL,
-              bool bLoadDefault = TRUE);
+    bool Init(const wxChar *szName,
+              const wxChar *szShort = (const wxChar *) NULL,
+              const wxChar *szLocale = (const wxChar *) NULL,
+              bool bLoadDefault = TRUE,
+              bool bConvertEncoding = FALSE);
+
+        // 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
+    static int GetSystemLanguage();
+
+    // return TRUE if the locale was set successfully
+    bool IsOk() const { return m_pszOldLocale != NULL; }
 
     // returns locale name
-    const char *GetLocale() const { return m_strLocale; }
+    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()    
+    wxString GetSysName() const;
+
+    // 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/<lang>/LC_MESSAGES, prefix/LC_MESSAGES and prefix
     // (in this order).
@@ -86,10 +401,15 @@ public:
     // The loaded catalog will be used for message lookup by GetString().
     //
     // Returns 'true' if it was successfully loaded
-    bool AddCatalog(const char *szDomain);
+    bool AddCatalog(const wxChar *szDomain);
 
     // check if the given catalog is loaded
-    bool IsLoaded(const char *szDomain) const;
+    bool IsLoaded(const wxChar *szDomain) const;
+    
+    // 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
+    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
@@ -101,23 +421,38 @@ public:
     //
     // domains are searched in the last to first order, i.e. catalogs
     // added later override those added before.
-    const char *GetString(const char *szOrigString,
-                          const char *szDomain = (const char *) NULL) const;
+    const wxMB2WXbuf GetString(const wxChar *szOrigString,
+                               const wxChar *szDomain = (const wxChar *) NULL) const;
 
     // Returns the current short name for the locale
     const wxString& GetName() const { return m_strShort; }
 
+    // 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 char *szDomain) const;
+    wxMsgCatalog  *FindCatalog(const wxChar *szDomain) const;
+    
+    // copy default table of languages from global static array to
+    // m_langugagesInfo, called by InitLanguagesDB
+    static void InitLanguagesDB();
 
-    wxString       m_strLocale,     // this locale name
-                   m_strShort;      // short name for the locale
+    wxString       m_strLocale,       // this locale name
+                   m_strShort;        // short name for the locale
+    int            m_language;        // this locale wxLanguage value
 
-    const char    *m_pszOldLocale;  // previous locale from setlocale()
-    wxLocale      *m_pOldLocale;    // previous wxLocale
+    const wxChar  *m_pszOldLocale;    // previous locale from setlocale()
+    wxLocale      *m_pOldLocale;      // previous wxLocale
 
-    wxMsgCatalog  *m_pMsgCat;       // pointer to linked list of catalogs
+    wxMsgCatalog  *m_pMsgCat;         // pointer to linked list of catalogs
+    
+    bool           m_bConvertEncoding;
+
+    static wxLanguageInfoArray *ms_languagesDB;
 };
 
 // ----------------------------------------------------------------------------
@@ -128,11 +463,34 @@ private:
 extern WXDLLEXPORT wxLocale* wxGetLocale();
 
 // get the translation of the string in the current locale
-inline const char *wxGetTranslation(const char *sz)
+inline const wxMB2WXbuf wxGetTranslation(const wxChar *sz)
 {
     wxLocale *pLoc = wxGetLocale();
-    return pLoc ? pLoc->GetString(sz) : sz;
+    if (pLoc)
+        return pLoc->GetString(sz);
+    else
+        return (const wxMB2WXbuf)sz;
 }
 
+#else // !wxUSE_INTL
+
+// the macros should still be defined - otherwise compilation would fail
+
+#if !defined(WXINTL_NO_GETTEXT_MACRO) && !defined(_)
+    #define   _(str)  (str)
+#endif
+
+#define wxTRANSLATE(str) _T(str)
+
+inline const wxChar *wxGetTranslation(const wxChar *sz) { return 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)
+#endif
+
 #endif
     // _WX_INTLH__