array.cpp 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821
  1. /**************************************************************************/
  2. /* array.cpp */
  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. #include "array.h"
  31. #include "container_type_validate.h"
  32. #include "core/math/math_funcs.h"
  33. #include "core/object/class_db.h"
  34. #include "core/object/script_language.h"
  35. #include "core/templates/hashfuncs.h"
  36. #include "core/templates/search_array.h"
  37. #include "core/templates/vector.h"
  38. #include "core/variant/callable.h"
  39. #include "core/variant/dictionary.h"
  40. #include "core/variant/variant.h"
  41. class ArrayPrivate {
  42. public:
  43. SafeRefCount refcount;
  44. Vector<Variant> array;
  45. Variant *read_only = nullptr; // If enabled, a pointer is used to a temporary value that is used to return read-only values.
  46. ContainerTypeValidate typed;
  47. };
  48. void Array::_ref(const Array &p_from) const {
  49. ArrayPrivate *_fp = p_from._p;
  50. ERR_FAIL_COND(!_fp); // should NOT happen.
  51. if (_fp == _p) {
  52. return; // whatever it is, nothing to do here move along
  53. }
  54. bool success = _fp->refcount.ref();
  55. ERR_FAIL_COND(!success); // should really not happen either
  56. _unref();
  57. _p = _fp;
  58. }
  59. void Array::_unref() const {
  60. if (!_p) {
  61. return;
  62. }
  63. if (_p->refcount.unref()) {
  64. if (_p->read_only) {
  65. memdelete(_p->read_only);
  66. }
  67. memdelete(_p);
  68. }
  69. _p = nullptr;
  70. }
  71. Variant &Array::operator[](int p_idx) {
  72. if (unlikely(_p->read_only)) {
  73. *_p->read_only = _p->array[p_idx];
  74. return *_p->read_only;
  75. }
  76. return _p->array.write[p_idx];
  77. }
  78. const Variant &Array::operator[](int p_idx) const {
  79. if (unlikely(_p->read_only)) {
  80. *_p->read_only = _p->array[p_idx];
  81. return *_p->read_only;
  82. }
  83. return _p->array[p_idx];
  84. }
  85. int Array::size() const {
  86. return _p->array.size();
  87. }
  88. bool Array::is_empty() const {
  89. return _p->array.is_empty();
  90. }
  91. void Array::clear() {
  92. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  93. _p->array.clear();
  94. }
  95. bool Array::operator==(const Array &p_array) const {
  96. return recursive_equal(p_array, 0);
  97. }
  98. bool Array::operator!=(const Array &p_array) const {
  99. return !recursive_equal(p_array, 0);
  100. }
  101. bool Array::recursive_equal(const Array &p_array, int recursion_count) const {
  102. // Cheap checks
  103. if (_p == p_array._p) {
  104. return true;
  105. }
  106. const Vector<Variant> &a1 = _p->array;
  107. const Vector<Variant> &a2 = p_array._p->array;
  108. const int size = a1.size();
  109. if (size != a2.size()) {
  110. return false;
  111. }
  112. // Heavy O(n) check
  113. if (recursion_count > MAX_RECURSION) {
  114. ERR_PRINT("Max recursion reached");
  115. return true;
  116. }
  117. recursion_count++;
  118. for (int i = 0; i < size; i++) {
  119. if (!a1[i].hash_compare(a2[i], recursion_count)) {
  120. return false;
  121. }
  122. }
  123. return true;
  124. }
  125. bool Array::operator<(const Array &p_array) const {
  126. int a_len = size();
  127. int b_len = p_array.size();
  128. int min_cmp = MIN(a_len, b_len);
  129. for (int i = 0; i < min_cmp; i++) {
  130. if (operator[](i) < p_array[i]) {
  131. return true;
  132. } else if (p_array[i] < operator[](i)) {
  133. return false;
  134. }
  135. }
  136. return a_len < b_len;
  137. }
  138. bool Array::operator<=(const Array &p_array) const {
  139. return !operator>(p_array);
  140. }
  141. bool Array::operator>(const Array &p_array) const {
  142. return p_array < *this;
  143. }
  144. bool Array::operator>=(const Array &p_array) const {
  145. return !operator<(p_array);
  146. }
  147. uint32_t Array::hash() const {
  148. return recursive_hash(0);
  149. }
  150. uint32_t Array::recursive_hash(int recursion_count) const {
  151. if (recursion_count > MAX_RECURSION) {
  152. ERR_PRINT("Max recursion reached");
  153. return 0;
  154. }
  155. uint32_t h = hash_murmur3_one_32(Variant::ARRAY);
  156. recursion_count++;
  157. for (int i = 0; i < _p->array.size(); i++) {
  158. h = hash_murmur3_one_32(_p->array[i].recursive_hash(recursion_count), h);
  159. }
  160. return hash_fmix32(h);
  161. }
  162. void Array::operator=(const Array &p_array) {
  163. if (this == &p_array) {
  164. return;
  165. }
  166. _ref(p_array);
  167. }
  168. void Array::assign(const Array &p_array) {
  169. const ContainerTypeValidate &typed = _p->typed;
  170. const ContainerTypeValidate &source_typed = p_array._p->typed;
  171. if (typed == source_typed || typed.type == Variant::NIL || (source_typed.type == Variant::OBJECT && typed.can_reference(source_typed))) {
  172. // from same to same or
  173. // from anything to variants or
  174. // from subclasses to base classes
  175. _p->array = p_array._p->array;
  176. return;
  177. }
  178. const Variant *source = p_array._p->array.ptr();
  179. int size = p_array._p->array.size();
  180. if ((source_typed.type == Variant::NIL && typed.type == Variant::OBJECT) || (source_typed.type == Variant::OBJECT && source_typed.can_reference(typed))) {
  181. // from variants to objects or
  182. // from base classes to subclasses
  183. for (int i = 0; i < size; i++) {
  184. const Variant &element = source[i];
  185. if (element.get_type() != Variant::NIL && (element.get_type() != Variant::OBJECT || !typed.validate_object(element, "assign"))) {
  186. ERR_FAIL_MSG(vformat(R"(Unable to convert array index %i from "%s" to "%s".)", i, Variant::get_type_name(element.get_type()), Variant::get_type_name(typed.type)));
  187. }
  188. }
  189. _p->array = p_array._p->array;
  190. return;
  191. }
  192. if (typed.type == Variant::OBJECT || source_typed.type == Variant::OBJECT) {
  193. ERR_FAIL_MSG(vformat(R"(Cannot assign contents of "Array[%s]" to "Array[%s]".)", Variant::get_type_name(source_typed.type), Variant::get_type_name(typed.type)));
  194. }
  195. Vector<Variant> array;
  196. array.resize(size);
  197. Variant *data = array.ptrw();
  198. if (source_typed.type == Variant::NIL && typed.type != Variant::OBJECT) {
  199. // from variants to primitives
  200. for (int i = 0; i < size; i++) {
  201. const Variant *value = source + i;
  202. if (value->get_type() == typed.type) {
  203. data[i] = *value;
  204. continue;
  205. }
  206. if (!Variant::can_convert_strict(value->get_type(), typed.type)) {
  207. ERR_FAIL_MSG("Unable to convert array index " + itos(i) + " from '" + Variant::get_type_name(value->get_type()) + "' to '" + Variant::get_type_name(typed.type) + "'.");
  208. }
  209. Callable::CallError ce;
  210. Variant::construct(typed.type, data[i], &value, 1, ce);
  211. ERR_FAIL_COND_MSG(ce.error, vformat(R"(Unable to convert array index %i from "%s" to "%s".)", i, Variant::get_type_name(value->get_type()), Variant::get_type_name(typed.type)));
  212. }
  213. } else if (Variant::can_convert_strict(source_typed.type, typed.type)) {
  214. // from primitives to different convertible primitives
  215. for (int i = 0; i < size; i++) {
  216. const Variant *value = source + i;
  217. Callable::CallError ce;
  218. Variant::construct(typed.type, data[i], &value, 1, ce);
  219. ERR_FAIL_COND_MSG(ce.error, vformat(R"(Unable to convert array index %i from "%s" to "%s".)", i, Variant::get_type_name(value->get_type()), Variant::get_type_name(typed.type)));
  220. }
  221. } else {
  222. ERR_FAIL_MSG(vformat(R"(Cannot assign contents of "Array[%s]" to "Array[%s]".)", Variant::get_type_name(source_typed.type), Variant::get_type_name(typed.type)));
  223. }
  224. _p->array = array;
  225. }
  226. void Array::push_back(const Variant &p_value) {
  227. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  228. Variant value = p_value;
  229. ERR_FAIL_COND(!_p->typed.validate(value, "push_back"));
  230. _p->array.push_back(value);
  231. }
  232. void Array::append_array(const Array &p_array) {
  233. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  234. Vector<Variant> validated_array = p_array._p->array;
  235. for (int i = 0; i < validated_array.size(); ++i) {
  236. ERR_FAIL_COND(!_p->typed.validate(validated_array.write[i], "append_array"));
  237. }
  238. _p->array.append_array(validated_array);
  239. }
  240. Error Array::resize(int p_new_size) {
  241. ERR_FAIL_COND_V_MSG(_p->read_only, ERR_LOCKED, "Array is in read-only state.");
  242. Variant::Type &variant_type = _p->typed.type;
  243. int old_size = _p->array.size();
  244. Error err = _p->array.resize_zeroed(p_new_size);
  245. if (!err && variant_type != Variant::NIL && variant_type != Variant::OBJECT) {
  246. for (int i = old_size; i < p_new_size; i++) {
  247. VariantInternal::initialize(&_p->array.write[i], variant_type);
  248. }
  249. }
  250. return err;
  251. }
  252. Error Array::insert(int p_pos, const Variant &p_value) {
  253. ERR_FAIL_COND_V_MSG(_p->read_only, ERR_LOCKED, "Array is in read-only state.");
  254. Variant value = p_value;
  255. ERR_FAIL_COND_V(!_p->typed.validate(value, "insert"), ERR_INVALID_PARAMETER);
  256. return _p->array.insert(p_pos, value);
  257. }
  258. void Array::fill(const Variant &p_value) {
  259. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  260. Variant value = p_value;
  261. ERR_FAIL_COND(!_p->typed.validate(value, "fill"));
  262. _p->array.fill(value);
  263. }
  264. void Array::erase(const Variant &p_value) {
  265. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  266. Variant value = p_value;
  267. ERR_FAIL_COND(!_p->typed.validate(value, "erase"));
  268. _p->array.erase(value);
  269. }
  270. Variant Array::front() const {
  271. ERR_FAIL_COND_V_MSG(_p->array.size() == 0, Variant(), "Can't take value from empty array.");
  272. return operator[](0);
  273. }
  274. Variant Array::back() const {
  275. ERR_FAIL_COND_V_MSG(_p->array.size() == 0, Variant(), "Can't take value from empty array.");
  276. return operator[](_p->array.size() - 1);
  277. }
  278. Variant Array::pick_random() const {
  279. ERR_FAIL_COND_V_MSG(_p->array.size() == 0, Variant(), "Can't take value from empty array.");
  280. return operator[](Math::rand() % _p->array.size());
  281. }
  282. int Array::find(const Variant &p_value, int p_from) const {
  283. if (_p->array.size() == 0) {
  284. return -1;
  285. }
  286. Variant value = p_value;
  287. ERR_FAIL_COND_V(!_p->typed.validate(value, "find"), -1);
  288. int ret = -1;
  289. if (p_from < 0 || size() == 0) {
  290. return ret;
  291. }
  292. for (int i = p_from; i < size(); i++) {
  293. if (StringLikeVariantComparator::compare(_p->array[i], value)) {
  294. ret = i;
  295. break;
  296. }
  297. }
  298. return ret;
  299. }
  300. int Array::rfind(const Variant &p_value, int p_from) const {
  301. if (_p->array.size() == 0) {
  302. return -1;
  303. }
  304. Variant value = p_value;
  305. ERR_FAIL_COND_V(!_p->typed.validate(value, "rfind"), -1);
  306. if (p_from < 0) {
  307. // Relative offset from the end
  308. p_from = _p->array.size() + p_from;
  309. }
  310. if (p_from < 0 || p_from >= _p->array.size()) {
  311. // Limit to array boundaries
  312. p_from = _p->array.size() - 1;
  313. }
  314. for (int i = p_from; i >= 0; i--) {
  315. if (StringLikeVariantComparator::compare(_p->array[i], value)) {
  316. return i;
  317. }
  318. }
  319. return -1;
  320. }
  321. int Array::count(const Variant &p_value) const {
  322. Variant value = p_value;
  323. ERR_FAIL_COND_V(!_p->typed.validate(value, "count"), 0);
  324. if (_p->array.size() == 0) {
  325. return 0;
  326. }
  327. int amount = 0;
  328. for (int i = 0; i < _p->array.size(); i++) {
  329. if (StringLikeVariantComparator::compare(_p->array[i], value)) {
  330. amount++;
  331. }
  332. }
  333. return amount;
  334. }
  335. bool Array::has(const Variant &p_value) const {
  336. Variant value = p_value;
  337. ERR_FAIL_COND_V(!_p->typed.validate(value, "use 'has'"), false);
  338. return find(value) != -1;
  339. }
  340. void Array::remove_at(int p_pos) {
  341. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  342. _p->array.remove_at(p_pos);
  343. }
  344. void Array::set(int p_idx, const Variant &p_value) {
  345. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  346. Variant value = p_value;
  347. ERR_FAIL_COND(!_p->typed.validate(value, "set"));
  348. operator[](p_idx) = value;
  349. }
  350. const Variant &Array::get(int p_idx) const {
  351. return operator[](p_idx);
  352. }
  353. Array Array::duplicate(bool p_deep) const {
  354. return recursive_duplicate(p_deep, 0);
  355. }
  356. Array Array::recursive_duplicate(bool p_deep, int recursion_count) const {
  357. Array new_arr;
  358. new_arr._p->typed = _p->typed;
  359. if (recursion_count > MAX_RECURSION) {
  360. ERR_PRINT("Max recursion reached");
  361. return new_arr;
  362. }
  363. if (p_deep) {
  364. recursion_count++;
  365. int element_count = size();
  366. new_arr.resize(element_count);
  367. for (int i = 0; i < element_count; i++) {
  368. new_arr[i] = get(i).recursive_duplicate(true, recursion_count);
  369. }
  370. } else {
  371. new_arr._p->array = _p->array;
  372. }
  373. return new_arr;
  374. }
  375. Array Array::slice(int p_begin, int p_end, int p_step, bool p_deep) const {
  376. Array result;
  377. result._p->typed = _p->typed;
  378. ERR_FAIL_COND_V_MSG(p_step == 0, result, "Slice step cannot be zero.");
  379. const int s = size();
  380. int begin = CLAMP(p_begin, -s, s);
  381. if (begin < 0) {
  382. begin += s;
  383. }
  384. int end = CLAMP(p_end, -s, s);
  385. if (end < 0) {
  386. end += s;
  387. }
  388. ERR_FAIL_COND_V_MSG(p_step > 0 && begin > end, result, "Slice is positive, but bounds is decreasing.");
  389. ERR_FAIL_COND_V_MSG(p_step < 0 && begin < end, result, "Slice is negative, but bounds is increasing.");
  390. int result_size = (end - begin) / p_step + (((end - begin) % p_step != 0) ? 1 : 0);
  391. result.resize(result_size);
  392. for (int src_idx = begin, dest_idx = 0; dest_idx < result_size; ++dest_idx) {
  393. result[dest_idx] = p_deep ? get(src_idx).duplicate(true) : get(src_idx);
  394. src_idx += p_step;
  395. }
  396. return result;
  397. }
  398. Array Array::filter(const Callable &p_callable) const {
  399. Array new_arr;
  400. new_arr.resize(size());
  401. new_arr._p->typed = _p->typed;
  402. int accepted_count = 0;
  403. const Variant *argptrs[1];
  404. for (int i = 0; i < size(); i++) {
  405. argptrs[0] = &get(i);
  406. Variant result;
  407. Callable::CallError ce;
  408. p_callable.callp(argptrs, 1, result, ce);
  409. if (ce.error != Callable::CallError::CALL_OK) {
  410. ERR_FAIL_V_MSG(Array(), "Error calling method from 'filter': " + Variant::get_callable_error_text(p_callable, argptrs, 1, ce));
  411. }
  412. if (result.operator bool()) {
  413. new_arr[accepted_count] = get(i);
  414. accepted_count++;
  415. }
  416. }
  417. new_arr.resize(accepted_count);
  418. return new_arr;
  419. }
  420. Array Array::map(const Callable &p_callable) const {
  421. Array new_arr;
  422. new_arr.resize(size());
  423. const Variant *argptrs[1];
  424. for (int i = 0; i < size(); i++) {
  425. argptrs[0] = &get(i);
  426. Variant result;
  427. Callable::CallError ce;
  428. p_callable.callp(argptrs, 1, result, ce);
  429. if (ce.error != Callable::CallError::CALL_OK) {
  430. ERR_FAIL_V_MSG(Array(), "Error calling method from 'map': " + Variant::get_callable_error_text(p_callable, argptrs, 1, ce));
  431. }
  432. new_arr[i] = result;
  433. }
  434. return new_arr;
  435. }
  436. Variant Array::reduce(const Callable &p_callable, const Variant &p_accum) const {
  437. int start = 0;
  438. Variant ret = p_accum;
  439. if (ret == Variant() && size() > 0) {
  440. ret = front();
  441. start = 1;
  442. }
  443. const Variant *argptrs[2];
  444. for (int i = start; i < size(); i++) {
  445. argptrs[0] = &ret;
  446. argptrs[1] = &get(i);
  447. Variant result;
  448. Callable::CallError ce;
  449. p_callable.callp(argptrs, 2, result, ce);
  450. if (ce.error != Callable::CallError::CALL_OK) {
  451. ERR_FAIL_V_MSG(Variant(), "Error calling method from 'reduce': " + Variant::get_callable_error_text(p_callable, argptrs, 2, ce));
  452. }
  453. ret = result;
  454. }
  455. return ret;
  456. }
  457. bool Array::any(const Callable &p_callable) const {
  458. const Variant *argptrs[1];
  459. for (int i = 0; i < size(); i++) {
  460. argptrs[0] = &get(i);
  461. Variant result;
  462. Callable::CallError ce;
  463. p_callable.callp(argptrs, 1, result, ce);
  464. if (ce.error != Callable::CallError::CALL_OK) {
  465. ERR_FAIL_V_MSG(false, "Error calling method from 'any': " + Variant::get_callable_error_text(p_callable, argptrs, 1, ce));
  466. }
  467. if (result.operator bool()) {
  468. // Return as early as possible when one of the conditions is `true`.
  469. // This improves performance compared to relying on `filter(...).size() >= 1`.
  470. return true;
  471. }
  472. }
  473. return false;
  474. }
  475. bool Array::all(const Callable &p_callable) const {
  476. const Variant *argptrs[1];
  477. for (int i = 0; i < size(); i++) {
  478. argptrs[0] = &get(i);
  479. Variant result;
  480. Callable::CallError ce;
  481. p_callable.callp(argptrs, 1, result, ce);
  482. if (ce.error != Callable::CallError::CALL_OK) {
  483. ERR_FAIL_V_MSG(false, "Error calling method from 'all': " + Variant::get_callable_error_text(p_callable, argptrs, 1, ce));
  484. }
  485. if (!(result.operator bool())) {
  486. // Return as early as possible when one of the inverted conditions is `false`.
  487. // This improves performance compared to relying on `filter(...).size() >= array_size().`.
  488. return false;
  489. }
  490. }
  491. return true;
  492. }
  493. struct _ArrayVariantSort {
  494. _FORCE_INLINE_ bool operator()(const Variant &p_l, const Variant &p_r) const {
  495. bool valid = false;
  496. Variant res;
  497. Variant::evaluate(Variant::OP_LESS, p_l, p_r, res, valid);
  498. if (!valid) {
  499. res = false;
  500. }
  501. return res;
  502. }
  503. };
  504. void Array::sort() {
  505. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  506. _p->array.sort_custom<_ArrayVariantSort>();
  507. }
  508. void Array::sort_custom(const Callable &p_callable) {
  509. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  510. _p->array.sort_custom<CallableComparator, true>(p_callable);
  511. }
  512. void Array::shuffle() {
  513. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  514. const int n = _p->array.size();
  515. if (n < 2) {
  516. return;
  517. }
  518. Variant *data = _p->array.ptrw();
  519. for (int i = n - 1; i >= 1; i--) {
  520. const int j = Math::rand() % (i + 1);
  521. const Variant tmp = data[j];
  522. data[j] = data[i];
  523. data[i] = tmp;
  524. }
  525. }
  526. int Array::bsearch(const Variant &p_value, bool p_before) const {
  527. Variant value = p_value;
  528. ERR_FAIL_COND_V(!_p->typed.validate(value, "binary search"), -1);
  529. SearchArray<Variant, _ArrayVariantSort> avs;
  530. return avs.bisect(_p->array.ptrw(), _p->array.size(), value, p_before);
  531. }
  532. int Array::bsearch_custom(const Variant &p_value, const Callable &p_callable, bool p_before) const {
  533. Variant value = p_value;
  534. ERR_FAIL_COND_V(!_p->typed.validate(value, "custom binary search"), -1);
  535. return _p->array.bsearch_custom<CallableComparator>(value, p_before, p_callable);
  536. }
  537. void Array::reverse() {
  538. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  539. _p->array.reverse();
  540. }
  541. void Array::push_front(const Variant &p_value) {
  542. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  543. Variant value = p_value;
  544. ERR_FAIL_COND(!_p->typed.validate(value, "push_front"));
  545. _p->array.insert(0, value);
  546. }
  547. Variant Array::pop_back() {
  548. ERR_FAIL_COND_V_MSG(_p->read_only, Variant(), "Array is in read-only state.");
  549. if (!_p->array.is_empty()) {
  550. const int n = _p->array.size() - 1;
  551. const Variant ret = _p->array.get(n);
  552. _p->array.resize(n);
  553. return ret;
  554. }
  555. return Variant();
  556. }
  557. Variant Array::pop_front() {
  558. ERR_FAIL_COND_V_MSG(_p->read_only, Variant(), "Array is in read-only state.");
  559. if (!_p->array.is_empty()) {
  560. const Variant ret = _p->array.get(0);
  561. _p->array.remove_at(0);
  562. return ret;
  563. }
  564. return Variant();
  565. }
  566. Variant Array::pop_at(int p_pos) {
  567. ERR_FAIL_COND_V_MSG(_p->read_only, Variant(), "Array is in read-only state.");
  568. if (_p->array.is_empty()) {
  569. // Return `null` without printing an error to mimic `pop_back()` and `pop_front()` behavior.
  570. return Variant();
  571. }
  572. if (p_pos < 0) {
  573. // Relative offset from the end
  574. p_pos = _p->array.size() + p_pos;
  575. }
  576. ERR_FAIL_INDEX_V_MSG(
  577. p_pos,
  578. _p->array.size(),
  579. Variant(),
  580. vformat(
  581. "The calculated index %s is out of bounds (the array has %s elements). Leaving the array untouched and returning `null`.",
  582. p_pos,
  583. _p->array.size()));
  584. const Variant ret = _p->array.get(p_pos);
  585. _p->array.remove_at(p_pos);
  586. return ret;
  587. }
  588. Variant Array::min() const {
  589. Variant minval;
  590. for (int i = 0; i < size(); i++) {
  591. if (i == 0) {
  592. minval = get(i);
  593. } else {
  594. bool valid;
  595. Variant ret;
  596. Variant test = get(i);
  597. Variant::evaluate(Variant::OP_LESS, test, minval, ret, valid);
  598. if (!valid) {
  599. return Variant(); //not a valid comparison
  600. }
  601. if (bool(ret)) {
  602. //is less
  603. minval = test;
  604. }
  605. }
  606. }
  607. return minval;
  608. }
  609. Variant Array::max() const {
  610. Variant maxval;
  611. for (int i = 0; i < size(); i++) {
  612. if (i == 0) {
  613. maxval = get(i);
  614. } else {
  615. bool valid;
  616. Variant ret;
  617. Variant test = get(i);
  618. Variant::evaluate(Variant::OP_GREATER, test, maxval, ret, valid);
  619. if (!valid) {
  620. return Variant(); //not a valid comparison
  621. }
  622. if (bool(ret)) {
  623. //is less
  624. maxval = test;
  625. }
  626. }
  627. }
  628. return maxval;
  629. }
  630. const void *Array::id() const {
  631. return _p;
  632. }
  633. Array::Array(const Array &p_from, uint32_t p_type, const StringName &p_class_name, const Variant &p_script) {
  634. _p = memnew(ArrayPrivate);
  635. _p->refcount.init();
  636. set_typed(p_type, p_class_name, p_script);
  637. assign(p_from);
  638. }
  639. void Array::set_typed(uint32_t p_type, const StringName &p_class_name, const Variant &p_script) {
  640. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  641. ERR_FAIL_COND_MSG(_p->array.size() > 0, "Type can only be set when array is empty.");
  642. ERR_FAIL_COND_MSG(_p->refcount.get() > 1, "Type can only be set when array has no more than one user.");
  643. ERR_FAIL_COND_MSG(_p->typed.type != Variant::NIL, "Type can only be set once.");
  644. ERR_FAIL_COND_MSG(p_class_name != StringName() && p_type != Variant::OBJECT, "Class names can only be set for type OBJECT");
  645. Ref<Script> script = p_script;
  646. ERR_FAIL_COND_MSG(script.is_valid() && p_class_name == StringName(), "Script class can only be set together with base class name");
  647. _p->typed.type = Variant::Type(p_type);
  648. _p->typed.class_name = p_class_name;
  649. _p->typed.script = script;
  650. _p->typed.where = "TypedArray";
  651. }
  652. bool Array::is_typed() const {
  653. return _p->typed.type != Variant::NIL;
  654. }
  655. bool Array::is_same_typed(const Array &p_other) const {
  656. return _p->typed == p_other._p->typed;
  657. }
  658. uint32_t Array::get_typed_builtin() const {
  659. return _p->typed.type;
  660. }
  661. StringName Array::get_typed_class_name() const {
  662. return _p->typed.class_name;
  663. }
  664. Variant Array::get_typed_script() const {
  665. return _p->typed.script;
  666. }
  667. void Array::make_read_only() {
  668. if (_p->read_only == nullptr) {
  669. _p->read_only = memnew(Variant);
  670. }
  671. }
  672. bool Array::is_read_only() const {
  673. return _p->read_only != nullptr;
  674. }
  675. Array::Array(const Array &p_from) {
  676. _p = nullptr;
  677. _ref(p_from);
  678. }
  679. Array::Array() {
  680. _p = memnew(ArrayPrivate);
  681. _p->refcount.init();
  682. }
  683. Array::~Array() {
  684. _unref();
  685. }