array.cpp 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817
  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. Vector<Variant> array;
  193. array.resize(size);
  194. Variant *data = array.ptrw();
  195. if (source_typed.type == Variant::NIL && typed.type != Variant::OBJECT) {
  196. // from variants to primitives
  197. for (int i = 0; i < size; i++) {
  198. const Variant *value = source + i;
  199. if (value->get_type() == typed.type) {
  200. data[i] = *value;
  201. continue;
  202. }
  203. if (!Variant::can_convert_strict(value->get_type(), typed.type)) {
  204. 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) + "'.");
  205. }
  206. Callable::CallError ce;
  207. Variant::construct(typed.type, data[i], &value, 1, ce);
  208. 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)));
  209. }
  210. } else if (Variant::can_convert_strict(source_typed.type, typed.type)) {
  211. // from primitives to different convertable primitives
  212. for (int i = 0; i < size; i++) {
  213. const Variant *value = source + i;
  214. Callable::CallError ce;
  215. Variant::construct(typed.type, data[i], &value, 1, ce);
  216. 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)));
  217. }
  218. } else {
  219. 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)));
  220. }
  221. _p->array = array;
  222. }
  223. void Array::push_back(const Variant &p_value) {
  224. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  225. Variant value = p_value;
  226. ERR_FAIL_COND(!_p->typed.validate(value, "push_back"));
  227. _p->array.push_back(value);
  228. }
  229. void Array::append_array(const Array &p_array) {
  230. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  231. Vector<Variant> validated_array = p_array._p->array;
  232. for (int i = 0; i < validated_array.size(); ++i) {
  233. ERR_FAIL_COND(!_p->typed.validate(validated_array.write[i], "append_array"));
  234. }
  235. _p->array.append_array(validated_array);
  236. }
  237. Error Array::resize(int p_new_size) {
  238. ERR_FAIL_COND_V_MSG(_p->read_only, ERR_LOCKED, "Array is in read-only state.");
  239. Variant::Type &variant_type = _p->typed.type;
  240. int old_size = _p->array.size();
  241. Error err = _p->array.resize_zeroed(p_new_size);
  242. if (!err && variant_type != Variant::NIL && variant_type != Variant::OBJECT) {
  243. for (int i = old_size; i < p_new_size; i++) {
  244. VariantInternal::initialize(&_p->array.write[i], variant_type);
  245. }
  246. }
  247. return err;
  248. }
  249. Error Array::insert(int p_pos, const Variant &p_value) {
  250. ERR_FAIL_COND_V_MSG(_p->read_only, ERR_LOCKED, "Array is in read-only state.");
  251. Variant value = p_value;
  252. ERR_FAIL_COND_V(!_p->typed.validate(value, "insert"), ERR_INVALID_PARAMETER);
  253. return _p->array.insert(p_pos, value);
  254. }
  255. void Array::fill(const Variant &p_value) {
  256. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  257. Variant value = p_value;
  258. ERR_FAIL_COND(!_p->typed.validate(value, "fill"));
  259. _p->array.fill(value);
  260. }
  261. void Array::erase(const Variant &p_value) {
  262. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  263. Variant value = p_value;
  264. ERR_FAIL_COND(!_p->typed.validate(value, "erase"));
  265. _p->array.erase(value);
  266. }
  267. Variant Array::front() const {
  268. ERR_FAIL_COND_V_MSG(_p->array.size() == 0, Variant(), "Can't take value from empty array.");
  269. return operator[](0);
  270. }
  271. Variant Array::back() const {
  272. ERR_FAIL_COND_V_MSG(_p->array.size() == 0, Variant(), "Can't take value from empty array.");
  273. return operator[](_p->array.size() - 1);
  274. }
  275. Variant Array::pick_random() const {
  276. ERR_FAIL_COND_V_MSG(_p->array.size() == 0, Variant(), "Can't take value from empty array.");
  277. return operator[](Math::rand() % _p->array.size());
  278. }
  279. int Array::find(const Variant &p_value, int p_from) const {
  280. if (_p->array.size() == 0) {
  281. return -1;
  282. }
  283. Variant value = p_value;
  284. ERR_FAIL_COND_V(!_p->typed.validate(value, "find"), -1);
  285. int ret = -1;
  286. if (p_from < 0 || size() == 0) {
  287. return ret;
  288. }
  289. for (int i = p_from; i < size(); i++) {
  290. if (StringLikeVariantComparator::compare(_p->array[i], value)) {
  291. ret = i;
  292. break;
  293. }
  294. }
  295. return ret;
  296. }
  297. int Array::rfind(const Variant &p_value, int p_from) const {
  298. if (_p->array.size() == 0) {
  299. return -1;
  300. }
  301. Variant value = p_value;
  302. ERR_FAIL_COND_V(!_p->typed.validate(value, "rfind"), -1);
  303. if (p_from < 0) {
  304. // Relative offset from the end
  305. p_from = _p->array.size() + p_from;
  306. }
  307. if (p_from < 0 || p_from >= _p->array.size()) {
  308. // Limit to array boundaries
  309. p_from = _p->array.size() - 1;
  310. }
  311. for (int i = p_from; i >= 0; i--) {
  312. if (StringLikeVariantComparator::compare(_p->array[i], value)) {
  313. return i;
  314. }
  315. }
  316. return -1;
  317. }
  318. int Array::count(const Variant &p_value) const {
  319. Variant value = p_value;
  320. ERR_FAIL_COND_V(!_p->typed.validate(value, "count"), 0);
  321. if (_p->array.size() == 0) {
  322. return 0;
  323. }
  324. int amount = 0;
  325. for (int i = 0; i < _p->array.size(); i++) {
  326. if (StringLikeVariantComparator::compare(_p->array[i], value)) {
  327. amount++;
  328. }
  329. }
  330. return amount;
  331. }
  332. bool Array::has(const Variant &p_value) const {
  333. Variant value = p_value;
  334. ERR_FAIL_COND_V(!_p->typed.validate(value, "use 'has'"), false);
  335. return find(value) != -1;
  336. }
  337. void Array::remove_at(int p_pos) {
  338. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  339. _p->array.remove_at(p_pos);
  340. }
  341. void Array::set(int p_idx, const Variant &p_value) {
  342. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  343. Variant value = p_value;
  344. ERR_FAIL_COND(!_p->typed.validate(value, "set"));
  345. operator[](p_idx) = value;
  346. }
  347. const Variant &Array::get(int p_idx) const {
  348. return operator[](p_idx);
  349. }
  350. Array Array::duplicate(bool p_deep) const {
  351. return recursive_duplicate(p_deep, 0);
  352. }
  353. Array Array::recursive_duplicate(bool p_deep, int recursion_count) const {
  354. Array new_arr;
  355. new_arr._p->typed = _p->typed;
  356. if (recursion_count > MAX_RECURSION) {
  357. ERR_PRINT("Max recursion reached");
  358. return new_arr;
  359. }
  360. if (p_deep) {
  361. recursion_count++;
  362. int element_count = size();
  363. new_arr.resize(element_count);
  364. for (int i = 0; i < element_count; i++) {
  365. new_arr[i] = get(i).recursive_duplicate(true, recursion_count);
  366. }
  367. } else {
  368. new_arr._p->array = _p->array;
  369. }
  370. return new_arr;
  371. }
  372. Array Array::slice(int p_begin, int p_end, int p_step, bool p_deep) const {
  373. Array result;
  374. result._p->typed = _p->typed;
  375. ERR_FAIL_COND_V_MSG(p_step == 0, result, "Slice step cannot be zero.");
  376. const int s = size();
  377. int begin = CLAMP(p_begin, -s, s);
  378. if (begin < 0) {
  379. begin += s;
  380. }
  381. int end = CLAMP(p_end, -s, s);
  382. if (end < 0) {
  383. end += s;
  384. }
  385. ERR_FAIL_COND_V_MSG(p_step > 0 && begin > end, result, "Slice is positive, but bounds is decreasing.");
  386. ERR_FAIL_COND_V_MSG(p_step < 0 && begin < end, result, "Slice is negative, but bounds is increasing.");
  387. int result_size = (end - begin) / p_step;
  388. result.resize(result_size);
  389. for (int src_idx = begin, dest_idx = 0; dest_idx < result_size; ++dest_idx) {
  390. result[dest_idx] = p_deep ? get(src_idx).duplicate(true) : get(src_idx);
  391. src_idx += p_step;
  392. }
  393. return result;
  394. }
  395. Array Array::filter(const Callable &p_callable) const {
  396. Array new_arr;
  397. new_arr.resize(size());
  398. new_arr._p->typed = _p->typed;
  399. int accepted_count = 0;
  400. const Variant *argptrs[1];
  401. for (int i = 0; i < size(); i++) {
  402. argptrs[0] = &get(i);
  403. Variant result;
  404. Callable::CallError ce;
  405. p_callable.callp(argptrs, 1, result, ce);
  406. if (ce.error != Callable::CallError::CALL_OK) {
  407. ERR_FAIL_V_MSG(Array(), "Error calling method from 'filter': " + Variant::get_callable_error_text(p_callable, argptrs, 1, ce));
  408. }
  409. if (result.operator bool()) {
  410. new_arr[accepted_count] = get(i);
  411. accepted_count++;
  412. }
  413. }
  414. new_arr.resize(accepted_count);
  415. return new_arr;
  416. }
  417. Array Array::map(const Callable &p_callable) const {
  418. Array new_arr;
  419. new_arr.resize(size());
  420. const Variant *argptrs[1];
  421. for (int i = 0; i < size(); i++) {
  422. argptrs[0] = &get(i);
  423. Variant result;
  424. Callable::CallError ce;
  425. p_callable.callp(argptrs, 1, result, ce);
  426. if (ce.error != Callable::CallError::CALL_OK) {
  427. ERR_FAIL_V_MSG(Array(), "Error calling method from 'map': " + Variant::get_callable_error_text(p_callable, argptrs, 1, ce));
  428. }
  429. new_arr[i] = result;
  430. }
  431. return new_arr;
  432. }
  433. Variant Array::reduce(const Callable &p_callable, const Variant &p_accum) const {
  434. int start = 0;
  435. Variant ret = p_accum;
  436. if (ret == Variant() && size() > 0) {
  437. ret = front();
  438. start = 1;
  439. }
  440. const Variant *argptrs[2];
  441. for (int i = start; i < size(); i++) {
  442. argptrs[0] = &ret;
  443. argptrs[1] = &get(i);
  444. Variant result;
  445. Callable::CallError ce;
  446. p_callable.callp(argptrs, 2, result, ce);
  447. if (ce.error != Callable::CallError::CALL_OK) {
  448. ERR_FAIL_V_MSG(Variant(), "Error calling method from 'reduce': " + Variant::get_callable_error_text(p_callable, argptrs, 2, ce));
  449. }
  450. ret = result;
  451. }
  452. return ret;
  453. }
  454. bool Array::any(const Callable &p_callable) const {
  455. const Variant *argptrs[1];
  456. for (int i = 0; i < size(); i++) {
  457. argptrs[0] = &get(i);
  458. Variant result;
  459. Callable::CallError ce;
  460. p_callable.callp(argptrs, 1, result, ce);
  461. if (ce.error != Callable::CallError::CALL_OK) {
  462. ERR_FAIL_V_MSG(false, "Error calling method from 'any': " + Variant::get_callable_error_text(p_callable, argptrs, 1, ce));
  463. }
  464. if (result.operator bool()) {
  465. // Return as early as possible when one of the conditions is `true`.
  466. // This improves performance compared to relying on `filter(...).size() >= 1`.
  467. return true;
  468. }
  469. }
  470. return false;
  471. }
  472. bool Array::all(const Callable &p_callable) const {
  473. const Variant *argptrs[1];
  474. for (int i = 0; i < size(); i++) {
  475. argptrs[0] = &get(i);
  476. Variant result;
  477. Callable::CallError ce;
  478. p_callable.callp(argptrs, 1, result, ce);
  479. if (ce.error != Callable::CallError::CALL_OK) {
  480. ERR_FAIL_V_MSG(false, "Error calling method from 'all': " + Variant::get_callable_error_text(p_callable, argptrs, 1, ce));
  481. }
  482. if (!(result.operator bool())) {
  483. // Return as early as possible when one of the inverted conditions is `false`.
  484. // This improves performance compared to relying on `filter(...).size() >= array_size().`.
  485. return false;
  486. }
  487. }
  488. return true;
  489. }
  490. struct _ArrayVariantSort {
  491. _FORCE_INLINE_ bool operator()(const Variant &p_l, const Variant &p_r) const {
  492. bool valid = false;
  493. Variant res;
  494. Variant::evaluate(Variant::OP_LESS, p_l, p_r, res, valid);
  495. if (!valid) {
  496. res = false;
  497. }
  498. return res;
  499. }
  500. };
  501. void Array::sort() {
  502. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  503. _p->array.sort_custom<_ArrayVariantSort>();
  504. }
  505. void Array::sort_custom(const Callable &p_callable) {
  506. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  507. _p->array.sort_custom<CallableComparator, true>(p_callable);
  508. }
  509. void Array::shuffle() {
  510. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  511. const int n = _p->array.size();
  512. if (n < 2) {
  513. return;
  514. }
  515. Variant *data = _p->array.ptrw();
  516. for (int i = n - 1; i >= 1; i--) {
  517. const int j = Math::rand() % (i + 1);
  518. const Variant tmp = data[j];
  519. data[j] = data[i];
  520. data[i] = tmp;
  521. }
  522. }
  523. int Array::bsearch(const Variant &p_value, bool p_before) {
  524. Variant value = p_value;
  525. ERR_FAIL_COND_V(!_p->typed.validate(value, "binary search"), -1);
  526. SearchArray<Variant, _ArrayVariantSort> avs;
  527. return avs.bisect(_p->array.ptrw(), _p->array.size(), value, p_before);
  528. }
  529. int Array::bsearch_custom(const Variant &p_value, const Callable &p_callable, bool p_before) {
  530. Variant value = p_value;
  531. ERR_FAIL_COND_V(!_p->typed.validate(value, "custom binary search"), -1);
  532. return _p->array.bsearch_custom<CallableComparator>(value, p_before, p_callable);
  533. }
  534. void Array::reverse() {
  535. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  536. _p->array.reverse();
  537. }
  538. void Array::push_front(const Variant &p_value) {
  539. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  540. Variant value = p_value;
  541. ERR_FAIL_COND(!_p->typed.validate(value, "push_front"));
  542. _p->array.insert(0, value);
  543. }
  544. Variant Array::pop_back() {
  545. ERR_FAIL_COND_V_MSG(_p->read_only, Variant(), "Array is in read-only state.");
  546. if (!_p->array.is_empty()) {
  547. const int n = _p->array.size() - 1;
  548. const Variant ret = _p->array.get(n);
  549. _p->array.resize(n);
  550. return ret;
  551. }
  552. return Variant();
  553. }
  554. Variant Array::pop_front() {
  555. ERR_FAIL_COND_V_MSG(_p->read_only, Variant(), "Array is in read-only state.");
  556. if (!_p->array.is_empty()) {
  557. const Variant ret = _p->array.get(0);
  558. _p->array.remove_at(0);
  559. return ret;
  560. }
  561. return Variant();
  562. }
  563. Variant Array::pop_at(int p_pos) {
  564. ERR_FAIL_COND_V_MSG(_p->read_only, Variant(), "Array is in read-only state.");
  565. if (_p->array.is_empty()) {
  566. // Return `null` without printing an error to mimic `pop_back()` and `pop_front()` behavior.
  567. return Variant();
  568. }
  569. if (p_pos < 0) {
  570. // Relative offset from the end
  571. p_pos = _p->array.size() + p_pos;
  572. }
  573. ERR_FAIL_INDEX_V_MSG(
  574. p_pos,
  575. _p->array.size(),
  576. Variant(),
  577. vformat(
  578. "The calculated index %s is out of bounds (the array has %s elements). Leaving the array untouched and returning `null`.",
  579. p_pos,
  580. _p->array.size()));
  581. const Variant ret = _p->array.get(p_pos);
  582. _p->array.remove_at(p_pos);
  583. return ret;
  584. }
  585. Variant Array::min() const {
  586. Variant minval;
  587. for (int i = 0; i < size(); i++) {
  588. if (i == 0) {
  589. minval = get(i);
  590. } else {
  591. bool valid;
  592. Variant ret;
  593. Variant test = get(i);
  594. Variant::evaluate(Variant::OP_LESS, test, minval, ret, valid);
  595. if (!valid) {
  596. return Variant(); //not a valid comparison
  597. }
  598. if (bool(ret)) {
  599. //is less
  600. minval = test;
  601. }
  602. }
  603. }
  604. return minval;
  605. }
  606. Variant Array::max() const {
  607. Variant maxval;
  608. for (int i = 0; i < size(); i++) {
  609. if (i == 0) {
  610. maxval = get(i);
  611. } else {
  612. bool valid;
  613. Variant ret;
  614. Variant test = get(i);
  615. Variant::evaluate(Variant::OP_GREATER, test, maxval, ret, valid);
  616. if (!valid) {
  617. return Variant(); //not a valid comparison
  618. }
  619. if (bool(ret)) {
  620. //is less
  621. maxval = test;
  622. }
  623. }
  624. }
  625. return maxval;
  626. }
  627. const void *Array::id() const {
  628. return _p;
  629. }
  630. Array::Array(const Array &p_from, uint32_t p_type, const StringName &p_class_name, const Variant &p_script) {
  631. _p = memnew(ArrayPrivate);
  632. _p->refcount.init();
  633. set_typed(p_type, p_class_name, p_script);
  634. assign(p_from);
  635. }
  636. void Array::set_typed(uint32_t p_type, const StringName &p_class_name, const Variant &p_script) {
  637. ERR_FAIL_COND_MSG(_p->read_only, "Array is in read-only state.");
  638. ERR_FAIL_COND_MSG(_p->array.size() > 0, "Type can only be set when array is empty.");
  639. ERR_FAIL_COND_MSG(_p->refcount.get() > 1, "Type can only be set when array has no more than one user.");
  640. ERR_FAIL_COND_MSG(_p->typed.type != Variant::NIL, "Type can only be set once.");
  641. ERR_FAIL_COND_MSG(p_class_name != StringName() && p_type != Variant::OBJECT, "Class names can only be set for type OBJECT");
  642. Ref<Script> script = p_script;
  643. ERR_FAIL_COND_MSG(script.is_valid() && p_class_name == StringName(), "Script class can only be set together with base class name");
  644. _p->typed.type = Variant::Type(p_type);
  645. _p->typed.class_name = p_class_name;
  646. _p->typed.script = script;
  647. _p->typed.where = "TypedArray";
  648. }
  649. bool Array::is_typed() const {
  650. return _p->typed.type != Variant::NIL;
  651. }
  652. bool Array::is_same_typed(const Array &p_other) const {
  653. return _p->typed == p_other._p->typed;
  654. }
  655. uint32_t Array::get_typed_builtin() const {
  656. return _p->typed.type;
  657. }
  658. StringName Array::get_typed_class_name() const {
  659. return _p->typed.class_name;
  660. }
  661. Variant Array::get_typed_script() const {
  662. return _p->typed.script;
  663. }
  664. void Array::make_read_only() {
  665. if (_p->read_only == nullptr) {
  666. _p->read_only = memnew(Variant);
  667. }
  668. }
  669. bool Array::is_read_only() const {
  670. return _p->read_only != nullptr;
  671. }
  672. Array::Array(const Array &p_from) {
  673. _p = nullptr;
  674. _ref(p_from);
  675. }
  676. Array::Array() {
  677. _p = memnew(ArrayPrivate);
  678. _p->refcount.init();
  679. }
  680. Array::~Array() {
  681. _unref();
  682. }