summaryrefslogtreecommitdiff
path: root/gtk/gtktreerbtreeprivate.h
blob: 3dece561f5f6cbd430134e6982fd5155c21d10b3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
/* gtkrbtreeprivate.h
 * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
 */

/* A Red-Black Tree implementation used specifically by GtkTreeView.
 */
#ifndef __GTK_TREE_RBTREE_PRIVATE_H__
#define __GTK_TREE_RBTREE_PRIVATE_H__

#include <glib.h>


G_BEGIN_DECLS


typedef enum
{
  GTK_TREE_RBNODE_BLACK = 1 << 0,
  GTK_TREE_RBNODE_RED = 1 << 1,
  GTK_TREE_RBNODE_IS_PARENT = 1 << 2,
  GTK_TREE_RBNODE_IS_SELECTED = 1 << 3,
  GTK_TREE_RBNODE_IS_PRELIT = 1 << 4,
  GTK_TREE_RBNODE_INVALID = 1 << 7,
  GTK_TREE_RBNODE_COLUMN_INVALID = 1 << 8,
  GTK_TREE_RBNODE_DESCENDANTS_INVALID = 1 << 9,
  GTK_TREE_RBNODE_NON_COLORS = GTK_TREE_RBNODE_IS_PARENT |
                            GTK_TREE_RBNODE_IS_SELECTED |
                            GTK_TREE_RBNODE_IS_PRELIT |
                          GTK_TREE_RBNODE_INVALID |
                          GTK_TREE_RBNODE_COLUMN_INVALID |
                          GTK_TREE_RBNODE_DESCENDANTS_INVALID
} GtkTreeRBNodeColor;

typedef struct _GtkTreeRBTree GtkTreeRBTree;
typedef struct _GtkTreeRBNode GtkTreeRBNode;
typedef struct _GtkTreeRBTreeView GtkTreeRBTreeView;

typedef void (*GtkTreeRBTreeTraverseFunc) (GtkTreeRBTree  *tree,
                                       GtkTreeRBNode  *node,
                                       gpointer  data);

struct _GtkTreeRBTree
{
  GtkTreeRBNode *root;
  GtkTreeRBTree *parent_tree;
  GtkTreeRBNode *parent_node;
};

struct _GtkTreeRBNode
{
  guint flags : 14;

  /* count is the number of nodes beneath us, plus 1 for ourselves.
   * i.e. node->left->count + node->right->count + 1
   */
  gint count;

  GtkTreeRBNode *left;
  GtkTreeRBNode *right;
  GtkTreeRBNode *parent;

  /* count the number of total nodes beneath us, including nodes
   * of children trees.
   * i.e. node->left->count + node->right->count + node->children->root->count + 1
   */
  guint total_count;
  
  /* this is the total of sizes of
   * node->left, node->right, our own height, and the height
   * of all trees in ->children, iff children exists because
   * the thing is expanded.
   */
  gint offset;

  /* Child trees */
  GtkTreeRBTree *children;
};


#define GTK_TREE_RBNODE_GET_COLOR(node)                (node?(((node->flags&GTK_TREE_RBNODE_RED)==GTK_TREE_RBNODE_RED)?GTK_TREE_RBNODE_RED:GTK_TREE_RBNODE_BLACK):GTK_TREE_RBNODE_BLACK)
#define GTK_TREE_RBNODE_SET_COLOR(node,color)         if((node->flags&color)!=color)node->flags=node->flags^(GTK_TREE_RBNODE_RED|GTK_TREE_RBNODE_BLACK)
#define GTK_TREE_RBNODE_GET_HEIGHT(node)                 (node->offset-(node->left->offset+node->right->offset+(node->children?node->children->root->offset:0)))
#define GTK_TREE_RBNODE_SET_FLAG(node, flag)           G_STMT_START{ (node->flags|=flag); }G_STMT_END
#define GTK_TREE_RBNODE_UNSET_FLAG(node, flag)         G_STMT_START{ (node->flags&=~(flag)); }G_STMT_END
#define GTK_TREE_RBNODE_FLAG_SET(node, flag)         (node?(((node->flags&flag)==flag)?TRUE:FALSE):FALSE)


GtkTreeRBTree * gtk_tree_rbtree_new                     (void);
void            gtk_tree_rbtree_free                    (GtkTreeRBTree                 *tree);
void            gtk_tree_rbtree_remove                  (GtkTreeRBTree                 *tree);
void            gtk_tree_rbtree_destroy                 (GtkTreeRBTree                 *tree);
GtkTreeRBNode * gtk_tree_rbtree_insert_before           (GtkTreeRBTree                 *tree,
                                                         GtkTreeRBNode                 *node,
                                                         gint                           height,
                                                         gboolean                       valid);
GtkTreeRBNode * gtk_tree_rbtree_insert_after            (GtkTreeRBTree                 *tree,
                                                         GtkTreeRBNode                 *node,
                                                         gint                           height,
                                                         gboolean                       valid);
void            gtk_tree_rbtree_remove_node             (GtkTreeRBTree                 *tree,
                                                         GtkTreeRBNode                 *node);
gboolean        gtk_tree_rbtree_is_nil                  (GtkTreeRBNode                 *node);
void            gtk_tree_rbtree_reorder                 (GtkTreeRBTree                 *tree,
                                                         gint                          *new_order,
                                                         gint                           length);
gboolean        gtk_tree_rbtree_contains                (GtkTreeRBTree                 *tree,
                                                         GtkTreeRBTree                 *potential_child);
GtkTreeRBNode * gtk_tree_rbtree_find_count              (GtkTreeRBTree                 *tree,
                                                         gint                           count);
void            gtk_tree_rbtree_node_set_height         (GtkTreeRBTree                 *tree,
                                                         GtkTreeRBNode                 *node,
                                                         gint                           height);
void            gtk_tree_rbtree_node_mark_invalid       (GtkTreeRBTree                 *tree,
                                                         GtkTreeRBNode                 *node);
void            gtk_tree_rbtree_node_mark_valid         (GtkTreeRBTree                 *tree,
                                                         GtkTreeRBNode                 *node);
void            gtk_tree_rbtree_column_invalid          (GtkTreeRBTree                 *tree);
void            gtk_tree_rbtree_mark_invalid            (GtkTreeRBTree                 *tree);
void            gtk_tree_rbtree_set_fixed_height        (GtkTreeRBTree                 *tree,
                                                         gint                           height,
                                                         gboolean                       mark_valid);
gint            gtk_tree_rbtree_node_find_offset        (GtkTreeRBTree                 *tree,
                                                         GtkTreeRBNode                 *node);
guint           gtk_tree_rbtree_node_get_index          (GtkTreeRBTree                 *tree,
                                                         GtkTreeRBNode                 *node);
gboolean        gtk_tree_rbtree_find_index              (GtkTreeRBTree                 *tree,
                                                         guint                          index,
                                                         GtkTreeRBTree                **new_tree,
                                                         GtkTreeRBNode                **new_node);
gint            gtk_tree_rbtree_find_offset             (GtkTreeRBTree                 *tree,
                                                         gint                           offset,
                                                         GtkTreeRBTree                **new_tree,
                                                         GtkTreeRBNode                **new_node);
void            gtk_tree_rbtree_traverse                (GtkTreeRBTree                 *tree,
                                                         GtkTreeRBNode                 *node,
                                                         GTraverseType                  order,
                                                         GtkTreeRBTreeTraverseFunc      func,
                                                         gpointer                       data);
GtkTreeRBNode * gtk_tree_rbtree_first                   (GtkTreeRBTree                 *tree);
GtkTreeRBNode * gtk_tree_rbtree_next                    (GtkTreeRBTree                 *tree,
                                                         GtkTreeRBNode                 *node);
GtkTreeRBNode * gtk_tree_rbtree_prev                    (GtkTreeRBTree                 *tree,
                                                         GtkTreeRBNode                 *node);
void            gtk_tree_rbtree_next_full               (GtkTreeRBTree                 *tree,
                                                         GtkTreeRBNode                 *node,
                                                         GtkTreeRBTree                **new_tree,
                                                         GtkTreeRBNode                **new_node);
void            gtk_tree_rbtree_prev_full               (GtkTreeRBTree                 *tree,
                                                         GtkTreeRBNode                 *node,
                                                         GtkTreeRBTree                **new_tree,
                                                         GtkTreeRBNode                **new_node);

gint            gtk_tree_rbtree_get_depth               (GtkTreeRBTree                 *tree);


G_END_DECLS


#endif /* __GTK_TREE_RBTREE_PRIVATE_H__ */