1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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.
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.
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.
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/.
30 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
31 #error "Only <glib.h> can be included directly."
34 #include <glibconfig.h>
35 #include <glib/gmacros.h>
36 #include <glib/gversionmacros.h>
41 /* Provide type definitions for commonly used types.
42 * These are useful because a "gint8" can be adjusted
43 * to be 1 byte (8 bits) on all platforms. Similarly and
44 * more importantly, "gint32" can be adjusted to be
45 * 4 bytes (32 bits) on all platforms.
52 typedef gint gboolean
;
54 typedef unsigned char guchar
;
55 typedef unsigned short gushort
;
56 typedef unsigned long gulong
;
57 typedef unsigned int guint
;
60 typedef double gdouble
;
62 /* Define min and max constants for the fixed size numerical types */
63 #define G_MININT8 ((gint8) 0x80)
64 #define G_MAXINT8 ((gint8) 0x7f)
65 #define G_MAXUINT8 ((guint8) 0xff)
67 #define G_MININT16 ((gint16) 0x8000)
68 #define G_MAXINT16 ((gint16) 0x7fff)
69 #define G_MAXUINT16 ((guint16) 0xffff)
71 #define G_MININT32 ((gint32) 0x80000000)
72 #define G_MAXINT32 ((gint32) 0x7fffffff)
73 #define G_MAXUINT32 ((guint32) 0xffffffff)
75 #define G_MININT64 ((gint64) G_GINT64_CONSTANT(0x8000000000000000))
76 #define G_MAXINT64 G_GINT64_CONSTANT(0x7fffffffffffffff)
77 #define G_MAXUINT64 G_GINT64_CONSTANT(0xffffffffffffffffU)
79 typedef void* gpointer
;
80 typedef const void *gconstpointer
;
82 typedef gint (*GCompareFunc
) (gconstpointer a
,
84 typedef gint (*GCompareDataFunc
) (gconstpointer a
,
87 typedef gboolean (*GEqualFunc
) (gconstpointer a
,
89 typedef void (*GDestroyNotify
) (gpointer data
);
90 typedef void (*GFunc
) (gpointer data
,
92 typedef guint (*GHashFunc
) (gconstpointer key
);
93 typedef void (*GHFunc
) (gpointer key
,
99 * @data: a data pointer
101 * Declares a type of function which takes an arbitrary
102 * data pointer argument and has no return value. It is
103 * not currently used in GLib or GTK+.
105 typedef void (*GFreeFunc
) (gpointer data
);
109 * @str: the untranslated string
110 * @data: user data specified when installing the function, e.g.
111 * in g_option_group_set_translate_func()
113 * The type of functions which are used to translate user-visible
114 * strings, for <option>--help</option> output.
116 * Returns: a translation of the string for the current locale.
117 * The returned string is owned by GLib and must not be freed.
119 typedef const gchar
* (*GTranslateFunc
) (const gchar
*str
,
123 /* Define some mathematical constants that aren't available
124 * symbolically in some strict ISO C implementations.
126 * Note that the large number of digits used in these definitions
127 * doesn't imply that GLib or current computers in general would be
128 * able to handle floating point numbers with an accuracy like this.
129 * It's mostly an exercise in futility and future proofing. For
130 * extended precision floating point support, look somewhere else
133 #define G_E 2.7182818284590452353602874713526624977572470937000
134 #define G_LN2 0.69314718055994530941723212145817656807550013436026
135 #define G_LN10 2.3025850929940456840179914546843642076011014886288
136 #define G_PI 3.1415926535897932384626433832795028841971693993751
137 #define G_PI_2 1.5707963267948966192313216916397514420985846996876
138 #define G_PI_4 0.78539816339744830961566084581987572104929234984378
139 #define G_SQRT2 1.4142135623730950488016887242096980785696718753769
141 /* Portable endian checks and conversions
143 * glibconfig.h defines G_BYTE_ORDER which expands to one of
146 #define G_LITTLE_ENDIAN 1234
147 #define G_BIG_ENDIAN 4321
148 #define G_PDP_ENDIAN 3412 /* unused, need specific PDP check */
151 /* Basic bit swapping functions
153 #define GUINT16_SWAP_LE_BE_CONSTANT(val) ((guint16) ( \
154 (guint16) ((guint16) (val) >> 8) | \
155 (guint16) ((guint16) (val) << 8)))
157 #define GUINT32_SWAP_LE_BE_CONSTANT(val) ((guint32) ( \
158 (((guint32) (val) & (guint32) 0x000000ffU) << 24) | \
159 (((guint32) (val) & (guint32) 0x0000ff00U) << 8) | \
160 (((guint32) (val) & (guint32) 0x00ff0000U) >> 8) | \
161 (((guint32) (val) & (guint32) 0xff000000U) >> 24)))
163 #define GUINT64_SWAP_LE_BE_CONSTANT(val) ((guint64) ( \
164 (((guint64) (val) & \
165 (guint64) G_GINT64_CONSTANT (0x00000000000000ffU)) << 56) | \
166 (((guint64) (val) & \
167 (guint64) G_GINT64_CONSTANT (0x000000000000ff00U)) << 40) | \
168 (((guint64) (val) & \
169 (guint64) G_GINT64_CONSTANT (0x0000000000ff0000U)) << 24) | \
170 (((guint64) (val) & \
171 (guint64) G_GINT64_CONSTANT (0x00000000ff000000U)) << 8) | \
172 (((guint64) (val) & \
173 (guint64) G_GINT64_CONSTANT (0x000000ff00000000U)) >> 8) | \
174 (((guint64) (val) & \
175 (guint64) G_GINT64_CONSTANT (0x0000ff0000000000U)) >> 24) | \
176 (((guint64) (val) & \
177 (guint64) G_GINT64_CONSTANT (0x00ff000000000000U)) >> 40) | \
178 (((guint64) (val) & \
179 (guint64) G_GINT64_CONSTANT (0xff00000000000000U)) >> 56)))
181 /* Arch specific stuff for speed
183 #if defined (__GNUC__) && (__GNUC__ >= 2) && defined (__OPTIMIZE__)
185 # if __GNUC__ >= 4 && defined (__GNUC_MINOR__) && __GNUC_MINOR__ >= 3
186 # define GUINT32_SWAP_LE_BE(val) ((guint32) __builtin_bswap32 ((gint32) (val)))
187 # define GUINT64_SWAP_LE_BE(val) ((guint64) __builtin_bswap64 ((gint64) (val)))
190 # if defined (__i386__)
191 # define GUINT16_SWAP_LE_BE_IA32(val) \
193 ({ register guint16 __v, __x = ((guint16) (val)); \
194 if (__builtin_constant_p (__x)) \
195 __v = GUINT16_SWAP_LE_BE_CONSTANT (__x); \
197 __asm__ ("rorw $8, %w0" \
202 # if !defined (__i486__) && !defined (__i586__) \
203 && !defined (__pentium__) && !defined (__i686__) \
204 && !defined (__pentiumpro__) && !defined (__pentium4__)
205 # define GUINT32_SWAP_LE_BE_IA32(val) \
207 ({ register guint32 __v, __x = ((guint32) (val)); \
208 if (__builtin_constant_p (__x)) \
209 __v = GUINT32_SWAP_LE_BE_CONSTANT (__x); \
211 __asm__ ("rorw $8, %w0\n\t" \
218 # else /* 486 and higher has bswap */
219 # define GUINT32_SWAP_LE_BE_IA32(val) \
221 ({ register guint32 __v, __x = ((guint32) (val)); \
222 if (__builtin_constant_p (__x)) \
223 __v = GUINT32_SWAP_LE_BE_CONSTANT (__x); \
225 __asm__ ("bswap %0" \
229 # endif /* processor specific 32-bit stuff */
230 # define GUINT64_SWAP_LE_BE_IA32(val) \
232 ({ union { guint64 __ll; \
233 guint32 __l[2]; } __w, __r; \
234 __w.__ll = ((guint64) (val)); \
235 if (__builtin_constant_p (__w.__ll)) \
236 __r.__ll = GUINT64_SWAP_LE_BE_CONSTANT (__w.__ll); \
239 __r.__l[0] = GUINT32_SWAP_LE_BE (__w.__l[1]); \
240 __r.__l[1] = GUINT32_SWAP_LE_BE (__w.__l[0]); \
243 /* Possibly just use the constant version and let gcc figure it out? */
244 # define GUINT16_SWAP_LE_BE(val) (GUINT16_SWAP_LE_BE_IA32 (val))
245 # ifndef GUINT32_SWAP_LE_BE
246 # define GUINT32_SWAP_LE_BE(val) (GUINT32_SWAP_LE_BE_IA32 (val))
248 # ifndef GUINT64_SWAP_LE_BE
249 # define GUINT64_SWAP_LE_BE(val) (GUINT64_SWAP_LE_BE_IA32 (val))
251 # elif defined (__ia64__)
252 # define GUINT16_SWAP_LE_BE_IA64(val) \
254 ({ register guint16 __v, __x = ((guint16) (val)); \
255 if (__builtin_constant_p (__x)) \
256 __v = GUINT16_SWAP_LE_BE_CONSTANT (__x); \
258 __asm__ __volatile__ ("shl %0 = %1, 48 ;;" \
259 "mux1 %0 = %0, @rev ;;" \
263 # define GUINT32_SWAP_LE_BE_IA64(val) \
265 ({ register guint32 __v, __x = ((guint32) (val)); \
266 if (__builtin_constant_p (__x)) \
267 __v = GUINT32_SWAP_LE_BE_CONSTANT (__x); \
269 __asm__ __volatile__ ("shl %0 = %1, 32 ;;" \
270 "mux1 %0 = %0, @rev ;;" \
274 # define GUINT64_SWAP_LE_BE_IA64(val) \
276 ({ register guint64 __v, __x = ((guint64) (val)); \
277 if (__builtin_constant_p (__x)) \
278 __v = GUINT64_SWAP_LE_BE_CONSTANT (__x); \
280 __asm__ __volatile__ ("mux1 %0 = %1, @rev ;;" \
284 # define GUINT16_SWAP_LE_BE(val) (GUINT16_SWAP_LE_BE_IA64 (val))
285 # ifndef GUINT32_SWAP_LE_BE
286 # define GUINT32_SWAP_LE_BE(val) (GUINT32_SWAP_LE_BE_IA64 (val))
288 # ifndef GUINT64_SWAP_LE_BE
289 # define GUINT64_SWAP_LE_BE(val) (GUINT64_SWAP_LE_BE_IA64 (val))
291 # elif defined (__x86_64__)
292 # define GUINT32_SWAP_LE_BE_X86_64(val) \
294 ({ register guint32 __v, __x = ((guint32) (val)); \
295 if (__builtin_constant_p (__x)) \
296 __v = GUINT32_SWAP_LE_BE_CONSTANT (__x); \
298 __asm__ ("bswapl %0" \
302 # define GUINT64_SWAP_LE_BE_X86_64(val) \
304 ({ register guint64 __v, __x = ((guint64) (val)); \
305 if (__builtin_constant_p (__x)) \
306 __v = GUINT64_SWAP_LE_BE_CONSTANT (__x); \
308 __asm__ ("bswapq %0" \
312 /* gcc seems to figure out optimal code for this on its own */
313 # define GUINT16_SWAP_LE_BE(val) (GUINT16_SWAP_LE_BE_CONSTANT (val))
314 # ifndef GUINT32_SWAP_LE_BE
315 # define GUINT32_SWAP_LE_BE(val) (GUINT32_SWAP_LE_BE_X86_64 (val))
317 # ifndef GUINT64_SWAP_LE_BE
318 # define GUINT64_SWAP_LE_BE(val) (GUINT64_SWAP_LE_BE_X86_64 (val))
320 # else /* generic gcc */
321 # define GUINT16_SWAP_LE_BE(val) (GUINT16_SWAP_LE_BE_CONSTANT (val))
322 # ifndef GUINT32_SWAP_LE_BE
323 # define GUINT32_SWAP_LE_BE(val) (GUINT32_SWAP_LE_BE_CONSTANT (val))
325 # ifndef GUINT64_SWAP_LE_BE
326 # define GUINT64_SWAP_LE_BE(val) (GUINT64_SWAP_LE_BE_CONSTANT (val))
330 # define GUINT16_SWAP_LE_BE(val) (GUINT16_SWAP_LE_BE_CONSTANT (val))
331 # define GUINT32_SWAP_LE_BE(val) (GUINT32_SWAP_LE_BE_CONSTANT (val))
332 # define GUINT64_SWAP_LE_BE(val) (GUINT64_SWAP_LE_BE_CONSTANT (val))
335 #define GUINT16_SWAP_LE_PDP(val) ((guint16) (val))
336 #define GUINT16_SWAP_BE_PDP(val) (GUINT16_SWAP_LE_BE (val))
337 #define GUINT32_SWAP_LE_PDP(val) ((guint32) ( \
338 (((guint32) (val) & (guint32) 0x0000ffffU) << 16) | \
339 (((guint32) (val) & (guint32) 0xffff0000U) >> 16)))
340 #define GUINT32_SWAP_BE_PDP(val) ((guint32) ( \
341 (((guint32) (val) & (guint32) 0x00ff00ffU) << 8) | \
342 (((guint32) (val) & (guint32) 0xff00ff00U) >> 8)))
344 /* The G*_TO_?E() macros are defined in glibconfig.h.
345 * The transformation is symmetric, so the FROM just maps to the TO.
347 #define GINT16_FROM_LE(val) (GINT16_TO_LE (val))
348 #define GUINT16_FROM_LE(val) (GUINT16_TO_LE (val))
349 #define GINT16_FROM_BE(val) (GINT16_TO_BE (val))
350 #define GUINT16_FROM_BE(val) (GUINT16_TO_BE (val))
351 #define GINT32_FROM_LE(val) (GINT32_TO_LE (val))
352 #define GUINT32_FROM_LE(val) (GUINT32_TO_LE (val))
353 #define GINT32_FROM_BE(val) (GINT32_TO_BE (val))
354 #define GUINT32_FROM_BE(val) (GUINT32_TO_BE (val))
356 #define GINT64_FROM_LE(val) (GINT64_TO_LE (val))
357 #define GUINT64_FROM_LE(val) (GUINT64_TO_LE (val))
358 #define GINT64_FROM_BE(val) (GINT64_TO_BE (val))
359 #define GUINT64_FROM_BE(val) (GUINT64_TO_BE (val))
361 #define GLONG_FROM_LE(val) (GLONG_TO_LE (val))
362 #define GULONG_FROM_LE(val) (GULONG_TO_LE (val))
363 #define GLONG_FROM_BE(val) (GLONG_TO_BE (val))
364 #define GULONG_FROM_BE(val) (GULONG_TO_BE (val))
366 #define GINT_FROM_LE(val) (GINT_TO_LE (val))
367 #define GUINT_FROM_LE(val) (GUINT_TO_LE (val))
368 #define GINT_FROM_BE(val) (GINT_TO_BE (val))
369 #define GUINT_FROM_BE(val) (GUINT_TO_BE (val))
371 #define GSIZE_FROM_LE(val) (GSIZE_TO_LE (val))
372 #define GSSIZE_FROM_LE(val) (GSSIZE_TO_LE (val))
373 #define GSIZE_FROM_BE(val) (GSIZE_TO_BE (val))
374 #define GSSIZE_FROM_BE(val) (GSSIZE_TO_BE (val))
377 /* Portable versions of host-network order stuff
379 #define g_ntohl(val) (GUINT32_FROM_BE (val))
380 #define g_ntohs(val) (GUINT16_FROM_BE (val))
381 #define g_htonl(val) (GUINT32_TO_BE (val))
382 #define g_htons(val) (GUINT16_TO_BE (val))
384 /* IEEE Standard 754 Single Precision Storage Format (gfloat):
387 * +--------+---------------+---------------+
388 * | s 1bit | e[30:23] 8bit | f[22:0] 23bit |
389 * +--------+---------------+---------------+
390 * B0------------------->B1------->B2-->B3-->
392 * IEEE Standard 754 Double Precision Storage Format (gdouble):
394 * 63 62 52 51 32 31 0
395 * +--------+----------------+----------------+ +---------------+
396 * | s 1bit | e[62:52] 11bit | f[51:32] 20bit | | f[31:0] 32bit |
397 * +--------+----------------+----------------+ +---------------+
398 * B0--------------->B1---------->B2--->B3----> B4->B5->B6->B7->
400 /* subtract from biased_exponent to form base2 exponent (normal numbers) */
401 typedef union _GDoubleIEEE754 GDoubleIEEE754
;
402 typedef union _GFloatIEEE754 GFloatIEEE754
;
403 #define G_IEEE754_FLOAT_BIAS (127)
404 #define G_IEEE754_DOUBLE_BIAS (1023)
405 /* multiply with base2 exponent to get base10 exponent (normal numbers) */
406 #define G_LOG_2_BASE_10 (0.30102999566398119521)
407 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
413 guint biased_exponent
: 8;
417 union _GDoubleIEEE754
421 guint mantissa_low
: 32;
422 guint mantissa_high
: 20;
423 guint biased_exponent
: 11;
427 #elif G_BYTE_ORDER == G_BIG_ENDIAN
433 guint biased_exponent
: 8;
437 union _GDoubleIEEE754
442 guint biased_exponent
: 11;
443 guint mantissa_high
: 20;
444 guint mantissa_low
: 32;
447 #else /* !G_LITTLE_ENDIAN && !G_BIG_ENDIAN */
448 #error unknown ENDIAN type
449 #endif /* !G_LITTLE_ENDIAN && !G_BIG_ENDIAN */
451 typedef struct _GTimeVal GTimeVal
;
461 /* We prefix variable declarations so they can
462 * properly get exported in Windows DLLs.
465 # ifdef G_PLATFORM_WIN32
466 # ifdef GLIB_STATIC_COMPILATION
467 # define GLIB_VAR extern
468 # else /* !GLIB_STATIC_COMPILATION */
469 # ifdef GLIB_COMPILATION
471 # define GLIB_VAR __declspec(dllexport)
472 # else /* !DLL_EXPORT */
473 # define GLIB_VAR extern
474 # endif /* !DLL_EXPORT */
475 # else /* !GLIB_COMPILATION */
476 # define GLIB_VAR extern __declspec(dllimport)
477 # endif /* !GLIB_COMPILATION */
478 # endif /* !GLIB_STATIC_COMPILATION */
479 # else /* !G_PLATFORM_WIN32 */
480 # define GLIB_VAR _GLIB_EXTERN
481 # endif /* !G_PLATFORM_WIN32 */
482 #endif /* GLIB_VAR */
484 #endif /* __G_TYPES_H__ */