2
0

test_array.h 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789
  1. /**************************************************************************/
  2. /* test_array.h */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #pragma once
  31. #include "core/variant/array.h"
  32. #include "tests/test_macros.h"
  33. #include "tests/test_tools.h"
  34. namespace TestArray {
  35. TEST_CASE("[Array] initializer list") {
  36. Array arr = { 0, 1, "test", true, { 0.0, 1.0 } };
  37. CHECK(arr.size() == 5);
  38. CHECK(arr[0] == Variant(0));
  39. CHECK(arr[1] == Variant(1));
  40. CHECK(arr[2] == Variant("test"));
  41. CHECK(arr[3] == Variant(true));
  42. CHECK(arr[4] == Variant({ 0.0, 1.0 }));
  43. arr = { "reassign" };
  44. CHECK(arr.size() == 1);
  45. CHECK(arr[0] == Variant("reassign"));
  46. TypedArray<int> typed_arr = { 0, 1, 2 };
  47. CHECK(typed_arr.size() == 3);
  48. CHECK(typed_arr[0] == Variant(0));
  49. CHECK(typed_arr[1] == Variant(1));
  50. CHECK(typed_arr[2] == Variant(2));
  51. }
  52. TEST_CASE("[Array] size(), clear(), and is_empty()") {
  53. Array arr;
  54. CHECK(arr.size() == 0);
  55. CHECK(arr.is_empty());
  56. arr.push_back(1);
  57. CHECK(arr.size() == 1);
  58. arr.clear();
  59. CHECK(arr.is_empty());
  60. CHECK(arr.size() == 0);
  61. }
  62. TEST_CASE("[Array] fill()") {
  63. Array arr;
  64. arr.resize(5);
  65. arr.fill(7);
  66. Array expected = { 7, 7, 7, 7, 7 };
  67. CHECK_EQ(arr, expected);
  68. Array empty;
  69. empty.fill(7);
  70. Array empty_expected;
  71. CHECK_EQ(empty, empty_expected);
  72. }
  73. TEST_CASE("[Array] reverse()") {
  74. Array odd_sized = { 1, 2, 3 };
  75. odd_sized.reverse();
  76. Array odd_sized_expected = { 3, 2, 1 };
  77. CHECK_EQ(odd_sized, odd_sized_expected);
  78. Array even_sized = { "a", "b", "c", "d" };
  79. even_sized.reverse();
  80. Array even_sized_expected = { "d", "c", "b", "a" };
  81. CHECK_EQ(even_sized, even_sized_expected);
  82. Array empty;
  83. empty.reverse();
  84. Array empty_expected;
  85. CHECK_EQ(empty, empty_expected);
  86. }
  87. TEST_CASE("[Array] Assignment and comparison operators") {
  88. Array arr1;
  89. Array arr2;
  90. arr1.push_back(1);
  91. CHECK(arr1 != arr2);
  92. CHECK(arr1 > arr2);
  93. CHECK(arr1 >= arr2);
  94. arr2.push_back(2);
  95. CHECK(arr1 != arr2);
  96. CHECK(arr1 < arr2);
  97. CHECK(arr1 <= arr2);
  98. CHECK(arr2 > arr1);
  99. CHECK(arr2 >= arr1);
  100. Array arr3 = arr2;
  101. CHECK(arr3 == arr2);
  102. }
  103. TEST_CASE("[Array] append()") {
  104. Array arr;
  105. arr.append(1);
  106. arr.append(2);
  107. arr.append(3);
  108. arr.append("test");
  109. Array expected = { 1, 2, 3, "test" };
  110. CHECK_EQ(arr, expected);
  111. }
  112. TEST_CASE("[Array] append_array()") {
  113. Array arr1;
  114. Array arr2;
  115. arr1.push_back(1);
  116. arr1.append_array(arr2);
  117. CHECK(arr1.size() == 1);
  118. arr2.push_back(2);
  119. arr1.append_array(arr2);
  120. CHECK(arr1.size() == 2);
  121. CHECK(int(arr1[0]) == 1);
  122. CHECK(int(arr1[1]) == 2);
  123. }
  124. TEST_CASE("[Array] resize(), insert(), and erase()") {
  125. Array arr;
  126. arr.resize(2);
  127. CHECK(arr.size() == 2);
  128. arr.insert(0, 1);
  129. CHECK(int(arr[0]) == 1);
  130. arr.insert(0, 2);
  131. CHECK(int(arr[0]) == 2);
  132. arr.erase(2);
  133. CHECK(int(arr[0]) == 1);
  134. arr.resize(0);
  135. CHECK(arr.size() == 0);
  136. arr.insert(0, 8);
  137. CHECK(arr.size() == 1);
  138. arr.insert(1, 16);
  139. CHECK(int(arr[1]) == 16);
  140. arr.insert(-1, 3);
  141. CHECK(int(arr[1]) == 3);
  142. }
  143. TEST_CASE("[Array] front() and back()") {
  144. Array arr;
  145. arr.push_back(1);
  146. CHECK(int(arr.front()) == 1);
  147. CHECK(int(arr.back()) == 1);
  148. arr.push_back(3);
  149. CHECK(int(arr.front()) == 1);
  150. CHECK(int(arr.back()) == 3);
  151. }
  152. TEST_CASE("[Array] has() and count()") {
  153. Array arr = { 1, 1 };
  154. CHECK(arr.has(1));
  155. CHECK(!arr.has(2));
  156. CHECK(arr.count(1) == 2);
  157. CHECK(arr.count(2) == 0);
  158. }
  159. TEST_CASE("[Array] remove_at()") {
  160. Array arr = { 1, 2 };
  161. arr.remove_at(0);
  162. CHECK(arr.size() == 1);
  163. CHECK(int(arr[0]) == 2);
  164. arr.remove_at(0);
  165. CHECK(arr.size() == 0);
  166. // Negative index.
  167. arr.push_back(3);
  168. arr.push_back(4);
  169. arr.remove_at(-1);
  170. CHECK(arr.size() == 1);
  171. CHECK(int(arr[0]) == 3);
  172. arr.remove_at(-1);
  173. CHECK(arr.size() == 0);
  174. // The array is now empty; try to use `remove_at()` again.
  175. // Normally, this prints an error message so we silence it.
  176. ERR_PRINT_OFF;
  177. arr.remove_at(0);
  178. ERR_PRINT_ON;
  179. CHECK(arr.size() == 0);
  180. }
  181. TEST_CASE("[Array] get() and set()") {
  182. Array arr = { 1, 2, 3 };
  183. CHECK_EQ(int(arr.get(0)), 1);
  184. CHECK_EQ(int(arr.get(1)), 2);
  185. CHECK_EQ(int(arr.get(2)), 3);
  186. arr.set(1, 5);
  187. CHECK_EQ(int(arr.get(1)), 5);
  188. }
  189. TEST_CASE("[Array] sort() and bsearch()") {
  190. Array arr = { 3, 4, 2, 1 };
  191. arr.sort();
  192. Array expected = { 1, 2, 3, 4 };
  193. CHECK_EQ(arr, expected);
  194. CHECK_EQ(arr.bsearch(1), 0);
  195. CHECK_EQ(arr.bsearch(3), 2);
  196. CHECK_EQ(arr.bsearch(-100), 0);
  197. CHECK_EQ(arr.bsearch(100), 4);
  198. }
  199. static bool _order_descending(int p_a, int p_b) {
  200. return p_b < p_a;
  201. }
  202. TEST_CASE("[Array] sort_custom() and bsearch_custom()") {
  203. Array arr = { 3, 4, 2, 1 };
  204. arr.sort_custom(callable_mp_static(_order_descending));
  205. Array expected = { 4, 3, 2, 1 };
  206. CHECK_EQ(arr, expected);
  207. CHECK_EQ(arr.bsearch_custom(1, callable_mp_static(_order_descending)), 3);
  208. CHECK_EQ(arr.bsearch_custom(4, callable_mp_static(_order_descending)), 0);
  209. CHECK_EQ(arr.bsearch_custom(100, callable_mp_static(_order_descending)), 0);
  210. CHECK_EQ(arr.bsearch_custom(-100, callable_mp_static(_order_descending)), 4);
  211. }
  212. static bool _is_even(int p_num) {
  213. return p_num % 2 == 0;
  214. }
  215. static bool _is_odd(int p_num) {
  216. return p_num % 2 == 1;
  217. }
  218. TEST_CASE("[Array] filter(), any(), all()") {
  219. Array nums = { 1, 2, 3, 4, 5, 6, 7 };
  220. CHECK(nums.any(callable_mp_static(_is_odd)));
  221. CHECK(nums.any(callable_mp_static(_is_even)));
  222. CHECK(!nums.all(callable_mp_static(_is_odd)));
  223. CHECK(!nums.all(callable_mp_static(_is_even)));
  224. Array odd = nums.filter(callable_mp_static(_is_odd));
  225. Array odd_expected = { 1, 3, 5, 7 };
  226. CHECK_EQ(odd, odd_expected);
  227. Array even = nums.filter(callable_mp_static(_is_even));
  228. Array even_expected = { 2, 4, 6 };
  229. CHECK_EQ(even, even_expected);
  230. CHECK(odd.all(callable_mp_static(_is_odd)));
  231. CHECK(odd.any(callable_mp_static(_is_odd)));
  232. CHECK(!odd.all(callable_mp_static(_is_even)));
  233. CHECK(!odd.any(callable_mp_static(_is_even)));
  234. }
  235. static int _add(int p_a, int p_b) {
  236. return p_a + p_b;
  237. }
  238. TEST_CASE("[Array] map() and reduce()") {
  239. Array array = { 1, 2, 3, 4, 5 };
  240. Array mapped = array.map(callable_mp_static(_add).bind(5));
  241. Array mapped_expected = { 6, 7, 8, 9, 10 };
  242. CHECK_EQ(mapped, mapped_expected);
  243. Variant sum = 0;
  244. CHECK_EQ(int(array.reduce(callable_mp_static(_add), sum)), 15);
  245. }
  246. TEST_CASE("[Array] push_front(), pop_front(), pop_back()") {
  247. Array arr;
  248. arr.push_front(1);
  249. arr.push_front(2);
  250. CHECK(int(arr[0]) == 2);
  251. arr.pop_front();
  252. CHECK(int(arr[0]) == 1);
  253. CHECK(arr.size() == 1);
  254. arr.push_front(2);
  255. arr.push_front(3);
  256. arr.pop_back();
  257. CHECK(int(arr[1]) == 2);
  258. CHECK(arr.size() == 2);
  259. }
  260. TEST_CASE("[Array] pop_at()") {
  261. ErrorDetector ed;
  262. Array arr = { 2, 4, 6, 8, 10 };
  263. REQUIRE(int(arr.pop_at(2)) == 6);
  264. REQUIRE(arr.size() == 4);
  265. CHECK(int(arr[0]) == 2);
  266. CHECK(int(arr[1]) == 4);
  267. CHECK(int(arr[2]) == 8);
  268. CHECK(int(arr[3]) == 10);
  269. REQUIRE(int(arr.pop_at(2)) == 8);
  270. REQUIRE(arr.size() == 3);
  271. CHECK(int(arr[0]) == 2);
  272. CHECK(int(arr[1]) == 4);
  273. CHECK(int(arr[2]) == 10);
  274. // Negative index.
  275. REQUIRE(int(arr.pop_at(-1)) == 10);
  276. REQUIRE(arr.size() == 2);
  277. CHECK(int(arr[0]) == 2);
  278. CHECK(int(arr[1]) == 4);
  279. // Invalid pop.
  280. ed.clear();
  281. ERR_PRINT_OFF;
  282. const Variant ret = arr.pop_at(-15);
  283. ERR_PRINT_ON;
  284. REQUIRE(ret.is_null());
  285. CHECK(ed.has_error);
  286. REQUIRE(int(arr.pop_at(0)) == 2);
  287. REQUIRE(arr.size() == 1);
  288. CHECK(int(arr[0]) == 4);
  289. REQUIRE(int(arr.pop_at(0)) == 4);
  290. REQUIRE(arr.is_empty());
  291. // Pop from empty array.
  292. ed.clear();
  293. REQUIRE(arr.pop_at(24).is_null());
  294. CHECK_FALSE(ed.has_error);
  295. }
  296. TEST_CASE("[Array] max() and min()") {
  297. Array arr;
  298. arr.push_back(3);
  299. arr.push_front(4);
  300. arr.push_back(5);
  301. arr.push_back(2);
  302. int max = int(arr.max());
  303. int min = int(arr.min());
  304. CHECK(max == 5);
  305. CHECK(min == 2);
  306. }
  307. TEST_CASE("[Array] slice()") {
  308. Array array = { 0, 1, 2, 3, 4, 5 };
  309. Array slice0 = array.slice(0, 0);
  310. CHECK(slice0.size() == 0);
  311. Array slice1 = array.slice(1, 3);
  312. CHECK(slice1.size() == 2);
  313. CHECK(slice1[0] == Variant(1));
  314. CHECK(slice1[1] == Variant(2));
  315. Array slice2 = array.slice(1, -1);
  316. CHECK(slice2.size() == 4);
  317. CHECK(slice2[0] == Variant(1));
  318. CHECK(slice2[1] == Variant(2));
  319. CHECK(slice2[2] == Variant(3));
  320. CHECK(slice2[3] == Variant(4));
  321. Array slice3 = array.slice(3);
  322. CHECK(slice3.size() == 3);
  323. CHECK(slice3[0] == Variant(3));
  324. CHECK(slice3[1] == Variant(4));
  325. CHECK(slice3[2] == Variant(5));
  326. Array slice4 = array.slice(2, -2);
  327. CHECK(slice4.size() == 2);
  328. CHECK(slice4[0] == Variant(2));
  329. CHECK(slice4[1] == Variant(3));
  330. Array slice5 = array.slice(-2);
  331. CHECK(slice5.size() == 2);
  332. CHECK(slice5[0] == Variant(4));
  333. CHECK(slice5[1] == Variant(5));
  334. Array slice6 = array.slice(2, 42);
  335. CHECK(slice6.size() == 4);
  336. CHECK(slice6[0] == Variant(2));
  337. CHECK(slice6[1] == Variant(3));
  338. CHECK(slice6[2] == Variant(4));
  339. CHECK(slice6[3] == Variant(5));
  340. Array slice7 = array.slice(4, 0, -2);
  341. CHECK(slice7.size() == 2);
  342. CHECK(slice7[0] == Variant(4));
  343. CHECK(slice7[1] == Variant(2));
  344. Array slice8 = array.slice(5, 0, -2);
  345. CHECK(slice8.size() == 3);
  346. CHECK(slice8[0] == Variant(5));
  347. CHECK(slice8[1] == Variant(3));
  348. CHECK(slice8[2] == Variant(1));
  349. Array slice9 = array.slice(10, 0, -2);
  350. CHECK(slice9.size() == 3);
  351. CHECK(slice9[0] == Variant(5));
  352. CHECK(slice9[1] == Variant(3));
  353. CHECK(slice9[2] == Variant(1));
  354. Array slice10 = array.slice(2, -10, -1);
  355. CHECK(slice10.size() == 3);
  356. CHECK(slice10[0] == Variant(2));
  357. CHECK(slice10[1] == Variant(1));
  358. CHECK(slice10[2] == Variant(0));
  359. ERR_PRINT_OFF;
  360. Array slice11 = array.slice(4, 1);
  361. CHECK(slice11.size() == 0);
  362. Array slice12 = array.slice(3, -4);
  363. CHECK(slice12.size() == 0);
  364. ERR_PRINT_ON;
  365. Array slice13 = Array().slice(1);
  366. CHECK(slice13.size() == 0);
  367. Array slice14 = array.slice(6);
  368. CHECK(slice14.size() == 0);
  369. }
  370. TEST_CASE("[Array] Duplicate array") {
  371. // a = [1, [2, 2], {3: 3}]
  372. Array a = { 1, { 2, 2 }, Dictionary({ { 3, 3 } }) };
  373. // Deep copy
  374. Array deep_a = a.duplicate(true);
  375. CHECK_MESSAGE(deep_a.id() != a.id(), "Should create a new array");
  376. CHECK_MESSAGE(Array(deep_a[1]).id() != Array(a[1]).id(), "Should clone nested array");
  377. CHECK_MESSAGE(Dictionary(deep_a[2]).id() != Dictionary(a[2]).id(), "Should clone nested dictionary");
  378. CHECK_EQ(deep_a, a);
  379. deep_a.push_back(1);
  380. CHECK_NE(deep_a, a);
  381. deep_a.pop_back();
  382. Array(deep_a[1]).push_back(1);
  383. CHECK_NE(deep_a, a);
  384. Array(deep_a[1]).pop_back();
  385. CHECK_EQ(deep_a, a);
  386. // Shallow copy
  387. Array shallow_a = a.duplicate(false);
  388. CHECK_MESSAGE(shallow_a.id() != a.id(), "Should create a new array");
  389. CHECK_MESSAGE(Array(shallow_a[1]).id() == Array(a[1]).id(), "Should keep nested array");
  390. CHECK_MESSAGE(Dictionary(shallow_a[2]).id() == Dictionary(a[2]).id(), "Should keep nested dictionary");
  391. CHECK_EQ(shallow_a, a);
  392. Array(shallow_a).push_back(1);
  393. CHECK_NE(shallow_a, a);
  394. }
  395. TEST_CASE("[Array] Duplicate recursive array") {
  396. // Self recursive
  397. Array a;
  398. a.push_back(a);
  399. Array a_shallow = a.duplicate(false);
  400. CHECK_EQ(a, a_shallow);
  401. // Deep copy of recursive array ends up with recursion limit and return
  402. // an invalid result (multiple nested arrays), the point is we should
  403. // not end up with a segfault and an error log should be printed
  404. ERR_PRINT_OFF;
  405. a.duplicate(true);
  406. ERR_PRINT_ON;
  407. // Nested recursive
  408. Array a1;
  409. Array a2;
  410. a2.push_back(a1);
  411. a1.push_back(a2);
  412. Array a1_shallow = a1.duplicate(false);
  413. CHECK_EQ(a1, a1_shallow);
  414. // Same deep copy issue as above
  415. ERR_PRINT_OFF;
  416. a1.duplicate(true);
  417. ERR_PRINT_ON;
  418. // Break the recursivity otherwise Array teardown will leak memory
  419. a.clear();
  420. a1.clear();
  421. a2.clear();
  422. }
  423. TEST_CASE("[Array] Hash array") {
  424. // a = [1, [2, 2], {3: 3}]
  425. Array a = { 1, { 2, 2 }, Dictionary({ { 3, 3 } }) };
  426. uint32_t original_hash = a.hash();
  427. a.push_back(1);
  428. CHECK_NE(a.hash(), original_hash);
  429. a.pop_back();
  430. CHECK_EQ(a.hash(), original_hash);
  431. Array(a[1]).push_back(1);
  432. CHECK_NE(a.hash(), original_hash);
  433. Array(a[1]).pop_back();
  434. CHECK_EQ(a.hash(), original_hash);
  435. (Dictionary(a[2]))[1] = 1;
  436. CHECK_NE(a.hash(), original_hash);
  437. Dictionary(a[2]).erase(1);
  438. CHECK_EQ(a.hash(), original_hash);
  439. Array a2 = a.duplicate(true);
  440. CHECK_EQ(a2.hash(), a.hash());
  441. }
  442. TEST_CASE("[Array] Hash recursive array") {
  443. Array a1;
  444. a1.push_back(a1);
  445. Array a2;
  446. a2.push_back(a2);
  447. // Hash should reach recursion limit
  448. ERR_PRINT_OFF;
  449. CHECK_EQ(a1.hash(), a2.hash());
  450. ERR_PRINT_ON;
  451. // Break the recursivity otherwise Array teardown will leak memory
  452. a1.clear();
  453. a2.clear();
  454. }
  455. TEST_CASE("[Array] Empty comparison") {
  456. Array a1;
  457. Array a2;
  458. // test both operator== and operator!=
  459. CHECK_EQ(a1, a2);
  460. CHECK_FALSE(a1 != a2);
  461. }
  462. TEST_CASE("[Array] Flat comparison") {
  463. Array a1 = { 1 };
  464. Array a2 = { 1 };
  465. Array other_a = { 2 };
  466. // test both operator== and operator!=
  467. CHECK_EQ(a1, a1); // compare self
  468. CHECK_FALSE(a1 != a1);
  469. CHECK_EQ(a1, a2); // different equivalent arrays
  470. CHECK_FALSE(a1 != a2);
  471. CHECK_NE(a1, other_a); // different arrays with different content
  472. CHECK_FALSE(a1 == other_a);
  473. }
  474. TEST_CASE("[Array] Nested array comparison") {
  475. // a1 = [[[1], 2], 3]
  476. Array a1 = { { { 1 }, 2 }, 3 };
  477. Array a2 = a1.duplicate(true);
  478. // other_a = [[[1, 0], 2], 3]
  479. Array other_a = { { { 1, 0 }, 2 }, 3 };
  480. // test both operator== and operator!=
  481. CHECK_EQ(a1, a1); // compare self
  482. CHECK_FALSE(a1 != a1);
  483. CHECK_EQ(a1, a2); // different equivalent arrays
  484. CHECK_FALSE(a1 != a2);
  485. CHECK_NE(a1, other_a); // different arrays with different content
  486. CHECK_FALSE(a1 == other_a);
  487. }
  488. TEST_CASE("[Array] Nested dictionary comparison") {
  489. // a1 = [{1: 2}, 3]
  490. Array a1 = { Dictionary({ { 1, 2 } }), 3 };
  491. Array a2 = a1.duplicate(true);
  492. // other_a = [{1: 0}, 3]
  493. Array other_a = { Dictionary({ { 1, 0 } }), 3 };
  494. // test both operator== and operator!=
  495. CHECK_EQ(a1, a1); // compare self
  496. CHECK_FALSE(a1 != a1);
  497. CHECK_EQ(a1, a2); // different equivalent arrays
  498. CHECK_FALSE(a1 != a2);
  499. CHECK_NE(a1, other_a); // different arrays with different content
  500. CHECK_FALSE(a1 == other_a);
  501. }
  502. TEST_CASE("[Array] Recursive comparison") {
  503. Array a1;
  504. a1.push_back(a1);
  505. Array a2;
  506. a2.push_back(a2);
  507. // Comparison should reach recursion limit
  508. ERR_PRINT_OFF;
  509. CHECK_EQ(a1, a2);
  510. CHECK_FALSE(a1 != a2);
  511. ERR_PRINT_ON;
  512. a1.push_back(1);
  513. a2.push_back(1);
  514. // Comparison should reach recursion limit
  515. ERR_PRINT_OFF;
  516. CHECK_EQ(a1, a2);
  517. CHECK_FALSE(a1 != a2);
  518. ERR_PRINT_ON;
  519. a1.push_back(1);
  520. a2.push_back(2);
  521. // Comparison should reach recursion limit
  522. ERR_PRINT_OFF;
  523. CHECK_NE(a1, a2);
  524. CHECK_FALSE(a1 == a2);
  525. ERR_PRINT_ON;
  526. // Break the recursivity otherwise Array tearndown will leak memory
  527. a1.clear();
  528. a2.clear();
  529. }
  530. TEST_CASE("[Array] Recursive self comparison") {
  531. Array a1;
  532. Array a2;
  533. a2.push_back(a1);
  534. a1.push_back(a2);
  535. CHECK_EQ(a1, a1);
  536. CHECK_FALSE(a1 != a1);
  537. // Break the recursivity otherwise Array tearndown will leak memory
  538. a1.clear();
  539. a2.clear();
  540. }
  541. TEST_CASE("[Array] Iteration") {
  542. Array a1 = { 1, 2, 3 };
  543. Array a2 = { 1, 2, 3 };
  544. int idx = 0;
  545. for (Variant &E : a1) {
  546. CHECK_EQ(int(a2[idx]), int(E));
  547. idx++;
  548. }
  549. CHECK_EQ(idx, a1.size());
  550. idx = 0;
  551. for (const Variant &E : (const Array &)a1) {
  552. CHECK_EQ(int(a2[idx]), int(E));
  553. idx++;
  554. }
  555. CHECK_EQ(idx, a1.size());
  556. a1.clear();
  557. }
  558. TEST_CASE("[Array] Iteration and modification") {
  559. Array a1 = { 1, 2, 3 };
  560. Array a2 = { 2, 3, 4 };
  561. Array a3 = { 1, 2, 3 };
  562. Array a4 = { 1, 2, 3 };
  563. a3.make_read_only();
  564. int idx = 0;
  565. for (Variant &E : a1) {
  566. E = a2[idx];
  567. idx++;
  568. }
  569. CHECK_EQ(a1, a2);
  570. // Ensure read-only is respected.
  571. idx = 0;
  572. for (Variant &E : a3) {
  573. E = a2[idx];
  574. }
  575. CHECK_EQ(a3, a4);
  576. a1.clear();
  577. a2.clear();
  578. a4.clear();
  579. }
  580. TEST_CASE("[Array] Typed copying") {
  581. TypedArray<int> a1 = { 1 };
  582. TypedArray<double> a2 = { 1.0 };
  583. Array a3 = a1;
  584. TypedArray<int> a4 = a3;
  585. Array a5 = a2;
  586. TypedArray<int> a6 = a5;
  587. a3[0] = 2;
  588. a4[0] = 3;
  589. // Same typed TypedArray should be shared.
  590. CHECK_EQ(a1[0], Variant(3));
  591. CHECK_EQ(a3[0], Variant(3));
  592. CHECK_EQ(a4[0], Variant(3));
  593. a5[0] = 2.0;
  594. a6[0] = 3.0;
  595. // Different typed TypedArray should not be shared.
  596. CHECK_EQ(a2[0], Variant(2.0));
  597. CHECK_EQ(a5[0], Variant(2.0));
  598. CHECK_EQ(a6[0], Variant(3.0));
  599. a1.clear();
  600. a2.clear();
  601. a3.clear();
  602. a4.clear();
  603. a5.clear();
  604. a6.clear();
  605. }
  606. TEST_CASE("[Array] find() and rfind()") {
  607. Array array = { "a", "b", "c", "a", "b", "c" };
  608. CHECK_EQ(array.find("a"), 0);
  609. CHECK_EQ(array.find("c"), 2);
  610. CHECK_EQ(array.find("a", 1), 3);
  611. CHECK_EQ(array.rfind("b"), 4);
  612. CHECK_EQ(array.rfind("c", -2), 2);
  613. }
  614. static bool _find_custom_callable(const Variant &p_val) {
  615. return (int)p_val % 2 == 0;
  616. }
  617. TEST_CASE("[Array] Test find_custom") {
  618. Array a1 = { 1, 3, 4, 5, 8, 9 };
  619. // Find first even number.
  620. int index = a1.find_custom(callable_mp_static(_find_custom_callable));
  621. CHECK_EQ(index, 2);
  622. }
  623. TEST_CASE("[Array] Test rfind_custom") {
  624. Array a1 = { 1, 3, 4, 5, 8, 9 };
  625. // Find last even number.
  626. int index = a1.rfind_custom(callable_mp_static(_find_custom_callable));
  627. CHECK_EQ(index, 4);
  628. }
  629. TEST_CASE("[Array] Test typed arrays") {
  630. Array arr1;
  631. CHECK_FALSE(arr1.is_typed());
  632. arr1.set_typed(Variant::FLOAT, StringName(), Variant());
  633. CHECK(arr1.is_typed());
  634. CHECK_EQ(arr1.get_typed_builtin(), Variant::FLOAT);
  635. arr1.push_back(1);
  636. CHECK_EQ(arr1.size(), 1);
  637. ERR_PRINT_OFF;
  638. arr1.push_back("test wrong type");
  639. CHECK_EQ(arr1.size(), 1);
  640. ERR_PRINT_ON;
  641. Array arr2;
  642. arr2.set_typed(Variant::INT, StringName(), Variant());
  643. CHECK_FALSE(arr1.is_same_typed(arr2));
  644. Array arr3;
  645. arr3.set_typed(Variant::OBJECT, "Node", Variant());
  646. CHECK_EQ(arr3.get_typed_class_name(), "Node");
  647. }
  648. } // namespace TestArray