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