2023-01-05 13:25:55 +01:00
|
|
|
/**************************************************************************/
|
|
|
|
/* array.h */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
|
|
|
/* https://godotengine.org */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* */
|
|
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
|
|
/* a copy of this software and associated documentation files (the */
|
|
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
|
|
/* the following conditions: */
|
|
|
|
/* */
|
|
|
|
/* The above copyright notice and this permission notice shall be */
|
|
|
|
/* included in all copies or substantial portions of the Software. */
|
|
|
|
/* */
|
|
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
|
|
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
|
|
/**************************************************************************/
|
2018-01-05 00:50:27 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
#ifndef ARRAY_H
|
|
|
|
#define ARRAY_H
|
|
|
|
|
2018-09-11 18:13:45 +02:00
|
|
|
#include "core/typedefs.h"
|
|
|
|
|
2022-01-10 13:56:55 +01:00
|
|
|
#include <climits>
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
class Variant;
|
|
|
|
class ArrayPrivate;
|
|
|
|
class Object;
|
|
|
|
class StringName;
|
2021-02-04 02:02:06 +01:00
|
|
|
class Callable;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
class Array {
|
|
|
|
mutable ArrayPrivate *_p;
|
|
|
|
void _ref(const Array &p_from) const;
|
|
|
|
void _unref() const;
|
|
|
|
|
2020-04-21 00:06:00 +02:00
|
|
|
protected:
|
2021-03-15 14:07:34 +01:00
|
|
|
bool _assign(const Array &p_array);
|
2020-04-21 00:06:00 +02:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
public:
|
|
|
|
Variant &operator[](int p_idx);
|
|
|
|
const Variant &operator[](int p_idx) const;
|
|
|
|
|
|
|
|
void set(int p_idx, const Variant &p_value);
|
|
|
|
const Variant &get(int p_idx) const;
|
|
|
|
|
|
|
|
int size() const;
|
2020-12-15 13:04:21 +01:00
|
|
|
bool is_empty() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
void clear();
|
|
|
|
|
|
|
|
bool operator==(const Array &p_array) const;
|
2020-11-05 03:01:55 +01:00
|
|
|
bool operator!=(const Array &p_array) const;
|
2020-02-01 07:04:14 +01:00
|
|
|
bool recursive_equal(const Array &p_array, int recursion_count) const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
uint32_t hash() const;
|
2020-02-01 07:04:14 +01:00
|
|
|
uint32_t recursive_hash(int recursion_count) const;
|
2014-02-10 02:10:30 +01:00
|
|
|
void operator=(const Array &p_array);
|
|
|
|
|
|
|
|
void push_back(const Variant &p_value);
|
|
|
|
_FORCE_INLINE_ void append(const Variant &p_value) { push_back(p_value); } //for python compatibility
|
2020-11-08 21:09:45 +01:00
|
|
|
void append_array(const Array &p_array);
|
2014-02-10 02:10:30 +01:00
|
|
|
Error resize(int p_new_size);
|
|
|
|
|
2021-03-27 05:49:39 +01:00
|
|
|
Error insert(int p_pos, const Variant &p_value);
|
2021-07-04 00:17:03 +02:00
|
|
|
void remove_at(int p_pos);
|
2021-02-25 15:10:39 +01:00
|
|
|
void fill(const Variant &p_value);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2016-11-18 21:30:16 +01:00
|
|
|
Variant front() const;
|
|
|
|
Variant back() const;
|
2022-10-15 14:43:16 +02:00
|
|
|
Variant pick_random() const;
|
2016-11-18 21:30:16 +01:00
|
|
|
|
2020-10-13 20:59:37 +02:00
|
|
|
void sort();
|
2022-03-28 03:57:20 +02:00
|
|
|
void sort_custom(const Callable &p_callable);
|
2018-01-10 19:36:53 +01:00
|
|
|
void shuffle();
|
2017-11-02 19:04:38 +01:00
|
|
|
int bsearch(const Variant &p_value, bool p_before = true);
|
2022-03-28 03:57:20 +02:00
|
|
|
int bsearch_custom(const Variant &p_value, const Callable &p_callable, bool p_before = true);
|
2021-03-14 08:21:32 +01:00
|
|
|
void reverse();
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2016-06-10 19:57:56 +02:00
|
|
|
int find(const Variant &p_value, int p_from = 0) const;
|
2016-06-10 22:28:09 +02:00
|
|
|
int rfind(const Variant &p_value, int p_from = -1) const;
|
2016-06-03 23:10:43 +02:00
|
|
|
int count(const Variant &p_value) const;
|
2016-07-02 19:03:35 +02:00
|
|
|
bool has(const Variant &p_value) const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
void erase(const Variant &p_value);
|
|
|
|
|
2015-12-12 12:27:30 +01:00
|
|
|
void push_front(const Variant &p_value);
|
2016-08-27 17:33:45 +02:00
|
|
|
Variant pop_back();
|
|
|
|
Variant pop_front();
|
2021-08-27 00:51:17 +02:00
|
|
|
Variant pop_at(int p_pos);
|
2015-12-12 12:27:30 +01:00
|
|
|
|
2018-03-09 20:16:08 +01:00
|
|
|
Array duplicate(bool p_deep = false) const;
|
2020-02-01 07:04:14 +01:00
|
|
|
Array recursive_duplicate(bool p_deep, int recursion_count) const;
|
2017-09-06 23:13:05 +02:00
|
|
|
|
2022-01-10 13:56:55 +01:00
|
|
|
Array slice(int p_begin, int p_end = INT_MAX, int p_step = 1, bool p_deep = false) const;
|
2020-10-19 21:21:16 +02:00
|
|
|
Array filter(const Callable &p_callable) const;
|
|
|
|
Array map(const Callable &p_callable) const;
|
|
|
|
Variant reduce(const Callable &p_callable, const Variant &p_accum) const;
|
2021-07-10 20:19:47 +02:00
|
|
|
bool any(const Callable &p_callable) const;
|
|
|
|
bool all(const Callable &p_callable) const;
|
2019-07-17 03:31:58 +02:00
|
|
|
|
2020-11-05 03:01:55 +01:00
|
|
|
bool operator<(const Array &p_array) const;
|
|
|
|
bool operator<=(const Array &p_array) const;
|
|
|
|
bool operator>(const Array &p_array) const;
|
|
|
|
bool operator>=(const Array &p_array) const;
|
|
|
|
|
2018-08-23 20:31:02 +02:00
|
|
|
Variant min() const;
|
|
|
|
Variant max() const;
|
|
|
|
|
2019-04-20 01:57:29 +02:00
|
|
|
const void *id() const;
|
|
|
|
|
2021-03-15 14:07:34 +01:00
|
|
|
bool typed_assign(const Array &p_other);
|
2020-04-21 00:06:00 +02:00
|
|
|
void set_typed(uint32_t p_type, const StringName &p_class_name, const Variant &p_script);
|
2021-03-09 16:30:06 +01:00
|
|
|
bool is_typed() const;
|
|
|
|
uint32_t get_typed_builtin() const;
|
|
|
|
StringName get_typed_class_name() const;
|
|
|
|
Variant get_typed_script() const;
|
2022-05-17 19:14:42 +02:00
|
|
|
|
2023-01-22 10:07:48 +01:00
|
|
|
void make_read_only();
|
2022-05-17 19:14:42 +02:00
|
|
|
bool is_read_only() const;
|
|
|
|
|
2022-08-25 11:35:30 +02:00
|
|
|
Array(const Array &p_base, uint32_t p_type, const StringName &p_class_name, const Variant &p_script);
|
2014-02-10 02:10:30 +01:00
|
|
|
Array(const Array &p_from);
|
2017-01-11 12:53:31 +01:00
|
|
|
Array();
|
2014-02-10 02:10:30 +01:00
|
|
|
~Array();
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif // ARRAY_H
|