Blame gnulib/lib/stdbool.in.h

Packit 06dd63
/* Copyright (C) 2001-2003, 2006-2019 Free Software Foundation, Inc.
Packit 06dd63
   Written by Bruno Haible <haible@clisp.cons.org>, 2001.
Packit 06dd63
Packit 06dd63
   This program is free software; you can redistribute it and/or modify
Packit 06dd63
   it under the terms of the GNU Lesser General Public License as published by
Packit 06dd63
   the Free Software Foundation; either version 2.1, or (at your option)
Packit 06dd63
   any later version.
Packit 06dd63
Packit 06dd63
   This program is distributed in the hope that it will be useful,
Packit 06dd63
   but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 06dd63
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit 06dd63
   GNU Lesser General Public License for more details.
Packit 06dd63
Packit 06dd63
   You should have received a copy of the GNU Lesser General Public License
Packit 06dd63
   along with this program; if not, see <https://www.gnu.org/licenses/>.  */
Packit 06dd63
Packit 06dd63
#ifndef _GL_STDBOOL_H
Packit 06dd63
#define _GL_STDBOOL_H
Packit 06dd63
Packit 06dd63
/* ISO C 99 <stdbool.h> for platforms that lack it.  */
Packit 06dd63
Packit 06dd63
/* Usage suggestions:
Packit 06dd63
Packit 06dd63
   Programs that use <stdbool.h> should be aware of some limitations
Packit 06dd63
   and standards compliance issues.
Packit 06dd63
Packit 06dd63
   Standards compliance:
Packit 06dd63
Packit 06dd63
       - <stdbool.h> must be #included before 'bool', 'false', 'true'
Packit 06dd63
         can be used.
Packit 06dd63
Packit 06dd63
       - You cannot assume that sizeof (bool) == 1.
Packit 06dd63
Packit 06dd63
       - Programs should not undefine the macros bool, true, and false,
Packit 06dd63
         as C99 lists that as an "obsolescent feature".
Packit 06dd63
Packit 06dd63
   Limitations of this substitute, when used in a C89 environment:
Packit 06dd63
Packit 06dd63
       - <stdbool.h> must be #included before the '_Bool' type can be used.
Packit 06dd63
Packit 06dd63
       - You cannot assume that _Bool is a typedef; it might be a macro.
Packit 06dd63
Packit 06dd63
       - Bit-fields of type 'bool' are not supported.  Portable code
Packit 06dd63
         should use 'unsigned int foo : 1;' rather than 'bool foo : 1;'.
Packit 06dd63
Packit 06dd63
       - In C99, casts and automatic conversions to '_Bool' or 'bool' are
Packit 06dd63
         performed in such a way that every nonzero value gets converted
Packit 06dd63
         to 'true', and zero gets converted to 'false'.  This doesn't work
Packit 06dd63
         with this substitute.  With this substitute, only the values 0 and 1
Packit 06dd63
         give the expected result when converted to _Bool' or 'bool'.
Packit 06dd63
Packit 06dd63
       - C99 allows the use of (_Bool)0.0 in constant expressions, but
Packit 06dd63
         this substitute cannot always provide this property.
Packit 06dd63
Packit 06dd63
   Also, it is suggested that programs use 'bool' rather than '_Bool';
Packit 06dd63
   this isn't required, but 'bool' is more common.  */
Packit 06dd63
Packit 06dd63
Packit 06dd63
/* 7.16. Boolean type and values */
Packit 06dd63
Packit 06dd63
/* BeOS <sys/socket.h> already #defines false 0, true 1.  We use the same
Packit 06dd63
   definitions below, but temporarily we have to #undef them.  */
Packit 06dd63
#if defined __BEOS__ && !defined __HAIKU__
Packit 06dd63
# include <OS.h> /* defines bool but not _Bool */
Packit 06dd63
# undef false
Packit 06dd63
# undef true
Packit 06dd63
#endif
Packit 06dd63
Packit 06dd63
#ifdef __cplusplus
Packit 06dd63
# define _Bool bool
Packit 06dd63
# define bool bool
Packit 06dd63
#else
Packit 06dd63
# if defined __BEOS__ && !defined __HAIKU__
Packit 06dd63
  /* A compiler known to have 'bool'.  */
Packit 06dd63
  /* If the compiler already has both 'bool' and '_Bool', we can assume they
Packit 06dd63
     are the same types.  */
Packit 06dd63
#  if !@HAVE__BOOL@
Packit 06dd63
typedef bool _Bool;
Packit 06dd63
#  endif
Packit 06dd63
# else
Packit 06dd63
#  if !defined __GNUC__
Packit 06dd63
   /* If @HAVE__BOOL@:
Packit 06dd63
        Some HP-UX cc and AIX IBM C compiler versions have compiler bugs when
Packit 06dd63
        the built-in _Bool type is used.  See
Packit 06dd63
          https://gcc.gnu.org/ml/gcc-patches/2003-12/msg02303.html
Packit 06dd63
          https://lists.gnu.org/r/bug-coreutils/2005-11/msg00161.html
Packit 06dd63
          https://lists.gnu.org/r/bug-coreutils/2005-10/msg00086.html
Packit 06dd63
        Similar bugs are likely with other compilers as well; this file
Packit 06dd63
        wouldn't be used if <stdbool.h> was working.
Packit 06dd63
        So we override the _Bool type.
Packit 06dd63
      If !@HAVE__BOOL@:
Packit 06dd63
        Need to define _Bool ourselves. As 'signed char' or as an enum type?
Packit 06dd63
        Use of a typedef, with SunPRO C, leads to a stupid
Packit 06dd63
          "warning: _Bool is a keyword in ISO C99".
Packit 06dd63
        Use of an enum type, with IRIX cc, leads to a stupid
Packit 06dd63
          "warning(1185): enumerated type mixed with another type".
Packit 06dd63
        Even the existence of an enum type, without a typedef,
Packit 06dd63
          "Invalid enumerator. (badenum)" with HP-UX cc on Tru64.
Packit 06dd63
        The only benefit of the enum, debuggability, is not important
Packit 06dd63
        with these compilers.  So use 'signed char' and no enum.  */
Packit 06dd63
#   define _Bool signed char
Packit 06dd63
#  else
Packit 06dd63
   /* With this compiler, trust the _Bool type if the compiler has it.  */
Packit 06dd63
#   if !@HAVE__BOOL@
Packit 06dd63
   /* For the sake of symbolic names in gdb, define true and false as
Packit 06dd63
      enum constants, not only as macros.
Packit 06dd63
      It is tempting to write
Packit 06dd63
         typedef enum { false = 0, true = 1 } _Bool;
Packit 06dd63
      so that gdb prints values of type 'bool' symbolically.  But then
Packit 06dd63
      values of type '_Bool' might promote to 'int' or 'unsigned int'
Packit 06dd63
      (see ISO C 99 6.7.2.2.(4)); however, '_Bool' must promote to 'int'
Packit 06dd63
      (see ISO C 99 6.3.1.1.(2)).  So add a negative value to the
Packit 06dd63
      enum; this ensures that '_Bool' promotes to 'int'.  */
Packit 06dd63
typedef enum { _Bool_must_promote_to_int = -1, false = 0, true = 1 } _Bool;
Packit 06dd63
#   endif
Packit 06dd63
#  endif
Packit 06dd63
# endif
Packit 06dd63
# define bool _Bool
Packit 06dd63
#endif
Packit 06dd63
Packit 06dd63
/* The other macros must be usable in preprocessor directives.  */
Packit 06dd63
#ifdef __cplusplus
Packit 06dd63
# define false false
Packit 06dd63
# define true true
Packit 06dd63
#else
Packit 06dd63
# define false 0
Packit 06dd63
# define true 1
Packit 06dd63
#endif
Packit 06dd63
Packit 06dd63
#define __bool_true_false_are_defined 1
Packit 06dd63
Packit 06dd63
#endif /* _GL_STDBOOL_H */