Skip to content

Add support for range based loops for Array #1717

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions binding_generator.py
Original file line number Diff line number Diff line change
Expand Up @@ -642,6 +642,11 @@ def generate_builtin_class_header(builtin_api, size, used_classes, fully_used_cl
result.append("")
result.append(f"\t{class_name}(const Variant *p_variant);")

if class_name == "Array":
result.append("")
result.append("\tconst Variant *ptr() const;")
result.append("\tVariant *ptrw();")

result.append("")
result.append("public:")

Expand Down Expand Up @@ -907,6 +912,47 @@ def generate_builtin_class_header(builtin_api, size, used_classes, fully_used_cl
result.append("\tVariant &operator[](int64_t p_index);")
result.append("\tvoid set_typed(uint32_t p_type, const StringName &p_class_name, const Variant &p_script);")
result.append("\tvoid _ref(const Array &p_from) const;")
result.append("""
struct Iterator {
_FORCE_INLINE_ Variant &operator*() const;
_FORCE_INLINE_ Variant *operator->() const;
_FORCE_INLINE_ Iterator &operator++();
_FORCE_INLINE_ Iterator &operator--();

_FORCE_INLINE_ bool operator==(const Iterator &b) const { return elem_ptr == b.elem_ptr; }
_FORCE_INLINE_ bool operator!=(const Iterator &b) const { return elem_ptr != b.elem_ptr; }

Iterator(Variant *p_ptr) { elem_ptr = p_ptr; }
Iterator() {}
Iterator(const Iterator &p_it) { elem_ptr = p_it.elem_ptr; }

private:
Variant *elem_ptr = nullptr;
};

struct ConstIterator {
_FORCE_INLINE_ const Variant &operator*() const;
_FORCE_INLINE_ const Variant *operator->() const;
_FORCE_INLINE_ ConstIterator &operator++();
_FORCE_INLINE_ ConstIterator &operator--();

_FORCE_INLINE_ bool operator==(const ConstIterator &b) const { return elem_ptr == b.elem_ptr; }
_FORCE_INLINE_ bool operator!=(const ConstIterator &b) const { return elem_ptr != b.elem_ptr; }

ConstIterator(const Variant *p_ptr) { elem_ptr = p_ptr; }
ConstIterator() {}
ConstIterator(const ConstIterator &p_it) { elem_ptr = p_it.elem_ptr; }

private:
const Variant *elem_ptr = nullptr;
};

_FORCE_INLINE_ Iterator begin();
_FORCE_INLINE_ Iterator end();

_FORCE_INLINE_ ConstIterator begin() const;
_FORCE_INLINE_ ConstIterator end() const;
""")

if class_name == "Dictionary":
result.append("\tconst Variant &operator[](const Variant &p_key) const;")
Expand Down
51 changes: 51 additions & 0 deletions include/godot_cpp/variant/variant.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@

#include <godot_cpp/core/defs.hpp>

#include <godot_cpp/variant/array.hpp>
#include <godot_cpp/variant/builtin_types.hpp>
#include <godot_cpp/variant/variant_size.hpp>

Expand Down Expand Up @@ -357,6 +358,56 @@ String vformat(const String &p_text, const VarArgs... p_args) {
return p_text % args_array;
}

Variant &Array::Iterator::operator*() const {
return *elem_ptr;
}

Variant *Array::Iterator::operator->() const {
return elem_ptr;
}

Array::Iterator &Array::Iterator::operator++() {
elem_ptr++;
return *this;
}

Array::Iterator &Array::Iterator::operator--() {
elem_ptr--;
return *this;
}

const Variant &Array::ConstIterator::operator*() const {
return *elem_ptr;
}

const Variant *Array::ConstIterator::operator->() const {
return elem_ptr;
}

Array::ConstIterator &Array::ConstIterator::operator++() {
elem_ptr++;
return *this;
}

Array::ConstIterator &Array::ConstIterator::operator--() {
elem_ptr--;
return *this;
}

Array::Iterator Array::begin() {
return Array::Iterator(ptrw());
}
Array::Iterator Array::end() {
return Array::Iterator(ptrw() + size());
}

Array::ConstIterator Array::begin() const {
return Array::ConstIterator(ptr());
}
Array::ConstIterator Array::end() const {
return Array::ConstIterator(ptr() + size());
}

#include <godot_cpp/variant/builtin_vararg_methods.hpp>

#ifdef REAL_T_IS_DOUBLE
Expand Down
8 changes: 8 additions & 0 deletions src/variant/packed_arrays.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,14 @@ void Array::_ref(const Array &p_from) const {
internal::gdextension_interface_array_ref((GDExtensionTypePtr *)this, (GDExtensionConstTypePtr *)&p_from);
}

const Variant *Array::ptr() const {
return (const Variant *)internal::gdextension_interface_array_operator_index_const((GDExtensionTypePtr *)this, 0);
}

Variant *Array::ptrw() {
return (Variant *)internal::gdextension_interface_array_operator_index((GDExtensionTypePtr *)this, 0);
}

const Variant &Dictionary::operator[](const Variant &p_key) const {
const Variant *var = (const Variant *)internal::gdextension_interface_dictionary_operator_index_const((GDExtensionTypePtr *)this, (GDExtensionVariantPtr)&p_key);
return *var;
Expand Down