]> git.gag.com Git - debian/tar/blob - gnu/intprops.h
turn documentation hack into a patch
[debian/tar] / gnu / intprops.h
1 /* -*- buffer-read-only: t -*- vi: set ro: */
2 /* DO NOT EDIT! GENERATED AUTOMATICALLY! */
3 /* intprops.h -- properties of integer types
4
5    Copyright (C) 2001-2005, 2009-2011 Free Software Foundation, Inc.
6
7    This program 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    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19
20 /* Written by Paul Eggert.  */
21
22 #ifndef GL_INTPROPS_H
23 # define GL_INTPROPS_H
24
25 # include <limits.h>
26
27 /* The extra casts in the following macros work around compiler bugs,
28    e.g., in Cray C 5.0.3.0.  */
29
30 /* True if the arithmetic type T is an integer type.  bool counts as
31    an integer.  */
32 # define TYPE_IS_INTEGER(t) ((t) 1.5 == 1)
33
34 /* True if negative values of the signed integer type T use two's
35    complement, ones' complement, or signed magnitude representation,
36    respectively.  Much GNU code assumes two's complement, but some
37    people like to be portable to all possible C hosts.  */
38 # define TYPE_TWOS_COMPLEMENT(t) ((t) ~ (t) 0 == (t) -1)
39 # define TYPE_ONES_COMPLEMENT(t) ((t) ~ (t) 0 == 0)
40 # define TYPE_SIGNED_MAGNITUDE(t) ((t) ~ (t) 0 < (t) -1)
41
42 /* True if the arithmetic type T is signed.  */
43 # define TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
44
45 /* The maximum and minimum values for the integer type T.  These
46    macros have undefined behavior if T is signed and has padding bits.
47    If this is a problem for you, please let us know how to fix it for
48    your host.  */
49 # define TYPE_MINIMUM(t) \
50   ((t) (! TYPE_SIGNED (t) \
51         ? (t) 0 \
52         : TYPE_SIGNED_MAGNITUDE (t) \
53         ? ~ (t) 0 \
54         : ~ TYPE_MAXIMUM (t)))
55 # define TYPE_MAXIMUM(t) \
56   ((t) (! TYPE_SIGNED (t) \
57         ? (t) -1 \
58         : ((((t) 1 << (sizeof (t) * CHAR_BIT - 2)) - 1) * 2 + 1)))
59
60 /* Return zero if T can be determined to be an unsigned type.
61    Otherwise, return 1.
62    When compiling with GCC, INT_STRLEN_BOUND uses this macro to obtain a
63    tighter bound.  Otherwise, it overestimates the true bound by one byte
64    when applied to unsigned types of size 2, 4, 16, ... bytes.
65    The symbol signed_type_or_expr__ is private to this header file.  */
66 # if __GNUC__ >= 2
67 #  define signed_type_or_expr__(t) TYPE_SIGNED (__typeof__ (t))
68 # else
69 #  define signed_type_or_expr__(t) 1
70 # endif
71
72 /* Bound on length of the string representing an unsigned integer
73    value representable in B bits.  log10 (2.0) < 146/485.  The
74    smallest value of B where this bound is not tight is 2621.  */
75 # define INT_BITS_STRLEN_BOUND(b) (((b) * 146 + 484) / 485)
76
77 /* Bound on length of the string representing an integer type or expression T.
78    Subtract 1 for the sign bit if T is signed, and then add 1 more for
79    a minus sign if needed.  */
80 # define INT_STRLEN_BOUND(t) \
81   (INT_BITS_STRLEN_BOUND (sizeof (t) * CHAR_BIT - signed_type_or_expr__ (t)) \
82    + signed_type_or_expr__ (t))
83
84 /* Bound on buffer size needed to represent an integer type or expression T,
85    including the terminating null.  */
86 # define INT_BUFSIZE_BOUND(t) (INT_STRLEN_BOUND (t) + 1)
87
88 #endif /* GL_INTPROPS_H */