epoc32/include/stdapis/glib-2.0/glib/grel.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 0 061f57f2323e
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
williamr@2
     1
/* GLIB - Library of useful routines for C programming
williamr@2
     2
 * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
williamr@2
     3
 * Portions copyright (c) 2006 Nokia Corporation.  All rights reserved.
williamr@2
     4
 *
williamr@2
     5
 * This library is free software; you can redistribute it and/or
williamr@2
     6
 * modify it under the terms of the GNU Lesser General Public
williamr@2
     7
 * License as published by the Free Software Foundation; either
williamr@2
     8
 * version 2 of the License, or (at your option) any later version.
williamr@2
     9
 *
williamr@2
    10
 * This library is distributed in the hope that it will be useful,
williamr@2
    11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
williamr@2
    12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
williamr@2
    13
 * Lesser General Public License for more details.
williamr@2
    14
 *
williamr@2
    15
 * You should have received a copy of the GNU Lesser General Public
williamr@2
    16
 * License along with this library; if not, write to the
williamr@2
    17
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
williamr@2
    18
 * Boston, MA 02111-1307, USA.
williamr@2
    19
 */
williamr@2
    20
williamr@2
    21
/*
williamr@2
    22
 * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
williamr@2
    23
 * file for a list of people on the GLib Team.  See the ChangeLog
williamr@2
    24
 * files for a list of changes.  These files are distributed with
williamr@2
    25
 * GLib at ftp://ftp.gtk.org/pub/gtk/. 
williamr@2
    26
 */
williamr@2
    27
williamr@2
    28
#ifndef __G_REL_H__
williamr@2
    29
#define __G_REL_H__
williamr@2
    30
williamr@2
    31
#include <_ansi.h>
williamr@2
    32
#include <glib/gtypes.h>
williamr@2
    33
williamr@2
    34
G_BEGIN_DECLS
williamr@2
    35
williamr@2
    36
typedef struct _GRelation       GRelation;
williamr@2
    37
typedef struct _GTuples         GTuples;
williamr@2
    38
williamr@2
    39
struct _GTuples
williamr@2
    40
{
williamr@2
    41
  guint len;
williamr@2
    42
};
williamr@2
    43
williamr@2
    44
/* GRelation
williamr@2
    45
 *
williamr@2
    46
 * Indexed Relations.  Imagine a really simple table in a
williamr@2
    47
 * database.  Relations are not ordered.  This data type is meant for
williamr@2
    48
 * maintaining a N-way mapping.
williamr@2
    49
 *
williamr@2
    50
 * g_relation_new() creates a relation with FIELDS fields
williamr@2
    51
 *
williamr@2
    52
 * g_relation_destroy() frees all resources
williamr@2
    53
 * g_tuples_destroy() frees the result of g_relation_select()
williamr@2
    54
 *
williamr@2
    55
 * g_relation_index() indexes relation FIELD with the provided
williamr@2
    56
 *   equality and hash functions.  this must be done before any
williamr@2
    57
 *   calls to insert are made.
williamr@2
    58
 *
williamr@2
    59
 * g_relation_insert() inserts a new tuple.  you are expected to
williamr@2
    60
 *   provide the right number of fields.
williamr@2
    61
 *
williamr@2
    62
 * g_relation_delete() deletes all relations with KEY in FIELD
williamr@2
    63
 * g_relation_select() returns ...
williamr@2
    64
 * g_relation_count() counts ...
williamr@2
    65
 */
williamr@2
    66
williamr@2
    67
IMPORT_C GRelation* g_relation_new     (gint         fields);
williamr@2
    68
IMPORT_C void       g_relation_destroy (GRelation   *relation);
williamr@2
    69
IMPORT_C void       g_relation_index   (GRelation   *relation,
williamr@2
    70
                               gint         field,
williamr@2
    71
                               GHashFunc    hash_func,
williamr@2
    72
                               GEqualFunc   key_equal_func);
williamr@2
    73
IMPORT_C void       g_relation_insert  (GRelation   *relation,
williamr@2
    74
                               ...);
williamr@2
    75
IMPORT_C gint       g_relation_delete  (GRelation   *relation,
williamr@2
    76
                               gconstpointer  key,
williamr@2
    77
                               gint         field);
williamr@2
    78
IMPORT_C GTuples*   g_relation_select  (GRelation   *relation,
williamr@2
    79
                               gconstpointer  key,
williamr@2
    80
                               gint         field);
williamr@2
    81
IMPORT_C gint       g_relation_count   (GRelation   *relation,
williamr@2
    82
                               gconstpointer  key,
williamr@2
    83
                               gint         field);
williamr@2
    84
IMPORT_C gboolean   g_relation_exists  (GRelation   *relation,
williamr@2
    85
                               ...);
williamr@2
    86
IMPORT_C void       g_relation_print   (GRelation   *relation);
williamr@2
    87
williamr@2
    88
IMPORT_C void       g_tuples_destroy   (GTuples     *tuples);
williamr@2
    89
IMPORT_C gpointer   g_tuples_index     (GTuples     *tuples,
williamr@2
    90
                               gint         index_,
williamr@2
    91
                               gint         field);
williamr@2
    92
williamr@2
    93
G_END_DECLS
williamr@2
    94
williamr@2
    95
#endif /* __G_REL_H__ */
williamr@2
    96