Merge branch 'dbus-1.2'
[platform/upstream/dbus.git] / 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 /** @def _DBUS_GNUC_PRINTF
78  * used to tell gcc about printf format strings
79  */
80 /** @def _DBUS_GNUC_NORETURN
81  * used to tell gcc about functions that never return, such as _dbus_abort()
82  */
83
84
85 /* Normally docs are in .c files, but there isn't a .c file for this. */
86 /**
87  * @defgroup DBusMacros Utility macros
88  * @ingroup  DBus
89  * @brief #TRUE, #FALSE, #NULL, and so on
90  *
91  * Utility macros.
92  *
93  * @{
94  */
95
96 /**
97  * @def DBUS_BEGIN_DECLS
98  *
99  * Macro used prior to declaring functions in the D-Bus header
100  * files. Expands to "extern "C"" when using a C++ compiler,
101  * and expands to nothing when using a C compiler.
102  *
103  * Please don't use this in your own code, consider it
104  * D-Bus internal.
105  */
106 /**
107  * @def DBUS_END_DECLS
108  *
109  * Macro used after declaring functions in the D-Bus header
110  * files. Expands to "}" when using a C++ compiler,
111  * and expands to nothing when using a C compiler.
112  *
113  * Please don't use this in your own code, consider it
114  * D-Bus internal.
115  */
116 /**
117  * @def TRUE
118  *
119  * Expands to "1"
120  */
121 /**
122  * @def FALSE
123  *
124  * Expands to "0"
125  */
126 /**
127  * @def NULL
128  *
129  * A null pointer, defined appropriately for C or C++.
130  */
131 /**
132  * @def DBUS_DEPRECATED
133  *
134  * Tells the compiler to warn about a function or type if it's used.
135  * Code marked in this way should also be enclosed in
136  * @code
137  * #ifndef DBUS_DISABLE_DEPRECATED
138  *  deprecated stuff here
139  * #endif
140  * @endcode
141  *
142  * Please don't use this in your own code, consider it
143  * D-Bus internal.
144  */
145 /**
146  * @def _DBUS_GNUC_EXTENSION
147  *
148  * Tells gcc not to warn about extensions to the C standard in the
149  * following expression, even if compiling with -pedantic. Do not use
150  * this macro in your own code; please consider it to be internal to libdbus.
151  */
152
153 /*
154  * @def DBUS_EXPORT
155  *
156  * Declare the following symbol as public.  This is currently a noop on
157  * platforms other than Windows.
158  */
159
160 #if defined(DBUS_WIN)
161 #  if defined(dbus_1_EXPORTS)
162 #  define DBUS_EXPORT __declspec(dllexport)
163 #  else
164 #  define DBUS_EXPORT __declspec(dllimport)
165 #  endif
166 #else
167 #define DBUS_EXPORT
168 #endif
169
170 /** @} */
171
172 #endif /* DBUS_MACROS_H */