blob: 2c5785123c4beab38b9c1775ea5635ee549871d4 [file] [log] [blame]
Jari Aalto31859422009-01-12 13:36:28 +00001/* gmo.h - Description of GNU message catalog format: general file layout. */
Jari Aaltob80f6442004-07-27 13:29:18 +00002
Jari Aalto31859422009-01-12 13:36:28 +00003/* Copyright (C) 1995, 1997, 2000-2002, 2005-2009 Free Software Foundation, Inc.
Jari Aaltob80f6442004-07-27 13:29:18 +00004
Jari Aalto31859422009-01-12 13:36:28 +00005 This file is part of GNU Bash.
6
7 Bash is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
11
12 Bash is distributed in the hope that it will be useful,
Jari Aaltob80f6442004-07-27 13:29:18 +000013 but WITHOUT ANY WARRANTY; without even the implied warranty of
Jari Aalto31859422009-01-12 13:36:28 +000014 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
Jari Aaltob80f6442004-07-27 13:29:18 +000016
Jari Aalto31859422009-01-12 13:36:28 +000017 You should have received a copy of the GNU General Public License
18 along with Bash. If not, see <http://www.gnu.org/licenses/>.
19*/
Jari Aaltob80f6442004-07-27 13:29:18 +000020
21#ifndef _GETTEXT_H
22#define _GETTEXT_H 1
23
24#include <limits.h>
25
26/* @@ end of prolog @@ */
27
28/* The magic number of the GNU message catalog format. */
29#define _MAGIC 0x950412de
30#define _MAGIC_SWAPPED 0xde120495
31
32/* Revision number of the currently used .mo (binary) file format. */
33#define MO_REVISION_NUMBER 0
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
57typedef unsigned nls_uint32;
58#else
59# if USHRT_MAX == UINT_MAX_32_BITS
60typedef unsigned short nls_uint32;
61# else
62# if ULONG_MAX == UINT_MAX_32_BITS
63typedef 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. */
74struct 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. */
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. */
109struct 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. */
120struct 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. */
129struct 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 */