gcc-attrs.h File Reference

---

Detailed Description

For internal use only.

This header file defines a number of macros to attach useful GCC attributes to various function and variable declarations.

Definition in file gcc-attrs.h.

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	_GCA_PREREQ(maj, min)
	Compact GCC version into a single number.
#define	_gca_noreturn
	Function does not return.
#define	_gca_const
	Function has no side effects.
#define	_gca_unused
	Function or variable may be unused.
#define	_gca_pure
	Function has no side-effects.
#define	_gca_nonnull(args)
	Function argument(s) may not be NULL.
#define	_gca_deprecated
	Function is deprecated.
#define	_gca_useresult
	Function return value must be examined.

---

Define Documentation

#define _gca_const

For internal use only. This macro is used to mark that a given function has no side-effects and does not examine any global variables; it may be used to hint that the function call may be optimized away. See the GCC documentation for the const function attribute for more information. Definition at line 77 of file gcc-attrs.h.

#define _gca_deprecated

For internal use only. This attribute marks that the function has been deprecated. GCC will emit a warning if the function is used by the user. For more information, see the GCC documentation for the deprecated function attribute. Definition at line 158 of file gcc-attrs.h.

#define _gca_nonnull (  args   )

For internal use only. This function attribute is used to indicate that certain function arguments may not be NULL. If a NULL value is passed, GCC will emit a warning. For more information, see the GCC documentation for the nonnull function attribute. Parameters: [in]  args  A parenthesized, comma-separated list of non-NULL function arguments; the first argument is 1, the second is 2, etc. If function arguments 2 and 5 should not be NULL, use e.g., _gca_nonnull((2, 5)). Definition at line 157 of file gcc-attrs.h.

#define _gca_noreturn

For internal use only. This macro is used to mark that a given function will not return to its caller. See the GCC documentation for the noreturn function attribute for more information. Definition at line 76 of file gcc-attrs.h.

#define _GCA_PREREQ (  maj, min   )

For internal use only. This macro is used to determine whether this version of GCC happens to implement a given feature. Parameters: [in]  maj  The major number of the first version of GCC known to implement a given feature. [in]  min  The minor number of the first version of GCC known to implement a given feature. Definition at line 49 of file gcc-attrs.h.

#define _gca_pure

For internal use only. This attribute is like _gca_const, except that a function marked with _gca_pure may examine global variables. For more information, see the GCC documentation for the pure function attribute. Definition at line 109 of file gcc-attrs.h.

#define _gca_unused

For internal use only. GCC warns if a static function or variable appears to be unused. This attribute drops that warning. Its primary use in this package is to force the RCS Id tag to be embedded in the binary. See the GCC documentation for the unused attribute for more information. Definition at line 94 of file gcc-attrs.h.

#define _gca_useresult

For internal use only. This attribute is used to indicate that the function return value must be examined, e.g., for an error indication. For more information, see the GCC documentation for the warn_unused_result function attribute. Definition at line 159 of file gcc-attrs.h.

---