Blame include/ansidecl.h

Packit bbfece
/* ANSI and traditional C compatability macros
Packit bbfece
   Copyright (C) 1991-2018 Free Software Foundation, Inc.
Packit bbfece
   This file is part of the GNU C Library.
Packit bbfece
Packit bbfece
This program is free software; you can redistribute it and/or modify
Packit bbfece
it under the terms of the GNU General Public License as published by
Packit bbfece
the Free Software Foundation; either version 2 of the License, or
Packit bbfece
(at your option) any later version.
Packit bbfece
Packit bbfece
This program is distributed in the hope that it will be useful,
Packit bbfece
but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit bbfece
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit bbfece
GNU General Public License for more details.
Packit bbfece
Packit bbfece
You should have received a copy of the GNU General Public License
Packit bbfece
along with this program; if not, write to the Free Software
Packit bbfece
Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.  */
Packit bbfece
Packit bbfece
/* ANSI and traditional C compatibility macros
Packit bbfece
Packit bbfece
   ANSI C is assumed if __STDC__ is #defined.
Packit bbfece
Packit bbfece
   Macro		ANSI C definition	Traditional C definition
Packit bbfece
   -----		---- - ----------	----------- - ----------
Packit bbfece
   PTR			`void *'		`char *'
Packit bbfece
   const		not defined		`'
Packit bbfece
   volatile		not defined		`'
Packit bbfece
   signed		not defined		`'
Packit bbfece
Packit bbfece
   For ease of writing code which uses GCC extensions but needs to be
Packit bbfece
   portable to other compilers, we provide the GCC_VERSION macro that
Packit bbfece
   simplifies testing __GNUC__ and __GNUC_MINOR__ together, and various
Packit bbfece
   wrappers around __attribute__.  Also, __extension__ will be #defined
Packit bbfece
   to nothing if it doesn't work.  See below.  */
Packit bbfece
Packit bbfece
#ifndef	_ANSIDECL_H
Packit bbfece
#define _ANSIDECL_H	1
Packit bbfece
Packit bbfece
#ifdef __cplusplus
Packit bbfece
extern "C" {
Packit bbfece
#endif
Packit bbfece
Packit bbfece
/* Every source file includes this file,
Packit bbfece
   so they will all get the switch for lint.  */
Packit bbfece
/* LINTLIBRARY */
Packit bbfece
Packit bbfece
/* Using MACRO(x,y) in cpp #if conditionals does not work with some
Packit bbfece
   older preprocessors.  Thus we can't define something like this:
Packit bbfece
Packit bbfece
#define HAVE_GCC_VERSION(MAJOR, MINOR) \
Packit bbfece
  (__GNUC__ > (MAJOR) || (__GNUC__ == (MAJOR) && __GNUC_MINOR__ >= (MINOR)))
Packit bbfece
Packit bbfece
and then test "#if HAVE_GCC_VERSION(2,7)".
Packit bbfece
Packit bbfece
So instead we use the macro below and test it against specific values.  */
Packit bbfece
Packit bbfece
/* This macro simplifies testing whether we are using gcc, and if it
Packit bbfece
   is of a particular minimum version. (Both major & minor numbers are
Packit bbfece
   significant.)  This macro will evaluate to 0 if we are not using
Packit bbfece
   gcc at all.  */
Packit bbfece
#ifndef GCC_VERSION
Packit bbfece
#define GCC_VERSION (__GNUC__ * 1000 + __GNUC_MINOR__)
Packit bbfece
#endif /* GCC_VERSION */
Packit bbfece
Packit bbfece
#if defined (__STDC__) || defined(__cplusplus) || defined (_AIX) || (defined (__mips) && defined (_SYSTYPE_SVR4)) || defined(_WIN32)
Packit bbfece
/* All known AIX compilers implement these things (but don't always
Packit bbfece
   define __STDC__).  The RISC/OS MIPS compiler defines these things
Packit bbfece
   in SVR4 mode, but does not define __STDC__.  */
Packit bbfece
/* eraxxon@alumni.rice.edu: The Compaq C++ compiler, unlike many other
Packit bbfece
   C++ compilers, does not define __STDC__, though it acts as if this
Packit bbfece
   was so. (Verified versions: 5.7, 6.2, 6.3, 6.5) */
Packit bbfece
Packit bbfece
#define PTR		void *
Packit bbfece
Packit bbfece
#undef const
Packit bbfece
#undef volatile
Packit bbfece
#undef signed
Packit bbfece
Packit bbfece
/* inline requires special treatment; it's in C99, and GCC >=2.7 supports
Packit bbfece
   it too, but it's not in C89.  */
Packit bbfece
#undef inline
Packit bbfece
#if __STDC_VERSION__ >= 199901L || defined(__cplusplus) || (defined(__SUNPRO_C) && defined(__C99FEATURES__))
Packit bbfece
/* it's a keyword */
Packit bbfece
#else
Packit bbfece
# if GCC_VERSION >= 2007
Packit bbfece
#  define inline __inline__   /* __inline__ prevents -pedantic warnings */
Packit bbfece
# else
Packit bbfece
#  define inline  /* nothing */
Packit bbfece
# endif
Packit bbfece
#endif
Packit bbfece
Packit bbfece
#else	/* Not ANSI C.  */
Packit bbfece
Packit bbfece
#define PTR		char *
Packit bbfece
Packit bbfece
/* some systems define these in header files for non-ansi mode */
Packit bbfece
#undef const
Packit bbfece
#undef volatile
Packit bbfece
#undef signed
Packit bbfece
#undef inline
Packit bbfece
#define const
Packit bbfece
#define volatile
Packit bbfece
#define signed
Packit bbfece
#define inline
Packit bbfece
Packit bbfece
#endif	/* ANSI C.  */
Packit bbfece
Packit bbfece
/* Define macros for some gcc attributes.  This permits us to use the
Packit bbfece
   macros freely, and know that they will come into play for the
Packit bbfece
   version of gcc in which they are supported.  */
Packit bbfece
Packit bbfece
#if (GCC_VERSION < 2007)
Packit bbfece
# define __attribute__(x)
Packit bbfece
#endif
Packit bbfece
Packit bbfece
/* Attribute __malloc__ on functions was valid as of gcc 2.96. */
Packit bbfece
#ifndef ATTRIBUTE_MALLOC
Packit bbfece
# if (GCC_VERSION >= 2096)
Packit bbfece
#  define ATTRIBUTE_MALLOC __attribute__ ((__malloc__))
Packit bbfece
# else
Packit bbfece
#  define ATTRIBUTE_MALLOC
Packit bbfece
# endif /* GNUC >= 2.96 */
Packit bbfece
#endif /* ATTRIBUTE_MALLOC */
Packit bbfece
Packit bbfece
/* Attributes on labels were valid as of gcc 2.93 and g++ 4.5.  For
Packit bbfece
   g++ an attribute on a label must be followed by a semicolon.  */
Packit bbfece
#ifndef ATTRIBUTE_UNUSED_LABEL
Packit bbfece
# ifndef __cplusplus
Packit bbfece
#  if GCC_VERSION >= 2093
Packit bbfece
#   define ATTRIBUTE_UNUSED_LABEL ATTRIBUTE_UNUSED
Packit bbfece
#  else
Packit bbfece
#   define ATTRIBUTE_UNUSED_LABEL
Packit bbfece
#  endif
Packit bbfece
# else
Packit bbfece
#  if GCC_VERSION >= 4005
Packit bbfece
#   define ATTRIBUTE_UNUSED_LABEL ATTRIBUTE_UNUSED ;
Packit bbfece
#  else
Packit bbfece
#   define ATTRIBUTE_UNUSED_LABEL
Packit bbfece
#  endif
Packit bbfece
# endif
Packit bbfece
#endif
Packit bbfece
Packit bbfece
/* Similarly to ARG_UNUSED below.  Prior to GCC 3.4, the C++ frontend
Packit bbfece
   couldn't parse attributes placed after the identifier name, and now
Packit bbfece
   the entire compiler is built with C++.  */
Packit bbfece
#ifndef ATTRIBUTE_UNUSED
Packit bbfece
#if GCC_VERSION >= 3004
Packit bbfece
#  define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
Packit bbfece
#else
Packit bbfece
#define ATTRIBUTE_UNUSED
Packit bbfece
#endif
Packit bbfece
#endif /* ATTRIBUTE_UNUSED */
Packit bbfece
Packit bbfece
/* Before GCC 3.4, the C++ frontend couldn't parse attributes placed after the
Packit bbfece
   identifier name.  */
Packit bbfece
#if ! defined(__cplusplus) || (GCC_VERSION >= 3004)
Packit bbfece
# define ARG_UNUSED(NAME) NAME ATTRIBUTE_UNUSED
Packit bbfece
#else /* !__cplusplus || GNUC >= 3.4 */
Packit bbfece
# define ARG_UNUSED(NAME) NAME
Packit bbfece
#endif /* !__cplusplus || GNUC >= 3.4 */
Packit bbfece
Packit bbfece
#ifndef ATTRIBUTE_NORETURN
Packit bbfece
#define ATTRIBUTE_NORETURN __attribute__ ((__noreturn__))
Packit bbfece
#endif /* ATTRIBUTE_NORETURN */
Packit bbfece
Packit bbfece
/* Attribute `nonnull' was valid as of gcc 3.3.  */
Packit bbfece
#ifndef ATTRIBUTE_NONNULL
Packit bbfece
# if (GCC_VERSION >= 3003)
Packit bbfece
#  define ATTRIBUTE_NONNULL(m) __attribute__ ((__nonnull__ (m)))
Packit bbfece
# else
Packit bbfece
#  define ATTRIBUTE_NONNULL(m)
Packit bbfece
# endif /* GNUC >= 3.3 */
Packit bbfece
#endif /* ATTRIBUTE_NONNULL */
Packit bbfece
Packit bbfece
/* Attribute `returns_nonnull' was valid as of gcc 4.9.  */
Packit bbfece
#ifndef ATTRIBUTE_RETURNS_NONNULL
Packit bbfece
# if (GCC_VERSION >= 4009)
Packit bbfece
#  define ATTRIBUTE_RETURNS_NONNULL __attribute__ ((__returns_nonnull__))
Packit bbfece
# else
Packit bbfece
#  define ATTRIBUTE_RETURNS_NONNULL
Packit bbfece
# endif /* GNUC >= 4.9 */
Packit bbfece
#endif /* ATTRIBUTE_RETURNS_NONNULL */
Packit bbfece
Packit bbfece
/* Attribute `pure' was valid as of gcc 3.0.  */
Packit bbfece
#ifndef ATTRIBUTE_PURE
Packit bbfece
# if (GCC_VERSION >= 3000)
Packit bbfece
#  define ATTRIBUTE_PURE __attribute__ ((__pure__))
Packit bbfece
# else
Packit bbfece
#  define ATTRIBUTE_PURE
Packit bbfece
# endif /* GNUC >= 3.0 */
Packit bbfece
#endif /* ATTRIBUTE_PURE */
Packit bbfece
Packit bbfece
/* Use ATTRIBUTE_PRINTF when the format specifier must not be NULL.
Packit bbfece
   This was the case for the `printf' format attribute by itself
Packit bbfece
   before GCC 3.3, but as of 3.3 we need to add the `nonnull'
Packit bbfece
   attribute to retain this behavior.  */
Packit bbfece
#ifndef ATTRIBUTE_PRINTF
Packit bbfece
#define ATTRIBUTE_PRINTF(m, n) __attribute__ ((__format__ (__printf__, m, n))) ATTRIBUTE_NONNULL(m)
Packit bbfece
#define ATTRIBUTE_PRINTF_1 ATTRIBUTE_PRINTF(1, 2)
Packit bbfece
#define ATTRIBUTE_PRINTF_2 ATTRIBUTE_PRINTF(2, 3)
Packit bbfece
#define ATTRIBUTE_PRINTF_3 ATTRIBUTE_PRINTF(3, 4)
Packit bbfece
#define ATTRIBUTE_PRINTF_4 ATTRIBUTE_PRINTF(4, 5)
Packit bbfece
#define ATTRIBUTE_PRINTF_5 ATTRIBUTE_PRINTF(5, 6)
Packit bbfece
#endif /* ATTRIBUTE_PRINTF */
Packit bbfece
Packit bbfece
/* Use ATTRIBUTE_FPTR_PRINTF when the format attribute is to be set on
Packit bbfece
   a function pointer.  Format attributes were allowed on function
Packit bbfece
   pointers as of gcc 3.1.  */
Packit bbfece
#ifndef ATTRIBUTE_FPTR_PRINTF
Packit bbfece
# if (GCC_VERSION >= 3001)
Packit bbfece
#  define ATTRIBUTE_FPTR_PRINTF(m, n) ATTRIBUTE_PRINTF(m, n)
Packit bbfece
# else
Packit bbfece
#  define ATTRIBUTE_FPTR_PRINTF(m, n)
Packit bbfece
# endif /* GNUC >= 3.1 */
Packit bbfece
# define ATTRIBUTE_FPTR_PRINTF_1 ATTRIBUTE_FPTR_PRINTF(1, 2)
Packit bbfece
# define ATTRIBUTE_FPTR_PRINTF_2 ATTRIBUTE_FPTR_PRINTF(2, 3)
Packit bbfece
# define ATTRIBUTE_FPTR_PRINTF_3 ATTRIBUTE_FPTR_PRINTF(3, 4)
Packit bbfece
# define ATTRIBUTE_FPTR_PRINTF_4 ATTRIBUTE_FPTR_PRINTF(4, 5)
Packit bbfece
# define ATTRIBUTE_FPTR_PRINTF_5 ATTRIBUTE_FPTR_PRINTF(5, 6)
Packit bbfece
#endif /* ATTRIBUTE_FPTR_PRINTF */
Packit bbfece
Packit bbfece
/* Use ATTRIBUTE_NULL_PRINTF when the format specifier may be NULL.  A
Packit bbfece
   NULL format specifier was allowed as of gcc 3.3.  */
Packit bbfece
#ifndef ATTRIBUTE_NULL_PRINTF
Packit bbfece
# if (GCC_VERSION >= 3003)
Packit bbfece
#  define ATTRIBUTE_NULL_PRINTF(m, n) __attribute__ ((__format__ (__printf__, m, n)))
Packit bbfece
# else
Packit bbfece
#  define ATTRIBUTE_NULL_PRINTF(m, n)
Packit bbfece
# endif /* GNUC >= 3.3 */
Packit bbfece
# define ATTRIBUTE_NULL_PRINTF_1 ATTRIBUTE_NULL_PRINTF(1, 2)
Packit bbfece
# define ATTRIBUTE_NULL_PRINTF_2 ATTRIBUTE_NULL_PRINTF(2, 3)
Packit bbfece
# define ATTRIBUTE_NULL_PRINTF_3 ATTRIBUTE_NULL_PRINTF(3, 4)
Packit bbfece
# define ATTRIBUTE_NULL_PRINTF_4 ATTRIBUTE_NULL_PRINTF(4, 5)
Packit bbfece
# define ATTRIBUTE_NULL_PRINTF_5 ATTRIBUTE_NULL_PRINTF(5, 6)
Packit bbfece
#endif /* ATTRIBUTE_NULL_PRINTF */
Packit bbfece
Packit bbfece
/* Attribute `sentinel' was valid as of gcc 3.5.  */
Packit bbfece
#ifndef ATTRIBUTE_SENTINEL
Packit bbfece
# if (GCC_VERSION >= 3005)
Packit bbfece
#  define ATTRIBUTE_SENTINEL __attribute__ ((__sentinel__))
Packit bbfece
# else
Packit bbfece
#  define ATTRIBUTE_SENTINEL
Packit bbfece
# endif /* GNUC >= 3.5 */
Packit bbfece
#endif /* ATTRIBUTE_SENTINEL */
Packit bbfece
Packit bbfece
Packit bbfece
#ifndef ATTRIBUTE_ALIGNED_ALIGNOF
Packit bbfece
# if (GCC_VERSION >= 3000)
Packit bbfece
#  define ATTRIBUTE_ALIGNED_ALIGNOF(m) __attribute__ ((__aligned__ (__alignof__ (m))))
Packit bbfece
# else
Packit bbfece
#  define ATTRIBUTE_ALIGNED_ALIGNOF(m)
Packit bbfece
# endif /* GNUC >= 3.0 */
Packit bbfece
#endif /* ATTRIBUTE_ALIGNED_ALIGNOF */
Packit bbfece
Packit bbfece
/* Useful for structures whose layout must match some binary specification
Packit bbfece
   regardless of the alignment and padding qualities of the compiler.  */
Packit bbfece
#ifndef ATTRIBUTE_PACKED
Packit bbfece
# define ATTRIBUTE_PACKED __attribute__ ((packed))
Packit bbfece
#endif
Packit bbfece
Packit bbfece
/* Attribute `hot' and `cold' was valid as of gcc 4.3.  */
Packit bbfece
#ifndef ATTRIBUTE_COLD
Packit bbfece
# if (GCC_VERSION >= 4003)
Packit bbfece
#  define ATTRIBUTE_COLD __attribute__ ((__cold__))
Packit bbfece
# else
Packit bbfece
#  define ATTRIBUTE_COLD
Packit bbfece
# endif /* GNUC >= 4.3 */
Packit bbfece
#endif /* ATTRIBUTE_COLD */
Packit bbfece
#ifndef ATTRIBUTE_HOT
Packit bbfece
# if (GCC_VERSION >= 4003)
Packit bbfece
#  define ATTRIBUTE_HOT __attribute__ ((__hot__))
Packit bbfece
# else
Packit bbfece
#  define ATTRIBUTE_HOT
Packit bbfece
# endif /* GNUC >= 4.3 */
Packit bbfece
#endif /* ATTRIBUTE_HOT */
Packit bbfece
Packit bbfece
/* Attribute 'no_sanitize_undefined' was valid as of gcc 4.9.  */
Packit bbfece
#ifndef ATTRIBUTE_NO_SANITIZE_UNDEFINED
Packit bbfece
# if (GCC_VERSION >= 4009)
Packit bbfece
#  define ATTRIBUTE_NO_SANITIZE_UNDEFINED __attribute__ ((no_sanitize_undefined))
Packit bbfece
# else
Packit bbfece
#  define ATTRIBUTE_NO_SANITIZE_UNDEFINED
Packit bbfece
# endif /* GNUC >= 4.9 */
Packit bbfece
#endif /* ATTRIBUTE_NO_SANITIZE_UNDEFINED */
Packit bbfece
Packit bbfece
/* We use __extension__ in some places to suppress -pedantic warnings
Packit bbfece
   about GCC extensions.  This feature didn't work properly before
Packit bbfece
   gcc 2.8.  */
Packit bbfece
#if GCC_VERSION < 2008
Packit bbfece
#define __extension__
Packit bbfece
#endif
Packit bbfece
Packit bbfece
/* This is used to declare a const variable which should be visible
Packit bbfece
   outside of the current compilation unit.  Use it as
Packit bbfece
     EXPORTED_CONST int i = 1;
Packit bbfece
   This is because the semantics of const are different in C and C++.
Packit bbfece
   "extern const" is permitted in C but it looks strange, and gcc
Packit bbfece
   warns about it when -Wc++-compat is not used.  */
Packit bbfece
#ifdef __cplusplus
Packit bbfece
#define EXPORTED_CONST extern const
Packit bbfece
#else
Packit bbfece
#define EXPORTED_CONST const
Packit bbfece
#endif
Packit bbfece
Packit bbfece
/* Be conservative and only use enum bitfields with C++ or GCC.
Packit bbfece
   FIXME: provide a complete autoconf test for buggy enum bitfields.  */
Packit bbfece
Packit bbfece
#ifdef __cplusplus
Packit bbfece
#define ENUM_BITFIELD(TYPE) enum TYPE
Packit bbfece
#elif (GCC_VERSION > 2000)
Packit bbfece
#define ENUM_BITFIELD(TYPE) __extension__ enum TYPE
Packit bbfece
#else
Packit bbfece
#define ENUM_BITFIELD(TYPE) unsigned int
Packit bbfece
#endif
Packit bbfece
Packit bbfece
#if __cpp_constexpr >= 200704
Packit bbfece
#define CONSTEXPR constexpr
Packit bbfece
#else
Packit bbfece
#define CONSTEXPR
Packit bbfece
#endif
Packit bbfece
Packit bbfece
/* C++11 adds the ability to add "override" after an implementation of a
Packit bbfece
   virtual function in a subclass, to:
Packit bbfece
     (A) document that this is an override of a virtual function
Packit bbfece
     (B) allow the compiler to issue a warning if it isn't (e.g. a mismatch
Packit bbfece
         of the type signature).
Packit bbfece
Packit bbfece
   Similarly, it allows us to add a "final" to indicate that no subclass
Packit bbfece
   may subsequently override the vfunc.
Packit bbfece
Packit bbfece
   Provide OVERRIDE and FINAL as macros, allowing us to get these benefits
Packit bbfece
   when compiling with C++11 support, but without requiring C++11.
Packit bbfece
Packit bbfece
   For gcc, use "-std=c++11" to enable C++11 support; gcc 6 onwards enables
Packit bbfece
   this by default (actually GNU++14).  */
Packit bbfece
Packit bbfece
#if defined __cplusplus
Packit bbfece
# if __cplusplus >= 201103
Packit bbfece
   /* C++11 claims to be available: use it.  Final/override were only
Packit bbfece
      implemented in 4.7, though.  */
Packit bbfece
#  if GCC_VERSION < 4007
Packit bbfece
#   define OVERRIDE
Packit bbfece
#   define FINAL
Packit bbfece
#  else
Packit bbfece
#   define OVERRIDE override
Packit bbfece
#   define FINAL final
Packit bbfece
#  endif
Packit bbfece
# elif GCC_VERSION >= 4007
Packit bbfece
   /* G++ 4.7 supports __final in C++98.  */
Packit bbfece
#  define OVERRIDE
Packit bbfece
#  define FINAL __final
Packit bbfece
# else
Packit bbfece
   /* No C++11 support; leave the macros empty.  */
Packit bbfece
#  define OVERRIDE
Packit bbfece
#  define FINAL
Packit bbfece
# endif
Packit bbfece
#else
Packit bbfece
  /* No C++11 support; leave the macros empty.  */
Packit bbfece
# define OVERRIDE
Packit bbfece
# define FINAL
Packit bbfece
#endif
Packit bbfece
Packit bbfece
/* A macro to disable the copy constructor and assignment operator.
Packit bbfece
   When building with C++11 and above, the methods are explicitly
Packit bbfece
   deleted, causing a compile-time error if something tries to copy.
Packit bbfece
   For C++03, this just declares the methods, causing a link-time
Packit bbfece
   error if the methods end up called (assuming you don't
Packit bbfece
   define them).  For C++03, for best results, place the macro
Packit bbfece
   under the private: access specifier, like this,
Packit bbfece
Packit bbfece
   class name_lookup
Packit bbfece
   {
Packit bbfece
     private:
Packit bbfece
       DISABLE_COPY_AND_ASSIGN (name_lookup);
Packit bbfece
   };
Packit bbfece
Packit bbfece
   so that most attempts at copy are caught at compile-time.  */
Packit bbfece
Packit bbfece
#if __cplusplus >= 201103
Packit bbfece
#define DISABLE_COPY_AND_ASSIGN(TYPE)		\
Packit bbfece
  TYPE (const TYPE&) = delete;			\
Packit bbfece
  void operator= (const TYPE &) = delete
Packit bbfece
  #else
Packit bbfece
#define DISABLE_COPY_AND_ASSIGN(TYPE)		\
Packit bbfece
  TYPE (const TYPE&);				\
Packit bbfece
  void operator= (const TYPE &)
Packit bbfece
#endif /* __cplusplus >= 201103 */
Packit bbfece
Packit bbfece
#ifdef __cplusplus
Packit bbfece
}
Packit bbfece
#endif
Packit bbfece
Packit bbfece
#endif	/* ansidecl.h	*/