make it possible to disable single-file includes by defining
[platform/upstream/glib.git] / 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 (__G_LIB_H__) && !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 typedef struct _GTree  GTree;
39
40 typedef gboolean (*GTraverseFunc) (gpointer  key,
41                                    gpointer  value,
42                                    gpointer  data);
43
44 /* Balanced binary trees
45  */
46 GTree*   g_tree_new             (GCompareFunc      key_compare_func);
47 GTree*   g_tree_new_with_data   (GCompareDataFunc  key_compare_func,
48                                  gpointer          key_compare_data);
49 GTree*   g_tree_new_full        (GCompareDataFunc  key_compare_func,
50                                  gpointer          key_compare_data,
51                                  GDestroyNotify    key_destroy_func,
52                                  GDestroyNotify    value_destroy_func);
53 void     g_tree_destroy         (GTree            *tree);
54 void     g_tree_insert          (GTree            *tree,
55                                  gpointer          key,
56                                  gpointer          value);
57 void     g_tree_replace         (GTree            *tree,
58                                  gpointer          key,
59                                  gpointer          value);
60 gboolean g_tree_remove          (GTree            *tree,
61                                  gconstpointer     key);
62 gboolean g_tree_steal           (GTree            *tree,
63                                  gconstpointer     key);
64 gpointer g_tree_lookup          (GTree            *tree,
65                                  gconstpointer     key);
66 gboolean g_tree_lookup_extended (GTree            *tree,
67                                  gconstpointer     lookup_key,
68                                  gpointer         *orig_key,
69                                  gpointer         *value);
70 void     g_tree_foreach         (GTree            *tree,
71                                  GTraverseFunc     func,
72                                  gpointer          user_data);
73
74 #ifndef G_DISABLE_DEPRECATED
75 void     g_tree_traverse        (GTree            *tree,
76                                  GTraverseFunc     traverse_func,
77                                  GTraverseType     traverse_type,
78                                  gpointer          user_data);
79 #endif /* G_DISABLE_DEPRECATED */
80
81 gpointer g_tree_search          (GTree            *tree,
82                                  GCompareFunc      search_func,
83                                  gconstpointer     user_data);
84 gint     g_tree_height          (GTree            *tree);
85 gint     g_tree_nnodes          (GTree            *tree);
86
87 G_END_DECLS
88
89 #endif /* __G_TREE_H__ */