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 #ifndef __G_LIB_H__
  20 #define __G_LIB_H__
  21
  22 /* system specific config file
  23  */
  24 #include <glibconfig.h>
  25
  26 /* include varargs functions for assertment macros
  27  */
  28 #include <stdarg.h>
  29
  30 /* optionally feature DMALLOC memory allocation debugger
  31  */
  32 #ifdef USE_DMALLOC
  33 #include "dmalloc.h"
  34 #endif
  35
  36
  37 /* glib provides definitions for the extrema of many
  38  *  of the standard types. These are:
  39  * G_MINFLOAT
  40  * G_MAXFLOAT
  41  * G_MINDOUBLE
  42  * G_MAXDOUBLE
  43  * G_MINSHORT
  44  * G_MAXSHORT
  45  * G_MININT
  46  * G_MAXINT
  47  * G_MINLONG
  48  * G_MAXLONG
  49  */
  50
  51 #ifdef HAVE_FLOAT_H
  52
  53 #include <float.h>
  54
  55 #define G_MINFLOAT   FLT_MIN
  56 #define G_MAXFLOAT   FLT_MAX
  57 #define G_MINDOUBLE  DBL_MIN
  58 #define G_MAXDOUBLE  DBL_MAX
  59
  60 #elif HAVE_VALUES_H
  61
  62 #include <values.h>
  63
  64 #define G_MINFLOAT  MINFLOAT
  65 #define G_MAXFLOAT  MAXFLOAT
  66 #define G_MINDOUBLE MINDOUBLE
  67 #define G_MAXDOUBLE MAXDOUBLE
  68
  69 #endif /* HAVE_VALUES_H */
  70
  71 #ifdef HAVE_LIMITS_H
  72
  73 #include <limits.h>
  74
  75 #define G_MINSHORT  SHRT_MIN
  76 #define G_MAXSHORT  SHRT_MAX
  77 #define G_MININT    INT_MIN
  78 #define G_MAXINT    INT_MAX
  79 #define G_MINLONG   LONG_MIN
  80 #define G_MAXLONG   LONG_MAX
  81
  82 #elif HAVE_VALUES_H
  83
  84 #ifdef HAVE_FLOAT_H
  85 #include <values.h>
  86 #endif /* HAVE_FLOAT_H */
  87
  88 #define G_MINSHORT  MINSHORT
  89 #define G_MAXSHORT  MAXSHORT
  90 #define G_MININT    MININT
  91 #define G_MAXINT    MAXINT
  92 #define G_MINLONG   MINLONG
  93 #define G_MAXLONG   MAXLONG
  94
  95 #endif /* HAVE_VALUES_H */
  96
  97
  98 /* the #pragma } statment is used to fix up emacs' c-mode which gets
  99  * confused by extern "C" {. the ansi standard says that compilers
 100  * have to ignore #pragma directives that they don't know about,
 101  * so we should be save in using this.
 102  */
 103 #ifdef __cplusplus
 104 extern "C" {
 105 #pragma }
 106 #endif /* __cplusplus */
 107
 108
 109 /* Provide definitions for some commonly used macros.
 110  *  Some of them are only provided if they haven't already
 111  *  been defined. It is assumed that if they are already
 112  *  defined then the current definition is correct.
 113  */
 114 #ifndef NULL
 115 #define NULL    ((void*) 0)
 116 #endif
 117
 118 #ifndef FALSE
 119 #define FALSE   (0)
 120 #endif
 121
 122 #ifndef TRUE
 123 #define TRUE    (!FALSE)
 124 #endif
 125
 126 #undef  MAX
 127 #define MAX(a, b)  (((a) > (b)) ? (a) : (b))
 128
 129 #undef  MIN
 130 #define MIN(a, b)  (((a) < (b)) ? (a) : (b))
 131
 132 #undef  ABS
 133 #define ABS(a)     (((a) < 0) ? -(a) : (a))
 134
 135 #undef  CLAMP
 136 #define CLAMP(x, low, high)  (((x) > (high)) ? (high) : (((x) < (low)) ? (low) : (x)))
 137
 138
 139 /* Define G_VA_COPY() to do the right thing for copying va_list variables.
 140  * glibconfig.h may have already defined G_VA_COPY as va_copy or __va_copy.
 141  */
 142 #if !defined (G_VA_COPY)
 143 #  if defined (__GNUC__) && defined (__PPC__) && (defined (_CALL_SYSV) || defined (_WIN32))
 144 #  define G_VA_COPY(ap1, ap2)     (*(ap1) = *(ap2))
 145 #  elif defined (G_VA_COPY_AS_ARRAY)
 146 #  define G_VA_COPY(ap1, ap2)     g_memmove ((ap1), (ap2), sizeof (va_list))
 147 #  else /* va_list is a pointer */
 148 #  define G_VA_COPY(ap1, ap2)     ((ap1) = (ap2))
 149 #  endif /* va_list is a pointer */
 150 #endif /* !G_VA_COPY */
 151
 152
 153 /* Provide simple enum value macro wrappers that ease automated
 154  * enum value stringification code. [abandoned]
 155  */
 156 #if     !defined (G_CODE_GENERATION)
 157 #define G_ENUM( EnumerationName )               EnumerationName
 158 #define G_FLAGS( EnumerationName )              EnumerationName
 159 #define G_NV( VALUE_NAME , value_nick, VALUE)   VALUE_NAME = (VALUE)
 160 #define G_SV( VALUE_NAME, value_nick )          VALUE_NAME
 161 #else   /* G_CODE_GENERATION */
 162 #define G_ENUM( EnumerationName )               G_ENUM_E + EnumerationName +
 163 #define G_FLAGS( EnumerationName )              G_ENUM_F + EnumerationName +
 164 #define G_NV( VALUE_NAME , value_nick, VALUE)   G_ENUM_V + VALUE_NAME + value_nick +
 165 #define G_SV( VALUE_NAME, value_nick )          G_ENUM_V + VALUE_NAME + value_nick +
 166 #endif  /* G_CODE_GENERATION */
 167
 168
 169 /* inlining hassle. for compilers that don't allow the `inline' keyword,
 170  * mostly because of strict ANSI C compliance or dumbness, we try to fall
 171  * back to either `__inline__' or `__inline'.
 172  * we define G_CAN_INLINE, if the compiler seems to be actually
 173  * *capable* to do function inlining, in which case inline function bodys
 174  * do make sense. we also define G_INLINE_FUNC to properly export the
 175  * function prototypes if no inlinig can be performed.
 176  * we special case most of the stuff, so inline functions can have a normal
 177  * implementation by defining G_INLINE_FUNC to extern and G_CAN_INLINE to 1.
 178  */
 179 #ifndef G_INLINE_FUNC
 180 #  define G_CAN_INLINE 1
 181 #endif
 182 #ifdef G_HAVE_INLINE
 183 #  if defined (__GNUC__) && defined (__STRICT_ANSI__)
 184 #    undef inline
 185 #    define inline __inline__
 186 #  endif
 187 #else /* !G_HAVE_INLINE */
 188 #  undef inline
 189 #  if defined (G_HAVE___INLINE__)
 190 #    define inline __inline__
 191 #  else /* !inline && !__inline__ */
 192 #    if defined (G_HAVE___INLINE)
 193 #      define inline __inline
 194 #    else /* !inline && !__inline__ && !__inline */
 195 #      define inline /* don't inline, then */
 196 #      ifndef G_INLINE_FUNC
 197 #        undef G_CAN_INLINE
 198 #      endif
 199 #    endif
 200 #  endif
 201 #endif
 202 #ifndef G_INLINE_FUNC
 203 #  ifdef __GNUC__
 204 #    ifdef __OPTIMIZE__
 205 #      define G_INLINE_FUNC extern inline
 206 #    else
 207 #      undef G_CAN_INLINE
 208 #      define G_INLINE_FUNC extern
 209 #    endif
 210 #  else /* !__GNUC__ */
 211 #    ifdef G_CAN_INLINE
 212 #      define G_INLINE_FUNC static inline
 213 #    else
 214 #      define G_INLINE_FUNC extern
 215 #    endif
 216 #  endif /* !__GNUC__ */
 217 #endif /* !G_INLINE_FUNC */
 218
 219
 220 /* Provide simple macro statement wrappers (adapted from Perl):
 221  *  G_STMT_START { statements; } G_STMT_END;
 222  *  can be used as a single statement, as in
 223  *  if (x) G_STMT_START { ... } G_STMT_END; else ...
 224  *
 225  *  For gcc we will wrap the statements within `({' and `})' braces.
 226  *  For SunOS they will be wrapped within `if (1)' and `else (void) 0',
 227  *  and otherwise within `do' and `while (0)'.
 228  */
 229 #if !(defined (G_STMT_START) && defined (G_STMT_END))
 230 #  if defined (__GNUC__) && !defined (__STRICT_ANSI__) && !defined (__cplusplus)
 231 #    define G_STMT_START        (void)(
 232 #    define G_STMT_END          )
 233 #  else
 234 #    if (defined (sun) || defined (__sun__))
 235 #      define G_STMT_START      if (1)
 236 #      define G_STMT_END        else (void)0
 237 #    else
 238 #      define G_STMT_START      do
 239 #      define G_STMT_END        while (0)
 240 #    endif
 241 #  endif
 242 #endif
 243
 244
 245 /* Provide macros to feature the GCC function attribute.
 246  */
 247 #if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
 248 #define G_GNUC_PRINTF( format_idx, arg_idx )    \
 249   __attribute__((format (printf, format_idx, arg_idx)))
 250 #define G_GNUC_SCANF( format_idx, arg_idx )     \
 251   __attribute__((format (scanf, format_idx, arg_idx)))
 252 #define G_GNUC_FORMAT( arg_idx )                \
 253   __attribute__((format_arg (arg_idx)))
 254 #define G_GNUC_NORETURN                         \
 255   __attribute__((noreturn))
 256 #define G_GNUC_CONST                            \
 257   __attribute__((const))
 258 #else   /* !__GNUC__ */
 259 #define G_GNUC_PRINTF( format_idx, arg_idx )
 260 #define G_GNUC_SCANF( format_idx, arg_idx )
 261 #define G_GNUC_FORMAT( arg_idx )
 262 #define G_GNUC_NORETURN
 263 #define G_GNUC_CONST
 264 #endif  /* !__GNUC__ */
 265
 266
 267 /* Wrap the gcc __PRETTY_FUNCTION__ and __FUNCTION__ variables with
 268  * macros, so we can refer to them as strings unconditionally.
 269  */
 270 #ifdef  __GNUC__
 271 #define G_GNUC_FUNCTION         (__FUNCTION__)
 272 #define G_GNUC_PRETTY_FUNCTION  (__PRETTY_FUNCTION__)
 273 #else   /* !__GNUC__ */
 274 #define G_GNUC_FUNCTION         ("")
 275 #define G_GNUC_PRETTY_FUNCTION  ("")
 276 #endif  /* !__GNUC__ */
 277
 278
 279 /* we try to provide a usefull equivalent for ATEXIT if it is
 280  * not defined, but use is actually abandoned. people should
 281  * use g_atexit() instead.
 282  * keep this in sync with gutils.c.
 283  */
 284 #ifndef ATEXIT
 285 #  ifdef HAVE_ATEXIT
 286 #    ifdef NeXT /* @#%@! NeXTStep */
 287 #      define ATEXIT(proc)   (!atexit (proc))
 288 #    else /* !NeXT */
 289 #      define ATEXIT(proc)   (atexit (proc))
 290 #    endif /* !NeXT */
 291 #  elif defined (HAVE_ON_EXIT)
 292 #    define ATEXIT(proc)   (on_exit ((void (*)(int, void *))(proc), NULL))
 293 #  else
 294 #  error Could not determine proper atexit() implementation
 295 #  endif
 296 #else
 297 #  define G_NATIVE_ATEXIT
 298 #endif /* ATEXIT */
 299
 300 /* Hacker macro to place breakpoints for x86 machines.
 301  * Actual use is strongly deprecated of course ;)
 302  */
 303 #if     defined (__i386__) && defined (__GNUC__)
 304 #define G_BREAKPOINT()          G_STMT_START{ __asm__ volatile ("int $03"); }G_STMT_END
 305 #else   /* !__i386__ */
 306 #define G_BREAKPOINT()
 307 #endif  /* __i386__ */
 308
 309
 310 /* Provide macros for easily allocating memory. The macros
 311  *  will cast the allocated memory to the specified type
 312  *  in order to avoid compiler warnings. (Makes the code neater).
 313  */
 314
 315 #ifdef __DMALLOC_H__
 316
 317 #define g_new(type, count)       (ALLOC (type, count))
 318 #define g_new0(type, count)      (CALLOC (type, count))
 319
 320 #else /* __DMALLOC_H__ */
 321
 322 #define g_new(type, count)        \
 323     ((type *) g_malloc ((unsigned) sizeof (type) * (count)))
 324 #define g_new0(type, count)       \
 325     ((type *) g_malloc0 ((unsigned) sizeof (type) * (count)))
 326 #endif /* __DMALLOC_H__ */
 327
 328 #define g_mem_chunk_create(type, pre_alloc, alloc_type) ( \
 329   g_mem_chunk_new (#type " mem chunks (" #pre_alloc ")", \
 330                    sizeof (type), \
 331                    sizeof (type) * (pre_alloc), \
 332                    (alloc_type)) \
 333 )
 334 #define g_chunk_new(type, chunk)        ( \
 335   (type *) g_mem_chunk_alloc (chunk) \
 336 )
 337 #define g_chunk_new0(type, chunk)       ( \
 338   (type *) g_mem_chunk_alloc0 (chunk) \
 339 )
 340 #define g_chunk_free(mem, mem_chunk)    G_STMT_START { \
 341   g_mem_chunk_free ((mem_chunk), (mem)); \
 342 } G_STMT_END
 343
 344
 345 #define g_string(x) #x
 346
 347
 348 /* Provide macros for error handling. The "assert" macros will
 349  *  exit on failure. The "return" macros will exit the current
 350  *  function. Two different definitions are given for the macros
 351  *  if G_DISABLE_ASSERT is not defined, in order to support gcc's
 352  *  __PRETTY_FUNCTION__ capability.
 353  */
 354
 355 #ifdef G_DISABLE_ASSERT
 356
 357 #define g_assert(expr)
 358 #define g_assert_not_reached()
 359
 360 #else /* !G_DISABLE_ASSERT */
 361
 362 #ifdef __GNUC__
 363
 364 #define g_assert(expr)                  G_STMT_START{           \
 365      if (!(expr))                                               \
 366        g_log (G_LOG_DOMAIN,                                     \
 367               G_LOG_LEVEL_ERROR,                                \
 368               "file %s: line %d (%s): assertion failed: (%s)",  \
 369               __FILE__,                                         \
 370               __LINE__,                                         \
 371               __PRETTY_FUNCTION__,                              \
 372               #expr);                   }G_STMT_END
 373
 374 #define g_assert_not_reached()          G_STMT_START{           \
 375      g_log (G_LOG_DOMAIN,                                       \
 376             G_LOG_LEVEL_ERROR,                                  \
 377             "file %s: line %d (%s): should not be reached",     \
 378             __FILE__,                                           \
 379             __LINE__,                                           \
 380             __PRETTY_FUNCTION__);       }G_STMT_END
 381
 382 #else /* !__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: assertion failed: (%s)",       \
 389               __FILE__,                                         \
 390               __LINE__,                                         \
 391               #expr);                   }G_STMT_END
 392
 393 #define g_assert_not_reached()          G_STMT_START{   \
 394      g_log (G_LOG_DOMAIN,                               \
 395             G_LOG_LEVEL_ERROR,                          \
 396             "file %s: line %d: should not be reached",  \
 397             __FILE__,                                   \
 398             __LINE__);          }G_STMT_END
 399
 400 #endif /* __GNUC__ */
 401
 402 #endif /* !G_DISABLE_ASSERT */
 403
 404
 405 #ifdef G_DISABLE_CHECKS
 406
 407 #define g_return_if_fail(expr)
 408 #define g_return_val_if_fail(expr,val)
 409
 410 #else /* !G_DISABLE_CHECKS */
 411
 412 #ifdef __GNUC__
 413
 414 #define g_return_if_fail(expr)          G_STMT_START{                   \
 415      if (!(expr))                                                       \
 416        {                                                                \
 417          g_log (G_LOG_DOMAIN,                                           \
 418                 G_LOG_LEVEL_CRITICAL,                                   \
 419                 "file %s: line %d (%s): assertion `%s' failed.",        \
 420                 __FILE__,                                               \
 421                 __LINE__,                                               \
 422                 __PRETTY_FUNCTION__,                                    \
 423                 #expr);                                                 \
 424          return;                                                        \
 425        };                               }G_STMT_END
 426
 427 #define g_return_val_if_fail(expr,val)  G_STMT_START{                   \
 428      if (!(expr))                                                       \
 429        {                                                                \
 430          g_log (G_LOG_DOMAIN,                                           \
 431                 G_LOG_LEVEL_CRITICAL,                                   \
 432                 "file %s: line %d (%s): assertion `%s' failed.",        \
 433                 __FILE__,                                               \
 434                 __LINE__,                                               \
 435                 __PRETTY_FUNCTION__,                                    \
 436                 #expr);                                                 \
 437          return val;                                                    \
 438        };                               }G_STMT_END
 439
 440 #else /* !__GNUC__ */
 441
 442 #define g_return_if_fail(expr)          G_STMT_START{           \
 443      if (!(expr))                                               \
 444        {                                                        \
 445          g_log (G_LOG_DOMAIN,                                   \
 446                 G_LOG_LEVEL_CRITICAL,                           \
 447                 "file %s: line %d: assertion `%s' failed.",     \
 448                 __FILE__,                                       \
 449                 __LINE__,                                       \
 450                 #expr);                                         \
 451          return;                                                \
 452        };                               }G_STMT_END
 453
 454 #define g_return_val_if_fail(expr, val) G_STMT_START{           \
 455      if (!(expr))                                               \
 456        {                                                        \
 457          g_log (G_LOG_DOMAIN,                                   \
 458                 G_LOG_LEVEL_CRITICAL,                           \
 459                 "file %s: line %d: assertion `%s' failed.",     \
 460                 __FILE__,                                       \
 461                 __LINE__,                                       \
 462                 #expr);                                         \
 463          return val;                                            \
 464        };                               }G_STMT_END
 465
 466 #endif /* !__GNUC__ */
 467
 468 #endif /* !G_DISABLE_CHECKS */
 469
 470
 471 /* Provide type definitions for commonly used types.
 472  *  These are useful because a "gint8" can be adjusted
 473  *  to be 1 byte (8 bits) on all platforms. Similarly and
 474  *  more importantly, "gint32" can be adjusted to be
 475  *  4 bytes (32 bits) on all platforms.
 476  */
 477
 478 typedef char   gchar;
 479 typedef short  gshort;
 480 typedef long   glong;
 481 typedef int    gint;
 482 typedef gint   gboolean;
 483
 484 typedef unsigned char   guchar;
 485 typedef unsigned short  gushort;
 486 typedef unsigned long   gulong;
 487 typedef unsigned int    guint;
 488
 489 typedef float   gfloat;
 490 typedef double  gdouble;
 491
 492 /* HAVE_LONG_DOUBLE doesn't work correctly on all platforms.
 493  * Since gldouble isn't used anywhere, just disable it for now */
 494
 495 #if 0
 496 #ifdef HAVE_LONG_DOUBLE
 497 typedef long double gldouble;
 498 #else /* HAVE_LONG_DOUBLE */
 499 typedef double gldouble;
 500 #endif /* HAVE_LONG_DOUBLE */
 501 #endif /* 0 */
 502
 503 typedef void* gpointer;
 504 typedef const void *gconstpointer;
 505
 506 #if (SIZEOF_CHAR == 1)
 507 typedef signed char     gint8;
 508 typedef unsigned char   guint8;
 509 #endif /* SIZEOF_CHAR */
 510
 511 #if (SIZEOF_SHORT == 2)
 512 typedef signed short    gint16;
 513 typedef unsigned short  guint16;
 514 #endif /* SIZEOF_SHORT */
 515
 516 #if (SIZEOF_INT == 4)
 517 typedef signed int      gint32;
 518 typedef unsigned int    guint32;
 519 #elif (SIZEOF_LONG == 4)
 520 typedef signed long     gint32;
 521 typedef unsigned long   guint32;
 522 #endif /* SIZEOF_INT */
 523
 524 #if (SIZEOF_LONG == 8)
 525 #define HAVE_GINT64 1
 526 typedef signed long gint64;
 527 typedef unsigned long guint64;
 528 #elif (SIZEOF_LONG_LONG == 8)
 529 #define HAVE_GINT64 1
 530 typedef signed long long gint64;
 531 typedef unsigned long long guint64;
 532 #else
 533 /* No gint64 */
 534 #undef HAVE_GINT64
 535 #endif
 536
 537
 538 /* Define macros for storing integers inside pointers
 539  */
 540 #if (SIZEOF_INT == SIZEOF_VOID_P)
 541
 542 #define GPOINTER_TO_INT(p) ((gint)(p))
 543 #define GPOINTER_TO_UINT(p) ((guint)(p))
 544
 545 #define GINT_TO_POINTER(i) ((gpointer)(i))
 546 #define GUINT_TO_POINTER(u) ((gpointer)(u))
 547
 548 #elif (SIZEOF_LONG == SIZEOF_VOID_P)
 549
 550 #define GPOINTER_TO_INT(p) ((gint)(glong)(p))
 551 #define GPOINTER_TO_UINT(p) ((guint)(gulong)(p))
 552
 553 #define GINT_TO_POINTER(i) ((gpointer)(glong)(i))
 554 #define GUINT_TO_POINTER(u) ((gpointer)(gulong)(u))
 555
 556 #else
 557 #error SIZEOF_VOID_P unknown - This should never happen
 558 #endif
 559
 560 typedef gint32  gssize;
 561 typedef guint32 gsize;
 562 typedef guint32 GQuark;
 563 typedef gint32  GTime;
 564
 565
 566 /* Glib version.
 567  */
 568 extern const guint glib_major_version;
 569 extern const guint glib_minor_version;
 570 extern const guint glib_micro_version;
 571 extern const guint glib_interface_age;
 572 extern const guint glib_binary_age;
 573
 574
 575 /* Forward declarations of glib types.
 576  */
 577
 578 typedef struct _GArray          GArray;
 579 typedef struct _GByteArray      GByteArray;
 580 typedef struct _GCache          GCache;
 581 typedef struct _GCompletion     GCompletion;
 582 typedef struct _GData           GData;
 583 typedef struct _GDebugKey       GDebugKey;
 584 typedef struct _GHashTable      GHashTable;
 585 typedef struct _GList           GList;
 586 typedef struct _GListAllocator  GListAllocator;
 587 typedef struct _GMemChunk       GMemChunk;
 588 typedef struct _GNode           GNode;
 589 typedef struct _GPtrArray       GPtrArray;
 590 typedef struct _GRelation       GRelation;
 591 typedef struct _GScanner        GScanner;
 592 typedef struct _GScannerConfig  GScannerConfig;
 593 typedef struct _GSList          GSList;
 594 typedef struct _GString         GString;
 595 typedef struct _GStringChunk    GStringChunk;
 596 typedef struct _GTimer          GTimer;
 597 typedef struct _GTree           GTree;
 598 typedef struct _GTuples         GTuples;
 599 typedef union  _GValue          GValue;
 600
 601
 602 typedef enum
 603 {
 604   G_TRAVERSE_LEAFS      = 1 << 0,
 605   G_TRAVERSE_NON_LEAFS  = 1 << 1,
 606   G_TRAVERSE_ALL        = G_TRAVERSE_LEAFS | G_TRAVERSE_NON_LEAFS,
 607   G_TRAVERSE_MASK       = 0x03
 608 } GTraverseFlags;
 609
 610 typedef enum
 611 {
 612   G_IN_ORDER,
 613   G_PRE_ORDER,
 614   G_POST_ORDER,
 615   G_LEVEL_ORDER
 616 } GTraverseType;
 617
 618 /* Log level shift offset for user defined
 619  * log levels (0-7 are used by GLib).
 620  */
 621 #define G_LOG_LEVEL_USER_SHIFT  (8)
 622
 623 /* Glib log levels and flags.
 624  */
 625 typedef enum
 626 {
 627   /* log flags */
 628   G_LOG_FLAG_RECURSION          = 1 << 0,
 629   G_LOG_FLAG_FATAL              = 1 << 1,
 630
 631   /* GLib log levels */
 632   G_LOG_LEVEL_ERROR             = 1 << 2,       /* always fatal */
 633   G_LOG_LEVEL_CRITICAL          = 1 << 3,
 634   G_LOG_LEVEL_WARNING           = 1 << 4,
 635   G_LOG_LEVEL_MESSAGE           = 1 << 5,
 636   G_LOG_LEVEL_INFO              = 1 << 6,
 637   G_LOG_LEVEL_DEBUG             = 1 << 7,
 638
 639   G_LOG_LEVEL_MASK              = ~(G_LOG_FLAG_RECURSION | G_LOG_FLAG_FATAL)
 640 } GLogLevelFlags;
 641
 642 /* GLib log levels that are considered fatal by default */
 643 #define G_LOG_FATAL_MASK        (G_LOG_FLAG_RECURSION | G_LOG_LEVEL_ERROR)
 644
 645
 646 typedef gpointer        (*GCacheNewFunc)        (gpointer       key);
 647 typedef gpointer        (*GCacheDupFunc)        (gpointer       value);
 648 typedef void            (*GCacheDestroyFunc)    (gpointer       value);
 649 typedef gint            (*GCompareFunc)         (gconstpointer  a,
 650                                                  gconstpointer  b);
 651 typedef gchar*          (*GCompletionFunc)      (gpointer);
 652 typedef void            (*GDestroyNotify)       (gpointer       data);
 653 typedef void            (*GDataForeachFunc)     (GQuark         key_id,
 654                                                  gpointer       data,
 655                                                  gpointer       user_data);
 656 typedef void            (*GFunc)                (gpointer       data,
 657                                                  gpointer       user_data);
 658 typedef guint           (*GHashFunc)            (gconstpointer  key);
 659 typedef void            (*GHFunc)               (gpointer       key,
 660                                                  gpointer       value,
 661                                                  gpointer       user_data);
 662 typedef void            (*GLogFunc)             (const gchar   *log_domain,
 663                                                  GLogLevelFlags log_level,
 664                                                  const gchar   *message,
 665                                                  gpointer       user_data);
 666 typedef gboolean        (*GNodeTraverseFunc)    (GNode         *node,
 667                                                  gpointer       data);
 668 typedef void            (*GNodeForeachFunc)     (GNode         *node,
 669                                                  gpointer       data);
 670 typedef gint            (*GSearchFunc)          (gpointer       key,
 671                                                  gpointer       data);
 672 typedef void            (*GScannerMsgFunc)      (GScanner      *scanner,
 673                                                  gchar         *message,
 674                                                  gint           error);
 675 typedef gint            (*GTraverseFunc)        (gpointer       key,
 676                                                  gpointer       value,
 677                                                  gpointer       data);
 678 typedef void            (*GVoidFunc)            (void);
 679
 680
 681 struct _GList
 682 {
 683   gpointer data;
 684   GList *next;
 685   GList *prev;
 686 };
 687
 688 struct _GSList
 689 {
 690   gpointer data;
 691   GSList *next;
 692 };
 693
 694 struct _GString
 695 {
 696   gchar *str;
 697   gint len;
 698 };
 699
 700 struct _GArray
 701 {
 702   gchar *data;
 703   guint len;
 704 };
 705
 706 struct _GByteArray
 707 {
 708   guint8 *data;
 709   guint   len;
 710 };
 711
 712 struct _GPtrArray
 713 {
 714   gpointer *pdata;
 715   guint     len;
 716 };
 717
 718 struct _GTuples
 719 {
 720   guint len;
 721 };
 722
 723 struct _GDebugKey
 724 {
 725   gchar *key;
 726   guint  value;
 727 };
 728
 729 struct _GCache { gint dummy; };
 730 struct _GTree { gint dummy; };
 731 struct _GTimer { gint dummy; };
 732 struct _GMemChunk { gint dummy; };
 733 struct _GListAllocator { gint dummy; };
 734 struct _GStringChunk { gint dummy; };
 735
 736
 737 /* Doubly linked lists
 738  */
 739 GList* g_list_alloc             (void);
 740 void   g_list_free              (GList          *list);
 741 void   g_list_free_1            (GList          *list);
 742 GList* g_list_append            (GList          *list,
 743                                  gpointer        data);
 744 GList* g_list_prepend           (GList          *list,
 745                                  gpointer        data);
 746 GList* g_list_insert            (GList          *list,
 747                                  gpointer        data,
 748                                  gint            position);
 749 GList* g_list_insert_sorted     (GList          *list,
 750                                  gpointer        data,
 751                                  GCompareFunc    func);
 752 GList* g_list_concat            (GList          *list1,
 753                                  GList          *list2);
 754 GList* g_list_remove            (GList          *list,
 755                                  gpointer        data);
 756 GList* g_list_remove_link       (GList          *list,
 757                                  GList          *llink);
 758 GList* g_list_reverse           (GList          *list);
 759 GList* g_list_nth               (GList          *list,
 760                                  guint           n);
 761 GList* g_list_find              (GList          *list,
 762                                  gpointer        data);
 763 GList* g_list_find_custom       (GList          *list,
 764                                  gpointer        data,
 765                                  GCompareFunc    func);
 766 gint   g_list_position          (GList          *list,
 767                                  GList          *llink);
 768 gint   g_list_index             (GList          *list,
 769                                  gpointer        data);
 770 GList* g_list_last              (GList          *list);
 771 GList* g_list_first             (GList          *list);
 772 guint  g_list_length            (GList          *list);
 773 void   g_list_foreach           (GList          *list,
 774                                  GFunc           func,
 775                                  gpointer        user_data);
 776 gpointer g_list_nth_data        (GList          *list,
 777                                  guint           n);
 778 #define g_list_previous(list)   ((list) ? (((GList *)(list))->prev) : NULL)
 779 #define g_list_next(list)       ((list) ? (((GList *)(list))->next) : NULL)
 780
 781
 782 /* Singly linked lists
 783  */
 784 GSList* g_slist_alloc           (void);
 785 void    g_slist_free            (GSList         *list);
 786 void    g_slist_free_1          (GSList         *list);
 787 GSList* g_slist_append          (GSList         *list,
 788                                  gpointer        data);
 789 GSList* g_slist_prepend         (GSList         *list,
 790                                  gpointer        data);
 791 GSList* g_slist_insert          (GSList         *list,
 792                                  gpointer        data,
 793                                  gint            position);
 794 GSList* g_slist_insert_sorted   (GSList         *list,
 795                                  gpointer        data,
 796                                  GCompareFunc    func);
 797 GSList* g_slist_concat          (GSList         *list1,
 798                                  GSList         *list2);
 799 GSList* g_slist_remove          (GSList         *list,
 800                                  gpointer        data);
 801 GSList* g_slist_remove_link     (GSList         *list,
 802                                  GSList         *llink);
 803 GSList* g_slist_reverse         (GSList         *list);
 804 GSList* g_slist_nth             (GSList         *list,
 805                                  guint           n);
 806 GSList* g_slist_find            (GSList         *list,
 807                                  gpointer        data);
 808 GSList* g_slist_find_custom     (GSList         *list,
 809                                  gpointer        data,
 810                                  GCompareFunc    func);
 811 gint    g_slist_position        (GSList         *list,
 812                                  GSList         *llink);
 813 gint    g_slist_index           (GSList         *list,
 814                                  gpointer        data);
 815 GSList* g_slist_last            (GSList         *list);
 816 guint   g_slist_length          (GSList         *list);
 817 void    g_slist_foreach         (GSList         *list,
 818                                  GFunc           func,
 819                                  gpointer        user_data);
 820 gpointer g_slist_nth_data       (GSList         *list,
 821                                  guint           n);
 822 #define g_slist_next(slist)     ((slist) ? (((GSList *)(slist))->next) : NULL)
 823
 824
 825 /* List Allocators
 826  */
 827 GListAllocator* g_list_allocator_new  (void);
 828 void            g_list_allocator_free (GListAllocator* allocator);
 829 GListAllocator* g_slist_set_allocator (GListAllocator* allocator);
 830 GListAllocator* g_list_set_allocator  (GListAllocator* allocator);
 831
 832
 833 /* Hash tables
 834  */
 835 GHashTable* g_hash_table_new            (GHashFunc       hash_func,
 836                                          GCompareFunc    key_compare_func);
 837 void        g_hash_table_destroy        (GHashTable     *hash_table);
 838 void        g_hash_table_insert         (GHashTable     *hash_table,
 839                                          gpointer        key,
 840                                          gpointer        value);
 841 void        g_hash_table_remove         (GHashTable     *hash_table,
 842                                          gconstpointer   key);
 843 gpointer    g_hash_table_lookup         (GHashTable     *hash_table,
 844                                          gconstpointer   key);
 845 gboolean    g_hash_table_lookup_extended(GHashTable     *hash_table,
 846                                          gconstpointer   lookup_key,
 847                                          gpointer       *orig_key,
 848                                          gpointer       *value);
 849 void        g_hash_table_freeze         (GHashTable     *hash_table);
 850 void        g_hash_table_thaw           (GHashTable     *hash_table);
 851 void        g_hash_table_foreach        (GHashTable     *hash_table,
 852                                          GHFunc          func,
 853                                          gpointer        user_data);
 854 gint        g_hash_table_size           (GHashTable     *hash_table);
 855
 856
 857 /* Caches
 858  */
 859 GCache*  g_cache_new           (GCacheNewFunc      value_new_func,
 860                                 GCacheDestroyFunc  value_destroy_func,
 861                                 GCacheDupFunc      key_dup_func,
 862                                 GCacheDestroyFunc  key_destroy_func,
 863                                 GHashFunc          hash_key_func,
 864                                 GHashFunc          hash_value_func,
 865                                 GCompareFunc       key_compare_func);
 866 void     g_cache_destroy       (GCache            *cache);
 867 gpointer g_cache_insert        (GCache            *cache,
 868                                 gpointer           key);
 869 void     g_cache_remove        (GCache            *cache,
 870                                 gpointer           value);
 871 void     g_cache_key_foreach   (GCache            *cache,
 872                                 GHFunc             func,
 873                                 gpointer           user_data);
 874 void     g_cache_value_foreach (GCache            *cache,
 875                                 GHFunc             func,
 876                                 gpointer           user_data);
 877
 878
 879 /* Balanced binary trees
 880  */
 881 GTree*   g_tree_new      (GCompareFunc   key_compare_func);
 882 void     g_tree_destroy  (GTree         *tree);
 883 void     g_tree_insert   (GTree         *tree,
 884                           gpointer       key,
 885                           gpointer       value);
 886 void     g_tree_remove   (GTree         *tree,
 887                           gpointer       key);
 888 gpointer g_tree_lookup   (GTree         *tree,
 889                           gpointer       key);
 890 void     g_tree_traverse (GTree         *tree,
 891                           GTraverseFunc  traverse_func,
 892                           GTraverseType  traverse_type,
 893                           gpointer       data);
 894 gpointer g_tree_search   (GTree         *tree,
 895                           GSearchFunc    search_func,
 896                           gpointer       data);
 897 gint     g_tree_height   (GTree         *tree);
 898 gint     g_tree_nnodes   (GTree         *tree);
 899
 900
 901
 902 /* N-way tree implementation
 903  */
 904 struct _GNode
 905 {
 906   gpointer data;
 907   GNode   *next;
 908   GNode   *prev;
 909   GNode   *parent;
 910   GNode   *children;
 911 };
 912
 913 #define  G_NODE_IS_ROOT(node)   (((GNode*) (node))->parent == NULL && \
 914                                  ((GNode*) (node))->prev == NULL && \
 915                                  ((GNode*) (node))->next == NULL)
 916 #define  G_NODE_IS_LEAF(node)   (((GNode*) (node))->children == NULL)
 917
 918 GNode*   g_node_new             (gpointer          data);
 919 void     g_node_destroy         (GNode            *root);
 920 void     g_node_unlink          (GNode            *node);
 921 GNode*   g_node_insert          (GNode            *parent,
 922                                  gint              position,
 923                                  GNode            *node);
 924 GNode*   g_node_insert_before   (GNode            *parent,
 925                                  GNode            *sibling,
 926                                  GNode            *node);
 927 GNode*   g_node_prepend         (GNode            *parent,
 928                                  GNode            *node);
 929 guint    g_node_n_nodes         (GNode            *root,
 930                                  GTraverseFlags    flags);
 931 GNode*   g_node_get_root        (GNode            *node);
 932 gboolean g_node_is_ancestor     (GNode            *node,
 933                                  GNode            *descendant);
 934 guint    g_node_depth           (GNode            *node);
 935 GNode*   g_node_find            (GNode            *root,
 936                                  GTraverseType     order,
 937                                  GTraverseFlags    flags,
 938                                  gpointer          data);
 939
 940 /* convenience macros */
 941 #define g_node_append(parent, node)                             \
 942      g_node_insert_before ((parent), NULL, (node))
 943 #define g_node_insert_data(parent, position, data)              \
 944      g_node_insert ((parent), (position), g_node_new (data))
 945 #define g_node_insert_data_before(parent, sibling, data)        \
 946      g_node_insert_before ((parent), (sibling), g_node_new (data))
 947 #define g_node_prepend_data(parent, data)                       \
 948      g_node_prepend ((parent), g_node_new (data))
 949 #define g_node_append_data(parent, data)                        \
 950      g_node_insert_before ((parent), NULL, g_node_new (data))
 951
 952 /* traversal function, assumes that `node' is root
 953  * (only traverses `node' and its subtree).
 954  * this function is just a high level interface to
 955  * low level traversal functions, optimized for speed.
 956  */
 957 void     g_node_traverse        (GNode            *root,
 958                                  GTraverseType     order,
 959                                  GTraverseFlags    flags,
 960                                  gint              max_depth,
 961                                  GNodeTraverseFunc func,
 962                                  gpointer          data);
 963
 964 /* return the maximum tree height starting with `node', this is an expensive
 965  * operation, since we need to visit all nodes. this could be shortened by
 966  * adding `guint height' to struct _GNode, but then again, this is not very
 967  * often needed, and would make g_node_insert() more time consuming.
 968  */
 969 guint    g_node_max_height       (GNode *root);
 970
 971 void     g_node_children_foreach (GNode           *node,
 972                                   GTraverseFlags   flags,
 973                                   GNodeForeachFunc func,
 974                                   gpointer         data);
 975 void     g_node_reverse_children (GNode           *node);
 976 guint    g_node_n_children       (GNode           *node);
 977 GNode*   g_node_nth_child        (GNode           *node,
 978                                   guint            n);
 979 GNode*   g_node_last_child       (GNode           *node);
 980 GNode*   g_node_find_child       (GNode           *node,
 981                                   GTraverseFlags   flags,
 982                                   gpointer         data);
 983 gint     g_node_child_position   (GNode           *node,
 984                                   GNode           *child);
 985 gint     g_node_child_index      (GNode           *node,
 986                                   gpointer         data);
 987
 988 GNode*   g_node_first_sibling    (GNode           *node);
 989 GNode*   g_node_last_sibling     (GNode           *node);
 990
 991 #define  g_node_prev_sibling(node)      ((node) ? \
 992                                          ((GNode*) (node))->prev : NULL)
 993 #define  g_node_next_sibling(node)      ((node) ? \
 994                                          ((GNode*) (node))->next : NULL)
 995 #define  g_node_first_child(node)       ((node) ? \
 996                                          ((GNode*) (node))->children : NULL)
 997
 998
 999 /* Fatal error handlers.
1000  * g_on_error_query() will prompt the user to either
1001  * [E]xit, [H]alt, [P]roceed or show [S]tack trace.
1002  * g_on_error_stack_trace() invokes gdb, which attaches to the current
1003  * process and shows a stack trace.
1004  * These function may cause different actions on non-unix platforms.
1005  * The prg_name arg is required by gdb to find the executable, if it is
1006  * passed as NULL, g_on_error_query() will try g_get_prgname().
1007  */
1008 void g_on_error_query (const gchar *prg_name);
1009 void g_on_error_stack_trace (const gchar *prg_name);
1010
1011
1012 /* Logging mechanism
1013  */
1014 extern const gchar                      *g_log_domain_glib;
1015 guint           g_log_set_handler       (const gchar    *log_domain,
1016                                          GLogLevelFlags  log_levels,
1017                                          GLogFunc        log_func,
1018                                          gpointer        user_data);
1019 void            g_log_remove_handler    (const gchar    *log_domain,
1020                                          guint           handler_id);
1021 void            g_log_default_handler   (const gchar    *log_domain,
1022                                          GLogLevelFlags  log_level,
1023                                          const gchar    *message,
1024                                          gpointer        unused_data);
1025 void            g_log                   (const gchar    *log_domain,
1026                                          GLogLevelFlags  log_level,
1027                                          const gchar    *format,
1028                                          ...) G_GNUC_PRINTF (3, 4);
1029 void            g_logv                  (const gchar    *log_domain,
1030                                          GLogLevelFlags  log_level,
1031                                          const gchar    *format,
1032                                          va_list         args);
1033 GLogLevelFlags  g_log_set_fatal_mask    (const gchar    *log_domain,
1034                                          GLogLevelFlags  fatal_mask);
1035 GLogLevelFlags  g_log_set_always_fatal  (GLogLevelFlags  fatal_mask);
1036 #ifndef G_LOG_DOMAIN
1037 #define G_LOG_DOMAIN    (NULL)
1038 #endif  /* G_LOG_DOMAIN */
1039 #ifdef  __GNUC__
1040 #define g_error(format, args...)        g_log (G_LOG_DOMAIN, \
1041                                                G_LOG_LEVEL_ERROR, \
1042                                                format, ##args)
1043 #define g_message(format, args...)      g_log (G_LOG_DOMAIN, \
1044                                                G_LOG_LEVEL_MESSAGE, \
1045                                                format, ##args)
1046 #define g_warning(format, args...)      g_log (G_LOG_DOMAIN, \
1047                                                G_LOG_LEVEL_WARNING, \
1048                                                format, ##args)
1049 #else   /* !__GNUC__ */
1050 static inline void
1051 g_error (const gchar *format,
1052          ...)
1053 {
1054   va_list args;
1055   va_start (args, format);
1056   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR, format, args);
1057   va_end (args);
1058 }
1059 static inline void
1060 g_message (const gchar *format,
1061            ...)
1062 {
1063   va_list args;
1064   va_start (args, format);
1065   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_MESSAGE, format, args);
1066   va_end (args);
1067 }
1068 static inline void
1069 g_warning (const gchar *format,
1070            ...)
1071 {
1072   va_list args;
1073   va_start (args, format);
1074   g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING, format, args);
1075   va_end (args);
1076 }
1077 #endif  /* !__GNUC__ */
1078
1079 typedef void    (*GPrintFunc)           (const gchar    *string);
1080 void            g_print                 (const gchar    *format,
1081                                          ...) G_GNUC_PRINTF (1, 2);
1082 GPrintFunc      g_set_print_handler     (GPrintFunc      func);
1083 void            g_printerr              (const gchar    *format,
1084                                          ...) G_GNUC_PRINTF (1, 2);
1085 GPrintFunc      g_set_printerr_handler  (GPrintFunc      func);
1086
1087 /* deprecated compatibility functions, use g_log_set_handler() instead */
1088 typedef void            (*GErrorFunc)           (const gchar *str);
1089 typedef void            (*GWarningFunc)         (const gchar *str);
1090 GErrorFunc   g_set_error_handler   (GErrorFunc   func);
1091 GWarningFunc g_set_warning_handler (GWarningFunc func);
1092 GPrintFunc   g_set_message_handler (GPrintFunc func);
1093
1094
1095 /* Memory allocation and debugging
1096  */
1097 #ifdef USE_DMALLOC
1098
1099 #define g_malloc(size)       ((gpointer) MALLOC (size))
1100 #define g_malloc0(size)      ((gpointer) CALLOC (char, size))
1101 #define g_realloc(mem,size)  ((gpointer) REALLOC (mem, char, size))
1102 #define g_free(mem)          FREE (mem)
1103
1104 #else /* !USE_DMALLOC */
1105
1106 gpointer g_malloc      (gulong    size);
1107 gpointer g_malloc0     (gulong    size);
1108 gpointer g_realloc     (gpointer  mem,
1109                         gulong    size);
1110 void     g_free        (gpointer  mem);
1111
1112 #endif /* !USE_DMALLOC */
1113
1114 void     g_mem_profile (void);
1115 void     g_mem_check   (gpointer  mem);
1116
1117
1118 /* "g_mem_chunk_new" creates a new memory chunk.
1119  * Memory chunks are used to allocate pieces of memory which are
1120  *  always the same size. Lists are a good example of such a data type.
1121  * The memory chunk allocates and frees blocks of memory as needed.
1122  *  Just be sure to call "g_mem_chunk_free" and not "g_free" on data
1123  *  allocated in a mem chunk. ("g_free" will most likely cause a seg
1124  *  fault...somewhere).
1125  *
1126  * Oh yeah, GMemChunk is an opaque data type. (You don't really
1127  *  want to know what's going on inside do you?)
1128  */
1129
1130 /* ALLOC_ONLY MemChunk's can only allocate memory. The free operation
1131  *  is interpreted as a no op. ALLOC_ONLY MemChunk's save 4 bytes per
1132  *  atom. (They are also useful for lists which use MemChunk to allocate
1133  *  memory but are also part of the MemChunk implementation).
1134  * ALLOC_AND_FREE MemChunk's can allocate and free memory.
1135  */
1136
1137 #define G_ALLOC_ONLY      1
1138 #define G_ALLOC_AND_FREE  2
1139
1140 GMemChunk* g_mem_chunk_new     (gchar     *name,
1141                                 gint       atom_size,
1142                                 gulong     area_size,
1143                                 gint       type);
1144 void       g_mem_chunk_destroy (GMemChunk *mem_chunk);
1145 gpointer   g_mem_chunk_alloc   (GMemChunk *mem_chunk);
1146 gpointer   g_mem_chunk_alloc0  (GMemChunk *mem_chunk);
1147 void       g_mem_chunk_free    (GMemChunk *mem_chunk,
1148                                 gpointer   mem);
1149 void       g_mem_chunk_clean   (GMemChunk *mem_chunk);
1150 void       g_mem_chunk_reset   (GMemChunk *mem_chunk);
1151 void       g_mem_chunk_print   (GMemChunk *mem_chunk);
1152 void       g_mem_chunk_info    (void);
1153
1154 /* Ah yes...we have a "g_blow_chunks" function.
1155  * "g_blow_chunks" simply compresses all the chunks. This operation
1156  *  consists of freeing every memory area that should be freed (but
1157  *  which we haven't gotten around to doing yet). And, no,
1158  *  "g_blow_chunks" doesn't follow the naming scheme, but it is a
1159  *  much better name than "g_mem_chunk_clean_all" or something
1160  *  similar.
1161  */
1162 void g_blow_chunks (void);
1163
1164
1165 /* Timer
1166  */
1167 GTimer* g_timer_new     (void);
1168 void    g_timer_destroy (GTimer  *timer);
1169 void    g_timer_start   (GTimer  *timer);
1170 void    g_timer_stop    (GTimer  *timer);
1171 void    g_timer_reset   (GTimer  *timer);
1172 gdouble g_timer_elapsed (GTimer  *timer,
1173                          gulong  *microseconds);
1174
1175
1176 /* String utility functions
1177  */
1178 #define G_STR_DELIMITERS        "_-|> <."
1179 void    g_strdelimit            (gchar       *string,
1180                                  const gchar *delimiters,
1181                                  gchar        new_delimiter);
1182 gchar*  g_strdup                (const gchar *str);
1183 gchar*  g_strdup_printf         (const gchar *format,
1184                                  ...) G_GNUC_PRINTF (1, 2);
1185 gchar*  g_strdup_vprintf        (const gchar *format,
1186                                  va_list      args);
1187 gchar*  g_strndup               (const gchar *str,
1188                                  guint        n);
1189 gchar*  g_strnfill              (guint        length,
1190                                  gchar        fill_char);
1191 gchar*  g_strconcat             (const gchar *string1,
1192                                  ...); /* NULL terminated */
1193 gdouble g_strtod                (const gchar *nptr,
1194                                  gchar      **endptr);
1195 gchar*  g_strerror              (gint         errnum);
1196 gchar*  g_strsignal             (gint         signum);
1197 gint    g_strcasecmp            (const gchar *s1,
1198                                  const gchar *s2);
1199 void    g_strdown               (gchar       *string);
1200 void    g_strup                 (gchar       *string);
1201 void    g_strreverse            (gchar       *string);
1202
1203 /* calculate a string size, guarranteed to fit format + args.
1204  */
1205 guint   g_printf_string_upper_bound (const gchar* format,
1206                                      va_list      args);
1207
1208 guint8* g_memdup                (const guint8 *mem,
1209                                  guint         len);
1210
1211
1212 /* Retrive static string info
1213  */
1214 gchar*  g_get_user_name         (void);
1215 gchar*  g_get_real_name         (void);
1216 gchar*  g_get_home_dir          (void);
1217 gchar*  g_get_tmp_dir           (void);
1218 gchar*  g_get_prgname           (void);
1219 void    g_set_prgname           (const gchar *prgname);
1220
1221
1222 /* Miscellaneous utility functions
1223  */
1224 guint   g_parse_debug_string    (const gchar *string,
1225                                  GDebugKey   *keys,
1226                                  guint        nkeys);
1227 gint    g_snprintf              (gchar       *string,
1228                                  gulong       n,
1229                                  gchar const *format,
1230                                  ...) G_GNUC_PRINTF (3, 4);
1231 gint    g_vsnprintf             (gchar       *string,
1232                                  gulong       n,
1233                                  gchar const *format,
1234                                  va_list      args);
1235 gchar*  g_basename              (const gchar *file_name);
1236
1237 /* strings are newly allocated with g_malloc() */
1238 gchar*  g_dirname               (const gchar *file_name);
1239 gchar*  g_get_current_dir       (void);
1240
1241 /* We make the assumption that if memmove isn't available, then
1242  * bcopy will do the job. This isn't safe everywhere. (bcopy can't
1243  * necessarily handle overlapping copies).
1244  * Either way, g_memmove() will not return a value.
1245  */
1246 #ifdef HAVE_MEMMOVE
1247 #define g_memmove(dest, src, size)      G_STMT_START {  \
1248      memmove ((dest), (src), (size));                   \
1249 } G_STMT_END
1250 #else
1251 #define g_memmove(dest, src, size)      G_STMT_START {  \
1252      bcopy ((src), (dest), (size));                     \
1253 } G_STMT_END
1254 #endif
1255
1256 /* we use a GLib function as a replacement for ATEXIT, so
1257  * the programmer is not required to check the return value
1258  * (if there is any in the implementation) and doesn't encounter
1259  * missing include files.
1260  */
1261 void    g_atexit                (GVoidFunc    func);
1262
1263
1264 /* Bit tests
1265  */
1266 G_INLINE_FUNC gint      g_bit_nth_lsf (guint32 mask,
1267                                        gint    nth_bit);
1268 #ifdef  G_CAN_INLINE
1269 G_INLINE_FUNC gint
1270 g_bit_nth_lsf (guint32 mask,
1271                gint    nth_bit)
1272 {
1273   do
1274     {
1275       nth_bit++;
1276       if (mask & (1 << (guint) nth_bit))
1277         return nth_bit;
1278     }
1279   while (nth_bit < 32);
1280   return -1;
1281 }
1282 #endif  /* G_CAN_INLINE */
1283
1284 G_INLINE_FUNC gint      g_bit_nth_msf (guint32 mask,
1285                                        gint    nth_bit);
1286 #ifdef G_CAN_INLINE
1287 G_INLINE_FUNC gint
1288 g_bit_nth_msf (guint32 mask,
1289                gint    nth_bit)
1290 {
1291   if (nth_bit < 0)
1292     nth_bit = 33;
1293   do
1294     {
1295       nth_bit--;
1296       if (mask & (1 << (guint) nth_bit))
1297         return nth_bit;
1298     }
1299   while (nth_bit > 0);
1300   return -1;
1301 }
1302 #endif  /* G_CAN_INLINE */
1303
1304 G_INLINE_FUNC guint     g_bit_storage (guint number);
1305 #ifdef G_CAN_INLINE
1306 G_INLINE_FUNC guint
1307 g_bit_storage (guint number)
1308 {
1309   register guint n_bits = 0;
1310
1311   do
1312     {
1313       n_bits++;
1314       number >>= 1;
1315     }
1316   while (number);
1317   return n_bits;
1318 }
1319 #endif  /* G_CAN_INLINE */
1320
1321
1322 /* String Chunks
1323  */
1324 GStringChunk* g_string_chunk_new           (gint size);
1325 void          g_string_chunk_free          (GStringChunk *chunk);
1326 gchar*        g_string_chunk_insert        (GStringChunk *chunk,
1327                                             const gchar  *string);
1328 gchar*        g_string_chunk_insert_const  (GStringChunk *chunk,
1329                                             const gchar  *string);
1330
1331
1332 /* Strings
1333  */
1334 GString* g_string_new       (const gchar *init);
1335 GString* g_string_sized_new (guint        dfl_size);
1336 void     g_string_free      (GString     *string,
1337                              gint         free_segment);
1338 GString* g_string_assign    (GString     *lval,
1339                              const gchar *rval);
1340 GString* g_string_truncate  (GString     *string,
1341                              gint         len);
1342 GString* g_string_append    (GString     *string,
1343                              const gchar *val);
1344 GString* g_string_append_c  (GString     *string,
1345                              gchar        c);
1346 GString* g_string_prepend   (GString     *string,
1347                              const gchar *val);
1348 GString* g_string_prepend_c (GString     *string,
1349                              gchar        c);
1350 GString* g_string_insert    (GString     *string,
1351                              gint         pos,
1352                              const gchar *val);
1353 GString* g_string_insert_c  (GString     *string,
1354                              gint         pos,
1355                              gchar        c);
1356 GString* g_string_erase     (GString     *string,
1357                              gint         pos,
1358                              gint         len);
1359 GString* g_string_down      (GString     *string);
1360 GString* g_string_up        (GString     *string);
1361 void     g_string_sprintf   (GString     *string,
1362                              const gchar *format,
1363                              ...) G_GNUC_PRINTF (2, 3);
1364 void     g_string_sprintfa  (GString     *string,
1365                              const gchar *format,
1366                              ...) G_GNUC_PRINTF (2, 3);
1367
1368
1369 /* Resizable arrays
1370  */
1371
1372 #define g_array_append_val(a,v) g_array_append_vals(a,&v,1)
1373 #define g_array_prepend_val(a,v) g_array_prepend_vals(a,&v,1)
1374 #define g_array_index(a,t,i) (((t*)a->data)[i])
1375
1376 GArray* g_array_new          (gboolean      zero_terminated,
1377                               gboolean      clear,
1378                               guint         element_size);
1379 void    g_array_free         (GArray       *array,
1380                               gboolean      free_segment);
1381 GArray* g_array_append_vals  (GArray       *array,
1382                               gconstpointer data,
1383                               guint         len);
1384 GArray* g_array_prepend_vals (GArray       *array,
1385                               gconstpointer data,
1386                               guint         len);
1387 GArray* g_array_set_size     (GArray       *array,
1388                               guint         length);
1389
1390 /* Resizable pointer array.  This interface is much less complicated
1391  * than the above.  Add appends appends a pointer.  Remove fills any
1392  * cleared spot and shortens the array.
1393  */
1394 #define     g_ptr_array_index(array,index) (array->pdata)[index]
1395 GPtrArray*  g_ptr_array_new                (void);
1396 void        g_ptr_array_free               (GPtrArray   *array,
1397                                             gboolean     free_seg);
1398 void        g_ptr_array_set_size           (GPtrArray   *array,
1399                                             gint         length);
1400 gpointer    g_ptr_array_remove_index       (GPtrArray   *array,
1401                                             gint         index);
1402 gboolean    g_ptr_array_remove             (GPtrArray   *array,
1403                                             gpointer     data);
1404 void        g_ptr_array_add                (GPtrArray   *array,
1405                                             gpointer     data);
1406
1407 /* Byte arrays, an array of guint8.  Implemented as a GArray,
1408  * but type-safe.
1409  */
1410
1411 GByteArray* g_byte_array_new      (void);
1412 void        g_byte_array_free     (GByteArray   *array,
1413                                    gboolean      free_segment);
1414 GByteArray* g_byte_array_append   (GByteArray   *array,
1415                                    const guint8 *data,
1416                                    guint         len);
1417 GByteArray* g_byte_array_prepend  (GByteArray   *array,
1418                                    const guint8 *data,
1419                                    guint         len);
1420 GByteArray* g_byte_array_set_size (GByteArray   *array,
1421                                    guint         length);
1422
1423
1424 /* Hash Functions
1425  */
1426 gint  g_str_equal (gconstpointer   v,
1427                    gconstpointer   v2);
1428 guint g_str_hash  (gconstpointer   v);
1429
1430 gint  g_int_equal (gconstpointer   v,
1431                    gconstpointer   v2);
1432 guint g_int_hash  (gconstpointer   v);
1433
1434 /* This "hash" function will just return the key's adress as an
1435  * unsigned integer. Useful for hashing on plain adresses or
1436  * simple integer values.
1437  */
1438 guint g_direct_hash  (gconstpointer v);
1439 gint  g_direct_equal (gconstpointer v,
1440                       gconstpointer v2);
1441
1442
1443 /* Quarks (string<->id association)
1444  */
1445 GQuark    g_quark_try_string            (const gchar    *string);
1446 GQuark    g_quark_from_static_string    (const gchar    *string);
1447 GQuark    g_quark_from_string           (const gchar    *string);
1448 gchar*    g_quark_to_string             (GQuark          quark);
1449
1450
1451 /* Keyed Data List
1452  */
1453 void      g_datalist_init               (GData          **datalist);
1454 void      g_datalist_clear              (GData          **datalist);
1455 gpointer  g_datalist_id_get_data        (GData          **datalist,
1456                                          GQuark           key_id);
1457 void      g_datalist_id_set_data_full   (GData          **datalist,
1458                                          GQuark           key_id,
1459                                          gpointer         data,
1460                                          GDestroyNotify   destroy_func);
1461 void      g_datalist_id_set_destroy     (GData          **datalist,
1462                                          GQuark           key_id,
1463                                          GDestroyNotify   destroy_func);
1464 void      g_datalist_foreach            (GData          **datalist,
1465                                          GDataForeachFunc func,
1466                                          gpointer         user_data);
1467 #define   g_datalist_id_set_data(dl, q, d)      \
1468      g_datalist_id_set_data_full ((dl), (q), (d), NULL)
1469 #define   g_datalist_id_remove_data(dl, q)      \
1470      g_datalist_id_set_data ((dl), (q), NULL)
1471 #define   g_datalist_get_data(dl, k)            \
1472      (g_datalist_id_get_data ((dl), g_quark_try_string ((k))))
1473 #define   g_datalist_set_data_full(dl, k, d, f) \
1474      g_datalist_id_set_data_full ((dl), g_quark_from_string ((k)), (d), (f))
1475 #define   g_datalist_set_destroy(dl, k, f)      \
1476      g_datalist_id_set_destroy ((dl), g_quark_try_string ((k)), (f))
1477 #define   g_datalist_set_data(dl, k, d)         \
1478      g_datalist_set_data_full ((dl), (k), (d), NULL)
1479 #define   g_datalist_remove_data(dl, k)         \
1480      g_datalist_id_set_data ((dl), g_quark_try_string ((k)), NULL)
1481
1482
1483 /* Location Associated Keyed Data
1484  */
1485 void      g_dataset_destroy             (gconstpointer    dataset_location);
1486 gpointer  g_dataset_id_get_data         (gconstpointer    dataset_location,
1487                                          GQuark           key_id);
1488 void      g_dataset_id_set_data_full    (gconstpointer    dataset_location,
1489                                          GQuark           key_id,
1490                                          gpointer         data,
1491                                          GDestroyNotify   destroy_func);
1492 void      g_dataset_id_set_destroy      (gconstpointer    dataset_location,
1493                                          GQuark           key_id,
1494                                          GDestroyNotify   destroy_func);
1495 void      g_dataset_foreach             (gconstpointer    dataset_location,
1496                                          GDataForeachFunc func,
1497                                          gpointer         user_data);
1498 #define   g_dataset_id_set_data(l, k, d)        \
1499      g_dataset_id_set_data_full ((l), (k), (d), NULL)
1500 #define   g_dataset_id_remove_data(l, k)        \
1501      g_dataset_id_set_data ((l), (k), NULL)
1502 #define   g_dataset_get_data(l, k)              \
1503      (g_dataset_id_get_data ((l), g_quark_try_string ((k))))
1504 #define   g_dataset_set_data_full(l, k, d, f)   \
1505      g_dataset_id_set_data_full ((l), g_quark_from_string ((k)), (d), (f))
1506 #define   g_dataset_set_destroy(l, k, f)        \
1507      g_dataset_id_set_destroy ((l), g_quark_try_string ((k)), (f))
1508 #define   g_dataset_set_data(l, k, d)           \
1509      g_dataset_set_data_full ((l), (k), (d), NULL)
1510 #define   g_dataset_remove_data(l, k)           \
1511      g_dataset_id_set_data ((l), g_quark_try_string ((k)), NULL)
1512
1513
1514 /* GScanner: Flexible lexical scanner for general purpose.
1515  */
1516
1517 /* Character sets */
1518 #define G_CSET_A_2_Z    "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1519 #define G_CSET_a_2_z    "abcdefghijklmnopqrstuvwxyz"
1520 #define G_CSET_LATINC   "\300\301\302\303\304\305\306"\
1521                         "\307\310\311\312\313\314\315\316\317\320"\
1522                         "\321\322\323\324\325\326"\
1523                         "\330\331\332\333\334\335\336"
1524 #define G_CSET_LATINS   "\337\340\341\342\343\344\345\346"\
1525                         "\347\350\351\352\353\354\355\356\357\360"\
1526                         "\361\362\363\364\365\366"\
1527                         "\370\371\372\373\374\375\376\377"
1528
1529 /* Error types */
1530 typedef enum
1531 {
1532   G_ERR_UNKNOWN,
1533   G_ERR_UNEXP_EOF,
1534   G_ERR_UNEXP_EOF_IN_STRING,
1535   G_ERR_UNEXP_EOF_IN_COMMENT,
1536   G_ERR_NON_DIGIT_IN_CONST,
1537   G_ERR_DIGIT_RADIX,
1538   G_ERR_FLOAT_RADIX,
1539   G_ERR_FLOAT_MALFORMED
1540 } GErrorType;
1541
1542 /* Token types */
1543 typedef enum
1544 {
1545   G_TOKEN_EOF                   =   0,
1546
1547   G_TOKEN_LEFT_PAREN            = '(',
1548   G_TOKEN_RIGHT_PAREN           = ')',
1549   G_TOKEN_LEFT_CURLY            = '{',
1550   G_TOKEN_RIGHT_CURLY           = '}',
1551   G_TOKEN_LEFT_BRACE            = '[',
1552   G_TOKEN_RIGHT_BRACE           = ']',
1553   G_TOKEN_EQUAL_SIGN            = '=',
1554   G_TOKEN_COMMA                 = ',',
1555
1556   G_TOKEN_NONE                  = 256,
1557
1558   G_TOKEN_ERROR,
1559
1560   G_TOKEN_CHAR,
1561   G_TOKEN_BINARY,
1562   G_TOKEN_OCTAL,
1563   G_TOKEN_INT,
1564   G_TOKEN_HEX,
1565   G_TOKEN_FLOAT,
1566   G_TOKEN_STRING,
1567
1568   G_TOKEN_SYMBOL,
1569   G_TOKEN_IDENTIFIER,
1570   G_TOKEN_IDENTIFIER_NULL,
1571
1572   G_TOKEN_COMMENT_SINGLE,
1573   G_TOKEN_COMMENT_MULTI,
1574   G_TOKEN_LAST
1575 } GTokenType;
1576
1577 union   _GValue
1578 {
1579   gpointer      v_symbol;
1580   gchar         *v_identifier;
1581   gulong        v_binary;
1582   gulong        v_octal;
1583   gulong        v_int;
1584   gdouble       v_float;
1585   gulong        v_hex;
1586   gchar         *v_string;
1587   gchar         *v_comment;
1588   guchar        v_char;
1589   guint         v_error;
1590 };
1591
1592 struct  _GScannerConfig
1593 {
1594   /* Character sets
1595    */
1596   gchar         *cset_skip_characters;          /* default: " \t\n" */
1597   gchar         *cset_identifier_first;
1598   gchar         *cset_identifier_nth;
1599   gchar         *cpair_comment_single;          /* default: "#\n" */
1600
1601   /* Should symbol lookup work case sensitive?
1602    */
1603   guint         case_sensitive : 1;
1604
1605   /* Boolean values to be adjusted "on the fly"
1606    * to configure scanning behaviour.
1607    */
1608   guint         skip_comment_multi : 1;         /* C like comment */
1609   guint         skip_comment_single : 1;        /* single line comment */
1610   guint         scan_comment_multi : 1;         /* scan multi line comments? */
1611   guint         scan_identifier : 1;
1612   guint         scan_identifier_1char : 1;
1613   guint         scan_identifier_NULL : 1;
1614   guint         scan_symbols : 1;
1615   guint         scan_binary : 1;
1616   guint         scan_octal : 1;
1617   guint         scan_float : 1;
1618   guint         scan_hex : 1;                   /* `0x0ff0' */
1619   guint         scan_hex_dollar : 1;            /* `$0ff0' */
1620   guint         scan_string_sq : 1;             /* string: 'anything' */
1621   guint         scan_string_dq : 1;             /* string: "\\-escapes!\n" */
1622   guint         numbers_2_int : 1;              /* bin, octal, hex => int */
1623   guint         int_2_float : 1;                /* int => G_TOKEN_FLOAT? */
1624   guint         identifier_2_string : 1;
1625   guint         char_2_token : 1;               /* return G_TOKEN_CHAR? */
1626   guint         symbol_2_token : 1;
1627   guint         scope_0_fallback : 1;           /* try scope 0 on lookups? */
1628 };
1629
1630 struct  _GScanner
1631 {
1632   /* unused fields */
1633   gpointer              user_data;
1634   guint                 max_parse_errors;
1635
1636   /* g_scanner_error() increments this field */
1637   guint                 parse_errors;
1638
1639   /* name of input stream, featured by the default message handler */
1640   const gchar           *input_name;
1641
1642   /* data pointer for derived structures */
1643   gpointer              derived_data;
1644
1645   /* link into the scanner configuration */
1646   GScannerConfig        *config;
1647
1648   /* fields filled in after g_scanner_get_next_token() */
1649   GTokenType            token;
1650   GValue                value;
1651   guint                 line;
1652   guint                 position;
1653
1654   /* fields filled in after g_scanner_peek_next_token() */
1655   GTokenType            next_token;
1656   GValue                next_value;
1657   guint                 next_line;
1658   guint                 next_position;
1659
1660   /* to be considered private */
1661   GHashTable            *symbol_table;
1662   const gchar           *text;
1663   guint                 text_len;
1664   gint                  input_fd;
1665   gint                  peeked_char;
1666   guint                 scope_id;
1667
1668   /* handler function for _warn and _error */
1669   GScannerMsgFunc       msg_handler;
1670 };
1671
1672 GScanner*       g_scanner_new                   (GScannerConfig *config_templ);
1673 void            g_scanner_destroy               (GScanner       *scanner);
1674 void            g_scanner_input_file            (GScanner       *scanner,
1675                                                  gint           input_fd);
1676 void            g_scanner_input_text            (GScanner       *scanner,
1677                                                  const  gchar   *text,
1678                                                  guint          text_len);
1679 GTokenType      g_scanner_get_next_token        (GScanner       *scanner);
1680 GTokenType      g_scanner_peek_next_token       (GScanner       *scanner);
1681 GTokenType      g_scanner_cur_token             (GScanner       *scanner);
1682 GValue          g_scanner_cur_value             (GScanner       *scanner);
1683 guint           g_scanner_cur_line              (GScanner       *scanner);
1684 guint           g_scanner_cur_position          (GScanner       *scanner);
1685 gboolean        g_scanner_eof                   (GScanner       *scanner);
1686 guint           g_scanner_set_scope             (GScanner       *scanner,
1687                                                  guint           scope_id);
1688 void            g_scanner_scope_add_symbol      (GScanner       *scanner,
1689                                                  guint           scope_id,
1690                                                  const gchar    *symbol,
1691                                                  gpointer       value);
1692 void            g_scanner_scope_remove_symbol   (GScanner       *scanner,
1693                                                  guint           scope_id,
1694                                                  const gchar    *symbol);
1695 gpointer        g_scanner_scope_lookup_symbol   (GScanner       *scanner,
1696                                                  guint           scope_id,
1697                                                  const gchar    *symbol);
1698 void            g_scanner_scope_foreach_symbol  (GScanner       *scanner,
1699                                                  guint           scope_id,
1700                                                  GHFunc          func,
1701                                                  gpointer        func_data);
1702 gpointer        g_scanner_lookup_symbol         (GScanner       *scanner,
1703                                                  const gchar    *symbol);
1704 void            g_scanner_freeze_symbol_table   (GScanner       *scanner);
1705 void            g_scanner_thaw_symbol_table     (GScanner       *scanner);
1706 void            g_scanner_unexp_token           (GScanner       *scanner,
1707                                                  GTokenType     expected_token,
1708                                                  const gchar    *identifier_spec,
1709                                                  const gchar    *symbol_spec,
1710                                                  const gchar    *symbol_name,
1711                                                  const gchar    *message,
1712                                                  gint            is_error);
1713 void            g_scanner_error                 (GScanner       *scanner,
1714                                                  const gchar    *format,
1715                                                  ...) G_GNUC_PRINTF (2,3);
1716 void            g_scanner_warn                  (GScanner       *scanner,
1717                                                  const gchar    *format,
1718                                                  ...) G_GNUC_PRINTF (2,3);
1719 gint            g_scanner_stat_mode             (const gchar    *filename);
1720 /* keep downward source compatibility */
1721 #define         g_scanner_add_symbol( scanner, symbol, value )  G_STMT_START { \
1722   g_scanner_scope_add_symbol ((scanner), 0, (symbol), (value)); \
1723 } G_STMT_END
1724 #define         g_scanner_remove_symbol( scanner, symbol )      G_STMT_START { \
1725   g_scanner_scope_remove_symbol ((scanner), 0, (symbol)); \
1726 } G_STMT_END
1727 #define         g_scanner_foreach_symbol( scanner, func, data ) G_STMT_START { \
1728   g_scanner_scope_foreach_symbol ((scanner), 0, (func), (data)); \
1729 } G_STMT_END
1730
1731
1732 /* Completion */
1733
1734 struct _GCompletion
1735 {
1736   GList* items;
1737   GCompletionFunc func;
1738
1739   gchar* prefix;
1740   GList* cache;
1741 };
1742
1743 GCompletion* g_completion_new          (GCompletionFunc func);
1744 void         g_completion_add_items    (GCompletion*    cmp,
1745                                         GList*          items);
1746 void         g_completion_remove_items (GCompletion*    cmp,
1747                                         GList*          items);
1748 void         g_completion_clear_items  (GCompletion*    cmp);
1749 GList*       g_completion_complete     (GCompletion*    cmp,
1750                                         gchar*          prefix,
1751                                         gchar**         new_prefix);
1752 void         g_completion_free         (GCompletion*    cmp);
1753
1754
1755 /* GRelation: Indexed Relations.  Imagine a really simple table in a
1756  * database.  Relations are not ordered.  This data type is meant for
1757  * maintaining a N-way mapping.
1758  *
1759  * g_relation_new() creates a relation with FIELDS fields
1760  *
1761  * g_relation_destroy() frees all resources
1762  * g_tuples_destroy() frees the result of g_relation_select()
1763  *
1764  * g_relation_index() indexes relation FIELD with the provided
1765  *   equality and hash functions.  this must be done before any
1766  *   calls to insert are made.
1767  *
1768  * g_relation_insert() inserts a new tuple.  you are expected to
1769  *   provide the right number of fields.
1770  *
1771  * g_relation_delete() deletes all relations with KEY in FIELD
1772  * g_relation_select() returns ...
1773  * g_relation_count() counts ...
1774  */
1775
1776 GRelation* g_relation_new     (gint         fields);
1777 void       g_relation_destroy (GRelation   *relation);
1778 void       g_relation_index   (GRelation   *relation,
1779                                gint         field,
1780                                GHashFunc    hash_func,
1781                                GCompareFunc key_compare_func);
1782 void       g_relation_insert  (GRelation   *relation,
1783                                ...);
1784 gint       g_relation_delete  (GRelation   *relation,
1785                                gconstpointer  key,
1786                                gint         field);
1787 GTuples*   g_relation_select  (GRelation   *relation,
1788                                gconstpointer  key,
1789                                gint         field);
1790 gint       g_relation_count   (GRelation   *relation,
1791                                gconstpointer  key,
1792                                gint         field);
1793 gboolean   g_relation_exists  (GRelation   *relation,
1794                                ...);
1795 void       g_relation_print   (GRelation   *relation);
1796
1797 void       g_tuples_destroy   (GTuples     *tuples);
1798 gpointer   g_tuples_index     (GTuples     *tuples,
1799                                gint         index,
1800                                gint         field);
1801
1802
1803 /* Prime numbers.
1804  */
1805
1806 /* This function returns prime numbers spaced by approximately 1.5-2.0
1807  * and is for use in resizing data structures which prefer
1808  * prime-valued sizes.  The closest spaced prime function returns the
1809  * next largest prime, or the highest it knows about which is about
1810  * MAXINT/4.
1811  */
1812
1813 guint      g_spaced_primes_closest (guint num);
1814
1815 /* Glib version.
1816  */
1817 extern const guint glib_major_version;
1818 extern const guint glib_minor_version;
1819 extern const guint glib_micro_version;
1820
1821 #ifdef __cplusplus
1822 }
1823 #endif /* __cplusplus */
1824
1825
1826 #endif /* __G_LIB_H__ */