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