Tue, 27 Jun 2023 20:04:48 +0200
add docs for the compare.h and printf.h utilities
391
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
1 | /* |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
3 | * |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
4 | * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved. |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
5 | * |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
6 | * Redistribution and use in source and binary forms, with or without |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
7 | * modification, are permitted provided that the following conditions are met: |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
8 | * |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
9 | * 1. Redistributions of source code must retain the above copyright |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
10 | * notice, this list of conditions and the following disclaimer. |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
11 | * |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
12 | * 2. Redistributions in binary form must reproduce the above copyright |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
13 | * notice, this list of conditions and the following disclaimer in the |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
14 | * documentation and/or other materials provided with the distribution. |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
15 | * |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
26 | * POSSIBILITY OF SUCH DAMAGE. |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
27 | */ |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
28 | /** |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
29 | * \file allocator.h |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
30 | * Interface for custom allocators. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
31 | */ |
391
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
32 | |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
33 | #ifndef UCX_ALLOCATOR_H |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
34 | #define UCX_ALLOCATOR_H |
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
35 | |
484
9e6900b1cf9d
add common.h include to all other header files
Mike Becker <universe@uap-core.de>
parents:
465
diff
changeset
|
36 | #include "common.h" |
391
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
37 | |
415 | 38 | #ifdef __cplusplus |
39 | extern "C" { | |
40 | #endif | |
41 | ||
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
42 | /** |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
43 | * The class definition for an allocator. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
44 | */ |
396
3539dd99ab92
make cx_allocator_class shared
Mike Becker <universe@uap-core.de>
parents:
394
diff
changeset
|
45 | typedef struct { |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
46 | /** |
465
1e3cb39815f8
remove redundant documentation for function pointers
Mike Becker <universe@uap-core.de>
parents:
461
diff
changeset
|
47 | * The allocator's malloc() implementation. |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
48 | */ |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
49 | void *(*malloc)( |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
50 | void *data, |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
51 | size_t n |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
52 | ); |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
53 | |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
54 | /** |
465
1e3cb39815f8
remove redundant documentation for function pointers
Mike Becker <universe@uap-core.de>
parents:
461
diff
changeset
|
55 | * The allocator's realloc() implementation. |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
56 | */ |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
57 | void *(*realloc)( |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
58 | void *data, |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
59 | void *mem, |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
60 | size_t n |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
61 | ) |
450
7960298039cf
improves usage of attributes
Mike Becker <universe@uap-core.de>
parents:
434
diff
changeset
|
62 | __attribute__((__warn_unused_result__)); |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
63 | |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
64 | /** |
465
1e3cb39815f8
remove redundant documentation for function pointers
Mike Becker <universe@uap-core.de>
parents:
461
diff
changeset
|
65 | * The allocator's calloc() implementation. |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
66 | */ |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
67 | void *(*calloc)( |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
68 | void *data, |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
69 | size_t nelem, |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
70 | size_t n |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
71 | ); |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
72 | |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
73 | /** |
465
1e3cb39815f8
remove redundant documentation for function pointers
Mike Becker <universe@uap-core.de>
parents:
461
diff
changeset
|
74 | * The allocator's free() implementation. |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
75 | */ |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
76 | void (*free)( |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
77 | void *data, |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
78 | void *mem |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
79 | ) |
450
7960298039cf
improves usage of attributes
Mike Becker <universe@uap-core.de>
parents:
434
diff
changeset
|
80 | __attribute__((__nonnull__)); |
396
3539dd99ab92
make cx_allocator_class shared
Mike Becker <universe@uap-core.de>
parents:
394
diff
changeset
|
81 | } cx_allocator_class; |
3539dd99ab92
make cx_allocator_class shared
Mike Becker <universe@uap-core.de>
parents:
394
diff
changeset
|
82 | |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
83 | /** |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
84 | * Structure holding the data for an allocator. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
85 | */ |
394
80c31ebd66c1
high level allocator functions should be real functions, not macros
Mike Becker <universe@uap-core.de>
parents:
393
diff
changeset
|
86 | struct cx_allocator_s { |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
87 | /** |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
88 | * A pointer to the instance of the allocator class. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
89 | */ |
396
3539dd99ab92
make cx_allocator_class shared
Mike Becker <universe@uap-core.de>
parents:
394
diff
changeset
|
90 | cx_allocator_class *cl; |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
91 | /** |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
92 | * A pointer to the data this allocator uses. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
93 | */ |
397
cfc1193b1e65
removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents:
396
diff
changeset
|
94 | void *data; |
391
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
95 | }; |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
96 | |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
97 | /** |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
98 | * High-Level type alias for the allocator type. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
99 | */ |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
100 | typedef struct cx_allocator_s CxAllocator; |
391
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
101 | |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
102 | /** |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
103 | * A default allocator using standard library malloc() etc. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
104 | */ |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
105 | extern CxAllocator *cxDefaultAllocator; |
391
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
106 | |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
107 | /** |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
108 | * Function pointer type for destructor functions. |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
109 | * |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
110 | * A destructor function deallocates possible contents and MAY free the memory |
526
b070ef465313
simplify destructor signature (but loads more responsibility onto the user)
Mike Becker <universe@uap-core.de>
parents:
508
diff
changeset
|
111 | * pointed to by \p memory. Read the documentation of the respective function |
b070ef465313
simplify destructor signature (but loads more responsibility onto the user)
Mike Becker <universe@uap-core.de>
parents:
508
diff
changeset
|
112 | * pointer to learn if a destructor SHALL, MAY, or MUST NOT free the memory in that |
b070ef465313
simplify destructor signature (but loads more responsibility onto the user)
Mike Becker <universe@uap-core.de>
parents:
508
diff
changeset
|
113 | * particular implementation. |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
114 | * |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
115 | * @param memory a pointer to the object to destruct |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
116 | */ |
526
b070ef465313
simplify destructor signature (but loads more responsibility onto the user)
Mike Becker <universe@uap-core.de>
parents:
508
diff
changeset
|
117 | typedef void (*cx_destructor_func)(void *memory) __attribute__((__nonnull__)); |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
118 | |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
119 | /** |
528
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
120 | * Function pointer type for destructor functions. |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
121 | * |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
122 | * A destructor function deallocates possible contents and MAY free the memory |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
123 | * pointed to by \p memory. Read the documentation of the respective function |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
124 | * pointer to learn if a destructor SHALL, MAY, or MUST NOT free the memory in that |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
125 | * particular implementation. |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
126 | * |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
127 | * @param data an optional pointer to custom data |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
128 | * @param memory a pointer to the object to destruct |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
129 | */ |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
130 | typedef void (*cx_destructor_func2)( |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
131 | void *data, |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
132 | void *memory |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
133 | ) __attribute__((__nonnull__(2))); |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
134 | |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
135 | /** |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
136 | * Allocate \p n bytes of memory. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
137 | * |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
138 | * @param allocator the allocator |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
139 | * @param n the number of bytes |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
140 | * @return a pointer to the allocated memory |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
141 | */ |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
142 | void *cxMalloc( |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
503
diff
changeset
|
143 | CxAllocator const *allocator, |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
144 | size_t n |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
145 | ) |
461
005c2791c2e2
put attributes on separate lines
Mike Becker <universe@uap-core.de>
parents:
452
diff
changeset
|
146 | __attribute__((__malloc__)) |
005c2791c2e2
put attributes on separate lines
Mike Becker <universe@uap-core.de>
parents:
452
diff
changeset
|
147 | __attribute__((__alloc_size__(2))); |
397
cfc1193b1e65
removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents:
396
diff
changeset
|
148 | |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
149 | /** |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
150 | * Re-allocate the previously allocated block in \p mem, making the new block \p n bytes long. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
151 | * This function may return the same pointer that was passed to it, if moving the memory |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
152 | * was not necessary. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
153 | * |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
154 | * \note Re-allocating a block allocated by a different allocator is undefined. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
155 | * |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
156 | * @param allocator the allocator |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
157 | * @param mem pointer to the previously allocated block |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
158 | * @param n the new size in bytes |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
159 | * @return a pointer to the re-allocated memory |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
160 | */ |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
161 | void *cxRealloc( |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
503
diff
changeset
|
162 | CxAllocator const *allocator, |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
163 | void *mem, |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
164 | size_t n |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
165 | ) |
461
005c2791c2e2
put attributes on separate lines
Mike Becker <universe@uap-core.de>
parents:
452
diff
changeset
|
166 | __attribute__((__warn_unused_result__)) |
005c2791c2e2
put attributes on separate lines
Mike Becker <universe@uap-core.de>
parents:
452
diff
changeset
|
167 | __attribute__((__alloc_size__(3))); |
397
cfc1193b1e65
removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents:
396
diff
changeset
|
168 | |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
169 | /** |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
170 | * Re-allocate a previously allocated block and changes the pointer in-place, if necessary. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
171 | * This function acts like cxRealloc() using the pointer pointed to by \p mem. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
172 | * On success, the pointer is changed to the new location (in case the |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
173 | * |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
174 | * \note Re-allocating a block allocated by a different allocator is undefined. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
175 | * |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
176 | * \par Error handling |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
177 | * \c errno will be set, if the underlying realloc function does so. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
178 | * |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
179 | * @param allocator the allocator |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
180 | * @param mem pointer to the pointer to allocated block |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
181 | * @param n the new size in bytes |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
182 | * @return zero on success, non-zero on failure |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
183 | */ |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
184 | int cxReallocate( |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
503
diff
changeset
|
185 | CxAllocator const *allocator, |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
186 | void **mem, |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
187 | size_t n |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
188 | ) |
452
a10c3e127050
add __alloc_size__ attribute
Mike Becker <universe@uap-core.de>
parents:
450
diff
changeset
|
189 | __attribute__((__nonnull__)); |
414 | 190 | |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
191 | /** |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
192 | * Allocate \p nelem elements of \p n bytes each, all initialized to zero. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
193 | * |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
194 | * @param allocator the allocator |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
195 | * @param nelem the number of elements |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
196 | * @param n the size of each element in bytes |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
197 | * @return a pointer to the allocated memory |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
198 | */ |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
199 | void *cxCalloc( |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
503
diff
changeset
|
200 | CxAllocator const *allocator, |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
201 | size_t nelem, |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
202 | size_t n |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
203 | ) |
461
005c2791c2e2
put attributes on separate lines
Mike Becker <universe@uap-core.de>
parents:
452
diff
changeset
|
204 | __attribute__((__malloc__)) |
005c2791c2e2
put attributes on separate lines
Mike Becker <universe@uap-core.de>
parents:
452
diff
changeset
|
205 | __attribute__((__alloc_size__(2, 3))); |
397
cfc1193b1e65
removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents:
396
diff
changeset
|
206 | |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
207 | /** |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
208 | * Free a block allocated by this allocator. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
209 | * |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
210 | * \note Freeing a block of a different allocator is undefined. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
211 | * |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
212 | * @param allocator the allocator |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
213 | * @param mem a pointer to the block to free |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
214 | */ |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
215 | void cxFree( |
508
8aea65ae1eaf
#168 - add attributes and const
Mike Becker <universe@uap-core.de>
parents:
503
diff
changeset
|
216 | CxAllocator const *allocator, |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
217 | void *mem |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
218 | ) |
452
a10c3e127050
add __alloc_size__ attribute
Mike Becker <universe@uap-core.de>
parents:
450
diff
changeset
|
219 | __attribute__((__nonnull__)); |
391
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
220 | |
415 | 221 | #ifdef __cplusplus |
628
1e2be40f0cb5
use //-style single line comments everywhere
Mike Becker <universe@uap-core.de>
parents:
528
diff
changeset
|
222 | } // extern "C" |
415 | 223 | #endif |
224 | ||
628
1e2be40f0cb5
use //-style single line comments everywhere
Mike Becker <universe@uap-core.de>
parents:
528
diff
changeset
|
225 | #endif // UCX_ALLOCATOR_H |