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 | |
b3641a6e DD |
40 | #ifdef HAVE_STDINT_H |
41 | #include <stdint.h> | |
96d86ee3 | 42 | #endif |
b3641a6e DD |
43 | #ifdef HAVE_INTTYPES_H |
44 | #include <inttypes.h> | |
d2df793a NC |
45 | #endif |
46 | ||
32b5d301 DD |
47 | #ifndef GTY |
48 | #define GTY(X) | |
49 | #endif | |
50 | ||
252b5132 RH |
51 | /* Use typedefs for the key and data types to facilitate changing |
52 | these types, if necessary. These types should be sufficiently wide | |
53 | that any pointer or scalar can be cast to these types, and then | |
54 | cast back, without loss of precision. */ | |
b3641a6e DD |
55 | typedef uintptr_t splay_tree_key; |
56 | typedef uintptr_t splay_tree_value; | |
252b5132 RH |
57 | |
58 | /* Forward declaration for a node in the tree. */ | |
cc89ffe6 | 59 | typedef struct splay_tree_node_s *splay_tree_node; |
252b5132 RH |
60 | |
61 | /* The type of a function which compares two splay-tree keys. The | |
62 | function should return values as for qsort. */ | |
1e45deed | 63 | typedef int (*splay_tree_compare_fn) (splay_tree_key, splay_tree_key); |
252b5132 RH |
64 | |
65 | /* The type of a function used to deallocate any resources associated | |
66 | with the key. */ | |
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 | |
70 | with the value. */ | |
1e45deed | 71 | typedef void (*splay_tree_delete_value_fn) (splay_tree_value); |
252b5132 RH |
72 | |
73 | /* The type of a function used to iterate over the tree. */ | |
1e45deed | 74 | typedef int (*splay_tree_foreach_fn) (splay_tree_node, void*); |
252b5132 | 75 | |
2bbcdae9 JB |
76 | /* The type of a function used to allocate memory for tree root and |
77 | node structures. The first argument is the number of bytes needed; | |
78 | the second is a data pointer the splay tree functions pass through | |
79 | to the allocator. This function must never return zero. */ | |
a288642d | 80 | typedef void *(*splay_tree_allocate_fn) (int, void *); |
2bbcdae9 JB |
81 | |
82 | /* The type of a function used to free memory allocated using the | |
83 | corresponding splay_tree_allocate_fn. The first argument is the | |
84 | memory to be freed; the latter is a data pointer the splay tree | |
85 | functions pass through to the freer. */ | |
1e45deed | 86 | typedef void (*splay_tree_deallocate_fn) (void *, void *); |
2bbcdae9 | 87 | |
252b5132 | 88 | /* The nodes in the splay tree. */ |
167bdac1 | 89 | struct GTY(()) splay_tree_node_s { |
252b5132 | 90 | /* The key. */ |
f29d4bb8 | 91 | splay_tree_key GTY ((use_param1)) key; |
252b5132 RH |
92 | |
93 | /* The value. */ | |
f29d4bb8 | 94 | splay_tree_value GTY ((use_param2)) value; |
252b5132 RH |
95 | |
96 | /* The left and right children, respectively. */ | |
f29d4bb8 DD |
97 | splay_tree_node GTY ((use_params)) left; |
98 | splay_tree_node GTY ((use_params)) right; | |
252b5132 RH |
99 | }; |
100 | ||
101 | /* The splay tree itself. */ | |
167bdac1 | 102 | struct GTY(()) splay_tree_s { |
252b5132 | 103 | /* The root of the tree. */ |
f29d4bb8 | 104 | splay_tree_node GTY ((use_params)) root; |
252b5132 RH |
105 | |
106 | /* The comparision function. */ | |
107 | splay_tree_compare_fn comp; | |
108 | ||
109 | /* The deallocate-key function. NULL if no cleanup is necessary. */ | |
110 | splay_tree_delete_key_fn delete_key; | |
111 | ||
112 | /* The deallocate-value function. NULL if no cleanup is necessary. */ | |
113 | splay_tree_delete_value_fn delete_value; | |
2bbcdae9 | 114 | |
219a461e | 115 | /* Node allocate function. Takes allocate_data as a parameter. */ |
2bbcdae9 | 116 | splay_tree_allocate_fn allocate; |
219a461e DD |
117 | |
118 | /* Free function for nodes and trees. Takes allocate_data as a parameter. */ | |
2bbcdae9 | 119 | splay_tree_deallocate_fn deallocate; |
219a461e DD |
120 | |
121 | /* Parameter for allocate/free functions. */ | |
a288642d | 122 | void * GTY((skip)) allocate_data; |
32b5d301 | 123 | }; |
31a55cbe | 124 | |
32b5d301 | 125 | typedef struct splay_tree_s *splay_tree; |
252b5132 | 126 | |
31a55cbe DD |
127 | extern splay_tree splay_tree_new (splay_tree_compare_fn, |
128 | splay_tree_delete_key_fn, | |
129 | splay_tree_delete_value_fn); | |
1e45deed | 130 | extern splay_tree splay_tree_new_with_allocator (splay_tree_compare_fn, |
31a55cbe DD |
131 | splay_tree_delete_key_fn, |
132 | splay_tree_delete_value_fn, | |
133 | splay_tree_allocate_fn, | |
134 | splay_tree_deallocate_fn, | |
135 | void *); | |
219a461e DD |
136 | extern splay_tree splay_tree_new_typed_alloc (splay_tree_compare_fn, |
137 | splay_tree_delete_key_fn, | |
138 | splay_tree_delete_value_fn, | |
139 | splay_tree_allocate_fn, | |
140 | splay_tree_allocate_fn, | |
141 | splay_tree_deallocate_fn, | |
142 | void *); | |
31a55cbe | 143 | extern void splay_tree_delete (splay_tree); |
1e45deed | 144 | extern splay_tree_node splay_tree_insert (splay_tree, |
31a55cbe DD |
145 | splay_tree_key, |
146 | splay_tree_value); | |
1e45deed DD |
147 | extern void splay_tree_remove (splay_tree, splay_tree_key); |
148 | extern splay_tree_node splay_tree_lookup (splay_tree, splay_tree_key); | |
149 | extern splay_tree_node splay_tree_predecessor (splay_tree, splay_tree_key); | |
150 | extern splay_tree_node splay_tree_successor (splay_tree, splay_tree_key); | |
151 | extern splay_tree_node splay_tree_max (splay_tree); | |
152 | extern splay_tree_node splay_tree_min (splay_tree); | |
153 | extern int splay_tree_foreach (splay_tree, splay_tree_foreach_fn, void*); | |
154 | extern int splay_tree_compare_ints (splay_tree_key, splay_tree_key); | |
155 | extern int splay_tree_compare_pointers (splay_tree_key, splay_tree_key); | |
31a55cbe | 156 | |
252b5132 RH |
157 | #ifdef __cplusplus |
158 | } | |
159 | #endif /* __cplusplus */ | |
160 | ||
161 | #endif /* _SPLAY_TREE_H */ |