dbus/dbus-macros.h

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2 /* dbus-macros.h  generic macros
   3  *
   4  * Copyright (C) 2002  Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 2.1
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  21  *
  22  */
  23 #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
  24 #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
  25 #endif
  26
  27 #ifndef DBUS_MACROS_H
  28 #define DBUS_MACROS_H
  29
  30 #ifdef  __cplusplus
  31 #  define DBUS_BEGIN_DECLS  extern "C" {
  32 #  define DBUS_END_DECLS    }
  33 #else
  34 #  define DBUS_BEGIN_DECLS
  35 #  define DBUS_END_DECLS
  36 #endif
  37
  38 #ifndef TRUE
  39 #  define TRUE 1
  40 #endif
  41 #ifndef FALSE
  42 #  define FALSE 0
  43 #endif
  44
  45 #ifndef NULL
  46 #  ifdef __cplusplus
  47 #    define NULL        (0L)
  48 #  else /* !__cplusplus */
  49 #    define NULL        ((void*) 0)
  50 #  endif /* !__cplusplus */
  51 #endif
  52
  53 #if  __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1)
  54 #  define DBUS_DEPRECATED __attribute__ ((__deprecated__))
  55 #elif defined(_MSC_VER) && (_MSC_VER >= 1300)
  56 #  define DBUS_DEPRECATED __declspec(deprecated)
  57 #else
  58 #  define DBUS_DEPRECATED
  59 #endif
  60
  61 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8)
  62 #  define _DBUS_GNUC_EXTENSION __extension__
  63 #else
  64 #  define _DBUS_GNUC_EXTENSION
  65 #endif
  66
  67 #if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
  68 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )    \
  69   __attribute__((__format__ (__printf__, format_idx, arg_idx)))
  70 #define _DBUS_GNUC_NORETURN                         \
  71   __attribute__((__noreturn__))
  72 #define _DBUS_GNUC_UNUSED                           \
  73   __attribute__((__unused__))
  74 #else   /* !__GNUC__ */
  75 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
  76 #define _DBUS_GNUC_NORETURN
  77 #define _DBUS_GNUC_UNUSED
  78 #endif  /* !__GNUC__ */
  79
  80 #if    __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96)
  81 #define DBUS_MALLOC     __attribute__((__malloc__))
  82 #else
  83 #define DBUS_MALLOC
  84 #endif
  85
  86 #if     (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
  87 #define DBUS_ALLOC_SIZE(x) __attribute__((__alloc_size__(x)))
  88 #define DBUS_ALLOC_SIZE2(x,y) __attribute__((__alloc_size__(x,y)))
  89 #else
  90 #define DBUS_ALLOC_SIZE(x)
  91 #define DBUS_ALLOC_SIZE2(x,y)
  92 #endif
  93
  94 #if    (__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
  95 #define _DBUS_GNUC_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
  96 #else
  97 #define _DBUS_GNUC_WARN_UNUSED_RESULT
  98 #endif
  99
 100 /** @def _DBUS_GNUC_PRINTF
 101  * used to tell gcc about printf format strings
 102  */
 103 /** @def _DBUS_GNUC_NORETURN
 104  * used to tell gcc about functions that never return, such as _dbus_abort()
 105  */
 106 /** @def _DBUS_GNUC_WARN_UNUSED_RESULT
 107  * used to tell gcc about functions whose result must be used
 108  */
 109
 110 /* Normally docs are in .c files, but there isn't a .c file for this. */
 111 /**
 112  * @defgroup DBusMacros Utility macros
 113  * @ingroup  DBus
 114  * @brief #TRUE, #FALSE, #NULL, and so on
 115  *
 116  * Utility macros.
 117  *
 118  * @{
 119  */
 120
 121 /**
 122  * @def DBUS_BEGIN_DECLS
 123  *
 124  * Macro used prior to declaring functions in the D-Bus header
 125  * files. Expands to "extern "C"" when using a C++ compiler,
 126  * and expands to nothing when using a C compiler.
 127  *
 128  * Please don't use this in your own code, consider it
 129  * D-Bus internal.
 130  */
 131 /**
 132  * @def DBUS_END_DECLS
 133  *
 134  * Macro used after declaring functions in the D-Bus header
 135  * files. Expands to "}" when using a C++ compiler,
 136  * and expands to nothing when using a C compiler.
 137  *
 138  * Please don't use this in your own code, consider it
 139  * D-Bus internal.
 140  */
 141 /**
 142  * @def TRUE
 143  *
 144  * Expands to "1"
 145  */
 146 /**
 147  * @def FALSE
 148  *
 149  * Expands to "0"
 150  */
 151 /**
 152  * @def NULL
 153  *
 154  * A null pointer, defined appropriately for C or C++.
 155  */
 156 /**
 157  * @def DBUS_DEPRECATED
 158  *
 159  * Tells the compiler to warn about a function or type if it's used.
 160  * Code marked in this way should also be enclosed in
 161  * @code
 162  * #ifndef DBUS_DISABLE_DEPRECATED
 163  *  deprecated stuff here
 164  * #endif
 165  * @endcode
 166  *
 167  * Please don't use this in your own code, consider it
 168  * D-Bus internal.
 169  */
 170 /**
 171  * @def _DBUS_GNUC_EXTENSION
 172  *
 173  * Tells gcc not to warn about extensions to the C standard in the
 174  * following expression, even if compiling with -pedantic. Do not use
 175  * this macro in your own code; please consider it to be internal to libdbus.
 176  */
 177
 178 /*
 179  * @def DBUS_EXPORT
 180  *
 181  * Declare the following symbol as public.  This is currently a noop on
 182  * platforms other than Windows.
 183  */
 184
 185 #if defined(DBUS_EXPORT)
 186   /* value forced by compiler command line, don't redefine */
 187 #elif defined(_WIN32)
 188 #  if defined(DBUS_STATIC_BUILD)
 189 #  define DBUS_EXPORT
 190 #  elif defined(dbus_1_EXPORTS)
 191 #  define DBUS_EXPORT __declspec(dllexport)
 192 #  else
 193 #  define DBUS_EXPORT __declspec(dllimport)
 194 #  endif
 195 #elif defined(__GNUC__) && __GNUC__ >= 4
 196 #  define DBUS_EXPORT __attribute__ ((__visibility__ ("default")))
 197 #else
 198 #define DBUS_EXPORT
 199 #endif
 200
 201 #if defined(DBUS_PRIVATE_EXPORT)
 202   /* value forced by compiler command line, don't redefine */
 203 #elif defined(_WIN32)
 204 #  if defined(DBUS_STATIC_BUILD)
 205 #    define DBUS_PRIVATE_EXPORT /* no decoration */
 206 #  elif defined(dbus_1_EXPORTS)
 207 #    define DBUS_PRIVATE_EXPORT __declspec(dllexport)
 208 #  else
 209 #    define DBUS_PRIVATE_EXPORT __declspec(dllimport)
 210 #  endif
 211 #elif defined(__GNUC__) && __GNUC__ >= 4
 212 #  define DBUS_PRIVATE_EXPORT __attribute__ ((__visibility__ ("default")))
 213 #else
 214 #  define DBUS_PRIVATE_EXPORT /* no decoration */
 215 #endif
 216
 217 /** @} */
 218
 219 #endif /* DBUS_MACROS_H */