[deliverable/binutils-gdb.git] / include / ansidecl.h

/* ANSI and traditional C compatability macros
   Copyright (C) 1991-2019 Free Software Foundation, Inc.
   This file is part of the GNU C Library.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.  */

/* ANSI and traditional C compatibility macros

   ANSI C is assumed if __STDC__ is #defined.

   Macro		ANSI C definition	Traditional C definition
   -----		---- - ----------	----------- - ----------
   PTR			`void *'		`char *'
   const		not defined		`'
   volatile		not defined		`'
   signed		not defined		`'

   For ease of writing code which uses GCC extensions but needs to be
   portable to other compilers, we provide the GCC_VERSION macro that
   simplifies testing __GNUC__ and __GNUC_MINOR__ together, and various
   wrappers around __attribute__.  Also, __extension__ will be #defined
   to nothing if it doesn't work.  See below.  */

#ifndef	_ANSIDECL_H
#define _ANSIDECL_H	1

#ifdef __cplusplus
extern "C" {
#endif

/* Every source file includes this file,
   so they will all get the switch for lint.  */
/* LINTLIBRARY */

/* Using MACRO(x,y) in cpp #if conditionals does not work with some
   older preprocessors.  Thus we can't define something like this:

#define HAVE_GCC_VERSION(MAJOR, MINOR) \
  (__GNUC__ > (MAJOR) || (__GNUC__ == (MAJOR) && __GNUC_MINOR__ >= (MINOR)))

and then test "#if HAVE_GCC_VERSION(2,7)".

So instead we use the macro below and test it against specific values.  */

/* This macro simplifies testing whether we are using gcc, and if it
   is of a particular minimum version. (Both major & minor numbers are
   significant.)  This macro will evaluate to 0 if we are not using
   gcc at all.  */
#ifndef GCC_VERSION
#define GCC_VERSION (__GNUC__ * 1000 + __GNUC_MINOR__)
#endif /* GCC_VERSION */

#if defined (__STDC__) || defined(__cplusplus) || defined (_AIX) || (defined (__mips) && defined (_SYSTYPE_SVR4)) || defined(_WIN32)
/* All known AIX compilers implement these things (but don't always
   define __STDC__).  The RISC/OS MIPS compiler defines these things
   in SVR4 mode, but does not define __STDC__.  */
/* eraxxon@alumni.rice.edu: The Compaq C++ compiler, unlike many other
   C++ compilers, does not define __STDC__, though it acts as if this
   was so. (Verified versions: 5.7, 6.2, 6.3, 6.5) */

#define PTR		void *

#undef const
#undef volatile
#undef signed

/* inline requires special treatment; it's in C99, and GCC >=2.7 supports
   it too, but it's not in C89.  */
#undef inline
#if __STDC_VERSION__ >= 199901L || defined(__cplusplus) || (defined(__SUNPRO_C) && defined(__C99FEATURES__))
/* it's a keyword */
#else
# if GCC_VERSION >= 2007
#  define inline __inline__   /* __inline__ prevents -pedantic warnings */
# else
#  define inline  /* nothing */
# endif
#endif

#else	/* Not ANSI C.  */

#define PTR		char *

/* some systems define these in header files for non-ansi mode */
#undef const
#undef volatile
#undef signed
#undef inline
#define const
#define volatile
#define signed
#define inline

#endif	/* ANSI C.  */

/* Define macros for some gcc attributes.  This permits us to use the
   macros freely, and know that they will come into play for the
   version of gcc in which they are supported.  */

#if (GCC_VERSION < 2007)
# define __attribute__(x)
#endif

/* Attribute __malloc__ on functions was valid as of gcc 2.96. */
#ifndef ATTRIBUTE_MALLOC
# if (GCC_VERSION >= 2096)
#  define ATTRIBUTE_MALLOC __attribute__ ((__malloc__))
# else
#  define ATTRIBUTE_MALLOC
# endif /* GNUC >= 2.96 */
#endif /* ATTRIBUTE_MALLOC */

/* Attributes on labels were valid as of gcc 2.93 and g++ 4.5.  For
   g++ an attribute on a label must be followed by a semicolon.  */
#ifndef ATTRIBUTE_UNUSED_LABEL
# ifndef __cplusplus
#  if GCC_VERSION >= 2093
#   define ATTRIBUTE_UNUSED_LABEL ATTRIBUTE_UNUSED
#  else
#   define ATTRIBUTE_UNUSED_LABEL
#  endif
# else
#  if GCC_VERSION >= 4005
#   define ATTRIBUTE_UNUSED_LABEL ATTRIBUTE_UNUSED ;
#  else
#   define ATTRIBUTE_UNUSED_LABEL
#  endif
# endif
#endif

/* Similarly to ARG_UNUSED below.  Prior to GCC 3.4, the C++ frontend
   couldn't parse attributes placed after the identifier name, and now
   the entire compiler is built with C++.  */
#ifndef ATTRIBUTE_UNUSED
#if GCC_VERSION >= 3004
#  define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
#else
#define ATTRIBUTE_UNUSED
#endif
#endif /* ATTRIBUTE_UNUSED */

/* Before GCC 3.4, the C++ frontend couldn't parse attributes placed after the
   identifier name.  */
#if ! defined(__cplusplus) || (GCC_VERSION >= 3004)
# define ARG_UNUSED(NAME) NAME ATTRIBUTE_UNUSED
#else /* !__cplusplus || GNUC >= 3.4 */
# define ARG_UNUSED(NAME) NAME
#endif /* !__cplusplus || GNUC >= 3.4 */

#ifndef ATTRIBUTE_NORETURN
#define ATTRIBUTE_NORETURN __attribute__ ((__noreturn__))
#endif /* ATTRIBUTE_NORETURN */

/* Attribute `nonnull' was valid as of gcc 3.3.  */
#ifndef ATTRIBUTE_NONNULL
# if (GCC_VERSION >= 3003)
#  define ATTRIBUTE_NONNULL(m) __attribute__ ((__nonnull__ (m)))
# else
#  define ATTRIBUTE_NONNULL(m)
# endif /* GNUC >= 3.3 */
#endif /* ATTRIBUTE_NONNULL */

/* Attribute `returns_nonnull' was valid as of gcc 4.9.  */
#ifndef ATTRIBUTE_RETURNS_NONNULL
# if (GCC_VERSION >= 4009)
#  define ATTRIBUTE_RETURNS_NONNULL __attribute__ ((__returns_nonnull__))
# else
#  define ATTRIBUTE_RETURNS_NONNULL
# endif /* GNUC >= 4.9 */
#endif /* ATTRIBUTE_RETURNS_NONNULL */

/* Attribute `pure' was valid as of gcc 3.0.  */
#ifndef ATTRIBUTE_PURE
# if (GCC_VERSION >= 3000)
#  define ATTRIBUTE_PURE __attribute__ ((__pure__))
# else
#  define ATTRIBUTE_PURE
# endif /* GNUC >= 3.0 */
#endif /* ATTRIBUTE_PURE */

/* Use ATTRIBUTE_PRINTF when the format specifier must not be NULL.
   This was the case for the `printf' format attribute by itself
   before GCC 3.3, but as of 3.3 we need to add the `nonnull'
   attribute to retain this behavior.  */
#ifndef ATTRIBUTE_PRINTF
#define ATTRIBUTE_PRINTF(m, n) __attribute__ ((__format__ (__printf__, m, n))) ATTRIBUTE_NONNULL(m)
#define ATTRIBUTE_PRINTF_1 ATTRIBUTE_PRINTF(1, 2)
#define ATTRIBUTE_PRINTF_2 ATTRIBUTE_PRINTF(2, 3)
#define ATTRIBUTE_PRINTF_3 ATTRIBUTE_PRINTF(3, 4)
#define ATTRIBUTE_PRINTF_4 ATTRIBUTE_PRINTF(4, 5)
#define ATTRIBUTE_PRINTF_5 ATTRIBUTE_PRINTF(5, 6)
#endif /* ATTRIBUTE_PRINTF */

/* Use ATTRIBUTE_FPTR_PRINTF when the format attribute is to be set on
   a function pointer.  Format attributes were allowed on function
   pointers as of gcc 3.1.  */
#ifndef ATTRIBUTE_FPTR_PRINTF
# if (GCC_VERSION >= 3001)
#  define ATTRIBUTE_FPTR_PRINTF(m, n) ATTRIBUTE_PRINTF(m, n)
# else
#  define ATTRIBUTE_FPTR_PRINTF(m, n)
# endif /* GNUC >= 3.1 */
# define ATTRIBUTE_FPTR_PRINTF_1 ATTRIBUTE_FPTR_PRINTF(1, 2)
# define ATTRIBUTE_FPTR_PRINTF_2 ATTRIBUTE_FPTR_PRINTF(2, 3)
# define ATTRIBUTE_FPTR_PRINTF_3 ATTRIBUTE_FPTR_PRINTF(3, 4)
# define ATTRIBUTE_FPTR_PRINTF_4 ATTRIBUTE_FPTR_PRINTF(4, 5)
# define ATTRIBUTE_FPTR_PRINTF_5 ATTRIBUTE_FPTR_PRINTF(5, 6)
#endif /* ATTRIBUTE_FPTR_PRINTF */

/* Use ATTRIBUTE_NULL_PRINTF when the format specifier may be NULL.  A
   NULL format specifier was allowed as of gcc 3.3.  */
#ifndef ATTRIBUTE_NULL_PRINTF
# if (GCC_VERSION >= 3003)
#  define ATTRIBUTE_NULL_PRINTF(m, n) __attribute__ ((__format__ (__printf__, m, n)))
# else
#  define ATTRIBUTE_NULL_PRINTF(m, n)
# endif /* GNUC >= 3.3 */
# define ATTRIBUTE_NULL_PRINTF_1 ATTRIBUTE_NULL_PRINTF(1, 2)
# define ATTRIBUTE_NULL_PRINTF_2 ATTRIBUTE_NULL_PRINTF(2, 3)
# define ATTRIBUTE_NULL_PRINTF_3 ATTRIBUTE_NULL_PRINTF(3, 4)
# define ATTRIBUTE_NULL_PRINTF_4 ATTRIBUTE_NULL_PRINTF(4, 5)
# define ATTRIBUTE_NULL_PRINTF_5 ATTRIBUTE_NULL_PRINTF(5, 6)
#endif /* ATTRIBUTE_NULL_PRINTF */

/* Attribute `sentinel' was valid as of gcc 3.5.  */
#ifndef ATTRIBUTE_SENTINEL
# if (GCC_VERSION >= 3005)
#  define ATTRIBUTE_SENTINEL __attribute__ ((__sentinel__))
# else
#  define ATTRIBUTE_SENTINEL
# endif /* GNUC >= 3.5 */
#endif /* ATTRIBUTE_SENTINEL */


#ifndef ATTRIBUTE_ALIGNED_ALIGNOF
# if (GCC_VERSION >= 3000)
#  define ATTRIBUTE_ALIGNED_ALIGNOF(m) __attribute__ ((__aligned__ (__alignof__ (m))))
# else
#  define ATTRIBUTE_ALIGNED_ALIGNOF(m)
# endif /* GNUC >= 3.0 */
#endif /* ATTRIBUTE_ALIGNED_ALIGNOF */

/* Useful for structures whose layout must match some binary specification
   regardless of the alignment and padding qualities of the compiler.  */
#ifndef ATTRIBUTE_PACKED
# define ATTRIBUTE_PACKED __attribute__ ((packed))
#endif

/* Attribute `hot' and `cold' was valid as of gcc 4.3.  */
#ifndef ATTRIBUTE_COLD
# if (GCC_VERSION >= 4003)
#  define ATTRIBUTE_COLD __attribute__ ((__cold__))
# else
#  define ATTRIBUTE_COLD
# endif /* GNUC >= 4.3 */
#endif /* ATTRIBUTE_COLD */
#ifndef ATTRIBUTE_HOT
# if (GCC_VERSION >= 4003)
#  define ATTRIBUTE_HOT __attribute__ ((__hot__))
# else
#  define ATTRIBUTE_HOT
# endif /* GNUC >= 4.3 */
#endif /* ATTRIBUTE_HOT */

/* Attribute 'no_sanitize_undefined' was valid as of gcc 4.9.  */
#ifndef ATTRIBUTE_NO_SANITIZE_UNDEFINED
# if (GCC_VERSION >= 4009)
#  define ATTRIBUTE_NO_SANITIZE_UNDEFINED __attribute__ ((no_sanitize_undefined))
# else
#  define ATTRIBUTE_NO_SANITIZE_UNDEFINED
# endif /* GNUC >= 4.9 */
#endif /* ATTRIBUTE_NO_SANITIZE_UNDEFINED */

/* Attribute 'nonstring' was valid as of gcc 8.  */
#ifndef ATTRIBUTE_NONSTRING
# if GCC_VERSION >= 8000
#  define ATTRIBUTE_NONSTRING __attribute__ ((__nonstring__))
# else
#  define ATTRIBUTE_NONSTRING
# endif
#endif

/* We use __extension__ in some places to suppress -pedantic warnings
   about GCC extensions.  This feature didn't work properly before
   gcc 2.8.  */
#if GCC_VERSION < 2008
#define __extension__
#endif

/* This is used to declare a const variable which should be visible
   outside of the current compilation unit.  Use it as
     EXPORTED_CONST int i = 1;
   This is because the semantics of const are different in C and C++.
   "extern const" is permitted in C but it looks strange, and gcc
   warns about it when -Wc++-compat is not used.  */
#ifdef __cplusplus
#define EXPORTED_CONST extern const
#else
#define EXPORTED_CONST const
#endif

/* Be conservative and only use enum bitfields with C++ or GCC.
   FIXME: provide a complete autoconf test for buggy enum bitfields.  */

#ifdef __cplusplus
#define ENUM_BITFIELD(TYPE) enum TYPE
#elif (GCC_VERSION > 2000)
#define ENUM_BITFIELD(TYPE) __extension__ enum TYPE
#else
#define ENUM_BITFIELD(TYPE) unsigned int
#endif

#if __cpp_constexpr >= 200704
#define CONSTEXPR constexpr
#else
#define CONSTEXPR
#endif

/* C++11 adds the ability to add "override" after an implementation of a
   virtual function in a subclass, to:
     (A) document that this is an override of a virtual function
     (B) allow the compiler to issue a warning if it isn't (e.g. a mismatch
         of the type signature).

   Similarly, it allows us to add a "final" to indicate that no subclass
   may subsequently override the vfunc.

   Provide OVERRIDE and FINAL as macros, allowing us to get these benefits
   when compiling with C++11 support, but without requiring C++11.

   For gcc, use "-std=c++11" to enable C++11 support; gcc 6 onwards enables
   this by default (actually GNU++14).  */

#if defined __cplusplus
# if __cplusplus >= 201103
   /* C++11 claims to be available: use it.  Final/override were only
      implemented in 4.7, though.  */
#  if GCC_VERSION < 4007
#   define OVERRIDE
#   define FINAL
#  else
#   define OVERRIDE override
#   define FINAL final
#  endif
# elif GCC_VERSION >= 4007
   /* G++ 4.7 supports __final in C++98.  */
#  define OVERRIDE
#  define FINAL __final
# else
   /* No C++11 support; leave the macros empty.  */
#  define OVERRIDE
#  define FINAL
# endif
#else
  /* No C++11 support; leave the macros empty.  */
# define OVERRIDE
# define FINAL
#endif

/* A macro to disable the copy constructor and assignment operator.
   When building with C++11 and above, the methods are explicitly
   deleted, causing a compile-time error if something tries to copy.
   For C++03, this just declares the methods, causing a link-time
   error if the methods end up called (assuming you don't
   define them).  For C++03, for best results, place the macro
   under the private: access specifier, like this,

   class name_lookup
   {
     private:
       DISABLE_COPY_AND_ASSIGN (name_lookup);
   };

   so that most attempts at copy are caught at compile-time.  */

#if __cplusplus >= 201103
#define DISABLE_COPY_AND_ASSIGN(TYPE)		\
  TYPE (const TYPE&) = delete;			\
  void operator= (const TYPE &) = delete
  #else
#define DISABLE_COPY_AND_ASSIGN(TYPE)		\
  TYPE (const TYPE&);				\
  void operator= (const TYPE &)
#endif /* __cplusplus >= 201103 */

#ifdef __cplusplus
}
#endif

#endif	/* ansidecl.h	*/
Commit	Line	Data
252b5132	1	/* ANSI and traditional C compatability macros
82704155	2	Copyright (C) 1991-2019 Free Software Foundation, Inc.
252b5132 RH	3	This file is part of the GNU C Library.
	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 2 of the License, or
	8	(at your option) 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, write to the Free Software
e172dbf8	17	Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */
252b5132 RH	18
	19	/* ANSI and traditional C compatibility macros
	20
	21	ANSI C is assumed if __STDC__ is #defined.
	22
562c4c36 DD	23	Macro ANSI C definition Traditional C definition
562c4c36 DD	24	----- ---- - ---------- ----------- - ----------
562c4c36	25	PTR `void ' `char '
562c4c36 DD	26	const not defined `'
	27	volatile not defined `'
	28	signed not defined `'
562c4c36 DD	29
	30	For ease of writing code which uses GCC extensions but needs to be
	31	portable to other compilers, we provide the GCC_VERSION macro that
	32	simplifies testing __GNUC__ and __GNUC_MINOR__ together, and various
	33	wrappers around __attribute__. Also, __extension__ will be #defined
281e9aa6	34	to nothing if it doesn't work. See below. */
252b5132 RH	35
252b5132 RH	36	#ifndef _ANSIDECL_H
562c4c36	37	#define _ANSIDECL_H 1
252b5132	38
52d6785f DD	39	#ifdef __cplusplus
	40	extern "C" {
	41	#endif
	42
252b5132 RH	43	/* Every source file includes this file,
	44	so they will all get the switch for lint. */
	45	/* LINTLIBRARY */
	46
562c4c36 DD	47	/* Using MACRO(x,y) in cpp #if conditionals does not work with some
	48	older preprocessors. Thus we can't define something like this:
	49
	50	#define HAVE_GCC_VERSION(MAJOR, MINOR) \
	51	(__GNUC__ > (MAJOR) \|\| (__GNUC__ == (MAJOR) && __GNUC_MINOR__ >= (MINOR)))
	52
	53	and then test "#if HAVE_GCC_VERSION(2,7)".
	54
	55	So instead we use the macro below and test it against specific values. */
	56
	57	/* This macro simplifies testing whether we are using gcc, and if it
	58	is of a particular minimum version. (Both major & minor numbers are
	59	significant.) This macro will evaluate to 0 if we are not using
	60	gcc at all. */
	61	#ifndef GCC_VERSION
	62	#define GCC_VERSION (__GNUC__ * 1000 + __GNUC_MINOR__)
	63	#endif /* GCC_VERSION */
252b5132	64
52d6785f	65	#if defined (__STDC__) \|\| defined(__cplusplus) \|\| defined (_AIX) \|\| (defined (__mips) && defined (_SYSTYPE_SVR4)) \|\| defined(_WIN32)
252b5132 RH	66	/* All known AIX compilers implement these things (but don't always
	67	define __STDC__). The RISC/OS MIPS compiler defines these things
	68	in SVR4 mode, but does not define __STDC__. */
995a8435 DD	69	/* eraxxon@alumni.rice.edu: The Compaq C++ compiler, unlike many other
	70	C++ compilers, does not define __STDC__, though it acts as if this
	71	was so. (Verified versions: 5.7, 6.2, 6.3, 6.5) */
252b5132	72
562c4c36	73	#define PTR void *
562c4c36	74
562c4c36 DD	75	#undef const
	76	#undef volatile
	77	#undef signed
	78
	79	/* inline requires special treatment; it's in C99, and GCC >=2.7 supports
	80	it too, but it's not in C89. */
	81	#undef inline
43e85a8f	82	#if __STDC_VERSION__ >= 199901L \|\| defined(__cplusplus) \|\| (defined(__SUNPRO_C) && defined(__C99FEATURES__))
562c4c36 DD	83	/* it's a keyword */
	84	#else
	85	# if GCC_VERSION >= 2007
	86	# define inline __inline__ /* __inline__ prevents -pedantic warnings */
	87	# else
	88	# define inline /* nothing */
	89	# endif
	90	#endif
252b5132	91
252b5132 RH	92	#else /* Not ANSI C. */
252b5132 RH	93
562c4c36	94	#define PTR char *
562c4c36 DD	95
	96	/* some systems define these in header files for non-ansi mode */
	97	#undef const
	98	#undef volatile
	99	#undef signed
	100	#undef inline
	101	#define const
	102	#define volatile
	103	#define signed
	104	#define inline
252b5132	105
252b5132 RH	106	#endif /* ANSI C. */
252b5132 RH	107
893e9593 ILT	108	/* Define macros for some gcc attributes. This permits us to use the
	109	macros freely, and know that they will come into play for the
	110	version of gcc in which they are supported. */
	111
4597ba0f	112	#if (GCC_VERSION < 2007)
893e9593 ILT	113	# define __attribute__(x)
	114	#endif
	115
4597ba0f ILT	116	/* Attribute __malloc__ on functions was valid as of gcc 2.96. */
	117	#ifndef ATTRIBUTE_MALLOC
	118	# if (GCC_VERSION >= 2096)
	119	# define ATTRIBUTE_MALLOC __attribute__ ((__malloc__))
893e9593	120	# else
4597ba0f ILT	121	# define ATTRIBUTE_MALLOC
	122	# endif /* GNUC >= 2.96 */
	123	#endif /* ATTRIBUTE_MALLOC */
	124
671f4ed1 DD	125	/* Attributes on labels were valid as of gcc 2.93 and g++ 4.5. For
671f4ed1 DD	126	g++ an attribute on a label must be followed by a semicolon. */
4597ba0f	127	#ifndef ATTRIBUTE_UNUSED_LABEL
671f4ed1 DD	128	# ifndef __cplusplus
	129	# if GCC_VERSION >= 2093
	130	# define ATTRIBUTE_UNUSED_LABEL ATTRIBUTE_UNUSED
	131	# else
	132	# define ATTRIBUTE_UNUSED_LABEL
	133	# endif
4597ba0f	134	# else
671f4ed1 DD	135	# if GCC_VERSION >= 4005
	136	# define ATTRIBUTE_UNUSED_LABEL ATTRIBUTE_UNUSED ;
	137	# else
	138	# define ATTRIBUTE_UNUSED_LABEL
	139	# endif
	140	# endif
	141	#endif
893e9593	142
ddd27bde DD	143	/* Similarly to ARG_UNUSED below. Prior to GCC 3.4, the C++ frontend
	144	couldn't parse attributes placed after the identifier name, and now
	145	the entire compiler is built with C++. */
893e9593	146	#ifndef ATTRIBUTE_UNUSED
ddd27bde DD	147	#if GCC_VERSION >= 3004
	148	# define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
	149	#else
	150	#define ATTRIBUTE_UNUSED
	151	#endif
893e9593 ILT	152	#endif /* ATTRIBUTE_UNUSED */
893e9593 ILT	153
d5b4094f DD	154	/* Before GCC 3.4, the C++ frontend couldn't parse attributes placed after the
	155	identifier name. */
	156	#if ! defined(__cplusplus) \|\| (GCC_VERSION >= 3004)
	157	# define ARG_UNUSED(NAME) NAME ATTRIBUTE_UNUSED
	158	#else /* !__cplusplus \|\| GNUC >= 3.4 */
	159	# define ARG_UNUSED(NAME) NAME
	160	#endif /* !__cplusplus \|\| GNUC >= 3.4 */
	161
893e9593 ILT	162	#ifndef ATTRIBUTE_NORETURN
	163	#define ATTRIBUTE_NORETURN __attribute__ ((__noreturn__))
	164	#endif /* ATTRIBUTE_NORETURN */
	165
bf8db3d4 DD	166	/* Attribute `nonnull' was valid as of gcc 3.3. */
	167	#ifndef ATTRIBUTE_NONNULL
	168	# if (GCC_VERSION >= 3003)
	169	# define ATTRIBUTE_NONNULL(m) __attribute__ ((__nonnull__ (m)))
	170	# else
	171	# define ATTRIBUTE_NONNULL(m)
	172	# endif /* GNUC >= 3.3 */
	173	#endif /* ATTRIBUTE_NONNULL */
	174
689a1abf	175	/* Attribute `returns_nonnull' was valid as of gcc 4.9. */
	176	#ifndef ATTRIBUTE_RETURNS_NONNULL
	177	# if (GCC_VERSION >= 4009)
	178	# define ATTRIBUTE_RETURNS_NONNULL __attribute__ ((__returns_nonnull__))
	179	# else
	180	# define ATTRIBUTE_RETURNS_NONNULL
	181	# endif /* GNUC >= 4.9 */
	182	#endif /* ATTRIBUTE_RETURNS_NONNULL */
	183
a35b6b04 DD	184	/* Attribute `pure' was valid as of gcc 3.0. */
	185	#ifndef ATTRIBUTE_PURE
	186	# if (GCC_VERSION >= 3000)
	187	# define ATTRIBUTE_PURE __attribute__ ((__pure__))
	188	# else
	189	# define ATTRIBUTE_PURE
	190	# endif /* GNUC >= 3.0 */
	191	#endif /* ATTRIBUTE_PURE */
	192
bf8db3d4 DD	193	/* Use ATTRIBUTE_PRINTF when the format specifier must not be NULL.
	194	This was the case for the `printf' format attribute by itself
	195	before GCC 3.3, but as of 3.3 we need to add the `nonnull'
	196	attribute to retain this behavior. */
893e9593	197	#ifndef ATTRIBUTE_PRINTF
bf8db3d4	198	#define ATTRIBUTE_PRINTF(m, n) __attribute__ ((__format__ (__printf__, m, n))) ATTRIBUTE_NONNULL(m)
893e9593 ILT	199	#define ATTRIBUTE_PRINTF_1 ATTRIBUTE_PRINTF(1, 2)
	200	#define ATTRIBUTE_PRINTF_2 ATTRIBUTE_PRINTF(2, 3)
	201	#define ATTRIBUTE_PRINTF_3 ATTRIBUTE_PRINTF(3, 4)
	202	#define ATTRIBUTE_PRINTF_4 ATTRIBUTE_PRINTF(4, 5)
	203	#define ATTRIBUTE_PRINTF_5 ATTRIBUTE_PRINTF(5, 6)
	204	#endif /* ATTRIBUTE_PRINTF */
	205
e9472921 DD	206	/* Use ATTRIBUTE_FPTR_PRINTF when the format attribute is to be set on
	207	a function pointer. Format attributes were allowed on function
	208	pointers as of gcc 3.1. */
	209	#ifndef ATTRIBUTE_FPTR_PRINTF
	210	# if (GCC_VERSION >= 3001)
	211	# define ATTRIBUTE_FPTR_PRINTF(m, n) ATTRIBUTE_PRINTF(m, n)
	212	# else
	213	# define ATTRIBUTE_FPTR_PRINTF(m, n)
	214	# endif /* GNUC >= 3.1 */
	215	# define ATTRIBUTE_FPTR_PRINTF_1 ATTRIBUTE_FPTR_PRINTF(1, 2)
	216	# define ATTRIBUTE_FPTR_PRINTF_2 ATTRIBUTE_FPTR_PRINTF(2, 3)
	217	# define ATTRIBUTE_FPTR_PRINTF_3 ATTRIBUTE_FPTR_PRINTF(3, 4)
	218	# define ATTRIBUTE_FPTR_PRINTF_4 ATTRIBUTE_FPTR_PRINTF(4, 5)
	219	# define ATTRIBUTE_FPTR_PRINTF_5 ATTRIBUTE_FPTR_PRINTF(5, 6)
	220	#endif /* ATTRIBUTE_FPTR_PRINTF */
	221
bf8db3d4 DD	222	/* Use ATTRIBUTE_NULL_PRINTF when the format specifier may be NULL. A
	223	NULL format specifier was allowed as of gcc 3.3. */
	224	#ifndef ATTRIBUTE_NULL_PRINTF
	225	# if (GCC_VERSION >= 3003)
	226	# define ATTRIBUTE_NULL_PRINTF(m, n) __attribute__ ((__format__ (__printf__, m, n)))
	227	# else
	228	# define ATTRIBUTE_NULL_PRINTF(m, n)
	229	# endif /* GNUC >= 3.3 */
	230	# define ATTRIBUTE_NULL_PRINTF_1 ATTRIBUTE_NULL_PRINTF(1, 2)
	231	# define ATTRIBUTE_NULL_PRINTF_2 ATTRIBUTE_NULL_PRINTF(2, 3)
	232	# define ATTRIBUTE_NULL_PRINTF_3 ATTRIBUTE_NULL_PRINTF(3, 4)
	233	# define ATTRIBUTE_NULL_PRINTF_4 ATTRIBUTE_NULL_PRINTF(4, 5)
	234	# define ATTRIBUTE_NULL_PRINTF_5 ATTRIBUTE_NULL_PRINTF(5, 6)
	235	#endif /* ATTRIBUTE_NULL_PRINTF */
	236
a5ecc6a5 DD	237	/* Attribute `sentinel' was valid as of gcc 3.5. */
	238	#ifndef ATTRIBUTE_SENTINEL
	239	# if (GCC_VERSION >= 3005)
	240	# define ATTRIBUTE_SENTINEL __attribute__ ((__sentinel__))
	241	# else
	242	# define ATTRIBUTE_SENTINEL
	243	# endif /* GNUC >= 3.5 */
	244	#endif /* ATTRIBUTE_SENTINEL */
	245
6ba85b8c DD	246
	247	#ifndef ATTRIBUTE_ALIGNED_ALIGNOF
	248	# if (GCC_VERSION >= 3000)
	249	# define ATTRIBUTE_ALIGNED_ALIGNOF(m) __attribute__ ((__aligned__ (__alignof__ (m))))
	250	# else
	251	# define ATTRIBUTE_ALIGNED_ALIGNOF(m)
	252	# endif /* GNUC >= 3.0 */
	253	#endif /* ATTRIBUTE_ALIGNED_ALIGNOF */
	254
26a67918	255	/* Useful for structures whose layout must match some binary specification
4fd454c8 NC	256	regardless of the alignment and padding qualities of the compiler. */
	257	#ifndef ATTRIBUTE_PACKED
	258	# define ATTRIBUTE_PACKED __attribute__ ((packed))
	259	#endif
	260
e04d7611 DD	261	/* Attribute `hot' and `cold' was valid as of gcc 4.3. */
	262	#ifndef ATTRIBUTE_COLD
	263	# if (GCC_VERSION >= 4003)
	264	# define ATTRIBUTE_COLD __attribute__ ((__cold__))
	265	# else
	266	# define ATTRIBUTE_COLD
	267	# endif /* GNUC >= 4.3 */
	268	#endif /* ATTRIBUTE_COLD */
	269	#ifndef ATTRIBUTE_HOT
	270	# if (GCC_VERSION >= 4003)
	271	# define ATTRIBUTE_HOT __attribute__ ((__hot__))
	272	# else
	273	# define ATTRIBUTE_HOT
	274	# endif /* GNUC >= 4.3 */
	275	#endif /* ATTRIBUTE_HOT */
	276
4d6404f0 L	277	/* Attribute 'no_sanitize_undefined' was valid as of gcc 4.9. */
	278	#ifndef ATTRIBUTE_NO_SANITIZE_UNDEFINED
	279	# if (GCC_VERSION >= 4009)
	280	# define ATTRIBUTE_NO_SANITIZE_UNDEFINED __attribute__ ((no_sanitize_undefined))
	281	# else
	282	# define ATTRIBUTE_NO_SANITIZE_UNDEFINED
	283	# endif /* GNUC >= 4.9 */
	284	#endif /* ATTRIBUTE_NO_SANITIZE_UNDEFINED */
	285
602f1657 AM	286	/* Attribute 'nonstring' was valid as of gcc 8. */
	287	#ifndef ATTRIBUTE_NONSTRING
	288	# if GCC_VERSION >= 8000
	289	# define ATTRIBUTE_NONSTRING __attribute__ ((__nonstring__))
	290	# else
	291	# define ATTRIBUTE_NONSTRING
	292	# endif
	293	#endif
	294
f1d95f4b L	295	/* We use __extension__ in some places to suppress -pedantic warnings
	296	about GCC extensions. This feature didn't work properly before
	297	gcc 2.8. */
	298	#if GCC_VERSION < 2008
	299	#define __extension__
	300	#endif
	301
8466c6d4 DD	302	/* This is used to declare a const variable which should be visible
	303	outside of the current compilation unit. Use it as
	304	EXPORTED_CONST int i = 1;
	305	This is because the semantics of const are different in C and C++.
	306	"extern const" is permitted in C but it looks strange, and gcc
	307	warns about it when -Wc++-compat is not used. */
	308	#ifdef __cplusplus
	309	#define EXPORTED_CONST extern const
	310	#else
	311	#define EXPORTED_CONST const
	312	#endif
	313
006d5c88	314	/* Be conservative and only use enum bitfields with C++ or GCC.
1ae0d051 JK	315	FIXME: provide a complete autoconf test for buggy enum bitfields. */
1ae0d051 JK	316
006d5c88 DD	317	#ifdef __cplusplus
	318	#define ENUM_BITFIELD(TYPE) enum TYPE
	319	#elif (GCC_VERSION > 2000)
1ae0d051 JK	320	#define ENUM_BITFIELD(TYPE) __extension__ enum TYPE
	321	#else
	322	#define ENUM_BITFIELD(TYPE) unsigned int
dd419f3a L	323	#endif
dd419f3a L	324
26a67918 PA	325	#if __cpp_constexpr >= 200704
	326	#define CONSTEXPR constexpr
	327	#else
	328	#define CONSTEXPR
	329	#endif
	330
d118ee37 PA	331	/* C++11 adds the ability to add "override" after an implementation of a
	332	virtual function in a subclass, to:
	333	(A) document that this is an override of a virtual function
	334	(B) allow the compiler to issue a warning if it isn't (e.g. a mismatch
	335	of the type signature).
	336
	337	Similarly, it allows us to add a "final" to indicate that no subclass
	338	may subsequently override the vfunc.
	339
	340	Provide OVERRIDE and FINAL as macros, allowing us to get these benefits
	341	when compiling with C++11 support, but without requiring C++11.
	342
	343	For gcc, use "-std=c++11" to enable C++11 support; gcc 6 onwards enables
	344	this by default (actually GNU++14). */
	345
c48a4d98 NC	346	#if defined __cplusplus
	347	# if __cplusplus >= 201103
	348	/* C++11 claims to be available: use it. Final/override were only
	349	implemented in 4.7, though. */
	350	# if GCC_VERSION < 4007
	351	# define OVERRIDE
	352	# define FINAL
	353	# else
	354	# define OVERRIDE override
	355	# define FINAL final
	356	# endif
	357	# elif GCC_VERSION >= 4007
	358	/* G++ 4.7 supports __final in C++98. */
b4f6af8e	359	# define OVERRIDE
c48a4d98	360	# define FINAL __final
b4f6af8e	361	# else
c48a4d98 NC	362	/* No C++11 support; leave the macros empty. */
	363	# define OVERRIDE
	364	# define FINAL
b4f6af8e	365	# endif
dd419f3a	366	#else
c48a4d98	367	/* No C++11 support; leave the macros empty. */
b4f6af8e PA	368	# define OVERRIDE
b4f6af8e PA	369	# define FINAL
1ae0d051 JK	370	#endif
1ae0d051 JK	371
26a67918 PA	372	/* A macro to disable the copy constructor and assignment operator.
	373	When building with C++11 and above, the methods are explicitly
	374	deleted, causing a compile-time error if something tries to copy.
	375	For C++03, this just declares the methods, causing a link-time
	376	error if the methods end up called (assuming you don't
	377	define them). For C++03, for best results, place the macro
	378	under the private: access specifier, like this,
	379
	380	class name_lookup
	381	{
	382	private:
	383	DISABLE_COPY_AND_ASSIGN (name_lookup);
	384	};
	385
	386	so that most attempts at copy are caught at compile-time. */
	387
	388	#if __cplusplus >= 201103
	389	#define DISABLE_COPY_AND_ASSIGN(TYPE) \
	390	TYPE (const TYPE&) = delete; \
	391	void operator= (const TYPE &) = delete
	392	#else
	393	#define DISABLE_COPY_AND_ASSIGN(TYPE) \
	394	TYPE (const TYPE&); \
	395	void operator= (const TYPE &)
	396	#endif /* __cplusplus >= 201103 */
	397
52d6785f DD	398	#ifdef __cplusplus
	399	}
	400	#endif
	401
252b5132	402	#endif /* ansidecl.h */