* dbus/dbus-macros.h, dbus/dbus-message.c, dbus/dbus-message.h: renamed DBUS_GNUC_DEP...
[platform/upstream/dbus.git] / dbus / dbus-macros.h
1 /* -*- mode: C; c-file-style: "gnu" -*- */
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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 /* Normally docs are in .c files, but there isn't a .c file for this. */
62 /**
63  * @defgroup DBusMacros Utility macros
64  * @ingroup  DBus
65  * @brief #TRUE, #FALSE, #NULL, and so on
66  *
67  * Utility macros.
68  *
69  * @{
70  */
71
72 /**
73  * @def DBUS_BEGIN_DECLS
74  *
75  * Macro used prior to declaring functions in the D-Bus header
76  * files. Expands to "extern "C"" when using a C++ compiler,
77  * and expands to nothing when using a C compiler.
78  *
79  * Please don't use this in your own code, consider it
80  * D-Bus internal.
81  */
82 /**
83  * @def DBUS_END_DECLS
84  *
85  * Macro used after declaring functions in the D-Bus header
86  * files. Expands to "}" when using a C++ compiler,
87  * and expands to nothing when using a C compiler.
88  *
89  * Please don't use this in your own code, consider it
90  * D-Bus internal.
91  */
92 /**
93  * @def TRUE
94  *
95  * Expands to "1"
96  */
97 /**
98  * @def FALSE
99  *
100  * Expands to "0"
101  */
102 /**
103  * @def NULL
104  *
105  * A null pointer, defined appropriately for C or C++.
106  */
107 /**
108  * @def DBUS_DEPRECATED
109  *
110  * Tells the compiler to warn about a function or type if it's used.
111  * Code marked in this way should also be enclosed in
112  * @code
113  * #ifndef DBUS_DISABLE_DEPRECATED
114  *  deprecated stuff here
115  * #endif
116  * @endcode
117  *
118  * Please don't use this in your own code, consider it
119  * D-Bus internal.
120  */
121
122 /** @} */
123
124 #endif /* DBUS_MACROS_H */