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 #include <glibconfig.h>
  23
  24 #ifdef USE_DMALLOC
  25 #include "dmalloc.h"
  26 #endif
  27
  28
  29 /* glib provides definitions for the extrema of many
  30  *  of the standard types. These are:
  31  * G_MINFLOAT
  32  * G_MAXFLOAT
  33  * G_MINDOUBLE
  34  * G_MAXDOUBLE
  35  * G_MINSHORT
  36  * G_MAXSHORT
  37  * G_MININT
  38  * G_MAXINT
  39  * G_MINLONG
  40  * G_MAXLONG
  41  */
  42
  43 #ifdef HAVE_FLOAT_H
  44
  45 #include <float.h>
  46
  47 #define G_MINFLOAT   FLT_MIN
  48 #define G_MAXFLOAT   FLT_MAX
  49 #define G_MINDOUBLE  DBL_MIN
  50 #define G_MAXDOUBLE  DBL_MAX
  51
  52 #elif HAVE_VALUES_H
  53
  54 #include <values.h>
  55
  56 #define G_MINFLOAT  MINFLOAT
  57 #define G_MAXFLOAT  MAXFLOAT
  58 #define G_MINDOUBLE MINDOUBLE
  59 #define G_MAXDOUBLE MAXDOUBLE
  60
  61 #endif /* HAVE_VALUES_H */
  62
  63
  64 #ifdef HAVE_LIMITS_H
  65
  66 #include <limits.h>
  67
  68 #define G_MINSHORT  SHRT_MIN
  69 #define G_MAXSHORT  SHRT_MAX
  70 #define G_MININT    INT_MIN
  71 #define G_MAXINT    INT_MAX
  72 #define G_MINLONG   LONG_MIN
  73 #define G_MAXLONG   LONG_MAX
  74
  75 #elif HAVE_VALUES_H
  76
  77 #ifdef HAVE_FLOAT_H
  78 #include <values.h>
  79 #endif /* HAVE_FLOAT_H */
  80
  81 #define G_MINSHORT  MINSHORT
  82 #define G_MAXSHORT  MAXSHORT
  83 #define G_MININT    MININT
  84 #define G_MAXINT    MAXINT
  85 #define G_MINLONG   MINLONG
  86 #define G_MAXLONG   MAXLONG
  87
  88 #endif /* HAVE_VALUES_H */
  89
  90
  91 /* Provide definitions for some commonly used macros.
  92  *  Some of them are only provided if they haven't already
  93  *  been defined. It is assumed that if they are already
  94  *  defined then the current definition is correct.
  95  */
  96 #ifndef NULL
  97 #define NULL    ((void*) 0)
  98 #endif
  99
 100 #ifndef FALSE
 101 #define FALSE   (0)
 102 #endif
 103
 104 #ifndef TRUE
 105 #define TRUE    (!FALSE)
 106 #endif
 107
 108 #undef  MAX
 109 #define MAX(a, b)  (((a) > (b)) ? (a) : (b))
 110
 111 #undef  MIN
 112 #define MIN(a, b)  (((a) < (b)) ? (a) : (b))
 113
 114 #undef  ABS
 115 #define ABS(a)     (((a) < 0) ? -(a) : (a))
 116
 117 #undef  CLAMP
 118 #define CLAMP(x, low, high)  (((x) > (high)) ? (high) : (((x) < (low)) ? (low) : (x)))
 119
 120
 121 /* Provide simple enum value macro wrappers that ease automated enum value
 122  * stringification code.
 123  */
 124 #if     !defined (G_CODE_GENERATION)
 125 #define G_ENUM( EnumerationName )               EnumerationName
 126 #define G_FLAGS( EnumerationName )              EnumerationName
 127 #define G_NV( VALUE_NAME , value_nick, VALUE)   VALUE_NAME = (VALUE)
 128 #define G_SV( VALUE_NAME, value_nick )          VALUE_NAME
 129 #else   /* G_CODE_GENERATION */
 130 #define G_ENUM( EnumerationName )               G_ENUM_E + EnumerationName +
 131 #define G_FLAGS( EnumerationName )              G_ENUM_F + EnumerationName +
 132 #define G_NV( VALUE_NAME , value_nick, VALUE)   G_ENUM_V + VALUE_NAME + value_nick +
 133 #define G_SV( VALUE_NAME, value_nick )          G_ENUM_V + VALUE_NAME + value_nick +
 134 #endif  /* G_CODE_GENERATION */
 135
 136
 137 /* Provide simple macro statement wrappers (adapted from Pearl):
 138  *  G_STMT_START { statements; } G_STMT_END;
 139  *  can be used as a single statement, as in
 140  *  if (x) G_STMT_START { ... } G_STMT_END; else ...
 141  *
 142  *  For gcc we will wrap the statements within `({' and `})' braces.
 143  *  For SunOS they will be wrapped within `if (1)' and `else (void) 0',
 144  *  and otherwise within `do' and `while (0)'.
 145  */
 146 #if !(defined (G_STMT_START) && defined (G_STMT_END))
 147 #  if defined (__GNUC__) && !defined (__STRICT_ANSI__) && !defined (__cplusplus)
 148 #    define G_STMT_START        (void)(
 149 #    define G_STMT_END          )
 150 #  else
 151 #    if (defined (sun) || defined (__sun__))
 152 #      define G_STMT_START      if (1)
 153 #      define G_STMT_END        else (void)0
 154 #    else
 155 #      define G_STMT_START      do
 156 #      define G_STMT_END        while (0)
 157 #    endif
 158 #  endif
 159 #endif
 160
 161 /* Provide macros to feature the GCC function attribute.
 162  */
 163 #if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
 164 #define G_GNUC_PRINTF( format_idx, arg_idx )    \
 165   __attribute__((format (printf, format_idx, arg_idx)))
 166 #define G_GNUC_SCANF( format_idx, arg_idx )     \
 167   __attribute__((format (scanf, format_idx, arg_idx)))
 168 #define G_GNUC_FORMAT( arg_idx )                \
 169   __attribute__((format_arg (arg_idx)))
 170 #define G_GNUC_NORETURN                         \
 171   __attribute__((noreturn))
 172 #define G_GNUC_CONST                            \
 173   __attribute__((const))
 174 #else   /* !__GNUC__ */
 175 #define G_GNUC_PRINTF( format_idx, arg_idx )
 176 #define G_GNUC_SCANF( format_idx, arg_idx )
 177 #define G_GNUC_FORMAT( arg_idx )
 178 #define G_GNUC_NORETURN
 179 #define G_GNUC_CONST
 180 #endif  /* !__GNUC__ */
 181
 182 /* Hacker macro to place breakpoints for x86 machines.
 183  * Actuall use is strongly deprecated of course ;)
 184  */
 185 #if     defined (__i386__)
 186 #define G_BREAKPOINT()          G_STMT_START{ __asm__ ("int $03"); }G_STMT_END
 187 #else   /* !__i386__ */
 188 #define G_BREAKPOINT()
 189 #endif  /* __i386__ */
 190
 191 /* Wrap the __PRETTY_FUNCTION__ and __FUNCTION__ variables with macros,
 192  * so we can refer to them as strings unconditionally.
 193  */
 194 #ifdef  __GNUC__
 195 #define G_GNUC_FUNCTION         (__FUNCTION__)
 196 #define G_GNUC_PRETTY_FUNCTION  (__PRETTY_FUNCTION__)
 197 #else   /* !__GNUC__ */
 198 #define G_GNUC_FUNCTION         ("")
 199 #define G_GNUC_PRETTY_FUNCTION  ("")
 200 #endif  /* !__GNUC__ */
 201
 202
 203 #ifndef ATEXIT
 204 #  ifdef HAVE_ATEXIT
 205 #    define ATEXIT(proc)   (atexit (proc))
 206 #  elif defined (HAVE_ON_EXIT)
 207 #    define ATEXIT(proc)   (on_exit ((void (*)(int, void *))(proc), NULL))
 208 #  endif
 209 #endif /* ATEXIT */
 210
 211
 212 /* Provide macros for easily allocating memory. The macros
 213  *  will cast the allocated memory to the specified type
 214  *  in order to avoid compiler warnings. (Makes the code neater).
 215  */
 216
 217 #ifdef __DMALLOC_H__
 218
 219 #define g_new(type,count)        ALLOC(type,count)
 220 #define g_new0(type,count)       CALLOC(type,count)
 221
 222 #else /* __DMALLOC_H__ */
 223
 224 #define g_new(type, count)        \
 225     ((type *) g_malloc ((unsigned) sizeof (type) * (count)))
 226 #define g_new0(type, count)       \
 227     ((type *) g_malloc0 ((unsigned) sizeof (type) * (count)))
 228 #endif /* __DMALLOC_H__ */
 229
 230 #define g_mem_chunk_create(type, pre_alloc, alloc_type) ( \
 231   g_mem_chunk_new (#type " mem chunks (" #pre_alloc ")", \
 232                    sizeof (type), \
 233                    sizeof (type) * (pre_alloc), \
 234                    (alloc_type)) \
 235 )
 236 #define g_chunk_new(type, chunk)        ( \
 237   (type *) g_mem_chunk_alloc (chunk) \
 238 )
 239 #define g_chunk_new0(type, chunk)       ( \
 240   (type *) memset (g_mem_chunk_alloc (chunk), 0, sizeof (type)) \
 241 )
 242 #define g_chunk_free(mem, mem_chunk)    G_STMT_START { \
 243   g_mem_chunk_free ((mem_chunk), (mem)); \
 244 } G_STMT_END
 245
 246 #define g_string(x) #x
 247
 248
 249 /* Provide macros for error handling. The "assert" macros will
 250  *  exit on failure. The "return" macros will exit the current
 251  *  function. Two different definitions are given for the macros
 252  *  in order to support gcc's __PRETTY_FUNCTION__ capability.
 253  */
 254
 255 #ifdef G_DISABLE_ASSERT
 256
 257 #define g_assert(expr)
 258 #define g_assert_not_reached()
 259
 260 #else /* !G_DISABLE_ASSERT */
 261
 262 #ifdef __GNUC__
 263
 264 #define g_assert(expr)                  G_STMT_START{\
 265      if (!(expr))                                    \
 266        g_error ("file %s: line %d (%s): \"%s\"",     \
 267                 __FILE__,                            \
 268                 __LINE__,                            \
 269                 __PRETTY_FUNCTION__,                 \
 270                 #expr);                 }G_STMT_END
 271
 272 #define g_assert_not_reached()          G_STMT_START{                 \
 273      g_error ("file %s: line %d (%s): \"should not be reached\"",     \
 274               __FILE__,                                               \
 275               __LINE__,                                               \
 276               __PRETTY_FUNCTION__);     }G_STMT_END
 277
 278 #else /* !__GNUC__ */
 279
 280 #define g_assert(expr)                  G_STMT_START{\
 281      if (!(expr))                                    \
 282        g_error ("file %s: line %d: \"%s\"",          \
 283                 __FILE__,                            \
 284                 __LINE__,                            \
 285                 #expr);                 }G_STMT_END
 286
 287 #define g_assert_not_reached()          G_STMT_START{                 \
 288      g_error ("file %s: line %d: \"should not be reached\"",          \
 289               __FILE__,                                               \
 290               __LINE__);                }G_STMT_END
 291
 292 #endif /* __GNUC__ */
 293
 294 #endif /* G_DISABLE_ASSERT */
 295
 296 #ifdef G_DISABLE_CHECKS
 297
 298 #define g_return_if_fail(expr)
 299 #define g_return_val_if_fail(expr,val)
 300
 301 #else /* !G_DISABLE_CHECKS */
 302
 303 #ifdef __GNUC__
 304
 305 #define g_return_if_fail(expr)          G_STMT_START{                  \
 306      if (!(expr))                                                      \
 307        {                                                               \
 308          g_warning ("file %s: line %d (%s): assertion \"%s\" failed.", \
 309                     __FILE__,                                          \
 310                     __LINE__,                                          \
 311                     __PRETTY_FUNCTION__,                               \
 312                     #expr);                                            \
 313          return;                                                       \
 314        };                               }G_STMT_END
 315
 316 #define g_return_val_if_fail(expr,val)  G_STMT_START{                  \
 317      if (!(expr))                                                      \
 318        {                                                               \
 319          g_warning ("file %s: line %d (%s): assertion \"%s\" failed.", \
 320                     __FILE__,                                          \
 321                     __LINE__,                                          \
 322                     __PRETTY_FUNCTION__,                               \
 323                     #expr);                                            \
 324          return val;                                                   \
 325        };                               }G_STMT_END
 326
 327 #else /* !__GNUC__ */
 328
 329 #define g_return_if_fail(expr)          G_STMT_START{             \
 330      if (!(expr))                                                 \
 331        {                                                          \
 332          g_warning ("file %s: line %d: assertion. \"%s\" failed", \
 333                     __FILE__,                                     \
 334                     __LINE__,                                     \
 335                     #expr);                                       \
 336          return;                                                  \
 337        };                               }G_STMT_END
 338
 339 #define g_return_val_if_fail(expr, val) G_STMT_START{             \
 340      if (!(expr))                                                 \
 341        {                                                          \
 342          g_warning ("file %s: line %d: assertion \"%s\" failed.", \
 343                     __FILE__,                                     \
 344                     __LINE__,                                     \
 345                     #expr);                                       \
 346          return val;                                              \
 347        };                               }G_STMT_END
 348
 349 #endif /* !__GNUC__ */
 350
 351 #endif /* G_DISABLE_CHECKS */
 352
 353
 354 #ifdef __cplusplus
 355 extern "C" {
 356 #pragma }
 357 #endif /* __cplusplus */
 358
 359 /* Provide type definitions for commonly used types.
 360  *  These are useful because a "gint8" can be adjusted
 361  *  to be 1 byte (8 bits) on all platforms. Similarly and
 362  *  more importantly, "gint32" can be adjusted to be
 363  *  4 bytes (32 bits) on all platforms.
 364  */
 365
 366 typedef char   gchar;
 367 typedef short  gshort;
 368 typedef long   glong;
 369 typedef int    gint;
 370 typedef gint   gboolean;
 371
 372 typedef unsigned char   guchar;
 373 typedef unsigned short  gushort;
 374 typedef unsigned long   gulong;
 375 typedef unsigned int    guint;
 376
 377 typedef float   gfloat;
 378 typedef double  gdouble;
 379
 380 /* HAVE_LONG_DOUBLE doesn't work correctly on all platforms.
 381  * Since gldouble isn't used anywhere, just disable it for now */
 382
 383 #if 0
 384 #ifdef HAVE_LONG_DOUBLE
 385 typedef long double gldouble;
 386 #else /* HAVE_LONG_DOUBLE */
 387 typedef double gldouble;
 388 #endif /* HAVE_LONG_DOUBLE */
 389 #endif /* 0 */
 390
 391 typedef void* gpointer;
 392 typedef const void *gconstpointer;
 393
 394 #if (SIZEOF_CHAR == 1)
 395 typedef signed char     gint8;
 396 typedef unsigned char   guint8;
 397 #endif /* SIZEOF_CHAR */
 398
 399
 400 #if (SIZEOF_SHORT == 2)
 401 typedef signed short    gint16;
 402 typedef unsigned short  guint16;
 403 #endif /* SIZEOF_SHORT */
 404
 405
 406 #if (SIZEOF_INT == 4)
 407 typedef signed int      gint32;
 408 typedef unsigned int    guint32;
 409 #elif (SIZEOF_LONG == 4)
 410 typedef signed long     gint32;
 411 typedef unsigned long   guint32;
 412 #endif /* SIZEOF_INT */
 413
 414 /* Define macros for storing integers inside pointers */
 415
 416 #if (SIZEOF_INT == SIZEOF_VOID_P)
 417
 418 #define GPOINTER_TO_INT(p) ((gint)(p))
 419 #define GPOINTER_TO_UINT(p) ((guint)(p))
 420
 421 #define GINT_TO_POINTER(i) ((gpointer)(i))
 422 #define GUINT_TO_POINTER(u) ((gpointer)(u))
 423
 424 #elif (SIZEOF_LONG == SIZEOF_VOID_P)
 425
 426 #define GPOINTER_TO_INT(p) ((gint)(glong)(p))
 427 #define GPOINTER_TO_UINT(p) ((guint)(gulong)(p))
 428
 429 #define GINT_TO_POINTER(i) ((gpointer)(glong)(i))
 430 #define GUINT_TO_POINTER(u) ((gpointer)(gulong)(u))
 431
 432 #else
 433 /* This should never happen */
 434 #endif
 435
 436 typedef gint32  gssize;
 437 typedef guint32 gsize;
 438 typedef gint32  gtime;
 439 typedef guint32 GQuark;
 440
 441 typedef struct _GList           GList;
 442 typedef struct _GSList          GSList;
 443 typedef struct _GHashTable      GHashTable;
 444 typedef struct _GCache          GCache;
 445 typedef struct _GTree           GTree;
 446 typedef struct _GTimer          GTimer;
 447 typedef struct _GMemChunk       GMemChunk;
 448 typedef struct _GListAllocator  GListAllocator;
 449 typedef struct _GStringChunk    GStringChunk;
 450 typedef struct _GString         GString;
 451 typedef struct _GArray          GArray;
 452 typedef struct _GPtrArray       GPtrArray;
 453 typedef struct _GByteArray      GByteArray;
 454 typedef struct _GDebugKey       GDebugKey;
 455 typedef struct _GScannerConfig  GScannerConfig;
 456 typedef struct _GScanner        GScanner;
 457 typedef union  _GValue          GValue;
 458 typedef struct _GRelation      GRelation;
 459 typedef struct _GTuples        GTuples;
 460
 461
 462 typedef void            (*GFunc)                (gpointer  data,
 463                                                  gpointer  user_data);
 464 typedef void            (*GHFunc)               (gpointer  key,
 465                                                  gpointer  value,
 466                                                  gpointer  user_data);
 467 typedef gpointer        (*GCacheNewFunc)        (gpointer  key);
 468 typedef gpointer        (*GCacheDupFunc)        (gpointer  value);
 469 typedef void            (*GCacheDestroyFunc)    (gpointer  value);
 470 typedef gint            (*GTraverseFunc)        (gpointer  key,
 471                                                  gpointer  value,
 472                                                  gpointer  data);
 473 typedef gint            (*GSearchFunc)          (gpointer  key,
 474                                                  gpointer  data);
 475 typedef void            (*GErrorFunc)           (gchar    *str);
 476 typedef void            (*GWarningFunc)         (gchar    *str);
 477 typedef void            (*GPrintFunc)           (gchar    *str);
 478 typedef void            (*GScannerMsgFunc)      (GScanner *scanner,
 479                                                  gchar    *message,
 480                                                  gint      error);
 481 typedef void            (*GDestroyNotify)       (gpointer  data);
 482
 483 typedef guint           (*GHashFunc)            (gconstpointer    key);
 484 typedef gint            (*GCompareFunc)         (gconstpointer    a,
 485                                                  gconstpointer    b);
 486
 487 struct _GList
 488 {
 489   gpointer data;
 490   GList *next;
 491   GList *prev;
 492 };
 493
 494 struct _GSList
 495 {
 496   gpointer data;
 497   GSList *next;
 498 };
 499
 500 struct _GString
 501 {
 502   gchar *str;
 503   gint len;
 504 };
 505
 506 struct _GArray
 507 {
 508   gchar *data;
 509   guint len;
 510 };
 511
 512 struct _GByteArray
 513 {
 514   guint8 *data;
 515   guint   len;
 516 };
 517
 518 struct _GPtrArray
 519 {
 520   gpointer *pdata;
 521   guint     len;
 522 };
 523
 524 struct _GTuples
 525 {
 526   guint len;
 527 };
 528
 529 struct _GDebugKey
 530 {
 531   gchar *key;
 532   guint  value;
 533 };
 534
 535 struct _GCache { gint dummy; };
 536 struct _GTree { gint dummy; };
 537 struct _GTimer { gint dummy; };
 538 struct _GMemChunk { gint dummy; };
 539 struct _GListAllocator { gint dummy; };
 540 struct _GStringChunk { gint dummy; };
 541
 542 typedef enum
 543 {
 544   G_IN_ORDER,
 545   G_PRE_ORDER,
 546   G_POST_ORDER
 547 } GTraverseType;
 548
 549 /* Doubly linked lists
 550  */
 551 GList* g_list_alloc             (void);
 552 void   g_list_free              (GList          *list);
 553 void   g_list_free_1            (GList          *list);
 554 GList* g_list_append            (GList          *list,
 555                                  gpointer        data);
 556 GList* g_list_prepend           (GList          *list,
 557                                  gpointer        data);
 558 GList* g_list_insert            (GList          *list,
 559                                  gpointer        data,
 560                                  gint            position);
 561 GList* g_list_insert_sorted     (GList          *list,
 562                                  gpointer        data,
 563                                  GCompareFunc    func);
 564 GList* g_list_concat            (GList          *list1,
 565                                  GList          *list2);
 566 GList* g_list_remove            (GList          *list,
 567                                  gpointer        data);
 568 GList* g_list_remove_link       (GList          *list,
 569                                  GList          *link);
 570 GList* g_list_reverse           (GList          *list);
 571 GList* g_list_nth               (GList          *list,
 572                                  guint           n);
 573 GList* g_list_find              (GList          *list,
 574                                  gpointer        data);
 575 GList* g_list_find_custom       (GList          *list,
 576                                  gpointer        data,
 577                                  GCompareFunc    func);
 578 gint   g_list_position          (GList          *list,
 579                                  GList          *link);
 580 gint   g_list_index             (GList          *list,
 581                                  gpointer        data);
 582 GList* g_list_last              (GList          *list);
 583 GList* g_list_first             (GList          *list);
 584 guint  g_list_length            (GList          *list);
 585 void   g_list_foreach           (GList          *list,
 586                                  GFunc           func,
 587                                  gpointer        user_data);
 588 gpointer g_list_nth_data        (GList          *list,
 589                                  guint           n);
 590
 591 #define g_list_previous(list)   ((list) ? (((GList *)(list))->prev) : NULL)
 592 #define g_list_next(list)       ((list) ? (((GList *)(list))->next) : NULL)
 593
 594 /* Singly linked lists
 595  */
 596 GSList* g_slist_alloc           (void);
 597 void    g_slist_free            (GSList         *list);
 598 void    g_slist_free_1          (GSList         *list);
 599 GSList* g_slist_append          (GSList         *list,
 600                                  gpointer        data);
 601 GSList* g_slist_prepend         (GSList         *list,
 602                                  gpointer        data);
 603 GSList* g_slist_insert          (GSList         *list,
 604                                  gpointer        data,
 605                                  gint            position);
 606 GSList* g_slist_insert_sorted   (GSList         *list,
 607                                  gpointer        data,
 608                                  GCompareFunc    func);
 609 GSList* g_slist_concat          (GSList         *list1,
 610                                  GSList         *list2);
 611 GSList* g_slist_remove          (GSList         *list,
 612                                  gpointer        data);
 613 GSList* g_slist_remove_link     (GSList         *list,
 614                                  GSList         *link);
 615 GSList* g_slist_reverse         (GSList         *list);
 616 GSList* g_slist_nth             (GSList         *list,
 617                                  guint           n);
 618 GSList* g_slist_find            (GSList         *list,
 619                                  gpointer        data);
 620 GSList* g_slist_find_custom     (GSList         *list,
 621                                  gpointer        data,
 622                                  GCompareFunc    func);
 623 gint    g_slist_position        (GSList         *list,
 624                                  GSList         *link);
 625 gint    g_slist_index           (GSList         *list,
 626                                  gpointer        data);
 627 GSList* g_slist_last            (GSList         *list);
 628 guint   g_slist_length          (GSList         *list);
 629 void    g_slist_foreach         (GSList         *list,
 630                                  GFunc           func,
 631                                  gpointer        user_data);
 632 gpointer g_slist_nth_data       (GSList         *list,
 633                                  guint           n);
 634
 635 #define g_slist_next(slist)     ((slist) ? (((GSList *)(slist))->next) : NULL)
 636
 637 /* List Allocators
 638  */
 639 GListAllocator* g_list_allocator_new  (void);
 640 void            g_list_allocator_free (GListAllocator* allocator);
 641 GListAllocator* g_slist_set_allocator (GListAllocator* allocator);
 642 GListAllocator* g_list_set_allocator  (GListAllocator* allocator);
 643
 644
 645 /* Hash tables
 646  */
 647 GHashTable* g_hash_table_new            (GHashFunc       hash_func,
 648                                          GCompareFunc    key_compare_func);
 649 void        g_hash_table_destroy        (GHashTable     *hash_table);
 650 void        g_hash_table_insert         (GHashTable     *hash_table,
 651                                          gpointer        key,
 652                                          gpointer        value);
 653 void        g_hash_table_remove         (GHashTable     *hash_table,
 654                                          gconstpointer   key);
 655 gpointer    g_hash_table_lookup         (GHashTable     *hash_table,
 656                                          gconstpointer   key);
 657 gboolean    g_hash_table_lookup_full    (GHashTable     *hash_table,
 658                                          gconstpointer   lookup_key,
 659                                          gpointer       *orig_key,
 660                                          gpointer       *value);
 661 void        g_hash_table_freeze         (GHashTable     *hash_table);
 662 void        g_hash_table_thaw           (GHashTable     *hash_table);
 663 void        g_hash_table_foreach        (GHashTable     *hash_table,
 664                                          GHFunc          func,
 665                                          gpointer        user_data);
 666 gint        g_hash_table_size           (GHashTable     *hash_table);
 667
 668
 669 /* Caches
 670  */
 671 GCache*  g_cache_new           (GCacheNewFunc      value_new_func,
 672                                 GCacheDestroyFunc  value_destroy_func,
 673                                 GCacheDupFunc      key_dup_func,
 674                                 GCacheDestroyFunc  key_destroy_func,
 675                                 GHashFunc          hash_key_func,
 676                                 GHashFunc          hash_value_func,
 677                                 GCompareFunc       key_compare_func);
 678 void     g_cache_destroy       (GCache            *cache);
 679 gpointer g_cache_insert        (GCache            *cache,
 680                                 gpointer           key);
 681 void     g_cache_remove        (GCache            *cache,
 682                                 gpointer           value);
 683 void     g_cache_key_foreach   (GCache            *cache,
 684                                 GHFunc             func,
 685                                 gpointer           user_data);
 686 void     g_cache_value_foreach (GCache            *cache,
 687                                 GHFunc             func,
 688                                 gpointer           user_data);
 689
 690
 691 /* Trees
 692  */
 693 GTree*   g_tree_new      (GCompareFunc   key_compare_func);
 694 void     g_tree_destroy  (GTree         *tree);
 695 void     g_tree_insert   (GTree         *tree,
 696                           gpointer       key,
 697                           gpointer       value);
 698 void     g_tree_remove   (GTree         *tree,
 699                           gpointer       key);
 700 gpointer g_tree_lookup   (GTree         *tree,
 701                           gpointer       key);
 702 void     g_tree_traverse (GTree         *tree,
 703                           GTraverseFunc  traverse_func,
 704                           GTraverseType  traverse_type,
 705                           gpointer       data);
 706 gpointer g_tree_search   (GTree         *tree,
 707                           GSearchFunc    search_func,
 708                           gpointer       data);
 709 gint     g_tree_height   (GTree         *tree);
 710 gint     g_tree_nnodes   (GTree         *tree);
 711
 712
 713 /* Memory
 714  */
 715
 716 #ifdef USE_DMALLOC
 717
 718 #define g_malloc(size)       (gpointer) MALLOC(size)
 719 #define g_malloc0(size)      (gpointer) CALLOC(char,size)
 720 #define g_realloc(mem,size)  (gpointer) REALLOC(mem,char,size)
 721 #define g_free(mem)          FREE(mem)
 722
 723 #else /* USE_DMALLOC */
 724
 725 gpointer g_malloc      (gulong    size);
 726 gpointer g_malloc0     (gulong    size);
 727 gpointer g_realloc     (gpointer  mem,
 728                         gulong    size);
 729 void     g_free        (gpointer  mem);
 730
 731 #endif /* USE_DMALLOC */
 732
 733 void     g_mem_profile (void);
 734 void     g_mem_check   (gpointer  mem);
 735
 736
 737 /* "g_mem_chunk_new" creates a new memory chunk.
 738  * Memory chunks are used to allocate pieces of memory which are
 739  *  always the same size. Lists are a good example of such a data type.
 740  * The memory chunk allocates and frees blocks of memory as needed.
 741  *  Just be sure to call "g_mem_chunk_free" and not "g_free" on data
 742  *  allocated in a mem chunk. ("g_free" will most likely cause a seg
 743  *  fault...somewhere).
 744  *
 745  * Oh yeah, GMemChunk is an opaque data type. (You don't really
 746  *  want to know what's going on inside do you?)
 747  */
 748
 749 /* ALLOC_ONLY MemChunk's can only allocate memory. The free operation
 750  *  is interpreted as a no op. ALLOC_ONLY MemChunk's save 4 bytes per
 751  *  atom. (They are also useful for lists which use MemChunk to allocate
 752  *  memory but are also part of the MemChunk implementation).
 753  * ALLOC_AND_FREE MemChunk's can allocate and free memory.
 754  */
 755
 756 #define G_ALLOC_ONLY      1
 757 #define G_ALLOC_AND_FREE  2
 758
 759 GMemChunk* g_mem_chunk_new     (gchar     *name,
 760                                 gint       atom_size,
 761                                 gulong     area_size,
 762                                 gint       type);
 763 void       g_mem_chunk_destroy (GMemChunk *mem_chunk);
 764 gpointer   g_mem_chunk_alloc   (GMemChunk *mem_chunk);
 765 void       g_mem_chunk_free    (GMemChunk *mem_chunk,
 766                                 gpointer   mem);
 767 void       g_mem_chunk_clean   (GMemChunk *mem_chunk);
 768 void       g_mem_chunk_reset   (GMemChunk *mem_chunk);
 769 void       g_mem_chunk_print   (GMemChunk *mem_chunk);
 770 void       g_mem_chunk_info    (void);
 771
 772 /* Ah yes...we have a "g_blow_chunks" function.
 773  * "g_blow_chunks" simply compresses all the chunks. This operation
 774  *  consists of freeing every memory area that should be freed (but
 775  *  which we haven't gotten around to doing yet). And, no,
 776  *  "g_blow_chunks" doesn't follow the naming scheme, but it is a
 777  *  much better name than "g_mem_chunk_clean_all" or something
 778  *  similar.
 779  */
 780 void g_blow_chunks (void);
 781
 782
 783 /* Timer
 784  */
 785 GTimer* g_timer_new     (void);
 786 void    g_timer_destroy (GTimer  *timer);
 787 void    g_timer_start   (GTimer  *timer);
 788 void    g_timer_stop    (GTimer  *timer);
 789 void    g_timer_reset   (GTimer  *timer);
 790 gdouble g_timer_elapsed (GTimer  *timer,
 791                          gulong  *microseconds);
 792
 793
 794 /* Output
 795  */
 796 void g_error   (const gchar *format, ...) G_GNUC_PRINTF (1, 2);
 797 void g_warning (const gchar *format, ...) G_GNUC_PRINTF (1, 2);
 798 void g_message (const gchar *format, ...) G_GNUC_PRINTF (1, 2);
 799 void g_print   (const gchar *format, ...) G_GNUC_PRINTF (1, 2);
 800
 801 /* Utility functions
 802  */
 803 #define G_STR_DELIMITERS     "_-|> <."
 804 void    g_strdelimit            (gchar       *string,
 805                                  const gchar *delimiters,
 806                                  gchar        new_delimiter);
 807 gchar*  g_strdup                (const gchar *str);
 808 gchar*  g_strconcat             (const gchar *string1,
 809                                  ...); /* NULL terminated */
 810 gdouble g_strtod                (const gchar *nptr,
 811                                  gchar      **endptr);
 812 gchar*  g_strerror              (gint         errnum);
 813 gchar*  g_strsignal             (gint         signum);
 814 gint    g_strcasecmp            (const gchar *s1,
 815                                  const gchar *s2);
 816 void    g_strdown               (gchar       *string);
 817 void    g_strup                 (gchar       *string);
 818 void    g_strreverse            (gchar       *string);
 819 guint   g_parse_debug_string    (const gchar *string,
 820                                  GDebugKey   *keys,
 821                                  guint        nkeys);
 822 gint    g_snprintf              (gchar       *string,
 823                                  gulong       n,
 824                                  gchar const *format,
 825                                  ...) G_GNUC_PRINTF (3, 4);
 826
 827 /* We make the assumption that if memmove isn't available, then
 828  * bcopy will do the job. This isn't safe everywhere. (bcopy can't
 829  * necessarily handle overlapping copies) */
 830 #ifdef HAVE_MEMMOVE
 831 #define g_memmove memmove
 832 #else
 833 #define g_memmove(a,b,c) bcopy(b,a,c)
 834 #endif
 835
 836 /* Errors
 837  */
 838 GErrorFunc   g_set_error_handler   (GErrorFunc   func);
 839 GWarningFunc g_set_warning_handler (GWarningFunc func);
 840 GPrintFunc   g_set_message_handler (GPrintFunc func);
 841 GPrintFunc   g_set_print_handler   (GPrintFunc func);
 842
 843 void g_debug          (const gchar *progname);
 844 void g_attach_process (const gchar *progname,
 845                        gint         query);
 846 void g_stack_trace    (const gchar *progname,
 847                        gint         query);
 848
 849
 850 /* String Chunks
 851  */
 852 GStringChunk* g_string_chunk_new           (gint size);
 853 void          g_string_chunk_free          (GStringChunk *chunk);
 854 gchar*        g_string_chunk_insert        (GStringChunk *chunk,
 855                                             const gchar  *string);
 856 gchar*        g_string_chunk_insert_const  (GStringChunk *chunk,
 857                                             const gchar  *string);
 858
 859 /* Strings
 860  */
 861 GString* g_string_new       (const gchar *init);
 862 GString* g_string_sized_new (guint        dfl_size);
 863 void     g_string_free      (GString     *string,
 864                              gint         free_segment);
 865 GString* g_string_assign    (GString     *lval,
 866                              const gchar *rval);
 867 GString* g_string_truncate  (GString     *string,
 868                              gint         len);
 869 GString* g_string_append    (GString     *string,
 870                              const gchar *val);
 871 GString* g_string_append_c  (GString     *string,
 872                              gchar        c);
 873 GString* g_string_prepend   (GString     *string,
 874                              const gchar *val);
 875 GString* g_string_prepend_c (GString     *string,
 876                              gchar        c);
 877 GString* g_string_insert    (GString     *string,
 878                              gint         pos,
 879                              const gchar *val);
 880 GString* g_string_insert_c  (GString     *string,
 881                              gint         pos,
 882                              gchar        c);
 883 GString* g_string_erase     (GString     *string,
 884                              gint         pos,
 885                              gint         len);
 886 GString* g_string_down      (GString     *string);
 887 GString* g_string_up        (GString     *string);
 888 void     g_string_sprintf   (GString     *string,
 889                              const gchar *format,
 890                              ...) G_GNUC_PRINTF (2, 3);
 891 void     g_string_sprintfa  (GString     *string,
 892                              const gchar *format,
 893                              ...) G_GNUC_PRINTF (2, 3);
 894
 895 /* Resizable arrays
 896  */
 897 #define g_array_length(array,type) \
 898      (((array)->len)/sizeof(type))
 899 #define g_array_append_val(array,type,val) \
 900      g_rarray_append (array, (gpointer) &val, sizeof (type))
 901 #define g_array_append_vals(array,type,vals,nvals) \
 902      g_rarray_append (array, (gpointer) vals, sizeof (type) * nvals)
 903 #define g_array_prepend_val(array,type,val) \
 904      g_rarray_prepend (array, (gpointer) &val, sizeof (type))
 905 #define g_array_prepend_vals(array,type,vals,nvals) \
 906      g_rarray_prepend (array, (gpointer) vals, sizeof (type) * nvals)
 907 #define g_array_truncate(array,type,length) \
 908      g_rarray_truncate (array, length, sizeof (type))
 909 #define g_array_index(array,type,index) \
 910      ((type*) array->data)[index]
 911
 912 GArray* g_array_new       (gint      zero_terminated);
 913 void    g_array_free      (GArray   *array,
 914                            gint      free_segment);
 915 GArray* g_rarray_append   (GArray   *array,
 916                            gpointer  data,
 917                            gint      size);
 918 GArray* g_rarray_prepend  (GArray   *array,
 919                            gpointer  data,
 920                            gint      size);
 921 GArray* g_rarray_truncate (GArray   *array,
 922                            gint      length,
 923                            gint      size);
 924
 925 /* Resizable pointer array.  This interface is much less complicated
 926  * than the above.  Add appends appends a pointer.  Remove fills any
 927  * cleared spot and shortens the array.
 928  */
 929
 930 #define     g_ptr_array_index(array,index) (array->pdata)[index]
 931
 932 GPtrArray*  g_ptr_array_new                (void);
 933 void        g_ptr_array_free               (GPtrArray   *array,
 934                                             gboolean     free_seg);
 935 void        g_ptr_array_set_size           (GPtrArray   *array,
 936                                             gint         length);
 937 void        g_ptr_array_remove_index       (GPtrArray   *array,
 938                                             gint         index);
 939 gboolean    g_ptr_array_remove             (GPtrArray   *array,
 940                                             gpointer     data);
 941 void        g_ptr_array_add                (GPtrArray   *array,
 942                                             gpointer     data);
 943
 944 /* Byte arrays, an array of guint8.  Implemented as a GArray,
 945  * but type-safe.
 946  */
 947
 948 GByteArray* g_byte_array_new      (void);
 949 void        g_byte_array_free     (GByteArray *array,
 950                                    gint        free_segment);
 951
 952 GByteArray* g_byte_array_append   (GByteArray   *array,
 953                                    const guint8 *data,
 954                                    guint         len);
 955
 956 GByteArray* g_byte_array_prepend  (GByteArray   *array,
 957                                    const guint8 *data,
 958                                    guint         len);
 959
 960 GByteArray* g_byte_array_truncate (GByteArray *array,
 961                                    gint        length);
 962
 963
 964 /* Hash Functions
 965  */
 966 gint  g_str_equal (gconstpointer   v,
 967                    gconstpointer   v2);
 968 guint g_str_hash  (gconstpointer v);
 969
 970 gint  g_int_equal (gconstpointer v,
 971                    gconstpointer v2);
 972 guint g_int_hash  (gconstpointer v);
 973
 974 /* This "hash" function will just return the key's adress as an
 975  * unsigned integer. Useful for hashing on plain adresses or
 976  * simple integer values.
 977  */
 978 guint g_direct_hash  (gconstpointer v);
 979 gint  g_direct_equal (gconstpointer v,
 980                       gconstpointer v2);
 981
 982
 983 /* Quarks (string<->id association)
 984  */
 985 GQuark    g_quark_try_string            (const gchar    *string);
 986 GQuark    g_quark_from_static_string    (const gchar    *string);
 987 GQuark    g_quark_from_string           (const gchar    *string);
 988 gchar*    g_quark_to_string             (GQuark          quark);
 989
 990 /* Location Associated Data
 991  */
 992 void      g_dataset_destroy             (gconstpointer   dataset_location);
 993 gpointer  g_dataset_id_get_data         (gconstpointer   dataset_location,
 994                                          GQuark          key_id);
 995 void      g_dataset_id_set_data_full    (gconstpointer   dataset_location,
 996                                          GQuark          key_id,
 997                                          gpointer        data,
 998                                          GDestroyNotify  destroy_func);
 999 void      g_dataset_id_set_destroy      (gconstpointer   dataset_location,
1000                                          GQuark          key_id,
1001                                          GDestroyNotify  destroy_func);
1002
1003 #define   g_dataset_id_set_data(l,k,d)  G_STMT_START{g_dataset_id_set_data_full((l),(k),(d),NULL);}G_STMT_END
1004 #define   g_dataset_id_remove_data(l,k) G_STMT_START{g_dataset_id_set_data((l),(k),NULL);}G_STMT_END
1005 #define   g_dataset_get_data(l,k)       (g_dataset_id_get_data((l),g_quark_try_string(k)))
1006 #define   g_dataset_set_data_full(l,k,d,f) G_STMT_START{g_dataset_id_set_data_full((l),g_quark_from_string(k),(d),(f));}G_STMT_END
1007 #define   g_dataset_set_destroy(l,k,f)  G_STMT_START{g_dataset_id_set_destroy((l),g_quark_from_string(k),(f));}G_STMT_END
1008 #define   g_dataset_set_data(l,k,d)     G_STMT_START{g_dataset_set_data_full((l),(k),(d),NULL);}G_STMT_END
1009 #define   g_dataset_remove_data(l,k)    G_STMT_START{g_dataset_set_data((l),(k),NULL);}G_STMT_END
1010
1011
1012 /* GScanner: Flexible lexical scanner for general purpose.
1013  */
1014
1015 /* Character sets */
1016 #define G_CSET_A_2_Z    "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1017 #define G_CSET_a_2_z    "abcdefghijklmnopqrstuvwxyz"
1018 #define G_CSET_LATINC   "\300\301\302\303\304\305\306"\
1019                         "\307\310\311\312\313\314\315\316\317\320"\
1020                         "\321\322\323\324\325\326"\
1021                         "\330\331\332\333\334\335\336"
1022 #define G_CSET_LATINS   "\337\340\341\342\343\344\345\346"\
1023                         "\347\350\351\352\353\354\355\356\357\360"\
1024                         "\361\362\363\364\365\366"\
1025                         "\370\371\372\373\374\375\376\377"
1026
1027 /* Error types */
1028 typedef enum
1029 {
1030   G_ERR_UNKNOWN,
1031   G_ERR_UNEXP_EOF,
1032   G_ERR_UNEXP_EOF_IN_STRING,
1033   G_ERR_UNEXP_EOF_IN_COMMENT,
1034   G_ERR_NON_DIGIT_IN_CONST,
1035   G_ERR_DIGIT_RADIX,
1036   G_ERR_FLOAT_RADIX,
1037   G_ERR_FLOAT_MALFORMED
1038 } GErrorType;
1039
1040 /* Token types */
1041 typedef enum
1042 {
1043   G_TOKEN_EOF                   =   0,
1044
1045   G_TOKEN_LEFT_PAREN            = '(',
1046   G_TOKEN_RIGHT_PAREN           = ')',
1047   G_TOKEN_LEFT_CURLY            = '{',
1048   G_TOKEN_RIGHT_CURLY           = '}',
1049   G_TOKEN_LEFT_BRACE            = '[',
1050   G_TOKEN_RIGHT_BRACE           = ']',
1051   G_TOKEN_EQUAL_SIGN            = '=',
1052   G_TOKEN_COMMA                 = ',',
1053
1054   G_TOKEN_NONE                  = 256,
1055
1056   G_TOKEN_ERROR,
1057
1058   G_TOKEN_CHAR,
1059   G_TOKEN_BINARY,
1060   G_TOKEN_OCTAL,
1061   G_TOKEN_INT,
1062   G_TOKEN_HEX,
1063   G_TOKEN_FLOAT,
1064   G_TOKEN_STRING,
1065
1066   G_TOKEN_SYMBOL,
1067   G_TOKEN_IDENTIFIER,
1068   G_TOKEN_IDENTIFIER_NULL,
1069
1070   G_TOKEN_COMMENT_SINGLE,
1071   G_TOKEN_COMMENT_MULTI,
1072   G_TOKEN_LAST
1073 } GTokenType;
1074
1075 union   _GValue
1076 {
1077   gpointer      v_symbol;
1078   gchar         *v_identifier;
1079   gulong        v_binary;
1080   gulong        v_octal;
1081   gulong        v_int;
1082   gdouble       v_float;
1083   gulong        v_hex;
1084   gchar         *v_string;
1085   gchar         *v_comment;
1086   guchar        v_char;
1087   guint         v_error;
1088 };
1089
1090 struct  _GScannerConfig
1091 {
1092   /* Character sets
1093    */
1094   gchar         *cset_skip_characters;          /* default: " \t\n" */
1095   gchar         *cset_identifier_first;
1096   gchar         *cset_identifier_nth;
1097   gchar         *cpair_comment_single;          /* default: "#\n" */
1098
1099   /* Should symbol lookup work case sensitive?
1100    */
1101   guint         case_sensitive : 1;
1102
1103   /* Boolean values to be adjusted "on the fly"
1104    * to configure scanning behaviour.
1105    */
1106   guint         skip_comment_multi : 1;         /* C like comment */
1107   guint         skip_comment_single : 1;        /* single line comment */
1108   guint         scan_comment_multi : 1;         /* scan multi line comments? */
1109   guint         scan_identifier : 1;
1110   guint         scan_identifier_1char : 1;
1111   guint         scan_identifier_NULL : 1;
1112   guint         scan_symbols : 1;
1113   guint         scan_binary : 1;
1114   guint         scan_octal : 1;
1115   guint         scan_float : 1;
1116   guint         scan_hex : 1;                   /* `0x0ff0' */
1117   guint         scan_hex_dollar : 1;            /* `$0ff0' */
1118   guint         scan_string_sq : 1;             /* string: 'anything' */
1119   guint         scan_string_dq : 1;             /* string: "\\-escapes!\n" */
1120   guint         numbers_2_int : 1;              /* bin, octal, hex => int */
1121   guint         int_2_float : 1;                /* int => G_TOKEN_FLOAT? */
1122   guint         identifier_2_string : 1;
1123   guint         char_2_token : 1;               /* return G_TOKEN_CHAR? */
1124   guint         symbol_2_token : 1;
1125 };
1126
1127 struct  _GScanner
1128 {
1129   /* unused fields */
1130   gpointer              user_data;
1131   guint                 max_parse_errors;
1132
1133   /* g_scanner_error() increments this field */
1134   guint                 parse_errors;
1135
1136   /* name of input stream, featured by the default message handler */
1137   const gchar           *input_name;
1138
1139   /* data pointer for derived structures */
1140   gpointer              derived_data;
1141
1142   /* link into the scanner configuration */
1143   GScannerConfig        *config;
1144
1145   /* fields filled in after g_scanner_get_next_token() */
1146   GTokenType            token;
1147   GValue                value;
1148   guint                 line;
1149   guint                 position;
1150
1151   /* fields filled in after g_scanner_peek_next_token() */
1152   GTokenType            next_token;
1153   GValue                next_value;
1154   guint                 next_line;
1155   guint                 next_position;
1156
1157   /* to be considered private */
1158   GHashTable            *symbol_table;
1159   const gchar           *text;
1160   guint                 text_len;
1161   gint                  input_fd;
1162   gint                  peeked_char;
1163
1164   /* handler function for _warn and _error */
1165   GScannerMsgFunc       msg_handler;
1166 };
1167
1168 GScanner*       g_scanner_new                   (GScannerConfig *config_templ);
1169 void            g_scanner_destroy               (GScanner       *scanner);
1170 void            g_scanner_input_file            (GScanner       *scanner,
1171                                                  gint           input_fd);
1172 void            g_scanner_input_text            (GScanner       *scanner,
1173                                                  const  gchar   *text,
1174                                                  guint          text_len);
1175 GTokenType      g_scanner_get_next_token        (GScanner       *scanner);
1176 GTokenType      g_scanner_peek_next_token       (GScanner       *scanner);
1177 GTokenType      g_scanner_cur_token             (GScanner       *scanner);
1178 GValue          g_scanner_cur_value             (GScanner       *scanner);
1179 guint           g_scanner_cur_line              (GScanner       *scanner);
1180 guint           g_scanner_cur_position          (GScanner       *scanner);
1181 gboolean        g_scanner_eof                   (GScanner       *scanner);
1182 void            g_scanner_add_symbol            (GScanner       *scanner,
1183                                                  const gchar    *symbol,
1184                                                  gpointer       value);
1185 gpointer        g_scanner_lookup_symbol         (GScanner       *scanner,
1186                                                  const gchar    *symbol);
1187 void            g_scanner_foreach_symbol        (GScanner       *scanner,
1188                                                  GHFunc          func,
1189                                                  gpointer        func_data);
1190 void            g_scanner_remove_symbol         (GScanner       *scanner,
1191                                                  const gchar    *symbol);
1192 void            g_scanner_freeze_symbol_table   (GScanner       *scanner);
1193 void            g_scanner_thaw_symbol_table     (GScanner       *scanner);
1194 void            g_scanner_unexp_token           (GScanner       *scanner,
1195                                                  GTokenType     expected_token,
1196                                                  const gchar    *identifier_spec,
1197                                                  const gchar    *symbol_spec,
1198                                                  const gchar    *symbol_name,
1199                                                  const gchar    *message,
1200                                                  gint            is_error);
1201 void            g_scanner_error                 (GScanner       *scanner,
1202                                                  const gchar    *format,
1203                                                  ...) G_GNUC_PRINTF (2,3);
1204 void            g_scanner_warn                  (GScanner       *scanner,
1205                                                  const gchar    *format,
1206                                                  ...) G_GNUC_PRINTF (2,3);
1207 gint            g_scanner_stat_mode             (const gchar    *filename);
1208
1209
1210 /* Completion */
1211
1212 typedef gchar* (*GCompletionFunc)(gpointer);
1213
1214 typedef struct _GCompletion GCompletion;
1215
1216 struct _GCompletion {
1217         GList* items;
1218         GCompletionFunc func;
1219
1220         gchar* prefix;
1221         GList* cache;
1222
1223 };
1224
1225 GCompletion* g_completion_new          (GCompletionFunc func);
1226 void         g_completion_add_items    (GCompletion* cmp,
1227                                         GList* items);
1228 void         g_completion_remove_items (GCompletion* cmp,
1229                                         GList* items);
1230 void         g_completion_clear_items  (GCompletion* cmp);
1231 GList*       g_completion_complete     (GCompletion* cmp,
1232                                         gchar* prefix,
1233                                         gchar** new_prefix);
1234 void         g_completion_free         (GCompletion* cmp);
1235
1236 /* GRelation: Indexed Relations.  Imagine a really simple table in a
1237  * database.  Relations are not ordered.  This data type is meant for
1238  * maintaining a N-way mapping.
1239  *
1240  * g_relation_new() creates a relation with FIELDS fields
1241  *
1242  * g_relation_destroy() frees all resources
1243  * g_tuples_destroy() frees the result of g_relation_select()
1244  *
1245  * g_relation_index() indexes relation FIELD with the provided
1246  *   equality and hash functions.  this must be done before any
1247  *   calls to insert are made.
1248  *
1249  * g_relation_insert() inserts a new tuple.  you are expected to
1250  *   provide the right number of fields.
1251  *
1252  * g_relation_delete() deletes all relations with KEY in FIELD
1253  * g_relation_select() returns ...
1254  * g_relation_count() counts ...
1255  */
1256
1257 GRelation* g_relation_new     (gint         fields);
1258 void       g_relation_destroy (GRelation   *relation);
1259 void       g_relation_index   (GRelation   *relation,
1260                                gint         field,
1261                                GHashFunc    hash_func,
1262                                GCompareFunc key_compare_func);
1263 void       g_relation_insert  (GRelation   *relation,
1264                                ...);
1265 gint       g_relation_delete  (GRelation   *relation,
1266                                gconstpointer  key,
1267                                gint         field);
1268 GTuples*   g_relation_select  (GRelation   *relation,
1269                                gconstpointer  key,
1270                                gint         field);
1271 gint       g_relation_count   (GRelation   *relation,
1272                                gconstpointer  key,
1273                                gint         field);
1274 gboolean   g_relation_exists  (GRelation   *relation,
1275                                ...);
1276 void       g_relation_print   (GRelation   *relation);
1277
1278 void       g_tuples_destroy   (GTuples     *tuples);
1279 gpointer   g_tuples_index     (GTuples     *tuples,
1280                                gint         index,
1281                                gint         field);
1282
1283
1284 /* Glib version.
1285  */
1286 extern const guint glib_major_version;
1287 extern const guint glib_minor_version;
1288 extern const guint glib_micro_version;
1289
1290 #ifdef __cplusplus
1291 }
1292 #endif /* __cplusplus */
1293
1294
1295 #endif /* __G_LIB_H__ */