Add main_gutter (breakpoints, bookmarks, execution lines) to code_edit

2025-11-09 12:50:35 +00:00 · 2020-07-26 15:57:23 +01:00
parent 907f9f2a84
commit 4d7df24d46
19 changed files with 403 additions and 377 deletions
--- a/scene/gui/code_edit.cpp
+++ b/scene/gui/code_edit.cpp
@@ -34,8 +34,18 @@ void CodeEdit::_notification(int p_what) {
 	switch (p_what) {
 		case NOTIFICATION_THEME_CHANGED:
 		case NOTIFICATION_ENTER_TREE: {
+			set_gutter_width(main_gutter, cache.row_height);
 			set_gutter_width(line_number_gutter, (line_number_digits + 1) * cache.font->get_char_size('0').width);

+			breakpoint_color = get_theme_color("breakpoint_color");
+			breakpoint_icon = get_theme_icon("breakpoint");
+
+			bookmark_color = get_theme_color("bookmark_color");
+			bookmark_icon = get_theme_icon("bookmark");
+
+			executing_line_color = get_theme_color("executing_line_color");
+			executing_line_icon = get_theme_icon("executing_line");
+
 			line_number_color = get_theme_color("line_number_color");
 		} break;
 		case NOTIFICATION_DRAW: {
@@ -43,6 +53,160 @@ void CodeEdit::_notification(int p_what) {
 	}
 }

+/* Main Gutter */
+void CodeEdit::_update_draw_main_gutter() {
+	set_gutter_draw(main_gutter, draw_breakpoints || draw_bookmarks || draw_executing_lines);
+}
+
+void CodeEdit::set_draw_breakpoints_gutter(bool p_draw) {
+	draw_breakpoints = p_draw;
+	set_gutter_clickable(main_gutter, p_draw);
+	_update_draw_main_gutter();
+}
+
+bool CodeEdit::is_drawing_breakpoints_gutter() const {
+	return draw_breakpoints;
+}
+
+void CodeEdit::set_draw_bookmarks_gutter(bool p_draw) {
+	draw_bookmarks = p_draw;
+	_update_draw_main_gutter();
+}
+
+bool CodeEdit::is_drawing_bookmarks_gutter() const {
+	return draw_bookmarks;
+}
+
+void CodeEdit::set_draw_executing_lines_gutter(bool p_draw) {
+	draw_executing_lines = p_draw;
+	_update_draw_main_gutter();
+}
+
+bool CodeEdit::is_drawing_executing_lines_gutter() const {
+	return draw_executing_lines;
+}
+
+void CodeEdit::_main_gutter_draw_callback(int p_line, int p_gutter, const Rect2 &p_region) {
+	if (draw_breakpoints && is_line_breakpointed(p_line)) {
+		int padding = p_region.size.x / 6;
+
+		Rect2 breakpoint_region = p_region;
+		breakpoint_region.position += Point2(padding, padding);
+		breakpoint_region.size -= Point2(padding, padding) * 2;
+		breakpoint_icon->draw_rect(get_canvas_item(), breakpoint_region, false, breakpoint_color);
+	}
+
+	if (draw_bookmarks && is_line_bookmarked(p_line)) {
+		int horizontal_padding = p_region.size.x / 2;
+		int vertical_padding = p_region.size.y / 4;
+
+		Rect2 bookmark_region = p_region;
+		bookmark_region.position += Point2(horizontal_padding, 0);
+		bookmark_region.size -= Point2(horizontal_padding * 1.1, vertical_padding);
+		bookmark_icon->draw_rect(get_canvas_item(), bookmark_region, false, bookmark_color);
+	}
+
+	if (draw_executing_lines && is_line_executing(p_line)) {
+		int horizontal_padding = p_region.size.x / 10;
+		int vertical_padding = p_region.size.y / 4;
+
+		Rect2 executing_line_region = p_region;
+		executing_line_region.position += Point2(horizontal_padding, vertical_padding);
+		executing_line_region.size -= Point2(horizontal_padding, vertical_padding) * 2;
+		executing_line_icon->draw_rect(get_canvas_item(), executing_line_region, false, executing_line_color);
+	}
+}
+
+// Breakpoints
+void CodeEdit::set_line_as_breakpoint(int p_line, bool p_breakpointed) {
+	int mask = get_line_gutter_metadata(p_line, main_gutter);
+	set_line_gutter_metadata(p_line, main_gutter, p_breakpointed ? mask | MAIN_GUTTER_BREAKPOINT : mask & ~MAIN_GUTTER_BREAKPOINT);
+	if (p_breakpointed) {
+		breakpointed_lines[p_line] = true;
+	} else if (breakpointed_lines.has(p_line)) {
+		breakpointed_lines.erase(p_line);
+	}
+	emit_signal("breakpoint_toggled", p_line);
+}
+
+bool CodeEdit::is_line_breakpointed(int p_line) const {
+	return (int)get_line_gutter_metadata(p_line, main_gutter) & MAIN_GUTTER_BREAKPOINT;
+}
+
+void CodeEdit::clear_breakpointed_lines() {
+	for (int i = 0; i < get_line_count(); i++) {
+		if (is_line_breakpointed(i)) {
+			set_line_as_breakpoint(i, false);
+		}
+	}
+}
+
+Array CodeEdit::get_breakpointed_lines() const {
+	Array ret;
+	for (int i = 0; i < get_line_count(); i++) {
+		if (is_line_breakpointed(i)) {
+			ret.append(i);
+		}
+	}
+	return ret;
+}
+
+// Bookmarks
+void CodeEdit::set_line_as_bookmarked(int p_line, bool p_bookmarked) {
+	int mask = get_line_gutter_metadata(p_line, main_gutter);
+	set_line_gutter_metadata(p_line, main_gutter, p_bookmarked ? mask | MAIN_GUTTER_BOOKMARK : mask & ~MAIN_GUTTER_BOOKMARK);
+}
+
+bool CodeEdit::is_line_bookmarked(int p_line) const {
+	return (int)get_line_gutter_metadata(p_line, main_gutter) & MAIN_GUTTER_BOOKMARK;
+}
+
+void CodeEdit::clear_bookmarked_lines() {
+	for (int i = 0; i < get_line_count(); i++) {
+		if (is_line_bookmarked(i)) {
+			set_line_as_bookmarked(i, false);
+		}
+	}
+}
+
+Array CodeEdit::get_bookmarked_lines() const {
+	Array ret;
+	for (int i = 0; i < get_line_count(); i++) {
+		if (is_line_bookmarked(i)) {
+			ret.append(i);
+		}
+	}
+	return ret;
+}
+
+// executing lines
+void CodeEdit::set_line_as_executing(int p_line, bool p_executing) {
+	int mask = get_line_gutter_metadata(p_line, main_gutter);
+	set_line_gutter_metadata(p_line, main_gutter, p_executing ? mask | MAIN_GUTTER_EXECUTING : mask & ~MAIN_GUTTER_EXECUTING);
+}
+
+bool CodeEdit::is_line_executing(int p_line) const {
+	return (int)get_line_gutter_metadata(p_line, main_gutter) & MAIN_GUTTER_EXECUTING;
+}
+
+void CodeEdit::clear_executing_lines() {
+	for (int i = 0; i < get_line_count(); i++) {
+		if (is_line_executing(i)) {
+			set_line_as_executing(i, false);
+		}
+	}
+}
+
+Array CodeEdit::get_executing_lines() const {
+	Array ret;
+	for (int i = 0; i < get_line_count(); i++) {
+		if (is_line_executing(i)) {
+			ret.append(i);
+		}
+	}
+	return ret;
+}
+
 /* Line numbers */
 void CodeEdit::set_draw_line_numbers(bool p_draw) {
 	set_gutter_draw(line_number_gutter, p_draw);
@@ -69,6 +233,36 @@ void CodeEdit::_line_number_draw_callback(int p_line, int p_gutter, const Rect2
 }

 void CodeEdit::_bind_methods() {
+	/* Main Gutter */
+	ClassDB::bind_method(D_METHOD("_main_gutter_draw_callback"), &CodeEdit::_main_gutter_draw_callback);
+
+	ClassDB::bind_method(D_METHOD("set_draw_breakpoints_gutter", "enable"), &CodeEdit::set_draw_breakpoints_gutter);
+	ClassDB::bind_method(D_METHOD("is_drawing_breakpoints_gutter"), &CodeEdit::is_drawing_breakpoints_gutter);
+
+	ClassDB::bind_method(D_METHOD("set_draw_bookmarks_gutter", "enable"), &CodeEdit::set_draw_bookmarks_gutter);
+	ClassDB::bind_method(D_METHOD("is_drawing_bookmarks_gutter"), &CodeEdit::is_drawing_bookmarks_gutter);
+
+	ClassDB::bind_method(D_METHOD("set_draw_executing_lines_gutter", "enable"), &CodeEdit::set_draw_executing_lines_gutter);
+	ClassDB::bind_method(D_METHOD("is_drawing_executing_lines_gutter"), &CodeEdit::is_drawing_executing_lines_gutter);
+
+	// Breakpoints
+	ClassDB::bind_method(D_METHOD("set_line_as_breakpoint", "line", "breakpointed"), &CodeEdit::set_line_as_breakpoint);
+	ClassDB::bind_method(D_METHOD("is_line_breakpointed", "line"), &CodeEdit::is_line_breakpointed);
+	ClassDB::bind_method(D_METHOD("clear_breakpointed_lines"), &CodeEdit::clear_breakpointed_lines);
+	ClassDB::bind_method(D_METHOD("get_breakpointed_lines"), &CodeEdit::get_breakpointed_lines);
+
+	// Bookmarks
+	ClassDB::bind_method(D_METHOD("set_line_as_bookmarked", "line", "bookmarked"), &CodeEdit::set_line_as_bookmarked);
+	ClassDB::bind_method(D_METHOD("is_line_bookmarked", "line"), &CodeEdit::is_line_bookmarked);
+	ClassDB::bind_method(D_METHOD("clear_bookmarked_lines"), &CodeEdit::clear_bookmarked_lines);
+	ClassDB::bind_method(D_METHOD("get_bookmarked_lines"), &CodeEdit::get_bookmarked_lines);
+
+	// executing lines
+	ClassDB::bind_method(D_METHOD("set_line_as_executing", "line", "executing"), &CodeEdit::set_line_as_executing);
+	ClassDB::bind_method(D_METHOD("is_line_executing", "line"), &CodeEdit::is_line_executing);
+	ClassDB::bind_method(D_METHOD("clear_executing_lines"), &CodeEdit::clear_executing_lines);
+	ClassDB::bind_method(D_METHOD("get_executing_lines"), &CodeEdit::get_executing_lines);
+
 	/* Line numbers */
 	ClassDB::bind_method(D_METHOD("_line_number_draw_callback"), &CodeEdit::_line_number_draw_callback);

@@ -77,11 +271,28 @@ void CodeEdit::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("set_line_numbers_zero_padded", "enable"), &CodeEdit::set_line_numbers_zero_padded);
 	ClassDB::bind_method(D_METHOD("is_line_numbers_zero_padded"), &CodeEdit::is_line_numbers_zero_padded);

+	ADD_PROPERTY(PropertyInfo(Variant::BOOL, "draw_breakpoints_gutter"), "set_draw_breakpoints_gutter", "is_drawing_breakpoints_gutter");
+
+	ADD_PROPERTY(PropertyInfo(Variant::BOOL, "draw_bookmarks"), "set_draw_bookmarks_gutter", "is_drawing_bookmarks_gutter");
+
+	ADD_PROPERTY(PropertyInfo(Variant::BOOL, "draw_executing_lines"), "set_draw_executing_lines_gutter", "is_drawing_executing_lines_gutter");
+
 	ADD_PROPERTY(PropertyInfo(Variant::BOOL, "draw_line_numbers"), "set_draw_line_numbers", "is_draw_line_numbers_enabled");
 	ADD_PROPERTY(PropertyInfo(Variant::BOOL, "zero_pad_line_numbers"), "set_line_numbers_zero_padded", "is_line_numbers_zero_padded");
+
+	ADD_PROPERTY(PropertyInfo(Variant::BOOL, "draw_fold_gutter"), "set_draw_fold_gutter", "is_drawing_fold_gutter");
+
+	ADD_SIGNAL(MethodInfo("breakpoint_toggled", PropertyInfo(Variant::INT, "line")));
 }

 void CodeEdit::_gutter_clicked(int p_line, int p_gutter) {
+	if (p_gutter == main_gutter) {
+		if (draw_breakpoints) {
+			set_line_as_breakpoint(p_line, !is_line_breakpointed(p_line));
+		}
+		return;
+	}
+
 	if (p_gutter == line_number_gutter) {
 		cursor_set_line(p_line);
 		return;
@@ -89,21 +300,44 @@ void CodeEdit::_gutter_clicked(int p_line, int p_gutter) {
 }

 void CodeEdit::_lines_edited_from(int p_from_line, int p_to_line) {
-	int line_count = get_line_count();
-	if (line_count != cached_line_count) {
-		int lc = line_count;
-		line_number_digits = 1;
-		while (lc /= 10) {
-			line_number_digits++;
-		}
-		set_gutter_width(line_number_gutter, (line_number_digits + 1) * cache.font->get_char_size('0').width);
+	if (p_from_line == p_to_line) {
+		return;
+	}

-		cached_line_count = line_count;
+	int lc = get_line_count();
+	line_number_digits = 1;
+	while (lc /= 10) {
+		line_number_digits++;
+	}
+	set_gutter_width(line_number_gutter, (line_number_digits + 1) * cache.font->get_char_size('0').width);
+
+	int from_line = MIN(p_from_line, p_to_line);
+	int line_count = (p_to_line - p_from_line);
+	List<int> breakpoints;
+	breakpointed_lines.get_key_list(&breakpoints);
+	for (const List<int>::Element *E = breakpoints.front(); E; E = E->next()) {
+		int line = E->get();
+		if (line <= from_line) {
+			continue;
+		}
+		breakpointed_lines.erase(line);
+
+		emit_signal("breakpoint_toggled", line);
+		if (line_count > 0 || line >= p_from_line) {
+			emit_signal("breakpoint_toggled", line + line_count);
+			breakpointed_lines[line + line_count] = true;
+			continue;
+		}
 	}
 }

 void CodeEdit::_update_gutter_indexes() {
 	for (int i = 0; i < get_gutter_count(); i++) {
+		if (get_gutter_name(i) == "main_gutter") {
+			main_gutter = i;
+			continue;
+		}
+
 		if (get_gutter_name(i) == "line_numbers") {
 			line_number_gutter = i;
 			continue;
@@ -112,12 +346,25 @@ void CodeEdit::_update_gutter_indexes() {
 }

 CodeEdit::CodeEdit() {
+	/* Gutters */
+	int gutter_idx = 0;
+
+	/* Main Gutter */
+	add_gutter();
+	set_gutter_name(gutter_idx, "main_gutter");
+	set_gutter_draw(gutter_idx, false);
+	set_gutter_overwritable(gutter_idx, true);
+	set_gutter_type(gutter_idx, GUTTER_TPYE_CUSTOM);
+	set_gutter_custom_draw(gutter_idx, this, "_main_gutter_draw_callback");
+	gutter_idx++;
+
 	/* Line numbers */
 	add_gutter();
-	set_gutter_name(0, "line_numbers");
-	set_gutter_draw(0, false);
-	set_gutter_type(0, GUTTER_TPYE_CUSTOM);
-	set_gutter_custom_draw(0, this, "_line_number_draw_callback");
+	set_gutter_name(gutter_idx, "line_numbers");
+	set_gutter_draw(gutter_idx, false);
+	set_gutter_type(gutter_idx, GUTTER_TPYE_CUSTOM);
+	set_gutter_custom_draw(gutter_idx, this, "_line_number_draw_callback");
+	gutter_idx++;

 	connect("lines_edited_from", callable_mp(this, &CodeEdit::_lines_edited_from));
 	connect("gutter_clicked", callable_mp(this, &CodeEdit::_gutter_clicked));