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 */
93 /* Make MSVC more pedantic, this is a recommended pragma list
94 * from _Win32_Programming_ by Rector and Newcomer.
96 #pragma warning(error:4002)
97 #pragma warning(error:4003)
98 #pragma warning(1:4010)
99 #pragma warning(error:4013)
100 #pragma warning(1:4016)
101 #pragma warning(error:4020)
102 #pragma warning(error:4021)
103 #pragma warning(error:4027)
104 #pragma warning(error:4029)
105 #pragma warning(error:4033)
106 #pragma warning(error:4035)
107 #pragma warning(error:4045)
108 #pragma warning(error:4047)
109 #pragma warning(error:4049)
110 #pragma warning(error:4053)
111 #pragma warning(error:4071)
112 #pragma warning(disable:4101)
113 #pragma warning(error:4150)
115 #pragma warning(disable:4244) /* No possible loss of data warnings, please */
116 #endif /* _MSC_VER */
121 #endif /* __cplusplus */
124 /* Provide definitions for some commonly used macros.
125 * Some of them are only provided if they haven't already
126 * been defined. It is assumed that if they are already
127 * defined then the current definition is correct.
130 #define NULL ((void*) 0)
138 #define TRUE (!FALSE)
142 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
145 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
148 #define ABS(a) (((a) < 0) ? -(a) : (a))
151 #define CLAMP(x, low, high) (((x) > (high)) ? (high) : (((x) < (low)) ? (low) : (x)))
154 /* Define G_VA_COPY() to do the right thing for copying va_list variables.
155 * glibconfig.h may have already defined G_VA_COPY as va_copy or __va_copy.
157 #if !defined (G_VA_COPY)
158 # if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
159 # define G_VA_COPY(ap1, ap2) (*(ap1) = *(ap2))
160 # elif defined (G_VA_COPY_AS_ARRAY)
161 # define G_VA_COPY(ap1, ap2) g_memmove ((ap1), (ap2), sizeof (va_list))
162 # else /* va_list is a pointer */
163 # define G_VA_COPY(ap1, ap2) ((ap1) = (ap2))
164 # endif /* va_list is a pointer */
165 #endif /* !G_VA_COPY */
168 /* Provide convenience macros for handling structure
169 * fields through their offsets.
171 #define G_STRUCT_OFFSET(struct_type, member) \
172 ((gulong) ((gchar*) &((struct_type*) 0)->member))
173 #define G_STRUCT_MEMBER_P(struct_p, struct_offset) \
174 ((gpointer) ((gchar*) (struct_p) + (gulong) (struct_offset)))
175 #define G_STRUCT_MEMBER(member_type, struct_p, struct_offset) \
176 (*(member_type*) G_STRUCT_MEMBER_P ((struct_p), (struct_offset)))
179 /* inlining hassle. for compilers that don't allow the `inline' keyword,
180 * mostly because of strict ANSI C compliance or dumbness, we try to fall
181 * back to either `__inline__' or `__inline'.
182 * we define G_CAN_INLINE, if the compiler seems to be actually
183 * *capable* to do function inlining, in which case inline function bodys
184 * do make sense. we also define G_INLINE_FUNC to properly export the
185 * function prototypes if no inlinig can be performed.
186 * we special case most of the stuff, so inline functions can have a normal
187 * implementation by defining G_INLINE_FUNC to extern and G_CAN_INLINE to 1.
189 #ifndef G_INLINE_FUNC
190 # define G_CAN_INLINE 1
193 # if defined (__GNUC__) && defined (__STRICT_ANSI__)
195 # define inline __inline__
197 #else /* !G_HAVE_INLINE */
199 # if defined (G_HAVE___INLINE__)
200 # define inline __inline__
201 # else /* !inline && !__inline__ */
202 # if defined (G_HAVE___INLINE)
203 # define inline __inline
204 # else /* !inline && !__inline__ && !__inline */
205 # define inline /* don't inline, then */
206 # ifndef G_INLINE_FUNC
212 #ifndef G_INLINE_FUNC
215 # define G_INLINE_FUNC extern inline
218 # define G_INLINE_FUNC extern
220 # else /* !__GNUC__ */
222 # define G_INLINE_FUNC static inline
224 # define G_INLINE_FUNC extern
226 # endif /* !__GNUC__ */
227 #endif /* !G_INLINE_FUNC */
230 /* Provide simple macro statement wrappers (adapted from Perl):
231 * G_STMT_START { statements; } G_STMT_END;
232 * can be used as a single statement, as in
233 * if (x) G_STMT_START { ... } G_STMT_END; else ...
235 * For gcc we will wrap the statements within `({' and `})' braces.
236 * For SunOS they will be wrapped within `if (1)' and `else (void) 0',
237 * and otherwise within `do' and `while (0)'.
239 #if !(defined (G_STMT_START) && defined (G_STMT_END))
240 # if defined (__GNUC__) && !defined (__STRICT_ANSI__) && !defined (__cplusplus)
241 # define G_STMT_START (void)(
242 # define G_STMT_END )
244 # if (defined (sun) || defined (__sun__))
245 # define G_STMT_START if (1)
246 # define G_STMT_END else (void)0
248 # define G_STMT_START do
249 # define G_STMT_END while (0)
255 /* Provide macros to feature the GCC function attribute.
257 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
258 #define G_GNUC_PRINTF( format_idx, arg_idx ) \
259 __attribute__((format (printf, format_idx, arg_idx)))
260 #define G_GNUC_SCANF( format_idx, arg_idx ) \
261 __attribute__((format (scanf, format_idx, arg_idx)))
262 #define G_GNUC_FORMAT( arg_idx ) \
263 __attribute__((format_arg (arg_idx)))
264 #define G_GNUC_NORETURN \
265 __attribute__((noreturn))
266 #define G_GNUC_CONST \
267 __attribute__((const))
268 #define G_GNUC_UNUSED \
269 __attribute__((unused))
270 #else /* !__GNUC__ */
271 #define G_GNUC_PRINTF( format_idx, arg_idx )
272 #define G_GNUC_SCANF( format_idx, arg_idx )
273 #define G_GNUC_FORMAT( arg_idx )
274 #define G_GNUC_NORETURN
276 #define G_GNUC_UNUSED
277 #endif /* !__GNUC__ */
280 /* Wrap the gcc __PRETTY_FUNCTION__ and __FUNCTION__ variables with
281 * macros, so we can refer to them as strings unconditionally.
284 #define G_GNUC_FUNCTION (__FUNCTION__)
285 #define G_GNUC_PRETTY_FUNCTION (__PRETTY_FUNCTION__)
286 #else /* !__GNUC__ */
287 #define G_GNUC_FUNCTION ("")
288 #define G_GNUC_PRETTY_FUNCTION ("")
289 #endif /* !__GNUC__ */
291 /* we try to provide a usefull equivalent for ATEXIT if it is
292 * not defined, but use is actually abandoned. people should
293 * use g_atexit() instead.
296 # define ATEXIT(proc) g_ATEXIT(proc)
298 # define G_NATIVE_ATEXIT
301 /* Hacker macro to place breakpoints for x86 machines.
302 * Actual use is strongly deprecated of course ;)
304 #if defined (__i386__) && defined (__GNUC__)
305 #define G_BREAKPOINT() G_STMT_START{ __asm__ __volatile__ ("int $03"); }G_STMT_END
306 #elif defined (__alpha__) && defined (__GNUC__)
307 #define G_BREAKPOINT() G_STMT_START{ __asm__ __volatile__ ("bpt"); }G_STMT_END
308 #else /* !__i386__ && !__alpha__ */
309 #define G_BREAKPOINT()
310 #endif /* __i386__ */
313 /* Provide macros for easily allocating memory. The macros
314 * will cast the allocated memory to the specified type
315 * in order to avoid compiler warnings. (Makes the code neater).
319 # define g_new(type, count) (ALLOC (type, count))
320 # define g_new0(type, count) (CALLOC (type, count))
321 # define g_renew(type, mem, count) (REALLOC (mem, type, count))
322 #else /* __DMALLOC_H__ */
323 # define g_new(type, count) \
324 ((type *) g_malloc ((unsigned) sizeof (type) * (count)))
325 # define g_new0(type, count) \
326 ((type *) g_malloc0 ((unsigned) sizeof (type) * (count)))
327 # define g_renew(type, mem, count) \
328 ((type *) g_realloc (mem, (unsigned) sizeof (type) * (count)))
329 #endif /* __DMALLOC_H__ */
331 #define g_mem_chunk_create(type, pre_alloc, alloc_type) ( \
332 g_mem_chunk_new (#type " mem chunks (" #pre_alloc ")", \
334 sizeof (type) * (pre_alloc), \
337 #define g_chunk_new(type, chunk) ( \
338 (type *) g_mem_chunk_alloc (chunk) \
340 #define g_chunk_new0(type, chunk) ( \
341 (type *) g_mem_chunk_alloc0 (chunk) \
343 #define g_chunk_free(mem, mem_chunk) G_STMT_START { \
344 g_mem_chunk_free ((mem_chunk), (mem)); \
348 #define g_string(x) #x
351 /* Provide macros for error handling. The "assert" macros will
352 * exit on failure. The "return" macros will exit the current
353 * function. Two different definitions are given for the macros
354 * if G_DISABLE_ASSERT is not defined, in order to support gcc's
355 * __PRETTY_FUNCTION__ capability.
358 #ifdef G_DISABLE_ASSERT
360 #define g_assert(expr)
361 #define g_assert_not_reached()
363 #else /* !G_DISABLE_ASSERT */
367 #define g_assert(expr) G_STMT_START{ \
369 g_log (G_LOG_DOMAIN, \
371 "file %s: line %d (%s): assertion failed: (%s)", \
374 __PRETTY_FUNCTION__, \
377 #define g_assert_not_reached() G_STMT_START{ \
378 g_log (G_LOG_DOMAIN, \
380 "file %s: line %d (%s): should not be reached", \
383 __PRETTY_FUNCTION__); }G_STMT_END
385 #else /* !__GNUC__ */
387 #define g_assert(expr) G_STMT_START{ \
389 g_log (G_LOG_DOMAIN, \
391 "file %s: line %d: assertion failed: (%s)", \
396 #define g_assert_not_reached() G_STMT_START{ \
397 g_log (G_LOG_DOMAIN, \
399 "file %s: line %d: should not be reached", \
401 __LINE__); }G_STMT_END
403 #endif /* __GNUC__ */
405 #endif /* !G_DISABLE_ASSERT */
408 #ifdef G_DISABLE_CHECKS
410 #define g_return_if_fail(expr)
411 #define g_return_val_if_fail(expr,val)
413 #else /* !G_DISABLE_CHECKS */
417 #define g_return_if_fail(expr) G_STMT_START{ \
420 g_log (G_LOG_DOMAIN, \
421 G_LOG_LEVEL_CRITICAL, \
422 "file %s: line %d (%s): assertion `%s' failed.", \
425 __PRETTY_FUNCTION__, \
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 (%s): assertion `%s' failed.", \
438 __PRETTY_FUNCTION__, \
443 #else /* !__GNUC__ */
445 #define g_return_if_fail(expr) G_STMT_START{ \
448 g_log (G_LOG_DOMAIN, \
449 G_LOG_LEVEL_CRITICAL, \
450 "file %s: line %d: assertion `%s' failed.", \
457 #define g_return_val_if_fail(expr, val) G_STMT_START{ \
460 g_log (G_LOG_DOMAIN, \
461 G_LOG_LEVEL_CRITICAL, \
462 "file %s: line %d: assertion `%s' failed.", \
469 #endif /* !__GNUC__ */
471 #endif /* !G_DISABLE_CHECKS */
474 /* Provide type definitions for commonly used types.
475 * These are useful because a "gint8" can be adjusted
476 * to be 1 byte (8 bits) on all platforms. Similarly and
477 * more importantly, "gint32" can be adjusted to be
478 * 4 bytes (32 bits) on all platforms.
482 typedef short gshort;
485 typedef gint gboolean;
487 typedef unsigned char guchar;
488 typedef unsigned short gushort;
489 typedef unsigned long gulong;
490 typedef unsigned int guint;
492 typedef float gfloat;
493 typedef double gdouble;
495 /* HAVE_LONG_DOUBLE doesn't work correctly on all platforms.
496 * Since gldouble isn't used anywhere, just disable it for now */
499 #ifdef HAVE_LONG_DOUBLE
500 typedef long double gldouble;
501 #else /* HAVE_LONG_DOUBLE */
502 typedef double gldouble;
503 #endif /* HAVE_LONG_DOUBLE */
506 typedef void* gpointer;
507 typedef const void *gconstpointer;
510 typedef gint32 gssize;
511 typedef guint32 gsize;
512 typedef guint32 GQuark;
513 typedef gint32 GTime;
516 /* Portable endian checks and conversions
519 #define G_LITTLE_ENDIAN 1234
520 #define G_BIG_ENDIAN 4321
521 #define G_PDP_ENDIAN 3412 /* unused, need specific PDP check */
523 /* Basic bit swapping functions
525 #define GUINT16_SWAP_LE_BE_CONSTANT(val) ((guint16) ( \
526 (((guint16) (val) & (guint16) 0x00ffU) << 8) | \
527 (((guint16) (val) & (guint16) 0xff00U) >> 8)))
528 #define GUINT32_SWAP_LE_BE_CONSTANT(val) ((guint32) ( \
529 (((guint32) (val) & (guint32) 0x000000ffU) << 24) | \
530 (((guint32) (val) & (guint32) 0x0000ff00U) << 8) | \
531 (((guint32) (val) & (guint32) 0x00ff0000U) >> 8) | \
532 (((guint32) (val) & (guint32) 0xff000000U) >> 24)))
534 /* Intel specific stuff for speed
536 #if defined (__i386__) && (defined __GNUC__)
538 # define GUINT16_SWAP_LE_BE_X86(val) \
540 ({ register guint16 __v; \
541 if (__builtin_constant_p (val)) \
542 __v = GUINT16_SWAP_LE_BE_CONSTANT (val); \
544 __asm__ __volatile__ ("rorw $8, %w0" \
546 : "0" ((guint16) (val)) \
550 # define GUINT16_SWAP_LE_BE(val) \
551 ((guint16) GUINT16_SWAP_LE_BE_X86 ((guint16) (val)))
553 # if !defined(__i486__) && !defined(__i586__) \
554 && !defined(__pentium__) && !defined(__pentiumpro__) && !defined(__i686__)
555 # define GUINT32_SWAP_LE_BE_X86(val) \
557 ({ register guint32 __v; \
558 if (__builtin_constant_p (val)) \
559 __v = GUINT32_SWAP_LE_BE_CONSTANT (val); \
561 __asm__ __volatile__ ("rorw $8, %w0\n\t" \
565 : "0" ((guint32) (val)) \
569 # else /* 486 and higher has bswap */
570 # define GUINT32_SWAP_LE_BE_X86(val) \
572 ({ register guint32 __v; \
573 if (__builtin_constant_p (val)) \
574 __v = GUINT32_SWAP_LE_BE_CONSTANT (val); \
576 __asm__ __volatile__ ("bswap %0" \
578 : "0" ((guint32) (val))); \
580 # endif /* processor specific 32-bit stuff */
582 # define GUINT32_SWAP_LE_BE(val) \
583 ((guint32) GUINT32_SWAP_LE_BE_X86 ((guint32) (val)))
585 #else /* !__i386__ */
586 # define GUINT16_SWAP_LE_BE(val) (GUINT16_SWAP_LE_BE_CONSTANT (val))
587 # define GUINT32_SWAP_LE_BE(val) (GUINT32_SWAP_LE_BE_CONSTANT (val))
588 #endif /* __i386__ */
591 #define GUINT64_SWAP_LE_BE(val) ((guint64) ( \
592 (((guint64) (val) & (guint64) 0x00000000000000ffU) << 56) | \
593 (((guint64) (val) & (guint64) 0x000000000000ff00U) << 40) | \
594 (((guint64) (val) & (guint64) 0x0000000000ff0000U) << 24) | \
595 (((guint64) (val) & (guint64) 0x00000000ff000000U) << 8) | \
596 (((guint64) (val) & (guint64) 0x000000ff00000000U) >> 8) | \
597 (((guint64) (val) & (guint64) 0x0000ff0000000000U) >> 24) | \
598 (((guint64) (val) & (guint64) 0x00ff000000000000U) >> 40) | \
599 (((guint64) (val) & (guint64) 0xff00000000000000U) >> 56)))
602 #define GUINT16_SWAP_LE_PDP(val) ((guint16) (val))
603 #define GUINT16_SWAP_BE_PDP(val) (GUINT16_SWAP_LE_BE (val))
604 #define GUINT32_SWAP_LE_PDP(val) ((guint32) ( \
605 (((guint32) (val) & (guint32) 0x0000ffffU) << 16) | \
606 (((guint32) (val) & (guint32) 0xffff0000U) >> 16)))
607 #define GUINT32_SWAP_BE_PDP(val) ((guint32) ( \
608 (((guint32) (val) & (guint32) 0x00ff00ffU) << 8) | \
609 (((guint32) (val) & (guint32) 0xff00ff00U) >> 8)))
611 /* The TO_?E stuff is defined in glibconfig.h. The transformation is symmetric,
612 so the FROM just maps to the TO.
614 #define GINT16_FROM_LE(val) (GINT16_TO_LE (val))
615 #define GUINT16_FROM_LE(val) (GUINT16_TO_LE (val))
616 #define GINT16_FROM_BE(val) (GINT16_TO_BE (val))
617 #define GUINT16_FROM_BE(val) (GUINT16_TO_BE (val))
618 #define GINT32_FROM_LE(val) (GINT32_TO_LE (val))
619 #define GUINT32_FROM_LE(val) (GUINT32_TO_LE (val))
620 #define GINT32_FROM_BE(val) (GINT32_TO_BE (val))
621 #define GUINT32_FROM_BE(val) (GUINT32_TO_BE (val))
624 #define GINT64_FROM_LE(val) (GINT32_TO_LE (val))
625 #define GUINT64_FROM_LE(val) (GUINT32_TO_LE (val))
626 #define GINT64_FROM_BE(val) (GINT32_TO_BE (val))
627 #define GUINT64_FROM_BE(val) (GUINT32_TO_BE (val))
630 #define GLONG_FROM_LE(val) (GLONG_TO_LE (val))
631 #define GULONG_FROM_LE(val) (GULONG_TO_LE (val))
632 #define GLONG_FROM_BE(val) (GLONG_TO_BE (val))
633 #define GULONG_FROM_BE(val) (GULONG_TO_BE (val))
635 #define GINT_FROM_LE(val) (GINT_TO_LE (val))
636 #define GUINT_FROM_LE(val) (GUINT_TO_LE (val))
637 #define GINT_FROM_BE(val) (GINT_TO_BE (val))
638 #define GUINT_FROM_BE(val) (GUINT_TO_BE (val))
640 /* Portable versions of host-network order stuff
642 #define g_ntohl(val) (GUINT32_FROM_BE (val))
643 #define g_ntohs(val) (GUINT16_FROM_BE (val))
644 #define g_htonl(val) (GUINT32_TO_BE (val))
645 #define g_htons(val) (GUINT16_TO_BE (val))
649 * we prefix variable declarations so they can
650 * properly get exported in windows dlls.
653 # ifdef GLIB_COMPILATION
654 # define GUTILS_C_VAR __declspec(dllexport)
655 # else /* !GLIB_COMPILATION */
656 # define GUTILS_C_VAR __declspec(dllimport)
657 # endif /* !GLIB_COMPILATION */
658 #else /* !NATIVE_WIN32 */
659 # define GUTILS_C_VAR extern
660 #endif /* !NATIVE_WIN32 */
662 GUTILS_C_VAR const guint glib_major_version;
663 GUTILS_C_VAR const guint glib_minor_version;
664 GUTILS_C_VAR const guint glib_micro_version;
665 GUTILS_C_VAR const guint glib_interface_age;
666 GUTILS_C_VAR const guint glib_binary_age;
668 /* Forward declarations of glib types.
671 typedef struct _GArray GArray;
672 typedef struct _GByteArray GByteArray;
673 typedef struct _GCache GCache;
674 typedef struct _GCompletion GCompletion;
675 typedef struct _GData GData;
676 typedef struct _GDebugKey GDebugKey;
677 typedef struct _GHashTable GHashTable;
678 typedef struct _GHook GHook;
679 typedef struct _GHookList GHookList;
680 typedef struct _GList GList;
681 typedef struct _GListAllocator GListAllocator;
682 typedef struct _GMemChunk GMemChunk;
683 typedef struct _GNode GNode;
684 typedef struct _GPtrArray GPtrArray;
685 typedef struct _GRelation GRelation;
686 typedef struct _GScanner GScanner;
687 typedef struct _GScannerConfig GScannerConfig;
688 typedef struct _GSList GSList;
689 typedef struct _GString GString;
690 typedef struct _GStringChunk GStringChunk;
691 typedef struct _GTimer GTimer;
692 typedef struct _GTree GTree;
693 typedef struct _GTuples GTuples;
694 typedef union _GTokenValue GTokenValue;
695 typedef struct _GIOChannel GIOChannel;
700 G_TRAVERSE_LEAFS = 1 << 0,
701 G_TRAVERSE_NON_LEAFS = 1 << 1,
702 G_TRAVERSE_ALL = G_TRAVERSE_LEAFS | G_TRAVERSE_NON_LEAFS,
703 G_TRAVERSE_MASK = 0x03
714 /* Log level shift offset for user defined
715 * log levels (0-7 are used by GLib).
717 #define G_LOG_LEVEL_USER_SHIFT (8)
719 /* Glib log levels and flags.
724 G_LOG_FLAG_RECURSION = 1 << 0,
725 G_LOG_FLAG_FATAL = 1 << 1,
727 /* GLib log levels */
728 G_LOG_LEVEL_ERROR = 1 << 2, /* always fatal */
729 G_LOG_LEVEL_CRITICAL = 1 << 3,
730 G_LOG_LEVEL_WARNING = 1 << 4,
731 G_LOG_LEVEL_MESSAGE = 1 << 5,
732 G_LOG_LEVEL_INFO = 1 << 6,
733 G_LOG_LEVEL_DEBUG = 1 << 7,
735 G_LOG_LEVEL_MASK = ~(G_LOG_FLAG_RECURSION | G_LOG_FLAG_FATAL)
738 /* GLib log levels that are considered fatal by default */
739 #define G_LOG_FATAL_MASK (G_LOG_FLAG_RECURSION | G_LOG_LEVEL_ERROR)
742 typedef gpointer (*GCacheNewFunc) (gpointer key);
743 typedef gpointer (*GCacheDupFunc) (gpointer value);
744 typedef void (*GCacheDestroyFunc) (gpointer value);
745 typedef gint (*GCompareFunc) (gconstpointer a,
747 typedef gchar* (*GCompletionFunc) (gpointer);
748 typedef void (*GDestroyNotify) (gpointer data);
749 typedef void (*GDataForeachFunc) (GQuark key_id,
752 typedef void (*GFunc) (gpointer data,
754 typedef guint (*GHashFunc) (gconstpointer key);
755 typedef void (*GHFunc) (gpointer key,
758 typedef gboolean (*GHRFunc) (gpointer key,
761 typedef gint (*GHookCompareFunc) (GHook *new_hook,
763 typedef gboolean (*GHookFindFunc) (GHook *hook,
765 typedef void (*GHookMarshaller) (GHook *hook,
767 typedef void (*GHookFunc) (gpointer data);
768 typedef gboolean (*GHookCheckFunc) (gpointer data);
769 typedef void (*GHookFreeFunc) (GHookList *hook_list,
771 typedef void (*GLogFunc) (const gchar *log_domain,
772 GLogLevelFlags log_level,
773 const gchar *message,
775 typedef gboolean (*GNodeTraverseFunc) (GNode *node,
777 typedef void (*GNodeForeachFunc) (GNode *node,
779 typedef gint (*GSearchFunc) (gpointer key,
781 typedef void (*GScannerMsgFunc) (GScanner *scanner,
784 typedef gint (*GTraverseFunc) (gpointer key,
787 typedef void (*GVoidFunc) (void);
839 /* Doubly linked lists
841 GList* g_list_alloc (void);
842 void g_list_free (GList *list);
843 void g_list_free_1 (GList *list);
844 GList* g_list_append (GList *list,
846 GList* g_list_prepend (GList *list,
848 GList* g_list_insert (GList *list,
851 GList* g_list_insert_sorted (GList *list,
854 GList* g_list_concat (GList *list1,
856 GList* g_list_remove (GList *list,
858 GList* g_list_remove_link (GList *list,
860 GList* g_list_reverse (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 gpointer g_list_nth_data (GList *list,
880 #define g_list_previous(list) ((list) ? (((GList *)(list))->prev) : NULL)
881 #define g_list_next(list) ((list) ? (((GList *)(list))->next) : NULL)
884 /* Singly linked lists
886 GSList* g_slist_alloc (void);
887 void g_slist_free (GSList *list);
888 void g_slist_free_1 (GSList *list);
889 GSList* g_slist_append (GSList *list,
891 GSList* g_slist_prepend (GSList *list,
893 GSList* g_slist_insert (GSList *list,
896 GSList* g_slist_insert_sorted (GSList *list,
899 GSList* g_slist_concat (GSList *list1,
901 GSList* g_slist_remove (GSList *list,
903 GSList* g_slist_remove_link (GSList *list,
905 GSList* g_slist_reverse (GSList *list);
906 GSList* g_slist_nth (GSList *list,
908 GSList* g_slist_find (GSList *list,
910 GSList* g_slist_find_custom (GSList *list,
913 gint g_slist_position (GSList *list,
915 gint g_slist_index (GSList *list,
917 GSList* g_slist_last (GSList *list);
918 guint g_slist_length (GSList *list);
919 void g_slist_foreach (GSList *list,
922 gpointer g_slist_nth_data (GSList *list,
924 #define g_slist_next(slist) ((slist) ? (((GSList *)(slist))->next) : NULL)
929 GListAllocator* g_list_allocator_new (void);
930 void g_list_allocator_free (GListAllocator* allocator);
931 GListAllocator* g_slist_set_allocator (GListAllocator* allocator);
932 GListAllocator* g_list_set_allocator (GListAllocator* allocator);
937 GHashTable* g_hash_table_new (GHashFunc hash_func,
938 GCompareFunc key_compare_func);
939 void g_hash_table_destroy (GHashTable *hash_table);
940 void g_hash_table_insert (GHashTable *hash_table,
943 void g_hash_table_remove (GHashTable *hash_table,
945 gpointer g_hash_table_lookup (GHashTable *hash_table,
947 gboolean g_hash_table_lookup_extended(GHashTable *hash_table,
948 gconstpointer lookup_key,
951 void g_hash_table_freeze (GHashTable *hash_table);
952 void g_hash_table_thaw (GHashTable *hash_table);
953 void g_hash_table_foreach (GHashTable *hash_table,
956 gint g_hash_table_foreach_remove (GHashTable *hash_table,
959 gint g_hash_table_size (GHashTable *hash_table);
964 GCache* g_cache_new (GCacheNewFunc value_new_func,
965 GCacheDestroyFunc value_destroy_func,
966 GCacheDupFunc key_dup_func,
967 GCacheDestroyFunc key_destroy_func,
968 GHashFunc hash_key_func,
969 GHashFunc hash_value_func,
970 GCompareFunc key_compare_func);
971 void g_cache_destroy (GCache *cache);
972 gpointer g_cache_insert (GCache *cache,
974 void g_cache_remove (GCache *cache,
976 void g_cache_key_foreach (GCache *cache,
979 void g_cache_value_foreach (GCache *cache,
984 /* Balanced binary trees
986 GTree* g_tree_new (GCompareFunc key_compare_func);
987 void g_tree_destroy (GTree *tree);
988 void g_tree_insert (GTree *tree,
991 void g_tree_remove (GTree *tree,
993 gpointer g_tree_lookup (GTree *tree,
995 void g_tree_traverse (GTree *tree,
996 GTraverseFunc traverse_func,
997 GTraverseType traverse_type,
999 gpointer g_tree_search (GTree *tree,
1000 GSearchFunc search_func,
1002 gint g_tree_height (GTree *tree);
1003 gint g_tree_nnodes (GTree *tree);
1007 /* N-way tree implementation
1018 #define G_NODE_IS_ROOT(node) (((GNode*) (node))->parent == NULL && \
1019 ((GNode*) (node))->prev == NULL && \
1020 ((GNode*) (node))->next == NULL)
1021 #define G_NODE_IS_LEAF(node) (((GNode*) (node))->children == NULL)
1023 GNode* g_node_new (gpointer data);
1024 void g_node_destroy (GNode *root);
1025 void g_node_unlink (GNode *node);
1026 GNode* g_node_insert (GNode *parent,
1029 GNode* g_node_insert_before (GNode *parent,
1032 GNode* g_node_prepend (GNode *parent,
1034 guint g_node_n_nodes (GNode *root,
1035 GTraverseFlags flags);
1036 GNode* g_node_get_root (GNode *node);
1037 gboolean g_node_is_ancestor (GNode *node,
1039 guint g_node_depth (GNode *node);
1040 GNode* g_node_find (GNode *root,
1041 GTraverseType order,
1042 GTraverseFlags flags,
1045 /* convenience macros */
1046 #define g_node_append(parent, node) \
1047 g_node_insert_before ((parent), NULL, (node))
1048 #define g_node_insert_data(parent, position, data) \
1049 g_node_insert ((parent), (position), g_node_new (data))
1050 #define g_node_insert_data_before(parent, sibling, data) \
1051 g_node_insert_before ((parent), (sibling), g_node_new (data))
1052 #define g_node_prepend_data(parent, data) \
1053 g_node_prepend ((parent), g_node_new (data))
1054 #define g_node_append_data(parent, data) \
1055 g_node_insert_before ((parent), NULL, g_node_new (data))
1057 /* traversal function, assumes that `node' is root
1058 * (only traverses `node' and its subtree).
1059 * this function is just a high level interface to
1060 * low level traversal functions, optimized for speed.
1062 void g_node_traverse (GNode *root,
1063 GTraverseType order,
1064 GTraverseFlags flags,
1066 GNodeTraverseFunc func,
1069 /* return the maximum tree height starting with `node', this is an expensive
1070 * operation, since we need to visit all nodes. this could be shortened by
1071 * adding `guint height' to struct _GNode, but then again, this is not very
1072 * often needed, and would make g_node_insert() more time consuming.
1074 guint g_node_max_height (GNode *root);
1076 void g_node_children_foreach (GNode *node,
1077 GTraverseFlags flags,
1078 GNodeForeachFunc func,
1080 void g_node_reverse_children (GNode *node);
1081 guint g_node_n_children (GNode *node);
1082 GNode* g_node_nth_child (GNode *node,
1084 GNode* g_node_last_child (GNode *node);
1085 GNode* g_node_find_child (GNode *node,
1086 GTraverseFlags flags,
1088 gint g_node_child_position (GNode *node,
1090 gint g_node_child_index (GNode *node,
1093 GNode* g_node_first_sibling (GNode *node);
1094 GNode* g_node_last_sibling (GNode *node);
1096 #define g_node_prev_sibling(node) ((node) ? \
1097 ((GNode*) (node))->prev : NULL)
1098 #define g_node_next_sibling(node) ((node) ? \
1099 ((GNode*) (node))->next : NULL)
1100 #define g_node_first_child(node) ((node) ? \
1101 ((GNode*) (node))->children : NULL)
1104 /* Callback maintenance functions
1106 #define G_HOOK_FLAG_USER_SHIFT (4)
1109 G_HOOK_FLAG_ACTIVE = 1 << 0,
1110 G_HOOK_FLAG_IN_CALL = 1 << 1,
1111 G_HOOK_FLAG_MASK = 0x0f
1120 GMemChunk *hook_memchunk;
1121 GHookFreeFunc hook_free; /* virtual function */
1133 GDestroyNotify destroy;
1136 #define G_HOOK_ACTIVE(hook) ((((GHook*) hook)->flags & \
1137 G_HOOK_FLAG_ACTIVE) != 0)
1138 #define G_HOOK_IN_CALL(hook) ((((GHook*) hook)->flags & \
1139 G_HOOK_FLAG_IN_CALL) != 0)
1140 #define G_HOOK_IS_VALID(hook) (((GHook*) hook)->hook_id != 0 && \
1141 G_HOOK_ACTIVE (hook))
1142 #define G_HOOK_IS_UNLINKED(hook) (((GHook*) hook)->next == NULL && \
1143 ((GHook*) hook)->prev == NULL && \
1144 ((GHook*) hook)->hook_id == 0 && \
1145 ((GHook*) hook)->ref_count == 0)
1147 void g_hook_list_init (GHookList *hook_list,
1149 void g_hook_list_clear (GHookList *hook_list);
1150 GHook* g_hook_alloc (GHookList *hook_list);
1151 void g_hook_free (GHookList *hook_list,
1153 void g_hook_ref (GHookList *hook_list,
1155 void g_hook_unref (GHookList *hook_list,
1157 gboolean g_hook_destroy (GHookList *hook_list,
1159 void g_hook_destroy_link (GHookList *hook_list,
1161 void g_hook_prepend (GHookList *hook_list,
1163 void g_hook_insert_before (GHookList *hook_list,
1166 void g_hook_insert_sorted (GHookList *hook_list,
1168 GHookCompareFunc func);
1169 GHook* g_hook_get (GHookList *hook_list,
1171 GHook* g_hook_find (GHookList *hook_list,
1172 gboolean need_valids,
1175 GHook* g_hook_find_data (GHookList *hook_list,
1176 gboolean need_valids,
1178 GHook* g_hook_find_func (GHookList *hook_list,
1179 gboolean need_valids,
1181 GHook* g_hook_find_func_data (GHookList *hook_list,
1182 gboolean need_valids,
1185 GHook* g_hook_first_valid (GHookList *hook_list,
1186 gboolean may_be_in_call);
1187 GHook* g_hook_next_valid (GHook *hook,
1188 gboolean may_be_in_call);
1190 /* GHookCompareFunc implementation to insert hooks sorted by their id */
1191 gint g_hook_compare_ids (GHook *new_hook,
1194 /* convenience macros */
1195 #define g_hook_append( hook_list, hook ) \
1196 g_hook_insert_before ((hook_list), NULL, (hook))
1198 /* invoke all valid hooks with the (*GHookFunc) signature.
1200 void g_hook_list_invoke (GHookList *hook_list,
1201 gboolean may_recurse);
1202 /* invoke all valid hooks with the (*GHookCheckFunc) signature,
1203 * and destroy the hook if FALSE is returned.
1205 void g_hook_list_invoke_check (GHookList *hook_list,
1206 gboolean may_recurse);
1207 /* invoke a marshaller on all valid hooks.
1209 void g_hook_list_marshal (GHookList *hook_list,
1210 gboolean may_recurse,
1211 GHookMarshaller marshaller,
1215 /* Fatal error handlers.
1216 * g_on_error_query() will prompt the user to either
1217 * [E]xit, [H]alt, [P]roceed or show [S]tack trace.
1218 * g_on_error_stack_trace() invokes gdb, which attaches to the current
1219 * process and shows a stack trace.
1220 * These function may cause different actions on non-unix platforms.
1221 * The prg_name arg is required by gdb to find the executable, if it is
1222 * passed as NULL, g_on_error_query() will try g_get_prgname().
1224 void g_on_error_query (const gchar *prg_name);
1225 void g_on_error_stack_trace (const gchar *prg_name);
1228 /* Logging mechanism
1230 extern const gchar *g_log_domain_glib;
1231 guint g_log_set_handler (const gchar *log_domain,
1232 GLogLevelFlags log_levels,
1234 gpointer user_data);
1235 void g_log_remove_handler (const gchar *log_domain,
1237 void g_log_default_handler (const gchar *log_domain,
1238 GLogLevelFlags log_level,
1239 const gchar *message,
1240 gpointer unused_data);
1241 void g_log (const gchar *log_domain,
1242 GLogLevelFlags log_level,
1243 const gchar *format,
1244 ...) G_GNUC_PRINTF (3, 4);
1245 void g_logv (const gchar *log_domain,
1246 GLogLevelFlags log_level,
1247 const gchar *format,
1249 GLogLevelFlags g_log_set_fatal_mask (const gchar *log_domain,
1250 GLogLevelFlags fatal_mask);
1251 GLogLevelFlags g_log_set_always_fatal (GLogLevelFlags fatal_mask);
1252 #ifndef G_LOG_DOMAIN
1253 #define G_LOG_DOMAIN (NULL)
1254 #endif /* G_LOG_DOMAIN */
1256 #define g_error(format, args...) g_log (G_LOG_DOMAIN, \
1257 G_LOG_LEVEL_ERROR, \
1259 #define g_message(format, args...) g_log (G_LOG_DOMAIN, \
1260 G_LOG_LEVEL_MESSAGE, \
1262 #define g_warning(format, args...) g_log (G_LOG_DOMAIN, \
1263 G_LOG_LEVEL_WARNING, \
1265 #else /* !__GNUC__ */
1267 g_error (const gchar *format,
1271 va_start (args, format);
1272 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR, format, args);
1276 g_message (const gchar *format,
1280 va_start (args, format);
1281 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_MESSAGE, format, args);
1285 g_warning (const gchar *format,
1289 va_start (args, format);
1290 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING, format, args);
1293 #endif /* !__GNUC__ */
1295 typedef void (*GPrintFunc) (const gchar *string);
1296 void g_print (const gchar *format,
1297 ...) G_GNUC_PRINTF (1, 2);
1298 GPrintFunc g_set_print_handler (GPrintFunc func);
1299 void g_printerr (const gchar *format,
1300 ...) G_GNUC_PRINTF (1, 2);
1301 GPrintFunc g_set_printerr_handler (GPrintFunc func);
1303 /* deprecated compatibility functions, use g_log_set_handler() instead */
1304 typedef void (*GErrorFunc) (const gchar *str);
1305 typedef void (*GWarningFunc) (const gchar *str);
1306 GErrorFunc g_set_error_handler (GErrorFunc func);
1307 GWarningFunc g_set_warning_handler (GWarningFunc func);
1308 GPrintFunc g_set_message_handler (GPrintFunc func);
1311 /* Memory allocation and debugging
1315 #define g_malloc(size) ((gpointer) MALLOC (size))
1316 #define g_malloc0(size) ((gpointer) CALLOC (char, size))
1317 #define g_realloc(mem,size) ((gpointer) REALLOC (mem, char, size))
1318 #define g_free(mem) FREE (mem)
1320 #else /* !USE_DMALLOC */
1322 gpointer g_malloc (gulong size);
1323 gpointer g_malloc0 (gulong size);
1324 gpointer g_realloc (gpointer mem,
1326 void g_free (gpointer mem);
1328 #endif /* !USE_DMALLOC */
1330 void g_mem_profile (void);
1331 void g_mem_check (gpointer mem);
1334 /* "g_mem_chunk_new" creates a new memory chunk.
1335 * Memory chunks are used to allocate pieces of memory which are
1336 * always the same size. Lists are a good example of such a data type.
1337 * The memory chunk allocates and frees blocks of memory as needed.
1338 * Just be sure to call "g_mem_chunk_free" and not "g_free" on data
1339 * allocated in a mem chunk. ("g_free" will most likely cause a seg
1340 * fault...somewhere).
1342 * Oh yeah, GMemChunk is an opaque data type. (You don't really
1343 * want to know what's going on inside do you?)
1346 /* ALLOC_ONLY MemChunk's can only allocate memory. The free operation
1347 * is interpreted as a no op. ALLOC_ONLY MemChunk's save 4 bytes per
1348 * atom. (They are also useful for lists which use MemChunk to allocate
1349 * memory but are also part of the MemChunk implementation).
1350 * ALLOC_AND_FREE MemChunk's can allocate and free memory.
1353 #define G_ALLOC_ONLY 1
1354 #define G_ALLOC_AND_FREE 2
1356 GMemChunk* g_mem_chunk_new (gchar *name,
1360 void g_mem_chunk_destroy (GMemChunk *mem_chunk);
1361 gpointer g_mem_chunk_alloc (GMemChunk *mem_chunk);
1362 gpointer g_mem_chunk_alloc0 (GMemChunk *mem_chunk);
1363 void g_mem_chunk_free (GMemChunk *mem_chunk,
1365 void g_mem_chunk_clean (GMemChunk *mem_chunk);
1366 void g_mem_chunk_reset (GMemChunk *mem_chunk);
1367 void g_mem_chunk_print (GMemChunk *mem_chunk);
1368 void g_mem_chunk_info (void);
1370 /* Ah yes...we have a "g_blow_chunks" function.
1371 * "g_blow_chunks" simply compresses all the chunks. This operation
1372 * consists of freeing every memory area that should be freed (but
1373 * which we haven't gotten around to doing yet). And, no,
1374 * "g_blow_chunks" doesn't follow the naming scheme, but it is a
1375 * much better name than "g_mem_chunk_clean_all" or something
1378 void g_blow_chunks (void);
1383 GTimer* g_timer_new (void);
1384 void g_timer_destroy (GTimer *timer);
1385 void g_timer_start (GTimer *timer);
1386 void g_timer_stop (GTimer *timer);
1387 void g_timer_reset (GTimer *timer);
1388 gdouble g_timer_elapsed (GTimer *timer,
1389 gulong *microseconds);
1392 /* String utility functions that modify a string argument or
1393 * return a constant string that must not be freed.
1395 #define G_STR_DELIMITERS "_-|> <."
1396 gchar* g_strdelimit (gchar *string,
1397 const gchar *delimiters,
1398 gchar new_delimiter);
1399 gdouble g_strtod (const gchar *nptr,
1401 gchar* g_strerror (gint errnum);
1402 gchar* g_strsignal (gint signum);
1403 gint g_strcasecmp (const gchar *s1,
1405 gint g_strncasecmp (const gchar *s1,
1408 void g_strdown (gchar *string);
1409 void g_strup (gchar *string);
1410 void g_strreverse (gchar *string);
1411 /* removes leading spaces */
1412 gchar* g_strchug (gchar *string);
1413 /* removes trailing spaces */
1414 gchar* g_strchomp (gchar *string);
1415 /* removes leading & trailing spaces */
1416 #define g_strstrip( string ) g_strchomp (g_strchug (string))
1418 /* String utility functions that return a newly allocated string which
1419 * ought to be freed from the caller at some point.
1421 gchar* g_strdup (const gchar *str);
1422 gchar* g_strdup_printf (const gchar *format,
1423 ...) G_GNUC_PRINTF (1, 2);
1424 gchar* g_strdup_vprintf (const gchar *format,
1426 gchar* g_strndup (const gchar *str,
1428 gchar* g_strnfill (guint length,
1430 gchar* g_strconcat (const gchar *string1,
1431 ...); /* NULL terminated */
1432 gchar* g_strjoin (const gchar *separator,
1433 ...); /* NULL terminated */
1434 gchar* g_strescape (gchar *string);
1435 gpointer g_memdup (gconstpointer mem,
1438 /* NULL terminated string arrays.
1439 * g_strsplit() splits up string into max_tokens tokens at delim and
1440 * returns a newly allocated string array.
1441 * g_strjoinv() concatenates all of str_array's strings, sliding in an
1442 * optional separator, the returned string is newly allocated.
1443 * g_strfreev() frees the array itself and all of its strings.
1445 gchar** g_strsplit (const gchar *string,
1446 const gchar *delimiter,
1448 gchar* g_strjoinv (const gchar *separator,
1450 void g_strfreev (gchar **str_array);
1454 /* calculate a string size, guarranteed to fit format + args.
1456 guint g_printf_string_upper_bound (const gchar* format,
1460 /* Retrive static string info
1462 gchar* g_get_user_name (void);
1463 gchar* g_get_real_name (void);
1464 gchar* g_get_home_dir (void);
1465 gchar* g_get_tmp_dir (void);
1466 gchar* g_get_prgname (void);
1467 void g_set_prgname (const gchar *prgname);
1470 /* Miscellaneous utility functions
1472 guint g_parse_debug_string (const gchar *string,
1475 gint g_snprintf (gchar *string,
1477 gchar const *format,
1478 ...) G_GNUC_PRINTF (3, 4);
1479 gint g_vsnprintf (gchar *string,
1481 gchar const *format,
1483 gchar* g_basename (const gchar *file_name);
1484 /* Check if a file name is an absolute path */
1485 gboolean g_path_is_absolute (const gchar *file_name);
1486 /* In case of absolute paths, skip the root part */
1487 gchar* g_path_skip_root (gchar *file_name);
1489 /* strings are newly allocated with g_malloc() */
1490 gchar* g_dirname (const gchar *file_name);
1491 gchar* g_get_current_dir (void);
1492 gchar* g_getenv (const gchar *variable);
1495 /* we use a GLib function as a replacement for ATEXIT, so
1496 * the programmer is not required to check the return value
1497 * (if there is any in the implementation) and doesn't encounter
1498 * missing include files.
1500 void g_atexit (GVoidFunc func);
1505 G_INLINE_FUNC gint g_bit_nth_lsf (guint32 mask,
1509 g_bit_nth_lsf (guint32 mask,
1515 if (mask & (1 << (guint) nth_bit))
1518 while (nth_bit < 32);
1521 #endif /* G_CAN_INLINE */
1523 G_INLINE_FUNC gint g_bit_nth_msf (guint32 mask,
1527 g_bit_nth_msf (guint32 mask,
1535 if (mask & (1 << (guint) nth_bit))
1538 while (nth_bit > 0);
1541 #endif /* G_CAN_INLINE */
1543 G_INLINE_FUNC guint g_bit_storage (guint number);
1546 g_bit_storage (guint number)
1548 register guint n_bits = 0;
1558 #endif /* G_CAN_INLINE */
1562 GStringChunk* g_string_chunk_new (gint size);
1563 void g_string_chunk_free (GStringChunk *chunk);
1564 gchar* g_string_chunk_insert (GStringChunk *chunk,
1565 const gchar *string);
1566 gchar* g_string_chunk_insert_const (GStringChunk *chunk,
1567 const gchar *string);
1572 GString* g_string_new (const gchar *init);
1573 GString* g_string_sized_new (guint dfl_size);
1574 void g_string_free (GString *string,
1576 GString* g_string_assign (GString *lval,
1578 GString* g_string_truncate (GString *string,
1580 GString* g_string_append (GString *string,
1582 GString* g_string_append_c (GString *string,
1584 GString* g_string_prepend (GString *string,
1586 GString* g_string_prepend_c (GString *string,
1588 GString* g_string_insert (GString *string,
1591 GString* g_string_insert_c (GString *string,
1594 GString* g_string_erase (GString *string,
1597 GString* g_string_down (GString *string);
1598 GString* g_string_up (GString *string);
1599 void g_string_sprintf (GString *string,
1600 const gchar *format,
1601 ...) G_GNUC_PRINTF (2, 3);
1602 void g_string_sprintfa (GString *string,
1603 const gchar *format,
1604 ...) G_GNUC_PRINTF (2, 3);
1607 /* Resizable arrays, remove fills any cleared spot and shortens the
1608 * array, while preserving the order. remove_fast will distort the
1609 * order by moving the last element to the position of the removed
1612 #define g_array_append_val(a,v) g_array_append_vals(a,&v,1)
1613 #define g_array_prepend_val(a,v) g_array_prepend_vals(a,&v,1)
1614 #define g_array_index(a,t,i) (((t*)a->data)[i])
1616 GArray* g_array_new (gboolean zero_terminated,
1618 guint element_size);
1619 void g_array_free (GArray *array,
1620 gboolean free_segment);
1621 GArray* g_array_append_vals (GArray *array,
1624 GArray* g_array_prepend_vals (GArray *array,
1627 GArray* g_array_set_size (GArray *array,
1629 GArray* g_array_remove_index (GArray *array,
1631 GArray* g_array_remove_index_fast (GArray *array,
1634 /* Resizable pointer array. This interface is much less complicated
1635 * than the above. Add appends appends a pointer. Remove fills any
1636 * cleared spot and shortens the array. remove_fast will again distort
1639 #define g_ptr_array_index(array,index) (array->pdata)[index]
1640 GPtrArray* g_ptr_array_new (void);
1641 void g_ptr_array_free (GPtrArray *array,
1643 void g_ptr_array_set_size (GPtrArray *array,
1645 gpointer g_ptr_array_remove_index (GPtrArray *array,
1647 gpointer g_ptr_array_remove_index_fast (GPtrArray *array,
1649 gboolean g_ptr_array_remove (GPtrArray *array,
1651 gboolean g_ptr_array_remove_fast (GPtrArray *array,
1653 void g_ptr_array_add (GPtrArray *array,
1656 /* Byte arrays, an array of guint8. Implemented as a GArray,
1660 GByteArray* g_byte_array_new (void);
1661 void g_byte_array_free (GByteArray *array,
1662 gboolean free_segment);
1663 GByteArray* g_byte_array_append (GByteArray *array,
1666 GByteArray* g_byte_array_prepend (GByteArray *array,
1669 GByteArray* g_byte_array_set_size (GByteArray *array,
1671 GByteArray* g_byte_array_remove_index (GByteArray *array,
1673 GByteArray* g_byte_array_remove_index_fast (GByteArray *array,
1679 gint g_str_equal (gconstpointer v,
1681 guint g_str_hash (gconstpointer v);
1683 gint g_int_equal (gconstpointer v,
1685 guint g_int_hash (gconstpointer v);
1687 /* This "hash" function will just return the key's adress as an
1688 * unsigned integer. Useful for hashing on plain adresses or
1689 * simple integer values.
1691 guint g_direct_hash (gconstpointer v);
1692 gint g_direct_equal (gconstpointer v,
1696 /* Quarks (string<->id association)
1698 GQuark g_quark_try_string (const gchar *string);
1699 GQuark g_quark_from_static_string (const gchar *string);
1700 GQuark g_quark_from_string (const gchar *string);
1701 gchar* g_quark_to_string (GQuark quark);
1706 void g_datalist_init (GData **datalist);
1707 void g_datalist_clear (GData **datalist);
1708 gpointer g_datalist_id_get_data (GData **datalist,
1710 void g_datalist_id_set_data_full (GData **datalist,
1713 GDestroyNotify destroy_func);
1714 void g_datalist_id_remove_no_notify (GData **datalist,
1716 void g_datalist_foreach (GData **datalist,
1717 GDataForeachFunc func,
1718 gpointer user_data);
1719 #define g_datalist_id_set_data(dl, q, d) \
1720 g_datalist_id_set_data_full ((dl), (q), (d), NULL)
1721 #define g_datalist_id_remove_data(dl, q) \
1722 g_datalist_id_set_data ((dl), (q), NULL)
1723 #define g_datalist_get_data(dl, k) \
1724 (g_datalist_id_get_data ((dl), g_quark_try_string (k)))
1725 #define g_datalist_set_data_full(dl, k, d, f) \
1726 g_datalist_id_set_data_full ((dl), g_quark_from_string (k), (d), (f))
1727 #define g_datalist_remove_no_notify(dl, k) \
1728 g_datalist_id_remove_no_notify ((dl), g_quark_try_string (k))
1729 #define g_datalist_set_data(dl, k, d) \
1730 g_datalist_set_data_full ((dl), (k), (d), NULL)
1731 #define g_datalist_remove_data(dl, k) \
1732 g_datalist_id_set_data ((dl), g_quark_try_string (k), NULL)
1735 /* Location Associated Keyed Data
1737 void g_dataset_destroy (gconstpointer dataset_location);
1738 gpointer g_dataset_id_get_data (gconstpointer dataset_location,
1740 void g_dataset_id_set_data_full (gconstpointer dataset_location,
1743 GDestroyNotify destroy_func);
1744 void g_dataset_id_remove_no_notify (gconstpointer dataset_location,
1746 void g_dataset_foreach (gconstpointer dataset_location,
1747 GDataForeachFunc func,
1748 gpointer user_data);
1749 #define g_dataset_id_set_data(l, k, d) \
1750 g_dataset_id_set_data_full ((l), (k), (d), NULL)
1751 #define g_dataset_id_remove_data(l, k) \
1752 g_dataset_id_set_data ((l), (k), NULL)
1753 #define g_dataset_get_data(l, k) \
1754 (g_dataset_id_get_data ((l), g_quark_try_string (k)))
1755 #define g_dataset_set_data_full(l, k, d, f) \
1756 g_dataset_id_set_data_full ((l), g_quark_from_string (k), (d), (f))
1757 #define g_dataset_remove_no_notify(l, k) \
1758 g_dataset_id_remove_no_notify ((l), g_quark_try_string (k))
1759 #define g_dataset_set_data(l, k, d) \
1760 g_dataset_set_data_full ((l), (k), (d), NULL)
1761 #define g_dataset_remove_data(l, k) \
1762 g_dataset_id_set_data ((l), g_quark_try_string (k), NULL)
1765 /* GScanner: Flexible lexical scanner for general purpose.
1768 /* Character sets */
1769 #define G_CSET_A_2_Z "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1770 #define G_CSET_a_2_z "abcdefghijklmnopqrstuvwxyz"
1771 #define G_CSET_LATINC "\300\301\302\303\304\305\306"\
1772 "\307\310\311\312\313\314\315\316\317\320"\
1773 "\321\322\323\324\325\326"\
1774 "\330\331\332\333\334\335\336"
1775 #define G_CSET_LATINS "\337\340\341\342\343\344\345\346"\
1776 "\347\350\351\352\353\354\355\356\357\360"\
1777 "\361\362\363\364\365\366"\
1778 "\370\371\372\373\374\375\376\377"
1785 G_ERR_UNEXP_EOF_IN_STRING,
1786 G_ERR_UNEXP_EOF_IN_COMMENT,
1787 G_ERR_NON_DIGIT_IN_CONST,
1790 G_ERR_FLOAT_MALFORMED
1798 G_TOKEN_LEFT_PAREN = '(',
1799 G_TOKEN_RIGHT_PAREN = ')',
1800 G_TOKEN_LEFT_CURLY = '{',
1801 G_TOKEN_RIGHT_CURLY = '}',
1802 G_TOKEN_LEFT_BRACE = '[',
1803 G_TOKEN_RIGHT_BRACE = ']',
1804 G_TOKEN_EQUAL_SIGN = '=',
1805 G_TOKEN_COMMA = ',',
1821 G_TOKEN_IDENTIFIER_NULL,
1823 G_TOKEN_COMMENT_SINGLE,
1824 G_TOKEN_COMMENT_MULTI,
1831 gchar *v_identifier;
1843 struct _GScannerConfig
1847 gchar *cset_skip_characters; /* default: " \t\n" */
1848 gchar *cset_identifier_first;
1849 gchar *cset_identifier_nth;
1850 gchar *cpair_comment_single; /* default: "#\n" */
1852 /* Should symbol lookup work case sensitive?
1854 guint case_sensitive : 1;
1856 /* Boolean values to be adjusted "on the fly"
1857 * to configure scanning behaviour.
1859 guint skip_comment_multi : 1; /* C like comment */
1860 guint skip_comment_single : 1; /* single line comment */
1861 guint scan_comment_multi : 1; /* scan multi line comments? */
1862 guint scan_identifier : 1;
1863 guint scan_identifier_1char : 1;
1864 guint scan_identifier_NULL : 1;
1865 guint scan_symbols : 1;
1866 guint scan_binary : 1;
1867 guint scan_octal : 1;
1868 guint scan_float : 1;
1869 guint scan_hex : 1; /* `0x0ff0' */
1870 guint scan_hex_dollar : 1; /* `$0ff0' */
1871 guint scan_string_sq : 1; /* string: 'anything' */
1872 guint scan_string_dq : 1; /* string: "\\-escapes!\n" */
1873 guint numbers_2_int : 1; /* bin, octal, hex => int */
1874 guint int_2_float : 1; /* int => G_TOKEN_FLOAT? */
1875 guint identifier_2_string : 1;
1876 guint char_2_token : 1; /* return G_TOKEN_CHAR? */
1877 guint symbol_2_token : 1;
1878 guint scope_0_fallback : 1; /* try scope 0 on lookups? */
1885 guint max_parse_errors;
1887 /* g_scanner_error() increments this field */
1890 /* name of input stream, featured by the default message handler */
1891 const gchar *input_name;
1893 /* data pointer for derived structures */
1894 gpointer derived_data;
1896 /* link into the scanner configuration */
1897 GScannerConfig *config;
1899 /* fields filled in after g_scanner_get_next_token() */
1905 /* fields filled in after g_scanner_peek_next_token() */
1906 GTokenType next_token;
1907 GTokenValue next_value;
1909 guint next_position;
1911 /* to be considered private */
1912 GHashTable *symbol_table;
1915 const gchar *text_end;
1919 /* handler function for _warn and _error */
1920 GScannerMsgFunc msg_handler;
1923 GScanner* g_scanner_new (GScannerConfig *config_templ);
1924 void g_scanner_destroy (GScanner *scanner);
1925 void g_scanner_input_file (GScanner *scanner,
1927 void g_scanner_sync_file_offset (GScanner *scanner);
1928 void g_scanner_input_text (GScanner *scanner,
1931 GTokenType g_scanner_get_next_token (GScanner *scanner);
1932 GTokenType g_scanner_peek_next_token (GScanner *scanner);
1933 GTokenType g_scanner_cur_token (GScanner *scanner);
1934 GTokenValue g_scanner_cur_value (GScanner *scanner);
1935 guint g_scanner_cur_line (GScanner *scanner);
1936 guint g_scanner_cur_position (GScanner *scanner);
1937 gboolean g_scanner_eof (GScanner *scanner);
1938 guint g_scanner_set_scope (GScanner *scanner,
1940 void g_scanner_scope_add_symbol (GScanner *scanner,
1942 const gchar *symbol,
1944 void g_scanner_scope_remove_symbol (GScanner *scanner,
1946 const gchar *symbol);
1947 gpointer g_scanner_scope_lookup_symbol (GScanner *scanner,
1949 const gchar *symbol);
1950 void g_scanner_scope_foreach_symbol (GScanner *scanner,
1953 gpointer func_data);
1954 gpointer g_scanner_lookup_symbol (GScanner *scanner,
1955 const gchar *symbol);
1956 void g_scanner_freeze_symbol_table (GScanner *scanner);
1957 void g_scanner_thaw_symbol_table (GScanner *scanner);
1958 void g_scanner_unexp_token (GScanner *scanner,
1959 GTokenType expected_token,
1960 const gchar *identifier_spec,
1961 const gchar *symbol_spec,
1962 const gchar *symbol_name,
1963 const gchar *message,
1965 void g_scanner_error (GScanner *scanner,
1966 const gchar *format,
1967 ...) G_GNUC_PRINTF (2,3);
1968 void g_scanner_warn (GScanner *scanner,
1969 const gchar *format,
1970 ...) G_GNUC_PRINTF (2,3);
1971 gint g_scanner_stat_mode (const gchar *filename);
1972 /* keep downward source compatibility */
1973 #define g_scanner_add_symbol( scanner, symbol, value ) G_STMT_START { \
1974 g_scanner_scope_add_symbol ((scanner), 0, (symbol), (value)); \
1976 #define g_scanner_remove_symbol( scanner, symbol ) G_STMT_START { \
1977 g_scanner_scope_remove_symbol ((scanner), 0, (symbol)); \
1979 #define g_scanner_foreach_symbol( scanner, func, data ) G_STMT_START { \
1980 g_scanner_scope_foreach_symbol ((scanner), 0, (func), (data)); \
1989 GCompletionFunc func;
1995 GCompletion* g_completion_new (GCompletionFunc func);
1996 void g_completion_add_items (GCompletion* cmp,
1998 void g_completion_remove_items (GCompletion* cmp,
2000 void g_completion_clear_items (GCompletion* cmp);
2001 GList* g_completion_complete (GCompletion* cmp,
2003 gchar** new_prefix);
2004 void g_completion_free (GCompletion* cmp);
2007 /* GRelation: Indexed Relations. Imagine a really simple table in a
2008 * database. Relations are not ordered. This data type is meant for
2009 * maintaining a N-way mapping.
2011 * g_relation_new() creates a relation with FIELDS fields
2013 * g_relation_destroy() frees all resources
2014 * g_tuples_destroy() frees the result of g_relation_select()
2016 * g_relation_index() indexes relation FIELD with the provided
2017 * equality and hash functions. this must be done before any
2018 * calls to insert are made.
2020 * g_relation_insert() inserts a new tuple. you are expected to
2021 * provide the right number of fields.
2023 * g_relation_delete() deletes all relations with KEY in FIELD
2024 * g_relation_select() returns ...
2025 * g_relation_count() counts ...
2028 GRelation* g_relation_new (gint fields);
2029 void g_relation_destroy (GRelation *relation);
2030 void g_relation_index (GRelation *relation,
2032 GHashFunc hash_func,
2033 GCompareFunc key_compare_func);
2034 void g_relation_insert (GRelation *relation,
2036 gint g_relation_delete (GRelation *relation,
2039 GTuples* g_relation_select (GRelation *relation,
2042 gint g_relation_count (GRelation *relation,
2045 gboolean g_relation_exists (GRelation *relation,
2047 void g_relation_print (GRelation *relation);
2049 void g_tuples_destroy (GTuples *tuples);
2050 gpointer g_tuples_index (GTuples *tuples,
2058 /* This function returns prime numbers spaced by approximately 1.5-2.0
2059 * and is for use in resizing data structures which prefer
2060 * prime-valued sizes. The closest spaced prime function returns the
2061 * next largest prime, or the highest it knows about which is about
2064 guint g_spaced_primes_closest (guint num);
2068 * These are used for plug-in communication in the GIMP, for instance.
2069 * On Unix, it's simply an encapsulated file descriptor (a pipe).
2070 * On Windows, it's a handle to an anonymouos pipe, *and* (in the case
2071 * of the writable end) a thread id to post a message to when you have written
2076 gint fd; /* file handle (pseudo such in Win32) */
2078 guint peer; /* thread to post message to */
2079 guint peer_fd; /* read handle (in the other process) */
2080 guint offset; /* counter of accumulated bytes, to
2081 * be included in the message posted
2082 * so we keep in sync.
2084 guint peer_offset; /* in input channels where the writer's
2085 * offset is, so we don't try to read too much
2090 GIOChannel *g_iochannel_new (gint fd);
2091 void g_iochannel_free (GIOChannel *channel);
2092 void g_iochannel_close_and_free (GIOChannel *channel);
2093 void g_iochannel_wakeup_peer (GIOChannel *channel);
2094 #ifndef NATIVE_WIN32
2095 # define g_iochannel_wakeup_peer(channel) G_STMT_START { } G_STMT_END
2099 /* Windows emulation stubs for common unix functions
2103 #define MAXPATHLEN 1024
2108 /* These POSIXish functions are available in the Microsoft C library
2109 * prefixed with underscore (which of course technically speaking is
2110 * the Right Thing, as they are non-ANSI. Not that being non-ANSI
2111 * prevents Microsoft from practically requiring you to include
2112 * <windows.h> every now and then...).
2114 * You still need to include the appropriate headers to get the
2115 * prototypes, <io.h> or <direct.h>.
2117 * For some functions, we provide emulators in glib, which are prefixed
2120 #define getcwd _getcwd
2121 #define getpid _getpid
2122 #define access _access
2125 #define write _write
2126 #define lseek _lseek
2127 #define close _close
2128 #define pipe(phandles) _pipe (phandles, 4096, _O_BINARY)
2129 #define popen _popen
2130 #define pclose _pclose
2131 #define fdopen _fdopen
2132 #define ftruncate(fd, size) gwin_ftruncate (fd, size)
2133 #define opendir gwin_opendir
2134 #define readdir gwin_readdir
2135 #define rewinddir gwin_rewinddir
2136 #define closedir gwin_closedir
2138 #define NAME_MAX 255
2144 gboolean just_opened;
2145 guint find_file_handle;
2146 gpointer find_file_data;
2148 typedef struct DIR DIR;
2151 gchar d_name[NAME_MAX + 1];
2154 /* emulation functions */
2155 extern int gwin_ftruncate (gint f,
2157 DIR* gwin_opendir (const gchar *dirname);
2158 struct dirent* gwin_readdir (DIR *dir);
2159 void gwin_rewinddir (DIR *dir);
2160 gint gwin_closedir (DIR *dir);
2162 #endif /* _MSC_VER */
2164 #endif /* NATIVE_WIN32 */
2169 #endif /* __cplusplus */
2172 #endif /* __G_LIB_H__ */