include/splay-tree.h

   1 /* A splay-tree datatype.
   2    Copyright 1998, 1999, 2000, 2002, 2005, 2007, 2009
   3    Free Software Foundation, Inc.
   4    Contributed by Mark Mitchell (mark@markmitchell.com).
   5
   6    This file is part of GCC.
   7
   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.
  12
  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.
  17
  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.  */
  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
  38 #include "ansidecl.h"
  39
  40 #ifndef _WIN64
  41   typedef unsigned long int libi_uhostptr_t;
  42   typedef long int libi_shostptr_t;
  43 #else
  44   typedef unsigned long long libi_uhostptr_t;
  45   typedef long long libi_shostptr_t;
  46 #endif
  47
  48 #ifndef GTY
  49 #define GTY(X)
  50 #endif
  51
  52 /* Use typedefs for the key and data types to facilitate changing
  53    these types, if necessary.  These types should be sufficiently wide
  54    that any pointer or scalar can be cast to these types, and then
  55    cast back, without loss of precision.  */
  56 typedef libi_uhostptr_t splay_tree_key;
  57 typedef libi_uhostptr_t splay_tree_value;
  58
  59 /* Forward declaration for a node in the tree.  */
  60 typedef struct splay_tree_node_s *splay_tree_node;
  61
  62 /* The type of a function which compares two splay-tree keys.  The
  63    function should return values as for qsort.  */
  64 typedef int (*splay_tree_compare_fn) (splay_tree_key, splay_tree_key);
  65
  66 /* The type of a function used to deallocate any resources associated
  67    with the key.  */
  68 typedef void (*splay_tree_delete_key_fn) (splay_tree_key);
  69
  70 /* The type of a function used to deallocate any resources associated
  71    with the value.  */
  72 typedef void (*splay_tree_delete_value_fn) (splay_tree_value);
  73
  74 /* The type of a function used to iterate over the tree.  */
  75 typedef int (*splay_tree_foreach_fn) (splay_tree_node, void*);
  76
  77 /* The type of a function used to allocate memory for tree root and
  78    node structures.  The first argument is the number of bytes needed;
  79    the second is a data pointer the splay tree functions pass through
  80    to the allocator.  This function must never return zero.  */
  81 typedef void *(*splay_tree_allocate_fn) (int, void *);
  82
  83 /* The type of a function used to free memory allocated using the
  84    corresponding splay_tree_allocate_fn.  The first argument is the
  85    memory to be freed; the latter is a data pointer the splay tree
  86    functions pass through to the freer.  */
  87 typedef void (*splay_tree_deallocate_fn) (void *, void *);
  88
  89 /* The nodes in the splay tree.  */
  90 struct GTY(()) splay_tree_node_s {
  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 GTY(()) splay_tree_s {
 104   /* The root of the tree.  */
 105   splay_tree_node GTY ((use_params)) root;
 106
 107   /* The comparision function.  */
 108   splay_tree_compare_fn comp;
 109
 110   /* The deallocate-key function.  NULL if no cleanup is necessary.  */
 111   splay_tree_delete_key_fn delete_key;
 112
 113   /* The deallocate-value function.  NULL if no cleanup is necessary.  */
 114   splay_tree_delete_value_fn delete_value;
 115
 116   /* Allocate/free functions, and a data pointer to pass to them.  */
 117   splay_tree_allocate_fn allocate;
 118   splay_tree_deallocate_fn deallocate;
 119   void * GTY((skip)) allocate_data;
 120 };
 121
 122 typedef struct splay_tree_s *splay_tree;
 123
 124 extern splay_tree splay_tree_new (splay_tree_compare_fn,
 125                                   splay_tree_delete_key_fn,
 126                                   splay_tree_delete_value_fn);
 127 extern splay_tree splay_tree_new_with_allocator (splay_tree_compare_fn,
 128                                                  splay_tree_delete_key_fn,
 129                                                  splay_tree_delete_value_fn,
 130                                                  splay_tree_allocate_fn,
 131                                                  splay_tree_deallocate_fn,
 132                                                  void *);
 133 extern void splay_tree_delete (splay_tree);
 134 extern splay_tree_node splay_tree_insert (splay_tree,
 135                                           splay_tree_key,
 136                                           splay_tree_value);
 137 extern void splay_tree_remove   (splay_tree, splay_tree_key);
 138 extern splay_tree_node splay_tree_lookup (splay_tree, splay_tree_key);
 139 extern splay_tree_node splay_tree_predecessor (splay_tree, splay_tree_key);
 140 extern splay_tree_node splay_tree_successor (splay_tree, splay_tree_key);
 141 extern splay_tree_node splay_tree_max (splay_tree);
 142 extern splay_tree_node splay_tree_min (splay_tree);
 143 extern int splay_tree_foreach (splay_tree, splay_tree_foreach_fn, void*);
 144 extern int splay_tree_compare_ints (splay_tree_key, splay_tree_key);
 145 extern int splay_tree_compare_pointers (splay_tree_key, splay_tree_key);
 146
 147 #ifdef __cplusplus
 148 }
 149 #endif /* __cplusplus */
 150
 151 #endif /* _SPLAY_TREE_H */