Implementing dictionary operators

Author: BastiaanOlij

binding_generator.py

@@ -448,6 +448,10 @@ def generate_builtin_class_header(builtin_api, size, used_classes, fully_used_cl
         result.append(f"\tconst Variant &operator[](int p_index) const;")
         result.append(f"\tVariant &operator[](int p_index);")
 
+    if class_name == "Dictionary":
+        result.append(f"\tconst Variant &operator[](const Variant &p_key) const;")
+        result.append(f"\tVariant &operator[](const Variant &p_key);")
+
     result.append("};")
 
     if class_name == "String":

src/variant/packed_arrays.cpp

@@ -33,6 +33,7 @@
 #include <godot_cpp/godot.hpp>
 
 #include <godot_cpp/variant/array.hpp>
+#include <godot_cpp/variant/dictionary.hpp>
 #include <godot_cpp/variant/packed_byte_array.hpp>
 #include <godot_cpp/variant/packed_color_array.hpp>
 #include <godot_cpp/variant/packed_float32_array.hpp>
@@ -135,4 +136,14 @@ Variant &Array::operator[](int p_index) {
 	return *var;
 }
 
+const Variant &Dictionary::operator[](const Variant &p_key) const {
+	const Variant *var = (const Variant *)internal::gdn_interface->dictionary_operator_index_const((GDNativeTypePtr *)this, (GDNativeVariantPtr)&p_key);
+	return *var;
+}
+
+Variant &Dictionary::operator[](const Variant &p_key) {
+	Variant *var = (Variant *)internal::gdn_interface->dictionary_operator_index((GDNativeTypePtr *)this, (GDNativeVariantPtr)&p_key);
+	return *var;
+}
+
 } // namespace godot

test/demo/main.gd

@@ -13,7 +13,9 @@ func _ready():
 	var ref = ExampleRef.new()
 	prints("sending ref: ", ref.get_instance_id(), "returned ref: ", $Example.extended_ref_checks(ref).get_instance_id())
 	prints("vararg args", $Example.varargs_func("some", "arguments", "to", "test"))
+
 	prints("test array", $Example.test_array())
+	prints("test dictionary", $Example.test_dictionary())
 
 	# Use properties.
 	prints("custom position is", $Example.group_subgroup_custom_position)

test/demo/main.tscn

@@ -6,15 +6,12 @@
 script = ExtResource( "1_c326s" )
 
 [node name="Example" type="Example" parent="."]
-script = null
 
 [node name="Label" type="Label" parent="Example"]
 offset_left = 194.0
 offset_top = -2.0
 offset_right = 234.0
 offset_bottom = 21.0
-structured_text_bidi_override_options = []
-script = null
 __meta__ = {
 "_edit_use_anchors_": false
 }
@@ -23,9 +20,6 @@ __meta__ = {
 offset_right = 79.0
 offset_bottom = 29.0
 text = "Click me!"
-script = null
 __meta__ = {
 "_edit_use_anchors_": false
 }
-
-[connection signal="custom_signal" from="Example" to="." method="_on_Example_custom_signal"]

test/src/example.cpp

@@ -54,7 +54,9 @@ void Example::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("return_something_const"), &Example::return_something_const);
 	ClassDB::bind_method(D_METHOD("return_extended_ref"), &Example::return_extended_ref);
 	ClassDB::bind_method(D_METHOD("extended_ref_checks"), &Example::extended_ref_checks);
+
 	ClassDB::bind_method(D_METHOD("test_array"), &Example::test_array);
+	ClassDB::bind_method(D_METHOD("test_dictionary"), &Example::test_dictionary);
 
 	{
 		MethodInfo mi;
@@ -145,6 +147,15 @@ Array Example::test_array() const {
 	return arr;
 }
 
+Dictionary Example::test_dictionary() const {
+	Dictionary dict;
+
+	dict["hello"] = "world";
+	dict["foo"] = "bar";
+
+	return dict;
+}
+
 // Properties.
 void Example::set_custom_position(const Vector2 &pos) {
 	custom_position = pos;

test/src/example.h

@@ -88,7 +88,9 @@ class Example : public Control {
 	Ref<ExampleRef> extended_ref_checks(Ref<ExampleRef> p_ref) const;
 	Variant varargs_func(const Variant **args, GDNativeInt arg_count, GDNativeCallError &error);
 	void emit_custom_signal(const String &name, int value);
+
 	Array test_array() const;
+	Dictionary test_dictionary() const;
 
 	// Property.
 	void set_custom_position(const Vector2 &pos);