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