Change GetC to return an int so that it can return wxEOF on error.

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

diff --git a/include/wx/intl.h b/include/wx/intl.h
index df82d4d49aef077397851f9194ce30807da7f462..471d9ad9bab693c51aa48737108a68fa31313421 100644 (file)
--- a/include/wx/intl.h
+++ b/include/wx/intl.h
@@ -1,8 +1,9 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/intl.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/intl.h

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

 // Author:      Vadim Zeitlin
 // Author:      Vadim Zeitlin

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

 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>


@@ -12,13 +13,19 @@
 #ifndef _WX_INTL_H_
 #define _WX_INTL_H_
 
 #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"
 
 #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"


@@ -31,10 +38,12 @@
 // macros
 // ----------------------------------------------------------------------------
 
 // 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
 #ifndef WXINTL_NO_GETTEXT_MACRO

-    #define   _(str)  wxGetTranslation(_T(str))
+    #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


@@ -45,9 +54,9 @@
 // forward decls
 // ----------------------------------------------------------------------------
 
 // forward decls
 // ----------------------------------------------------------------------------
 

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

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


@@ -308,7 +317,7 @@ enum wxLanguage
 //                 translation information
 // ----------------------------------------------------------------------------
 
 //                 translation information
 // ----------------------------------------------------------------------------
 

-struct WXDLLEXPORT wxLanguageInfo
+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


@@ -317,6 +326,7 @@ struct WXDLLEXPORT 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;

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


@@ -362,43 +372,50 @@ enum wxLocaleInitFlags
     wxLOCALE_CONV_ENCODING = 0x0002      // convert encoding on the fly?
 };
 
     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
 {
 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)
         // 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?
+             bool bLoadDefault = true,                           // preload wxstd.mo?
+             bool bConvertEncoding = false)                      // convert Win<->Unix if necessary?

         {
         {

+            DoCommonInit();
+

             Init(szName, szShort, szLocale, bLoadDefault, bConvertEncoding);
         }
 
     wxLocale(int language, // wxLanguage id or custom language
              int flags = wxLOCALE_LOAD_DEFAULT | wxLOCALE_CONV_ENCODING)
             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); }
+        {
+            DoCommonInit();
+
+            Init(language, flags);
+        }

 
 

-        // 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 wxChar *szName,
               const wxChar *szShort = (const wxChar *) NULL,
               const wxChar *szLocale = (const wxChar *) NULL,

-              bool bLoadDefault = TRUE,
-              bool bConvertEncoding = FALSE);
+              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
     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();
 


@@ -414,7 +431,7 @@ 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


@@ -446,6 +463,11 @@ public:
     //
     // Returns 'true' if it was successfully loaded
     bool AddCatalog(const wxChar *szDomain);
     //
     // Returns 'true' if it was successfully loaded
     bool AddCatalog(const wxChar *szDomain);

+    bool AddCatalog(const wxChar *szDomain,
+                    wxLanguage msgIdLanguage, const wxChar *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;
 
     // check if the given catalog is loaded
     bool IsLoaded(const wxChar *szDomain) const;


@@ -455,6 +477,10 @@ public:
     // Returns NULL if no info found, pointer must *not* be deleted by caller
     static const wxLanguageInfo *GetLanguageInfo(int lang);
 
     // 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...")
     // 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)
     // 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
     //
     // return original string if translation is not available
     // (in this case an error message is generated the first time


@@ -477,12 +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 wxChar *GetString(const wxChar *szOrigString,
+                                    const wxChar *szDomain = NULL) 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;

 
     // 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 wxChar* szHeader,
+                             const wxChar* szDomain = NULL ) 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.


@@ -497,6 +533,9 @@ private:
     // m_langugagesInfo, called by InitLanguagesDB
     static void InitLanguagesDB();
 
     // 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


@@ -508,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)


@@ -518,24 +559,35 @@ private:
 // ----------------------------------------------------------------------------
 
 // get the current locale object (note that it may be NULL!)
 // ----------------------------------------------------------------------------
 
 // 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
 
 // get the translation of the string in the current locale

-inline const wxChar *wxGetTranslation(const wxChar *sz)
+inline const wxChar *wxGetTranslation(const wxChar *sz, const wxChar* domain=NULL)

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

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

     else
         return sz;
 }
     else
         return sz;
 }

+inline const wxChar *wxGetTranslation(const wxChar *sz1, const wxChar *sz2,
+                                      size_t n, const wxChar* domain=NULL)
+{
+    wxLocale *pLoc = wxGetLocale();
+    if (pLoc)
+        return pLoc->GetString(sz1, sz2, n, domain);
+    else
+        return n == 1 ? sz1 : sz2;
+}

 
 #else // !wxUSE_INTL
 
 // the macros should still be defined - otherwise compilation would fail
 
 
 #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)                 (_T(s))
+    #endif

 #endif
 
 #define wxTRANSLATE(str) _T(str)
 #endif
 
 #define wxTRANSLATE(str) _T(str)


@@ -548,9 +600,13 @@ inline const wxChar *wxGetTranslation(const wxChar *sz)
 
 // define this one just in case it occurs somewhere (instead of preferred
 // wxTRANSLATE) too
 
 // 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) _T(str)
+    #endif
+    #if !defined(N_)
+        #define N_(s)             _T(s)
+    #endif

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

-