1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-macros.h generic macros
4 * Copyright (C) 2002 Red Hat Inc.
6 * Licensed under the Academic Free License version 2.1
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.
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.
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
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."
31 # define DBUS_BEGIN_DECLS extern "C" {
32 # define DBUS_END_DECLS }
34 # define DBUS_BEGIN_DECLS
35 # define DBUS_END_DECLS
48 # else /* !__cplusplus */
49 # define NULL ((void*) 0)
50 # endif /* !__cplusplus */
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)
58 # define DBUS_DEPRECATED
61 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8)
62 # define _DBUS_GNUC_EXTENSION __extension__
64 # define _DBUS_GNUC_EXTENSION
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__))
75 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
76 #define _DBUS_GNUC_NORETURN
77 #define _DBUS_GNUC_UNUSED
78 #endif /* !__GNUC__ */
80 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96)
81 #define DBUS_MALLOC __attribute__((__malloc__))
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)))
90 #define DBUS_ALLOC_SIZE(x)
91 #define DBUS_ALLOC_SIZE2(x,y)
94 #if (__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
95 #define _DBUS_GNUC_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
97 #define _DBUS_GNUC_WARN_UNUSED_RESULT
100 /** @def _DBUS_GNUC_PRINTF
101 * used to tell gcc about printf format strings
103 /** @def _DBUS_GNUC_NORETURN
104 * used to tell gcc about functions that never return, such as _dbus_abort()
106 /** @def _DBUS_GNUC_WARN_UNUSED_RESULT
107 * used to tell gcc about functions whose result must be used
110 /* Normally docs are in .c files, but there isn't a .c file for this. */
112 * @defgroup DBusMacros Utility macros
114 * @brief #TRUE, #FALSE, #NULL, and so on
122 * @def DBUS_BEGIN_DECLS
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.
128 * Please don't use this in your own code, consider it
132 * @def DBUS_END_DECLS
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.
138 * Please don't use this in your own code, consider it
154 * A null pointer, defined appropriately for C or C++.
157 * @def DBUS_DEPRECATED
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
162 * #ifndef DBUS_DISABLE_DEPRECATED
163 * deprecated stuff here
167 * Please don't use this in your own code, consider it
171 * @def _DBUS_GNUC_EXTENSION
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.
181 * Declare the following symbol as public. This is currently a noop on
182 * platforms other than Windows.
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)
190 # elif defined(dbus_1_EXPORTS)
191 # define DBUS_EXPORT __declspec(dllexport)
193 # define DBUS_EXPORT __declspec(dllimport)
195 #elif defined(__GNUC__) && __GNUC__ >= 4
196 # define DBUS_EXPORT __attribute__ ((__visibility__ ("default")))
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)
209 # define DBUS_PRIVATE_EXPORT __declspec(dllimport)
211 #elif defined(__GNUC__) && __GNUC__ >= 4
212 # define DBUS_PRIVATE_EXPORT __attribute__ ((__visibility__ ("default")))
214 # define DBUS_PRIVATE_EXPORT /* no decoration */
219 #endif /* DBUS_MACROS_H */