1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
|
/** @file
* IPRT - Vector - STL-inspired vector implementation in C.
*/
/*
* Copyright (C) 2011-2025 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program 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, in version 3 of the
* License.
*
* This program 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 this program; if not, see <https://www.gnu.org/licenses>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
/**
* @todo the right Doxygen tag here
* This file defines a set of macros which provide a functionality and an
* interface roughly similar to the C++ STL vector container. To create a
* vector of a particular type one must first explicitly instantiate such a
* vector in the source file, e.g.
* RTVEC_DECL(TopLevels, Window *)
* without a semi-colon. This macro will define a structure (struct TopLevels)
* which contains a dynamically resizeable array of Window * elements. It
* will also define a number of inline methods for manipulating the structure,
* such as
* Window *TopLevelsPushBack(struct TopLevels *)
* which adds a new element to the end of the array and returns it, optionally
* reallocating the array if there is not enough space for the new element.
* (This particular method prototype differs from the STL equivalent -
* push_back - more than most of the other methods).
*
* To create a vector, one simply needs to declare the structure, in this case
* struct TopLevels = RTVEC_INITIALIZER;
*
* There are various other macros for declaring vectors with different
* allocators (e.g. RTVEC_DECL_ALLOCATOR) or with clean-up functions
* (e.g. RTVEC_DECL_DELETE). See the descriptions of the generic methods and
* the declarator macros below.
*
* One particular use of vectors is to assemble an array of a particular type
* in heap memory without knowing - or counting - the number of elements in
* advance. To do this, add the elements onto the array using PushBack, then
* extract the array from the vector using the (non-STL) Detach method.
*
* @note functions in this file are inline to prevent warnings about
* unused static functions. I assume that in this day and age a
* compiler makes its own decisions about whether to actually
* inline a function.
* @note since vector structures must be explicitly instanciated unlike the
* C++ vector template, care must be taken not to instanciate a
* particular type twice, e.g. once in a header and once in a code file.
* Only using vectors in code files and keeping them out of interfaces
* (or passing them as anonymously) makes it easier to take care of this.
*/
#ifndef IPRT_INCLUDED_vector_h
#define IPRT_INCLUDED_vector_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
/*******************************************************************************
* Header Files *
*******************************************************************************/
#include <iprt/assert.h>
#include <iprt/cdefs.h>
#include <iprt/errcore.h>
#include <iprt/mem.h> /** @todo Should the caller include this if they need
* it? */
/**
* Generic vector structure
*/
/** @todo perhaps we should include an additional member for a parameter to
* three-argument reallocators, so that we can support e.g. mempools? */
#define RTVEC_DECL_STRUCT(name, type) \
struct name \
{ \
/** The number of elements in the vector */ \
size_t mcElements; \
/** The current capacity of the vector */ \
size_t mcCapacity; \
/** The elements themselves */ \
type *mpElements; \
};
/** Initialiser for an empty vector structure */
#define RTVEC_INITIALIZER { 0, 0, NULL }
/** The unit by which the vector capacity is increased */
#define RTVECIMPL_ALLOC_UNIT 16
/**
* Generic method - get the size of a vector
*/
/** @todo What is the correct way to do doxygen for this sort of macro? */
#define RTVEC_DECLFN_SIZE(name, type) \
DECLINLINE(size_t) name ## Size(struct name *pVec) \
{ \
return(pVec->mcElements); \
}
/**
* Generic method - expand a vector
*/
#define RTVEC_DECLFN_RESERVE(name, type, pfnRealloc) \
DECLINLINE(int) name ## Reserve(struct name *pVec, size_t cNewCapacity) \
{ \
void *pvNew; \
\
if (cNewCapacity <= pVec->mcCapacity) \
return VINF_SUCCESS; \
pvNew = pfnRealloc(pVec->mpElements, cNewCapacity * sizeof(type)); \
if (!pvNew) \
return VERR_NO_MEMORY; \
pVec->mcCapacity = cNewCapacity; \
pVec->mpElements = (type *)pvNew; \
return VINF_SUCCESS; \
}
/**
* Generic method - return a pointer to the first element in the vector.
*/
#define RTVEC_DECLFN_BEGIN(name, type) \
DECLINLINE(type *) name ## Begin(struct name *pVec) \
{ \
return(pVec->mpElements); \
}
/**
* Generic method - return a pointer to one past the last element in the
* vector.
*/
#define RTVEC_DECLFN_END(name, type) \
DECLINLINE(type *) name ## End(struct name *pVec) \
{ \
return(&pVec->mpElements[pVec->mcElements]); \
}
/**
* Generic method - add a new, uninitialised element onto a vector and return
* it.
* @note this method differs from the STL equivalent by letting the caller
* post-initialise the new element rather than copying it from its
* argument.
*/
#define RTVEC_DECLFN_PUSHBACK(name, type) \
DECLINLINE(type *) name ## PushBack(struct name *pVec) \
{ \
Assert(pVec->mcElements <= pVec->mcCapacity); \
if ( pVec->mcElements == pVec->mcCapacity \
&& RT_FAILURE(name ## Reserve(pVec, pVec->mcCapacity \
+ RTVECIMPL_ALLOC_UNIT))) \
return NULL; \
++pVec->mcElements; \
return &pVec->mpElements[pVec->mcElements - 1]; \
}
/**
* Generic method - drop the last element from the vector.
*/
#define RTVEC_DECLFN_POPBACK(name) \
DECLINLINE(void) name ## PopBack(struct name *pVec) \
{ \
Assert(pVec->mcElements <= pVec->mcCapacity); \
--pVec->mcElements; \
}
/**
* Generic method - drop the last element from the vector, calling a clean-up
* method first.
*
* By taking an adapter function for the element to be dropped as an
* additional macro parameter we can support clean-up by pointer
* (pfnAdapter maps T* -> T*) or by value (maps T* -> T). pfnAdapter takes
* one argument of type @a type * and must return whatever type pfnDelete
* expects.
*/
/** @todo find a better name for pfnAdapter? */
#define RTVEC_DECLFN_POPBACK_DELETE(name, type, pfnDelete, pfnAdapter) \
DECLINLINE(void) name ## PopBack(struct name *pVec) \
{ \
Assert(pVec->mcElements <= pVec->mcCapacity); \
--pVec->mcElements; \
pfnDelete(pfnAdapter(&pVec->mpElements[pVec->mcElements])); \
}
/**
* Generic method - reset a vector to empty.
* @note This function does not free any memory
*/
#define RTVEC_DECLFN_CLEAR(name) \
DECLINLINE(void) name ## Clear(struct name *pVec) \
{ \
Assert(pVec->mcElements <= pVec->mcCapacity); \
pVec->mcElements = 0; \
}
/**
* Generic method - reset a vector to empty, calling a clean-up method on each
* element first.
* @note See @a RTVEC_DECLFN_POPBACK_DELETE for an explanation of pfnAdapter
* @note This function does not free any memory
* @note The cleanup function is currently called on the elements from first
* to last. The testcase expects this.
*/
#define RTVEC_DECLFN_CLEAR_DELETE(name, pfnDelete, pfnAdapter) \
DECLINLINE(void) name ## Clear(struct name *pVec) \
{ \
size_t i; \
\
Assert(pVec->mcElements <= pVec->mcCapacity); \
for (i = 0; i < pVec->mcElements; ++i) \
pfnDelete(pfnAdapter(&pVec->mpElements[i])); \
pVec->mcElements = 0; \
}
/**
* Generic method - detach the array contained inside a vector and reset the
* vector to empty.
* @note This function does not free any memory
*/
#define RTVEC_DECLFN_DETACH(name, type) \
DECLINLINE(type *) name ## Detach(struct name *pVec) \
{ \
type *pArray = pVec->mpElements; \
\
Assert(pVec->mcElements <= pVec->mcCapacity); \
pVec->mcElements = 0; \
pVec->mpElements = NULL; \
pVec->mcCapacity = 0; \
return pArray; \
}
/** Common declarations for all vector types */
#define RTVEC_DECL_COMMON(name, type, pfnRealloc) \
RTVEC_DECL_STRUCT(name, type) \
RTVEC_DECLFN_SIZE(name, type) \
RTVEC_DECLFN_RESERVE(name, type, pfnRealloc) \
RTVEC_DECLFN_BEGIN(name, type) \
RTVEC_DECLFN_END(name, type) \
RTVEC_DECLFN_PUSHBACK(name, type) \
RTVEC_DECLFN_DETACH(name, type)
/**
* Declarator macro - declare a vector type
* @param name the name of the C struct type describing the vector as
* well as the prefix of the functions for manipulating it
* @param type the type of the objects contained in the vector
* @param pfnRealloc the memory reallocation function used for expanding the
* vector
*/
#define RTVEC_DECL_ALLOCATOR(name, type, pfnRealloc) \
RTVEC_DECL_COMMON(name, type, pfnRealloc) \
RTVEC_DECLFN_POPBACK(name) \
RTVEC_DECLFN_CLEAR(name)
/**
* Generic method - inline id mapping delete adapter function - see the
* explanation of pfnAdapter in @a RTVEC_DECLFN_POPBACK_DELETE.
*/
#define RTVEC_DECLFN_DELETE_ADAPTER_ID(name, type) \
DECLINLINE(type *) name ## DeleteAdapterId(type *arg) \
{ \
return arg; \
}
/**
* Generic method - inline pointer-to-value mapping delete adapter function -
* see the explanation of pfnAdapter in @a RTVEC_DECLFN_POPBACK_DELETE.
*/
#define RTVEC_DECLFN_DELETE_ADAPTER_TO_VALUE(name, type) \
DECLINLINE(type) name ## DeleteAdapterToValue(type *arg) \
{ \
return *arg; \
}
/**
* Declarator macro - declare a vector type with a cleanup callback to be used
* when elements are dropped from the vector. The callback takes a pointer to
* @a type,
* NOT a value of type @a type.
* @param name the name of the C struct type describing the vector as
* well as the prefix of the functions for manipulating it
* @param type the type of the objects contained in the vector
* @param pfnRealloc the memory reallocation function used for expanding the
* vector
* @param pfnDelete the cleanup callback function - signature
* void pfnDelete(type *)
*/
#define RTVEC_DECL_ALLOCATOR_DELETE(name, type, pfnRealloc, pfnDelete) \
RTVEC_DECL_COMMON(name, type, pfnRealloc) \
RTVEC_DECLFN_DELETE_ADAPTER_ID(name, type) \
RTVEC_DECLFN_POPBACK_DELETE(name, type, pfnDelete, \
name ## DeleteAdapterId) \
RTVEC_DECLFN_CLEAR_DELETE(name, pfnDelete, name ## DeleteAdapterId)
/**
* Declarator macro - declare a vector type with a cleanup callback to be used
* when elements are dropped from the vector. The callback takes a parameter
* of type @a type, NOT a pointer to @a type.
* @param name the name of the C struct type describing the vector as
* well as the prefix of the functions for manipulating it
* @param type the type of the objects contained in the vector
* @param pfnRealloc the memory reallocation function used for expanding the
* vector
* @param pfnDelete the cleanup callback function - signature
* void pfnDelete(type)
*/
#define RTVEC_DECL_ALLOCATOR_DELETE_BY_VALUE(name, type, pfnRealloc, \
pfnDelete) \
RTVEC_DECL_COMMON(name, type, pfnRealloc) \
RTVEC_DECLFN_DELETE_ADAPTER_TO_VALUE(name, type) \
RTVEC_DECLFN_POPBACK_DELETE(name, type, pfnDelete, \
name ## DeleteAdapterToValue) \
RTVEC_DECLFN_CLEAR_DELETE(name, pfnDelete, \
name ## DeleteAdapterToValue)
/**
* Inline wrapper around RTMemRealloc macro to get a function usable as a
* callback.
*/
DECLINLINE(void *) rtvecReallocDefTag(void *pv, size_t cbNew)
{
return RTMemRealloc(pv, cbNew);
}
/**
* Declarator macro - declare a vector type (see @a RTVEC_DECL_ALLOCATOR)
* using RTMemRealloc as a memory allocator
* @param name the name of the C struct type describing the vector as
* well as the prefix of the functions for manipulating it
* @param type the type of the objects contained in the vector
*/
#define RTVEC_DECL(name, type) \
RTVEC_DECL_ALLOCATOR(name, type, rtvecReallocDefTag)
/**
* Declarator macro - declare a vector type with a cleanup by pointer callback
* (see @a RTVEC_DECL_ALLOCATOR_DELETE) using RTMemRealloc as a memory
* allocator
* @param name the name of the C struct type describing the vector as
* well as the prefix of the functions for manipulating it
* @param type the type of the objects contained in the vector
* @param pfnDelete the cleanup callback function - signature
* void pfnDelete(type *)
*/
#define RTVEC_DECL_DELETE(name, type, pfnDelete) \
RTVEC_DECL_ALLOCATOR_DELETE(name, type, rtvecReallocDefTag, pfnDelete)
/**
* Declarator macro - declare a vector type with a cleanup by value callback
* (see @a RTVEC_DECL_ALLOCATOR_DELETE_BY_VALUE) using RTMemRealloc as a memory
* allocator
* @param name the name of the C struct type describing the vector as
* well as the prefix of the functions for manipulating it
* @param type the type of the objects contained in the vector
* @param pfnDelete the cleanup callback function - signature
* void pfnDelete(type)
*/
#define RTVEC_DECL_DELETE_BY_VALUE(name, type, pfnDelete) \
RTVEC_DECL_ALLOCATOR_DELETE_BY_VALUE(name, type, rtvecReallocDefTag, \
pfnDelete)
#endif /* !IPRT_INCLUDED_vector_h */
|
