Add color pickers to script editor

Author: dugramen

doc/classes/EditorSettings.xml

@@ -1216,6 +1216,9 @@
 		<member name="text_editor/appearance/caret/type" type="int" setter="" getter="">
 			The shape of the caret to use in the script editor. [b]Line[/b] displays a vertical line to the left of the current character, whereas [b]Block[/b] displays an outline over the current character.
 		</member>
+		<member name="text_editor/appearance/enable_inline_color_picker" type="bool" setter="" getter="">
+			If [code]true[/code], displays a colored button before any [Color] constructor in the script editor. Clicking on them allows the color to be modified through a color picker.
+		</member>
 		<member name="text_editor/appearance/guidelines/line_length_guideline_hard_column" type="int" setter="" getter="">
 			The column at which to display a subtle line as a line length guideline for scripts. This should generally be greater than [member text_editor/appearance/guidelines/line_length_guideline_soft_column].
 		</member>

editor/editor_settings.cpp

@@ -683,6 +683,8 @@ void EditorSettings::_load_defaults(Ref<ConfigFile> p_extra_config) {
 	_load_godot2_text_editor_theme();
 
 	// Appearance
+	EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "text_editor/appearance/enable_inline_color_picker", true, "");
+
 	// Appearance: Caret
 	EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "text_editor/appearance/caret/type", 0, "Line,Block")
 	_initial_set("text_editor/appearance/caret/caret_blink", true, true);

editor/plugins/script_text_editor.cpp

@@ -396,8 +396,215 @@ bool ScriptTextEditor::show_members_overview() {
 	return true;
 }
 
+bool ScriptTextEditor::_is_valid_color_info(const Array &p_info) {
+	if (p_info.size() < INFO_COLOR_MAX) {
+		return false;
+	}
+	if (p_info[INFO_COLOR].get_type() != Variant::COLOR) {
+		return false;
+	}
+	if (!p_info[INFO_COLOR_END].is_num() || !p_info[INFO_COLOR_MODE].is_num()) {
+		return false;
+	}
+	return true;
+}
+
+Array ScriptTextEditor::_inline_object_parse(const String &p_text, int p_line) {
+	Array result;
+	int i_end_previous = 0;
+	int i_start = p_text.find("Color");
+
+	while (i_start != -1) {
+		int i_par_start = p_text.find_char('(', i_start + 5);
+		if (i_par_start != -1) {
+			int i_par_end = p_text.find_char(')', i_start + 5);
+			if (i_par_end != -1) {
+				Array color_info;
+				color_info.resize(INFO_COLOR_MAX);
+				color_info[TextEdit::INFO_LINE] = p_line;
+				color_info[TextEdit::INFO_COLUMN] = i_start;
+				color_info[TextEdit::INFO_WIDTH_RATIO] = 1.0;
+				color_info[INFO_COLOR_END] = i_par_end;
+
+				String fn_name = p_text.substr(i_start + 5, i_par_start - i_start - 5);
+				String s_params = p_text.substr(i_par_start + 1, i_par_end - i_par_start - 1);
+				bool has_added_color = false;
+
+				if (fn_name.is_empty() || fn_name == ".from_string") {
+					String stripped = s_params.strip_edges(true, true);
+					// String parameter.
+					if (stripped.length() > 0 && (stripped[0] == '\"')) {
+						String color_string = stripped.substr(1, stripped.length() - 2);
+						color_info[INFO_COLOR] = Color(color_string);
+						color_info[INFO_COLOR_MODE] = -1;
+						has_added_color = true;
+					}
+					// Empty Color() constructor.
+					else if (stripped.is_empty()) {
+						color_info[INFO_COLOR] = Color();
+						color_info[INFO_COLOR_MODE] = -1;
+						has_added_color = true;
+					}
+				}
+				// Float & int parameters.
+				if (!has_added_color && s_params.size() > 0) {
+					PackedFloat64Array params = s_params.split_floats(",", false);
+					if (params.size() == 3) {
+						params.resize(4);
+						params.set(3, 1.0);
+					}
+					if (params.size() == 4) {
+						has_added_color = true;
+						if (fn_name == ".from_ok_hsl") {
+							color_info[INFO_COLOR] = Color::from_ok_hsl(params[0], params[1], params[2], params[3]);
+							color_info[INFO_COLOR_MODE] = ColorPicker::MODE_OKHSL;
+						} else if (fn_name == ".from_hsv") {
+							color_info[INFO_COLOR] = Color::from_hsv(params[0], params[1], params[2], params[3]);
+							color_info[INFO_COLOR_MODE] = ColorPicker::MODE_HSV;
+						} else if (fn_name == ".from_rgba8") {
+							color_info[INFO_COLOR] = Color::from_rgba8(int(params[0]), int(params[1]), int(params[2]), int(params[3]));
+							color_info[INFO_COLOR_MODE] = ColorPicker::MODE_RGB;
+						} else if (fn_name.is_empty()) {
+							color_info[INFO_COLOR] = Color(params[0], params[1], params[2], params[3]);
+							color_info[INFO_COLOR_MODE] = ColorPicker::MODE_RAW;
+						} else {
+							has_added_color = false;
+						}
+					}
+				}
+
+				if (has_added_color) {
+					result.push_back(color_info);
+					i_end_previous = i_par_end + 1;
+				}
+			}
+		}
+		i_end_previous = MAX(i_end_previous, i_start);
+		i_start = p_text.find("Color", i_start + 1);
+	}
+	return result;
+}
+
+void ScriptTextEditor::_inline_object_draw(const Array &p_info, const Rect2 &p_rect) {
+	if (_is_valid_color_info(p_info)) {
+		Rect2 col_rect = p_rect.grow(-4);
+		code_editor->get_text_editor()->draw_rect(col_rect, Color(p_info[INFO_COLOR]));
+		code_editor->get_text_editor()->draw_rect(col_rect, Color(1, 1, 1), false, 1);
+	}
+}
+
+void ScriptTextEditor::_inline_object_handle_click(const Array &p_info, const Rect2 &p_rect) {
+	if (_is_valid_color_info(p_info)) {
+		int mode = p_info[INFO_COLOR_MODE];
+		if (mode < 0 || mode >= ColorPicker::MODE_MAX) {
+			inline_color_picker->set_using_hex_string(true);
+		} else {
+			inline_color_picker->set_using_hex_string(false);
+			inline_color_picker->set_color_mode((ColorPicker::ColorModeType)mode);
+		}
+
+		inline_color_picker->set_pick_color(p_info[INFO_COLOR]);
+		inline_color_line = p_info[TextEdit::INFO_LINE];
+		inline_color_start = p_info[TextEdit::INFO_COLUMN];
+		inline_color_end = p_info[INFO_COLOR_END];
+
+		// Move popup above the line if it's too low.
+		float_t view_h = get_viewport_rect().size.y;
+		float_t pop_h = inline_color_popup->get_contents_minimum_size().y;
+		float_t pop_y = p_rect.get_end().y;
+		float_t pop_x = p_rect.position.x;
+		if (pop_y + pop_h > view_h) {
+			pop_y = p_rect.position.y - pop_h;
+		}
+		// Move popup to the right if it's too high.
+		if (pop_y < 0) {
+			pop_x = p_rect.get_end().x;
+		}
+
+		inline_color_popup->popup(Rect2(pop_x, pop_y, 0, 0));
+		code_editor->get_text_editor()->set_selection_mode(TextEdit::SelectionMode::SELECTION_MODE_NONE);
+	}
+}
+
+String ScriptTextEditor::_picker_color_stringify(const Color &p_color, int p_mode) {
+	String result;
+	String fname;
+	Vector<String> str_params;
+	// HTML string.
+	if (p_mode < 0) {
+		str_params.push_back("\"" + p_color.to_html() + "\"");
+	}
+	// RGBA int parameters (0-255).
+	else if (p_mode == ColorPicker::MODE_RGB) {
+		str_params = {
+			itos(p_color.get_r8()),
+			itos(p_color.get_g8()),
+			itos(p_color.get_b8()),
+			itos(p_color.get_a8())
+		};
+		fname = ".from_rgba8";
+	}
+	// HSL, HSV, and RAW Float parameters.
+	else {
+		PackedFloat64Array flt_params;
+		str_params.resize(4);
+		switch (p_mode) {
+			case ColorPicker::MODE_HSV: {
+				flt_params = { p_color.get_h(), p_color.get_s(), p_color.get_v(), p_color.a };
+				fname = ".from_hsv";
+			} break;
+			case ColorPicker::MODE_OKHSL: {
+				flt_params = { p_color.get_ok_hsl_h(), p_color.get_ok_hsl_s(), p_color.get_ok_hsl_l(), p_color.a };
+				fname = ".from_ok_hsl";
+			} break;
+			case ColorPicker::MODE_RAW: {
+				flt_params = { p_color.r, p_color.g, p_color.b, p_color.a };
+				fname = "";
+			} break;
+		}
+		for (int ind = 0; ind < flt_params.size(); ind++) {
+			str_params.set(ind, String::num(flt_params[ind], 3));
+		}
+	}
+	result = "Color" + fname + "(" + String(", ").join(str_params) + ")";
+	return result;
+}
+
+void ScriptTextEditor::_picker_color_changed(const Color &p_color) {
+	if (inline_color_line < 0) {
+		return;
+	}
+	int mode = inline_color_picker->get_color_mode();
+	if (inline_color_picker->is_using_hex_string()) {
+		mode = -1;
+	}
+	String result = _picker_color_stringify(p_color, mode);
+	code_editor->get_text_editor()->begin_complex_operation();
+	code_editor->get_text_editor()->remove_text(inline_color_line, inline_color_start, inline_color_line, inline_color_end + 1);
+	inline_color_end = inline_color_start + result.size() - 2;
+	code_editor->get_text_editor()->insert_text(result, inline_color_line, inline_color_start);
+	code_editor->get_text_editor()->end_complex_operation();
+}
+
+void ScriptTextEditor::_picker_opening() {
+	previous_tooltip_enabled = code_editor->get_text_editor()->is_symbol_tooltip_on_hover_enabled();
+	code_editor->get_text_editor()->set_symbol_tooltip_on_hover_enabled(false);
+}
+
+void ScriptTextEditor::_picker_closed() {
+	code_editor->get_text_editor()->set_symbol_tooltip_on_hover_enabled(previous_tooltip_enabled);
+}
+
 void ScriptTextEditor::update_settings() {
 	code_editor->get_text_editor()->set_gutter_draw(connection_gutter, EDITOR_GET("text_editor/appearance/gutters/show_info_gutter"));
+	if (EDITOR_GET("text_editor/appearance/enable_inline_color_picker")) {
+		code_editor->get_text_editor()->set_inline_object_handlers(
+				callable_mp(this, &ScriptTextEditor::_inline_object_parse),
+				callable_mp(this, &ScriptTextEditor::_inline_object_draw),
+				callable_mp(this, &ScriptTextEditor::_inline_object_handle_click));
+	} else {
+		code_editor->get_text_editor()->set_inline_object_handlers(Callable(), Callable(), Callable());
+	}
 	code_editor->update_editor_settings();
 }
 
@@ -2594,6 +2801,17 @@ ScriptTextEditor::ScriptTextEditor() {
 	bookmarks_menu = memnew(PopupMenu);
 	breakpoints_menu = memnew(PopupMenu);
 
+	inline_color_popup = memnew(PopupPanel);
+	inline_color_popup->connect("about_to_popup", callable_mp(this, &ScriptTextEditor::_picker_opening));
+	inline_color_popup->connect("popup_hide", callable_mp(this, &ScriptTextEditor::_picker_closed));
+	add_child(inline_color_popup);
+
+	inline_color_picker = memnew(ColorPicker);
+	inline_color_picker->set_mouse_filter(MOUSE_FILTER_STOP);
+	inline_color_picker->set_deferred_mode(true);
+	inline_color_picker->connect("color_changed", callable_mp(this, &ScriptTextEditor::_picker_color_changed));
+	inline_color_popup->add_child(inline_color_picker);
+
 	connection_info_dialog = memnew(ConnectionInfoDialog);
 
 	SET_DRAG_FORWARDING_GCD(code_editor->get_text_editor(), ScriptTextEditor);

editor/plugins/script_text_editor.h

@@ -84,6 +84,13 @@ class ScriptTextEditor : public ScriptEditorBase {
 	PopupMenu *highlighter_menu = nullptr;
 	PopupMenu *context_menu = nullptr;
 
+	int inline_color_line = -1;
+	int inline_color_start = -1;
+	int inline_color_end = -1;
+	PopupPanel *inline_color_popup = nullptr;
+	ColorPicker *inline_color_picker = nullptr;
+	bool previous_tooltip_enabled = true;
+
 	GotoLinePopup *goto_line_popup = nullptr;
 	ScriptEditorQuickOpen *quick_open = nullptr;
 	ConnectionInfoDialog *connection_info_dialog = nullptr;
@@ -160,6 +167,13 @@ class ScriptTextEditor : public ScriptEditorBase {
 		EDIT_EMOJI_AND_SYMBOL,
 	};
 
+	enum ColorInfo {
+		INFO_COLOR = TextEdit::INFO_MAX,
+		INFO_COLOR_MODE,
+		INFO_COLOR_END,
+		INFO_COLOR_MAX
+	};
+
 	void _enable_code_editor();
 
 protected:
@@ -185,6 +199,15 @@ class ScriptTextEditor : public ScriptEditorBase {
 	void _error_clicked(const Variant &p_line);
 	void _warning_clicked(const Variant &p_line);
 
+	bool _is_valid_color_info(const Array &p_info);
+	Array _inline_object_parse(const String &p_text, int p_line);
+	void _inline_object_draw(const Array &p_info, const Rect2 &p_rect);
+	void _inline_object_handle_click(const Array &p_info, const Rect2 &p_rect);
+	String _picker_color_stringify(const Color &p_color, int p_mode);
+	void _picker_color_changed(const Color &p_color);
+	void _picker_opening();
+	void _picker_closed();
+
 	void _notification(int p_what);
 
 	HashMap<String, Ref<EditorSyntaxHighlighter>> highlighters;

modules/text_server_adv/text_server_adv.cpp

@@ -5196,7 +5196,8 @@ bool TextServerAdvanced::_shape_substr(ShapedTextDataAdvanced *p_new_sd, const S
 				int32_t bidi_run_end = _convert_pos(p_sd, ov_start + start + _bidi_run_start + _bidi_run_length);
 
 				for (int j = 0; j < sd_size; j++) {
-					if ((sd_glyphs[j].start >= bidi_run_start) && (sd_glyphs[j].end <= bidi_run_end)) {
+					int col_key_off = (sd_glyphs[j].start == sd_glyphs[j].end) ? 1 : 0;
+					if ((sd_glyphs[j].start >= bidi_run_start) && (sd_glyphs[j].end <= bidi_run_end - col_key_off)) {
 						// Copy glyphs.
 						Glyph gl = sd_glyphs[j];
 						if (gl.span_index >= 0) {
@@ -5986,7 +5987,11 @@ bool TextServerAdvanced::_shaped_text_update_breaks(const RID &p_shaped) {
 		while (i < span_size) {
 			String language = sd->spans[i].language;
 			int r_start = sd->spans[i].start;
-			while (i + 1 < span_size && language == sd->spans[i + 1].language) {
+			if (r_start == sd->spans[i].end) {
+				i++;
+				continue;
+			}
+			while (i + 1 < span_size && (language == sd->spans[i + 1].language || sd->spans[i + 1].start == sd->spans[i + 1].end)) {
 				i++;
 			}
 			int r_end = sd->spans[i].end;
@@ -6114,6 +6119,11 @@ bool TextServerAdvanced::_shaped_text_update_breaks(const RID &p_shaped) {
 							continue;
 						}
 					}
+					// Do not add extra space for color picker object.
+					if (((sd_glyphs[i].flags & GRAPHEME_IS_EMBEDDED_OBJECT) == GRAPHEME_IS_EMBEDDED_OBJECT && sd_glyphs[i].start == sd_glyphs[i].end) || (i + 1 < sd->glyphs.size() && (sd_glyphs[i + 1].flags & GRAPHEME_IS_EMBEDDED_OBJECT) == GRAPHEME_IS_EMBEDDED_OBJECT && sd_glyphs[i + 1].start == sd_glyphs[i + 1].end)) {
+						i += (sd_glyphs[i].count - 1);
+						continue;
+					}
 					Glyph gl;
 					gl.span_index = sd_glyphs[i].span_index;
 					gl.start = sd_glyphs[i].start;
@@ -6983,7 +6993,8 @@ bool TextServerAdvanced::_shaped_text_shape(const RID &p_shaped) {
 
 					for (int k = spn_from; k != spn_to; k += spn_delta) {
 						const ShapedTextDataAdvanced::Span &span = sd->spans[k];
-						if (span.start - sd->start >= script_run_end || span.end - sd->start <= script_run_start) {
+						int col_key_off = (span.start == span.end) ? 1 : 0;
+						if (span.start - sd->start >= script_run_end || span.end - sd->start <= script_run_start - col_key_off) {
 							continue;
 						}
 						if (span.embedded_key != Variant()) {

scene/gui/color_picker.cpp

@@ -452,6 +452,16 @@ bool ColorPicker::is_editing_alpha() const {
 	return edit_alpha;
 }
 
+void ColorPicker::set_using_hex_string(bool p_using_hex_string) {
+	if (p_using_hex_string == text_is_constructor) {
+		_text_type_toggled();
+	}
+}
+
+bool ColorPicker::is_using_hex_string() {
+	return !text_is_constructor;
+}
+
 void ColorPicker::_slider_drag_started() {
 	currently_dragging = true;
 }

scene/gui/color_picker.h

@@ -368,6 +368,9 @@ class ColorPicker : public VBoxContainer {
 	void set_edit_alpha(bool p_show);
 	bool is_editing_alpha() const;
 
+	void set_using_hex_string(bool p_using_hex_string);
+	bool is_using_hex_string();
+
 	void _set_pick_color(const Color &p_color, bool p_update_sliders);
 	void set_pick_color(const Color &p_color);
 	Color get_pick_color() const;