include/splay-tree.h

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