Enhanced debugger for godot 3.0 #11940

Geequlim · 2017-10-08T12:12:17Z

Some improvements for the debugger of godot 3.0. As disscused with @reduz in #10891.

The PR will take the enhanced debugger like the cuurent debugger 2.1.4 to the master branch.

Make it possiable to access members and constants from all kind of script languages.
Send script varialbes and constants when inspector remote objects.
Improved property editor to interact with remote objects.
Merge debugger inspector with normal inspector.
Merge live scene tree panel with normal scene tree.
Implement a ~~better~~ dictionary editor ~~than the 2.1 version~~.
- It is hard to implement that with current PropertyEditor as discussed in Implement DictionaryPropertyEdit . #12015. So I will take the 2.1.4 version with some improvements.

reduz · 2017-10-09T15:33:55Z

Did you see my proposal in the 2.1 issue? Seems like it from your two last checkboxes, but making sure :P
I would also add that live editing should probably be enabled by default too.

Geequlim · 2017-10-14T16:44:39Z

@reduz I have implemented the inspector to show and edit remote objects now but the live scene tree still stays here.

reduz · 2017-10-14T16:52:53Z

looking great!

Geequlim · 2017-10-14T16:56:20Z

Why I didn't move the Live Scene Tree to the normal Scene Tree dock is I didn't find a good way to manage the tree with the debugger but it is contained in another place.

That would make the code more mess 😕

reduz · 2017-10-14T17:21:32Z

I can help you move it when I get back home on Tuesday

…

On Oct 14, 2017 1:56 PM, "Geequlim" ***@***.***> wrote: [image: 2017-10-15 00-51-40] <https://user-images.githubusercontent.com/6964556/31577540-18daa606-b143-11e7-8ebb-6a1ad0d938c8.png> Why I didn't move the Live Scene Tree to the normal Scene Tree dock is I didn't find a good way to manage the tree with the debugger but it is contained in another place. That would make the code more mess 😕 — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#11940 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AF-Z20LJHGXxDMi4XMXw3EwlJ3YSVh3Tks5ssOfCgaJpZM4PxryO> .

Geequlim · 2017-10-17T14:52:50Z

~~The commits of this PR is not event to my origin branch: debugger after I git push --force to it.~~
~~Could you please give me a help about this?~~

Geequlim · 2017-10-17T15:41:08Z

Seems the github delayed to synchronize the commit from the origin branch.

Geequlim · 2017-10-24T03:49:42Z

@reduz Are you going to have a review and mege this before alpha2 ?

reduz · 2017-11-13T11:52:56Z

Hi @Geequlim I was planning this week to add the tools so you can properly implement:
"Merge live scene tree panel with normal scene tree.", in hopes of having it implemented before beta. It seems you completed the work for everything else, so will try to have this working ASAP

Geequlim · 2017-11-15T07:56:10Z

@reduz Great!
I hope we can finish this work within this week so it can be merge before the 3.0 BETA . Then I have enough time to fix bugs before the 3.0 stable.

MarianoGnu · 2017-11-15T22:05:55Z

why not adding the remote scene tree to a dock in the same slot as Scene and make it active when debugging? (or add a setting to allow enable it automatically)
Other way (here comes a big complain, because of extreme and unneded complexity) is adding a "remote scene" to scene tabs, with the X button not enabled, then you can see the scene in realtime while the game is runing (you have a duplicate of the nodes with the same property values, but scripts disabled)

reduz · 2017-11-16T01:25:05Z

@Geequlim alright, added the support you were missing. You can acess SceneTreeDock by using

EditorNode::get_singleton()->get_scene_tree_dock()

so, basically add your remote tree editor with

EditorNode::get_singleton()->get_scene_tree_dock()->add_remote_tree_editor(editor)

When debug begins, show it by doing:

EditorNode::get_singleton()->get_scene_tree_dock()->show_remote_tree()

and when debug ends, hide it by doing:

EditorNode::get_singleton()->get_scene_tree_dock()->hide_remote_tree()

and the remote debug menu can go away!

Geequlim · 2017-11-16T09:40:24Z

All features are implemented now.
It is ready for merging.

akien-mga · 2017-11-16T09:43:53Z

Some screenshots to build up the hype? :D

Geequlim · 2017-11-16T09:59:38Z

@akien-mga Here we go!

Explore remote member variables with dictionary support in breakpoint stacks.
Live explore the remote scene tree
Edit remote objects from the inspector directly

SirPigeonz · 2017-11-16T10:35:26Z

This is excelsior!

reduz · 2017-11-16T11:54:37Z

core/script_debugger_remote.cpp

@@ -532,56 +553,77 @@ void ScriptDebuggerRemote::_send_object_id(ObjectID p_id) {
 	if (!obj)
 		return;

-	List<PropertyInfo> pinfo;


I actually like my code for handling requesting objects better. It's newer than yours, fixes a few bugs, sends Object IDs and can handle when an object is too big to send.

I remember you have changed the limit to 8MB it should be enough for most objects. I will check your code again and make it more reliable with this. But it is necessary to change something to send more usable informations like script constant values and member variables of script instance.

member variables of script instance should already be obtainable with get_property_list to the object, they have the usage flag: PROPERTY_USAGE_SCRIPT_VARIABLE , so no extra code is needed.

reduz · 2017-11-16T11:55:23Z

core/script_debugger_remote.cpp

@@ -231,11 +252,11 @@ void ScriptDebuggerRemote::debug(ScriptLanguage *p_script, bool p_can_continue)
 					}
 				}

-				{ //locals
-					packet_peer_stream->put_var(locals.size());
+				{ //globals


The idea of sending globals is fine, but in GDScript, globals are constants and there are a ton of them. Sending them every time seems like too much.

Infact only autoloads will be sent in GDScript.

reduz · 2017-11-16T11:58:09Z

editor/script_editor_debugger.cpp

-			inspected_object->prop_list.clear();
-			inspected_object->prop_values.clear();
+		bool is_new_object = false;
+		if (remote_objects.has(id)) {


Ah, I like this, makes the history work.

reduz · 2017-11-16T11:59:10Z

editor/script_editor_debugger.cpp

 		}

-		for (int i = 0; i < prop_count; i++) {
+		for (int i = 0; i < properties.size(); i++) {


Please check my code for sending objects, it fixes a few bugs since 2.1 regarding objects being too big that may crash the debugger, so you may want to use it, or part of it.

akien-mga · 2017-11-16T23:44:36Z

Sorry @Geequlim, I did a slight refactoring of the gdscript module in #12969 so you'll need to rebase this PR.

Remove remote inspector panel

…simple dictionary editor implement

Ignore all script constants in the global section of the breakpoint stack. Check property size before send to avoid too large of data be sent. Fix crash while clear the remote objects from the debugger.

Geequlim · 2017-11-17T04:12:47Z

@akien-mga Rebased to latest master.

@reduz I try to use your code to send properties but I got some problems

Constant values can't be send.
Some of script members are not listed in the result even with flag PROPERTY_USAGE_SCRIPT_VARIABLE
The debugger stopped with parsing the received data with script_editor_debugger.cpp:1042 and script_editor_debugger.cpp:1055

So I keep the code of mine for send objects with your size checking logic for properties.

reduz · 2017-11-17T16:47:51Z

@Geequlim If you want to keep your code but use the size checking it's fine

reduz · 2017-11-21T18:14:20Z

@Geequlim I don't mind, but please make sure to use my code to check that no buffer overrides exist, otherwise the editor will crash.

reduz · 2017-11-21T22:40:31Z

@Geequlim also, cant seem to drag values in the inspector

Geequlim · 2017-11-22T04:56:44Z

@reduz I have take the size checking code inside the PR before merged. But I’m not sure it is safe enough as the size checking for each property to the max size of the stream peer as it did before.

groud added feature proposal topic:editor labels Oct 8, 2017

groud added this to the 3.0 milestone Oct 8, 2017

Geequlim mentioned this pull request Nov 9, 2017

Add null check to fix crashing with debugger #12771

Merged

Geequlim mentioned this pull request Nov 15, 2017

Implement DictionaryPropertyEdit . #12015

Closed

Geequlim changed the title ~~[WIP] Enhanced debugger for godot 3.0~~ Enhanced debugger for godot 3.0 Nov 16, 2017

reduz reviewed Nov 16, 2017

View reviewed changes

Geequlim added 4 commits November 17, 2017 09:20

Abstract some method for script system

475cee9

Send script members, contants and globals to debugger

ccf7679

Remove remote inspector panel

Better supported for remote object editing with the inspector with a …

c655fc7

…simple dictionary editor implement

Move the remote scene tree to the scene tree dock.

fab66af

Ignore all script constants in the global section of the breakpoint stack. Check property size before send to avoid too large of data be sent. Fix crash while clear the remote objects from the debugger.

akien-mga merged commit 6065b2d into godotengine:master Nov 20, 2017

akien-mga mentioned this pull request Nov 24, 2017

Edit on Inspector an exported Dictionary. #10018

Closed

Geequlim mentioned this pull request Nov 29, 2017

Cannot change remote variables in debuger #13346

Closed

27thLiz mentioned this pull request Jan 10, 2018

Cannot insert value in Dictionary in visual script #12913

Closed

Geequlim deleted the debugger branch January 11, 2018 03:02

willnationsdev mentioned this pull request Jan 31, 2018

Cannot export Dictionary in 3.0 #16247

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhanced debugger for godot 3.0 #11940

Enhanced debugger for godot 3.0 #11940

Geequlim commented Oct 8, 2017 •

edited by akien-mga

Loading

reduz commented Oct 9, 2017

Geequlim commented Oct 14, 2017

reduz commented Oct 14, 2017

Geequlim commented Oct 14, 2017

reduz commented Oct 14, 2017 via email

Geequlim commented Oct 17, 2017 •

edited

Loading

Geequlim commented Oct 17, 2017

Geequlim commented Oct 24, 2017

reduz commented Nov 13, 2017

Geequlim commented Nov 15, 2017

MarianoGnu commented Nov 15, 2017

reduz commented Nov 16, 2017

Geequlim commented Nov 16, 2017

akien-mga commented Nov 16, 2017

Geequlim commented Nov 16, 2017

SirPigeonz commented Nov 16, 2017

reduz Nov 16, 2017

Geequlim Nov 16, 2017

reduz Nov 16, 2017

reduz Nov 16, 2017

Geequlim Nov 16, 2017

reduz Nov 16, 2017

reduz Nov 16, 2017

akien-mga commented Nov 16, 2017

Geequlim commented Nov 17, 2017 •

edited

Loading

reduz commented Nov 17, 2017

reduz commented Nov 21, 2017

reduz commented Nov 21, 2017

Geequlim commented Nov 22, 2017

Enhanced debugger for godot 3.0 #11940

Enhanced debugger for godot 3.0 #11940

Conversation

Geequlim commented Oct 8, 2017 • edited by akien-mga Loading

reduz commented Oct 9, 2017

Geequlim commented Oct 14, 2017

reduz commented Oct 14, 2017

Geequlim commented Oct 14, 2017

reduz commented Oct 14, 2017 via email

Geequlim commented Oct 17, 2017 • edited Loading

Geequlim commented Oct 17, 2017

Geequlim commented Oct 24, 2017

reduz commented Nov 13, 2017

Geequlim commented Nov 15, 2017

MarianoGnu commented Nov 15, 2017

reduz commented Nov 16, 2017

Geequlim commented Nov 16, 2017

akien-mga commented Nov 16, 2017

Geequlim commented Nov 16, 2017

SirPigeonz commented Nov 16, 2017

reduz Nov 16, 2017

Choose a reason for hiding this comment

Geequlim Nov 16, 2017

Choose a reason for hiding this comment

reduz Nov 16, 2017

Choose a reason for hiding this comment

reduz Nov 16, 2017

Choose a reason for hiding this comment

Geequlim Nov 16, 2017

Choose a reason for hiding this comment

reduz Nov 16, 2017

Choose a reason for hiding this comment

reduz Nov 16, 2017

Choose a reason for hiding this comment

akien-mga commented Nov 16, 2017

Geequlim commented Nov 17, 2017 • edited Loading

reduz commented Nov 17, 2017

reduz commented Nov 21, 2017

reduz commented Nov 21, 2017

Geequlim commented Nov 22, 2017

Geequlim commented Oct 8, 2017 •

edited by akien-mga

Loading

Geequlim commented Oct 17, 2017 •

edited

Loading

Geequlim commented Nov 17, 2017 •

edited

Loading