glib/gtree.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_TREE_H__
  32 #define __G_TREE_H__
  33
  34 #include <glib/gnode.h>
  35
  36 G_BEGIN_DECLS
  37
  38 /* Tree Search Types */
  39 typedef enum
  40 {
  41   G_TREE_SEARCH_EXACT,
  42   G_TREE_SEARCH_SUCCESSOR,
  43   G_TREE_SEARCH_PREDECESSOR
  44 } GTreeSearchType;
  45
  46 typedef struct _GTree  GTree;
  47
  48 typedef gboolean (*GTraverseFunc) (gpointer  key,
  49                                    gpointer  value,
  50                                    gpointer  data);
  51
  52 /* Balanced binary trees
  53  */
  54 GTree*   g_tree_new             (GCompareFunc      key_compare_func);
  55 GTree*   g_tree_new_with_data   (GCompareDataFunc  key_compare_func,
  56                                  gpointer          key_compare_data);
  57 GTree*   g_tree_new_full        (GCompareDataFunc  key_compare_func,
  58                                  gpointer          key_compare_data,
  59                                  GDestroyNotify    key_destroy_func,
  60                                  GDestroyNotify    value_destroy_func);
  61 GTree*   g_tree_ref             (GTree            *tree);
  62 void     g_tree_unref           (GTree            *tree);
  63 void     g_tree_destroy         (GTree            *tree);
  64 guint    g_tree_current_version (GTree            *tree);
  65 guint    g_tree_next_version    (GTree            *tree);
  66 void     g_tree_delete_versions (GTree            *tree,
  67                                  guint             version);
  68 void     g_tree_insert          (GTree            *tree,
  69                                  gpointer          key,
  70                                  gpointer          value);
  71 void     g_tree_replace         (GTree            *tree,
  72                                  gpointer          key,
  73                                  gpointer          value);
  74 gboolean g_tree_remove          (GTree            *tree,
  75                                  gconstpointer     key);
  76 gboolean g_tree_steal           (GTree            *tree,
  77                                  gconstpointer     key);
  78 gpointer g_tree_lookup          (GTree            *tree,
  79                                  gconstpointer     key);
  80 gboolean g_tree_lookup_extended (GTree            *tree,
  81                                  gconstpointer     lookup_key,
  82                                  gpointer         *orig_key,
  83                                  gpointer         *value);
  84 gpointer g_tree_lookup_related  (GTree            *tree,
  85                                  gconstpointer     key,
  86                                  GTreeSearchType   search_type,
  87                                  guint             version);
  88 void     g_tree_foreach         (GTree            *tree,
  89                                  GTraverseFunc     func,
  90                                  gpointer          user_data);
  91
  92 #ifndef G_DISABLE_DEPRECATED
  93 void     g_tree_traverse        (GTree            *tree,
  94                                  GTraverseFunc     traverse_func,
  95                                  GTraverseType     traverse_type,
  96                                  gpointer          user_data);
  97 #endif /* G_DISABLE_DEPRECATED */
  98
  99 gpointer g_tree_search          (GTree            *tree,
 100                                  GCompareFunc      search_func,
 101                                  gconstpointer     user_data);
 102 gpointer g_tree_search_related  (GTree            *tree,
 103                                  GCompareFunc      search_func,
 104                                  gconstpointer     user_data,
 105                                  GTreeSearchType   search_type);
 106 gint     g_tree_height          (GTree            *tree);
 107 gint     g_tree_nnodes          (GTree            *tree);
 108
 109 G_END_DECLS
 110
 111 #endif /* __G_TREE_H__ */