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 #ifndef __G_TREE_H__
  28 #define __G_TREE_H__
  29
  30 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  31 #error "Only <glib.h> can be included directly."
  32 #endif
  33
  34 #include <glib/gnode.h>
  35
  36 G_BEGIN_DECLS
  37
  38 typedef struct _GTree  GTree;
  39
  40 typedef gboolean (*GTraverseFunc) (gpointer  key,
  41                                    gpointer  value,
  42                                    gpointer  data);
  43
  44 /* Balanced binary trees
  45  */
  46 GLIB_AVAILABLE_IN_ALL
  47 GTree*   g_tree_new             (GCompareFunc      key_compare_func);
  48 GLIB_AVAILABLE_IN_ALL
  49 GTree*   g_tree_new_with_data   (GCompareDataFunc  key_compare_func,
  50                                  gpointer          key_compare_data);
  51 GLIB_AVAILABLE_IN_ALL
  52 GTree*   g_tree_new_full        (GCompareDataFunc  key_compare_func,
  53                                  gpointer          key_compare_data,
  54                                  GDestroyNotify    key_destroy_func,
  55                                  GDestroyNotify    value_destroy_func);
  56 GLIB_AVAILABLE_IN_ALL
  57 GTree*   g_tree_ref             (GTree            *tree);
  58 GLIB_AVAILABLE_IN_ALL
  59 void     g_tree_unref           (GTree            *tree);
  60 GLIB_AVAILABLE_IN_ALL
  61 void     g_tree_destroy         (GTree            *tree);
  62 GLIB_AVAILABLE_IN_ALL
  63 void     g_tree_insert          (GTree            *tree,
  64                                  gpointer          key,
  65                                  gpointer          value);
  66 GLIB_AVAILABLE_IN_ALL
  67 void     g_tree_replace         (GTree            *tree,
  68                                  gpointer          key,
  69                                  gpointer          value);
  70 GLIB_AVAILABLE_IN_ALL
  71 gboolean g_tree_remove          (GTree            *tree,
  72                                  gconstpointer     key);
  73 GLIB_AVAILABLE_IN_ALL
  74 gboolean g_tree_steal           (GTree            *tree,
  75                                  gconstpointer     key);
  76 GLIB_AVAILABLE_IN_ALL
  77 gpointer g_tree_lookup          (GTree            *tree,
  78                                  gconstpointer     key);
  79 GLIB_AVAILABLE_IN_ALL
  80 gboolean g_tree_lookup_extended (GTree            *tree,
  81                                  gconstpointer     lookup_key,
  82                                  gpointer         *orig_key,
  83                                  gpointer         *value);
  84 GLIB_AVAILABLE_IN_ALL
  85 void     g_tree_foreach         (GTree            *tree,
  86                                  GTraverseFunc     func,
  87                                  gpointer          user_data);
  88
  89 GLIB_DEPRECATED
  90 void     g_tree_traverse        (GTree            *tree,
  91                                  GTraverseFunc     traverse_func,
  92                                  GTraverseType     traverse_type,
  93                                  gpointer          user_data);
  94
  95 GLIB_AVAILABLE_IN_ALL
  96 gpointer g_tree_search          (GTree            *tree,
  97                                  GCompareFunc      search_func,
  98                                  gconstpointer     user_data);
  99 GLIB_AVAILABLE_IN_ALL
 100 gint     g_tree_height          (GTree            *tree);
 101 GLIB_AVAILABLE_IN_ALL
 102 gint     g_tree_nnodes          (GTree            *tree);
 103
 104 G_END_DECLS
 105
 106 #endif /* __G_TREE_H__ */