1 /* Header describing internals of libintl library.
2 Copyright (C) 1995-2023 Free Software Foundation, Inc.
3 Written by Ulrich Drepper <drepper@cygnus.com>, 1995.
4
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
9
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 Lesser General Public License for more details.
14
15 You should have received a copy of the GNU Lesser General Public License
16 along with this program. If not, see <https://www.gnu.org/licenses/>. */
17
18 #ifndef _GETTEXTP_H
19 #define _GETTEXTP_H
20
21 #include <stddef.h> /* Get size_t. */
22
23 #ifdef _LIBC
24 # include "../iconv/gconv_int.h"
25 #else
26 # if HAVE_ICONV
27 # include <iconv.h>
28 # endif
29 #endif
30
31 /* Handle multi-threaded applications. */
32 #ifdef _LIBC
33 # include <libc-lock.h>
34 # define gl_rwlock_define __libc_rwlock_define
35 #else
36 # include "lock.h"
37 #endif
38
39 #ifdef _LIBC
40 struct loaded_domain;
41 extern char *__gettext (const char *__msgid);
42 extern char *__dgettext (const char *__domainname, const char *__msgid);
43 extern char *__dcgettext (const char *__domainname, const char *__msgid,
44 int __category);
45 extern char *__ngettext (const char *__msgid1, const char *__msgid2,
46 unsigned long int __n);
47 extern char *__dngettext (const char *__domainname,
48 const char *__msgid1, const char *__msgid2,
49 unsigned long int n);
50 extern char *__dcngettext (const char *__domainname,
51 const char *__msgid1, const char *__msgid2,
52 unsigned long int __n, int __category)
53 attribute_hidden;
54 extern char *__dcigettext (const char *__domainname,
55 const char *__msgid1, const char *__msgid2,
56 int __plural, unsigned long int __n,
57 int __category) attribute_hidden;
58 extern char *__textdomain (const char *__domainname);
59 extern char *__bindtextdomain (const char *__domainname,
60 const char *__dirname);
61 extern char *__bind_textdomain_codeset (const char *__domainname,
62 const char *__codeset);
63 extern void _nl_finddomain_subfreeres (void) attribute_hidden;
64 extern void _nl_unload_domain (struct loaded_domain *__domain)
65 attribute_hidden;
66 #else
67 /* Declare the exported libintl_* functions, in a way that allows us to
68 call them under their real name. */
69 # undef _INTL_REDIRECT_INLINE
70 # undef _INTL_REDIRECT_MACROS
71 # define _INTL_REDIRECT_MACROS
72 # include "libgnuintl.h"
73 # ifdef IN_LIBGLOCALE
74 extern char *gl_dcigettext (const char *__domainname,
75 const char *__msgid1, const char *__msgid2,
76 int __plural, unsigned long int __n,
77 int __category,
78 const char *__localename, const char *__encoding);
79 # else
80 extern char *libintl_dcigettext (const char *__domainname,
81 const char *__msgid1, const char *__msgid2,
82 int __plural, unsigned long int __n,
83 int __category);
84 # endif
85 #endif
86
87 #include "loadinfo.h"
88
89 #include "gmo.h" /* Get nls_uint32. */
90
91 /* @@ end of prolog @@ */
92
93 #ifndef attribute_hidden
94 # define attribute_hidden
95 #endif
96
97 /* Tell the compiler when a conditional or integer expression is
98 almost always true or almost always false. */
99 #ifndef HAVE_BUILTIN_EXPECT
100 # define __builtin_expect(expr, val) (expr)
101 #endif
102
103 #ifndef W
104 # define W(flag, data) ((flag) ? SWAP (data) : (data))
105 #endif
106
107
108 #ifdef _LIBC
109 # include <byteswap.h>
110 # define SWAP(i) bswap_32 (i)
111 #else
112 static inline nls_uint32
113 # ifdef __cplusplus
114 SWAP (nls_uint32 i)
115 # else
116 SWAP (i)
117 nls_uint32 i;
118 # endif
119 {
120 return (i << 24) | ((i & 0xff00) << 8) | ((i >> 8) & 0xff00) | (i >> 24);
121 }
122 #endif
123
124
125 /* In-memory representation of system dependent string. */
126 struct sysdep_string_desc
127 {
128 /* Length of addressed string, including the trailing NUL. */
129 size_t length;
130 /* Pointer to addressed string. */
131 const char *pointer;
132 };
133
134 /* Cache of translated strings after charset conversion.
135 Note: The strings are converted to the target encoding only on an as-needed
136 basis. */
137 struct converted_domain
138 {
139 /* The target encoding name. */
140 const char *encoding;
141 /* The descriptor for conversion from the message catalog's encoding to
142 this target encoding. */
143 #ifdef _LIBC
144 __gconv_t conv;
145 #else
146 # if HAVE_ICONV
147 iconv_t conv;
148 # endif
149 #endif
150 /* The table of translated strings after charset conversion. */
151 char **conv_tab;
152 };
153
154 /* The representation of an opened message catalog. */
155 struct loaded_domain
156 {
157 /* Pointer to memory containing the .mo file. */
158 const char *data;
159 /* 1 if the memory is mmap()ed, 0 if the memory is malloc()ed. */
160 int use_mmap;
161 /* Size of mmap()ed memory. */
162 size_t mmap_size;
163 /* 1 if the .mo file uses a different endianness than this machine. */
164 int must_swap;
165 /* Pointer to additional malloc()ed memory. */
166 void *malloced;
167
168 /* Number of static strings pairs. */
169 nls_uint32 nstrings;
170 /* Pointer to descriptors of original strings in the file. */
171 const struct string_desc *orig_tab;
172 /* Pointer to descriptors of translated strings in the file. */
173 const struct string_desc *trans_tab;
174
175 /* Number of system dependent strings pairs. */
176 nls_uint32 n_sysdep_strings;
177 /* Pointer to descriptors of original sysdep strings. */
178 const struct sysdep_string_desc *orig_sysdep_tab;
179 /* Pointer to descriptors of translated sysdep strings. */
180 const struct sysdep_string_desc *trans_sysdep_tab;
181
182 /* Size of hash table. */
183 nls_uint32 hash_size;
184 /* Pointer to hash table. */
185 const nls_uint32 *hash_tab;
186 /* 1 if the hash table uses a different endianness than this machine. */
187 int must_swap_hash_tab;
188
189 /* Cache of charset conversions of the translated strings. */
190 struct converted_domain *conversions;
191 size_t nconversions;
192 gl_rwlock_define (, conversions_lock)
193
194 const struct expression *plural;
195 unsigned long int nplurals;
196 };
197
198 /* We want to allocate a string at the end of the struct. But ISO C
199 doesn't allow zero sized arrays. */
200 #ifdef __GNUC__
201 # define ZERO 0
202 #else
203 # define ZERO 1
204 #endif
205
206 /* A set of settings bound to a message domain. Used to store settings
207 from bindtextdomain() and bind_textdomain_codeset(). */
208 struct binding
209 {
210 struct binding *next;
211 char *dirname;
212 char *codeset;
213 char domainname[ZERO];
214 };
215
216 /* A counter which is incremented each time some previous translations
217 become invalid.
218 This variable is part of the external ABI of the GNU libintl. */
219 #ifdef IN_LIBGLOCALE
220 # include <glocale/config.h>
221 extern LIBGLOCALE_DLL_EXPORTED int _nl_msg_cat_cntr;
222 #else
223 extern LIBINTL_DLL_EXPORTED int _nl_msg_cat_cntr;
224 #endif
225
226 #ifndef _LIBC
227 extern const char *_nl_language_preferences_default (void);
228 # define gl_locale_name_canonicalize _nl_locale_name_canonicalize
229 extern void _nl_locale_name_canonicalize (char *name);
230 # define gl_locale_name_from_win32_LANGID _nl_locale_name_from_win32_LANGID
231 /* extern const char *_nl_locale_name_from_win32_LANGID (LANGID langid); */
232 # define gl_locale_name_from_win32_LCID _nl_locale_name_from_win32_LCID
233 /* extern const char *_nl_locale_name_from_win32_LCID (LCID lcid); */
234 # define gl_locale_name_thread_unsafe _nl_locale_name_thread_unsafe
235 extern const char *_nl_locale_name_thread_unsafe (int category,
236 const char *categoryname);
237 # define gl_locale_name_thread _nl_locale_name_thread
238 /* extern const char *_nl_locale_name_thread (int category,
239 const char *categoryname); */
240 # define gl_locale_name_posix _nl_locale_name_posix
241 extern const char *_nl_locale_name_posix (int category,
242 const char *categoryname);
243 # define gl_locale_name_environ _nl_locale_name_environ
244 extern const char *_nl_locale_name_environ (int category,
245 const char *categoryname);
246 # define gl_locale_name_default _nl_locale_name_default
247 extern const char *_nl_locale_name_default (void);
248 # define gl_locale_name _nl_locale_name
249 /* extern const char *_nl_locale_name (int category,
250 const char *categoryname); */
251 #endif
252
253 struct loaded_l10nfile *_nl_find_domain (const char *__dirname, char *__locale,
254 const char *__domainname,
255 struct binding *__domainbinding)
256 attribute_hidden;
257 void _nl_load_domain (struct loaded_l10nfile *__domain,
258 struct binding *__domainbinding)
259 attribute_hidden;
260
261 #ifdef IN_LIBGLOCALE
262 char *_nl_find_msg (struct loaded_l10nfile *domain_file,
263 struct binding *domainbinding, const char *encoding,
264 const char *msgid,
265 size_t *lengthp)
266 attribute_hidden;
267 #else
268 char *_nl_find_msg (struct loaded_l10nfile *domain_file,
269 struct binding *domainbinding, const char *msgid,
270 int convert, size_t *lengthp)
271 attribute_hidden;
272 #endif
273
274 /* The internal variables in the standalone libintl.a must have different
275 names than the internal variables in GNU libc, otherwise programs
276 using libintl.a cannot be linked statically. */
277 #if !defined _LIBC
278 # define _nl_default_dirname libintl_nl_default_dirname
279 # define _nl_domain_bindings libintl_nl_domain_bindings
280 #endif
281
282 /* Contains the default location of the message catalogs. */
283 extern const char _nl_default_dirname[];
284 #ifdef _LIBC
285 libc_hidden_proto (_nl_default_dirname)
286 #endif
287
288 /* List with bindings of specific domains. */
289 extern struct binding *_nl_domain_bindings;
290
291 /* The internal variables in the standalone libintl.a must have different
292 names than the internal variables in GNU libc, otherwise programs
293 using libintl.a cannot be linked statically. */
294 #if !defined _LIBC
295 # define _nl_default_default_domain libintl_nl_default_default_domain
296 # define _nl_current_default_domain libintl_nl_current_default_domain
297 #endif
298
299 /* Name of the default text domain. */
300 extern const char _nl_default_default_domain[] attribute_hidden;
301
302 /* Default text domain in which entries for gettext(3) are to be found. */
303 extern const char *_nl_current_default_domain attribute_hidden;
304
305 /* @@ begin of epilog @@ */
306
307 #endif /* gettextP.h */