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