X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Fcompiler%2Fcompiler.h;h=caa89edc5968a6b5cbcb800876d6ae66672e2720;hp=42245646c42ff772bcc6376ffc54ac79a1c1aca1;hb=97026cedabce510b2e2e547120f04fe0f6a5ecab;hpb=48c1824304ac2d8aeaef7b8a55c7d9edc8992f63 diff --git a/ccan/compiler/compiler.h b/ccan/compiler/compiler.h index 42245646..caa89edc 100644 --- a/ccan/compiler/compiler.h +++ b/ccan/compiler/compiler.h @@ -17,7 +17,7 @@ * fprintf(stderr, "Error: %s (%s)\n", reason, strerror(errno)); * } */ -#define COLD __attribute__((cold)) +#define COLD __attribute__((__cold__)) #else #define COLD #endif @@ -37,7 +37,7 @@ * exit(1); * } */ -#define NORETURN __attribute__((noreturn)) +#define NORETURN __attribute__((__noreturn__)) #else #define NORETURN #endif @@ -71,7 +71,7 @@ * same value for the exact same arguments. This implies that the function * must not use global variables, or dereference pointer arguments. */ -#define CONST_FUNCTION __attribute__((const)) +#define CONST_FUNCTION __attribute__((__const__)) #else #define CONST_FUNCTION #endif @@ -109,7 +109,7 @@ * counter += add; * } */ -#define UNNEEDED __attribute__((unused)) +#define UNNEEDED __attribute__((__unused__)) #endif #ifndef NEEDED @@ -128,10 +128,10 @@ * printf("Counter is %i\n", counter); * } */ -#define NEEDED __attribute__((used)) +#define NEEDED __attribute__((__used__)) #else /* Before used, unused functions and vars were always emitted. */ -#define NEEDED __attribute__((unused)) +#define NEEDED __attribute__((__unused__)) #endif #endif @@ -150,7 +150,7 @@ * return 0; * } */ -#define UNUSED __attribute__((unused)) +#define UNUSED __attribute__((__unused__)) #endif #else #ifndef UNNEEDED @@ -223,9 +223,67 @@ * return realloc(buf, (*size) *= 2); * } */ -#define WARN_UNUSED_RESULT __attribute__((warn_unused_result)) +#define WARN_UNUSED_RESULT __attribute__((__warn_unused_result__)) #else #define WARN_UNUSED_RESULT #endif #endif + + +#if HAVE_ATTRIBUTE_DEPRECATED +/** + * WARN_DEPRECATED - warn that a function/type/variable is deprecated when used. + * + * Used to mark a function, type or variable should not be used. + * + * Example: + * WARN_DEPRECATED char *oldfunc(char *buf); + */ +#define WARN_DEPRECATED __attribute__((__deprecated__)) +#else +#define WARN_DEPRECATED +#endif + + +#if HAVE_ATTRIBUTE_NONNULL +/** + * NO_NULL_ARGS - specify that no arguments to this function can be NULL. + * + * The compiler will warn if any pointer args are NULL. + * + * Example: + * NO_NULL_ARGS char *my_copy(char *buf); + */ +#define NO_NULL_ARGS __attribute__((__nonnull__)) + +/** + * NON_NULL_ARGS - specify that some arguments to this function can't be NULL. + * @...: 1-based argument numbers for which args can't be NULL. + * + * The compiler will warn if any of the specified pointer args are NULL. + * + * Example: + * char *my_copy2(char *buf, char *maybenull) NON_NULL_ARGS(1, 2); + */ +#define NON_NULL_ARGS(index, ...) __attribute__((__nonnull__(index, __VA_ARGS__))) +#else +#define NO_NULL_ARGS +#define NON_NULL_ARGS(index, ...) +#endif + + +#if HAVE_ATTRIBUTE_SENTINEL +/** + * LAST_ARG_NULL - specify the last argument of a variadic function must be NULL. + * + * The compiler will warn if the last argument isn't NULL. + * + * Example: + * char *join_string(char *buf, ...) LAST_ARG_NULL; + */ +#define LAST_ARG_NULL __attribute__((__sentinel__)) +#else +#define LAST_ARG_NULL +#endif + #endif /* CCAN_COMPILER_H */