Bakefile and other changes for new locations of STC and wxSVGFileDC.

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

diff --git a/include/wx/intl.h b/include/wx/intl.h
index 56e21256a9b45be0cae1aaec4ba87a0cff64b0d4..ba26a162954ddf12c3c4d4bbbd83a6fca2315331 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)


@@ -13,13 +13,19 @@
 #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,12 +38,12 @@
 // macros
 // ----------------------------------------------------------------------------
 
 // macros
 // ----------------------------------------------------------------------------
 

-// gettext() style macros (notice that xgettext should be invoked with 
-// --keyword="_" --keyword="ngettext: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 ngettext(s1, s2, n)   wxGetTranslation(_T(s1), _T(s2), n)
+    #define _(s)                     wxGetTranslation(_T(s))
+    #define wxPLURAL(sing, plur, n)  wxGetTranslation(_T(sing), _T(plur), n)

 #endif
 
 // another one which just marks the strings for extraction, but doesn't
 #endif
 
 // another one which just marks the strings for extraction, but doesn't


@@ -49,8 +55,8 @@
 // ----------------------------------------------------------------------------
 
 class WXDLLIMPEXP_BASE wxLocale;
 // ----------------------------------------------------------------------------
 
 class WXDLLIMPEXP_BASE wxLocale;

-class WXDLLIMPEXP_BASE wxMsgCatalog;

 class WXDLLIMPEXP_BASE wxLanguageInfoArray;
 class WXDLLIMPEXP_BASE wxLanguageInfoArray;

+class wxMsgCatalog;

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


@@ -320,6 +326,7 @@ struct WXDLLIMPEXP_BASE wxLanguageInfo
              WinSublang;
 #endif // __WIN32__
     wxString Description;           // human-readable name of the language
              WinSublang;
 #endif // __WIN32__
     wxString Description;           // human-readable name of the language

+    wxLayoutDirection LayoutDirection;

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -372,36 +379,43 @@ public:
     // -----------
 
         // call Init() if you use this ctor
     // -----------
 
         // call Init() if you use this ctor

-    wxLocale();
+    wxLocale() { DoCommonInit(); }
+

         // the ctor has a side effect of changing current locale
         // 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)
         }
 
     wxLocale(int language, // wxLanguage id or custom language
              int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING)

-        { Init(language, flags); }
+        {
+            DoCommonInit();

 
 

-        // 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);
+            Init(language, flags);
+        }

 
 

-        // same as second ctor (returns TRUE on success)
+        // 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)

     bool Init(int language = wxLANGUAGE_DEFAULT,
               int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING);
 
         // restores old locale
     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();
 
     // Return wxLANGUAGE_UNKNOWN if language-guessing algorithm failed
     static int GetSystemLanguage();
 


@@ -417,11 +431,11 @@ public:
     // is used, the US default value is returned if everything else fails
     static wxString GetInfo(wxLocaleInfo index, wxLocaleCategory cat);
 
     // 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
     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; }


@@ -448,10 +462,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
     //


@@ -485,17 +504,21 @@ 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;

 
     // 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.


@@ -504,12 +527,15 @@ 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
     static void InitLanguagesDB();
 
 
     // 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
     wxString       m_strLocale,       // this locale name
                    m_strShort;        // short name for the locale
     int            m_language;        // this locale wxLanguage value


@@ -521,6 +547,8 @@ private:
 
     bool           m_bConvertEncoding;
 
 
     bool           m_bConvertEncoding;
 

+    bool           m_initialized;
+

     static wxLanguageInfoArray *ms_languagesDB;
 
     DECLARE_NO_COPY_CLASS(wxLocale)
     static wxLanguageInfoArray *ms_languagesDB;
 
     DECLARE_NO_COPY_CLASS(wxLocale)


@@ -534,22 +562,25 @@ 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;
+        return 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;
+        return n == 1 ? str1 : str2;

 }
 
 #else // !wxUSE_INTL
 }
 
 #else // !wxUSE_INTL


@@ -560,16 +591,15 @@ inline const wxChar *wxGetTranslation(const wxChar *sz1, const wxChar *sz2,
     #if !defined(_)
         #define _(s)                 (_T(s))
     #endif
     #if !defined(_)
         #define _(s)                 (_T(s))
     #endif

-    #if !defined(ngettext)
-        #define ngettext(s1, s2, n)  ((n) == 1 ? _T(s1) : _T(s2))
-    #endif

 #endif
 
 #define wxTRANSLATE(str) _T(str)
 
 #endif
 
 #define wxTRANSLATE(str) _T(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)
+inline const wxString& wxGetTranslation(const wxString& str,
+                                        const wxString& WXUNUSED(domain) = wxEmptyString)
+{
+    return str;
+}

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


@@ -585,4 +615,3 @@ inline const wxChar *wxGetTranslation(const wxChar *sz1, const wxChar *sz2,
 #endif
 
 #endif // _WX_INTL_H_
 #endif
 
 #endif // _WX_INTL_H_

-