tree.h: K&R formatting and typo cosmetics
[ffmpeg.git] / libavutil / tree.h
1 /*
2  * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of Libav.
5  *
6  * Libav is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * Libav is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /**
22  * @file
23  * A tree container.
24  * @author Michael Niedermayer <michaelni@gmx.at>
25  */
26
27 #ifndef AVUTIL_TREE_H
28 #define AVUTIL_TREE_H
29
30 #include "attributes.h"
31 #include "version.h"
32
33 /**
34  * @addtogroup lavu_tree AVTree
35  * @ingroup lavu_data
36  *
37  * Low-complexity tree container
38  *
39  * Insertion, removal, finding equal, largest which is smaller than and
40  * smallest which is larger than, all have O(log n) worst-case complexity.
41  * @{
42  */
43
44
45 struct AVTreeNode;
46 #if FF_API_CONTEXT_SIZE
47 extern attribute_deprecated const int av_tree_node_size;
48 #endif
49
50 /**
51  * Allocate an AVTreeNode.
52  */
53 struct AVTreeNode *av_tree_node_alloc(void);
54
55 /**
56  * Find an element.
57  * @param root a pointer to the root node of the tree
58  * @param next If next is not NULL, then next[0] will contain the previous
59  *             element and next[1] the next element. If either does not exist,
60  *             then the corresponding entry in next is unchanged.
61  * @return An element with cmp(key, elem) == 0 or NULL if no such element
62  *         exists in the tree.
63  */
64 void *av_tree_find(const struct AVTreeNode *root, void *key,
65                    int (*cmp)(void *key, const void *b), void *next[2]);
66
67 /**
68  * Insert or remove an element.
69  * If *next is NULL, then the supplied element will be removed if it exists.
70  * If *next is not NULL, then the supplied element will be inserted, unless
71  * it already exists in the tree.
72  * @param rootp A pointer to a pointer to the root node of the tree; note that
73  *              the root node can change during insertions, this is required
74  *              to keep the tree balanced.
75  * @param next Used to allocate and free AVTreeNodes. For insertion the user
76  *             must set it to an allocated and zeroed object of at least
77  *             av_tree_node_size bytes size. av_tree_insert() will set it to
78  *             NULL if it has been consumed.
79  *             For deleting elements *next is set to NULL by the user and
80  *             av_tree_node_size() will set it to the AVTreeNode which was
81  *             used for the removed element.
82  *             This allows the use of flat arrays, which have
83  *             lower overhead compared to many malloced elements.
84  *             You might want to define a function like:
85  *             @code
86  *             void *tree_insert(struct AVTreeNode **rootp, void *key,
87  *                               int (*cmp)(void *key, const void *b),
88  *                               AVTreeNode **next)
89  *             {
90  *                 if (!*next)
91  *                     *next = av_mallocz(av_tree_node_size);
92  *                 return av_tree_insert(rootp, key, cmp, next);
93  *             }
94  *             void *tree_remove(struct AVTreeNode **rootp, void *key,
95  *                               int (*cmp)(void *key, const void *b, AVTreeNode **next))
96  *             {
97  *                 av_freep(next);
98  *                 return av_tree_insert(rootp, key, cmp, next);
99  *             }
100  *             @endcode
101  * @return If no insertion happened, the found element; if an insertion or
102  *         removal happened, then either key or NULL will be returned.
103  *         Which one it is depends on the tree state and the implementation. You
104  *         should make no assumptions that it's one or the other in the code.
105  */
106 void *av_tree_insert(struct AVTreeNode **rootp, void *key,
107                      int (*cmp)(void *key, const void *b),
108                      struct AVTreeNode **next);
109
110 void av_tree_destroy(struct AVTreeNode *t);
111
112 /**
113  * Apply enu(opaque, &elem) to all the elements in the tree in a given range.
114  *
115  * @param cmp a comparison function that returns < 0 for a element below the
116  *            range, > 0 for a element above the range and == 0 for a
117  *            element inside the range
118  *
119  * @note The cmp function should use the same ordering used to construct the
120  *       tree.
121  */
122 void av_tree_enumerate(struct AVTreeNode *t, void *opaque,
123                        int (*cmp)(void *opaque, void *elem),
124                        int (*enu)(void *opaque, void *elem));
125
126 /**
127  * @}
128  */
129
130 #endif /* AVUTIL_TREE_H */