avl.h@ 7051

Last change on this file since 7051 was 7051, checked in by vboxsync, 17 years ago
Realigning after RTGCPHYS change.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 30.6 KB

Line
1	/** @file
2	* innotek Portable Runtime - AVL Trees.
3	*/
4
5	/*
6	* Copyright (C) 1999-2003 knut st. osmundsen <[email protected]>
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	/** Make sure the structure is a multiple of 8 in size. */
274	unsigned char Padding[7];
275	} AVLROGCPHYSNODECORE, *PAVLROGCPHYSNODECORE;
276
277	/** A offset base tree with uint32_t keys. */
278	typedef AVLROGCPHYS AVLROGCPHYSTREE;
279	/** Pointer to a offset base tree with uint32_t keys. */
280	typedef AVLROGCPHYSTREE *PAVLROGCPHYSTREE;
281
282	/** Pointer to an internal tree pointer.
283	* In this case it's a pointer to a relative offset. */
284	typedef AVLROGCPHYSTREE *PPAVLROGCPHYSNODECORE;
285
286	/** Callback function for RTAvlroGCPhysDoWithAll() and RTAvlroGCPhysDestroy(). */
287	typedef DECLCALLBACK(int) AVLROGCPHYSCALLBACK(PAVLROGCPHYSNODECORE pNode, void *pvUser);
288	/** Pointer to callback function for RTAvlroGCPhysDoWithAll() and RTAvlroGCPhysDestroy(). */
289	typedef AVLROGCPHYSCALLBACK *PAVLROGCPHYSCALLBACK;
290
291	RTDECL(bool) RTAvlroGCPhysInsert(PAVLROGCPHYSTREE pTree, PAVLROGCPHYSNODECORE pNode);
292	RTDECL(PAVLROGCPHYSNODECORE) RTAvlroGCPhysRemove(PAVLROGCPHYSTREE pTree, RTGCPHYS Key);
293	RTDECL(PAVLROGCPHYSNODECORE) RTAvlroGCPhysGet(PAVLROGCPHYSTREE pTree, RTGCPHYS Key);
294	RTDECL(PAVLROGCPHYSNODECORE) RTAvlroGCPhysRangeGet(PAVLROGCPHYSTREE pTree, RTGCPHYS Key);
295	RTDECL(PAVLROGCPHYSNODECORE) RTAvlroGCPhysRangeRemove(PAVLROGCPHYSTREE pTree, RTGCPHYS Key);
296	RTDECL(PAVLROGCPHYSNODECORE) RTAvlroGCPhysGetBestFit(PAVLROGCPHYSTREE ppTree, RTGCPHYS Key, bool fAbove);
297	RTDECL(int) RTAvlroGCPhysDoWithAll(PAVLROGCPHYSTREE pTree, int fFromLeft, PAVLROGCPHYSCALLBACK pfnCallBack, void *pvParam);
298	RTDECL(int) RTAvlroGCPhysDestroy(PAVLROGCPHYSTREE pTree, PAVLROGCPHYSCALLBACK pfnCallBack, void *pvParam);
299	RTDECL(PAVLROGCPHYSNODECORE) RTAvlroGCPhysGetRoot(PAVLROGCPHYSTREE pTree);
300	RTDECL(PAVLROGCPHYSNODECORE) RTAvlroGCPhysGetLeft(PAVLROGCPHYSNODECORE pNode);
301	RTDECL(PAVLROGCPHYSNODECORE) RTAvlroGCPhysGetRight(PAVLROGCPHYSNODECORE pNode);
302
303	/** @} */
304
305
306	/** AVL tree of RTGCPTRs.
307	* @{
308	*/
309
310	/**
311	* AVL Core node.
312	*/
313	typedef struct _AVLGCPtrNodeCore
314	{
315	/** Key value. */
316	RTGCPTR Key;
317	/** Pointer to the left node. */
318	struct _AVLGCPtrNodeCore *pLeft;
319	/** Pointer to the right node. */
320	struct _AVLGCPtrNodeCore *pRight;
321	/** Height of this tree: max(height(left), height(right)) + 1 */
322	unsigned char uchHeight;
323	} AVLGCPTRNODECORE, PAVLGCPTRNODECORE, *PPAVLGCPTRNODECORE;
324
325	/** A tree of RTGCPTR keys. */
326	typedef PAVLGCPTRNODECORE AVLGCPTRTREE;
327	/** Pointer to a tree of RTGCPTR keys. */
328	typedef PPAVLGCPTRNODECORE PAVLGCPTRTREE;
329
330	/** Callback function for RTAvlGCPtrDoWithAll(). */
331	typedef DECLCALLBACK(int) AVLGCPTRCALLBACK(PAVLGCPTRNODECORE pNode, void *pvUser);
332	/** Pointer to callback function for RTAvlGCPtrDoWithAll(). */
333	typedef AVLGCPTRCALLBACK *PAVLGCPTRCALLBACK;
334
335	RTDECL(bool) RTAvlGCPtrInsert(PAVLGCPTRTREE pTree, PAVLGCPTRNODECORE pNode);
336	RTDECL(PAVLGCPTRNODECORE) RTAvlGCPtrRemove(PAVLGCPTRTREE pTree, RTGCPTR Key);
337	RTDECL(PAVLGCPTRNODECORE) RTAvlGCPtrGet(PAVLGCPTRTREE pTree, RTGCPTR Key);
338	RTDECL(int) RTAvlGCPtrDoWithAll(PAVLGCPTRTREE pTree, int fFromLeft, PAVLGCPTRCALLBACK pfnCallBack, void *pvParam);
339	RTDECL(PAVLGCPTRNODECORE) RTAvlGCPtrGetBestFit(PAVLGCPTRTREE ppTree, RTGCPTR Key, bool fAbove);
340	RTDECL(PAVLGCPTRNODECORE) RTAvlGCPtrRemoveBestFit(PAVLGCPTRTREE ppTree, RTGCPTR Key, bool fAbove);
341	RTDECL(int) RTAvlGCPtrDestroy(PAVLGCPTRTREE pTree, PAVLGCPTRCALLBACK pfnCallBack, void *pvParam);
342
343	/** @} */
344
345
346	/** AVL tree of RTGCPTRs - using relative offsets internally.
347	* @{
348	*/
349
350	/**
351	* AVL 'pointer' type for the relative offset pointer scheme.
352	*/
353	typedef int32_t AVLOGCPTR;
354
355	/**
356	* AVL Core node.
357	*/
358	typedef struct _AVLOGCPtrNodeCore
359	{
360	/** Key value. */
361	RTGCPTR Key;
362	/** Offset to the left leaf node, relative to this field. */
363	AVLOGCPTR pLeft;
364	/** Offset to the right leaf node, relative to this field. */
365	AVLOGCPTR pRight;
366	/** Height of this tree: max(height(left), height(right)) + 1 */
367	unsigned char uchHeight;
368	} AVLOGCPTRNODECORE, *PAVLOGCPTRNODECORE;
369
370	/** A offset base tree with uint32_t keys. */
371	typedef AVLOGCPTR AVLOGCPTRTREE;
372	/** Pointer to a offset base tree with uint32_t keys. */
373	typedef AVLOGCPTRTREE *PAVLOGCPTRTREE;
374
375	/** Pointer to an internal tree pointer.
376	* In this case it's a pointer to a relative offset. */
377	typedef AVLOGCPTRTREE *PPAVLOGCPTRNODECORE;
378
379	/** Callback function for RTAvloGCPtrDoWithAll(). */
380	typedef DECLCALLBACK(int) AVLOGCPTRCALLBACK(PAVLOGCPTRNODECORE pNode, void *pvUser);
381	/** Pointer to callback function for RTAvloGCPtrDoWithAll(). */
382	typedef AVLOGCPTRCALLBACK *PAVLOGCPTRCALLBACK;
383
384	RTDECL(bool) RTAvloGCPtrInsert(PAVLOGCPTRTREE pTree, PAVLOGCPTRNODECORE pNode);
385	RTDECL(PAVLOGCPTRNODECORE) RTAvloGCPtrRemove(PAVLOGCPTRTREE pTree, RTGCPTR Key);
386	RTDECL(PAVLOGCPTRNODECORE) RTAvloGCPtrGet(PAVLOGCPTRTREE pTree, RTGCPTR Key);
387	RTDECL(int) RTAvloGCPtrDoWithAll(PAVLOGCPTRTREE pTree, int fFromLeft, PAVLOGCPTRCALLBACK pfnCallBack, void *pvParam);
388	RTDECL(PAVLOGCPTRNODECORE) RTAvloGCPtrGetBestFit(PAVLOGCPTRTREE ppTree, RTGCPTR Key, bool fAbove);
389	RTDECL(PAVLOGCPTRNODECORE) RTAvloGCPtrRemoveBestFit(PAVLOGCPTRTREE ppTree, RTGCPTR Key, bool fAbove);
390	RTDECL(int) RTAvloGCPtrDestroy(PAVLOGCPTRTREE pTree, PAVLOGCPTRCALLBACK pfnCallBack, void *pvParam);
391
392	/** @} */
393
394
395	/** AVL tree of RTGCPTR ranges.
396	* @{
397	*/
398
399	/**
400	* AVL Core node.
401	*/
402	typedef struct _AVLRGCPtrNodeCore
403	{
404	/** First key value in the range (inclusive). */
405	RTGCPTR Key;
406	/** Last key value in the range (inclusive). */
407	RTGCPTR KeyLast;
408	/** Offset to the left leaf node, relative to this field. */
409	struct _AVLRGCPtrNodeCore *pLeft;
410	/** Offset to the right leaf node, relative to this field. */
411	struct _AVLRGCPtrNodeCore *pRight;
412	/** Height of this tree: max(height(left), height(right)) + 1 */
413	unsigned char uchHeight;
414	} AVLRGCPTRNODECORE, *PAVLRGCPTRNODECORE;
415
416	/** A offset base tree with RTGCPTR keys. */
417	typedef PAVLRGCPTRNODECORE AVLRGCPTRTREE;
418	/** Pointer to a offset base tree with RTGCPTR keys. */
419	typedef AVLRGCPTRTREE *PAVLRGCPTRTREE;
420
421	/** Pointer to an internal tree pointer.
422	* In this case it's a pointer to a relative offset. */
423	typedef AVLRGCPTRTREE *PPAVLRGCPTRNODECORE;
424
425	/** Callback function for RTAvlrGCPtrDoWithAll() and RTAvlrGCPtrDestroy(). */
426	typedef DECLCALLBACK(int) AVLRGCPTRCALLBACK(PAVLRGCPTRNODECORE pNode, void *pvUser);
427	/** Pointer to callback function for RTAvlrGCPtrDoWithAll() and RTAvlrGCPtrDestroy(). */
428	typedef AVLRGCPTRCALLBACK *PAVLRGCPTRCALLBACK;
429
430	RTDECL(bool) RTAvlrGCPtrInsert( PAVLRGCPTRTREE pTree, PAVLRGCPTRNODECORE pNode);
431	RTDECL(PAVLRGCPTRNODECORE) RTAvlrGCPtrRemove( PAVLRGCPTRTREE pTree, RTGCPTR Key);
432	RTDECL(PAVLRGCPTRNODECORE) RTAvlrGCPtrGet( PAVLRGCPTRTREE pTree, RTGCPTR Key);
433	RTDECL(PAVLRGCPTRNODECORE) RTAvlrGCPtrGetBestFit( PAVLRGCPTRTREE pTree, RTGCPTR Key, bool fAbove);
434	RTDECL(PAVLRGCPTRNODECORE) RTAvlrGCPtrRangeGet( PAVLRGCPTRTREE pTree, RTGCPTR Key);
435	RTDECL(PAVLRGCPTRNODECORE) RTAvlrGCPtrRangeRemove( PAVLRGCPTRTREE pTree, RTGCPTR Key);
436	RTDECL(int) RTAvlrGCPtrDoWithAll( PAVLRGCPTRTREE pTree, int fFromLeft, PAVLRGCPTRCALLBACK pfnCallBack, void *pvParam);
437	RTDECL(int) RTAvlrGCPtrDestroy( PAVLRGCPTRTREE pTree, PAVLRGCPTRCALLBACK pfnCallBack, void *pvParam);
438	RTDECL(PAVLRGCPTRNODECORE) RTAvlrGCPtrGetRoot( PAVLRGCPTRTREE pTree);
439	RTDECL(PAVLRGCPTRNODECORE) RTAvlrGCPtrGetLeft( PAVLRGCPTRNODECORE pNode);
440	RTDECL(PAVLRGCPTRNODECORE) RTAvlrGCPtrGetRight( PAVLRGCPTRNODECORE pNode);
441
442	/** @} */
443
444
445	/** AVL tree of RTGCPTR ranges - using relative offsets internally.
446	* @{
447	*/
448
449	/**
450	* AVL 'pointer' type for the relative offset pointer scheme.
451	*/
452	typedef int32_t AVLROGCPTR;
453
454	/**
455	* AVL Core node.
456	*/
457	typedef struct _AVLROGCPtrNodeCore
458	{
459	/** First key value in the range (inclusive). */
460	RTGCPTR Key;
461	/** Last key value in the range (inclusive). */
462	RTGCPTR KeyLast;
463	/** Offset to the left leaf node, relative to this field. */
464	AVLROGCPTR pLeft;
465	/** Offset to the right leaf node, relative to this field. */
466	AVLROGCPTR pRight;
467	/** Height of this tree: max(height(left), height(right)) + 1 */
468	unsigned char uchHeight;
469	} AVLROGCPTRNODECORE, *PAVLROGCPTRNODECORE;
470
471	/** A offset base tree with uint32_t keys. */
472	typedef AVLROGCPTR AVLROGCPTRTREE;
473	/** Pointer to a offset base tree with uint32_t keys. */
474	typedef AVLROGCPTRTREE *PAVLROGCPTRTREE;
475
476	/** Pointer to an internal tree pointer.
477	* In this case it's a pointer to a relative offset. */
478	typedef AVLROGCPTRTREE *PPAVLROGCPTRNODECORE;
479
480	/** Callback function for RTAvlroGCPtrDoWithAll() and RTAvlroGCPtrDestroy(). */
481	typedef DECLCALLBACK(int) AVLROGCPTRCALLBACK(PAVLROGCPTRNODECORE pNode, void *pvUser);
482	/** Pointer to callback function for RTAvlroGCPtrDoWithAll() and RTAvlroGCPtrDestroy(). */
483	typedef AVLROGCPTRCALLBACK *PAVLROGCPTRCALLBACK;
484
485	RTDECL(bool) RTAvlroGCPtrInsert(PAVLROGCPTRTREE pTree, PAVLROGCPTRNODECORE pNode);
486	RTDECL(PAVLROGCPTRNODECORE) RTAvlroGCPtrRemove(PAVLROGCPTRTREE pTree, RTGCPTR Key);
487	RTDECL(PAVLROGCPTRNODECORE) RTAvlroGCPtrGet(PAVLROGCPTRTREE pTree, RTGCPTR Key);
488	RTDECL(PAVLROGCPTRNODECORE) RTAvlroGCPtrGetBestFit(PAVLROGCPTRTREE ppTree, RTGCPTR Key, bool fAbove);
489	RTDECL(PAVLROGCPTRNODECORE) RTAvlroGCPtrRangeGet(PAVLROGCPTRTREE pTree, RTGCPTR Key);
490	RTDECL(PAVLROGCPTRNODECORE) RTAvlroGCPtrRangeRemove(PAVLROGCPTRTREE pTree, RTGCPTR Key);
491	RTDECL(int) RTAvlroGCPtrDoWithAll(PAVLROGCPTRTREE pTree, int fFromLeft, PAVLROGCPTRCALLBACK pfnCallBack, void *pvParam);
492	RTDECL(int) RTAvlroGCPtrDestroy(PAVLROGCPTRTREE pTree, PAVLROGCPTRCALLBACK pfnCallBack, void *pvParam);
493	RTDECL(PAVLROGCPTRNODECORE) RTAvlroGCPtrGetRoot(PAVLROGCPTRTREE pTree);
494	RTDECL(PAVLROGCPTRNODECORE) RTAvlroGCPtrGetLeft(PAVLROGCPTRNODECORE pNode);
495	RTDECL(PAVLROGCPTRNODECORE) RTAvlroGCPtrGetRight(PAVLROGCPTRNODECORE pNode);
496
497	/** @} */
498
499
500	/** AVL tree of RTGCPTR ranges (overlapping supported) - using relative offsets internally.
501	* @{
502	*/
503
504	/**
505	* AVL 'pointer' type for the relative offset pointer scheme.
506	*/
507	typedef int32_t AVLROOGCPTR;
508
509	/**
510	* AVL Core node.
511	*/
512	typedef struct _AVLROOGCPtrNodeCore
513	{
514	/** First key value in the range (inclusive). */
515	RTGCPTR Key;
516	/** Last key value in the range (inclusive). */
517	RTGCPTR KeyLast;
518	/** Offset to the left leaf node, relative to this field. */
519	AVLROOGCPTR pLeft;
520	/** Offset to the right leaf node, relative to this field. */
521	AVLROOGCPTR pRight;
522	/** Pointer to the list of string with the same key. Don't touch. */
523	AVLROOGCPTR pList;
524	/** Height of this tree: max(height(left), height(right)) + 1 */
525	unsigned char uchHeight;
526	} AVLROOGCPTRNODECORE, *PAVLROOGCPTRNODECORE;
527
528	/** A offset base tree with uint32_t keys. */
529	typedef AVLROOGCPTR AVLROOGCPTRTREE;
530	/** Pointer to a offset base tree with uint32_t keys. */
531	typedef AVLROOGCPTRTREE *PAVLROOGCPTRTREE;
532
533	/** Pointer to an internal tree pointer.
534	* In this case it's a pointer to a relative offset. */
535	typedef AVLROOGCPTRTREE *PPAVLROOGCPTRNODECORE;
536
537	/** Callback function for RTAvlrooGCPtrDoWithAll() and RTAvlrooGCPtrDestroy(). */
538	typedef DECLCALLBACK(int) AVLROOGCPTRCALLBACK(PAVLROOGCPTRNODECORE pNode, void *pvUser);
539	/** Pointer to callback function for RTAvlrooGCPtrDoWithAll() and RTAvlrooGCPtrDestroy(). */
540	typedef AVLROOGCPTRCALLBACK *PAVLROOGCPTRCALLBACK;
541
542	RTDECL(bool) RTAvlrooGCPtrInsert(PAVLROOGCPTRTREE pTree, PAVLROOGCPTRNODECORE pNode);
543	RTDECL(PAVLROOGCPTRNODECORE) RTAvlrooGCPtrRemove(PAVLROOGCPTRTREE pTree, RTGCPTR Key);
544	RTDECL(PAVLROOGCPTRNODECORE) RTAvlrooGCPtrGet(PAVLROOGCPTRTREE pTree, RTGCPTR Key);
545	RTDECL(PAVLROOGCPTRNODECORE) RTAvlrooGCPtrGetBestFit(PAVLROOGCPTRTREE ppTree, RTGCPTR Key, bool fAbove);
546	RTDECL(PAVLROOGCPTRNODECORE) RTAvlrooGCPtrRangeGet(PAVLROOGCPTRTREE pTree, RTGCPTR Key);
547	RTDECL(PAVLROOGCPTRNODECORE) RTAvlrooGCPtrRangeRemove(PAVLROOGCPTRTREE pTree, RTGCPTR Key);
548	RTDECL(int) RTAvlrooGCPtrDoWithAll(PAVLROOGCPTRTREE pTree, int fFromLeft, PAVLROOGCPTRCALLBACK pfnCallBack, void *pvParam);
549	RTDECL(int) RTAvlrooGCPtrDestroy(PAVLROOGCPTRTREE pTree, PAVLROOGCPTRCALLBACK pfnCallBack, void *pvParam);
550	RTDECL(PAVLROOGCPTRNODECORE) RTAvlrooGCPtrGetRoot(PAVLROOGCPTRTREE pTree);
551	RTDECL(PAVLROOGCPTRNODECORE) RTAvlrooGCPtrGetLeft(PAVLROOGCPTRNODECORE pNode);
552	RTDECL(PAVLROOGCPTRNODECORE) RTAvlrooGCPtrGetRight(PAVLROOGCPTRNODECORE pNode);
553	RTDECL(PAVLROOGCPTRNODECORE) RTAvlrooGCPtrGetNextEqual(PAVLROOGCPTRNODECORE pNode);
554
555	/** @} */
556
557
558	/** AVL tree of RTHCPHYSes - using relative offsets internally.
559	* @{
560	*/
561
562	/**
563	* AVL 'pointer' type for the relative offset pointer scheme.
564	*/
565	typedef int32_t AVLOHCPHYS;
566
567	/**
568	* AVL Core node.
569	*/
570	typedef struct _AVLOHCPhysNodeCore
571	{
572	/** Key value. */
573	RTHCPHYS Key;
574	/** Offset to the left leaf node, relative to this field. */
575	AVLOHCPHYS pLeft;
576	/** Offset to the right leaf node, relative to this field. */
577	AVLOHCPHYS pRight;
578	/** Height of this tree: max(height(left), height(right)) + 1 */
579	unsigned char uchHeight;
580	#if HC_ARCH_BITS == 64 \|\| GC_ARCH_BITS == 64
581	unsigned char Padding[7]; /*< Alignment padding. /
582	#endif
583	} AVLOHCPHYSNODECORE, *PAVLOHCPHYSNODECORE;
584
585	/** A offset base tree with uint32_t keys. */
586	typedef AVLOHCPHYS AVLOHCPHYSTREE;
587	/** Pointer to a offset base tree with uint32_t keys. */
588	typedef AVLOHCPHYSTREE *PAVLOHCPHYSTREE;
589
590	/** Pointer to an internal tree pointer.
591	* In this case it's a pointer to a relative offset. */
592	typedef AVLOHCPHYSTREE *PPAVLOHCPHYSNODECORE;
593
594	/** Callback function for RTAvloHCPhysDoWithAll() and RTAvloHCPhysDestroy(). */
595	typedef DECLCALLBACK(int) AVLOHCPHYSCALLBACK(PAVLOHCPHYSNODECORE pNode, void *pvUser);
596	/** Pointer to callback function for RTAvloHCPhysDoWithAll() and RTAvloHCPhysDestroy(). */
597	typedef AVLOHCPHYSCALLBACK *PAVLOHCPHYSCALLBACK;
598
599	RTDECL(bool) RTAvloHCPhysInsert(PAVLOHCPHYSTREE pTree, PAVLOHCPHYSNODECORE pNode);
600	RTDECL(PAVLOHCPHYSNODECORE) RTAvloHCPhysRemove(PAVLOHCPHYSTREE pTree, RTHCPHYS Key);
601	RTDECL(PAVLOHCPHYSNODECORE) RTAvloHCPhysGet(PAVLOHCPHYSTREE pTree, RTHCPHYS Key);
602	RTDECL(int) RTAvloHCPhysDoWithAll(PAVLOHCPHYSTREE pTree, int fFromLeft, PAVLOHCPHYSCALLBACK pfnCallBack, void *pvParam);
603	RTDECL(PAVLOHCPHYSNODECORE) RTAvloHCPhysGetBestFit(PAVLOHCPHYSTREE ppTree, RTHCPHYS Key, bool fAbove);
604	RTDECL(PAVLOHCPHYSNODECORE) RTAvloHCPhysRemoveBestFit(PAVLOHCPHYSTREE ppTree, RTHCPHYS Key, bool fAbove);
605	RTDECL(int) RTAvloHCPhysDestroy(PAVLOHCPHYSTREE pTree, PAVLOHCPHYSCALLBACK pfnCallBack, void *pvParam);
606
607	/** @} */
608
609
610
611	/** AVL tree of RTIOPORTs - using relative offsets internally.
612	* @{
613	*/
614
615	/**
616	* AVL 'pointer' type for the relative offset pointer scheme.
617	*/
618	typedef int32_t AVLOIOPORTPTR;
619
620	/**
621	* AVL Core node.
622	*/
623	typedef struct _AVLOIOPortNodeCore
624	{
625	/** Offset to the left leaf node, relative to this field. */
626	AVLOIOPORTPTR pLeft;
627	/** Offset to the right leaf node, relative to this field. */
628	AVLOIOPORTPTR pRight;
629	/** Key value. */
630	RTIOPORT Key;
631	/** Height of this tree: max(height(left), height(right)) + 1 */
632	unsigned char uchHeight;
633	} AVLOIOPORTNODECORE, *PAVLOIOPORTNODECORE;
634
635	/** A offset base tree with uint32_t keys. */
636	typedef AVLOIOPORTPTR AVLOIOPORTTREE;
637	/** Pointer to a offset base tree with uint32_t keys. */
638	typedef AVLOIOPORTTREE *PAVLOIOPORTTREE;
639
640	/** Pointer to an internal tree pointer.
641	* In this case it's a pointer to a relative offset. */
642	typedef AVLOIOPORTTREE *PPAVLOIOPORTNODECORE;
643
644	/** Callback function for RTAvloIOPortDoWithAll() and RTAvloIOPortDestroy(). */
645	typedef DECLCALLBACK(int) AVLOIOPORTCALLBACK(PAVLOIOPORTNODECORE pNode, void *pvUser);
646	/** Pointer to callback function for RTAvloIOPortDoWithAll() and RTAvloIOPortDestroy(). */
647	typedef AVLOIOPORTCALLBACK *PAVLOIOPORTCALLBACK;
648
649	RTDECL(bool) RTAvloIOPortInsert(PAVLOIOPORTTREE pTree, PAVLOIOPORTNODECORE pNode);
650	RTDECL(PAVLOIOPORTNODECORE) RTAvloIOPortRemove(PAVLOIOPORTTREE pTree, RTIOPORT Key);
651	RTDECL(PAVLOIOPORTNODECORE) RTAvloIOPortGet(PAVLOIOPORTTREE pTree, RTIOPORT Key);
652	RTDECL(int) RTAvloIOPortDoWithAll(PAVLOIOPORTTREE pTree, int fFromLeft, PAVLOIOPORTCALLBACK pfnCallBack, void *pvParam);
653	RTDECL(int) RTAvloIOPortDestroy(PAVLOIOPORTTREE pTree, PAVLOIOPORTCALLBACK pfnCallBack, void *pvParam);
654
655	/** @} */
656
657
658	/** AVL tree of RTIOPORT ranges - using relative offsets internally.
659	* @{
660	*/
661
662	/**
663	* AVL 'pointer' type for the relative offset pointer scheme.
664	*/
665	typedef int32_t AVLROIOPORTPTR;
666
667	/**
668	* AVL Core node.
669	*/
670	typedef struct _AVLROIOPortNodeCore
671	{
672	/** First key value in the range (inclusive). */
673	RTIOPORT Key;
674	/** Last key value in the range (inclusive). */
675	RTIOPORT KeyLast;
676	/** Offset to the left leaf node, relative to this field. */
677	AVLROIOPORTPTR pLeft;
678	/** Offset to the right leaf node, relative to this field. */
679	AVLROIOPORTPTR pRight;
680	/** Height of this tree: max(height(left), height(right)) + 1 */
681	unsigned char uchHeight;
682	} AVLROIOPORTNODECORE, *PAVLROIOPORTNODECORE;
683
684	/** A offset base tree with uint32_t keys. */
685	typedef AVLROIOPORTPTR AVLROIOPORTTREE;
686	/** Pointer to a offset base tree with uint32_t keys. */
687	typedef AVLROIOPORTTREE *PAVLROIOPORTTREE;
688
689	/** Pointer to an internal tree pointer.
690	* In this case it's a pointer to a relative offset. */
691	typedef AVLROIOPORTTREE *PPAVLROIOPORTNODECORE;
692
693	/** Callback function for RTAvlroIOPortDoWithAll() and RTAvlroIOPortDestroy(). */
694	typedef DECLCALLBACK(int) AVLROIOPORTCALLBACK(PAVLROIOPORTNODECORE pNode, void *pvUser);
695	/** Pointer to callback function for RTAvlroIOPortDoWithAll() and RTAvlroIOPortDestroy(). */
696	typedef AVLROIOPORTCALLBACK *PAVLROIOPORTCALLBACK;
697
698	RTDECL(bool) RTAvlroIOPortInsert(PAVLROIOPORTTREE pTree, PAVLROIOPORTNODECORE pNode);
699	RTDECL(PAVLROIOPORTNODECORE) RTAvlroIOPortRemove(PAVLROIOPORTTREE pTree, RTIOPORT Key);
700	RTDECL(PAVLROIOPORTNODECORE) RTAvlroIOPortGet(PAVLROIOPORTTREE pTree, RTIOPORT Key);
701	RTDECL(PAVLROIOPORTNODECORE) RTAvlroIOPortRangeGet(PAVLROIOPORTTREE pTree, RTIOPORT Key);
702	RTDECL(PAVLROIOPORTNODECORE) RTAvlroIOPortRangeRemove(PAVLROIOPORTTREE pTree, RTIOPORT Key);
703	RTDECL(int) RTAvlroIOPortDoWithAll(PAVLROIOPORTTREE pTree, int fFromLeft, PAVLROIOPORTCALLBACK pfnCallBack, void *pvParam);
704	RTDECL(int) RTAvlroIOPortDestroy(PAVLROIOPORTTREE pTree, PAVLROIOPORTCALLBACK pfnCallBack, void *pvParam);
705
706	/** @} */
707
708
709	/** AVL tree of RTHCPHYSes.
710	* @{
711	*/
712
713	/**
714	* AVL 'pointer' type for the relative offset pointer scheme.
715	*/
716	typedef struct _AVLHCPhysNodeCore *AVLHCPHYSPTR;
717
718	/**
719	* AVL Core node.
720	*/
721	typedef struct _AVLHCPhysNodeCore
722	{
723	/** Offset to the left leaf node, relative to this field. */
724	AVLHCPHYSPTR pLeft;
725	/** Offset to the right leaf node, relative to this field. */
726	AVLHCPHYSPTR pRight;
727	/** Key value. */
728	RTHCPHYS Key;
729	/** Height of this tree: max(height(left), height(right)) + 1 */
730	unsigned char uchHeight;
731	} AVLHCPHYSNODECORE, *PAVLHCPHYSNODECORE;
732
733	/** A offset base tree with RTHCPHYS keys. */
734	typedef AVLHCPHYSPTR AVLHCPHYSTREE;
735	/** Pointer to a offset base tree with RTHCPHYS keys. */
736	typedef AVLHCPHYSTREE *PAVLHCPHYSTREE;
737
738	/** Pointer to an internal tree pointer.
739	* In this case it's a pointer to a relative offset. */
740	typedef AVLHCPHYSTREE *PPAVLHCPHYSNODECORE;
741
742	/** Callback function for RTAvlHCPhysDoWithAll() and RTAvlHCPhysDestroy(). */
743	typedef DECLCALLBACK(int) AVLHCPHYSCALLBACK(PAVLHCPHYSNODECORE pNode, void *pvUser);
744	/** Pointer to callback function for RTAvlHCPhysDoWithAll() and RTAvlHCPhysDestroy(). */
745	typedef AVLHCPHYSCALLBACK *PAVLHCPHYSCALLBACK;
746
747	RTDECL(bool) RTAvlHCPhysInsert(PAVLHCPHYSTREE pTree, PAVLHCPHYSNODECORE pNode);
748	RTDECL(PAVLHCPHYSNODECORE) RTAvlHCPhysRemove(PAVLHCPHYSTREE pTree, RTHCPHYS Key);
749	RTDECL(PAVLHCPHYSNODECORE) RTAvlHCPhysGet(PAVLHCPHYSTREE pTree, RTHCPHYS Key);
750	RTDECL(int) RTAvlHCPhysDoWithAll(PAVLHCPHYSTREE pTree, int fFromLeft, PAVLHCPHYSCALLBACK pfnCallBack, void *pvParam);
751	RTDECL(PAVLHCPHYSNODECORE) RTAvlHCPhysGetBestFit(PAVLHCPHYSTREE ppTree, RTHCPHYS Key, bool fAbove);
752	RTDECL(PAVLHCPHYSNODECORE) RTAvlHCPhysRemoveBestFit(PAVLHCPHYSTREE ppTree, RTHCPHYS Key, bool fAbove);
753	RTDECL(int) RTAvlHCPhysDestroy(PAVLHCPHYSTREE pTree, PAVLHCPHYSCALLBACK pfnCallBack, void *pvParam);
754
755	/** @} */
756
757
758	/** @} */
759
760	__END_DECLS
761
762	#endif
763

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

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

Download in other formats: