src/gettext.h

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