2 * Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library 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.
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 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library 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.
20 /* A Red-Black Tree implementation used specifically by GtkTreeView.
22 #ifndef __GTK_RBTREE_H__
23 #define __GTK_RBTREE_H__
33 GTK_RBNODE_BLACK = 1 << 0,
34 GTK_RBNODE_RED = 1 << 1,
35 GTK_RBNODE_IS_PARENT = 1 << 2,
36 GTK_RBNODE_IS_SELECTED = 1 << 3,
37 GTK_RBNODE_IS_PRELIT = 1 << 4,
38 GTK_RBNODE_IS_SEMI_COLLAPSED = 1 << 5,
39 GTK_RBNODE_IS_SEMI_EXPANDED = 1 << 6,
40 GTK_RBNODE_INVALID = 1 << 7,
41 GTK_RBNODE_COLUMN_INVALID = 1 << 8,
42 GTK_RBNODE_DESCENDANTS_INVALID = 1 << 9,
43 GTK_RBNODE_NON_COLORS = GTK_RBNODE_IS_PARENT |
44 GTK_RBNODE_IS_SELECTED |
45 GTK_RBNODE_IS_PRELIT |
46 GTK_RBNODE_IS_SEMI_COLLAPSED |
47 GTK_RBNODE_IS_SEMI_EXPANDED |
49 GTK_RBNODE_COLUMN_INVALID |
50 GTK_RBNODE_DESCENDANTS_INVALID
53 typedef struct _GtkRBTree GtkRBTree;
54 typedef struct _GtkRBNode GtkRBNode;
55 typedef struct _GtkRBTreeView GtkRBTreeView;
57 typedef void (*GtkRBTreeTraverseFunc) (GtkRBTree *tree,
65 GtkRBTree *parent_tree;
66 GtkRBNode *parent_node;
73 /* We keep track of whether the aggregate count of children plus 1
74 * for the node itself comes to an even number. The parity flag is
75 * the total count of children mod 2, where the total count of
76 * children gets computed in the same way that the total offset gets
77 * computed. i.e. not the same as the "count" field below which
78 * doesn't include children. We could replace parity with a
79 * full-size int field here, and then take % 2 to get the parity flag,
80 * but that would use extra memory.
89 /* count is the number of nodes beneath us, plus 1 for ourselves.
90 * i.e. node->left->count + node->right->count + 1
94 /* this is the total of sizes of
95 * node->left, node->right, our own height, and the height
96 * of all trees in ->children, iff children exists because
97 * the thing is expanded.
106 #define GTK_RBNODE_GET_COLOR(node) (node?(((node->flags>K_RBNODE_RED)==GTK_RBNODE_RED)?GTK_RBNODE_RED:GTK_RBNODE_BLACK):GTK_RBNODE_BLACK)
107 #define GTK_RBNODE_SET_COLOR(node,color) if((node->flags&color)!=color)node->flags=node->flags^(GTK_RBNODE_RED|GTK_RBNODE_BLACK)
108 #define GTK_RBNODE_GET_HEIGHT(node) (node->offset-(node->left->offset+node->right->offset+(node->children?node->children->root->offset:0)))
109 #define GTK_RBNODE_SET_FLAG(node, flag) G_STMT_START{ (node->flags|=flag); }G_STMT_END
110 #define GTK_RBNODE_UNSET_FLAG(node, flag) G_STMT_START{ (node->flags&=~(flag)); }G_STMT_END
111 #define GTK_RBNODE_FLAG_SET(node, flag) (node?(((node->flags&flag)==flag)?TRUE:FALSE):FALSE)
114 GtkRBTree *_gtk_rbtree_new (void);
115 void _gtk_rbtree_free (GtkRBTree *tree);
116 void _gtk_rbtree_remove (GtkRBTree *tree);
117 void _gtk_rbtree_destroy (GtkRBTree *tree);
118 GtkRBNode *_gtk_rbtree_insert_before (GtkRBTree *tree,
122 GtkRBNode *_gtk_rbtree_insert_after (GtkRBTree *tree,
126 void _gtk_rbtree_remove_node (GtkRBTree *tree,
128 void _gtk_rbtree_reorder (GtkRBTree *tree,
131 GtkRBNode *_gtk_rbtree_find_count (GtkRBTree *tree,
133 void _gtk_rbtree_node_set_height (GtkRBTree *tree,
136 void _gtk_rbtree_node_mark_invalid(GtkRBTree *tree,
138 void _gtk_rbtree_node_mark_valid (GtkRBTree *tree,
140 void _gtk_rbtree_column_invalid (GtkRBTree *tree);
141 void _gtk_rbtree_mark_invalid (GtkRBTree *tree);
142 void _gtk_rbtree_set_fixed_height (GtkRBTree *tree,
144 gboolean mark_valid);
145 gint _gtk_rbtree_node_find_offset (GtkRBTree *tree,
147 gint _gtk_rbtree_node_find_parity (GtkRBTree *tree,
149 gint _gtk_rbtree_find_offset (GtkRBTree *tree,
151 GtkRBTree **new_tree,
152 GtkRBNode **new_node);
153 void _gtk_rbtree_traverse (GtkRBTree *tree,
156 GtkRBTreeTraverseFunc func,
158 GtkRBNode *_gtk_rbtree_next (GtkRBTree *tree,
160 GtkRBNode *_gtk_rbtree_prev (GtkRBTree *tree,
162 void _gtk_rbtree_next_full (GtkRBTree *tree,
164 GtkRBTree **new_tree,
165 GtkRBNode **new_node);
166 void _gtk_rbtree_prev_full (GtkRBTree *tree,
168 GtkRBTree **new_tree,
169 GtkRBNode **new_node);
171 gint _gtk_rbtree_get_depth (GtkRBTree *tree);
173 /* This func checks the integrity of the tree */
174 #ifdef G_ENABLE_DEBUG
175 void _gtk_rbtree_test (const gchar *where,
177 void _gtk_rbtree_debug_spew (GtkRBTree *tree);
184 #endif /* __GTK_RBTREE_H__ */