?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Copy all elements of the allocations[] array, including the last. (Pointed
[glib.git] / glib.h
bloba50f6d0f3e956fb9a7698fe18b38b7e5e7472cd2
1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3 *
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.
8 *
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.
13 *
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.
18 */
19 #ifndef __G_LIB_H__
20 #define __G_LIB_H__
21
22 /* system specific config file glibconfig.h provides definitions for
23 * the extrema of many of the standard types. These are:
24 *
25 * G_MINSHORT, G_MAXSHORT
26 * G_MININT, G_MAXINT
27 * G_MINLONG, G_MAXLONG
28 * G_MINFLOAT, G_MAXFLOAT
29 * G_MINDOUBLE, G_MAXDOUBLE
30 *
31 * It also provides the following typedefs:
32 *
33 * gint8, guint8
34 * gint16, guint16
35 * gint32, guint32
36 * gint64, guint64
37 *
38 * It defines the G_BYTE_ORDER symbol to one of G_*_ENDIAN (see later in
39 * this file).
40 *
41 * And it provides a way to store and retrieve a `gint' in/from a `gpointer'.
42 * This is useful to pass an integer instead of a pointer to a callback.
43 *
44 * GINT_TO_POINTER(i), GUINT_TO_POINTER(i)
45 * GPOINTER_TO_INT(p), GPOINTER_TO_UINT(p)
46 *
47 * Finally, it provide the following wrappers to STDC functions:
48 *
49 * g_ATEXIT
50 * To register hooks which are executed on exit().
51 * Usually a wrapper for STDC atexit.
52 *
53 * void *g_memmove(void *dest, const void *src, guint count);
54 * A wrapper for STDC memmove, or an implementation, if memmove doesn't
55 * exist. The prototype looks like the above, give or take a const,
56 * or size_t.
57 */
58 #include <glibconfig.h>
59
60 /* include varargs functions for assertment macros
61 */
62 #include <stdarg.h>
63
64 /* optionally feature DMALLOC memory allocation debugger
65 */
66 #ifdef USE_DMALLOC
67 #include "dmalloc.h"
68 #endif
69
70
71 #ifdef NATIVE_WIN32
72
73 /* On native Win32, directory separator is the backslash, and search path
74 * separator is the semicolon.
75 */
76 #define G_DIR_SEPARATOR '\\'
77 #define G_DIR_SEPARATOR_S "\\"
78 #define G_SEARCHPATH_SEPARATOR ';'
79 #define G_SEARCHPATH_SEPARATOR_S ";"
80
81 #else /* !NATIVE_WIN32 */
82
83 /* Unix */
84
85 #define G_DIR_SEPARATOR '/'
86 #define G_DIR_SEPARATOR_S "/"
87 #define G_SEARCHPATH_SEPARATOR ':'
88 #define G_SEARCHPATH_SEPARATOR_S ":"
89
90 #endif /* !NATIVE_WIN32 */
91
92 #ifdef __cplusplus
93 extern "C" {
94 #endif /* __cplusplus */
95
96
97 /* Provide definitions for some commonly used macros.
98 * Some of them are only provided if they haven't already
99 * been defined. It is assumed that if they are already
100 * defined then the current definition is correct.
101 */
102 #ifndef NULL
103 #define NULL ((void*) 0)
104 #endif
105
106 #ifndef FALSE
107 #define FALSE (0)
108 #endif
109
110 #ifndef TRUE
111 #define TRUE (!FALSE)
112 #endif
113
114 #undef MAX
115 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
116
117 #undef MIN
118 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
119
120 #undef ABS
121 #define ABS(a) (((a) < 0) ? -(a) : (a))
122
123 #undef CLAMP
124 #define CLAMP(x, low, high) (((x) > (high)) ? (high) : (((x) < (low)) ? (low) : (x)))
125
126
127 /* Define G_VA_COPY() to do the right thing for copying va_list variables.
128 * glibconfig.h may have already defined G_VA_COPY as va_copy or __va_copy.
129 */
130 #if !defined (G_VA_COPY)
131 # if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
132 # define G_VA_COPY(ap1, ap2) (*(ap1) = *(ap2))
133 # elif defined (G_VA_COPY_AS_ARRAY)
134 # define G_VA_COPY(ap1, ap2) g_memmove ((ap1), (ap2), sizeof (va_list))
135 # else /* va_list is a pointer */
136 # define G_VA_COPY(ap1, ap2) ((ap1) = (ap2))
137 # endif /* va_list is a pointer */
138 #endif /* !G_VA_COPY */
139
140
141 /* Provide convenience macros for handling structure
142 * fields through their offsets.
143 */
144 #define G_STRUCT_OFFSET(struct_type, member) \
145 ((gulong) ((gchar*) &((struct_type*) 0)->member))
146 #define G_STRUCT_MEMBER_P(struct_p, struct_offset) \
147 ((gpointer) ((gchar*) (struct_p) + (gulong) (struct_offset)))
148 #define G_STRUCT_MEMBER(member_type, struct_p, struct_offset) \
149 (*(member_type*) G_STRUCT_MEMBER_P ((struct_p), (struct_offset)))
150
151
152 /* inlining hassle. for compilers that don't allow the `inline' keyword,
153 * mostly because of strict ANSI C compliance or dumbness, we try to fall
154 * back to either `__inline__' or `__inline'.
155 * we define G_CAN_INLINE, if the compiler seems to be actually
156 * *capable* to do function inlining, in which case inline function bodys
157 * do make sense. we also define G_INLINE_FUNC to properly export the
158 * function prototypes if no inlining can be performed.
159 * we special case most of the stuff, so inline functions can have a normal
160 * implementation by defining G_INLINE_FUNC to extern and G_CAN_INLINE to 1.
161 */
162 #ifndef G_INLINE_FUNC
163 # define G_CAN_INLINE 1
164 #endif
165 #ifdef G_HAVE_INLINE
166 # if defined (__GNUC__) && defined (__STRICT_ANSI__)
167 # undef inline
168 # define inline __inline__
169 # endif
170 #else /* !G_HAVE_INLINE */
171 # undef inline
172 # if defined (G_HAVE___INLINE__)
173 # define inline __inline__
174 # else /* !inline && !__inline__ */
175 # if defined (G_HAVE___INLINE)
176 # define inline __inline
177 # else /* !inline && !__inline__ && !__inline */
178 # define inline /* don't inline, then */
179 # ifndef G_INLINE_FUNC
180 # undef G_CAN_INLINE
181 # endif
182 # endif
183 # endif
184 #endif
185 #ifndef G_INLINE_FUNC
186 # ifdef __GNUC__
187 # ifdef __OPTIMIZE__
188 # define G_INLINE_FUNC extern inline
189 # else
190 # undef G_CAN_INLINE
191 # define G_INLINE_FUNC extern
192 # endif
193 # else /* !__GNUC__ */
194 # ifdef G_CAN_INLINE
195 # define G_INLINE_FUNC static inline
196 # else
197 # define G_INLINE_FUNC extern
198 # endif
199 # endif /* !__GNUC__ */
200 #endif /* !G_INLINE_FUNC */
201
202
203 /* Provide simple macro statement wrappers (adapted from Perl):
204 * G_STMT_START { statements; } G_STMT_END;
205 * can be used as a single statement, as in
206 * if (x) G_STMT_START { ... } G_STMT_END; else ...
207 *
208 * For gcc we will wrap the statements within `({' and `})' braces.
209 * For SunOS they will be wrapped within `if (1)' and `else (void) 0',
210 * and otherwise within `do' and `while (0)'.
211 */
212 #if !(defined (G_STMT_START) && defined (G_STMT_END))
213 # if defined (__GNUC__) && !defined (__STRICT_ANSI__) && !defined (__cplusplus)
214 # define G_STMT_START (void)(
215 # define G_STMT_END )
216 # else
217 # if (defined (sun) || defined (__sun__))
218 # define G_STMT_START if (1)
219 # define G_STMT_END else (void)0
220 # else
221 # define G_STMT_START do
222 # define G_STMT_END while (0)
223 # endif
224 # endif
225 #endif
226
227
228 /* Provide macros to feature the GCC function attribute.
229 */
230 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
231 #define G_GNUC_PRINTF( format_idx, arg_idx ) \
232 __attribute__((format (printf, format_idx, arg_idx)))
233 #define G_GNUC_SCANF( format_idx, arg_idx ) \
234 __attribute__((format (scanf, format_idx, arg_idx)))
235 #define G_GNUC_FORMAT( arg_idx ) \
236 __attribute__((format_arg (arg_idx)))
237 #define G_GNUC_NORETURN \
238 __attribute__((noreturn))
239 #define G_GNUC_CONST \
240 __attribute__((const))
241 #define G_GNUC_UNUSED \
242 __attribute__((unused))
243 #else /* !__GNUC__ */
244 #define G_GNUC_PRINTF( format_idx, arg_idx )
245 #define G_GNUC_SCANF( format_idx, arg_idx )
246 #define G_GNUC_FORMAT( arg_idx )
247 #define G_GNUC_NORETURN
248 #define G_GNUC_CONST
249 #define G_GNUC_UNUSED
250 #endif /* !__GNUC__ */
251
252
253 /* Wrap the gcc __PRETTY_FUNCTION__ and __FUNCTION__ variables with
254 * macros, so we can refer to them as strings unconditionally.
255 */
256 #ifdef __GNUC__
257 #define G_GNUC_FUNCTION (__FUNCTION__)
258 #define G_GNUC_PRETTY_FUNCTION (__PRETTY_FUNCTION__)
259 #else /* !__GNUC__ */
260 #define G_GNUC_FUNCTION ("")
261 #define G_GNUC_PRETTY_FUNCTION ("")
262 #endif /* !__GNUC__ */
263
264 /* we try to provide a usefull equivalent for ATEXIT if it is
265 * not defined, but use is actually abandoned. people should
266 * use g_atexit() instead.
267 */
268 #ifndef ATEXIT
269 # define ATEXIT(proc) g_ATEXIT(proc)
270 #else
271 # define G_NATIVE_ATEXIT
272 #endif /* ATEXIT */
273
274 /* Hacker macro to place breakpoints for elected machines.
275 * Actual use is strongly deprecated of course ;)
276 */
277 #if defined (__i386__) && defined (__GNUC__) && __GNUC__ >= 2
278 #define G_BREAKPOINT() G_STMT_START{ __asm__ __volatile__ ("int $03"); }G_STMT_END
279 #elif defined (__alpha__) && defined (__GNUC__) && __GNUC__ >= 2
280 #define G_BREAKPOINT() G_STMT_START{ __asm__ __volatile__ ("bpt"); }G_STMT_END
281 #else /* !__i386__ && !__alpha__ */
282 #define G_BREAKPOINT()
283 #endif /* __i386__ */
284
285
286 /* Provide macros for easily allocating memory. The macros
287 * will cast the allocated memory to the specified type
288 * in order to avoid compiler warnings. (Makes the code neater).
289 */
290
291 #ifdef __DMALLOC_H__
292 # define g_new(type, count) (ALLOC (type, count))
293 # define g_new0(type, count) (CALLOC (type, count))
294 # define g_renew(type, mem, count) (REALLOC (mem, type, count))
295 #else /* __DMALLOC_H__ */
296 # define g_new(type, count) \
297 ((type *) g_malloc ((unsigned) sizeof (type) * (count)))
298 # define g_new0(type, count) \
299 ((type *) g_malloc0 ((unsigned) sizeof (type) * (count)))
300 # define g_renew(type, mem, count) \
301 ((type *) g_realloc (mem, (unsigned) sizeof (type) * (count)))
302 #endif /* __DMALLOC_H__ */
303
304 #define g_mem_chunk_create(type, pre_alloc, alloc_type) ( \
305 g_mem_chunk_new (#type " mem chunks (" #pre_alloc ")", \
306 sizeof (type), \
307 sizeof (type) * (pre_alloc), \
308 (alloc_type)) \
309 )
310 #define g_chunk_new(type, chunk) ( \
311 (type *) g_mem_chunk_alloc (chunk) \
312 )
313 #define g_chunk_new0(type, chunk) ( \
314 (type *) g_mem_chunk_alloc0 (chunk) \
315 )
316 #define g_chunk_free(mem, mem_chunk) G_STMT_START { \
317 g_mem_chunk_free ((mem_chunk), (mem)); \
318 } G_STMT_END
319
320
321 #define g_string(x) #x
322
323
324 /* Provide macros for error handling. The "assert" macros will
325 * exit on failure. The "return" macros will exit the current
326 * function. Two different definitions are given for the macros
327 * if G_DISABLE_ASSERT is not defined, in order to support gcc's
328 * __PRETTY_FUNCTION__ capability.
329 */
330
331 #ifdef G_DISABLE_ASSERT
332
333 #define g_assert(expr)
334 #define g_assert_not_reached()
335
336 #else /* !G_DISABLE_ASSERT */
337
338 #ifdef __GNUC__
339
340 #define g_assert(expr) G_STMT_START{ \
341 if (!(expr)) \
342 g_log (G_LOG_DOMAIN, \
343 G_LOG_LEVEL_ERROR, \
344 "file %s: line %d (%s): assertion failed: (%s)", \
345 __FILE__, \
346 __LINE__, \
347 __PRETTY_FUNCTION__, \
348 #expr); }G_STMT_END
349
350 #define g_assert_not_reached() G_STMT_START{ \
351 g_log (G_LOG_DOMAIN, \
352 G_LOG_LEVEL_ERROR, \
353 "file %s: line %d (%s): should not be reached", \
354 __FILE__, \
355 __LINE__, \
356 __PRETTY_FUNCTION__); }G_STMT_END
357
358 #else /* !__GNUC__ */
359
360 #define g_assert(expr) G_STMT_START{ \
361 if (!(expr)) \
362 g_log (G_LOG_DOMAIN, \
363 G_LOG_LEVEL_ERROR, \
364 "file %s: line %d: assertion failed: (%s)", \
365 __FILE__, \
366 __LINE__, \
367 #expr); }G_STMT_END
368
369 #define g_assert_not_reached() G_STMT_START{ \
370 g_log (G_LOG_DOMAIN, \
371 G_LOG_LEVEL_ERROR, \
372 "file %s: line %d: should not be reached", \
373 __FILE__, \
374 __LINE__); }G_STMT_END
375
376 #endif /* __GNUC__ */
377
378 #endif /* !G_DISABLE_ASSERT */
379
380
381 #ifdef G_DISABLE_CHECKS
382
383 #define g_return_if_fail(expr)
384 #define g_return_val_if_fail(expr,val)
385
386 #else /* !G_DISABLE_CHECKS */
387
388 #ifdef __GNUC__
389
390 #define g_return_if_fail(expr) G_STMT_START{ \
391 if (!(expr)) \
392 { \
393 g_log (G_LOG_DOMAIN, \
394 G_LOG_LEVEL_CRITICAL, \
395 "file %s: line %d (%s): assertion `%s' failed.", \
396 __FILE__, \
397 __LINE__, \
398 __PRETTY_FUNCTION__, \
399 #expr); \
400 return; \
401 }; }G_STMT_END
402
403 #define g_return_val_if_fail(expr,val) G_STMT_START{ \
404 if (!(expr)) \
405 { \
406 g_log (G_LOG_DOMAIN, \
407 G_LOG_LEVEL_CRITICAL, \
408 "file %s: line %d (%s): assertion `%s' failed.", \
409 __FILE__, \
410 __LINE__, \
411 __PRETTY_FUNCTION__, \
412 #expr); \
413 return val; \
414 }; }G_STMT_END
415
416 #else /* !__GNUC__ */
417
418 #define g_return_if_fail(expr) G_STMT_START{ \
419 if (!(expr)) \
420 { \
421 g_log (G_LOG_DOMAIN, \
422 G_LOG_LEVEL_CRITICAL, \
423 "file %s: line %d: assertion `%s' failed.", \
424 __FILE__, \
425 __LINE__, \
426 #expr); \
427 return; \
428 }; }G_STMT_END
429
430 #define g_return_val_if_fail(expr, val) G_STMT_START{ \
431 if (!(expr)) \
432 { \
433 g_log (G_LOG_DOMAIN, \
434 G_LOG_LEVEL_CRITICAL, \
435 "file %s: line %d: assertion `%s' failed.", \
436 __FILE__, \
437 __LINE__, \
438 #expr); \
439 return val; \
440 }; }G_STMT_END
441
442 #endif /* !__GNUC__ */
443
444 #endif /* !G_DISABLE_CHECKS */
445
446
447 /* Provide type definitions for commonly used types.
448 * These are useful because a "gint8" can be adjusted
449 * to be 1 byte (8 bits) on all platforms. Similarly and
450 * more importantly, "gint32" can be adjusted to be
451 * 4 bytes (32 bits) on all platforms.
452 */
453
454 typedef char gchar;
455 typedef short gshort;
456 typedef long glong;
457 typedef int gint;
458 typedef gint gboolean;
459
460 typedef unsigned char guchar;
461 typedef unsigned short gushort;
462 typedef unsigned long gulong;
463 typedef unsigned int guint;
464
465 typedef float gfloat;
466 typedef double gdouble;
467
468 /* HAVE_LONG_DOUBLE doesn't work correctly on all platforms.
469 * Since gldouble isn't used anywhere, just disable it for now */
470
471 #if 0
472 #ifdef HAVE_LONG_DOUBLE
473 typedef long double gldouble;
474 #else /* HAVE_LONG_DOUBLE */
475 typedef double gldouble;
476 #endif /* HAVE_LONG_DOUBLE */
477 #endif /* 0 */
478
479 typedef void* gpointer;
480 typedef const void *gconstpointer;
481
482
483 typedef gint32 gssize;
484 typedef guint32 gsize;
485 typedef guint32 GQuark;
486 typedef gint32 GTime;
487
488
489 /* Portable endian checks and conversions
490 *
491 * glibconfig.h defines G_BYTE_ORDER which expands to one of
492 * the below macros.
493 */
494 #define G_LITTLE_ENDIAN 1234
495 #define G_BIG_ENDIAN 4321
496 #define G_PDP_ENDIAN 3412 /* unused, need specific PDP check */
497
498
499 /* Basic bit swapping functions
500 */
501 #define GUINT16_SWAP_LE_BE_CONSTANT(val) ((guint16) ( \
502 (((guint16) (val) & (guint16) 0x00ffU) << 8) | \
503 (((guint16) (val) & (guint16) 0xff00U) >> 8)))
504 #define GUINT32_SWAP_LE_BE_CONSTANT(val) ((guint32) ( \
505 (((guint32) (val) & (guint32) 0x000000ffU) << 24) | \
506 (((guint32) (val) & (guint32) 0x0000ff00U) << 8) | \
507 (((guint32) (val) & (guint32) 0x00ff0000U) >> 8) | \
508 (((guint32) (val) & (guint32) 0xff000000U) >> 24)))
509
510 /* Intel specific stuff for speed
511 */
512 #if defined (__i386__) && defined (__GNUC__) && __GNUC__ >= 2
513 # define GUINT16_SWAP_LE_BE_X86(val) \
514 (__extension__ \
515 ({ register guint16 __v; \
516 if (__builtin_constant_p (val)) \
517 __v = GUINT16_SWAP_LE_BE_CONSTANT (val); \
518 else \
519 __asm__ __const__ ("rorw $8, %w0" \
520 : "=r" (__v) \
521 : "0" ((guint16) (val))); \
522 __v; }))
523 # define GUINT16_SWAP_LE_BE(val) (GUINT16_SWAP_LE_BE_X86 (val))
524 # if !defined(__i486__) && !defined(__i586__) \
525 && !defined(__pentium__) && !defined(__i686__) && !defined(__pentiumpro__)
526 # define GUINT32_SWAP_LE_BE_X86(val) \
527 (__extension__ \
528 ({ register guint32 __v; \
529 if (__builtin_constant_p (val)) \
530 __v = GUINT32_SWAP_LE_BE_CONSTANT (val); \
531 else \
532 __asm__ __const__ ("rorw $8, %w0\n\t" \
533 "rorl $16, %0\n\t" \
534 "rorw $8, %w0" \
535 : "=r" (__v) \
536 : "0" ((guint32) (val))); \
537 __v; }))
538 # else /* 486 and higher has bswap */
539 # define GUINT32_SWAP_LE_BE_X86(val) \
540 (__extension__ \
541 ({ register guint32 __v; \
542 if (__builtin_constant_p (val)) \
543 __v = GUINT32_SWAP_LE_BE_CONSTANT (val); \
544 else \
545 __asm__ __const__ ("bswap %0" \
546 : "=r" (__v) \
547 : "0" ((guint32) (val))); \
548 __v; }))
549 # endif /* processor specific 32-bit stuff */
550 # define GUINT32_SWAP_LE_BE(val) (GUINT32_SWAP_LE_BE_X86 (val))
551 #else /* !__i386__ */
552 # define GUINT16_SWAP_LE_BE(val) (GUINT16_SWAP_LE_BE_CONSTANT (val))
553 # define GUINT32_SWAP_LE_BE(val) (GUINT32_SWAP_LE_BE_CONSTANT (val))
554 #endif /* __i386__ */
555
556 #ifdef G_HAVE_GINT64
557 # define GUINT64_SWAP_LE_BE_CONSTANT(val) ((guint64) ( \
558 (((guint64) (val) & \
559 (guint64) G_GINT64_CONSTANT(0x00000000000000ffU)) << 56) | \
560 (((guint64) (val) & \
561 (guint64) G_GINT64_CONSTANT(0x000000000000ff00U)) << 40) | \
562 (((guint64) (val) & \
563 (guint64) G_GINT64_CONSTANT(0x0000000000ff0000U)) << 24) | \
564 (((guint64) (val) & \
565 (guint64) G_GINT64_CONSTANT(0x00000000ff000000U)) << 8) | \
566 (((guint64) (val) & \
567 (guint64) G_GINT64_CONSTANT(0x000000ff00000000U)) >> 8) | \
568 (((guint64) (val) & \
569 (guint64) G_GINT64_CONSTANT(0x0000ff0000000000U)) >> 24) | \
570 (((guint64) (val) & \
571 (guint64) G_GINT64_CONSTANT(0x00ff000000000000U)) >> 40) | \
572 (((guint64) (val) & \
573 (guint64) G_GINT64_CONSTANT(0xff00000000000000U)) >> 56)))
574 # if defined (__i386__) && defined (__GNUC__) && __GNUC__ >= 2
575 # define GUINT64_SWAP_LE_BE_X86(val) \
576 (__extension__ \
577 ({ union { guint64 __ll; \
578 guint32 __l[2]; } __r; \
579 if (__builtin_constant_p (val)) \
580 __r.__ll = GUINT64_SWAP_LE_BE_CONSTANT (val); \
581 else \
582 { \
583 union { guint64 __ll; \
584 guint32 __l[2]; } __w; \
585 __w.__ll = ((guint64) val); \
586 __r.__l[0] = GUINT32_SWAP_LE_BE (__w.__l[1]); \
587 __r.__l[1] = GUINT32_SWAP_LE_BE (__w.__l[0]); \
588 } \
589 __r.__ll; }))
590 # define GUINT64_SWAP_LE_BE(val) (GUINT64_SWAP_LE_BE_X86 (val))
591 # else /* !__i386__ */
592 # define GUINT64_SWAP_LE_BE(val) (GUINT64_SWAP_LE_BE_CONSTANT(val))
593 # endif
594 #endif
595
596 #define GUINT16_SWAP_LE_PDP(val) ((guint16) (val))
597 #define GUINT16_SWAP_BE_PDP(val) (GUINT16_SWAP_LE_BE (val))
598 #define GUINT32_SWAP_LE_PDP(val) ((guint32) ( \
599 (((guint32) (val) & (guint32) 0x0000ffffU) << 16) | \
600 (((guint32) (val) & (guint32) 0xffff0000U) >> 16)))
601 #define GUINT32_SWAP_BE_PDP(val) ((guint32) ( \
602 (((guint32) (val) & (guint32) 0x00ff00ffU) << 8) | \
603 (((guint32) (val) & (guint32) 0xff00ff00U) >> 8)))
604
605 /* The G*_TO_?E() macros are defined in glibconfig.h.
606 * The transformation is symmetric, so the FROM just maps to the TO.
607 */
608 #define GINT16_FROM_LE(val) (GINT16_TO_LE (val))
609 #define GUINT16_FROM_LE(val) (GUINT16_TO_LE (val))
610 #define GINT16_FROM_BE(val) (GINT16_TO_BE (val))
611 #define GUINT16_FROM_BE(val) (GUINT16_TO_BE (val))
612 #define GINT32_FROM_LE(val) (GINT32_TO_LE (val))
613 #define GUINT32_FROM_LE(val) (GUINT32_TO_LE (val))
614 #define GINT32_FROM_BE(val) (GINT32_TO_BE (val))
615 #define GUINT32_FROM_BE(val) (GUINT32_TO_BE (val))
616
617 #ifdef G_HAVE_GINT64
618 #define GINT64_FROM_LE(val) (GINT64_TO_LE (val))
619 #define GUINT64_FROM_LE(val) (GUINT64_TO_LE (val))
620 #define GINT64_FROM_BE(val) (GINT64_TO_BE (val))
621 #define GUINT64_FROM_BE(val) (GUINT64_TO_BE (val))
622 #endif
623
624 #define GLONG_FROM_LE(val) (GLONG_TO_LE (val))
625 #define GULONG_FROM_LE(val) (GULONG_TO_LE (val))
626 #define GLONG_FROM_BE(val) (GLONG_TO_BE (val))
627 #define GULONG_FROM_BE(val) (GULONG_TO_BE (val))
628
629 #define GINT_FROM_LE(val) (GINT_TO_LE (val))
630 #define GUINT_FROM_LE(val) (GUINT_TO_LE (val))
631 #define GINT_FROM_BE(val) (GINT_TO_BE (val))
632 #define GUINT_FROM_BE(val) (GUINT_TO_BE (val))
633
634
635 /* Portable versions of host-network order stuff
636 */
637 #define g_ntohl(val) (GUINT32_FROM_BE (val))
638 #define g_ntohs(val) (GUINT16_FROM_BE (val))
639 #define g_htonl(val) (GUINT32_TO_BE (val))
640 #define g_htons(val) (GUINT16_TO_BE (val))
641
642
643 /* Glib version.
644 * we prefix variable declarations so they can
645 * properly get exported in windows dlls.
646 */
647 #ifdef NATIVE_WIN32
648 # ifdef GLIB_COMPILATION
649 # define GUTILS_C_VAR __declspec(dllexport)
650 # else /* !GLIB_COMPILATION */
651 # define GUTILS_C_VAR extern __declspec(dllimport)
652 # endif /* !GLIB_COMPILATION */
653 #else /* !NATIVE_WIN32 */
654 # define GUTILS_C_VAR extern
655 #endif /* !NATIVE_WIN32 */
656
657 GUTILS_C_VAR const guint glib_major_version;
658 GUTILS_C_VAR const guint glib_minor_version;
659 GUTILS_C_VAR const guint glib_micro_version;
660 GUTILS_C_VAR const guint glib_interface_age;
661 GUTILS_C_VAR const guint glib_binary_age;
662
663
664 /* Forward declarations of glib types.
665 */
666 typedef struct _GAllocator GAllocator;
667 typedef struct _GArray GArray;
668 typedef struct _GByteArray GByteArray;
669 typedef struct _GCache GCache;
670 typedef struct _GCompletion GCompletion;
671 typedef struct _GData GData;
672 typedef struct _GDebugKey GDebugKey;
673 typedef struct _GHashTable GHashTable;
674 typedef struct _GHook GHook;
675 typedef struct _GHookList GHookList;
676 typedef struct _GList GList;
677 typedef struct _GMemChunk GMemChunk;
678 typedef struct _GNode GNode;
679 typedef struct _GPtrArray GPtrArray;
680 typedef struct _GRelation GRelation;
681 typedef struct _GScanner GScanner;
682 typedef struct _GScannerConfig GScannerConfig;
683 typedef struct _GSList GSList;
684 typedef struct _GString GString;
685 typedef struct _GStringChunk GStringChunk;
686 typedef struct _GTimer GTimer;
687 typedef struct _GTree GTree;
688 typedef struct _GTuples GTuples;
689 typedef union _GTokenValue GTokenValue;
690 typedef struct _GIOChannel GIOChannel;
691
692 typedef enum
693 {
694 G_TRAVERSE_LEAFS = 1 << 0,
695 G_TRAVERSE_NON_LEAFS = 1 << 1,
696 G_TRAVERSE_ALL = G_TRAVERSE_LEAFS | G_TRAVERSE_NON_LEAFS,
697 G_TRAVERSE_MASK = 0x03
698 } GTraverseFlags;
699
700 typedef enum
701 {
702 G_IN_ORDER,
703 G_PRE_ORDER,
704 G_POST_ORDER,
705 G_LEVEL_ORDER
706 } GTraverseType;
707
708 /* Log level shift offset for user defined
709 * log levels (0-7 are used by GLib).
710 */
711 #define G_LOG_LEVEL_USER_SHIFT (8)
712
713 /* Glib log levels and flags.
714 */
715 typedef enum
716 {
717 /* log flags */
718 G_LOG_FLAG_RECURSION = 1 << 0,
719 G_LOG_FLAG_FATAL = 1 << 1,
720
721 /* GLib log levels */
722 G_LOG_LEVEL_ERROR = 1 << 2, /* always fatal */
723 G_LOG_LEVEL_CRITICAL = 1 << 3,
724 G_LOG_LEVEL_WARNING = 1 << 4,
725 G_LOG_LEVEL_MESSAGE = 1 << 5,
726 G_LOG_LEVEL_INFO = 1 << 6,
727 G_LOG_LEVEL_DEBUG = 1 << 7,
728
729 G_LOG_LEVEL_MASK = ~(G_LOG_FLAG_RECURSION | G_LOG_FLAG_FATAL)
730 } GLogLevelFlags;
731
732 /* GLib log levels that are considered fatal by default */
733 #define G_LOG_FATAL_MASK (G_LOG_FLAG_RECURSION | G_LOG_LEVEL_ERROR)
734
735
736 typedef gpointer (*GCacheNewFunc) (gpointer key);
737 typedef gpointer (*GCacheDupFunc) (gpointer value);
738 typedef void (*GCacheDestroyFunc) (gpointer value);
739 typedef gint (*GCompareFunc) (gconstpointer a,
740 gconstpointer b);
741 typedef gchar* (*GCompletionFunc) (gpointer);
742 typedef void (*GDestroyNotify) (gpointer data);
743 typedef void (*GDataForeachFunc) (GQuark key_id,
744 gpointer data,
745 gpointer user_data);
746 typedef void (*GFunc) (gpointer data,
747 gpointer user_data);
748 typedef guint (*GHashFunc) (gconstpointer key);
749 typedef void (*GFreeFunc) (gpointer data);
750 typedef void (*GHFunc) (gpointer key,
751 gpointer value,
752 gpointer user_data);
753 typedef gboolean (*GHRFunc) (gpointer key,
754 gpointer value,
755 gpointer user_data);
756 typedef gint (*GHookCompareFunc) (GHook *new_hook,
757 GHook *sibling);
758 typedef gboolean (*GHookFindFunc) (GHook *hook,
759 gpointer data);
760 typedef void (*GHookMarshaller) (GHook *hook,
761 gpointer data);
762 typedef gboolean (*GHookCheckMarshaller) (GHook *hook,
763 gpointer data);
764 typedef void (*GHookFunc) (gpointer data);
765 typedef gboolean (*GHookCheckFunc) (gpointer data);
766 typedef void (*GHookFreeFunc) (GHookList *hook_list,
767 GHook *hook);
768 typedef void (*GLogFunc) (const gchar *log_domain,
769 GLogLevelFlags log_level,
770 const gchar *message,
771 gpointer user_data);
772 typedef gboolean (*GNodeTraverseFunc) (GNode *node,
773 gpointer data);
774 typedef void (*GNodeForeachFunc) (GNode *node,
775 gpointer data);
776 typedef gint (*GSearchFunc) (gpointer key,
777 gpointer data);
778 typedef void (*GScannerMsgFunc) (GScanner *scanner,
779 gchar *message,
780 gint error);
781 typedef gint (*GTraverseFunc) (gpointer key,
782 gpointer value,
783 gpointer data);
784 typedef void (*GVoidFunc) (void);
785
786
787 struct _GList
788 {
789 gpointer data;
790 GList *next;
791 GList *prev;
792 };
793
794 struct _GSList
795 {
796 gpointer data;
797 GSList *next;
798 };
799
800 struct _GString
801 {
802 gchar *str;
803 gint len;
804 };
805
806 struct _GArray
807 {
808 gchar *data;
809 guint len;
810 };
811
812 struct _GByteArray
813 {
814 guint8 *data;
815 guint len;
816 };
817
818 struct _GPtrArray
819 {
820 gpointer *pdata;
821 guint len;
822 };
823
824 struct _GTuples
825 {
826 guint len;
827 };
828
829 struct _GDebugKey
830 {
831 gchar *key;
832 guint value;
833 };
834
835
836 /* Doubly linked lists
837 */
838 void g_list_push_allocator (GAllocator *allocator);
839 void g_list_pop_allocator (void);
840 GList* g_list_alloc (void);
841 void g_list_free (GList *list);
842 void g_list_free_1 (GList *list);
843 GList* g_list_append (GList *list,
844 gpointer data);
845 GList* g_list_prepend (GList *list,
846 gpointer data);
847 GList* g_list_insert (GList *list,
848 gpointer data,
849 gint position);
850 GList* g_list_insert_sorted (GList *list,
851 gpointer data,
852 GCompareFunc func);
853 GList* g_list_concat (GList *list1,
854 GList *list2);
855 GList* g_list_remove (GList *list,
856 gpointer data);
857 GList* g_list_remove_link (GList *list,
858 GList *llink);
859 GList* g_list_reverse (GList *list);
860 GList* g_list_copy (GList *list);
861 GList* g_list_nth (GList *list,
862 guint n);
863 GList* g_list_find (GList *list,
864 gpointer data);
865 GList* g_list_find_custom (GList *list,
866 gpointer data,
867 GCompareFunc func);
868 gint g_list_position (GList *list,
869 GList *llink);
870 gint g_list_index (GList *list,
871 gpointer data);
872 GList* g_list_last (GList *list);
873 GList* g_list_first (GList *list);
874 guint g_list_length (GList *list);
875 void g_list_foreach (GList *list,
876 GFunc func,
877 gpointer user_data);
878 GList* g_list_sort (GList *list,
879 GCompareFunc compare_func);
880 gpointer g_list_nth_data (GList *list,
881 guint n);
882 #define g_list_previous(list) ((list) ? (((GList *)(list))->prev) : NULL)
883 #define g_list_next(list) ((list) ? (((GList *)(list))->next) : NULL)
884
885
886 /* Singly linked lists
887 */
888 void g_slist_push_allocator (GAllocator *allocator);
889 void g_slist_pop_allocator (void);
890 GSList* g_slist_alloc (void);
891 void g_slist_free (GSList *list);
892 void g_slist_free_1 (GSList *list);
893 GSList* g_slist_append (GSList *list,
894 gpointer data);
895 GSList* g_slist_prepend (GSList *list,
896 gpointer data);
897 GSList* g_slist_insert (GSList *list,
898 gpointer data,
899 gint position);
900 GSList* g_slist_insert_sorted (GSList *list,
901 gpointer data,
902 GCompareFunc func);
903 GSList* g_slist_concat (GSList *list1,
904 GSList *list2);
905 GSList* g_slist_remove (GSList *list,
906 gpointer data);
907 GSList* g_slist_remove_link (GSList *list,
908 GSList *llink);
909 GSList* g_slist_reverse (GSList *list);
910 GSList* g_slist_copy (GSList *list);
911 GSList* g_slist_nth (GSList *list,
912 guint n);
913 GSList* g_slist_find (GSList *list,
914 gpointer data);
915 GSList* g_slist_find_custom (GSList *list,
916 gpointer data,
917 GCompareFunc func);
918 gint g_slist_position (GSList *list,
919 GSList *llink);
920 gint g_slist_index (GSList *list,
921 gpointer data);
922 GSList* g_slist_last (GSList *list);
923 guint g_slist_length (GSList *list);
924 void g_slist_foreach (GSList *list,
925 GFunc func,
926 gpointer user_data);
927 GSList* g_slist_sort (GSList *list,
928 GCompareFunc compare_func);
929 gpointer g_slist_nth_data (GSList *list,
930 guint n);
931 #define g_slist_next(slist) ((slist) ? (((GSList *)(slist))->next) : NULL)
932
933
934 /* Hash tables
935 */
936 GHashTable* g_hash_table_new (GHashFunc hash_func,
937 GCompareFunc key_compare_func);
938 void g_hash_table_destroy (GHashTable *hash_table);
939 void g_hash_table_insert (GHashTable *hash_table,
940 gpointer key,
941 gpointer value);
942 void g_hash_table_remove (GHashTable *hash_table,
943 gconstpointer key);
944 gpointer g_hash_table_lookup (GHashTable *hash_table,
945 gconstpointer key);
946 gboolean g_hash_table_lookup_extended(GHashTable *hash_table,
947 gconstpointer lookup_key,
948 gpointer *orig_key,
949 gpointer *value);
950 void g_hash_table_freeze (GHashTable *hash_table);
951 void g_hash_table_thaw (GHashTable *hash_table);
952 void g_hash_table_foreach (GHashTable *hash_table,
953 GHFunc func,
954 gpointer user_data);
955 gint g_hash_table_foreach_remove (GHashTable *hash_table,
956 GHRFunc func,
957 gpointer user_data);
958 gint g_hash_table_size (GHashTable *hash_table);
959
960
961 /* Caches
962 */
963 GCache* g_cache_new (GCacheNewFunc value_new_func,
964 GCacheDestroyFunc value_destroy_func,
965 GCacheDupFunc key_dup_func,
966 GCacheDestroyFunc key_destroy_func,
967 GHashFunc hash_key_func,
968 GHashFunc hash_value_func,
969 GCompareFunc key_compare_func);
970 void g_cache_destroy (GCache *cache);
971 gpointer g_cache_insert (GCache *cache,
972 gpointer key);
973 void g_cache_remove (GCache *cache,
974 gpointer value);
975 void g_cache_key_foreach (GCache *cache,
976 GHFunc func,
977 gpointer user_data);
978 void g_cache_value_foreach (GCache *cache,
979 GHFunc func,
980 gpointer user_data);
981
982
983 /* Balanced binary trees
984 */
985 GTree* g_tree_new (GCompareFunc key_compare_func);
986 void g_tree_destroy (GTree *tree);
987 void g_tree_insert (GTree *tree,
988 gpointer key,
989 gpointer value);
990 void g_tree_remove (GTree *tree,
991 gpointer key);
992 gpointer g_tree_lookup (GTree *tree,
993 gpointer key);
994 void g_tree_traverse (GTree *tree,
995 GTraverseFunc traverse_func,
996 GTraverseType traverse_type,
997 gpointer data);
998 gpointer g_tree_search (GTree *tree,
999 GSearchFunc search_func,
1000 gpointer data);
1001 gint g_tree_height (GTree *tree);
1002 gint g_tree_nnodes (GTree *tree);
1003
1004
1005
1006 /* N-way tree implementation
1007 */
1008 struct _GNode
1009 {
1010 gpointer data;
1011 GNode *next;
1012 GNode *prev;
1013 GNode *parent;
1014 GNode *children;
1015 };
1016
1017 #define G_NODE_IS_ROOT(node) (((GNode*) (node))->parent == NULL && \
1018 ((GNode*) (node))->prev == NULL && \
1019 ((GNode*) (node))->next == NULL)
1020 #define G_NODE_IS_LEAF(node) (((GNode*) (node))->children == NULL)
1021
1022 void g_node_push_allocator (GAllocator *allocator);
1023 void g_node_pop_allocator (void);
1024 GNode* g_node_new (gpointer data);
1025 void g_node_destroy (GNode *root);
1026 void g_node_unlink (GNode *node);
1027 GNode* g_node_insert (GNode *parent,
1028 gint position,
1029 GNode *node);
1030 GNode* g_node_insert_before (GNode *parent,
1031 GNode *sibling,
1032 GNode *node);
1033 GNode* g_node_prepend (GNode *parent,
1034 GNode *node);
1035 guint g_node_n_nodes (GNode *root,
1036 GTraverseFlags flags);
1037 GNode* g_node_get_root (GNode *node);
1038 gboolean g_node_is_ancestor (GNode *node,
1039 GNode *descendant);
1040 guint g_node_depth (GNode *node);
1041 GNode* g_node_find (GNode *root,
1042 GTraverseType order,
1043 GTraverseFlags flags,
1044 gpointer data);
1045
1046 /* convenience macros */
1047 #define g_node_append(parent, node) \
1048 g_node_insert_before ((parent), NULL, (node))
1049 #define g_node_insert_data(parent, position, data) \
1050 g_node_insert ((parent), (position), g_node_new (data))
1051 #define g_node_insert_data_before(parent, sibling, data) \
1052 g_node_insert_before ((parent), (sibling), g_node_new (data))
1053 #define g_node_prepend_data(parent, data) \
1054 g_node_prepend ((parent), g_node_new (data))
1055 #define g_node_append_data(parent, data) \
1056 g_node_insert_before ((parent), NULL, g_node_new (data))
1057
1058 /* traversal function, assumes that `node' is root
1059 * (only traverses `node' and its subtree).
1060 * this function is just a high level interface to
1061 * low level traversal functions, optimized for speed.
1062 */
1063 void g_node_traverse (GNode *root,
1064 GTraverseType order,
1065 GTraverseFlags flags,
1066 gint max_depth,
1067 GNodeTraverseFunc func,
1068 gpointer data);
1069
1070 /* return the maximum tree height starting with `node', this is an expensive
1071 * operation, since we need to visit all nodes. this could be shortened by
1072 * adding `guint height' to struct _GNode, but then again, this is not very
1073 * often needed, and would make g_node_insert() more time consuming.
1074 */
1075 guint g_node_max_height (GNode *root);
1076
1077 void g_node_children_foreach (GNode *node,
1078 GTraverseFlags flags,
1079 GNodeForeachFunc func,
1080 gpointer data);
1081 void g_node_reverse_children (GNode *node);
1082 guint g_node_n_children (GNode *node);
1083 GNode* g_node_nth_child (GNode *node,
1084 guint n);
1085 GNode* g_node_last_child (GNode *node);
1086 GNode* g_node_find_child (GNode *node,
1087 GTraverseFlags flags,
1088 gpointer data);
1089 gint g_node_child_position (GNode *node,
1090 GNode *child);
1091 gint g_node_child_index (GNode *node,
1092 gpointer data);
1093
1094 GNode* g_node_first_sibling (GNode *node);
1095 GNode* g_node_last_sibling (GNode *node);
1096
1097 #define g_node_prev_sibling(node) ((node) ? \
1098 ((GNode*) (node))->prev : NULL)
1099 #define g_node_next_sibling(node) ((node) ? \
1100 ((GNode*) (node))->next : NULL)
1101 #define g_node_first_child(node) ((node) ? \
1102 ((GNode*) (node))->children : NULL)
1103
1104
1105 /* Callback maintenance functions
1106 */
1107 #define G_HOOK_FLAG_USER_SHIFT (4)
1108 typedef enum
1109 {
1110 G_HOOK_FLAG_ACTIVE = 1 << 0,
1111 G_HOOK_FLAG_IN_CALL = 1 << 1,
1112 G_HOOK_FLAG_MASK = 0x0f
1113 } GHookFlagMask;
1114
1115 #define G_HOOK_DEFERRED_DESTROY ((GHookFreeFunc) 0x01)
1116
1117 struct _GHookList
1118 {
1119 guint seq_id;
1120 guint hook_size;
1121 guint is_setup : 1;
1122 GHook *hooks;
1123 GMemChunk *hook_memchunk;
1124 GHookFreeFunc hook_free; /* virtual function */
1125 GHookFreeFunc hook_destroy; /* virtual function */
1126 };
1127
1128 struct _GHook
1129 {
1130 gpointer data;
1131 GHook *next;
1132 GHook *prev;
1133 guint ref_count;
1134 guint hook_id;
1135 guint flags;
1136 gpointer func;
1137 GDestroyNotify destroy;
1138 };
1139
1140 #define G_HOOK_ACTIVE(hook) ((((GHook*) hook)->flags & \
1141 G_HOOK_FLAG_ACTIVE) != 0)
1142 #define G_HOOK_IN_CALL(hook) ((((GHook*) hook)->flags & \
1143 G_HOOK_FLAG_IN_CALL) != 0)
1144 #define G_HOOK_IS_VALID(hook) (((GHook*) hook)->hook_id != 0 && \
1145 G_HOOK_ACTIVE (hook))
1146 #define G_HOOK_IS_UNLINKED(hook) (((GHook*) hook)->next == NULL && \
1147 ((GHook*) hook)->prev == NULL && \
1148 ((GHook*) hook)->hook_id == 0 && \
1149 ((GHook*) hook)->ref_count == 0)
1150
1151 void g_hook_list_init (GHookList *hook_list,
1152 guint hook_size);
1153 void g_hook_list_clear (GHookList *hook_list);
1154 GHook* g_hook_alloc (GHookList *hook_list);
1155 void g_hook_free (GHookList *hook_list,
1156 GHook *hook);
1157 void g_hook_ref (GHookList *hook_list,
1158 GHook *hook);
1159 void g_hook_unref (GHookList *hook_list,
1160 GHook *hook);
1161 gboolean g_hook_destroy (GHookList *hook_list,
1162 guint hook_id);
1163 void g_hook_destroy_link (GHookList *hook_list,
1164 GHook *hook);
1165 void g_hook_prepend (GHookList *hook_list,
1166 GHook *hook);
1167 void g_hook_insert_before (GHookList *hook_list,
1168 GHook *sibling,
1169 GHook *hook);
1170 void g_hook_insert_sorted (GHookList *hook_list,
1171 GHook *hook,
1172 GHookCompareFunc func);
1173 GHook* g_hook_get (GHookList *hook_list,
1174 guint hook_id);
1175 GHook* g_hook_find (GHookList *hook_list,
1176 gboolean need_valids,
1177 GHookFindFunc func,
1178 gpointer data);
1179 GHook* g_hook_find_data (GHookList *hook_list,
1180 gboolean need_valids,
1181 gpointer data);
1182 GHook* g_hook_find_func (GHookList *hook_list,
1183 gboolean need_valids,
1184 gpointer func);
1185 GHook* g_hook_find_func_data (GHookList *hook_list,
1186 gboolean need_valids,
1187 gpointer func,
1188 gpointer data);
1189 /* return the first valid hook, and increment its reference count */
1190 GHook* g_hook_first_valid (GHookList *hook_list,
1191 gboolean may_be_in_call);
1192 /* return the next valid hook with incremented reference count, and
1193 * decrement the reference count of the original hook
1194 */
1195 GHook* g_hook_next_valid (GHookList *hook_list,
1196 GHook *hook,
1197 gboolean may_be_in_call);
1198
1199 /* GHookCompareFunc implementation to insert hooks sorted by their id */
1200 gint g_hook_compare_ids (GHook *new_hook,
1201 GHook *sibling);
1202
1203 /* convenience macros */
1204 #define g_hook_append( hook_list, hook ) \
1205 g_hook_insert_before ((hook_list), NULL, (hook))
1206
1207 /* invoke all valid hooks with the (*GHookFunc) signature.
1208 */
1209 void g_hook_list_invoke (GHookList *hook_list,
1210 gboolean may_recurse);
1211 /* invoke all valid hooks with the (*GHookCheckFunc) signature,
1212 * and destroy the hook if FALSE is returned.
1213 */
1214 void g_hook_list_invoke_check (GHookList *hook_list,
1215 gboolean may_recurse);
1216 /* invoke a marshaller on all valid hooks.
1217 */
1218 void g_hook_list_marshal (GHookList *hook_list,
1219 gboolean may_recurse,
1220 GHookMarshaller marshaller,
1221 gpointer data);
1222 void g_hook_list_marshal_check (GHookList *hook_list,
1223 gboolean may_recurse,
1224 GHookCheckMarshaller marshaller,
1225 gpointer data);
1226
1227
1228 /* Fatal error handlers.
1229 * g_on_error_query() will prompt the user to either
1230 * [E]xit, [H]alt, [P]roceed or show [S]tack trace.
1231 * g_on_error_stack_trace() invokes gdb, which attaches to the current
1232 * process and shows a stack trace.
1233 * These function may cause different actions on non-unix platforms.
1234 * The prg_name arg is required by gdb to find the executable, if it is
1235 * passed as NULL, g_on_error_query() will try g_get_prgname().
1236 */
1237 void g_on_error_query (const gchar *prg_name);
1238 void g_on_error_stack_trace (const gchar *prg_name);
1239
1240
1241 /* Logging mechanism
1242 */
1243 extern const gchar *g_log_domain_glib;
1244 guint g_log_set_handler (const gchar *log_domain,
1245 GLogLevelFlags log_levels,
1246 GLogFunc log_func,
1247 gpointer user_data);
1248 void g_log_remove_handler (const gchar *log_domain,
1249 guint handler_id);
1250 void g_log_default_handler (const gchar *log_domain,
1251 GLogLevelFlags log_level,
1252 const gchar *message,
1253 gpointer unused_data);
1254 void g_log (const gchar *log_domain,
1255 GLogLevelFlags log_level,
1256 const gchar *format,
1257 ...) G_GNUC_PRINTF (3, 4);
1258 void g_logv (const gchar *log_domain,
1259 GLogLevelFlags log_level,
1260 const gchar *format,
1261 va_list args);
1262 GLogLevelFlags g_log_set_fatal_mask (const gchar *log_domain,
1263 GLogLevelFlags fatal_mask);
1264 GLogLevelFlags g_log_set_always_fatal (GLogLevelFlags fatal_mask);
1265 #ifndef G_LOG_DOMAIN
1266 #define G_LOG_DOMAIN ((gchar*) 0)
1267 #endif /* G_LOG_DOMAIN */
1268 #ifdef __GNUC__
1269 #define g_error(format, args...) g_log (G_LOG_DOMAIN, \
1270 G_LOG_LEVEL_ERROR, \
1271 format, ##args)
1272 #define g_message(format, args...) g_log (G_LOG_DOMAIN, \
1273 G_LOG_LEVEL_MESSAGE, \
1274 format, ##args)
1275 #define g_warning(format, args...) g_log (G_LOG_DOMAIN, \
1276 G_LOG_LEVEL_WARNING, \
1277 format, ##args)
1278 #else /* !__GNUC__ */
1279 static void
1280 g_error (const gchar *format,
1281 ...)
1282 {
1283 va_list args;
1284 va_start (args, format);
1285 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR, format, args);
1286 va_end (args);
1287 }
1288 static void
1289 g_message (const gchar *format,
1290 ...)
1291 {
1292 va_list args;
1293 va_start (args, format);
1294 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_MESSAGE, format, args);
1295 va_end (args);
1296 }
1297 static void
1298 g_warning (const gchar *format,
1299 ...)
1300 {
1301 va_list args;
1302 va_start (args, format);
1303 g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING, format, args);
1304 va_end (args);
1305 }
1306 #endif /* !__GNUC__ */
1307
1308 typedef void (*GPrintFunc) (const gchar *string);
1309 void g_print (const gchar *format,
1310 ...) G_GNUC_PRINTF (1, 2);
1311 GPrintFunc g_set_print_handler (GPrintFunc func);
1312 void g_printerr (const gchar *format,
1313 ...) G_GNUC_PRINTF (1, 2);
1314 GPrintFunc g_set_printerr_handler (GPrintFunc func);
1315
1316 /* deprecated compatibility functions, use g_log_set_handler() instead */
1317 typedef void (*GErrorFunc) (const gchar *str);
1318 typedef void (*GWarningFunc) (const gchar *str);
1319 GErrorFunc g_set_error_handler (GErrorFunc func);
1320 GWarningFunc g_set_warning_handler (GWarningFunc func);
1321 GPrintFunc g_set_message_handler (GPrintFunc func);
1322
1323
1324 /* Memory allocation and debugging
1325 */
1326 #ifdef USE_DMALLOC
1327
1328 #define g_malloc(size) ((gpointer) MALLOC (size))
1329 #define g_malloc0(size) ((gpointer) CALLOC (char, size))
1330 #define g_realloc(mem,size) ((gpointer) REALLOC (mem, char, size))
1331 #define g_free(mem) FREE (mem)
1332
1333 #else /* !USE_DMALLOC */
1334
1335 gpointer g_malloc (gulong size);
1336 gpointer g_malloc0 (gulong size);
1337 gpointer g_realloc (gpointer mem,
1338 gulong size);
1339 void g_free (gpointer mem);
1340
1341 #endif /* !USE_DMALLOC */
1342
1343 void g_mem_profile (void);
1344 void g_mem_check (gpointer mem);
1345
1346 /* Generic allocators
1347 */
1348 GAllocator* g_allocator_new (const gchar *name,
1349 guint n_preallocs);
1350 void g_allocator_free (GAllocator *allocator);
1351
1352 #define G_ALLOCATOR_LIST (1)
1353 #define G_ALLOCATOR_SLIST (2)
1354 #define G_ALLOCATOR_NODE (3)
1355
1356
1357 /* "g_mem_chunk_new" creates a new memory chunk.
1358 * Memory chunks are used to allocate pieces of memory which are
1359 * always the same size. Lists are a good example of such a data type.
1360 * The memory chunk allocates and frees blocks of memory as needed.
1361 * Just be sure to call "g_mem_chunk_free" and not "g_free" on data
1362 * allocated in a mem chunk. ("g_free" will most likely cause a seg
1363 * fault...somewhere).
1364 *
1365 * Oh yeah, GMemChunk is an opaque data type. (You don't really
1366 * want to know what's going on inside do you?)
1367 */
1368
1369 /* ALLOC_ONLY MemChunk's can only allocate memory. The free operation
1370 * is interpreted as a no op. ALLOC_ONLY MemChunk's save 4 bytes per
1371 * atom. (They are also useful for lists which use MemChunk to allocate
1372 * memory but are also part of the MemChunk implementation).
1373 * ALLOC_AND_FREE MemChunk's can allocate and free memory.
1374 */
1375
1376 #define G_ALLOC_ONLY 1
1377 #define G_ALLOC_AND_FREE 2
1378
1379 GMemChunk* g_mem_chunk_new (gchar *name,
1380 gint atom_size,
1381 gulong area_size,
1382 gint type);
1383 void g_mem_chunk_destroy (GMemChunk *mem_chunk);
1384 gpointer g_mem_chunk_alloc (GMemChunk *mem_chunk);
1385 gpointer g_mem_chunk_alloc0 (GMemChunk *mem_chunk);
1386 void g_mem_chunk_free (GMemChunk *mem_chunk,
1387 gpointer mem);
1388 void g_mem_chunk_clean (GMemChunk *mem_chunk);
1389 void g_mem_chunk_reset (GMemChunk *mem_chunk);
1390 void g_mem_chunk_print (GMemChunk *mem_chunk);
1391 void g_mem_chunk_info (void);
1392
1393 /* Ah yes...we have a "g_blow_chunks" function.
1394 * "g_blow_chunks" simply compresses all the chunks. This operation
1395 * consists of freeing every memory area that should be freed (but
1396 * which we haven't gotten around to doing yet). And, no,
1397 * "g_blow_chunks" doesn't follow the naming scheme, but it is a
1398 * much better name than "g_mem_chunk_clean_all" or something
1399 * similar.
1400 */
1401 void g_blow_chunks (void);
1402
1403
1404 /* Timer
1405 */
1406 GTimer* g_timer_new (void);
1407 void g_timer_destroy (GTimer *timer);
1408 void g_timer_start (GTimer *timer);
1409 void g_timer_stop (GTimer *timer);
1410 void g_timer_reset (GTimer *timer);
1411 gdouble g_timer_elapsed (GTimer *timer,
1412 gulong *microseconds);
1413
1414
1415 /* String utility functions that modify a string argument or
1416 * return a constant string that must not be freed.
1417 */
1418 #define G_STR_DELIMITERS "_-|> <."
1419 gchar* g_strdelimit (gchar *string,
1420 const gchar *delimiters,
1421 gchar new_delimiter);
1422 gdouble g_strtod (const gchar *nptr,
1423 gchar **endptr);
1424 gchar* g_strerror (gint errnum);
1425 gchar* g_strsignal (gint signum);
1426 gint g_strcasecmp (const gchar *s1,
1427 const gchar *s2);
1428 gint g_strncasecmp (const gchar *s1,
1429 const gchar *s2,
1430 guint n);
1431 void g_strdown (gchar *string);
1432 void g_strup (gchar *string);
1433 void g_strreverse (gchar *string);
1434 /* removes leading spaces */
1435 gchar* g_strchug (gchar *string);
1436 /* removes trailing spaces */
1437 gchar* g_strchomp (gchar *string);
1438 /* removes leading & trailing spaces */
1439 #define g_strstrip( string ) g_strchomp (g_strchug (string))
1440
1441 /* String utility functions that return a newly allocated string which
1442 * ought to be freed from the caller at some point.
1443 */
1444 gchar* g_strdup (const gchar *str);
1445 gchar* g_strdup_printf (const gchar *format,
1446 ...) G_GNUC_PRINTF (1, 2);
1447 gchar* g_strdup_vprintf (const gchar *format,
1448 va_list args);
1449 gchar* g_strndup (const gchar *str,
1450 guint n);
1451 gchar* g_strnfill (guint length,
1452 gchar fill_char);
1453 gchar* g_strconcat (const gchar *string1,
1454 ...); /* NULL terminated */
1455 gchar* g_strjoin (const gchar *separator,
1456 ...); /* NULL terminated */
1457 gchar* g_strescape (gchar *string);
1458 gpointer g_memdup (gconstpointer mem,
1459 guint byte_size);
1460
1461 /* NULL terminated string arrays.
1462 * g_strsplit() splits up string into max_tokens tokens at delim and
1463 * returns a newly allocated string array.
1464 * g_strjoinv() concatenates all of str_array's strings, sliding in an
1465 * optional separator, the returned string is newly allocated.
1466 * g_strfreev() frees the array itself and all of its strings.
1467 */
1468 gchar** g_strsplit (const gchar *string,
1469 const gchar *delimiter,
1470 gint max_tokens);
1471 gchar* g_strjoinv (const gchar *separator,
1472 gchar **str_array);
1473 void g_strfreev (gchar **str_array);
1474
1475
1476
1477 /* calculate a string size, guarranteed to fit format + args.
1478 */
1479 guint g_printf_string_upper_bound (const gchar* format,
1480 va_list args);
1481
1482
1483 /* Retrive static string info
1484 */
1485 gchar* g_get_user_name (void);
1486 gchar* g_get_real_name (void);
1487 gchar* g_get_home_dir (void);
1488 gchar* g_get_tmp_dir (void);
1489 gchar* g_get_prgname (void);
1490 void g_set_prgname (const gchar *prgname);
1491
1492
1493 /* Miscellaneous utility functions
1494 */
1495 guint g_parse_debug_string (const gchar *string,
1496 GDebugKey *keys,
1497 guint nkeys);
1498 gint g_snprintf (gchar *string,
1499 gulong n,
1500 gchar const *format,
1501 ...) G_GNUC_PRINTF (3, 4);
1502 gint g_vsnprintf (gchar *string,
1503 gulong n,
1504 gchar const *format,
1505 va_list args);
1506 gchar* g_basename (const gchar *file_name);
1507 /* Check if a file name is an absolute path */
1508 gboolean g_path_is_absolute (const gchar *file_name);
1509 /* In case of absolute paths, skip the root part */
1510 gchar* g_path_skip_root (gchar *file_name);
1511
1512 /* strings are newly allocated with g_malloc() */
1513 gchar* g_dirname (const gchar *file_name);
1514 gchar* g_get_current_dir (void);
1515 gchar* g_getenv (const gchar *variable);
1516
1517
1518 /* we use a GLib function as a replacement for ATEXIT, so
1519 * the programmer is not required to check the return value
1520 * (if there is any in the implementation) and doesn't encounter
1521 * missing include files.
1522 */
1523 void g_atexit (GVoidFunc func);
1524
1525
1526 /* Bit tests
1527 */
1528 G_INLINE_FUNC gint g_bit_nth_lsf (guint32 mask,
1529 gint nth_bit);
1530 #ifdef G_CAN_INLINE
1531 G_INLINE_FUNC gint
1532 g_bit_nth_lsf (guint32 mask,
1533 gint nth_bit)
1534 {
1535 do
1536 {
1537 nth_bit++;
1538 if (mask & (1 << (guint) nth_bit))
1539 return nth_bit;
1540 }
1541 while (nth_bit < 32);
1542 return -1;
1543 }
1544 #endif /* G_CAN_INLINE */
1545
1546 G_INLINE_FUNC gint g_bit_nth_msf (guint32 mask,
1547 gint nth_bit);
1548 #ifdef G_CAN_INLINE
1549 G_INLINE_FUNC gint
1550 g_bit_nth_msf (guint32 mask,
1551 gint nth_bit)
1552 {
1553 if (nth_bit < 0)
1554 nth_bit = 32;
1555 do
1556 {
1557 nth_bit--;
1558 if (mask & (1 << (guint) nth_bit))
1559 return nth_bit;
1560 }
1561 while (nth_bit > 0);
1562 return -1;
1563 }
1564 #endif /* G_CAN_INLINE */
1565
1566 G_INLINE_FUNC guint g_bit_storage (guint number);
1567 #ifdef G_CAN_INLINE
1568 G_INLINE_FUNC guint
1569 g_bit_storage (guint number)
1570 {
1571 register guint n_bits = 0;
1572
1573 do
1574 {
1575 n_bits++;
1576 number >>= 1;
1577 }
1578 while (number);
1579 return n_bits;
1580 }
1581 #endif /* G_CAN_INLINE */
1582
1583 /* String Chunks
1584 */
1585 GStringChunk* g_string_chunk_new (gint size);
1586 void g_string_chunk_free (GStringChunk *chunk);
1587 gchar* g_string_chunk_insert (GStringChunk *chunk,
1588 const gchar *string);
1589 gchar* g_string_chunk_insert_const (GStringChunk *chunk,
1590 const gchar *string);
1591
1592
1593 /* Strings
1594 */
1595 GString* g_string_new (const gchar *init);
1596 GString* g_string_sized_new (guint dfl_size);
1597 void g_string_free (GString *string,
1598 gint free_segment);
1599 GString* g_string_assign (GString *lval,
1600 const gchar *rval);
1601 GString* g_string_truncate (GString *string,
1602 gint len);
1603 GString* g_string_append (GString *string,
1604 const gchar *val);
1605 GString* g_string_append_c (GString *string,
1606 gchar c);
1607 GString* g_string_prepend (GString *string,
1608 const gchar *val);
1609 GString* g_string_prepend_c (GString *string,
1610 gchar c);
1611 GString* g_string_insert (GString *string,
1612 gint pos,
1613 const gchar *val);
1614 GString* g_string_insert_c (GString *string,
1615 gint pos,
1616 gchar c);
1617 GString* g_string_erase (GString *string,
1618 gint pos,
1619 gint len);
1620 GString* g_string_down (GString *string);
1621 GString* g_string_up (GString *string);
1622 void g_string_sprintf (GString *string,
1623 const gchar *format,
1624 ...) G_GNUC_PRINTF (2, 3);
1625 void g_string_sprintfa (GString *string,
1626 const gchar *format,
1627 ...) G_GNUC_PRINTF (2, 3);
1628
1629
1630 /* Resizable arrays, remove fills any cleared spot and shortens the
1631 * array, while preserving the order. remove_fast will distort the
1632 * order by moving the last element to the position of the removed
1633 */
1634
1635 #define g_array_append_val(a,v) g_array_append_vals(a,&v,1)
1636 #define g_array_prepend_val(a,v) g_array_prepend_vals(a,&v,1)
1637 #define g_array_insert_val(a,i,v) g_array_insert_vals(a,i,&v,1)
1638 #define g_array_index(a,t,i) (((t*)a->data)[i])
1639
1640 GArray* g_array_new (gboolean zero_terminated,
1641 gboolean clear,
1642 guint element_size);
1643 void g_array_free (GArray *array,
1644 gboolean free_segment);
1645 GArray* g_array_append_vals (GArray *array,
1646 gconstpointer data,
1647 guint len);
1648 GArray* g_array_prepend_vals (GArray *array,
1649 gconstpointer data,
1650 guint len);
1651 GArray* g_array_insert_vals (GArray *array,
1652 guint index,
1653 gconstpointer data,
1654 guint len);
1655 GArray* g_array_set_size (GArray *array,
1656 guint length);
1657 GArray* g_array_remove_index (GArray *array,
1658 guint index);
1659 GArray* g_array_remove_index_fast (GArray *array,
1660 guint index);
1661
1662 /* Resizable pointer array. This interface is much less complicated
1663 * than the above. Add appends appends a pointer. Remove fills any
1664 * cleared spot and shortens the array. remove_fast will again distort
1665 * order.
1666 */
1667 #define g_ptr_array_index(array,index) (array->pdata)[index]
1668 GPtrArray* g_ptr_array_new (void);
1669 void g_ptr_array_free (GPtrArray *array,
1670 gboolean free_seg);
1671 void g_ptr_array_set_size (GPtrArray *array,
1672 gint length);
1673 gpointer g_ptr_array_remove_index (GPtrArray *array,
1674 guint index);
1675 gpointer g_ptr_array_remove_index_fast (GPtrArray *array,
1676 guint index);
1677 gboolean g_ptr_array_remove (GPtrArray *array,
1678 gpointer data);
1679 gboolean g_ptr_array_remove_fast (GPtrArray *array,
1680 gpointer data);
1681 void g_ptr_array_add (GPtrArray *array,
1682 gpointer data);
1683
1684 /* Byte arrays, an array of guint8. Implemented as a GArray,
1685 * but type-safe.
1686 */
1687
1688 GByteArray* g_byte_array_new (void);
1689 void g_byte_array_free (GByteArray *array,
1690 gboolean free_segment);
1691 GByteArray* g_byte_array_append (GByteArray *array,
1692 const guint8 *data,
1693 guint len);
1694 GByteArray* g_byte_array_prepend (GByteArray *array,
1695 const guint8 *data,
1696 guint len);
1697 GByteArray* g_byte_array_set_size (GByteArray *array,
1698 guint length);
1699 GByteArray* g_byte_array_remove_index (GByteArray *array,
1700 guint index);
1701 GByteArray* g_byte_array_remove_index_fast (GByteArray *array,
1702 guint index);
1703
1704
1705 /* Hash Functions
1706 */
1707 gint g_str_equal (gconstpointer v,
1708 gconstpointer v2);
1709 guint g_str_hash (gconstpointer v);
1710
1711 gint g_int_equal (gconstpointer v,
1712 gconstpointer v2);
1713 guint g_int_hash (gconstpointer v);
1714
1715 /* This "hash" function will just return the key's adress as an
1716 * unsigned integer. Useful for hashing on plain adresses or
1717 * simple integer values.
1718 */
1719 guint g_direct_hash (gconstpointer v);
1720 gint g_direct_equal (gconstpointer v,
1721 gconstpointer v2);
1722
1723
1724 /* Quarks (string<->id association)
1725 */
1726 GQuark g_quark_try_string (const gchar *string);
1727 GQuark g_quark_from_static_string (const gchar *string);
1728 GQuark g_quark_from_string (const gchar *string);
1729 gchar* g_quark_to_string (GQuark quark);
1730
1731
1732 /* Keyed Data List
1733 */
1734 void g_datalist_init (GData **datalist);
1735 void g_datalist_clear (GData **datalist);
1736 gpointer g_datalist_id_get_data (GData **datalist,
1737 GQuark key_id);
1738 void g_datalist_id_set_data_full (GData **datalist,
1739 GQuark key_id,
1740 gpointer data,
1741 GDestroyNotify destroy_func);
1742 void g_datalist_id_remove_no_notify (GData **datalist,
1743 GQuark key_id);
1744 void g_datalist_foreach (GData **datalist,
1745 GDataForeachFunc func,
1746 gpointer user_data);
1747 #define g_datalist_id_set_data(dl, q, d) \
1748 g_datalist_id_set_data_full ((dl), (q), (d), NULL)
1749 #define g_datalist_id_remove_data(dl, q) \
1750 g_datalist_id_set_data ((dl), (q), NULL)
1751 #define g_datalist_get_data(dl, k) \
1752 (g_datalist_id_get_data ((dl), g_quark_try_string (k)))
1753 #define g_datalist_set_data_full(dl, k, d, f) \
1754 g_datalist_id_set_data_full ((dl), g_quark_from_string (k), (d), (f))
1755 #define g_datalist_remove_no_notify(dl, k) \
1756 g_datalist_id_remove_no_notify ((dl), g_quark_try_string (k))
1757 #define g_datalist_set_data(dl, k, d) \
1758 g_datalist_set_data_full ((dl), (k), (d), NULL)
1759 #define g_datalist_remove_data(dl, k) \
1760 g_datalist_id_set_data ((dl), g_quark_try_string (k), NULL)
1761
1762
1763 /* Location Associated Keyed Data
1764 */
1765 void g_dataset_destroy (gconstpointer dataset_location);
1766 gpointer g_dataset_id_get_data (gconstpointer dataset_location,
1767 GQuark key_id);
1768 void g_dataset_id_set_data_full (gconstpointer dataset_location,
1769 GQuark key_id,
1770 gpointer data,
1771 GDestroyNotify destroy_func);
1772 void g_dataset_id_remove_no_notify (gconstpointer dataset_location,
1773 GQuark key_id);
1774 void g_dataset_foreach (gconstpointer dataset_location,
1775 GDataForeachFunc func,
1776 gpointer user_data);
1777 #define g_dataset_id_set_data(l, k, d) \
1778 g_dataset_id_set_data_full ((l), (k), (d), NULL)
1779 #define g_dataset_id_remove_data(l, k) \
1780 g_dataset_id_set_data ((l), (k), NULL)
1781 #define g_dataset_get_data(l, k) \
1782 (g_dataset_id_get_data ((l), g_quark_try_string (k)))
1783 #define g_dataset_set_data_full(l, k, d, f) \
1784 g_dataset_id_set_data_full ((l), g_quark_from_string (k), (d), (f))
1785 #define g_dataset_remove_no_notify(l, k) \
1786 g_dataset_id_remove_no_notify ((l), g_quark_try_string (k))
1787 #define g_dataset_set_data(l, k, d) \
1788 g_dataset_set_data_full ((l), (k), (d), NULL)
1789 #define g_dataset_remove_data(l, k) \
1790 g_dataset_id_set_data ((l), g_quark_try_string (k), NULL)
1791
1792
1793 /* GScanner: Flexible lexical scanner for general purpose.
1794 */
1795
1796 /* Character sets */
1797 #define G_CSET_A_2_Z "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1798 #define G_CSET_a_2_z "abcdefghijklmnopqrstuvwxyz"
1799 #define G_CSET_LATINC "\300\301\302\303\304\305\306"\
1800 "\307\310\311\312\313\314\315\316\317\320"\
1801 "\321\322\323\324\325\326"\
1802 "\330\331\332\333\334\335\336"
1803 #define G_CSET_LATINS "\337\340\341\342\343\344\345\346"\
1804 "\347\350\351\352\353\354\355\356\357\360"\
1805 "\361\362\363\364\365\366"\
1806 "\370\371\372\373\374\375\376\377"
1807
1808 /* Error types */
1809 typedef enum
1810 {
1811 G_ERR_UNKNOWN,
1812 G_ERR_UNEXP_EOF,
1813 G_ERR_UNEXP_EOF_IN_STRING,
1814 G_ERR_UNEXP_EOF_IN_COMMENT,
1815 G_ERR_NON_DIGIT_IN_CONST,
1816 G_ERR_DIGIT_RADIX,
1817 G_ERR_FLOAT_RADIX,
1818 G_ERR_FLOAT_MALFORMED
1819 } GErrorType;
1820
1821 /* Token types */
1822 typedef enum
1823 {
1824 G_TOKEN_EOF = 0,
1825
1826 G_TOKEN_LEFT_PAREN = '(',
1827 G_TOKEN_RIGHT_PAREN = ')',
1828 G_TOKEN_LEFT_CURLY = '{',
1829 G_TOKEN_RIGHT_CURLY = '}',
1830 G_TOKEN_LEFT_BRACE = '[',
1831 G_TOKEN_RIGHT_BRACE = ']',
1832 G_TOKEN_EQUAL_SIGN = '=',
1833 G_TOKEN_COMMA = ',',
1834
1835 G_TOKEN_NONE = 256,
1836
1837 G_TOKEN_ERROR,
1838
1839 G_TOKEN_CHAR,
1840 G_TOKEN_BINARY,
1841 G_TOKEN_OCTAL,
1842 G_TOKEN_INT,
1843 G_TOKEN_HEX,
1844 G_TOKEN_FLOAT,
1845 G_TOKEN_STRING,
1846
1847 G_TOKEN_SYMBOL,
1848 G_TOKEN_IDENTIFIER,
1849 G_TOKEN_IDENTIFIER_NULL,
1850
1851 G_TOKEN_COMMENT_SINGLE,
1852 G_TOKEN_COMMENT_MULTI,
1853 G_TOKEN_LAST
1854 } GTokenType;
1855
1856 union _GTokenValue
1857 {
1858 gpointer v_symbol;
1859 gchar *v_identifier;
1860 gulong v_binary;
1861 gulong v_octal;
1862 gulong v_int;
1863 gdouble v_float;
1864 gulong v_hex;
1865 gchar *v_string;
1866 gchar *v_comment;
1867 guchar v_char;
1868 guint v_error;
1869 };
1870
1871 struct _GScannerConfig
1872 {
1873 /* Character sets
1874 */
1875 gchar *cset_skip_characters; /* default: " \t\n" */
1876 gchar *cset_identifier_first;
1877 gchar *cset_identifier_nth;
1878 gchar *cpair_comment_single; /* default: "#\n" */
1879
1880 /* Should symbol lookup work case sensitive?
1881 */
1882 guint case_sensitive : 1;
1883
1884 /* Boolean values to be adjusted "on the fly"
1885 * to configure scanning behaviour.
1886 */
1887 guint skip_comment_multi : 1; /* C like comment */
1888 guint skip_comment_single : 1; /* single line comment */
1889 guint scan_comment_multi : 1; /* scan multi line comments? */
1890 guint scan_identifier : 1;
1891 guint scan_identifier_1char : 1;
1892 guint scan_identifier_NULL : 1;
1893 guint scan_symbols : 1;
1894 guint scan_binary : 1;
1895 guint scan_octal : 1;
1896 guint scan_float : 1;
1897 guint scan_hex : 1; /* `0x0ff0' */
1898 guint scan_hex_dollar : 1; /* `$0ff0' */
1899 guint scan_string_sq : 1; /* string: 'anything' */
1900 guint scan_string_dq : 1; /* string: "\\-escapes!\n" */
1901 guint numbers_2_int : 1; /* bin, octal, hex => int */
1902 guint int_2_float : 1; /* int => G_TOKEN_FLOAT? */
1903 guint identifier_2_string : 1;
1904 guint char_2_token : 1; /* return G_TOKEN_CHAR? */
1905 guint symbol_2_token : 1;
1906 guint scope_0_fallback : 1; /* try scope 0 on lookups? */
1907 };
1908
1909 struct _GScanner
1910 {
1911 /* unused fields */
1912 gpointer user_data;
1913 guint max_parse_errors;
1914
1915 /* g_scanner_error() increments this field */
1916 guint parse_errors;
1917
1918 /* name of input stream, featured by the default message handler */
1919 const gchar *input_name;
1920
1921 /* data pointer for derived structures */
1922 gpointer derived_data;
1923
1924 /* link into the scanner configuration */
1925 GScannerConfig *config;
1926
1927 /* fields filled in after g_scanner_get_next_token() */
1928 GTokenType token;
1929 GTokenValue value;
1930 guint line;
1931 guint position;
1932
1933 /* fields filled in after g_scanner_peek_next_token() */
1934 GTokenType next_token;
1935 GTokenValue next_value;
1936 guint next_line;
1937 guint next_position;
1938
1939 /* to be considered private */
1940 GHashTable *symbol_table;
1941 gint input_fd;
1942 const gchar *text;
1943 const gchar *text_end;
1944 gchar *buffer;
1945 guint scope_id;
1946
1947 /* handler function for _warn and _error */
1948 GScannerMsgFunc msg_handler;
1949 };
1950
1951 GScanner* g_scanner_new (GScannerConfig *config_templ);
1952 void g_scanner_destroy (GScanner *scanner);
1953 void g_scanner_input_file (GScanner *scanner,
1954 gint input_fd);
1955 void g_scanner_sync_file_offset (GScanner *scanner);
1956 void g_scanner_input_text (GScanner *scanner,
1957 const gchar *text,
1958 guint text_len);
1959 GTokenType g_scanner_get_next_token (GScanner *scanner);
1960 GTokenType g_scanner_peek_next_token (GScanner *scanner);
1961 GTokenType g_scanner_cur_token (GScanner *scanner);
1962 GTokenValue g_scanner_cur_value (GScanner *scanner);
1963 guint g_scanner_cur_line (GScanner *scanner);
1964 guint g_scanner_cur_position (GScanner *scanner);
1965 gboolean g_scanner_eof (GScanner *scanner);
1966 guint g_scanner_set_scope (GScanner *scanner,
1967 guint scope_id);
1968 void g_scanner_scope_add_symbol (GScanner *scanner,
1969 guint scope_id,
1970 const gchar *symbol,
1971 gpointer value);
1972 void g_scanner_scope_remove_symbol (GScanner *scanner,
1973 guint scope_id,
1974 const gchar *symbol);
1975 gpointer g_scanner_scope_lookup_symbol (GScanner *scanner,
1976 guint scope_id,
1977 const gchar *symbol);
1978 void g_scanner_scope_foreach_symbol (GScanner *scanner,
1979 guint scope_id,
1980 GHFunc func,
1981 gpointer user_data);
1982 gpointer g_scanner_lookup_symbol (GScanner *scanner,
1983 const gchar *symbol);
1984 void g_scanner_freeze_symbol_table (GScanner *scanner);
1985 void g_scanner_thaw_symbol_table (GScanner *scanner);
1986 void g_scanner_unexp_token (GScanner *scanner,
1987 GTokenType expected_token,
1988 const gchar *identifier_spec,
1989 const gchar *symbol_spec,
1990 const gchar *symbol_name,
1991 const gchar *message,
1992 gint is_error);
1993 void g_scanner_error (GScanner *scanner,
1994 const gchar *format,
1995 ...) G_GNUC_PRINTF (2,3);
1996 void g_scanner_warn (GScanner *scanner,
1997 const gchar *format,
1998 ...) G_GNUC_PRINTF (2,3);
1999 gint g_scanner_stat_mode (const gchar *filename);
2000 /* keep downward source compatibility */
2001 #define g_scanner_add_symbol( scanner, symbol, value ) G_STMT_START { \
2002 g_scanner_scope_add_symbol ((scanner), 0, (symbol), (value)); \
2003 } G_STMT_END
2004 #define g_scanner_remove_symbol( scanner, symbol ) G_STMT_START { \
2005 g_scanner_scope_remove_symbol ((scanner), 0, (symbol)); \
2006 } G_STMT_END
2007 #define g_scanner_foreach_symbol( scanner, func, data ) G_STMT_START { \
2008 g_scanner_scope_foreach_symbol ((scanner), 0, (func), (data)); \
2009 } G_STMT_END
2010
2011
2012 /* GCompletion
2013 */
2014
2015 struct _GCompletion
2016 {
2017 GList* items;
2018 GCompletionFunc func;
2019
2020 gchar* prefix;
2021 GList* cache;
2022 };
2023
2024 GCompletion* g_completion_new (GCompletionFunc func);
2025 void g_completion_add_items (GCompletion* cmp,
2026 GList* items);
2027 void g_completion_remove_items (GCompletion* cmp,
2028 GList* items);
2029 void g_completion_clear_items (GCompletion* cmp);
2030 GList* g_completion_complete (GCompletion* cmp,
2031 gchar* prefix,
2032 gchar** new_prefix);
2033 void g_completion_free (GCompletion* cmp);
2034
2035
2036 /* GDate
2037 *
2038 * Date calculations (not time for now, to be resolved). These are a
2039 * mutant combination of Steffen Beyer's DateCalc routines
2040 * (http://www.perl.com/CPAN/authors/id/STBEY/) and Jon Trowbridge's
2041 * date routines (written for in-house software). Written by Havoc
2042 * Pennington <hp@pobox.com>
2043 */
2044
2045 typedef guint16 GDateYear;
2046 typedef guint8 GDateDay; /* day of the month */
2047 typedef struct _GDate GDate;
2048 /* make struct tm known without having to include time.h */
2049 struct tm;
2050
2051 /* enum used to specify order of appearance in parsed date strings */
2052 typedef enum
2053 {
2054 G_DATE_DAY = 0,
2055 G_DATE_MONTH = 1,
2056 G_DATE_YEAR = 2
2057 } GDateDMY;
2058
2059 /* actual week and month values */
2060 typedef enum
2061 {
2062 G_DATE_BAD_WEEKDAY = 0,
2063 G_DATE_MONDAY = 1,
2064 G_DATE_TUESDAY = 2,
2065 G_DATE_WEDNESDAY = 3,
2066 G_DATE_THURSDAY = 4,
2067 G_DATE_FRIDAY = 5,
2068 G_DATE_SATURDAY = 6,
2069 G_DATE_SUNDAY = 7
2070 } GDateWeekday;
2071 typedef enum
2072 {
2073 G_DATE_BAD_MONTH = 0,
2074 G_DATE_JANUARY = 1,
2075 G_DATE_FEBRUARY = 2,
2076 G_DATE_MARCH = 3,
2077 G_DATE_APRIL = 4,
2078 G_DATE_MAY = 5,
2079 G_DATE_JUNE = 6,
2080 G_DATE_JULY = 7,
2081 G_DATE_AUGUST = 8,
2082 G_DATE_SEPTEMBER = 9,
2083 G_DATE_OCTOBER = 10,
2084 G_DATE_NOVEMBER = 11,
2085 G_DATE_DECEMBER = 12
2086 } GDateMonth;
2087
2088 #define G_DATE_BAD_JULIAN 0U
2089 #define G_DATE_BAD_DAY 0U
2090 #define G_DATE_BAD_YEAR 0U
2091
2092 /* Note: directly manipulating structs is generally a bad idea, but
2093 * in this case it's an *incredibly* bad idea, because all or part
2094 * of this struct can be invalid at any given time. Use the functions,
2095 * or you will get hosed, I promise.
2096 */
2097 struct _GDate
2098 {
2099 guint julian_days : 32; /* julian days representation - we use a
2100 * bitfield hoping that 64 bit platforms
2101 * will pack this whole struct in one big
2102 * int
2103 */
2104
2105 guint julian : 1; /* julian is valid */
2106 guint dmy : 1; /* dmy is valid */
2107
2108 /* DMY representation */
2109 guint day : 6;
2110 guint month : 4;
2111 guint year : 16;
2112 };
2113
2114 /* g_date_new() returns an invalid date, you then have to _set() stuff
2115 * to get a usable object. You can also allocate a GDate statically,
2116 * then call g_date_clear() to initialize.
2117 */
2118 GDate* g_date_new (void);
2119 GDate* g_date_new_dmy (GDateDay day,
2120 GDateMonth month,
2121 GDateYear year);
2122 GDate* g_date_new_julian (guint32 julian_day);
2123 void g_date_free (GDate *date);
2124
2125 /* check g_date_valid() after doing an operation that might fail, like
2126 * _parse. Almost all g_date operations are undefined on invalid
2127 * dates (the exceptions are the mutators, since you need those to
2128 * return to validity).
2129 */
2130 gboolean g_date_valid (GDate *date);
2131 gboolean g_date_valid_day (GDateDay day);
2132 gboolean g_date_valid_month (GDateMonth month);
2133 gboolean g_date_valid_year (GDateYear year);
2134 gboolean g_date_valid_weekday (GDateWeekday weekday);
2135 gboolean g_date_valid_julian (guint32 julian_date);
2136 gboolean g_date_valid_dmy (GDateDay day,
2137 GDateMonth month,
2138 GDateYear year);
2139
2140 GDateWeekday g_date_weekday (GDate *date);
2141 GDateMonth g_date_month (GDate *date);
2142 GDateYear g_date_year (GDate *date);
2143 GDateDay g_date_day (GDate *date);
2144 guint32 g_date_julian (GDate *date);
2145 guint g_date_day_of_year (GDate *date);
2146
2147 /* First monday/sunday is the start of week 1; if we haven't reached
2148 * that day, return 0. These are not ISO weeks of the year; that
2149 * routine needs to be added.
2150 * these functions return the number of weeks, starting on the
2151 * corrsponding day
2152 */
2153 guint g_date_monday_week_of_year (GDate *date);
2154 guint g_date_sunday_week_of_year (GDate *date);
2155
2156 /* If you create a static date struct you need to clear it to get it
2157 * in a sane state before use. You can clear a whole array at
2158 * once with the ndates argument.
2159 */
2160 void g_date_clear (GDate *date,
2161 guint n_dates);
2162
2163 /* The parse routine is meant for dates typed in by a user, so it
2164 * permits many formats but tries to catch common typos. If your data
2165 * needs to be strictly validated, it is not an appropriate function.
2166 */
2167 void g_date_set_parse (GDate *date,
2168 const gchar *str);
2169 void g_date_set_time (GDate *date,
2170 GTime time);
2171 void g_date_set_month (GDate *date,
2172 GDateMonth month);
2173 void g_date_set_day (GDate *date,
2174 GDateDay day);
2175 void g_date_set_year (GDate *date,
2176 GDateYear year);
2177 void g_date_set_dmy (GDate *date,
2178 GDateDay day,
2179 GDateMonth month,
2180 GDateYear y);
2181 void g_date_set_julian (GDate *date,
2182 guint32 julian_date);
2183 gboolean g_date_is_first_of_month (GDate *date);
2184 gboolean g_date_is_last_of_month (GDate *date);
2185
2186 /* To go forward by some number of weeks just go forward weeks*7 days */
2187 void g_date_add_days (GDate *date,
2188 guint n_days);
2189 void g_date_subtract_days (GDate *date,
2190 guint n_days);
2191
2192 /* If you add/sub months while day > 28, the day might change */
2193 void g_date_add_months (GDate *date,
2194 guint n_months);
2195 void g_date_subtract_months (GDate *date,
2196 guint n_months);
2197
2198 /* If it's feb 29, changing years can move you to the 28th */
2199 void g_date_add_years (GDate *date,
2200 guint n_years);
2201 void g_date_subtract_years (GDate *date,
2202 guint n_years);
2203 gboolean g_date_is_leap_year (GDateYear year);
2204 guint8 g_date_days_in_month (GDateMonth month,
2205 GDateYear year);
2206 guint8 g_date_monday_weeks_in_year (GDateYear year);
2207 guint8 g_date_sunday_weeks_in_year (GDateYear year);
2208
2209 /* qsort-friendly (with a cast...) */
2210 gint g_date_compare (GDate *lhs,
2211 GDate *rhs);
2212 void g_date_to_struct_tm (GDate *date,
2213 struct tm *tm);
2214
2215 /* Just like strftime() except you can only use date-related formats.
2216 * Using a time format is undefined.
2217 */
2218 gsize g_date_strftime (gchar *s,
2219 gsize slen,
2220 const gchar *format,
2221 GDate *date);
2222
2223
2224 /* GRelation
2225 *
2226 * Indexed Relations. Imagine a really simple table in a
2227 * database. Relations are not ordered. This data type is meant for
2228 * maintaining a N-way mapping.
2229 *
2230 * g_relation_new() creates a relation with FIELDS fields
2231 *
2232 * g_relation_destroy() frees all resources
2233 * g_tuples_destroy() frees the result of g_relation_select()
2234 *
2235 * g_relation_index() indexes relation FIELD with the provided
2236 * equality and hash functions. this must be done before any
2237 * calls to insert are made.
2238 *
2239 * g_relation_insert() inserts a new tuple. you are expected to
2240 * provide the right number of fields.
2241 *
2242 * g_relation_delete() deletes all relations with KEY in FIELD
2243 * g_relation_select() returns ...
2244 * g_relation_count() counts ...
2245 */
2246
2247 GRelation* g_relation_new (gint fields);
2248 void g_relation_destroy (GRelation *relation);
2249 void g_relation_index (GRelation *relation,
2250 gint field,
2251 GHashFunc hash_func,
2252 GCompareFunc key_compare_func);
2253 void g_relation_insert (GRelation *relation,
2254 ...);
2255 gint g_relation_delete (GRelation *relation,
2256 gconstpointer key,
2257 gint field);
2258 GTuples* g_relation_select (GRelation *relation,
2259 gconstpointer key,
2260 gint field);
2261 gint g_relation_count (GRelation *relation,
2262 gconstpointer key,
2263 gint field);
2264 gboolean g_relation_exists (GRelation *relation,
2265 ...);
2266 void g_relation_print (GRelation *relation);
2267
2268 void g_tuples_destroy (GTuples *tuples);
2269 gpointer g_tuples_index (GTuples *tuples,
2270 gint index,
2271 gint field);
2272
2273
2274 /* Prime numbers.
2275 */
2276
2277 /* This function returns prime numbers spaced by approximately 1.5-2.0
2278 * and is for use in resizing data structures which prefer
2279 * prime-valued sizes. The closest spaced prime function returns the
2280 * next largest prime, or the highest it knows about which is about
2281 * MAXINT/4.
2282 */
2283 guint g_spaced_primes_closest (guint num);
2284
2285
2286 /* GIOChannel
2287 */
2288
2289 typedef struct _GIOFuncs GIOFuncs;
2290 typedef enum
2291 {
2292 G_IO_ERROR_NONE,
2293 G_IO_ERROR_AGAIN,
2294 G_IO_ERROR_INVAL,
2295 G_IO_ERROR_UNKNOWN
2296 } GIOError;
2297 typedef enum
2298 {
2299 G_SEEK_CUR,
2300 G_SEEK_SET,
2301 G_SEEK_END
2302 } GSeekType;
2303 typedef enum
2304 {
2305 G_IO_IN GLIB_SYSDEF_POLLIN,
2306 G_IO_OUT GLIB_SYSDEF_POLLOUT,
2307 G_IO_PRI GLIB_SYSDEF_POLLPRI,
2308 G_IO_ERR GLIB_SYSDEF_POLLERR,
2309 G_IO_HUP GLIB_SYSDEF_POLLHUP,
2310 G_IO_NVAL GLIB_SYSDEF_POLLNVAL
2311 } GIOCondition;
2312
2313 struct _GIOChannel
2314 {
2315 guint channel_flags;
2316 guint ref_count;
2317 GIOFuncs *funcs;
2318 };
2319
2320 typedef gboolean (*GIOFunc) (GIOChannel *source,
2321 GIOCondition condition,
2322 gpointer data);
2323 struct _GIOFuncs
2324 {
2325 GIOError (*io_read) (GIOChannel *channel,
2326 gchar *buf,
2327 guint count,
2328 guint *bytes_read);
2329 GIOError (*io_write) (GIOChannel *channel,
2330 gchar *buf,
2331 guint count,
2332 guint *bytes_written);
2333 GIOError (*io_seek) (GIOChannel *channel,
2334 gint offset,
2335 GSeekType type);
2336 void (*io_close) (GIOChannel *channel);
2337 guint (*io_add_watch) (GIOChannel *channel,
2338 gint priority,
2339 GIOCondition condition,
2340 GIOFunc func,
2341 gpointer user_data,
2342 GDestroyNotify notify);
2343 void (*io_free) (GIOChannel *channel);
2344 };
2345
2346 void g_io_channel_init (GIOChannel *channel);
2347 void g_io_channel_ref (GIOChannel *channel);
2348 void g_io_channel_unref (GIOChannel *channel);
2349 GIOError g_io_channel_read (GIOChannel *channel,
2350 gchar *buf,
2351 guint count,
2352 guint *bytes_read);
2353 GIOError g_io_channel_write (GIOChannel *channel,
2354 gchar *buf,
2355 guint count,
2356 guint *bytes_written);
2357 GIOError g_io_channel_seek (GIOChannel *channel,
2358 gint offset,
2359 GSeekType type);
2360 void g_io_channel_close (GIOChannel *channel);
2361 guint g_io_add_watch_full (GIOChannel *channel,
2362 gint priority,
2363 GIOCondition condition,
2364 GIOFunc func,
2365 gpointer user_data,
2366 GDestroyNotify notify);
2367 guint g_io_add_watch (GIOChannel *channel,
2368 GIOCondition condition,
2369 GIOFunc func,
2370 gpointer user_data);
2371
2372
2373 /* Main loop
2374 */
2375 typedef struct _GTimeVal GTimeVal;
2376 typedef struct _GSourceFuncs GSourceFuncs;
2377 typedef struct _GMainLoop GMainLoop; /* Opaque */
2378
2379 struct _GTimeVal
2380 {
2381 glong tv_sec;
2382 glong tv_usec;
2383 };
2384 struct _GSourceFuncs
2385 {
2386 gboolean (*prepare) (gpointer source_data,
2387 GTimeVal *current_time,
2388 gint *timeout);
2389 gboolean (*check) (gpointer source_data,
2390 GTimeVal *current_time);
2391 gboolean (*dispatch) (gpointer source_data,
2392 GTimeVal *current_time,
2393 gpointer user_data);
2394 GDestroyNotify destroy;
2395 };
2396
2397 /* Standard priorities */
2398
2399 #define G_PRIORITY_HIGH -100
2400 #define G_PRIORITY_DEFAULT 0
2401 #define G_PRIORITY_HIGH_IDLE 100
2402 #define G_PRIORITY_DEFAULT_IDLE 200
2403 #define G_PRIORITY_LOW 300
2404
2405 typedef gboolean (*GSourceFunc) (gpointer data);
2406
2407 /* Hooks for adding to the main loop */
2408 guint g_source_add (gint priority,
2409 gboolean can_recurse,
2410 GSourceFuncs *funcs,
2411 gpointer source_data,
2412 gpointer user_data,
2413 GDestroyNotify notify);
2414 gboolean g_source_remove (guint tag);
2415 gboolean g_source_remove_by_user_data (gpointer user_data);
2416 gboolean g_source_remove_by_source_data (gpointer source_data);
2417 gboolean g_source_remove_by_funcs_user_data (GSourceFuncs *funcs,
2418 gpointer user_data);
2419
2420 void g_get_current_time (GTimeVal *result);
2421
2422 /* Running the main loop */
2423 GMainLoop* g_main_new (gboolean is_running);
2424 void g_main_run (GMainLoop *loop);
2425 void g_main_quit (GMainLoop *loop);
2426 void g_main_destroy (GMainLoop *loop);
2427 gboolean g_main_is_running (GMainLoop *loop);
2428
2429 /* Run a single iteration of the mainloop. If block is FALSE,
2430 * will never block
2431 */
2432 gboolean g_main_iteration (gboolean may_block);
2433
2434 /* See if any events are pending */
2435 gboolean g_main_pending (void);
2436
2437 /* Idles and timeouts */
2438 guint g_timeout_add_full (gint priority,
2439 guint interval,
2440 GSourceFunc function,
2441 gpointer data,
2442 GDestroyNotify notify);
2443 guint g_timeout_add (guint interval,
2444 GSourceFunc function,
2445 gpointer data);
2446 guint g_idle_add (GSourceFunc function,
2447 gpointer data);
2448 guint g_idle_add_full (gint priority,
2449 GSourceFunc function,
2450 gpointer data,
2451 GDestroyNotify destroy);
2452 gboolean g_idle_remove_by_data (gpointer data);
2453
2454 /* GPollFD
2455 *
2456 * System-specific IO and main loop calls
2457 *
2458 * On Win32, the fd in a GPollFD should be Win32 HANDLE (*not* a file
2459 * descriptor as provided by the C runtime) that can be used by
2460 * MsgWaitForMultipleObjects. This does *not* include file handles
2461 * from CreateFile, SOCKETs, nor pipe handles. (But you can use
2462 * WSAEventSelect to signal events when a SOCKET is readable).
2463 *
2464 * On Win32, fd can also be the special value G_WIN32_MSG_HANDLE to
2465 * indicate polling for messages. These message queue GPollFDs should
2466 * be added with the g_main_poll_win32_msg_add function.
2467 *
2468 * But note that G_WIN32_MSG_HANDLE GPollFDs should not be used by GDK
2469 * (GTK) programs, as GDK itself wants to read messages and convert them
2470 * to GDK events.
2471 *
2472 * So, unless you really know what you are doing, it's best not to try
2473 * to use the main loop polling stuff for your own needs on
2474 * Win32. It's really only written for the GIMP's needs so
2475 * far.
2476 */
2477
2478 typedef struct _GPollFD GPollFD;
2479 typedef gint (*GPollFunc) (GPollFD *ufds,
2480 guint nfsd,
2481 gint timeout);
2482 struct _GPollFD
2483 {
2484 gint fd;
2485 gushort events;
2486 gushort revents;
2487 };
2488
2489 void g_main_add_poll (GPollFD *fd,
2490 gint priority);
2491 void g_main_remove_poll (GPollFD *fd);
2492 void g_main_set_poll_func (GPollFunc func);
2493
2494 /* On Unix, IO channels created with this function for any file
2495 * descriptor or socket.
2496 *
2497 * On Win32, use this only for plain files opened with the MSVCRT (the
2498 * Microsoft run-time C library) _open(), including file descriptors
2499 * 0, 1 and 2 (corresponding to stdin, stdout and stderr).
2500 * Actually, don't do even that, this code isn't done yet.
2501 *
2502 * The term file descriptor as used in the context of Win32 refers to
2503 * the emulated Unix-like file descriptors MSVCRT provides.
2504 */
2505 GIOChannel* g_io_channel_unix_new (int fd);
2506 gint g_io_channel_unix_get_fd (GIOChannel *channel);
2507
2508 #ifdef NATIVE_WIN32
2509
2510 GUTILS_C_VAR guint g_pipe_readable_msg;
2511
2512 #define G_WIN32_MSG_HANDLE 19981206
2513
2514 /* This is used to add polling for Windows messages. GDK (GTk+) programs
2515 * should *not* use this. (In fact, I can't think of any program that
2516 * would want to use this, but it's here just for completeness's sake.
2517 */
2518 void g_main_poll_win32_msg_add(gint priority,
2519 GPollFD *fd,
2520 guint hwnd);
2521
2522 /* An IO channel for Windows messages for window handle hwnd. */
2523 GIOChannel *g_io_channel_win32_new_messages (guint hwnd);
2524
2525 /* An IO channel for an anonymous pipe as returned from the MSVCRT
2526 * _pipe(), with no mechanism for the writer to tell the reader when
2527 * there is data in the pipe.
2528 *
2529 * This is not really implemented yet.
2530 */
2531 GIOChannel *g_io_channel_win32_new_pipe (int fd);
2532
2533 /* An IO channel for a pipe as returned from the MSVCRT _pipe(), with
2534 * Windows user messages used to signal data in the pipe for the
2535 * reader.
2536 *
2537 * fd is the file descriptor. For the write end, peer is the thread id
2538 * of the reader, and peer_fd is his file descriptor for the read end
2539 * of the pipe.
2540 *
2541 * This is used by the GIMP, and works.
2542 */
2543 GIOChannel *g_io_channel_win32_new_pipe_with_wakeups (int fd,
2544 guint peer,
2545 int peer_fd);
2546
2547 void g_io_channel_win32_pipe_request_wakeups (GIOChannel *channel,
2548 guint peer,
2549 int peer_fd);
2550
2551 void g_io_channel_win32_pipe_readable (int fd,
2552 guint offset);
2553
2554 /* Get the C runtime file descriptor of a channel. */
2555 gint g_io_channel_win32_get_fd (GIOChannel *channel);
2556
2557 /* An IO channel for a SOCK_STREAM winsock socket. The parameter is
2558 * actually a SOCKET.
2559 */
2560 GIOChannel *g_io_channel_win32_new_stream_socket (int socket);
2561
2562 #endif
2563
2564 /* Windows emulation stubs for common Unix functions
2565 */
2566 #ifdef NATIVE_WIN32
2567 # define MAXPATHLEN 1024
2568 # ifdef _MSC_VER
2569 typedef int pid_t;
2570
2571 /* These POSIXish functions are available in the Microsoft C library
2572 * prefixed with underscore (which of course technically speaking is
2573 * the Right Thing, as they are non-ANSI. Not that being non-ANSI
2574 * prevents Microsoft from practically requiring you to include
2575 * <windows.h> every now and then...).
2576 *
2577 * You still need to include the appropriate headers to get the
2578 * prototypes, <io.h> or <direct.h>.
2579 *
2580 * For some functions, we provide emulators in glib, which are prefixed
2581 * with gwin_.
2582 */
2583 # define getcwd _getcwd
2584 # define getpid _getpid
2585 # define access _access
2586 # define open _open
2587 # define read _read
2588 # define write _write
2589 # define lseek _lseek
2590 # define close _close
2591 # define pipe(phandles) _pipe (phandles, 4096, _O_BINARY)
2592 # define popen _popen
2593 # define pclose _pclose
2594 # define fdopen _fdopen
2595 # define ftruncate(fd, size) gwin_ftruncate (fd, size)
2596 # define opendir gwin_opendir
2597 # define readdir gwin_readdir
2598 # define rewinddir gwin_rewinddir
2599 # define closedir gwin_closedir
2600 # define NAME_MAX 255
2601 struct DIR
2602 {
2603 gchar *dir_name;
2604 gboolean just_opened;
2605 guint find_file_handle;
2606 gpointer find_file_data;
2607 };
2608 typedef struct DIR DIR;
2609 struct dirent
2610 {
2611 gchar d_name[NAME_MAX + 1];
2612 };
2613 /* emulation functions */
2614 extern int gwin_ftruncate (gint f,
2615 guint size);
2616 DIR* gwin_opendir (const gchar *dirname);
2617 struct dirent* gwin_readdir (DIR *dir);
2618 void gwin_rewinddir (DIR *dir);
2619 gint gwin_closedir (DIR *dir);
2620 # endif /* _MSC_VER */
2621 #endif /* NATIVE_WIN32 */
2622
2623
2624 /* GLib Thread support
2625 */
2626 typedef struct _GMutex GMutex;
2627 typedef struct _GCond GCond;
2628 typedef struct _GPrivate GPrivate;
2629 typedef struct _GStaticPrivate GStaticPrivate;
2630 typedef struct _GThreadFunctions GThreadFunctions;
2631 struct _GThreadFunctions
2632 {
2633 GMutex* (*mutex_new) (void);
2634 void (*mutex_lock) (GMutex *mutex);
2635 gboolean (*mutex_trylock) (GMutex *mutex);
2636 void (*mutex_unlock) (GMutex *mutex);
2637 void (*mutex_free) (GMutex *mutex);
2638 GCond* (*cond_new) (void);
2639 void (*cond_signal) (GCond *cond);
2640 void (*cond_broadcast) (GCond *cond);
2641 void (*cond_wait) (GCond *cond,
2642 GMutex *mutex);
2643 gboolean (*cond_timed_wait) (GCond *cond,
2644 GMutex *mutex,
2645 GTimeVal *end_time);
2646 void (*cond_free) (GCond *cond);
2647 GPrivate* (*private_new) (GDestroyNotify destructor);
2648 gpointer (*private_get) (GPrivate *private_key);
2649 void (*private_set) (GPrivate *private_key,
2650 gpointer data);
2651 };
2652
2653 GUTILS_C_VAR GThreadFunctions g_thread_functions_for_glib_use;
2654 GUTILS_C_VAR gboolean g_thread_use_default_impl;
2655 GUTILS_C_VAR gboolean g_threads_got_initialized;
2656
2657 /* initializes the mutex/cond/private implementation for glib, might
2658 * only be called once, and must not be called directly or indirectly
2659 * from another glib-function, e.g. as a callback.
2660 */
2661 void g_thread_init (GThreadFunctions *vtable);
2662
2663 /* internal function for fallback static mutex implementation */
2664 GMutex* g_static_mutex_get_mutex_impl (GMutex **mutex);
2665
2666 /* shorthands for conditional and unconditional function calls */
2667 #define G_THREAD_UF(name, arglist) \
2668 (*g_thread_functions_for_glib_use . name) arglist
2669 #define G_THREAD_CF(name, fail, arg) \
2670 (g_thread_supported () ? G_THREAD_UF (name, arg) : (fail))
2671 /* keep in mind, all those mutexes and static mutexes are not
2672 * recursive in general, don't rely on that
2673 */
2674 #define g_thread_supported() (g_threads_got_initialized)
2675 #define g_mutex_new() G_THREAD_UF (mutex_new, ())
2676 #define g_mutex_lock(mutex) G_THREAD_CF (mutex_lock, (void)0, (mutex))
2677 #define g_mutex_trylock(mutex) G_THREAD_CF (mutex_trylock, TRUE, (mutex))
2678 #define g_mutex_unlock(mutex) G_THREAD_CF (mutex_unlock, (void)0, (mutex))
2679 #define g_mutex_free(mutex) G_THREAD_CF (mutex_free, (void)0, (mutex))
2680 #define g_cond_new() G_THREAD_UF (cond_new, ())
2681 #define g_cond_signal(cond) G_THREAD_CF (cond_signal, (void)0, (cond))
2682 #define g_cond_broadcast(cond) G_THREAD_CF (cond_broadcast, (void)0, (cond))
2683 #define g_cond_wait(cond, mutex) G_THREAD_CF (cond_wait, (void)0, (cond, \
2684 mutex))
2685 #define g_cond_free(cond) G_THREAD_CF (cond_free, (void)0, (cond))
2686 #define g_cond_timed_wait(cond, mutex, abs_time) G_THREAD_CF (cond_timed_wait, \
2687 TRUE, \
2688 (cond, mutex, \
2689 abs_time))
2690 #define g_private_new(destructor) G_THREAD_UF (private_new, (destructor))
2691 #define g_private_get(private_key) G_THREAD_CF (private_get, \
2692 ((gpointer)private_key), \
2693 (private_key))
2694 #define g_private_set(private_key, value) G_THREAD_CF (private_set, \
2695 (void) (private_key = \
2696 (GPrivate*) (value)), \
2697 (private_key, value))
2698 /* GStaticMutexes can be statically initialized with the value
2699 * G_STATIC_MUTEX_INIT, and then they can directly be used, that is
2700 * much easier, than having to explicitly allocate the mutex before
2701 * use
2702 */
2703 #define g_static_mutex_lock(mutex) \
2704 g_mutex_lock (g_static_mutex_get_mutex (mutex))
2705 #define g_static_mutex_trylock(mutex) \
2706 g_mutex_trylock (g_static_mutex_get_mutex (mutex))
2707 #define g_static_mutex_unlock(mutex) \
2708 g_mutex_unlock (g_static_mutex_get_mutex (mutex))
2709 struct _GStaticPrivate
2710 {
2711 guint index;
2712 };
2713 #define G_STATIC_PRIVATE_INIT { 0 }
2714 gpointer g_static_private_get (GStaticPrivate *private_key);
2715 void g_static_private_set (GStaticPrivate *private_key,
2716 gpointer data,
2717 GDestroyNotify notify);
2718
2719 /* these are some convenience macros that expand to nothing if GLib was
2720 * configured with --deisable-threads. for using StaticMutexes, you
2721 * declare them with G_LOCK_DECLARE_STATIC (name) or G_LOCK_DECLARE (name)
2722 * if you need to export the mutex. name is a unique identifier for the
2723 * protected varibale or code portion. locking, testing and unlocking of
2724 * such mutexes can be done with G_LOCK(), G_UNLOCK() and G_TRYLOCK()
2725 * respectively.
2726 */
2727 extern void glib_dummy_decl (void);
2728 #define G_LOCK_NAME(name) (g__ ## name ## _lock)
2729 #ifdef G_THREADS_ENABLED
2730 # define G_LOCK_DECLARE_STATIC(name) static G_LOCK_DECLARE (name)
2731 # define G_LOCK_DECLARE(name) \
2732 GStaticMutex G_LOCK_NAME (name) = G_STATIC_MUTEX_INIT
2733
2734 # ifdef G_DEBUG_LOCKS
2735 # define G_LOCK(name) G_STMT_START{ \
2736 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
2737 "file %s: line %d (%s): locking: %s ", \
2738 __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION, \
2739 #name); \
2740 g_static_mutex_lock (G_LOCK_NAME (name)); \
2741 }G_STMT_END
2742 # define G_UNLOCK(name) G_STMT_START{ \
2743 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
2744 "file %s: line %d (%s): unlocking: %s ", \
2745 __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION, \
2746 #name); \
2747 g_static_mutex_unlock (G_LOCK_NAME (name)); \
2748 }G_STMT_END
2749 # define G_TRYLOCK(name) G_STMT_START{ \
2750 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, \
2751 "file %s: line %d (%s): try locking: %s ", \
2752 __FILE__, __LINE__, G_GNUC_PRETTY_FUNCTION, \
2753 #name); \
2754 }G_STMT_END, g_static_mutex_trylock (G_LOCK_NAME (name))
2755 # else /* !G_DEBUG_LOCKS */
2756 # define G_LOCK(name) g_static_mutex_lock (G_LOCK_NAME (name))
2757 # define G_UNLOCK(name) g_static_mutex_unlock (G_LOCK_NAME (name))
2758 # define G_TRYLOCK(name) g_static_mutex_trylock (G_LOCK_NAME (name))
2759 # endif /* !G_DEBUG_LOCKS */
2760 #else /* !G_THREADS_ENABLED */
2761 # define G_LOCK_DECLARE_STATIC(name) extern void glib_dummy_decl (void)
2762 # define G_LOCK_DECLARE(name) extern void glib_dummy_decl (void)
2763 # define G_LOCK(name)
2764 # define G_UNLOCK(name)
2765 # define G_TRYLOCK(name) (FALSE)
2766 #endif /* !G_THREADS_ENABLED */
2767
2768 #ifdef __cplusplus
2769 }
2770 #endif /* __cplusplus */
2771
2772
2773 #endif /* __G_LIB_H__ */
glib mirror