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, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GLib Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 /* This file must not include any other glib header file and must thus
  28  * not refer to variables from glibconfig.h
  29  */
  30
  31 #ifndef __G_MACROS_H__
  32 #define __G_MACROS_H__
  33
  34 /* We include stddef.h to get the system's definition of NULL
  35  */
  36 #include <stddef.h>
  37
  38 /* Here we provide G_GNUC_EXTENSION as an alias for __extension__,
  39  * where this is valid. This allows for warningless compilation of
  40  * "long long" types even in the presence of '-ansi -pedantic'.
  41  */
  42 #if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8)
  43 #  define G_GNUC_EXTENSION __extension__
  44 #else
  45 #  define G_GNUC_EXTENSION
  46 #endif
  47
  48 /* Provide macros to feature the GCC function attribute.
  49  */
  50 #if    __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96)
  51 #define G_GNUC_PURE                            \
  52   __attribute__((__pure__))
  53 #define G_GNUC_MALLOC                           \
  54   __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__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
  67 #define G_GNUC_PRINTF( format_idx, arg_idx )    \
  68   __attribute__((__format__ (__printf__, format_idx, arg_idx)))
  69 #define G_GNUC_SCANF( format_idx, arg_idx )     \
  70   __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
  71 #define G_GNUC_FORMAT( arg_idx )                \
  72   __attribute__((__format_arg__ (arg_idx)))
  73 #define G_GNUC_NORETURN                         \
  74   __attribute__((__noreturn__))
  75 #define G_GNUC_CONST                            \
  76   __attribute__((__const__))
  77 #define G_GNUC_UNUSED                           \
  78   __attribute__((__unused__))
  79 #define G_GNUC_NO_INSTRUMENT                    \
  80   __attribute__((__no_instrument_function__))
  81 #else   /* !__GNUC__ */
  82 #define G_GNUC_PRINTF( format_idx, arg_idx )
  83 #define G_GNUC_SCANF( format_idx, arg_idx )
  84 #define G_GNUC_FORMAT( arg_idx )
  85 #define G_GNUC_NORETURN
  86 #define G_GNUC_CONST
  87 #define G_GNUC_UNUSED
  88 #define G_GNUC_NO_INSTRUMENT
  89 #endif  /* !__GNUC__ */
  90
  91 #if    __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1)
  92 #define G_GNUC_DEPRECATED                            \
  93   __attribute__((__deprecated__))
  94 #else
  95 #define G_GNUC_DEPRECATED
  96 #endif /* __GNUC__ */
  97
  98 #if     __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 3)
  99 #  define G_GNUC_MAY_ALIAS __attribute__((may_alias))
 100 #else
 101 #  define G_GNUC_MAY_ALIAS
 102 #endif
 103
 104 #if    __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
 105 #define G_GNUC_WARN_UNUSED_RESULT               \
 106   __attribute__((warn_unused_result))
 107 #else
 108 #define G_GNUC_WARN_UNUSED_RESULT
 109 #endif /* __GNUC__ */
 110
 111 /* Wrap the gcc __PRETTY_FUNCTION__ and __FUNCTION__ variables with
 112  * macros, so we can refer to them as strings unconditionally.
 113  * usage not-recommended since gcc-3.0
 114  */
 115 #if defined (__GNUC__) && (__GNUC__ < 3)
 116 #define G_GNUC_FUNCTION         __FUNCTION__
 117 #define G_GNUC_PRETTY_FUNCTION  __PRETTY_FUNCTION__
 118 #else   /* !__GNUC__ */
 119 #define G_GNUC_FUNCTION         ""
 120 #define G_GNUC_PRETTY_FUNCTION  ""
 121 #endif  /* !__GNUC__ */
 122
 123 #define G_STRINGIFY(macro_or_string)    G_STRINGIFY_ARG (macro_or_string)
 124 #define G_STRINGIFY_ARG(contents)       #contents
 125
 126 /* Provide a string identifying the current code position */
 127 #if defined(__GNUC__) && (__GNUC__ < 3) && !defined(__cplusplus)
 128 #  define G_STRLOC      __FILE__ ":" G_STRINGIFY (__LINE__) ":" __PRETTY_FUNCTION__ "()"
 129 #else
 130 #  define G_STRLOC      __FILE__ ":" G_STRINGIFY (__LINE__)
 131 #endif
 132
 133 /* Provide a string identifying the current function, non-concatenatable */
 134 #if defined (__GNUC__)
 135 #  define G_STRFUNC     ((const char*) (__PRETTY_FUNCTION__))
 136 #elif defined (G_HAVE_ISO_VARARGS)
 137 #  define G_STRFUNC     ((const char*) (__func__))
 138 #else
 139 #  define G_STRFUNC     ((const char*) ("???"))
 140 #endif
 141
 142 /* Guard C code in headers, while including them from C++ */
 143 #ifdef  __cplusplus
 144 # define G_BEGIN_DECLS  extern "C" {
 145 # define G_END_DECLS    }
 146 #else
 147 # define G_BEGIN_DECLS
 148 # define G_END_DECLS
 149 #endif
 150
 151 /* Provide definitions for some commonly used macros.
 152  *  Some of them are only provided if they haven't already
 153  *  been defined. It is assumed that if they are already
 154  *  defined then the current definition is correct.
 155  */
 156 #ifndef NULL
 157 #  ifdef __cplusplus
 158 #    define NULL        (0L)
 159 #  else /* !__cplusplus */
 160 #    define NULL        ((void*) 0)
 161 #  endif /* !__cplusplus */
 162 #endif
 163
 164 #ifndef FALSE
 165 #define FALSE   (0)
 166 #endif
 167
 168 #ifndef TRUE
 169 #define TRUE    (!FALSE)
 170 #endif
 171
 172 #undef  MAX
 173 #define MAX(a, b)  (((a) > (b)) ? (a) : (b))
 174
 175 #undef  MIN
 176 #define MIN(a, b)  (((a) < (b)) ? (a) : (b))
 177
 178 #undef  ABS
 179 #define ABS(a)     (((a) < 0) ? -(a) : (a))
 180
 181 #undef  CLAMP
 182 #define CLAMP(x, low, high)  (((x) > (high)) ? (high) : (((x) < (low)) ? (low) : (x)))
 183
 184 /* Count the number of elements in an array. The array must be defined
 185  * as such; using this with a dynamically allocated array will give
 186  * incorrect results.
 187  */
 188 #define G_N_ELEMENTS(arr)               (sizeof (arr) / sizeof ((arr)[0]))
 189
 190 /* Macros by analogy to GINT_TO_POINTER, GPOINTER_TO_INT
 191  */
 192 #define GPOINTER_TO_SIZE(p)     ((gsize) (p))
 193 #define GSIZE_TO_POINTER(s)     ((gpointer) (gsize) (s))
 194
 195 /* Provide convenience macros for handling structure
 196  * fields through their offsets.
 197  */
 198 #define G_STRUCT_OFFSET(struct_type, member)    \
 199     ((glong) ((guint8*) &((struct_type*) 0)->member))
 200 #define G_STRUCT_MEMBER_P(struct_p, struct_offset)   \
 201     ((gpointer) ((guint8*) (struct_p) + (glong) (struct_offset)))
 202 #define G_STRUCT_MEMBER(member_type, struct_p, struct_offset)   \
 203     (*(member_type*) G_STRUCT_MEMBER_P ((struct_p), (struct_offset)))
 204
 205 /* Provide simple macro statement wrappers (adapted from Perl):
 206  *  G_STMT_START { statements; } G_STMT_END;
 207  *  can be used as a single statement, as in
 208  *  if (x) G_STMT_START { ... } G_STMT_END; else ...
 209  *
 210  *  When GCC is compiling C code in non-ANSI mode, it will use the
 211  *  compiler __extension__ to wrap the statements wihin `({' and '})' braces.
 212  *  When compiling on platforms where configure has defined
 213  *  HAVE_DOWHILE_MACROS, statements will be wrapped with `do' and `while (0)'.
 214  *  For any other platforms (SunOS4 is known to have this issue), wrap the
 215  *  statements with `if (1)' and `else (void) 0'.
 216  */
 217 #if !(defined (G_STMT_START) && defined (G_STMT_END))
 218 # if defined (__GNUC__) && !defined (__STRICT_ANSI__) && !defined (__cplusplus)
 219 #  define G_STMT_START (void) __extension__ (
 220 #  define G_STMT_END )
 221 # else /* !(__GNUC__ && !__STRICT_ANSI__ && !__cplusplus) */
 222 #  if defined (HAVE_DOWHILE_MACROS)
 223 #   define G_STMT_START do
 224 #   define G_STMT_END while (0)
 225 #  else /* !HAVE_DOWHILE_MACROS */
 226 #   define G_STMT_START if (1)
 227 #   define G_STMT_END else (void) 0
 228 #  endif /* !HAVE_DOWHILE_MACROS */
 229 # endif /* !(__GNUC__ && !__STRICT_ANSI__ && !__cplusplus) */
 230 #endif
 231
 232 /* Allow the app programmer to select whether or not return values
 233  * (usually char*) are const or not.  Don't try using this feature for
 234  * functions with C++ linkage.
 235  */
 236 #ifdef G_DISABLE_CONST_RETURNS
 237 #define G_CONST_RETURN
 238 #else
 239 #define G_CONST_RETURN const
 240 #endif
 241
 242 /*
 243  * The G_LIKELY and G_UNLIKELY macros let the programmer give hints to
 244  * the compiler about the expected result of an expression. Some compilers
 245  * can use this information for optimizations.
 246  *
 247  * The _G_BOOLEAN_EXPR macro is intended to trigger a gcc warning when
 248  * putting assignments in g_return_if_fail ().
 249  */
 250 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
 251 #define _G_BOOLEAN_EXPR(expr)                   \
 252  __extension__ ({                               \
 253    int _g_boolean_var_;                         \
 254    if (expr)                                    \
 255       _g_boolean_var_ = 1;                      \
 256    else                                         \
 257       _g_boolean_var_ = 0;                      \
 258    _g_boolean_var_;                             \
 259 })
 260 #define G_LIKELY(expr) (__builtin_expect (_G_BOOLEAN_EXPR(expr), 1))
 261 #define G_UNLIKELY(expr) (__builtin_expect (_G_BOOLEAN_EXPR(expr), 0))
 262 #else
 263 #define G_LIKELY(expr) (expr)
 264 #define G_UNLIKELY(expr) (expr)
 265 #endif
 266
 267 #endif /* __G_MACROS_H__ */