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 #else   /* !__GNUC__ */
  73 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
  74 #define _DBUS_GNUC_NORETURN
  75 #endif  /* !__GNUC__ */
  76
  77 #if    __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96)
  78 #define DBUS_MALLOC     __attribute__((__malloc__))
  79 #else
  80 #define DBUS_MALLOC
  81 #endif
  82
  83 #if     (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
  84 #define DBUS_ALLOC_SIZE(x) __attribute__((__alloc_size__(x)))
  85 #define DBUS_ALLOC_SIZE2(x,y) __attribute__((__alloc_size__(x,y)))
  86 #else
  87 #define DBUS_ALLOC_SIZE(x)
  88 #define DBUS_ALLOC_SIZE2(x,y)
  89 #endif
  90
  91 #if    (__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
  92 #define _DBUS_GNUC_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
  93 #else
  94 #define _DBUS_GNUC_WARN_UNUSED_RESULT
  95 #endif
  96
  97 /** @def _DBUS_GNUC_PRINTF
  98  * used to tell gcc about printf format strings
  99  */
 100 /** @def _DBUS_GNUC_NORETURN
 101  * used to tell gcc about functions that never return, such as _dbus_abort()
 102  */
 103 /** @def _DBUS_GNUC_WARN_UNUSED_RESULT
 104  * used to tell gcc about functions whose result must be used
 105  */
 106
 107 /* Normally docs are in .c files, but there isn't a .c file for this. */
 108 /**
 109  * @defgroup DBusMacros Utility macros
 110  * @ingroup  DBus
 111  * @brief #TRUE, #FALSE, #NULL, and so on
 112  *
 113  * Utility macros.
 114  *
 115  * @{
 116  */
 117
 118 /**
 119  * @def DBUS_BEGIN_DECLS
 120  *
 121  * Macro used prior to declaring functions in the D-Bus header
 122  * files. Expands to "extern "C"" when using a C++ compiler,
 123  * and expands to nothing when using a C compiler.
 124  *
 125  * Please don't use this in your own code, consider it
 126  * D-Bus internal.
 127  */
 128 /**
 129  * @def DBUS_END_DECLS
 130  *
 131  * Macro used after declaring functions in the D-Bus header
 132  * files. Expands to "}" when using a C++ compiler,
 133  * and expands to nothing when using a C compiler.
 134  *
 135  * Please don't use this in your own code, consider it
 136  * D-Bus internal.
 137  */
 138 /**
 139  * @def TRUE
 140  *
 141  * Expands to "1"
 142  */
 143 /**
 144  * @def FALSE
 145  *
 146  * Expands to "0"
 147  */
 148 /**
 149  * @def NULL
 150  *
 151  * A null pointer, defined appropriately for C or C++.
 152  */
 153 /**
 154  * @def DBUS_DEPRECATED
 155  *
 156  * Tells the compiler to warn about a function or type if it's used.
 157  * Code marked in this way should also be enclosed in
 158  * @code
 159  * #ifndef DBUS_DISABLE_DEPRECATED
 160  *  deprecated stuff here
 161  * #endif
 162  * @endcode
 163  *
 164  * Please don't use this in your own code, consider it
 165  * D-Bus internal.
 166  */
 167 /**
 168  * @def _DBUS_GNUC_EXTENSION
 169  *
 170  * Tells gcc not to warn about extensions to the C standard in the
 171  * following expression, even if compiling with -pedantic. Do not use
 172  * this macro in your own code; please consider it to be internal to libdbus.
 173  */
 174
 175 /*
 176  * @def DBUS_EXPORT
 177  *
 178  * Declare the following symbol as public.  This is currently a noop on
 179  * platforms other than Windows.
 180  */
 181
 182 #if defined(_WIN32)
 183 #  if defined(DBUS_STATIC_BUILD)
 184 #  define DBUS_EXPORT
 185 #  elif defined(dbus_1_EXPORTS)
 186 #  define DBUS_EXPORT __declspec(dllexport)
 187 #  else
 188 #  define DBUS_EXPORT __declspec(dllimport)
 189 #  endif
 190 #else
 191 #define DBUS_EXPORT
 192 #endif
 193
 194 /** @} */
 195
 196 #endif /* DBUS_MACROS_H */