Tue, 26 Nov 2024 22:16:27 +0100
make names of destroy and free functions consistent - fixes #484
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 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
49 | cx_attr_nonnull |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
50 | cx_attr_nodiscard cx_attr_allocsize(2) |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
51 | void *(*malloc)( |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
52 | void *data, |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
53 | size_t n |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
54 | ); |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
55 | |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
56 | /** |
465
1e3cb39815f8
remove redundant documentation for function pointers
Mike Becker <universe@uap-core.de>
parents:
461
diff
changeset
|
57 | * The allocator's realloc() implementation. |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
58 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
59 | cx_attr_nodiscard |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
60 | cx_attr_allocsize(3) |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
61 | void *(*realloc)( |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
62 | void *data, |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
63 | void *mem, |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
64 | size_t n |
891
49d8cff6f0ee
make all function attributes leading - fixes #425
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
65 | ); |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
66 | |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
67 | /** |
465
1e3cb39815f8
remove redundant documentation for function pointers
Mike Becker <universe@uap-core.de>
parents:
461
diff
changeset
|
68 | * The allocator's calloc() implementation. |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
69 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
70 | cx_attr_nodiscard |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
71 | cx_attr_allocsize(2, 3) |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
72 | void *(*calloc)( |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
73 | void *data, |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
74 | size_t nelem, |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
75 | size_t n |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
76 | ); |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
77 | |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
78 | /** |
465
1e3cb39815f8
remove redundant documentation for function pointers
Mike Becker <universe@uap-core.de>
parents:
461
diff
changeset
|
79 | * The allocator's free() implementation. |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
80 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
81 | cx_attr_nonnull_arg(1) |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
82 | void (*free)( |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
83 | void *data, |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
84 | void *mem |
891
49d8cff6f0ee
make all function attributes leading - fixes #425
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
85 | ); |
396
3539dd99ab92
make cx_allocator_class shared
Mike Becker <universe@uap-core.de>
parents:
394
diff
changeset
|
86 | } cx_allocator_class; |
3539dd99ab92
make cx_allocator_class shared
Mike Becker <universe@uap-core.de>
parents:
394
diff
changeset
|
87 | |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
88 | /** |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
89 | * Structure holding the data for an allocator. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
90 | */ |
394
80c31ebd66c1
high level allocator functions should be real functions, not macros
Mike Becker <universe@uap-core.de>
parents:
393
diff
changeset
|
91 | struct cx_allocator_s { |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
92 | /** |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
93 | * 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
|
94 | */ |
396
3539dd99ab92
make cx_allocator_class shared
Mike Becker <universe@uap-core.de>
parents:
394
diff
changeset
|
95 | cx_allocator_class *cl; |
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 | * A pointer to the data this allocator uses. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
98 | */ |
397
cfc1193b1e65
removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents:
396
diff
changeset
|
99 | void *data; |
391
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
100 | }; |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
101 | |
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 | * High-Level type alias for the allocator type. |
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 | typedef struct cx_allocator_s CxAllocator; |
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 | /** |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
108 | * A default allocator using standard library malloc() etc. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
109 | */ |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
110 | extern CxAllocator *cxDefaultAllocator; |
391
f094a53c1178
adds allocator interface and default implementation
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
111 | |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
112 | /** |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
113 | * 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
|
114 | * |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
115 | * 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
|
116 | * pointed to by \p memory. Read the documentation of the respective function |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
117 | * pointer to learn if a destructor SHALL, MAY, or MUST NOT free the memory in |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
118 | * that particular implementation. |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
119 | * |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
120 | * @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
|
121 | */ |
891
49d8cff6f0ee
make all function attributes leading - fixes #425
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
122 | typedef void (*cx_destructor_func)(void *memory); |
503
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
123 | |
a89857072ace
add new destructor API and apply it to CxList
Mike Becker <universe@uap-core.de>
parents:
500
diff
changeset
|
124 | /** |
528
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
125 | * Function pointer type for destructor functions. |
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 | * 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
|
128 | * pointed to by \p memory. Read the documentation of the respective function |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
129 | * pointer to learn if a destructor SHALL, MAY, or MUST NOT free the memory in |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
130 | * that particular implementation. |
528
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
131 | * |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
132 | * @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
|
133 | * @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
|
134 | */ |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
135 | typedef void (*cx_destructor_func2)( |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
136 | void *data, |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
137 | void *memory |
891
49d8cff6f0ee
make all function attributes leading - fixes #425
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
138 | ); |
528
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
139 | |
4fbfac557df8
#179 improve API for list content destruction
Mike Becker <universe@uap-core.de>
parents:
526
diff
changeset
|
140 | /** |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
141 | * Re-allocate a previously allocated block and changes the pointer in-place, |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
142 | * if necessary. |
726
44986c0e2b05
add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents:
677
diff
changeset
|
143 | * |
44986c0e2b05
add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents:
677
diff
changeset
|
144 | * \par Error handling |
44986c0e2b05
add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents:
677
diff
changeset
|
145 | * \c errno will be set by realloc() on failure. |
44986c0e2b05
add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents:
677
diff
changeset
|
146 | * |
44986c0e2b05
add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents:
677
diff
changeset
|
147 | * @param mem pointer to the pointer to allocated block |
44986c0e2b05
add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents:
677
diff
changeset
|
148 | * @param n the new size in bytes |
44986c0e2b05
add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents:
677
diff
changeset
|
149 | * @return zero on success, non-zero on failure |
44986c0e2b05
add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents:
677
diff
changeset
|
150 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
151 | cx_attr_nonnull |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
152 | cx_attr_nodiscard |
726
44986c0e2b05
add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents:
677
diff
changeset
|
153 | int cx_reallocate( |
44986c0e2b05
add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents:
677
diff
changeset
|
154 | void **mem, |
44986c0e2b05
add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents:
677
diff
changeset
|
155 | size_t n |
891
49d8cff6f0ee
make all function attributes leading - fixes #425
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
156 | ); |
726
44986c0e2b05
add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents:
677
diff
changeset
|
157 | |
44986c0e2b05
add a low-level stdlib-based cx_reallocate()
Mike Becker <universe@uap-core.de>
parents:
677
diff
changeset
|
158 | /** |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
159 | * Re-allocate a previously allocated block and changes the pointer in-place, |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
160 | * if necessary. |
935
312fb24c14de
add convenience macro for cx_reallocate to hide the (void**) cast
Mike Becker <universe@uap-core.de>
parents:
891
diff
changeset
|
161 | * |
963
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
162 | * The size is calculated by multiplying \p nemb and \p size. |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
163 | * |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
164 | * \par Error handling |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
165 | * \c errno will be set by realloc() on failure or when the multiplication of |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
166 | * \p nmemb and \p size overflows. |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
167 | * |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
168 | * @param mem pointer to the pointer to allocated block |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
169 | * @param nmemb the number of elements |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
170 | * @param size the size of each element |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
171 | * @return zero on success, non-zero on failure |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
172 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
173 | cx_attr_nonnull |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
174 | cx_attr_nodiscard |
963
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
175 | int cx_reallocatearray( |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
176 | void **mem, |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
177 | size_t nmemb, |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
178 | size_t size |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
179 | ); |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
180 | |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
181 | /** |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
182 | * Re-allocate a previously allocated block and changes the pointer in-place, |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
183 | * if necessary. |
963
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
184 | * |
935
312fb24c14de
add convenience macro for cx_reallocate to hide the (void**) cast
Mike Becker <universe@uap-core.de>
parents:
891
diff
changeset
|
185 | * \par Error handling |
312fb24c14de
add convenience macro for cx_reallocate to hide the (void**) cast
Mike Becker <universe@uap-core.de>
parents:
891
diff
changeset
|
186 | * \c errno will be set by realloc() on failure. |
312fb24c14de
add convenience macro for cx_reallocate to hide the (void**) cast
Mike Becker <universe@uap-core.de>
parents:
891
diff
changeset
|
187 | * |
312fb24c14de
add convenience macro for cx_reallocate to hide the (void**) cast
Mike Becker <universe@uap-core.de>
parents:
891
diff
changeset
|
188 | * @param mem pointer to the pointer to allocated block |
312fb24c14de
add convenience macro for cx_reallocate to hide the (void**) cast
Mike Becker <universe@uap-core.de>
parents:
891
diff
changeset
|
189 | * @param n the new size in bytes |
312fb24c14de
add convenience macro for cx_reallocate to hide the (void**) cast
Mike Becker <universe@uap-core.de>
parents:
891
diff
changeset
|
190 | * @return zero on success, non-zero on failure |
312fb24c14de
add convenience macro for cx_reallocate to hide the (void**) cast
Mike Becker <universe@uap-core.de>
parents:
891
diff
changeset
|
191 | */ |
312fb24c14de
add convenience macro for cx_reallocate to hide the (void**) cast
Mike Becker <universe@uap-core.de>
parents:
891
diff
changeset
|
192 | #define cx_reallocate(mem, n) cx_reallocate((void**)(mem), n) |
312fb24c14de
add convenience macro for cx_reallocate to hide the (void**) cast
Mike Becker <universe@uap-core.de>
parents:
891
diff
changeset
|
193 | |
312fb24c14de
add convenience macro for cx_reallocate to hide the (void**) cast
Mike Becker <universe@uap-core.de>
parents:
891
diff
changeset
|
194 | /** |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
195 | * Re-allocate a previously allocated block and changes the pointer in-place, |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
196 | * if necessary. |
963
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
197 | * |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
198 | * The size is calculated by multiplying \p nemb and \p size. |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
199 | * |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
200 | * \par Error handling |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
201 | * \c errno will be set by realloc() on failure or when the multiplication of |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
202 | * \p nmemb and \p size overflows. |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
203 | * |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
204 | * @param mem pointer to the pointer to allocated block |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
205 | * @param nmemb the number of elements |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
206 | * @param size the size of each element |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
207 | * @return zero on success, non-zero on failure |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
208 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
209 | #define cx_reallocatearray(mem, nmemb, size) \ |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
210 | cx_reallocatearray((void**)(mem), nmemb, size) |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
211 | |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
212 | /** |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
213 | * Free a block allocated by this allocator. |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
214 | * |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
215 | * \note Freeing a block of a different allocator is undefined. |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
216 | * |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
217 | * @param allocator the allocator |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
218 | * @param mem a pointer to the block to free |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
219 | */ |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
220 | cx_attr_nonnull_arg(1) |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
221 | void cxFree( |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
222 | const CxAllocator *allocator, |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
223 | void *mem |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
224 | ); |
963
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
225 | |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
226 | /** |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
227 | * Allocate \p n bytes of memory. |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
228 | * |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
229 | * @param allocator the allocator |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
230 | * @param n the number of bytes |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
231 | * @return a pointer to the allocated memory |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
232 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
233 | cx_attr_nodiscard |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
234 | cx_attr_nonnull |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
235 | cx_attr_malloc |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
236 | cx_attr_dealloc_ucx |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
237 | cx_attr_allocsize(2) |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
238 | void *cxMalloc( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
726
diff
changeset
|
239 | const CxAllocator *allocator, |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
240 | size_t n |
891
49d8cff6f0ee
make all function attributes leading - fixes #425
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
241 | ); |
397
cfc1193b1e65
removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents:
396
diff
changeset
|
242 | |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
243 | /** |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
244 | * Re-allocate the previously allocated block in \p mem, making the new block |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
245 | * \p n bytes long. |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
246 | * This function may return the same pointer that was passed to it, if moving |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
247 | * the memory was not necessary. |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
248 | * |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
249 | * \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
|
250 | * |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
251 | * @param allocator the allocator |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
252 | * @param mem pointer to the previously allocated block |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
253 | * @param n the new size in bytes |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
254 | * @return a pointer to the re-allocated memory |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
255 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
256 | cx_attr_nodiscard |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
257 | cx_attr_nonnull_arg(1) |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
258 | cx_attr_dealloc_ucx |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
259 | cx_attr_allocsize(3) |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
260 | void *cxRealloc( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
726
diff
changeset
|
261 | const CxAllocator *allocator, |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
262 | void *mem, |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
263 | size_t n |
891
49d8cff6f0ee
make all function attributes leading - fixes #425
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
264 | ); |
397
cfc1193b1e65
removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents:
396
diff
changeset
|
265 | |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
266 | /** |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
267 | * Re-allocate the previously allocated block in \p mem, making the new block |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
268 | * \p n bytes long. |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
269 | * This function may return the same pointer that was passed to it, if moving |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
270 | * the memory was not necessary. |
963
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
271 | * |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
272 | * The size is calculated by multiplying \p nemb and \p size. |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
273 | * If that multiplication overflows, this function returns \c NULL and \c errno |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
274 | * will be set. |
963
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
275 | * |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
276 | * \note Re-allocating a block allocated by a different allocator is undefined. |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
277 | * |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
278 | * @param allocator the allocator |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
279 | * @param mem pointer to the previously allocated block |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
280 | * @param nmemb the number of elements |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
281 | * @param size the size of each element |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
282 | * @return a pointer to the re-allocated memory |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
283 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
284 | cx_attr_nodiscard |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
285 | cx_attr_nonnull_arg(1) |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
286 | cx_attr_dealloc_ucx |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
287 | cx_attr_allocsize(3, 4) |
963
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
288 | void *cxReallocArray( |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
289 | const CxAllocator *allocator, |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
290 | void *mem, |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
291 | size_t nmemb, |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
292 | size_t size |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
293 | ); |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
294 | |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
295 | /** |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
296 | * Re-allocate a previously allocated block and changes the pointer in-place, |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
297 | * if necessary. |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
298 | * 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
|
299 | * |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
300 | * \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
|
301 | * |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
302 | * \par Error handling |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
303 | * \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
|
304 | * |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
305 | * @param allocator the allocator |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
306 | * @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
|
307 | * @param n the new size in bytes |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
308 | * @return zero on success, non-zero on failure |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
309 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
310 | cx_attr_nodiscard |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
311 | cx_attr_nonnull |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
312 | int cxReallocate( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
726
diff
changeset
|
313 | const CxAllocator *allocator, |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
314 | void **mem, |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
315 | size_t n |
891
49d8cff6f0ee
make all function attributes leading - fixes #425
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
316 | ); |
414 | 317 | |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
318 | /** |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
319 | * Re-allocate a previously allocated block and changes the pointer in-place, |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
320 | * if necessary. |
963
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
321 | * This function acts like cxRealloc() using the pointer pointed to by \p mem. |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
322 | * |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
323 | * \note Re-allocating a block allocated by a different allocator is undefined. |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
324 | * |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
325 | * \par Error handling |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
326 | * \c errno will be set, if the underlying realloc function does so. |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
327 | * |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
328 | * @param allocator the allocator |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
329 | * @param mem pointer to the pointer to allocated block |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
330 | * @param n the new size in bytes |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
331 | * @return zero on success, non-zero on failure |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
332 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
333 | #define cxReallocate(allocator, mem, n) \ |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
334 | cxReallocate(allocator, (void**)(mem), n) |
963
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
335 | |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
336 | /** |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
337 | * Re-allocate a previously allocated block and changes the pointer in-place, |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
338 | * if necessary. |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
339 | * This function acts like cxReallocArray() using the pointer pointed to |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
340 | * by \p mem. |
963
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
341 | * |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
342 | * \note Re-allocating a block allocated by a different allocator is undefined. |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
343 | * |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
344 | * \par Error handling |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
345 | * \c errno will be set, if the underlying realloc function does so or the |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
346 | * multiplication of \p nmemb and \p size overflows. |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
347 | * |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
348 | * @param allocator the allocator |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
349 | * @param mem pointer to the pointer to allocated block |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
350 | * @param nmemb the number of elements |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
351 | * @param size the size of each element |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
352 | * @return zero on success, non-zero on failure |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
353 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
354 | cx_attr_nodiscard |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
355 | cx_attr_nonnull |
963
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
356 | int cxReallocateArray( |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
357 | const CxAllocator *allocator, |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
358 | void **mem, |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
359 | size_t nmemb, |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
360 | size_t size |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
361 | ); |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
362 | |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
363 | /** |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
364 | * Re-allocate a previously allocated block and changes the pointer in-place, |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
365 | * if necessary. |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
366 | * This function acts like cxReallocArray() using the pointer pointed to |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
367 | * by \p mem. |
963
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
368 | * |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
369 | * \note Re-allocating a block allocated by a different allocator is undefined. |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
370 | * |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
371 | * \par Error handling |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
372 | * \c errno will be set, if the underlying realloc function does so or the |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
373 | * multiplication of \p nmemb and \p size overflows. |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
374 | * |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
375 | * @param allocator the allocator |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
376 | * @param mem pointer to the pointer to allocated block |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
377 | * @param nmemb the number of elements |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
378 | * @param size the size of each element |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
379 | * @return zero on success, non-zero on failure |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
380 | */ |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
381 | #define cxReallocateArray(allocator, mem, nmemb, size) \ |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
382 | cxReallocateArray(allocator, (void**) (mem), nmemb, size) |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
383 | |
2f601274bbac
add reallocarray() like functions - resolves #468
Mike Becker <universe@uap-core.de>
parents:
935
diff
changeset
|
384 | /** |
429
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
385 | * 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
|
386 | * |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
387 | * @param allocator the allocator |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
388 | * @param nelem the number of elements |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
389 | * @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
|
390 | * @return a pointer to the allocated memory |
3d8235c96a27
add documentation to allocator.h
Mike Becker <universe@uap-core.de>
parents:
419
diff
changeset
|
391 | */ |
985
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
392 | cx_attr_nonnull_arg(1) |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
393 | cx_attr_nodiscard |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
394 | cx_attr_malloc |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
395 | cx_attr_dealloc_ucx |
68754c7de906
major refactoring of attributes
Mike Becker <universe@uap-core.de>
parents:
963
diff
changeset
|
396 | cx_attr_allocsize(2, 3) |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
397 | void *cxCalloc( |
890
54565fd74e74
move all const keywords to the west - fixes #426
Mike Becker <universe@uap-core.de>
parents:
726
diff
changeset
|
398 | const CxAllocator *allocator, |
500
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
399 | size_t nelem, |
eb9e7bd40a8e
do not hide pointers behind typedefs
Mike Becker <universe@uap-core.de>
parents:
484
diff
changeset
|
400 | size_t n |
891
49d8cff6f0ee
make all function attributes leading - fixes #425
Mike Becker <universe@uap-core.de>
parents:
890
diff
changeset
|
401 | ); |
397
cfc1193b1e65
removes unnecessary cx_allocator typedef
Mike Becker <universe@uap-core.de>
parents:
396
diff
changeset
|
402 | |
415 | 403 | #ifdef __cplusplus |
628
1e2be40f0cb5
use //-style single line comments everywhere
Mike Becker <universe@uap-core.de>
parents:
528
diff
changeset
|
404 | } // extern "C" |
415 | 405 | #endif |
406 | ||
628
1e2be40f0cb5
use //-style single line comments everywhere
Mike Becker <universe@uap-core.de>
parents:
528
diff
changeset
|
407 | #endif // UCX_ALLOCATOR_H |