gettext-runtime/intl/gettextP.h

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