avl.h@ 6981

Last change on this file since 6981 was 5999, checked in by vboxsync, 17 years ago
The Giant CDDL Dual-License Header Change.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 30.5 KB

Line
1	/** @file
2	* innotek Portable Runtime - AVL Trees.
3	*/
4
5	/*
6	* Copyright (C) 1999-2003 knut st. osmundsen <bird-src-spam@anduin.net>
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* The contents of this file may alternatively be used under the terms
17	* of the Common Development and Distribution License Version 1.0
18	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19	* VirtualBox OSE distribution, in which case the provisions of the
20	* CDDL are applicable instead of those of the GPL.
21	*
22	* You may elect to license modified versions of this file under the
23	* terms and conditions of either the GPL or the CDDL or both.
24	*/
25
26	#ifndef ___iprt_avl_h
27	#define ___iprt_avl_h
28
29	#include <iprt/cdefs.h>
30	#include <iprt/types.h>
31
32	__BEGIN_DECLS
33
34	/** @defgroup grp_rt_avl RTAvl - AVL Trees
35	* @ingroup grp_rt
36	* @{
37	*/
38
39
40	/** AVL tree of void pointers.
41	* @{
42	*/
43
44	/**
45	* AVL key type
46	*/
47	typedef void * AVLPVKEY;
48
49	/**
50	* AVL Core node.
51	*/
52	typedef struct _AVLPVNodeCore
53	{
54	AVLPVKEY Key; /** Key value. */
55	struct _AVLPVNodeCore pLeft; /* Pointer to left leaf node. */
56	struct _AVLPVNodeCore pRight; /* Pointer to right leaf node. */
57	unsigned char uchHeight; /** Height of this tree: max(height(left), height(right)) + 1 */
58	} AVLPVNODECORE, PAVLPVNODECORE, *PPAVLPVNODECORE;
59
60	/** A tree with void pointer keys. */
61	typedef PAVLPVNODECORE AVLPVTREE;
62	/** Pointer to a tree with void pointer keys. */
63	typedef PPAVLPVNODECORE PAVLPVTREE;
64
65	/** Callback function for AVLPVDoWithAll(). */
66	typedef DECLCALLBACK(int) AVLPVCALLBACK(PAVLPVNODECORE, void *);
67	/** Pointer to callback function for AVLPVDoWithAll(). */
68	typedef AVLPVCALLBACK *PAVLPVCALLBACK;
69
70	/*
71	* Functions.
72	*/
73	RTDECL(bool) RTAvlPVInsert(PAVLPVTREE ppTree, PAVLPVNODECORE pNode);
74	RTDECL(PAVLPVNODECORE) RTAvlPVRemove(PAVLPVTREE ppTree, AVLPVKEY Key);
75	RTDECL(PAVLPVNODECORE) RTAvlPVGet(PAVLPVTREE ppTree, AVLPVKEY Key);
76	RTDECL(PAVLPVNODECORE) RTAvlPVGetBestFit(PAVLPVTREE ppTree, AVLPVKEY Key, bool fAbove);
77	RTDECL(PAVLPVNODECORE) RTAvlPVRemoveBestFit(PAVLPVTREE ppTree, AVLPVKEY Key, bool fAbove);
78	RTDECL(int) RTAvlPVDoWithAll(PAVLPVTREE ppTree, int fFromLeft, PAVLPVCALLBACK pfnCallBack, void *pvParam);
79	RTDECL(int) RTAvlPVDestroy(PAVLPVTREE ppTree, PAVLPVCALLBACK pfnCallBack, void *pvParam);
80
81	/** @} */
82
83
84	/** AVL tree of unsigned long.
85	* @{
86	*/
87
88	/**
89	* AVL key type
90	*/
91	typedef unsigned long AVLULKEY;
92
93	/**
94	* AVL Core node.
95	*/
96	typedef struct _AVLULNodeCore
97	{
98	AVLULKEY Key; /** Key value. */
99	struct _AVLULNodeCore pLeft; /* Pointer to left leaf node. */
100	struct _AVLULNodeCore pRight; /* Pointer to right leaf node. */
101	unsigned char uchHeight; /** Height of this tree: max(height(left), height(right)) + 1 */
102	} AVLULNODECORE, PAVLULNODECORE, *PPAVLULNODECORE;
103
104
105	/** Callback function for AVLULDoWithAll(). */
106	typedef DECLCALLBACK(int) AVLULCALLBACK(PAVLULNODECORE, void*);
107	/** Pointer to callback function for AVLULDoWithAll(). */
108	typedef AVLULCALLBACK *PAVLULCALLBACK;
109
110
111	/*
112	* Functions.
113	*/
114	RTDECL(bool) RTAvlULInsert(PPAVLULNODECORE ppTree, PAVLULNODECORE pNode);
115	RTDECL(PAVLULNODECORE) RTAvlULRemove(PPAVLULNODECORE ppTree, AVLULKEY Key);
116	RTDECL(PAVLULNODECORE) RTAvlULGet(PPAVLULNODECORE ppTree, AVLULKEY Key);
117	RTDECL(PAVLULNODECORE) RTAvlULGetBestFit(PPAVLULNODECORE ppTree, AVLULKEY Key, bool fAbove);
118	RTDECL(PAVLULNODECORE) RTAvlULRemoveBestFit(PPAVLULNODECORE ppTree, AVLULKEY Key, bool fAbove);
119	RTDECL(int) RTAvlULDoWithAll(PPAVLULNODECORE ppTree, int fFromLeft, PAVLULCALLBACK pfnCallBack, void *pvParam);
120
121	/** @} */
122
123
124
125	/** AVL tree of uint32_t
126	* @{
127	*/
128
129	/** AVL key type. */
130	typedef uint32_t AVLU32KEY;
131
132	/** AVL Core node. */
133	typedef struct _AVLU32NodeCore
134	{
135	AVLU32KEY Key; /*< Key value. /
136	struct _AVLU32NodeCore pLeft; /< Pointer to left leaf node. /
137	struct _AVLU32NodeCore pRight; /< Pointer to right leaf node. /
138	unsigned char uchHeight; /*< Height of this tree: max(height(left), height(right)) + 1 /
139	} AVLU32NODECORE, PAVLU32NODECORE, *PPAVLU32NODECORE;
140
141	/** Callback function for AVLU32DoWithAll() & AVLU32Destroy(). */
142	typedef DECLCALLBACK(int) AVLU32CALLBACK(PAVLU32NODECORE, void*);
143	/** Pointer to callback function for AVLU32DoWithAll() & AVLU32Destroy(). */
144	typedef AVLU32CALLBACK *PAVLU32CALLBACK;
145
146
147	/*
148	* Functions.
149	*/
150	RTDECL(bool) RTAvlU32Insert(PPAVLU32NODECORE ppTree, PAVLU32NODECORE pNode);
151	RTDECL(PAVLU32NODECORE) RTAvlU32Remove(PPAVLU32NODECORE ppTree, AVLU32KEY Key);
152	RTDECL(PAVLU32NODECORE) RTAvlU32Get(PPAVLU32NODECORE ppTree, AVLU32KEY Key);
153	RTDECL(PAVLU32NODECORE) RTAvlU32GetBestFit(PPAVLU32NODECORE ppTree, AVLU32KEY Key, bool fAbove);
154	RTDECL(PAVLU32NODECORE) RTAvlU32RemoveBestFit(PPAVLU32NODECORE ppTree, AVLU32KEY Key, bool fAbove);
155	RTDECL(int) RTAvlU32DoWithAll(PPAVLU32NODECORE ppTree, int fFromLeft, PAVLU32CALLBACK pfnCallBack, void *pvParam);
156	RTDECL(int) RTAvlU32Destroy(PPAVLU32NODECORE pTree, PAVLU32CALLBACK pfnCallBack, void *pvParam);
157
158	/** @} */
159
160
161
162	/** AVL tree of uint32_t, list duplicates.
163	* @{
164	*/
165
166	/** AVL key type. */
167	typedef uint32_t AVLLU32KEY;
168
169	/** AVL Core node. */
170	typedef struct _AVLLU32NodeCore
171	{
172	AVLLU32KEY Key; /*< Key value. /
173	unsigned char uchHeight; /*< Height of this tree: max(height(left), height(right)) + 1 /
174	struct _AVLLU32NodeCore pLeft; /< Pointer to left leaf node. /
175	struct _AVLLU32NodeCore pRight; /< Pointer to right leaf node. /
176	struct _AVLLU32NodeCore pList; /< Pointer to next node with the same key. /
177	} AVLLU32NODECORE, PAVLLU32NODECORE, *PPAVLLU32NODECORE;
178
179	/** Callback function for RTAvllU32DoWithAll() & RTAvllU32Destroy(). */
180	typedef DECLCALLBACK(int) AVLLU32CALLBACK(PAVLLU32NODECORE, void*);
181	/** Pointer to callback function for RTAvllU32DoWithAll() & RTAvllU32Destroy(). */
182	typedef AVLLU32CALLBACK *PAVLLU32CALLBACK;
183
184
185	/*
186	* Functions.
187	*/
188	RTDECL(bool) RTAvllU32Insert(PPAVLLU32NODECORE ppTree, PAVLLU32NODECORE pNode);
189	RTDECL(PAVLLU32NODECORE) RTAvllU32Remove(PPAVLLU32NODECORE ppTree, AVLLU32KEY Key);
190	RTDECL(PAVLLU32NODECORE) RTAvllU32Get(PPAVLLU32NODECORE ppTree, AVLLU32KEY Key);
191	RTDECL(PAVLLU32NODECORE) RTAvllU32GetBestFit(PPAVLLU32NODECORE ppTree, AVLLU32KEY Key, bool fAbove);
192	RTDECL(PAVLLU32NODECORE) RTAvllU32RemoveBestFit(PPAVLLU32NODECORE ppTree, AVLLU32KEY Key, bool fAbove);
193	RTDECL(int) RTAvllU32DoWithAll(PPAVLLU32NODECORE ppTree, int fFromLeft, PAVLLU32CALLBACK pfnCallBack, void *pvParam);
194	RTDECL(int) RTAvllU32Destroy(PPAVLLU32NODECORE pTree, PAVLLU32CALLBACK pfnCallBack, void *pvParam);
195
196	/** @} */
197
198
199
200	/** AVL tree of RTGCPHYSes - using relative offsets internally.
201	* @{
202	*/
203
204	/**
205	* AVL 'pointer' type for the relative offset pointer scheme.
206	*/
207	typedef int32_t AVLOGCPHYS;
208
209	/**
210	* AVL Core node.
211	*/
212	typedef struct _AVLOGCPhysNodeCore
213	{
214	/** Key value. */
215	RTGCPHYS Key;
216	/** Offset to the left leaf node, relative to this field. */
217	AVLOGCPHYS pLeft;
218	/** Offset to the right leaf node, relative to this field. */
219	AVLOGCPHYS pRight;
220	/** Height of this tree: max(height(left), height(right)) + 1 */
221	unsigned char uchHeight;
222	} AVLOGCPHYSNODECORE, *PAVLOGCPHYSNODECORE;
223
224	/** A offset base tree with uint32_t keys. */
225	typedef AVLOGCPHYS AVLOGCPHYSTREE;
226	/** Pointer to a offset base tree with uint32_t keys. */
227	typedef AVLOGCPHYSTREE *PAVLOGCPHYSTREE;
228
229	/** Pointer to an internal tree pointer.
230	* In this case it's a pointer to a relative offset. */
231	typedef AVLOGCPHYSTREE *PPAVLOGCPHYSNODECORE;
232
233	/** Callback function for RTAvloGCPhysDoWithAll() and RTAvloGCPhysDestroy(). */
234	typedef DECLCALLBACK(int) AVLOGCPHYSCALLBACK(PAVLOGCPHYSNODECORE pNode, void *pvUser);
235	/** Pointer to callback function for RTAvloGCPhysDoWithAll() and RTAvloGCPhysDestroy(). */
236	typedef AVLOGCPHYSCALLBACK *PAVLOGCPHYSCALLBACK;
237
238	RTDECL(bool) RTAvloGCPhysInsert(PAVLOGCPHYSTREE pTree, PAVLOGCPHYSNODECORE pNode);
239	RTDECL(PAVLOGCPHYSNODECORE) RTAvloGCPhysRemove(PAVLOGCPHYSTREE pTree, RTGCPHYS Key);
240	RTDECL(PAVLOGCPHYSNODECORE) RTAvloGCPhysGet(PAVLOGCPHYSTREE pTree, RTGCPHYS Key);
241	RTDECL(int) RTAvloGCPhysDoWithAll(PAVLOGCPHYSTREE pTree, int fFromLeft, PAVLOGCPHYSCALLBACK pfnCallBack, void *pvParam);
242	RTDECL(PAVLOGCPHYSNODECORE) RTAvloGCPhysGetBestFit(PAVLOGCPHYSTREE ppTree, RTGCPHYS Key, bool fAbove);
243	RTDECL(PAVLOGCPHYSNODECORE) RTAvloGCPhysRemoveBestFit(PAVLOGCPHYSTREE ppTree, RTGCPHYS Key, bool fAbove);
244	RTDECL(int) RTAvloGCPhysDestroy(PAVLOGCPHYSTREE pTree, PAVLOGCPHYSCALLBACK pfnCallBack, void *pvParam);
245
246	/** @} */
247
248
249	/** AVL tree of RTGCPHYS ranges - using relative offsets internally.
250	* @{
251	*/
252
253	/**
254	* AVL 'pointer' type for the relative offset pointer scheme.
255	*/
256	typedef int32_t AVLROGCPHYS;
257
258	/**
259	* AVL Core node.
260	*/
261	typedef struct _AVLROGCPhysNodeCore
262	{
263	/** First key value in the range (inclusive). */
264	RTGCPHYS Key;
265	/** Last key value in the range (inclusive). */
266	RTGCPHYS KeyLast;
267	/** Offset to the left leaf node, relative to this field. */
268	AVLROGCPHYS pLeft;
269	/** Offset to the right leaf node, relative to this field. */
270	AVLROGCPHYS pRight;
271	/** Height of this tree: max(height(left), height(right)) + 1 */
272	unsigned char uchHeight;
273	} AVLROGCPHYSNODECORE, *PAVLROGCPHYSNODECORE;
274
275	/** A offset base tree with uint32_t keys. */
276	typedef AVLROGCPHYS AVLROGCPHYSTREE;
277	/** Pointer to a offset base tree with uint32_t keys. */
278	typedef AVLROGCPHYSTREE *PAVLROGCPHYSTREE;
279
280	/** Pointer to an internal tree pointer.
281	* In this case it's a pointer to a relative offset. */
282	typedef AVLROGCPHYSTREE *PPAVLROGCPHYSNODECORE;
283
284	/** Callback function for RTAvlroGCPhysDoWithAll() and RTAvlroGCPhysDestroy(). */
285	typedef DECLCALLBACK(int) AVLROGCPHYSCALLBACK(PAVLROGCPHYSNODECORE pNode, void *pvUser);
286	/** Pointer to callback function for RTAvlroGCPhysDoWithAll() and RTAvlroGCPhysDestroy(). */
287	typedef AVLROGCPHYSCALLBACK *PAVLROGCPHYSCALLBACK;
288
289	RTDECL(bool) RTAvlroGCPhysInsert(PAVLROGCPHYSTREE pTree, PAVLROGCPHYSNODECORE pNode);
290	RTDECL(PAVLROGCPHYSNODECORE) RTAvlroGCPhysRemove(PAVLROGCPHYSTREE pTree, RTGCPHYS Key);
291	RTDECL(PAVLROGCPHYSNODECORE) RTAvlroGCPhysGet(PAVLROGCPHYSTREE pTree, RTGCPHYS Key);
292	RTDECL(PAVLROGCPHYSNODECORE) RTAvlroGCPhysRangeGet(PAVLROGCPHYSTREE pTree, RTGCPHYS Key);
293	RTDECL(PAVLROGCPHYSNODECORE) RTAvlroGCPhysRangeRemove(PAVLROGCPHYSTREE pTree, RTGCPHYS Key);
294	RTDECL(PAVLROGCPHYSNODECORE) RTAvlroGCPhysGetBestFit(PAVLROGCPHYSTREE ppTree, RTGCPHYS Key, bool fAbove);
295	RTDECL(int) RTAvlroGCPhysDoWithAll(PAVLROGCPHYSTREE pTree, int fFromLeft, PAVLROGCPHYSCALLBACK pfnCallBack, void *pvParam);
296	RTDECL(int) RTAvlroGCPhysDestroy(PAVLROGCPHYSTREE pTree, PAVLROGCPHYSCALLBACK pfnCallBack, void *pvParam);
297	RTDECL(PAVLROGCPHYSNODECORE) RTAvlroGCPhysGetRoot(PAVLROGCPHYSTREE pTree);
298	RTDECL(PAVLROGCPHYSNODECORE) RTAvlroGCPhysGetLeft(PAVLROGCPHYSNODECORE pNode);
299	RTDECL(PAVLROGCPHYSNODECORE) RTAvlroGCPhysGetRight(PAVLROGCPHYSNODECORE pNode);
300
301	/** @} */
302
303
304	/** AVL tree of RTGCPTRs.
305	* @{
306	*/
307
308	/**
309	* AVL Core node.
310	*/
311	typedef struct _AVLGCPtrNodeCore
312	{
313	/** Key value. */
314	RTGCPTR Key;
315	/** Pointer to the left node. */
316	struct _AVLGCPtrNodeCore *pLeft;
317	/** Pointer to the right node. */
318	struct _AVLGCPtrNodeCore *pRight;
319	/** Height of this tree: max(height(left), height(right)) + 1 */
320	unsigned char uchHeight;
321	} AVLGCPTRNODECORE, PAVLGCPTRNODECORE, *PPAVLGCPTRNODECORE;
322
323	/** A tree of RTGCPTR keys. */
324	typedef PAVLGCPTRNODECORE AVLGCPTRTREE;
325	/** Pointer to a tree of RTGCPTR keys. */
326	typedef PPAVLGCPTRNODECORE PAVLGCPTRTREE;
327
328	/** Callback function for RTAvlGCPtrDoWithAll(). */
329	typedef DECLCALLBACK(int) AVLGCPTRCALLBACK(PAVLGCPTRNODECORE pNode, void *pvUser);
330	/** Pointer to callback function for RTAvlGCPtrDoWithAll(). */
331	typedef AVLGCPTRCALLBACK *PAVLGCPTRCALLBACK;
332
333	RTDECL(bool) RTAvlGCPtrInsert(PAVLGCPTRTREE pTree, PAVLGCPTRNODECORE pNode);
334	RTDECL(PAVLGCPTRNODECORE) RTAvlGCPtrRemove(PAVLGCPTRTREE pTree, RTGCPTR Key);
335	RTDECL(PAVLGCPTRNODECORE) RTAvlGCPtrGet(PAVLGCPTRTREE pTree, RTGCPTR Key);
336	RTDECL(int) RTAvlGCPtrDoWithAll(PAVLGCPTRTREE pTree, int fFromLeft, PAVLGCPTRCALLBACK pfnCallBack, void *pvParam);
337	RTDECL(PAVLGCPTRNODECORE) RTAvlGCPtrGetBestFit(PAVLGCPTRTREE ppTree, RTGCPTR Key, bool fAbove);
338	RTDECL(PAVLGCPTRNODECORE) RTAvlGCPtrRemoveBestFit(PAVLGCPTRTREE ppTree, RTGCPTR Key, bool fAbove);
339	RTDECL(int) RTAvlGCPtrDestroy(PAVLGCPTRTREE pTree, PAVLGCPTRCALLBACK pfnCallBack, void *pvParam);
340
341	/** @} */
342
343
344	/** AVL tree of RTGCPTRs - using relative offsets internally.
345	* @{
346	*/
347
348	/**
349	* AVL 'pointer' type for the relative offset pointer scheme.
350	*/
351	typedef int32_t AVLOGCPTR;
352
353	/**
354	* AVL Core node.
355	*/
356	typedef struct _AVLOGCPtrNodeCore
357	{
358	/** Key value. */
359	RTGCPTR Key;
360	/** Offset to the left leaf node, relative to this field. */
361	AVLOGCPTR pLeft;
362	/** Offset to the right leaf node, relative to this field. */
363	AVLOGCPTR pRight;
364	/** Height of this tree: max(height(left), height(right)) + 1 */
365	unsigned char uchHeight;
366	} AVLOGCPTRNODECORE, *PAVLOGCPTRNODECORE;
367
368	/** A offset base tree with uint32_t keys. */
369	typedef AVLOGCPTR AVLOGCPTRTREE;
370	/** Pointer to a offset base tree with uint32_t keys. */
371	typedef AVLOGCPTRTREE *PAVLOGCPTRTREE;
372
373	/** Pointer to an internal tree pointer.
374	* In this case it's a pointer to a relative offset. */
375	typedef AVLOGCPTRTREE *PPAVLOGCPTRNODECORE;
376
377	/** Callback function for RTAvloGCPtrDoWithAll(). */
378	typedef DECLCALLBACK(int) AVLOGCPTRCALLBACK(PAVLOGCPTRNODECORE pNode, void *pvUser);
379	/** Pointer to callback function for RTAvloGCPtrDoWithAll(). */
380	typedef AVLOGCPTRCALLBACK *PAVLOGCPTRCALLBACK;
381
382	RTDECL(bool) RTAvloGCPtrInsert(PAVLOGCPTRTREE pTree, PAVLOGCPTRNODECORE pNode);
383	RTDECL(PAVLOGCPTRNODECORE) RTAvloGCPtrRemove(PAVLOGCPTRTREE pTree, RTGCPTR Key);
384	RTDECL(PAVLOGCPTRNODECORE) RTAvloGCPtrGet(PAVLOGCPTRTREE pTree, RTGCPTR Key);
385	RTDECL(int) RTAvloGCPtrDoWithAll(PAVLOGCPTRTREE pTree, int fFromLeft, PAVLOGCPTRCALLBACK pfnCallBack, void *pvParam);
386	RTDECL(PAVLOGCPTRNODECORE) RTAvloGCPtrGetBestFit(PAVLOGCPTRTREE ppTree, RTGCPTR Key, bool fAbove);
387	RTDECL(PAVLOGCPTRNODECORE) RTAvloGCPtrRemoveBestFit(PAVLOGCPTRTREE ppTree, RTGCPTR Key, bool fAbove);
388	RTDECL(int) RTAvloGCPtrDestroy(PAVLOGCPTRTREE pTree, PAVLOGCPTRCALLBACK pfnCallBack, void *pvParam);
389
390	/** @} */
391
392
393	/** AVL tree of RTGCPTR ranges.
394	* @{
395	*/
396
397	/**
398	* AVL Core node.
399	*/
400	typedef struct _AVLRGCPtrNodeCore
401	{
402	/** First key value in the range (inclusive). */
403	RTGCPTR Key;
404	/** Last key value in the range (inclusive). */
405	RTGCPTR KeyLast;
406	/** Offset to the left leaf node, relative to this field. */
407	struct _AVLRGCPtrNodeCore *pLeft;
408	/** Offset to the right leaf node, relative to this field. */
409	struct _AVLRGCPtrNodeCore *pRight;
410	/** Height of this tree: max(height(left), height(right)) + 1 */
411	unsigned char uchHeight;
412	} AVLRGCPTRNODECORE, *PAVLRGCPTRNODECORE;
413
414	/** A offset base tree with RTGCPTR keys. */
415	typedef PAVLRGCPTRNODECORE AVLRGCPTRTREE;
416	/** Pointer to a offset base tree with RTGCPTR keys. */
417	typedef AVLRGCPTRTREE *PAVLRGCPTRTREE;
418
419	/** Pointer to an internal tree pointer.
420	* In this case it's a pointer to a relative offset. */
421	typedef AVLRGCPTRTREE *PPAVLRGCPTRNODECORE;
422
423	/** Callback function for RTAvlrGCPtrDoWithAll() and RTAvlrGCPtrDestroy(). */
424	typedef DECLCALLBACK(int) AVLRGCPTRCALLBACK(PAVLRGCPTRNODECORE pNode, void *pvUser);
425	/** Pointer to callback function for RTAvlrGCPtrDoWithAll() and RTAvlrGCPtrDestroy(). */
426	typedef AVLRGCPTRCALLBACK *PAVLRGCPTRCALLBACK;
427
428	RTDECL(bool) RTAvlrGCPtrInsert( PAVLRGCPTRTREE pTree, PAVLRGCPTRNODECORE pNode);
429	RTDECL(PAVLRGCPTRNODECORE) RTAvlrGCPtrRemove( PAVLRGCPTRTREE pTree, RTGCPTR Key);
430	RTDECL(PAVLRGCPTRNODECORE) RTAvlrGCPtrGet( PAVLRGCPTRTREE pTree, RTGCPTR Key);
431	RTDECL(PAVLRGCPTRNODECORE) RTAvlrGCPtrGetBestFit( PAVLRGCPTRTREE pTree, RTGCPTR Key, bool fAbove);
432	RTDECL(PAVLRGCPTRNODECORE) RTAvlrGCPtrRangeGet( PAVLRGCPTRTREE pTree, RTGCPTR Key);
433	RTDECL(PAVLRGCPTRNODECORE) RTAvlrGCPtrRangeRemove( PAVLRGCPTRTREE pTree, RTGCPTR Key);
434	RTDECL(int) RTAvlrGCPtrDoWithAll( PAVLRGCPTRTREE pTree, int fFromLeft, PAVLRGCPTRCALLBACK pfnCallBack, void *pvParam);
435	RTDECL(int) RTAvlrGCPtrDestroy( PAVLRGCPTRTREE pTree, PAVLRGCPTRCALLBACK pfnCallBack, void *pvParam);
436	RTDECL(PAVLRGCPTRNODECORE) RTAvlrGCPtrGetRoot( PAVLRGCPTRTREE pTree);
437	RTDECL(PAVLRGCPTRNODECORE) RTAvlrGCPtrGetLeft( PAVLRGCPTRNODECORE pNode);
438	RTDECL(PAVLRGCPTRNODECORE) RTAvlrGCPtrGetRight( PAVLRGCPTRNODECORE pNode);
439
440	/** @} */
441
442
443	/** AVL tree of RTGCPTR ranges - using relative offsets internally.
444	* @{
445	*/
446
447	/**
448	* AVL 'pointer' type for the relative offset pointer scheme.
449	*/
450	typedef int32_t AVLROGCPTR;
451
452	/**
453	* AVL Core node.
454	*/
455	typedef struct _AVLROGCPtrNodeCore
456	{
457	/** First key value in the range (inclusive). */
458	RTGCPTR Key;
459	/** Last key value in the range (inclusive). */
460	RTGCPTR KeyLast;
461	/** Offset to the left leaf node, relative to this field. */
462	AVLROGCPTR pLeft;
463	/** Offset to the right leaf node, relative to this field. */
464	AVLROGCPTR pRight;
465	/** Height of this tree: max(height(left), height(right)) + 1 */
466	unsigned char uchHeight;
467	} AVLROGCPTRNODECORE, *PAVLROGCPTRNODECORE;
468
469	/** A offset base tree with uint32_t keys. */
470	typedef AVLROGCPTR AVLROGCPTRTREE;
471	/** Pointer to a offset base tree with uint32_t keys. */
472	typedef AVLROGCPTRTREE *PAVLROGCPTRTREE;
473
474	/** Pointer to an internal tree pointer.
475	* In this case it's a pointer to a relative offset. */
476	typedef AVLROGCPTRTREE *PPAVLROGCPTRNODECORE;
477
478	/** Callback function for RTAvlroGCPtrDoWithAll() and RTAvlroGCPtrDestroy(). */
479	typedef DECLCALLBACK(int) AVLROGCPTRCALLBACK(PAVLROGCPTRNODECORE pNode, void *pvUser);
480	/** Pointer to callback function for RTAvlroGCPtrDoWithAll() and RTAvlroGCPtrDestroy(). */
481	typedef AVLROGCPTRCALLBACK *PAVLROGCPTRCALLBACK;
482
483	RTDECL(bool) RTAvlroGCPtrInsert(PAVLROGCPTRTREE pTree, PAVLROGCPTRNODECORE pNode);
484	RTDECL(PAVLROGCPTRNODECORE) RTAvlroGCPtrRemove(PAVLROGCPTRTREE pTree, RTGCPTR Key);
485	RTDECL(PAVLROGCPTRNODECORE) RTAvlroGCPtrGet(PAVLROGCPTRTREE pTree, RTGCPTR Key);
486	RTDECL(PAVLROGCPTRNODECORE) RTAvlroGCPtrGetBestFit(PAVLROGCPTRTREE ppTree, RTGCPTR Key, bool fAbove);
487	RTDECL(PAVLROGCPTRNODECORE) RTAvlroGCPtrRangeGet(PAVLROGCPTRTREE pTree, RTGCPTR Key);
488	RTDECL(PAVLROGCPTRNODECORE) RTAvlroGCPtrRangeRemove(PAVLROGCPTRTREE pTree, RTGCPTR Key);
489	RTDECL(int) RTAvlroGCPtrDoWithAll(PAVLROGCPTRTREE pTree, int fFromLeft, PAVLROGCPTRCALLBACK pfnCallBack, void *pvParam);
490	RTDECL(int) RTAvlroGCPtrDestroy(PAVLROGCPTRTREE pTree, PAVLROGCPTRCALLBACK pfnCallBack, void *pvParam);
491	RTDECL(PAVLROGCPTRNODECORE) RTAvlroGCPtrGetRoot(PAVLROGCPTRTREE pTree);
492	RTDECL(PAVLROGCPTRNODECORE) RTAvlroGCPtrGetLeft(PAVLROGCPTRNODECORE pNode);
493	RTDECL(PAVLROGCPTRNODECORE) RTAvlroGCPtrGetRight(PAVLROGCPTRNODECORE pNode);
494
495	/** @} */
496
497
498	/** AVL tree of RTGCPTR ranges (overlapping supported) - using relative offsets internally.
499	* @{
500	*/
501
502	/**
503	* AVL 'pointer' type for the relative offset pointer scheme.
504	*/
505	typedef int32_t AVLROOGCPTR;
506
507	/**
508	* AVL Core node.
509	*/
510	typedef struct _AVLROOGCPtrNodeCore
511	{
512	/** First key value in the range (inclusive). */
513	RTGCPTR Key;
514	/** Last key value in the range (inclusive). */
515	RTGCPTR KeyLast;
516	/** Offset to the left leaf node, relative to this field. */
517	AVLROOGCPTR pLeft;
518	/** Offset to the right leaf node, relative to this field. */
519	AVLROOGCPTR pRight;
520	/** Pointer to the list of string with the same key. Don't touch. */
521	AVLROOGCPTR pList;
522	/** Height of this tree: max(height(left), height(right)) + 1 */
523	unsigned char uchHeight;
524	} AVLROOGCPTRNODECORE, *PAVLROOGCPTRNODECORE;
525
526	/** A offset base tree with uint32_t keys. */
527	typedef AVLROOGCPTR AVLROOGCPTRTREE;
528	/** Pointer to a offset base tree with uint32_t keys. */
529	typedef AVLROOGCPTRTREE *PAVLROOGCPTRTREE;
530
531	/** Pointer to an internal tree pointer.
532	* In this case it's a pointer to a relative offset. */
533	typedef AVLROOGCPTRTREE *PPAVLROOGCPTRNODECORE;
534
535	/** Callback function for RTAvlrooGCPtrDoWithAll() and RTAvlrooGCPtrDestroy(). */
536	typedef DECLCALLBACK(int) AVLROOGCPTRCALLBACK(PAVLROOGCPTRNODECORE pNode, void *pvUser);
537	/** Pointer to callback function for RTAvlrooGCPtrDoWithAll() and RTAvlrooGCPtrDestroy(). */
538	typedef AVLROOGCPTRCALLBACK *PAVLROOGCPTRCALLBACK;
539
540	RTDECL(bool) RTAvlrooGCPtrInsert(PAVLROOGCPTRTREE pTree, PAVLROOGCPTRNODECORE pNode);
541	RTDECL(PAVLROOGCPTRNODECORE) RTAvlrooGCPtrRemove(PAVLROOGCPTRTREE pTree, RTGCPTR Key);
542	RTDECL(PAVLROOGCPTRNODECORE) RTAvlrooGCPtrGet(PAVLROOGCPTRTREE pTree, RTGCPTR Key);
543	RTDECL(PAVLROOGCPTRNODECORE) RTAvlrooGCPtrGetBestFit(PAVLROOGCPTRTREE ppTree, RTGCPTR Key, bool fAbove);
544	RTDECL(PAVLROOGCPTRNODECORE) RTAvlrooGCPtrRangeGet(PAVLROOGCPTRTREE pTree, RTGCPTR Key);
545	RTDECL(PAVLROOGCPTRNODECORE) RTAvlrooGCPtrRangeRemove(PAVLROOGCPTRTREE pTree, RTGCPTR Key);
546	RTDECL(int) RTAvlrooGCPtrDoWithAll(PAVLROOGCPTRTREE pTree, int fFromLeft, PAVLROOGCPTRCALLBACK pfnCallBack, void *pvParam);
547	RTDECL(int) RTAvlrooGCPtrDestroy(PAVLROOGCPTRTREE pTree, PAVLROOGCPTRCALLBACK pfnCallBack, void *pvParam);
548	RTDECL(PAVLROOGCPTRNODECORE) RTAvlrooGCPtrGetRoot(PAVLROOGCPTRTREE pTree);
549	RTDECL(PAVLROOGCPTRNODECORE) RTAvlrooGCPtrGetLeft(PAVLROOGCPTRNODECORE pNode);
550	RTDECL(PAVLROOGCPTRNODECORE) RTAvlrooGCPtrGetRight(PAVLROOGCPTRNODECORE pNode);
551	RTDECL(PAVLROOGCPTRNODECORE) RTAvlrooGCPtrGetNextEqual(PAVLROOGCPTRNODECORE pNode);
552
553	/** @} */
554
555
556	/** AVL tree of RTHCPHYSes - using relative offsets internally.
557	* @{
558	*/
559
560	/**
561	* AVL 'pointer' type for the relative offset pointer scheme.
562	*/
563	typedef int32_t AVLOHCPHYS;
564
565	/**
566	* AVL Core node.
567	*/
568	typedef struct _AVLOHCPhysNodeCore
569	{
570	/** Key value. */
571	RTHCPHYS Key;
572	/** Offset to the left leaf node, relative to this field. */
573	AVLOHCPHYS pLeft;
574	/** Offset to the right leaf node, relative to this field. */
575	AVLOHCPHYS pRight;
576	/** Height of this tree: max(height(left), height(right)) + 1 */
577	unsigned char uchHeight;
578	#if HC_ARCH_BITS == 64 \|\| GC_ARCH_BITS == 64
579	unsigned char Padding[7]; /*< Alignment padding. /
580	#endif
581	} AVLOHCPHYSNODECORE, *PAVLOHCPHYSNODECORE;
582
583	/** A offset base tree with uint32_t keys. */
584	typedef AVLOHCPHYS AVLOHCPHYSTREE;
585	/** Pointer to a offset base tree with uint32_t keys. */
586	typedef AVLOHCPHYSTREE *PAVLOHCPHYSTREE;
587
588	/** Pointer to an internal tree pointer.
589	* In this case it's a pointer to a relative offset. */
590	typedef AVLOHCPHYSTREE *PPAVLOHCPHYSNODECORE;
591
592	/** Callback function for RTAvloHCPhysDoWithAll() and RTAvloHCPhysDestroy(). */
593	typedef DECLCALLBACK(int) AVLOHCPHYSCALLBACK(PAVLOHCPHYSNODECORE pNode, void *pvUser);
594	/** Pointer to callback function for RTAvloHCPhysDoWithAll() and RTAvloHCPhysDestroy(). */
595	typedef AVLOHCPHYSCALLBACK *PAVLOHCPHYSCALLBACK;
596
597	RTDECL(bool) RTAvloHCPhysInsert(PAVLOHCPHYSTREE pTree, PAVLOHCPHYSNODECORE pNode);
598	RTDECL(PAVLOHCPHYSNODECORE) RTAvloHCPhysRemove(PAVLOHCPHYSTREE pTree, RTHCPHYS Key);
599	RTDECL(PAVLOHCPHYSNODECORE) RTAvloHCPhysGet(PAVLOHCPHYSTREE pTree, RTHCPHYS Key);
600	RTDECL(int) RTAvloHCPhysDoWithAll(PAVLOHCPHYSTREE pTree, int fFromLeft, PAVLOHCPHYSCALLBACK pfnCallBack, void *pvParam);
601	RTDECL(PAVLOHCPHYSNODECORE) RTAvloHCPhysGetBestFit(PAVLOHCPHYSTREE ppTree, RTHCPHYS Key, bool fAbove);
602	RTDECL(PAVLOHCPHYSNODECORE) RTAvloHCPhysRemoveBestFit(PAVLOHCPHYSTREE ppTree, RTHCPHYS Key, bool fAbove);
603	RTDECL(int) RTAvloHCPhysDestroy(PAVLOHCPHYSTREE pTree, PAVLOHCPHYSCALLBACK pfnCallBack, void *pvParam);
604
605	/** @} */
606
607
608
609	/** AVL tree of RTIOPORTs - using relative offsets internally.
610	* @{
611	*/
612
613	/**
614	* AVL 'pointer' type for the relative offset pointer scheme.
615	*/
616	typedef int32_t AVLOIOPORTPTR;
617
618	/**
619	* AVL Core node.
620	*/
621	typedef struct _AVLOIOPortNodeCore
622	{
623	/** Offset to the left leaf node, relative to this field. */
624	AVLOIOPORTPTR pLeft;
625	/** Offset to the right leaf node, relative to this field. */
626	AVLOIOPORTPTR pRight;
627	/** Key value. */
628	RTIOPORT Key;
629	/** Height of this tree: max(height(left), height(right)) + 1 */
630	unsigned char uchHeight;
631	} AVLOIOPORTNODECORE, *PAVLOIOPORTNODECORE;
632
633	/** A offset base tree with uint32_t keys. */
634	typedef AVLOIOPORTPTR AVLOIOPORTTREE;
635	/** Pointer to a offset base tree with uint32_t keys. */
636	typedef AVLOIOPORTTREE *PAVLOIOPORTTREE;
637
638	/** Pointer to an internal tree pointer.
639	* In this case it's a pointer to a relative offset. */
640	typedef AVLOIOPORTTREE *PPAVLOIOPORTNODECORE;
641
642	/** Callback function for RTAvloIOPortDoWithAll() and RTAvloIOPortDestroy(). */
643	typedef DECLCALLBACK(int) AVLOIOPORTCALLBACK(PAVLOIOPORTNODECORE pNode, void *pvUser);
644	/** Pointer to callback function for RTAvloIOPortDoWithAll() and RTAvloIOPortDestroy(). */
645	typedef AVLOIOPORTCALLBACK *PAVLOIOPORTCALLBACK;
646
647	RTDECL(bool) RTAvloIOPortInsert(PAVLOIOPORTTREE pTree, PAVLOIOPORTNODECORE pNode);
648	RTDECL(PAVLOIOPORTNODECORE) RTAvloIOPortRemove(PAVLOIOPORTTREE pTree, RTIOPORT Key);
649	RTDECL(PAVLOIOPORTNODECORE) RTAvloIOPortGet(PAVLOIOPORTTREE pTree, RTIOPORT Key);
650	RTDECL(int) RTAvloIOPortDoWithAll(PAVLOIOPORTTREE pTree, int fFromLeft, PAVLOIOPORTCALLBACK pfnCallBack, void *pvParam);
651	RTDECL(int) RTAvloIOPortDestroy(PAVLOIOPORTTREE pTree, PAVLOIOPORTCALLBACK pfnCallBack, void *pvParam);
652
653	/** @} */
654
655
656	/** AVL tree of RTIOPORT ranges - using relative offsets internally.
657	* @{
658	*/
659
660	/**
661	* AVL 'pointer' type for the relative offset pointer scheme.
662	*/
663	typedef int32_t AVLROIOPORTPTR;
664
665	/**
666	* AVL Core node.
667	*/
668	typedef struct _AVLROIOPortNodeCore
669	{
670	/** First key value in the range (inclusive). */
671	RTIOPORT Key;
672	/** Last key value in the range (inclusive). */
673	RTIOPORT KeyLast;
674	/** Offset to the left leaf node, relative to this field. */
675	AVLROIOPORTPTR pLeft;
676	/** Offset to the right leaf node, relative to this field. */
677	AVLROIOPORTPTR pRight;
678	/** Height of this tree: max(height(left), height(right)) + 1 */
679	unsigned char uchHeight;
680	} AVLROIOPORTNODECORE, *PAVLROIOPORTNODECORE;
681
682	/** A offset base tree with uint32_t keys. */
683	typedef AVLROIOPORTPTR AVLROIOPORTTREE;
684	/** Pointer to a offset base tree with uint32_t keys. */
685	typedef AVLROIOPORTTREE *PAVLROIOPORTTREE;
686
687	/** Pointer to an internal tree pointer.
688	* In this case it's a pointer to a relative offset. */
689	typedef AVLROIOPORTTREE *PPAVLROIOPORTNODECORE;
690
691	/** Callback function for RTAvlroIOPortDoWithAll() and RTAvlroIOPortDestroy(). */
692	typedef DECLCALLBACK(int) AVLROIOPORTCALLBACK(PAVLROIOPORTNODECORE pNode, void *pvUser);
693	/** Pointer to callback function for RTAvlroIOPortDoWithAll() and RTAvlroIOPortDestroy(). */
694	typedef AVLROIOPORTCALLBACK *PAVLROIOPORTCALLBACK;
695
696	RTDECL(bool) RTAvlroIOPortInsert(PAVLROIOPORTTREE pTree, PAVLROIOPORTNODECORE pNode);
697	RTDECL(PAVLROIOPORTNODECORE) RTAvlroIOPortRemove(PAVLROIOPORTTREE pTree, RTIOPORT Key);
698	RTDECL(PAVLROIOPORTNODECORE) RTAvlroIOPortGet(PAVLROIOPORTTREE pTree, RTIOPORT Key);
699	RTDECL(PAVLROIOPORTNODECORE) RTAvlroIOPortRangeGet(PAVLROIOPORTTREE pTree, RTIOPORT Key);
700	RTDECL(PAVLROIOPORTNODECORE) RTAvlroIOPortRangeRemove(PAVLROIOPORTTREE pTree, RTIOPORT Key);
701	RTDECL(int) RTAvlroIOPortDoWithAll(PAVLROIOPORTTREE pTree, int fFromLeft, PAVLROIOPORTCALLBACK pfnCallBack, void *pvParam);
702	RTDECL(int) RTAvlroIOPortDestroy(PAVLROIOPORTTREE pTree, PAVLROIOPORTCALLBACK pfnCallBack, void *pvParam);
703
704	/** @} */
705
706
707	/** AVL tree of RTHCPHYSes.
708	* @{
709	*/
710
711	/**
712	* AVL 'pointer' type for the relative offset pointer scheme.
713	*/
714	typedef struct _AVLHCPhysNodeCore *AVLHCPHYSPTR;
715
716	/**
717	* AVL Core node.
718	*/
719	typedef struct _AVLHCPhysNodeCore
720	{
721	/** Offset to the left leaf node, relative to this field. */
722	AVLHCPHYSPTR pLeft;
723	/** Offset to the right leaf node, relative to this field. */
724	AVLHCPHYSPTR pRight;
725	/** Key value. */
726	RTHCPHYS Key;
727	/** Height of this tree: max(height(left), height(right)) + 1 */
728	unsigned char uchHeight;
729	} AVLHCPHYSNODECORE, *PAVLHCPHYSNODECORE;
730
731	/** A offset base tree with RTHCPHYS keys. */
732	typedef AVLHCPHYSPTR AVLHCPHYSTREE;
733	/** Pointer to a offset base tree with RTHCPHYS keys. */
734	typedef AVLHCPHYSTREE *PAVLHCPHYSTREE;
735
736	/** Pointer to an internal tree pointer.
737	* In this case it's a pointer to a relative offset. */
738	typedef AVLHCPHYSTREE *PPAVLHCPHYSNODECORE;
739
740	/** Callback function for RTAvlHCPhysDoWithAll() and RTAvlHCPhysDestroy(). */
741	typedef DECLCALLBACK(int) AVLHCPHYSCALLBACK(PAVLHCPHYSNODECORE pNode, void *pvUser);
742	/** Pointer to callback function for RTAvlHCPhysDoWithAll() and RTAvlHCPhysDestroy(). */
743	typedef AVLHCPHYSCALLBACK *PAVLHCPHYSCALLBACK;
744
745	RTDECL(bool) RTAvlHCPhysInsert(PAVLHCPHYSTREE pTree, PAVLHCPHYSNODECORE pNode);
746	RTDECL(PAVLHCPHYSNODECORE) RTAvlHCPhysRemove(PAVLHCPHYSTREE pTree, RTHCPHYS Key);
747	RTDECL(PAVLHCPHYSNODECORE) RTAvlHCPhysGet(PAVLHCPHYSTREE pTree, RTHCPHYS Key);
748	RTDECL(int) RTAvlHCPhysDoWithAll(PAVLHCPHYSTREE pTree, int fFromLeft, PAVLHCPHYSCALLBACK pfnCallBack, void *pvParam);
749	RTDECL(PAVLHCPHYSNODECORE) RTAvlHCPhysGetBestFit(PAVLHCPHYSTREE ppTree, RTHCPHYS Key, bool fAbove);
750	RTDECL(PAVLHCPHYSNODECORE) RTAvlHCPhysRemoveBestFit(PAVLHCPHYSTREE ppTree, RTHCPHYS Key, bool fAbove);
751	RTDECL(int) RTAvlHCPhysDestroy(PAVLHCPHYSTREE pTree, PAVLHCPHYSCALLBACK pfnCallBack, void *pvParam);
752
753	/** @} */
754
755
756	/** @} */
757
758	__END_DECLS
759
760	#endif
761

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/include/iprt/avl.h@ 6981

Download in other formats: