lib/gettext.h

   1 /* Convenience header for conditional use of GNU <libintl.h>.
   2    Copyright (C) 1995-1998, 2000-2002, 2004-2006 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify it
   5    under the terms of the GNU Library General Public License as published
   6    by the Free Software Foundation; either version 2, or (at your option)
   7    any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    Library General Public License for more details.
  13
  14    You should have received a copy of the GNU Library General Public
  15    License along with this program; if not, write to the Free Software
  16    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
  17    USA.  */
  18
  19 #ifndef _LIBGETTEXT_H
  20 #define _LIBGETTEXT_H 1
  21
  22 /* NLS can be disabled through the configure --disable-nls option.
  23  *
  24  * Extra hack in LZMA Utils: if DISABLE_NLS is defined, NLS is disabled
  25  * even if ENABLE_NLS is true. See Makefile.am for more information.
  26  */
  27 #if ENABLE_NLS && !defined(DISABLE_NLS)
  28
  29 /* Get declarations of GNU message catalog functions.  */
  30 # include <libintl.h>
  31
  32 /* You can set the DEFAULT_TEXT_DOMAIN macro to specify the domain used by
  33    the gettext() and ngettext() macros.  This is an alternative to calling
  34    textdomain(), and is useful for libraries.  */
  35 # ifdef DEFAULT_TEXT_DOMAIN
  36 #  undef gettext
  37 #  define gettext(Msgid) \
  38      dgettext (DEFAULT_TEXT_DOMAIN, Msgid)
  39 #  undef ngettext
  40 #  define ngettext(Msgid1, Msgid2, N) \
  41      dngettext (DEFAULT_TEXT_DOMAIN, Msgid1, Msgid2, N)
  42 # endif
  43
  44 #else
  45
  46 /* Solaris /usr/include/locale.h includes /usr/include/libintl.h, which
  47    chokes if dcgettext is defined as a macro.  So include it now, to make
  48    later inclusions of <locale.h> a NOP.  We don't include <libintl.h>
  49    as well because people using "gettext.h" will not include <libintl.h>,
  50    and also including <libintl.h> would fail on SunOS 4, whereas <locale.h>
  51    is OK.  */
  52 #if defined(__sun)
  53 # include <locale.h>
  54 #endif
  55
  56 /* Many header files from the libstdc++ coming with g++ 3.3 or newer include
  57    <libintl.h>, which chokes if dcgettext is defined as a macro.  So include
  58    it now, to make later inclusions of <libintl.h> a NOP.  */
  59 #if defined(__cplusplus) && defined(__GNUG__) && (__GNUC__ >= 3)
  60 # include <cstdlib>
  61 # if (__GLIBC__ >= 2) || _GLIBCXX_HAVE_LIBINTL_H
  62 #  include <libintl.h>
  63 # endif
  64 #endif
  65
  66 /* Disabled NLS.
  67    The casts to 'const char *' serve the purpose of producing warnings
  68    for invalid uses of the value returned from these functions.
  69    On pre-ANSI systems without 'const', the config.h file is supposed to
  70    contain "#define const".  */
  71 # define gettext(Msgid) ((const char *) (Msgid))
  72 # define dgettext(Domainname, Msgid) ((const char *) (Msgid))
  73 # define dcgettext(Domainname, Msgid, Category) ((const char *) (Msgid))
  74 # define ngettext(Msgid1, Msgid2, N) \
  75     ((N) == 1 ? (const char *) (Msgid1) : (const char *) (Msgid2))
  76 # define dngettext(Domainname, Msgid1, Msgid2, N) \
  77     ((N) == 1 ? (const char *) (Msgid1) : (const char *) (Msgid2))
  78 # define dcngettext(Domainname, Msgid1, Msgid2, N, Category) \
  79     ((N) == 1 ? (const char *) (Msgid1) : (const char *) (Msgid2))
  80 # define textdomain(Domainname) ((const char *) (Domainname))
  81 # define bindtextdomain(Domainname, Dirname) ((const char *) (Dirname))
  82 # define bind_textdomain_codeset(Domainname, Codeset) ((const char *) (Codeset))
  83
  84 #endif
  85
  86 /* A pseudo function call that serves as a marker for the automated
  87    extraction of messages, but does not call gettext().  The run-time
  88    translation is done at a different place in the code.
  89    The argument, String, should be a literal string.  Concatenated strings
  90    and other string expressions won't work.
  91    The macro's expansion is not parenthesized, so that it is suitable as
  92    initializer for static 'char[]' or 'const char[]' variables.  */
  93 #define gettext_noop(String) String
  94
  95 /* The separator between msgctxt and msgid in a .mo file.  */
  96 #define GETTEXT_CONTEXT_GLUE "\004"
  97
  98 /* Pseudo function calls, taking a MSGCTXT and a MSGID instead of just a
  99    MSGID.  MSGCTXT and MSGID must be string literals.  MSGCTXT should be
 100    short and rarely need to change.
 101    The letter 'p' stands for 'particular' or 'special'.  */
 102 #ifdef DEFAULT_TEXT_DOMAIN
 103 # define pgettext(Msgctxt, Msgid) \
 104    pgettext_aux (DEFAULT_TEXT_DOMAIN, Msgctxt GETTEXT_CONTEXT_GLUE Msgid, Msgid, LC_MESSAGES)
 105 #else
 106 # define pgettext(Msgctxt, Msgid) \
 107    pgettext_aux (NULL, Msgctxt GETTEXT_CONTEXT_GLUE Msgid, Msgid, LC_MESSAGES)
 108 #endif
 109 #define dpgettext(Domainname, Msgctxt, Msgid) \
 110   pgettext_aux (Domainname, Msgctxt GETTEXT_CONTEXT_GLUE Msgid, Msgid, LC_MESSAGES)
 111 #define dcpgettext(Domainname, Msgctxt, Msgid, Category) \
 112   pgettext_aux (Domainname, Msgctxt GETTEXT_CONTEXT_GLUE Msgid, Msgid, Category)
 113 #ifdef DEFAULT_TEXT_DOMAIN
 114 # define npgettext(Msgctxt, Msgid, MsgidPlural, N) \
 115    npgettext_aux (DEFAULT_TEXT_DOMAIN, Msgctxt GETTEXT_CONTEXT_GLUE Msgid, Msgid, MsgidPlural, N, LC_MESSAGES)
 116 #else
 117 # define npgettext(Msgctxt, Msgid, MsgidPlural, N) \
 118    npgettext_aux (NULL, Msgctxt GETTEXT_CONTEXT_GLUE Msgid, Msgid, MsgidPlural, N, LC_MESSAGES)
 119 #endif
 120 #define dnpgettext(Domainname, Msgctxt, Msgid, MsgidPlural, N) \
 121   npgettext_aux (Domainname, Msgctxt GETTEXT_CONTEXT_GLUE Msgid, Msgid, MsgidPlural, N, LC_MESSAGES)
 122 #define dcnpgettext(Domainname, Msgctxt, Msgid, MsgidPlural, N, Category) \
 123   npgettext_aux (Domainname, Msgctxt GETTEXT_CONTEXT_GLUE Msgid, Msgid, MsgidPlural, N, Category)
 124
 125 static inline const char *
 126 pgettext_aux (const char *domain,
 127               const char *msg_ctxt_id, const char *msgid,
 128               int category)
 129 {
 130   const char *translation = dcgettext (domain, msg_ctxt_id, category);
 131   if (translation == msg_ctxt_id)
 132     return msgid;
 133   else
 134     return translation;
 135 }
 136
 137 static inline const char *
 138 npgettext_aux (const char *domain,
 139                const char *msg_ctxt_id, const char *msgid,
 140                const char *msgid_plural, unsigned long int n,
 141                int category)
 142 {
 143   const char *translation =
 144     dcngettext (domain, msg_ctxt_id, msgid_plural, n, category);
 145   if (translation == msg_ctxt_id || translation == msgid_plural)
 146     return (n == 1 ? msgid : msgid_plural);
 147   else
 148     return translation;
 149 }
 150
 151 /* The same thing extended for non-constant arguments.  Here MSGCTXT and MSGID
 152    can be arbitrary expressions.  But for string literals these macros are
 153    less efficient than those above.  */
 154
 155 #include <string.h>
 156
 157 #define _LIBGETTEXT_HAVE_VARIABLE_SIZE_ARRAYS 1
 158
 159 #if !_LIBGETTEXT_HAVE_VARIABLE_SIZE_ARRAYS
 160 #include <stdlib.h>
 161 #endif
 162
 163 #define pgettext_expr(Msgctxt, Msgid) \
 164   dcpgettext_expr (NULL, Msgctxt, Msgid, LC_MESSAGES)
 165 #define dpgettext_expr(Domainname, Msgctxt, Msgid) \
 166   dcpgettext_expr (Domainname, Msgctxt, Msgid, LC_MESSAGES)
 167
 168 static inline const char *
 169 dcpgettext_expr (const char *domain,
 170                  const char *msgctxt, const char *msgid,
 171                  int category)
 172 {
 173   size_t msgctxt_len = strlen (msgctxt) + 1;
 174   size_t msgid_len = strlen (msgid) + 1;
 175   const char *translation;
 176 #if _LIBGETTEXT_HAVE_VARIABLE_SIZE_ARRAYS
 177   char msg_ctxt_id[msgctxt_len + msgid_len];
 178 #else
 179   char buf[1024];
 180   char *msg_ctxt_id =
 181     (msgctxt_len + msgid_len <= sizeof (buf)
 182      ? buf
 183      : (char *) malloc (msgctxt_len + msgid_len));
 184   if (msg_ctxt_id != NULL)
 185 #endif
 186     {
 187       memcpy (msg_ctxt_id, msgctxt, msgctxt_len - 1);
 188       msg_ctxt_id[msgctxt_len - 1] = '\004';
 189       memcpy (msg_ctxt_id + msgctxt_len, msgid, msgid_len);
 190       translation = dcgettext (domain, msg_ctxt_id, category);
 191 #if !_LIBGETTEXT_HAVE_VARIABLE_SIZE_ARRAYS
 192       if (msg_ctxt_id != buf)
 193         free (msg_ctxt_id);
 194 #endif
 195       if (translation != msg_ctxt_id)
 196         return translation;
 197     }
 198   return msgid;
 199 }
 200
 201 #define npgettext_expr(Msgctxt, Msgid, MsgidPlural, N) \
 202   dcnpgettext_expr (NULL, Msgctxt, Msgid, MsgidPlural, N, LC_MESSAGES)
 203 #define dnpgettext_expr(Domainname, Msgctxt, Msgid, MsgidPlural, N) \
 204   dcnpgettext_expr (Domainname, Msgctxt, Msgid, MsgidPlural, N, LC_MESSAGES)
 205
 206 static inline const char *
 207 dcnpgettext_expr (const char *domain,
 208                   const char *msgctxt, const char *msgid,
 209                   const char *msgid_plural, unsigned long int n,
 210                   int category)
 211 {
 212   size_t msgctxt_len = strlen (msgctxt) + 1;
 213   size_t msgid_len = strlen (msgid) + 1;
 214   const char *translation;
 215 #if _LIBGETTEXT_HAVE_VARIABLE_SIZE_ARRAYS
 216   char msg_ctxt_id[msgctxt_len + msgid_len];
 217 #else
 218   char buf[1024];
 219   char *msg_ctxt_id =
 220     (msgctxt_len + msgid_len <= sizeof (buf)
 221      ? buf
 222      : (char *) malloc (msgctxt_len + msgid_len));
 223   if (msg_ctxt_id != NULL)
 224 #endif
 225     {
 226       memcpy (msg_ctxt_id, msgctxt, msgctxt_len - 1);
 227       msg_ctxt_id[msgctxt_len - 1] = '\004';
 228       memcpy (msg_ctxt_id + msgctxt_len, msgid, msgid_len);
 229       translation = dcngettext (domain, msg_ctxt_id, msgid_plural, n, category);
 230 #if !_LIBGETTEXT_HAVE_VARIABLE_SIZE_ARRAYS
 231       if (msg_ctxt_id != buf)
 232         free (msg_ctxt_id);
 233 #endif
 234       if (!(translation == msg_ctxt_id || translation == msgid_plural))
 235         return translation;
 236     }
 237   return (n == 1 ? msgid : msgid_plural);
 238 }
 239
 240 #endif /* _LIBGETTEXT_H */