array.cpp 22 KB

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