glib/grel.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 Lesser 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  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GLib Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  28 #error "Only <glib.h> can be included directly."
  29 #endif
  30
  31 #ifndef __G_REL_H__
  32 #define __G_REL_H__
  33
  34 #include <glib/gtypes.h>
  35
  36 G_BEGIN_DECLS
  37
  38 typedef struct _GRelation       GRelation;
  39 typedef struct _GTuples         GTuples;
  40
  41 struct _GTuples
  42 {
  43   guint len;
  44 };
  45
  46 /* GRelation
  47  *
  48  * Indexed Relations.  Imagine a really simple table in a
  49  * database.  Relations are not ordered.  This data type is meant for
  50  * maintaining a N-way mapping.
  51  *
  52  * g_relation_new() creates a relation with FIELDS fields
  53  *
  54  * g_relation_destroy() frees all resources
  55  * g_tuples_destroy() frees the result of g_relation_select()
  56  *
  57  * g_relation_index() indexes relation FIELD with the provided
  58  *   equality and hash functions.  this must be done before any
  59  *   calls to insert are made.
  60  *
  61  * g_relation_insert() inserts a new tuple.  you are expected to
  62  *   provide the right number of fields.
  63  *
  64  * g_relation_delete() deletes all relations with KEY in FIELD
  65  * g_relation_select() returns ...
  66  * g_relation_count() counts ...
  67  */
  68
  69 GRelation* g_relation_new     (gint         fields);
  70 void       g_relation_destroy (GRelation   *relation);
  71 void       g_relation_index   (GRelation   *relation,
  72                                gint         field,
  73                                GHashFunc    hash_func,
  74                                GEqualFunc   key_equal_func);
  75 void       g_relation_insert  (GRelation   *relation,
  76                                ...);
  77 gint       g_relation_delete  (GRelation   *relation,
  78                                gconstpointer  key,
  79                                gint         field);
  80 GTuples*   g_relation_select  (GRelation   *relation,
  81                                gconstpointer  key,
  82                                gint         field);
  83 gint       g_relation_count   (GRelation   *relation,
  84                                gconstpointer  key,
  85                                gint         field);
  86 gboolean   g_relation_exists  (GRelation   *relation,
  87                                ...);
  88 void       g_relation_print   (GRelation   *relation);
  89
  90 void       g_tuples_destroy   (GTuples     *tuples);
  91 gpointer   g_tuples_index     (GTuples     *tuples,
  92                                gint         index_,
  93                                gint         field);
  94
  95 G_END_DECLS
  96
  97 #endif /* __G_REL_H__ */