include/wx/intl.h

   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 // ============================================================================
  23 // global decls
  24 // ============================================================================
  25
  26 // ----------------------------------------------------------------------------
  27 // simple types
  28 // ----------------------------------------------------------------------------
  29
  30 // # adjust if necessary
  31 typedef unsigned char size_t8;
  32 typedef unsigned long size_t32;
  33
  34 // ----------------------------------------------------------------------------
  35 // macros
  36 // ----------------------------------------------------------------------------
  37
  38 // gettext() style macro
  39 #ifndef WXINTL_NO_GETTEXT_MACRO
  40 #define   _(str)  wxGetTranslation(str)
  41 #endif
  42
  43 // ----------------------------------------------------------------------------
  44 // forward decls
  45 // ----------------------------------------------------------------------------
  46 class WXDLLEXPORT wxLocale;
  47 class WXDLLEXPORT wxMsgCatalog;
  48 extern WXDLLEXPORT_DATA(wxLocale *) g_pLocale;
  49
  50 // ============================================================================
  51 // locale support
  52 // ============================================================================
  53
  54 // ----------------------------------------------------------------------------
  55 // wxLocale: encapsulates all language dependent settings, including current
  56 //           message catalogs, date, time and currency formats (#### to do) &c
  57 // ----------------------------------------------------------------------------
  58 class WXDLLEXPORT wxLocale
  59 {
  60 public:
  61   // ctor & dtor
  62     // call Init() if you use this ctor
  63   wxLocale();
  64     // the ctor has a side effect of changing current locale
  65   wxLocale(const char *szName,              // name (for messages)
  66            const char *szShort = (const char *) NULL,      // dir prefix (for msg files)
  67            const char *szLocale = (const char *) 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 char *szName,
  72             const char *szShort = (const char *) NULL,
  73             const char *szLocale = (const char *) NULL,
  74             bool bLoadDefault = TRUE);
  75     // restores old locale
  76  ~wxLocale();
  77
  78   // returns locale name
  79   const char *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 char *szDomain);
  96
  97   // check if the given catalog is loaded
  98   bool IsLoaded(const char *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 char *GetString(const char *szOrigString,
 111                         const char *szDomain = (const char *) NULL) const;
 112
 113 private:
 114   // find catalog by name in a linked list, return NULL if !found
 115   wxMsgCatalog  *FindCatalog(const char *szDomain) const;
 116
 117   wxString       m_strLocale,     // this locale name
 118                  m_strShort;      // short name for the locale
 119
 120   const char    *m_pszOldLocale;  // previous locale from setlocale()
 121   wxLocale      *m_pOldLocale;    // previous wxLocale
 122
 123   wxMsgCatalog  *m_pMsgCat;       // pointer to linked list of catalogs
 124 };
 125
 126 // ----------------------------------------------------------------------------
 127 // global functions
 128 // ----------------------------------------------------------------------------
 129 WXDLLEXPORT wxLocale* wxGetLocale();
 130
 131 // get the translation of the string in the current locale
 132 inline const char *wxGetTranslation(const char *sz)
 133 {
 134   wxLocale *pLoc = wxGetLocale();
 135   return pLoc == (wxLocale *) NULL ? sz : pLoc->GetString(sz);
 136 }
 137
 138 #endif
 139         // _WX_INTLH__