D-Bus  1.8.16
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 
110 /* Normally docs are in .c files, but there isn't a .c file for this. */
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(_WIN32)
186 # if defined(DBUS_STATIC_BUILD)
187 # define DBUS_EXPORT
188 # elif defined(dbus_1_EXPORTS)
189 # define DBUS_EXPORT __declspec(dllexport)
190 # else
191 # define DBUS_EXPORT __declspec(dllimport)
192 # endif
193 #else
194 #define DBUS_EXPORT
195 #endif
196 
199 #endif /* DBUS_MACROS_H */