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 #include <gnode.h>
  31
  32 G_BEGIN_DECLS
  33
  34 typedef struct _GTree           GTree;
  35
  36 typedef gint            (*GTraverseFunc)        (gpointer       key,
  37                                                  gpointer       value,
  38                                                  gpointer       data);
  39
  40 /* Balanced binary trees
  41  */
  42 GTree*   g_tree_new      (GCompareFunc   key_compare_func);
  43 void     g_tree_destroy  (GTree         *tree);
  44 void     g_tree_insert   (GTree         *tree,
  45                           gpointer       key,
  46                           gpointer       value);
  47 void     g_tree_remove   (GTree         *tree,
  48                           gconstpointer  key);
  49 gpointer g_tree_lookup   (GTree         *tree,
  50                           gconstpointer  key);
  51 void     g_tree_traverse (GTree         *tree,
  52                           GTraverseFunc  traverse_func,
  53                           GTraverseType  traverse_type,
  54                           gpointer       data);
  55 gpointer g_tree_search   (GTree         *tree,
  56                           GCompareFunc   search_func,
  57                           gconstpointer  data);
  58 gint     g_tree_height   (GTree         *tree);
  59 gint     g_tree_nnodes   (GTree         *tree);
  60
  61 G_END_DECLS
  62
  63 #endif /* __G_TREE_H__ */
  64