utils/macros.h: Add `MUST_CHECK', so return codes aren't ignored.

[mLib] / utils / macros.h

diff --git a/utils/macros.h b/utils/macros.h
index 35ececf..70f535f 100644 (file)
--- a/utils/macros.h
+++ b/utils/macros.h
@@ -32,9 +32,17 @@
   extern "C" {
 #endif
 
+/*----- Header files ------------------------------------------------------*/
+
+#include <assert.h>
+
+#ifndef MLIB_COMPILER_H
+#  include "compiler.h"
+#endif
+
 /*----- Miscellaneous utility macros --------------------------------------*/
 
-#define N(v) (sizeof(v)/sizeof(*v))
+#define N(v) (sizeof(v)/sizeof(*(v)))
 
 #define MLIB__STR(x) #x
 #define STR(x) MLIB__STR(x)
@@ -42,35 +50,82 @@
 #define MLIB__GLUE(x, y) x##y
 #define GLUE(x, y) MLIB__GLUE(x, y)
 
+#ifdef static_assert
+#  define STATIC_ASSERT(cond, msg) static_assert(!!(cond), msg)
+#else
+#  define STATIC_ASSERT(cond, msg)                                     \
+       IGNORABLE extern char static_assert_failed[2*!!(cond) - 1]
+#endif
+
+/*----- String and character hacks ----------------------------------------*/
+
+#define CTYPE_HACK(func, ch) (func((unsigned char)(ch)))
+
+#define ISALNUM(ch) CTYPE_HACK(isalnum, ch)
+#define ISALPHA(ch) CTYPE_HACK(isalpha, ch)
+#define ISASCII(ch) CTYPE_HACK(isascii, ch)
+#define ISBLANK(ch) CTYPE_HACK(isblank, ch)
+#define ISCNTRL(ch) CTYPE_HACK(iscntrl, ch)
+#define ISDIGIT(ch) CTYPE_HACK(isdigit, ch)
+#define ISGRAPH(ch) CTYPE_HACK(isgraph, ch)
+#define ISLOWER(ch) CTYPE_HACK(islower, ch)
+#define ISPRINT(ch) CTYPE_HACK(isprint, ch)
+#define ISPUNCT(ch) CTYPE_HACK(ispunct, ch)
+#define ISSPACE(ch) CTYPE_HACK(isspace, ch)
+#define ISUPPER(ch) CTYPE_HACK(isupper, ch)
+#define ISXDIGIT(ch) CTYPE_HACK(isxdigit, ch)
+
+#define TOASCII(ch) CTYPE_HACK(toascii, ch)
+#define TOLOWER(ch) CTYPE_HACK(tolower, ch)
+#define TOUPPER(ch) CTYPE_HACK(toupper, ch)
+
+#define MEMCMP(x, op, y, n) (memcmp((x), (y), (n)) op 0)
+#define STRCMP(x, op, y) (strcmp((x), (y)) op 0)
+#define STRNCMP(x, op, y, n) (strncmp((x), (y), (n)) op 0)
+
 /*----- Compiler diagnostics ----------------------------------------------*/
 
 /* --- Compiler-specific definitions --- */
 
-#if defined(__GNUC__)
-#  define GCC_VERSION_P(maj, min)                                      \
-       (__GNUC__ > (maj) || (__GNUC__ == (maj) && __GNUC_MINOR__ >= (min)))
-#else
-#  define GCC_VERSION_P(maj, min) 0
+#if GCC_VERSION_P(2, 5) || CLANG_VERSION_P(3, 3)
+#  define NORETURN __attribute__((__noreturn__))
+#  define PRINTF_LIKE(fix, aix) __attribute__((__format__(printf, fix, aix)))
+#  define SCANF_LIKE(fix, aix) __attribute__((__format__(scanf, fix, aix)))
+#  define IGNORABLE __attribute__((__unused__))
 #endif
 
-#if GCC_VERSION_P(2, 5)
-#  define NORETURN __attribute__((noreturn))
-#  define PRINTF_LIKE(fix, aix) __attribute__((format(printf, fix, aix)))
-#  define SCANF_LIKE(fix, aix) __attribute__((format(scanf, fix, aix)))
-#  define IGNORABLE __attribute__((unused))
+#if GCC_VERSION_P(3, 4) || CLANG_VERSION_P(3, 3)
+#  define MUST_CHECK __attribute__((__warn_unused_result__))
 #endif
 
-#if GCC_VERSION_P(4, 5)
-#  define DEPRECATED(msg) __attribute__((deprecated(msg)))
+#if GCC_VERSION_P(4, 5) || CLANG_VERSION_P(3, 3)
+#  define DEPRECATED(msg) __attribute__((__deprecated__(msg)))
 #elif GCC_VERSION_P(3, 1)
-#  define DEPRECATED(msg) __attribute__((deprecated))
+#  define DEPRECATED(msg) __attribute__((__deprecated__))
 #endif
 
-#if GCC_VERSION_P(4, 0)
-#  define EXECL_LIKE(ntrail) __attribute__((sentinel(ntrail)))
+#if GCC_VERSION_P(4, 0) || CLANG_VERSION_P(3, 3)
+#  define EXECL_LIKE(ntrail) __attribute__((__sentinel__(ntrail)))
 #endif
 
-#if GCC_VERSION_P(4, 6)
+#if CLANG_VERSION_P(3, 3)
+
+#  define MLIB__PRAGMA_HACK(x) _Pragma(#x)
+#  define MLIB__MUFFLE_WARNINGS(warns, body)                           \
+       _Pragma("clang diagnostic push")                                \
+       warns                                                           \
+       body                                                            \
+       _Pragma("clang diagnostic pop")
+#  define CLANG_WARNING(warn)                                          \
+       MLIB__PRAGMA_HACK(clang diagnostic ignored warn)
+#  define MUFFLE_WARNINGS_DECL(warns, body)                            \
+       MLIB__MUFFLE_WARNINGS(warns, body)
+#  define MUFFLE_WARNINGS_EXPR(warns, body)                            \
+       __extension__ ({ MLIB__MUFFLE_WARNINGS(warns, (body);) })
+#  define MUFFLE_WARNINGS_STMT(warns, body)                            \
+       do { MLIB__MUFFLE_WARNINGS(warns, body) } while (0)
+
+#elif GCC_VERSION_P(4, 6)
 
    /* --- Diagnostic suppression in GCC: a tale of woe --- *
     *
@@ -164,14 +219,26 @@
 #  define SCANF_LIKE(fmtix, argix)
 #endif
 
+#ifndef NORETURN
+#  define NORETURN
+#endif
+
 #ifndef IGNORABLE
 #  define IGNORABLE
 #endif
 
+#ifndef MUST_CHECK
+#  define MUST_CHECK
+#endif
+
 #ifndef GCC_WARNING
 #  define GCC_WARNING(warn)
 #endif
 
+#ifndef CLANG_WARNING
+#  define CLANG_WARNING(warn)
+#endif
+
 /*----- That's all, folks -------------------------------------------------*/
 
 #ifdef __cplusplus