d5032b58a21d2ef678c7fa8da430b1cf9212f6a0
[tprouty/samba.git] / source / ubiqx / ubi_BinTree.h
1 #ifndef ubi_BinTree_H
2 #define ubi_BinTree_H
3 /* ========================================================================== **
4  *                              ubi_BinTree.h
5  *
6  *  Copyright (C) 1991-1997 by Christopher R. Hertel
7  *
8  *  Email:  crh@ubiqx.mn.org
9  * -------------------------------------------------------------------------- **
10  *
11  *  This module implements simple binary trees.
12  *
13  * -------------------------------------------------------------------------- **
14  *
15  *  This library is free software; you can redistribute it and/or
16  *  modify it under the terms of the GNU Library General Public
17  *  License as published by the Free Software Foundation; either
18  *  version 2 of the License, or (at your option) any later version.
19  *
20  *  This library is distributed in the hope that it will be useful,
21  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
22  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
23  *  Library General Public License for more details.
24  *
25  *  You should have received a copy of the GNU Library General Public
26  *  License along with this library; if not, write to the Free
27  *  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28  *
29  * -------------------------------------------------------------------------- **
30  *
31  * Log: ubi_BinTree.h,v
32  * Revision 3.0  1997/12/08 06:49:15  crh
33  * This is a new major revision level for all ubiqx binary tree modules.
34  * In previous releases, the ubi_trNode structure looked like this:
35  *
36  *   typedef struct ubi_btNodeStruct
37  *     {
38  *     struct ubi_btNodeStruct *Link[3];
39  *     signed char              gender;
40  *     } ubi_btNode;
41  *
42  * As a result, the pointers were indexed as
43  *
44  *   Link[0] == Left Child
45  *   Link[1] == Parent
46  *   Link[2] == Right Child
47  *
48  * With this release, the node structure changes to:
49  *
50  *   typedef struct ubi_btNodeStruct
51  *     {
52  *     struct ubi_btNodeStruct *leftlink
53  *     struct ubi_btNodeStruct *Link[2];
54  *     signed char              gender;
55  *     } ubi_btNode;
56  *
57  * The leftlink field is used as a place holder, and the pointers are now
58  * index as
59  *
60  *   Link[-1] == Left Child  (aka. leftlink)
61  *   Link[ 0] == Parent
62  *   Link[ 1] == Right Child
63  *
64  * which is much nicer.  Doing things this way removes the need to shift
65  * values between the two numbering schemes, thus removing one macro,
66  * simplifying another, and getting rid of a whole bunch of increment &
67  * decrement operations.
68  *
69  * Revision 2; 1995/02/27 - 1997/12/07 included:
70  *  - The addition of the ModuleID static string and ubi_ModuleID() function.
71  *  - The addition of the public functions FirstOf() and LastOf(). These
72  *    functions are used with trees that allow duplicate keys.
73  *  - The addition of the ubi_btLeafNode() function.
74  *  - A rewrite of the Locate() function.
75  *  - A change to the parameter list in function ubi_btInitTree().
76  *  - Bugfixes.
77  *
78  * Revision 1; 93/10/15 - 95/02/27:
79  * Revision 1 introduced a set of #define's that provide a single API to all
80  * of the existing tree modules.  Each of these modules has a different name
81  * prefix, as follows:
82  *
83  *       Module        Prefix
84  *     ubi_BinTree     ubi_bt
85  *     ubi_AVLtree     ubi_avl
86  *     ubi_SplayTree   ubi_spt
87  *
88  * Only those portions of the base module (ubi_BinTree) that are superceeded
89  * in the descendant module have new names.  For example, the AVL node
90  * structure in ubi_AVLtree.h is named "ubi_avlNode", but the root structure
91  * is still "ubi_btRoot".  Using SplayTree, the locate function is called
92  * "ubi_sptLocate", but the next and previous functions remained "ubi_btNext"
93  * and "ubi_btPrev".
94  *
95  * This is confusing.
96  *
97  * So, I added a set of defined names that get redefined in any of the
98  * descendant modules.  To use this standardized interface in your code,
99  * simply replace all occurances of "ubi_bt", "ubi_avl", and "ubi_spt" with
100  * "ubi_tr".  The "ubi_tr" names will resolve to the correct function or
101  * datatype names for the module that you are using.  Just remember to
102  * include the header for that module in your program file.  Because these
103  * names are handled by the preprocessor, there is no added run-time
104  * overhead.
105  *
106  * Note that the original names do still exist, and can be used if you wish
107  * to write code directly to a specific module.  This should probably only be
108  * done if you are planning to implement a new descendant type, such as
109  * red/black trees, or if you plan to use two or more specific tree types
110  * in the same piece of code.  CRH
111  *
112  *  V0.0 - June, 1991   -  Written by Christopher R. Hertel (CRH).
113  *
114  * ========================================================================== **
115  */
116
117 /* -------------------------------------------------------------------------- **
118  * Constants...
119  *
120  *  General purpose:
121  *    ubi_trTRUE  - Boolean TRUE.
122  *    ubi_trFALSE - Boolean FALSE.
123  *
124  *  Flags used in the tree header:
125  *    ubi_trOVERWRITE   - This flag indicates that an existing node may be
126  *                        overwritten by a new node with a matching key.
127  *    ubi_trDUPKEY      - This flag indicates that the tree allows duplicate
128  *                        keys.  If the tree allows duplicates, the overwrite
129  *                        flag is ignored.
130  *
131  *  Node link array index constants:
132  *    (Each node has an array of three pointers; pointer to the left child,
133  *    pointer to the right child, and a pointer back to the parent node.)
134  *      ubi_trLEFT    - Left child pointer.
135  *      ubi_trPARENT  - Parent pointer.
136  *      ubi_trRIGHT   - Right child pointer.
137  *      ubi_trEQUAL   - Synonym for PARENT.
138  *
139  *  ubi_trCompOps:  These values are used in the ubi_trLocate() function.
140  *    ubi_trLT  - request the first instance of the greatest key less than
141  *                the search key.
142  *    ubi_trLE  - request the first instance of the greatest key that is less
143  *                than or equal to the search key.
144  *    ubi_trEQ  - request the first instance of key that is equal to the
145  *                search key.
146  *    ubi_trGE  - request the first instance of a key that is greater than
147  *                or equal to the search key.
148  *    ubi_trGT  - request the first instance of the first key that is greater
149  *                than the search key.
150  */
151
152 #define ubi_trTRUE  0xFF
153 #define ubi_trFALSE 0x00
154
155 #define ubi_trOVERWRITE 0x01        /* Turn on allow overwrite      */
156 #define ubi_trDUPKEY    0x02        /* Turn on allow duplicate keys */
157
158 /* Pointer array index constants... */
159 #define ubi_trLEFT   -1
160 #define ubi_trPARENT  0
161 #define ubi_trRIGHT   1
162 #define ubi_trEQUAL   ubi_trPARENT
163
164 typedef enum
165   {
166   ubi_trLT = 1,
167   ubi_trLE,
168   ubi_trEQ,
169   ubi_trGE,
170   ubi_trGT
171   } ubi_trCompOps;
172
173 /* -------------------------------------------------------------------------- **
174  * Macros...
175  *  ubi_trNormalize() - "Normalize" a value with respect to ubi_trLEFT,
176  *                      ubi_trRIGHT, and ubi_trPARENT.  This macro calls
177  *                      ubi_btSgn() to convert the input to -1, 0, or 1.
178  *                      The resultant value is returned as a signed char.
179  *
180  *  ubi_trRevWay()    - converts ubi_trLEFT to ubi_trRIGHT and vice versa.
181  *                      ubi_trPARENT (ubi_trEQUAL) is left as is.
182  *
183  *  ubi_trDups_OK()   - returns TRUE if the tree allows duplicates.
184  *
185  *  ubi_trOvwt_OK()   - returns TRUE if the overwrite flag is on.  Note
186  *                      that overwrites will not occur in a tree that
187  *                      allows duplicates.
188  */
189
190 #define ubi_trNormalize(W) ((signed char)ubi_btSgn(W))
191 #define ubi_trRevWay(W) (-(W))
192
193 #define ubi_trDups_OK(A) \
194         ((ubi_trDUPKEY & ((A)->flags))   ? (ubi_trTRUE) : (ubi_trFALSE))
195 #define ubi_trOvwt_OK(A) \
196         ((ubi_trOVERWRITE & ((A)->flags))? (ubi_trTRUE) : (ubi_trFALSE))
197
198
199 /* -------------------------------------------------------------------------- **
200  * Typedefs...
201  * 
202  * ubi_trBool     - Your typcial true or false...
203  *
204  * ubi_btItemPtr  - The Item Pointer is a generic pointer.  It is used to
205  *                  indicate a key for which to search within the tree.
206  *                  The ubi_trFind(), ubi_trLocate(), and  ubi_trInsert()
207  *                  functions all perform searches.
208  */
209
210 typedef unsigned char ubi_trBool;   /* Our own name for "boolean".            */
211
212 typedef void *ubi_btItemPtr;        /* A pointer to (key) data within a node. */
213
214 /* -------------------------------------------------------------------------- **
215  * Typedefs continued...
216  *
217  *  Binary Tree Node Structure:  This structure defines the basic elements of
218  *       the tree nodes.  In general you *SHOULD NOT PLAY WITH THESE FIELDS*!
219  *       But, of course, I have to put the structure into this header so that
220  *       you can use it as a building block.
221  *
222  *  The fields are as follows:
223  *    leftlink -  pointer to the left child of the node.  This field will
224  *                be accessed as Link[-1].
225  *    Link     -  an array of pointers.  These pointers are manipulated by
226  *                the BT routines.  The pointers indicate the left and right
227  *                child nodes and the parent node.  By keeping track of the
228  *                parent pointer, we avoid the need for recursive routines or
229  *                hand-tooled stacks to keep track of our path back to the
230  *                root.  The use of these pointers is subject to change without
231  *                notice.
232  *    gender   -  a one-byte field indicating whether the node is the RIGHT or
233  *                LEFT child of its parent.  If the node is the root of the
234  *                tree, gender will be PARENT.
235  */
236
237 typedef struct ubi_btNodeStruct
238   {
239   struct ubi_btNodeStruct *leftlink;    /* Will be accessed as Link[-1].      */
240   struct ubi_btNodeStruct *Link[2];     /* Parent & Right links.              */
241   signed char              gender;      /* Indicates Left/Right of parent.    */
242   } ubi_btNode;
243
244 typedef ubi_btNode *ubi_btNodePtr;     /* Pointer to an ubi_btNode structure. */
245
246 /* -------------------------------------------------------------------------- **
247  * Typedefs continued...
248  *
249  *  The next three typedefs define standard function types used by the binary
250  *  tree management routines.  In particular:
251  *
252  *    ubi_btCompFunc    is a pointer to a comparison function.  Comparison
253  *                      functions are passed an ubi_btItemPtr and an
254  *                      ubi_btNodePtr.  They return a value that is (<0), 0,
255  *                      or (>0) to indicate that the Item is (respectively)
256  *                      "less than", "equal to", or "greater than" the Item
257  *                      contained within the node.  (See ubi_btInitTree()).
258  *    ubi_btActionRtn   is a pointer to a function that may be called for each
259  *                      node visited when performing a tree traversal (see
260  *                      ubi_btTraverse()).  The function will be passed two
261  *                      parameters: the first is a pointer to a node in the
262  *                      tree, the second is a generic pointer that may point to
263  *                      anything that you like.
264  *    ubi_btKillNodeRtn is a pointer to a function that will deallocate the
265  *                      memory used by a node (see ubi_btKillTree()).  Since
266  *                      memory management is left up to you, deallocation may
267  *                      mean anything that you want it to mean.  Just remember
268  *                      that the tree *will* be destroyed and that none of the
269  *                      node pointers will be valid any more.
270  */
271
272 typedef  int (*ubi_btCompFunc)( ubi_btItemPtr, ubi_btNodePtr );
273
274 typedef void (*ubi_btActionRtn)( ubi_btNodePtr, void * );
275
276 typedef void (*ubi_btKillNodeRtn)( ubi_btNodePtr );
277
278 /* -------------------------------------------------------------------------- **
279  * Typedefs continued...
280  *
281  *  Tree Root Structure: This structure gives us a convenient handle for
282  *                       accessing whole AVL trees.  The fields are:
283  *    root  -  A pointer to the root node of the AVL tree.
284  *    count -  A count of the number of nodes stored in the tree.
285  *    cmp   -  A pointer to the comparison routine to be used when building or
286  *             searching the tree.
287  *    flags -  A set of bit flags.  Two flags are currently defined:
288  *
289  *       ubi_trOVERWRITE -  If set, this flag indicates that a new node should
290  *         (bit 0x01)       overwrite an old node if the two have identical
291  *                          keys (ie., the keys are equal).
292  *       ubi_trDUPKEY    -  If set, this flag indicates that the tree is
293  *         (bit 0x02)       allowed to contain nodes with duplicate keys.
294  *
295  *       NOTE: ubi_trInsert() tests ubi_trDUPKEY before ubi_trOVERWRITE.
296  *             If duplicate keys are allowed, then no entry will be
297  *             overwritten.
298  *
299  *  All of these values are set when you initialize the root structure by
300  *  calling ubi_trInitTree().
301  */
302
303 typedef struct
304   {
305   ubi_btNodePtr  root;     /* A pointer to the root node of the tree       */
306   unsigned long  count;    /* A count of the number of nodes in the tree   */
307   ubi_btCompFunc cmp;      /* A pointer to the tree's comparison function  */
308   unsigned char  flags;    /* Overwrite Y|N, Duplicate keys Y|N...         */
309   } ubi_btRoot;
310
311 typedef ubi_btRoot *ubi_btRootPtr;  /* Pointer to an ubi_btRoot structure. */
312
313
314 /* -------------------------------------------------------------------------- **
315  * Function Prototypes.
316  */
317
318 long ubi_btSgn( long x );
319   /* ------------------------------------------------------------------------ **
320    * Return the sign of x; {negative,zero,positive} ==> {-1, 0, 1}.
321    *
322    *  Input:  x - a signed long integer value.
323    *
324    *  Output: -1, 0, or 1 representing the "sign" of x as follows:
325    *            -1 == negative
326    *             0 == zero (no sign)
327    *             1 == positive
328    *
329    *  Notes:  This utility is provided in order to facilitate the conversion
330    *          of C comparison function return values into BinTree direction
331    *          values: {ubi_trLEFT, ubi_trPARENT, ubi_trEQUAL}.  It is
332    *          incorporated into the Normalize() conversion macro.
333    *
334    * ------------------------------------------------------------------------ **
335    */
336
337 ubi_btNodePtr ubi_btInitNode( ubi_btNodePtr NodePtr );
338   /* ------------------------------------------------------------------------ **
339    * Initialize a tree node.
340    *
341    *  Input:   a pointer to a ubi_btNode structure to be initialized.
342    *  Output:  a pointer to the initialized ubi_btNode structure (ie. the
343    *           same as the input pointer).
344    * ------------------------------------------------------------------------ **
345    */
346
347 ubi_btRootPtr ubi_btInitTree( ubi_btRootPtr   RootPtr,
348                               ubi_btCompFunc  CompFunc,
349                               unsigned char   Flags );
350   /* ------------------------------------------------------------------------ **
351    * Initialize the fields of a Tree Root header structure.
352    *  
353    *  Input:   RootPtr   - a pointer to an ubi_btRoot structure to be
354    *                       initialized.   
355    *           CompFunc  - a pointer to a comparison function that will be used
356    *                       whenever nodes in the tree must be compared against
357    *                       outside values.
358    *           Flags     - One bytes worth of flags.  Flags include
359    *                       ubi_trOVERWRITE and ubi_trDUPKEY.  See the header
360    *                       file for more info.
361    *
362    *  Output:  a pointer to the initialized ubi_btRoot structure (ie. the
363    *           same value as RootPtr).
364    * 
365    *  Note:    The interface to this function has changed from that of 
366    *           previous versions.  The <Flags> parameter replaces two      
367    *           boolean parameters that had the same basic effect.
368    * ------------------------------------------------------------------------ **
369    */
370
371 ubi_trBool ubi_btInsert( ubi_btRootPtr  RootPtr,
372                          ubi_btNodePtr  NewNode,
373                          ubi_btItemPtr  ItemPtr,
374                          ubi_btNodePtr *OldNode );
375   /* ------------------------------------------------------------------------ **
376    * This function uses a non-recursive algorithm to add a new element to the
377    * tree.
378    *
379    *  Input:   RootPtr  -  a pointer to the ubi_btRoot structure that indicates
380    *                       the root of the tree to which NewNode is to be added.
381    *           NewNode  -  a pointer to an ubi_btNode structure that is NOT
382    *                       part of any tree.
383    *           ItemPtr  -  A pointer to the sort key that is stored within
384    *                       *NewNode.  ItemPtr MUST point to information stored
385    *                       in *NewNode or an EXACT DUPLICATE.  The key data
386    *                       indicated by ItemPtr is used to place the new node
387    *                       into the tree.
388    *           OldNode  -  a pointer to an ubi_btNodePtr.  When searching
389    *                       the tree, a duplicate node may be found.  If
390    *                       duplicates are allowed, then the new node will
391    *                       be simply placed into the tree.  If duplicates
392    *                       are not allowed, however, then one of two things
393    *                       may happen.
394    *                       1) if overwritting *is not* allowed, this
395    *                          function will return FALSE (indicating that
396    *                          the new node could not be inserted), and
397    *                          *OldNode will point to the duplicate that is
398    *                          still in the tree.
399    *                       2) if overwritting *is* allowed, then this
400    *                          function will swap **OldNode for *NewNode.
401    *                          In this case, *OldNode will point to the node
402    *                          that was removed (thus allowing you to free
403    *                          the node).
404    *                          **  If you are using overwrite mode, ALWAYS  **
405    *                          ** check the return value of this parameter! **
406    *                 Note: You may pass NULL in this parameter, the
407    *                       function knows how to cope.  If you do this,
408    *                       however, there will be no way to return a
409    *                       pointer to an old (ie. replaced) node (which is
410    *                       a problem if you are using overwrite mode).
411    *
412    *  Output:  a boolean value indicating success or failure.  The function
413    *           will return FALSE if the node could not be added to the tree.
414    *           Such failure will only occur if duplicates are not allowed,
415    *           nodes cannot be overwritten, AND a duplicate key was found
416    *           within the tree.
417    * ------------------------------------------------------------------------ **
418    */
419
420 ubi_btNodePtr ubi_btRemove( ubi_btRootPtr RootPtr,
421                             ubi_btNodePtr DeadNode );
422   /* ------------------------------------------------------------------------ **
423    * This function removes the indicated node from the tree.
424    *
425    *  Input:   RootPtr  -  A pointer to the header of the tree that contains
426    *                       the node to be removed.
427    *           DeadNode -  A pointer to the node that will be removed.
428    *
429    *  Output:  This function returns a pointer to the node that was removed
430    *           from the tree (ie. the same as DeadNode).
431    *
432    *  Note:    The node MUST be in the tree indicated by RootPtr.  If not,
433    *           strange and evil things will happen to your trees.
434    * ------------------------------------------------------------------------ **
435    */
436
437 ubi_btNodePtr ubi_btLocate( ubi_btRootPtr RootPtr,
438                             ubi_btItemPtr FindMe,
439                             ubi_trCompOps CompOp );
440   /* ------------------------------------------------------------------------ **
441    * The purpose of ubi_btLocate() is to find a node or set of nodes given
442    * a target value and a "comparison operator".  The Locate() function is
443    * more flexible and (in the case of trees that may contain dupicate keys)
444    * more precise than the ubi_btFind() function.  The latter is faster,
445    * but it only searches for exact matches and, if the tree contains
446    * duplicates, Find() may return a pointer to any one of the duplicate-
447    * keyed records.
448    *
449    *  Input:
450    *     RootPtr  -  A pointer to the header of the tree to be searched.
451    *     FindMe   -  An ubi_btItemPtr that indicates the key for which to
452    *                 search.
453    *     CompOp   -  One of the following:
454    *                    CompOp     Return a pointer to the node with
455    *                    ------     ---------------------------------
456    *                   ubi_trLT - the last key value that is less
457    *                              than FindMe.
458    *                   ubi_trLE - the first key matching FindMe, or
459    *                              the last key that is less than
460    *                              FindMe.
461    *                   ubi_trEQ - the first key matching FindMe.
462    *                   ubi_trGE - the first key matching FindMe, or the
463    *                              first key greater than FindMe.
464    *                   ubi_trGT - the first key greater than FindMe.
465    *  Output:
466    *     A pointer to the node matching the criteria listed above under
467    *     CompOp, or NULL if no node matched the criteria.
468    *
469    *  Notes:
470    *     In the case of trees with duplicate keys, Locate() will behave as
471    *     follows:
472    *
473    *     Find:  3                       Find: 3
474    *     Keys:  1 2 2 2 3 3 3 3 3 4 4   Keys: 1 1 2 2 2 4 4 5 5 5 6
475    *                  ^ ^         ^                   ^ ^
476    *                 LT EQ        GT                 LE GE
477    *
478    *     That is, when returning a pointer to a node with a key that is LESS
479    *     THAN the target key (FindMe), Locate() will return a pointer to the
480    *     LAST matching node.
481    *     When returning a pointer to a node with a key that is GREATER
482    *     THAN the target key (FindMe), Locate() will return a pointer to the
483    *     FIRST matching node.
484    *
485    *  See Also: ubi_btFind(), ubi_btFirstOf(), ubi_btLastOf().
486    * ------------------------------------------------------------------------ **
487    */
488
489 ubi_btNodePtr ubi_btFind( ubi_btRootPtr RootPtr,
490                           ubi_btItemPtr FindMe );
491   /* ------------------------------------------------------------------------ **
492    * This function performs a non-recursive search of a tree for any node
493    * matching a specific key.
494    *
495    *  Input:
496    *     RootPtr  -  a pointer to the header of the tree to be searched.
497    *     FindMe   -  a pointer to the key value for which to search.
498    *
499    *  Output:
500    *     A pointer to a node with a key that matches the key indicated by
501    *     FindMe, or NULL if no such node was found.
502    *
503    *  Note:   In a tree that allows duplicates, the pointer returned *might
504    *          not* point to the (sequentially) first occurance of the
505    *          desired key.  In such a tree, it may be more useful to use
506    *          ubi_btLocate().
507    * ------------------------------------------------------------------------ **
508    */
509
510 ubi_btNodePtr ubi_btNext( ubi_btNodePtr P );
511   /* ------------------------------------------------------------------------ **
512    * Given the node indicated by P, find the (sorted order) Next node in the
513    * tree.
514    *  Input:   P  -  a pointer to a node that exists in a binary tree.
515    *  Output:  A pointer to the "next" node in the tree, or NULL if P pointed
516    *           to the "last" node in the tree or was NULL.
517    * ------------------------------------------------------------------------ **
518    */
519
520 ubi_btNodePtr ubi_btPrev( ubi_btNodePtr P );
521   /* ------------------------------------------------------------------------ **
522    * Given the node indicated by P, find the (sorted order) Previous node in
523    * the tree.
524    *  Input:   P  -  a pointer to a node that exists in a binary tree.
525    *  Output:  A pointer to the "previous" node in the tree, or NULL if P
526    *           pointed to the "first" node in the tree or was NULL.
527    * ------------------------------------------------------------------------ **
528    */
529
530 ubi_btNodePtr ubi_btFirst( ubi_btNodePtr P );
531   /* ------------------------------------------------------------------------ **
532    * Given the node indicated by P, find the (sorted order) First node in the
533    * subtree of which *P is the root.
534    *  Input:   P  -  a pointer to a node that exists in a binary tree.
535    *  Output:  A pointer to the "first" node in a subtree that has *P as its
536    *           root.  This function will return NULL only if P is NULL.
537    *  Note:    In general, you will be passing in the value of the root field
538    *           of an ubi_btRoot structure.
539    * ------------------------------------------------------------------------ **
540    */
541
542 ubi_btNodePtr ubi_btLast( ubi_btNodePtr P );
543   /* ------------------------------------------------------------------------ **
544    * Given the node indicated by P, find the (sorted order) Last node in the
545    * subtree of which *P is the root.
546    *  Input:   P  -  a pointer to a node that exists in a binary tree.
547    *  Output:  A pointer to the "last" node in a subtree that has *P as its
548    *           root.  This function will return NULL only if P is NULL.
549    *  Note:    In general, you will be passing in the value of the root field
550    *           of an ubi_btRoot structure.
551    * ------------------------------------------------------------------------ **
552    */
553
554 ubi_btNodePtr ubi_btFirstOf( ubi_btRootPtr RootPtr,
555                              ubi_btItemPtr MatchMe,
556                              ubi_btNodePtr p );
557   /* ------------------------------------------------------------------------ **
558    * Given a tree that a allows duplicate keys, and a pointer to a node in
559    * the tree, this function will return a pointer to the first (traversal
560    * order) node with the same key value.
561    *
562    *  Input:  RootPtr - A pointer to the root of the tree.
563    *          MatchMe - A pointer to the key value.  This should probably
564    *                    point to the key within node *p.
565    *          p       - A pointer to a node in the tree.
566    *  Output: A pointer to the first node in the set of nodes with keys
567    *          matching <FindMe>.
568    *  Notes:  Node *p MUST be in the set of nodes with keys matching
569    *          <FindMe>.  If not, this function will return NULL.
570    * ------------------------------------------------------------------------ **
571    */
572
573 ubi_btNodePtr ubi_btLastOf( ubi_btRootPtr RootPtr,
574                             ubi_btItemPtr MatchMe,
575                             ubi_btNodePtr p );
576   /* ------------------------------------------------------------------------ **
577    * Given a tree that a allows duplicate keys, and a pointer to a node in
578    * the tree, this function will return a pointer to the last (traversal
579    * order) node with the same key value.
580    *
581    *  Input:  RootPtr - A pointer to the root of the tree.
582    *          MatchMe - A pointer to the key value.  This should probably
583    *                    point to the key within node *p.
584    *          p       - A pointer to a node in the tree.
585    *  Output: A pointer to the last node in the set of nodes with keys
586    *          matching <FindMe>.
587    *  Notes:  Node *p MUST be in the set of nodes with keys matching
588    *          <FindMe>.  If not, this function will return NULL.
589    * ------------------------------------------------------------------------ **
590    */
591
592 ubi_trBool ubi_btTraverse( ubi_btRootPtr   RootPtr,
593                            ubi_btActionRtn EachNode,
594                            void           *UserData );
595   /* ------------------------------------------------------------------------ **
596    * Traverse a tree in sorted order (non-recursively).  At each node, call
597    * (*EachNode)(), passing a pointer to the current node, and UserData as the
598    * second parameter.
599    *  Input:   RootPtr  -  a pointer to an ubi_btRoot structure that indicates
600    *                       the tree to be traversed.
601    *           EachNode -  a pointer to a function to be called at each node
602    *                       as the node is visited.
603    *           UserData -  a generic pointer that may point to anything that
604    *                       you choose.
605    *  Output:  A boolean value.  FALSE if the tree is empty, otherwise TRUE.
606    * ------------------------------------------------------------------------ **
607    */
608
609 ubi_trBool ubi_btKillTree( ubi_btRootPtr     RootPtr,
610                            ubi_btKillNodeRtn FreeNode );
611   /* ------------------------------------------------------------------------ **
612    * Delete an entire tree (non-recursively) and reinitialize the ubi_btRoot
613    * structure.  Note that this function will return FALSE if either parameter
614    * is NULL.
615    *
616    *  Input:   RootPtr  -  a pointer to an ubi_btRoot structure that indicates
617    *                       the root of the tree to delete.
618    *           FreeNode -  a function that will be called for each node in the
619    *                       tree to deallocate the memory used by the node.
620    *
621    *  Output:  A boolean value.  FALSE if either input parameter was NULL, else
622    *           TRUE.
623    *
624    * ------------------------------------------------------------------------ **
625    */
626
627 ubi_btNodePtr ubi_btLeafNode( ubi_btNodePtr leader );
628   /* ------------------------------------------------------------------------ **
629    * Returns a pointer to a leaf node.
630    *
631    *  Input:  leader  - Pointer to a node at which to start the descent.
632    *
633    *  Output: A pointer to a leaf node selected in a somewhat arbitrary
634    *          manner.
635    *
636    *  Notes:  I wrote this function because I was using splay trees as a
637    *          database cache.  The cache had a maximum size on it, and I
638    *          needed a way of choosing a node to sacrifice if the cache
639    *          became full.  In a splay tree, less recently accessed nodes
640    *          tend toward the bottom of the tree, meaning that leaf nodes
641    *          are good candidates for removal.  (I really can't think of
642    *          any other reason to use this function.)
643    *        + In a simple binary tree or an AVL tree, the most recently
644    *          added nodes tend to be nearer the bottom, making this a *bad*
645    *          way to choose which node to remove from the cache.
646    *        + Randomizing the traversal order is probably a good idea.  You
647    *          can improve the randomization of leaf node selection by passing
648    *          in pointers to nodes other than the root node each time.  A
649    *          pointer to any node in the tree will do.  Of course, if you
650    *          pass a pointer to a leaf node you'll get the same thing back.
651    *        + If using a splay tree, splaying the tree will tend to randomize
652    *          things a bit too.  See ubi_SplayTree for more info.
653    *
654    * ------------------------------------------------------------------------ **
655    */
656
657
658 int ubi_btModuleID( int size, char *list[] );
659   /* ------------------------------------------------------------------------ **
660    * Returns a set of strings that identify the module.
661    *
662    *  Input:  size  - The number of elements in the array <list>.
663    *          list  - An array of pointers of type (char *).  This array
664    *                  should, initially, be empty.  This function will fill
665    *                  in the array with pointers to strings.
666    *  Output: The number of elements of <list> that were used.  If this value
667    *          is less than <size>, the values of the remaining elements are
668    *          not guaranteed.
669    *
670    *  Notes:  Please keep in mind that the pointers returned indicate strings
671    *          stored in static memory.  Don't free() them, don't write over
672    *          them, etc.  Just read them.
673    * ------------------------------------------------------------------------ **
674    */
675
676 /* -------------------------------------------------------------------------- **
677  * Masquarade...
678  *
679  * This set of defines allows you to write programs that will use any of the
680  * implemented binary tree modules (currently BinTree, AVLtree, and SplayTree).
681  * Instead of using ubi_bt..., use ubi_tr..., and select the tree type by
682  * including the appropriate module header.
683  */
684
685 #define ubi_trItemPtr ubi_btItemPtr
686
687 #define ubi_trNode    ubi_btNode
688 #define ubi_trNodePtr ubi_btNodePtr
689
690 #define ubi_trRoot    ubi_btRoot
691 #define ubi_trRootPtr ubi_btRootPtr
692
693 #define ubi_trCompFunc    ubi_btCompFunc
694 #define ubi_trActionRtn   ubi_btActionRtn
695 #define ubi_trKillNodeRtn ubi_btKillNodeRtn
696
697 #define ubi_trSgn( x ) ubi_btSgn( x )
698
699 #define ubi_trInitNode( Np ) ubi_btInitNode( (ubi_btNodePtr)(Np) )
700
701 #define ubi_trInitTree( Rp, Cf, Fl ) \
702         ubi_btInitTree( (ubi_btRootPtr)(Rp), (ubi_btCompFunc)(Cf), (Fl) )
703
704 #define ubi_trInsert( Rp, Nn, Ip, On ) \
705         ubi_btInsert( (ubi_btRootPtr)(Rp), (ubi_btNodePtr)(Nn), \
706                       (ubi_btItemPtr)(Ip), (ubi_btNodePtr *)(On) )
707
708 #define ubi_trRemove( Rp, Dn ) \
709         ubi_btRemove( (ubi_btRootPtr)(Rp), (ubi_btNodePtr)(Dn) )
710
711 #define ubi_trLocate( Rp, Ip, Op ) \
712         ubi_btLocate( (ubi_btRootPtr)(Rp), \
713                       (ubi_btItemPtr)(Ip), \
714                       (ubi_trCompOps)(Op) )
715
716 #define ubi_trFind( Rp, Ip ) \
717         ubi_btFind( (ubi_btRootPtr)(Rp), (ubi_btItemPtr)(Ip) )
718
719 #define ubi_trNext( P ) ubi_btNext( (ubi_btNodePtr)(P) )
720
721 #define ubi_trPrev( P ) ubi_btPrev( (ubi_btNodePtr)(P) )
722
723 #define ubi_trFirst( P ) ubi_btFirst( (ubi_btNodePtr)(P) )
724
725 #define ubi_trLast( P ) ubi_btLast( (ubi_btNodePtr)(P) )
726
727 #define ubi_trFirstOf( Rp, Ip, P ) \
728         ubi_btFirstOf( (ubi_btRootPtr)(Rp), \
729                        (ubi_btItemPtr)(Ip), \
730                        (ubi_btNodePtr)(P) )
731
732 #define ubi_trLastOf( Rp, Ip, P ) \
733         ubi_btLastOf( (ubi_btRootPtr)(Rp), \
734                       (ubi_btItemPtr)(Ip), \
735                       (ubi_btNodePtr)(P) )
736
737 #define ubi_trTraverse( Rp, En, Ud ) \
738         ubi_btTraverse((ubi_btRootPtr)(Rp), (ubi_btActionRtn)(En), (void *)(Ud))
739
740 #define ubi_trKillTree( Rp, Fn ) \
741         ubi_btKillTree( (ubi_btRootPtr)(Rp), (ubi_btKillNodeRtn)(Fn) )
742
743 #define ubi_trLeafNode( Nd ) \
744         ubi_btLeafNode( (ubi_btNodePtr)(Nd) )
745
746 #define ubi_trModuleID( s, l ) ubi_btModuleID( s, l )
747
748 /* ========================================================================== */
749 #endif /* ubi_BinTree_H */