D-Bus  1.13.7
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  defined(__clang__)
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__))
75 #else /* !__GNUC__ */
76 #define _DBUS_GNUC_PRINTF( format_idx, arg_idx )
77 #define _DBUS_GNUC_NORETURN
78 #define _DBUS_GNUC_UNUSED
79 #endif /* !__GNUC__ */
80 
81 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96)
82 #define DBUS_MALLOC __attribute__((__malloc__))
83 #else
84 #define DBUS_MALLOC
85 #endif
86 
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)))
90 #else
91 #define DBUS_ALLOC_SIZE(x)
92 #define DBUS_ALLOC_SIZE2(x,y)
93 #endif
94 
107 #if defined(_MSC_VER) && (_MSC_VER >= 1700)
108 #define _DBUS_WARN_UNUSED_RESULT _Must_inspect_result_
109 #elif (__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
110 #define _DBUS_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
111 #else
112 #define _DBUS_WARN_UNUSED_RESULT
113 #endif
114 
122 /* Normally docs are in .c files, but there isn't a .c file for this. */
190 /*
191  * @def DBUS_EXPORT
192  *
193  * Declare the following symbol as public. This is currently a noop on
194  * platforms other than Windows.
195  */
196 
197 #if defined(DBUS_EXPORT)
198  /* value forced by compiler command line, don't redefine */
199 #elif defined(_WIN32)
200 # if defined(DBUS_STATIC_BUILD)
201 # define DBUS_EXPORT
202 # elif defined(dbus_1_EXPORTS)
203 # define DBUS_EXPORT __declspec(dllexport)
204 # else
205 # define DBUS_EXPORT __declspec(dllimport)
206 # endif
207 #elif defined(__GNUC__) && __GNUC__ >= 4
208 # define DBUS_EXPORT __attribute__ ((__visibility__ ("default")))
209 #else
210 #define DBUS_EXPORT
211 #endif
212 
213 #if defined(DBUS_PRIVATE_EXPORT)
214  /* value forced by compiler command line, don't redefine */
215 #elif defined(_WIN32)
216 # if defined(DBUS_STATIC_BUILD)
217 # define DBUS_PRIVATE_EXPORT /* no decoration */
218 # elif defined(dbus_1_EXPORTS)
219 # define DBUS_PRIVATE_EXPORT __declspec(dllexport)
220 # else
221 # define DBUS_PRIVATE_EXPORT __declspec(dllimport)
222 # endif
223 #elif defined(__GNUC__) && __GNUC__ >= 4
224 # define DBUS_PRIVATE_EXPORT __attribute__ ((__visibility__ ("default")))
225 #else
226 # define DBUS_PRIVATE_EXPORT /* no decoration */
227 #endif
228 
229 /* Implementation for dbus_clear_message() etc. This is not API,
230  * do not use it directly.
231  *
232  * We're using a specific type (T ** and T *) instead of void ** and
233  * void * partly for type-safety, partly to be strict-aliasing-compliant,
234  * and partly to keep C++ compilers happy. This code is inlined into
235  * users of libdbus, so we can't rely on it having dbus' own compiler
236  * settings. */
237 #define _dbus_clear_pointer_impl(T, pointer_to_pointer, destroy) \
238  do { \
239  T **_pp = (pointer_to_pointer); \
240  T *_value = *_pp; \
241  \
242  *_pp = NULL; \
243  \
244  if (_value != NULL) \
245  destroy (_value); \
246  } while (0)
247 /* Not (destroy) (_value) in case destroy() is a function-like macro */
248 
251 #endif /* DBUS_MACROS_H */