intl/gmo.h

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