| 1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: intl.h |
| 3 | // Purpose: Internationalization and localisation for wxWindows |
| 4 | // Author: Vadim Zeitlin |
| 5 | // Modified by: |
| 6 | // Created: 29/01/98 |
| 7 | // RCS-ID: $Id$ |
| 8 | // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr> |
| 9 | // Licence: wxWindows license |
| 10 | ///////////////////////////////////////////////////////////////////////////// |
| 11 | |
| 12 | #ifndef __INTLH__ |
| 13 | #define __INTLH__ |
| 14 | |
| 15 | #ifdef __GNUG__ |
| 16 | #pragma interface "intl.h" |
| 17 | #endif |
| 18 | |
| 19 | #include "wx/defs.h" |
| 20 | #include "wx/string.h" |
| 21 | |
| 22 | #if wxUSE_INTL |
| 23 | |
| 24 | // ============================================================================ |
| 25 | // global decls |
| 26 | // ============================================================================ |
| 27 | |
| 28 | // ---------------------------------------------------------------------------- |
| 29 | // macros |
| 30 | // ---------------------------------------------------------------------------- |
| 31 | |
| 32 | // gettext() style macro (notice that xgettext should be invoked with "-k_" |
| 33 | // option to extract the strings inside _() from the sources) |
| 34 | #ifndef WXINTL_NO_GETTEXT_MACRO |
| 35 | #define _(str) wxGetTranslation(wxT(str)) |
| 36 | #endif |
| 37 | |
| 38 | // another one which just marks the strings for extraction, but doesn't |
| 39 | // perform the translation (use -kwxTRANSLATE with xgettext!) |
| 40 | #define wxTRANSLATE(str) wxT(str) |
| 41 | |
| 42 | // ---------------------------------------------------------------------------- |
| 43 | // forward decls |
| 44 | // ---------------------------------------------------------------------------- |
| 45 | class WXDLLEXPORT wxLocale; |
| 46 | class WXDLLEXPORT wxMsgCatalog; |
| 47 | |
| 48 | // ============================================================================ |
| 49 | // locale support |
| 50 | // ============================================================================ |
| 51 | |
| 52 | // ---------------------------------------------------------------------------- |
| 53 | // wxLocale: encapsulates all language dependent settings, including current |
| 54 | // message catalogs, date, time and currency formats (TODO) &c |
| 55 | // ---------------------------------------------------------------------------- |
| 56 | class WXDLLEXPORT wxLocale |
| 57 | { |
| 58 | public: |
| 59 | // ctor & dtor |
| 60 | // ----------- |
| 61 | |
| 62 | // call Init() if you use this ctor |
| 63 | wxLocale(); |
| 64 | // the ctor has a side effect of changing current locale |
| 65 | wxLocale(const wxChar *szName, // name (for messages) |
| 66 | const wxChar *szShort = (const wxChar *) NULL, // dir prefix (for msg files) |
| 67 | const wxChar *szLocale = (const wxChar *) NULL, // locale (for setlocale) |
| 68 | bool bLoadDefault = TRUE) // preload wxstd.mo? |
| 69 | { Init(szName, szShort, szLocale, bLoadDefault); } |
| 70 | // the same as a function (returns TRUE on success) |
| 71 | bool Init(const wxChar *szName, |
| 72 | const wxChar *szShort = (const wxChar *) NULL, |
| 73 | const wxChar *szLocale = (const wxChar *) NULL, |
| 74 | bool bLoadDefault = TRUE); |
| 75 | // restores old locale |
| 76 | ~wxLocale(); |
| 77 | |
| 78 | // returns locale name |
| 79 | const wxChar *GetLocale() const { return m_strLocale; } |
| 80 | |
| 81 | // add a prefix to the catalog lookup path: the message catalog files will be |
| 82 | // looked up under prefix/<lang>/LC_MESSAGES, prefix/LC_MESSAGES and prefix |
| 83 | // (in this order). |
| 84 | // |
| 85 | // This only applies to subsequent invocations of AddCatalog()! |
| 86 | static void AddCatalogLookupPathPrefix(const wxString& prefix); |
| 87 | |
| 88 | // add a catalog: it's searched for in standard places (current directory |
| 89 | // first, system one after), but the you may prepend additional directories to |
| 90 | // the search path with AddCatalogLookupPathPrefix(). |
| 91 | // |
| 92 | // The loaded catalog will be used for message lookup by GetString(). |
| 93 | // |
| 94 | // Returns 'true' if it was successfully loaded |
| 95 | bool AddCatalog(const wxChar *szDomain); |
| 96 | |
| 97 | // check if the given catalog is loaded |
| 98 | bool IsLoaded(const wxChar *szDomain) const; |
| 99 | |
| 100 | // retrieve the translation for a string in all loaded domains unless |
| 101 | // the szDomain parameter is specified (and then only this domain is |
| 102 | // searched) |
| 103 | // |
| 104 | // return original string if translation is not available |
| 105 | // (in this case an error message is generated the first time |
| 106 | // a string is not found; use wxLogNull to suppress it) |
| 107 | // |
| 108 | // domains are searched in the last to first order, i.e. catalogs |
| 109 | // added later override those added before. |
| 110 | const wxMB2WXbuf GetString(const wxChar *szOrigString, |
| 111 | const wxChar *szDomain = (const wxChar *) NULL) const; |
| 112 | |
| 113 | // Returns the current short name for the locale |
| 114 | const wxString& GetName() const { return m_strShort; } |
| 115 | |
| 116 | private: |
| 117 | // find catalog by name in a linked list, return NULL if !found |
| 118 | wxMsgCatalog *FindCatalog(const wxChar *szDomain) const; |
| 119 | |
| 120 | wxString m_strLocale, // this locale name |
| 121 | m_strShort; // short name for the locale |
| 122 | |
| 123 | const wxChar *m_pszOldLocale; // previous locale from setlocale() |
| 124 | wxLocale *m_pOldLocale; // previous wxLocale |
| 125 | |
| 126 | wxMsgCatalog *m_pMsgCat; // pointer to linked list of catalogs |
| 127 | }; |
| 128 | |
| 129 | // ---------------------------------------------------------------------------- |
| 130 | // global functions |
| 131 | // ---------------------------------------------------------------------------- |
| 132 | |
| 133 | // get the current locale object (note that it may be NULL!) |
| 134 | extern WXDLLEXPORT wxLocale* wxGetLocale(); |
| 135 | |
| 136 | // get the translation of the string in the current locale |
| 137 | inline const wxMB2WXbuf wxGetTranslation(const wxChar *sz) |
| 138 | { |
| 139 | wxLocale *pLoc = wxGetLocale(); |
| 140 | if (pLoc) |
| 141 | return pLoc->GetString(sz); |
| 142 | else |
| 143 | return (const wxMB2WXbuf)sz; |
| 144 | } |
| 145 | |
| 146 | #else // !wxUSE_INTL |
| 147 | |
| 148 | #ifndef WXINTL_NO_GETTEXT_MACRO |
| 149 | #define _(str) (str) |
| 150 | #endif |
| 151 | |
| 152 | inline const wxChar *wxGetTranslation(const wxChar *sz) { return sz; } |
| 153 | |
| 154 | #endif // wxUSE_INTL/!wxUSE_INTL |
| 155 | |
| 156 | #endif |
| 157 | // _WX_INTLH__ |