[thirdparty/gcc.git] / include / splay-tree.h

/* A splay-tree datatype.  
   Copyright 1998, 1999, 2000, 2002 Free Software Foundation, Inc.
   Contributed by Mark Mitchell (mark@markmitchell.com).

This file is part of GCC.
   
GCC is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GCC is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING.  If not, write to
the Free Software Foundation, 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */

/* For an easily readable description of splay-trees, see:

     Lewis, Harry R. and Denenberg, Larry.  Data Structures and Their
     Algorithms.  Harper-Collins, Inc.  1991.  

   The major feature of splay trees is that all basic tree operations
   are amortized O(log n) time for a tree with n nodes.  */

#ifndef _SPLAY_TREE_H
#define _SPLAY_TREE_H

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#include "ansidecl.h"

#ifndef GTY
#define GTY(X)
#endif

/* Use typedefs for the key and data types to facilitate changing
   these types, if necessary.  These types should be sufficiently wide
   that any pointer or scalar can be cast to these types, and then
   cast back, without loss of precision.  */
typedef unsigned long int splay_tree_key;
typedef unsigned long int splay_tree_value;

/* Forward declaration for a node in the tree.  */
typedef struct splay_tree_node_s *splay_tree_node;

/* The type of a function which compares two splay-tree keys.  The
   function should return values as for qsort.  */
typedef int (*splay_tree_compare_fn) PARAMS((splay_tree_key, splay_tree_key));

/* The type of a function used to deallocate any resources associated
   with the key.  */
typedef void (*splay_tree_delete_key_fn) PARAMS((splay_tree_key));

/* The type of a function used to deallocate any resources associated
   with the value.  */
typedef void (*splay_tree_delete_value_fn) PARAMS((splay_tree_value));

/* The type of a function used to iterate over the tree.  */
typedef int (*splay_tree_foreach_fn) PARAMS((splay_tree_node, void*));

/* The type of a function used to allocate memory for tree root and
   node structures.  The first argument is the number of bytes needed;
   the second is a data pointer the splay tree functions pass through
   to the allocator.  This function must never return zero.  */
typedef PTR (*splay_tree_allocate_fn) PARAMS((int, void *));

/* The type of a function used to free memory allocated using the
   corresponding splay_tree_allocate_fn.  The first argument is the
   memory to be freed; the latter is a data pointer the splay tree
   functions pass through to the freer.  */
typedef void (*splay_tree_deallocate_fn) PARAMS((void *, void *));

/* The nodes in the splay tree.  */
struct splay_tree_node_s GTY(())
{
  /* The key.  */
  splay_tree_key GTY ((use_param1)) key;

  /* The value.  */
  splay_tree_value GTY ((use_param2)) value;

  /* The left and right children, respectively.  */
  splay_tree_node GTY ((use_params)) left;
  splay_tree_node GTY ((use_params)) right;
};

/* The splay tree itself.  */
struct splay_tree_s GTY(())
{
  /* The root of the tree.  */
  splay_tree_node GTY ((use_params)) root;

  /* The comparision function.  */
  splay_tree_compare_fn comp;

  /* The deallocate-key function.  NULL if no cleanup is necessary.  */
  splay_tree_delete_key_fn delete_key;

  /* The deallocate-value function.  NULL if no cleanup is necessary.  */
  splay_tree_delete_value_fn delete_value;

  /* Allocate/free functions, and a data pointer to pass to them.  */
  splay_tree_allocate_fn allocate;
  splay_tree_deallocate_fn deallocate;
  PTR GTY((skip)) allocate_data;

};
typedef struct splay_tree_s *splay_tree;

extern splay_tree splay_tree_new        PARAMS((splay_tree_compare_fn,
					        splay_tree_delete_key_fn,
					        splay_tree_delete_value_fn));
extern splay_tree splay_tree_new_with_allocator
                                        PARAMS((splay_tree_compare_fn,
					        splay_tree_delete_key_fn,
					        splay_tree_delete_value_fn,
                                                splay_tree_allocate_fn,
                                                splay_tree_deallocate_fn,
                                                void *));
extern void splay_tree_delete           PARAMS((splay_tree));
extern splay_tree_node splay_tree_insert          
		                        PARAMS((splay_tree,
					        splay_tree_key,
					        splay_tree_value));
extern void splay_tree_remove		PARAMS((splay_tree,
						splay_tree_key));
extern splay_tree_node splay_tree_lookup   
                                        PARAMS((splay_tree,
					        splay_tree_key));
extern splay_tree_node splay_tree_predecessor
                                        PARAMS((splay_tree,
						splay_tree_key));
extern splay_tree_node splay_tree_successor
                                        PARAMS((splay_tree,
						splay_tree_key));
extern splay_tree_node splay_tree_max
                                        PARAMS((splay_tree));
extern splay_tree_node splay_tree_min
                                        PARAMS((splay_tree));
extern int splay_tree_foreach           PARAMS((splay_tree,
					        splay_tree_foreach_fn,
					        void*));
extern int splay_tree_compare_ints      PARAMS((splay_tree_key,
						splay_tree_key));
extern int splay_tree_compare_pointers  PARAMS((splay_tree_key,
						splay_tree_key));
					       
#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* _SPLAY_TREE_H */
Commit	Line	Data
52e90c55	1	/* A splay-tree datatype.
8ff82b06	2	Copyright 1998, 1999, 2000, 2002 Free Software Foundation, Inc.
52e90c55 MM	3	Contributed by Mark Mitchell (mark@markmitchell.com).
52e90c55 MM	4
88c1082b	5	This file is part of GCC.
52e90c55	6
88c1082b	7	GCC is free software; you can redistribute it and/or modify it
916a8c46 JL	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
88c1082b	12	GCC is distributed in the hope that it will be useful, but
916a8c46 JL	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
88c1082b	18	along with GCC; see the file COPYING. If not, write to
916a8c46 JL	19	the Free Software Foundation, 59 Temple Place - Suite 330,
	20	Boston, MA 02111-1307, USA. */
	21
	22	/* For an easily readable description of splay-trees, see:
52e90c55 MM	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
8ff82b06	37	#include "ansidecl.h"
52e90c55	38
17211ab5 GK	39	#ifndef GTY
	40	#define GTY(X)
	41	#endif
	42
52e90c55 MM	43	/* Use typedefs for the key and data types to facilitate changing
	44	these types, if necessary. These types should be sufficiently wide
	45	that any pointer or scalar can be cast to these types, and then
	46	cast back, without loss of precision. */
	47	typedef unsigned long int splay_tree_key;
	48	typedef unsigned long int splay_tree_value;
	49
	50	/* Forward declaration for a node in the tree. */
08230f26	51	typedef struct splay_tree_node_s *splay_tree_node;
52e90c55 MM	52
	53	/* The type of a function which compares two splay-tree keys. The
	54	function should return values as for qsort. */
da61b7d5	55	typedef int (*splay_tree_compare_fn) PARAMS((splay_tree_key, splay_tree_key));
52e90c55 MM	56
	57	/* The type of a function used to deallocate any resources associated
	58	with the key. */
da61b7d5	59	typedef void (*splay_tree_delete_key_fn) PARAMS((splay_tree_key));
52e90c55 MM	60
	61	/* The type of a function used to deallocate any resources associated
	62	with the value. */
da61b7d5	63	typedef void (*splay_tree_delete_value_fn) PARAMS((splay_tree_value));
52e90c55 MM	64
52e90c55 MM	65	/* The type of a function used to iterate over the tree. */
da61b7d5	66	typedef int (splay_tree_foreach_fn) PARAMS((splay_tree_node, void));
52e90c55	67
00c2f96f JB	68	/* The type of a function used to allocate memory for tree root and
	69	node structures. The first argument is the number of bytes needed;
	70	the second is a data pointer the splay tree functions pass through
	71	to the allocator. This function must never return zero. */
17211ab5	72	typedef PTR (splay_tree_allocate_fn) PARAMS((int, void ));
00c2f96f JB	73
	74	/* The type of a function used to free memory allocated using the
	75	corresponding splay_tree_allocate_fn. The first argument is the
	76	memory to be freed; the latter is a data pointer the splay tree
	77	functions pass through to the freer. */
	78	typedef void (splay_tree_deallocate_fn) PARAMS((void , void *));
	79
52e90c55	80	/* The nodes in the splay tree. */
17211ab5	81	struct splay_tree_node_s GTY(())
52e90c55 MM	82	{
52e90c55 MM	83	/* The key. */
cfdfa110	84	splay_tree_key GTY ((use_param1)) key;
52e90c55 MM	85
52e90c55 MM	86	/* The value. */
cfdfa110	87	splay_tree_value GTY ((use_param2)) value;
52e90c55 MM	88
52e90c55 MM	89	/* The left and right children, respectively. */
cfdfa110 ZW	90	splay_tree_node GTY ((use_params)) left;
cfdfa110 ZW	91	splay_tree_node GTY ((use_params)) right;
52e90c55 MM	92	};
	93
	94	/* The splay tree itself. */
17211ab5	95	struct splay_tree_s GTY(())
52e90c55 MM	96	{
52e90c55 MM	97	/* The root of the tree. */
cfdfa110	98	splay_tree_node GTY ((use_params)) root;
52e90c55 MM	99
	100	/* The comparision function. */
	101	splay_tree_compare_fn comp;
	102
	103	/* The deallocate-key function. NULL if no cleanup is necessary. */
	104	splay_tree_delete_key_fn delete_key;
	105
	106	/* The deallocate-value function. NULL if no cleanup is necessary. */
	107	splay_tree_delete_value_fn delete_value;
00c2f96f JB	108
	109	/* Allocate/free functions, and a data pointer to pass to them. */
	110	splay_tree_allocate_fn allocate;
	111	splay_tree_deallocate_fn deallocate;
cfdfa110	112	PTR GTY((skip)) allocate_data;
00c2f96f	113
17211ab5 GK	114	};
17211ab5 GK	115	typedef struct splay_tree_s *splay_tree;
52e90c55 MM	116
	117	extern splay_tree splay_tree_new PARAMS((splay_tree_compare_fn,
	118	splay_tree_delete_key_fn,
	119	splay_tree_delete_value_fn));
00c2f96f JB	120	extern splay_tree splay_tree_new_with_allocator
	121	PARAMS((splay_tree_compare_fn,
	122	splay_tree_delete_key_fn,
	123	splay_tree_delete_value_fn,
	124	splay_tree_allocate_fn,
	125	splay_tree_deallocate_fn,
	126	void *));
52e90c55	127	extern void splay_tree_delete PARAMS((splay_tree));
d080bbfa MM	128	extern splay_tree_node splay_tree_insert
d080bbfa MM	129	PARAMS((splay_tree,
52e90c55 MM	130	splay_tree_key,
52e90c55 MM	131	splay_tree_value));
aa5a5f02 RH	132	extern void splay_tree_remove PARAMS((splay_tree,
aa5a5f02 RH	133	splay_tree_key));
52e90c55 MM	134	extern splay_tree_node splay_tree_lookup
	135	PARAMS((splay_tree,
	136	splay_tree_key));
2c9f4db7 MM	137	extern splay_tree_node splay_tree_predecessor
	138	PARAMS((splay_tree,
	139	splay_tree_key));
	140	extern splay_tree_node splay_tree_successor
	141	PARAMS((splay_tree,
	142	splay_tree_key));
5cdba4ff MM	143	extern splay_tree_node splay_tree_max
	144	PARAMS((splay_tree));
	145	extern splay_tree_node splay_tree_min
	146	PARAMS((splay_tree));
52e90c55 MM	147	extern int splay_tree_foreach PARAMS((splay_tree,
	148	splay_tree_foreach_fn,
	149	void*));
30f72379 MM	150	extern int splay_tree_compare_ints PARAMS((splay_tree_key,
30f72379 MM	151	splay_tree_key));
ae7f7270 MM	152	extern int splay_tree_compare_pointers PARAMS((splay_tree_key,
ae7f7270 MM	153	splay_tree_key));
52e90c55 MM	154
	155	#ifdef __cplusplus
	156	}
	157	#endif /* __cplusplus */
	158
	159	#endif /* _SPLAY_TREE_H */