Convert doc/DETAILS to org-mode
[gnupg.git] / gl / stdint_.h
1 /* Copyright (C) 2001-2002, 2004-2006 Free Software Foundation, Inc.
2    Written by Paul Eggert, Bruno Haible, Sam Steingold, Peter Burwood.
3    This file is part of gnulib.
4
5    This program is free software; you can redistribute it and/or modify
6    it under the terms of the GNU General Public License as published by
7    the Free Software Foundation; either version 3, 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
13    GNU General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, see <http://www.gnu.org/licenses/>.  */
17
18 #ifndef _GL_STDINT_H
19 #define _GL_STDINT_H
20
21 /*
22  * ISO C 99 <stdint.h> for platforms that lack it.
23  * <http://www.opengroup.org/susv3xbd/stdint.h.html>
24  */
25
26 /* On Android (Bionic libc), <sys/types.h> includes this file before
27    having defined 'time_t'.  Therefore in this case avoid including
28    other system header files; just include the system's <stdint.h>.
29    Ideally we should test __BIONIC__ here, but it is only defined after
30    <sys/cdefs.h> has been included; hence test __ANDROID__ instead.  */
31 #if defined __ANDROID__ \
32     && defined _SYS_TYPES_H_ && !defined _SSIZE_T_DEFINED_
33 # include_next <stdint.h>
34 #else
35
36 /* Get those types that are already defined in other system include
37    files, so that we can "#define int8_t signed char" below without
38    worrying about a later system include file containing a "typedef
39    signed char int8_t;" that will get messed up by our macro.  Our
40    macros should all be consistent with the system versions, except
41    for the "fast" types and macros, which we recommend against using
42    in public interfaces due to compiler differences.  */
43
44 #if @HAVE_STDINT_H@
45 # if defined __sgi && ! defined __c99
46    /* Bypass IRIX's <stdint.h> if in C89 mode, since it merely annoys users
47       with "This header file is to be used only for c99 mode compilations"
48       diagnostics.  */
49 #  define __STDINT_H__
50 # endif
51   /* Other systems may have an incomplete or buggy <stdint.h>.
52      Include it before <inttypes.h>, since any "#include <stdint.h>"
53      in <inttypes.h> would reinclude us, skipping our contents because
54      _GL_STDINT_H is defined.  */
55 # include @ABSOLUTE_STDINT_H@
56 #endif
57
58 /* <sys/types.h> defines some of the stdint.h types as well, on glibc,
59    IRIX 6.5, and OpenBSD 3.8 (via <machine/types.h>).
60    MacOS X 10.4.6 <sys/types.h> includes <stdint.h> (which is us), but
61    relies on the system <stdint.h> definitions, so include
62    <sys/types.h> after @ABSOLUTE_STDINT_H@.  */
63 #if @HAVE_SYS_TYPES_H@
64 # include <sys/types.h>
65 #endif
66
67 /* Get LONG_MIN, LONG_MAX, ULONG_MAX.  */
68 #include <limits.h>
69
70 #if @HAVE_INTTYPES_H@
71   /* In OpenBSD 3.8, <inttypes.h> includes <machine/types.h>, which defines
72      int{8,16,32,64}_t, uint{8,16,32,64}_t and __BIT_TYPES_DEFINED__.
73      <inttypes.h> also defines intptr_t and uintptr_t.  */
74 # define _GL_JUST_INCLUDE_ABSOLUTE_INTTYPES_H
75 # include <inttypes.h>
76 # undef _GL_JUST_INCLUDE_ABSOLUTE_INTTYPES_H
77 #elif @HAVE_SYS_INTTYPES_H@
78   /* Solaris 7 <sys/inttypes.h> has the types except the *_fast*_t types, and
79      the macros except for *_FAST*_*, INTPTR_MIN, PTRDIFF_MIN, PTRDIFF_MAX.  */
80 # include <sys/inttypes.h>
81 #endif
82
83 #if @HAVE_SYS_BITYPES_H@ && ! defined __BIT_TYPES_DEFINED__
84   /* Linux libc4 >= 4.6.7 and libc5 have a <sys/bitypes.h> that defines
85      int{8,16,32,64}_t and __BIT_TYPES_DEFINED__.  In libc5 >= 5.2.2 it is
86      included by <sys/types.h>.  */
87 # include <sys/bitypes.h>
88 #endif
89
90 #if ! defined __cplusplus || defined __STDC_CONSTANT_MACROS
91
92 /* Get WCHAR_MIN, WCHAR_MAX.  */
93 # if @HAVE_WCHAR_H@ && ! (defined WCHAR_MIN && defined WCHAR_MAX)
94    /* BSD/OS 4.1 has a bug: <stdio.h> and <time.h> must be included before
95       <wchar.h>.  */
96 #  include <stdio.h>
97 #  include <time.h>
98 #  include <wchar.h>
99 # endif
100
101 #endif
102
103 /* Minimum and maximum values for a integer type under the usual assumption.
104    Return an unspecified value if BITS == 0, adding a check to pacify
105    picky compilers.  */
106
107 #define _STDINT_MIN(signed, bits, zero) \
108   ((signed) ? (- ((zero) + 1) << ((bits) ? (bits) - 1 : 0)) : (zero))
109
110 #define _STDINT_MAX(signed, bits, zero) \
111   ((signed) \
112    ? ~ _STDINT_MIN (signed, bits, zero) \
113    : ((((zero) + 1) << ((bits) ? (bits) - 1 : 0)) - 1) * 2 + 1)
114
115 /* 7.18.1.1. Exact-width integer types */
116
117 /* Here we assume a standard architecture where the hardware integer
118    types have 8, 16, 32, optionally 64 bits.  */
119
120 #undef int8_t
121 #undef uint8_t
122 #define int8_t signed char
123 #define uint8_t unsigned char
124
125 #undef int16_t
126 #undef uint16_t
127 #define int16_t short int
128 #define uint16_t unsigned short int
129
130 #undef int32_t
131 #undef uint32_t
132 #define int32_t int
133 #define uint32_t unsigned int
134
135 #undef int64_t
136 #if LONG_MAX >> 31 >> 31 == 1
137 # define int64_t long int
138 #elif defined _MSC_VER
139 # define int64_t __int64
140 #elif @HAVE_LONG_LONG_INT@
141 # define int64_t long long int
142 #endif
143
144 #undef uint64_t
145 #if ULONG_MAX >> 31 >> 31 >> 1 == 1
146 # define uint64_t unsigned long int
147 #elif defined _MSC_VER
148 # define uint64_t unsigned __int64
149 #elif @HAVE_UNSIGNED_LONG_LONG_INT@
150 # define uint64_t unsigned long long int
151 #endif
152
153 /* Avoid collision with Solaris 2.5.1 <pthread.h> etc.  */
154 #define _UINT8_T
155 #define _UINT32_T
156 #define _UINT64_T
157
158
159 /* 7.18.1.2. Minimum-width integer types */
160
161 /* Here we assume a standard architecture where the hardware integer
162    types have 8, 16, 32, optionally 64 bits. Therefore the leastN_t types
163    are the same as the corresponding N_t types.  */
164
165 #undef int_least8_t
166 #undef uint_least8_t
167 #undef int_least16_t
168 #undef uint_least16_t
169 #undef int_least32_t
170 #undef uint_least32_t
171 #undef int_least64_t
172 #undef uint_least64_t
173 #define int_least8_t int8_t
174 #define uint_least8_t uint8_t
175 #define int_least16_t int16_t
176 #define uint_least16_t uint16_t
177 #define int_least32_t int32_t
178 #define uint_least32_t uint32_t
179 #ifdef int64_t
180 # define int_least64_t int64_t
181 #endif
182 #ifdef uint64_t
183 # define uint_least64_t uint64_t
184 #endif
185
186 /* 7.18.1.3. Fastest minimum-width integer types */
187
188 /* Note: Other <stdint.h> substitutes may define these types differently.
189    It is not recommended to use these types in public header files. */
190
191 /* Here we assume a standard architecture where the hardware integer
192    types have 8, 16, 32, optionally 64 bits. Therefore the fastN_t types
193    are taken from the same list of types.  Assume that 'long int'
194    is fast enough for all narrower integers.  */
195
196 #undef int_fast8_t
197 #undef uint_fast8_t
198 #undef int_fast16_t
199 #undef uint_fast16_t
200 #undef int_fast32_t
201 #undef uint_fast32_t
202 #undef int_fast64_t
203 #undef uint_fast64_t
204 #define int_fast8_t long int
205 #define uint_fast8_t unsigned int_fast8_t
206 #define int_fast16_t long int
207 #define uint_fast16_t unsigned int_fast16_t
208 #define int_fast32_t long int
209 #define uint_fast32_t unsigned int_fast32_t
210 #ifdef int64_t
211 # define int_fast64_t int64_t
212 #endif
213 #ifdef uint64_t
214 # define uint_fast64_t uint64_t
215 #endif
216
217 /* 7.18.1.4. Integer types capable of holding object pointers */
218
219 #undef intptr_t
220 #undef uintptr_t
221 #define intptr_t long int
222 #define uintptr_t unsigned long int
223
224 /* 7.18.1.5. Greatest-width integer types */
225
226 /* Note: These types are compiler dependent. It may be unwise to use them in
227    public header files. */
228
229 #undef intmax_t
230 #if @HAVE_LONG_LONG_INT@ && LONG_MAX >> 30 == 1
231 # define intmax_t long long int
232 #elif defined int64_t
233 # define intmax_t int64_t
234 #else
235 # define intmax_t long int
236 #endif
237
238 #undef uintmax_t
239 #if @HAVE_UNSIGNED_LONG_LONG_INT@ && ULONG_MAX >> 31 == 1
240 # define uintmax_t unsigned long long int
241 #elif defined int64_t
242 # define uintmax_t uint64_t
243 #else
244 # define uintmax_t unsigned long int
245 #endif
246
247 /* 7.18.2. Limits of specified-width integer types */
248
249 #if ! defined __cplusplus || defined __STDC_LIMIT_MACROS
250
251 /* 7.18.2.1. Limits of exact-width integer types */
252
253 /* Here we assume a standard architecture where the hardware integer
254    types have 8, 16, 32, optionally 64 bits.  */
255
256 # undef INT8_MIN
257 # undef INT8_MAX
258 # undef UINT8_MAX
259 # define INT8_MIN  (~ INT8_MAX)
260 # define INT8_MAX  127
261 # define UINT8_MAX  255
262
263 # undef INT16_MIN
264 # undef INT16_MAX
265 # undef UINT16_MAX
266 # define INT16_MIN  (~ INT16_MAX)
267 # define INT16_MAX  32767
268 # define UINT16_MAX  65535
269
270 # undef INT32_MIN
271 # undef INT32_MAX
272 # undef UINT32_MAX
273 # define INT32_MIN  (~ INT32_MAX)
274 # define INT32_MAX  2147483647
275 # define UINT32_MAX  4294967295U
276
277 # undef INT64_MIN
278 # undef INT64_MAX
279 # ifdef int64_t
280 #  define INT64_MIN  (~ INT64_MAX)
281 #  define INT64_MAX  INTMAX_C (9223372036854775807)
282 # endif
283
284 # undef UINT64_MAX
285 # ifdef uint64_t
286 #  define UINT64_MAX  UINTMAX_C (18446744073709551615)
287 # endif
288
289 /* 7.18.2.2. Limits of minimum-width integer types */
290
291 /* Here we assume a standard architecture where the hardware integer
292    types have 8, 16, 32, optionally 64 bits. Therefore the leastN_t types
293    are the same as the corresponding N_t types.  */
294
295 # undef INT_LEAST8_MIN
296 # undef INT_LEAST8_MAX
297 # undef UINT_LEAST8_MAX
298 # define INT_LEAST8_MIN  INT8_MIN
299 # define INT_LEAST8_MAX  INT8_MAX
300 # define UINT_LEAST8_MAX  UINT8_MAX
301
302 # undef INT_LEAST16_MIN
303 # undef INT_LEAST16_MAX
304 # undef UINT_LEAST16_MAX
305 # define INT_LEAST16_MIN  INT16_MIN
306 # define INT_LEAST16_MAX  INT16_MAX
307 # define UINT_LEAST16_MAX  UINT16_MAX
308
309 # undef INT_LEAST32_MIN
310 # undef INT_LEAST32_MAX
311 # undef UINT_LEAST32_MAX
312 # define INT_LEAST32_MIN  INT32_MIN
313 # define INT_LEAST32_MAX  INT32_MAX
314 # define UINT_LEAST32_MAX  UINT32_MAX
315
316 # undef INT_LEAST64_MIN
317 # undef INT_LEAST64_MAX
318 # ifdef int64_t
319 #  define INT_LEAST64_MIN  INT64_MIN
320 #  define INT_LEAST64_MAX  INT64_MAX
321 # endif
322
323 # undef UINT_LEAST64_MAX
324 # ifdef uint64_t
325 #  define UINT_LEAST64_MAX  UINT64_MAX
326 # endif
327
328 /* 7.18.2.3. Limits of fastest minimum-width integer types */
329
330 /* Here we assume a standard architecture where the hardware integer
331    types have 8, 16, 32, optionally 64 bits. Therefore the fastN_t types
332    are taken from the same list of types.  */
333
334 # undef INT_FAST8_MIN
335 # undef INT_FAST8_MAX
336 # undef UINT_FAST8_MAX
337 # define INT_FAST8_MIN  LONG_MIN
338 # define INT_FAST8_MAX  LONG_MAX
339 # define UINT_FAST8_MAX  ULONG_MAX
340
341 # undef INT_FAST16_MIN
342 # undef INT_FAST16_MAX
343 # undef UINT_FAST16_MAX
344 # define INT_FAST16_MIN  LONG_MIN
345 # define INT_FAST16_MAX  LONG_MAX
346 # define UINT_FAST16_MAX  ULONG_MAX
347
348 # undef INT_FAST32_MIN
349 # undef INT_FAST32_MAX
350 # undef UINT_FAST32_MAX
351 # define INT_FAST32_MIN  LONG_MIN
352 # define INT_FAST32_MAX  LONG_MAX
353 # define UINT_FAST32_MAX  ULONG_MAX
354
355 # undef INT_FAST64_MIN
356 # undef INT_FAST64_MAX
357 # ifdef int64_t
358 #  define INT_FAST64_MIN  INT64_MIN
359 #  define INT_FAST64_MAX  INT64_MAX
360 # endif
361
362 # undef UINT_FAST64_MAX
363 # ifdef uint64_t
364 #  define UINT_FAST64_MAX  UINT64_MAX
365 # endif
366
367 /* 7.18.2.4. Limits of integer types capable of holding object pointers */
368
369 # undef INTPTR_MIN
370 # undef INTPTR_MAX
371 # undef UINTPTR_MAX
372 # define INTPTR_MIN  LONG_MIN
373 # define INTPTR_MAX  LONG_MAX
374 # define UINTPTR_MAX  ULONG_MAX
375
376 /* 7.18.2.5. Limits of greatest-width integer types */
377
378 # undef INTMAX_MIN
379 # undef INTMAX_MAX
380 # define INTMAX_MIN  (~ INTMAX_MAX)
381 # ifdef INT64_MAX
382 #  define INTMAX_MAX  INT64_MAX
383 # else
384 #  define INTMAX_MAX  INT32_MAX
385 # endif
386
387 # undef UINTMAX_MAX
388 # ifdef UINT64_MAX
389 #  define UINTMAX_MAX  UINT64_MAX
390 # else
391 #  define UINTMAX_MAX  UINT32_MAX
392 # endif
393
394 /* 7.18.3. Limits of other integer types */
395
396 /* ptrdiff_t limits */
397 # undef PTRDIFF_MIN
398 # undef PTRDIFF_MAX
399 # define PTRDIFF_MIN  \
400    _STDINT_MIN (1, @BITSIZEOF_PTRDIFF_T@, 0@PTRDIFF_T_SUFFIX@)
401 # define PTRDIFF_MAX  \
402    _STDINT_MAX (1, @BITSIZEOF_PTRDIFF_T@, 0@PTRDIFF_T_SUFFIX@)
403
404 /* sig_atomic_t limits */
405 # undef SIG_ATOMIC_MIN
406 # undef SIG_ATOMIC_MAX
407 # define SIG_ATOMIC_MIN  \
408    _STDINT_MIN (@HAVE_SIGNED_SIG_ATOMIC_T@, @BITSIZEOF_SIG_ATOMIC_T@, \
409                 0@SIG_ATOMIC_T_SUFFIX@)
410 # define SIG_ATOMIC_MAX  \
411    _STDINT_MAX (@HAVE_SIGNED_SIG_ATOMIC_T@, @BITSIZEOF_SIG_ATOMIC_T@, \
412                 0@SIG_ATOMIC_T_SUFFIX@)
413
414
415 /* size_t limit */
416 # undef SIZE_MAX
417 # define SIZE_MAX  _STDINT_MAX (0, @BITSIZEOF_SIZE_T@, 0@SIZE_T_SUFFIX@)
418
419 /* wchar_t limits */
420 # undef WCHAR_MIN
421 # undef WCHAR_MAX
422 # define WCHAR_MIN  \
423    _STDINT_MIN (@HAVE_SIGNED_WCHAR_T@, @BITSIZEOF_WCHAR_T@, 0@WCHAR_T_SUFFIX@)
424 # define WCHAR_MAX  \
425    _STDINT_MAX (@HAVE_SIGNED_WCHAR_T@, @BITSIZEOF_WCHAR_T@, 0@WCHAR_T_SUFFIX@)
426
427 /* wint_t limits */
428 # undef WINT_MIN
429 # undef WINT_MAX
430 # define WINT_MIN  \
431    _STDINT_MIN (@HAVE_SIGNED_WINT_T@, @BITSIZEOF_WINT_T@, 0@WINT_T_SUFFIX@)
432 # define WINT_MAX  \
433    _STDINT_MAX (@HAVE_SIGNED_WINT_T@, @BITSIZEOF_WINT_T@, 0@WINT_T_SUFFIX@)
434
435 #endif /* !defined __cplusplus || defined __STDC_LIMIT_MACROS */
436
437 /* 7.18.4. Macros for integer constants */
438
439 #if ! defined __cplusplus || defined __STDC_CONSTANT_MACROS
440
441 /* 7.18.4.1. Macros for minimum-width integer constants */
442 /* According to ISO C 99 Technical Corrigendum 1 */
443
444 /* Here we assume a standard architecture where the hardware integer
445    types have 8, 16, 32, optionally 64 bits, and int is 32 bits.  */
446
447 # undef INT8_C
448 # undef UINT8_C
449 # define INT8_C(x) x
450 # define UINT8_C(x) x
451
452 # undef INT16_C
453 # undef UINT16_C
454 # define INT16_C(x) x
455 # define UINT16_C(x) x
456
457 # undef INT32_C
458 # undef UINT32_C
459 # define INT32_C(x) x
460 # define UINT32_C(x) x ## U
461
462 # undef INT64_C
463 # undef UINT64_C
464 # if LONG_MAX >> 31 >> 31 == 1
465 #  define INT64_C(x) x##L
466 # elif defined _MSC_VER
467 #  define INT64_C(x) x##i64
468 # elif @HAVE_LONG_LONG_INT@
469 #  define INT64_C(x) x##LL
470 # endif
471 # if ULONG_MAX >> 31 >> 31 >> 1 == 1
472 #  define UINT64_C(x) x##UL
473 # elif defined _MSC_VER
474 #  define UINT64_C(x) x##ui64
475 # elif @HAVE_UNSIGNED_LONG_LONG_INT@
476 #  define UINT64_C(x) x##ULL
477 # endif
478
479 /* 7.18.4.2. Macros for greatest-width integer constants */
480
481 # undef INTMAX_C
482 # if @HAVE_LONG_LONG_INT@ && LONG_MAX >> 30 == 1
483 #  define INTMAX_C(x)   x##LL
484 # elif defined int64_t
485 #  define INTMAX_C(x)   INT64_C(x)
486 # else
487 #  define INTMAX_C(x)   x##L
488 # endif
489
490 # undef UINTMAX_C
491 # if @HAVE_UNSIGNED_LONG_LONG_INT@ && ULONG_MAX >> 31 == 1
492 #  define UINTMAX_C(x)  x##ULL
493 # elif defined uint64_t
494 #  define UINTMAX_C(x)  UINT64_C(x)
495 # else
496 #  define UINTMAX_C(x)  x##UL
497 # endif
498
499 #endif /* !(defined __ANDROID__ && ...) */
500 #endif /* !defined __cplusplus || defined __STDC_CONSTANT_MACROS */
501 #endif /* _GL_STDINT_H */