* gettextP.h: Add comment for HP/UX users. Local fix for GnuPG.
[gnupg.git] / intl / gettextP.h
1 /* Header describing internals of libintl library.
2    Copyright (C) 1995-1999, 2000, 2001 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 it
6    under the terms of the GNU Library General Public License as published
7    by the Free Software Foundation; either version 2, or (at your option)
8    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 GNU
13    Library General Public License for more details.
14
15    You should have received a copy of the GNU Library General Public
16    License along with this program; if not, write to the Free Software
17    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
18    USA.  */
19
20 #ifndef _GETTEXTP_H
21 #define _GETTEXTP_H
22
23 /* HP/UX users - if you get errors line "Unexpected symbol: SWAP" when
24    building with HP's C compiler, you will need to uncomment the
25    following line.  This is a GnuPG-specific change. */
26
27 /* #define inline */
28
29 #include <stddef.h>             /* Get size_t.  */
30
31 #ifdef _LIBC
32 # include "../iconv/gconv_int.h"
33 #else
34 # if HAVE_ICONV
35 #  include <iconv.h>
36 # endif
37 #endif
38
39 #include "loadinfo.h"
40
41 #include "gettext.h"            /* Get nls_uint32.  */
42
43 /* @@ end of prolog @@ */
44
45 #ifndef PARAMS
46 # if __STDC__
47 #  define PARAMS(args) args
48 # else
49 #  define PARAMS(args) ()
50 # endif
51 #endif
52
53 #ifndef internal_function
54 # define internal_function
55 #endif
56
57 /* Tell the compiler when a conditional or integer expression is
58    almost always true or almost always false.  */
59 #ifndef HAVE_BUILTIN_EXPECT
60 # define __builtin_expect(expr, val) (expr)
61 #endif
62
63 #ifndef W
64 # define W(flag, data) ((flag) ? SWAP (data) : (data))
65 #endif
66
67
68 #ifdef _LIBC
69 # include <byteswap.h>
70 # define SWAP(i) bswap_32 (i)
71 #else
72 static inline nls_uint32
73 SWAP (i)
74      nls_uint32 i;
75 {
76   return (i << 24) | ((i & 0xff00) << 8) | ((i >> 8) & 0xff00) | (i >> 24);
77 }
78 #endif
79
80
81 /* This is the representation of the expressions to determine the
82    plural form.  */
83 struct expression
84 {
85   int nargs;                    /* Number of arguments.  */
86   enum operator
87   {
88     /* Without arguments:  */
89     var,                        /* The variable "n".  */
90     num,                        /* Decimal number.  */
91     /* Unary operators:  */
92     lnot,                       /* Logical NOT.  */
93     /* Binary operators:  */
94     mult,                       /* Multiplication.  */
95     divide,                     /* Division.  */
96     module,                     /* Module operation.  */
97     plus,                       /* Addition.  */
98     minus,                      /* Subtraction.  */
99     less_than,                  /* Comparison.  */
100     greater_than,               /* Comparison.  */
101     less_or_equal,              /* Comparison.  */
102     greater_or_equal,           /* Comparison.  */
103     equal,                      /* Comparision for equality.  */
104     not_equal,                  /* Comparision for inequality.  */
105     land,                       /* Logical AND.  */
106     lor,                        /* Logical OR.  */
107     /* Ternary operators:  */
108     qmop                        /* Question mark operator.  */
109   } operation;
110   union
111   {
112     unsigned long int num;      /* Number value for `num'.  */
113     struct expression *args[3]; /* Up to three arguments.  */
114   } val;
115 };
116
117 /* This is the data structure to pass information to the parser and get
118    the result in a thread-safe way.  */
119 struct parse_args
120 {
121   const char *cp;
122   struct expression *res;
123 };
124
125
126 /* The representation of an opened message catalog.  */
127 struct loaded_domain
128 {
129   const char *data;
130   int use_mmap;
131   size_t mmap_size;
132   int must_swap;
133   nls_uint32 nstrings;
134   struct string_desc *orig_tab;
135   struct string_desc *trans_tab;
136   nls_uint32 hash_size;
137   nls_uint32 *hash_tab;
138   int codeset_cntr;
139 #ifdef _LIBC
140   __gconv_t conv;
141 #else
142 # if HAVE_ICONV
143   iconv_t conv;
144 # endif
145 #endif
146   char **conv_tab;
147
148   struct expression *plural;
149   unsigned long int nplurals;
150 };
151
152 /* We want to allocate a string at the end of the struct.  But ISO C
153    doesn't allow zero sized arrays.  */
154 #ifdef __GNUC__
155 # define ZERO 0
156 #else
157 # define ZERO 1
158 #endif
159
160 /* A set of settings bound to a message domain.  Used to store settings
161    from bindtextdomain() and bind_textdomain_codeset().  */
162 struct binding
163 {
164   struct binding *next;
165   char *dirname;
166   int codeset_cntr;     /* Incremented each time codeset changes.  */
167   char *codeset;
168   char domainname[ZERO];
169 };
170
171 /* A counter which is incremented each time some previous translations
172    become invalid.
173    This variable is part of the external ABI of the GNU libintl.  */
174 extern int _nl_msg_cat_cntr;
175
176 struct loaded_l10nfile *_nl_find_domain PARAMS ((const char *__dirname,
177                                                  char *__locale,
178                                                  const char *__domainname,
179                                               struct binding *__domainbinding))
180      internal_function;
181 void _nl_load_domain PARAMS ((struct loaded_l10nfile *__domain,
182                               struct binding *__domainbinding))
183      internal_function;
184 void _nl_unload_domain PARAMS ((struct loaded_domain *__domain))
185      internal_function;
186 const char *_nl_init_domain_conv PARAMS ((struct loaded_l10nfile *__domain_file,
187                                           struct loaded_domain *__domain,
188                                           struct binding *__domainbinding))
189      internal_function;
190 void _nl_free_domain_conv PARAMS ((struct loaded_domain *__domain))
191      internal_function;
192
193 char *_nl_find_msg PARAMS ((struct loaded_l10nfile *domain_file,
194                             struct binding *domainbinding,
195                             const char *msgid, size_t *lengthp))
196      internal_function;
197
198 #ifdef _LIBC
199 extern char *__gettext PARAMS ((const char *__msgid));
200 extern char *__dgettext PARAMS ((const char *__domainname,
201                                  const char *__msgid));
202 extern char *__dcgettext PARAMS ((const char *__domainname,
203                                   const char *__msgid, int __category));
204 extern char *__ngettext PARAMS ((const char *__msgid1, const char *__msgid2,
205                                  unsigned long int __n));
206 extern char *__dngettext PARAMS ((const char *__domainname,
207                                   const char *__msgid1, const char *__msgid2,
208                                   unsigned long int n));
209 extern char *__dcngettext PARAMS ((const char *__domainname,
210                                    const char *__msgid1, const char *__msgid2,
211                                    unsigned long int __n, int __category));
212 extern char *__dcigettext PARAMS ((const char *__domainname,
213                                    const char *__msgid1, const char *__msgid2,
214                                    int __plural, unsigned long int __n,
215                                    int __category));
216 extern char *__textdomain PARAMS ((const char *__domainname));
217 extern char *__bindtextdomain PARAMS ((const char *__domainname,
218                                        const char *__dirname));
219 extern char *__bind_textdomain_codeset PARAMS ((const char *__domainname,
220                                                 const char *__codeset));
221 #else
222 extern char *gettext__ PARAMS ((const char *__msgid));
223 extern char *dgettext__ PARAMS ((const char *__domainname,
224                                  const char *__msgid));
225 extern char *dcgettext__ PARAMS ((const char *__domainname,
226                                   const char *__msgid, int __category));
227 extern char *ngettext__ PARAMS ((const char *__msgid1, const char *__msgid2,
228                                  unsigned long int __n));
229 extern char *dngettext__ PARAMS ((const char *__domainname,
230                                   const char *__msgid1, const char *__msgid2,
231                                   unsigned long int __n));
232 extern char *dcngettext__ PARAMS ((const char *__domainname,
233                                    const char *__msgid1, const char *__msgid2,
234                                    unsigned long int __n, int __category));
235 extern char *dcigettext__ PARAMS ((const char *__domainname,
236                                    const char *__msgid1, const char *__msgid2,
237                                    int __plural, unsigned long int __n,
238                                    int __category));
239 extern char *textdomain__ PARAMS ((const char *__domainname));
240 extern char *bindtextdomain__ PARAMS ((const char *__domainname,
241                                        const char *__dirname));
242 extern char *bind_textdomain_codeset__ PARAMS ((const char *__domainname,
243                                                 const char *__codeset));
244 #endif
245
246 #ifdef _LIBC
247 extern void __gettext_free_exp PARAMS ((struct expression *exp))
248      internal_function;
249 extern int __gettextparse PARAMS ((void *arg));
250 #else
251 extern void gettext_free_exp__ PARAMS ((struct expression *exp))
252      internal_function;
253 extern int gettextparse__ PARAMS ((void *arg));
254 #endif
255
256 /* @@ begin of epilog @@ */
257
258 #endif /* gettextP.h  */