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.
22 /* system specific config file glibconfig.h provides definitions for
23 * the extrema of many of the standard types. These are:
25 * G_MINSHORT, G_MAXSHORT
27 * G_MINLONG, G_MAXLONG
28 * G_MINFLOAT, G_MAXFLOAT
29 * G_MINDOUBLE, G_MAXDOUBLE
31 * It also provides the following typedefs:
38 * It defines the G_BYTE_ORDER symbol to one of G_*_ENDIAN (see later in
41 * And it provides a way to store and retrieve a `gint' in/from a `gpointer'.
42 * This is useful to pass an integer instead of a pointer to a callback.
44 * GINT_TO_POINTER(i), GUINT_TO_POINTER(i)
45 * GPOINTER_TO_INT(p), GPOINTER_TO_UINT(p)
47 * Finally, it provide the following wrappers to STDC functions:
50 * To register hooks which are executed on exit().
51 * Usually a wrapper for STDC atexit.
53 * void *g_memmove(void *dest, const void *src, guint count);
54 * A wrapper for STDC memmove, or an implementation, if memmove doesn't
55 * exist. The prototype looks like the above, give or take a const,
58 #include <glibconfig.h>
60 /* include varargs functions for assertment macros
64 /* optionally feature DMALLOC memory allocation debugger
73 /* On native Win32, directory separator is the backslash, and search path
74 * separator is the semicolon.
76 #define G_DIR_SEPARATOR '\\'
77 #define G_DIR_SEPARATOR_S "\\"
78 #define G_SEARCHPATH_SEPARATOR ';'
79 #define G_SEARCHPATH_SEPARATOR_S ";"
81 #else /* !NATIVE_WIN32 */
85 #define G_DIR_SEPARATOR '/'
86 #define G_DIR_SEPARATOR_S "/"
87 #define G_SEARCHPATH_SEPARATOR ':'
88 #define G_SEARCHPATH_SEPARATOR_S ":"
90 #endif /* !NATIVE_WIN32 */
94 #endif /* __cplusplus */
97 /* Provide definitions for some commonly used macros.
98 * Some of them are only provided if they haven't already
99 * been defined. It is assumed that if they are already
100 * defined then the current definition is correct.
103 #define NULL ((void*) 0)
111 #define TRUE (!FALSE)
115 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
118 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
121 #define ABS(a) (((a) < 0) ? -(a) : (a))
124 #define CLAMP(x, low, high) (((x) > (high)) ? (high) : (((x) < (low)) ? (low) : (x)))
127 /* Define G_VA_COPY() to do the right thing for copying va_list variables.
128 * glibconfig.h may have already defined G_VA_COPY as va_copy or __va_copy.
130 #if !defined (G_VA_COPY)
131 # if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
132 # define G_VA_COPY(ap1, ap2) (*(ap1) = *(ap2))
133 # elif defined (G_VA_COPY_AS_ARRAY)
134 # define G_VA_COPY(ap1, ap2) g_memmove ((ap1), (ap2), sizeof (va_list))
135 # else /* va_list is a pointer */
136 # define G_VA_COPY(ap1, ap2) ((ap1) = (ap2))
137 # endif /* va_list is a pointer */
138 #endif /* !G_VA_COPY */
141 /* Provide convenience macros for handling structure
142 * fields through their offsets.
144 #define G_STRUCT_OFFSET(struct_type, member) \
145 ((gulong) ((gchar*) &((struct_type*) 0)->member))
146 #define G_STRUCT_MEMBER_P(struct_p, struct_offset) \
147 ((gpointer) ((gchar*) (struct_p) + (gulong) (struct_offset)))
148 #define G_STRUCT_MEMBER(member_type, struct_p, struct_offset) \
149 (*(member_type*) G_STRUCT_MEMBER_P ((struct_p), (struct_offset)))
152 /* inlining hassle. for compilers that don't allow the `inline' keyword,
153 * mostly because of strict ANSI C compliance or dumbness, we try to fall
154 * back to either `__inline__' or `__inline'.
155 * we define G_CAN_INLINE, if the compiler seems to be actually
156 * *capable* to do function inlining, in which case inline function bodys
157 * do make sense. we also define G_INLINE_FUNC to properly export the
158 * function prototypes if no inlining can be performed.
159 * we special case most of the stuff, so inline functions can have a normal
160 * implementation by defining G_INLINE_FUNC to extern and G_CAN_INLINE to 1.
162 #ifndef G_INLINE_FUNC
163 # define G_CAN_INLINE 1
166 # if defined (__GNUC__) && defined (__STRICT_ANSI__)
168 # define inline __inline__
170 #else /* !G_HAVE_INLINE */
172 # if defined (G_HAVE___INLINE__)
173 # define inline __inline__
174 # else /* !inline && !__inline__ */
175 # if defined (G_HAVE___INLINE)
176 # define inline __inline
177 # else /* !inline && !__inline__ && !__inline */
178 # define inline /* don't inline, then */
179 # ifndef G_INLINE_FUNC
185 #ifndef G_INLINE_FUNC
188 # define G_INLINE_FUNC extern inline
191 # define G_INLINE_FUNC extern
193 # else /* !__GNUC__ */
195 # define G_INLINE_FUNC static inline
197 # define G_INLINE_FUNC extern
199 # endif /* !__GNUC__ */
200 #endif /* !G_INLINE_FUNC */
203 /* Provide simple macro statement wrappers (adapted from Perl):
204 * G_STMT_START { statements; } G_STMT_END;
205 * can be used as a single statement, as in
206 * if (x) G_STMT_START { ... } G_STMT_END; else ...
208 * For gcc we will wrap the statements within `({' and `})' braces.
209 * For SunOS they will be wrapped within `if (1)' and `else (void) 0',
210 * and otherwise within `do' and `while (0)'.
212 #if !(defined (G_STMT_START) && defined (G_STMT_END))
213 # if defined (__GNUC__) && !defined (__STRICT_ANSI__) && !defined (__cplusplus)
214 # define G_STMT_START (void)(
215 # define G_STMT_END )
217 # if (defined (sun) || defined (__sun__))
218 # define G_STMT_START if (1)
219 # define G_STMT_END else (void)0
221 # define G_STMT_START do
222 # define G_STMT_END while (0)
228 /* Provide macros to feature the GCC function attribute.
230 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
231 #define G_GNUC_PRINTF( format_idx, arg_idx ) \
232 __attribute__((format (printf, format_idx, arg_idx)))
233 #define G_GNUC_SCANF( format_idx, arg_idx ) \
234 __attribute__((format (scanf, format_idx, arg_idx)))
235 #define G_GNUC_FORMAT( arg_idx ) \
236 __attribute__((format_arg (arg_idx)))
237 #define G_GNUC_NORETURN \
238 __attribute__((noreturn))
239 #define G_GNUC_CONST \
240 __attribute__((const))
241 #define G_GNUC_UNUSED \
242 __attribute__((unused))
243 #else /* !__GNUC__ */
244 #define G_GNUC_PRINTF( format_idx, arg_idx )
245 #define G_GNUC_SCANF( format_idx, arg_idx )
246 #define G_GNUC_FORMAT( arg_idx )
247 #define G_GNUC_NORETURN
249 #define G_GNUC_UNUSED
250 #endif /* !__GNUC__ */
253 /* Wrap the gcc __PRETTY_FUNCTION__ and __FUNCTION__ variables with
254 * macros, so we can refer to them as strings unconditionally.
257 #define G_GNUC_FUNCTION (__FUNCTION__)
258 #define G_GNUC_PRETTY_FUNCTION (__PRETTY_FUNCTION__)
259 #else /* !__GNUC__ */
260 #define G_GNUC_FUNCTION ("")
261 #define G_GNUC_PRETTY_FUNCTION ("")
262 #endif /* !__GNUC__ */
264 /* we try to provide a usefull equivalent for ATEXIT if it is
265 * not defined, but use is actually abandoned. people should
266 * use g_atexit() instead.
269 # define ATEXIT(proc) g_ATEXIT(proc)
271 # define G_NATIVE_ATEXIT
274 /* Hacker macro to place breakpoints for elected machines.
275 * Actual use is strongly deprecated of course ;)
277 #if defined (__i386__) && defined (__GNUC__) && __GNUC__ >= 2
278 #define G_BREAKPOINT() G_STMT_START{ __asm__ __volatile__ ("int $03"); }G_STMT_END
279 #elif defined (__alpha__) && defined (__GNUC__) && __GNUC__ >= 2
280 #define G_BREAKPOINT() G_STMT_START{ __asm__ __volatile__ ("bpt"); }G_STMT_END
281 #else /* !__i386__ && !__alpha__ */
282 #define G_BREAKPOINT()
283 #endif /* __i386__ */
286 /* Provide macros for easily allocating memory. The macros
287 * will cast the allocated memory to the specified type
288 * in order to avoid compiler warnings. (Makes the code neater).
292 # define g_new(type, count) (ALLOC (type, count))
293 # define g_new0(type, count) (CALLOC (type, count))
294 # define g_renew(type, mem, count) (REALLOC (mem, type, count))
295 #else /* __DMALLOC_H__ */
296 # define g_new(type, count) \
297 ((type *) g_malloc ((unsigned) sizeof (type) * (count)))
298 # define g_new0(type, count) \
299 ((type *) g_malloc0 ((unsigned) sizeof (type) * (count)))
300 # define g_renew(type, mem, count) \
301 ((type *) g_realloc (mem, (unsigned) sizeof (type) * (count)))
302 #endif /* __DMALLOC_H__ */
304 #define g_mem_chunk_create(type, pre_alloc, alloc_type) ( \
305 g_mem_chunk_new (#type " mem chunks (" #pre_alloc ")", \
307 sizeof (type) * (pre_alloc), \
310 #define g_chunk_new(type, chunk) ( \
311 (type *) g_mem_chunk_alloc (chunk) \
313 #define g_chunk_new0(type, chunk) ( \
314 (type *) g_mem_chunk_alloc0 (chunk) \
316 #define g_chunk_free(mem, mem_chunk) G_STMT_START { \
317 g_mem_chunk_free ((mem_chunk), (mem)); \
321 #define g_string(x) #x
324 /* Provide macros for error handling. The "assert" macros will
325 * exit on failure. The "return" macros will exit the current
326 * function. Two different definitions are given for the macros
327 * if G_DISABLE_ASSERT is not defined, in order to support gcc's
328 * __PRETTY_FUNCTION__ capability.
331 #ifdef G_DISABLE_ASSERT
333 #define g_assert(expr)
334 #define g_assert_not_reached()
336 #else /* !G_DISABLE_ASSERT */
340 #define g_assert(expr) G_STMT_START{ \
342 g_log (G_LOG_DOMAIN, \
344 "file %s: line %d (%s): assertion failed: (%s)", \
347 __PRETTY_FUNCTION__, \
350 #define g_assert_not_reached() G_STMT_START{ \
351 g_log (G_LOG_DOMAIN, \
353 "file %s: line %d (%s): should not be reached", \
356 __PRETTY_FUNCTION__); }G_STMT_END
358 #else /* !__GNUC__ */
360 #define g_assert(expr) G_STMT_START{ \
362 g_log (G_LOG_DOMAIN, \
364 "file %s: line %d: assertion failed: (%s)", \
369 #define g_assert_not_reached() G_STMT_START{ \
370 g_log (G_LOG_DOMAIN, \
372 "file %s: line %d: should not be reached", \
374 __LINE__); }G_STMT_END
376 #endif /* __GNUC__ */
378 #endif /* !G_DISABLE_ASSERT */
381 #ifdef G_DISABLE_CHECKS
383 #define g_return_if_fail(expr)
384 #define g_return_val_if_fail(expr,val)
386 #else /* !G_DISABLE_CHECKS */
390 #define g_return_if_fail(expr) G_STMT_START{ \
393 g_log (G_LOG_DOMAIN, \
394 G_LOG_LEVEL_CRITICAL, \
395 "file %s: line %d (%s): assertion `%s' failed.", \
398 __PRETTY_FUNCTION__, \
403 #define g_return_val_if_fail(expr,val) 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 #else /* !__GNUC__ */
418 #define g_return_if_fail(expr) G_STMT_START{ \
421 g_log (G_LOG_DOMAIN, \
422 G_LOG_LEVEL_CRITICAL, \
423 "file %s: line %d: assertion `%s' failed.", \
430 #define g_return_val_if_fail(expr, val) G_STMT_START{ \
433 g_log (G_LOG_DOMAIN, \
434 G_LOG_LEVEL_CRITICAL, \
435 "file %s: line %d: assertion `%s' failed.", \
442 #endif /* !__GNUC__ */
444 #endif /* !G_DISABLE_CHECKS */
447 /* Provide type definitions for commonly used types.
448 * These are useful because a "gint8" can be adjusted
449 * to be 1 byte (8 bits) on all platforms. Similarly and
450 * more importantly, "gint32" can be adjusted to be
451 * 4 bytes (32 bits) on all platforms.
455 typedef short gshort;
458 typedef gint gboolean;
460 typedef unsigned char guchar;
461 typedef unsigned short gushort;
462 typedef unsigned long gulong;
463 typedef unsigned int guint;
465 typedef float gfloat;
466 typedef double gdouble;
468 /* HAVE_LONG_DOUBLE doesn't work correctly on all platforms.
469 * Since gldouble isn't used anywhere, just disable it for now */
472 #ifdef HAVE_LONG_DOUBLE
473 typedef long double gldouble;
474 #else /* HAVE_LONG_DOUBLE */
475 typedef double gldouble;
476 #endif /* HAVE_LONG_DOUBLE */
479 typedef void* gpointer;
480 typedef const void *gconstpointer;
483 typedef gint32 gssize;
484 typedef guint32 gsize;
485 typedef guint32 GQuark;
486 typedef gint32 GTime;
489 /* Portable endian checks and conversions
491 * glibconfig.h defines G_BYTE_ORDER which expands to one of
494 #define G_LITTLE_ENDIAN 1234
495 #define G_BIG_ENDIAN 4321
496 #define G_PDP_ENDIAN 3412 /* unused, need specific PDP check */
499 /* Basic bit swapping functions
501 #define GUINT16_SWAP_LE_BE_CONSTANT(val) ((guint16) ( \
502 (((guint16) (val) & (guint16) 0x00ffU) << 8) | \
503 (((guint16) (val) & (guint16) 0xff00U) >> 8)))
504 #define GUINT32_SWAP_LE_BE_CONSTANT(val) ((guint32) ( \
505 (((guint32) (val) & (guint32) 0x000000ffU) << 24) | \
506 (((guint32) (val) & (guint32) 0x0000ff00U) << 8) | \
507 (((guint32) (val) & (guint32) 0x00ff0000U) >> 8) | \
508 (((guint32) (val) & (guint32) 0xff000000U) >> 24)))
510 /* Intel specific stuff for speed
512 #if defined (__i386__) && defined (__GNUC__) && __GNUC__ >= 2
513 # define GUINT16_SWAP_LE_BE_X86(val) \
515 ({ register guint16 __v; \
516 if (__builtin_constant_p (val)) \
517 __v = GUINT16_SWAP_LE_BE_CONSTANT (val); \
519 __asm__ __const__ ("rorw $8, %w0" \
521 : "0" ((guint16) (val))); \
523 # define GUINT16_SWAP_LE_BE(val) (GUINT16_SWAP_LE_BE_X86 (val))
524 # if !defined(__i486__) && !defined(__i586__) \
525 && !defined(__pentium__) && !defined(__i686__) && !defined(__pentiumpro__)
526 # define GUINT32_SWAP_LE_BE_X86(val) \
528 ({ register guint32 __v; \
529 if (__builtin_constant_p (val)) \
530 __v = GUINT32_SWAP_LE_BE_CONSTANT (val); \
532 __asm__ __const__ ("rorw $8, %w0\n\t" \
536 : "0" ((guint32) (val))); \
538 # else /* 486 and higher has bswap */
539 # define GUINT32_SWAP_LE_BE_X86(val) \
541 ({ register guint32 __v; \
542 if (__builtin_constant_p (val)) \
543 __v = GUINT32_SWAP_LE_BE_CONSTANT (val); \
545 __asm__ __const__ ("bswap %0" \
547 : "0" ((guint32) (val))); \
549 # endif /* processor specific 32-bit stuff */
550 # define GUINT32_SWAP_LE_BE(val) (GUINT32_SWAP_LE_BE_X86 (val))
551 #else /* !__i386__ */
552 # define GUINT16_SWAP_LE_BE(val) (GUINT16_SWAP_LE_BE_CONSTANT (val))
553 # define GUINT32_SWAP_LE_BE(val) (GUINT32_SWAP_LE_BE_CONSTANT (val))
554 #endif /* __i386__ */
557 # define GUINT64_SWAP_LE_BE_CONSTANT(val) ((guint64) ( \
558 (((guint64) (val) & \
559 (guint64) G_GINT64_CONSTANT(0x00000000000000ffU)) << 56) | \
560 (((guint64) (val) & \
561 (guint64) G_GINT64_CONSTANT(0x000000000000ff00U)) << 40) | \
562 (((guint64) (val) & \
563 (guint64) G_GINT64_CONSTANT(0x0000000000ff0000U)) << 24) | \
564 (((guint64) (val) & \
565 (guint64) G_GINT64_CONSTANT(0x00000000ff000000U)) << 8) | \
566 (((guint64) (val) & \
567 (guint64) G_GINT64_CONSTANT(0x000000ff00000000U)) >> 8) | \
568 (((guint64) (val) & \
569 (guint64) G_GINT64_CONSTANT(0x0000ff0000000000U)) >> 24) | \
570 (((guint64) (val) & \
571 (guint64) G_GINT64_CONSTANT(0x00ff000000000000U)) >> 40) | \
572 (((guint64) (val) & \
573 (guint64) G_GINT64_CONSTANT(0xff00000000000000U)) >> 56)))
574 # if defined (__i386__) && defined (__GNUC__) && __GNUC__ >= 2
575 # define GUINT64_SWAP_LE_BE_X86(val) \
577 ({ union { guint64 __ll; \
578 guint32 __l[2]; } __r; \
579 if (__builtin_constant_p (val)) \
580 __r.__ll = GUINT64_SWAP_LE_BE_CONSTANT (val); \
583 union { guint64 __ll; \
584 guint32 __l[2]; } __w; \
585 __w.__ll = ((guint64) val); \
586 __r.__l[0] = GUINT32_SWAP_LE_BE (__w.__l[1]); \
587 __r.__l[1] = GUINT32_SWAP_LE_BE (__w.__l[0]); \
590 # define GUINT64_SWAP_LE_BE(val) (GUINT64_SWAP_LE_BE_X86 (val))
591 # else /* !__i386__ */
592 # define GUINT64_SWAP_LE_BE(val) (GUINT64_SWAP_LE_BE_CONSTANT(val))
596 #define GUINT16_SWAP_LE_PDP(val) ((guint16) (val))
597 #define GUINT16_SWAP_BE_PDP(val) (GUINT16_SWAP_LE_BE (val))
598 #define GUINT32_SWAP_LE_PDP(val) ((guint32) ( \
599 (((guint32) (val) & (guint32) 0x0000ffffU) << 16) | \
600 (((guint32) (val) & (guint32) 0xffff0000U) >> 16)))
601 #define GUINT32_SWAP_BE_PDP(val) ((guint32) ( \
602 (((guint32) (val) & (guint32) 0x00ff00ffU) << 8) | \
603 (((guint32) (val) & (guint32) 0xff00ff00U) >> 8)))
605 /* The G*_TO_?E() macros are defined in glibconfig.h.
606 * The transformation is symmetric, so the FROM just maps to the TO.
608 #define GINT16_FROM_LE(val) (GINT16_TO_LE (val))
609 #define GUINT16_FROM_LE(val) (GUINT16_TO_LE (val))
610 #define GINT16_FROM_BE(val) (GINT16_TO_BE (val))
611 #define GUINT16_FROM_BE(val) (GUINT16_TO_BE (val))
612 #define GINT32_FROM_LE(val) (GINT32_TO_LE (val))
613 #define GUINT32_FROM_LE(val) (GUINT32_TO_LE (val))
614 #define GINT32_FROM_BE(val) (GINT32_TO_BE (val))
615 #define GUINT32_FROM_BE(val) (GUINT32_TO_BE (val))
618 #define GINT64_FROM_LE(val) (GINT64_TO_LE (val))
619 #define GUINT64_FROM_LE(val) (GUINT64_TO_LE (val))
620 #define GINT64_FROM_BE(val) (GINT64_TO_BE (val))
621 #define GUINT64_FROM_BE(val) (GUINT64_TO_BE (val))
624 #define GLONG_FROM_LE(val) (GLONG_TO_LE (val))
625 #define GULONG_FROM_LE(val) (GULONG_TO_LE (val))
626 #define GLONG_FROM_BE(val) (GLONG_TO_BE (val))
627 #define GULONG_FROM_BE(val) (GULONG_TO_BE (val))
629 #define GINT_FROM_LE(val) (GINT_TO_LE (val))
630 #define GUINT_FROM_LE(val) (GUINT_TO_LE (val))
631 #define GINT_FROM_BE(val) (GINT_TO_BE (val))
632 #define GUINT_FROM_BE(val) (GUINT_TO_BE (val))
635 /* Portable versions of host-network order stuff
637 #define g_ntohl(val) (GUINT32_FROM_BE (val))
638 #define g_ntohs(val) (GUINT16_FROM_BE (val))
639 #define g_htonl(val) (GUINT32_TO_BE (val))
640 #define g_htons(val) (GUINT16_TO_BE (val))
644 * we prefix variable declarations so they can
645 * properly get exported in windows dlls.
648 # ifdef GLIB_COMPILATION
649 # define GUTILS_C_VAR __declspec(dllexport)
650 # else /* !GLIB_COMPILATION */
651 # define GUTILS_C_VAR extern __declspec(dllimport)
652 # endif /* !GLIB_COMPILATION */
653 #else /* !NATIVE_WIN32 */
654 # define GUTILS_C_VAR extern
655 #endif /* !NATIVE_WIN32 */
657 GUTILS_C_VAR const guint glib_major_version;
658 GUTILS_C_VAR const guint glib_minor_version;
659 GUTILS_C_VAR const guint glib_micro_version;
660 GUTILS_C_VAR const guint glib_interface_age;
661 GUTILS_C_VAR const guint glib_binary_age;
664 /* Forward declarations of glib types.
666 typedef struct _GAllocator GAllocator;
667 typedef struct _GArray GArray;
668 typedef struct _GByteArray GByteArray;
669 typedef struct _GCache GCache;
670 typedef struct _GCompletion GCompletion;
671 typedef struct _GData GData;
672 typedef struct _GDebugKey GDebugKey;
673 typedef struct _GHashTable GHashTable;
674 typedef struct _GHook GHook;
675 typedef struct _GHookList GHookList;
676 typedef struct _GList GList;
677 typedef struct _GMemChunk GMemChunk;
678 typedef struct _GNode GNode;
679 typedef struct _GPtrArray GPtrArray;
680 typedef struct _GRelation GRelation;
681 typedef struct _GScanner GScanner;
682 typedef struct _GScannerConfig GScannerConfig;
683 typedef struct _GSList GSList;
684 typedef struct _GString GString;
685 typedef struct _GStringChunk GStringChunk;
686 typedef struct _GTimer GTimer;
687 typedef struct _GTree GTree;
688 typedef struct _GTuples GTuples;
689 typedef union _GTokenValue GTokenValue;
690 typedef struct _GIOChannel GIOChannel;
694 G_TRAVERSE_LEAFS = 1 << 0,
695 G_TRAVERSE_NON_LEAFS = 1 << 1,
696 G_TRAVERSE_ALL = G_TRAVERSE_LEAFS | G_TRAVERSE_NON_LEAFS,
697 G_TRAVERSE_MASK = 0x03
708 /* Log level shift offset for user defined
709 * log levels (0-7 are used by GLib).
711 #define G_LOG_LEVEL_USER_SHIFT (8)
713 /* Glib log levels and flags.
718 G_LOG_FLAG_RECURSION = 1 << 0,
719 G_LOG_FLAG_FATAL = 1 << 1,
721 /* GLib log levels */
722 G_LOG_LEVEL_ERROR = 1 << 2, /* always fatal */
723 G_LOG_LEVEL_CRITICAL = 1 << 3,
724 G_LOG_LEVEL_WARNING = 1 << 4,
725 G_LOG_LEVEL_MESSAGE = 1 << 5,
726 G_LOG_LEVEL_INFO = 1 << 6,
727 G_LOG_LEVEL_DEBUG = 1 << 7,
729 G_LOG_LEVEL_MASK = ~(G_LOG_FLAG_RECURSION | G_LOG_FLAG_FATAL)
732 /* GLib log levels that are considered fatal by default */
733 #define G_LOG_FATAL_MASK (G_LOG_FLAG_RECURSION | G_LOG_LEVEL_ERROR)
736 typedef gpointer (*GCacheNewFunc) (gpointer key);
737 typedef gpointer (*GCacheDupFunc) (gpointer value);
738 typedef void (*GCacheDestroyFunc) (gpointer value);
739 typedef gint (*GCompareFunc) (gconstpointer a,
741 typedef gchar* (*GCompletionFunc) (gpointer);
742 typedef void (*GDestroyNotify) (gpointer data);
743 typedef void (*GDataForeachFunc) (GQuark key_id,
746 typedef void (*GFunc) (gpointer data,
748 typedef guint (*GHashFunc) (gconstpointer key);
749 typedef void (*GFreeFunc) (gpointer data);
750 typedef void (*GHFunc) (gpointer key,
753 typedef gboolean (*GHRFunc) (gpointer key,
756 typedef gint (*GHookCompareFunc) (GHook *new_hook,
758 typedef gboolean (*GHookFindFunc) (GHook *hook,
760 typedef void (*GHookMarshaller) (GHook *hook,
762 typedef gboolean (*GHookCheckMarshaller) (GHook *hook,
764 typedef void (*GHookFunc) (gpointer data);
765 typedef gboolean (*GHookCheckFunc) (gpointer data);
766 typedef void (*GHookFreeFunc) (GHookList *hook_list,
768 typedef void (*GLogFunc) (const gchar *log_domain,
769 GLogLevelFlags log_level,
770 const gchar *message,
772 typedef gboolean (*GNodeTraverseFunc) (GNode *node,
774 typedef void (*GNodeForeachFunc) (GNode *node,
776 typedef gint (*GSearchFunc) (gpointer key,
778 typedef void (*GScannerMsgFunc) (GScanner *scanner,
781 typedef gint (*GTraverseFunc) (gpointer key,
784 typedef void (*GVoidFunc) (void);
836 /* Doubly linked lists
838 void g_list_push_allocator (GAllocator *allocator);
839 void g_list_pop_allocator (void);
840 GList* g_list_alloc (void);
841 void g_list_free (GList *list);
842 void g_list_free_1 (GList *list);
843 GList* g_list_append (GList *list,
845 GList* g_list_prepend (GList *list,
847 GList* g_list_insert (GList *list,
850 GList* g_list_insert_sorted (GList *list,
853 GList* g_list_concat (GList *list1,
855 GList* g_list_remove (GList *list,
857 GList* g_list_remove_link (GList *list,
859 GList* g_list_reverse (GList *list);
860 GList* g_list_copy (GList *list);
861 GList* g_list_nth (GList *list,
863 GList* g_list_find (GList *list,
865 GList* g_list_find_custom (GList *list,
868 gint g_list_position (GList *list,
870 gint g_list_index (GList *list,
872 GList* g_list_last (GList *list);
873 GList* g_list_first (GList *list);
874 guint g_list_length (GList *list);
875 void g_list_foreach (GList *list,
878 GList* g_list_sort (GList *list,
879 GCompareFunc compare_func);
880 gpointer g_list_nth_data (GList *list,
882 #define g_list_previous(list) ((list) ? (((GList *)(list))->prev) : NULL)
883 #define g_list_next(list) ((list) ? (((GList *)(list))->next) : NULL)
886 /* Singly linked lists
888 void g_slist_push_allocator (GAllocator *allocator);
889 void g_slist_pop_allocator (void);
890 GSList* g_slist_alloc (void);
891 void g_slist_free (GSList *list);
892 void g_slist_free_1 (GSList *list);
893 GSList* g_slist_append (GSList *list,
895 GSList* g_slist_prepend (GSList *list,
897 GSList* g_slist_insert (GSList *list,
900 GSList* g_slist_insert_sorted (GSList *list,
903 GSList* g_slist_concat (GSList *list1,
905 GSList* g_slist_remove (GSList *list,
907 GSList* g_slist_remove_link (GSList *list,
909 GSList* g_slist_reverse (GSList *list);
910 GSList* g_slist_copy (GSList *list);
911 GSList* g_slist_nth (GSList *list,
913 GSList* g_slist_find (GSList *list,
915 GSList* g_slist_find_custom (GSList *list,
918 gint g_slist_position (GSList *list,
920 gint g_slist_index (GSList *list,
922 GSList* g_slist_last (GSList *list);
923 guint g_slist_length (GSList *list);
924 void g_slist_foreach (GSList *list,
927 GSList* g_slist_sort (GSList *list,
928 GCompareFunc compare_func);
929 gpointer g_slist_nth_data (GSList *list,
931 #define g_slist_next(slist) ((slist) ? (((GSList *)(slist))->next) : NULL)
936 GHashTable* g_hash_table_new (GHashFunc hash_func,
937 GCompareFunc key_compare_func);
938 void g_hash_table_destroy (GHashTable *hash_table);
939 void g_hash_table_insert (GHashTable *hash_table,
942 void g_hash_table_remove (GHashTable *hash_table,
944 gpointer g_hash_table_lookup (GHashTable *hash_table,
946 gboolean g_hash_table_lookup_extended(GHashTable *hash_table,
947 gconstpointer lookup_key,
950 void g_hash_table_freeze (GHashTable *hash_table);
951 void g_hash_table_thaw (GHashTable *hash_table);
952 void g_hash_table_foreach (GHashTable *hash_table,
955 gint g_hash_table_foreach_remove (GHashTable *hash_table,
958 gint g_hash_table_size (GHashTable *hash_table);
963 GCache* g_cache_new (GCacheNewFunc value_new_func,
964 GCacheDestroyFunc value_destroy_func,
965 GCacheDupFunc key_dup_func,
966 GCacheDestroyFunc key_destroy_func,
967 GHashFunc hash_key_func,
968 GHashFunc hash_value_func,
969 GCompareFunc key_compare_func);
970 void g_cache_destroy (GCache *cache);
971 gpointer g_cache_insert (GCache *cache,
973 void g_cache_remove (GCache *cache,
975 void g_cache_key_foreach (GCache *cache,
978 void g_cache_value_foreach (GCache *cache,
983 /* Balanced binary trees
985 GTree* g_tree_new (GCompareFunc key_compare_func);
986 void g_tree_destroy (GTree *tree);
987 void g_tree_insert (GTree *tree,
990 void g_tree_remove (GTree *tree,
992 gpointer g_tree_lookup (GTree *tree,
994 void g_tree_traverse (GTree *tree,
995 GTraverseFunc traverse_func,
996 GTraverseType traverse_type,
998 gpointer g_tree_search (GTree *tree,
999 GSearchFunc search_func,
1001 gint g_tree_height (GTree *tree);
1002 gint g_tree_nnodes (GTree *tree);
1006 /* N-way tree implementation
1017 #define G_NODE_IS_ROOT(node) (((GNode*) (node))->parent == NULL && \
1018 ((GNode*) (node))->prev == NULL && \
1019 ((GNode*) (node))->next == NULL)
1020 #define G_NODE_IS_LEAF(node) (((GNode*) (node))->children == NULL)
1022 void g_node_push_allocator (GAllocator *allocator);
1023 void g_node_pop_allocator (void);
1024 GNode* g_node_new (gpointer data);
1025 void g_node_destroy (GNode *root);
1026 void g_node_unlink (GNode *node);
1027 GNode* g_node_insert (GNode *parent,
1030 GNode* g_node_insert_before (GNode *parent,
1033 GNode* g_node_prepend (GNode *parent,
1035 guint g_node_n_nodes (GNode *root,
1036 GTraverseFlags flags);
1037 GNode* g_node_get_root (GNode *node);
1038 gboolean g_node_is_ancestor (GNode *node,
1040 guint g_node_depth (GNode *node);
1041 GNode* g_node_find (GNode *root,
1042 GTraverseType order,
1043 GTraverseFlags flags,
1046 /* convenience macros */
1047 #define g_node_append(parent, node) \
1048 g_node_insert_before ((parent), NULL, (node))
1049 #define g_node_insert_data(parent, position, data) \
1050 g_node_insert ((parent), (position), g_node_new (data))
1051 #define g_node_insert_data_before(parent, sibling, data) \
1052 g_node_insert_before ((parent), (sibling), g_node_new (data))
1053 #define g_node_prepend_data(parent, data) \
1054 g_node_prepend ((parent), g_node_new (data))
1055 #define g_node_append_data(parent, data) \
1056 g_node_insert_before ((parent), NULL, g_node_new (data))
1058 /* traversal function, assumes that `node' is root
1059 * (only traverses `node' and its subtree).
1060 * this function is just a high level interface to
1061 * low level traversal functions, optimized for speed.
1063 void g_node_traverse (GNode *root,
1064 GTraverseType order,
1065 GTraverseFlags flags,
1067 GNodeTraverseFunc func,
1070 /* return the maximum tree height starting with `node', this is an expensive
1071 * operation, since we need to visit all nodes. this could be shortened by
1072 * adding `guint height' to struct _GNode, but then again, this is not very
1073 * often needed, and would make g_node_insert() more time consuming.
1075 guint g_node_max_height (GNode *root);
1077 void g_node_children_foreach (GNode *node,
1078 GTraverseFlags flags,
1079 GNodeForeachFunc func,
1081 void g_node_reverse_children (GNode *node);
1082 guint g_node_n_children (GNode *node);
1083 GNode* g_node_nth_child (GNode *node,
1085 GNode* g_node_last_child (GNode *node);
1086 GNode* g_node_find_child (GNode *node,
1087 GTraverseFlags flags,
1089 gint g_node_child_position (GNode *node,
1091 gint g_node_child_index (GNode *node,
1094 GNode* g_node_first_sibling (GNode *node);
1095 GNode* g_node_last_sibling (GNode *node);
1097 #define g_node_prev_sibling(node) ((node) ? \
1098 ((GNode*) (node))->prev : NULL)
1099 #define g_node_next_sibling(node) ((node) ? \
1100 ((GNode*) (node))->next : NULL)
1101 #define g_node_first_child(node) ((node) ? \
1102 ((GNode*) (node))->children : NULL)
1105 /* Callback maintenance functions
1107 #define G_HOOK_FLAG_USER_SHIFT (4)
1110 G_HOOK_FLAG_ACTIVE = 1 << 0,
1111 G_HOOK_FLAG_IN_CALL = 1 << 1,
1112 G_HOOK_FLAG_MASK = 0x0f
1121 GMemChunk *hook_memchunk;
1122 GHookFreeFunc hook_free; /* virtual function */
1134 GDestroyNotify destroy;
1137 #define G_HOOK_ACTIVE(hook) ((((GHook*) hook)->flags & \
1138 G_HOOK_FLAG_ACTIVE) != 0)
1139 #define G_HOOK_IN_CALL(hook) ((((GHook*) hook)->flags & \
1140 G_HOOK_FLAG_IN_CALL) != 0)
1141 #define G_HOOK_IS_VALID(hook) (((GHook*) hook)->hook_id != 0 && \
1142 G_HOOK_ACTIVE (hook))
1143 #define G_HOOK_IS_UNLINKED(hook) (((GHook*) hook)->next == NULL && \
1144 ((GHook*) hook)->prev == NULL && \
1145 ((GHook*) hook)->hook_id == 0 && \
1146 ((GHook*) hook)->ref_count == 0)
1148 void g_hook_list_init (GHookList *hook_list,
1150 void g_hook_list_clear (GHookList *hook_list);
1151 GHook* g_hook_alloc (GHookList *hook_list);
1152 void g_hook_free (GHookList *hook_list,
1154 void g_hook_ref (GHookList *hook_list,
1156 void g_hook_unref (GHookList *hook_list,
1158 gboolean g_hook_destroy (GHookList *hook_list,
1160 void g_hook_destroy_link (GHookList *hook_list,
1162 void g_hook_prepend (GHookList *hook_list,
1164 void g_hook_insert_before (GHookList *hook_list,
1167 void g_hook_insert_sorted (GHookList *hook_list,
1169 GHookCompareFunc func);
1170 GHook* g_hook_get (GHookList *hook_list,
1172 GHook* g_hook_find (GHookList *hook_list,
1173 gboolean need_valids,
1176 GHook* g_hook_find_data (GHookList *hook_list,
1177 gboolean need_valids,
1179 GHook* g_hook_find_func (GHookList *hook_list,
1180 gboolean need_valids,
1182 GHook* g_hook_find_func_data (GHookList *hook_list,
1183 gboolean need_valids,
1186 /* return the first valid hook, and increment its reference count */
1187 GHook* g_hook_first_valid (GHookList *hook_list,
1188 gboolean may_be_in_call);
1189 /* return the next valid hook with incremented reference count, and
1190 * decrement the reference count of the original hook
1192 GHook* g_hook_next_valid (GHookList *hook_list,
1194 gboolean may_be_in_call);
1196 /* GHookCompareFunc implementation to insert hooks sorted by their id */
1197 gint g_hook_compare_ids (GHook *new_hook,
1200 /* convenience macros */
1201 #define g_hook_append( hook_list, hook ) \
1202 g_hook_insert_before ((hook_list), NULL, (hook))
1204 /* invoke all valid hooks with the (*GHookFunc) signature.
1206 void g_hook_list_invoke (GHookList *hook_list,
1207 gboolean may_recurse);
1208 /* invoke all valid hooks with the (*GHookCheckFunc) signature,
1209 * and destroy the hook if FALSE is returned.
1211 void g_hook_list_invoke_check (GHookList *hook_list,
1212 gboolean may_recurse);
1213 /* invoke a marshaller on all valid hooks.
1215 void g_hook_list_marshal (GHookList *hook_list,
1216 gboolean may_recurse,
1217 GHookMarshaller marshaller,
1219 void g_hook_list_marshal_check (GHookList *hook_list,
1220 gboolean may_recurse,
1221 GHookCheckMarshaller marshaller,
1225 /* Fatal error handlers.
1226 * g_on_error_query() will prompt the user to either
1227 * [E]xit, [H]alt, [P]roceed or show [S]tack trace.
1228 * g_on_error_stack_trace() invokes gdb, which attaches to the current
1229 * process and shows a stack trace.
1230 * These function may cause different actions on non-unix platforms.
1231 * The prg_name arg is required by gdb to find the executable, if it is
1232 * passed as NULL, g_on_error_query() will try g_get_prgname().
1234 void g_on_error_query (const gchar *prg_name);
1235 void g_on_error_stack_trace (const gchar *prg_name);
1238 /* Logging mechanism
1240 extern const gchar *g_log_domain_glib;
1241 guint g_log_set_handler (const gchar *log_domain,
1242 GLogLevelFlags log_levels,
1244 gpointer user_data);
1245 void g_log_remove_handler (const gchar *log_domain,
1247 void g_log_default_handler (const gchar *log_domain,
1248 GLogLevelFlags log_level,
1249 const gchar *message,
1250 gpointer unused_data);
1251 void g_log (const gchar *log_domain,
1252 GLogLevelFlags log_level,
1253 const gchar *format,
1254 ...) G_GNUC_PRINTF (3, 4);
1255 void g_logv (const gchar *log_domain,
1256 GLogLevelFlags log_level,
1257 const gchar *format,
1259 GLogLevelFlags g_log_set_fatal_mask (const gchar *log_domain,
1260 GLogLevelFlags fatal_mask);
1261 GLogLevelFlags g_log_set_always_fatal (GLogLevelFlags fatal_mask);
1262 #ifndef G_LOG_DOMAIN
1263 #define G_LOG_DOMAIN (NULL)
1264 #endif /* G_LOG_DOMAIN */
1266 #define g_error(format, args...) g_log (G_LOG_DOMAIN, \
1267 G_LOG_LEVEL_ERROR, \
1269 #define g_message(format, args...) g_log (G_LOG_DOMAIN, \
1270 G_LOG_LEVEL_MESSAGE, \
1272 #define g_warning(format, args...) g_log (G_LOG_DOMAIN, \
1273 G_LOG_LEVEL_WARNING, \
1275 #else /* !__GNUC__ */
1277 g_error (const gchar *format,
1281 va_start (args, format);
1282 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR, format, args);
1286 g_message (const gchar *format,
1290 va_start (args, format);
1291 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_MESSAGE, format, args);
1295 g_warning (const gchar *format,
1299 va_start (args, format);
1300 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING, format, args);
1303 #endif /* !__GNUC__ */
1305 typedef void (*GPrintFunc) (const gchar *string);
1306 void g_print (const gchar *format,
1307 ...) G_GNUC_PRINTF (1, 2);
1308 GPrintFunc g_set_print_handler (GPrintFunc func);
1309 void g_printerr (const gchar *format,
1310 ...) G_GNUC_PRINTF (1, 2);
1311 GPrintFunc g_set_printerr_handler (GPrintFunc func);
1313 /* deprecated compatibility functions, use g_log_set_handler() instead */
1314 typedef void (*GErrorFunc) (const gchar *str);
1315 typedef void (*GWarningFunc) (const gchar *str);
1316 GErrorFunc g_set_error_handler (GErrorFunc func);
1317 GWarningFunc g_set_warning_handler (GWarningFunc func);
1318 GPrintFunc g_set_message_handler (GPrintFunc func);
1321 /* Memory allocation and debugging
1325 #define g_malloc(size) ((gpointer) MALLOC (size))
1326 #define g_malloc0(size) ((gpointer) CALLOC (char, size))
1327 #define g_realloc(mem,size) ((gpointer) REALLOC (mem, char, size))
1328 #define g_free(mem) FREE (mem)
1330 #else /* !USE_DMALLOC */
1332 gpointer g_malloc (gulong size);
1333 gpointer g_malloc0 (gulong size);
1334 gpointer g_realloc (gpointer mem,
1336 void g_free (gpointer mem);
1338 #endif /* !USE_DMALLOC */
1340 void g_mem_profile (void);
1341 void g_mem_check (gpointer mem);
1343 /* Generic allocators
1345 GAllocator* g_allocator_new (const gchar *name,
1347 void g_allocator_free (GAllocator *allocator);
1349 #define G_ALLOCATOR_LIST (1)
1350 #define G_ALLOCATOR_SLIST (2)
1351 #define G_ALLOCATOR_NODE (3)
1354 /* "g_mem_chunk_new" creates a new memory chunk.
1355 * Memory chunks are used to allocate pieces of memory which are
1356 * always the same size. Lists are a good example of such a data type.
1357 * The memory chunk allocates and frees blocks of memory as needed.
1358 * Just be sure to call "g_mem_chunk_free" and not "g_free" on data
1359 * allocated in a mem chunk. ("g_free" will most likely cause a seg
1360 * fault...somewhere).
1362 * Oh yeah, GMemChunk is an opaque data type. (You don't really
1363 * want to know what's going on inside do you?)
1366 /* ALLOC_ONLY MemChunk's can only allocate memory. The free operation
1367 * is interpreted as a no op. ALLOC_ONLY MemChunk's save 4 bytes per
1368 * atom. (They are also useful for lists which use MemChunk to allocate
1369 * memory but are also part of the MemChunk implementation).
1370 * ALLOC_AND_FREE MemChunk's can allocate and free memory.
1373 #define G_ALLOC_ONLY 1
1374 #define G_ALLOC_AND_FREE 2
1376 GMemChunk* g_mem_chunk_new (gchar *name,
1380 void g_mem_chunk_destroy (GMemChunk *mem_chunk);
1381 gpointer g_mem_chunk_alloc (GMemChunk *mem_chunk);
1382 gpointer g_mem_chunk_alloc0 (GMemChunk *mem_chunk);
1383 void g_mem_chunk_free (GMemChunk *mem_chunk,
1385 void g_mem_chunk_clean (GMemChunk *mem_chunk);
1386 void g_mem_chunk_reset (GMemChunk *mem_chunk);
1387 void g_mem_chunk_print (GMemChunk *mem_chunk);
1388 void g_mem_chunk_info (void);
1390 /* Ah yes...we have a "g_blow_chunks" function.
1391 * "g_blow_chunks" simply compresses all the chunks. This operation
1392 * consists of freeing every memory area that should be freed (but
1393 * which we haven't gotten around to doing yet). And, no,
1394 * "g_blow_chunks" doesn't follow the naming scheme, but it is a
1395 * much better name than "g_mem_chunk_clean_all" or something
1398 void g_blow_chunks (void);
1403 GTimer* g_timer_new (void);
1404 void g_timer_destroy (GTimer *timer);
1405 void g_timer_start (GTimer *timer);
1406 void g_timer_stop (GTimer *timer);
1407 void g_timer_reset (GTimer *timer);
1408 gdouble g_timer_elapsed (GTimer *timer,
1409 gulong *microseconds);
1412 /* String utility functions that modify a string argument or
1413 * return a constant string that must not be freed.
1415 #define G_STR_DELIMITERS "_-|> <."
1416 gchar* g_strdelimit (gchar *string,
1417 const gchar *delimiters,
1418 gchar new_delimiter);
1419 gdouble g_strtod (const gchar *nptr,
1421 gchar* g_strerror (gint errnum);
1422 gchar* g_strsignal (gint signum);
1423 gint g_strcasecmp (const gchar *s1,
1425 gint g_strncasecmp (const gchar *s1,
1428 void g_strdown (gchar *string);
1429 void g_strup (gchar *string);
1430 void g_strreverse (gchar *string);
1431 /* removes leading spaces */
1432 gchar* g_strchug (gchar *string);
1433 /* removes trailing spaces */
1434 gchar* g_strchomp (gchar *string);
1435 /* removes leading & trailing spaces */
1436 #define g_strstrip( string ) g_strchomp (g_strchug (string))
1438 /* String utility functions that return a newly allocated string which
1439 * ought to be freed from the caller at some point.
1441 gchar* g_strdup (const gchar *str);
1442 gchar* g_strdup_printf (const gchar *format,
1443 ...) G_GNUC_PRINTF (1, 2);
1444 gchar* g_strdup_vprintf (const gchar *format,
1446 gchar* g_strndup (const gchar *str,
1448 gchar* g_strnfill (guint length,
1450 gchar* g_strconcat (const gchar *string1,
1451 ...); /* NULL terminated */
1452 gchar* g_strjoin (const gchar *separator,
1453 ...); /* NULL terminated */
1454 gchar* g_strescape (gchar *string);
1455 gpointer g_memdup (gconstpointer mem,
1458 /* Macros for dynamic strings via fast stack allocation
1459 * All macros take a special first argument: the target gchar* string
1463 # define g_strdup_a(newstr,str) G_STMT_START { \
1464 const char *__old = (str); \
1466 size_t __len = strlen (__old) + 1; \
1467 __new = alloca (__len); \
1468 memcpy (__new, __old, __len); \
1472 # define g_strconcat_a(newstr,str1,str2,str3) G_STMT_START { \
1473 size_t __len1 = ((str1) == (gchar*)NULL) ? 0 : strlen((str1)); \
1474 size_t __len2 = ((str2) == (gchar*)NULL) ? 0 : strlen((str2)); \
1475 size_t __len3 = ((str3) == (gchar*)NULL) ? 0 : strlen((str3)); \
1476 char *__sptr, *__new = \
1477 alloca (__len1 + __len2 + __len3 + 1); \
1479 if (__len1){memcpy (__sptr, (str1), __len1); __sptr += __len1;} \
1480 if (__len2){memcpy (__sptr, (str2), __len2); __sptr += __len2;} \
1481 if (__len3){memcpy (__sptr, (str3), __len3); __sptr += __len3;} \
1486 #endif /* G_HAVE_ALLOCA */
1489 /* NULL terminated string arrays.
1490 * g_strsplit() splits up string into max_tokens tokens at delim and
1491 * returns a newly allocated string array.
1492 * g_strjoinv() concatenates all of str_array's strings, sliding in an
1493 * optional separator, the returned string is newly allocated.
1494 * g_strfreev() frees the array itself and all of its strings.
1496 gchar** g_strsplit (const gchar *string,
1497 const gchar *delimiter,
1499 gchar* g_strjoinv (const gchar *separator,
1501 void g_strfreev (gchar **str_array);
1505 /* calculate a string size, guarranteed to fit format + args.
1507 guint g_printf_string_upper_bound (const gchar* format,
1511 /* Retrive static string info
1513 gchar* g_get_user_name (void);
1514 gchar* g_get_real_name (void);
1515 gchar* g_get_home_dir (void);
1516 gchar* g_get_tmp_dir (void);
1517 gchar* g_get_prgname (void);
1518 void g_set_prgname (const gchar *prgname);
1521 /* Miscellaneous utility functions
1523 guint g_parse_debug_string (const gchar *string,
1526 gint g_snprintf (gchar *string,
1528 gchar const *format,
1529 ...) G_GNUC_PRINTF (3, 4);
1530 gint g_vsnprintf (gchar *string,
1532 gchar const *format,
1534 gchar* g_basename (const gchar *file_name);
1535 /* Check if a file name is an absolute path */
1536 gboolean g_path_is_absolute (const gchar *file_name);
1537 /* In case of absolute paths, skip the root part */
1538 gchar* g_path_skip_root (gchar *file_name);
1540 /* strings are newly allocated with g_malloc() */
1541 gchar* g_dirname (const gchar *file_name);
1542 gchar* g_get_current_dir (void);
1543 gchar* g_getenv (const gchar *variable);
1546 /* we use a GLib function as a replacement for ATEXIT, so
1547 * the programmer is not required to check the return value
1548 * (if there is any in the implementation) and doesn't encounter
1549 * missing include files.
1551 void g_atexit (GVoidFunc func);
1556 G_INLINE_FUNC gint g_bit_nth_lsf (guint32 mask,
1560 g_bit_nth_lsf (guint32 mask,
1566 if (mask & (1 << (guint) nth_bit))
1569 while (nth_bit < 32);
1572 #endif /* G_CAN_INLINE */
1574 G_INLINE_FUNC gint g_bit_nth_msf (guint32 mask,
1578 g_bit_nth_msf (guint32 mask,
1586 if (mask & (1 << (guint) nth_bit))
1589 while (nth_bit > 0);
1592 #endif /* G_CAN_INLINE */
1594 G_INLINE_FUNC guint g_bit_storage (guint number);
1597 g_bit_storage (guint number)
1599 register guint n_bits = 0;
1609 #endif /* G_CAN_INLINE */
1613 GStringChunk* g_string_chunk_new (gint size);
1614 void g_string_chunk_free (GStringChunk *chunk);
1615 gchar* g_string_chunk_insert (GStringChunk *chunk,
1616 const gchar *string);
1617 gchar* g_string_chunk_insert_const (GStringChunk *chunk,
1618 const gchar *string);
1623 GString* g_string_new (const gchar *init);
1624 GString* g_string_sized_new (guint dfl_size);
1625 void g_string_free (GString *string,
1627 GString* g_string_assign (GString *lval,
1629 GString* g_string_truncate (GString *string,
1631 GString* g_string_append (GString *string,
1633 GString* g_string_append_c (GString *string,
1635 GString* g_string_prepend (GString *string,
1637 GString* g_string_prepend_c (GString *string,
1639 GString* g_string_insert (GString *string,
1642 GString* g_string_insert_c (GString *string,
1645 GString* g_string_erase (GString *string,
1648 GString* g_string_down (GString *string);
1649 GString* g_string_up (GString *string);
1650 void g_string_sprintf (GString *string,
1651 const gchar *format,
1652 ...) G_GNUC_PRINTF (2, 3);
1653 void g_string_sprintfa (GString *string,
1654 const gchar *format,
1655 ...) G_GNUC_PRINTF (2, 3);
1658 /* Resizable arrays, remove fills any cleared spot and shortens the
1659 * array, while preserving the order. remove_fast will distort the
1660 * order by moving the last element to the position of the removed
1663 #define g_array_append_val(a,v) g_array_append_vals(a,&v,1)
1664 #define g_array_prepend_val(a,v) g_array_prepend_vals(a,&v,1)
1665 #define g_array_insert_val(a,i,v) g_array_prepend_vals(a,i,&v,1)
1666 #define g_array_index(a,t,i) (((t*)a->data)[i])
1668 GArray* g_array_new (gboolean zero_terminated,
1670 guint element_size);
1671 void g_array_free (GArray *array,
1672 gboolean free_segment);
1673 GArray* g_array_append_vals (GArray *array,
1676 GArray* g_array_prepend_vals (GArray *array,
1679 GArray* g_array_insert_vals (GArray *array,
1683 GArray* g_array_set_size (GArray *array,
1685 GArray* g_array_remove_index (GArray *array,
1687 GArray* g_array_remove_index_fast (GArray *array,
1690 /* Resizable pointer array. This interface is much less complicated
1691 * than the above. Add appends appends a pointer. Remove fills any
1692 * cleared spot and shortens the array. remove_fast will again distort
1695 #define g_ptr_array_index(array,index) (array->pdata)[index]
1696 GPtrArray* g_ptr_array_new (void);
1697 void g_ptr_array_free (GPtrArray *array,
1699 void g_ptr_array_set_size (GPtrArray *array,
1701 gpointer g_ptr_array_remove_index (GPtrArray *array,
1703 gpointer g_ptr_array_remove_index_fast (GPtrArray *array,
1705 gboolean g_ptr_array_remove (GPtrArray *array,
1707 gboolean g_ptr_array_remove_fast (GPtrArray *array,
1709 void g_ptr_array_add (GPtrArray *array,
1712 /* Byte arrays, an array of guint8. Implemented as a GArray,
1716 GByteArray* g_byte_array_new (void);
1717 void g_byte_array_free (GByteArray *array,
1718 gboolean free_segment);
1719 GByteArray* g_byte_array_append (GByteArray *array,
1722 GByteArray* g_byte_array_prepend (GByteArray *array,
1725 GByteArray* g_byte_array_set_size (GByteArray *array,
1727 GByteArray* g_byte_array_remove_index (GByteArray *array,
1729 GByteArray* g_byte_array_remove_index_fast (GByteArray *array,
1735 gint g_str_equal (gconstpointer v,
1737 guint g_str_hash (gconstpointer v);
1739 gint g_int_equal (gconstpointer v,
1741 guint g_int_hash (gconstpointer v);
1743 /* This "hash" function will just return the key's adress as an
1744 * unsigned integer. Useful for hashing on plain adresses or
1745 * simple integer values.
1747 guint g_direct_hash (gconstpointer v);
1748 gint g_direct_equal (gconstpointer v,
1752 /* Quarks (string<->id association)
1754 GQuark g_quark_try_string (const gchar *string);
1755 GQuark g_quark_from_static_string (const gchar *string);
1756 GQuark g_quark_from_string (const gchar *string);
1757 gchar* g_quark_to_string (GQuark quark);
1762 void g_datalist_init (GData **datalist);
1763 void g_datalist_clear (GData **datalist);
1764 gpointer g_datalist_id_get_data (GData **datalist,
1766 void g_datalist_id_set_data_full (GData **datalist,
1769 GDestroyNotify destroy_func);
1770 void g_datalist_id_remove_no_notify (GData **datalist,
1772 void g_datalist_foreach (GData **datalist,
1773 GDataForeachFunc func,
1774 gpointer user_data);
1775 #define g_datalist_id_set_data(dl, q, d) \
1776 g_datalist_id_set_data_full ((dl), (q), (d), NULL)
1777 #define g_datalist_id_remove_data(dl, q) \
1778 g_datalist_id_set_data ((dl), (q), NULL)
1779 #define g_datalist_get_data(dl, k) \
1780 (g_datalist_id_get_data ((dl), g_quark_try_string (k)))
1781 #define g_datalist_set_data_full(dl, k, d, f) \
1782 g_datalist_id_set_data_full ((dl), g_quark_from_string (k), (d), (f))
1783 #define g_datalist_remove_no_notify(dl, k) \
1784 g_datalist_id_remove_no_notify ((dl), g_quark_try_string (k))
1785 #define g_datalist_set_data(dl, k, d) \
1786 g_datalist_set_data_full ((dl), (k), (d), NULL)
1787 #define g_datalist_remove_data(dl, k) \
1788 g_datalist_id_set_data ((dl), g_quark_try_string (k), NULL)
1791 /* Location Associated Keyed Data
1793 void g_dataset_destroy (gconstpointer dataset_location);
1794 gpointer g_dataset_id_get_data (gconstpointer dataset_location,
1796 void g_dataset_id_set_data_full (gconstpointer dataset_location,
1799 GDestroyNotify destroy_func);
1800 void g_dataset_id_remove_no_notify (gconstpointer dataset_location,
1802 void g_dataset_foreach (gconstpointer dataset_location,
1803 GDataForeachFunc func,
1804 gpointer user_data);
1805 #define g_dataset_id_set_data(l, k, d) \
1806 g_dataset_id_set_data_full ((l), (k), (d), NULL)
1807 #define g_dataset_id_remove_data(l, k) \
1808 g_dataset_id_set_data ((l), (k), NULL)
1809 #define g_dataset_get_data(l, k) \
1810 (g_dataset_id_get_data ((l), g_quark_try_string (k)))
1811 #define g_dataset_set_data_full(l, k, d, f) \
1812 g_dataset_id_set_data_full ((l), g_quark_from_string (k), (d), (f))
1813 #define g_dataset_remove_no_notify(l, k) \
1814 g_dataset_id_remove_no_notify ((l), g_quark_try_string (k))
1815 #define g_dataset_set_data(l, k, d) \
1816 g_dataset_set_data_full ((l), (k), (d), NULL)
1817 #define g_dataset_remove_data(l, k) \
1818 g_dataset_id_set_data ((l), g_quark_try_string (k), NULL)
1821 /* GScanner: Flexible lexical scanner for general purpose.
1824 /* Character sets */
1825 #define G_CSET_A_2_Z "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1826 #define G_CSET_a_2_z "abcdefghijklmnopqrstuvwxyz"
1827 #define G_CSET_LATINC "\300\301\302\303\304\305\306"\
1828 "\307\310\311\312\313\314\315\316\317\320"\
1829 "\321\322\323\324\325\326"\
1830 "\330\331\332\333\334\335\336"
1831 #define G_CSET_LATINS "\337\340\341\342\343\344\345\346"\
1832 "\347\350\351\352\353\354\355\356\357\360"\
1833 "\361\362\363\364\365\366"\
1834 "\370\371\372\373\374\375\376\377"
1841 G_ERR_UNEXP_EOF_IN_STRING,
1842 G_ERR_UNEXP_EOF_IN_COMMENT,
1843 G_ERR_NON_DIGIT_IN_CONST,
1846 G_ERR_FLOAT_MALFORMED
1854 G_TOKEN_LEFT_PAREN = '(',
1855 G_TOKEN_RIGHT_PAREN = ')',
1856 G_TOKEN_LEFT_CURLY = '{',
1857 G_TOKEN_RIGHT_CURLY = '}',
1858 G_TOKEN_LEFT_BRACE = '[',
1859 G_TOKEN_RIGHT_BRACE = ']',
1860 G_TOKEN_EQUAL_SIGN = '=',
1861 G_TOKEN_COMMA = ',',
1877 G_TOKEN_IDENTIFIER_NULL,
1879 G_TOKEN_COMMENT_SINGLE,
1880 G_TOKEN_COMMENT_MULTI,
1887 gchar *v_identifier;
1899 struct _GScannerConfig
1903 gchar *cset_skip_characters; /* default: " \t\n" */
1904 gchar *cset_identifier_first;
1905 gchar *cset_identifier_nth;
1906 gchar *cpair_comment_single; /* default: "#\n" */
1908 /* Should symbol lookup work case sensitive?
1910 guint case_sensitive : 1;
1912 /* Boolean values to be adjusted "on the fly"
1913 * to configure scanning behaviour.
1915 guint skip_comment_multi : 1; /* C like comment */
1916 guint skip_comment_single : 1; /* single line comment */
1917 guint scan_comment_multi : 1; /* scan multi line comments? */
1918 guint scan_identifier : 1;
1919 guint scan_identifier_1char : 1;
1920 guint scan_identifier_NULL : 1;
1921 guint scan_symbols : 1;
1922 guint scan_binary : 1;
1923 guint scan_octal : 1;
1924 guint scan_float : 1;
1925 guint scan_hex : 1; /* `0x0ff0' */
1926 guint scan_hex_dollar : 1; /* `$0ff0' */
1927 guint scan_string_sq : 1; /* string: 'anything' */
1928 guint scan_string_dq : 1; /* string: "\\-escapes!\n" */
1929 guint numbers_2_int : 1; /* bin, octal, hex => int */
1930 guint int_2_float : 1; /* int => G_TOKEN_FLOAT? */
1931 guint identifier_2_string : 1;
1932 guint char_2_token : 1; /* return G_TOKEN_CHAR? */
1933 guint symbol_2_token : 1;
1934 guint scope_0_fallback : 1; /* try scope 0 on lookups? */
1941 guint max_parse_errors;
1943 /* g_scanner_error() increments this field */
1946 /* name of input stream, featured by the default message handler */
1947 const gchar *input_name;
1949 /* data pointer for derived structures */
1950 gpointer derived_data;
1952 /* link into the scanner configuration */
1953 GScannerConfig *config;
1955 /* fields filled in after g_scanner_get_next_token() */
1961 /* fields filled in after g_scanner_peek_next_token() */
1962 GTokenType next_token;
1963 GTokenValue next_value;
1965 guint next_position;
1967 /* to be considered private */
1968 GHashTable *symbol_table;
1971 const gchar *text_end;
1975 /* handler function for _warn and _error */
1976 GScannerMsgFunc msg_handler;
1979 GScanner* g_scanner_new (GScannerConfig *config_templ);
1980 void g_scanner_destroy (GScanner *scanner);
1981 void g_scanner_input_file (GScanner *scanner,
1983 void g_scanner_sync_file_offset (GScanner *scanner);
1984 void g_scanner_input_text (GScanner *scanner,
1987 GTokenType g_scanner_get_next_token (GScanner *scanner);
1988 GTokenType g_scanner_peek_next_token (GScanner *scanner);
1989 GTokenType g_scanner_cur_token (GScanner *scanner);
1990 GTokenValue g_scanner_cur_value (GScanner *scanner);
1991 guint g_scanner_cur_line (GScanner *scanner);
1992 guint g_scanner_cur_position (GScanner *scanner);
1993 gboolean g_scanner_eof (GScanner *scanner);
1994 guint g_scanner_set_scope (GScanner *scanner,
1996 void g_scanner_scope_add_symbol (GScanner *scanner,
1998 const gchar *symbol,
2000 void g_scanner_scope_remove_symbol (GScanner *scanner,
2002 const gchar *symbol);
2003 gpointer g_scanner_scope_lookup_symbol (GScanner *scanner,
2005 const gchar *symbol);
2006 void g_scanner_scope_foreach_symbol (GScanner *scanner,
2009 gpointer user_data);
2010 gpointer g_scanner_lookup_symbol (GScanner *scanner,
2011 const gchar *symbol);
2012 void g_scanner_freeze_symbol_table (GScanner *scanner);
2013 void g_scanner_thaw_symbol_table (GScanner *scanner);
2014 void g_scanner_unexp_token (GScanner *scanner,
2015 GTokenType expected_token,
2016 const gchar *identifier_spec,
2017 const gchar *symbol_spec,
2018 const gchar *symbol_name,
2019 const gchar *message,
2021 void g_scanner_error (GScanner *scanner,
2022 const gchar *format,
2023 ...) G_GNUC_PRINTF (2,3);
2024 void g_scanner_warn (GScanner *scanner,
2025 const gchar *format,
2026 ...) G_GNUC_PRINTF (2,3);
2027 gint g_scanner_stat_mode (const gchar *filename);
2028 /* keep downward source compatibility */
2029 #define g_scanner_add_symbol( scanner, symbol, value ) G_STMT_START { \
2030 g_scanner_scope_add_symbol ((scanner), 0, (symbol), (value)); \
2032 #define g_scanner_remove_symbol( scanner, symbol ) G_STMT_START { \
2033 g_scanner_scope_remove_symbol ((scanner), 0, (symbol)); \
2035 #define g_scanner_foreach_symbol( scanner, func, data ) G_STMT_START { \
2036 g_scanner_scope_foreach_symbol ((scanner), 0, (func), (data)); \
2046 GCompletionFunc func;
2052 GCompletion* g_completion_new (GCompletionFunc func);
2053 void g_completion_add_items (GCompletion* cmp,
2055 void g_completion_remove_items (GCompletion* cmp,
2057 void g_completion_clear_items (GCompletion* cmp);
2058 GList* g_completion_complete (GCompletion* cmp,
2060 gchar** new_prefix);
2061 void g_completion_free (GCompletion* cmp);
2066 * Date calculations (not time for now, to be resolved). These are a
2067 * mutant combination of Steffen Beyer's DateCalc routines
2068 * (http://www.perl.com/CPAN/authors/id/STBEY/) and Jon Trowbridge's
2069 * date routines (written for in-house software). Written by Havoc
2070 * Pennington <hp@pobox.com>
2073 typedef guint16 GDateYear;
2074 typedef guint8 GDateDay; /* day of the month */
2075 typedef struct _GDate GDate;
2076 /* make struct tm known without having to include time.h */
2079 /* enum used to specify order of appearance in parsed date strings */
2087 /* actual week and month values */
2090 G_DATE_BAD_WEEKDAY = 0,
2093 G_DATE_WEDNESDAY = 3,
2094 G_DATE_THURSDAY = 4,
2096 G_DATE_SATURDAY = 6,
2101 G_DATE_BAD_MONTH = 0,
2103 G_DATE_FEBRUARY = 2,
2110 G_DATE_SEPTEMBER = 9,
2111 G_DATE_OCTOBER = 10,
2112 G_DATE_NOVEMBER = 11,
2113 G_DATE_DECEMBER = 12
2116 #define G_DATE_BAD_JULIAN 0U
2117 #define G_DATE_BAD_DAY 0U
2118 #define G_DATE_BAD_YEAR 0U
2120 /* Note: directly manipulating structs is generally a bad idea, but
2121 * in this case it's an *incredibly* bad idea, because all or part
2122 * of this struct can be invalid at any given time. Use the functions,
2123 * or you will get hosed, I promise.
2127 guint julian_days : 32; /* julian days representation - we use a
2128 * bitfield hoping that 64 bit platforms
2129 * will pack this whole struct in one big
2133 guint julian : 1; /* julian is valid */
2134 guint dmy : 1; /* dmy is valid */
2136 /* DMY representation */
2142 /* g_date_new() returns an invalid date, you then have to _set() stuff
2143 * to get a usable object. You can also allocate a GDate statically,
2144 * then call g_date_clear() to initialize.
2146 GDate* g_date_new (void);
2147 GDate* g_date_new_dmy (GDateDay day,
2150 GDate* g_date_new_julian (guint32 julian_day);
2151 void g_date_free (GDate *date);
2153 /* check g_date_valid() after doing an operation that might fail, like
2154 * _parse. Almost all g_date operations are undefined on invalid
2155 * dates (the exceptions are the mutators, since you need those to
2156 * return to validity).
2158 gboolean g_date_valid (GDate *date);
2159 gboolean g_date_valid_day (GDateDay day);
2160 gboolean g_date_valid_month (GDateMonth month);
2161 gboolean g_date_valid_year (GDateYear year);
2162 gboolean g_date_valid_weekday (GDateWeekday weekday);
2163 gboolean g_date_valid_julian (guint32 julian_date);
2164 gboolean g_date_valid_dmy (GDateDay day,
2168 GDateWeekday g_date_weekday (GDate *date);
2169 GDateMonth g_date_month (GDate *date);
2170 GDateYear g_date_year (GDate *date);
2171 GDateDay g_date_day (GDate *date);
2172 guint32 g_date_julian (GDate *date);
2173 guint g_date_day_of_year (GDate *date);
2175 /* First monday/sunday is the start of week 1; if we haven't reached
2176 * that day, return 0. These are not ISO weeks of the year; that
2177 * routine needs to be added.
2178 * these functions return the number of weeks, starting on the
2181 guint g_date_monday_week_of_year (GDate *date);
2182 guint g_date_sunday_week_of_year (GDate *date);
2184 /* If you create a static date struct you need to clear it to get it
2185 * in a sane state before use. You can clear a whole array at
2186 * once with the ndates argument.
2188 void g_date_clear (GDate *date,
2191 /* The parse routine is meant for dates typed in by a user, so it
2192 * permits many formats but tries to catch common typos. If your data
2193 * needs to be strictly validated, it is not an appropriate function.
2195 void g_date_set_parse (GDate *date,
2197 void g_date_set_time (GDate *date,
2199 void g_date_set_month (GDate *date,
2201 void g_date_set_day (GDate *date,
2203 void g_date_set_year (GDate *date,
2205 void g_date_set_dmy (GDate *date,
2209 void g_date_set_julian (GDate *date,
2210 guint32 julian_date);
2211 gboolean g_date_is_first_of_month (GDate *date);
2212 gboolean g_date_is_last_of_month (GDate *date);
2214 /* To go forward by some number of weeks just go forward weeks*7 days */
2215 void g_date_add_days (GDate *date,
2217 void g_date_subtract_days (GDate *date,
2220 /* If you add/sub months while day > 28, the day might change */
2221 void g_date_add_months (GDate *date,
2223 void g_date_subtract_months (GDate *date,
2226 /* If it's feb 29, changing years can move you to the 28th */
2227 void g_date_add_years (GDate *date,
2229 void g_date_subtract_years (GDate *date,
2231 gboolean g_date_is_leap_year (GDateYear year);
2232 guint8 g_date_days_in_month (GDateMonth month,
2234 guint8 g_date_monday_weeks_in_year (GDateYear year);
2235 guint8 g_date_sunday_weeks_in_year (GDateYear year);
2237 /* qsort-friendly (with a cast...) */
2238 gint g_date_compare (GDate *lhs,
2240 void g_date_to_struct_tm (GDate *date,
2243 /* Just like strftime() except you can only use date-related formats.
2244 * Using a time format is undefined.
2246 gsize g_date_strftime (gchar *s,
2248 const gchar *format,
2254 * Indexed Relations. Imagine a really simple table in a
2255 * database. Relations are not ordered. This data type is meant for
2256 * maintaining a N-way mapping.
2258 * g_relation_new() creates a relation with FIELDS fields
2260 * g_relation_destroy() frees all resources
2261 * g_tuples_destroy() frees the result of g_relation_select()
2263 * g_relation_index() indexes relation FIELD with the provided
2264 * equality and hash functions. this must be done before any
2265 * calls to insert are made.
2267 * g_relation_insert() inserts a new tuple. you are expected to
2268 * provide the right number of fields.
2270 * g_relation_delete() deletes all relations with KEY in FIELD
2271 * g_relation_select() returns ...
2272 * g_relation_count() counts ...
2275 GRelation* g_relation_new (gint fields);
2276 void g_relation_destroy (GRelation *relation);
2277 void g_relation_index (GRelation *relation,
2279 GHashFunc hash_func,
2280 GCompareFunc key_compare_func);
2281 void g_relation_insert (GRelation *relation,
2283 gint g_relation_delete (GRelation *relation,
2286 GTuples* g_relation_select (GRelation *relation,
2289 gint g_relation_count (GRelation *relation,
2292 gboolean g_relation_exists (GRelation *relation,
2294 void g_relation_print (GRelation *relation);
2296 void g_tuples_destroy (GTuples *tuples);
2297 gpointer g_tuples_index (GTuples *tuples,
2305 /* This function returns prime numbers spaced by approximately 1.5-2.0
2306 * and is for use in resizing data structures which prefer
2307 * prime-valued sizes. The closest spaced prime function returns the
2308 * next largest prime, or the highest it knows about which is about
2311 guint g_spaced_primes_closest (guint num);
2317 typedef struct _GIOFuncs GIOFuncs;
2333 G_IO_IN GLIB_SYSDEF_POLLIN,
2334 G_IO_OUT GLIB_SYSDEF_POLLOUT,
2335 G_IO_PRI GLIB_SYSDEF_POLLPRI,
2336 G_IO_ERR GLIB_SYSDEF_POLLERR,
2337 G_IO_HUP GLIB_SYSDEF_POLLHUP,
2338 G_IO_NVAL GLIB_SYSDEF_POLLNVAL
2343 guint channel_flags;
2348 typedef gboolean (*GIOFunc) (GIOChannel *source,
2349 GIOCondition condition,
2353 GIOError (*io_read) (GIOChannel *channel,
2357 GIOError (*io_write) (GIOChannel *channel,
2360 guint *bytes_written);
2361 GIOError (*io_seek) (GIOChannel *channel,
2364 void (*io_close) (GIOChannel *channel);
2365 guint (*io_add_watch) (GIOChannel *channel,
2367 GIOCondition condition,
2370 GDestroyNotify notify);
2371 void (*io_free) (GIOChannel *channel);
2374 void g_io_channel_init (GIOChannel *channel);
2375 void g_io_channel_ref (GIOChannel *channel);
2376 void g_io_channel_unref (GIOChannel *channel);
2377 GIOError g_io_channel_read (GIOChannel *channel,
2381 GIOError g_io_channel_write (GIOChannel *channel,
2384 guint *bytes_written);
2385 GIOError g_io_channel_seek (GIOChannel *channel,
2388 void g_io_channel_close (GIOChannel *channel);
2389 guint g_io_add_watch_full (GIOChannel *channel,
2391 GIOCondition condition,
2394 GDestroyNotify notify);
2395 guint g_io_add_watch (GIOChannel *channel,
2396 GIOCondition condition,
2398 gpointer user_data);
2403 typedef struct _GTimeVal GTimeVal;
2404 typedef struct _GSourceFuncs GSourceFuncs;
2405 typedef struct _GMainLoop GMainLoop; /* Opaque */
2412 struct _GSourceFuncs
2414 gboolean (*prepare) (gpointer source_data,
2415 GTimeVal *current_time,
2417 gboolean (*check) (gpointer source_data,
2418 GTimeVal *current_time);
2419 gboolean (*dispatch) (gpointer source_data,
2420 GTimeVal *current_time,
2421 gpointer user_data);
2422 GDestroyNotify destroy;
2425 /* Standard priorities */
2427 #define G_PRIORITY_HIGH -100
2428 #define G_PRIORITY_DEFAULT 0
2429 #define G_PRIORITY_HIGH_IDLE 100
2430 #define G_PRIORITY_DEFAULT_IDLE 200
2431 #define G_PRIORITY_LOW 300
2433 typedef gboolean (*GSourceFunc) (gpointer data);
2435 /* Hooks for adding to the main loop */
2436 guint g_source_add (gint priority,
2437 gboolean can_recurse,
2438 GSourceFuncs *funcs,
2439 gpointer source_data,
2441 GDestroyNotify notify);
2442 void g_source_remove (guint tag);
2443 void g_source_remove_by_user_data (gpointer user_data);
2444 void g_source_remove_by_source_data (gpointer source_data);
2446 void g_get_current_time (GTimeVal *result);
2448 /* Running the main loop */
2449 GMainLoop* g_main_new (gboolean is_running);
2450 void g_main_run (GMainLoop *loop);
2451 void g_main_quit (GMainLoop *loop);
2452 void g_main_destroy (GMainLoop *loop);
2453 gboolean g_main_is_running (GMainLoop *loop);
2455 /* Run a single iteration of the mainloop. If block is FALSE,
2458 gboolean g_main_iteration (gboolean may_block);
2460 /* See if any events are pending */
2461 gboolean g_main_pending (void);
2463 /* Idles and timeouts */
2464 guint g_timeout_add_full (gint priority,
2466 GSourceFunc function,
2468 GDestroyNotify notify);
2469 guint g_timeout_add (guint interval,
2470 GSourceFunc function,
2472 guint g_idle_add (GSourceFunc function,
2474 guint g_idle_add_full (gint priority,
2475 GSourceFunc function,
2477 GDestroyNotify destroy);
2481 * Unix-specific IO and main loop calls
2484 typedef struct _GPollFD GPollFD;
2485 typedef gint (*GPollFunc) (GPollFD *ufds,
2495 void g_main_add_poll (GPollFD *fd,
2497 void g_main_remove_poll (GPollFD *fd);
2498 void g_main_set_poll_func (GPollFunc func);
2500 GIOChannel* g_io_channel_unix_new (int fd);
2501 gint g_io_channel_unix_get_fd (GIOChannel *channel);
2504 /* old IO Channels */
2507 * These are used for plug-in communication in the GIMP, for instance.
2508 * On Unix, it's simply an encapsulated file descriptor (a pipe).
2509 * On Windows, it's a handle to an anonymouos pipe, *and* (in the case
2510 * of the writable end) a thread id to post a message to when you have written
2515 gint fd; /* file handle (pseudo such in Win32) */
2517 guint peer; /* thread to post message to */
2518 guint peer_fd; /* read handle (in the other process) */
2519 guint offset; /* counter of accumulated bytes, to
2520 * be included in the message posted
2521 * so we keep in sync.
2523 guint need_wakeups; /* in output channels whether the reader
2528 GIOChannel *g_iochannel_new (gint fd);
2529 void g_iochannel_free (GIOChannel *channel);
2530 void g_iochannel_close_and_free (GIOChannel *channel);
2531 void g_iochannel_wakeup_peer (GIOChannel *channel);
2532 #ifndef NATIVE_WIN32
2533 # define g_iochannel_wakeup_peer(channel) G_STMT_START { } G_STMT_END
2535 #endif /* old IO Channels */
2538 /* Windows emulation stubs for common unix functions
2541 # define MAXPATHLEN 1024
2545 /* These POSIXish functions are available in the Microsoft C library
2546 * prefixed with underscore (which of course technically speaking is
2547 * the Right Thing, as they are non-ANSI. Not that being non-ANSI
2548 * prevents Microsoft from practically requiring you to include
2549 * <windows.h> every now and then...).
2551 * You still need to include the appropriate headers to get the
2552 * prototypes, <io.h> or <direct.h>.
2554 * For some functions, we provide emulators in glib, which are prefixed
2557 # define getcwd _getcwd
2558 # define getpid _getpid
2559 # define access _access
2562 # define write _write
2563 # define lseek _lseek
2564 # define close _close
2565 # define pipe(phandles) _pipe (phandles, 4096, _O_BINARY)
2566 # define popen _popen
2567 # define pclose _pclose
2568 # define fdopen _fdopen
2569 # define ftruncate(fd, size) gwin_ftruncate (fd, size)
2570 # define opendir gwin_opendir
2571 # define readdir gwin_readdir
2572 # define rewinddir gwin_rewinddir
2573 # define closedir gwin_closedir
2574 # define NAME_MAX 255
2578 gboolean just_opened;
2579 guint find_file_handle;
2580 gpointer find_file_data;
2582 typedef struct DIR DIR;
2585 gchar d_name[NAME_MAX + 1];
2587 /* emulation functions */
2588 extern int gwin_ftruncate (gint f,
2590 DIR* gwin_opendir (const gchar *dirname);
2591 struct dirent* gwin_readdir (DIR *dir);
2592 void gwin_rewinddir (DIR *dir);
2593 gint gwin_closedir (DIR *dir);
2594 # endif /* _MSC_VER */
2595 #endif /* NATIVE_WIN32 */
2598 /* GLib Thread support
2600 typedef struct _GMutex GMutex;
2601 typedef struct _GCond GCond;
2602 typedef struct _GPrivate GPrivate;
2603 typedef struct _GStaticPrivate GStaticPrivate;
2604 typedef struct _GThreadFunctions GThreadFunctions;
2605 struct _GThreadFunctions
2607 GMutex* (*mutex_new) (void);
2608 void (*mutex_lock) (GMutex *mutex);
2609 gboolean (*mutex_trylock) (GMutex *mutex);
2610 void (*mutex_unlock) (GMutex *mutex);
2611 void (*mutex_free) (GMutex *mutex);
2612 GCond* (*cond_new) (void);
2613 void (*cond_signal) (GCond *cond);
2614 void (*cond_broadcast) (GCond *cond);
2615 void (*cond_wait) (GCond *cond,
2617 gboolean (*cond_timed_wait) (GCond *cond,
2619 GTimeVal *end_time);
2620 void (*cond_free) (GCond *cond);
2621 GPrivate* (*private_new) (GDestroyNotify destructor);
2622 gpointer (*private_get) (GPrivate *private_key);
2623 void (*private_set) (GPrivate *private_key,
2627 GUTILS_C_VAR GThreadFunctions g_thread_functions_for_glib_use;
2628 GUTILS_C_VAR gboolean g_thread_use_default_impl;
2629 GUTILS_C_VAR gboolean g_threads_got_initialized;
2631 /* initializes the mutex/cond/private implementation for glib, might
2632 * only be called once, and must not be called directly or indirectly
2633 * from another glib-function, e.g. as a callback.
2635 void g_thread_init (GThreadFunctions *vtable);
2637 /* internal function for fallback static mutex implementation */
2638 GMutex* g_static_mutex_get_mutex_impl (GMutex **mutex);
2640 /* shorthands for conditional and unconditional function calls */
2641 #define G_THREAD_UF(name, arglist) \
2642 (*g_thread_functions_for_glib_use . name) arglist
2643 #define G_THREAD_CF(name, fail, arg) \
2644 (g_thread_supported () ? G_THREAD_UF (name, arg) : (fail))
2645 /* keep in mind, all those mutexes and static mutexes are not
2646 * recursive in general, don't rely on that
2648 #define g_thread_supported() (g_threads_got_initialized)
2649 #define g_mutex_new() G_THREAD_UF (mutex_new, ())
2650 #define g_mutex_lock(mutex) G_THREAD_CF (mutex_lock, (void)0, (mutex))
2651 #define g_mutex_trylock(mutex) G_THREAD_CF (mutex_trylock, TRUE, (mutex))
2652 #define g_mutex_unlock(mutex) G_THREAD_CF (mutex_unlock, (void)0, (mutex))
2653 #define g_mutex_free(mutex) G_THREAD_CF (mutex_free, (void)0, (mutex))
2654 #define g_cond_new() G_THREAD_UF (cond_new, ())
2655 #define g_cond_signal(cond) G_THREAD_CF (cond_signal, (void)0, (cond))
2656 #define g_cond_broadcast(cond) G_THREAD_CF (cond_broadcast, (void)0, (cond))
2657 #define g_cond_wait(cond, mutex) G_THREAD_CF (cond_wait, (void)0, (cond, \
2659 #define g_cond_free(cond) G_THREAD_CF (cond_free, (void)0, (cond))
2660 #define g_cond_timed_wait(cond, mutex, abs_time) G_THREAD_CF (cond_timed_wait, \
2664 #define g_private_new(destructor) G_THREAD_UF (private_new, (destructor))
2665 #define g_private_get(private_key) G_THREAD_CF (private_get, \
2666 ((gpointer)private_key), \
2668 #define g_private_set(private_key, value) G_THREAD_CF (private_set, \
2669 (void) (private_key = \
2670 (GPrivate*) (value)), \
2671 (private_key, value))
2672 /* GStaticMutexes can be statically initialized with the value
2673 * G_STATIC_MUTEX_INIT, and then they can directly be used, that is
2674 * much easier, than having to explicitly allocate the mutex before
2677 #define g_static_mutex_lock(mutex) \
2678 g_mutex_lock (g_static_mutex_get_mutex (mutex))
2679 #define g_static_mutex_trylock(mutex) \
2680 g_mutex_trylock (g_static_mutex_get_mutex (mutex))
2681 #define g_static_mutex_unlock(mutex) \
2682 g_mutex_unlock (g_static_mutex_get_mutex (mutex))
2683 struct _GStaticPrivate
2687 #define G_STATIC_PRIVATE_INIT { 0 }
2688 gpointer g_static_private_get (GStaticPrivate *private_key);
2689 void g_static_private_set (GStaticPrivate *private_key,
2691 GDestroyNotify notify);
2693 /* these are some convenience macros that expand to nothing if GLib was
2694 * configured with --deisable-threads. for using StaticMutexes, you
2695 * declare them with G_LOCK_DECLARE_STATIC (name) or G_LOCK_DECLARE (name)
2696 * if you need to export the mutex. name is a unique identifier for the
2697 * protected varibale or code portion. locking, testing and unlocking of
2698 * such mutexes can be done with G_LOCK(), G_UNLOCK() and G_TRYLOCK()
2701 extern void glib_dummy_decl (void);
2702 #define G_LOCK_NAME(name) (g__ ## name ## _lock)
2703 #ifdef G_THREADS_ENABLED
2704 # define G_LOCK_DECLARE_STATIC(name) static G_LOCK_DECLARE (name)
2705 # define G_LOCK_DECLARE(name) \
2706 GStaticMutex G_LOCK_NAME (name) = G_STATIC_MUTEX_INIT
2708 # ifdef G_DEBUG_LOCKS
2709 # define G_LOCK(name) G_STMT_START{ \
2710 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
2711 "file %s: line %d (%s): locking: %s ", \
2712 __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION, \
2714 g_static_mutex_lock (G_LOCK_NAME (name)); \
2716 # define G_UNLOCK(name) G_STMT_START{ \
2717 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
2718 "file %s: line %d (%s): unlocking: %s ", \
2719 __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION, \
2721 g_static_mutex_unlock (G_LOCK_NAME (name)); \
2723 # define G_TRYLOCK(name) G_STMT_START{ \
2724 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
2725 "file %s: line %d (%s): try locking: %s ", \
2726 __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION, \
2728 }G_STMT_END, g_static_mutex_trylock (G_LOCK_NAME (name))
2729 # else /* !G_DEBUG_LOCKS */
2730 # define G_LOCK(name) g_static_mutex_lock (G_LOCK_NAME (name))
2731 # define G_UNLOCK(name) g_static_mutex_unlock (G_LOCK_NAME (name))
2732 # define G_TRYLOCK(name) g_static_mutex_trylock (G_LOCK_NAME (name))
2733 # endif /* !G_DEBUG_LOCKS */
2734 #else /* !G_THREADS_ENABLED */
2735 # define G_LOCK_DECLARE_STATIC(name) extern void glib_dummy_decl (void)
2736 # define G_LOCK_DECLARE(name) extern void glib_dummy_decl (void)
2737 # define G_LOCK(name)
2738 # define G_UNLOCK(name)
2739 # define G_TRYLOCK(name) (FALSE)
2740 #endif /* !G_THREADS_ENABLED */
2744 #endif /* __cplusplus */
2747 #endif /* __G_LIB_H__ */