ClangFormat: apply to source, most of intern
[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, equal to, or greater than the given node
72  * - node: <DLRBT_Node> the node to compare to
73  * - data: pointer to the relevant data or values stored in the bitpattern dependent on the function
74  */
75 typedef short (*DLRBT_Comparator_FP)(void *node, void *data);
76
77 /* return a new node instance wrapping the given data
78  * - data: pointer to the relevant data to create a subclass of node from
79  */
80 typedef DLRBT_Node *(*DLRBT_NAlloc_FP)(void *data);
81
82 /* update an existing node instance accordingly to be in sync with the given data *
83  * - node: <DLRBT_Node> the node to update
84  * - data: pointer to the relevant data or values stored in the bitpattern dependent on the function
85  */
86 typedef void (*DLRBT_NUpdate_FP)(void *node, void *data);
87
88 /* ********************************************** */
89 /* Public API */
90
91 /* ADT Management ------------------------------- */
92
93 /* Create a new tree, and initialize as necessary */
94 DLRBT_Tree *BLI_dlrbTree_new(void);
95
96 /* Initializes some given trees */
97 void BLI_dlrbTree_init(DLRBT_Tree *tree);
98
99 /* Free some tree */
100 void BLI_dlrbTree_free(DLRBT_Tree *tree);
101
102 /* Make sure the tree's Double-Linked list representation is valid */
103 void BLI_dlrbTree_linkedlist_sync(DLRBT_Tree *tree);
104
105 /* Searching ------------------------------------ */
106
107 /* Find the node which matches or is the closest to the requested node */
108 DLRBT_Node *BLI_dlrbTree_search(DLRBT_Tree *tree, DLRBT_Comparator_FP cmp_cb, void *search_data);
109
110 /* Find the node which exactly matches the required data */
111 DLRBT_Node *BLI_dlrbTree_search_exact(DLRBT_Tree *tree,
112                                       DLRBT_Comparator_FP cmp_cb,
113                                       void *search_data);
114
115 /* Find the node which occurs immediately before the best matching node */
116 DLRBT_Node *BLI_dlrbTree_search_prev(DLRBT_Tree *tree,
117                                      DLRBT_Comparator_FP cmp_cb,
118                                      void *search_data);
119
120 /* Find the node which occurs immediately after the best matching node */
121 DLRBT_Node *BLI_dlrbTree_search_next(DLRBT_Tree *tree,
122                                      DLRBT_Comparator_FP cmp_cb,
123                                      void *search_data);
124
125 /* Check whether there is a node matching the requested node */
126 short BLI_dlrbTree_contains(DLRBT_Tree *tree, DLRBT_Comparator_FP cmp_cb, void *search_data);
127
128 /* Node Operations (Managed) --------------------- */
129 /* These methods automate the process of adding/removing nodes from the BST,
130  * using the supplied data and callbacks
131  */
132
133 /* Add the given data to the tree, and return the node added */
134 // NOTE: for duplicates, the update_cb is called (if available), and the existing node is returned
135 DLRBT_Node *BLI_dlrbTree_add(DLRBT_Tree *tree,
136                              DLRBT_Comparator_FP cmp_cb,
137                              DLRBT_NAlloc_FP new_cb,
138                              DLRBT_NUpdate_FP update_cb,
139                              void *data);
140
141 /* Remove the given element from the tree and balance again */
142 // FIXME: this is not implemented yet...
143 // void BLI_dlrbTree_remove(DLRBT_Tree *tree, DLRBT_Node *node);
144
145 /* Node Operations (Manual) --------------------- */
146 /* These methods require custom code for creating BST nodes and adding them to the
147  * tree in special ways, such that the node can then be balanced.
148  *
149  * It is recommended that these methods are only used where the other method is too cumbersome...
150  */
151
152 /* Balance the tree after the given node has been added to it
153  * (using custom code, in the Binary Tree way).
154  */
155 void BLI_dlrbTree_insert(DLRBT_Tree *tree, DLRBT_Node *node);
156
157 /* ********************************************** */
158
159 #endif /* __BLI_DLRBTREE_H__ */