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, see <http://www.gnu.org/licenses/>.
18 /* A Red-Black Tree implementation used specifically by GtkTreeView.
20 #ifndef __GTK_RBTREE_H__
21 #define __GTK_RBTREE_H__
31 GTK_RBNODE_BLACK = 1 << 0,
32 GTK_RBNODE_RED = 1 << 1,
33 GTK_RBNODE_IS_PARENT = 1 << 2,
34 GTK_RBNODE_IS_SELECTED = 1 << 3,
35 GTK_RBNODE_IS_PRELIT = 1 << 4,
36 GTK_RBNODE_INVALID = 1 << 7,
37 GTK_RBNODE_COLUMN_INVALID = 1 << 8,
38 GTK_RBNODE_DESCENDANTS_INVALID = 1 << 9,
39 GTK_RBNODE_NON_COLORS = GTK_RBNODE_IS_PARENT |
40 GTK_RBNODE_IS_SELECTED |
41 GTK_RBNODE_IS_PRELIT |
43 GTK_RBNODE_COLUMN_INVALID |
44 GTK_RBNODE_DESCENDANTS_INVALID
47 typedef struct _GtkRBTree GtkRBTree;
48 typedef struct _GtkRBNode GtkRBNode;
49 typedef struct _GtkRBTreeView GtkRBTreeView;
51 typedef void (*GtkRBTreeTraverseFunc) (GtkRBTree *tree,
58 GtkRBTree *parent_tree;
59 GtkRBNode *parent_node;
70 /* count is the number of nodes beneath us, plus 1 for ourselves.
71 * i.e. node->left->count + node->right->count + 1
74 /* count the number of total nodes beneath us, including nodes
76 * i.e. node->left->count + node->right->count + node->children->root->count + 1
80 /* this is the total of sizes of
81 * node->left, node->right, our own height, and the height
82 * of all trees in ->children, iff children exists because
83 * the thing is expanded.
92 #define GTK_RBNODE_GET_COLOR(node) (node?(((node->flags>K_RBNODE_RED)==GTK_RBNODE_RED)?GTK_RBNODE_RED:GTK_RBNODE_BLACK):GTK_RBNODE_BLACK)
93 #define GTK_RBNODE_SET_COLOR(node,color) if((node->flags&color)!=color)node->flags=node->flags^(GTK_RBNODE_RED|GTK_RBNODE_BLACK)
94 #define GTK_RBNODE_GET_HEIGHT(node) (node->offset-(node->left->offset+node->right->offset+(node->children?node->children->root->offset:0)))
95 #define GTK_RBNODE_SET_FLAG(node, flag) G_STMT_START{ (node->flags|=flag); }G_STMT_END
96 #define GTK_RBNODE_UNSET_FLAG(node, flag) G_STMT_START{ (node->flags&=~(flag)); }G_STMT_END
97 #define GTK_RBNODE_FLAG_SET(node, flag) (node?(((node->flags&flag)==flag)?TRUE:FALSE):FALSE)
100 GtkRBTree *_gtk_rbtree_new (void);
101 void _gtk_rbtree_free (GtkRBTree *tree);
102 void _gtk_rbtree_remove (GtkRBTree *tree);
103 void _gtk_rbtree_destroy (GtkRBTree *tree);
104 GtkRBNode *_gtk_rbtree_insert_before (GtkRBTree *tree,
108 GtkRBNode *_gtk_rbtree_insert_after (GtkRBTree *tree,
112 void _gtk_rbtree_remove_node (GtkRBTree *tree,
114 gboolean _gtk_rbtree_is_nil (GtkRBNode *node);
115 void _gtk_rbtree_reorder (GtkRBTree *tree,
118 gboolean _gtk_rbtree_contains (GtkRBTree *tree,
119 GtkRBTree *potential_child);
120 GtkRBNode *_gtk_rbtree_find_count (GtkRBTree *tree,
122 void _gtk_rbtree_node_set_height (GtkRBTree *tree,
125 void _gtk_rbtree_node_mark_invalid(GtkRBTree *tree,
127 void _gtk_rbtree_node_mark_valid (GtkRBTree *tree,
129 void _gtk_rbtree_column_invalid (GtkRBTree *tree);
130 void _gtk_rbtree_mark_invalid (GtkRBTree *tree);
131 void _gtk_rbtree_set_fixed_height (GtkRBTree *tree,
133 gboolean mark_valid);
134 gint _gtk_rbtree_node_find_offset (GtkRBTree *tree,
136 guint _gtk_rbtree_node_get_index (GtkRBTree *tree,
138 gboolean _gtk_rbtree_find_index (GtkRBTree *tree,
140 GtkRBTree **new_tree,
141 GtkRBNode **new_node);
142 gint _gtk_rbtree_find_offset (GtkRBTree *tree,
144 GtkRBTree **new_tree,
145 GtkRBNode **new_node);
146 void _gtk_rbtree_traverse (GtkRBTree *tree,
149 GtkRBTreeTraverseFunc func,
151 GtkRBNode *_gtk_rbtree_first (GtkRBTree *tree);
152 GtkRBNode *_gtk_rbtree_next (GtkRBTree *tree,
154 GtkRBNode *_gtk_rbtree_prev (GtkRBTree *tree,
156 void _gtk_rbtree_next_full (GtkRBTree *tree,
158 GtkRBTree **new_tree,
159 GtkRBNode **new_node);
160 void _gtk_rbtree_prev_full (GtkRBTree *tree,
162 GtkRBTree **new_tree,
163 GtkRBNode **new_node);
165 gint _gtk_rbtree_get_depth (GtkRBTree *tree);
171 #endif /* __GTK_RBTREE_H__ */