glib/gmacros.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  20  * file for a list of people on the GLib Team.  See the ChangeLog
  21  * files for a list of changes.  These files are distributed with
  22  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  23  */
  24
  25 /* This file must not include any other glib header file and must thus
  26  * not refer to variables from glibconfig.h
  27  */
  28
  29 #ifndef __G_MACROS_H__
  30 #define __G_MACROS_H__
  31
  32 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  33 #error "Only <glib.h> can be included directly."
  34 #endif
  35
  36 /* We include stddef.h to get the system's definition of NULL
  37  */
  38 #include <stddef.h>
  39
  40 /* Here we provide G_GNUC_EXTENSION as an alias for __extension__,
  41  * where this is valid. This allows for warningless compilation of
  42  * "long long" types even in the presence of '-ansi -pedantic'.
  43  */
  44 #if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8)
  45 #define G_GNUC_EXTENSION __extension__
  46 #else
  47 #define G_GNUC_EXTENSION
  48 #endif
  49
  50 /* Provide macros to feature the GCC function attribute.
  51  */
  52 #if    __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96)
  53 #define G_GNUC_PURE __attribute__((__pure__))
  54 #define G_GNUC_MALLOC __attribute__((__malloc__))
  55 #else
  56 #define G_GNUC_PURE
  57 #define G_GNUC_MALLOC
  58 #endif
  59
  60 #if     __GNUC__ >= 4
  61 #define G_GNUC_NULL_TERMINATED __attribute__((__sentinel__))
  62 #else
  63 #define G_GNUC_NULL_TERMINATED
  64 #endif
  65
  66 #if     (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
  67 #define G_GNUC_ALLOC_SIZE(x) __attribute__((__alloc_size__(x)))
  68 #define G_GNUC_ALLOC_SIZE2(x,y) __attribute__((__alloc_size__(x,y)))
  69 #else
  70 #define G_GNUC_ALLOC_SIZE(x)
  71 #define G_GNUC_ALLOC_SIZE2(x,y)
  72 #endif
  73
  74 #if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
  75 #define G_GNUC_PRINTF( format_idx, arg_idx )    \
  76   __attribute__((__format__ (__printf__, format_idx, arg_idx)))
  77 #define G_GNUC_SCANF( format_idx, arg_idx )     \
  78   __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
  79 #define G_GNUC_FORMAT( arg_idx )                \
  80   __attribute__((__format_arg__ (arg_idx)))
  81 #define G_GNUC_NORETURN                         \
  82   __attribute__((__noreturn__))
  83 #define G_GNUC_CONST                            \
  84   __attribute__((__const__))
  85 #define G_GNUC_UNUSED                           \
  86   __attribute__((__unused__))
  87 #define G_GNUC_NO_INSTRUMENT                    \
  88   __attribute__((__no_instrument_function__))
  89 #else   /* !__GNUC__ */
  90 #define G_GNUC_PRINTF( format_idx, arg_idx )
  91 #define G_GNUC_SCANF( format_idx, arg_idx )
  92 #define G_GNUC_FORMAT( arg_idx )
  93 #define G_GNUC_NORETURN
  94 #define G_GNUC_CONST
  95 #define G_GNUC_UNUSED
  96 #define G_GNUC_NO_INSTRUMENT
  97 #endif  /* !__GNUC__ */
  98
  99 #if    __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1)
 100 #define G_GNUC_DEPRECATED __attribute__((__deprecated__))
 101 #else
 102 #define G_GNUC_DEPRECATED
 103 #endif /* __GNUC__ */
 104
 105 #if    __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
 106 #define G_GNUC_DEPRECATED_FOR(f)                        \
 107   __attribute__((deprecated("Use " #f " instead")))
 108 #else
 109 #define G_GNUC_DEPRECATED_FOR(f)        G_GNUC_DEPRECATED
 110 #endif /* __GNUC__ */
 111
 112 #if    __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)
 113 #define G_GNUC_BEGIN_IGNORE_DEPRECATIONS                \
 114   _Pragma ("GCC diagnostic push")                       \
 115   _Pragma ("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
 116 #define G_GNUC_END_IGNORE_DEPRECATIONS                  \
 117   _Pragma ("GCC diagnostic pop")
 118 #elif defined (_MSC_VER) && (_MSC_VER >= 1500)
 119 #define G_GNUC_BEGIN_IGNORE_DEPRECATIONS                \
 120   __pragma (warning (push))  \
 121   __pragma (warning (disable : 4996))
 122 #define G_GNUC_END_IGNORE_DEPRECATIONS                  \
 123   __pragma (warning (pop))
 124 #else
 125 #define G_GNUC_BEGIN_IGNORE_DEPRECATIONS
 126 #define G_GNUC_END_IGNORE_DEPRECATIONS
 127 #endif
 128
 129 #if     __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 3)
 130 #define G_GNUC_MAY_ALIAS __attribute__((may_alias))
 131 #else
 132 #define G_GNUC_MAY_ALIAS
 133 #endif
 134
 135 #if    __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
 136 #define G_GNUC_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
 137 #else
 138 #define G_GNUC_WARN_UNUSED_RESULT
 139 #endif /* __GNUC__ */
 140
 141 #ifndef G_DISABLE_DEPRECATED
 142 /* Wrap the gcc __PRETTY_FUNCTION__ and __FUNCTION__ variables with
 143  * macros, so we can refer to them as strings unconditionally.
 144  * usage not-recommended since gcc-3.0
 145  */
 146 #if defined (__GNUC__) && (__GNUC__ < 3)
 147 #define G_GNUC_FUNCTION         __FUNCTION__
 148 #define G_GNUC_PRETTY_FUNCTION  __PRETTY_FUNCTION__
 149 #else   /* !__GNUC__ */
 150 #define G_GNUC_FUNCTION         ""
 151 #define G_GNUC_PRETTY_FUNCTION  ""
 152 #endif  /* !__GNUC__ */
 153 #endif  /* !G_DISABLE_DEPRECATED */
 154
 155 /* Clang feature detection: http://clang.llvm.org/docs/LanguageExtensions.html */
 156 #ifndef __has_feature
 157 #define __has_feature(x) 0
 158 #endif
 159
 160 #if __has_feature(attribute_analyzer_noreturn)
 161 #define G_ANALYZER_ANALYZING 1
 162 #define G_ANALYZER_NORETURN __attribute__((analyzer_noreturn))
 163 #else
 164 #define G_ANALYZER_ANALYZING 0
 165 #define G_ANALYZER_NORETURN
 166 #endif
 167
 168 #define G_STRINGIFY(macro_or_string)    G_STRINGIFY_ARG (macro_or_string)
 169 #define G_STRINGIFY_ARG(contents)       #contents
 170
 171 #ifndef __GI_SCANNER__ /* The static assert macro really confuses the introspection parser */
 172 #define G_PASTE_ARGS(identifier1,identifier2) identifier1 ## identifier2
 173 #define G_PASTE(identifier1,identifier2)      G_PASTE_ARGS (identifier1, identifier2)
 174 #ifdef __COUNTER__
 175 #define G_STATIC_ASSERT(expr) typedef char G_PASTE (_GStaticAssertCompileTimeAssertion_, __COUNTER__)[(expr) ? 1 : -1] G_GNUC_UNUSED
 176 #else
 177 #define G_STATIC_ASSERT(expr) typedef char G_PASTE (_GStaticAssertCompileTimeAssertion_, __LINE__)[(expr) ? 1 : -1] G_GNUC_UNUSED
 178 #endif
 179 #define G_STATIC_ASSERT_EXPR(expr) ((void) sizeof (char[(expr) ? 1 : -1]))
 180 #endif
 181
 182 /* Provide a string identifying the current code position */
 183 #if defined(__GNUC__) && (__GNUC__ < 3) && !defined(__cplusplus)
 184 #define G_STRLOC        __FILE__ ":" G_STRINGIFY (__LINE__) ":" __PRETTY_FUNCTION__ "()"
 185 #else
 186 #define G_STRLOC        __FILE__ ":" G_STRINGIFY (__LINE__)
 187 #endif
 188
 189 /* Provide a string identifying the current function, non-concatenatable */
 190 #if defined (__GNUC__) && defined (__cplusplus)
 191 #define G_STRFUNC     ((const char*) (__PRETTY_FUNCTION__))
 192 #elif defined (__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
 193 #define G_STRFUNC     ((const char*) (__func__))
 194 #elif defined (__GNUC__) || (defined(_MSC_VER) && (_MSC_VER > 1300))
 195 #define G_STRFUNC     ((const char*) (__FUNCTION__))
 196 #else
 197 #define G_STRFUNC     ((const char*) ("???"))
 198 #endif
 199
 200 /* Guard C code in headers, while including them from C++ */
 201 #ifdef  __cplusplus
 202 #define G_BEGIN_DECLS  extern "C" {
 203 #define G_END_DECLS    }
 204 #else
 205 #define G_BEGIN_DECLS
 206 #define G_END_DECLS
 207 #endif
 208
 209 /* Provide definitions for some commonly used macros.
 210  *  Some of them are only provided if they haven't already
 211  *  been defined. It is assumed that if they are already
 212  *  defined then the current definition is correct.
 213  */
 214 #ifndef NULL
 215 #  ifdef __cplusplus
 216 #  define NULL        (0L)
 217 #  else /* !__cplusplus */
 218 #  define NULL        ((void*) 0)
 219 #  endif /* !__cplusplus */
 220 #endif
 221
 222 #ifndef FALSE
 223 #define FALSE   (0)
 224 #endif
 225
 226 #ifndef TRUE
 227 #define TRUE    (!FALSE)
 228 #endif
 229
 230 #undef  MAX
 231 #define MAX(a, b)  (((a) > (b)) ? (a) : (b))
 232
 233 #undef  MIN
 234 #define MIN(a, b)  (((a) < (b)) ? (a) : (b))
 235
 236 #undef  ABS
 237 #define ABS(a)     (((a) < 0) ? -(a) : (a))
 238
 239 #undef  CLAMP
 240 #define CLAMP(x, low, high)  (((x) > (high)) ? (high) : (((x) < (low)) ? (low) : (x)))
 241
 242 /* Count the number of elements in an array. The array must be defined
 243  * as such; using this with a dynamically allocated array will give
 244  * incorrect results.
 245  */
 246 #define G_N_ELEMENTS(arr)               (sizeof (arr) / sizeof ((arr)[0]))
 247
 248 /* Macros by analogy to GINT_TO_POINTER, GPOINTER_TO_INT
 249  */
 250 #define GPOINTER_TO_SIZE(p)     ((gsize) (p))
 251 #define GSIZE_TO_POINTER(s)     ((gpointer) (gsize) (s))
 252
 253 /* Provide convenience macros for handling structure
 254  * fields through their offsets.
 255  */
 256
 257 #if defined(__GNUC__)  && __GNUC__ >= 4
 258 #define G_STRUCT_OFFSET(struct_type, member) \
 259       ((glong) offsetof (struct_type, member))
 260 #else
 261 #define G_STRUCT_OFFSET(struct_type, member)    \
 262       ((glong) ((guint8*) &((struct_type*) 0)->member))
 263 #endif
 264
 265 #define G_STRUCT_MEMBER_P(struct_p, struct_offset)   \
 266     ((gpointer) ((guint8*) (struct_p) + (glong) (struct_offset)))
 267 #define G_STRUCT_MEMBER(member_type, struct_p, struct_offset)   \
 268     (*(member_type*) G_STRUCT_MEMBER_P ((struct_p), (struct_offset)))
 269
 270 /* Provide simple macro statement wrappers:
 271  *   G_STMT_START { statements; } G_STMT_END;
 272  * This can be used as a single statement, like:
 273  *   if (x) G_STMT_START { ... } G_STMT_END; else ...
 274  * This intentionally does not use compiler extensions like GCC's '({...})' to
 275  * avoid portability issue or side effects when compiled with different compilers.
 276  */
 277 #if !(defined (G_STMT_START) && defined (G_STMT_END))
 278 #define G_STMT_START  do
 279 #define G_STMT_END    while (0)
 280 #endif
 281
 282 /* Deprecated -- do not use. */
 283 #ifndef G_DISABLE_DEPRECATED
 284 #ifdef G_DISABLE_CONST_RETURNS
 285 #define G_CONST_RETURN
 286 #else
 287 #define G_CONST_RETURN const
 288 #endif
 289 #endif
 290
 291 /*
 292  * The G_LIKELY and G_UNLIKELY macros let the programmer give hints to
 293  * the compiler about the expected result of an expression. Some compilers
 294  * can use this information for optimizations.
 295  *
 296  * The _G_BOOLEAN_EXPR macro is intended to trigger a gcc warning when
 297  * putting assignments in g_return_if_fail ().
 298  */
 299 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
 300 #define _G_BOOLEAN_EXPR(expr)                   \
 301  G_GNUC_EXTENSION ({                            \
 302    int _g_boolean_var_;                         \
 303    if (expr)                                    \
 304       _g_boolean_var_ = 1;                      \
 305    else                                         \
 306       _g_boolean_var_ = 0;                      \
 307    _g_boolean_var_;                             \
 308 })
 309 #define G_LIKELY(expr) (__builtin_expect (_G_BOOLEAN_EXPR(expr), 1))
 310 #define G_UNLIKELY(expr) (__builtin_expect (_G_BOOLEAN_EXPR(expr), 0))
 311 #else
 312 #define G_LIKELY(expr) (expr)
 313 #define G_UNLIKELY(expr) (expr)
 314 #endif
 315
 316 #if    __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1)
 317 #define G_DEPRECATED __attribute__((__deprecated__))
 318 #elif defined(_MSC_VER) && (_MSC_VER >= 1300)
 319 #define G_DEPRECATED __declspec(deprecated)
 320 #else
 321 #define G_DEPRECATED
 322 #endif
 323
 324 #if    __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
 325 #define G_DEPRECATED_FOR(f) __attribute__((__deprecated__("Use '" #f "' instead")))
 326 #elif defined(_MSC_FULL_VER) && (_MSC_FULL_VER > 140050320)
 327 #define G_DEPRECATED_FOR(f) __declspec(deprecated("is deprecated. Use '" #f "' instead"))
 328 #else
 329 #define G_DEPRECATED_FOR(f) G_DEPRECATED
 330 #endif
 331
 332 #if    __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
 333 #define G_UNAVAILABLE(maj,min) __attribute__((deprecated("Not available before " #maj "." #min)))
 334 #elif defined(_MSC_FULL_VER) && (_MSC_FULL_VER > 140050320)
 335 #define G_UNAVAILABLE(maj,min) __declspec(deprecated("is not available before " #maj "." #min))
 336 #else
 337 #define G_UNAVAILABLE(maj,min) G_DEPRECATED
 338 #endif
 339
 340 #ifndef _GLIB_EXTERN
 341 #define _GLIB_EXTERN extern
 342 #endif
 343
 344 /* These macros are used to mark deprecated functions in GLib headers,
 345  * and thus have to be exposed in installed headers. But please
 346  * do *not* use them in other projects. Instead, use G_DEPRECATED
 347  * or define your own wrappers around it.
 348  */
 349
 350 #ifdef GLIB_DISABLE_DEPRECATION_WARNINGS
 351 #define GLIB_DEPRECATED _GLIB_EXTERN
 352 #define GLIB_DEPRECATED_FOR(f) _GLIB_EXTERN
 353 #define GLIB_UNAVAILABLE(maj,min) _GLIB_EXTERN
 354 #else
 355 #define GLIB_DEPRECATED G_DEPRECATED _GLIB_EXTERN
 356 #define GLIB_DEPRECATED_FOR(f) G_DEPRECATED_FOR(f) _GLIB_EXTERN
 357 #define GLIB_UNAVAILABLE(maj,min) G_UNAVAILABLE(maj,min) _GLIB_EXTERN
 358 #endif
 359
 360 #endif /* __G_MACROS_H__ */