1 /* A splay-tree datatype. 2 Copyright 1998, 1999, 2000, 2002, 2007 Free Software Foundation, Inc. 3 Contributed by Mark Mitchell (mark (at) markmitchell.com). 4 5 This file is part of GCC. 6 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. 11 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. 16 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. */ 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 37 #include "ansidecl.h" 38 39 #ifndef _WIN64 40 typedef unsigned long int libi_uhostptr_t; 41 typedef long int libi_shostptr_t; 42 #else 43 typedef unsigned long long libi_uhostptr_t; 44 typedef long long libi_shostptr_t; 45 #endif 46 47 #ifndef GTY 48 #define GTY(X) 49 #endif 50 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. */ 55 typedef libi_uhostptr_t splay_tree_key; 56 typedef libi_uhostptr_t splay_tree_value; 57 58 /* Forward declaration for a node in the tree. */ 59 typedef struct splay_tree_node_s *splay_tree_node; 60 61 /* The type of a function which compares two splay-tree keys. The 62 function should return values as for qsort. */ 63 typedef int (*splay_tree_compare_fn) (splay_tree_key, splay_tree_key); 64 65 /* The type of a function used to deallocate any resources associated 66 with the key. */ 67 typedef void (*splay_tree_delete_key_fn) (splay_tree_key); 68 69 /* The type of a function used to deallocate any resources associated 70 with the value. */ 71 typedef void (*splay_tree_delete_value_fn) (splay_tree_value); 72 73 /* The type of a function used to iterate over the tree. */ 74 typedef int (*splay_tree_foreach_fn) (splay_tree_node, void*); 75 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. */ 80 typedef void *(*splay_tree_allocate_fn) (int, void *); 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. */ 86 typedef void (*splay_tree_deallocate_fn) (void *, void *); 87 88 /* The nodes in the splay tree. */ 89 struct splay_tree_node_s GTY(()) 90 { 91 /* The key. */ 92 splay_tree_key GTY ((use_param1)) key; 93 94 /* The value. */ 95 splay_tree_value GTY ((use_param2)) value; 96 97 /* The left and right children, respectively. */ 98 splay_tree_node GTY ((use_params)) left; 99 splay_tree_node GTY ((use_params)) right; 100 }; 101 102 /* The splay tree itself. */ 103 struct splay_tree_s GTY(()) 104 { 105 /* The root of the tree. */ 106 splay_tree_node GTY ((use_params)) root; 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; 116 117 /* Allocate/free functions, and a data pointer to pass to them. */ 118 splay_tree_allocate_fn allocate; 119 splay_tree_deallocate_fn deallocate; 120 void * GTY((skip)) allocate_data; 121 }; 122 123 typedef struct splay_tree_s *splay_tree; 124 125 extern splay_tree splay_tree_new (splay_tree_compare_fn, 126 splay_tree_delete_key_fn, 127 splay_tree_delete_value_fn); 128 extern splay_tree splay_tree_new_with_allocator (splay_tree_compare_fn, 129 splay_tree_delete_key_fn, 130 splay_tree_delete_value_fn, 131 splay_tree_allocate_fn, 132 splay_tree_deallocate_fn, 133 void *); 134 extern void splay_tree_delete (splay_tree); 135 extern splay_tree_node splay_tree_insert (splay_tree, 136 splay_tree_key, 137 splay_tree_value); 138 extern void splay_tree_remove (splay_tree, splay_tree_key); 139 extern splay_tree_node splay_tree_lookup (splay_tree, splay_tree_key); 140 extern splay_tree_node splay_tree_predecessor (splay_tree, splay_tree_key); 141 extern splay_tree_node splay_tree_successor (splay_tree, splay_tree_key); 142 extern splay_tree_node splay_tree_max (splay_tree); 143 extern splay_tree_node splay_tree_min (splay_tree); 144 extern int splay_tree_foreach (splay_tree, splay_tree_foreach_fn, void*); 145 extern int splay_tree_compare_ints (splay_tree_key, splay_tree_key); 146 extern int splay_tree_compare_pointers (splay_tree_key, splay_tree_key); 147 148 #ifdef __cplusplus 149 } 150 #endif /* __cplusplus */ 151 152 #endif /* _SPLAY_TREE_H */ 153
