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)) || \
69 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx ) \
70 __attribute__((__format__ (__printf__, format_idx, arg_idx)))
71 #define _DBUS_GNUC_NORETURN \
72 __attribute__((__noreturn__))
73 #define _DBUS_GNUC_UNUSED \
74 __attribute__((__unused__))
76 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
77 #define _DBUS_GNUC_NORETURN
78 #define _DBUS_GNUC_UNUSED
79 #endif /* !__GNUC__ */
81 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96)
82 #define DBUS_MALLOC __attribute__((__malloc__))
87 #if (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
88 #define DBUS_ALLOC_SIZE(x) __attribute__((__alloc_size__(x)))
89 #define DBUS_ALLOC_SIZE2(x,y) __attribute__((__alloc_size__(x,y)))
91 #define DBUS_ALLOC_SIZE(x)
92 #define DBUS_ALLOC_SIZE2(x,y)
95 #if (__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
96 #define _DBUS_GNUC_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
98 #define _DBUS_GNUC_WARN_UNUSED_RESULT
101 /** @def _DBUS_GNUC_PRINTF
102 * used to tell gcc about printf format strings
104 /** @def _DBUS_GNUC_NORETURN
105 * used to tell gcc about functions that never return, such as _dbus_abort()
107 /** @def _DBUS_GNUC_WARN_UNUSED_RESULT
108 * used to tell gcc about functions whose result must be used
111 /* Normally docs are in .c files, but there isn't a .c file for this. */
113 * @defgroup DBusMacros Utility macros
115 * @brief #TRUE, #FALSE, #NULL, and so on
123 * @def DBUS_BEGIN_DECLS
125 * Macro used prior to declaring functions in the D-Bus header
126 * files. Expands to "extern "C"" when using a C++ compiler,
127 * and expands to nothing when using a C compiler.
129 * Please don't use this in your own code, consider it
133 * @def DBUS_END_DECLS
135 * Macro used after declaring functions in the D-Bus header
136 * files. Expands to "}" when using a C++ compiler,
137 * and expands to nothing when using a C compiler.
139 * Please don't use this in your own code, consider it
155 * A null pointer, defined appropriately for C or C++.
158 * @def DBUS_DEPRECATED
160 * Tells the compiler to warn about a function or type if it's used.
161 * Code marked in this way should also be enclosed in
163 * #ifndef DBUS_DISABLE_DEPRECATED
164 * deprecated stuff here
168 * Please don't use this in your own code, consider it
172 * @def _DBUS_GNUC_EXTENSION
174 * Tells gcc not to warn about extensions to the C standard in the
175 * following expression, even if compiling with -pedantic. Do not use
176 * this macro in your own code; please consider it to be internal to libdbus.
182 * Declare the following symbol as public. This is currently a noop on
183 * platforms other than Windows.
186 #if defined(DBUS_EXPORT)
187 /* value forced by compiler command line, don't redefine */
188 #elif defined(_WIN32)
189 # if defined(DBUS_STATIC_BUILD)
191 # elif defined(dbus_1_EXPORTS)
192 # define DBUS_EXPORT __declspec(dllexport)
194 # define DBUS_EXPORT __declspec(dllimport)
196 #elif defined(__GNUC__) && __GNUC__ >= 4
197 # define DBUS_EXPORT __attribute__ ((__visibility__ ("default")))
202 #if defined(DBUS_PRIVATE_EXPORT)
203 /* value forced by compiler command line, don't redefine */
204 #elif defined(_WIN32)
205 # if defined(DBUS_STATIC_BUILD)
206 # define DBUS_PRIVATE_EXPORT /* no decoration */
207 # elif defined(dbus_1_EXPORTS)
208 # define DBUS_PRIVATE_EXPORT __declspec(dllexport)
210 # define DBUS_PRIVATE_EXPORT __declspec(dllimport)
212 #elif defined(__GNUC__) && __GNUC__ >= 4
213 # define DBUS_PRIVATE_EXPORT __attribute__ ((__visibility__ ("default")))
215 # define DBUS_PRIVATE_EXPORT /* no decoration */
220 #endif /* DBUS_MACROS_H */