Core: Migrate typed container logic

• Dedicated typed container files entirely removed • Typed container classes now defined in their base headers; methods declared in `variant.h` • Consolidate to a single template for both typed containers, thanks to `constexpr` • Nest private containers in their base classes
godotengine · Sep 15, 2024 · c63cf08 · c63cf08
1 parent 6681f25
commit c63cf08
Show file tree

Hide file tree

Showing 73 changed files with 311 additions and 703 deletions.
diff --git a/core/config/engine.cpp b/core/config/engine.cpp
@@ -34,7 +34,6 @@
 #include "core/config/project_settings.h"
 #include "core/donors.gen.h"
 #include "core/license.gen.h"
-#include "core/variant/typed_array.h"
 #include "core/version.h"
 
 void Engine::set_physics_ticks_per_second(int p_ips) {

diff --git a/core/config/engine.h b/core/config/engine.h
@@ -36,9 +36,6 @@
 #include "core/templates/list.h"
 #include "core/templates/vector.h"
 
-template <typename T>
-class TypedArray;
-
 class Engine {
 public:
 	struct Singleton {

diff --git a/core/config/project_settings.cpp b/core/config/project_settings.cpp
@@ -41,7 +41,6 @@
 #include "core/object/script_language.h"
 #include "core/os/keyboard.h"
 #include "core/templates/rb_set.h"
-#include "core/variant/typed_array.h"
 #include "core/variant/variant_parser.h"
 #include "core/version.h"
 

diff --git a/core/config/project_settings.h b/core/config/project_settings.h
@@ -33,9 +33,6 @@
 
 #include "core/object/class_db.h"
 
-template <typename T>
-class TypedArray;
-
 class ProjectSettings : public Object {
 	GDCLASS(ProjectSettings, Object);
 	_THREAD_SAFE_CLASS_

diff --git a/core/core_bind.cpp b/core/core_bind.cpp
@@ -42,7 +42,6 @@
 #include "core/math/geometry_3d.h"
 #include "core/os/keyboard.h"
 #include "core/os/thread_safe.h"
-#include "core/variant/typed_array.h"
 
 namespace core_bind {
 

diff --git a/core/core_bind.h b/core/core_bind.h
@@ -42,8 +42,6 @@
 #include "core/templates/safe_refcount.h"
 
 class MainLoop;
-template <typename T>
-class TypedArray;
 
 namespace core_bind {
 

diff --git a/core/input/input.h b/core/input/input.h
@@ -36,7 +36,6 @@
 #include "core/os/keyboard.h"
 #include "core/os/thread_safe.h"
 #include "core/templates/rb_set.h"
-#include "core/variant/typed_array.h"
 
 class Input : public Object {
 	GDCLASS(Input, Object);

diff --git a/core/input/input_map.cpp b/core/input/input_map.cpp
@@ -34,7 +34,6 @@
 #include "core/input/input.h"
 #include "core/os/keyboard.h"
 #include "core/os/os.h"
-#include "core/variant/typed_array.h"
 
 InputMap *InputMap::singleton = nullptr;
 

diff --git a/core/input/input_map.h b/core/input/input_map.h
@@ -36,9 +36,6 @@
 #include "core/object/object.h"
 #include "core/templates/hash_map.h"
 
-template <typename T>
-class TypedArray;
-
 class InputMap : public Object {
 	GDCLASS(InputMap, Object);
 

diff --git a/core/io/ip.cpp b/core/io/ip.cpp
@@ -33,7 +33,6 @@
 #include "core/os/semaphore.h"
 #include "core/os/thread.h"
 #include "core/templates/hash_map.h"
-#include "core/variant/typed_array.h"
 
 /************* RESOLVER ******************/
 

diff --git a/core/io/ip.h b/core/io/ip.h
@@ -34,9 +34,6 @@
 #include "core/io/ip_address.h"
 #include "core/os/os.h"
 
-template <typename T>
-class TypedArray;
-
 struct _IP_ResolverPrivate;
 
 class IP : public Object {

diff --git a/core/math/a_star_grid_2d.compat.inc b/core/math/a_star_grid_2d.compat.inc
@@ -30,8 +30,6 @@
 
 #ifndef DISABLE_DEPRECATED
 
-#include "core/variant/typed_array.h"
-
 TypedArray<Vector2i> AStarGrid2D::_get_id_path_bind_compat_88047(const Vector2i &p_from_id, const Vector2i &p_to_id) {
 	return get_id_path(p_from_id, p_to_id, false);
 }

diff --git a/core/math/a_star_grid_2d.cpp b/core/math/a_star_grid_2d.cpp
@@ -31,8 +31,6 @@
 #include "a_star_grid_2d.h"
 #include "a_star_grid_2d.compat.inc"
 
-#include "core/variant/typed_array.h"
-
 static real_t heuristic_euclidean(const Vector2i &p_from, const Vector2i &p_to) {
 	real_t dx = (real_t)ABS(p_to.x - p_from.x);
 	real_t dy = (real_t)ABS(p_to.y - p_from.y);

diff --git a/core/object/object.cpp b/core/object/object.cpp
@@ -39,7 +39,6 @@
 #include "core/string/print_string.h"
 #include "core/string/translation_server.h"
 #include "core/templates/local_vector.h"
-#include "core/variant/typed_array.h"
 
 #ifdef DEBUG_ENABLED
 

diff --git a/core/object/object.h b/core/object/object.h
@@ -44,9 +44,6 @@
 #include "core/variant/callable_bind.h"
 #include "core/variant/variant.h"
 
-template <typename T>
-class TypedArray;
-
 enum PropertyHint {
 	PROPERTY_HINT_NONE, ///< no hint provided.
 	PROPERTY_HINT_RANGE, ///< hint_text = "min,max[,step][,or_greater][,or_less][,hide_slider][,radians_as_degrees][,degrees][,exp][,suffix:<keyword>] range.

diff --git a/core/object/script_language.h b/core/object/script_language.h
@@ -37,11 +37,8 @@
 #include "core/templates/pair.h"
 #include "core/templates/rb_map.h"
 #include "core/templates/safe_refcount.h"
-#include "core/variant/typed_array.h"
 
 class ScriptLanguage;
-template <typename T>
-class TypedArray;
 
 typedef void (*ScriptEditRequestFunction)(const String &p_path);
 

diff --git a/core/object/script_language_extension.h b/core/object/script_language_extension.h
@@ -35,7 +35,6 @@
 #include "core/object/gdvirtual.gen.inc"
 #include "core/object/script_language.h"
 #include "core/variant/native_ptr.h"
-#include "core/variant/typed_array.h"
 
 class ScriptExtension : public Script {
 	GDCLASS(ScriptExtension, Script)

diff --git a/core/typedefs.h b/core/typedefs.h
@@ -54,6 +54,11 @@ static_assert(__cplusplus >= 201703L);
 #define _MKSTR(m_x) _STR(m_x)
 #endif
 
+// Allow comma separators within macros.
+#ifndef _COMMA
+#define _COMMA ,
+#endif
+
 // Should always inline no matter what.
 #ifndef _ALWAYS_INLINE_
 #if defined(__GNUC__)

diff --git a/core/variant/array.cpp b/core/variant/array.cpp
@@ -41,8 +41,7 @@
 #include "core/variant/dictionary.h"
 #include "core/variant/variant.h"
 
-class ArrayPrivate {
-public:
+struct Array::ArrayPrivate {
 	SafeRefCount refcount;
 	Vector<Variant> array;
 	Variant *read_only = nullptr; // If enabled, a pointer is used to a temporary value that is used to return read-only values.

diff --git a/core/variant/array.h b/core/variant/array.h
@@ -36,12 +36,12 @@
 #include <climits>
 
 class Variant;
-class ArrayPrivate;
 class Object;
 class StringName;
 class Callable;
 
 class Array {
+	struct ArrayPrivate;
 	mutable ArrayPrivate *_p;
 	void _unref() const;
 
@@ -201,4 +201,13 @@ class Array {
 	~Array();
 };
 
+template <typename T>
+class TypedArray : public Array {
+public:
+	_FORCE_INLINE_ void operator=(const Array &p_array);
+	_FORCE_INLINE_ TypedArray(const Variant &p_variant);
+	_FORCE_INLINE_ TypedArray(const Array &p_array);
+	_FORCE_INLINE_ TypedArray();
+};
+
 #endif // ARRAY_H
diff --git a/core/variant/dictionary.cpp b/core/variant/dictionary.cpp
@@ -40,7 +40,7 @@
 #include "core/variant/type_info.h"
 #include "core/variant/variant_internal.h"
 
-struct DictionaryPrivate {
+struct Dictionary::DictionaryPrivate {
 	SafeRefCount refcount;
 	Variant *read_only = nullptr; // If enabled, a pointer is used to a temporary value that is used to return read-only values.
 	HashMap<Variant, Variant, VariantHasher, StringLikeVariantComparator> variant_map;

diff --git a/core/variant/dictionary.h b/core/variant/dictionary.h
@@ -31,15 +31,11 @@
 #ifndef DICTIONARY_H
 #define DICTIONARY_H
 
-#include "core/string/ustring.h"
 #include "core/templates/list.h"
 #include "core/variant/array.h"
 
-class Variant;
-
-struct DictionaryPrivate;
-
 class Dictionary {
+	struct DictionaryPrivate;
 	mutable DictionaryPrivate *_p;
 
 	void _ref(const Dictionary &p_from) const;
@@ -114,4 +110,13 @@ class Dictionary {
 	~Dictionary();
 };
 
+template <typename K, typename V>
+class TypedDictionary : public Dictionary {
+public:
+	_FORCE_INLINE_ void operator=(const Dictionary &p_dictionary);
+	_FORCE_INLINE_ TypedDictionary(const Variant &p_variant);
+	_FORCE_INLINE_ TypedDictionary(const Dictionary &p_dictionary);
+	_FORCE_INLINE_ TypedDictionary();
+};
+
 #endif // DICTIONARY_H
diff --git a/core/variant/method_ptrcall.h b/core/variant/method_ptrcall.h
@@ -192,6 +192,52 @@ struct PtrToArg<ObjectID> {
 	}
 };
 
+// This is for typed containers.
+
+template <typename T>
+struct PtrToArg<TypedArray<T>> {
+	_FORCE_INLINE_ static TypedArray<T> convert(const void *p_ptr) {
+		return TypedArray<T>(*reinterpret_cast<const Array *>(p_ptr));
+	}
+	typedef Array EncodeT;
+	_FORCE_INLINE_ static void encode(TypedArray<T> p_val, void *p_ptr) {
+		*(Array *)p_ptr = p_val;
+	}
+};
+
+template <typename T>
+struct PtrToArg<const TypedArray<T> &> {
+	_FORCE_INLINE_ static TypedArray<T> convert(const void *p_ptr) {
+		return TypedArray<T>(*reinterpret_cast<const Array *>(p_ptr));
+	}
+	typedef Array EncodeT;
+	_FORCE_INLINE_ static void encode(TypedArray<T> p_val, void *p_ptr) {
+		*(Array *)p_ptr = p_val;
+	}
+};
+
+template <typename K, typename V>
+struct PtrToArg<TypedDictionary<K, V>> {
+	_FORCE_INLINE_ static TypedDictionary<K, V> convert(const void *p_ptr) {
+		return TypedDictionary<K, V>(*reinterpret_cast<const Dictionary *>(p_ptr));
+	}
+	typedef Dictionary EncodeT;
+	_FORCE_INLINE_ static void encode(TypedDictionary<K, V> p_val, void *p_ptr) {
+		*(Dictionary *)p_ptr = p_val;
+	}
+};
+
+template <typename K, typename V>
+struct PtrToArg<const TypedDictionary<K, V> &> {
+	_FORCE_INLINE_ static TypedDictionary<K, V> convert(const void *p_ptr) {
+		return TypedDictionary<K, V>(*reinterpret_cast<const Dictionary *>(p_ptr));
+	}
+	typedef Dictionary EncodeT;
+	_FORCE_INLINE_ static void encode(TypedDictionary<K, V> p_val, void *p_ptr) {
+		*(Dictionary *)p_ptr = p_val;
+	}
+};
+
 // This is for the special cases used by Variant.
 
 // No EncodeT because direct pointer conversion not possible.

diff --git a/core/variant/type_info.h b/core/variant/type_info.h
@@ -31,7 +31,7 @@
 #ifndef TYPE_INFO_H
 #define TYPE_INFO_H
 
-#include "core/typedefs.h"
+#include "core/object/object.h"
 
 #include <type_traits>
 
@@ -148,6 +148,79 @@ MAKE_TYPE_INFO(PackedVector4Array, Variant::PACKED_VECTOR4_ARRAY)
 
 MAKE_TYPE_INFO(IPAddress, Variant::STRING)
 
+// Typed containers.
+template <typename T>
+struct GetTypeInfo<TypedArray<T>> {
+	static const Variant::Type VARIANT_TYPE = Variant::ARRAY;
+	static const GodotTypeInfo::Metadata METADATA = GodotTypeInfo::METADATA_NONE;
+	static inline PropertyInfo get_class_info() {
+		String hint_string;
+		if constexpr (GTI::variant_type_v<T> == Variant::OBJECT) {
+			hint_string = T::get_class_static();
+		} else {
+			hint_string = Variant::get_type_name(GTI::variant_type_v<T>);
+		}
+		return PropertyInfo(VARIANT_TYPE, String(), PROPERTY_HINT_ARRAY_TYPE, hint_string);
+	}
+};
+
+template <typename T>
+struct GetTypeInfo<const TypedArray<T> &> {
+	static const Variant::Type VARIANT_TYPE = Variant::ARRAY;
+	static const GodotTypeInfo::Metadata METADATA = GodotTypeInfo::METADATA_NONE;
+	static inline PropertyInfo get_class_info() {
+		String hint_string;
+		if constexpr (GTI::variant_type_v<T> == Variant::OBJECT) {
+			hint_string = T::get_class_static();
+		} else {
+			hint_string = Variant::get_type_name(GTI::variant_type_v<T>);
+		}
+		return PropertyInfo(VARIANT_TYPE, String(), PROPERTY_HINT_ARRAY_TYPE, hint_string);
+	}
+};
+
+template <typename K, typename V>
+struct GetTypeInfo<TypedDictionary<K, V>> {
+	static const Variant::Type VARIANT_TYPE = Variant::DICTIONARY;
+	static const GodotTypeInfo::Metadata METADATA = GodotTypeInfo::METADATA_NONE;
+	static inline PropertyInfo get_class_info() {
+		String hint_key;
+		if constexpr (GTI::variant_type_v<K> == Variant::OBJECT) {
+			hint_key = K::get_class_static();
+		} else {
+			hint_key = GTI::variant_type_v<K> == Variant::NIL ? "Variant" : Variant::get_type_name(GTI::variant_type_v<K>);
+		}
+		String hint_value;
+		if constexpr (GTI::variant_type_v<V> == Variant::OBJECT) {
+			hint_value = V::get_class_static();
+		} else {
+			hint_value = GTI::variant_type_v<V> == Variant::NIL ? "Variant" : Variant::get_type_name(GTI::variant_type_v<V>);
+		}
+		return PropertyInfo(VARIANT_TYPE, String(), PROPERTY_HINT_DICTIONARY_TYPE, vformat("%s;%s", hint_key, hint_value));
+	}
+};
+
+template <typename K, typename V>
+struct GetTypeInfo<const TypedDictionary<K, V> &> {
+	static const Variant::Type VARIANT_TYPE = Variant::DICTIONARY;
+	static const GodotTypeInfo::Metadata METADATA = GodotTypeInfo::METADATA_NONE;
+	static inline PropertyInfo get_class_info() {
+		String hint_key;
+		if constexpr (GTI::variant_type_v<K> == Variant::OBJECT) {
+			hint_key = K::get_class_static();
+		} else {
+			hint_key = GTI::variant_type_v<K> == Variant::NIL ? "Variant" : Variant::get_type_name(GTI::variant_type_v<K>);
+		}
+		String hint_value;
+		if constexpr (GTI::variant_type_v<V> == Variant::OBJECT) {
+			hint_value = V::get_class_static();
+		} else {
+			hint_value = GTI::variant_type_v<V> == Variant::NIL ? "Variant" : Variant::get_type_name(GTI::variant_type_v<V>);
+		}
+		return PropertyInfo(VARIANT_TYPE, String(), PROPERTY_HINT_DICTIONARY_TYPE, vformat("%s;%s", hint_key, hint_value));
+	}
+};
+
 //objectID
 template <>
 struct GetTypeInfo<ObjectID> {