no changes, just fix typo in variable name

[wxWidgets.git] / include / wx / intl.h

diff --git a/include/wx/intl.h b/include/wx/intl.h
index 8a72c6179655dfd2a1c166de0b76e15d62c32c69..54c1b9734fff4a575d6759f9aca97f751922e15c 100644 (file)
--- a/include/wx/intl.h
+++ b/include/wx/intl.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/intl.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/intl.h

-// Purpose:     Internationalization and localisation for wxWindows
+// Purpose:     Internationalization and localisation for wxWidgets

 // Author:      Vadim Zeitlin
 // Modified by: Michael N. Filippov <michael@idisys.iae.nsk.su>
 //              (2003/09/30 - plural forms support)
 // Author:      Vadim Zeitlin
 // Modified by: Michael N. Filippov <michael@idisys.iae.nsk.su>
 //              (2003/09/30 - plural forms support)


@@ -10,16 +10,25 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

+// WARNING: Parts of this file are generated. See misc/languages/README for
+// details.
+

 #ifndef _WX_INTL_H_
 #define _WX_INTL_H_
 
 #ifndef _WX_INTL_H_
 #define _WX_INTL_H_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "intl.h"
-#endif
-

 #include "wx/defs.h"
 #include "wx/string.h"
 
 #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"
 #if wxUSE_INTL
 
 #include "wx/fontenc.h"


@@ -32,24 +41,25 @@
 // macros
 // ----------------------------------------------------------------------------
 
 // macros
 // ----------------------------------------------------------------------------
 

-// gettext() style macros (notice that xgettext should be invoked with 
-// --keyword="_" --keyword="wxGetTranslation:1,2" options
+// 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
 // to extract the strings from the sources)
 #ifndef WXINTL_NO_GETTEXT_MACRO

-    #define _(s)                  wxGetTranslation(_T(s))
+    #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!)
 #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
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // forward decls
 // ----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_BASE wxLocale;
-class WXDLLIMPEXP_BASE wxMsgCatalog;
-class WXDLLIMPEXP_BASE wxLanguageInfoArray;
+class WXDLLIMPEXP_FWD_BASE wxLocale;
+class WXDLLIMPEXP_FWD_BASE wxLanguageInfoArray;
+class wxMsgCatalog;

 
 // ============================================================================
 // locale support
 
 // ============================================================================
 // locale support


@@ -289,6 +299,7 @@ enum wxLanguage
     wxLANGUAGE_UZBEK,
     wxLANGUAGE_UZBEK_CYRILLIC,
     wxLANGUAGE_UZBEK_LATIN,
     wxLANGUAGE_UZBEK,
     wxLANGUAGE_UZBEK_CYRILLIC,
     wxLANGUAGE_UZBEK_LATIN,

+    wxLANGUAGE_VALENCIAN,

     wxLANGUAGE_VIETNAMESE,
     wxLANGUAGE_VOLAPUK,
     wxLANGUAGE_WELSH,
     wxLANGUAGE_VIETNAMESE,
     wxLANGUAGE_VOLAPUK,
     wxLANGUAGE_WELSH,


@@ -314,13 +325,29 @@ struct WXDLLIMPEXP_BASE wxLanguageInfo
 {
     int Language;                   // wxLanguage id
     wxString CanonicalName;         // Canonical name, e.g. fr_FR
 {
     int Language;                   // wxLanguage id
     wxString CanonicalName;         // Canonical name, e.g. fr_FR

-#ifdef __WIN32__
+#ifdef __WXMSW__

     wxUint32 WinLang,               // Win32 language identifiers
              WinSublang;
     wxUint32 WinLang,               // Win32 language identifiers
              WinSublang;

-#endif // __WIN32__
+#endif // __WXMSW__

     wxString Description;           // human-readable name of the language
     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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxLocaleCategory: the category of locale settings
 // ----------------------------------------------------------------------------


@@ -374,15 +401,15 @@ public:
     wxLocale() { DoCommonInit(); }
 
         // the ctor has a side effect of changing current locale
     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 bLoadDefault = true,                           // preload wxstd.mo?

-             bool bConvertEncoding = false)                      // convert Win<->Unix if neccessary?
+             bool bConvertEncoding = false)                      // convert Win<->Unix if necessary?

         {
             DoCommonInit();
 
         {
             DoCommonInit();
 

-            Init(szName, szShort, szLocale, bLoadDefault, bConvertEncoding);
+            Init(name, shortName, locale, bLoadDefault, bConvertEncoding);

         }
 
     wxLocale(int language, // wxLanguage id or custom language
         }
 
     wxLocale(int language, // wxLanguage id or custom language


@@ -394,9 +421,9 @@ public:
         }
 
         // 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 Init(const wxString& name,
+              const wxString& shortName = wxEmptyString,
+              const wxString& locale = wxEmptyString,

               bool bLoadDefault = true,
               bool bConvertEncoding = false);
 
               bool bLoadDefault = true,
               bool bConvertEncoding = false);
 


@@ -405,9 +432,9 @@ public:
               int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING);
 
         // restores old locale
               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();
 
     // Return wxLANGUAGE_UNKNOWN if language-guessing algorithm failed
     static int GetSystemLanguage();
 


@@ -427,7 +454,7 @@ public:
     bool IsOk() const { return m_pszOldLocale != NULL; }
 
     // returns locale name
     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; }
 
     // return current locale wxLanguage value
     int GetLanguage() const { return m_language; }


@@ -454,10 +481,15 @@ public:
     // The loaded catalog will be used for message lookup by GetString().
     //
     // Returns 'true' if it was successfully loaded
     // 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
 
     // 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
     //
 
     // Retrieve the language info struct for the given language
     //


@@ -491,17 +523,26 @@ public:
     //
     // domains are searched in the last to first order, i.e. catalogs
     // added later override those added before.
     //
     // 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:
     // plural form version of the same:

-    const wxChar *GetString(const wxChar *szOrigString,
-                            const wxChar *szOrigString2,
-                            size_t n,
-                            const wxChar *szDomain = (const wxChar *) 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; }
 
 
     // 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.
     // These two methods are for internal use only. First one creates
     // ms_languagesDB if it doesn't already exist, second one destroys
     // it.


@@ -510,7 +551,7 @@ public:
 
 private:
     // find catalog by name in a linked list, return NULL if !found
 
 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
 
     // copy default table of languages from global static array to
     // m_langugagesInfo, called by InitLanguagesDB


@@ -523,7 +564,7 @@ private:
                    m_strShort;        // short name for the locale
     int            m_language;        // this locale wxLanguage value
 
                    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
     wxLocale      *m_pOldLocale;      // previous wxLocale
 
     wxMsgCatalog  *m_pMsgCat;         // pointer to linked list of catalogs


@@ -545,22 +586,31 @@ private:
 extern WXDLLIMPEXP_BASE wxLocale* wxGetLocale();
 
 // get the translation of the string in the current locale
 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)
 {
     wxLocale *pLoc = wxGetLocale();
     if (pLoc)

-        return pLoc->GetString(sz);
+        return pLoc->GetString(str, domain);

     else
     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)
+inline const wxString& wxGetTranslation(const wxString& str1,
+                                        const wxString& str2,
+                                        size_t n,
+                                        const wxString& domain = wxEmptyString)

 {
     wxLocale *pLoc = wxGetLocale();
     if (pLoc)
 {
     wxLocale *pLoc = wxGetLocale();
     if (pLoc)

-        return pLoc->GetString(sz1, sz2, n);
+        return pLoc->GetString(str1, str2, n, domain);

     else
     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
 }
 
 #else // !wxUSE_INTL


@@ -569,15 +619,34 @@ inline const wxChar *wxGetTranslation(const wxChar *sz1, const wxChar *sz2,
 
 #if !defined(WXINTL_NO_GETTEXT_MACRO)
     #if !defined(_)
 
 #if !defined(WXINTL_NO_GETTEXT_MACRO)
     #if !defined(_)

-        #define _(s)                 (_T(s))
+        #define _(s)                 (s)

     #endif
     #endif

+    #define wxPLURAL(sing, plur, n)  ((n) == 1 ? (sing) : (plur))

 #endif
 
 #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

 
 

-// 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<typename TString>
+inline TString wxGetTranslation(TString str)
+    { return str; }
+
+template<typename TString, typename TDomain>
+inline TString wxGetTranslation(TString str, TDomain WXUNUSED(domain))
+    { return str; }
+
+template<typename TString, typename TDomain>
+inline TString wxGetTranslation(TString str1, TString str2, size_t n)
+    { return n == 1 ? str1 : str2; }
+
+template<typename TString, typename TDomain>
+inline TString wxGetTranslation(TString str1, TString str2, size_t n,
+                                TDomain WXUNUSED(domain))
+    { return n == 1 ? str1 : str2; }

 
 #endif // wxUSE_INTL/!wxUSE_INTL
 
 
 #endif // wxUSE_INTL/!wxUSE_INTL
 


@@ -585,12 +654,11 @@ inline const wxChar *wxGetTranslation(const wxChar *sz1, const wxChar *sz2,
 // wxTRANSLATE) too
 #if !defined(WXINTL_NO_GETTEXT_MACRO)
     #if !defined(gettext_noop)
 // 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_)
     #endif
     #if !defined(N_)

-        #define N_(s)             _T(s)
+        #define N_(s)             (s)

     #endif
 #endif
 
 #endif // _WX_INTL_H_
     #endif
 #endif
 
 #endif // _WX_INTL_H_

-