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