summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2023-01-30 12:07:15 +0100
committerRémi Verschelde <rverschelde@gmail.com>2023-01-30 12:07:15 +0100
commit2ef10f9754208f5a7fd388e6928d8fc00b9f97fd (patch)
tree628f04aa58de52690b826a4e4ce0968e14b66a15
parent0f3a0913f100dcd988b538582431d064f46c4e17 (diff)
parent6528c7177fa96bfcc81805e97a0a03290816cb51 (diff)
downloadredot-cpp-2ef10f9754208f5a7fd388e6928d8fc00b9f97fd.tar.gz
Merge pull request #956 from DmitriySalnikov/enum_bitfield_cast
Fixed `VARIANT_ENUM/BITFIELD_CAST` to show the correct names
-rw-r--r--binding_generator.py8
-rw-r--r--include/godot_cpp/core/binder_common.hpp76
-rw-r--r--include/godot_cpp/core/type_info.hpp52
-rw-r--r--test/demo/main.gd6
-rw-r--r--test/src/example.cpp11
-rw-r--r--test/src/example.h15
6 files changed, 104 insertions, 64 deletions
diff --git a/binding_generator.py b/binding_generator.py
index 6ce4379..569ea00 100644
--- a/binding_generator.py
+++ b/binding_generator.py
@@ -336,7 +336,7 @@ def generate_builtin_bindings(api, output_dir, build_config):
if is_included_type(builtin_api["name"]):
if "enums" in builtin_api:
for enum_api in builtin_api["enums"]:
- builtin_binds.append(f"VARIANT_ENUM_CAST({builtin_api['name']}, {enum_api['name']});")
+ builtin_binds.append(f"VARIANT_ENUM_CAST({builtin_api['name']}::{enum_api['name']});")
builtin_binds.append("")
builtin_binds.append("#endif // ! GODOT_CPP_BUILTIN_BINDS_HPP")
@@ -1381,9 +1381,9 @@ def generate_engine_class_header(class_api, used_classes, fully_used_classes, us
if "enums" in class_api and class_name != "Object":
for enum_api in class_api["enums"]:
if enum_api["is_bitfield"]:
- result.append(f'VARIANT_BITFIELD_CAST({class_name}, {class_name}::{enum_api["name"]});')
+ result.append(f'VARIANT_BITFIELD_CAST({class_name}::{enum_api["name"]});')
else:
- result.append(f'VARIANT_ENUM_CAST({class_name}, {class_name}::{enum_api["name"]});')
+ result.append(f'VARIANT_ENUM_CAST({class_name}::{enum_api["name"]});')
result.append("")
result.append(f"#endif // ! {header_guard}")
@@ -1621,7 +1621,7 @@ def generate_global_constant_binds(api, output_dir):
if enum_def["name"].startswith("Variant."):
continue
- header.append(f'VARIANT_ENUM_CAST(, godot::{enum_def["name"]});')
+ header.append(f'VARIANT_ENUM_CAST(godot::{enum_def["name"]});')
header.append("")
diff --git a/include/godot_cpp/core/binder_common.hpp b/include/godot_cpp/core/binder_common.hpp
index c96498f..ed7c487 100644
--- a/include/godot_cpp/core/binder_common.hpp
+++ b/include/godot_cpp/core/binder_common.hpp
@@ -41,46 +41,46 @@
namespace godot {
-#define VARIANT_ENUM_CAST(m_class, m_enum) \
- namespace godot { \
- MAKE_ENUM_TYPE_INFO(m_class, m_enum) \
- template <> \
- struct VariantCaster<m_class::m_enum> { \
- static _FORCE_INLINE_ m_class::m_enum cast(const Variant &p_variant) { \
- return (m_class::m_enum)p_variant.operator int64_t(); \
- } \
- }; \
- template <> \
- struct PtrToArg<m_class::m_enum> { \
- _FORCE_INLINE_ static m_class::m_enum convert(const void *p_ptr) { \
- return m_class::m_enum(*reinterpret_cast<const int64_t *>(p_ptr)); \
- } \
- typedef int64_t EncodeT; \
- _FORCE_INLINE_ static void encode(m_class::m_enum p_val, void *p_ptr) { \
- *reinterpret_cast<int64_t *>(p_ptr) = p_val; \
- } \
- }; \
+#define VARIANT_ENUM_CAST(m_enum) \
+ namespace godot { \
+ MAKE_ENUM_TYPE_INFO(m_enum) \
+ template <> \
+ struct VariantCaster<m_enum> { \
+ static _FORCE_INLINE_ m_enum cast(const Variant &p_variant) { \
+ return (m_enum)p_variant.operator int64_t(); \
+ } \
+ }; \
+ template <> \
+ struct PtrToArg<m_enum> { \
+ _FORCE_INLINE_ static m_enum convert(const void *p_ptr) { \
+ return m_enum(*reinterpret_cast<const int64_t *>(p_ptr)); \
+ } \
+ typedef int64_t EncodeT; \
+ _FORCE_INLINE_ static void encode(m_enum p_val, void *p_ptr) { \
+ *reinterpret_cast<int64_t *>(p_ptr) = p_val; \
+ } \
+ }; \
}
-#define VARIANT_BITFIELD_CAST(m_class, m_enum) \
- namespace godot { \
- MAKE_BITFIELD_TYPE_INFO(m_class, m_enum) \
- template <> \
- struct VariantCaster<BitField<m_class::m_enum>> { \
- static _FORCE_INLINE_ BitField<m_class::m_enum> cast(const Variant &p_variant) { \
- return BitField<m_class::m_enum>(p_variant.operator int64_t()); \
- } \
- }; \
- template <> \
- struct PtrToArg<BitField<m_class::m_enum>> { \
- _FORCE_INLINE_ static BitField<m_class::m_enum> convert(const void *p_ptr) { \
- return BitField<m_class::m_enum>(*reinterpret_cast<const int64_t *>(p_ptr)); \
- } \
- typedef int64_t EncodeT; \
- _FORCE_INLINE_ static void encode(BitField<m_class::m_enum> p_val, void *p_ptr) { \
- *reinterpret_cast<int64_t *>(p_ptr) = p_val; \
- } \
- }; \
+#define VARIANT_BITFIELD_CAST(m_enum) \
+ namespace godot { \
+ MAKE_BITFIELD_TYPE_INFO(m_enum) \
+ template <> \
+ struct VariantCaster<BitField<m_enum>> { \
+ static _FORCE_INLINE_ BitField<m_enum> cast(const Variant &p_variant) { \
+ return BitField<m_enum>(p_variant.operator int64_t()); \
+ } \
+ }; \
+ template <> \
+ struct PtrToArg<BitField<m_enum>> { \
+ _FORCE_INLINE_ static BitField<m_enum> convert(const void *p_ptr) { \
+ return BitField<m_enum>(*reinterpret_cast<const int64_t *>(p_ptr)); \
+ } \
+ typedef int64_t EncodeT; \
+ _FORCE_INLINE_ static void encode(BitField<m_enum> p_val, void *p_ptr) { \
+ *reinterpret_cast<int64_t *>(p_ptr) = p_val; \
+ } \
+ }; \
}
template <class T>
diff --git a/include/godot_cpp/core/type_info.hpp b/include/godot_cpp/core/type_info.hpp
index 509bfb7..039cb2e 100644
--- a/include/godot_cpp/core/type_info.hpp
+++ b/include/godot_cpp/core/type_info.hpp
@@ -214,21 +214,31 @@ struct GetTypeInfo<const T *, typename EnableIf<TypeInherits<Object, T>::value>:
}
};
-#define TEMPL_MAKE_ENUM_TYPE_INFO(m_class, m_enum, m_impl) \
- template <> \
- struct GetTypeInfo<m_impl> { \
- static const Variant::Type VARIANT_TYPE = Variant::INT; \
- static const GDExtensionClassMethodArgumentMetadata METADATA = GDEXTENSION_METHOD_ARGUMENT_METADATA_NONE; \
- static inline PropertyInfo get_class_info() { \
- return make_property_info(Variant::Type::INT, "", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_CLASS_IS_ENUM, #m_class "." #m_enum); \
- } \
+inline String enum_qualified_name_to_class_info_name(const String &p_qualified_name) {
+ PackedStringArray parts = p_qualified_name.split("::", false);
+ if (parts.size() <= 2) {
+ return String(".").join(parts);
+ }
+ // Contains namespace. We only want the class and enum names.
+ return parts[parts.size() - 2] + "." + parts[parts.size() - 1];
+}
+
+#define TEMPL_MAKE_ENUM_TYPE_INFO(m_enum, m_impl) \
+ template <> \
+ struct GetTypeInfo<m_impl> { \
+ static const Variant::Type VARIANT_TYPE = Variant::INT; \
+ static const GDExtensionClassMethodArgumentMetadata METADATA = GDEXTENSION_METHOD_ARGUMENT_METADATA_NONE; \
+ static inline PropertyInfo get_class_info() { \
+ return make_property_info(Variant::Type::INT, "", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_CLASS_IS_ENUM, \
+ enum_qualified_name_to_class_info_name(#m_enum)); \
+ } \
};
-#define MAKE_ENUM_TYPE_INFO(m_class, m_enum) \
- TEMPL_MAKE_ENUM_TYPE_INFO(m_class, m_enum, m_class::m_enum) \
- TEMPL_MAKE_ENUM_TYPE_INFO(m_class, m_enum, m_class::m_enum const) \
- TEMPL_MAKE_ENUM_TYPE_INFO(m_class, m_enum, m_class::m_enum &) \
- TEMPL_MAKE_ENUM_TYPE_INFO(m_class, m_enum, const m_class::m_enum &)
+#define MAKE_ENUM_TYPE_INFO(m_enum) \
+ TEMPL_MAKE_ENUM_TYPE_INFO(m_enum, m_enum) \
+ TEMPL_MAKE_ENUM_TYPE_INFO(m_enum, m_enum const) \
+ TEMPL_MAKE_ENUM_TYPE_INFO(m_enum, m_enum &) \
+ TEMPL_MAKE_ENUM_TYPE_INFO(m_enum, const m_enum &)
template <typename T>
inline StringName __constant_get_enum_name(T param, StringName p_constant) {
@@ -251,14 +261,14 @@ public:
_FORCE_INLINE_ operator Variant() const { return value; }
};
-#define TEMPL_MAKE_BITFIELD_TYPE_INFO(m_class, m_enum, m_impl) \
+#define TEMPL_MAKE_BITFIELD_TYPE_INFO(m_enum, m_impl) \
template <> \
struct GetTypeInfo<m_impl> { \
static const Variant::Type VARIANT_TYPE = Variant::INT; \
static const GDExtensionClassMethodArgumentMetadata METADATA = GDEXTENSION_METHOD_ARGUMENT_METADATA_NONE; \
static inline PropertyInfo get_class_info() { \
return make_property_info(Variant::Type::INT, "", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_CLASS_IS_BITFIELD, \
- #m_class "." #m_enum); \
+ enum_qualified_name_to_class_info_name(#m_enum)); \
} \
}; \
template <> \
@@ -267,15 +277,15 @@ public:
static const GDExtensionClassMethodArgumentMetadata METADATA = GDEXTENSION_METHOD_ARGUMENT_METADATA_NONE; \
static inline PropertyInfo get_class_info() { \
return make_property_info(Variant::Type::INT, "", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_CLASS_IS_BITFIELD, \
- #m_class "." #m_enum); \
+ enum_qualified_name_to_class_info_name(#m_enum)); \
} \
};
-#define MAKE_BITFIELD_TYPE_INFO(m_class, m_enum) \
- TEMPL_MAKE_BITFIELD_TYPE_INFO(m_class, m_enum, m_enum) \
- TEMPL_MAKE_BITFIELD_TYPE_INFO(m_class, m_enum, m_enum const) \
- TEMPL_MAKE_BITFIELD_TYPE_INFO(m_class, m_enum, m_enum &) \
- TEMPL_MAKE_BITFIELD_TYPE_INFO(m_class, m_enum, const m_enum &)
+#define MAKE_BITFIELD_TYPE_INFO(m_enum) \
+ TEMPL_MAKE_BITFIELD_TYPE_INFO(m_enum, m_enum) \
+ TEMPL_MAKE_BITFIELD_TYPE_INFO(m_enum, m_enum const) \
+ TEMPL_MAKE_BITFIELD_TYPE_INFO(m_enum, m_enum &) \
+ TEMPL_MAKE_BITFIELD_TYPE_INFO(m_enum, const m_enum &)
template <typename T>
inline StringName __constant_get_bitfield_name(T param, StringName p_constant) {
diff --git a/test/demo/main.gd b/test/demo/main.gd
index 7ef3ace..9b74d14 100644
--- a/test/demo/main.gd
+++ b/test/demo/main.gd
@@ -73,5 +73,11 @@ func _ready():
prints(" ANSWER_TO_EVERYTHING", $Example.ANSWER_TO_EVERYTHING)
prints(" CONSTANT_WITHOUT_ENUM", $Example.CONSTANT_WITHOUT_ENUM)
+ prints("BitFields")
+ prints(" FLAG_ONE", Example.FLAG_ONE)
+ prints(" FLAG_TWO", Example.FLAG_TWO)
+ prints(" returned BitField", $Example.test_bitfield(0))
+ prints(" returned BitField", $Example.test_bitfield(Example.FLAG_ONE | Example.FLAG_TWO))
+
func _on_Example_custom_signal(signal_name, value):
prints("Example emitted:", signal_name, value)
diff --git a/test/src/example.cpp b/test/src/example.cpp
index dec8f57..f0fce6c 100644
--- a/test/src/example.cpp
+++ b/test/src/example.cpp
@@ -126,6 +126,8 @@ void Example::_bind_methods() {
ClassDB::bind_method(D_METHOD("test_string_ops"), &Example::test_string_ops);
ClassDB::bind_method(D_METHOD("test_vector_ops"), &Example::test_vector_ops);
+ ClassDB::bind_method(D_METHOD("test_bitfield", "flags"), &Example::test_bitfield);
+
ClassDB::bind_method(D_METHOD("def_args", "a", "b"), &Example::def_args, DEFVAL(100), DEFVAL(200));
ClassDB::bind_static_method("Example", D_METHOD("test_static", "a", "b"), &Example::test_static);
@@ -169,7 +171,11 @@ void Example::_bind_methods() {
BIND_ENUM_CONSTANT(FIRST);
BIND_ENUM_CONSTANT(ANSWER_TO_EVERYTHING);
+ BIND_BITFIELD_FLAG(FLAG_ONE);
+ BIND_BITFIELD_FLAG(FLAG_TWO);
+
BIND_CONSTANT(CONSTANT_WITHOUT_ENUM);
+ BIND_ENUM_CONSTANT(OUTSIDE_OF_CLASS);
}
Example::Example() {
@@ -304,6 +310,11 @@ Dictionary Example::test_dictionary() const {
return dict;
}
+BitField<Example::Flags> Example::test_bitfield(BitField<Flags> flags) {
+ UtilityFunctions::print(" Got BitField: ", String::num(flags));
+ return flags;
+}
+
// Properties.
void Example::set_custom_position(const Vector2 &pos) {
custom_position = pos;
diff --git a/test/src/example.h b/test/src/example.h
index 2d4a6b0..afde0f7 100644
--- a/test/src/example.h
+++ b/test/src/example.h
@@ -75,6 +75,11 @@ public:
ANSWER_TO_EVERYTHING = 42,
};
+ enum Flags {
+ FLAG_ONE = 1,
+ FLAG_TWO = 2,
+ };
+
enum {
CONSTANT_WITHOUT_ENUM = 314,
};
@@ -104,6 +109,8 @@ public:
String test_string_ops() const;
int test_vector_ops() const;
+ BitField<Flags> test_bitfield(BitField<Flags> flags);
+
// Property.
void set_custom_position(const Vector2 &pos);
Vector2 get_custom_position() const;
@@ -117,7 +124,13 @@ public:
virtual bool _has_point(const Vector2 &point) const override;
};
-VARIANT_ENUM_CAST(Example, Constants);
+VARIANT_ENUM_CAST(Example::Constants);
+VARIANT_BITFIELD_CAST(Example::Flags);
+
+enum EnumWithoutClass {
+ OUTSIDE_OF_CLASS = 512
+};
+VARIANT_ENUM_CAST(EnumWithoutClass);
class ExampleVirtual : public Object {
GDCLASS(ExampleVirtual, Object);