1426cd3b3a
As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see". Backported from #70885.
112 lines
4.2 KiB
C++
112 lines
4.2 KiB
C++
/**************************************************************************/
|
|
/* 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. */
|
|
/**************************************************************************/
|
|
|
|
#ifndef ARRAY_H
|
|
#define ARRAY_H
|
|
|
|
#include "core/typedefs.h"
|
|
|
|
class Variant;
|
|
class ArrayPrivate;
|
|
class Object;
|
|
class StringName;
|
|
|
|
class Array {
|
|
mutable ArrayPrivate *_p;
|
|
void _ref(const Array &p_from) const;
|
|
void _unref() const;
|
|
|
|
inline int _clamp_slice_index(int p_index) const;
|
|
|
|
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;
|
|
bool empty() const;
|
|
void clear();
|
|
|
|
bool deep_equal(const Array &p_array, int p_recursion_count = 0) const;
|
|
bool operator==(const Array &p_array) const;
|
|
|
|
uint32_t hash() const;
|
|
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
|
|
void append_array(const Array &p_array);
|
|
Error resize(int p_new_size);
|
|
|
|
void insert(int p_pos, const Variant &p_value);
|
|
void remove(int p_pos);
|
|
void fill(const Variant &p_value);
|
|
|
|
Variant front() const;
|
|
Variant pick_random() const;
|
|
Variant back() const;
|
|
|
|
Array &sort();
|
|
Array &sort_custom(Object *p_obj, const StringName &p_function);
|
|
void shuffle();
|
|
int bsearch(const Variant &p_value, bool p_before = true);
|
|
int bsearch_custom(const Variant &p_value, Object *p_obj, const StringName &p_function, bool p_before = true);
|
|
Array &invert();
|
|
|
|
int find(const Variant &p_value, int p_from = 0) const;
|
|
int rfind(const Variant &p_value, int p_from = -1) const;
|
|
int find_last(const Variant &p_value) const;
|
|
int count(const Variant &p_value) const;
|
|
bool has(const Variant &p_value) const;
|
|
|
|
void erase(const Variant &p_value);
|
|
|
|
void push_front(const Variant &p_value);
|
|
Variant pop_back();
|
|
Variant pop_front();
|
|
Variant pop_at(int p_pos);
|
|
|
|
Array duplicate(bool p_deep = false) const;
|
|
|
|
Array slice(int p_begin, int p_end, int p_step = 1, bool p_deep = false) const;
|
|
|
|
Variant min() const;
|
|
Variant max() const;
|
|
|
|
const void *id() const;
|
|
|
|
Array(const Array &p_from);
|
|
Array();
|
|
~Array();
|
|
};
|
|
|
|
#endif // ARRAY_H
|