Code Folding #12950

kitbdev · 2017-11-15T17:05:29Z

Script Editor Code Folding
Fixes #2732
Allows collapsing/expanding code chunks
Code chunks are lines of text where the next line has more whitespace than the first

Implementation details:
TextEdit Text Line can now be hidden
Hidden lines are not drawn
Adds fold gutter similar to breakpoint gutter
Uses icon forward for lines that can fold and icon collapse for folded lines. Mainly because I couldn't find anything better.
Editor bool setting Text Editor/Line Numbers/Code Folding
whitespace level is the number of ' ' spaces and '\t' tabs that come before any other character. '#' comments at the beginning of the line are ignored.
Property bool hiding_enabled enables/disables all code hiding. must be enabled for all code folding features.
TextEdit set_line_hidden(int line, bool enabled) sets the hidden state of a line.
TextEdit can_fold(int line) determines whether a line can be folded. The whitespace level of the next must be higher than the first line
TextEdit fold_line(int line) folds this line. This just sets all lines following this one to hidden if they are empty or has more whitespace. trailing empty lines are unhidden.
TextEdit unfold_line(int line) unhides all lines below this line until the next nonhidden line
TextEdit is_folded(int line) returns true if this line is not hidden and the next line is hidden
Searching unfolds line with found text.
Edit menu and context menu items to fold and unfold line
Default shortcuts for fold line is Alt+Left, unfold line is Alt+Right
Smooth scrolling over hidden lines and page up/page down works (smooth scrolling down over large sections of unhidden code could be better though)
Moving a line up/down unfolds hidden section
Centering viewport to cursor takes into account hidden lines

reduz · 2017-11-15T17:08:11Z

... wow

…

On Wed, Nov 15, 2017 at 2:05 PM, Ian ***@***.***> wrote: Script Editor Code Folding Fixes #2732 <#2732> Allows collapsing/expanding code chunks Code chunks are lines of text where the next line has more whitespace than the first [image: foldable] <https://user-images.githubusercontent.com/10054226/32849350-e428a502-c9fc-11e7-9fbf-fad7e44d71fb.gif> Implementation details: TextEdit Text Line can now be hidden Hidden lines are not drawn Adds fold gutter similar to breakpoint gutter Uses icon forward for lines that can fold and icon collapse for folded lines. Mainly because I couldn't find anything better. Editor bool setting Text Editor/Line Numbers/Code Folding whitespace level is the number of ' ' spaces and '\t' tabs that come before any other character. '#' comments at the beginning of the line are ignored. Property bool hiding_enabled enables/disables all code hiding. must be enabled for all code folding features. TextEdit set_line_hidden(int line, bool enabled) sets the hidden state of a line. TextEdit can_fold(int line) determines whether a line can be folded. The whitespace level of the next must be higher than the first line TextEdit fold_line(int line) folds this line. This just sets all lines following this one to hidden if they are empty or has more whitespace. trailing empty lines are unhidden. TextEdit unfold_line(int line) unhides all lines below this line until the next nonhidden line TextEdit is_folded(int line) returns true if this line is not hidden and the next line is hidden Searching unfolds line with found text. Edit menu and context menu items to fold and unfold line Default shortcuts for fold line is Alt+Left, unfold line is Alt+Right Smooth scrolling over hidden lines and page up/page down works (smooth scrolling down over large sections of unhidden code could be better though) Moving a line up/down unfolds hidden section Centering viewport to cursor takes into account hidden lines ------------------------------ You can view, comment on, or merge this pull request online at: #12950 Commit Summary - TextEdit code folding File Changes - *M* editor/code_editor.cpp <https://github.com/godotengine/godot/pull/12950/files#diff-0> (6) - *M* editor/editor_settings.cpp <https://github.com/godotengine/godot/pull/12950/files#diff-1> (1) - *M* editor/plugins/script_text_editor.cpp <https://github.com/godotengine/godot/pull/12950/files#diff-2> (64) - *M* editor/plugins/script_text_editor.h <https://github.com/godotengine/godot/pull/12950/files#diff-3> (5) - *M* scene/gui/text_edit.cpp <https://github.com/godotengine/godot/pull/12950/files#diff-4> (449) - *M* scene/gui/text_edit.h <https://github.com/godotengine/godot/pull/12950/files#diff-5> (32) Patch Links: - https://github.com/godotengine/godot/pull/12950.patch - https://github.com/godotengine/godot/pull/12950.diff — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#12950>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AF-Z2-ArNIrQ8zdiX-Fu-OnpKWQDUMFnks5s2xnpgaJpZM4QfQiW> .

akien-mga · 2017-11-15T17:12:55Z

editor/plugins/script_text_editor.cpp

-	String tmp2 = tx->get_line(line2);
-	tx->set_line(line2, tmp);
-	tx->set_line(line1, tmp2);
+// static void swap_lines(TextEdit *tx, int line1, int line2) {


I guess this can be removed.

reduz · 2017-11-15T17:17:43Z

@Paulb23 and others will probably want to give this a check

neikeq · 2017-11-15T17:25:36Z

I think code chunks should also be determined by curly braces. This is needed for C-like languages like C# and for dictionaries in GDScript.

blurymind · 2017-11-15T18:59:55Z

Holly cow! :o
Been waiting to see this for years..

NathanWarden · 2017-11-15T21:01:14Z

Great job, very nice :)

Paulb23 · 2017-11-15T21:39:18Z

Nice job!

Apologies for the wall of bullet points I don't want to scare you off :P

But some feedback after playing around with it:

Need some more padding between the gutter and text, can be quite hard (if not impossible) to select the start of a line.
The arrows should be drawn the other way around i.e. > for folded lines and v for unfolded lines
Any line with a '#' below is foldable even on the same indent level, i.e. the following should not be foldable:


This is a line of code



# this is a line with a '#'

Unfolding/folding lines should not adjust viewport to the caret.
Folding a line while the caret is on a line that will be hidden, should place the caret on the line folded rather then the next line below.

Bugs:

if the last line is folded you can enter the folded section.
You can still click the last line even when its folded.
Pressing left/right enters the folded section
Duplicating a folded line hides the duplicated line, but unfolds the rest of the hidden text
Moving a folded line up does not move foldable status with it
Go to next/last breakpoints on a hidden lines does not automatically unfold the line.
If you select a line that can be hidden, and hide it the section still persists, creating some weird behaviour.
Scrolling over folded lines by dragging the scroll bar does not skip the folded lines
And yeah smooth scrolling over folded lines is weird :P
Creating a new script with only the following two lines cannot be folded:

func i_cant_be_folded():
	pass

Extra:

Function to fold all lines as well as unfold all.
Support for comments (Colour regions?, then multi-line strings would be caught.)

Paulb23 · 2017-11-15T21:59:52Z

editor/plugins/script_text_editor.cpp

@@ -1447,7 +1471,7 @@ void ScriptTextEditor::_color_changed(const Color &p_color) {
 	code_editor->get_text_edit()->set_line(color_line, new_line);
 }

-void ScriptTextEditor::_make_context_menu(bool p_selection, bool p_color) {
+void ScriptTextEditor::_make_context_menu(bool p_selection, bool p_color, int p_fold_state) {


Would be better if this was a bool, as it can't be half folded.

Paulb23 · 2017-11-15T22:24:44Z

scene/gui/text_edit.cpp

@@ -3731,6 +3862,8 @@ void TextEdit::_update_caches() {
 	cache.line_spacing = get_constant("line_spacing");
 	cache.row_height = cache.font->get_height() + cache.line_spacing;
 	cache.tab_icon = get_icon("tab");
+	cache.folded_icon = get_icon("Collapse", "EditorIcons");
+	cache.can_fold_icon = get_icon("Forward", "EditorIcons");


Could probably create new icons for code folding, or at least keep them separate by adding them here

Paulb23 · 2017-11-15T22:29:18Z

scene/gui/text_edit.cpp

+	if (!is_hiding_enabled())
+		return false;
+	if (!draw_fold_gutter)
+		return false;


It should still be possible to fold lines even if the gutter is disabled, could draw a marker on / behind the line to denote that its folded?

Paulb23 · 2017-11-15T22:31:52Z

scene/gui/text_edit.cpp

+void TextEdit::set_hiding_enabled(int p_enabled) {
+	hiding_enabled = p_enabled;
+	if (!hiding_enabled)
+		set_draw_fold_gutter(false);


Same here, hiding lines and the fold gutter should be unlinked.

Paulb23 · 2017-11-15T22:34:08Z

scene/gui/text_edit.h

@@ -325,6 +334,8 @@ class TextEdit : public Control {

 	int get_row_height() const;

+	// int _get_fold_offset(int p_line_from, int p_line_to) const;


Can be removed?

ghost · 2017-11-16T02:04:00Z

Awesome work!

I think the icons should be swapped. It should be > for collapsed and v for expanded. (Tree uses these as well.)

(Edit: Whoops, didn't see that Paulb23's already commented on this topic.)

BastiaanOlij · 2017-11-16T02:11:20Z

Love this! ditto on Noshyaar and Paulb's remark, icons should be the other way around :)

kitbdev · 2017-11-16T04:15:42Z

Thanks for all the great feedback!
I have rebased a commit to swap the icons and fix most of what @Paulb23 mentioned. :)
I am still working on the scrolling and selecting the last line.
There is still no support for comments or brackets either. Unindented comments now are not ignored.
Also, there is an icon added to the end of the line when it is folded, click to unfold.
I used some random tools icon for this because I couldn't find an ellipses (...) icon and didn't know what else to use.

Zylann · 2017-11-16T12:38:13Z

Is it working with word wrap? (assuming there is support for it, I know by experience the features might overlap, because visible lines and actual lines are no longer the same thing)
I'd also suggest it could have some language awareness (GDScript, JSON, GLSL, C#) since indentation is not always part of the language syntax (even in GDScript as already noted for dictionaries and arrays). It doesnt need to be "language" though, maybe just some patterns that should produce folding.

DriNeo · 2017-11-16T14:05:12Z

Just a cosmetic suggestion. The arrows are big in my taste. Tiny triangles, like in the scene dock, maybe better.
Anyway this PR is a very nice improvement. Sorry if my english is rough.

blurymind · 2017-11-16T15:41:26Z

The arrows would be less intrusive if they had a slightly darker tone or were semi transparent. I dont mind the size myself

…

On 16 Nov 2017 14:05, "DriNeo" ***@***.***> wrote: Just a cosmetic suggestion. The arrows are big in my taste. Tiny triangles, like in the scene dock, maybe better. Anyway it's a very nice improvement. Sorry if my english is rough. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#12950 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AGMbVX9bCN5Z9Is4X2vLGVWScNKDNCVJks5s3EEtgaJpZM4QfQiW> .

volzhs · 2017-11-16T15:55:58Z

@blurymind yeap. @djrm the professional will take care of it, I think.

Paulb23 · 2017-11-16T20:36:00Z

scene/gui/text_edit.cpp

+void TextEdit::set_draw_fold_gutter(bool p_draw) {
+	draw_fold_gutter = p_draw;
+	if (draw_fold_gutter)
+		set_hiding_enabled(true);


Missed this to disconnect gutter from folding :D

kitbdev · 2017-11-16T21:04:29Z

Fixes for smooth scrolling, last line folded, and others. Cursor now shape changes over icons.
Scrolling now ranges from 0 to the total number of unhidden lines, so it does not match cursor.line_ofs anymore.

Paulb23 · 2017-11-16T23:01:17Z

Great work, scrolling over the hidden lines feel a lot better!

I noticed a few problems when "Scroll Past End Of File" is disabled and "Smooth Scrolling" is enabled.

When there are a lot of folded lines it's impossible to scroll to the last line.
It also starts 2 lines from the end if the content is less then a screen full.
You can also scroll past the first line when the content is less then a screen full.

kitbdev · 2017-11-18T03:02:49Z

Fixed the Scroll past end of file bugs. Took me longer than I would have liked, but scrolling should work now.
I dimmed the icons a bit and I took the GUITabMenu icon and transposed it so it now looks like ellipses for the end of line icon :)

remorse107 · 2017-11-18T14:48:54Z

I am a fan of the new look. Really looks like it belongs now. I hope this makes it into beta.

Zylann · 2017-11-18T14:59:15Z

I think the folding icons are still too wide...
Also, there should be a space between the end of the line and the ellipsis icon.

djrm · 2017-11-18T22:57:30Z

there are two arrow icons that are smaller, and would be better in this case
GuiTreeArrowDown and GuiTreeArrowRight, that would make it look better. also i think i will have to create an ellipsis icon

kitbdev · 2017-11-19T01:09:12Z

Updated to use the smaller icons. Thanks!

Paulb23 · 2017-11-19T13:22:09Z

scene/gui/text_edit.cpp

+bool TextEdit::is_folded(int p_line) const {
+
+	ERR_FAIL_INDEX_V(p_line, text.size(), false);
+	if (p_line + 1 >= text.size() - 1)


This line should be p_line + 1 >= text.size() else you can't unfold the last line.

The last line isn't able to be folded. I determine whether a line is folded by seeing if this line isn't hidden and the next one is hidden, so the next line needs to be less than or equal to text.size() - 1 for that check.

Paulb23 · 2017-11-19T13:37:58Z

There are few more scrolling bugs:

With "Smooth Scrolling" disabled everything if offset by one, (ie clicking line 2 will select line 3)
With "Smooth Scrolling" enabled and scrolled to the top, clicking any line will move the scroll down a line.
With "Scroll Past End Of File" disabled scrolling to the bottom of the file and hiding lines, will not update the scroll/viewport.
"Smooth Scrolling" enabled does not draw enough lines resulting in a small gap at the bottom.

HummusSamurai · 2017-11-19T15:29:55Z

I vote to have this merged for the feature freeze asap and the remaining trivial bugs closed later.

blurymind · 2017-11-19T21:07:28Z

Yes please :)
Perhaps if it gets merged we will be able to find possible bugs faster too

akien-mga · 2017-11-19T23:14:37Z

Alright, let's merge :) Please open issues for the known issues mentioned above which haven't been addressed yet.

akien-mga added enhancement topic:editor usability labels Nov 15, 2017

akien-mga added this to the 3.0 milestone Nov 15, 2017

akien-mga reviewed Nov 15, 2017

View reviewed changes

kitbdev force-pushed the code_folding branch from 6d0ddcf to 48c6a78 Compare November 15, 2017 17:17

Paulb23 reviewed Nov 15, 2017

View reviewed changes

kitbdev force-pushed the code_folding branch from 48c6a78 to 0bf0e28 Compare November 16, 2017 04:14

Paulb23 reviewed Nov 16, 2017

View reviewed changes

kitbdev force-pushed the code_folding branch from 0bf0e28 to 4a98505 Compare November 16, 2017 20:59

TextEdit code folding

d350f50

kitbdev force-pushed the code_folding branch 2 times, most recently from 64a0109 to 18df45d Compare November 18, 2017 02:53

kitbdev force-pushed the code_folding branch from 18df45d to 514392c Compare November 18, 2017 03:41

scrolling fixes

1e59169

kitbdev force-pushed the code_folding branch from 514392c to 1e59169 Compare November 19, 2017 01:08

Paulb23 reviewed Nov 19, 2017

View reviewed changes

akien-mga merged commit d826b04 into godotengine:master Nov 19, 2017

kitbdev deleted the code_folding branch February 13, 2018 19:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Code Folding #12950

Code Folding #12950

kitbdev commented Nov 15, 2017

reduz commented Nov 15, 2017 via email

akien-mga Nov 15, 2017

reduz commented Nov 15, 2017

neikeq commented Nov 15, 2017

blurymind commented Nov 15, 2017

NathanWarden commented Nov 15, 2017

Paulb23 commented Nov 15, 2017

Paulb23 Nov 15, 2017

akien-mga Nov 17, 2017

Paulb23 Nov 15, 2017

Paulb23 Nov 15, 2017 •

edited

Loading

Paulb23 Nov 15, 2017

Paulb23 Nov 15, 2017

ghost commented Nov 16, 2017 •

edited by ghost

Loading

BastiaanOlij commented Nov 16, 2017

kitbdev commented Nov 16, 2017 •

edited

Loading

Zylann commented Nov 16, 2017 •

edited

Loading

DriNeo commented Nov 16, 2017 •

edited

Loading

blurymind commented Nov 16, 2017 via email

volzhs commented Nov 16, 2017

Paulb23 Nov 16, 2017

kitbdev commented Nov 16, 2017 •

edited

Loading

Paulb23 commented Nov 16, 2017

kitbdev commented Nov 18, 2017

remorse107 commented Nov 18, 2017

Zylann commented Nov 18, 2017 •

edited

Loading

djrm commented Nov 18, 2017

kitbdev commented Nov 19, 2017

Paulb23 Nov 19, 2017

kitbdev Nov 21, 2017

Paulb23 commented Nov 19, 2017

HummusSamurai commented Nov 19, 2017

blurymind commented Nov 19, 2017

akien-mga commented Nov 19, 2017

		@@ -325,6 +334,8 @@ class TextEdit : public Control {

		int get_row_height() const;

		// int _get_fold_offset(int p_line_from, int p_line_to) const;

Code Folding #12950

Code Folding #12950

Conversation

kitbdev commented Nov 15, 2017

reduz commented Nov 15, 2017 via email

Choose a reason for hiding this comment

reduz commented Nov 15, 2017

neikeq commented Nov 15, 2017

blurymind commented Nov 15, 2017

NathanWarden commented Nov 15, 2017

Paulb23 commented Nov 15, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Paulb23 Nov 15, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented Nov 16, 2017 • edited by ghost Loading

BastiaanOlij commented Nov 16, 2017

kitbdev commented Nov 16, 2017 • edited Loading

Zylann commented Nov 16, 2017 • edited Loading

DriNeo commented Nov 16, 2017 • edited Loading

blurymind commented Nov 16, 2017 via email

volzhs commented Nov 16, 2017

Choose a reason for hiding this comment

kitbdev commented Nov 16, 2017 • edited Loading

Paulb23 commented Nov 16, 2017

kitbdev commented Nov 18, 2017

remorse107 commented Nov 18, 2017

Zylann commented Nov 18, 2017 • edited Loading

djrm commented Nov 18, 2017

kitbdev commented Nov 19, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Paulb23 commented Nov 19, 2017

HummusSamurai commented Nov 19, 2017

blurymind commented Nov 19, 2017

akien-mga commented Nov 19, 2017

Paulb23 Nov 15, 2017 •

edited

Loading

ghost commented Nov 16, 2017 •

edited by ghost

Loading

kitbdev commented Nov 16, 2017 •

edited

Loading

Zylann commented Nov 16, 2017 •

edited

Loading

DriNeo commented Nov 16, 2017 •

edited

Loading

kitbdev commented Nov 16, 2017 •

edited

Loading

Zylann commented Nov 18, 2017 •

edited

Loading