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