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 Library 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 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library 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-1999. 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 /* system specific config file glibconfig.h provides definitions for
31 * the extrema of many of the standard types. These are:
33 * G_MINSHORT, G_MAXSHORT
35 * G_MINLONG, G_MAXLONG
36 * G_MINFLOAT, G_MAXFLOAT
37 * G_MINDOUBLE, G_MAXDOUBLE
39 * It also provides the following typedefs:
46 * It defines the G_BYTE_ORDER symbol to one of G_*_ENDIAN (see later in
49 * And it provides a way to store and retrieve a `gint' in/from a `gpointer'.
50 * This is useful to pass an integer instead of a pointer to a callback.
52 * GINT_TO_POINTER (i), GUINT_TO_POINTER (i)
53 * GPOINTER_TO_INT (p), GPOINTER_TO_UINT (p)
55 * Finally, it provides the following wrappers to STDC functions:
57 * void g_memmove (gpointer dest, gconstpointer void *src, gulong count);
58 * A wrapper for STDC memmove, or an implementation, if memmove doesn't
59 * exist. The prototype looks like the above, give or take a const,
62 #include <glibconfig.h>
64 /* include varargs functions for assertment macros
68 /* optionally feature DMALLOC memory allocation debugger
77 /* On native Win32, directory separator is the backslash, and search path
78 * separator is the semicolon.
80 #define G_DIR_SEPARATOR '\\'
81 #define G_DIR_SEPARATOR_S "\\"
82 #define G_SEARCHPATH_SEPARATOR ';'
83 #define G_SEARCHPATH_SEPARATOR_S ";"
85 #else /* !G_OS_WIN32 */
89 #define G_DIR_SEPARATOR '/'
90 #define G_DIR_SEPARATOR_S "/"
91 #define G_SEARCHPATH_SEPARATOR ':'
92 #define G_SEARCHPATH_SEPARATOR_S ":"
94 #endif /* !G_OS_WIN32 */
98 #endif /* __cplusplus */
101 /* Provide definitions for some commonly used macros.
102 * Some of them are only provided if they haven't already
103 * been defined. It is assumed that if they are already
104 * defined then the current definition is correct.
109 # else /* !__cplusplus */
110 # define NULL ((void*) 0)
111 # endif /* !__cplusplus */
119 #define TRUE (!FALSE)
123 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
126 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
129 #define ABS(a) (((a) < 0) ? -(a) : (a))
132 #define CLAMP(x, low, high) (((x) > (high)) ? (high) : (((x) < (low)) ? (low) : (x)))
134 #define G_STRINGIFY(macro_or_string) G_STRINGIFY_ARG (macro_or_string)
135 #define G_STRINGIFY_ARG(contents) #contents
137 /* Count the number of elements in an array. The array must be defined
138 * as such; using this with a dynamically allocated array will give
141 #define G_N_ELEMENTS(arr) (sizeof (arr) / sizeof ((arr)[0]))
143 /* Define G_VA_COPY() to do the right thing for copying va_list variables.
144 * glibconfig.h may have already defined G_VA_COPY as va_copy or __va_copy.
146 #if !defined (G_VA_COPY)
147 # if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
148 # define G_VA_COPY(ap1, ap2) (*(ap1) = *(ap2))
149 # elif defined (G_VA_COPY_AS_ARRAY)
150 # define G_VA_COPY(ap1, ap2) g_memmove ((ap1), (ap2), sizeof (va_list))
151 # else /* va_list is a pointer */
152 # define G_VA_COPY(ap1, ap2) ((ap1) = (ap2))
153 # endif /* va_list is a pointer */
154 #endif /* !G_VA_COPY */
157 /* Provide convenience macros for handling structure
158 * fields through their offsets.
160 #define G_STRUCT_OFFSET(struct_type, member) \
161 ((gulong) ((gchar*) &((struct_type*) 0)->member))
162 #define G_STRUCT_MEMBER_P(struct_p, struct_offset) \
163 ((gpointer) ((gchar*) (struct_p) + (gulong) (struct_offset)))
164 #define G_STRUCT_MEMBER(member_type, struct_p, struct_offset) \
165 (*(member_type*) G_STRUCT_MEMBER_P ((struct_p), (struct_offset)))
168 /* inlining hassle. for compilers that don't allow the `inline' keyword,
169 * mostly because of strict ANSI C compliance or dumbness, we try to fall
170 * back to either `__inline__' or `__inline'.
171 * we define G_CAN_INLINE, if the compiler seems to be actually
172 * *capable* to do function inlining, in which case inline function bodys
173 * do make sense. we also define G_INLINE_FUNC to properly export the
174 * function prototypes if no inlining can be performed.
175 * we special case most of the stuff, so inline functions can have a normal
176 * implementation by defining G_INLINE_FUNC to extern and G_CAN_INLINE to 1.
178 #ifndef G_INLINE_FUNC
179 # define G_CAN_INLINE 1
182 # if defined (__GNUC__) && defined (__STRICT_ANSI__)
184 # define inline __inline__
186 #else /* !G_HAVE_INLINE */
188 # if defined (G_HAVE___INLINE__)
189 # define inline __inline__
190 # else /* !inline && !__inline__ */
191 # if defined (G_HAVE___INLINE)
192 # define inline __inline
193 # else /* !inline && !__inline__ && !__inline */
194 # define inline /* don't inline, then */
195 # ifndef G_INLINE_FUNC
201 #ifndef G_INLINE_FUNC
204 # define G_INLINE_FUNC extern inline
207 # define G_INLINE_FUNC extern
209 # else /* !__GNUC__ */
211 # define G_INLINE_FUNC static inline
213 # define G_INLINE_FUNC extern
215 # endif /* !__GNUC__ */
216 #endif /* !G_INLINE_FUNC */
219 /* Provide simple macro statement wrappers (adapted from Perl):
220 * G_STMT_START { statements; } G_STMT_END;
221 * can be used as a single statement, as in
222 * if (x) G_STMT_START { ... } G_STMT_END; else ...
224 * For gcc we will wrap the statements within `({' and `})' braces.
225 * For SunOS they will be wrapped within `if (1)' and `else (void) 0',
226 * and otherwise within `do' and `while (0)'.
228 #if !(defined (G_STMT_START) && defined (G_STMT_END))
229 # if defined (__GNUC__) && !defined (__STRICT_ANSI__) && !defined (__cplusplus)
230 # define G_STMT_START (void)(
231 # define G_STMT_END )
233 # if (defined (sun) || defined (__sun__))
234 # define G_STMT_START if (1)
235 # define G_STMT_END else (void)0
237 # define G_STMT_START do
238 # define G_STMT_END while (0)
244 /* Provide macros to feature the GCC function attribute.
246 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
247 #define G_GNUC_PRINTF( format_idx, arg_idx ) \
248 __attribute__((format (printf, format_idx, arg_idx)))
249 #define G_GNUC_SCANF( format_idx, arg_idx ) \
250 __attribute__((format (scanf, format_idx, arg_idx)))
251 #define G_GNUC_FORMAT( arg_idx ) \
252 __attribute__((format_arg (arg_idx)))
253 #define G_GNUC_NORETURN \
254 __attribute__((noreturn))
255 #define G_GNUC_CONST \
256 __attribute__((const))
257 #define G_GNUC_UNUSED \
258 __attribute__((unused))
259 #else /* !__GNUC__ */
260 #define G_GNUC_PRINTF( format_idx, arg_idx )
261 #define G_GNUC_SCANF( format_idx, arg_idx )
262 #define G_GNUC_FORMAT( arg_idx )
263 #define G_GNUC_NORETURN
265 #define G_GNUC_UNUSED
266 #endif /* !__GNUC__ */
269 /* Wrap the gcc __PRETTY_FUNCTION__ and __FUNCTION__ variables with
270 * macros, so we can refer to them as strings unconditionally.
273 #define G_GNUC_FUNCTION __FUNCTION__
274 #define G_GNUC_PRETTY_FUNCTION __PRETTY_FUNCTION__
275 #else /* !__GNUC__ */
276 #define G_GNUC_FUNCTION ""
277 #define G_GNUC_PRETTY_FUNCTION ""
278 #endif /* !__GNUC__ */
280 /* we try to provide a usefull equivalent for ATEXIT if it is
281 * not defined, but use is actually abandoned. people should
282 * use g_atexit() instead.
285 # define ATEXIT(proc) g_ATEXIT(proc)
287 # define G_NATIVE_ATEXIT
290 /* Hacker macro to place breakpoints for elected machines.
291 * Actual use is strongly deprecated of course ;)
293 #if defined (__i386__) && defined (__GNUC__) && __GNUC__ >= 2
294 #define G_BREAKPOINT() G_STMT_START{ __asm__ __volatile__ ("int $03"); }G_STMT_END
295 #elif defined (__alpha__) && defined (__GNUC__) && __GNUC__ >= 2
296 #define G_BREAKPOINT() G_STMT_START{ __asm__ __volatile__ ("bpt"); }G_STMT_END
297 #else /* !__i386__ && !__alpha__ */
298 #define G_BREAKPOINT()
299 #endif /* __i386__ */
302 /* Provide macros for easily allocating memory. The macros
303 * will cast the allocated memory to the specified type
304 * in order to avoid compiler warnings. (Makes the code neater).
308 # define g_new(type, count) (ALLOC (type, count))
309 # define g_new0(type, count) (CALLOC (type, count))
310 # define g_renew(type, mem, count) (REALLOC (mem, type, count))
311 #else /* __DMALLOC_H__ */
312 # define g_new(type, count) \
313 ((type *) g_malloc ((unsigned) sizeof (type) * (count)))
314 # define g_new0(type, count) \
315 ((type *) g_malloc0 ((unsigned) sizeof (type) * (count)))
316 # define g_renew(type, mem, count) \
317 ((type *) g_realloc (mem, (unsigned) sizeof (type) * (count)))
318 #endif /* __DMALLOC_H__ */
320 #define g_mem_chunk_create(type, pre_alloc, alloc_type) ( \
321 g_mem_chunk_new (#type " mem chunks (" #pre_alloc ")", \
323 sizeof (type) * (pre_alloc), \
326 #define g_chunk_new(type, chunk) ( \
327 (type *) g_mem_chunk_alloc (chunk) \
329 #define g_chunk_new0(type, chunk) ( \
330 (type *) g_mem_chunk_alloc0 (chunk) \
332 #define g_chunk_free(mem, mem_chunk) G_STMT_START { \
333 g_mem_chunk_free ((mem_chunk), (mem)); \
337 /* Provide macros for error handling. The "assert" macros will
338 * exit on failure. The "return" macros will exit the current
339 * function. Two different definitions are given for the macros
340 * if G_DISABLE_ASSERT is not defined, in order to support gcc's
341 * __PRETTY_FUNCTION__ capability.
344 #ifdef G_DISABLE_ASSERT
346 #define g_assert(expr)
347 #define g_assert_not_reached()
349 #else /* !G_DISABLE_ASSERT */
353 #define g_assert(expr) G_STMT_START{ \
355 g_log (G_LOG_DOMAIN, \
357 "file %s: line %d (%s): assertion failed: (%s)", \
360 __PRETTY_FUNCTION__, \
363 #define g_assert_not_reached() G_STMT_START{ \
364 g_log (G_LOG_DOMAIN, \
366 "file %s: line %d (%s): should not be reached", \
369 __PRETTY_FUNCTION__); }G_STMT_END
371 #else /* !__GNUC__ */
373 #define g_assert(expr) G_STMT_START{ \
375 g_log (G_LOG_DOMAIN, \
377 "file %s: line %d: assertion failed: (%s)", \
382 #define g_assert_not_reached() G_STMT_START{ \
383 g_log (G_LOG_DOMAIN, \
385 "file %s: line %d: should not be reached", \
387 __LINE__); }G_STMT_END
389 #endif /* __GNUC__ */
391 #endif /* !G_DISABLE_ASSERT */
394 #ifdef G_DISABLE_CHECKS
396 #define g_return_if_fail(expr)
397 #define g_return_val_if_fail(expr,val)
399 #else /* !G_DISABLE_CHECKS */
403 #define g_return_if_fail(expr) G_STMT_START{ \
406 g_log (G_LOG_DOMAIN, \
407 G_LOG_LEVEL_CRITICAL, \
408 "file %s: line %d (%s): assertion `%s' failed.", \
411 __PRETTY_FUNCTION__, \
416 #define g_return_val_if_fail(expr,val) G_STMT_START{ \
419 g_log (G_LOG_DOMAIN, \
420 G_LOG_LEVEL_CRITICAL, \
421 "file %s: line %d (%s): assertion `%s' failed.", \
424 __PRETTY_FUNCTION__, \
429 #else /* !__GNUC__ */
431 #define g_return_if_fail(expr) G_STMT_START{ \
434 g_log (G_LOG_DOMAIN, \
435 G_LOG_LEVEL_CRITICAL, \
436 "file %s: line %d: assertion `%s' failed.", \
443 #define g_return_val_if_fail(expr, val) G_STMT_START{ \
446 g_log (G_LOG_DOMAIN, \
447 G_LOG_LEVEL_CRITICAL, \
448 "file %s: line %d: assertion `%s' failed.", \
455 #endif /* !__GNUC__ */
457 #endif /* !G_DISABLE_CHECKS */
460 /* Provide type definitions for commonly used types.
461 * These are useful because a "gint8" can be adjusted
462 * to be 1 byte (8 bits) on all platforms. Similarly and
463 * more importantly, "gint32" can be adjusted to be
464 * 4 bytes (32 bits) on all platforms.
468 typedef short gshort;
471 typedef gint gboolean;
473 typedef unsigned char guchar;
474 typedef unsigned short gushort;
475 typedef unsigned long gulong;
476 typedef unsigned int guint;
478 #define G_GSHORT_FORMAT "hi"
479 #define G_GUSHORT_FORMAT "hu"
480 #define G_GINT_FORMAT "i"
481 #define G_GUINT_FORMAT "u"
482 #define G_GLONG_FORMAT "li"
483 #define G_GULONG_FORMAT "lu"
485 typedef float gfloat;
486 typedef double gdouble;
488 /* HAVE_LONG_DOUBLE doesn't work correctly on all platforms.
489 * Since gldouble isn't used anywhere, just disable it for now */
492 #ifdef HAVE_LONG_DOUBLE
493 typedef long double gldouble;
494 #else /* HAVE_LONG_DOUBLE */
495 typedef double gldouble;
496 #endif /* HAVE_LONG_DOUBLE */
499 typedef void* gpointer;
500 typedef const void *gconstpointer;
503 typedef gint32 gssize;
504 typedef guint32 gsize;
505 typedef guint32 GQuark;
506 typedef gint32 GTime;
509 /* Portable endian checks and conversions
511 * glibconfig.h defines G_BYTE_ORDER which expands to one of
514 #define G_LITTLE_ENDIAN 1234
515 #define G_BIG_ENDIAN 4321
516 #define G_PDP_ENDIAN 3412 /* unused, need specific PDP check */
519 /* Basic bit swapping functions
521 #define GUINT16_SWAP_LE_BE_CONSTANT(val) ((guint16) ( \
522 (((guint16) (val) & (guint16) 0x00ffU) << 8) | \
523 (((guint16) (val) & (guint16) 0xff00U) >> 8)))
524 #define GUINT32_SWAP_LE_BE_CONSTANT(val) ((guint32) ( \
525 (((guint32) (val) & (guint32) 0x000000ffU) << 24) | \
526 (((guint32) (val) & (guint32) 0x0000ff00U) << 8) | \
527 (((guint32) (val) & (guint32) 0x00ff0000U) >> 8) | \
528 (((guint32) (val) & (guint32) 0xff000000U) >> 24)))
530 /* Intel specific stuff for speed
532 #if defined (__i386__) && defined (__GNUC__) && __GNUC__ >= 2
533 # define GUINT16_SWAP_LE_BE_X86(val) \
535 ({ register guint16 __v; \
536 if (__builtin_constant_p (val)) \
537 __v = GUINT16_SWAP_LE_BE_CONSTANT (val); \
539 __asm__ __const__ ("rorw $8, %w0" \
541 : "0" ((guint16) (val))); \
543 # define GUINT16_SWAP_LE_BE(val) (GUINT16_SWAP_LE_BE_X86 (val))
544 # if !defined(__i486__) && !defined(__i586__) \
545 && !defined(__pentium__) && !defined(__i686__) && !defined(__pentiumpro__)
546 # define GUINT32_SWAP_LE_BE_X86(val) \
548 ({ register guint32 __v; \
549 if (__builtin_constant_p (val)) \
550 __v = GUINT32_SWAP_LE_BE_CONSTANT (val); \
552 __asm__ __const__ ("rorw $8, %w0\n\t" \
556 : "0" ((guint32) (val))); \
558 # else /* 486 and higher has bswap */
559 # define GUINT32_SWAP_LE_BE_X86(val) \
561 ({ register guint32 __v; \
562 if (__builtin_constant_p (val)) \
563 __v = GUINT32_SWAP_LE_BE_CONSTANT (val); \
565 __asm__ __const__ ("bswap %0" \
567 : "0" ((guint32) (val))); \
569 # endif /* processor specific 32-bit stuff */
570 # define GUINT32_SWAP_LE_BE(val) (GUINT32_SWAP_LE_BE_X86 (val))
571 #else /* !__i386__ */
572 # define GUINT16_SWAP_LE_BE(val) (GUINT16_SWAP_LE_BE_CONSTANT (val))
573 # define GUINT32_SWAP_LE_BE(val) (GUINT32_SWAP_LE_BE_CONSTANT (val))
574 #endif /* __i386__ */
577 # define GUINT64_SWAP_LE_BE_CONSTANT(val) ((guint64) ( \
578 (((guint64) (val) & \
579 (guint64) G_GINT64_CONSTANT(0x00000000000000ffU)) << 56) | \
580 (((guint64) (val) & \
581 (guint64) G_GINT64_CONSTANT(0x000000000000ff00U)) << 40) | \
582 (((guint64) (val) & \
583 (guint64) G_GINT64_CONSTANT(0x0000000000ff0000U)) << 24) | \
584 (((guint64) (val) & \
585 (guint64) G_GINT64_CONSTANT(0x00000000ff000000U)) << 8) | \
586 (((guint64) (val) & \
587 (guint64) G_GINT64_CONSTANT(0x000000ff00000000U)) >> 8) | \
588 (((guint64) (val) & \
589 (guint64) G_GINT64_CONSTANT(0x0000ff0000000000U)) >> 24) | \
590 (((guint64) (val) & \
591 (guint64) G_GINT64_CONSTANT(0x00ff000000000000U)) >> 40) | \
592 (((guint64) (val) & \
593 (guint64) G_GINT64_CONSTANT(0xff00000000000000U)) >> 56)))
594 # if defined (__i386__) && defined (__GNUC__) && __GNUC__ >= 2
595 # define GUINT64_SWAP_LE_BE_X86(val) \
597 ({ union { guint64 __ll; \
598 guint32 __l[2]; } __r; \
599 if (__builtin_constant_p (val)) \
600 __r.__ll = GUINT64_SWAP_LE_BE_CONSTANT (val); \
603 union { guint64 __ll; \
604 guint32 __l[2]; } __w; \
605 __w.__ll = ((guint64) val); \
606 __r.__l[0] = GUINT32_SWAP_LE_BE (__w.__l[1]); \
607 __r.__l[1] = GUINT32_SWAP_LE_BE (__w.__l[0]); \
610 # define GUINT64_SWAP_LE_BE(val) (GUINT64_SWAP_LE_BE_X86 (val))
611 # else /* !__i386__ */
612 # define GUINT64_SWAP_LE_BE(val) (GUINT64_SWAP_LE_BE_CONSTANT(val))
616 #define GUINT16_SWAP_LE_PDP(val) ((guint16) (val))
617 #define GUINT16_SWAP_BE_PDP(val) (GUINT16_SWAP_LE_BE (val))
618 #define GUINT32_SWAP_LE_PDP(val) ((guint32) ( \
619 (((guint32) (val) & (guint32) 0x0000ffffU) << 16) | \
620 (((guint32) (val) & (guint32) 0xffff0000U) >> 16)))
621 #define GUINT32_SWAP_BE_PDP(val) ((guint32) ( \
622 (((guint32) (val) & (guint32) 0x00ff00ffU) << 8) | \
623 (((guint32) (val) & (guint32) 0xff00ff00U) >> 8)))
625 /* The G*_TO_?E() macros are defined in glibconfig.h.
626 * The transformation is symmetric, so the FROM just maps to the TO.
628 #define GINT16_FROM_LE(val) (GINT16_TO_LE (val))
629 #define GUINT16_FROM_LE(val) (GUINT16_TO_LE (val))
630 #define GINT16_FROM_BE(val) (GINT16_TO_BE (val))
631 #define GUINT16_FROM_BE(val) (GUINT16_TO_BE (val))
632 #define GINT32_FROM_LE(val) (GINT32_TO_LE (val))
633 #define GUINT32_FROM_LE(val) (GUINT32_TO_LE (val))
634 #define GINT32_FROM_BE(val) (GINT32_TO_BE (val))
635 #define GUINT32_FROM_BE(val) (GUINT32_TO_BE (val))
638 #define GINT64_FROM_LE(val) (GINT64_TO_LE (val))
639 #define GUINT64_FROM_LE(val) (GUINT64_TO_LE (val))
640 #define GINT64_FROM_BE(val) (GINT64_TO_BE (val))
641 #define GUINT64_FROM_BE(val) (GUINT64_TO_BE (val))
644 #define GLONG_FROM_LE(val) (GLONG_TO_LE (val))
645 #define GULONG_FROM_LE(val) (GULONG_TO_LE (val))
646 #define GLONG_FROM_BE(val) (GLONG_TO_BE (val))
647 #define GULONG_FROM_BE(val) (GULONG_TO_BE (val))
649 #define GINT_FROM_LE(val) (GINT_TO_LE (val))
650 #define GUINT_FROM_LE(val) (GUINT_TO_LE (val))
651 #define GINT_FROM_BE(val) (GINT_TO_BE (val))
652 #define GUINT_FROM_BE(val) (GUINT_TO_BE (val))
655 /* Portable versions of host-network order stuff
657 #define g_ntohl(val) (GUINT32_FROM_BE (val))
658 #define g_ntohs(val) (GUINT16_FROM_BE (val))
659 #define g_htonl(val) (GUINT32_TO_BE (val))
660 #define g_htons(val) (GUINT16_TO_BE (val))
664 * we prefix variable declarations so they can
665 * properly get exported in windows dlls.
668 # ifdef GLIB_COMPILATION
669 # define GUTILS_C_VAR __declspec(dllexport)
670 # else /* !GLIB_COMPILATION */
671 # define GUTILS_C_VAR extern __declspec(dllimport)
672 # endif /* !GLIB_COMPILATION */
673 #else /* !G_OS_WIN32 */
674 # define GUTILS_C_VAR extern
675 #endif /* !G_OS_WIN32 */
677 GUTILS_C_VAR const guint glib_major_version;
678 GUTILS_C_VAR const guint glib_minor_version;
679 GUTILS_C_VAR const guint glib_micro_version;
680 GUTILS_C_VAR const guint glib_interface_age;
681 GUTILS_C_VAR const guint glib_binary_age;
683 #define GLIB_CHECK_VERSION(major,minor,micro) \
684 (GLIB_MAJOR_VERSION > (major) || \
685 (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION > (minor)) || \
686 (GLIB_MAJOR_VERSION == (major) && GLIB_MINOR_VERSION == (minor) && \
687 GLIB_MICRO_VERSION >= (micro)))
689 /* Forward declarations of glib types.
691 typedef struct _GAllocator GAllocator;
692 typedef struct _GArray GArray;
693 typedef struct _GByteArray GByteArray;
694 typedef struct _GCache GCache;
695 typedef struct _GCompletion GCompletion;
696 typedef struct _GData GData;
697 typedef struct _GDebugKey GDebugKey;
698 typedef union _GDoubleIEEE754 GDoubleIEEE754;
699 typedef union _GFloatIEEE754 GFloatIEEE754;
700 typedef struct _GHashTable GHashTable;
701 typedef struct _GHook GHook;
702 typedef struct _GHookList GHookList;
703 typedef struct _GList GList;
704 typedef struct _GMemChunk GMemChunk;
705 typedef struct _GNode GNode;
706 typedef struct _GPtrArray GPtrArray;
707 typedef struct _GQueue GQueue;
708 typedef struct _GRand GRand;
709 typedef struct _GRelation GRelation;
710 typedef struct _GScanner GScanner;
711 typedef struct _GScannerConfig GScannerConfig;
712 typedef struct _GSList GSList;
713 typedef struct _GString GString;
714 typedef struct _GStringChunk GStringChunk;
715 typedef struct _GTimer GTimer;
716 typedef struct _GTrashStack GTrashStack;
717 typedef struct _GTree GTree;
718 typedef struct _GTuples GTuples;
719 typedef union _GTokenValue GTokenValue;
720 typedef struct _GIOChannel GIOChannel;
722 /* Tree traverse flags */
725 G_TRAVERSE_LEAFS = 1 << 0,
726 G_TRAVERSE_NON_LEAFS = 1 << 1,
727 G_TRAVERSE_ALL = G_TRAVERSE_LEAFS | G_TRAVERSE_NON_LEAFS,
728 G_TRAVERSE_MASK = 0x03
731 /* Tree traverse orders */
740 /* Log level shift offset for user defined
741 * log levels (0-7 are used by GLib).
743 #define G_LOG_LEVEL_USER_SHIFT (8)
745 /* Glib log levels and flags.
750 G_LOG_FLAG_RECURSION = 1 << 0,
751 G_LOG_FLAG_FATAL = 1 << 1,
753 /* GLib log levels */
754 G_LOG_LEVEL_ERROR = 1 << 2, /* always fatal */
755 G_LOG_LEVEL_CRITICAL = 1 << 3,
756 G_LOG_LEVEL_WARNING = 1 << 4,
757 G_LOG_LEVEL_MESSAGE = 1 << 5,
758 G_LOG_LEVEL_INFO = 1 << 6,
759 G_LOG_LEVEL_DEBUG = 1 << 7,
761 G_LOG_LEVEL_MASK = ~(G_LOG_FLAG_RECURSION | G_LOG_FLAG_FATAL)
764 /* GLib log levels that are considered fatal by default */
765 #define G_LOG_FATAL_MASK (G_LOG_FLAG_RECURSION | G_LOG_LEVEL_ERROR)
768 typedef gpointer (*GCacheNewFunc) (gpointer key);
769 typedef gpointer (*GCacheDupFunc) (gpointer value);
770 typedef void (*GCacheDestroyFunc) (gpointer value);
771 typedef gint (*GCompareFunc) (gconstpointer a,
773 typedef gchar* (*GCompletionFunc) (gpointer);
774 typedef void (*GDestroyNotify) (gpointer data);
775 typedef void (*GDataForeachFunc) (GQuark key_id,
778 typedef void (*GFunc) (gpointer data,
780 typedef guint (*GHashFunc) (gconstpointer key);
781 typedef void (*GFreeFunc) (gpointer data);
782 typedef void (*GHFunc) (gpointer key,
785 typedef gboolean (*GHRFunc) (gpointer key,
788 typedef gint (*GHookCompareFunc) (GHook *new_hook,
790 typedef gboolean (*GHookFindFunc) (GHook *hook,
792 typedef void (*GHookMarshaller) (GHook *hook,
794 typedef gboolean (*GHookCheckMarshaller) (GHook *hook,
796 typedef void (*GHookFunc) (gpointer data);
797 typedef gboolean (*GHookCheckFunc) (gpointer data);
798 typedef void (*GHookFreeFunc) (GHookList *hook_list,
800 typedef void (*GLogFunc) (const gchar *log_domain,
801 GLogLevelFlags log_level,
802 const gchar *message,
804 typedef gboolean (*GNodeTraverseFunc) (GNode *node,
806 typedef void (*GNodeForeachFunc) (GNode *node,
808 typedef gint (*GSearchFunc) (gpointer key,
810 typedef void (*GScannerMsgFunc) (GScanner *scanner,
813 typedef gint (*GTraverseFunc) (gpointer key,
816 typedef void (*GVoidFunc) (void);
880 /* IEEE Standard 754 Single Precision Storage Format (gfloat):
883 * +--------+---------------+---------------+
884 * | s 1bit | e[30:23] 8bit | f[22:0] 23bit |
885 * +--------+---------------+---------------+
886 * B0------------------->B1------->B2-->B3-->
888 * IEEE Standard 754 Double Precision Storage Format (gdouble):
890 * 63 62 52 51 32 31 0
891 * +--------+----------------+----------------+ +---------------+
892 * | s 1bit | e[62:52] 11bit | f[51:32] 20bit | | f[31:0] 32bit |
893 * +--------+----------------+----------------+ +---------------+
894 * B0--------------->B1---------->B2--->B3----> B4->B5->B6->B7->
896 /* subtract from biased_exponent to form base2 exponent (normal numbers) */
897 #define G_IEEE754_FLOAT_BIAS (127)
898 #define G_IEEE754_DOUBLE_BIAS (1023)
899 /* multiply with base2 exponent to get base10 exponent (nomal numbers) */
900 #define G_LOG_2_BASE_10 (0.30102999566398119521)
901 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
907 guint biased_exponent : 8;
911 union _GDoubleIEEE754
915 guint mantissa_low : 32;
916 guint mantissa_high : 20;
917 guint biased_exponent : 11;
921 #elif G_BYTE_ORDER == G_BIG_ENDIAN
927 guint biased_exponent : 8;
931 union _GDoubleIEEE754
936 guint biased_exponent : 11;
937 guint mantissa_high : 20;
938 guint mantissa_low : 32;
941 #else /* !G_LITTLE_ENDIAN && !G_BIG_ENDIAN */
942 #error unknown ENDIAN type
943 #endif /* !G_LITTLE_ENDIAN && !G_BIG_ENDIAN */
946 /* Doubly linked lists
948 void g_list_push_allocator (GAllocator *allocator);
949 void g_list_pop_allocator (void);
950 GList* g_list_alloc (void);
951 void g_list_free (GList *list);
952 void g_list_free_1 (GList *list);
953 GList* g_list_append (GList *list,
955 GList* g_list_prepend (GList *list,
957 GList* g_list_insert (GList *list,
960 GList* g_list_insert_sorted (GList *list,
963 GList* g_list_concat (GList *list1,
965 GList* g_list_remove (GList *list,
967 GList* g_list_remove_link (GList *list,
969 GList* g_list_delete_link (GList *list,
971 GList* g_list_reverse (GList *list);
972 GList* g_list_copy (GList *list);
973 GList* g_list_nth (GList *list,
975 GList* g_list_find (GList *list,
977 GList* g_list_find_custom (GList *list,
980 gint g_list_position (GList *list,
982 gint g_list_index (GList *list,
984 GList* g_list_last (GList *list);
985 GList* g_list_first (GList *list);
986 guint g_list_length (GList *list);
987 void g_list_foreach (GList *list,
990 GList* g_list_sort (GList *list,
991 GCompareFunc compare_func);
992 gpointer g_list_nth_data (GList *list,
994 #define g_list_previous(list) ((list) ? (((GList *)(list))->prev) : NULL)
995 #define g_list_next(list) ((list) ? (((GList *)(list))->next) : NULL)
998 /* Singly linked lists
1000 void g_slist_push_allocator (GAllocator *allocator);
1001 void g_slist_pop_allocator (void);
1002 GSList* g_slist_alloc (void);
1003 void g_slist_free (GSList *list);
1004 void g_slist_free_1 (GSList *list);
1005 GSList* g_slist_append (GSList *list,
1007 GSList* g_slist_prepend (GSList *list,
1009 GSList* g_slist_insert (GSList *list,
1012 GSList* g_slist_insert_sorted (GSList *list,
1015 GSList* g_slist_concat (GSList *list1,
1017 GSList* g_slist_remove (GSList *list,
1019 GSList* g_slist_remove_link (GSList *list,
1021 GSList* g_slist_delete_link (GSList *list,
1023 GSList* g_slist_reverse (GSList *list);
1024 GSList* g_slist_copy (GSList *list);
1025 GSList* g_slist_nth (GSList *list,
1027 GSList* g_slist_find (GSList *list,
1029 GSList* g_slist_find_custom (GSList *list,
1032 gint g_slist_position (GSList *list,
1034 gint g_slist_index (GSList *list,
1036 GSList* g_slist_last (GSList *list);
1037 guint g_slist_length (GSList *list);
1038 void g_slist_foreach (GSList *list,
1040 gpointer user_data);
1041 GSList* g_slist_sort (GSList *list,
1042 GCompareFunc compare_func);
1043 gpointer g_slist_nth_data (GSList *list,
1045 #define g_slist_next(slist) ((slist) ? (((GSList *)(slist))->next) : NULL)
1050 GQueue* g_queue_create (void);
1051 void g_queue_free (GQueue *queue);
1052 void g_queue_push_head (GQueue *queue,
1054 void g_queue_push_tail (GQueue *queue,
1056 gpointer g_queue_pop_head (GQueue *queue);
1057 gpointer g_queue_pop_tail (GQueue *queue);
1058 gboolean g_queue_is_empty (GQueue *queue);
1059 gpointer g_queue_peek_head (GQueue *queue);
1060 gpointer g_queue_peek_tail (GQueue *queue);
1061 void g_queue_push_head_link (GQueue *queue,
1063 void g_queue_push_tail_link (GQueue *queue,
1065 GList* g_queue_pop_head_link (GQueue *queue);
1066 GList* g_queue_pop_tail_link (GQueue *queue);
1071 GHashTable* g_hash_table_new (GHashFunc hash_func,
1072 GCompareFunc key_compare_func);
1073 void g_hash_table_destroy (GHashTable *hash_table);
1074 void g_hash_table_insert (GHashTable *hash_table,
1077 void g_hash_table_remove (GHashTable *hash_table,
1079 gpointer g_hash_table_lookup (GHashTable *hash_table,
1081 gboolean g_hash_table_lookup_extended(GHashTable *hash_table,
1082 gconstpointer lookup_key,
1085 void g_hash_table_freeze (GHashTable *hash_table);
1086 void g_hash_table_thaw (GHashTable *hash_table);
1087 void g_hash_table_foreach (GHashTable *hash_table,
1089 gpointer user_data);
1090 guint g_hash_table_foreach_remove (GHashTable *hash_table,
1092 gpointer user_data);
1093 guint g_hash_table_size (GHashTable *hash_table);
1098 GCache* g_cache_new (GCacheNewFunc value_new_func,
1099 GCacheDestroyFunc value_destroy_func,
1100 GCacheDupFunc key_dup_func,
1101 GCacheDestroyFunc key_destroy_func,
1102 GHashFunc hash_key_func,
1103 GHashFunc hash_value_func,
1104 GCompareFunc key_compare_func);
1105 void g_cache_destroy (GCache *cache);
1106 gpointer g_cache_insert (GCache *cache,
1108 void g_cache_remove (GCache *cache,
1110 void g_cache_key_foreach (GCache *cache,
1112 gpointer user_data);
1113 void g_cache_value_foreach (GCache *cache,
1115 gpointer user_data);
1118 /* Balanced binary trees
1120 GTree* g_tree_new (GCompareFunc key_compare_func);
1121 void g_tree_destroy (GTree *tree);
1122 void g_tree_insert (GTree *tree,
1125 void g_tree_remove (GTree *tree,
1127 gpointer g_tree_lookup (GTree *tree,
1129 void g_tree_traverse (GTree *tree,
1130 GTraverseFunc traverse_func,
1131 GTraverseType traverse_type,
1133 gpointer g_tree_search (GTree *tree,
1134 GSearchFunc search_func,
1136 gint g_tree_height (GTree *tree);
1137 gint g_tree_nnodes (GTree *tree);
1141 /* N-way tree implementation
1152 #define G_NODE_IS_ROOT(node) (((GNode*) (node))->parent == NULL && \
1153 ((GNode*) (node))->prev == NULL && \
1154 ((GNode*) (node))->next == NULL)
1155 #define G_NODE_IS_LEAF(node) (((GNode*) (node))->children == NULL)
1157 void g_node_push_allocator (GAllocator *allocator);
1158 void g_node_pop_allocator (void);
1159 GNode* g_node_new (gpointer data);
1160 void g_node_destroy (GNode *root);
1161 void g_node_unlink (GNode *node);
1162 GNode* g_node_insert (GNode *parent,
1165 GNode* g_node_insert_before (GNode *parent,
1168 GNode* g_node_prepend (GNode *parent,
1170 guint g_node_n_nodes (GNode *root,
1171 GTraverseFlags flags);
1172 GNode* g_node_get_root (GNode *node);
1173 gboolean g_node_is_ancestor (GNode *node,
1175 guint g_node_depth (GNode *node);
1176 GNode* g_node_find (GNode *root,
1177 GTraverseType order,
1178 GTraverseFlags flags,
1181 /* convenience macros */
1182 #define g_node_append(parent, node) \
1183 g_node_insert_before ((parent), NULL, (node))
1184 #define g_node_insert_data(parent, position, data) \
1185 g_node_insert ((parent), (position), g_node_new (data))
1186 #define g_node_insert_data_before(parent, sibling, data) \
1187 g_node_insert_before ((parent), (sibling), g_node_new (data))
1188 #define g_node_prepend_data(parent, data) \
1189 g_node_prepend ((parent), g_node_new (data))
1190 #define g_node_append_data(parent, data) \
1191 g_node_insert_before ((parent), NULL, g_node_new (data))
1193 /* traversal function, assumes that `node' is root
1194 * (only traverses `node' and its subtree).
1195 * this function is just a high level interface to
1196 * low level traversal functions, optimized for speed.
1198 void g_node_traverse (GNode *root,
1199 GTraverseType order,
1200 GTraverseFlags flags,
1202 GNodeTraverseFunc func,
1205 /* return the maximum tree height starting with `node', this is an expensive
1206 * operation, since we need to visit all nodes. this could be shortened by
1207 * adding `guint height' to struct _GNode, but then again, this is not very
1208 * often needed, and would make g_node_insert() more time consuming.
1210 guint g_node_max_height (GNode *root);
1212 void g_node_children_foreach (GNode *node,
1213 GTraverseFlags flags,
1214 GNodeForeachFunc func,
1216 void g_node_reverse_children (GNode *node);
1217 guint g_node_n_children (GNode *node);
1218 GNode* g_node_nth_child (GNode *node,
1220 GNode* g_node_last_child (GNode *node);
1221 GNode* g_node_find_child (GNode *node,
1222 GTraverseFlags flags,
1224 gint g_node_child_position (GNode *node,
1226 gint g_node_child_index (GNode *node,
1229 GNode* g_node_first_sibling (GNode *node);
1230 GNode* g_node_last_sibling (GNode *node);
1232 #define g_node_prev_sibling(node) ((node) ? \
1233 ((GNode*) (node))->prev : NULL)
1234 #define g_node_next_sibling(node) ((node) ? \
1235 ((GNode*) (node))->next : NULL)
1236 #define g_node_first_child(node) ((node) ? \
1237 ((GNode*) (node))->children : NULL)
1240 /* Callback maintenance functions
1242 #define G_HOOK_FLAG_USER_SHIFT (4)
1245 G_HOOK_FLAG_ACTIVE = 1 << 0,
1246 G_HOOK_FLAG_IN_CALL = 1 << 1,
1247 G_HOOK_FLAG_MASK = 0x0f
1250 #define G_HOOK_DEFERRED_DESTROY ((GHookFreeFunc) 0x01)
1258 GMemChunk *hook_memchunk;
1259 GHookFreeFunc hook_free; /* virtual function */
1260 GHookFreeFunc hook_destroy; /* virtual function */
1272 GDestroyNotify destroy;
1275 #define G_HOOK_ACTIVE(hook) ((((GHook*) hook)->flags & \
1276 G_HOOK_FLAG_ACTIVE) != 0)
1277 #define G_HOOK_IN_CALL(hook) ((((GHook*) hook)->flags & \
1278 G_HOOK_FLAG_IN_CALL) != 0)
1279 #define G_HOOK_IS_VALID(hook) (((GHook*) hook)->hook_id != 0 && \
1280 G_HOOK_ACTIVE (hook))
1281 #define G_HOOK_IS_UNLINKED(hook) (((GHook*) hook)->next == NULL && \
1282 ((GHook*) hook)->prev == NULL && \
1283 ((GHook*) hook)->hook_id == 0 && \
1284 ((GHook*) hook)->ref_count == 0)
1286 void g_hook_list_init (GHookList *hook_list,
1288 void g_hook_list_clear (GHookList *hook_list);
1289 GHook* g_hook_alloc (GHookList *hook_list);
1290 void g_hook_free (GHookList *hook_list,
1292 void g_hook_ref (GHookList *hook_list,
1294 void g_hook_unref (GHookList *hook_list,
1296 gboolean g_hook_destroy (GHookList *hook_list,
1298 void g_hook_destroy_link (GHookList *hook_list,
1300 void g_hook_prepend (GHookList *hook_list,
1302 void g_hook_insert_before (GHookList *hook_list,
1305 void g_hook_insert_sorted (GHookList *hook_list,
1307 GHookCompareFunc func);
1308 GHook* g_hook_get (GHookList *hook_list,
1310 GHook* g_hook_find (GHookList *hook_list,
1311 gboolean need_valids,
1314 GHook* g_hook_find_data (GHookList *hook_list,
1315 gboolean need_valids,
1317 GHook* g_hook_find_func (GHookList *hook_list,
1318 gboolean need_valids,
1320 GHook* g_hook_find_func_data (GHookList *hook_list,
1321 gboolean need_valids,
1324 /* return the first valid hook, and increment its reference count */
1325 GHook* g_hook_first_valid (GHookList *hook_list,
1326 gboolean may_be_in_call);
1327 /* return the next valid hook with incremented reference count, and
1328 * decrement the reference count of the original hook
1330 GHook* g_hook_next_valid (GHookList *hook_list,
1332 gboolean may_be_in_call);
1334 /* GHookCompareFunc implementation to insert hooks sorted by their id */
1335 gint g_hook_compare_ids (GHook *new_hook,
1338 /* convenience macros */
1339 #define g_hook_append( hook_list, hook ) \
1340 g_hook_insert_before ((hook_list), NULL, (hook))
1342 /* invoke all valid hooks with the (*GHookFunc) signature.
1344 void g_hook_list_invoke (GHookList *hook_list,
1345 gboolean may_recurse);
1346 /* invoke all valid hooks with the (*GHookCheckFunc) signature,
1347 * and destroy the hook if FALSE is returned.
1349 void g_hook_list_invoke_check (GHookList *hook_list,
1350 gboolean may_recurse);
1351 /* invoke a marshaller on all valid hooks.
1353 void g_hook_list_marshal (GHookList *hook_list,
1354 gboolean may_recurse,
1355 GHookMarshaller marshaller,
1357 void g_hook_list_marshal_check (GHookList *hook_list,
1358 gboolean may_recurse,
1359 GHookCheckMarshaller marshaller,
1363 /* Fatal error handlers.
1364 * g_on_error_query() will prompt the user to either
1365 * [E]xit, [H]alt, [P]roceed or show [S]tack trace.
1366 * g_on_error_stack_trace() invokes gdb, which attaches to the current
1367 * process and shows a stack trace.
1368 * These function may cause different actions on non-unix platforms.
1369 * The prg_name arg is required by gdb to find the executable, if it is
1370 * passed as NULL, g_on_error_query() will try g_get_prgname().
1372 void g_on_error_query (const gchar *prg_name);
1373 void g_on_error_stack_trace (const gchar *prg_name);
1376 /* Logging mechanism
1378 extern const gchar *g_log_domain_glib;
1379 guint g_log_set_handler (const gchar *log_domain,
1380 GLogLevelFlags log_levels,
1382 gpointer user_data);
1383 void g_log_remove_handler (const gchar *log_domain,
1385 void g_log_default_handler (const gchar *log_domain,
1386 GLogLevelFlags log_level,
1387 const gchar *message,
1388 gpointer unused_data);
1389 void g_log (const gchar *log_domain,
1390 GLogLevelFlags log_level,
1391 const gchar *format,
1392 ...) G_GNUC_PRINTF (3, 4);
1393 void g_logv (const gchar *log_domain,
1394 GLogLevelFlags log_level,
1395 const gchar *format,
1397 GLogLevelFlags g_log_set_fatal_mask (const gchar *log_domain,
1398 GLogLevelFlags fatal_mask);
1399 GLogLevelFlags g_log_set_always_fatal (GLogLevelFlags fatal_mask);
1400 #ifndef G_LOG_DOMAIN
1401 #define G_LOG_DOMAIN ((gchar*) 0)
1402 #endif /* G_LOG_DOMAIN */
1404 #define g_error(format, args...) g_log (G_LOG_DOMAIN, \
1405 G_LOG_LEVEL_ERROR, \
1407 #define g_message(format, args...) g_log (G_LOG_DOMAIN, \
1408 G_LOG_LEVEL_MESSAGE, \
1410 #define g_warning(format, args...) g_log (G_LOG_DOMAIN, \
1411 G_LOG_LEVEL_WARNING, \
1413 #else /* !__GNUC__ */
1415 g_error (const gchar *format,
1419 va_start (args, format);
1420 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR, format, args);
1424 g_message (const gchar *format,
1428 va_start (args, format);
1429 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_MESSAGE, format, args);
1433 g_warning (const gchar *format,
1437 va_start (args, format);
1438 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING, format, args);
1441 #endif /* !__GNUC__ */
1443 typedef void (*GPrintFunc) (const gchar *string);
1444 void g_print (const gchar *format,
1445 ...) G_GNUC_PRINTF (1, 2);
1446 GPrintFunc g_set_print_handler (GPrintFunc func);
1447 void g_printerr (const gchar *format,
1448 ...) G_GNUC_PRINTF (1, 2);
1449 GPrintFunc g_set_printerr_handler (GPrintFunc func);
1451 /* deprecated compatibility functions, use g_log_set_handler() instead */
1452 typedef void (*GErrorFunc) (const gchar *str);
1453 typedef void (*GWarningFunc) (const gchar *str);
1454 GErrorFunc g_set_error_handler (GErrorFunc func);
1455 GWarningFunc g_set_warning_handler (GWarningFunc func);
1456 GPrintFunc g_set_message_handler (GPrintFunc func);
1459 /* Memory allocation and debugging
1463 #define g_malloc(size) ((gpointer) MALLOC (size))
1464 #define g_malloc0(size) ((gpointer) CALLOC (char, size))
1465 #define g_realloc(mem,size) ((gpointer) REALLOC (mem, char, size))
1466 #define g_free(mem) FREE (mem)
1468 #else /* !USE_DMALLOC */
1470 gpointer g_malloc (gulong size);
1471 gpointer g_malloc0 (gulong size);
1472 gpointer g_realloc (gpointer mem,
1474 void g_free (gpointer mem);
1476 #endif /* !USE_DMALLOC */
1478 void g_mem_profile (void);
1479 void g_mem_check (gpointer mem);
1481 /* Generic allocators
1483 GAllocator* g_allocator_new (const gchar *name,
1485 void g_allocator_free (GAllocator *allocator);
1487 #define G_ALLOCATOR_LIST (1)
1488 #define G_ALLOCATOR_SLIST (2)
1489 #define G_ALLOCATOR_NODE (3)
1492 /* "g_mem_chunk_new" creates a new memory chunk.
1493 * Memory chunks are used to allocate pieces of memory which are
1494 * always the same size. Lists are a good example of such a data type.
1495 * The memory chunk allocates and frees blocks of memory as needed.
1496 * Just be sure to call "g_mem_chunk_free" and not "g_free" on data
1497 * allocated in a mem chunk. ("g_free" will most likely cause a seg
1498 * fault...somewhere).
1500 * Oh yeah, GMemChunk is an opaque data type. (You don't really
1501 * want to know what's going on inside do you?)
1504 /* ALLOC_ONLY MemChunk's can only allocate memory. The free operation
1505 * is interpreted as a no op. ALLOC_ONLY MemChunk's save 4 bytes per
1506 * atom. (They are also useful for lists which use MemChunk to allocate
1507 * memory but are also part of the MemChunk implementation).
1508 * ALLOC_AND_FREE MemChunk's can allocate and free memory.
1511 #define G_ALLOC_ONLY 1
1512 #define G_ALLOC_AND_FREE 2
1514 GMemChunk* g_mem_chunk_new (gchar *name,
1518 void g_mem_chunk_destroy (GMemChunk *mem_chunk);
1519 gpointer g_mem_chunk_alloc (GMemChunk *mem_chunk);
1520 gpointer g_mem_chunk_alloc0 (GMemChunk *mem_chunk);
1521 void g_mem_chunk_free (GMemChunk *mem_chunk,
1523 void g_mem_chunk_clean (GMemChunk *mem_chunk);
1524 void g_mem_chunk_reset (GMemChunk *mem_chunk);
1525 void g_mem_chunk_print (GMemChunk *mem_chunk);
1526 void g_mem_chunk_info (void);
1528 /* Ah yes...we have a "g_blow_chunks" function.
1529 * "g_blow_chunks" simply compresses all the chunks. This operation
1530 * consists of freeing every memory area that should be freed (but
1531 * which we haven't gotten around to doing yet). And, no,
1532 * "g_blow_chunks" doesn't follow the naming scheme, but it is a
1533 * much better name than "g_mem_chunk_clean_all" or something
1536 void g_blow_chunks (void);
1542 #define G_MICROSEC 1000000
1544 GTimer* g_timer_new (void);
1545 void g_timer_destroy (GTimer *timer);
1546 void g_timer_start (GTimer *timer);
1547 void g_timer_stop (GTimer *timer);
1548 void g_timer_reset (GTimer *timer);
1549 gdouble g_timer_elapsed (GTimer *timer,
1550 gulong *microseconds);
1551 void g_usleep (gulong microseconds);
1553 /* String utility functions that modify a string argument or
1554 * return a constant string that must not be freed.
1556 #define G_STR_DELIMITERS "_-|> <."
1557 gchar* g_strdelimit (gchar *string,
1558 const gchar *delimiters,
1559 gchar new_delimiter);
1560 gdouble g_strtod (const gchar *nptr,
1562 gchar* g_strerror (gint errnum);
1563 gchar* g_strsignal (gint signum);
1564 gint g_strcasecmp (const gchar *s1,
1566 gint g_strncasecmp (const gchar *s1,
1569 void g_strdown (gchar *string);
1570 void g_strup (gchar *string);
1571 void g_strreverse (gchar *string);
1572 /* removes leading spaces */
1573 gchar* g_strchug (gchar *string);
1574 /* removes trailing spaces */
1575 gchar* g_strchomp (gchar *string);
1576 /* removes leading & trailing spaces */
1577 #define g_strstrip( string ) g_strchomp (g_strchug (string))
1579 /* String utility functions that return a newly allocated string which
1580 * ought to be freed with g_free from the caller at some point.
1582 gchar* g_strdup (const gchar *str);
1583 gchar* g_strdup_printf (const gchar *format,
1584 ...) G_GNUC_PRINTF (1, 2);
1585 gchar* g_strdup_vprintf (const gchar *format,
1587 gchar* g_strndup (const gchar *str,
1589 gchar* g_strnfill (guint length,
1591 gchar* g_strconcat (const gchar *string1,
1592 ...); /* NULL terminated */
1593 gchar* g_strjoin (const gchar *separator,
1594 ...); /* NULL terminated */
1595 /* Make a copy of a string interpreting C string -style escape
1596 * sequences. Inverse of g_strescape. The recognized sequences are \b
1597 * \f \n \r \t \\ \" and the octal format.
1599 gchar* g_strcompress (const gchar *source);
1601 /* Copy a string escaping nonprintable characters like in C strings.
1602 * Inverse of g_strcompress. The exceptions parameter, if non-NULL, points
1603 * to a string containing characters that are not to be escaped.
1605 gchar* g_strescape (const gchar *source,
1606 const gchar *exceptions);
1608 * Convert between the operating system (or C runtime)
1609 * representation of file names and UTF-8.
1611 gchar* g_filename_to_utf8 (const gchar *opsysstring);
1612 gchar* g_filename_from_utf8 (const gchar *utf8string);
1615 * gchar* g_strescape (const gchar *source);
1616 * Luckily this function wasn't much used.
1617 * Add a second NULL parameter in calls for mostly identical semantics.
1620 gpointer g_memdup (gconstpointer mem,
1623 /* NULL terminated string arrays.
1624 * g_strsplit() splits up string into max_tokens tokens at delim and
1625 * returns a newly allocated string array.
1626 * g_strjoinv() concatenates all of str_array's strings, sliding in an
1627 * optional separator, the returned string is newly allocated.
1628 * g_strfreev() frees the array itself and all of its strings.
1630 gchar** g_strsplit (const gchar *string,
1631 const gchar *delimiter,
1633 gchar* g_strjoinv (const gchar *separator,
1635 void g_strfreev (gchar **str_array);
1639 /* calculate a string size, guarranteed to fit format + args.
1641 guint g_printf_string_upper_bound (const gchar* format,
1645 /* Retrive static string info
1647 gchar* g_get_user_name (void);
1648 gchar* g_get_real_name (void);
1649 gchar* g_get_home_dir (void);
1650 gchar* g_get_tmp_dir (void);
1651 gchar* g_get_prgname (void);
1652 void g_set_prgname (const gchar *prgname);
1655 /* Miscellaneous utility functions
1657 guint g_parse_debug_string (const gchar *string,
1660 gint g_snprintf (gchar *string,
1662 gchar const *format,
1663 ...) G_GNUC_PRINTF (3, 4);
1664 gint g_vsnprintf (gchar *string,
1666 gchar const *format,
1668 gchar* g_basename (const gchar *file_name);
1669 /* Check if a file name is an absolute path */
1670 gboolean g_path_is_absolute (const gchar *file_name);
1671 /* In case of absolute paths, skip the root part */
1672 gchar* g_path_skip_root (gchar *file_name);
1674 /* strings are newly allocated with g_malloc() */
1675 gchar* g_dirname (const gchar *file_name);
1676 gchar* g_get_current_dir (void);
1677 gchar* g_getenv (const gchar *variable);
1680 /* we use a GLib function as a replacement for ATEXIT, so
1681 * the programmer is not required to check the return value
1682 * (if there is any in the implementation) and doesn't encounter
1683 * missing include files.
1685 void g_atexit (GVoidFunc func);
1690 G_INLINE_FUNC gint g_bit_nth_lsf (guint32 mask,
1694 g_bit_nth_lsf (guint32 mask,
1700 if (mask & (1 << (guint) nth_bit))
1703 while (nth_bit < 32);
1706 #endif /* G_CAN_INLINE */
1708 G_INLINE_FUNC gint g_bit_nth_msf (guint32 mask,
1712 g_bit_nth_msf (guint32 mask,
1720 if (mask & (1 << (guint) nth_bit))
1723 while (nth_bit > 0);
1726 #endif /* G_CAN_INLINE */
1728 G_INLINE_FUNC guint g_bit_storage (guint number);
1731 g_bit_storage (guint number)
1733 register guint n_bits = 0;
1743 #endif /* G_CAN_INLINE */
1747 * elements need to be >= sizeof (gpointer)
1749 G_INLINE_FUNC void g_trash_stack_push (GTrashStack **stack_p,
1753 g_trash_stack_push (GTrashStack **stack_p,
1756 GTrashStack *data = (GTrashStack *) data_p;
1758 data->next = *stack_p;
1761 #endif /* G_CAN_INLINE */
1763 G_INLINE_FUNC gpointer g_trash_stack_pop (GTrashStack **stack_p);
1765 G_INLINE_FUNC gpointer
1766 g_trash_stack_pop (GTrashStack **stack_p)
1773 *stack_p = data->next;
1774 /* NULLify private pointer here, most platforms store NULL as
1775 * subsequent 0 bytes
1782 #endif /* G_CAN_INLINE */
1784 G_INLINE_FUNC gpointer g_trash_stack_peek (GTrashStack **stack_p);
1786 G_INLINE_FUNC gpointer
1787 g_trash_stack_peek (GTrashStack **stack_p)
1795 #endif /* G_CAN_INLINE */
1797 G_INLINE_FUNC guint g_trash_stack_height (GTrashStack **stack_p);
1800 g_trash_stack_height (GTrashStack **stack_p)
1805 for (data = *stack_p; data; data = data->next)
1810 #endif /* G_CAN_INLINE */
1815 GStringChunk* g_string_chunk_new (gint size);
1816 void g_string_chunk_free (GStringChunk *chunk);
1817 gchar* g_string_chunk_insert (GStringChunk *chunk,
1818 const gchar *string);
1819 gchar* g_string_chunk_insert_const (GStringChunk *chunk,
1820 const gchar *string);
1825 GString* g_string_new (const gchar *init);
1826 GString* g_string_sized_new (guint dfl_size);
1827 void g_string_free (GString *string,
1828 gboolean free_segment);
1829 GString* g_string_assign (GString *string,
1831 GString* g_string_truncate (GString *string,
1833 GString* g_string_insert_len (GString *string,
1837 GString* g_string_append (GString *string,
1839 GString* g_string_append_len (GString *string,
1842 GString* g_string_append_c (GString *string,
1844 GString* g_string_prepend (GString *string,
1846 GString* g_string_prepend_c (GString *string,
1848 GString* g_string_prepend_len (GString *string,
1851 GString* g_string_insert (GString *string,
1854 GString* g_string_insert_c (GString *string,
1857 GString* g_string_erase (GString *string,
1860 GString* g_string_down (GString *string);
1861 GString* g_string_up (GString *string);
1862 void g_string_sprintf (GString *string,
1863 const gchar *format,
1864 ...) G_GNUC_PRINTF (2, 3);
1865 void g_string_sprintfa (GString *string,
1866 const gchar *format,
1867 ...) G_GNUC_PRINTF (2, 3);
1870 /* Resizable arrays, remove fills any cleared spot and shortens the
1871 * array, while preserving the order. remove_fast will distort the
1872 * order by moving the last element to the position of the removed
1875 #define g_array_append_val(a,v) g_array_append_vals (a, &v, 1)
1876 #define g_array_prepend_val(a,v) g_array_prepend_vals (a, &v, 1)
1877 #define g_array_insert_val(a,i,v) g_array_insert_vals (a, i, &v, 1)
1878 #define g_array_index(a,t,i) (((t*) (a)->data) [(i)])
1880 GArray* g_array_new (gboolean zero_terminated,
1882 guint element_size);
1883 void g_array_free (GArray *array,
1884 gboolean free_segment);
1885 GArray* g_array_append_vals (GArray *array,
1888 GArray* g_array_prepend_vals (GArray *array,
1891 GArray* g_array_insert_vals (GArray *array,
1895 GArray* g_array_set_size (GArray *array,
1897 GArray* g_array_remove_index (GArray *array,
1899 GArray* g_array_remove_index_fast (GArray *array,
1902 /* Resizable pointer array. This interface is much less complicated
1903 * than the above. Add appends appends a pointer. Remove fills any
1904 * cleared spot and shortens the array. remove_fast will again distort
1907 #define g_ptr_array_index(array,index) (array->pdata)[index]
1908 GPtrArray* g_ptr_array_new (void);
1909 void g_ptr_array_free (GPtrArray *array,
1911 void g_ptr_array_set_size (GPtrArray *array,
1913 gpointer g_ptr_array_remove_index (GPtrArray *array,
1915 gpointer g_ptr_array_remove_index_fast (GPtrArray *array,
1917 gboolean g_ptr_array_remove (GPtrArray *array,
1919 gboolean g_ptr_array_remove_fast (GPtrArray *array,
1921 void g_ptr_array_add (GPtrArray *array,
1924 /* Byte arrays, an array of guint8. Implemented as a GArray,
1928 GByteArray* g_byte_array_new (void);
1929 void g_byte_array_free (GByteArray *array,
1930 gboolean free_segment);
1931 GByteArray* g_byte_array_append (GByteArray *array,
1934 GByteArray* g_byte_array_prepend (GByteArray *array,
1937 GByteArray* g_byte_array_set_size (GByteArray *array,
1939 GByteArray* g_byte_array_remove_index (GByteArray *array,
1941 GByteArray* g_byte_array_remove_index_fast (GByteArray *array,
1947 gint g_str_equal (gconstpointer v,
1949 guint g_str_hash (gconstpointer v);
1951 gint g_int_equal (gconstpointer v,
1953 guint g_int_hash (gconstpointer v);
1955 /* This "hash" function will just return the key's adress as an
1956 * unsigned integer. Useful for hashing on plain adresses or
1957 * simple integer values.
1958 * passing NULL into g_hash_table_new() as GHashFunc has the
1959 * same effect as passing g_direct_hash().
1961 guint g_direct_hash (gconstpointer v);
1962 gint g_direct_equal (gconstpointer v,
1966 /* Quarks (string<->id association)
1968 GQuark g_quark_try_string (const gchar *string);
1969 GQuark g_quark_from_static_string (const gchar *string);
1970 GQuark g_quark_from_string (const gchar *string);
1971 gchar* g_quark_to_string (GQuark quark);
1976 void g_datalist_init (GData **datalist);
1977 void g_datalist_clear (GData **datalist);
1978 gpointer g_datalist_id_get_data (GData **datalist,
1980 void g_datalist_id_set_data_full (GData **datalist,
1983 GDestroyNotify destroy_func);
1984 gpointer g_datalist_id_remove_no_notify (GData **datalist,
1986 void g_datalist_foreach (GData **datalist,
1987 GDataForeachFunc func,
1988 gpointer user_data);
1989 #define g_datalist_id_set_data(dl, q, d) \
1990 g_datalist_id_set_data_full ((dl), (q), (d), NULL)
1991 #define g_datalist_id_remove_data(dl, q) \
1992 g_datalist_id_set_data ((dl), (q), NULL)
1993 #define g_datalist_get_data(dl, k) \
1994 (g_datalist_id_get_data ((dl), g_quark_try_string (k)))
1995 #define g_datalist_set_data_full(dl, k, d, f) \
1996 g_datalist_id_set_data_full ((dl), g_quark_from_string (k), (d), (f))
1997 #define g_datalist_remove_no_notify(dl, k) \
1998 g_datalist_id_remove_no_notify ((dl), g_quark_try_string (k))
1999 #define g_datalist_set_data(dl, k, d) \
2000 g_datalist_set_data_full ((dl), (k), (d), NULL)
2001 #define g_datalist_remove_data(dl, k) \
2002 g_datalist_id_set_data ((dl), g_quark_try_string (k), NULL)
2005 /* Location Associated Keyed Data
2007 void g_dataset_destroy (gconstpointer dataset_location);
2008 gpointer g_dataset_id_get_data (gconstpointer dataset_location,
2010 void g_dataset_id_set_data_full (gconstpointer dataset_location,
2013 GDestroyNotify destroy_func);
2014 gpointer g_dataset_id_remove_no_notify (gconstpointer dataset_location,
2016 void g_dataset_foreach (gconstpointer dataset_location,
2017 GDataForeachFunc func,
2018 gpointer user_data);
2019 #define g_dataset_id_set_data(l, k, d) \
2020 g_dataset_id_set_data_full ((l), (k), (d), NULL)
2021 #define g_dataset_id_remove_data(l, k) \
2022 g_dataset_id_set_data ((l), (k), NULL)
2023 #define g_dataset_get_data(l, k) \
2024 (g_dataset_id_get_data ((l), g_quark_try_string (k)))
2025 #define g_dataset_set_data_full(l, k, d, f) \
2026 g_dataset_id_set_data_full ((l), g_quark_from_string (k), (d), (f))
2027 #define g_dataset_remove_no_notify(l, k) \
2028 g_dataset_id_remove_no_notify ((l), g_quark_try_string (k))
2029 #define g_dataset_set_data(l, k, d) \
2030 g_dataset_set_data_full ((l), (k), (d), NULL)
2031 #define g_dataset_remove_data(l, k) \
2032 g_dataset_id_set_data ((l), g_quark_try_string (k), NULL)
2035 /* GScanner: Flexible lexical scanner for general purpose.
2038 /* Character sets */
2039 #define G_CSET_A_2_Z "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
2040 #define G_CSET_a_2_z "abcdefghijklmnopqrstuvwxyz"
2041 #define G_CSET_LATINC "\300\301\302\303\304\305\306"\
2042 "\307\310\311\312\313\314\315\316\317\320"\
2043 "\321\322\323\324\325\326"\
2044 "\330\331\332\333\334\335\336"
2045 #define G_CSET_LATINS "\337\340\341\342\343\344\345\346"\
2046 "\347\350\351\352\353\354\355\356\357\360"\
2047 "\361\362\363\364\365\366"\
2048 "\370\371\372\373\374\375\376\377"
2055 G_ERR_UNEXP_EOF_IN_STRING,
2056 G_ERR_UNEXP_EOF_IN_COMMENT,
2057 G_ERR_NON_DIGIT_IN_CONST,
2060 G_ERR_FLOAT_MALFORMED
2068 G_TOKEN_LEFT_PAREN = '(',
2069 G_TOKEN_RIGHT_PAREN = ')',
2070 G_TOKEN_LEFT_CURLY = '{',
2071 G_TOKEN_RIGHT_CURLY = '}',
2072 G_TOKEN_LEFT_BRACE = '[',
2073 G_TOKEN_RIGHT_BRACE = ']',
2074 G_TOKEN_EQUAL_SIGN = '=',
2075 G_TOKEN_COMMA = ',',
2091 G_TOKEN_IDENTIFIER_NULL,
2093 G_TOKEN_COMMENT_SINGLE,
2094 G_TOKEN_COMMENT_MULTI,
2101 gchar *v_identifier;
2113 struct _GScannerConfig
2117 gchar *cset_skip_characters; /* default: " \t\n" */
2118 gchar *cset_identifier_first;
2119 gchar *cset_identifier_nth;
2120 gchar *cpair_comment_single; /* default: "#\n" */
2122 /* Should symbol lookup work case sensitive?
2124 guint case_sensitive : 1;
2126 /* Boolean values to be adjusted "on the fly"
2127 * to configure scanning behaviour.
2129 guint skip_comment_multi : 1; /* C like comment */
2130 guint skip_comment_single : 1; /* single line comment */
2131 guint scan_comment_multi : 1; /* scan multi line comments? */
2132 guint scan_identifier : 1;
2133 guint scan_identifier_1char : 1;
2134 guint scan_identifier_NULL : 1;
2135 guint scan_symbols : 1;
2136 guint scan_binary : 1;
2137 guint scan_octal : 1;
2138 guint scan_float : 1;
2139 guint scan_hex : 1; /* `0x0ff0' */
2140 guint scan_hex_dollar : 1; /* `$0ff0' */
2141 guint scan_string_sq : 1; /* string: 'anything' */
2142 guint scan_string_dq : 1; /* string: "\\-escapes!\n" */
2143 guint numbers_2_int : 1; /* bin, octal, hex => int */
2144 guint int_2_float : 1; /* int => G_TOKEN_FLOAT? */
2145 guint identifier_2_string : 1;
2146 guint char_2_token : 1; /* return G_TOKEN_CHAR? */
2147 guint symbol_2_token : 1;
2148 guint scope_0_fallback : 1; /* try scope 0 on lookups? */
2155 guint max_parse_errors;
2157 /* g_scanner_error() increments this field */
2160 /* name of input stream, featured by the default message handler */
2161 const gchar *input_name;
2163 /* data pointer for derived structures */
2164 gpointer derived_data;
2166 /* link into the scanner configuration */
2167 GScannerConfig *config;
2169 /* fields filled in after g_scanner_get_next_token() */
2175 /* fields filled in after g_scanner_peek_next_token() */
2176 GTokenType next_token;
2177 GTokenValue next_value;
2179 guint next_position;
2181 /* to be considered private */
2182 GHashTable *symbol_table;
2185 const gchar *text_end;
2189 /* handler function for _warn and _error */
2190 GScannerMsgFunc msg_handler;
2193 GScanner* g_scanner_new (GScannerConfig *config_templ);
2194 void g_scanner_destroy (GScanner *scanner);
2195 void g_scanner_input_file (GScanner *scanner,
2197 void g_scanner_sync_file_offset (GScanner *scanner);
2198 void g_scanner_input_text (GScanner *scanner,
2201 GTokenType g_scanner_get_next_token (GScanner *scanner);
2202 GTokenType g_scanner_peek_next_token (GScanner *scanner);
2203 GTokenType g_scanner_cur_token (GScanner *scanner);
2204 GTokenValue g_scanner_cur_value (GScanner *scanner);
2205 guint g_scanner_cur_line (GScanner *scanner);
2206 guint g_scanner_cur_position (GScanner *scanner);
2207 gboolean g_scanner_eof (GScanner *scanner);
2208 guint g_scanner_set_scope (GScanner *scanner,
2210 void g_scanner_scope_add_symbol (GScanner *scanner,
2212 const gchar *symbol,
2214 void g_scanner_scope_remove_symbol (GScanner *scanner,
2216 const gchar *symbol);
2217 gpointer g_scanner_scope_lookup_symbol (GScanner *scanner,
2219 const gchar *symbol);
2220 void g_scanner_scope_foreach_symbol (GScanner *scanner,
2223 gpointer user_data);
2224 gpointer g_scanner_lookup_symbol (GScanner *scanner,
2225 const gchar *symbol);
2226 void g_scanner_freeze_symbol_table (GScanner *scanner);
2227 void g_scanner_thaw_symbol_table (GScanner *scanner);
2228 void g_scanner_unexp_token (GScanner *scanner,
2229 GTokenType expected_token,
2230 const gchar *identifier_spec,
2231 const gchar *symbol_spec,
2232 const gchar *symbol_name,
2233 const gchar *message,
2235 void g_scanner_error (GScanner *scanner,
2236 const gchar *format,
2237 ...) G_GNUC_PRINTF (2,3);
2238 void g_scanner_warn (GScanner *scanner,
2239 const gchar *format,
2240 ...) G_GNUC_PRINTF (2,3);
2241 gint g_scanner_stat_mode (const gchar *filename);
2242 /* keep downward source compatibility */
2243 #define g_scanner_add_symbol( scanner, symbol, value ) G_STMT_START { \
2244 g_scanner_scope_add_symbol ((scanner), 0, (symbol), (value)); \
2246 #define g_scanner_remove_symbol( scanner, symbol ) G_STMT_START { \
2247 g_scanner_scope_remove_symbol ((scanner), 0, (symbol)); \
2249 #define g_scanner_foreach_symbol( scanner, func, data ) G_STMT_START { \
2250 g_scanner_scope_foreach_symbol ((scanner), 0, (func), (data)); \
2260 GCompletionFunc func;
2266 GCompletion* g_completion_new (GCompletionFunc func);
2267 void g_completion_add_items (GCompletion* cmp,
2269 void g_completion_remove_items (GCompletion* cmp,
2271 void g_completion_clear_items (GCompletion* cmp);
2272 GList* g_completion_complete (GCompletion* cmp,
2274 gchar** new_prefix);
2275 void g_completion_free (GCompletion* cmp);
2280 * Date calculations (not time for now, to be resolved). These are a
2281 * mutant combination of Steffen Beyer's DateCalc routines
2282 * (http://www.perl.com/CPAN/authors/id/STBEY/) and Jon Trowbridge's
2283 * date routines (written for in-house software). Written by Havoc
2284 * Pennington <hp@pobox.com>
2287 typedef guint16 GDateYear;
2288 typedef guint8 GDateDay; /* day of the month */
2289 typedef struct _GDate GDate;
2290 /* make struct tm known without having to include time.h */
2293 /* enum used to specify order of appearance in parsed date strings */
2301 /* actual week and month values */
2304 G_DATE_BAD_WEEKDAY = 0,
2307 G_DATE_WEDNESDAY = 3,
2308 G_DATE_THURSDAY = 4,
2310 G_DATE_SATURDAY = 6,
2315 G_DATE_BAD_MONTH = 0,
2317 G_DATE_FEBRUARY = 2,
2324 G_DATE_SEPTEMBER = 9,
2325 G_DATE_OCTOBER = 10,
2326 G_DATE_NOVEMBER = 11,
2327 G_DATE_DECEMBER = 12
2330 #define G_DATE_BAD_JULIAN 0U
2331 #define G_DATE_BAD_DAY 0U
2332 #define G_DATE_BAD_YEAR 0U
2334 /* Note: directly manipulating structs is generally a bad idea, but
2335 * in this case it's an *incredibly* bad idea, because all or part
2336 * of this struct can be invalid at any given time. Use the functions,
2337 * or you will get hosed, I promise.
2341 guint julian_days : 32; /* julian days representation - we use a
2342 * bitfield hoping that 64 bit platforms
2343 * will pack this whole struct in one big
2347 guint julian : 1; /* julian is valid */
2348 guint dmy : 1; /* dmy is valid */
2350 /* DMY representation */
2356 /* g_date_new() returns an invalid date, you then have to _set() stuff
2357 * to get a usable object. You can also allocate a GDate statically,
2358 * then call g_date_clear() to initialize.
2360 GDate* g_date_new (void);
2361 GDate* g_date_new_dmy (GDateDay day,
2364 GDate* g_date_new_julian (guint32 julian_day);
2365 void g_date_free (GDate *date);
2367 /* check g_date_valid() after doing an operation that might fail, like
2368 * _parse. Almost all g_date operations are undefined on invalid
2369 * dates (the exceptions are the mutators, since you need those to
2370 * return to validity).
2372 gboolean g_date_valid (GDate *date);
2373 gboolean g_date_valid_day (GDateDay day);
2374 gboolean g_date_valid_month (GDateMonth month);
2375 gboolean g_date_valid_year (GDateYear year);
2376 gboolean g_date_valid_weekday (GDateWeekday weekday);
2377 gboolean g_date_valid_julian (guint32 julian_date);
2378 gboolean g_date_valid_dmy (GDateDay day,
2382 GDateWeekday g_date_weekday (GDate *date);
2383 GDateMonth g_date_month (GDate *date);
2384 GDateYear g_date_year (GDate *date);
2385 GDateDay g_date_day (GDate *date);
2386 guint32 g_date_julian (GDate *date);
2387 guint g_date_day_of_year (GDate *date);
2389 /* First monday/sunday is the start of week 1; if we haven't reached
2390 * that day, return 0. These are not ISO weeks of the year; that
2391 * routine needs to be added.
2392 * these functions return the number of weeks, starting on the
2395 guint g_date_monday_week_of_year (GDate *date);
2396 guint g_date_sunday_week_of_year (GDate *date);
2398 /* If you create a static date struct you need to clear it to get it
2399 * in a sane state before use. You can clear a whole array at
2400 * once with the ndates argument.
2402 void g_date_clear (GDate *date,
2405 /* The parse routine is meant for dates typed in by a user, so it
2406 * permits many formats but tries to catch common typos. If your data
2407 * needs to be strictly validated, it is not an appropriate function.
2409 void g_date_set_parse (GDate *date,
2411 void g_date_set_time (GDate *date,
2413 void g_date_set_month (GDate *date,
2415 void g_date_set_day (GDate *date,
2417 void g_date_set_year (GDate *date,
2419 void g_date_set_dmy (GDate *date,
2423 void g_date_set_julian (GDate *date,
2424 guint32 julian_date);
2425 gboolean g_date_is_first_of_month (GDate *date);
2426 gboolean g_date_is_last_of_month (GDate *date);
2428 /* To go forward by some number of weeks just go forward weeks*7 days */
2429 void g_date_add_days (GDate *date,
2431 void g_date_subtract_days (GDate *date,
2434 /* If you add/sub months while day > 28, the day might change */
2435 void g_date_add_months (GDate *date,
2437 void g_date_subtract_months (GDate *date,
2440 /* If it's feb 29, changing years can move you to the 28th */
2441 void g_date_add_years (GDate *date,
2443 void g_date_subtract_years (GDate *date,
2445 gboolean g_date_is_leap_year (GDateYear year);
2446 guint8 g_date_days_in_month (GDateMonth month,
2448 guint8 g_date_monday_weeks_in_year (GDateYear year);
2449 guint8 g_date_sunday_weeks_in_year (GDateYear year);
2451 /* qsort-friendly (with a cast...) */
2452 gint g_date_compare (GDate *lhs,
2454 void g_date_to_struct_tm (GDate *date,
2457 /* Just like strftime() except you can only use date-related formats.
2458 * Using a time format is undefined.
2460 gsize g_date_strftime (gchar *s,
2462 const gchar *format,
2468 * Indexed Relations. Imagine a really simple table in a
2469 * database. Relations are not ordered. This data type is meant for
2470 * maintaining a N-way mapping.
2472 * g_relation_new() creates a relation with FIELDS fields
2474 * g_relation_destroy() frees all resources
2475 * g_tuples_destroy() frees the result of g_relation_select()
2477 * g_relation_index() indexes relation FIELD with the provided
2478 * equality and hash functions. this must be done before any
2479 * calls to insert are made.
2481 * g_relation_insert() inserts a new tuple. you are expected to
2482 * provide the right number of fields.
2484 * g_relation_delete() deletes all relations with KEY in FIELD
2485 * g_relation_select() returns ...
2486 * g_relation_count() counts ...
2489 GRelation* g_relation_new (gint fields);
2490 void g_relation_destroy (GRelation *relation);
2491 void g_relation_index (GRelation *relation,
2493 GHashFunc hash_func,
2494 GCompareFunc key_compare_func);
2495 void g_relation_insert (GRelation *relation,
2497 gint g_relation_delete (GRelation *relation,
2500 GTuples* g_relation_select (GRelation *relation,
2503 gint g_relation_count (GRelation *relation,
2506 gboolean g_relation_exists (GRelation *relation,
2508 void g_relation_print (GRelation *relation);
2510 void g_tuples_destroy (GTuples *tuples);
2511 gpointer g_tuples_index (GTuples *tuples,
2516 /* GRand - a good and fast random number generator: Mersenne Twister
2517 * see http://www.math.keio.ac.jp/~matumoto/emt.html for more info.
2518 * The range functions return a value in the intervall [min,max).
2519 * int -> [0..2^32-1]
2520 * int_range -> [min..max-1]
2522 * double_range -> [min..max)
2525 GRand* g_rand_new_with_seed (guint32 seed);
2526 GRand* g_rand_new (void);
2527 void g_rand_free (GRand *rand);
2529 void g_rand_set_seed (GRand *rand,
2531 guint32 g_rand_int (GRand *rand);
2532 gint32 g_rand_int_range (GRand *rand,
2535 gdouble g_rand_double (GRand *rand);
2536 gdouble g_rand_double_range (GRand *rand,
2540 void g_random_set_seed (guint32 seed);
2541 guint32 g_random_int (void);
2542 gint32 g_random_int_range (gint32 min,
2544 gdouble g_random_double (void);
2545 gdouble g_random_double_range (gdouble min,
2552 /* This function returns prime numbers spaced by approximately 1.5-2.0
2553 * and is for use in resizing data structures which prefer
2554 * prime-valued sizes. The closest spaced prime function returns the
2555 * next largest prime, or the highest it knows about which is about
2558 guint g_spaced_primes_closest (guint num);
2564 typedef struct _GIOFuncs GIOFuncs;
2580 G_IO_IN GLIB_SYSDEF_POLLIN,
2581 G_IO_OUT GLIB_SYSDEF_POLLOUT,
2582 G_IO_PRI GLIB_SYSDEF_POLLPRI,
2583 G_IO_ERR GLIB_SYSDEF_POLLERR,
2584 G_IO_HUP GLIB_SYSDEF_POLLHUP,
2585 G_IO_NVAL GLIB_SYSDEF_POLLNVAL
2590 guint channel_flags;
2595 typedef gboolean (*GIOFunc) (GIOChannel *source,
2596 GIOCondition condition,
2600 GIOError (*io_read) (GIOChannel *channel,
2604 GIOError (*io_write) (GIOChannel *channel,
2607 guint *bytes_written);
2608 GIOError (*io_seek) (GIOChannel *channel,
2611 void (*io_close) (GIOChannel *channel);
2612 guint (*io_add_watch) (GIOChannel *channel,
2614 GIOCondition condition,
2617 GDestroyNotify notify);
2618 void (*io_free) (GIOChannel *channel);
2621 void g_io_channel_init (GIOChannel *channel);
2622 void g_io_channel_ref (GIOChannel *channel);
2623 void g_io_channel_unref (GIOChannel *channel);
2624 GIOError g_io_channel_read (GIOChannel *channel,
2628 GIOError g_io_channel_write (GIOChannel *channel,
2631 guint *bytes_written);
2632 GIOError g_io_channel_seek (GIOChannel *channel,
2635 void g_io_channel_close (GIOChannel *channel);
2636 guint g_io_add_watch_full (GIOChannel *channel,
2638 GIOCondition condition,
2641 GDestroyNotify notify);
2642 guint g_io_add_watch (GIOChannel *channel,
2643 GIOCondition condition,
2645 gpointer user_data);
2650 typedef struct _GTimeVal GTimeVal;
2651 typedef struct _GSourceFuncs GSourceFuncs;
2652 typedef struct _GMainLoop GMainLoop; /* Opaque */
2659 struct _GSourceFuncs
2661 gboolean (*prepare) (gpointer source_data,
2662 GTimeVal *current_time,
2664 gpointer user_data);
2665 gboolean (*check) (gpointer source_data,
2666 GTimeVal *current_time,
2667 gpointer user_data);
2668 gboolean (*dispatch) (gpointer source_data,
2669 GTimeVal *dispatch_time,
2670 gpointer user_data);
2671 GDestroyNotify destroy;
2674 /* Standard priorities */
2676 #define G_PRIORITY_HIGH -100
2677 #define G_PRIORITY_DEFAULT 0
2678 #define G_PRIORITY_HIGH_IDLE 100
2679 #define G_PRIORITY_DEFAULT_IDLE 200
2680 #define G_PRIORITY_LOW 300
2682 typedef gboolean (*GSourceFunc) (gpointer data);
2684 /* Hooks for adding to the main loop */
2685 guint g_source_add (gint priority,
2686 gboolean can_recurse,
2687 GSourceFuncs *funcs,
2688 gpointer source_data,
2690 GDestroyNotify notify);
2691 gboolean g_source_remove (guint tag);
2692 gboolean g_source_remove_by_user_data (gpointer user_data);
2693 gboolean g_source_remove_by_source_data (gpointer source_data);
2694 gboolean g_source_remove_by_funcs_user_data (GSourceFuncs *funcs,
2695 gpointer user_data);
2697 void g_get_current_time (GTimeVal *result);
2699 /* Running the main loop */
2700 GMainLoop* g_main_new (gboolean is_running);
2701 void g_main_run (GMainLoop *loop);
2702 void g_main_quit (GMainLoop *loop);
2703 void g_main_destroy (GMainLoop *loop);
2704 gboolean g_main_is_running (GMainLoop *loop);
2706 /* Run a single iteration of the mainloop. If block is FALSE,
2709 gboolean g_main_iteration (gboolean may_block);
2711 /* See if any events are pending */
2712 gboolean g_main_pending (void);
2714 /* Idles and timeouts */
2715 guint g_timeout_add_full (gint priority,
2717 GSourceFunc function,
2719 GDestroyNotify notify);
2720 guint g_timeout_add (guint interval,
2721 GSourceFunc function,
2723 guint g_idle_add (GSourceFunc function,
2725 guint g_idle_add_full (gint priority,
2726 GSourceFunc function,
2728 GDestroyNotify destroy);
2729 gboolean g_idle_remove_by_data (gpointer data);
2733 * System-specific IO and main loop calls
2735 * On Win32, the fd in a GPollFD should be Win32 HANDLE (*not* a file
2736 * descriptor as provided by the C runtime) that can be used by
2737 * MsgWaitForMultipleObjects. This does *not* include file handles
2738 * from CreateFile, SOCKETs, nor pipe handles. (But you can use
2739 * WSAEventSelect to signal events when a SOCKET is readable).
2741 * On Win32, fd can also be the special value G_WIN32_MSG_HANDLE to
2742 * indicate polling for messages. These message queue GPollFDs should
2743 * be added with the g_main_poll_win32_msg_add function.
2745 * But note that G_WIN32_MSG_HANDLE GPollFDs should not be used by GDK
2746 * (GTK) programs, as GDK itself wants to read messages and convert them
2749 * So, unless you really know what you are doing, it's best not to try
2750 * to use the main loop polling stuff for your own needs on
2751 * Win32. It's really only written for the GIMP's needs so
2755 typedef struct _GPollFD GPollFD;
2756 typedef gint (*GPollFunc) (GPollFD *ufds,
2766 void g_main_add_poll (GPollFD *fd,
2768 void g_main_remove_poll (GPollFD *fd);
2769 void g_main_set_poll_func (GPollFunc func);
2771 /* On Unix, IO channels created with this function for any file
2772 * descriptor or socket.
2774 * On Win32, use this only for plain files opened with the MSVCRT (the
2775 * Microsoft run-time C library) _open(), including file descriptors
2776 * 0, 1 and 2 (corresponding to stdin, stdout and stderr).
2777 * Actually, don't do even that, this code isn't done yet.
2779 * The term file descriptor as used in the context of Win32 refers to
2780 * the emulated Unix-like file descriptors MSVCRT provides.
2782 GIOChannel* g_io_channel_unix_new (int fd);
2783 gint g_io_channel_unix_get_fd (GIOChannel *channel);
2787 GUTILS_C_VAR guint g_pipe_readable_msg;
2789 #define G_WIN32_MSG_HANDLE 19981206
2791 /* This is used to add polling for Windows messages. GDK (GTk+) programs
2792 * should *not* use this. (In fact, I can't think of any program that
2793 * would want to use this, but it's here just for completeness's sake.
2795 void g_main_poll_win32_msg_add(gint priority,
2799 /* An IO channel for Windows messages for window handle hwnd. */
2800 GIOChannel *g_io_channel_win32_new_messages (guint hwnd);
2802 /* An IO channel for an anonymous pipe as returned from the MSVCRT
2803 * _pipe(), with no mechanism for the writer to tell the reader when
2804 * there is data in the pipe.
2806 * This is not really implemented yet.
2808 GIOChannel *g_io_channel_win32_new_pipe (int fd);
2810 /* An IO channel for a pipe as returned from the MSVCRT _pipe(), with
2811 * Windows user messages used to signal data in the pipe for the
2814 * fd is the file descriptor. For the write end, peer is the thread id
2815 * of the reader, and peer_fd is his file descriptor for the read end
2818 * This is used by the GIMP, and works.
2820 GIOChannel *g_io_channel_win32_new_pipe_with_wakeups (int fd,
2824 void g_io_channel_win32_pipe_request_wakeups (GIOChannel *channel,
2828 void g_io_channel_win32_pipe_readable (int fd,
2831 /* Get the C runtime file descriptor of a channel. */
2832 gint g_io_channel_win32_get_fd (GIOChannel *channel);
2834 /* An IO channel for a SOCK_STREAM winsock socket. The parameter is
2835 * actually a SOCKET.
2837 GIOChannel *g_io_channel_win32_new_stream_socket (int socket);
2841 /* Windows emulation stubs for common Unix functions
2844 # define MAXPATHLEN 1024
2851 * To get prototypes for the following POSIXish functions, you have to
2852 * include the indicated non-POSIX headers. The functions are defined
2853 * in OLDNAMES.LIB (MSVC) or -lmoldname-msvc (mingw32).
2855 * getcwd: <direct.h> (MSVC), <io.h> (mingw32)
2856 * getpid: <process.h>
2858 * unlink: <stdio.h> or <io.h>
2859 * open, read, write, lseek, close: <io.h>
2864 /* pipe is not in OLDNAMES.LIB or -lmoldname-msvc. */
2865 #define pipe(phandles) _pipe (phandles, 4096, _O_BINARY)
2867 /* For some POSIX functions that are not provided by the MS runtime,
2868 * we provide emulators in glib, which are prefixed with g_win32_.
2870 # define ftruncate(fd, size) g_win32_ftruncate (fd, size)
2872 /* -lmingw32 also has emulations for these, but we need our own
2873 * for MSVC anyhow, so we might aswell use them always.
2875 # define opendir g_win32_opendir
2876 # define readdir g_win32_readdir
2877 # define rewinddir g_win32_rewinddir
2878 # define closedir g_win32_closedir
2879 # define NAME_MAX 255
2884 gboolean just_opened;
2885 guint find_file_handle;
2886 gpointer find_file_data;
2888 typedef struct DIR DIR;
2891 gchar d_name[NAME_MAX + 1];
2893 /* emulation functions */
2894 extern int g_win32_ftruncate (gint f,
2896 DIR* g_win32_opendir (const gchar *dirname);
2897 struct dirent* g_win32_readdir (DIR *dir);
2898 void g_win32_rewinddir (DIR *dir);
2899 gint g_win32_closedir (DIR *dir);
2901 /* The MS setlocale uses locale names of the form "English_United
2902 * States.1252" etc. We want the Unixish standard form "en", "zh_TW"
2903 * etc. This function gets the current thread locale from Windows and
2904 * returns it as a string of the above form for use in forming file
2905 * names etc. The returned string should be deallocated with g_free().
2907 gchar * g_win32_getlocale (void);
2909 #endif /* G_OS_WIN32 */
2912 /* GLib Thread support
2915 typedef void (*GThreadFunc) (gpointer value);
2919 G_THREAD_PRIORITY_LOW,
2920 G_THREAD_PRIORITY_NORMAL,
2921 G_THREAD_PRIORITY_HIGH,
2922 G_THREAD_PRIORITY_URGENT
2925 typedef struct _GThread GThread;
2928 GThreadPriority priority;
2933 typedef struct _GMutex GMutex;
2934 typedef struct _GCond GCond;
2935 typedef struct _GPrivate GPrivate;
2936 typedef struct _GStaticPrivate GStaticPrivate;
2938 typedef struct _GThreadFunctions GThreadFunctions;
2939 struct _GThreadFunctions
2941 GMutex* (*mutex_new) (void);
2942 void (*mutex_lock) (GMutex *mutex);
2943 gboolean (*mutex_trylock) (GMutex *mutex);
2944 void (*mutex_unlock) (GMutex *mutex);
2945 void (*mutex_free) (GMutex *mutex);
2946 GCond* (*cond_new) (void);
2947 void (*cond_signal) (GCond *cond);
2948 void (*cond_broadcast) (GCond *cond);
2949 void (*cond_wait) (GCond *cond,
2951 gboolean (*cond_timed_wait) (GCond *cond,
2953 GTimeVal *end_time);
2954 void (*cond_free) (GCond *cond);
2955 GPrivate* (*private_new) (GDestroyNotify destructor);
2956 gpointer (*private_get) (GPrivate *private_key);
2957 void (*private_set) (GPrivate *private_key,
2959 void (*thread_create) (GThreadFunc thread_func,
2964 GThreadPriority priority,
2966 void (*thread_yield) (void);
2967 void (*thread_join) (gpointer thread);
2968 void (*thread_exit) (void);
2969 void (*thread_set_priority)(gpointer thread,
2970 GThreadPriority priority);
2971 void (*thread_self) (gpointer thread);
2974 GUTILS_C_VAR GThreadFunctions g_thread_functions_for_glib_use;
2975 GUTILS_C_VAR gboolean g_thread_use_default_impl;
2976 GUTILS_C_VAR gboolean g_threads_got_initialized;
2978 /* initializes the mutex/cond/private implementation for glib, might
2979 * only be called once, and must not be called directly or indirectly
2980 * from another glib-function, e.g. as a callback.
2982 void g_thread_init (GThreadFunctions *vtable);
2984 /* internal function for fallback static mutex implementation */
2985 GMutex* g_static_mutex_get_mutex_impl (GMutex **mutex);
2987 /* shorthands for conditional and unconditional function calls */
2988 #define G_THREAD_UF(name, arglist) \
2989 (*g_thread_functions_for_glib_use . name) arglist
2990 #define G_THREAD_CF(name, fail, arg) \
2991 (g_thread_supported () ? G_THREAD_UF (name, arg) : (fail))
2992 /* keep in mind, all those mutexes and static mutexes are not
2993 * recursive in general, don't rely on that
2995 #define g_thread_supported() (g_threads_got_initialized)
2996 #define g_mutex_new() G_THREAD_UF (mutex_new, ())
2997 #define g_mutex_lock(mutex) G_THREAD_CF (mutex_lock, (void)0, (mutex))
2998 #define g_mutex_trylock(mutex) G_THREAD_CF (mutex_trylock, TRUE, (mutex))
2999 #define g_mutex_unlock(mutex) G_THREAD_CF (mutex_unlock, (void)0, (mutex))
3000 #define g_mutex_free(mutex) G_THREAD_CF (mutex_free, (void)0, (mutex))
3001 #define g_cond_new() G_THREAD_UF (cond_new, ())
3002 #define g_cond_signal(cond) G_THREAD_CF (cond_signal, (void)0, (cond))
3003 #define g_cond_broadcast(cond) G_THREAD_CF (cond_broadcast, (void)0, (cond))
3004 #define g_cond_wait(cond, mutex) G_THREAD_CF (cond_wait, (void)0, (cond, \
3006 #define g_cond_free(cond) G_THREAD_CF (cond_free, (void)0, (cond))
3007 #define g_cond_timed_wait(cond, mutex, abs_time) G_THREAD_CF (cond_timed_wait, \
3011 #define g_private_new(destructor) G_THREAD_UF (private_new, (destructor))
3012 #define g_private_get(private_key) G_THREAD_CF (private_get, \
3013 ((gpointer)private_key), \
3015 #define g_private_set(private_key, value) G_THREAD_CF (private_set, \
3016 (void) (private_key = \
3017 (GPrivate*) (value)), \
3018 (private_key, value))
3019 #define g_thread_yield() G_THREAD_CF (thread_yield, (void)0, ())
3020 #define g_thread_exit() G_THREAD_CF (thread_exit, (void)0, ())
3022 GThread* g_thread_create (GThreadFunc thread_func,
3027 GThreadPriority priority);
3028 GThread* g_thread_self ();
3029 void g_thread_join (GThread* thread);
3030 void g_thread_set_priority (GThread* thread,
3031 GThreadPriority priority);
3033 /* GStaticMutexes can be statically initialized with the value
3034 * G_STATIC_MUTEX_INIT, and then they can directly be used, that is
3035 * much easier, than having to explicitly allocate the mutex before
3038 #define g_static_mutex_lock(mutex) \
3039 g_mutex_lock (g_static_mutex_get_mutex (mutex))
3040 #define g_static_mutex_trylock(mutex) \
3041 g_mutex_trylock (g_static_mutex_get_mutex (mutex))
3042 #define g_static_mutex_unlock(mutex) \
3043 g_mutex_unlock (g_static_mutex_get_mutex (mutex))
3045 struct _GStaticPrivate
3049 #define G_STATIC_PRIVATE_INIT { 0 }
3050 gpointer g_static_private_get (GStaticPrivate *private_key);
3051 void g_static_private_set (GStaticPrivate *private_key,
3053 GDestroyNotify notify);
3054 gpointer g_static_private_get_for_thread (GStaticPrivate *private_key,
3056 void g_static_private_set_for_thread (GStaticPrivate *private_key,
3059 GDestroyNotify notify);
3060 #ifndef G_STATIC_REC_MUTEX_INIT
3061 /* if GStaticRecMutex is not just a differently initialized GStaticMutex,
3062 * the following is done:
3063 * This can't be done in glibconfig.h, as GStaticPrivate and gboolean
3064 * are not yet known there
3066 typedef struct _GStaticRecMutex GStaticRecMutex;
3067 struct _GStaticRecMutex
3070 GStaticPrivate counter;
3072 #define G_STATIC_REC_MUTEX_INIT { G_STATIC_MUTEX_INIT, G_STATIC_PRIVATE_INIT }
3073 void g_static_rec_mutex_lock (GStaticRecMutex* mutex);
3074 gboolean g_static_rec_mutex_trylock (GStaticRecMutex* mutex);
3075 void g_static_rec_mutex_unlock (GStaticRecMutex* mutex);
3076 #define g_static_rec_mutex_get_mutex(mutex) ((mutex)->mutex)
3077 #endif /* G_STATIC_REC_MUTEX_INIT */
3079 typedef struct _GStaticRWLock GStaticRWLock;
3080 struct _GStaticRWLock
3087 guint want_to_write;
3090 #define G_STATIC_RW_LOCK_INIT { G_STATIC_MUTEX_INIT, NULL, NULL, 0, FALSE, FALSE }
3092 void g_static_rw_lock_reader_lock (GStaticRWLock* lock);
3093 gboolean g_static_rw_lock_reader_trylock (GStaticRWLock* lock);
3094 void g_static_rw_lock_reader_unlock (GStaticRWLock* lock);
3095 void g_static_rw_lock_writer_lock (GStaticRWLock* lock);
3096 gboolean g_static_rw_lock_writer_trylock (GStaticRWLock* lock);
3097 void g_static_rw_lock_writer_unlock (GStaticRWLock* lock);
3098 void g_static_rw_lock_free (GStaticRWLock* lock);
3100 /* these are some convenience macros that expand to nothing if GLib
3101 * was configured with --disable-threads. for using StaticMutexes,
3102 * you define them with G_LOCK_DEFINE_STATIC (name) or G_LOCK_DEFINE (name)
3103 * if you need to export the mutex. With G_LOCK_EXTERN (name) you can
3104 * declare such an globally defined lock. name is a unique identifier
3105 * for the protected varibale or code portion. locking, testing and
3106 * unlocking of such mutexes can be done with G_LOCK(), G_UNLOCK() and
3107 * G_TRYLOCK() respectively.
3109 extern void glib_dummy_decl (void);
3110 #define G_LOCK_NAME(name) (g__ ## name ## _lock)
3111 #ifdef G_THREADS_ENABLED
3112 # define G_LOCK_DEFINE_STATIC(name) static G_LOCK_DEFINE (name)
3113 # define G_LOCK_DEFINE(name) \
3114 GStaticMutex G_LOCK_NAME (name) = G_STATIC_MUTEX_INIT
3115 # define G_LOCK_EXTERN(name) extern GStaticMutex G_LOCK_NAME (name)
3117 # ifdef G_DEBUG_LOCKS
3118 # define G_LOCK(name) G_STMT_START{ \
3119 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
3120 "file %s: line %d (%s): locking: %s ", \
3121 __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION, \
3123 g_static_mutex_lock (&G_LOCK_NAME (name)); \
3125 # define G_UNLOCK(name) G_STMT_START{ \
3126 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
3127 "file %s: line %d (%s): unlocking: %s ", \
3128 __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION, \
3130 g_static_mutex_unlock (&G_LOCK_NAME (name)); \
3132 # define G_TRYLOCK(name) G_STMT_START{ \
3133 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
3134 "file %s: line %d (%s): try locking: %s ", \
3135 __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION, \
3137 }G_STMT_END, g_static_mutex_trylock (&G_LOCK_NAME (name))
3138 # else /* !G_DEBUG_LOCKS */
3139 # define G_LOCK(name) g_static_mutex_lock (&G_LOCK_NAME (name))
3140 # define G_UNLOCK(name) g_static_mutex_unlock (&G_LOCK_NAME (name))
3141 # define G_TRYLOCK(name) g_static_mutex_trylock (&G_LOCK_NAME (name))
3142 # endif /* !G_DEBUG_LOCKS */
3143 #else /* !G_THREADS_ENABLED */
3144 # define G_LOCK_DEFINE_STATIC(name) extern void glib_dummy_decl (void)
3145 # define G_LOCK_DEFINE(name) extern void glib_dummy_decl (void)
3146 # define G_LOCK_EXTERN(name) extern void glib_dummy_decl (void)
3147 # define G_LOCK(name)
3148 # define G_UNLOCK(name)
3149 # define G_TRYLOCK(name) (TRUE)
3150 #endif /* !G_THREADS_ENABLED */
3154 #endif /* __cplusplus */
3157 #endif /* __G_LIB_H__ */