Cleanup: comments (long lines) in blenlib
[blender.git] / source / blender / blenlib / BLI_dlrbTree.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2009 Blender Foundation, Joshua Leung
17  * All rights reserved.
18  */
19
20 #ifndef __BLI_DLRBTREE_H__
21 #define __BLI_DLRBTREE_H__
22
23 /** \file
24  * \ingroup bli
25  */
26
27 /* Double-Linked Red-Black Tree Implementation:
28  *
29  * This is simply a Red-Black Tree implementation whose nodes can later
30  * be arranged + retrieved as elements in a Double-Linked list (i.e. ListBase).
31  * The Red-Black Tree implementation is based on the methods defined by Wikipedia.
32  */
33
34 /* ********************************************** */
35 /* Data Types and Type Defines  */
36
37 /* Base Structs --------------------------------- */
38
39 /* Basic Layout for a Node */
40 typedef struct DLRBT_Node {
41   /* ListBase capabilities */
42   struct DLRBT_Node *next, *prev;
43
44   /* Tree Associativity settings */
45   struct DLRBT_Node *left, *right;
46   struct DLRBT_Node *parent;
47
48   char tree_col;
49   /* ... for nice alignment, next item should usually be a char too... */
50 } DLRBT_Node;
51
52 /* Red/Black defines for tree_col */
53 typedef enum eDLRBT_Colors {
54   DLRBT_BLACK = 0,
55   DLRBT_RED,
56 } eDLRBT_Colors;
57
58 /* -------- */
59
60 /* The Tree Data */
61 typedef struct DLRBT_Tree {
62   /* ListBase capabilities */
63   void *first, *last; /* these should be based on DLRBT_Node-s */
64
65   /* Root Node */
66   void *root; /* this should be based on DLRBT_Node-s */
67 } DLRBT_Tree;
68
69 /* Callback Types --------------------------------- */
70
71 /* Return -1, 0, 1 for whether the given data is less than,
72  * equal to, or greater than the given node.
73  * - node: <DLRBT_Node> the node to compare to
74  * - data: pointer to the relevant data or values stored in the bitpattern
75  *   dependent on the function.
76  */
77 typedef short (*DLRBT_Comparator_FP)(void *node, void *data);
78
79 /* Return a new node instance wrapping the given data
80  * - data: Pointer to the relevant data to create a subclass of node from
81  */
82 typedef DLRBT_Node *(*DLRBT_NAlloc_FP)(void *data);
83
84 /* Update an existing node instance accordingly to be in sync with the given data *
85  * - node: <DLRBT_Node> the node to update.
86  * - data: Pointer to the relevant data or values stored in the bitpattern
87  *   dependent on the function.
88  */
89 typedef void (*DLRBT_NUpdate_FP)(void *node, void *data);
90
91 /* ********************************************** */
92 /* Public API */
93
94 /* ADT Management ------------------------------- */
95
96 /* Create a new tree, and initialize as necessary */
97 DLRBT_Tree *BLI_dlrbTree_new(void);
98
99 /* Initializes some given trees */
100 void BLI_dlrbTree_init(DLRBT_Tree *tree);
101
102 /* Free some tree */
103 void BLI_dlrbTree_free(DLRBT_Tree *tree);
104
105 /* Make sure the tree's Double-Linked list representation is valid */
106 void BLI_dlrbTree_linkedlist_sync(DLRBT_Tree *tree);
107
108 /* Searching ------------------------------------ */
109
110 /* Find the node which matches or is the closest to the requested node */
111 DLRBT_Node *BLI_dlrbTree_search(DLRBT_Tree *tree, DLRBT_Comparator_FP cmp_cb, void *search_data);
112
113 /* Find the node which exactly matches the required data */
114 DLRBT_Node *BLI_dlrbTree_search_exact(DLRBT_Tree *tree,
115                                       DLRBT_Comparator_FP cmp_cb,
116                                       void *search_data);
117
118 /* Find the node which occurs immediately before the best matching node */
119 DLRBT_Node *BLI_dlrbTree_search_prev(DLRBT_Tree *tree,
120                                      DLRBT_Comparator_FP cmp_cb,
121                                      void *search_data);
122
123 /* Find the node which occurs immediately after the best matching node */
124 DLRBT_Node *BLI_dlrbTree_search_next(DLRBT_Tree *tree,
125                                      DLRBT_Comparator_FP cmp_cb,
126                                      void *search_data);
127
128 /* Check whether there is a node matching the requested node */
129 short BLI_dlrbTree_contains(DLRBT_Tree *tree, DLRBT_Comparator_FP cmp_cb, void *search_data);
130
131 /* Node Operations (Managed) --------------------- */
132 /* These methods automate the process of adding/removing nodes from the BST,
133  * using the supplied data and callbacks
134  */
135
136 /* Add the given data to the tree, and return the node added */
137 // NOTE: for duplicates, the update_cb is called (if available), and the existing node is returned
138 DLRBT_Node *BLI_dlrbTree_add(DLRBT_Tree *tree,
139                              DLRBT_Comparator_FP cmp_cb,
140                              DLRBT_NAlloc_FP new_cb,
141                              DLRBT_NUpdate_FP update_cb,
142                              void *data);
143
144 /* Remove the given element from the tree and balance again */
145 // FIXME: this is not implemented yet...
146 // void BLI_dlrbTree_remove(DLRBT_Tree *tree, DLRBT_Node *node);
147
148 /* Node Operations (Manual) --------------------- */
149 /* These methods require custom code for creating BST nodes and adding them to the
150  * tree in special ways, such that the node can then be balanced.
151  *
152  * It is recommended that these methods are only used where the other method is too cumbersome...
153  */
154
155 /* Balance the tree after the given node has been added to it
156  * (using custom code, in the Binary Tree way).
157  */
158 void BLI_dlrbTree_insert(DLRBT_Tree *tree, DLRBT_Node *node);
159
160 /* ********************************************** */
161
162 #endif /* __BLI_DLRBTREE_H__ */