/[zanavi_public1]/navit/navit/support/glib/gmacros.h
ZANavi

Contents of /navit/navit/support/glib/gmacros.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2 - (show annotations) (download)
Fri Oct 28 21:19:04 2011 UTC (12 years, 5 months ago) by zoff99
File MIME type: text/plain
File size: 9097 byte(s)
import files
1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
18 */
19
20 /*
21 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GLib Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GLib at ftp://ftp.gtk.org/pub/gtk/.
25 */
26
27 /* This file must not include any other glib header file and must thus
28 * not refer to variables from glibconfig.h
29 */
30
31 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
32 #error "Only <glib.h> can be included directly."
33 #endif
34
35 #ifndef __G_MACROS_H__
36 #define __G_MACROS_H__
37
38 /* We include stddef.h to get the system's definition of NULL
39 */
40 #include <stddef.h>
41
42 /* Here we provide G_GNUC_EXTENSION as an alias for __extension__,
43 * where this is valid. This allows for warningless compilation of
44 * "long long" types even in the presence of '-ansi -pedantic'.
45 */
46 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8)
47 # define G_GNUC_EXTENSION __extension__
48 #else
49 # define G_GNUC_EXTENSION
50 #endif
51
52 /* Provide macros to feature the GCC function attribute.
53 */
54 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96)
55 #define G_GNUC_PURE \
56 __attribute__((__pure__))
57 #define G_GNUC_MALLOC \
58 __attribute__((__malloc__))
59 #else
60 #define G_GNUC_PURE
61 #define G_GNUC_MALLOC
62 #endif
63
64 #if __GNUC__ >= 4
65 #define G_GNUC_NULL_TERMINATED __attribute__((__sentinel__))
66 #else
67 #define G_GNUC_NULL_TERMINATED
68 #endif
69
70 #if (__GNUC__ > 4) || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
71 #define G_GNUC_ALLOC_SIZE(x) __attribute__((__alloc_size__(x)))
72 #define G_GNUC_ALLOC_SIZE2(x,y) __attribute__((__alloc_size__(x,y)))
73 #else
74 #define G_GNUC_ALLOC_SIZE(x)
75 #define G_GNUC_ALLOC_SIZE2(x,y)
76 #endif
77
78 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
79 #define G_GNUC_PRINTF( format_idx, arg_idx ) \
80 __attribute__((__format__ (__printf__, format_idx, arg_idx)))
81 #define G_GNUC_SCANF( format_idx, arg_idx ) \
82 __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
83 #define G_GNUC_FORMAT( arg_idx ) \
84 __attribute__((__format_arg__ (arg_idx)))
85 #define G_GNUC_NORETURN \
86 __attribute__((__noreturn__))
87 #define G_GNUC_CONST \
88 __attribute__((__const__))
89 #define G_GNUC_UNUSED \
90 __attribute__((__unused__))
91 #define G_GNUC_NO_INSTRUMENT \
92 __attribute__((__no_instrument_function__))
93 #else /* !__GNUC__ */
94 #define G_GNUC_PRINTF( format_idx, arg_idx )
95 #define G_GNUC_SCANF( format_idx, arg_idx )
96 #define G_GNUC_FORMAT( arg_idx )
97 #define G_GNUC_NORETURN
98 #define G_GNUC_CONST
99 #define G_GNUC_UNUSED
100 #define G_GNUC_NO_INSTRUMENT
101 #endif /* !__GNUC__ */
102
103 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1)
104 #define G_GNUC_DEPRECATED \
105 __attribute__((__deprecated__))
106 #else
107 #define G_GNUC_DEPRECATED
108 #endif /* __GNUC__ */
109
110 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 3)
111 # define G_GNUC_MAY_ALIAS __attribute__((may_alias))
112 #else
113 # define G_GNUC_MAY_ALIAS
114 #endif
115
116 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
117 #define G_GNUC_WARN_UNUSED_RESULT \
118 __attribute__((warn_unused_result))
119 #else
120 #define G_GNUC_WARN_UNUSED_RESULT
121 #endif /* __GNUC__ */
122
123 #ifndef G_DISABLE_DEPRECATED
124 /* Wrap the gcc __PRETTY_FUNCTION__ and __FUNCTION__ variables with
125 * macros, so we can refer to them as strings unconditionally.
126 * usage not-recommended since gcc-3.0
127 */
128 #if defined (__GNUC__) && (__GNUC__ < 3)
129 #define G_GNUC_FUNCTION __FUNCTION__
130 #define G_GNUC_PRETTY_FUNCTION __PRETTY_FUNCTION__
131 #else /* !__GNUC__ */
132 #define G_GNUC_FUNCTION ""
133 #define G_GNUC_PRETTY_FUNCTION ""
134 #endif /* !__GNUC__ */
135 #endif /* !G_DISABLE_DEPRECATED */
136
137 #define G_STRINGIFY(macro_or_string) G_STRINGIFY_ARG (macro_or_string)
138 #define G_STRINGIFY_ARG(contents) #contents
139
140 /* Provide a string identifying the current code position */
141 #if defined(__GNUC__) && (__GNUC__ < 3) && !defined(__cplusplus)
142 # define G_STRLOC __FILE__ ":" G_STRINGIFY (__LINE__) ":" __PRETTY_FUNCTION__ "()"
143 #else
144 # define G_STRLOC __FILE__ ":" G_STRINGIFY (__LINE__)
145 #endif
146
147 /* Provide a string identifying the current function, non-concatenatable */
148 #if defined (__GNUC__)
149 # define G_STRFUNC ((const char*) (__PRETTY_FUNCTION__))
150 #elif defined (__STDC_VERSION__) && __STDC_VERSION__ >= 19901L
151 # define G_STRFUNC ((const char*) (__func__))
152 #else
153 # define G_STRFUNC ((const char*) ("???"))
154 #endif
155
156 /* Guard C code in headers, while including them from C++ */
157 #ifdef __cplusplus
158 # define G_BEGIN_DECLS extern "C" {
159 # define G_END_DECLS }
160 #else
161 # define G_BEGIN_DECLS
162 # define G_END_DECLS
163 #endif
164
165 /* Provide definitions for some commonly used macros.
166 * Some of them are only provided if they haven't already
167 * been defined. It is assumed that if they are already
168 * defined then the current definition is correct.
169 */
170 #ifndef NULL
171 # ifdef __cplusplus
172 # define NULL (0L)
173 # else /* !__cplusplus */
174 # define NULL ((void*) 0)
175 # endif /* !__cplusplus */
176 #endif
177
178 #ifndef FALSE
179 #define FALSE (0)
180 #endif
181
182 #ifndef TRUE
183 #define TRUE (!FALSE)
184 #endif
185
186 #undef MAX
187 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
188
189 #undef MIN
190 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
191
192 #undef ABS
193 #define ABS(a) (((a) < 0) ? -(a) : (a))
194
195 #undef CLAMP
196 #define CLAMP(x, low, high) (((x) > (high)) ? (high) : (((x) < (low)) ? (low) : (x)))
197
198 /* Count the number of elements in an array. The array must be defined
199 * as such; using this with a dynamically allocated array will give
200 * incorrect results.
201 */
202 #define G_N_ELEMENTS(arr) (sizeof (arr) / sizeof ((arr)[0]))
203
204 /* Macros by analogy to GINT_TO_POINTER, GPOINTER_TO_INT
205 */
206 #define GPOINTER_TO_SIZE(p) ((gsize) (p))
207 #define GSIZE_TO_POINTER(s) ((gpointer) (gsize) (s))
208
209 /* Provide convenience macros for handling structure
210 * fields through their offsets.
211 */
212
213 #if defined(__GNUC__) && __GNUC__ >= 4
214 # define G_STRUCT_OFFSET(struct_type, member) \
215 ((glong) __builtin_offsetof (struct_type, member))
216 #else
217 # define G_STRUCT_OFFSET(struct_type, member) \
218 ((glong) ((guint8*) &((struct_type*) 0)->member))
219 #endif
220
221 #define G_STRUCT_MEMBER_P(struct_p, struct_offset) \
222 ((gpointer) ((guint8*) (struct_p) + (glong) (struct_offset)))
223 #define G_STRUCT_MEMBER(member_type, struct_p, struct_offset) \
224 (*(member_type*) G_STRUCT_MEMBER_P ((struct_p), (struct_offset)))
225
226 /* Provide simple macro statement wrappers:
227 * G_STMT_START { statements; } G_STMT_END;
228 * This can be used as a single statement, like:
229 * if (x) G_STMT_START { ... } G_STMT_END; else ...
230 * This intentionally does not use compiler extensions like GCC's '({...})' to
231 * avoid portability issue or side effects when compiled with different compilers.
232 */
233 #if !(defined (G_STMT_START) && defined (G_STMT_END))
234 # define G_STMT_START do
235 # define G_STMT_END while (0)
236 #endif
237
238 /* Allow the app programmer to select whether or not return values
239 * (usually char*) are const or not. Don't try using this feature for
240 * functions with C++ linkage.
241 */
242 #ifdef G_DISABLE_CONST_RETURNS
243 #define G_CONST_RETURN
244 #else
245 #define G_CONST_RETURN const
246 #endif
247
248 /*
249 * The G_LIKELY and G_UNLIKELY macros let the programmer give hints to
250 * the compiler about the expected result of an expression. Some compilers
251 * can use this information for optimizations.
252 *
253 * The _G_BOOLEAN_EXPR macro is intended to trigger a gcc warning when
254 * putting assignments in g_return_if_fail ().
255 */
256 #if defined(__GNUC__) && (__GNUC__ > 2) && defined(__OPTIMIZE__)
257 #define _G_BOOLEAN_EXPR(expr) \
258 __extension__ ({ \
259 int _g_boolean_var_; \
260 if (expr) \
261 _g_boolean_var_ = 1; \
262 else \
263 _g_boolean_var_ = 0; \
264 _g_boolean_var_; \
265 })
266 #define G_LIKELY(expr) (__builtin_expect (_G_BOOLEAN_EXPR(expr), 1))
267 #define G_UNLIKELY(expr) (__builtin_expect (_G_BOOLEAN_EXPR(expr), 0))
268 #else
269 #define G_LIKELY(expr) (expr)
270 #define G_UNLIKELY(expr) (expr)
271 #endif
272
273 #endif /* __G_MACROS_H__ */

   
Visit the ZANavi Wiki