intl/gmo.h

   1 /* Internal header for GNU gettext internationalization functions.
   2    Copyright (C) 1995, 1997, 2000-2002, 2004 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library 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    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, write to the Free
  17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18    02111-1307 USA.  */
  19
  20 #ifndef _GETTEXT_H
  21 #define _GETTEXT_H 1
  22
  23 #include <limits.h>
  24
  25 /* @@ end of prolog @@ */
  26
  27 /* The magic number of the GNU message catalog format.  */
  28 #define _MAGIC 0x950412de
  29 #define _MAGIC_SWAPPED 0xde120495
  30
  31 /* Revision number of the currently used .mo (binary) file format.  */
  32 #define MO_REVISION_NUMBER 0
  33 #define MO_REVISION_NUMBER_WITH_SYSDEP_I 1
  34
  35 /* The following contortions are an attempt to use the C preprocessor
  36    to determine an unsigned integral type that is 32 bits wide.  An
  37    alternative approach is to use autoconf's AC_CHECK_SIZEOF macro, but
  38    as of version autoconf-2.13, the AC_CHECK_SIZEOF macro doesn't work
  39    when cross-compiling.  */
  40
  41 #if __STDC__
  42 # define UINT_MAX_32_BITS 4294967295U
  43 #else
  44 # define UINT_MAX_32_BITS 0xFFFFFFFF
  45 #endif
  46
  47 /* If UINT_MAX isn't defined, assume it's a 32-bit type.
  48    This should be valid for all systems GNU cares about because
  49    that doesn't include 16-bit systems, and only modern systems
  50    (that certainly have <limits.h>) have 64+-bit integral types.  */
  51
  52 #ifndef UINT_MAX
  53 # define UINT_MAX UINT_MAX_32_BITS
  54 #endif
  55
  56 #if UINT_MAX == UINT_MAX_32_BITS
  57 typedef unsigned nls_uint32;
  58 #else
  59 # if USHRT_MAX == UINT_MAX_32_BITS
  60 typedef unsigned short nls_uint32;
  61 # else
  62 #  if ULONG_MAX == UINT_MAX_32_BITS
  63 typedef unsigned long nls_uint32;
  64 #  else
  65   /* The following line is intended to throw an error.  Using #error is
  66      not portable enough.  */
  67   "Cannot determine unsigned 32-bit data type."
  68 #  endif
  69 # endif
  70 #endif
  71
  72
  73 /* Header for binary .mo file format.  */
  74 struct mo_file_header
  75 {
  76   /* The magic number.  */
  77   nls_uint32 magic;
  78   /* The revision number of the file format.  */
  79   nls_uint32 revision;
  80
  81   /* The following are only used in .mo files with major revision 0 or 1.  */
  82
  83   /* The number of strings pairs.  */
  84   nls_uint32 nstrings;
  85   /* Offset of table with start offsets of original strings.  */
  86   nls_uint32 orig_tab_offset;
  87   /* Offset of table with start offsets of translated strings.  */
  88   nls_uint32 trans_tab_offset;
  89   /* Size of hash table.  */
  90   nls_uint32 hash_tab_size;
  91   /* Offset of first hash table entry.  */
  92   nls_uint32 hash_tab_offset;
  93
  94   /* The following are only used in .mo files with minor revision >= 1.  */
  95
  96   /* The number of system dependent segments.  */
  97   nls_uint32 n_sysdep_segments;
  98   /* Offset of table describing system dependent segments.  */
  99   nls_uint32 sysdep_segments_offset;
 100   /* The number of system dependent strings pairs.  */
 101   nls_uint32 n_sysdep_strings;
 102   /* Offset of table with start offsets of original sysdep strings.  */
 103   nls_uint32 orig_sysdep_tab_offset;
 104   /* Offset of table with start offsets of translated sysdep strings.  */
 105   nls_uint32 trans_sysdep_tab_offset;
 106 };
 107
 108 /* Descriptor for static string contained in the binary .mo file.  */
 109 struct string_desc
 110 {
 111   /* Length of addressed string, not including the trailing NUL.  */
 112   nls_uint32 length;
 113   /* Offset of string in file.  */
 114   nls_uint32 offset;
 115 };
 116
 117 /* The following are only used in .mo files with minor revision >= 1.  */
 118
 119 /* Descriptor for system dependent string segment.  */
 120 struct sysdep_segment
 121 {
 122   /* Length of addressed string, including the trailing NUL.  */
 123   nls_uint32 length;
 124   /* Offset of string in file.  */
 125   nls_uint32 offset;
 126 };
 127
 128 /* Descriptor for system dependent string.  */
 129 struct sysdep_string
 130 {
 131   /* Offset of static string segments in file.  */
 132   nls_uint32 offset;
 133   /* Alternating sequence of static and system dependent segments.
 134      The last segment is a static segment, including the trailing NUL.  */
 135   struct segment_pair
 136   {
 137     /* Size of static segment.  */
 138     nls_uint32 segsize;
 139     /* Reference to system dependent string segment, or ~0 at the end.  */
 140     nls_uint32 sysdepref;
 141   } segments[1];
 142 };
 143
 144 /* Marker for the end of the segments[] array.  This has the value 0xFFFFFFFF,
 145    regardless whether 'int' is 16 bit, 32 bit, or 64 bit.  */
 146 #define SEGMENTS_END ((nls_uint32) ~0)
 147
 148 /* @@ begin of epilog @@ */
 149
 150 #endif  /* gettext.h  */