/*************************************************************************/ /* scene_debugger.cpp */ /*************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /*************************************************************************/ /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */ /* Copyright (c) 2014-2022 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 "scene_debugger.h" #include "core/debugger/engine_debugger.h" #include "core/debugger/engine_profiler.h" #include "core/io/marshalls.h" #include "core/object/script_language.h" #include "core/templates/local_vector.h" #include "scene/main/scene_tree.h" #include "scene/main/window.h" #include "scene/resources/packed_scene.h" Array SceneDebugger::RPCProfilerFrame::serialize() { Array arr; arr.push_back(infos.size() * 4); for (int i = 0; i < infos.size(); ++i) { arr.push_back(uint64_t(infos[i].node)); arr.push_back(infos[i].node_path); arr.push_back(infos[i].incoming_rpc); arr.push_back(infos[i].outgoing_rpc); } return arr; } bool SceneDebugger::RPCProfilerFrame::deserialize(const Array &p_arr) { ERR_FAIL_COND_V(p_arr.size() < 1, false); uint32_t size = p_arr[0]; ERR_FAIL_COND_V(size % 4, false); ERR_FAIL_COND_V((uint32_t)p_arr.size() != size + 1, false); infos.resize(size / 4); int idx = 1; for (uint32_t i = 0; i < size / 4; ++i) { infos.write[i].node = uint64_t(p_arr[idx]); infos.write[i].node_path = p_arr[idx + 1]; infos.write[i].incoming_rpc = p_arr[idx + 2]; infos.write[i].outgoing_rpc = p_arr[idx + 3]; } return true; } class SceneDebugger::RPCProfiler : public EngineProfiler { Map rpc_node_data; uint64_t last_profile_time = 0; void init_node(const ObjectID p_node) { if (rpc_node_data.has(p_node)) { return; } rpc_node_data.insert(p_node, RPCNodeInfo()); rpc_node_data[p_node].node = p_node; rpc_node_data[p_node].node_path = Object::cast_to(ObjectDB::get_instance(p_node))->get_path(); rpc_node_data[p_node].incoming_rpc = 0; rpc_node_data[p_node].outgoing_rpc = 0; } public: void toggle(bool p_enable, const Array &p_opts) { rpc_node_data.clear(); } void add(const Array &p_data) { ERR_FAIL_COND(p_data.size() < 2); const ObjectID id = p_data[0]; const String what = p_data[1]; init_node(id); RPCNodeInfo &info = rpc_node_data[id]; if (what == "rpc_in") { info.incoming_rpc++; } else if (what == "rpc_out") { info.outgoing_rpc++; } } void tick(double p_frame_time, double p_process_time, double p_physics_time, double p_physics_frame_time) { uint64_t pt = OS::get_singleton()->get_ticks_msec(); if (pt - last_profile_time > 100) { last_profile_time = pt; RPCProfilerFrame frame; for (const KeyValue &E : rpc_node_data) { frame.infos.push_back(E.value); } rpc_node_data.clear(); EngineDebugger::get_singleton()->send_message("multiplayer:rpc", frame.serialize()); } } }; SceneDebugger *SceneDebugger::singleton = nullptr; SceneDebugger::SceneDebugger() { singleton = this; rpc_profiler.instantiate(); rpc_profiler->bind("rpc"); #ifdef DEBUG_ENABLED LiveEditor::singleton = memnew(LiveEditor); EngineDebugger::register_message_capture("scene", EngineDebugger::Capture(nullptr, SceneDebugger::parse_message)); #endif } SceneDebugger::~SceneDebugger() { #ifdef DEBUG_ENABLED if (LiveEditor::singleton) { EngineDebugger::unregister_message_capture("scene"); memdelete(LiveEditor::singleton); LiveEditor::singleton = nullptr; } #endif singleton = nullptr; } void SceneDebugger::initialize() { if (EngineDebugger::is_active()) { memnew(SceneDebugger); } } void SceneDebugger::deinitialize() { if (singleton) { memdelete(singleton); } } #ifdef DEBUG_ENABLED Error SceneDebugger::parse_message(void *p_user, const String &p_msg, const Array &p_args, bool &r_captured) { SceneTree *scene_tree = SceneTree::get_singleton(); if (!scene_tree) { return ERR_UNCONFIGURED; } LiveEditor *live_editor = LiveEditor::get_singleton(); if (!live_editor) { return ERR_UNCONFIGURED; } r_captured = true; if (p_msg == "request_scene_tree") { // Scene tree live_editor->_send_tree(); } else if (p_msg == "save_node") { // Save node. ERR_FAIL_COND_V(p_args.size() < 2, ERR_INVALID_DATA); _save_node(p_args[0], p_args[1]); } else if (p_msg == "inspect_object") { // Object Inspect ERR_FAIL_COND_V(p_args.size() < 1, ERR_INVALID_DATA); ObjectID id = p_args[0]; _send_object_id(id); } else if (p_msg == "override_camera_2D:set") { // Camera ERR_FAIL_COND_V(p_args.size() < 1, ERR_INVALID_DATA); bool enforce = p_args[0]; scene_tree->get_root()->enable_canvas_transform_override(enforce); } else if (p_msg == "override_camera_2D:transform") { ERR_FAIL_COND_V(p_args.size() < 1, ERR_INVALID_DATA); Transform2D transform = p_args[0]; scene_tree->get_root()->set_canvas_transform_override(transform); #ifndef _3D_DISABLED } else if (p_msg == "override_camera_3D:set") { ERR_FAIL_COND_V(p_args.size() < 1, ERR_INVALID_DATA); bool enable = p_args[0]; scene_tree->get_root()->enable_camera_3d_override(enable); } else if (p_msg == "override_camera_3D:transform") { ERR_FAIL_COND_V(p_args.size() < 5, ERR_INVALID_DATA); Transform3D transform = p_args[0]; bool is_perspective = p_args[1]; float size_or_fov = p_args[2]; float near = p_args[3]; float far = p_args[4]; if (is_perspective) { scene_tree->get_root()->set_camera_3d_override_perspective(size_or_fov, near, far); } else { scene_tree->get_root()->set_camera_3d_override_orthogonal(size_or_fov, near, far); } scene_tree->get_root()->set_camera_3d_override_transform(transform); #endif // _3D_DISABLED } else if (p_msg == "set_object_property") { ERR_FAIL_COND_V(p_args.size() < 3, ERR_INVALID_DATA); _set_object_property(p_args[0], p_args[1], p_args[2]); } else if (!p_msg.begins_with("live_")) { // Live edits below. return ERR_SKIP; } else if (p_msg == "live_set_root") { ERR_FAIL_COND_V(p_args.size() < 2, ERR_INVALID_DATA); live_editor->_root_func(p_args[0], p_args[1]); } else if (p_msg == "live_node_path") { ERR_FAIL_COND_V(p_args.size() < 2, ERR_INVALID_DATA); live_editor->_node_path_func(p_args[0], p_args[1]); } else if (p_msg == "live_res_path") { ERR_FAIL_COND_V(p_args.size() < 2, ERR_INVALID_DATA); live_editor->_res_path_func(p_args[0], p_args[1]); } else if (p_msg == "live_node_prop_res") { ERR_FAIL_COND_V(p_args.size() < 3, ERR_INVALID_DATA); live_editor->_node_set_res_func(p_args[0], p_args[1], p_args[2]); } else if (p_msg == "live_node_prop") { ERR_FAIL_COND_V(p_args.size() < 3, ERR_INVALID_DATA); live_editor->_node_set_func(p_args[0], p_args[1], p_args[2]); } else if (p_msg == "live_res_prop_res") { ERR_FAIL_COND_V(p_args.size() < 3, ERR_INVALID_DATA); live_editor->_res_set_res_func(p_args[0], p_args[1], p_args[2]); } else if (p_msg == "live_res_prop") { ERR_FAIL_COND_V(p_args.size() < 3, ERR_INVALID_DATA); live_editor->_res_set_func(p_args[0], p_args[1], p_args[2]); } else if (p_msg == "live_node_call") { LocalVector args; LocalVector argptrs; args.resize(p_args.size() - 2); argptrs.resize(args.size()); for (uint32_t i = 0; i < args.size(); i++) { args[i] = p_args[i + 2]; argptrs[i] = &args[i]; } live_editor->_node_call_func(p_args[0], p_args[1], (const Variant **)argptrs.ptr(), argptrs.size()); } else if (p_msg == "live_res_call") { ERR_FAIL_COND_V(p_args.size() < 10, ERR_INVALID_DATA); LocalVector args; LocalVector argptrs; args.resize(p_args.size() - 2); argptrs.resize(args.size()); for (uint32_t i = 0; i < args.size(); i++) { args[i] = p_args[i + 2]; argptrs[i] = &args[i]; } live_editor->_res_call_func(p_args[0], p_args[1], (const Variant **)argptrs.ptr(), argptrs.size()); } else if (p_msg == "live_create_node") { ERR_FAIL_COND_V(p_args.size() < 3, ERR_INVALID_DATA); live_editor->_create_node_func(p_args[0], p_args[1], p_args[2]); } else if (p_msg == "live_instance_node") { ERR_FAIL_COND_V(p_args.size() < 3, ERR_INVALID_DATA); live_editor->_instance_node_func(p_args[0], p_args[1], p_args[2]); } else if (p_msg == "live_remove_node") { ERR_FAIL_COND_V(p_args.size() < 1, ERR_INVALID_DATA); live_editor->_remove_node_func(p_args[0]); } else if (p_msg == "live_remove_and_keep_node") { ERR_FAIL_COND_V(p_args.size() < 2, ERR_INVALID_DATA); live_editor->_remove_and_keep_node_func(p_args[0], p_args[1]); } else if (p_msg == "live_restore_node") { ERR_FAIL_COND_V(p_args.size() < 3, ERR_INVALID_DATA); live_editor->_restore_node_func(p_args[0], p_args[1], p_args[2]); } else if (p_msg == "live_duplicate_node") { ERR_FAIL_COND_V(p_args.size() < 2, ERR_INVALID_DATA); live_editor->_duplicate_node_func(p_args[0], p_args[1]); } else if (p_msg == "live_reparent_node") { ERR_FAIL_COND_V(p_args.size() < 4, ERR_INVALID_DATA); live_editor->_reparent_node_func(p_args[0], p_args[1], p_args[2], p_args[3]); } else { r_captured = false; } return OK; } void SceneDebugger::_save_node(ObjectID id, const String &p_path) { Node *node = Object::cast_to(ObjectDB::get_instance(id)); ERR_FAIL_COND(!node); Ref ps = memnew(PackedScene); ps->pack(node); ResourceSaver::save(p_path, ps); } void SceneDebugger::_send_object_id(ObjectID p_id, int p_max_size) { SceneDebuggerObject obj(p_id); if (obj.id.is_null()) { return; } Array arr; obj.serialize(arr); EngineDebugger::get_singleton()->send_message("scene:inspect_object", arr); } void SceneDebugger::_set_object_property(ObjectID p_id, const String &p_property, const Variant &p_value) { Object *obj = ObjectDB::get_instance(p_id); if (!obj) { return; } String prop_name = p_property; if (p_property.begins_with("Members/")) { Vector ss = p_property.split("/"); prop_name = ss[ss.size() - 1]; } obj->set(prop_name, p_value); } void SceneDebugger::add_to_cache(const String &p_filename, Node *p_node) { LiveEditor *debugger = LiveEditor::get_singleton(); if (!debugger) { return; } if (EngineDebugger::get_script_debugger() && !p_filename.is_empty()) { debugger->live_scene_edit_cache[p_filename].insert(p_node); } } void SceneDebugger::remove_from_cache(const String &p_filename, Node *p_node) { LiveEditor *debugger = LiveEditor::get_singleton(); if (!debugger) { return; } Map> &edit_cache = debugger->live_scene_edit_cache; Map>::Element *E = edit_cache.find(p_filename); if (E) { E->get().erase(p_node); if (E->get().size() == 0) { edit_cache.erase(E); } } Map> &remove_list = debugger->live_edit_remove_list; Map>::Element *F = remove_list.find(p_node); if (F) { for (const KeyValue &G : F->get()) { memdelete(G.value); } remove_list.erase(F); } } /// SceneDebuggerObject SceneDebuggerObject::SceneDebuggerObject(ObjectID p_id) { id = ObjectID(); Object *obj = ObjectDB::get_instance(p_id); if (!obj) { return; } id = p_id; class_name = obj->get_class(); if (ScriptInstance *si = obj->get_script_instance()) { // Read script instance constants and variables if (!si->get_script().is_null()) { Script *s = si->get_script().ptr(); _parse_script_properties(s, si); } } if (Node *node = Object::cast_to(obj)) { // Add specialized NodePath info (if inside tree). if (node->is_inside_tree()) { PropertyInfo pi(Variant::NODE_PATH, String("Node/path")); properties.push_back(SceneDebuggerProperty(pi, node->get_path())); } else { // Can't ask for path if a node is not in tree. PropertyInfo pi(Variant::STRING, String("Node/path")); properties.push_back(SceneDebuggerProperty(pi, "[Orphan]")); } } else if (Script *s = Object::cast_to