williamr@2: /* GLIB - Library of useful routines for C programming
williamr@2:  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
williamr@2:  * Portions copyright (c) 2006 Nokia Corporation.  All rights reserved.
williamr@2:  *
williamr@2:  * This library is free software; you can redistribute it and/or
williamr@2:  * modify it under the terms of the GNU Lesser General Public
williamr@2:  * License as published by the Free Software Foundation; either
williamr@2:  * version 2 of the License, or (at your option) any later version.
williamr@2:  *
williamr@2:  * This library is distributed in the hope that it will be useful,
williamr@2:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
williamr@2:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
williamr@2:  * Lesser General Public License for more details.
williamr@2:  *
williamr@2:  * You should have received a copy of the GNU Lesser General Public
williamr@2:  * License along with this library; if not, write to the
williamr@2:  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
williamr@2:  * Boston, MA 02111-1307, USA.
williamr@2:  */
williamr@2: 
williamr@2: /*
williamr@2:  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
williamr@2:  * file for a list of people on the GLib Team.  See the ChangeLog
williamr@2:  * files for a list of changes.  These files are distributed with
williamr@2:  * GLib at ftp://ftp.gtk.org/pub/gtk/. 
williamr@2:  */
williamr@2: 
williamr@2: #ifndef __G_REL_H__
williamr@2: #define __G_REL_H__
williamr@2: 
williamr@2: #include <_ansi.h>
williamr@2: #include <glib/gtypes.h>
williamr@2: 
williamr@2: G_BEGIN_DECLS
williamr@2: 
williamr@2: typedef struct _GRelation       GRelation;
williamr@2: typedef struct _GTuples         GTuples;
williamr@2: 
williamr@2: struct _GTuples
williamr@2: {
williamr@2:   guint len;
williamr@2: };
williamr@2: 
williamr@2: /* GRelation
williamr@2:  *
williamr@2:  * Indexed Relations.  Imagine a really simple table in a
williamr@2:  * database.  Relations are not ordered.  This data type is meant for
williamr@2:  * maintaining a N-way mapping.
williamr@2:  *
williamr@2:  * g_relation_new() creates a relation with FIELDS fields
williamr@2:  *
williamr@2:  * g_relation_destroy() frees all resources
williamr@2:  * g_tuples_destroy() frees the result of g_relation_select()
williamr@2:  *
williamr@2:  * g_relation_index() indexes relation FIELD with the provided
williamr@2:  *   equality and hash functions.  this must be done before any
williamr@2:  *   calls to insert are made.
williamr@2:  *
williamr@2:  * g_relation_insert() inserts a new tuple.  you are expected to
williamr@2:  *   provide the right number of fields.
williamr@2:  *
williamr@2:  * g_relation_delete() deletes all relations with KEY in FIELD
williamr@2:  * g_relation_select() returns ...
williamr@2:  * g_relation_count() counts ...
williamr@2:  */
williamr@2: 
williamr@2: IMPORT_C GRelation* g_relation_new     (gint         fields);
williamr@2: IMPORT_C void       g_relation_destroy (GRelation   *relation);
williamr@2: IMPORT_C void       g_relation_index   (GRelation   *relation,
williamr@2:                                gint         field,
williamr@2:                                GHashFunc    hash_func,
williamr@2:                                GEqualFunc   key_equal_func);
williamr@2: IMPORT_C void       g_relation_insert  (GRelation   *relation,
williamr@2:                                ...);
williamr@2: IMPORT_C gint       g_relation_delete  (GRelation   *relation,
williamr@2:                                gconstpointer  key,
williamr@2:                                gint         field);
williamr@2: IMPORT_C GTuples*   g_relation_select  (GRelation   *relation,
williamr@2:                                gconstpointer  key,
williamr@2:                                gint         field);
williamr@2: IMPORT_C gint       g_relation_count   (GRelation   *relation,
williamr@2:                                gconstpointer  key,
williamr@2:                                gint         field);
williamr@2: IMPORT_C gboolean   g_relation_exists  (GRelation   *relation,
williamr@2:                                ...);
williamr@2: IMPORT_C void       g_relation_print   (GRelation   *relation);
williamr@2: 
williamr@2: IMPORT_C void       g_tuples_destroy   (GTuples     *tuples);
williamr@2: IMPORT_C gpointer   g_tuples_index     (GTuples     *tuples,
williamr@2:                                gint         index_,
williamr@2:                                gint         field);
williamr@2: 
williamr@2: G_END_DECLS
williamr@2: 
williamr@2: #endif /* __G_REL_H__ */
williamr@2: