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 gint32 g_time;
453 typedef guint32 GQuark;
455 typedef struct _GList GList;
456 typedef struct _GSList GSList;
457 typedef struct _GHashTable GHashTable;
458 typedef struct _GCache GCache;
459 typedef struct _GTree GTree;
460 typedef struct _GTimer GTimer;
461 typedef struct _GMemChunk GMemChunk;
462 typedef struct _GListAllocator GListAllocator;
463 typedef struct _GStringChunk GStringChunk;
464 typedef struct _GString GString;
465 typedef struct _GArray GArray;
466 typedef struct _GPtrArray GPtrArray;
467 typedef struct _GByteArray GByteArray;
468 typedef struct _GDebugKey GDebugKey;
469 typedef struct _GScannerConfig GScannerConfig;
470 typedef struct _GScanner GScanner;
471 typedef union _GValue GValue;
472 typedef struct _GCompletion GCompletion;
473 typedef struct _GRelation GRelation;
474 typedef struct _GTuples GTuples;
477 typedef void (*GFunc) (gpointer data,
479 typedef void (*GHFunc) (gpointer key,
482 typedef gpointer (*GCacheNewFunc) (gpointer key);
483 typedef gpointer (*GCacheDupFunc) (gpointer value);
484 typedef void (*GCacheDestroyFunc) (gpointer value);
485 typedef gint (*GTraverseFunc) (gpointer key,
488 typedef gint (*GSearchFunc) (gpointer key,
490 typedef void (*GErrorFunc) (gchar *str);
491 typedef void (*GWarningFunc) (gchar *str);
492 typedef void (*GPrintFunc) (gchar *str);
493 typedef void (*GScannerMsgFunc) (GScanner *scanner,
496 typedef void (*GDestroyNotify) (gpointer data);
498 typedef guint (*GHashFunc) (gconstpointer key);
499 typedef gint (*GCompareFunc) (gconstpointer a,
501 typedef gchar* (*GCompletionFunc) (gpointer);
551 struct _GCache { gint dummy; };
552 struct _GTree { gint dummy; };
553 struct _GTimer { gint dummy; };
554 struct _GMemChunk { gint dummy; };
555 struct _GListAllocator { gint dummy; };
556 struct _GStringChunk { gint dummy; };
565 /* Doubly linked lists
567 GList* g_list_alloc (void);
568 void g_list_free (GList *list);
569 void g_list_free_1 (GList *list);
570 GList* g_list_append (GList *list,
572 GList* g_list_prepend (GList *list,
574 GList* g_list_insert (GList *list,
577 GList* g_list_insert_sorted (GList *list,
580 GList* g_list_concat (GList *list1,
582 GList* g_list_remove (GList *list,
584 GList* g_list_remove_link (GList *list,
586 GList* g_list_reverse (GList *list);
587 GList* g_list_nth (GList *list,
589 GList* g_list_find (GList *list,
591 GList* g_list_find_custom (GList *list,
594 gint g_list_position (GList *list,
596 gint g_list_index (GList *list,
598 GList* g_list_last (GList *list);
599 GList* g_list_first (GList *list);
600 guint g_list_length (GList *list);
601 void g_list_foreach (GList *list,
604 gpointer g_list_nth_data (GList *list,
607 #define g_list_previous(list) ((list) ? (((GList *)(list))->prev) : NULL)
608 #define g_list_next(list) ((list) ? (((GList *)(list))->next) : NULL)
610 /* Singly linked lists
612 GSList* g_slist_alloc (void);
613 void g_slist_free (GSList *list);
614 void g_slist_free_1 (GSList *list);
615 GSList* g_slist_append (GSList *list,
617 GSList* g_slist_prepend (GSList *list,
619 GSList* g_slist_insert (GSList *list,
622 GSList* g_slist_insert_sorted (GSList *list,
625 GSList* g_slist_concat (GSList *list1,
627 GSList* g_slist_remove (GSList *list,
629 GSList* g_slist_remove_link (GSList *list,
631 GSList* g_slist_reverse (GSList *list);
632 GSList* g_slist_nth (GSList *list,
634 GSList* g_slist_find (GSList *list,
636 GSList* g_slist_find_custom (GSList *list,
639 gint g_slist_position (GSList *list,
641 gint g_slist_index (GSList *list,
643 GSList* g_slist_last (GSList *list);
644 guint g_slist_length (GSList *list);
645 void g_slist_foreach (GSList *list,
648 gpointer g_slist_nth_data (GSList *list,
651 #define g_slist_next(slist) ((slist) ? (((GSList *)(slist))->next) : NULL)
655 GListAllocator* g_list_allocator_new (void);
656 void g_list_allocator_free (GListAllocator* allocator);
657 GListAllocator* g_slist_set_allocator (GListAllocator* allocator);
658 GListAllocator* g_list_set_allocator (GListAllocator* allocator);
663 GHashTable* g_hash_table_new (GHashFunc hash_func,
664 GCompareFunc key_compare_func);
665 void g_hash_table_destroy (GHashTable *hash_table);
666 void g_hash_table_insert (GHashTable *hash_table,
669 void g_hash_table_remove (GHashTable *hash_table,
671 gpointer g_hash_table_lookup (GHashTable *hash_table,
673 gboolean g_hash_table_lookup_extended(GHashTable *hash_table,
674 gconstpointer lookup_key,
677 void g_hash_table_freeze (GHashTable *hash_table);
678 void g_hash_table_thaw (GHashTable *hash_table);
679 void g_hash_table_foreach (GHashTable *hash_table,
682 gint g_hash_table_size (GHashTable *hash_table);
687 GCache* g_cache_new (GCacheNewFunc value_new_func,
688 GCacheDestroyFunc value_destroy_func,
689 GCacheDupFunc key_dup_func,
690 GCacheDestroyFunc key_destroy_func,
691 GHashFunc hash_key_func,
692 GHashFunc hash_value_func,
693 GCompareFunc key_compare_func);
694 void g_cache_destroy (GCache *cache);
695 gpointer g_cache_insert (GCache *cache,
697 void g_cache_remove (GCache *cache,
699 void g_cache_key_foreach (GCache *cache,
702 void g_cache_value_foreach (GCache *cache,
709 GTree* g_tree_new (GCompareFunc key_compare_func);
710 void g_tree_destroy (GTree *tree);
711 void g_tree_insert (GTree *tree,
714 void g_tree_remove (GTree *tree,
716 gpointer g_tree_lookup (GTree *tree,
718 void g_tree_traverse (GTree *tree,
719 GTraverseFunc traverse_func,
720 GTraverseType traverse_type,
722 gpointer g_tree_search (GTree *tree,
723 GSearchFunc search_func,
725 gint g_tree_height (GTree *tree);
726 gint g_tree_nnodes (GTree *tree);
734 #define g_malloc(size) (gpointer) MALLOC(size)
735 #define g_malloc0(size) (gpointer) CALLOC(char,size)
736 #define g_realloc(mem,size) (gpointer) REALLOC(mem,char,size)
737 #define g_free(mem) FREE(mem)
739 #else /* USE_DMALLOC */
741 gpointer g_malloc (gulong size);
742 gpointer g_malloc0 (gulong size);
743 gpointer g_realloc (gpointer mem,
745 void g_free (gpointer mem);
747 #endif /* USE_DMALLOC */
749 void g_mem_profile (void);
750 void g_mem_check (gpointer mem);
753 /* "g_mem_chunk_new" creates a new memory chunk.
754 * Memory chunks are used to allocate pieces of memory which are
755 * always the same size. Lists are a good example of such a data type.
756 * The memory chunk allocates and frees blocks of memory as needed.
757 * Just be sure to call "g_mem_chunk_free" and not "g_free" on data
758 * allocated in a mem chunk. ("g_free" will most likely cause a seg
759 * fault...somewhere).
761 * Oh yeah, GMemChunk is an opaque data type. (You don't really
762 * want to know what's going on inside do you?)
765 /* ALLOC_ONLY MemChunk's can only allocate memory. The free operation
766 * is interpreted as a no op. ALLOC_ONLY MemChunk's save 4 bytes per
767 * atom. (They are also useful for lists which use MemChunk to allocate
768 * memory but are also part of the MemChunk implementation).
769 * ALLOC_AND_FREE MemChunk's can allocate and free memory.
772 #define G_ALLOC_ONLY 1
773 #define G_ALLOC_AND_FREE 2
775 GMemChunk* g_mem_chunk_new (gchar *name,
779 void g_mem_chunk_destroy (GMemChunk *mem_chunk);
780 gpointer g_mem_chunk_alloc (GMemChunk *mem_chunk);
781 void g_mem_chunk_free (GMemChunk *mem_chunk,
783 void g_mem_chunk_clean (GMemChunk *mem_chunk);
784 void g_mem_chunk_reset (GMemChunk *mem_chunk);
785 void g_mem_chunk_print (GMemChunk *mem_chunk);
786 void g_mem_chunk_info (void);
788 /* Ah yes...we have a "g_blow_chunks" function.
789 * "g_blow_chunks" simply compresses all the chunks. This operation
790 * consists of freeing every memory area that should be freed (but
791 * which we haven't gotten around to doing yet). And, no,
792 * "g_blow_chunks" doesn't follow the naming scheme, but it is a
793 * much better name than "g_mem_chunk_clean_all" or something
796 void g_blow_chunks (void);
801 GTimer* g_timer_new (void);
802 void g_timer_destroy (GTimer *timer);
803 void g_timer_start (GTimer *timer);
804 void g_timer_stop (GTimer *timer);
805 void g_timer_reset (GTimer *timer);
806 gdouble g_timer_elapsed (GTimer *timer,
807 gulong *microseconds);
812 void g_error (const gchar *format, ...) G_GNUC_PRINTF (1, 2);
813 void g_warning (const gchar *format, ...) G_GNUC_PRINTF (1, 2);
814 void g_message (const gchar *format, ...) G_GNUC_PRINTF (1, 2);
815 void g_print (const gchar *format, ...) G_GNUC_PRINTF (1, 2);
818 /* String utility functions
820 #define G_STR_DELIMITERS "_-|> <."
821 void g_strdelimit (gchar *string,
822 const gchar *delimiters,
823 gchar new_delimiter);
824 gchar* g_strdup (const gchar *str);
825 gchar* g_strconcat (const gchar *string1,
826 ...); /* NULL terminated */
827 gdouble g_strtod (const gchar *nptr,
829 gchar* g_strerror (gint errnum);
830 gchar* g_strsignal (gint signum);
831 gint g_strcasecmp (const gchar *s1,
833 void g_strdown (gchar *string);
834 void g_strup (gchar *string);
835 void g_strreverse (gchar *string);
838 /* Retrive static info
840 gchar* g_get_user_name (void);
841 gchar* g_get_real_name (void);
842 gchar* g_get_home_dir (void);
843 gchar* g_get_tmp_dir (void);
844 gchar* g_get_prgname (void);
845 void g_set_prgname (const gchar *prgname);
848 /* Miscellaneous utility functions
850 guint g_parse_debug_string (const gchar *string,
853 gint g_snprintf (gchar *string,
856 ...) G_GNUC_PRINTF (3, 4);
857 gchar* g_basename (const gchar *file_name);
858 gchar* g_getcwd (void);
859 gchar* g_dirname (const gchar *file_name);
862 /* We make the assumption that if memmove isn't available, then
863 * bcopy will do the job. This isn't safe everywhere. (bcopy can't
864 * necessarily handle overlapping copies) */
866 #define g_memmove memmove
868 #define g_memmove(a,b,c) bcopy(b,a,c)
873 GErrorFunc g_set_error_handler (GErrorFunc func);
874 GWarningFunc g_set_warning_handler (GWarningFunc func);
875 GPrintFunc g_set_message_handler (GPrintFunc func);
876 GPrintFunc g_set_print_handler (GPrintFunc func);
878 void g_debug (const gchar *progname);
879 void g_attach_process (const gchar *progname,
881 void g_stack_trace (const gchar *progname,
888 GStringChunk* g_string_chunk_new (gint size);
889 void g_string_chunk_free (GStringChunk *chunk);
890 gchar* g_string_chunk_insert (GStringChunk *chunk,
891 const gchar *string);
892 gchar* g_string_chunk_insert_const (GStringChunk *chunk,
893 const gchar *string);
897 GString* g_string_new (const gchar *init);
898 GString* g_string_sized_new (guint dfl_size);
899 void g_string_free (GString *string,
901 GString* g_string_assign (GString *lval,
903 GString* g_string_truncate (GString *string,
905 GString* g_string_append (GString *string,
907 GString* g_string_append_c (GString *string,
909 GString* g_string_prepend (GString *string,
911 GString* g_string_prepend_c (GString *string,
913 GString* g_string_insert (GString *string,
916 GString* g_string_insert_c (GString *string,
919 GString* g_string_erase (GString *string,
922 GString* g_string_down (GString *string);
923 GString* g_string_up (GString *string);
924 void g_string_sprintf (GString *string,
926 ...) G_GNUC_PRINTF (2, 3);
927 void g_string_sprintfa (GString *string,
929 ...) G_GNUC_PRINTF (2, 3);
933 #define g_array_length(array,type) \
934 (((array)->len)/sizeof(type))
935 #define g_array_append_val(array,type,val) \
936 g_rarray_append (array, (gpointer) &val, sizeof (type))
937 #define g_array_append_vals(array,type,vals,nvals) \
938 g_rarray_append (array, (gpointer) vals, sizeof (type) * nvals)
939 #define g_array_prepend_val(array,type,val) \
940 g_rarray_prepend (array, (gpointer) &val, sizeof (type))
941 #define g_array_prepend_vals(array,type,vals,nvals) \
942 g_rarray_prepend (array, (gpointer) vals, sizeof (type) * nvals)
943 #define g_array_truncate(array,type,length) \
944 g_rarray_truncate (array, length, sizeof (type))
945 #define g_array_index(array,type,index) \
946 ((type*) array->data)[index]
948 GArray* g_array_new (gint zero_terminated);
949 void g_array_free (GArray *array,
951 GArray* g_rarray_append (GArray *array,
954 GArray* g_rarray_prepend (GArray *array,
957 GArray* g_rarray_truncate (GArray *array,
961 /* Resizable pointer array. This interface is much less complicated
962 * than the above. Add appends appends a pointer. Remove fills any
963 * cleared spot and shortens the array.
966 #define g_ptr_array_index(array,index) (array->pdata)[index]
968 GPtrArray* g_ptr_array_new (void);
969 void g_ptr_array_free (GPtrArray *array,
971 void g_ptr_array_set_size (GPtrArray *array,
973 void g_ptr_array_remove_index (GPtrArray *array,
975 gboolean g_ptr_array_remove (GPtrArray *array,
977 void g_ptr_array_add (GPtrArray *array,
980 /* Byte arrays, an array of guint8. Implemented as a GArray,
984 GByteArray* g_byte_array_new (void);
985 void g_byte_array_free (GByteArray *array,
988 GByteArray* g_byte_array_append (GByteArray *array,
992 GByteArray* g_byte_array_prepend (GByteArray *array,
996 GByteArray* g_byte_array_truncate (GByteArray *array,
1002 gint g_str_equal (gconstpointer v,
1004 guint g_str_hash (gconstpointer v);
1006 gint g_int_equal (gconstpointer v,
1008 guint g_int_hash (gconstpointer v);
1010 /* This "hash" function will just return the key's adress as an
1011 * unsigned integer. Useful for hashing on plain adresses or
1012 * simple integer values.
1014 guint g_direct_hash (gconstpointer v);
1015 gint g_direct_equal (gconstpointer v,
1019 /* Quarks (string<->id association)
1021 GQuark g_quark_try_string (const gchar *string);
1022 GQuark g_quark_from_static_string (const gchar *string);
1023 GQuark g_quark_from_string (const gchar *string);
1024 gchar* g_quark_to_string (GQuark quark);
1026 /* Location Associated Data
1028 void g_dataset_destroy (gconstpointer dataset_location);
1029 gpointer g_dataset_id_get_data (gconstpointer dataset_location,
1031 void g_dataset_id_set_data_full (gconstpointer dataset_location,
1034 GDestroyNotify destroy_func);
1035 void g_dataset_id_set_destroy (gconstpointer dataset_location,
1037 GDestroyNotify destroy_func);
1039 #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
1040 #define g_dataset_id_remove_data(l,k) G_STMT_START{g_dataset_id_set_data((l),(k),NULL);}G_STMT_END
1041 #define g_dataset_get_data(l,k) (g_dataset_id_get_data((l),g_quark_try_string(k)))
1042 #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
1043 #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
1044 #define g_dataset_set_data(l,k,d) G_STMT_START{g_dataset_set_data_full((l),(k),(d),NULL);}G_STMT_END
1045 #define g_dataset_remove_data(l,k) G_STMT_START{g_dataset_set_data((l),(k),NULL);}G_STMT_END
1048 /* GScanner: Flexible lexical scanner for general purpose.
1051 /* Character sets */
1052 #define G_CSET_A_2_Z "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1053 #define G_CSET_a_2_z "abcdefghijklmnopqrstuvwxyz"
1054 #define G_CSET_LATINC "\300\301\302\303\304\305\306"\
1055 "\307\310\311\312\313\314\315\316\317\320"\
1056 "\321\322\323\324\325\326"\
1057 "\330\331\332\333\334\335\336"
1058 #define G_CSET_LATINS "\337\340\341\342\343\344\345\346"\
1059 "\347\350\351\352\353\354\355\356\357\360"\
1060 "\361\362\363\364\365\366"\
1061 "\370\371\372\373\374\375\376\377"
1068 G_ERR_UNEXP_EOF_IN_STRING,
1069 G_ERR_UNEXP_EOF_IN_COMMENT,
1070 G_ERR_NON_DIGIT_IN_CONST,
1073 G_ERR_FLOAT_MALFORMED
1081 G_TOKEN_LEFT_PAREN = '(',
1082 G_TOKEN_RIGHT_PAREN = ')',
1083 G_TOKEN_LEFT_CURLY = '{',
1084 G_TOKEN_RIGHT_CURLY = '}',
1085 G_TOKEN_LEFT_BRACE = '[',
1086 G_TOKEN_RIGHT_BRACE = ']',
1087 G_TOKEN_EQUAL_SIGN = '=',
1088 G_TOKEN_COMMA = ',',
1104 G_TOKEN_IDENTIFIER_NULL,
1106 G_TOKEN_COMMENT_SINGLE,
1107 G_TOKEN_COMMENT_MULTI,
1114 gchar *v_identifier;
1126 struct _GScannerConfig
1130 gchar *cset_skip_characters; /* default: " \t\n" */
1131 gchar *cset_identifier_first;
1132 gchar *cset_identifier_nth;
1133 gchar *cpair_comment_single; /* default: "#\n" */
1135 /* Should symbol lookup work case sensitive?
1137 guint case_sensitive : 1;
1139 /* Boolean values to be adjusted "on the fly"
1140 * to configure scanning behaviour.
1142 guint skip_comment_multi : 1; /* C like comment */
1143 guint skip_comment_single : 1; /* single line comment */
1144 guint scan_comment_multi : 1; /* scan multi line comments? */
1145 guint scan_identifier : 1;
1146 guint scan_identifier_1char : 1;
1147 guint scan_identifier_NULL : 1;
1148 guint scan_symbols : 1;
1149 guint scan_binary : 1;
1150 guint scan_octal : 1;
1151 guint scan_float : 1;
1152 guint scan_hex : 1; /* `0x0ff0' */
1153 guint scan_hex_dollar : 1; /* `$0ff0' */
1154 guint scan_string_sq : 1; /* string: 'anything' */
1155 guint scan_string_dq : 1; /* string: "\\-escapes!\n" */
1156 guint numbers_2_int : 1; /* bin, octal, hex => int */
1157 guint int_2_float : 1; /* int => G_TOKEN_FLOAT? */
1158 guint identifier_2_string : 1;
1159 guint char_2_token : 1; /* return G_TOKEN_CHAR? */
1160 guint symbol_2_token : 1;
1161 guint scope_0_fallback : 1; /* try scope 0 on lookups? */
1168 guint max_parse_errors;
1170 /* g_scanner_error() increments this field */
1173 /* name of input stream, featured by the default message handler */
1174 const gchar *input_name;
1176 /* data pointer for derived structures */
1177 gpointer derived_data;
1179 /* link into the scanner configuration */
1180 GScannerConfig *config;
1182 /* fields filled in after g_scanner_get_next_token() */
1188 /* fields filled in after g_scanner_peek_next_token() */
1189 GTokenType next_token;
1192 guint next_position;
1194 /* to be considered private */
1195 GHashTable *symbol_table;
1202 /* handler function for _warn and _error */
1203 GScannerMsgFunc msg_handler;
1206 GScanner* g_scanner_new (GScannerConfig *config_templ);
1207 void g_scanner_destroy (GScanner *scanner);
1208 void g_scanner_input_file (GScanner *scanner,
1210 void g_scanner_input_text (GScanner *scanner,
1213 GTokenType g_scanner_get_next_token (GScanner *scanner);
1214 GTokenType g_scanner_peek_next_token (GScanner *scanner);
1215 GTokenType g_scanner_cur_token (GScanner *scanner);
1216 GValue g_scanner_cur_value (GScanner *scanner);
1217 guint g_scanner_cur_line (GScanner *scanner);
1218 guint g_scanner_cur_position (GScanner *scanner);
1219 gboolean g_scanner_eof (GScanner *scanner);
1220 guint g_scanner_set_scope (GScanner *scanner,
1222 void g_scanner_scope_add_symbol (GScanner *scanner,
1224 const gchar *symbol,
1226 void g_scanner_scope_remove_symbol (GScanner *scanner,
1228 const gchar *symbol);
1229 gpointer g_scanner_scope_lookup_symbol (GScanner *scanner,
1231 const gchar *symbol);
1232 void g_scanner_scope_foreach_symbol (GScanner *scanner,
1235 gpointer func_data);
1236 gpointer g_scanner_lookup_symbol (GScanner *scanner,
1237 const gchar *symbol);
1238 void g_scanner_freeze_symbol_table (GScanner *scanner);
1239 void g_scanner_thaw_symbol_table (GScanner *scanner);
1240 void g_scanner_unexp_token (GScanner *scanner,
1241 GTokenType expected_token,
1242 const gchar *identifier_spec,
1243 const gchar *symbol_spec,
1244 const gchar *symbol_name,
1245 const gchar *message,
1247 void g_scanner_error (GScanner *scanner,
1248 const gchar *format,
1249 ...) G_GNUC_PRINTF (2,3);
1250 void g_scanner_warn (GScanner *scanner,
1251 const gchar *format,
1252 ...) G_GNUC_PRINTF (2,3);
1253 gint g_scanner_stat_mode (const gchar *filename);
1254 /* keep downward source compatibility */
1255 #define g_scanner_add_symbol( scanner, symbol, value ) G_STMT_START { \
1256 g_scanner_scope_add_symbol ((scanner), 0, (symbol), (value)); \
1258 #define g_scanner_remove_symbol( scanner, symbol ) G_STMT_START { \
1259 g_scanner_scope_remove_symbol ((scanner), 0, (symbol)); \
1261 #define g_scanner_foreach_symbol( scanner, func, data ) G_STMT_START { \
1262 g_scanner_scope_foreach_symbol ((scanner), 0, (func), (data)); \
1272 GCompletionFunc func;
1278 GCompletion* g_completion_new (GCompletionFunc func);
1279 void g_completion_add_items (GCompletion* cmp,
1281 void g_completion_remove_items (GCompletion* cmp,
1283 void g_completion_clear_items (GCompletion* cmp);
1284 GList* g_completion_complete (GCompletion* cmp,
1286 gchar** new_prefix);
1287 void g_completion_free (GCompletion* cmp);
1290 /* GRelation: Indexed Relations. Imagine a really simple table in a
1291 * database. Relations are not ordered. This data type is meant for
1292 * maintaining a N-way mapping.
1294 * g_relation_new() creates a relation with FIELDS fields
1296 * g_relation_destroy() frees all resources
1297 * g_tuples_destroy() frees the result of g_relation_select()
1299 * g_relation_index() indexes relation FIELD with the provided
1300 * equality and hash functions. this must be done before any
1301 * calls to insert are made.
1303 * g_relation_insert() inserts a new tuple. you are expected to
1304 * provide the right number of fields.
1306 * g_relation_delete() deletes all relations with KEY in FIELD
1307 * g_relation_select() returns ...
1308 * g_relation_count() counts ...
1311 GRelation* g_relation_new (gint fields);
1312 void g_relation_destroy (GRelation *relation);
1313 void g_relation_index (GRelation *relation,
1315 GHashFunc hash_func,
1316 GCompareFunc key_compare_func);
1317 void g_relation_insert (GRelation *relation,
1319 gint g_relation_delete (GRelation *relation,
1322 GTuples* g_relation_select (GRelation *relation,
1325 gint g_relation_count (GRelation *relation,
1328 gboolean g_relation_exists (GRelation *relation,
1330 void g_relation_print (GRelation *relation);
1332 void g_tuples_destroy (GTuples *tuples);
1333 gpointer g_tuples_index (GTuples *tuples,
1340 extern const guint glib_major_version;
1341 extern const guint glib_minor_version;
1342 extern const guint glib_micro_version;
1346 #endif /* __cplusplus */
1349 #endif /* __G_LIB_H__ */