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