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,234 @@ bool ScriptTextEditor::show_members_overview() {
 	return true;
 }
 
+bool ScriptTextEditor::_is_valid_color_info(const Dictionary &p_info) {
+	if (p_info.get_valid("color").get_type() != Variant::COLOR) {
+		return false;
+	}
+	if (!p_info.get_valid("color_end").is_num() || !p_info.get_valid("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) {
+		// Ignore words that just have "Color" in them.
+		if (i_start == 0 || !("_" + p_text.substr(i_start - 1, 1)).is_valid_ascii_identifier()) {
+			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) {
+					Dictionary color_info;
+					color_info["line"] = p_line;
+					color_info["column"] = i_start;
+					color_info["width_ratio"] = 1.0;
+					color_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()) {
+						String stripped = s_params.strip_edges(true, true);
+						// String constructor.
+						if (stripped.length() > 0 && (stripped[0] == '\"')) {
+							String color_string = stripped.substr(1, stripped.length() - 2);
+							color_info["color"] = Color(color_string);
+							color_info["color_mode"] = MODE_STRING;
+							has_added_color = true;
+						}
+						// Hex constructor.
+						else if (stripped.length() == 10 && stripped.substr(0, 2) == "0x") {
+							color_info["color"] = Color(stripped.substr(2, stripped.length() - 2));
+							color_info["color_mode"] = MODE_HEX;
+							has_added_color = true;
+						}
+						// Empty Color() constructor.
+						else if (stripped.is_empty()) {
+							color_info["color"] = Color();
+							color_info["color_mode"] = MODE_RGB;
+							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["color"] = Color::from_ok_hsl(params[0], params[1], params[2], params[3]);
+								color_info["color_mode"] = MODE_OKHSL;
+							} else if (fn_name == ".from_hsv") {
+								color_info["color"] = Color::from_hsv(params[0], params[1], params[2], params[3]);
+								color_info["color_mode"] = MODE_HSV;
+							} else if (fn_name == ".from_rgba8") {
+								color_info["color"] = Color::from_rgba8(int(params[0]), int(params[1]), int(params[2]), int(params[3]));
+								color_info["color_mode"] = MODE_RGB8;
+							} else if (fn_name.is_empty()) {
+								color_info["color"] = Color(params[0], params[1], params[2], params[3]);
+								color_info["color_mode"] = MODE_RGB;
+							} 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 Dictionary &p_info, const Rect2 &p_rect) {
+	if (_is_valid_color_info(p_info)) {
+		Rect2 col_rect = p_rect.grow(-4);
+		if (color_alpha_texture.is_null()) {
+			color_alpha_texture = inline_color_picker->get_theme_icon("sample_bg", "ColorPicker");
+		}
+		code_editor->get_text_editor()->draw_texture_rect(color_alpha_texture, col_rect, false);
+		code_editor->get_text_editor()->draw_rect(col_rect, Color(p_info["color"]));
+		code_editor->get_text_editor()->draw_rect(col_rect, Color(1, 1, 1), false, 1);
+	}
+}
+
+void ScriptTextEditor::_inline_object_handle_click(const Dictionary &p_info, const Rect2 &p_rect) {
+	if (_is_valid_color_info(p_info)) {
+		inline_color_picker->set_pick_color(p_info["color"]);
+		inline_color_line = p_info["line"];
+		inline_color_start = p_info["column"];
+		inline_color_end = p_info["color_end"];
+
+		// Reset tooltip hover timer.
+		code_editor->get_text_editor()->set_symbol_tooltip_on_hover_enabled(false);
+		code_editor->get_text_editor()->set_symbol_tooltip_on_hover_enabled(true);
+
+		_update_color_constructor_options();
+		inline_color_options->select(p_info["color_mode"]);
+
+		// 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));
+	}
+}
+
+String ScriptTextEditor::_picker_color_stringify(const Color &p_color, COLOR_MODE p_mode) {
+	String result;
+	String fname;
+	Vector<String> str_params;
+	switch (p_mode) {
+		case ScriptTextEditor::MODE_STRING: {
+			str_params.push_back("\"" + p_color.to_html() + "\"");
+		} break;
+		case ScriptTextEditor::MODE_HEX: {
+			str_params.push_back("0x" + p_color.to_html());
+		} break;
+		case ScriptTextEditor::MODE_RGB: {
+			str_params = {
+				String::num(p_color.r, 3),
+				String::num(p_color.g, 3),
+				String::num(p_color.b, 3),
+				String::num(p_color.a, 3)
+			};
+		} break;
+		case ScriptTextEditor::MODE_HSV: {
+			str_params = {
+				String::num(p_color.get_h(), 3),
+				String::num(p_color.get_s(), 3),
+				String::num(p_color.get_v(), 3),
+				String::num(p_color.a, 3)
+			};
+			fname = ".from_hsv";
+		} break;
+		case ScriptTextEditor::MODE_OKHSL: {
+			str_params = {
+				String::num(p_color.get_ok_hsl_h(), 3),
+				String::num(p_color.get_ok_hsl_s(), 3),
+				String::num(p_color.get_ok_hsl_l(), 3),
+				String::num(p_color.a, 3)
+			};
+			fname = ".from_ok_hsl";
+		} break;
+		case ScriptTextEditor::MODE_RGB8: {
+			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";
+		} break;
+	}
+	result = "Color" + fname + "(" + String(", ").join(str_params) + ")";
+	return result;
+}
+
+void ScriptTextEditor::_picker_color_changed(const Color &p_color) {
+	_update_color_constructor_options();
+	_update_color_text();
+}
+
+void ScriptTextEditor::_update_color_constructor_options() {
+	int item_count = inline_color_options->get_item_count();
+	// Update or add each constructor as an option.
+	for (int i = 0; i < MODE_MAX; i++) {
+		String option_text = _picker_color_stringify(inline_color_picker->get_pick_color(), (COLOR_MODE)i);
+		if (i >= item_count) {
+			inline_color_options->add_item(option_text);
+		} else {
+			inline_color_options->set_item_text(i, option_text);
+		}
+	}
+}
+
+void ScriptTextEditor::_update_color_text() {
+	if (inline_color_line < 0) {
+		return;
+	}
+	String result = inline_color_options->get_item_text(inline_color_options->get_selected_id());
+	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::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 +2820,23 @@ ScriptTextEditor::ScriptTextEditor() {
 	bookmarks_menu = memnew(PopupMenu);
 	breakpoints_menu = memnew(PopupMenu);
 
+	inline_color_popup = memnew(PopupPanel);
+	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->set_hex_visible(false);
+	inline_color_picker->connect("color_changed", callable_mp(this, &ScriptTextEditor::_picker_color_changed));
+	inline_color_popup->add_child(inline_color_picker);
+
+	inline_color_options = memnew(OptionButton);
+	inline_color_options->set_h_size_flags(SIZE_FILL);
+	inline_color_options->set_text_overrun_behavior(TextServer::OVERRUN_TRIM_ELLIPSIS);
+	inline_color_options->set_fit_to_longest_item(false);
+	inline_color_options->connect("item_selected", callable_mp(this, &ScriptTextEditor::_update_color_text).unbind(1));
+	inline_color_picker->get_slider(ColorPicker::SLIDER_COUNT)->get_parent()->add_sibling(inline_color_options);
+
 	connection_info_dialog = memnew(ConnectionInfoDialog);
 
 	SET_DRAG_FORWARDING_GCD(code_editor->get_text_editor(), ScriptTextEditor);

editor/plugins/script_text_editor.h

@@ -35,6 +35,7 @@
 #include "editor/code_editor.h"
 #include "scene/gui/color_picker.h"
 #include "scene/gui/dialogs.h"
+#include "scene/gui/option_button.h"
 #include "scene/gui/tree.h"
 
 class RichTextLabel;
@@ -84,6 +85,14 @@ 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;
+	OptionButton *inline_color_options = nullptr;
+	Ref<Texture2D> color_alpha_texture;
+
 	GotoLinePopup *goto_line_popup = nullptr;
 	ScriptEditorQuickOpen *quick_open = nullptr;
 	ConnectionInfoDialog *connection_info_dialog = nullptr;
@@ -160,6 +169,16 @@ class ScriptTextEditor : public ScriptEditorBase {
 		EDIT_EMOJI_AND_SYMBOL,
 	};
 
+	enum COLOR_MODE {
+		MODE_STRING,
+		MODE_HEX,
+		MODE_RGB,
+		MODE_HSV,
+		MODE_OKHSL,
+		MODE_RGB8,
+		MODE_MAX
+	};
+
 	void _enable_code_editor();
 
 protected:
@@ -185,6 +204,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 Dictionary &p_info);
+	Array _inline_object_parse(const String &p_text, int p_line);
+	void _inline_object_draw(const Dictionary &p_info, const Rect2 &p_rect);
+	void _inline_object_handle_click(const Dictionary &p_info, const Rect2 &p_rect);
+	String _picker_color_stringify(const Color &p_color, COLOR_MODE p_mode);
+	void _picker_color_changed(const Color &p_color);
+	void _update_color_constructor_options();
+	void _update_color_text();
+
 	void _notification(int p_what);
 
 	HashMap<String, Ref<EditorSyntaxHighlighter>> highlighters;

modules/text_server_adv/text_server_adv.cpp

@@ -5204,7 +5204,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) {
@@ -5994,7 +5995,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;
@@ -6122,6 +6127,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;
@@ -6991,7 +7001,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

@@ -572,7 +572,6 @@ void ColorPicker::set_quick_open_callback(const Callable &p_file_selected) {
 void ColorPicker::set_palette_saved_callback(const Callable &p_palette_saved) {
 	palette_saved_callback = p_palette_saved;
 }
-
 #endif
 
 HSlider *ColorPicker::get_slider(int p_idx) {