Commit | Line | Data |
---|---|---|
252b5132 | 1 | /* A splay-tree datatype. |
82704155 | 2 | Copyright (C) 1998-2019 Free Software Foundation, Inc. |
252b5132 RH |
3 | Contributed by Mark Mitchell (mark@markmitchell.com). |
4 | ||
d2df793a | 5 | This file is part of GCC. |
252b5132 | 6 | |
d2df793a NC |
7 | GCC is free software; you can redistribute it and/or modify it |
8 | under the terms of the GNU General Public License as published by | |
9 | the Free Software Foundation; either version 2, or (at your option) | |
10 | any later version. | |
252b5132 | 11 | |
d2df793a NC |
12 | GCC is distributed in the hope that it will be useful, but |
13 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
15 | General Public License for more details. | |
252b5132 | 16 | |
d2df793a NC |
17 | You should have received a copy of the GNU General Public License |
18 | along with GCC; see the file COPYING. If not, write to | |
19 | the Free Software Foundation, 51 Franklin Street - Fifth Floor, | |
20 | Boston, MA 02110-1301, USA. */ | |
252b5132 RH |
21 | |
22 | /* For an easily readable description of splay-trees, see: | |
23 | ||
24 | Lewis, Harry R. and Denenberg, Larry. Data Structures and Their | |
25 | Algorithms. Harper-Collins, Inc. 1991. | |
26 | ||
27 | The major feature of splay trees is that all basic tree operations | |
28 | are amortized O(log n) time for a tree with n nodes. */ | |
29 | ||
30 | #ifndef _SPLAY_TREE_H | |
31 | #define _SPLAY_TREE_H | |
32 | ||
33 | #ifdef __cplusplus | |
34 | extern "C" { | |
35 | #endif /* __cplusplus */ | |
36 | ||
007425f1 | 37 | #include "ansidecl.h" |
252b5132 | 38 | |
b3641a6e DD |
39 | #ifdef HAVE_STDINT_H |
40 | #include <stdint.h> | |
96d86ee3 | 41 | #endif |
b3641a6e DD |
42 | #ifdef HAVE_INTTYPES_H |
43 | #include <inttypes.h> | |
d2df793a NC |
44 | #endif |
45 | ||
252b5132 RH |
46 | /* Use typedefs for the key and data types to facilitate changing |
47 | these types, if necessary. These types should be sufficiently wide | |
48 | that any pointer or scalar can be cast to these types, and then | |
49 | cast back, without loss of precision. */ | |
b3641a6e DD |
50 | typedef uintptr_t splay_tree_key; |
51 | typedef uintptr_t splay_tree_value; | |
252b5132 RH |
52 | |
53 | /* Forward declaration for a node in the tree. */ | |
cc89ffe6 | 54 | typedef struct splay_tree_node_s *splay_tree_node; |
252b5132 RH |
55 | |
56 | /* The type of a function which compares two splay-tree keys. The | |
57 | function should return values as for qsort. */ | |
1e45deed | 58 | typedef int (*splay_tree_compare_fn) (splay_tree_key, splay_tree_key); |
252b5132 RH |
59 | |
60 | /* The type of a function used to deallocate any resources associated | |
e2077304 | 61 | with the key. If you provide this function, the splay tree |
62 | will take the ownership of the memory of the splay_tree_key arg | |
63 | of splay_tree_insert. This function is called to release the keys | |
64 | present in the tree when calling splay_tree_delete or splay_tree_remove. | |
65 | If splay_tree_insert is called with a key equal to a key already | |
66 | present in the tree, the old key and old value will be released. */ | |
1e45deed | 67 | typedef void (*splay_tree_delete_key_fn) (splay_tree_key); |
252b5132 RH |
68 | |
69 | /* The type of a function used to deallocate any resources associated | |
e2077304 | 70 | with the value. If you provide this function, the memory of the |
71 | splay_tree_value arg of splay_tree_insert is managed similarly to | |
72 | the splay_tree_key memory: see splay_tree_delete_key_fn. */ | |
1e45deed | 73 | typedef void (*splay_tree_delete_value_fn) (splay_tree_value); |
252b5132 RH |
74 | |
75 | /* The type of a function used to iterate over the tree. */ | |
1e45deed | 76 | typedef int (*splay_tree_foreach_fn) (splay_tree_node, void*); |
252b5132 | 77 | |
2bbcdae9 JB |
78 | /* The type of a function used to allocate memory for tree root and |
79 | node structures. The first argument is the number of bytes needed; | |
80 | the second is a data pointer the splay tree functions pass through | |
81 | to the allocator. This function must never return zero. */ | |
a288642d | 82 | typedef void *(*splay_tree_allocate_fn) (int, void *); |
2bbcdae9 JB |
83 | |
84 | /* The type of a function used to free memory allocated using the | |
85 | corresponding splay_tree_allocate_fn. The first argument is the | |
86 | memory to be freed; the latter is a data pointer the splay tree | |
87 | functions pass through to the freer. */ | |
1e45deed | 88 | typedef void (*splay_tree_deallocate_fn) (void *, void *); |
2bbcdae9 | 89 | |
252b5132 | 90 | /* The nodes in the splay tree. */ |
d0270d8c | 91 | struct splay_tree_node_s { |
252b5132 | 92 | /* The key. */ |
d0270d8c | 93 | splay_tree_key key; |
252b5132 RH |
94 | |
95 | /* The value. */ | |
d0270d8c | 96 | splay_tree_value value; |
252b5132 RH |
97 | |
98 | /* The left and right children, respectively. */ | |
d0270d8c L |
99 | splay_tree_node left; |
100 | splay_tree_node right; | |
252b5132 RH |
101 | }; |
102 | ||
103 | /* The splay tree itself. */ | |
d0270d8c | 104 | struct splay_tree_s { |
252b5132 | 105 | /* The root of the tree. */ |
d0270d8c | 106 | splay_tree_node root; |
252b5132 RH |
107 | |
108 | /* The comparision function. */ | |
109 | splay_tree_compare_fn comp; | |
110 | ||
111 | /* The deallocate-key function. NULL if no cleanup is necessary. */ | |
112 | splay_tree_delete_key_fn delete_key; | |
113 | ||
114 | /* The deallocate-value function. NULL if no cleanup is necessary. */ | |
115 | splay_tree_delete_value_fn delete_value; | |
2bbcdae9 | 116 | |
219a461e | 117 | /* Node allocate function. Takes allocate_data as a parameter. */ |
2bbcdae9 | 118 | splay_tree_allocate_fn allocate; |
219a461e DD |
119 | |
120 | /* Free function for nodes and trees. Takes allocate_data as a parameter. */ | |
2bbcdae9 | 121 | splay_tree_deallocate_fn deallocate; |
219a461e DD |
122 | |
123 | /* Parameter for allocate/free functions. */ | |
d0270d8c | 124 | void *allocate_data; |
32b5d301 | 125 | }; |
31a55cbe | 126 | |
32b5d301 | 127 | typedef struct splay_tree_s *splay_tree; |
252b5132 | 128 | |
31a55cbe DD |
129 | extern splay_tree splay_tree_new (splay_tree_compare_fn, |
130 | splay_tree_delete_key_fn, | |
131 | splay_tree_delete_value_fn); | |
1e45deed | 132 | extern splay_tree splay_tree_new_with_allocator (splay_tree_compare_fn, |
31a55cbe DD |
133 | splay_tree_delete_key_fn, |
134 | splay_tree_delete_value_fn, | |
135 | splay_tree_allocate_fn, | |
136 | splay_tree_deallocate_fn, | |
137 | void *); | |
219a461e DD |
138 | extern splay_tree splay_tree_new_typed_alloc (splay_tree_compare_fn, |
139 | splay_tree_delete_key_fn, | |
140 | splay_tree_delete_value_fn, | |
141 | splay_tree_allocate_fn, | |
142 | splay_tree_allocate_fn, | |
143 | splay_tree_deallocate_fn, | |
144 | void *); | |
31a55cbe | 145 | extern void splay_tree_delete (splay_tree); |
1e45deed | 146 | extern splay_tree_node splay_tree_insert (splay_tree, |
31a55cbe DD |
147 | splay_tree_key, |
148 | splay_tree_value); | |
1e45deed DD |
149 | extern void splay_tree_remove (splay_tree, splay_tree_key); |
150 | extern splay_tree_node splay_tree_lookup (splay_tree, splay_tree_key); | |
151 | extern splay_tree_node splay_tree_predecessor (splay_tree, splay_tree_key); | |
152 | extern splay_tree_node splay_tree_successor (splay_tree, splay_tree_key); | |
153 | extern splay_tree_node splay_tree_max (splay_tree); | |
154 | extern splay_tree_node splay_tree_min (splay_tree); | |
155 | extern int splay_tree_foreach (splay_tree, splay_tree_foreach_fn, void*); | |
156 | extern int splay_tree_compare_ints (splay_tree_key, splay_tree_key); | |
22467434 | 157 | extern int splay_tree_compare_pointers (splay_tree_key, splay_tree_key); |
158 | extern int splay_tree_compare_strings (splay_tree_key, splay_tree_key); | |
159 | extern void splay_tree_delete_pointers (splay_tree_value); | |
31a55cbe | 160 | |
252b5132 RH |
161 | #ifdef __cplusplus |
162 | } | |
163 | #endif /* __cplusplus */ | |
164 | ||
165 | #endif /* _SPLAY_TREE_H */ |