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 provide the following wrappers to STDC functions:
58 * To register hooks which are executed on exit().
59 * Usually a wrapper for STDC atexit.
61 * void *g_memmove(void *dest, const void *src, guint count);
62 * A wrapper for STDC memmove, or an implementation, if memmove doesn't
63 * exist. The prototype looks like the above, give or take a const,
66 #include <glibconfig.h>
68 /* include varargs functions for assertment macros
72 /* optionally feature DMALLOC memory allocation debugger
81 /* On native Win32, directory separator is the backslash, and search path
82 * separator is the semicolon.
84 #define G_DIR_SEPARATOR '\\'
85 #define G_DIR_SEPARATOR_S "\\"
86 #define G_SEARCHPATH_SEPARATOR ';'
87 #define G_SEARCHPATH_SEPARATOR_S ";"
89 #else /* !NATIVE_WIN32 */
93 #define G_DIR_SEPARATOR '/'
94 #define G_DIR_SEPARATOR_S "/"
95 #define G_SEARCHPATH_SEPARATOR ':'
96 #define G_SEARCHPATH_SEPARATOR_S ":"
98 #endif /* !NATIVE_WIN32 */
102 #endif /* __cplusplus */
105 /* Provide definitions for some commonly used macros.
106 * Some of them are only provided if they haven't already
107 * been defined. It is assumed that if they are already
108 * defined then the current definition is correct.
111 #define NULL ((void*) 0)
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)))
135 /* Define G_VA_COPY() to do the right thing for copying va_list variables.
136 * glibconfig.h may have already defined G_VA_COPY as va_copy or __va_copy.
138 #if !defined (G_VA_COPY)
139 # if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
140 # define G_VA_COPY(ap1, ap2) (*(ap1) = *(ap2))
141 # elif defined (G_VA_COPY_AS_ARRAY)
142 # define G_VA_COPY(ap1, ap2) g_memmove ((ap1), (ap2), sizeof (va_list))
143 # else /* va_list is a pointer */
144 # define G_VA_COPY(ap1, ap2) ((ap1) = (ap2))
145 # endif /* va_list is a pointer */
146 #endif /* !G_VA_COPY */
149 /* Provide convenience macros for handling structure
150 * fields through their offsets.
152 #define G_STRUCT_OFFSET(struct_type, member) \
153 ((gulong) ((gchar*) &((struct_type*) 0)->member))
154 #define G_STRUCT_MEMBER_P(struct_p, struct_offset) \
155 ((gpointer) ((gchar*) (struct_p) + (gulong) (struct_offset)))
156 #define G_STRUCT_MEMBER(member_type, struct_p, struct_offset) \
157 (*(member_type*) G_STRUCT_MEMBER_P ((struct_p), (struct_offset)))
160 /* inlining hassle. for compilers that don't allow the `inline' keyword,
161 * mostly because of strict ANSI C compliance or dumbness, we try to fall
162 * back to either `__inline__' or `__inline'.
163 * we define G_CAN_INLINE, if the compiler seems to be actually
164 * *capable* to do function inlining, in which case inline function bodys
165 * do make sense. we also define G_INLINE_FUNC to properly export the
166 * function prototypes if no inlining can be performed.
167 * we special case most of the stuff, so inline functions can have a normal
168 * implementation by defining G_INLINE_FUNC to extern and G_CAN_INLINE to 1.
170 #ifndef G_INLINE_FUNC
171 # define G_CAN_INLINE 1
174 # if defined (__GNUC__) && defined (__STRICT_ANSI__)
176 # define inline __inline__
178 #else /* !G_HAVE_INLINE */
180 # if defined (G_HAVE___INLINE__)
181 # define inline __inline__
182 # else /* !inline && !__inline__ */
183 # if defined (G_HAVE___INLINE)
184 # define inline __inline
185 # else /* !inline && !__inline__ && !__inline */
186 # define inline /* don't inline, then */
187 # ifndef G_INLINE_FUNC
193 #ifndef G_INLINE_FUNC
196 # define G_INLINE_FUNC extern inline
199 # define G_INLINE_FUNC extern
201 # else /* !__GNUC__ */
203 # define G_INLINE_FUNC static inline
205 # define G_INLINE_FUNC extern
207 # endif /* !__GNUC__ */
208 #endif /* !G_INLINE_FUNC */
211 /* Provide simple macro statement wrappers (adapted from Perl):
212 * G_STMT_START { statements; } G_STMT_END;
213 * can be used as a single statement, as in
214 * if (x) G_STMT_START { ... } G_STMT_END; else ...
216 * For gcc we will wrap the statements within `({' and `})' braces.
217 * For SunOS they will be wrapped within `if (1)' and `else (void) 0',
218 * and otherwise within `do' and `while (0)'.
220 #if !(defined (G_STMT_START) && defined (G_STMT_END))
221 # if defined (__GNUC__) && !defined (__STRICT_ANSI__) && !defined (__cplusplus)
222 # define G_STMT_START (void)(
223 # define G_STMT_END )
225 # if (defined (sun) || defined (__sun__))
226 # define G_STMT_START if (1)
227 # define G_STMT_END else (void)0
229 # define G_STMT_START do
230 # define G_STMT_END while (0)
236 /* Provide macros to feature the GCC function attribute.
238 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
239 #define G_GNUC_PRINTF( format_idx, arg_idx ) \
240 __attribute__((format (printf, format_idx, arg_idx)))
241 #define G_GNUC_SCANF( format_idx, arg_idx ) \
242 __attribute__((format (scanf, format_idx, arg_idx)))
243 #define G_GNUC_FORMAT( arg_idx ) \
244 __attribute__((format_arg (arg_idx)))
245 #define G_GNUC_NORETURN \
246 __attribute__((noreturn))
247 #define G_GNUC_CONST \
248 __attribute__((const))
249 #define G_GNUC_UNUSED \
250 __attribute__((unused))
251 #else /* !__GNUC__ */
252 #define G_GNUC_PRINTF( format_idx, arg_idx )
253 #define G_GNUC_SCANF( format_idx, arg_idx )
254 #define G_GNUC_FORMAT( arg_idx )
255 #define G_GNUC_NORETURN
257 #define G_GNUC_UNUSED
258 #endif /* !__GNUC__ */
261 /* Wrap the gcc __PRETTY_FUNCTION__ and __FUNCTION__ variables with
262 * macros, so we can refer to them as strings unconditionally.
265 #define G_GNUC_FUNCTION (__FUNCTION__)
266 #define G_GNUC_PRETTY_FUNCTION (__PRETTY_FUNCTION__)
267 #else /* !__GNUC__ */
268 #define G_GNUC_FUNCTION ("")
269 #define G_GNUC_PRETTY_FUNCTION ("")
270 #endif /* !__GNUC__ */
272 /* we try to provide a usefull equivalent for ATEXIT if it is
273 * not defined, but use is actually abandoned. people should
274 * use g_atexit() instead.
277 # define ATEXIT(proc) g_ATEXIT(proc)
279 # define G_NATIVE_ATEXIT
282 /* Hacker macro to place breakpoints for elected machines.
283 * Actual use is strongly deprecated of course ;)
285 #if defined (__i386__) && defined (__GNUC__) && __GNUC__ >= 2
286 #define G_BREAKPOINT() G_STMT_START{ __asm__ __volatile__ ("int $03"); }G_STMT_END
287 #elif defined (__alpha__) && defined (__GNUC__) && __GNUC__ >= 2
288 #define G_BREAKPOINT() G_STMT_START{ __asm__ __volatile__ ("bpt"); }G_STMT_END
289 #else /* !__i386__ && !__alpha__ */
290 #define G_BREAKPOINT()
291 #endif /* __i386__ */
294 /* Provide macros for easily allocating memory. The macros
295 * will cast the allocated memory to the specified type
296 * in order to avoid compiler warnings. (Makes the code neater).
300 # define g_new(type, count) (ALLOC (type, count))
301 # define g_new0(type, count) (CALLOC (type, count))
302 # define g_renew(type, mem, count) (REALLOC (mem, type, count))
303 #else /* __DMALLOC_H__ */
304 # define g_new(type, count) \
305 ((type *) g_malloc ((unsigned) sizeof (type) * (count)))
306 # define g_new0(type, count) \
307 ((type *) g_malloc0 ((unsigned) sizeof (type) * (count)))
308 # define g_renew(type, mem, count) \
309 ((type *) g_realloc (mem, (unsigned) sizeof (type) * (count)))
310 #endif /* __DMALLOC_H__ */
312 #define g_mem_chunk_create(type, pre_alloc, alloc_type) ( \
313 g_mem_chunk_new (#type " mem chunks (" #pre_alloc ")", \
315 sizeof (type) * (pre_alloc), \
318 #define g_chunk_new(type, chunk) ( \
319 (type *) g_mem_chunk_alloc (chunk) \
321 #define g_chunk_new0(type, chunk) ( \
322 (type *) g_mem_chunk_alloc0 (chunk) \
324 #define g_chunk_free(mem, mem_chunk) G_STMT_START { \
325 g_mem_chunk_free ((mem_chunk), (mem)); \
329 #define g_string(x) #x
332 /* Provide macros for error handling. The "assert" macros will
333 * exit on failure. The "return" macros will exit the current
334 * function. Two different definitions are given for the macros
335 * if G_DISABLE_ASSERT is not defined, in order to support gcc's
336 * __PRETTY_FUNCTION__ capability.
339 #ifdef G_DISABLE_ASSERT
341 #define g_assert(expr)
342 #define g_assert_not_reached()
344 #else /* !G_DISABLE_ASSERT */
348 #define g_assert(expr) G_STMT_START{ \
350 g_log (G_LOG_DOMAIN, \
352 "file %s: line %d (%s): assertion failed: (%s)", \
355 __PRETTY_FUNCTION__, \
358 #define g_assert_not_reached() G_STMT_START{ \
359 g_log (G_LOG_DOMAIN, \
361 "file %s: line %d (%s): should not be reached", \
364 __PRETTY_FUNCTION__); }G_STMT_END
366 #else /* !__GNUC__ */
368 #define g_assert(expr) G_STMT_START{ \
370 g_log (G_LOG_DOMAIN, \
372 "file %s: line %d: assertion failed: (%s)", \
377 #define g_assert_not_reached() G_STMT_START{ \
378 g_log (G_LOG_DOMAIN, \
380 "file %s: line %d: should not be reached", \
382 __LINE__); }G_STMT_END
384 #endif /* __GNUC__ */
386 #endif /* !G_DISABLE_ASSERT */
389 #ifdef G_DISABLE_CHECKS
391 #define g_return_if_fail(expr)
392 #define g_return_val_if_fail(expr,val)
394 #else /* !G_DISABLE_CHECKS */
398 #define g_return_if_fail(expr) G_STMT_START{ \
401 g_log (G_LOG_DOMAIN, \
402 G_LOG_LEVEL_CRITICAL, \
403 "file %s: line %d (%s): assertion `%s' failed.", \
406 __PRETTY_FUNCTION__, \
411 #define g_return_val_if_fail(expr,val) G_STMT_START{ \
414 g_log (G_LOG_DOMAIN, \
415 G_LOG_LEVEL_CRITICAL, \
416 "file %s: line %d (%s): assertion `%s' failed.", \
419 __PRETTY_FUNCTION__, \
424 #else /* !__GNUC__ */
426 #define g_return_if_fail(expr) G_STMT_START{ \
429 g_log (G_LOG_DOMAIN, \
430 G_LOG_LEVEL_CRITICAL, \
431 "file %s: line %d: assertion `%s' failed.", \
438 #define g_return_val_if_fail(expr, val) G_STMT_START{ \
441 g_log (G_LOG_DOMAIN, \
442 G_LOG_LEVEL_CRITICAL, \
443 "file %s: line %d: assertion `%s' failed.", \
450 #endif /* !__GNUC__ */
452 #endif /* !G_DISABLE_CHECKS */
455 /* Provide type definitions for commonly used types.
456 * These are useful because a "gint8" can be adjusted
457 * to be 1 byte (8 bits) on all platforms. Similarly and
458 * more importantly, "gint32" can be adjusted to be
459 * 4 bytes (32 bits) on all platforms.
463 typedef short gshort;
466 typedef gint gboolean;
468 typedef unsigned char guchar;
469 typedef unsigned short gushort;
470 typedef unsigned long gulong;
471 typedef unsigned int guint;
473 #define G_GSHORT_FORMAT "hi"
474 #define G_GUSHORT_FORMAT "hu"
475 #define G_GINT_FORMAT "i"
476 #define G_GUINT_FORMAT "u"
477 #define G_GLONG_FORMAT "li"
478 #define G_GULONG_FORMAT "lu"
480 typedef float gfloat;
481 typedef double gdouble;
483 /* HAVE_LONG_DOUBLE doesn't work correctly on all platforms.
484 * Since gldouble isn't used anywhere, just disable it for now */
487 #ifdef HAVE_LONG_DOUBLE
488 typedef long double gldouble;
489 #else /* HAVE_LONG_DOUBLE */
490 typedef double gldouble;
491 #endif /* HAVE_LONG_DOUBLE */
494 typedef void* gpointer;
495 typedef const void *gconstpointer;
498 typedef gint32 gssize;
499 typedef guint32 gsize;
500 typedef guint32 GQuark;
501 typedef gint32 GTime;
504 /* Portable endian checks and conversions
506 * glibconfig.h defines G_BYTE_ORDER which expands to one of
509 #define G_LITTLE_ENDIAN 1234
510 #define G_BIG_ENDIAN 4321
511 #define G_PDP_ENDIAN 3412 /* unused, need specific PDP check */
514 /* Basic bit swapping functions
516 #define GUINT16_SWAP_LE_BE_CONSTANT(val) ((guint16) ( \
517 (((guint16) (val) & (guint16) 0x00ffU) << 8) | \
518 (((guint16) (val) & (guint16) 0xff00U) >> 8)))
519 #define GUINT32_SWAP_LE_BE_CONSTANT(val) ((guint32) ( \
520 (((guint32) (val) & (guint32) 0x000000ffU) << 24) | \
521 (((guint32) (val) & (guint32) 0x0000ff00U) << 8) | \
522 (((guint32) (val) & (guint32) 0x00ff0000U) >> 8) | \
523 (((guint32) (val) & (guint32) 0xff000000U) >> 24)))
525 /* Intel specific stuff for speed
527 #if defined (__i386__) && defined (__GNUC__) && __GNUC__ >= 2
528 # define GUINT16_SWAP_LE_BE_X86(val) \
530 ({ register guint16 __v; \
531 if (__builtin_constant_p (val)) \
532 __v = GUINT16_SWAP_LE_BE_CONSTANT (val); \
534 __asm__ __const__ ("rorw $8, %w0" \
536 : "0" ((guint16) (val))); \
538 # define GUINT16_SWAP_LE_BE(val) (GUINT16_SWAP_LE_BE_X86 (val))
539 # if !defined(__i486__) && !defined(__i586__) \
540 && !defined(__pentium__) && !defined(__i686__) && !defined(__pentiumpro__)
541 # define GUINT32_SWAP_LE_BE_X86(val) \
543 ({ register guint32 __v; \
544 if (__builtin_constant_p (val)) \
545 __v = GUINT32_SWAP_LE_BE_CONSTANT (val); \
547 __asm__ __const__ ("rorw $8, %w0\n\t" \
551 : "0" ((guint32) (val))); \
553 # else /* 486 and higher has bswap */
554 # define GUINT32_SWAP_LE_BE_X86(val) \
556 ({ register guint32 __v; \
557 if (__builtin_constant_p (val)) \
558 __v = GUINT32_SWAP_LE_BE_CONSTANT (val); \
560 __asm__ __const__ ("bswap %0" \
562 : "0" ((guint32) (val))); \
564 # endif /* processor specific 32-bit stuff */
565 # define GUINT32_SWAP_LE_BE(val) (GUINT32_SWAP_LE_BE_X86 (val))
566 #else /* !__i386__ */
567 # define GUINT16_SWAP_LE_BE(val) (GUINT16_SWAP_LE_BE_CONSTANT (val))
568 # define GUINT32_SWAP_LE_BE(val) (GUINT32_SWAP_LE_BE_CONSTANT (val))
569 #endif /* __i386__ */
572 # define GUINT64_SWAP_LE_BE_CONSTANT(val) ((guint64) ( \
573 (((guint64) (val) & \
574 (guint64) G_GINT64_CONSTANT(0x00000000000000ffU)) << 56) | \
575 (((guint64) (val) & \
576 (guint64) G_GINT64_CONSTANT(0x000000000000ff00U)) << 40) | \
577 (((guint64) (val) & \
578 (guint64) G_GINT64_CONSTANT(0x0000000000ff0000U)) << 24) | \
579 (((guint64) (val) & \
580 (guint64) G_GINT64_CONSTANT(0x00000000ff000000U)) << 8) | \
581 (((guint64) (val) & \
582 (guint64) G_GINT64_CONSTANT(0x000000ff00000000U)) >> 8) | \
583 (((guint64) (val) & \
584 (guint64) G_GINT64_CONSTANT(0x0000ff0000000000U)) >> 24) | \
585 (((guint64) (val) & \
586 (guint64) G_GINT64_CONSTANT(0x00ff000000000000U)) >> 40) | \
587 (((guint64) (val) & \
588 (guint64) G_GINT64_CONSTANT(0xff00000000000000U)) >> 56)))
589 # if defined (__i386__) && defined (__GNUC__) && __GNUC__ >= 2
590 # define GUINT64_SWAP_LE_BE_X86(val) \
592 ({ union { guint64 __ll; \
593 guint32 __l[2]; } __r; \
594 if (__builtin_constant_p (val)) \
595 __r.__ll = GUINT64_SWAP_LE_BE_CONSTANT (val); \
598 union { guint64 __ll; \
599 guint32 __l[2]; } __w; \
600 __w.__ll = ((guint64) val); \
601 __r.__l[0] = GUINT32_SWAP_LE_BE (__w.__l[1]); \
602 __r.__l[1] = GUINT32_SWAP_LE_BE (__w.__l[0]); \
605 # define GUINT64_SWAP_LE_BE(val) (GUINT64_SWAP_LE_BE_X86 (val))
606 # else /* !__i386__ */
607 # define GUINT64_SWAP_LE_BE(val) (GUINT64_SWAP_LE_BE_CONSTANT(val))
611 #define GUINT16_SWAP_LE_PDP(val) ((guint16) (val))
612 #define GUINT16_SWAP_BE_PDP(val) (GUINT16_SWAP_LE_BE (val))
613 #define GUINT32_SWAP_LE_PDP(val) ((guint32) ( \
614 (((guint32) (val) & (guint32) 0x0000ffffU) << 16) | \
615 (((guint32) (val) & (guint32) 0xffff0000U) >> 16)))
616 #define GUINT32_SWAP_BE_PDP(val) ((guint32) ( \
617 (((guint32) (val) & (guint32) 0x00ff00ffU) << 8) | \
618 (((guint32) (val) & (guint32) 0xff00ff00U) >> 8)))
620 /* The G*_TO_?E() macros are defined in glibconfig.h.
621 * The transformation is symmetric, so the FROM just maps to the TO.
623 #define GINT16_FROM_LE(val) (GINT16_TO_LE (val))
624 #define GUINT16_FROM_LE(val) (GUINT16_TO_LE (val))
625 #define GINT16_FROM_BE(val) (GINT16_TO_BE (val))
626 #define GUINT16_FROM_BE(val) (GUINT16_TO_BE (val))
627 #define GINT32_FROM_LE(val) (GINT32_TO_LE (val))
628 #define GUINT32_FROM_LE(val) (GUINT32_TO_LE (val))
629 #define GINT32_FROM_BE(val) (GINT32_TO_BE (val))
630 #define GUINT32_FROM_BE(val) (GUINT32_TO_BE (val))
633 #define GINT64_FROM_LE(val) (GINT64_TO_LE (val))
634 #define GUINT64_FROM_LE(val) (GUINT64_TO_LE (val))
635 #define GINT64_FROM_BE(val) (GINT64_TO_BE (val))
636 #define GUINT64_FROM_BE(val) (GUINT64_TO_BE (val))
639 #define GLONG_FROM_LE(val) (GLONG_TO_LE (val))
640 #define GULONG_FROM_LE(val) (GULONG_TO_LE (val))
641 #define GLONG_FROM_BE(val) (GLONG_TO_BE (val))
642 #define GULONG_FROM_BE(val) (GULONG_TO_BE (val))
644 #define GINT_FROM_LE(val) (GINT_TO_LE (val))
645 #define GUINT_FROM_LE(val) (GUINT_TO_LE (val))
646 #define GINT_FROM_BE(val) (GINT_TO_BE (val))
647 #define GUINT_FROM_BE(val) (GUINT_TO_BE (val))
650 /* Portable versions of host-network order stuff
652 #define g_ntohl(val) (GUINT32_FROM_BE (val))
653 #define g_ntohs(val) (GUINT16_FROM_BE (val))
654 #define g_htonl(val) (GUINT32_TO_BE (val))
655 #define g_htons(val) (GUINT16_TO_BE (val))
659 * we prefix variable declarations so they can
660 * properly get exported in windows dlls.
663 # ifdef GLIB_COMPILATION
664 # define GUTILS_C_VAR __declspec(dllexport)
665 # else /* !GLIB_COMPILATION */
666 # define GUTILS_C_VAR extern __declspec(dllimport)
667 # endif /* !GLIB_COMPILATION */
668 #else /* !NATIVE_WIN32 */
669 # define GUTILS_C_VAR extern
670 #endif /* !NATIVE_WIN32 */
672 GUTILS_C_VAR const guint glib_major_version;
673 GUTILS_C_VAR const guint glib_minor_version;
674 GUTILS_C_VAR const guint glib_micro_version;
675 GUTILS_C_VAR const guint glib_interface_age;
676 GUTILS_C_VAR const guint glib_binary_age;
679 /* Forward declarations of glib types.
681 typedef struct _GAllocator GAllocator;
682 typedef struct _GArray GArray;
683 typedef struct _GByteArray GByteArray;
684 typedef struct _GCache GCache;
685 typedef struct _GCompletion GCompletion;
686 typedef struct _GData GData;
687 typedef struct _GDebugKey GDebugKey;
688 typedef struct _GHashTable GHashTable;
689 typedef struct _GHook GHook;
690 typedef struct _GHookList GHookList;
691 typedef struct _GList GList;
692 typedef struct _GMemChunk GMemChunk;
693 typedef struct _GNode GNode;
694 typedef struct _GPtrArray GPtrArray;
695 typedef struct _GQueue GQueue;
696 typedef struct _GRelation GRelation;
697 typedef struct _GScanner GScanner;
698 typedef struct _GScannerConfig GScannerConfig;
699 typedef struct _GSList GSList;
700 typedef struct _GStack GStack;
701 typedef struct _GString GString;
702 typedef struct _GStringChunk GStringChunk;
703 typedef struct _GTimer GTimer;
704 typedef struct _GTree GTree;
705 typedef struct _GTuples GTuples;
706 typedef union _GTokenValue GTokenValue;
707 typedef struct _GIOChannel GIOChannel;
711 G_TRAVERSE_LEAFS = 1 << 0,
712 G_TRAVERSE_NON_LEAFS = 1 << 1,
713 G_TRAVERSE_ALL = G_TRAVERSE_LEAFS | G_TRAVERSE_NON_LEAFS,
714 G_TRAVERSE_MASK = 0x03
725 /* Log level shift offset for user defined
726 * log levels (0-7 are used by GLib).
728 #define G_LOG_LEVEL_USER_SHIFT (8)
730 /* Glib log levels and flags.
735 G_LOG_FLAG_RECURSION = 1 << 0,
736 G_LOG_FLAG_FATAL = 1 << 1,
738 /* GLib log levels */
739 G_LOG_LEVEL_ERROR = 1 << 2, /* always fatal */
740 G_LOG_LEVEL_CRITICAL = 1 << 3,
741 G_LOG_LEVEL_WARNING = 1 << 4,
742 G_LOG_LEVEL_MESSAGE = 1 << 5,
743 G_LOG_LEVEL_INFO = 1 << 6,
744 G_LOG_LEVEL_DEBUG = 1 << 7,
746 G_LOG_LEVEL_MASK = ~(G_LOG_FLAG_RECURSION | G_LOG_FLAG_FATAL)
749 /* GLib log levels that are considered fatal by default */
750 #define G_LOG_FATAL_MASK (G_LOG_FLAG_RECURSION | G_LOG_LEVEL_ERROR)
753 typedef gpointer (*GCacheNewFunc) (gpointer key);
754 typedef gpointer (*GCacheDupFunc) (gpointer value);
755 typedef void (*GCacheDestroyFunc) (gpointer value);
756 typedef gint (*GCompareFunc) (gconstpointer a,
758 typedef gchar* (*GCompletionFunc) (gpointer);
759 typedef void (*GDestroyNotify) (gpointer data);
760 typedef void (*GDataForeachFunc) (GQuark key_id,
763 typedef void (*GFunc) (gpointer data,
765 typedef guint (*GHashFunc) (gconstpointer key);
766 typedef void (*GFreeFunc) (gpointer data);
767 typedef void (*GHFunc) (gpointer key,
770 typedef gboolean (*GHRFunc) (gpointer key,
773 typedef gint (*GHookCompareFunc) (GHook *new_hook,
775 typedef gboolean (*GHookFindFunc) (GHook *hook,
777 typedef void (*GHookMarshaller) (GHook *hook,
779 typedef gboolean (*GHookCheckMarshaller) (GHook *hook,
781 typedef void (*GHookFunc) (gpointer data);
782 typedef gboolean (*GHookCheckFunc) (gpointer data);
783 typedef void (*GHookFreeFunc) (GHookList *hook_list,
785 typedef void (*GLogFunc) (const gchar *log_domain,
786 GLogLevelFlags log_level,
787 const gchar *message,
789 typedef gboolean (*GNodeTraverseFunc) (GNode *node,
791 typedef void (*GNodeForeachFunc) (GNode *node,
793 typedef gint (*GSearchFunc) (gpointer key,
795 typedef void (*GScannerMsgFunc) (GScanner *scanner,
798 typedef gint (*GTraverseFunc) (gpointer key,
801 typedef void (*GVoidFunc) (void);
865 /* Doubly linked lists
867 void g_list_push_allocator (GAllocator *allocator);
868 void g_list_pop_allocator (void);
869 GList* g_list_alloc (void);
870 void g_list_free (GList *list);
871 void g_list_free_1 (GList *list);
872 GList* g_list_append (GList *list,
874 GList* g_list_prepend (GList *list,
876 GList* g_list_insert (GList *list,
879 GList* g_list_insert_sorted (GList *list,
882 GList* g_list_concat (GList *list1,
884 GList* g_list_delete (GList *list,
886 GList* g_list_remove (GList *list,
888 GList* g_list_remove_link (GList *list,
890 GList* g_list_reverse (GList *list);
891 GList* g_list_copy (GList *list);
892 GList* g_list_nth (GList *list,
894 GList* g_list_find (GList *list,
896 GList* g_list_find_custom (GList *list,
899 gint g_list_position (GList *list,
901 gint g_list_index (GList *list,
903 GList* g_list_last (GList *list);
904 GList* g_list_first (GList *list);
905 guint g_list_length (GList *list);
906 void g_list_foreach (GList *list,
909 GList* g_list_sort (GList *list,
910 GCompareFunc compare_func);
911 gpointer g_list_nth_data (GList *list,
913 #define g_list_previous(list) ((list) ? (((GList *)(list))->prev) : NULL)
914 #define g_list_next(list) ((list) ? (((GList *)(list))->next) : NULL)
917 /* Singly linked lists
919 void g_slist_push_allocator (GAllocator *allocator);
920 void g_slist_pop_allocator (void);
921 GSList* g_slist_alloc (void);
922 void g_slist_free (GSList *list);
923 void g_slist_free_1 (GSList *list);
924 GSList* g_slist_append (GSList *list,
926 GSList* g_slist_prepend (GSList *list,
928 GSList* g_slist_insert (GSList *list,
931 GSList* g_slist_insert_sorted (GSList *list,
934 GSList* g_slist_concat (GSList *list1,
936 GSList* g_slist_remove (GSList *list,
938 GSList* g_slist_remove_link (GSList *list,
940 GSList* g_slist_reverse (GSList *list);
941 GSList* g_slist_copy (GSList *list);
942 GSList* g_slist_nth (GSList *list,
944 GSList* g_slist_find (GSList *list,
946 GSList* g_slist_find_custom (GSList *list,
949 gint g_slist_position (GSList *list,
951 gint g_slist_index (GSList *list,
953 GSList* g_slist_last (GSList *list);
954 guint g_slist_length (GSList *list);
955 void g_slist_foreach (GSList *list,
958 GSList* g_slist_sort (GSList *list,
959 GCompareFunc compare_func);
960 gpointer g_slist_nth_data (GSList *list,
962 #define g_slist_next(slist) ((slist) ? (((GSList *)(slist))->next) : NULL)
968 GStack * g_stack_new (void);
969 void g_stack_free (GStack *stack);
970 gpointer g_stack_pop (GStack *stack);
972 #define g_stack_empty(stack) \
973 ((((GStack *)(stack)) && ((GStack *)(stack))->list) ? FALSE : TRUE)
975 #define g_stack_peek(stack) \
976 ((((GStack *)(stack)) && ((GStack *)(stack))->list) ? \
977 ((GStack *)(stack))->list->data : NULL)
979 #define g_stack_index(stack,ptr) \
980 ((((GStack *)(stack)) && ((GStack *)(stack))->list) ? \
981 g_list_index (((GStack *)(stack))->list, (ptr)) : -1)
983 #define g_stack_push(stack,data) G_STMT_START { \
984 if ((GStack *)(stack)) \
985 ((GStack *)(stack))->list = \
986 g_list_prepend (((GStack *)(stack))->list, (data)); \
994 GQueue * g_queue_new (void);
995 void g_queue_free (GQueue *q);
996 guint g_queue_get_size (GQueue *q);
997 void g_queue_push_front (GQueue *q, gpointer data);
998 void g_queue_push_back (GQueue *q, gpointer data);
999 gpointer g_queue_pop_front (GQueue *q);
1000 gpointer g_queue_pop_back (GQueue *q);
1002 #define g_queue_empty(queue) \
1003 ((((GQueue *)(queue)) && ((GQueue *)(queue))->list) ? FALSE : TRUE)
1005 #define g_queue_peek_front(queue) \
1006 ((((GQueue *)(queue)) && ((GQueue *)(queue))->list) ? \
1007 ((GQueue *)(queue))->list->data : NULL)
1009 #define g_queue_peek_back(queue) \
1010 ((((GQueue *)(queue)) && ((GQueue *)(queue))->list_end) ? \
1011 ((GQueue *)(queue))->list_end->data : NULL)
1013 #define g_queue_index(queue,ptr) \
1014 ((((GQueue *)(queue)) && ((GQueue *)(queue))->list) ? \
1015 g_list_index (((GQueue *)(queue))->list, (ptr)) : -1)
1017 #define g_queue_push g_queue_push_back
1018 #define g_queue_pop g_queue_pop_front
1019 #define g_queue_peek g_queue_peek_front
1027 GHashTable* g_hash_table_new (GHashFunc hash_func,
1028 GCompareFunc key_compare_func);
1029 void g_hash_table_destroy (GHashTable *hash_table);
1030 void g_hash_table_insert (GHashTable *hash_table,
1033 void g_hash_table_remove (GHashTable *hash_table,
1035 gpointer g_hash_table_lookup (GHashTable *hash_table,
1037 gboolean g_hash_table_lookup_extended(GHashTable *hash_table,
1038 gconstpointer lookup_key,
1041 void g_hash_table_freeze (GHashTable *hash_table);
1042 void g_hash_table_thaw (GHashTable *hash_table);
1043 void g_hash_table_foreach (GHashTable *hash_table,
1045 gpointer user_data);
1046 guint g_hash_table_foreach_remove (GHashTable *hash_table,
1048 gpointer user_data);
1049 guint g_hash_table_size (GHashTable *hash_table);
1054 GCache* g_cache_new (GCacheNewFunc value_new_func,
1055 GCacheDestroyFunc value_destroy_func,
1056 GCacheDupFunc key_dup_func,
1057 GCacheDestroyFunc key_destroy_func,
1058 GHashFunc hash_key_func,
1059 GHashFunc hash_value_func,
1060 GCompareFunc key_compare_func);
1061 void g_cache_destroy (GCache *cache);
1062 gpointer g_cache_insert (GCache *cache,
1064 void g_cache_remove (GCache *cache,
1066 void g_cache_key_foreach (GCache *cache,
1068 gpointer user_data);
1069 void g_cache_value_foreach (GCache *cache,
1071 gpointer user_data);
1074 /* Balanced binary trees
1076 GTree* g_tree_new (GCompareFunc key_compare_func);
1077 void g_tree_destroy (GTree *tree);
1078 void g_tree_insert (GTree *tree,
1081 void g_tree_remove (GTree *tree,
1083 gpointer g_tree_lookup (GTree *tree,
1085 void g_tree_traverse (GTree *tree,
1086 GTraverseFunc traverse_func,
1087 GTraverseType traverse_type,
1089 gpointer g_tree_search (GTree *tree,
1090 GSearchFunc search_func,
1092 gint g_tree_height (GTree *tree);
1093 gint g_tree_nnodes (GTree *tree);
1097 /* N-way tree implementation
1108 #define G_NODE_IS_ROOT(node) (((GNode*) (node))->parent == NULL && \
1109 ((GNode*) (node))->prev == NULL && \
1110 ((GNode*) (node))->next == NULL)
1111 #define G_NODE_IS_LEAF(node) (((GNode*) (node))->children == NULL)
1113 void g_node_push_allocator (GAllocator *allocator);
1114 void g_node_pop_allocator (void);
1115 GNode* g_node_new (gpointer data);
1116 void g_node_destroy (GNode *root);
1117 void g_node_unlink (GNode *node);
1118 GNode* g_node_insert (GNode *parent,
1121 GNode* g_node_insert_before (GNode *parent,
1124 GNode* g_node_prepend (GNode *parent,
1126 guint g_node_n_nodes (GNode *root,
1127 GTraverseFlags flags);
1128 GNode* g_node_get_root (GNode *node);
1129 gboolean g_node_is_ancestor (GNode *node,
1131 guint g_node_depth (GNode *node);
1132 GNode* g_node_find (GNode *root,
1133 GTraverseType order,
1134 GTraverseFlags flags,
1137 /* convenience macros */
1138 #define g_node_append(parent, node) \
1139 g_node_insert_before ((parent), NULL, (node))
1140 #define g_node_insert_data(parent, position, data) \
1141 g_node_insert ((parent), (position), g_node_new (data))
1142 #define g_node_insert_data_before(parent, sibling, data) \
1143 g_node_insert_before ((parent), (sibling), g_node_new (data))
1144 #define g_node_prepend_data(parent, data) \
1145 g_node_prepend ((parent), g_node_new (data))
1146 #define g_node_append_data(parent, data) \
1147 g_node_insert_before ((parent), NULL, g_node_new (data))
1149 /* traversal function, assumes that `node' is root
1150 * (only traverses `node' and its subtree).
1151 * this function is just a high level interface to
1152 * low level traversal functions, optimized for speed.
1154 void g_node_traverse (GNode *root,
1155 GTraverseType order,
1156 GTraverseFlags flags,
1158 GNodeTraverseFunc func,
1161 /* return the maximum tree height starting with `node', this is an expensive
1162 * operation, since we need to visit all nodes. this could be shortened by
1163 * adding `guint height' to struct _GNode, but then again, this is not very
1164 * often needed, and would make g_node_insert() more time consuming.
1166 guint g_node_max_height (GNode *root);
1168 void g_node_children_foreach (GNode *node,
1169 GTraverseFlags flags,
1170 GNodeForeachFunc func,
1172 void g_node_reverse_children (GNode *node);
1173 guint g_node_n_children (GNode *node);
1174 GNode* g_node_nth_child (GNode *node,
1176 GNode* g_node_last_child (GNode *node);
1177 GNode* g_node_find_child (GNode *node,
1178 GTraverseFlags flags,
1180 gint g_node_child_position (GNode *node,
1182 gint g_node_child_index (GNode *node,
1185 GNode* g_node_first_sibling (GNode *node);
1186 GNode* g_node_last_sibling (GNode *node);
1188 #define g_node_prev_sibling(node) ((node) ? \
1189 ((GNode*) (node))->prev : NULL)
1190 #define g_node_next_sibling(node) ((node) ? \
1191 ((GNode*) (node))->next : NULL)
1192 #define g_node_first_child(node) ((node) ? \
1193 ((GNode*) (node))->children : NULL)
1196 /* Callback maintenance functions
1198 #define G_HOOK_FLAG_USER_SHIFT (4)
1201 G_HOOK_FLAG_ACTIVE = 1 << 0,
1202 G_HOOK_FLAG_IN_CALL = 1 << 1,
1203 G_HOOK_FLAG_MASK = 0x0f
1206 #define G_HOOK_DEFERRED_DESTROY ((GHookFreeFunc) 0x01)
1214 GMemChunk *hook_memchunk;
1215 GHookFreeFunc hook_free; /* virtual function */
1216 GHookFreeFunc hook_destroy; /* virtual function */
1228 GDestroyNotify destroy;
1231 #define G_HOOK_ACTIVE(hook) ((((GHook*) hook)->flags & \
1232 G_HOOK_FLAG_ACTIVE) != 0)
1233 #define G_HOOK_IN_CALL(hook) ((((GHook*) hook)->flags & \
1234 G_HOOK_FLAG_IN_CALL) != 0)
1235 #define G_HOOK_IS_VALID(hook) (((GHook*) hook)->hook_id != 0 && \
1236 G_HOOK_ACTIVE (hook))
1237 #define G_HOOK_IS_UNLINKED(hook) (((GHook*) hook)->next == NULL && \
1238 ((GHook*) hook)->prev == NULL && \
1239 ((GHook*) hook)->hook_id == 0 && \
1240 ((GHook*) hook)->ref_count == 0)
1242 void g_hook_list_init (GHookList *hook_list,
1244 void g_hook_list_clear (GHookList *hook_list);
1245 GHook* g_hook_alloc (GHookList *hook_list);
1246 void g_hook_free (GHookList *hook_list,
1248 void g_hook_ref (GHookList *hook_list,
1250 void g_hook_unref (GHookList *hook_list,
1252 gboolean g_hook_destroy (GHookList *hook_list,
1254 void g_hook_destroy_link (GHookList *hook_list,
1256 void g_hook_prepend (GHookList *hook_list,
1258 void g_hook_insert_before (GHookList *hook_list,
1261 void g_hook_insert_sorted (GHookList *hook_list,
1263 GHookCompareFunc func);
1264 GHook* g_hook_get (GHookList *hook_list,
1266 GHook* g_hook_find (GHookList *hook_list,
1267 gboolean need_valids,
1270 GHook* g_hook_find_data (GHookList *hook_list,
1271 gboolean need_valids,
1273 GHook* g_hook_find_func (GHookList *hook_list,
1274 gboolean need_valids,
1276 GHook* g_hook_find_func_data (GHookList *hook_list,
1277 gboolean need_valids,
1280 /* return the first valid hook, and increment its reference count */
1281 GHook* g_hook_first_valid (GHookList *hook_list,
1282 gboolean may_be_in_call);
1283 /* return the next valid hook with incremented reference count, and
1284 * decrement the reference count of the original hook
1286 GHook* g_hook_next_valid (GHookList *hook_list,
1288 gboolean may_be_in_call);
1290 /* GHookCompareFunc implementation to insert hooks sorted by their id */
1291 gint g_hook_compare_ids (GHook *new_hook,
1294 /* convenience macros */
1295 #define g_hook_append( hook_list, hook ) \
1296 g_hook_insert_before ((hook_list), NULL, (hook))
1298 /* invoke all valid hooks with the (*GHookFunc) signature.
1300 void g_hook_list_invoke (GHookList *hook_list,
1301 gboolean may_recurse);
1302 /* invoke all valid hooks with the (*GHookCheckFunc) signature,
1303 * and destroy the hook if FALSE is returned.
1305 void g_hook_list_invoke_check (GHookList *hook_list,
1306 gboolean may_recurse);
1307 /* invoke a marshaller on all valid hooks.
1309 void g_hook_list_marshal (GHookList *hook_list,
1310 gboolean may_recurse,
1311 GHookMarshaller marshaller,
1313 void g_hook_list_marshal_check (GHookList *hook_list,
1314 gboolean may_recurse,
1315 GHookCheckMarshaller marshaller,
1319 /* Fatal error handlers.
1320 * g_on_error_query() will prompt the user to either
1321 * [E]xit, [H]alt, [P]roceed or show [S]tack trace.
1322 * g_on_error_stack_trace() invokes gdb, which attaches to the current
1323 * process and shows a stack trace.
1324 * These function may cause different actions on non-unix platforms.
1325 * The prg_name arg is required by gdb to find the executable, if it is
1326 * passed as NULL, g_on_error_query() will try g_get_prgname().
1328 void g_on_error_query (const gchar *prg_name);
1329 void g_on_error_stack_trace (const gchar *prg_name);
1332 /* Logging mechanism
1334 extern const gchar *g_log_domain_glib;
1335 guint g_log_set_handler (const gchar *log_domain,
1336 GLogLevelFlags log_levels,
1338 gpointer user_data);
1339 void g_log_remove_handler (const gchar *log_domain,
1341 void g_log_default_handler (const gchar *log_domain,
1342 GLogLevelFlags log_level,
1343 const gchar *message,
1344 gpointer unused_data);
1345 void g_log (const gchar *log_domain,
1346 GLogLevelFlags log_level,
1347 const gchar *format,
1348 ...) G_GNUC_PRINTF (3, 4);
1349 void g_logv (const gchar *log_domain,
1350 GLogLevelFlags log_level,
1351 const gchar *format,
1353 GLogLevelFlags g_log_set_fatal_mask (const gchar *log_domain,
1354 GLogLevelFlags fatal_mask);
1355 GLogLevelFlags g_log_set_always_fatal (GLogLevelFlags fatal_mask);
1356 #ifndef G_LOG_DOMAIN
1357 #define G_LOG_DOMAIN ((gchar*) 0)
1358 #endif /* G_LOG_DOMAIN */
1360 #define g_error(format, args...) g_log (G_LOG_DOMAIN, \
1361 G_LOG_LEVEL_ERROR, \
1363 #define g_message(format, args...) g_log (G_LOG_DOMAIN, \
1364 G_LOG_LEVEL_MESSAGE, \
1366 #define g_warning(format, args...) g_log (G_LOG_DOMAIN, \
1367 G_LOG_LEVEL_WARNING, \
1369 #else /* !__GNUC__ */
1371 g_error (const gchar *format,
1375 va_start (args, format);
1376 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR, format, args);
1380 g_message (const gchar *format,
1384 va_start (args, format);
1385 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_MESSAGE, format, args);
1389 g_warning (const gchar *format,
1393 va_start (args, format);
1394 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING, format, args);
1397 #endif /* !__GNUC__ */
1399 typedef void (*GPrintFunc) (const gchar *string);
1400 void g_print (const gchar *format,
1401 ...) G_GNUC_PRINTF (1, 2);
1402 GPrintFunc g_set_print_handler (GPrintFunc func);
1403 void g_printerr (const gchar *format,
1404 ...) G_GNUC_PRINTF (1, 2);
1405 GPrintFunc g_set_printerr_handler (GPrintFunc func);
1407 /* deprecated compatibility functions, use g_log_set_handler() instead */
1408 typedef void (*GErrorFunc) (const gchar *str);
1409 typedef void (*GWarningFunc) (const gchar *str);
1410 GErrorFunc g_set_error_handler (GErrorFunc func);
1411 GWarningFunc g_set_warning_handler (GWarningFunc func);
1412 GPrintFunc g_set_message_handler (GPrintFunc func);
1415 /* Memory allocation and debugging
1419 #define g_malloc(size) ((gpointer) MALLOC (size))
1420 #define g_malloc0(size) ((gpointer) CALLOC (char, size))
1421 #define g_realloc(mem,size) ((gpointer) REALLOC (mem, char, size))
1422 #define g_free(mem) FREE (mem)
1424 #else /* !USE_DMALLOC */
1426 gpointer g_malloc (gulong size);
1427 gpointer g_malloc0 (gulong size);
1428 gpointer g_realloc (gpointer mem,
1430 void g_free (gpointer mem);
1432 #endif /* !USE_DMALLOC */
1434 void g_mem_profile (void);
1435 void g_mem_check (gpointer mem);
1437 /* Generic allocators
1439 GAllocator* g_allocator_new (const gchar *name,
1441 void g_allocator_free (GAllocator *allocator);
1443 #define G_ALLOCATOR_LIST (1)
1444 #define G_ALLOCATOR_SLIST (2)
1445 #define G_ALLOCATOR_NODE (3)
1448 /* "g_mem_chunk_new" creates a new memory chunk.
1449 * Memory chunks are used to allocate pieces of memory which are
1450 * always the same size. Lists are a good example of such a data type.
1451 * The memory chunk allocates and frees blocks of memory as needed.
1452 * Just be sure to call "g_mem_chunk_free" and not "g_free" on data
1453 * allocated in a mem chunk. ("g_free" will most likely cause a seg
1454 * fault...somewhere).
1456 * Oh yeah, GMemChunk is an opaque data type. (You don't really
1457 * want to know what's going on inside do you?)
1460 /* ALLOC_ONLY MemChunk's can only allocate memory. The free operation
1461 * is interpreted as a no op. ALLOC_ONLY MemChunk's save 4 bytes per
1462 * atom. (They are also useful for lists which use MemChunk to allocate
1463 * memory but are also part of the MemChunk implementation).
1464 * ALLOC_AND_FREE MemChunk's can allocate and free memory.
1467 #define G_ALLOC_ONLY 1
1468 #define G_ALLOC_AND_FREE 2
1470 GMemChunk* g_mem_chunk_new (gchar *name,
1474 void g_mem_chunk_destroy (GMemChunk *mem_chunk);
1475 gpointer g_mem_chunk_alloc (GMemChunk *mem_chunk);
1476 gpointer g_mem_chunk_alloc0 (GMemChunk *mem_chunk);
1477 void g_mem_chunk_free (GMemChunk *mem_chunk,
1479 void g_mem_chunk_clean (GMemChunk *mem_chunk);
1480 void g_mem_chunk_reset (GMemChunk *mem_chunk);
1481 void g_mem_chunk_print (GMemChunk *mem_chunk);
1482 void g_mem_chunk_info (void);
1484 /* Ah yes...we have a "g_blow_chunks" function.
1485 * "g_blow_chunks" simply compresses all the chunks. This operation
1486 * consists of freeing every memory area that should be freed (but
1487 * which we haven't gotten around to doing yet). And, no,
1488 * "g_blow_chunks" doesn't follow the naming scheme, but it is a
1489 * much better name than "g_mem_chunk_clean_all" or something
1492 void g_blow_chunks (void);
1497 GTimer* g_timer_new (void);
1498 void g_timer_destroy (GTimer *timer);
1499 void g_timer_start (GTimer *timer);
1500 void g_timer_stop (GTimer *timer);
1501 void g_timer_reset (GTimer *timer);
1502 gdouble g_timer_elapsed (GTimer *timer,
1503 gulong *microseconds);
1506 /* String utility functions that modify a string argument or
1507 * return a constant string that must not be freed.
1509 #define G_STR_DELIMITERS "_-|> <."
1510 gchar* g_strdelimit (gchar *string,
1511 const gchar *delimiters,
1512 gchar new_delimiter);
1513 gdouble g_strtod (const gchar *nptr,
1515 gchar* g_strerror (gint errnum);
1516 gchar* g_strsignal (gint signum);
1517 gint g_strcasecmp (const gchar *s1,
1519 gint g_strncasecmp (const gchar *s1,
1522 void g_strdown (gchar *string);
1523 void g_strup (gchar *string);
1524 void g_strreverse (gchar *string);
1525 /* removes leading spaces */
1526 gchar* g_strchug (gchar *string);
1527 /* removes trailing spaces */
1528 gchar* g_strchomp (gchar *string);
1529 /* removes leading & trailing spaces */
1530 #define g_strstrip( string ) g_strchomp (g_strchug (string))
1532 /* String utility functions that return a newly allocated string which
1533 * ought to be freed from the caller at some point.
1535 gchar* g_strdup (const gchar *str);
1536 gchar* g_strdup_printf (const gchar *format,
1537 ...) G_GNUC_PRINTF (1, 2);
1538 gchar* g_strdup_vprintf (const gchar *format,
1540 gchar* g_strndup (const gchar *str,
1542 gchar* g_strnfill (guint length,
1544 gchar* g_strconcat (const gchar *string1,
1545 ...); /* NULL terminated */
1546 gchar* g_strjoin (const gchar *separator,
1547 ...); /* NULL terminated */
1548 gchar* g_strescape (gchar *string);
1549 gpointer g_memdup (gconstpointer mem,
1552 /* NULL terminated string arrays.
1553 * g_strsplit() splits up string into max_tokens tokens at delim and
1554 * returns a newly allocated string array.
1555 * g_strjoinv() concatenates all of str_array's strings, sliding in an
1556 * optional separator, the returned string is newly allocated.
1557 * g_strfreev() frees the array itself and all of its strings.
1559 gchar** g_strsplit (const gchar *string,
1560 const gchar *delimiter,
1562 gchar* g_strjoinv (const gchar *separator,
1564 void g_strfreev (gchar **str_array);
1568 /* calculate a string size, guarranteed to fit format + args.
1570 guint g_printf_string_upper_bound (const gchar* format,
1574 /* Retrive static string info
1576 gchar* g_get_user_name (void);
1577 gchar* g_get_real_name (void);
1578 gchar* g_get_home_dir (void);
1579 gchar* g_get_tmp_dir (void);
1580 gchar* g_get_prgname (void);
1581 void g_set_prgname (const gchar *prgname);
1584 /* Miscellaneous utility functions
1586 guint g_parse_debug_string (const gchar *string,
1589 gint g_snprintf (gchar *string,
1591 gchar const *format,
1592 ...) G_GNUC_PRINTF (3, 4);
1593 gint g_vsnprintf (gchar *string,
1595 gchar const *format,
1597 gchar* g_basename (const gchar *file_name);
1598 /* Check if a file name is an absolute path */
1599 gboolean g_path_is_absolute (const gchar *file_name);
1600 /* In case of absolute paths, skip the root part */
1601 gchar* g_path_skip_root (gchar *file_name);
1603 /* strings are newly allocated with g_malloc() */
1604 gchar* g_dirname (const gchar *file_name);
1605 gchar* g_get_current_dir (void);
1606 gchar* g_getenv (const gchar *variable);
1609 /* we use a GLib function as a replacement for ATEXIT, so
1610 * the programmer is not required to check the return value
1611 * (if there is any in the implementation) and doesn't encounter
1612 * missing include files.
1614 void g_atexit (GVoidFunc func);
1619 G_INLINE_FUNC gint g_bit_nth_lsf (guint32 mask,
1623 g_bit_nth_lsf (guint32 mask,
1629 if (mask & (1 << (guint) nth_bit))
1632 while (nth_bit < 32);
1635 #endif /* G_CAN_INLINE */
1637 G_INLINE_FUNC gint g_bit_nth_msf (guint32 mask,
1641 g_bit_nth_msf (guint32 mask,
1649 if (mask & (1 << (guint) nth_bit))
1652 while (nth_bit > 0);
1655 #endif /* G_CAN_INLINE */
1657 G_INLINE_FUNC guint g_bit_storage (guint number);
1660 g_bit_storage (guint number)
1662 register guint n_bits = 0;
1672 #endif /* G_CAN_INLINE */
1676 GStringChunk* g_string_chunk_new (gint size);
1677 void g_string_chunk_free (GStringChunk *chunk);
1678 gchar* g_string_chunk_insert (GStringChunk *chunk,
1679 const gchar *string);
1680 gchar* g_string_chunk_insert_const (GStringChunk *chunk,
1681 const gchar *string);
1686 GString* g_string_new (const gchar *init);
1687 GString* g_string_sized_new (guint dfl_size);
1688 void g_string_free (GString *string,
1690 GString* g_string_assign (GString *lval,
1692 GString* g_string_truncate (GString *string,
1694 GString* g_string_append (GString *string,
1696 GString* g_string_append_c (GString *string,
1698 GString* g_string_prepend (GString *string,
1700 GString* g_string_prepend_c (GString *string,
1702 GString* g_string_insert (GString *string,
1705 GString* g_string_insert_c (GString *string,
1708 GString* g_string_erase (GString *string,
1711 GString* g_string_down (GString *string);
1712 GString* g_string_up (GString *string);
1713 void g_string_sprintf (GString *string,
1714 const gchar *format,
1715 ...) G_GNUC_PRINTF (2, 3);
1716 void g_string_sprintfa (GString *string,
1717 const gchar *format,
1718 ...) G_GNUC_PRINTF (2, 3);
1721 /* Resizable arrays, remove fills any cleared spot and shortens the
1722 * array, while preserving the order. remove_fast will distort the
1723 * order by moving the last element to the position of the removed
1726 #define g_array_append_val(a,v) g_array_append_vals (a, &v, 1)
1727 #define g_array_prepend_val(a,v) g_array_prepend_vals (a, &v, 1)
1728 #define g_array_insert_val(a,i,v) g_array_insert_vals (a, i, &v, 1)
1729 #define g_array_index(a,t,i) (((t*) (a)->data) [(i)])
1731 GArray* g_array_new (gboolean zero_terminated,
1733 guint element_size);
1734 void g_array_free (GArray *array,
1735 gboolean free_segment);
1736 GArray* g_array_append_vals (GArray *array,
1739 GArray* g_array_prepend_vals (GArray *array,
1742 GArray* g_array_insert_vals (GArray *array,
1746 GArray* g_array_set_size (GArray *array,
1748 GArray* g_array_remove_index (GArray *array,
1750 GArray* g_array_remove_index_fast (GArray *array,
1753 /* Resizable pointer array. This interface is much less complicated
1754 * than the above. Add appends appends a pointer. Remove fills any
1755 * cleared spot and shortens the array. remove_fast will again distort
1758 #define g_ptr_array_index(array,index) (array->pdata)[index]
1759 GPtrArray* g_ptr_array_new (void);
1760 void g_ptr_array_free (GPtrArray *array,
1762 void g_ptr_array_set_size (GPtrArray *array,
1764 gpointer g_ptr_array_remove_index (GPtrArray *array,
1766 gpointer g_ptr_array_remove_index_fast (GPtrArray *array,
1768 gboolean g_ptr_array_remove (GPtrArray *array,
1770 gboolean g_ptr_array_remove_fast (GPtrArray *array,
1772 void g_ptr_array_add (GPtrArray *array,
1775 /* Byte arrays, an array of guint8. Implemented as a GArray,
1779 GByteArray* g_byte_array_new (void);
1780 void g_byte_array_free (GByteArray *array,
1781 gboolean free_segment);
1782 GByteArray* g_byte_array_append (GByteArray *array,
1785 GByteArray* g_byte_array_prepend (GByteArray *array,
1788 GByteArray* g_byte_array_set_size (GByteArray *array,
1790 GByteArray* g_byte_array_remove_index (GByteArray *array,
1792 GByteArray* g_byte_array_remove_index_fast (GByteArray *array,
1798 gint g_str_equal (gconstpointer v,
1800 guint g_str_hash (gconstpointer v);
1802 gint g_int_equal (gconstpointer v,
1804 guint g_int_hash (gconstpointer v);
1806 /* This "hash" function will just return the key's adress as an
1807 * unsigned integer. Useful for hashing on plain adresses or
1808 * simple integer values.
1809 * passing NULL into g_hash_table_new() as GHashFunc has the
1810 * same effect as passing g_direct_hash().
1812 guint g_direct_hash (gconstpointer v);
1813 gint g_direct_equal (gconstpointer v,
1817 /* Quarks (string<->id association)
1819 GQuark g_quark_try_string (const gchar *string);
1820 GQuark g_quark_from_static_string (const gchar *string);
1821 GQuark g_quark_from_string (const gchar *string);
1822 gchar* g_quark_to_string (GQuark quark);
1827 void g_datalist_init (GData **datalist);
1828 void g_datalist_clear (GData **datalist);
1829 gpointer g_datalist_id_get_data (GData **datalist,
1831 void g_datalist_id_set_data_full (GData **datalist,
1834 GDestroyNotify destroy_func);
1835 void g_datalist_id_remove_no_notify (GData **datalist,
1837 void g_datalist_foreach (GData **datalist,
1838 GDataForeachFunc func,
1839 gpointer user_data);
1840 #define g_datalist_id_set_data(dl, q, d) \
1841 g_datalist_id_set_data_full ((dl), (q), (d), NULL)
1842 #define g_datalist_id_remove_data(dl, q) \
1843 g_datalist_id_set_data ((dl), (q), NULL)
1844 #define g_datalist_get_data(dl, k) \
1845 (g_datalist_id_get_data ((dl), g_quark_try_string (k)))
1846 #define g_datalist_set_data_full(dl, k, d, f) \
1847 g_datalist_id_set_data_full ((dl), g_quark_from_string (k), (d), (f))
1848 #define g_datalist_remove_no_notify(dl, k) \
1849 g_datalist_id_remove_no_notify ((dl), g_quark_try_string (k))
1850 #define g_datalist_set_data(dl, k, d) \
1851 g_datalist_set_data_full ((dl), (k), (d), NULL)
1852 #define g_datalist_remove_data(dl, k) \
1853 g_datalist_id_set_data ((dl), g_quark_try_string (k), NULL)
1856 /* Location Associated Keyed Data
1858 void g_dataset_destroy (gconstpointer dataset_location);
1859 gpointer g_dataset_id_get_data (gconstpointer dataset_location,
1861 void g_dataset_id_set_data_full (gconstpointer dataset_location,
1864 GDestroyNotify destroy_func);
1865 void g_dataset_id_remove_no_notify (gconstpointer dataset_location,
1867 void g_dataset_foreach (gconstpointer dataset_location,
1868 GDataForeachFunc func,
1869 gpointer user_data);
1870 #define g_dataset_id_set_data(l, k, d) \
1871 g_dataset_id_set_data_full ((l), (k), (d), NULL)
1872 #define g_dataset_id_remove_data(l, k) \
1873 g_dataset_id_set_data ((l), (k), NULL)
1874 #define g_dataset_get_data(l, k) \
1875 (g_dataset_id_get_data ((l), g_quark_try_string (k)))
1876 #define g_dataset_set_data_full(l, k, d, f) \
1877 g_dataset_id_set_data_full ((l), g_quark_from_string (k), (d), (f))
1878 #define g_dataset_remove_no_notify(l, k) \
1879 g_dataset_id_remove_no_notify ((l), g_quark_try_string (k))
1880 #define g_dataset_set_data(l, k, d) \
1881 g_dataset_set_data_full ((l), (k), (d), NULL)
1882 #define g_dataset_remove_data(l, k) \
1883 g_dataset_id_set_data ((l), g_quark_try_string (k), NULL)
1886 /* GScanner: Flexible lexical scanner for general purpose.
1889 /* Character sets */
1890 #define G_CSET_A_2_Z "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1891 #define G_CSET_a_2_z "abcdefghijklmnopqrstuvwxyz"
1892 #define G_CSET_LATINC "\300\301\302\303\304\305\306"\
1893 "\307\310\311\312\313\314\315\316\317\320"\
1894 "\321\322\323\324\325\326"\
1895 "\330\331\332\333\334\335\336"
1896 #define G_CSET_LATINS "\337\340\341\342\343\344\345\346"\
1897 "\347\350\351\352\353\354\355\356\357\360"\
1898 "\361\362\363\364\365\366"\
1899 "\370\371\372\373\374\375\376\377"
1906 G_ERR_UNEXP_EOF_IN_STRING,
1907 G_ERR_UNEXP_EOF_IN_COMMENT,
1908 G_ERR_NON_DIGIT_IN_CONST,
1911 G_ERR_FLOAT_MALFORMED
1919 G_TOKEN_LEFT_PAREN = '(',
1920 G_TOKEN_RIGHT_PAREN = ')',
1921 G_TOKEN_LEFT_CURLY = '{',
1922 G_TOKEN_RIGHT_CURLY = '}',
1923 G_TOKEN_LEFT_BRACE = '[',
1924 G_TOKEN_RIGHT_BRACE = ']',
1925 G_TOKEN_EQUAL_SIGN = '=',
1926 G_TOKEN_COMMA = ',',
1942 G_TOKEN_IDENTIFIER_NULL,
1944 G_TOKEN_COMMENT_SINGLE,
1945 G_TOKEN_COMMENT_MULTI,
1952 gchar *v_identifier;
1964 struct _GScannerConfig
1968 gchar *cset_skip_characters; /* default: " \t\n" */
1969 gchar *cset_identifier_first;
1970 gchar *cset_identifier_nth;
1971 gchar *cpair_comment_single; /* default: "#\n" */
1973 /* Should symbol lookup work case sensitive?
1975 guint case_sensitive : 1;
1977 /* Boolean values to be adjusted "on the fly"
1978 * to configure scanning behaviour.
1980 guint skip_comment_multi : 1; /* C like comment */
1981 guint skip_comment_single : 1; /* single line comment */
1982 guint scan_comment_multi : 1; /* scan multi line comments? */
1983 guint scan_identifier : 1;
1984 guint scan_identifier_1char : 1;
1985 guint scan_identifier_NULL : 1;
1986 guint scan_symbols : 1;
1987 guint scan_binary : 1;
1988 guint scan_octal : 1;
1989 guint scan_float : 1;
1990 guint scan_hex : 1; /* `0x0ff0' */
1991 guint scan_hex_dollar : 1; /* `$0ff0' */
1992 guint scan_string_sq : 1; /* string: 'anything' */
1993 guint scan_string_dq : 1; /* string: "\\-escapes!\n" */
1994 guint numbers_2_int : 1; /* bin, octal, hex => int */
1995 guint int_2_float : 1; /* int => G_TOKEN_FLOAT? */
1996 guint identifier_2_string : 1;
1997 guint char_2_token : 1; /* return G_TOKEN_CHAR? */
1998 guint symbol_2_token : 1;
1999 guint scope_0_fallback : 1; /* try scope 0 on lookups? */
2006 guint max_parse_errors;
2008 /* g_scanner_error() increments this field */
2011 /* name of input stream, featured by the default message handler */
2012 const gchar *input_name;
2014 /* data pointer for derived structures */
2015 gpointer derived_data;
2017 /* link into the scanner configuration */
2018 GScannerConfig *config;
2020 /* fields filled in after g_scanner_get_next_token() */
2026 /* fields filled in after g_scanner_peek_next_token() */
2027 GTokenType next_token;
2028 GTokenValue next_value;
2030 guint next_position;
2032 /* to be considered private */
2033 GHashTable *symbol_table;
2036 const gchar *text_end;
2040 /* handler function for _warn and _error */
2041 GScannerMsgFunc msg_handler;
2044 GScanner* g_scanner_new (GScannerConfig *config_templ);
2045 void g_scanner_destroy (GScanner *scanner);
2046 void g_scanner_input_file (GScanner *scanner,
2048 void g_scanner_sync_file_offset (GScanner *scanner);
2049 void g_scanner_input_text (GScanner *scanner,
2052 GTokenType g_scanner_get_next_token (GScanner *scanner);
2053 GTokenType g_scanner_peek_next_token (GScanner *scanner);
2054 GTokenType g_scanner_cur_token (GScanner *scanner);
2055 GTokenValue g_scanner_cur_value (GScanner *scanner);
2056 guint g_scanner_cur_line (GScanner *scanner);
2057 guint g_scanner_cur_position (GScanner *scanner);
2058 gboolean g_scanner_eof (GScanner *scanner);
2059 guint g_scanner_set_scope (GScanner *scanner,
2061 void g_scanner_scope_add_symbol (GScanner *scanner,
2063 const gchar *symbol,
2065 void g_scanner_scope_remove_symbol (GScanner *scanner,
2067 const gchar *symbol);
2068 gpointer g_scanner_scope_lookup_symbol (GScanner *scanner,
2070 const gchar *symbol);
2071 void g_scanner_scope_foreach_symbol (GScanner *scanner,
2074 gpointer user_data);
2075 gpointer g_scanner_lookup_symbol (GScanner *scanner,
2076 const gchar *symbol);
2077 void g_scanner_freeze_symbol_table (GScanner *scanner);
2078 void g_scanner_thaw_symbol_table (GScanner *scanner);
2079 void g_scanner_unexp_token (GScanner *scanner,
2080 GTokenType expected_token,
2081 const gchar *identifier_spec,
2082 const gchar *symbol_spec,
2083 const gchar *symbol_name,
2084 const gchar *message,
2086 void g_scanner_error (GScanner *scanner,
2087 const gchar *format,
2088 ...) G_GNUC_PRINTF (2,3);
2089 void g_scanner_warn (GScanner *scanner,
2090 const gchar *format,
2091 ...) G_GNUC_PRINTF (2,3);
2092 gint g_scanner_stat_mode (const gchar *filename);
2093 /* keep downward source compatibility */
2094 #define g_scanner_add_symbol( scanner, symbol, value ) G_STMT_START { \
2095 g_scanner_scope_add_symbol ((scanner), 0, (symbol), (value)); \
2097 #define g_scanner_remove_symbol( scanner, symbol ) G_STMT_START { \
2098 g_scanner_scope_remove_symbol ((scanner), 0, (symbol)); \
2100 #define g_scanner_foreach_symbol( scanner, func, data ) G_STMT_START { \
2101 g_scanner_scope_foreach_symbol ((scanner), 0, (func), (data)); \
2111 GCompletionFunc func;
2117 GCompletion* g_completion_new (GCompletionFunc func);
2118 void g_completion_add_items (GCompletion* cmp,
2120 void g_completion_remove_items (GCompletion* cmp,
2122 void g_completion_clear_items (GCompletion* cmp);
2123 GList* g_completion_complete (GCompletion* cmp,
2125 gchar** new_prefix);
2126 void g_completion_free (GCompletion* cmp);
2131 * Date calculations (not time for now, to be resolved). These are a
2132 * mutant combination of Steffen Beyer's DateCalc routines
2133 * (http://www.perl.com/CPAN/authors/id/STBEY/) and Jon Trowbridge's
2134 * date routines (written for in-house software). Written by Havoc
2135 * Pennington <hp@pobox.com>
2138 typedef guint16 GDateYear;
2139 typedef guint8 GDateDay; /* day of the month */
2140 typedef struct _GDate GDate;
2141 /* make struct tm known without having to include time.h */
2144 /* enum used to specify order of appearance in parsed date strings */
2152 /* actual week and month values */
2155 G_DATE_BAD_WEEKDAY = 0,
2158 G_DATE_WEDNESDAY = 3,
2159 G_DATE_THURSDAY = 4,
2161 G_DATE_SATURDAY = 6,
2166 G_DATE_BAD_MONTH = 0,
2168 G_DATE_FEBRUARY = 2,
2175 G_DATE_SEPTEMBER = 9,
2176 G_DATE_OCTOBER = 10,
2177 G_DATE_NOVEMBER = 11,
2178 G_DATE_DECEMBER = 12
2181 #define G_DATE_BAD_JULIAN 0U
2182 #define G_DATE_BAD_DAY 0U
2183 #define G_DATE_BAD_YEAR 0U
2185 /* Note: directly manipulating structs is generally a bad idea, but
2186 * in this case it's an *incredibly* bad idea, because all or part
2187 * of this struct can be invalid at any given time. Use the functions,
2188 * or you will get hosed, I promise.
2192 guint julian_days : 32; /* julian days representation - we use a
2193 * bitfield hoping that 64 bit platforms
2194 * will pack this whole struct in one big
2198 guint julian : 1; /* julian is valid */
2199 guint dmy : 1; /* dmy is valid */
2201 /* DMY representation */
2207 /* g_date_new() returns an invalid date, you then have to _set() stuff
2208 * to get a usable object. You can also allocate a GDate statically,
2209 * then call g_date_clear() to initialize.
2211 GDate* g_date_new (void);
2212 GDate* g_date_new_dmy (GDateDay day,
2215 GDate* g_date_new_julian (guint32 julian_day);
2216 void g_date_free (GDate *date);
2218 /* check g_date_valid() after doing an operation that might fail, like
2219 * _parse. Almost all g_date operations are undefined on invalid
2220 * dates (the exceptions are the mutators, since you need those to
2221 * return to validity).
2223 gboolean g_date_valid (GDate *date);
2224 gboolean g_date_valid_day (GDateDay day);
2225 gboolean g_date_valid_month (GDateMonth month);
2226 gboolean g_date_valid_year (GDateYear year);
2227 gboolean g_date_valid_weekday (GDateWeekday weekday);
2228 gboolean g_date_valid_julian (guint32 julian_date);
2229 gboolean g_date_valid_dmy (GDateDay day,
2233 GDateWeekday g_date_weekday (GDate *date);
2234 GDateMonth g_date_month (GDate *date);
2235 GDateYear g_date_year (GDate *date);
2236 GDateDay g_date_day (GDate *date);
2237 guint32 g_date_julian (GDate *date);
2238 guint g_date_day_of_year (GDate *date);
2240 /* First monday/sunday is the start of week 1; if we haven't reached
2241 * that day, return 0. These are not ISO weeks of the year; that
2242 * routine needs to be added.
2243 * these functions return the number of weeks, starting on the
2246 guint g_date_monday_week_of_year (GDate *date);
2247 guint g_date_sunday_week_of_year (GDate *date);
2249 /* If you create a static date struct you need to clear it to get it
2250 * in a sane state before use. You can clear a whole array at
2251 * once with the ndates argument.
2253 void g_date_clear (GDate *date,
2256 /* The parse routine is meant for dates typed in by a user, so it
2257 * permits many formats but tries to catch common typos. If your data
2258 * needs to be strictly validated, it is not an appropriate function.
2260 void g_date_set_parse (GDate *date,
2262 void g_date_set_time (GDate *date,
2264 void g_date_set_month (GDate *date,
2266 void g_date_set_day (GDate *date,
2268 void g_date_set_year (GDate *date,
2270 void g_date_set_dmy (GDate *date,
2274 void g_date_set_julian (GDate *date,
2275 guint32 julian_date);
2276 gboolean g_date_is_first_of_month (GDate *date);
2277 gboolean g_date_is_last_of_month (GDate *date);
2279 /* To go forward by some number of weeks just go forward weeks*7 days */
2280 void g_date_add_days (GDate *date,
2282 void g_date_subtract_days (GDate *date,
2285 /* If you add/sub months while day > 28, the day might change */
2286 void g_date_add_months (GDate *date,
2288 void g_date_subtract_months (GDate *date,
2291 /* If it's feb 29, changing years can move you to the 28th */
2292 void g_date_add_years (GDate *date,
2294 void g_date_subtract_years (GDate *date,
2296 gboolean g_date_is_leap_year (GDateYear year);
2297 guint8 g_date_days_in_month (GDateMonth month,
2299 guint8 g_date_monday_weeks_in_year (GDateYear year);
2300 guint8 g_date_sunday_weeks_in_year (GDateYear year);
2302 /* qsort-friendly (with a cast...) */
2303 gint g_date_compare (GDate *lhs,
2305 void g_date_to_struct_tm (GDate *date,
2308 /* Just like strftime() except you can only use date-related formats.
2309 * Using a time format is undefined.
2311 gsize g_date_strftime (gchar *s,
2313 const gchar *format,
2319 * Indexed Relations. Imagine a really simple table in a
2320 * database. Relations are not ordered. This data type is meant for
2321 * maintaining a N-way mapping.
2323 * g_relation_new() creates a relation with FIELDS fields
2325 * g_relation_destroy() frees all resources
2326 * g_tuples_destroy() frees the result of g_relation_select()
2328 * g_relation_index() indexes relation FIELD with the provided
2329 * equality and hash functions. this must be done before any
2330 * calls to insert are made.
2332 * g_relation_insert() inserts a new tuple. you are expected to
2333 * provide the right number of fields.
2335 * g_relation_delete() deletes all relations with KEY in FIELD
2336 * g_relation_select() returns ...
2337 * g_relation_count() counts ...
2340 GRelation* g_relation_new (gint fields);
2341 void g_relation_destroy (GRelation *relation);
2342 void g_relation_index (GRelation *relation,
2344 GHashFunc hash_func,
2345 GCompareFunc key_compare_func);
2346 void g_relation_insert (GRelation *relation,
2348 gint g_relation_delete (GRelation *relation,
2351 GTuples* g_relation_select (GRelation *relation,
2354 gint g_relation_count (GRelation *relation,
2357 gboolean g_relation_exists (GRelation *relation,
2359 void g_relation_print (GRelation *relation);
2361 void g_tuples_destroy (GTuples *tuples);
2362 gpointer g_tuples_index (GTuples *tuples,
2370 /* This function returns prime numbers spaced by approximately 1.5-2.0
2371 * and is for use in resizing data structures which prefer
2372 * prime-valued sizes. The closest spaced prime function returns the
2373 * next largest prime, or the highest it knows about which is about
2376 guint g_spaced_primes_closest (guint num);
2382 typedef struct _GIOFuncs GIOFuncs;
2398 G_IO_IN GLIB_SYSDEF_POLLIN,
2399 G_IO_OUT GLIB_SYSDEF_POLLOUT,
2400 G_IO_PRI GLIB_SYSDEF_POLLPRI,
2401 G_IO_ERR GLIB_SYSDEF_POLLERR,
2402 G_IO_HUP GLIB_SYSDEF_POLLHUP,
2403 G_IO_NVAL GLIB_SYSDEF_POLLNVAL
2408 guint channel_flags;
2413 typedef gboolean (*GIOFunc) (GIOChannel *source,
2414 GIOCondition condition,
2418 GIOError (*io_read) (GIOChannel *channel,
2422 GIOError (*io_write) (GIOChannel *channel,
2425 guint *bytes_written);
2426 GIOError (*io_seek) (GIOChannel *channel,
2429 void (*io_close) (GIOChannel *channel);
2430 guint (*io_add_watch) (GIOChannel *channel,
2432 GIOCondition condition,
2435 GDestroyNotify notify);
2436 void (*io_free) (GIOChannel *channel);
2439 void g_io_channel_init (GIOChannel *channel);
2440 void g_io_channel_ref (GIOChannel *channel);
2441 void g_io_channel_unref (GIOChannel *channel);
2442 GIOError g_io_channel_read (GIOChannel *channel,
2446 GIOError g_io_channel_write (GIOChannel *channel,
2449 guint *bytes_written);
2450 GIOError g_io_channel_seek (GIOChannel *channel,
2453 void g_io_channel_close (GIOChannel *channel);
2454 guint g_io_add_watch_full (GIOChannel *channel,
2456 GIOCondition condition,
2459 GDestroyNotify notify);
2460 guint g_io_add_watch (GIOChannel *channel,
2461 GIOCondition condition,
2463 gpointer user_data);
2468 typedef struct _GTimeVal GTimeVal;
2469 typedef struct _GSourceFuncs GSourceFuncs;
2470 typedef struct _GMainLoop GMainLoop; /* Opaque */
2477 struct _GSourceFuncs
2479 gboolean (*prepare) (gpointer source_data,
2480 GTimeVal *current_time,
2482 gboolean (*check) (gpointer source_data,
2483 GTimeVal *current_time);
2484 gboolean (*dispatch) (gpointer source_data,
2485 GTimeVal *current_time,
2486 gpointer user_data);
2487 GDestroyNotify destroy;
2490 /* Standard priorities */
2492 #define G_PRIORITY_HIGH -100
2493 #define G_PRIORITY_DEFAULT 0
2494 #define G_PRIORITY_HIGH_IDLE 100
2495 #define G_PRIORITY_DEFAULT_IDLE 200
2496 #define G_PRIORITY_LOW 300
2498 typedef gboolean (*GSourceFunc) (gpointer data);
2500 /* Hooks for adding to the main loop */
2501 guint g_source_add (gint priority,
2502 gboolean can_recurse,
2503 GSourceFuncs *funcs,
2504 gpointer source_data,
2506 GDestroyNotify notify);
2507 gboolean g_source_remove (guint tag);
2508 gboolean g_source_remove_by_user_data (gpointer user_data);
2509 gboolean g_source_remove_by_source_data (gpointer source_data);
2510 gboolean g_source_remove_by_funcs_user_data (GSourceFuncs *funcs,
2511 gpointer user_data);
2513 void g_get_current_time (GTimeVal *result);
2515 /* Running the main loop */
2516 GMainLoop* g_main_new (gboolean is_running);
2517 void g_main_run (GMainLoop *loop);
2518 void g_main_quit (GMainLoop *loop);
2519 void g_main_destroy (GMainLoop *loop);
2520 gboolean g_main_is_running (GMainLoop *loop);
2522 /* Run a single iteration of the mainloop. If block is FALSE,
2525 gboolean g_main_iteration (gboolean may_block);
2527 /* See if any events are pending */
2528 gboolean g_main_pending (void);
2530 /* Idles and timeouts */
2531 guint g_timeout_add_full (gint priority,
2533 GSourceFunc function,
2535 GDestroyNotify notify);
2536 guint g_timeout_add (guint interval,
2537 GSourceFunc function,
2539 guint g_idle_add (GSourceFunc function,
2541 guint g_idle_add_full (gint priority,
2542 GSourceFunc function,
2544 GDestroyNotify destroy);
2545 gboolean g_idle_remove_by_data (gpointer data);
2549 * System-specific IO and main loop calls
2551 * On Win32, the fd in a GPollFD should be Win32 HANDLE (*not* a file
2552 * descriptor as provided by the C runtime) that can be used by
2553 * MsgWaitForMultipleObjects. This does *not* include file handles
2554 * from CreateFile, SOCKETs, nor pipe handles. (But you can use
2555 * WSAEventSelect to signal events when a SOCKET is readable).
2557 * On Win32, fd can also be the special value G_WIN32_MSG_HANDLE to
2558 * indicate polling for messages. These message queue GPollFDs should
2559 * be added with the g_main_poll_win32_msg_add function.
2561 * But note that G_WIN32_MSG_HANDLE GPollFDs should not be used by GDK
2562 * (GTK) programs, as GDK itself wants to read messages and convert them
2565 * So, unless you really know what you are doing, it's best not to try
2566 * to use the main loop polling stuff for your own needs on
2567 * Win32. It's really only written for the GIMP's needs so
2571 typedef struct _GPollFD GPollFD;
2572 typedef gint (*GPollFunc) (GPollFD *ufds,
2582 void g_main_add_poll (GPollFD *fd,
2584 void g_main_remove_poll (GPollFD *fd);
2585 void g_main_set_poll_func (GPollFunc func);
2587 /* On Unix, IO channels created with this function for any file
2588 * descriptor or socket.
2590 * On Win32, use this only for plain files opened with the MSVCRT (the
2591 * Microsoft run-time C library) _open(), including file descriptors
2592 * 0, 1 and 2 (corresponding to stdin, stdout and stderr).
2593 * Actually, don't do even that, this code isn't done yet.
2595 * The term file descriptor as used in the context of Win32 refers to
2596 * the emulated Unix-like file descriptors MSVCRT provides.
2598 GIOChannel* g_io_channel_unix_new (int fd);
2599 gint g_io_channel_unix_get_fd (GIOChannel *channel);
2603 GUTILS_C_VAR guint g_pipe_readable_msg;
2605 #define G_WIN32_MSG_HANDLE 19981206
2607 /* This is used to add polling for Windows messages. GDK (GTk+) programs
2608 * should *not* use this. (In fact, I can't think of any program that
2609 * would want to use this, but it's here just for completeness's sake.
2611 void g_main_poll_win32_msg_add(gint priority,
2615 /* An IO channel for Windows messages for window handle hwnd. */
2616 GIOChannel *g_io_channel_win32_new_messages (guint hwnd);
2618 /* An IO channel for an anonymous pipe as returned from the MSVCRT
2619 * _pipe(), with no mechanism for the writer to tell the reader when
2620 * there is data in the pipe.
2622 * This is not really implemented yet.
2624 GIOChannel *g_io_channel_win32_new_pipe (int fd);
2626 /* An IO channel for a pipe as returned from the MSVCRT _pipe(), with
2627 * Windows user messages used to signal data in the pipe for the
2630 * fd is the file descriptor. For the write end, peer is the thread id
2631 * of the reader, and peer_fd is his file descriptor for the read end
2634 * This is used by the GIMP, and works.
2636 GIOChannel *g_io_channel_win32_new_pipe_with_wakeups (int fd,
2640 void g_io_channel_win32_pipe_request_wakeups (GIOChannel *channel,
2644 void g_io_channel_win32_pipe_readable (int fd,
2647 /* Get the C runtime file descriptor of a channel. */
2648 gint g_io_channel_win32_get_fd (GIOChannel *channel);
2650 /* An IO channel for a SOCK_STREAM winsock socket. The parameter is
2651 * actually a SOCKET.
2653 GIOChannel *g_io_channel_win32_new_stream_socket (int socket);
2657 /* Windows emulation stubs for common Unix functions
2660 # define MAXPATHLEN 1024
2664 /* These POSIXish functions are available in the Microsoft C library
2665 * prefixed with underscore (which of course technically speaking is
2666 * the Right Thing, as they are non-ANSI. Not that being non-ANSI
2667 * prevents Microsoft from practically requiring you to include
2668 * <windows.h> every now and then...).
2670 * You still need to include the appropriate headers to get the
2671 * prototypes, <io.h> or <direct.h>.
2673 * For some functions, we provide emulators in glib, which are prefixed
2676 # define getcwd _getcwd
2677 # define getpid _getpid
2678 # define access _access
2681 # define write _write
2682 # define lseek _lseek
2683 # define close _close
2684 # define pipe(phandles) _pipe (phandles, 4096, _O_BINARY)
2685 # define popen _popen
2686 # define pclose _pclose
2687 # define fdopen _fdopen
2688 # define ftruncate(fd, size) gwin_ftruncate (fd, size)
2689 # define opendir gwin_opendir
2690 # define readdir gwin_readdir
2691 # define rewinddir gwin_rewinddir
2692 # define closedir gwin_closedir
2693 # define NAME_MAX 255
2697 gboolean just_opened;
2698 guint find_file_handle;
2699 gpointer find_file_data;
2701 typedef struct DIR DIR;
2704 gchar d_name[NAME_MAX + 1];
2706 /* emulation functions */
2707 extern int gwin_ftruncate (gint f,
2709 DIR* gwin_opendir (const gchar *dirname);
2710 struct dirent* gwin_readdir (DIR *dir);
2711 void gwin_rewinddir (DIR *dir);
2712 gint gwin_closedir (DIR *dir);
2713 # endif /* _MSC_VER */
2714 #endif /* NATIVE_WIN32 */
2717 /* GLib Thread support
2719 typedef struct _GMutex GMutex;
2720 typedef struct _GCond GCond;
2721 typedef struct _GPrivate GPrivate;
2722 typedef struct _GStaticPrivate GStaticPrivate;
2723 typedef struct _GThreadFunctions GThreadFunctions;
2724 struct _GThreadFunctions
2726 GMutex* (*mutex_new) (void);
2727 void (*mutex_lock) (GMutex *mutex);
2728 gboolean (*mutex_trylock) (GMutex *mutex);
2729 void (*mutex_unlock) (GMutex *mutex);
2730 void (*mutex_free) (GMutex *mutex);
2731 GCond* (*cond_new) (void);
2732 void (*cond_signal) (GCond *cond);
2733 void (*cond_broadcast) (GCond *cond);
2734 void (*cond_wait) (GCond *cond,
2736 gboolean (*cond_timed_wait) (GCond *cond,
2738 GTimeVal *end_time);
2739 void (*cond_free) (GCond *cond);
2740 GPrivate* (*private_new) (GDestroyNotify destructor);
2741 gpointer (*private_get) (GPrivate *private_key);
2742 void (*private_set) (GPrivate *private_key,
2746 GUTILS_C_VAR GThreadFunctions g_thread_functions_for_glib_use;
2747 GUTILS_C_VAR gboolean g_thread_use_default_impl;
2748 GUTILS_C_VAR gboolean g_threads_got_initialized;
2750 /* initializes the mutex/cond/private implementation for glib, might
2751 * only be called once, and must not be called directly or indirectly
2752 * from another glib-function, e.g. as a callback.
2754 void g_thread_init (GThreadFunctions *vtable);
2756 /* internal function for fallback static mutex implementation */
2757 GMutex* g_static_mutex_get_mutex_impl (GMutex **mutex);
2759 /* shorthands for conditional and unconditional function calls */
2760 #define G_THREAD_UF(name, arglist) \
2761 (*g_thread_functions_for_glib_use . name) arglist
2762 #define G_THREAD_CF(name, fail, arg) \
2763 (g_thread_supported () ? G_THREAD_UF (name, arg) : (fail))
2764 /* keep in mind, all those mutexes and static mutexes are not
2765 * recursive in general, don't rely on that
2767 #define g_thread_supported() (g_threads_got_initialized)
2768 #define g_mutex_new() G_THREAD_UF (mutex_new, ())
2769 #define g_mutex_lock(mutex) G_THREAD_CF (mutex_lock, (void)0, (mutex))
2770 #define g_mutex_trylock(mutex) G_THREAD_CF (mutex_trylock, TRUE, (mutex))
2771 #define g_mutex_unlock(mutex) G_THREAD_CF (mutex_unlock, (void)0, (mutex))
2772 #define g_mutex_free(mutex) G_THREAD_CF (mutex_free, (void)0, (mutex))
2773 #define g_cond_new() G_THREAD_UF (cond_new, ())
2774 #define g_cond_signal(cond) G_THREAD_CF (cond_signal, (void)0, (cond))
2775 #define g_cond_broadcast(cond) G_THREAD_CF (cond_broadcast, (void)0, (cond))
2776 #define g_cond_wait(cond, mutex) G_THREAD_CF (cond_wait, (void)0, (cond, \
2778 #define g_cond_free(cond) G_THREAD_CF (cond_free, (void)0, (cond))
2779 #define g_cond_timed_wait(cond, mutex, abs_time) G_THREAD_CF (cond_timed_wait, \
2783 #define g_private_new(destructor) G_THREAD_UF (private_new, (destructor))
2784 #define g_private_get(private_key) G_THREAD_CF (private_get, \
2785 ((gpointer)private_key), \
2787 #define g_private_set(private_key, value) G_THREAD_CF (private_set, \
2788 (void) (private_key = \
2789 (GPrivate*) (value)), \
2790 (private_key, value))
2791 /* GStaticMutexes can be statically initialized with the value
2792 * G_STATIC_MUTEX_INIT, and then they can directly be used, that is
2793 * much easier, than having to explicitly allocate the mutex before
2796 #define g_static_mutex_lock(mutex) \
2797 g_mutex_lock (g_static_mutex_get_mutex (mutex))
2798 #define g_static_mutex_trylock(mutex) \
2799 g_mutex_trylock (g_static_mutex_get_mutex (mutex))
2800 #define g_static_mutex_unlock(mutex) \
2801 g_mutex_unlock (g_static_mutex_get_mutex (mutex))
2802 struct _GStaticPrivate
2806 #define G_STATIC_PRIVATE_INIT { 0 }
2807 gpointer g_static_private_get (GStaticPrivate *private_key);
2808 void g_static_private_set (GStaticPrivate *private_key,
2810 GDestroyNotify notify);
2812 /* these are some convenience macros that expand to nothing if GLib
2813 * was configured with --disable-threads. for using StaticMutexes,
2814 * you define them with G_LOCK_DEFINE_STATIC (name) or G_LOCK_DEFINE (name)
2815 * if you need to export the mutex. With G_LOCK_EXTERN (name) you can
2816 * declare such an globally defined lock. name is a unique identifier
2817 * for the protected varibale or code portion. locking, testing and
2818 * unlocking of such mutexes can be done with G_LOCK(), G_UNLOCK() and
2819 * G_TRYLOCK() respectively.
2821 extern void glib_dummy_decl (void);
2822 #define G_LOCK_NAME(name) (g__ ## name ## _lock)
2823 #ifdef G_THREADS_ENABLED
2824 # define G_LOCK_DEFINE_STATIC(name) static G_LOCK_DEFINE (name)
2825 # define G_LOCK_DEFINE(name) \
2826 GStaticMutex G_LOCK_NAME (name) = G_STATIC_MUTEX_INIT
2827 # define G_LOCK_EXTERN(name) extern GStaticMutex G_LOCK_NAME (name)
2829 # ifdef G_DEBUG_LOCKS
2830 # define G_LOCK(name) G_STMT_START{ \
2831 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
2832 "file %s: line %d (%s): locking: %s ", \
2833 __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION, \
2835 g_static_mutex_lock (&G_LOCK_NAME (name)); \
2837 # define G_UNLOCK(name) G_STMT_START{ \
2838 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
2839 "file %s: line %d (%s): unlocking: %s ", \
2840 __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION, \
2842 g_static_mutex_unlock (&G_LOCK_NAME (name)); \
2844 # define G_TRYLOCK(name) G_STMT_START{ \
2845 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
2846 "file %s: line %d (%s): try locking: %s ", \
2847 __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION, \
2849 }G_STMT_END, g_static_mutex_trylock (&G_LOCK_NAME (name))
2850 # else /* !G_DEBUG_LOCKS */
2851 # define G_LOCK(name) g_static_mutex_lock (&G_LOCK_NAME (name))
2852 # define G_UNLOCK(name) g_static_mutex_unlock (&G_LOCK_NAME (name))
2853 # define G_TRYLOCK(name) g_static_mutex_trylock (&G_LOCK_NAME (name))
2854 # endif /* !G_DEBUG_LOCKS */
2855 #else /* !G_THREADS_ENABLED */
2856 # define G_LOCK_DEFINE_STATIC(name) extern void glib_dummy_decl (void)
2857 # define G_LOCK_DEFINE(name) extern void glib_dummy_decl (void)
2858 # define G_LOCK_EXTERN(name) extern void glib_dummy_decl (void)
2859 # define G_LOCK(name)
2860 # define G_UNLOCK(name)
2861 # define G_TRYLOCK(name) (FALSE)
2862 #endif /* !G_THREADS_ENABLED */
2866 #endif /* __cplusplus */
2869 #endif /* __G_LIB_H__ */