Revert previous commit that contained an unrelated hunk.
[ffmpeg.git] / libavutil / tree.h
1 /*
2  * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg 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  * FFmpeg 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 FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #ifndef TREE_H
22 #define TREE_H
23
24 struct AVTreeNode;
25
26 /**
27  * Finds an element.
28  * @param root a pointer to the root node of the tree
29  * @param next if next is not NULL then next[0] will contain the previous element and
30  *             next[1] the next element if either doesnt exist then the corresponding
31  *             entry in next is unchanged
32  * @return an element with cmp(key, elem)==0 or NULL if no such element exists in
33  *         the tree
34  */
35 void *av_tree_find(const struct AVTreeNode *root, void *key, int (*cmp)(void *key, const void *b), void *next[2]);
36
37 /**
38  * Finds a element for which cmp(key, elem)==0, if no such element is found key
39  * is inserted into the tree.
40  * @param rootp a pointer to a pointer to the root node of the tree note the
41  *              root node can change during insertions, this is required to
42  *              keep the tree balanced
43  *
44  * @return if no insertion happened, the found element
45  *         if a insertion happened, then either key or NULL is returned (which it is
46  *         depends on the tree state and the implemenattion, you should make no
47  *         asumtations that its one or the other in code)
48  */
49 void *av_tree_insert(struct AVTreeNode **rootp, void *key, int (*cmp)(void *key, const void *b));
50 void av_tree_destroy(struct AVTreeNode *t);
51
52 #endif /* TREE_H */