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 #include <glibconfig.h>
29 /* glib provides definitions for the extrema of many
30 * of the standard types. These are:
47 #define G_MINFLOAT FLT_MIN
48 #define G_MAXFLOAT FLT_MAX
49 #define G_MINDOUBLE DBL_MIN
50 #define G_MAXDOUBLE DBL_MAX
56 #define G_MINFLOAT MINFLOAT
57 #define G_MAXFLOAT MAXFLOAT
58 #define G_MINDOUBLE MINDOUBLE
59 #define G_MAXDOUBLE MAXDOUBLE
61 #endif /* HAVE_VALUES_H */
68 #define G_MINSHORT SHRT_MIN
69 #define G_MAXSHORT SHRT_MAX
70 #define G_MININT INT_MIN
71 #define G_MAXINT INT_MAX
72 #define G_MINLONG LONG_MIN
73 #define G_MAXLONG LONG_MAX
79 #endif /* HAVE_FLOAT_H */
81 #define G_MINSHORT MINSHORT
82 #define G_MAXSHORT MAXSHORT
83 #define G_MININT MININT
84 #define G_MAXINT MAXINT
85 #define G_MINLONG MINLONG
86 #define G_MAXLONG MAXLONG
88 #endif /* HAVE_VALUES_H */
91 /* Provide definitions for some commonly used macros.
92 * Some of them are only provided if they haven't already
93 * been defined. It is assumed that if they are already
94 * defined then the current definition is correct.
97 #define NULL ((void*) 0)
105 #define TRUE (!FALSE)
109 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
112 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
115 #define ABS(a) (((a) < 0) ? -(a) : (a))
118 #define CLAMP(x, low, high) (((x) > (high)) ? (high) : (((x) < (low)) ? (low) : (x)))
121 /* Provide simple enum value macro wrappers that ease automated enum value
122 * stringification code.
124 #if !defined (G_CODE_GENERATION)
125 #define G_ENUM( EnumerationName ) EnumerationName
126 #define G_FLAGS( EnumerationName ) EnumerationName
127 #define G_NV( VALUE_NAME , value_nick, VALUE) VALUE_NAME = (VALUE)
128 #define G_SV( VALUE_NAME, value_nick ) VALUE_NAME
129 #else /* G_CODE_GENERATION */
130 #define G_ENUM( EnumerationName ) G_ENUM_E + EnumerationName +
131 #define G_FLAGS( EnumerationName ) G_ENUM_F + EnumerationName +
132 #define G_NV( VALUE_NAME , value_nick, VALUE) G_ENUM_V + VALUE_NAME + value_nick +
133 #define G_SV( VALUE_NAME, value_nick ) G_ENUM_V + VALUE_NAME + value_nick +
134 #endif /* G_CODE_GENERATION */
137 /* Provide simple macro statement wrappers (adapted from Perl):
138 * G_STMT_START { statements; } G_STMT_END;
139 * can be used as a single statement, as in
140 * if (x) G_STMT_START { ... } G_STMT_END; else ...
142 * For gcc we will wrap the statements within `({' and `})' braces.
143 * For SunOS they will be wrapped within `if (1)' and `else (void) 0',
144 * and otherwise within `do' and `while (0)'.
146 #if !(defined (G_STMT_START) && defined (G_STMT_END))
147 # if defined (__GNUC__) && !defined (__STRICT_ANSI__) && !defined (__cplusplus)
148 # define G_STMT_START (void)(
149 # define G_STMT_END )
151 # if (defined (sun) || defined (__sun__))
152 # define G_STMT_START if (1)
153 # define G_STMT_END else (void)0
155 # define G_STMT_START do
156 # define G_STMT_END while (0)
161 /* Provide macros to feature the GCC function attribute.
163 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
164 #define G_GNUC_PRINTF( format_idx, arg_idx ) \
165 __attribute__((format (printf, format_idx, arg_idx)))
166 #define G_GNUC_SCANF( format_idx, arg_idx ) \
167 __attribute__((format (scanf, format_idx, arg_idx)))
168 #define G_GNUC_FORMAT( arg_idx ) \
169 __attribute__((format_arg (arg_idx)))
170 #define G_GNUC_NORETURN \
171 __attribute__((noreturn))
172 #define G_GNUC_CONST \
173 __attribute__((const))
174 #else /* !__GNUC__ */
175 #define G_GNUC_PRINTF( format_idx, arg_idx )
176 #define G_GNUC_SCANF( format_idx, arg_idx )
177 #define G_GNUC_FORMAT( arg_idx )
178 #define G_GNUC_NORETURN
180 #endif /* !__GNUC__ */
182 /* Hacker macro to place breakpoints for x86 machines.
183 * Actual use is strongly deprecated of course ;)
185 #if defined (__i386__)
186 #define G_BREAKPOINT() G_STMT_START{ __asm__ ("int $03"); }G_STMT_END
187 #else /* !__i386__ */
188 #define G_BREAKPOINT()
189 #endif /* __i386__ */
191 /* Wrap the __PRETTY_FUNCTION__ and __FUNCTION__ variables with macros,
192 * so we can refer to them as strings unconditionally.
195 #define G_GNUC_FUNCTION (__FUNCTION__)
196 #define G_GNUC_PRETTY_FUNCTION (__PRETTY_FUNCTION__)
197 #else /* !__GNUC__ */
198 #define G_GNUC_FUNCTION ("")
199 #define G_GNUC_PRETTY_FUNCTION ("")
200 #endif /* !__GNUC__ */
205 # define ATEXIT(proc) (atexit (proc))
206 # elif defined (HAVE_ON_EXIT)
207 # define ATEXIT(proc) (on_exit ((void (*)(int, void *))(proc), NULL))
212 /* Provide macros for easily allocating memory. The macros
213 * will cast the allocated memory to the specified type
214 * in order to avoid compiler warnings. (Makes the code neater).
219 #define g_new(type,count) ALLOC(type,count)
220 #define g_new0(type,count) CALLOC(type,count)
222 #else /* __DMALLOC_H__ */
224 #define g_new(type, count) \
225 ((type *) g_malloc ((unsigned) sizeof (type) * (count)))
226 #define g_new0(type, count) \
227 ((type *) g_malloc0 ((unsigned) sizeof (type) * (count)))
228 #endif /* __DMALLOC_H__ */
230 #define g_mem_chunk_create(type, pre_alloc, alloc_type) ( \
231 g_mem_chunk_new (#type " mem chunks (" #pre_alloc ")", \
233 sizeof (type) * (pre_alloc), \
236 #define g_chunk_new(type, chunk) ( \
237 (type *) g_mem_chunk_alloc (chunk) \
239 #define g_chunk_new0(type, chunk) ( \
240 (type *) memset (g_mem_chunk_alloc (chunk), 0, sizeof (type)) \
242 #define g_chunk_free(mem, mem_chunk) G_STMT_START { \
243 g_mem_chunk_free ((mem_chunk), (mem)); \
246 #define g_string(x) #x
249 /* Provide macros for error handling. The "assert" macros will
250 * exit on failure. The "return" macros will exit the current
251 * function. Two different definitions are given for the macros
252 * in order to support gcc's __PRETTY_FUNCTION__ capability.
255 #ifdef G_DISABLE_ASSERT
257 #define g_assert(expr)
258 #define g_assert_not_reached()
260 #else /* !G_DISABLE_ASSERT */
264 #define g_assert(expr) G_STMT_START{\
266 g_error ("file %s: line %d (%s): \"%s\"", \
269 __PRETTY_FUNCTION__, \
272 #define g_assert_not_reached() G_STMT_START{ \
273 g_error ("file %s: line %d (%s): \"should not be reached\"", \
276 __PRETTY_FUNCTION__); }G_STMT_END
278 #else /* !__GNUC__ */
280 #define g_assert(expr) G_STMT_START{\
282 g_error ("file %s: line %d: \"%s\"", \
287 #define g_assert_not_reached() G_STMT_START{ \
288 g_error ("file %s: line %d: \"should not be reached\"", \
290 __LINE__); }G_STMT_END
292 #endif /* __GNUC__ */
294 #endif /* G_DISABLE_ASSERT */
296 #ifdef G_DISABLE_CHECKS
298 #define g_return_if_fail(expr)
299 #define g_return_val_if_fail(expr,val)
301 #else /* !G_DISABLE_CHECKS */
305 #define g_return_if_fail(expr) G_STMT_START{ \
308 g_warning ("file %s: line %d (%s): assertion \"%s\" failed.", \
311 __PRETTY_FUNCTION__, \
316 #define g_return_val_if_fail(expr,val) G_STMT_START{ \
319 g_warning ("file %s: line %d (%s): assertion \"%s\" failed.", \
322 __PRETTY_FUNCTION__, \
327 #else /* !__GNUC__ */
329 #define g_return_if_fail(expr) G_STMT_START{ \
332 g_warning ("file %s: line %d: assertion. \"%s\" failed", \
339 #define g_return_val_if_fail(expr, val) G_STMT_START{ \
342 g_warning ("file %s: line %d: assertion \"%s\" failed.", \
349 #endif /* !__GNUC__ */
351 #endif /* G_DISABLE_CHECKS */
357 #endif /* __cplusplus */
359 /* Provide type definitions for commonly used types.
360 * These are useful because a "gint8" can be adjusted
361 * to be 1 byte (8 bits) on all platforms. Similarly and
362 * more importantly, "gint32" can be adjusted to be
363 * 4 bytes (32 bits) on all platforms.
367 typedef short gshort;
370 typedef gint gboolean;
372 typedef unsigned char guchar;
373 typedef unsigned short gushort;
374 typedef unsigned long gulong;
375 typedef unsigned int guint;
377 typedef float gfloat;
378 typedef double gdouble;
380 /* HAVE_LONG_DOUBLE doesn't work correctly on all platforms.
381 * Since gldouble isn't used anywhere, just disable it for now */
384 #ifdef HAVE_LONG_DOUBLE
385 typedef long double gldouble;
386 #else /* HAVE_LONG_DOUBLE */
387 typedef double gldouble;
388 #endif /* HAVE_LONG_DOUBLE */
391 typedef void* gpointer;
392 typedef const void *gconstpointer;
394 #if (SIZEOF_CHAR == 1)
395 typedef signed char gint8;
396 typedef unsigned char guint8;
397 #endif /* SIZEOF_CHAR */
400 #if (SIZEOF_SHORT == 2)
401 typedef signed short gint16;
402 typedef unsigned short guint16;
403 #endif /* SIZEOF_SHORT */
406 #if (SIZEOF_INT == 4)
407 typedef signed int gint32;
408 typedef unsigned int guint32;
409 #elif (SIZEOF_LONG == 4)
410 typedef signed long gint32;
411 typedef unsigned long guint32;
412 #endif /* SIZEOF_INT */
414 #if (SIZEOF_LONG == 8)
415 #define HAVE_GINT64 1
416 typedef signed long gint64;
417 typedef unsigned long guint64;
418 #elif (SIZEOF_LONG_LONG == 8)
419 #define HAVE_GINT64 1
420 typedef signed long long gint64;
421 typedef unsigned long long guint64;
428 /* Define macros for storing integers inside pointers */
430 #if (SIZEOF_INT == SIZEOF_VOID_P)
432 #define GPOINTER_TO_INT(p) ((gint)(p))
433 #define GPOINTER_TO_UINT(p) ((guint)(p))
435 #define GINT_TO_POINTER(i) ((gpointer)(i))
436 #define GUINT_TO_POINTER(u) ((gpointer)(u))
438 #elif (SIZEOF_LONG == SIZEOF_VOID_P)
440 #define GPOINTER_TO_INT(p) ((gint)(glong)(p))
441 #define GPOINTER_TO_UINT(p) ((guint)(gulong)(p))
443 #define GINT_TO_POINTER(i) ((gpointer)(glong)(i))
444 #define GUINT_TO_POINTER(u) ((gpointer)(gulong)(u))
447 /* This should never happen */
450 typedef gint32 gssize;
451 typedef guint32 gsize;
452 typedef guint32 GQuark;
455 typedef gint32 GTime;
458 typedef struct _GList GList;
459 typedef struct _GSList GSList;
460 typedef struct _GHashTable GHashTable;
461 typedef struct _GCache GCache;
462 typedef struct _GTree GTree;
463 typedef struct _GTimer GTimer;
464 typedef struct _GMemChunk GMemChunk;
465 typedef struct _GListAllocator GListAllocator;
466 typedef struct _GStringChunk GStringChunk;
467 typedef struct _GString GString;
468 typedef struct _GArray GArray;
469 typedef struct _GPtrArray GPtrArray;
470 typedef struct _GByteArray GByteArray;
471 typedef struct _GDebugKey GDebugKey;
472 typedef struct _GScannerConfig GScannerConfig;
473 typedef struct _GScanner GScanner;
474 typedef union _GValue GValue;
475 typedef struct _GCompletion GCompletion;
476 typedef struct _GRelation GRelation;
477 typedef struct _GTuples GTuples;
478 typedef struct _GNode GNode;
481 typedef void (*GFunc) (gpointer data,
483 typedef void (*GHFunc) (gpointer key,
486 typedef gpointer (*GCacheNewFunc) (gpointer key);
487 typedef gpointer (*GCacheDupFunc) (gpointer value);
488 typedef void (*GCacheDestroyFunc) (gpointer value);
489 typedef gint (*GTraverseFunc) (gpointer key,
492 typedef gboolean (*GNodeTraverseFunc) (GNode *node,
494 typedef void (*GNodeForeachFunc) (GNode *node,
496 typedef gint (*GSearchFunc) (gpointer key,
498 typedef void (*GErrorFunc) (gchar *str);
499 typedef void (*GWarningFunc) (gchar *str);
500 typedef void (*GPrintFunc) (gchar *str);
501 typedef void (*GScannerMsgFunc) (GScanner *scanner,
504 typedef void (*GDestroyNotify) (gpointer data);
506 typedef guint (*GHashFunc) (gconstpointer key);
507 typedef gint (*GCompareFunc) (gconstpointer a,
509 typedef gchar* (*GCompletionFunc) (gpointer);
559 struct _GCache { gint dummy; };
560 struct _GTree { gint dummy; };
561 struct _GTimer { gint dummy; };
562 struct _GMemChunk { gint dummy; };
563 struct _GListAllocator { gint dummy; };
564 struct _GStringChunk { gint dummy; };
576 G_TRAVERSE_LEAFS = 1 << 0,
577 G_TRAVERSE_NON_LEAFS = 1 << 1,
578 G_TRAVERSE_ALL = G_TRAVERSE_LEAFS | G_TRAVERSE_NON_LEAFS,
579 G_TRAVERSE_MASK = 0x03
582 /* Doubly linked lists
584 GList* g_list_alloc (void);
585 void g_list_free (GList *list);
586 void g_list_free_1 (GList *list);
587 GList* g_list_append (GList *list,
589 GList* g_list_prepend (GList *list,
591 GList* g_list_insert (GList *list,
594 GList* g_list_insert_sorted (GList *list,
597 GList* g_list_concat (GList *list1,
599 GList* g_list_remove (GList *list,
601 GList* g_list_remove_link (GList *list,
603 GList* g_list_reverse (GList *list);
604 GList* g_list_nth (GList *list,
606 GList* g_list_find (GList *list,
608 GList* g_list_find_custom (GList *list,
611 gint g_list_position (GList *list,
613 gint g_list_index (GList *list,
615 GList* g_list_last (GList *list);
616 GList* g_list_first (GList *list);
617 guint g_list_length (GList *list);
618 void g_list_foreach (GList *list,
621 gpointer g_list_nth_data (GList *list,
624 #define g_list_previous(list) ((list) ? (((GList *)(list))->prev) : NULL)
625 #define g_list_next(list) ((list) ? (((GList *)(list))->next) : NULL)
627 /* Singly linked lists
629 GSList* g_slist_alloc (void);
630 void g_slist_free (GSList *list);
631 void g_slist_free_1 (GSList *list);
632 GSList* g_slist_append (GSList *list,
634 GSList* g_slist_prepend (GSList *list,
636 GSList* g_slist_insert (GSList *list,
639 GSList* g_slist_insert_sorted (GSList *list,
642 GSList* g_slist_concat (GSList *list1,
644 GSList* g_slist_remove (GSList *list,
646 GSList* g_slist_remove_link (GSList *list,
648 GSList* g_slist_reverse (GSList *list);
649 GSList* g_slist_nth (GSList *list,
651 GSList* g_slist_find (GSList *list,
653 GSList* g_slist_find_custom (GSList *list,
656 gint g_slist_position (GSList *list,
658 gint g_slist_index (GSList *list,
660 GSList* g_slist_last (GSList *list);
661 guint g_slist_length (GSList *list);
662 void g_slist_foreach (GSList *list,
665 gpointer g_slist_nth_data (GSList *list,
668 #define g_slist_next(slist) ((slist) ? (((GSList *)(slist))->next) : NULL)
672 GListAllocator* g_list_allocator_new (void);
673 void g_list_allocator_free (GListAllocator* allocator);
674 GListAllocator* g_slist_set_allocator (GListAllocator* allocator);
675 GListAllocator* g_list_set_allocator (GListAllocator* allocator);
680 GHashTable* g_hash_table_new (GHashFunc hash_func,
681 GCompareFunc key_compare_func);
682 void g_hash_table_destroy (GHashTable *hash_table);
683 void g_hash_table_insert (GHashTable *hash_table,
686 void g_hash_table_remove (GHashTable *hash_table,
688 gpointer g_hash_table_lookup (GHashTable *hash_table,
690 gboolean g_hash_table_lookup_extended(GHashTable *hash_table,
691 gconstpointer lookup_key,
694 void g_hash_table_freeze (GHashTable *hash_table);
695 void g_hash_table_thaw (GHashTable *hash_table);
696 void g_hash_table_foreach (GHashTable *hash_table,
699 gint g_hash_table_size (GHashTable *hash_table);
704 GCache* g_cache_new (GCacheNewFunc value_new_func,
705 GCacheDestroyFunc value_destroy_func,
706 GCacheDupFunc key_dup_func,
707 GCacheDestroyFunc key_destroy_func,
708 GHashFunc hash_key_func,
709 GHashFunc hash_value_func,
710 GCompareFunc key_compare_func);
711 void g_cache_destroy (GCache *cache);
712 gpointer g_cache_insert (GCache *cache,
714 void g_cache_remove (GCache *cache,
716 void g_cache_key_foreach (GCache *cache,
719 void g_cache_value_foreach (GCache *cache,
724 /* Balanced binary trees
726 GTree* g_tree_new (GCompareFunc key_compare_func);
727 void g_tree_destroy (GTree *tree);
728 void g_tree_insert (GTree *tree,
731 void g_tree_remove (GTree *tree,
733 gpointer g_tree_lookup (GTree *tree,
735 void g_tree_traverse (GTree *tree,
736 GTraverseFunc traverse_func,
737 GTraverseType traverse_type,
739 gpointer g_tree_search (GTree *tree,
740 GSearchFunc search_func,
742 gint g_tree_height (GTree *tree);
743 gint g_tree_nnodes (GTree *tree);
747 /* N-way tree implementation
758 #define G_NODE_IS_ROOT(node) (((GNode*) (node))->parent == NULL && \
759 ((GNode*) (node))->prev == NULL && \
760 ((GNode*) (node))->next == NULL)
761 #define G_NODE_IS_LEAF(node) (((GNode*) (node))->children == NULL)
763 GNode* g_node_new (gpointer data);
764 void g_node_destroy (GNode *root);
765 void g_node_unlink (GNode *node);
766 void g_node_insert (GNode *parent,
769 void g_node_insert_before (GNode *parent,
772 void g_node_prepend (GNode *parent,
774 guint g_node_n_nodes (GNode *root,
775 GTraverseFlags flags);
776 GNode* g_node_get_root (GNode *node);
777 gboolean g_node_is_ancestor (GNode *node,
779 guint g_node_depth (GNode *node);
780 GNode* g_node_find (GNode *root,
782 GTraverseFlags flags,
785 /* traversal function, assumes that `node' is root
786 * (only traverses `node' and its subtree).
787 * this function is just a high level interface to
788 * low level traversal functions, optimized for speed.
790 void g_node_traverse (GNode *root,
792 GTraverseFlags flags,
794 GNodeTraverseFunc func,
797 /* return the maximum tree height starting with `node', this is an expensive
798 * operation, since we need to visit all nodes. this could be shortened by
799 * adding `guint height' to struct _GNode, but then again, this is not very
800 * often needed, and would make g_node_insert() more time consuming.
802 guint g_node_max_height (GNode *root);
804 void g_node_children_foreach (GNode *node,
805 GTraverseFlags flags,
806 GNodeForeachFunc func,
808 void g_node_reverse_children (GNode *node);
809 guint g_node_n_children (GNode *node);
810 GNode* g_node_nth_child (GNode *node,
812 GNode* g_node_last_child (GNode *node);
813 GNode* g_node_find_child (GNode *node,
814 GTraverseFlags flags,
816 gint g_node_child_position (GNode *node,
818 gint g_node_child_index (GNode *node,
821 GNode* g_node_first_sibling (GNode *node);
822 GNode* g_node_last_sibling (GNode *node);
824 #define g_node_prev_sibling(node) ((node) ? \
825 ((GNode*) (node))->prev : NULL)
826 #define g_node_next_sibling(node) ((node) ? \
827 ((GNode*) (node))->next : NULL)
828 #define g_node_first_child(node) ((node) ? \
829 ((GNode*) (node))->children : NULL)
830 #define g_node_append(parent, node) G_STMT_START { \
831 g_node_insert_before ((parent), \
843 #define g_malloc(size) (gpointer) MALLOC(size)
844 #define g_malloc0(size) (gpointer) CALLOC(char,size)
845 #define g_realloc(mem,size) (gpointer) REALLOC(mem,char,size)
846 #define g_free(mem) FREE(mem)
848 #else /* USE_DMALLOC */
850 gpointer g_malloc (gulong size);
851 gpointer g_malloc0 (gulong size);
852 gpointer g_realloc (gpointer mem,
854 void g_free (gpointer mem);
856 #endif /* USE_DMALLOC */
858 void g_mem_profile (void);
859 void g_mem_check (gpointer mem);
862 /* "g_mem_chunk_new" creates a new memory chunk.
863 * Memory chunks are used to allocate pieces of memory which are
864 * always the same size. Lists are a good example of such a data type.
865 * The memory chunk allocates and frees blocks of memory as needed.
866 * Just be sure to call "g_mem_chunk_free" and not "g_free" on data
867 * allocated in a mem chunk. ("g_free" will most likely cause a seg
868 * fault...somewhere).
870 * Oh yeah, GMemChunk is an opaque data type. (You don't really
871 * want to know what's going on inside do you?)
874 /* ALLOC_ONLY MemChunk's can only allocate memory. The free operation
875 * is interpreted as a no op. ALLOC_ONLY MemChunk's save 4 bytes per
876 * atom. (They are also useful for lists which use MemChunk to allocate
877 * memory but are also part of the MemChunk implementation).
878 * ALLOC_AND_FREE MemChunk's can allocate and free memory.
881 #define G_ALLOC_ONLY 1
882 #define G_ALLOC_AND_FREE 2
884 GMemChunk* g_mem_chunk_new (gchar *name,
888 void g_mem_chunk_destroy (GMemChunk *mem_chunk);
889 gpointer g_mem_chunk_alloc (GMemChunk *mem_chunk);
890 void g_mem_chunk_free (GMemChunk *mem_chunk,
892 void g_mem_chunk_clean (GMemChunk *mem_chunk);
893 void g_mem_chunk_reset (GMemChunk *mem_chunk);
894 void g_mem_chunk_print (GMemChunk *mem_chunk);
895 void g_mem_chunk_info (void);
897 /* Ah yes...we have a "g_blow_chunks" function.
898 * "g_blow_chunks" simply compresses all the chunks. This operation
899 * consists of freeing every memory area that should be freed (but
900 * which we haven't gotten around to doing yet). And, no,
901 * "g_blow_chunks" doesn't follow the naming scheme, but it is a
902 * much better name than "g_mem_chunk_clean_all" or something
905 void g_blow_chunks (void);
910 GTimer* g_timer_new (void);
911 void g_timer_destroy (GTimer *timer);
912 void g_timer_start (GTimer *timer);
913 void g_timer_stop (GTimer *timer);
914 void g_timer_reset (GTimer *timer);
915 gdouble g_timer_elapsed (GTimer *timer,
916 gulong *microseconds);
921 void g_error (const gchar *format, ...) G_GNUC_PRINTF (1, 2);
922 void g_warning (const gchar *format, ...) G_GNUC_PRINTF (1, 2);
923 void g_message (const gchar *format, ...) G_GNUC_PRINTF (1, 2);
924 void g_print (const gchar *format, ...) G_GNUC_PRINTF (1, 2);
927 /* String utility functions
929 #define G_STR_DELIMITERS "_-|> <."
930 void g_strdelimit (gchar *string,
931 const gchar *delimiters,
932 gchar new_delimiter);
933 gchar* g_strdup (const gchar *str);
934 gchar* g_strconcat (const gchar *string1,
935 ...); /* NULL terminated */
936 gdouble g_strtod (const gchar *nptr,
938 gchar* g_strerror (gint errnum);
939 gchar* g_strsignal (gint signum);
940 gint g_strcasecmp (const gchar *s1,
942 void g_strdown (gchar *string);
943 void g_strup (gchar *string);
944 void g_strreverse (gchar *string);
947 /* Retrive static info
949 gchar* g_get_user_name (void);
950 gchar* g_get_real_name (void);
951 gchar* g_get_home_dir (void);
952 gchar* g_get_tmp_dir (void);
953 gchar* g_get_prgname (void);
954 void g_set_prgname (const gchar *prgname);
957 /* Miscellaneous utility functions
959 guint g_parse_debug_string (const gchar *string,
962 gint g_snprintf (gchar *string,
965 ...) G_GNUC_PRINTF (3, 4);
966 gchar* g_basename (const gchar *file_name);
967 gchar* g_dirname (const gchar *file_name);
969 gchar* g_getcwd (void);
973 /* We make the assumption that if memmove isn't available, then
974 * bcopy will do the job. This isn't safe everywhere. (bcopy can't
975 * necessarily handle overlapping copies) */
977 #define g_memmove memmove
979 #define g_memmove(a,b,c) bcopy(b,a,c)
984 GErrorFunc g_set_error_handler (GErrorFunc func);
985 GWarningFunc g_set_warning_handler (GWarningFunc func);
986 GPrintFunc g_set_message_handler (GPrintFunc func);
987 GPrintFunc g_set_print_handler (GPrintFunc func);
989 void g_debug (const gchar *progname);
990 void g_attach_process (const gchar *progname,
992 void g_stack_trace (const gchar *progname,
999 GStringChunk* g_string_chunk_new (gint size);
1000 void g_string_chunk_free (GStringChunk *chunk);
1001 gchar* g_string_chunk_insert (GStringChunk *chunk,
1002 const gchar *string);
1003 gchar* g_string_chunk_insert_const (GStringChunk *chunk,
1004 const gchar *string);
1008 GString* g_string_new (const gchar *init);
1009 GString* g_string_sized_new (guint dfl_size);
1010 void g_string_free (GString *string,
1012 GString* g_string_assign (GString *lval,
1014 GString* g_string_truncate (GString *string,
1016 GString* g_string_append (GString *string,
1018 GString* g_string_append_c (GString *string,
1020 GString* g_string_prepend (GString *string,
1022 GString* g_string_prepend_c (GString *string,
1024 GString* g_string_insert (GString *string,
1027 GString* g_string_insert_c (GString *string,
1030 GString* g_string_erase (GString *string,
1033 GString* g_string_down (GString *string);
1034 GString* g_string_up (GString *string);
1035 void g_string_sprintf (GString *string,
1036 const gchar *format,
1037 ...) G_GNUC_PRINTF (2, 3);
1038 void g_string_sprintfa (GString *string,
1039 const gchar *format,
1040 ...) G_GNUC_PRINTF (2, 3);
1044 #define g_array_length(array,type) \
1045 (((array)->len)/sizeof(type))
1046 #define g_array_append_val(array,type,val) \
1047 g_rarray_append (array, (gpointer) &val, sizeof (type))
1048 #define g_array_append_vals(array,type,vals,nvals) \
1049 g_rarray_append (array, (gpointer) vals, sizeof (type) * nvals)
1050 #define g_array_prepend_val(array,type,val) \
1051 g_rarray_prepend (array, (gpointer) &val, sizeof (type))
1052 #define g_array_prepend_vals(array,type,vals,nvals) \
1053 g_rarray_prepend (array, (gpointer) vals, sizeof (type) * nvals)
1054 #define g_array_truncate(array,type,length) \
1055 g_rarray_truncate (array, length, sizeof (type))
1056 #define g_array_index(array,type,index) \
1057 ((type*) array->data)[index]
1059 GArray* g_array_new (gint zero_terminated);
1060 void g_array_free (GArray *array,
1062 GArray* g_rarray_append (GArray *array,
1065 GArray* g_rarray_prepend (GArray *array,
1068 GArray* g_rarray_truncate (GArray *array,
1072 /* Resizable pointer array. This interface is much less complicated
1073 * than the above. Add appends appends a pointer. Remove fills any
1074 * cleared spot and shortens the array.
1077 #define g_ptr_array_index(array,index) (array->pdata)[index]
1079 GPtrArray* g_ptr_array_new (void);
1080 void g_ptr_array_free (GPtrArray *array,
1082 void g_ptr_array_set_size (GPtrArray *array,
1084 void g_ptr_array_remove_index (GPtrArray *array,
1086 gboolean g_ptr_array_remove (GPtrArray *array,
1088 void g_ptr_array_add (GPtrArray *array,
1091 /* Byte arrays, an array of guint8. Implemented as a GArray,
1095 GByteArray* g_byte_array_new (void);
1096 void g_byte_array_free (GByteArray *array,
1099 GByteArray* g_byte_array_append (GByteArray *array,
1103 GByteArray* g_byte_array_prepend (GByteArray *array,
1107 GByteArray* g_byte_array_truncate (GByteArray *array,
1113 gint g_str_equal (gconstpointer v,
1115 guint g_str_hash (gconstpointer v);
1117 gint g_int_equal (gconstpointer v,
1119 guint g_int_hash (gconstpointer v);
1121 /* This "hash" function will just return the key's adress as an
1122 * unsigned integer. Useful for hashing on plain adresses or
1123 * simple integer values.
1125 guint g_direct_hash (gconstpointer v);
1126 gint g_direct_equal (gconstpointer v,
1130 /* Quarks (string<->id association)
1132 GQuark g_quark_try_string (const gchar *string);
1133 GQuark g_quark_from_static_string (const gchar *string);
1134 GQuark g_quark_from_string (const gchar *string);
1135 gchar* g_quark_to_string (GQuark quark);
1137 /* Location Associated Data
1139 void g_dataset_destroy (gconstpointer dataset_location);
1140 gpointer g_dataset_id_get_data (gconstpointer dataset_location,
1142 void g_dataset_id_set_data_full (gconstpointer dataset_location,
1145 GDestroyNotify destroy_func);
1146 void g_dataset_id_set_destroy (gconstpointer dataset_location,
1148 GDestroyNotify destroy_func);
1150 #define g_dataset_id_set_data(l,k,d) G_STMT_START{g_dataset_id_set_data_full((l),(k),(d),NULL);}G_STMT_END
1151 #define g_dataset_id_remove_data(l,k) G_STMT_START{g_dataset_id_set_data((l),(k),NULL);}G_STMT_END
1152 #define g_dataset_get_data(l,k) (g_dataset_id_get_data((l),g_quark_try_string(k)))
1153 #define g_dataset_set_data_full(l,k,d,f) G_STMT_START{g_dataset_id_set_data_full((l),g_quark_from_string(k),(d),(f));}G_STMT_END
1154 #define g_dataset_set_destroy(l,k,f) G_STMT_START{g_dataset_id_set_destroy((l),g_quark_from_string(k),(f));}G_STMT_END
1155 #define g_dataset_set_data(l,k,d) G_STMT_START{g_dataset_set_data_full((l),(k),(d),NULL);}G_STMT_END
1156 #define g_dataset_remove_data(l,k) G_STMT_START{g_dataset_set_data((l),(k),NULL);}G_STMT_END
1159 /* GScanner: Flexible lexical scanner for general purpose.
1162 /* Character sets */
1163 #define G_CSET_A_2_Z "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1164 #define G_CSET_a_2_z "abcdefghijklmnopqrstuvwxyz"
1165 #define G_CSET_LATINC "\300\301\302\303\304\305\306"\
1166 "\307\310\311\312\313\314\315\316\317\320"\
1167 "\321\322\323\324\325\326"\
1168 "\330\331\332\333\334\335\336"
1169 #define G_CSET_LATINS "\337\340\341\342\343\344\345\346"\
1170 "\347\350\351\352\353\354\355\356\357\360"\
1171 "\361\362\363\364\365\366"\
1172 "\370\371\372\373\374\375\376\377"
1179 G_ERR_UNEXP_EOF_IN_STRING,
1180 G_ERR_UNEXP_EOF_IN_COMMENT,
1181 G_ERR_NON_DIGIT_IN_CONST,
1184 G_ERR_FLOAT_MALFORMED
1192 G_TOKEN_LEFT_PAREN = '(',
1193 G_TOKEN_RIGHT_PAREN = ')',
1194 G_TOKEN_LEFT_CURLY = '{',
1195 G_TOKEN_RIGHT_CURLY = '}',
1196 G_TOKEN_LEFT_BRACE = '[',
1197 G_TOKEN_RIGHT_BRACE = ']',
1198 G_TOKEN_EQUAL_SIGN = '=',
1199 G_TOKEN_COMMA = ',',
1215 G_TOKEN_IDENTIFIER_NULL,
1217 G_TOKEN_COMMENT_SINGLE,
1218 G_TOKEN_COMMENT_MULTI,
1225 gchar *v_identifier;
1237 struct _GScannerConfig
1241 gchar *cset_skip_characters; /* default: " \t\n" */
1242 gchar *cset_identifier_first;
1243 gchar *cset_identifier_nth;
1244 gchar *cpair_comment_single; /* default: "#\n" */
1246 /* Should symbol lookup work case sensitive?
1248 guint case_sensitive : 1;
1250 /* Boolean values to be adjusted "on the fly"
1251 * to configure scanning behaviour.
1253 guint skip_comment_multi : 1; /* C like comment */
1254 guint skip_comment_single : 1; /* single line comment */
1255 guint scan_comment_multi : 1; /* scan multi line comments? */
1256 guint scan_identifier : 1;
1257 guint scan_identifier_1char : 1;
1258 guint scan_identifier_NULL : 1;
1259 guint scan_symbols : 1;
1260 guint scan_binary : 1;
1261 guint scan_octal : 1;
1262 guint scan_float : 1;
1263 guint scan_hex : 1; /* `0x0ff0' */
1264 guint scan_hex_dollar : 1; /* `$0ff0' */
1265 guint scan_string_sq : 1; /* string: 'anything' */
1266 guint scan_string_dq : 1; /* string: "\\-escapes!\n" */
1267 guint numbers_2_int : 1; /* bin, octal, hex => int */
1268 guint int_2_float : 1; /* int => G_TOKEN_FLOAT? */
1269 guint identifier_2_string : 1;
1270 guint char_2_token : 1; /* return G_TOKEN_CHAR? */
1271 guint symbol_2_token : 1;
1272 guint scope_0_fallback : 1; /* try scope 0 on lookups? */
1279 guint max_parse_errors;
1281 /* g_scanner_error() increments this field */
1284 /* name of input stream, featured by the default message handler */
1285 const gchar *input_name;
1287 /* data pointer for derived structures */
1288 gpointer derived_data;
1290 /* link into the scanner configuration */
1291 GScannerConfig *config;
1293 /* fields filled in after g_scanner_get_next_token() */
1299 /* fields filled in after g_scanner_peek_next_token() */
1300 GTokenType next_token;
1303 guint next_position;
1305 /* to be considered private */
1306 GHashTable *symbol_table;
1313 /* handler function for _warn and _error */
1314 GScannerMsgFunc msg_handler;
1317 GScanner* g_scanner_new (GScannerConfig *config_templ);
1318 void g_scanner_destroy (GScanner *scanner);
1319 void g_scanner_input_file (GScanner *scanner,
1321 void g_scanner_input_text (GScanner *scanner,
1324 GTokenType g_scanner_get_next_token (GScanner *scanner);
1325 GTokenType g_scanner_peek_next_token (GScanner *scanner);
1326 GTokenType g_scanner_cur_token (GScanner *scanner);
1327 GValue g_scanner_cur_value (GScanner *scanner);
1328 guint g_scanner_cur_line (GScanner *scanner);
1329 guint g_scanner_cur_position (GScanner *scanner);
1330 gboolean g_scanner_eof (GScanner *scanner);
1331 guint g_scanner_set_scope (GScanner *scanner,
1333 void g_scanner_scope_add_symbol (GScanner *scanner,
1335 const gchar *symbol,
1337 void g_scanner_scope_remove_symbol (GScanner *scanner,
1339 const gchar *symbol);
1340 gpointer g_scanner_scope_lookup_symbol (GScanner *scanner,
1342 const gchar *symbol);
1343 void g_scanner_scope_foreach_symbol (GScanner *scanner,
1346 gpointer func_data);
1347 gpointer g_scanner_lookup_symbol (GScanner *scanner,
1348 const gchar *symbol);
1349 void g_scanner_freeze_symbol_table (GScanner *scanner);
1350 void g_scanner_thaw_symbol_table (GScanner *scanner);
1351 void g_scanner_unexp_token (GScanner *scanner,
1352 GTokenType expected_token,
1353 const gchar *identifier_spec,
1354 const gchar *symbol_spec,
1355 const gchar *symbol_name,
1356 const gchar *message,
1358 void g_scanner_error (GScanner *scanner,
1359 const gchar *format,
1360 ...) G_GNUC_PRINTF (2,3);
1361 void g_scanner_warn (GScanner *scanner,
1362 const gchar *format,
1363 ...) G_GNUC_PRINTF (2,3);
1364 gint g_scanner_stat_mode (const gchar *filename);
1365 /* keep downward source compatibility */
1366 #define g_scanner_add_symbol( scanner, symbol, value ) G_STMT_START { \
1367 g_scanner_scope_add_symbol ((scanner), 0, (symbol), (value)); \
1369 #define g_scanner_remove_symbol( scanner, symbol ) G_STMT_START { \
1370 g_scanner_scope_remove_symbol ((scanner), 0, (symbol)); \
1372 #define g_scanner_foreach_symbol( scanner, func, data ) G_STMT_START { \
1373 g_scanner_scope_foreach_symbol ((scanner), 0, (func), (data)); \
1383 GCompletionFunc func;
1389 GCompletion* g_completion_new (GCompletionFunc func);
1390 void g_completion_add_items (GCompletion* cmp,
1392 void g_completion_remove_items (GCompletion* cmp,
1394 void g_completion_clear_items (GCompletion* cmp);
1395 GList* g_completion_complete (GCompletion* cmp,
1397 gchar** new_prefix);
1398 void g_completion_free (GCompletion* cmp);
1401 /* GRelation: Indexed Relations. Imagine a really simple table in a
1402 * database. Relations are not ordered. This data type is meant for
1403 * maintaining a N-way mapping.
1405 * g_relation_new() creates a relation with FIELDS fields
1407 * g_relation_destroy() frees all resources
1408 * g_tuples_destroy() frees the result of g_relation_select()
1410 * g_relation_index() indexes relation FIELD with the provided
1411 * equality and hash functions. this must be done before any
1412 * calls to insert are made.
1414 * g_relation_insert() inserts a new tuple. you are expected to
1415 * provide the right number of fields.
1417 * g_relation_delete() deletes all relations with KEY in FIELD
1418 * g_relation_select() returns ...
1419 * g_relation_count() counts ...
1422 GRelation* g_relation_new (gint fields);
1423 void g_relation_destroy (GRelation *relation);
1424 void g_relation_index (GRelation *relation,
1426 GHashFunc hash_func,
1427 GCompareFunc key_compare_func);
1428 void g_relation_insert (GRelation *relation,
1430 gint g_relation_delete (GRelation *relation,
1433 GTuples* g_relation_select (GRelation *relation,
1436 gint g_relation_count (GRelation *relation,
1439 gboolean g_relation_exists (GRelation *relation,
1441 void g_relation_print (GRelation *relation);
1443 void g_tuples_destroy (GTuples *tuples);
1444 gpointer g_tuples_index (GTuples *tuples,
1451 extern const guint glib_major_version;
1452 extern const guint glib_minor_version;
1453 extern const guint glib_micro_version;
1457 #endif /* __cplusplus */
1460 #endif /* __G_LIB_H__ */