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