2007-05-05 Aaron Bockover <abockover@novell.com>
[mono.git] / eglib / src / glib.h
1 #ifndef __GLIB_H
2 #define __GLIB_H
3
4 #include <stdarg.h>
5 #include <stdlib.h>
6 #include <string.h>
7 #include <stdio.h>
8 #include <stddef.h>
9 #include <ctype.h>
10
11 #ifdef _MSC_VER
12 #pragma include_alias(<eglib-config.h>, <eglib-config.hw>)
13 #else
14 #include <stdint.h>
15 #endif
16
17 #include <eglib-config.h>
18
19 #ifndef offsetof
20 #   define offsetof(s_name,n_name) (size_t)(char *)&(((s_name*)0)->m_name)
21 #endif
22
23 #define __EGLIB_X11 1
24
25 /*
26  * Basic data types
27  */
28 typedef int            gboolean;
29 typedef int            gint;
30 typedef unsigned int   guint;
31 typedef short          gshort;
32 typedef unsigned short gushort;
33 typedef long           glong;
34 typedef unsigned long  gulong;
35 typedef void *         gpointer;
36 typedef const void *   gconstpointer;
37 typedef char           gchar;
38 typedef unsigned char  guchar;
39
40 #ifdef _MSC_VER
41 typedef __int8                          gint8;
42 typedef unsigned __int8         guint8;
43 typedef __int16                         gint16;
44 typedef unsigned __int16        guint16;
45 typedef __int32                         gint32;
46 typedef unsigned __int32        guint32;
47 typedef __int64                         gint64;
48 typedef unsigned __int64        guint64;
49 typedef float                           gfloat;
50 typedef double                          gdouble;
51 typedef unsigned __int16        gunichar2;
52 #else
53 /* Types defined in terms of the stdint.h */
54 typedef int8_t         gint8;
55 typedef uint8_t        guint8;
56 typedef int16_t        gint16;
57 typedef uint16_t       guint16;
58 typedef int32_t        gint32;
59 typedef uint32_t       guint32;
60 typedef int64_t        gint64;
61 typedef uint64_t       guint64;
62 typedef float          gfloat;
63 typedef double         gdouble;
64 typedef uint16_t       gunichar2;
65 #endif
66
67 /*
68  * Macros
69  */
70 #define G_N_ELEMENTS(s)      (sizeof(s) / sizeof ((s) [0]))
71
72 #define FALSE                0
73 #define TRUE                 1
74
75 #define G_MAXINT32           INT32_MAX
76 #define G_MININT32           INT32_MIN
77 #define G_MININT64           INT64_MIN
78 #define G_MAXINT64           INT64_MAX
79
80 #define G_LITTLE_ENDIAN 1234
81 #define G_BIG_ENDIAN    4321
82 #define G_STMT_START    do 
83 #define G_STMT_END      while (0)
84
85 #define G_USEC_PER_SEC  1000000
86
87 #define ABS(a)         ((a) > 0 ? (a) : -(a))
88
89 #define G_STRUCT_OFFSET(p_type,field) offsetof(p_type,field)
90
91 #define EGLIB_STRINGIFY(x) #x
92 #define EGLIB_TOSTRING(x) EGLIB_STRINGIFY(x)
93 #define G_STRLOC __FILE__ ":" EGLIB_TOSTRING(__LINE__) ":"
94
95 #define G_BEGIN_DECLS
96 #define G_END_DECLS
97  
98 #define G_CONST_RETURN const
99
100 /*
101  * Allocation
102  */
103 #define g_new(type,size)        ((type *) malloc (sizeof (type) * (size)))
104 #define g_new0(type,size)       ((type *) calloc (sizeof (type), (size)))
105 #define g_newa(type,size)       ((type *) alloca (sizeof (type) * (size)))
106 #define g_realloc(obj,size)     realloc((obj), (size))
107 #define g_malloc(x)             malloc(x)
108 #define g_try_malloc(x)         malloc(x)
109 #define g_try_realloc(obj,size) realloc((obj),(size))
110 #define g_malloc0(x)            calloc(1,x)
111 #define g_memmove(dest,src,len) memmove (dest, src, len)
112 #define g_renew(struct_type, mem, n_structs) realloc (mem, sizeof (struct_type) * n_structs)
113 #define g_alloca(size)          alloca (size)
114 #define g_free                  free
115
116 gpointer g_memdup (gconstpointer mem, guint byte_size);
117 gchar   *g_strdup (const gchar *str);
118
119 typedef struct {
120         gpointer (*malloc)      (gsize    n_bytes);
121         gpointer (*realloc)     (gpointer mem, gsize n_bytes);
122         void     (*free)        (gpointer mem);
123         gpointer (*calloc)      (gsize    n_blocks, gsize n_block_bytes);
124         gpointer (*try_malloc)  (gsize    n_bytes);
125         gpointer (*try_realloc) (gpointer mem, gsize n_bytes);
126 } GMemVTable;
127
128 #define g_mem_set_vtable(x)
129 /*
130  * Misc.
131  */
132 #define g_atexit(func)  ((void) atexit (func))
133
134 const gchar *    g_getenv(const gchar *variable);
135 gboolean         g_setenv(const gchar *variable, const gchar *value, gboolean overwrite);
136 void             g_unsetenv(const gchar *variable);
137
138 /*
139  * Precondition macros
140  */
141 #define g_return_if_fail(x)  G_STMT_START { if (!(x)) { printf ("%s:%d: assertion '%s' failed", __FILE__, __LINE__, #x); return; } } G_STMT_END
142 #define g_return_val_if_fail(x,e)  G_STMT_START { if (!(x)) { printf ("%s:%d: assertion '%s' failed", __FILE__, __LINE__, #x); return (e); } } G_STMT_END
143
144 /*
145  * Hashtables
146  */
147 typedef struct _GHashTable GHashTable;
148 typedef void     (*GFunc)          (gpointer data, gpointer user_data);
149 typedef gint     (*GCompareFunc)   (gconstpointer a, gconstpointer b);
150 typedef gint     (*GCompareDataFunc) (gconstpointer a, gconstpointer b, gpointer user_data);
151 typedef void     (*GHFunc)         (gpointer key, gpointer value, gpointer user_data);
152 typedef gboolean (*GHRFunc)        (gpointer key, gpointer value, gpointer user_data);
153 typedef void     (*GDestroyNotify) (gpointer data);
154 typedef guint    (*GHashFunc)      (gconstpointer key);
155 typedef gboolean (*GEqualFunc)     (gconstpointer a, gconstpointer b);
156
157 GHashTable     *g_hash_table_new             (GHashFunc hash_func, GEqualFunc key_equal_func);
158 GHashTable     *g_hash_table_new_full        (GHashFunc hash_func, GEqualFunc key_equal_func,
159                                               GDestroyNotify key_destroy_func, GDestroyNotify value_destroy_func);
160 void            g_hash_table_insert_replace  (GHashTable *hash, gpointer key, gpointer value, gboolean replace);
161 guint           g_hash_table_size            (GHashTable *hash);
162 gpointer        g_hash_table_lookup          (GHashTable *hash, gconstpointer key);
163 gboolean        g_hash_table_lookup_extended (GHashTable *hash, gconstpointer key, gpointer *orig_key, gpointer *value);
164 void            g_hash_table_foreach         (GHashTable *hash, GHFunc func, gpointer user_data);
165 gpointer        g_hash_table_find            (GHashTable *hash, GHRFunc predicate, gpointer user_data);
166 gboolean        g_hash_table_remove          (GHashTable *hash, gconstpointer key);
167 guint           g_hash_table_foreach_remove  (GHashTable *hash, GHRFunc func, gpointer user_data);
168 void            g_hash_table_destroy         (GHashTable *hash);
169
170 guint           g_spaced_primes_closest      (guint x);
171
172 #define g_hash_table_insert(h,k,v)    g_hash_table_insert_replace ((h),(k),(v),FALSE)
173 #define g_hash_table_replace(h,k,v)   g_hash_table_insert_replace ((h),(k),(v),TRUE)
174
175 gboolean g_direct_equal (gconstpointer v1, gconstpointer v2);
176 guint    g_direct_hash  (gconstpointer v1);
177 gboolean g_int_equal    (gconstpointer v1, gconstpointer v2);
178 guint    g_int_hash     (gconstpointer v1);
179 gboolean g_str_equal    (gconstpointer v1, gconstpointer v2);
180 guint    g_str_hash     (gconstpointer v1);
181
182 #define  g_assert(x)     G_STMT_START { if (!(x)) g_error ("* Assertion at %s:%d, condition `%s' not met\n", __FILE__, __LINE__, #x);  } G_STMT_END
183 #define  g_assert_not_reached() G_STMT_START { g_error ("* Assertion: should not be reached at %s:%d\n", __FILE__, __LINE__); } G_STMT_END
184
185 /*
186  * Errors
187  */
188 typedef struct {
189         /* In the real glib, this is a GQuark, but we dont use/need that */
190         gpointer domain;
191         gint     code;
192         gchar   *message;
193 } GError;
194
195 void    g_error_free (GError *error);
196 GError *g_error_new  (gpointer domain, gint code, const char *format, ...);
197 void    g_set_error  (GError **err, gpointer domain, gint code, const gchar *format, ...);
198 void    g_propagate_error (GError **dest, GError *src);
199
200 /*
201  * Strings utility
202  */
203 gchar       *g_strdup_printf  (const gchar *format, ...);
204 gchar       *g_strdup_vprintf (const gchar *format, va_list args);
205 gchar       *g_strndup        (const gchar *str, gsize n);
206 const gchar *g_strerror       (gint errnum);
207 gchar       *g_strndup        (const gchar *str, gsize n);
208 void         g_strfreev       (gchar **str_array);
209 gchar       *g_strconcat      (const gchar *first, ...);
210 gchar      **g_strsplit       (const gchar *string, const gchar *delimiter, gint max_tokens);
211 gchar       *g_strreverse     (gchar *str);
212 gboolean     g_str_has_prefix (const gchar *str, const gchar *prefix);
213 gboolean     g_str_has_suffix (const gchar *str, const gchar *suffix);
214 guint        g_strv_length    (gchar **str_array);
215 gchar       *g_strjoin        (const gchar *separator, ...);
216 gchar       *g_strjoinv       (const gchar *separator, gchar **str_array);
217 gchar       *g_strchug        (gchar *str);
218 gchar       *g_strchomp       (gchar *str);
219 void         g_strdown        (gchar *string);
220
221 gchar       *g_strdelimit     (gchar *string, const gchar *delimiters, gchar new_delimiter);
222 gchar       *g_strescape      (const gchar *source, const gchar *exceptions);
223
224 gchar       *g_filename_to_uri   (const gchar *filename, const gchar *hostname, GError **error);
225 gchar       *g_filename_from_uri (const gchar *uri, gchar **hostname, GError **error);
226
227 gint         g_printf          (gchar const *format, ...);
228 gint         g_fprintf         (FILE *file, gchar const *format, ...);
229 gint         g_sprintf         (gchar *string, gchar const *format, ...);
230 gint         g_snprintf        (gchar *string, gulong n, gchar const *format, ...);
231 #define g_vprintf vprintf
232 #define g_vfprintf vfprintf
233 #define g_vsprintf vsprintf
234 #define g_vsnprintf vsnprintf
235 #define g_vasprintf vasprintf
236
237 gsize       g_strlcpy          (gchar *dest, const gchar *src, gsize dest_size);
238
239 gchar   g_ascii_tolower      (gchar c);
240 gchar  *g_ascii_strdown      (const gchar *str, gssize len);
241 gint    g_ascii_strncasecmp  (const gchar *s1, const gchar *s2, gsize n);
242 gint    g_ascii_xdigit_value (gchar c);
243 #define g_ascii_isspace(c)   (isspace (c) != 0)
244 #define g_ascii_isalpha(c)   (isalpha (c) != 0)
245 #define g_ascii_isprint(c)   (isprint (c) != 0)
246 #define g_ascii_isxdigit(c)  (isxdigit (c) != 0)
247
248 /* FIXME: g_strcasecmp supports utf8 unicode stuff */
249 #ifdef _MSC_VER
250 #define g_strcasecmp stricmp
251 #define g_ascii_strcasecmp stricmp
252 #define g_strncasecmp strnicmp
253 #define g_strstrip(a) g_strchug (g_strchomp (a))
254 #else
255 #define g_strcasecmp strcasecmp
256 #define g_ascii_strcasecmp strcasecmp
257 #define g_strncasecmp strncasecmp
258 #define g_strstrip(a) g_strchug (g_strchomp (a))
259 #endif
260
261
262 #define G_STR_DELIMITERS "_-|> <."
263
264 /*
265  * String type
266  */
267 typedef struct {
268         char *str;
269         gsize len;
270         gsize allocated_len;
271 } GString;
272
273 GString     *g_string_new           (const gchar *init);
274 GString     *g_string_new_len       (const gchar *init, gssize len);
275 GString     *g_string_sized_new     (gsize default_size);
276 gchar       *g_string_free          (GString *string, gboolean free_segment);
277 GString     *g_string_append        (GString *string, const gchar *val);
278 void         g_string_printf        (GString *string, const gchar *format, ...);
279 void         g_string_append_printf (GString *string, const gchar *format, ...);
280 GString     *g_string_append_c      (GString *string, gchar c);
281 GString     *g_string_append        (GString *string, const gchar *val);
282 GString     *g_string_append_len    (GString *string, const gchar *val, gssize len);
283 GString     *g_string_truncate      (GString *string, gsize len);
284 GString     *g_string_prepend       (GString *string, const gchar *val);
285
286 #define g_string_sprintfa g_string_append_printf
287
288 /*
289  * Lists
290  */
291 typedef struct _GSList GSList;
292 struct _GSList {
293         gpointer data;
294         GSList *next;
295 };
296
297 GSList *g_slist_alloc         (void);
298 GSList *g_slist_append        (GSList        *list,
299                                gpointer       data);
300 GSList *g_slist_prepend       (GSList        *list,
301                                gpointer       data);
302 void    g_slist_free          (GSList        *list);
303 void    g_slist_free_1        (GSList        *list);
304 GSList *g_slist_copy          (GSList        *list);
305 GSList *g_slist_concat        (GSList        *list1,
306                                GSList        *list2);
307 void    g_slist_foreach       (GSList        *list,
308                                GFunc          func,
309                                gpointer       user_data);
310 GSList *g_slist_last          (GSList        *list);
311 GSList *g_slist_find          (GSList        *list,
312                                gconstpointer  data);
313 GSList *g_slist_remove        (GSList        *list,
314                                gconstpointer  data);
315 GSList *g_slist_remove_all    (GSList        *list,
316                                gconstpointer  data);
317 GSList *g_slist_reverse       (GSList        *list);
318 guint   g_slist_length        (GSList        *list);
319 GSList *g_slist_remove_link   (GSList        *list,
320                                GSList        *link);
321 GSList *g_slist_delete_link   (GSList        *list,
322                                GSList        *link);
323 GSList *g_slist_insert_sorted (GSList        *list,
324                                gpointer       data,
325                                GCompareFunc   func);
326 GSList *g_slist_insert_before (GSList        *list,
327                                GSList        *sibling,
328                                gpointer       data);
329 GSList *g_slist_sort          (GSList        *list,
330                                GCompareFunc   func);
331 #define g_slist_next(slist) ((slist) ? (((GSList *) (slist))->next) : NULL)
332
333 typedef struct _GList GList;
334 struct _GList {
335   gpointer data;
336   GList *next;
337   GList *prev;
338 };
339
340 #define g_list_next(list) ((list) ? (((GList *) (list))->next) : NULL)
341
342 GList *g_list_alloc         (void);
343 GList *g_list_append        (GList         *list,
344                              gpointer       data);
345 GList *g_list_prepend       (GList         *list,
346                              gpointer       data);
347 void   g_list_free          (GList         *list);
348 void   g_list_free_1        (GList         *list);
349 GList *g_list_copy          (GList         *list);
350 guint  g_list_length        (GList         *list);
351 gint   g_list_index         (GList         *list,
352                              gconstpointer  data);
353 GList *g_list_nth           (GList         *list,
354                              guint          n);
355 gpointer g_list_nth_data      (GList         *list,
356                              guint          n);
357 GList *g_list_last          (GList         *list);
358 GList *g_list_concat        (GList         *list1,
359                              GList         *list2);
360 void   g_list_foreach       (GList         *list,
361                              GFunc          func,
362                              gpointer       user_data);
363 GList *g_list_first         (GList         *list);
364 GList *g_list_find          (GList         *list,
365                              gconstpointer  data);
366 GList *g_list_remove        (GList         *list,
367                              gconstpointer  data);
368 GList *g_list_reverse       (GList         *list);
369 GList *g_list_remove_link   (GList         *list,
370                              GList         *link);
371 GList *g_list_delete_link   (GList         *list,
372                              GList         *link);
373 GList *g_list_insert_sorted (GList         *list,
374                              gpointer       data,
375                              GCompareFunc   func);
376 GList *g_list_insert_before (GList         *list,
377                              GList         *sibling,
378                              gpointer       data);
379 GList *g_list_sort          (GList         *sort,
380                              GCompareFunc   func);
381
382 /*
383  * Array
384  */
385
386 typedef struct _GArray GArray;
387 struct _GArray {
388         gchar *data;
389         gint len;
390 };
391
392 GArray *g_array_new               (gboolean zero_terminated, gboolean clear_, guint element_size);
393 gchar*  g_array_free              (GArray *array, gboolean free_segment);
394 GArray *g_array_append_vals       (GArray *array, gconstpointer data, guint len);
395 GArray* g_array_insert_vals       (GArray *array, guint index_, gconstpointer data, guint len);
396 GArray* g_array_remove_index      (GArray *array, guint index_);
397
398 #define g_array_append_val(a,v)   (g_array_append_vals((a),&(v),1))
399 #define g_array_insert_val(a,i,v) (g_array_insert_vals((a),(i),&(v),1))
400 #define g_array_index(a,t,i)      *(t*)(((a)->data) + sizeof(t) * (i))
401
402 /*
403  * Pointer Array
404  */
405
406 typedef struct _GPtrArray GPtrArray;
407 struct _GPtrArray {
408         gpointer *pdata;
409         guint len;
410 };
411
412 GPtrArray *g_ptr_array_new                (void);
413 GPtrArray *g_ptr_array_sized_new          (guint reserved_size);
414 void       g_ptr_array_add                (GPtrArray *array, gpointer data);
415 gboolean   g_ptr_array_remove             (GPtrArray *array, gpointer data);
416 gpointer   g_ptr_array_remove_index       (GPtrArray *array, guint index);
417 gboolean   g_ptr_array_remove_fast        (GPtrArray *array, gpointer data);
418 gpointer   g_ptr_array_remove_index_fast  (GPtrArray *array, gpointer data);
419 void       g_ptr_array_sort               (GPtrArray *array, GCompareFunc compare_func);
420 void       g_ptr_array_sort_with_data     (GPtrArray *array, GCompareDataFunc compare_func, gpointer user_data);
421 void       g_ptr_array_set_size           (GPtrArray *array, gint length);
422 gpointer  *g_ptr_array_free               (GPtrArray *array, gboolean free_seg);
423 void       g_ptr_array_foreach            (GPtrArray *array, GFunc func, gpointer user_data);
424 #define    g_ptr_array_index(array,index) (array)->pdata[(index)]
425
426 /*
427  * Queues
428  */
429 typedef struct {
430         GList *head;
431         GList *tail;
432         guint length;
433 } GQueue;
434
435 gpointer g_queue_pop_head  (GQueue   *queue);
436 void     g_queue_push_head (GQueue   *queue,
437                             gpointer  data);
438 gboolean g_queue_is_empty  (GQueue   *queue);
439 GQueue  *g_queue_new       (void);
440 void     g_queue_free      (GQueue   *queue);
441
442 /*
443  * Messages
444  */
445 #ifndef G_LOG_DOMAIN
446 #define G_LOG_DOMAIN ((gchar*) 0)
447 #endif
448
449 typedef enum {
450         G_LOG_FLAG_RECURSION          = 1 << 0,
451         G_LOG_FLAG_FATAL              = 1 << 1,
452         
453         G_LOG_LEVEL_ERROR             = 1 << 2,
454         G_LOG_LEVEL_CRITICAL          = 1 << 3,
455         G_LOG_LEVEL_WARNING           = 1 << 4,
456         G_LOG_LEVEL_MESSAGE           = 1 << 5,
457         G_LOG_LEVEL_INFO              = 1 << 6,
458         G_LOG_LEVEL_DEBUG             = 1 << 7,
459         
460         G_LOG_LEVEL_MASK              = ~(G_LOG_FLAG_RECURSION | G_LOG_FLAG_FATAL)
461 } GLogLevelFlags;
462
463 void           g_print                (const gchar *format, ...);
464 GLogLevelFlags g_log_set_always_fatal (GLogLevelFlags fatal_mask);
465 GLogLevelFlags g_log_set_fatal_mask   (const gchar *log_domain, GLogLevelFlags fatal_mask);
466 void           g_logv                 (const gchar *log_domain, GLogLevelFlags log_level, const gchar *format, va_list args);
467 void           g_log                  (const gchar *log_domain, GLogLevelFlags log_level, const gchar *format, ...);
468
469 #define g_error(format, ...)    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR, format, __VA_ARGS__)
470 #define g_critical(format, ...) g_log (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL, format, __VA_ARGS__)
471 #define g_warning(format, ...)  g_log (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING, format, __VA_ARGS__)
472 #define g_message(format, ...)  g_log (G_LOG_DOMAIN, G_LOG_LEVEL_MESSAGE, format, __VA_ARGS__)
473 #define g_debug(format, ...)    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, format, __VA_ARGS__)
474
475 #define g_log_set_handler(a,b,c,d)
476 #define g_printerr(format, ...) fprintf (stderr, format, __VA_ARGS__)
477 /*
478  * Conversions
479  */
480
481 gpointer g_convert_error_quark(void);
482
483
484 /*
485  * Unicode Manipulation: most of this is not used by Mono by default, it is
486  * only used if the old collation code is activated, so this is only the
487  * bare minimum to build.
488  */
489 typedef guint32 gunichar;
490
491 typedef enum {
492         G_UNICODE_LOWERCASE_LETTER,
493 } GUnicodeType;
494
495 gunichar       g_unichar_tolower (gunichar c);
496 GUnicodeType   g_unichar_type    (gunichar c);
497
498 #ifndef MAX
499 #define MAX(a,b) (((a)>(b)) ? (a) : (b))
500 #endif
501
502 #ifndef MIN
503 #define MIN(a,b) (((a)<(b)) ? (a) : (b))
504 #endif
505
506 /* FIXME: Implement these two for gcc */
507 #define G_LIKELY(x) (x)
508 #define G_UNLIKELY(x) (x)
509
510 /*
511  * Unicode conversion
512  */
513
514 #define G_CONVERT_ERROR g_convert_error_quark()
515
516 typedef enum {
517         G_CONVERT_ERROR_NO_CONVERSION,
518         G_CONVERT_ERROR_ILLEGAL_SEQUENCE,
519         G_CONVERT_ERROR_FAILED,
520         G_CONVERT_ERROR_PARTIAL_INPUT,
521         G_CONVERT_ERROR_BAD_URI,
522         G_CONVERT_ERROR_NOT_ABSOLUTE_PATH
523 } GConvertError;
524
525 gunichar2 *g_utf8_to_utf16 (const gchar *str, glong len, glong *items_read, glong     *items_written, GError **error);
526 gchar     *g_utf16_to_utf8 (const gunichar2 *str, glong len, glong *items_read, glong     *items_written, GError **error);
527
528 #define u8to16(str) g_utf8_to_utf16(str, (glong)strlen(str), NULL, NULL, NULL)
529
530 #ifdef G_OS_WIN32
531 #define u16to8(str) g_utf16_to_utf8(str, (glong)wcslen(str), NULL, NULL, NULL)
532 #else
533 #define u16to8(str) g_utf16_to_utf8(str, (glong)strlen(str), NULL, NULL, NULL)
534 #endif
535
536 /*
537  * Path
538  */
539 gchar  *g_build_path           (const gchar *separator, const gchar *first_element, ...);
540 #define g_build_filename(x, ...) g_build_path(G_DIR_SEPARATOR_S, x, __VA_ARGS__)
541 gchar  *g_path_get_dirname     (const gchar *filename);
542 gchar  *g_path_get_basename    (const char *filename);
543 gchar  *g_find_program_in_path (const gchar *program);
544 gchar  *g_get_current_dir      (void);
545 gboolean g_path_is_absolute    (const char *filename);
546
547 const gchar *g_get_home_dir    (void);
548 const gchar *g_get_tmp_dir     (void);
549 const gchar *g_get_user_name   (void);
550 gchar *g_get_prgname           (void);
551 void  g_set_prgname            (const gchar *prgname);
552
553 /*
554  * Shell
555  */
556
557 gboolean  g_shell_parse_argv (const gchar *command_line, gint *argcp, gchar ***argvp, GError **error);
558 gchar    *g_shell_unquote    (const gchar *quoted_string, GError **error);
559 gchar    *g_shell_quote      (const gchar *unquoted_string);
560
561 /*
562  * Spawn
563  */
564 typedef enum {
565         G_SPAWN_LEAVE_DESCRIPTORS_OPEN = 1,
566         G_SPAWN_DO_NOT_REAP_CHILD      = 1 << 1,
567         G_SPAWN_SEARCH_PATH            = 1 << 2,
568         G_SPAWN_STDOUT_TO_DEV_NULL     = 1 << 3,
569         G_SPAWN_STDERR_TO_DEV_NULL     = 1 << 4,
570         G_SPAWN_CHILD_INHERITS_STDIN   = 1 << 5,
571         G_SPAWN_FILE_AND_ARGV_ZERO     = 1 << 6
572 } GSpawnFlags;
573
574 typedef pid_t GPid;
575
576 typedef void (*GSpawnChildSetupFunc) (gpointer user_data);
577
578 gboolean g_spawn_command_line_sync (const gchar *command_line, gchar **standard_output, gchar **standard_error, gint *exit_status, GError **error);
579 gboolean g_spawn_async_with_pipes  (const gchar *working_directory, gchar **argv, gchar **envp, GSpawnFlags flags, GSpawnChildSetupFunc child_setup,
580                                 gpointer user_data, GPid *child_pid, gint *standard_input, gint *standard_output, gint *standard_error, GError **error);
581
582
583 /*
584  * Timer
585  */
586 typedef struct _GTimer GTimer;
587
588 GTimer *g_timer_new (void);
589 void g_timer_destroy (GTimer *timer);
590 gdouble g_timer_elapsed (GTimer *timer, gulong *microseconds);
591 void g_timer_stop (GTimer *timer);
592 void g_timer_start (GTimer *timer);
593
594 /*
595  * Date and time
596  */
597 typedef struct {
598         glong tv_sec;
599         glong tv_usec;
600 } GTimeVal;
601
602 void g_get_current_time (GTimeVal *result);
603
604 /*
605  * File
606  */
607
608 typedef enum {
609         G_FILE_ERROR_EXIST,
610         G_FILE_ERROR_ISDIR,
611         G_FILE_ERROR_ACCES,
612         G_FILE_ERROR_NAMETOOLONG,
613         G_FILE_ERROR_NOENT,
614         G_FILE_ERROR_NOTDIR,
615         G_FILE_ERROR_NXIO,
616         G_FILE_ERROR_NODEV,
617         G_FILE_ERROR_ROFS,
618         G_FILE_ERROR_TXTBSY,
619         G_FILE_ERROR_FAULT,
620         G_FILE_ERROR_LOOP,
621         G_FILE_ERROR_NOSPC,
622         G_FILE_ERROR_NOMEM,
623         G_FILE_ERROR_MFILE,
624         G_FILE_ERROR_NFILE,
625         G_FILE_ERROR_BADF,
626         G_FILE_ERROR_INVAL,
627         G_FILE_ERROR_PIPE,
628         G_FILE_ERROR_AGAIN,
629         G_FILE_ERROR_INTR,
630         G_FILE_ERROR_IO,
631         G_FILE_ERROR_PERM,
632         G_FILE_ERROR_NOSYS,
633         G_FILE_ERROR_FAILED
634 } GFileError;
635
636 typedef enum {
637         G_FILE_TEST_IS_REGULAR = 1 << 0,
638         G_FILE_TEST_IS_SYMLINK = 1 << 1,
639         G_FILE_TEST_IS_DIR = 1 << 2,
640         G_FILE_TEST_IS_EXECUTABLE = 1 << 3,
641         G_FILE_TEST_EXISTS = 1 << 4
642 } GFileTest;
643
644
645 gboolean   g_file_get_contents (const gchar *filename, gchar **contents, gsize *length, GError **error);
646 GFileError g_file_error_from_errno (gint err_no);
647 gint       g_file_open_tmp (const gchar *tmpl, gchar **name_used, GError **error);
648 gboolean   g_file_test (const gchar *filename, GFileTest test);
649
650 /*
651  * Pattern matching
652  */
653 typedef struct _GPatternSpec GPatternSpec;
654 GPatternSpec * g_pattern_spec_new (const gchar *pattern);
655 void           g_pattern_spec_free (GPatternSpec *pspec);
656 gboolean       g_pattern_match_string (GPatternSpec *pspec, const gchar *string);
657
658 /*
659  * Directory
660  */
661 typedef struct _GDir GDir;
662 GDir        *g_dir_open (const gchar *path, guint flags, GError **error);
663 const gchar *g_dir_read_name (GDir *dir);
664 void         g_dir_rewind (GDir *dir);
665 void         g_dir_close (GDir *dir);
666
667 /*
668  * GMarkup
669  */
670 typedef struct _GMarkupParseContext GMarkupParseContext;
671
672 typedef enum
673 {
674         G_MARKUP_DO_NOT_USE_THIS_UNSUPPORTED_FLAG = 1 << 0,
675         G_MARKUP_TREAT_CDATA_AS_TEXT              = 1 << 1
676 } GMarkupParseFlags;
677
678 typedef struct {
679         void (*start_element)  (GMarkupParseContext *context,
680                                 const gchar *element_name,
681                                 const gchar **attribute_names,
682                                 const gchar **attribute_values,
683                                 gpointer user_data,
684                                 GError **error);
685
686         void (*end_element)    (GMarkupParseContext *context,
687                                 const gchar         *element_name,
688                                 gpointer             user_data,
689                                 GError             **error);
690         
691         void (*text)           (GMarkupParseContext *context,
692                                 const gchar         *text,
693                                 gsize                text_len,  
694                                 gpointer             user_data,
695                                 GError             **error);
696         
697         void (*passthrough)    (GMarkupParseContext *context,
698                                 const gchar         *passthrough_text,
699                                 gsize                text_len,  
700                                 gpointer             user_data,
701                                 GError             **error);
702         void (*error)          (GMarkupParseContext *context,
703                                 GError              *error,
704                                 gpointer             user_data);
705 } GMarkupParser;
706
707 GMarkupParseContext *g_markup_parse_context_new   (const GMarkupParser *parser,
708                                                    GMarkupParseFlags flags,
709                                                    gpointer user_data,
710                                                    GDestroyNotify user_data_dnotify);
711 void                 g_markup_parse_context_free  (GMarkupParseContext *context);
712 gboolean             g_markup_parse_context_parse (GMarkupParseContext *context,
713                                                    const gchar *text, gssize text_len,
714                                                    GError **error);
715 gboolean         g_markup_parse_context_end_parse (GMarkupParseContext *context,
716                                                    GError **error);
717
718 /*
719  * Character set conversion
720  */
721 gboolean  g_get_charset        (G_CONST_RETURN char **charset);
722 gchar    *g_locale_to_utf8     (const gchar *opsysstring, gssize len,
723                                 gsize *bytes_read, gsize *bytes_written,
724                                 GError **error);
725 gchar    *g_locale_from_utf8   (const gchar *utf8string, gssize len, gsize *bytes_read,
726                                 gsize *bytes_written, GError **error);
727 gchar    *g_filename_from_utf8 (const gchar *utf8string, gssize len, gsize *bytes_read,
728                                 gsize *bytes_written, GError **error);
729 gchar    *g_convert            (const gchar *str, gssize len,
730                                 const gchar *to_codeset, const gchar *from_codeset,
731                                 gsize *bytes_read, gsize *bytes_written, GError **error);
732 gboolean  g_utf8_validate      (const gchar *str, gssize max_len, const gchar **end);
733
734 /*
735  * Empty thread functions, not used by eglib
736  */
737 #define g_thread_supported()   TRUE
738 #define g_thread_init(x)       G_STMT_START { if (x != NULL) { g_error ("No vtable supported in g_thread_init"); } } G_STMT_END
739
740 #define GUINT16_SWAP_LE_BE(x) ((guint16) (((guint16) x) >> 8) | ((((guint16)(x)) & 0xff) << 8))
741 #define GUINT32_SWAP_LE_BE(x) ((guint32) \
742                                ( (((guint32) (x)) << 24)| \
743                                  ((((guint32) (x)) & 0xff0000) >> 8) | \
744                                  ((((guint32) (x)) & 0xff00) << 8) | \
745                                  (((guint32) (x)) >> 24)) )
746  
747 #define GUINT64_SWAP_LE_BE(x) ((guint64) (((guint64)(GUINT32_SWAP_LE_BE(((guint64)x) & 0xffffffff))) << 32) | \
748                                GUINT32_SWAP_LE_BE(((guint64)x) >> 32))
749
750                                   
751  
752 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
753 #   define GUINT32_TO_LE(x) (x)
754 #   define GUINT64_TO_LE(x) (x)
755 #   define GUINT16_TO_LE(x) (x)
756 #else
757 #   define GUINT32_TO_LE(x) GUINT32_SWAP_LE_BE(x)
758 #   define GUINT64_TO_LE(x) GUINT64_SWAP_LE_BE(x)
759 #   define GUINT16_TO_LE(x) GUINT16_SWAP_LE_BE(x)
760 #endif
761
762 #define GUINT32_FROM_LE(x)  (GUINT32_TO_LE (x))
763 #define GUINT64_FROM_LE(x)  (GUINT64_TO_LE (x))
764 #define GUINT16_FROM_LE(x)  (GUINT16_TO_LE (x))
765
766 #define _EGLIB_MAJOR  2
767 #define _EGLIB_MIDDLE 4
768 #define _EGLIB_MINOR  0
769  
770 #define GLIB_CHECK_VERSION(a,b,c) ((a < _EGLIB_MAJOR) || (a == _EGLIB_MAJOR && (b < _EGLIB_MIDDLE || (b == _EGLIB_MIDDLE && c <= _EGLIB_MINOR))))
771  
772 #endif
773
774