Blender V5.3
BLI_array_test.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: Apache-2.0 */
4
5#include "testing/testing.h"
6
7#include "BLI_array.hh"
10#include "BLI_vector.hh"
11
12#include "BLI_strict_flags.hh" /* IWYU pragma: keep. Keep last. */
13
14namespace blender::tests {
15
16TEST(array, DefaultConstructor)
17{
19 EXPECT_EQ(array.size(), 0);
20 EXPECT_TRUE(array.is_empty());
21}
22
23TEST(array, SizeConstructor)
24{
26 EXPECT_EQ(array.size(), 5);
27 EXPECT_FALSE(array.is_empty());
28}
29
30TEST(array, FillConstructor)
31{
32 Array<int> array(5, 8);
33 EXPECT_EQ(array.size(), 5);
34 EXPECT_EQ(array[0], 8);
35 EXPECT_EQ(array[1], 8);
36 EXPECT_EQ(array[2], 8);
37 EXPECT_EQ(array[3], 8);
38 EXPECT_EQ(array[4], 8);
39}
40
41TEST(array, FillConstructorZero)
42{
43 Array<int> array(5, 0);
44 EXPECT_EQ(array.size(), 5);
45 EXPECT_EQ(array[0], 0);
46 EXPECT_EQ(array[1], 0);
47 EXPECT_EQ(array[2], 0);
48 EXPECT_EQ(array[3], 0);
49 EXPECT_EQ(array[4], 0);
50}
51
52TEST(array, FillConstructorZeroAligned)
53{
54 struct alignas(512) LargeAlignedType {
55 std::array<int, 857> array = {};
56 };
57 Array<LargeAlignedType> array(5, LargeAlignedType());
58 EXPECT_EQ(array.size(), 5);
59 EXPECT_EQ(array[0].array[285], 0);
60 EXPECT_EQ(array[1].array[285], 0);
61 EXPECT_EQ(array[2].array[285], 0);
62 EXPECT_EQ(array[3].array[285], 0);
63 EXPECT_EQ(array[4].array[285], 0);
64}
65
66TEST(array, InitializerListConstructor)
67{
68 Array<int> array = {4, 5, 6, 7};
69 EXPECT_EQ(array.size(), 4);
70 EXPECT_EQ(array[0], 4);
71 EXPECT_EQ(array[1], 5);
72 EXPECT_EQ(array[2], 6);
73 EXPECT_EQ(array[3], 7);
74}
75
76TEST(array, SpanConstructor)
77{
78 int stackarray[4] = {6, 7, 8, 9};
79 Span<int> span(stackarray, ARRAY_SIZE(stackarray));
80 Array<int> array(span);
81 EXPECT_EQ(array.size(), 4);
82 EXPECT_EQ(array[0], 6);
83 EXPECT_EQ(array[1], 7);
84 EXPECT_EQ(array[2], 8);
85 EXPECT_EQ(array[3], 9);
86}
87
88TEST(array, CopyConstructor)
89{
90 Array<int> array = {5, 6, 7, 8};
91 Array<int> new_array(array);
92
93 EXPECT_EQ(array.size(), 4);
94 EXPECT_EQ(new_array.size(), 4);
95 EXPECT_NE(array.data(), new_array.data());
96 EXPECT_EQ(new_array[0], 5);
97 EXPECT_EQ(new_array[1], 6);
98 EXPECT_EQ(new_array[2], 7);
99 EXPECT_EQ(new_array[3], 8);
100}
101
102TEST(array, MoveConstructor)
103{
104 Array<int> array = {5, 6, 7, 8};
105 Array<int> new_array(std::move(array));
106
107 EXPECT_EQ(array.size(), 0); /* NOLINT: bugprone-use-after-move */
108 EXPECT_EQ(new_array.size(), 4);
109 EXPECT_EQ(new_array[0], 5);
110 EXPECT_EQ(new_array[1], 6);
111 EXPECT_EQ(new_array[2], 7);
112 EXPECT_EQ(new_array[3], 8);
113}
114
115TEST(array, CopyAssignment)
116{
117 Array<int> array = {1, 2, 3};
118 Array<int> new_array = {4};
119 EXPECT_EQ(new_array.size(), 1);
120 new_array = array;
121 EXPECT_EQ(new_array.size(), 3);
122 EXPECT_EQ(array.size(), 3);
123 EXPECT_NE(array.data(), new_array.data());
124 EXPECT_EQ(new_array[0], 1);
125 EXPECT_EQ(new_array[1], 2);
126 EXPECT_EQ(new_array[2], 3);
127}
128
129TEST(array, MoveAssignment)
130{
131 Array<int> array = {1, 2, 3};
132 Array<int> new_array = {4};
133 EXPECT_EQ(new_array.size(), 1);
134 new_array = std::move(array);
135 EXPECT_EQ(new_array.size(), 3);
136 EXPECT_EQ(array.size(), 0); /* NOLINT: bugprone-use-after-move */
137 EXPECT_EQ(new_array[0], 1);
138 EXPECT_EQ(new_array[1], 2);
139 EXPECT_EQ(new_array[2], 3);
140}
141
146TEST(array, TrivialTypeSizeConstructor)
147{
149 char *ptr = array->data();
150 array->~Array();
151
152 const char magic = 42;
153 *ptr = magic;
154 EXPECT_EQ(*ptr, magic);
155
156 new (array) Array<char, 1>(1);
157 EXPECT_EQ((*array)[0], magic);
158 EXPECT_EQ(*ptr, magic);
159 delete array;
160}
161
163 char value;
164
166 {
167 value = 42;
168 }
169};
170
171TEST(array, NoInitializationSizeConstructor)
172{
173 using MyArray = Array<ConstructibleType>;
174
176 memset((void *)&buffer, 100, sizeof(MyArray));
177
178 /* Doing this to avoid some compiler optimization. */
179 for (int64_t i : IndexRange(sizeof(MyArray))) {
180 EXPECT_EQ(((char *)buffer.ptr())[i], 100);
181 }
182
183 {
184 MyArray &array = *new (buffer) MyArray(1, NoInitialization());
185 EXPECT_EQ(array[0].value, 100);
186 array.clear_without_destruct();
187 array.~Array();
188 }
189 {
190 MyArray &array = *new (buffer) MyArray(1);
191 EXPECT_EQ(array[0].value, 42);
192 array.~Array();
193 }
194}
195
197{
198 Array<int> array(5);
199 array.fill(3);
200 EXPECT_EQ(array.size(), 5u);
201 EXPECT_EQ(array[0], 3);
202 EXPECT_EQ(array[1], 3);
203 EXPECT_EQ(array[2], 3);
204 EXPECT_EQ(array[3], 3);
205 EXPECT_EQ(array[4], 3);
206}
207
208TEST(array, ReverseIterator)
209{
210 Array<int> array = {3, 4, 5, 6};
211 Vector<int> reversed_vec;
212
213 for (auto it = array.rbegin(); it != array.rend(); ++it) {
214 reversed_vec.append(*it);
215 *it += 10;
216 }
217
218 EXPECT_EQ_SPAN<int>(reversed_vec, Span({6, 5, 4, 3}));
219 EXPECT_EQ_SPAN<int>(array, Span({13, 14, 15, 16}));
220}
221
222TEST(array, SpanConstructorExceptions)
223{
224 std::array<ExceptionThrower, 4> values;
225 values[2].throw_during_copy = true;
226 Span<ExceptionThrower> span{values};
227 EXPECT_ANY_THROW({ Array<ExceptionThrower> array(span); });
228}
229
230TEST(array, SizeValueConstructorExceptions)
231{
232 ExceptionThrower value;
233 value.throw_during_copy = true;
234 EXPECT_ANY_THROW({ Array<ExceptionThrower> array(5, value); });
235}
236
237TEST(array, MoveConstructorExceptions)
238{
240 array[1].throw_during_move = true;
241 EXPECT_ANY_THROW({ Array<ExceptionThrower> array_copy(std::move(array)); });
242}
243
244TEST(array, CopyAssignmentExceptions)
245{
247 array[3].throw_during_copy = true;
248 Array<ExceptionThrower> array_copy(10);
249 EXPECT_ANY_THROW({ array_copy = array; });
250}
251
252TEST(array, MoveAssignmentExceptions)
253{
255 array[2].throw_during_move = true;
256 Array<ExceptionThrower> array_moved(10);
257 EXPECT_ANY_THROW({ array_moved = std::move(array); });
258}
259
261{
262 Array<int> array = {5, 7, 8, 9};
263 EXPECT_EQ(array.last(), 9);
264 EXPECT_EQ(array.last(1), 8);
265 array.last() = 1;
266 EXPECT_EQ(array[3], 1);
267 EXPECT_EQ(const_cast<const Array<int> &>(array).last(), 1);
268 EXPECT_EQ(const_cast<const Array<int> &>(array).last(2), 7);
269}
270
271TEST(array, Reinitialize)
272{
273 Array<std::string> array = {"hello", "world"};
274 EXPECT_EQ(array.size(), 2);
275 EXPECT_EQ(array[1], "world");
276 array.reinitialize(3);
277 EXPECT_EQ(array.size(), 3);
278 EXPECT_EQ(array[0], "");
279 EXPECT_EQ(array[1], "");
280 EXPECT_EQ(array[2], "");
281 array.reinitialize(0);
282 EXPECT_EQ(array.size(), 0);
283}
284
285TEST(array, ConstructStructWithBitFields)
286{
287 /* See bug report in #161714. */
288 struct TestStruct {
289 uint a : 1;
290 uint b : 1;
291 };
292
293 {
294 Array<TestStruct> array(3, {false, false});
295 EXPECT_EQ(array[0].a, 0);
296 EXPECT_EQ(array[0].b, 0);
297 }
298 {
299 Array<TestStruct> array(3, {true, false});
300 EXPECT_EQ(array[0].a, 1);
301 EXPECT_EQ(array[0].b, 0);
302 }
303 {
304 Array<TestStruct> array(3, {true, true});
305 EXPECT_EQ(array[0].a, 1);
306 EXPECT_EQ(array[0].b, 1);
307 }
308}
309
310TEST(array, ConstructZeroVector)
311{
312 /* This mainly exercises the #value_is_zero_memory specialization for VecBase. */
313 static_assert(!std::has_unique_object_representations_v<float3>);
314 float3 vec{0};
315 Array<float3> array(3, vec);
316 EXPECT_EQ(array[0], vec);
317}
318
319} // namespace blender::tests
size_t size() const
int64_t size() const
Definition BLI_array.hh:267
Array(Allocator allocator={}) noexcept
Definition BLI_array.hh:78
const T * data() const
Definition BLI_array.hh:323
constexpr IndexRange()=default
constexpr Span()=default
void append(const T &value)
#define EXPECT_FALSE(result)
#define EXPECT_NE(result, expect)
#define EXPECT_TRUE(result)
TEST(any_virtual, DefaultConstructor)
__int64 int64_t
Definition BKE_text.h:90
unsigned int uint
Definition BKE_text.h:55
constexpr size_t ARRAY_SIZE(const T(&arg)[N]) noexcept
EXPECT_EQ(BLI_expr_pylike_eval(expr, nullptr, 0, &result), EXPR_PYLIKE_INVALID)
VecBase< float, 3 > float3