Skip to content

Commit

Permalink
Allow to select multiple remote nodes at runtime
Browse files Browse the repository at this point in the history
  • Loading branch information
@YeldhamDev
YeldhamDev committed Nov 27, 2024
1 parent f128f38 commit c158225
Show file tree
Hide file tree
Showing 17 changed files with 1,380 additions and 284 deletions.
4 changes: 2 additions & 2 deletions editor/debugger/debug_adapter/debug_adapter_protocol.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1171,13 +1171,13 @@ void DebugAdapterProtocol::on_debug_data(const String &p_msg, const Array &p_dat
}

if (p_msg == "scene:inspect_object") {
// An object was requested from the debuggee; parse it.
// An object was requested from the debugger; parse it.
SceneDebuggerObject remote_obj;
remote_obj.deserialize(p_data);

parse_object(remote_obj);
} else if (p_msg == "evaluation_return") {
// An evaluation was requested from the debuggee; parse it.
// An evaluation was requested from the debugger; parse it.
DebuggerMarshalls::ScriptStackVariable remote_evaluation;
remote_evaluation.deserialize(p_data);

Expand Down
282 changes: 265 additions & 17 deletions editor/debugger/editor_debugger_inspector.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,11 @@
#include "core/debugger/debugger_marshalls.h"
#include "core/io/marshalls.h"
#include "editor/editor_node.h"
#include "editor/inspector_dock.h"
#include "scene/debugger/scene_debugger.h"

/// EditorDebuggerRemoteObject

bool EditorDebuggerRemoteObject::_set(const StringName &p_name, const Variant &p_value) {
if (!prop_values.has(p_name) || String(p_name).begins_with("Constants/")) {
return false;
Expand All @@ -55,7 +58,7 @@ bool EditorDebuggerRemoteObject::_get(const StringName &p_name, Variant &r_ret)
}

void EditorDebuggerRemoteObject::_get_property_list(List<PropertyInfo> *p_list) const {
p_list->clear(); // Sorry, no want category.
p_list->clear(); // Sorry, don't want any categories.
for (const PropertyInfo &prop : prop_list) {
if (prop.name == "script") {
// Skip the script property, it's always added by the non-virtual method.
Expand All @@ -82,13 +85,82 @@ Variant EditorDebuggerRemoteObject::get_variant(const StringName &p_name) {

void EditorDebuggerRemoteObject::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_title"), &EditorDebuggerRemoteObject::get_title);
ClassDB::bind_method(D_METHOD("get_variant"), &EditorDebuggerRemoteObject::get_variant);
ClassDB::bind_method(D_METHOD("clear"), &EditorDebuggerRemoteObject::clear);
ClassDB::bind_method(D_METHOD("get_remote_object_id"), &EditorDebuggerRemoteObject::get_remote_object_id);

ADD_SIGNAL(MethodInfo("value_edited", PropertyInfo(Variant::INT, "object_id"), PropertyInfo(Variant::STRING, "property"), PropertyInfo("value")));
}

/// EditorDebuggerMultiRemoteObject

bool EditorDebuggerMultiRemoteObject::_set(const StringName &p_name, const Variant &p_value) {
return _set_impl(p_name, p_value, "");
}

bool EditorDebuggerMultiRemoteObject::_set_impl(const StringName &p_name, const Variant &p_value, const String &p_field) {
String name = p_name;

if (!prop_values.has(name) || String(name).begins_with("Constants/")) {
return false;
}
if (name.begins_with("Metadata/")) {
name = name.replace_first("Metadata/", "metadata/");
}

emit_signal(SNAME("value_edited"), remote_object_ids, name, p_value, p_field);
return true;
}

bool EditorDebuggerMultiRemoteObject::_get(const StringName &p_name, Variant &r_ret) const {
String name = p_name;

if (!prop_values.has(name)) {
return false;
}
if (name.begins_with("Metadata/")) {
name = name.replace_first("Metadata/", "metadata/");
}

r_ret = prop_values[name];
return true;
}

void EditorDebuggerMultiRemoteObject::_get_property_list(List<PropertyInfo> *p_list) const {
p_list->clear(); // Sorry, don't want any categories.
for (const PropertyInfo &prop : prop_list) {
if (prop.name == "script") {
// Skip the script property, it's always added by the non-virtual method.
continue;
}

p_list->push_back(prop);
}
}

void EditorDebuggerMultiRemoteObject::set_property_field(const StringName &p_property, const Variant &p_value, const String &p_field) {
_set_impl(p_property, p_value, p_field);
}

String EditorDebuggerMultiRemoteObject::get_title() {
if (remote_object_ids.size() && ObjectID(remote_object_ids[0].operator uint64_t()).is_valid()) {
return vformat(TTR("Remote %s (%d Selected)"), type_name, remote_object_ids.size());
} else {
return "<null>";
}
}

Variant EditorDebuggerMultiRemoteObject::get_variant(const StringName &p_name) {
Variant var;
_get(p_name, var);
return var;
}

void EditorDebuggerMultiRemoteObject::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_title"), &EditorDebuggerMultiRemoteObject::get_title);

ADD_SIGNAL(MethodInfo("value_edited", PropertyInfo(Variant::PACKED_INT64_ARRAY, "object_ids"), PropertyInfo(Variant::STRING, "property"), PropertyInfo("value"), PropertyInfo(Variant::STRING, "field")));
}

/// EditorDebuggerInspector

EditorDebuggerInspector::EditorDebuggerInspector() {
variables = memnew(EditorDebuggerRemoteObject);
}
Expand All @@ -101,6 +173,7 @@ EditorDebuggerInspector::~EditorDebuggerInspector() {
void EditorDebuggerInspector::_bind_methods() {
ADD_SIGNAL(MethodInfo("object_selected", PropertyInfo(Variant::INT, "id")));
ADD_SIGNAL(MethodInfo("object_edited", PropertyInfo(Variant::INT, "id"), PropertyInfo(Variant::STRING, "property"), PropertyInfo("value")));
ADD_SIGNAL(MethodInfo("multi_objects_edited", PropertyInfo(Variant::ARRAY, "ids"), PropertyInfo(Variant::STRING, "property"), PropertyInfo("value"), PropertyInfo(Variant::STRING, "field")));
ADD_SIGNAL(MethodInfo("object_property_updated", PropertyInfo(Variant::INT, "id"), PropertyInfo(Variant::STRING, "property")));
}

Expand All @@ -120,17 +193,20 @@ void EditorDebuggerInspector::_object_edited(ObjectID p_id, const String &p_prop
emit_signal(SNAME("object_edited"), p_id, p_prop, p_value);
}

void EditorDebuggerInspector::_multi_objects_edited(const TypedArray<int64_t> &p_ids, const String &p_prop, const Variant &p_value, const String &p_field) {
emit_signal(SNAME("multi_objects_edited"), p_ids, p_prop, p_value, p_field);
}

void EditorDebuggerInspector::_object_selected(ObjectID p_object) {
emit_signal(SNAME("object_selected"), p_object);
}

ObjectID EditorDebuggerInspector::add_object(const Array &p_arr) {
EditorDebuggerRemoteObject *debug_obj = nullptr;

SceneDebuggerObject obj;
obj.deserialize(p_arr);
ERR_FAIL_COND_V(obj.id.is_null(), ObjectID());

EditorDebuggerRemoteObject *debug_obj = nullptr;
if (remote_objects.has(obj.id)) {
debug_obj = remote_objects[obj.id];
} else {
Expand All @@ -154,7 +230,7 @@ ObjectID EditorDebuggerInspector::add_object(const Array &p_arr) {
if (var.is_string()) {
String path = var;
if (path.contains("::")) {
// built-in resource
// Built-in resource.
String base_path = path.get_slice("::", 0);
Ref<Resource> dependency = ResourceLoader::load(base_path);
if (dependency.is_valid()) {
Expand All @@ -178,40 +254,212 @@ ObjectID EditorDebuggerInspector::add_object(const Array &p_arr) {
}
}

//always add the property, since props may have been added or removed
// Always add the property, since props may have been added or removed.
debug_obj->prop_list.push_back(pinfo);

if (!debug_obj->prop_values.has(pinfo.name)) {
new_props_added++;
debug_obj->prop_values[pinfo.name] = var;
} else {
if (bool(Variant::evaluate(Variant::OP_NOT_EQUAL, debug_obj->prop_values[pinfo.name], var))) {
debug_obj->prop_values[pinfo.name] = var;
changed.insert(pinfo.name);
}
} else if (bool(Variant::evaluate(Variant::OP_NOT_EQUAL, debug_obj->prop_values[pinfo.name], var))) {
debug_obj->prop_values[pinfo.name] = var;
changed.insert(pinfo.name);
}
}

if (old_prop_size == debug_obj->prop_list.size() && new_props_added == 0) {
//only some may have changed, if so, then update those, if exist
// Only some may have changed, if so, then update those, if they exist.
for (const String &E : changed) {
emit_signal(SNAME("object_property_updated"), debug_obj->remote_object_id, E);
}
} else {
//full update, because props were added or removed
// Full update, because props were added or removed.
debug_obj->update();
}
return obj.id;
}

EditorDebuggerMultiRemoteObject *EditorDebuggerInspector::get_multi_objects(const Array &p_arr) {
ERR_FAIL_COND_V(p_arr.is_empty(), nullptr);

if (!multi_remote_obj) {
multi_remote_obj = memnew(EditorDebuggerMultiRemoteObject);
multi_remote_obj->connect("value_edited", callable_mp(this, &EditorDebuggerInspector::_multi_objects_edited));
} else {
multi_remote_obj->remote_object_ids.clear();
}

LocalVector<SceneDebuggerObject> objects;
for (const Array arr : p_arr) {
SceneDebuggerObject obj;
obj.deserialize(arr);
if (obj.id.is_valid()) {
multi_remote_obj->remote_object_ids.push_front((uint64_t)obj.id);
objects.push_back(obj);
}
}
ERR_FAIL_COND_V(multi_remote_obj->remote_object_ids.is_empty(), nullptr);

StringName class_name = objects[0].class_name;
if (class_name != SNAME("Object")) {
// Search for the common class between all selected objects.
bool check_type_again = true;
while (check_type_again) {
check_type_again = false;

if (class_name == SNAME("Object") || class_name == StringName()) {
// All objects inherit from Object, so no need to continue checking.
class_name = SNAME("Object");
break;
}

// Check that all objects inherit from type_name.
for (const SceneDebuggerObject &obj : objects) {
if (obj.class_name == class_name || ClassDB::is_parent_class(obj.class_name, class_name)) {
continue; // class_name is the same or a parent of the object's class.
}

// class_name is not a parent of the node's class, so check again with the parent class.
class_name = ClassDB::get_parent_class(class_name);
check_type_again = true;
break;
}
}
}
multi_remote_obj->type_name = class_name;

// Search for properties that are present in all selected objects.
HashMap<String, Pair<int, SceneDebuggerObject::SceneDebuggerProperty>> usage;
LocalVector<Pair<int, SceneDebuggerObject::SceneDebuggerProperty> *> data_list;
LocalVector<SceneDebuggerObject::SceneDebuggerProperty> matching_props;
int nc = 0;
for (const SceneDebuggerObject &obj : objects) {
for (const SceneDebuggerObject::SceneDebuggerProperty &prop : obj.properties) {
PropertyInfo pinfo = prop.first;
if (pinfo.name == "script") {
continue; // Added later manually, since this is intercepted before being set (check Variant Object::get()).
} else if (pinfo.name.begins_with("metadata/")) {
pinfo.name = pinfo.name.replace_first("metadata/", "Metadata/"); // Trick to not get actual metadata edited from EditorDebuggerMultiRemoteObject.
}

if (!usage.has(pinfo.name)) {
Pair<int, SceneDebuggerObject::SceneDebuggerProperty> pld;
pld.first = 0;
pld.second = prop;
pld.second.first.name = pinfo.name;
usage[pinfo.name] = pld;
data_list.push_back(usage.getptr(pinfo.name));
}

// Make sure only properties with the same exact PropertyInfo data will appear.
if (usage[pinfo.name].second.first == pinfo) {
usage[pinfo.name].first++;
}
}

nc++;
}
for (const Pair<int, SceneDebuggerObject::SceneDebuggerProperty> *pld : data_list) {
if (nc == pld->first) {
matching_props.push_back(pld->second);
}
}

int old_prop_size = multi_remote_obj->prop_list.size();

multi_remote_obj->prop_list.clear();
int new_props_added = 0;
HashSet<String> changed;
for (SceneDebuggerObject::SceneDebuggerProperty &prop : matching_props) {
PropertyInfo &pinfo = prop.first;
Variant &var = prop.second;

if (pinfo.type == Variant::OBJECT) {
if (var.is_string()) {
String path = var;
if (path.contains("::")) {
// Built-in resource.
String base_path = path.get_slice("::", 0);
Ref<Resource> dependency = ResourceLoader::load(base_path);
if (dependency.is_valid()) {
remote_dependencies.insert(dependency);
}
}
var = ResourceLoader::load(path);

if (pinfo.hint_string == "Script") {
if (multi_remote_obj->get_script() != var) {
multi_remote_obj->set_script(Ref<RefCounted>());
Ref<Script> scr(var);
if (!scr.is_null()) {
ScriptInstance *scr_instance = scr->placeholder_instance_create(multi_remote_obj);
if (scr_instance) {
multi_remote_obj->set_script_and_instance(var, scr_instance);
}
}
}
}
}
}

// Always add the property, since props may have been added or removed.
multi_remote_obj->prop_list.push_back(pinfo);

if (!multi_remote_obj->prop_values.has(pinfo.name)) {
new_props_added++;
multi_remote_obj->prop_values[pinfo.name] = var;
} else if (bool(Variant::evaluate(Variant::OP_NOT_EQUAL, multi_remote_obj->prop_values[pinfo.name], var))) {
multi_remote_obj->prop_values[pinfo.name] = var;
changed.insert(pinfo.name);
}
}

if (old_prop_size == multi_remote_obj->prop_list.size() && new_props_added == 0) {
// Only some may have changed, if so, then update those, if they exist.
for (const String &E : changed) {
emit_signal(SNAME("object_property_updated"), multi_remote_obj->get_instance_id(), E);
}
} else {
// Full update, because props were added or removed.
multi_remote_obj->update();
}
return multi_remote_obj;
}

void EditorDebuggerInspector::clear_remote_inspector() {
EditorNode *editor = EditorNode::get_singleton();
const Object *inspector_obj = InspectorDock::get_inspector_singleton()->get_edited_object();

// Check if the inspector holds a remote item, and take it out if so.
for (const KeyValue<ObjectID, EditorDebuggerRemoteObject *> &E : remote_objects) {
if (inspector_obj && inspector_obj->get_instance_id() == E.value->get_instance_id()) {
editor->push_item(nullptr);
break;
}
}
if (multi_remote_obj && inspector_obj == multi_remote_obj) {
editor->push_item(nullptr);
}
}

void EditorDebuggerInspector::clear_cache() {
EditorNode *editor = EditorNode::get_singleton();
ObjectID editor_current_id = editor->get_editor_selection_history()->get_current();

for (const KeyValue<ObjectID, EditorDebuggerRemoteObject *> &E : remote_objects) {
EditorNode *editor = EditorNode::get_singleton();
if (editor->get_editor_selection_history()->get_current() == E.value->get_instance_id()) {
if (editor_current_id == E.value->get_instance_id()) {
editor->push_item(nullptr);
}
memdelete(E.value);
}

if (multi_remote_obj) {
if (editor_current_id == multi_remote_obj->get_instance_id()) {
editor->push_item(nullptr);
}
memdelete(multi_remote_obj);
multi_remote_obj = nullptr;
}

remote_objects.clear();
remote_dependencies.clear();
}
Expand Down
Loading

0 comments on commit c158225

Please sign in to comment.