glib/glib.h

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