annotate lib/stdbool.in.h @ 421:3c2e1f24cc7d 3.0-beta2

Added generated files for release
author lost@l-w.ca
date Sun, 19 Sep 2010 01:33:24 -0600
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
421
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
1 /* Copyright (C) 2001-2003, 2006-2010 Free Software Foundation, Inc.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
2 Written by Bruno Haible <haible@clisp.cons.org>, 2001.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
3
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
4 This program is free software; you can redistribute it and/or modify
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
5 it under the terms of the GNU General Public License as published by
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
6 the Free Software Foundation; either version 3, or (at your option)
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
7 any later version.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
8
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
9 This program is distributed in the hope that it will be useful,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
12 GNU General Public License for more details.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
13
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
14 You should have received a copy of the GNU General Public License
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
15 along with this program; if not, write to the Free Software Foundation,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
16 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
17
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
18 #ifndef _GL_STDBOOL_H
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
19 #define _GL_STDBOOL_H
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
20
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
21 /* ISO C 99 <stdbool.h> for platforms that lack it. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
22
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
23 /* Usage suggestions:
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
24
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
25 Programs that use <stdbool.h> should be aware of some limitations
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
26 and standards compliance issues.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
27
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
28 Standards compliance:
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
29
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
30 - <stdbool.h> must be #included before 'bool', 'false', 'true'
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
31 can be used.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
32
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
33 - You cannot assume that sizeof (bool) == 1.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
34
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
35 - Programs should not undefine the macros bool, true, and false,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
36 as C99 lists that as an "obsolescent feature".
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
37
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
38 Limitations of this substitute, when used in a C89 environment:
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
39
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
40 - <stdbool.h> must be #included before the '_Bool' type can be used.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
41
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
42 - You cannot assume that _Bool is a typedef; it might be a macro.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
43
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
44 - Bit-fields of type 'bool' are not supported. Portable code
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
45 should use 'unsigned int foo : 1;' rather than 'bool foo : 1;'.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
46
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
47 - In C99, casts and automatic conversions to '_Bool' or 'bool' are
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
48 performed in such a way that every nonzero value gets converted
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
49 to 'true', and zero gets converted to 'false'. This doesn't work
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
50 with this substitute. With this substitute, only the values 0 and 1
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
51 give the expected result when converted to _Bool' or 'bool'.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
52
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
53 Also, it is suggested that programs use 'bool' rather than '_Bool';
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
54 this isn't required, but 'bool' is more common. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
55
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
56
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
57 /* 7.16. Boolean type and values */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
58
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
59 /* BeOS <sys/socket.h> already #defines false 0, true 1. We use the same
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
60 definitions below, but temporarily we have to #undef them. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
61 #if defined __BEOS__ && !defined __HAIKU__
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
62 # include <OS.h> /* defines bool but not _Bool */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
63 # undef false
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
64 # undef true
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
65 #endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
66
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
67 /* For the sake of symbolic names in gdb, we define true and false as
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
68 enum constants, not only as macros.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
69 It is tempting to write
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
70 typedef enum { false = 0, true = 1 } _Bool;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
71 so that gdb prints values of type 'bool' symbolically. But if we do
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
72 this, values of type '_Bool' may promote to 'int' or 'unsigned int'
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
73 (see ISO C 99 6.7.2.2.(4)); however, '_Bool' must promote to 'int'
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
74 (see ISO C 99 6.3.1.1.(2)). So we add a negative value to the
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
75 enum; this ensures that '_Bool' promotes to 'int'. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
76 #if defined __cplusplus || (defined __BEOS__ && !defined __HAIKU__)
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
77 /* A compiler known to have 'bool'. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
78 /* If the compiler already has both 'bool' and '_Bool', we can assume they
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
79 are the same types. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
80 # if !@HAVE__BOOL@
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
81 typedef bool _Bool;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
82 # endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
83 #else
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
84 # if !defined __GNUC__
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
85 /* If @HAVE__BOOL@:
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
86 Some HP-UX cc and AIX IBM C compiler versions have compiler bugs when
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
87 the built-in _Bool type is used. See
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
88 http://gcc.gnu.org/ml/gcc-patches/2003-12/msg02303.html
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
89 http://lists.gnu.org/archive/html/bug-coreutils/2005-11/msg00161.html
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
90 http://lists.gnu.org/archive/html/bug-coreutils/2005-10/msg00086.html
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
91 Similar bugs are likely with other compilers as well; this file
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
92 wouldn't be used if <stdbool.h> was working.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
93 So we override the _Bool type.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
94 If !@HAVE__BOOL@:
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
95 Need to define _Bool ourselves. As 'signed char' or as an enum type?
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
96 Use of a typedef, with SunPRO C, leads to a stupid
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
97 "warning: _Bool is a keyword in ISO C99".
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
98 Use of an enum type, with IRIX cc, leads to a stupid
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
99 "warning(1185): enumerated type mixed with another type".
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
100 Even the existence of an enum type, without a typedef,
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
101 "Invalid enumerator. (badenum)" with HP-UX cc on Tru64.
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
102 The only benefit of the enum, debuggability, is not important
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
103 with these compilers. So use 'signed char' and no enum. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
104 # define _Bool signed char
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
105 # else
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
106 /* With this compiler, trust the _Bool type if the compiler has it. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
107 # if !@HAVE__BOOL@
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
108 typedef enum { _Bool_must_promote_to_int = -1, false = 0, true = 1 } _Bool;
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
109 # endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
110 # endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
111 #endif
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
112 #define bool _Bool
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
113
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
114 /* The other macros must be usable in preprocessor directives. */
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
115 #define false 0
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
116 #define true 1
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
117 #define __bool_true_false_are_defined 1
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
118
3c2e1f24cc7d Added generated files for release
lost@l-w.ca
parents:
diff changeset
119 #endif /* _GL_STDBOOL_H */