Add ability to bind an unbind arguments to Callable.

core/callable.cpp

@@ -30,6 +30,7 @@
 
 #include "callable.h"
 
+#include "callable_bind.h"
 #include "core/script_language.h"
 #include "message_queue.h"
 #include "object.h"
@@ -53,6 +54,18 @@ void Callable::call(const Variant **p_arguments, int p_argcount, Variant &r_retu
 	}
 }
 
+Callable Callable::bind(const Variant **p_arguments, int p_argcount) const {
+	Vector<Variant> args;
+	args.resize(p_argcount);
+	for (int i = 0; i < p_argcount; i++) {
+		args.write[i] = *p_arguments[i];
+	}
+	return Callable(memnew(CallableCustomBind(*this, args)));
+}
+Callable Callable::unbind(int p_argcount) const {
+	return Callable(memnew(CallableCustomUnbind(*this, p_argcount)));
+}
+
 Object *Callable::get_object() const {
 	if (is_null()) {
 		return nullptr;
@@ -85,6 +98,18 @@ CallableCustom *Callable::get_custom() const {
 	return custom;
 }
 
+const Callable *Callable::get_base_comparator() const {
+	const Callable *comparator = nullptr;
+	if (is_custom()) {
+		comparator = custom->get_base_comparator();
+	}
+	if (comparator) {
+		return comparator;
+	} else {
+		return this;
+	}
+}
+
 uint32_t Callable::hash() const {
 	if (is_custom()) {
 		return custom->hash();
@@ -258,6 +283,10 @@ Callable::~Callable() {
 	}
 }
 
+const Callable *CallableCustom::get_base_comparator() const {
+	return nullptr;
+}
+
 CallableCustom::CallableCustom() {
 	ref_count.init();
 }

core/callable.h

@@ -80,6 +80,9 @@ public:
 		return method != StringName();
 	}
 
+	Callable bind(const Variant **p_arguments, int p_argcount) const;
+	Callable unbind(int p_argcount) const;
+
 	Object *get_object() const;
 	ObjectID get_object_id() const;
 	StringName get_method() const;
@@ -87,6 +90,8 @@ public:
 
 	uint32_t hash() const;
 
+	const Callable *get_base_comparator() const; //used for bind/unbind to do less precise comparisons (ignoring binds) in signal connect/disconnect
+
 	bool operator==(const Callable &p_callable) const;
 	bool operator!=(const Callable &p_callable) const;
 	bool operator<(const Callable &p_callable) const;
@@ -119,6 +124,7 @@ public:
 	virtual CompareLessFunc get_compare_less_func() const = 0;
 	virtual ObjectID get_object() const = 0; //must always be able to provide an object
 	virtual void call(const Variant **p_arguments, int p_argcount, Variant &r_return_value, Callable::CallError &r_call_error) const = 0;
+	virtual const Callable *get_base_comparator() const;
 
 	CallableCustom();
 	virtual ~CallableCustom() {}

core/callable_bind.cpp

@@ -0,0 +1,193 @@
+/*************************************************************************/
+/*  callable_bind.cpp                                                    */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                      https://godotengine.org                          */
+/*************************************************************************/
+/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur.                 */
+/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md).   */
+/*                                                                       */
+/* 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.                */
+/*************************************************************************/
+
+#include "callable_bind.h"
+
+//////////////////////////////////
+
+uint32_t CallableCustomBind::hash() const {
+	return callable.hash();
+}
+String CallableCustomBind::get_as_text() const {
+	return callable.operator String();
+}
+
+bool CallableCustomBind::_equal_func(const CallableCustom *p_a, const CallableCustom *p_b) {
+	const CallableCustomBind *a = (const CallableCustomBind *)p_a;
+	const CallableCustomBind *b = (const CallableCustomBind *)p_b;
+
+	if (!(a->callable != b->callable)) {
+		return false;
+	}
+
+	if (a->binds.size() != b->binds.size()) {
+		return false;
+	}
+
+	return true;
+}
+
+bool CallableCustomBind::_less_func(const CallableCustom *p_a, const CallableCustom *p_b) {
+	const CallableCustomBind *a = (const CallableCustomBind *)p_a;
+	const CallableCustomBind *b = (const CallableCustomBind *)p_b;
+
+	if (a->callable < b->callable) {
+		return true;
+	} else if (b->callable < a->callable) {
+		return false;
+	}
+
+	return a->binds.size() < b->binds.size();
+}
+
+CallableCustom::CompareEqualFunc CallableCustomBind::get_compare_equal_func() const {
+	return _equal_func;
+}
+CallableCustom::CompareLessFunc CallableCustomBind::get_compare_less_func() const {
+	return _less_func;
+}
+ObjectID CallableCustomBind::get_object() const {
+	return callable.get_object_id();
+}
+const Callable *CallableCustomBind::get_base_comparator() const {
+	return &callable;
+}
+
+void CallableCustomBind::call(const Variant **p_arguments, int p_argcount, Variant &r_return_value, Callable::CallError &r_call_error) const {
+	const Variant **args = (const Variant **)alloca(sizeof(const Variant **) * (binds.size() + p_argcount));
+	for (int i = 0; i < p_argcount; i++) {
+		args[i] = (const Variant *)p_arguments[i];
+	}
+	for (int i = 0; i < binds.size(); i++) {
+		args[i + p_argcount] = (const Variant *)&binds[i];
+	}
+
+	callable.call(args, p_argcount + binds.size(), r_return_value, r_call_error);
+}
+
+CallableCustomBind::CallableCustomBind(const Callable &p_callable, const Vector<Variant> &p_binds) {
+	callable = p_callable;
+	binds = p_binds;
+}
+
+CallableCustomBind::~CallableCustomBind() {
+}
+
+//////////////////////////////////
+
+uint32_t CallableCustomUnbind::hash() const {
+	return callable.hash();
+}
+String CallableCustomUnbind::get_as_text() const {
+	return callable.operator String();
+}
+
+bool CallableCustomUnbind::_equal_func(const CallableCustom *p_a, const CallableCustom *p_b) {
+	const CallableCustomUnbind *a = (const CallableCustomUnbind *)p_a;
+	const CallableCustomUnbind *b = (const CallableCustomUnbind *)p_b;
+
+	if (!(a->callable != b->callable)) {
+		return false;
+	}
+
+	if (a->argcount != b->argcount) {
+		return false;
+	}
+
+	return true;
+}
+
+bool CallableCustomUnbind::_less_func(const CallableCustom *p_a, const CallableCustom *p_b) {
+	const CallableCustomUnbind *a = (const CallableCustomUnbind *)p_a;
+	const CallableCustomUnbind *b = (const CallableCustomUnbind *)p_b;
+
+	if (a->callable < b->callable) {
+		return true;
+	} else if (b->callable < a->callable) {
+		return false;
+	}
+
+	return a->argcount < b->argcount;
+}
+
+CallableCustom::CompareEqualFunc CallableCustomUnbind::get_compare_equal_func() const {
+	return _equal_func;
+}
+CallableCustom::CompareLessFunc CallableCustomUnbind::get_compare_less_func() const {
+	return _less_func;
+}
+ObjectID CallableCustomUnbind::get_object() const {
+	return callable.get_object_id();
+}
+const Callable *CallableCustomUnbind::get_base_comparator() const {
+	return &callable;
+}
+
+void CallableCustomUnbind::call(const Variant **p_arguments, int p_argcount, Variant &r_return_value, Callable::CallError &r_call_error) const {
+	if (argcount > p_argcount) {
+		r_call_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
+		r_call_error.argument = 0;
+		r_call_error.expected = argcount;
+		return;
+	}
+	callable.call(p_arguments, p_argcount - argcount, r_return_value, r_call_error);
+}
+
+CallableCustomUnbind::CallableCustomUnbind(const Callable &p_callable, int p_argcount) {
+	callable = p_callable;
+	argcount = p_argcount;
+}
+
+CallableCustomUnbind::~CallableCustomUnbind() {
+}
+
+Callable callable_bind(const Callable &p_callable, const Variant &p_arg1) {
+	return p_callable.bind((const Variant **)&p_arg1, 1);
+}
+
+Callable callable_bind(const Callable &p_callable, const Variant &p_arg1, const Variant &p_arg2) {
+	const Variant *args[2] = { &p_arg1, &p_arg2 };
+	return p_callable.bind(args, 2);
+}
+
+Callable callable_bind(const Callable &p_callable, const Variant &p_arg1, const Variant &p_arg2, const Variant &p_arg3) {
+	const Variant *args[3] = { &p_arg1, &p_arg2, &p_arg3 };
+	return p_callable.bind(args, 3);
+}
+
+Callable callable_bind(const Callable &p_callable, const Variant &p_arg1, const Variant &p_arg2, const Variant &p_arg3, const Variant &p_arg4) {
+	const Variant *args[4] = { &p_arg1, &p_arg2, &p_arg3, &p_arg4 };
+	return p_callable.bind(args, 4);
+}
+
+Callable callable_bind(const Callable &p_callable, const Variant &p_arg1, const Variant &p_arg2, const Variant &p_arg3, const Variant &p_arg4, const Variant &p_arg5) {
+	const Variant *args[5] = { &p_arg1, &p_arg2, &p_arg3, &p_arg4, &p_arg5 };
+	return p_callable.bind(args, 5);
+}

core/callable_bind.h

@@ -0,0 +1,85 @@
+/*************************************************************************/
+/*  callable_bind.h                                                      */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                      https://godotengine.org                          */
+/*************************************************************************/
+/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur.                 */
+/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md).   */
+/*                                                                       */
+/* 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 CALLABLE_BIND_H
+#define CALLABLE_BIND_H
+
+#include "core/callable.h"
+#include "core/variant.h"
+
+class CallableCustomBind : public CallableCustom {
+	Callable callable;
+	Vector<Variant> binds;
+
+	static bool _equal_func(const CallableCustom *p_a, const CallableCustom *p_b);
+	static bool _less_func(const CallableCustom *p_a, const CallableCustom *p_b);
+
+public:
+	//for every type that inherits, these must always be the same for this type
+	virtual uint32_t hash() const;
+	virtual String get_as_text() const;
+	virtual CompareEqualFunc get_compare_equal_func() const;
+	virtual CompareLessFunc get_compare_less_func() const;
+	virtual ObjectID get_object() const; //must always be able to provide an object
+	virtual void call(const Variant **p_arguments, int p_argcount, Variant &r_return_value, Callable::CallError &r_call_error) const;
+	virtual const Callable *get_base_comparator() const;
+
+	CallableCustomBind(const Callable &p_callable, const Vector<Variant> &p_binds);
+	virtual ~CallableCustomBind();
+};
+
+class CallableCustomUnbind : public CallableCustom {
+	Callable callable;
+	int argcount;
+
+	static bool _equal_func(const CallableCustom *p_a, const CallableCustom *p_b);
+	static bool _less_func(const CallableCustom *p_a, const CallableCustom *p_b);
+
+public:
+	//for every type that inherits, these must always be the same for this type
+	virtual uint32_t hash() const;
+	virtual String get_as_text() const;
+	virtual CompareEqualFunc get_compare_equal_func() const;
+	virtual CompareLessFunc get_compare_less_func() const;
+	virtual ObjectID get_object() const; //must always be able to provide an object
+	virtual void call(const Variant **p_arguments, int p_argcount, Variant &r_return_value, Callable::CallError &r_call_error) const;
+	virtual const Callable *get_base_comparator() const;
+
+	CallableCustomUnbind(const Callable &p_callable, int p_argcount);
+	virtual ~CallableCustomUnbind();
+};
+
+Callable callable_bind(const Callable &p_callable, const Variant &p_arg1);
+Callable callable_bind(const Callable &p_callable, const Variant &p_arg1, const Variant &p_arg2);
+Callable callable_bind(const Callable &p_callable, const Variant &p_arg1, const Variant &p_arg2, const Variant &p_arg3);
+Callable callable_bind(const Callable &p_callable, const Variant &p_arg1, const Variant &p_arg2, const Variant &p_arg3, const Variant &p_arg4);
+Callable callable_bind(const Callable &p_callable, const Variant &p_arg1, const Variant &p_arg2, const Variant &p_arg3, const Variant &p_arg4, const Variant &p_arg5);
+
+#endif // CALLABLE_BIND_H

core/core_string_names.cpp

@@ -73,6 +73,8 @@ CoreStringNames::CoreStringNames() :
 		a8(StaticCString::create("a8")),
 		call(StaticCString::create("call")),
 		call_deferred(StaticCString::create("call_deferred")),
+		bind(StaticCString::create("bind")),
+		unbind(StaticCString::create("unbind")),
 		emit(StaticCString::create("emit")),
 		notification(StaticCString::create("notification")) {
 }

core/core_string_names.h

@@ -92,6 +92,8 @@ public:
 
 	StringName call;
 	StringName call_deferred;
+	StringName bind;
+	StringName unbind;
 	StringName emit;
 	StringName notification;
 };

core/object.cpp

@@ -1315,9 +1315,10 @@ Error Object::connect(const StringName &p_signal, const Callable &p_callable, co
 
 	Callable target = p_callable;
 
-	if (s->slot_map.has(target)) {
+	//compare with the base callable, so binds can be ignored
+	if (s->slot_map.has(*target.get_base_comparator())) {
 		if (p_flags & CONNECT_REFERENCE_COUNTED) {
-			s->slot_map[target].reference_count++;
+			s->slot_map[*target.get_base_comparator()].reference_count++;
 			return OK;
 		} else {
 			ERR_FAIL_V_MSG(ERR_INVALID_PARAMETER, "Signal '" + p_signal + "' is already connected to given callable '" + p_callable + "' in that object.");
@@ -1337,7 +1338,8 @@ Error Object::connect(const StringName &p_signal, const Callable &p_callable, co
 		slot.reference_count = 1;
 	}
 
-	s->slot_map[target] = slot;
+	//use callable version as key, so binds can be ignored
+	s->slot_map[*target.get_base_comparator()] = slot;
 
 	return OK;
 }
@@ -1364,7 +1366,7 @@ bool Object::is_connected(const StringName &p_signal, const Callable &p_callable
 
 	Callable target = p_callable;
 
-	return s->slot_map.has(target);
+	return s->slot_map.has(*target.get_base_comparator());
 	//const Map<Signal::Target,Signal::Slot>::Element *E = s->slot_map.find(target);
 	//return (E!=nullptr );
 }
@@ -1386,7 +1388,7 @@ void Object::_disconnect(const StringName &p_signal, const Callable &p_callable,
 	SignalData *s = signal_map.getptr(p_signal);
 	ERR_FAIL_COND_MSG(!s, vformat("Nonexistent signal '%s' in %s.", p_signal, to_string()));
 
-	ERR_FAIL_COND_MSG(!s->slot_map.has(p_callable), "Disconnecting nonexistent signal '" + p_signal + "', callable: " + p_callable + ".");
+	ERR_FAIL_COND_MSG(!s->slot_map.has(*p_callable.get_base_comparator()), "Disconnecting nonexistent signal '" + p_signal + "', callable: " + p_callable + ".");
 
 	SignalData::Slot *slot = &s->slot_map[p_callable];
 
@@ -1398,7 +1400,7 @@ void Object::_disconnect(const StringName &p_signal, const Callable &p_callable,
 	}
 
 	target_object->connections.erase(slot->cE);
-	s->slot_map.erase(p_callable);
+	s->slot_map.erase(*p_callable.get_base_comparator());
 
 	if (s->slot_map.empty() && ClassDB::has_signal(get_class_name(), p_signal)) {
 		//not user signal, delete

core/object.h

@@ -31,6 +31,7 @@
 #ifndef OBJECT_H
 #define OBJECT_H
 
+#include "core/callable_bind.h"
 #include "core/hash_map.h"
 #include "core/list.h"
 #include "core/map.h"

core/variant_call.cpp

@@ -586,6 +586,7 @@ struct _VariantCall {
 	VCALL_LOCALMEM0(Callable, get_object_id);
 	VCALL_LOCALMEM0(Callable, get_method);
 	VCALL_LOCALMEM0(Callable, hash);
+	VCALL_LOCALMEM1R(Callable, unbind);
 
 	VCALL_LOCALMEM0R(Signal, is_null);
 	VCALL_LOCALMEM0R(Signal, get_object);
@@ -1347,11 +1348,14 @@ void Variant::call_ptr(const StringName &p_method, const Variant **p_args, int p
 				if (p_method == CoreStringNames::get_singleton()->call) {
 					reinterpret_cast<const Callable *>(_data._mem)->call(p_args, p_argcount, ret, r_error);
 					valid = true;
-				}
+				} else if (p_method == CoreStringNames::get_singleton()->call_deferred) {
-				if (p_method == CoreStringNames::get_singleton()->call_deferred) {
 					reinterpret_cast<const Callable *>(_data._mem)->call_deferred(p_args, p_argcount);
 					valid = true;
+				} else if (p_method == CoreStringNames::get_singleton()->bind) {
+					ret = reinterpret_cast<const Callable *>(_data._mem)->bind(p_args, p_argcount);
+					valid = true;
 				}
+
 			} else if (type == SIGNAL) {
 				if (p_method == CoreStringNames::get_singleton()->emit) {
 					if (r_ret) {
@@ -1696,9 +1700,13 @@ void Variant::get_method_list(List<MethodInfo> *p_list) const {
 
 	if (type == CALLABLE) {
 		MethodInfo mi;
+
+		mi.name = "bind";
+		mi.flags |= METHOD_FLAG_VARARG;
+		p_list->push_back(mi);
+
 		mi.name = "call";
 		mi.return_val.usage = PROPERTY_USAGE_NIL_IS_VARIANT;
-		mi.flags |= METHOD_FLAG_VARARG;
 
 		p_list->push_back(mi);
 
@@ -2130,6 +2138,7 @@ void register_variant_methods() {
 	ADDFUNC0R(CALLABLE, INT, Callable, get_object_id, varray());
 	ADDFUNC0R(CALLABLE, STRING_NAME, Callable, get_method, varray());
 	ADDFUNC0R(CALLABLE, INT, Callable, hash, varray());
+	ADDFUNC1R(CALLABLE, CALLABLE, Callable, unbind, INT, "argcount", varray());
 
 	ADDFUNC0R(SIGNAL, BOOL, Signal, is_null, varray());
 	ADDFUNC0R(SIGNAL, OBJECT, Signal, get_object, varray());

editor/scene_tree_dock.cpp

@@ -1141,7 +1141,7 @@ void SceneTreeDock::_notification(int p_what) {
 			node_shortcuts->add_child(button_custom);
 			button_custom->set_text(TTR("Other Node"));
 			button_custom->set_icon(get_theme_icon("Add", "EditorIcons"));
-			button_custom->connect("pressed", callable_mp(this, &SceneTreeDock::_tool_selected), make_binds(TOOL_NEW, false));
+			button_custom->connect("pressed", callable_bind(callable_mp(this, &SceneTreeDock::_tool_selected), TOOL_NEW, false));
 
 			node_shortcuts->add_spacer();
 			create_root_dialog->add_child(node_shortcuts);