array.cpp 22 KB

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