Merge pull request #28234 from Paulb23/connection_info_on_script

Display connection information in the script editor
This commit is contained in:
Rémi Verschelde 2019-04-22 11:52:13 +02:00 committed by GitHub
commit 22457b907e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 335 additions and 16 deletions

View file

@ -768,6 +768,7 @@ void CodeTextEditor::update_editor_settings() {
text_editor->set_hiding_enabled(EditorSettings::get_singleton()->get("text_editor/line_numbers/code_folding")); text_editor->set_hiding_enabled(EditorSettings::get_singleton()->get("text_editor/line_numbers/code_folding"));
text_editor->set_draw_fold_gutter(EditorSettings::get_singleton()->get("text_editor/line_numbers/code_folding")); text_editor->set_draw_fold_gutter(EditorSettings::get_singleton()->get("text_editor/line_numbers/code_folding"));
text_editor->set_wrap_enabled(EditorSettings::get_singleton()->get("text_editor/line_numbers/word_wrap")); text_editor->set_wrap_enabled(EditorSettings::get_singleton()->get("text_editor/line_numbers/word_wrap"));
text_editor->set_draw_info_gutter(EditorSettings::get_singleton()->get("text_editor/line_numbers/show_info_gutter"));
text_editor->cursor_set_block_mode(EditorSettings::get_singleton()->get("text_editor/cursor/block_caret")); text_editor->cursor_set_block_mode(EditorSettings::get_singleton()->get("text_editor/cursor/block_caret"));
text_editor->set_smooth_scroll_enabled(EditorSettings::get_singleton()->get("text_editor/open_scripts/smooth_scrolling")); text_editor->set_smooth_scroll_enabled(EditorSettings::get_singleton()->get("text_editor/open_scripts/smooth_scrolling"));
text_editor->set_v_scroll_speed(EditorSettings::get_singleton()->get("text_editor/open_scripts/v_scroll_speed")); text_editor->set_v_scroll_speed(EditorSettings::get_singleton()->get("text_editor/open_scripts/v_scroll_speed"));

View file

@ -429,6 +429,7 @@ void EditorSettings::_load_defaults(Ref<ConfigFile> p_extra_config) {
_initial_set("text_editor/line_numbers/show_line_numbers", true); _initial_set("text_editor/line_numbers/show_line_numbers", true);
_initial_set("text_editor/line_numbers/line_numbers_zero_padded", false); _initial_set("text_editor/line_numbers/line_numbers_zero_padded", false);
_initial_set("text_editor/line_numbers/show_breakpoint_gutter", true); _initial_set("text_editor/line_numbers/show_breakpoint_gutter", true);
_initial_set("text_editor/line_numbers/show_info_gutter", true);
_initial_set("text_editor/line_numbers/code_folding", true); _initial_set("text_editor/line_numbers/code_folding", true);
_initial_set("text_editor/line_numbers/word_wrap", false); _initial_set("text_editor/line_numbers/word_wrap", false);
_initial_set("text_editor/line_numbers/show_line_length_guideline", false); _initial_set("text_editor/line_numbers/show_line_length_guideline", false);

View file

@ -1801,6 +1801,16 @@ void ScriptEditor::_update_script_names() {
_update_script_colors(); _update_script_colors();
} }
void ScriptEditor::_update_script_connections() {
for (int i = 0; i < tab_container->get_child_count(); i++) {
ScriptTextEditor *ste = Object::cast_to<ScriptTextEditor>(tab_container->get_child(i));
if (!ste) {
continue;
}
ste->_update_connected_methods();
}
}
Ref<TextFile> ScriptEditor::_load_text_file(const String &p_path, Error *r_error) { Ref<TextFile> ScriptEditor::_load_text_file(const String &p_path, Error *r_error) {
if (r_error) { if (r_error) {
*r_error = ERR_FILE_CANT_OPEN; *r_error = ERR_FILE_CANT_OPEN;
@ -2203,6 +2213,7 @@ void ScriptEditor::_tree_changed() {
waiting_update_names = true; waiting_update_names = true;
call_deferred("_update_script_names"); call_deferred("_update_script_names");
call_deferred("_update_script_connections");
} }
void ScriptEditor::_script_split_dragged(float) { void ScriptEditor::_script_split_dragged(float) {
@ -2871,6 +2882,7 @@ void ScriptEditor::_bind_methods() {
ClassDB::bind_method("_autosave_scripts", &ScriptEditor::_autosave_scripts); ClassDB::bind_method("_autosave_scripts", &ScriptEditor::_autosave_scripts);
ClassDB::bind_method("_editor_settings_changed", &ScriptEditor::_editor_settings_changed); ClassDB::bind_method("_editor_settings_changed", &ScriptEditor::_editor_settings_changed);
ClassDB::bind_method("_update_script_names", &ScriptEditor::_update_script_names); ClassDB::bind_method("_update_script_names", &ScriptEditor::_update_script_names);
ClassDB::bind_method("_update_script_connections", &ScriptEditor::_update_script_connections);
ClassDB::bind_method("_tree_changed", &ScriptEditor::_tree_changed); ClassDB::bind_method("_tree_changed", &ScriptEditor::_tree_changed);
ClassDB::bind_method("_members_overview_selected", &ScriptEditor::_members_overview_selected); ClassDB::bind_method("_members_overview_selected", &ScriptEditor::_members_overview_selected);
ClassDB::bind_method("_help_overview_selected", &ScriptEditor::_help_overview_selected); ClassDB::bind_method("_help_overview_selected", &ScriptEditor::_help_overview_selected);

View file

@ -333,6 +333,7 @@ class ScriptEditor : public PanelContainer {
void _update_members_overview(); void _update_members_overview();
void _toggle_members_overview_alpha_sort(bool p_alphabetic_sort); void _toggle_members_overview_alpha_sort(bool p_alphabetic_sort);
void _update_script_names(); void _update_script_names();
void _update_script_connections();
bool _sort_list_on_update; bool _sort_list_on_update;
void _members_overview_selected(int p_idx); void _members_overview_selected(int p_idx);

View file

@ -35,6 +35,78 @@
#include "editor/editor_settings.h" #include "editor/editor_settings.h"
#include "editor/script_editor_debugger.h" #include "editor/script_editor_debugger.h"
void ConnectionInfoDialog::ok_pressed() {
}
void ConnectionInfoDialog::popup_connections(String p_method, Vector<Node *> p_nodes) {
method->set_text(p_method);
tree->clear();
TreeItem *root = tree->create_item();
for (int i = 0; i < p_nodes.size(); i++) {
List<Connection> all_connections;
p_nodes[i]->get_signals_connected_to_this(&all_connections);
for (List<Connection>::Element *E = all_connections.front(); E; E = E->next()) {
Connection connection = E->get();
if (connection.method != p_method) {
continue;
}
TreeItem *node_item = tree->create_item(root);
node_item->set_text(0, Object::cast_to<Node>(connection.source)->get_name());
node_item->set_icon(0, EditorNode::get_singleton()->get_object_icon(connection.source, "Node"));
node_item->set_selectable(0, false);
node_item->set_editable(0, false);
node_item->set_text(1, connection.signal);
node_item->set_icon(1, get_parent_control()->get_icon("Slot", "EditorIcons"));
node_item->set_selectable(1, false);
node_item->set_editable(1, false);
node_item->set_text(2, Object::cast_to<Node>(connection.target)->get_name());
node_item->set_icon(2, EditorNode::get_singleton()->get_object_icon(connection.target, "Node"));
node_item->set_selectable(2, false);
node_item->set_editable(2, false);
}
}
popup_centered(Size2(400, 300) * EDSCALE);
}
ConnectionInfoDialog::ConnectionInfoDialog() {
set_title(TTR("Connections to method:"));
set_resizable(true);
VBoxContainer *vbc = memnew(VBoxContainer);
vbc->set_anchor_and_margin(MARGIN_LEFT, ANCHOR_BEGIN, 8 * EDSCALE);
vbc->set_anchor_and_margin(MARGIN_TOP, ANCHOR_BEGIN, 8 * EDSCALE);
vbc->set_anchor_and_margin(MARGIN_RIGHT, ANCHOR_END, -8 * EDSCALE);
vbc->set_anchor_and_margin(MARGIN_BOTTOM, ANCHOR_END, -8 * EDSCALE);
add_child(vbc);
method = memnew(Label);
method->set_text("");
method->set_align(Label::ALIGN_CENTER);
vbc->add_child(method);
tree = memnew(Tree);
tree->set_columns(3);
tree->set_hide_root(true);
tree->set_column_titles_visible(true);
tree->set_column_title(0, TTR("Source"));
tree->set_column_title(1, TTR("Signal"));
tree->set_column_title(2, TTR("Target"));
vbc->add_child(tree);
tree->set_v_size_flags(SIZE_EXPAND_FILL);
tree->set_allow_rmb_select(true);
}
////////////////////////////////////////////////////////////////////////////////
Vector<String> ScriptTextEditor::get_functions() { Vector<String> ScriptTextEditor::get_functions() {
String errortxt; String errortxt;
@ -470,9 +542,32 @@ void ScriptTextEditor::_validate_script() {
functions.push_back(E->get()); functions.push_back(E->get());
} }
} }
_update_connected_methods();
code_editor->set_warning_nb(warnings.size()); code_editor->set_warning_nb(missing_connections.size() + warnings.size());
warnings_panel->clear(); warnings_panel->clear();
// add missing connections
Node *base = get_tree()->get_edited_scene_root();
if (base && missing_connections.size() > 0) {
warnings_panel->push_table(1);
for (List<Connection>::Element *E = missing_connections.front(); E; E = E->next()) {
Connection connection = E->get();
String base_path = base->get_name();
String source_path = base == connection.source ? base_path : base_path + "/" + String(base->get_path_to(Object::cast_to<Node>(connection.source)));
String target_path = base == connection.target ? base_path : base_path + "/" + String(base->get_path_to(Object::cast_to<Node>(connection.target)));
warnings_panel->push_cell();
warnings_panel->push_color(warnings_panel->get_color("warning_color", "Editor"));
warnings_panel->add_text(vformat(TTR("Missing connected method '%s' for signal '%s' from node '%s' to node '%s'"), connection.method, connection.signal, source_path, target_path));
warnings_panel->pop(); // Color
warnings_panel->pop(); // Cell
}
warnings_panel->pop(); // Table
}
// add script warnings
warnings_panel->push_table(3); warnings_panel->push_table(3);
for (List<ScriptLanguage::Warning>::Element *E = warnings.front(); E; E = E->next()) { for (List<ScriptLanguage::Warning>::Element *E = warnings.front(); E; E = E->next()) {
ScriptLanguage::Warning w = E->get(); ScriptLanguage::Warning w = E->get();
@ -526,6 +621,27 @@ void ScriptTextEditor::_validate_script() {
emit_signal("edited_script_changed"); emit_signal("edited_script_changed");
} }
static Vector<Node *> _find_all_node_for_script(Node *p_base, Node *p_current, const Ref<Script> &p_script) {
Vector<Node *> nodes;
if (p_current->get_owner() != p_base && p_base != p_current) {
return nodes;
}
Ref<Script> c = p_current->get_script();
if (c == p_script) {
nodes.push_back(p_current);
}
for (int i = 0; i < p_current->get_child_count(); i++) {
Vector<Node *> found = _find_all_node_for_script(p_base, p_current->get_child(i), p_script);
nodes.append_array(found);
}
return nodes;
}
static Node *_find_node_for_script(Node *p_base, Node *p_current, const Ref<Script> &p_script) { static Node *_find_node_for_script(Node *p_base, Node *p_current, const Ref<Script> &p_script) {
if (p_current->get_owner() != p_base && p_base != p_current) if (p_current->get_owner() != p_base && p_base != p_current)
@ -721,6 +837,47 @@ void ScriptTextEditor::_lookup_symbol(const String &p_symbol, int p_row, int p_c
} }
} }
void ScriptTextEditor::_update_connected_methods() {
TextEdit *text_edit = code_editor->get_text_edit();
text_edit->clear_info_icons();
missing_connections.clear();
Node *base = get_tree()->get_edited_scene_root();
if (!base) {
return;
}
Vector<Node *> nodes = _find_all_node_for_script(base, base, script);
for (int i = 0; i < nodes.size(); i++) {
List<Connection> connections;
nodes[i]->get_signals_connected_to_this(&connections);
for (List<Connection>::Element *E = connections.front(); E; E = E->next()) {
Connection connection = E->get();
if (!(connection.flags & CONNECT_PERSIST)) {
continue;
}
int line = script->get_language()->find_function(connection.method, text_edit->get_text());
if (line < 0) {
missing_connections.push_back(connection);
continue;
}
text_edit->set_line_info_icon(line - 1, get_parent_control()->get_icon("Slot", "EditorIcons"), connection.method);
}
}
}
void ScriptTextEditor::_lookup_connections(int p_row, String p_method) {
Node *base = get_tree()->get_edited_scene_root();
if (!base) {
return;
}
Vector<Node *> nodes = _find_all_node_for_script(base, base, script);
connection_info_dialog->popup_connections(p_method, nodes);
}
void ScriptTextEditor::_edit_option(int p_op) { void ScriptTextEditor::_edit_option(int p_op) {
TextEdit *tx = code_editor->get_text_edit(); TextEdit *tx = code_editor->get_text_edit();
@ -1040,6 +1197,8 @@ void ScriptTextEditor::_bind_methods() {
ClassDB::bind_method("_validate_script", &ScriptTextEditor::_validate_script); ClassDB::bind_method("_validate_script", &ScriptTextEditor::_validate_script);
ClassDB::bind_method("_load_theme_settings", &ScriptTextEditor::_load_theme_settings); ClassDB::bind_method("_load_theme_settings", &ScriptTextEditor::_load_theme_settings);
ClassDB::bind_method("_breakpoint_toggled", &ScriptTextEditor::_breakpoint_toggled); ClassDB::bind_method("_breakpoint_toggled", &ScriptTextEditor::_breakpoint_toggled);
ClassDB::bind_method("_lookup_connections", &ScriptTextEditor::_lookup_connections);
ClassDB::bind_method("_update_connected_methods", &ScriptTextEditor::_update_connected_methods);
ClassDB::bind_method("_change_syntax_highlighter", &ScriptTextEditor::_change_syntax_highlighter); ClassDB::bind_method("_change_syntax_highlighter", &ScriptTextEditor::_change_syntax_highlighter);
ClassDB::bind_method("_edit_option", &ScriptTextEditor::_edit_option); ClassDB::bind_method("_edit_option", &ScriptTextEditor::_edit_option);
ClassDB::bind_method("_goto_line", &ScriptTextEditor::_goto_line); ClassDB::bind_method("_goto_line", &ScriptTextEditor::_goto_line);
@ -1372,6 +1531,7 @@ ScriptTextEditor::ScriptTextEditor() {
code_editor->set_code_complete_func(_code_complete_scripts, this); code_editor->set_code_complete_func(_code_complete_scripts, this);
code_editor->get_text_edit()->connect("breakpoint_toggled", this, "_breakpoint_toggled"); code_editor->get_text_edit()->connect("breakpoint_toggled", this, "_breakpoint_toggled");
code_editor->get_text_edit()->connect("symbol_lookup", this, "_lookup_symbol"); code_editor->get_text_edit()->connect("symbol_lookup", this, "_lookup_symbol");
code_editor->get_text_edit()->connect("info_clicked", this, "_lookup_connections");
code_editor->set_v_size_flags(SIZE_EXPAND_FILL); code_editor->set_v_size_flags(SIZE_EXPAND_FILL);
warnings_panel = memnew(RichTextLabel); warnings_panel = memnew(RichTextLabel);
@ -1492,6 +1652,9 @@ ScriptTextEditor::ScriptTextEditor() {
goto_line_dialog = memnew(GotoLineDialog); goto_line_dialog = memnew(GotoLineDialog);
add_child(goto_line_dialog); add_child(goto_line_dialog);
connection_info_dialog = memnew(ConnectionInfoDialog);
add_child(connection_info_dialog);
code_editor->get_text_edit()->set_drag_forwarding(this); code_editor->get_text_edit()->set_drag_forwarding(this);
} }

View file

@ -32,8 +32,25 @@
#define SCRIPT_TEXT_EDITOR_H #define SCRIPT_TEXT_EDITOR_H
#include "scene/gui/color_picker.h" #include "scene/gui/color_picker.h"
#include "scene/gui/dialogs.h"
#include "scene/gui/tree.h"
#include "script_editor_plugin.h" #include "script_editor_plugin.h"
class ConnectionInfoDialog : public AcceptDialog {
GDCLASS(ConnectionInfoDialog, AcceptDialog);
Label *method;
Tree *tree;
virtual void ok_pressed();
public:
void popup_connections(String p_method, Vector<Node *> p_nodes);
ConnectionInfoDialog();
};
class ScriptTextEditor : public ScriptEditorBase { class ScriptTextEditor : public ScriptEditorBase {
GDCLASS(ScriptTextEditor, ScriptEditorBase); GDCLASS(ScriptTextEditor, ScriptEditorBase);
@ -45,6 +62,8 @@ class ScriptTextEditor : public ScriptEditorBase {
Vector<String> functions; Vector<String> functions;
List<Connection> missing_connections;
Vector<String> member_keywords; Vector<String> member_keywords;
HBoxContainer *edit_hb; HBoxContainer *edit_hb;
@ -56,6 +75,7 @@ class ScriptTextEditor : public ScriptEditorBase {
GotoLineDialog *goto_line_dialog; GotoLineDialog *goto_line_dialog;
ScriptEditorQuickOpen *quick_open; ScriptEditorQuickOpen *quick_open;
ConnectionInfoDialog *connection_info_dialog;
PopupPanel *color_panel; PopupPanel *color_panel;
ColorPicker *color_picker; ColorPicker *color_picker;
@ -144,6 +164,8 @@ protected:
void _goto_line(int p_line) { goto_line(p_line); } void _goto_line(int p_line) { goto_line(p_line); }
void _lookup_symbol(const String &p_symbol, int p_row, int p_column); void _lookup_symbol(const String &p_symbol, int p_row, int p_column);
void _lookup_connections(int p_row, String p_method);
void _convert_case(CodeTextEditor::CaseStyle p_case); void _convert_case(CodeTextEditor::CaseStyle p_case);
Variant get_drag_data_fw(const Point2 &p_point, Control *p_from); Variant get_drag_data_fw(const Point2 &p_point, Control *p_from);
@ -151,6 +173,8 @@ protected:
void drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from); void drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_from);
public: public:
void _update_connected_methods();
virtual void add_syntax_highlighter(SyntaxHighlighter *p_highlighter); virtual void add_syntax_highlighter(SyntaxHighlighter *p_highlighter);
virtual void set_syntax_highlighter(SyntaxHighlighter *p_highlighter); virtual void set_syntax_highlighter(SyntaxHighlighter *p_highlighter);

View file

@ -350,6 +350,10 @@ void TextEdit::_update_scrollbars() {
total_width += cache.breakpoint_gutter_width; total_width += cache.breakpoint_gutter_width;
} }
if (draw_info_gutter) {
total_width += cache.info_gutter_width;
}
if (draw_fold_gutter) { if (draw_fold_gutter) {
total_width += cache.fold_gutter_width; total_width += cache.fold_gutter_width;
} }
@ -608,6 +612,13 @@ void TextEdit::_notification(int p_what) {
cache.breakpoint_gutter_width = 0; cache.breakpoint_gutter_width = 0;
} }
if (draw_info_gutter) {
info_gutter_width = (get_row_height());
cache.info_gutter_width = info_gutter_width;
} else {
cache.info_gutter_width = 0;
}
if (draw_fold_gutter) { if (draw_fold_gutter) {
fold_gutter_width = (get_row_height() * 55) / 100; fold_gutter_width = (get_row_height() * 55) / 100;
cache.fold_gutter_width = fold_gutter_width; cache.fold_gutter_width = fold_gutter_width;
@ -637,7 +648,7 @@ void TextEdit::_notification(int p_what) {
RID ci = get_canvas_item(); RID ci = get_canvas_item();
VisualServer::get_singleton()->canvas_item_set_clip(get_canvas_item(), true); VisualServer::get_singleton()->canvas_item_set_clip(get_canvas_item(), true);
int xmargin_beg = cache.style_normal->get_margin(MARGIN_LEFT) + cache.line_number_w + cache.breakpoint_gutter_width + cache.fold_gutter_width; int xmargin_beg = cache.style_normal->get_margin(MARGIN_LEFT) + cache.line_number_w + cache.breakpoint_gutter_width + cache.fold_gutter_width + cache.info_gutter_width;
int xmargin_end = size.width - cache.style_normal->get_margin(MARGIN_RIGHT); int xmargin_end = size.width - cache.style_normal->get_margin(MARGIN_RIGHT);
//let's do it easy for now: //let's do it easy for now:
cache.style_normal->draw(ci, Rect2(Point2(), size)); cache.style_normal->draw(ci, Rect2(Point2(), size));
@ -952,10 +963,34 @@ void TextEdit::_notification(int p_what) {
} }
} }
// draw info icons
if (draw_info_gutter && text.has_info_icon(line)) {
int horizontal_gap = (cache.info_gutter_width * 30) / 100;
int gutter_left = cache.style_normal->get_margin(MARGIN_LEFT) + cache.breakpoint_gutter_width;
Ref<Texture> info_icon = text.get_info_icon(line);
// ensure the icon fits the gutter size
Size2i icon_size = info_icon->get_size();
if (icon_size.width > cache.info_gutter_width - horizontal_gap) {
icon_size.width = cache.info_gutter_width - horizontal_gap;
}
if (icon_size.height > get_row_height() - horizontal_gap) {
icon_size.height = get_row_height() - horizontal_gap;
}
Size2i icon_pos;
int xofs = horizontal_gap - (info_icon->get_width()) / 2;
int yofs = (get_row_height() - info_icon->get_height()) / 2;
icon_pos.x = gutter_left + xofs + ofs_x;
icon_pos.y = ofs_y + yofs;
draw_texture_rect(info_icon, Rect2(icon_pos, icon_size));
}
// draw fold markers // draw fold markers
if (draw_fold_gutter) { if (draw_fold_gutter) {
int horizontal_gap = (cache.fold_gutter_width * 30) / 100; int horizontal_gap = (cache.fold_gutter_width * 30) / 100;
int gutter_left = cache.style_normal->get_margin(MARGIN_LEFT) + cache.breakpoint_gutter_width + cache.line_number_w; int gutter_left = cache.style_normal->get_margin(MARGIN_LEFT) + cache.breakpoint_gutter_width + cache.line_number_w + cache.info_gutter_width;
if (is_folded(line)) { if (is_folded(line)) {
int xofs = horizontal_gap - (cache.can_fold_icon->get_width()) / 2; int xofs = horizontal_gap - (cache.can_fold_icon->get_width()) / 2;
int yofs = (get_row_height() - cache.folded_icon->get_height()) / 2; int yofs = (get_row_height() - cache.folded_icon->get_height()) / 2;
@ -975,7 +1010,7 @@ void TextEdit::_notification(int p_what) {
fc = line_num_padding + fc; fc = line_num_padding + fc;
} }
cache.font->draw(ci, Point2(cache.style_normal->get_margin(MARGIN_LEFT) + cache.breakpoint_gutter_width + ofs_x, yofs + cache.font->get_ascent()), fc, text.is_safe(line) ? cache.safe_line_number_color : cache.line_number_color); cache.font->draw(ci, Point2(cache.style_normal->get_margin(MARGIN_LEFT) + cache.breakpoint_gutter_width + cache.info_gutter_width + ofs_x, yofs + cache.font->get_ascent()), fc, text.is_safe(line) ? cache.safe_line_number_color : cache.line_number_color);
} }
} }
@ -1566,6 +1601,10 @@ void TextEdit::backspace_at_cursor() {
set_line_as_breakpoint(prev_line, true); set_line_as_breakpoint(prev_line, true);
} }
if (text.has_info_icon(cursor.line)) {
set_line_info_icon(prev_line, text.get_info_icon(cursor.line), text.get_info(cursor.line));
}
if (auto_brace_completion_enabled && if (auto_brace_completion_enabled &&
cursor.column > 0 && cursor.column > 0 &&
_is_pair_left_symbol(text[cursor.line][cursor.column - 1])) { _is_pair_left_symbol(text[cursor.line][cursor.column - 1])) {
@ -1718,7 +1757,7 @@ void TextEdit::_get_mouse_pos(const Point2i &p_mouse, int &r_row, int &r_col) co
col = text[row].size(); col = text[row].size();
} else { } else {
int colx = p_mouse.x - (cache.style_normal->get_margin(MARGIN_LEFT) + cache.line_number_w + cache.breakpoint_gutter_width + cache.fold_gutter_width); int colx = p_mouse.x - (cache.style_normal->get_margin(MARGIN_LEFT) + cache.line_number_w + cache.breakpoint_gutter_width + cache.fold_gutter_width + cache.info_gutter_width);
colx += cursor.x_ofs; colx += cursor.x_ofs;
col = get_char_pos_for_line(colx, row, wrap_index); col = get_char_pos_for_line(colx, row, wrap_index);
if (is_wrap_enabled() && wrap_index < times_line_wraps(row)) { if (is_wrap_enabled() && wrap_index < times_line_wraps(row)) {
@ -1816,18 +1855,28 @@ void TextEdit::_gui_input(const Ref<InputEvent> &p_gui_input) {
// toggle breakpoint on gutter click // toggle breakpoint on gutter click
if (draw_breakpoint_gutter) { if (draw_breakpoint_gutter) {
int gutter = cache.style_normal->get_margin(MARGIN_LEFT); int gutter = cache.style_normal->get_margin(MARGIN_LEFT);
if (mb->get_position().x > gutter && mb->get_position().x <= gutter + cache.breakpoint_gutter_width + 3) { if (mb->get_position().x > gutter - 6 && mb->get_position().x <= gutter + cache.breakpoint_gutter_width - 3) {
set_line_as_breakpoint(row, !is_line_set_as_breakpoint(row)); set_line_as_breakpoint(row, !is_line_set_as_breakpoint(row));
emit_signal("breakpoint_toggled", row); emit_signal("breakpoint_toggled", row);
return; return;
} }
} }
// emit info clicked
if (draw_info_gutter && text.has_info_icon(row)) {
int left_margin = cache.style_normal->get_margin(MARGIN_LEFT);
int gutter_left = left_margin + cache.breakpoint_gutter_width;
if (mb->get_position().x > gutter_left - 6 && mb->get_position().x <= gutter_left + cache.info_gutter_width - 3) {
emit_signal("info_clicked", row, text.get_info(row));
return;
}
}
// toggle fold on gutter click if can // toggle fold on gutter click if can
if (draw_fold_gutter) { if (draw_fold_gutter) {
int left_margin = cache.style_normal->get_margin(MARGIN_LEFT); int left_margin = cache.style_normal->get_margin(MARGIN_LEFT);
int gutter_left = left_margin + cache.breakpoint_gutter_width + cache.line_number_w; int gutter_left = left_margin + cache.breakpoint_gutter_width + cache.line_number_w + cache.info_gutter_width;
if (mb->get_position().x > gutter_left - 6 && mb->get_position().x <= gutter_left + cache.fold_gutter_width - 3) { if (mb->get_position().x > gutter_left - 6 && mb->get_position().x <= gutter_left + cache.fold_gutter_width - 3) {
if (is_folded(row)) { if (is_folded(row)) {
unfold_line(row); unfold_line(row);
@ -1841,7 +1890,7 @@ void TextEdit::_gui_input(const Ref<InputEvent> &p_gui_input) {
// unfold on folded icon click // unfold on folded icon click
if (is_folded(row)) { if (is_folded(row)) {
int line_width = text.get_line_width(row); int line_width = text.get_line_width(row);
line_width += cache.style_normal->get_margin(MARGIN_LEFT) + cache.line_number_w + cache.breakpoint_gutter_width + cache.fold_gutter_width - cursor.x_ofs; line_width += cache.style_normal->get_margin(MARGIN_LEFT) + cache.line_number_w + cache.breakpoint_gutter_width + cache.info_gutter_width + cache.fold_gutter_width - cursor.x_ofs;
if (mb->get_position().x > line_width - 3 && mb->get_position().x <= line_width + cache.folded_eol_icon->get_width() + 3) { if (mb->get_position().x > line_width - 3 && mb->get_position().x <= line_width + cache.folded_eol_icon->get_width() + 3) {
unfold_line(row); unfold_line(row);
return; return;
@ -3374,8 +3423,11 @@ void TextEdit::_base_insert_text(int p_line, int p_char, const String &p_text, i
if (shift_first_line) { if (shift_first_line) {
text.set_breakpoint(p_line + 1, text.is_breakpoint(p_line)); text.set_breakpoint(p_line + 1, text.is_breakpoint(p_line));
text.set_hidden(p_line + 1, text.is_hidden(p_line)); text.set_hidden(p_line + 1, text.is_hidden(p_line));
text.set_info_icon(p_line + 1, text.get_info_icon(p_line), text.get_info(p_line));
text.set_breakpoint(p_line, false); text.set_breakpoint(p_line, false);
text.set_hidden(p_line, false); text.set_hidden(p_line, false);
text.set_info_icon(p_line, NULL, "");
} }
text.set_line_wrap_amount(p_line, -1); text.set_line_wrap_amount(p_line, -1);
@ -3628,7 +3680,7 @@ int TextEdit::get_total_visible_rows() const {
void TextEdit::_update_wrap_at() { void TextEdit::_update_wrap_at() {
wrap_at = get_size().width - cache.style_normal->get_minimum_size().width - cache.line_number_w - cache.breakpoint_gutter_width - cache.fold_gutter_width - wrap_right_offset; wrap_at = get_size().width - cache.style_normal->get_minimum_size().width - cache.line_number_w - cache.breakpoint_gutter_width - cache.fold_gutter_width - cache.info_gutter_width - wrap_right_offset;
update_cursor_wrap_offset(); update_cursor_wrap_offset();
text.clear_wrap_cache(); text.clear_wrap_cache();
@ -3662,7 +3714,7 @@ void TextEdit::adjust_viewport_to_cursor() {
set_line_as_last_visible(cur_line, cur_wrap); set_line_as_last_visible(cur_line, cur_wrap);
} }
int visible_width = get_size().width - cache.style_normal->get_minimum_size().width - cache.line_number_w - cache.breakpoint_gutter_width - cache.fold_gutter_width; int visible_width = get_size().width - cache.style_normal->get_minimum_size().width - cache.line_number_w - cache.breakpoint_gutter_width - cache.fold_gutter_width - cache.info_gutter_width;
if (v_scroll->is_visible_in_tree()) if (v_scroll->is_visible_in_tree())
visible_width -= v_scroll->get_combined_minimum_size().width; visible_width -= v_scroll->get_combined_minimum_size().width;
visible_width -= 20; // give it a little more space visible_width -= 20; // give it a little more space
@ -3693,7 +3745,7 @@ void TextEdit::center_viewport_to_cursor() {
unfold_line(cursor.line); unfold_line(cursor.line);
set_line_as_center_visible(cursor.line, get_cursor_wrap_index()); set_line_as_center_visible(cursor.line, get_cursor_wrap_index());
int visible_width = get_size().width - cache.style_normal->get_minimum_size().width - cache.line_number_w - cache.breakpoint_gutter_width - cache.fold_gutter_width; int visible_width = get_size().width - cache.style_normal->get_minimum_size().width - cache.line_number_w - cache.breakpoint_gutter_width - cache.fold_gutter_width - cache.info_gutter_width;
if (v_scroll->is_visible_in_tree()) if (v_scroll->is_visible_in_tree())
visible_width -= v_scroll->get_combined_minimum_size().width; visible_width -= v_scroll->get_combined_minimum_size().width;
visible_width -= 20; // give it a little more space visible_width -= 20; // give it a little more space
@ -4132,7 +4184,7 @@ Control::CursorShape TextEdit::get_cursor_shape(const Point2 &p_pos) const {
if (highlighted_word != String()) if (highlighted_word != String())
return CURSOR_POINTING_HAND; return CURSOR_POINTING_HAND;
int gutter = cache.style_normal->get_margin(MARGIN_LEFT) + cache.line_number_w + cache.breakpoint_gutter_width + cache.fold_gutter_width; int gutter = cache.style_normal->get_margin(MARGIN_LEFT) + cache.line_number_w + cache.breakpoint_gutter_width + cache.fold_gutter_width + cache.info_gutter_width;
if ((completion_active && completion_rect.has_point(p_pos))) { if ((completion_active && completion_rect.has_point(p_pos))) {
return CURSOR_ARROW; return CURSOR_ARROW;
} }
@ -4143,18 +4195,27 @@ Control::CursorShape TextEdit::get_cursor_shape(const Point2 &p_pos) const {
int left_margin = cache.style_normal->get_margin(MARGIN_LEFT); int left_margin = cache.style_normal->get_margin(MARGIN_LEFT);
// breakpoint icon // breakpoint icon
if (draw_breakpoint_gutter && p_pos.x > left_margin && p_pos.x <= left_margin + cache.breakpoint_gutter_width + 3) { if (draw_breakpoint_gutter && p_pos.x > left_margin - 6 && p_pos.x <= left_margin + cache.breakpoint_gutter_width - 3) {
return CURSOR_POINTING_HAND; return CURSOR_POINTING_HAND;
} }
// info icons
int gutter_left = left_margin + cache.breakpoint_gutter_width + cache.info_gutter_width;
if (draw_info_gutter && p_pos.x > left_margin + cache.breakpoint_gutter_width - 6 && p_pos.x <= gutter_left - 3) {
if (text.has_info_icon(row)) {
return CURSOR_POINTING_HAND;
}
return CURSOR_ARROW;
}
// fold icon // fold icon
int gutter_left = left_margin + cache.breakpoint_gutter_width + cache.line_number_w; if (draw_fold_gutter && p_pos.x > gutter_left + cache.line_number_w - 6 && p_pos.x <= gutter_left + cache.line_number_w + cache.fold_gutter_width - 3) {
if (draw_fold_gutter && p_pos.x > gutter_left - 6 && p_pos.x <= gutter_left + cache.fold_gutter_width - 3) {
if (is_folded(row) || can_fold(row)) if (is_folded(row) || can_fold(row))
return CURSOR_POINTING_HAND; return CURSOR_POINTING_HAND;
else else
return CURSOR_ARROW; return CURSOR_ARROW;
} }
return CURSOR_ARROW; return CURSOR_ARROW;
} else { } else {
int row, col; int row, col;
@ -4162,7 +4223,7 @@ Control::CursorShape TextEdit::get_cursor_shape(const Point2 &p_pos) const {
// eol fold icon // eol fold icon
if (is_folded(row)) { if (is_folded(row)) {
int line_width = text.get_line_width(row); int line_width = text.get_line_width(row);
line_width += cache.style_normal->get_margin(MARGIN_LEFT) + cache.line_number_w + cache.breakpoint_gutter_width + cache.fold_gutter_width - cursor.x_ofs; line_width += cache.style_normal->get_margin(MARGIN_LEFT) + cache.line_number_w + cache.breakpoint_gutter_width + cache.fold_gutter_width + cache.info_gutter_width - cursor.x_ofs;
if (p_pos.x > line_width - 3 && p_pos.x <= line_width + cache.folded_eol_icon->get_width() + 3) { if (p_pos.x > line_width - 3 && p_pos.x <= line_width + cache.folded_eol_icon->get_width() + 3) {
return CURSOR_POINTING_HAND; return CURSOR_POINTING_HAND;
} }
@ -4973,6 +5034,19 @@ void TextEdit::remove_breakpoints() {
} }
} }
void TextEdit::set_line_info_icon(int p_line, Ref<Texture> p_icon, String p_info) {
ERR_FAIL_INDEX(p_line, text.size());
text.set_info_icon(p_line, p_icon, p_info);
update();
}
void TextEdit::clear_info_icons() {
for (int i = 0; i < text.size(); i++) {
text.set_info_icon(i, NULL, "");
}
update();
}
void TextEdit::set_line_as_hidden(int p_line, bool p_hidden) { void TextEdit::set_line_as_hidden(int p_line, bool p_hidden) {
ERR_FAIL_INDEX(p_line, text.size()); ERR_FAIL_INDEX(p_line, text.size());
@ -6010,6 +6084,24 @@ int TextEdit::get_fold_gutter_width() const {
return cache.fold_gutter_width; return cache.fold_gutter_width;
} }
void TextEdit::set_draw_info_gutter(bool p_draw) {
draw_info_gutter = p_draw;
update();
}
bool TextEdit::is_drawing_info_gutter() const {
return draw_info_gutter;
}
void TextEdit::set_info_gutter_width(int p_gutter_width) {
info_gutter_width = p_gutter_width;
update();
}
int TextEdit::get_info_gutter_width() const {
return info_gutter_width;
}
void TextEdit::set_hiding_enabled(int p_enabled) { void TextEdit::set_hiding_enabled(int p_enabled) {
if (!p_enabled) if (!p_enabled)
unhide_all_lines(); unhide_all_lines();
@ -6235,6 +6327,7 @@ void TextEdit::_bind_methods() {
ADD_SIGNAL(MethodInfo("request_completion")); ADD_SIGNAL(MethodInfo("request_completion"));
ADD_SIGNAL(MethodInfo("breakpoint_toggled", PropertyInfo(Variant::INT, "row"))); ADD_SIGNAL(MethodInfo("breakpoint_toggled", PropertyInfo(Variant::INT, "row")));
ADD_SIGNAL(MethodInfo("symbol_lookup", PropertyInfo(Variant::STRING, "symbol"), PropertyInfo(Variant::INT, "row"), PropertyInfo(Variant::INT, "column"))); ADD_SIGNAL(MethodInfo("symbol_lookup", PropertyInfo(Variant::STRING, "symbol"), PropertyInfo(Variant::INT, "row"), PropertyInfo(Variant::INT, "column")));
ADD_SIGNAL(MethodInfo("info_clicked", PropertyInfo(Variant::INT, "row"), PropertyInfo(Variant::STRING, "info")));
BIND_ENUM_CONSTANT(MENU_CUT); BIND_ENUM_CONSTANT(MENU_CUT);
BIND_ENUM_CONSTANT(MENU_COPY); BIND_ENUM_CONSTANT(MENU_COPY);
@ -6270,6 +6363,8 @@ TextEdit::TextEdit() {
breakpoint_gutter_width = 0; breakpoint_gutter_width = 0;
cache.fold_gutter_width = 0; cache.fold_gutter_width = 0;
fold_gutter_width = 0; fold_gutter_width = 0;
info_gutter_width = 0;
cache.info_gutter_width = 0;
set_default_cursor_shape(CURSOR_IBEAM); set_default_cursor_shape(CURSOR_IBEAM);
indent_size = 4; indent_size = 4;
@ -6342,6 +6437,7 @@ TextEdit::TextEdit() {
line_length_guideline_col = 80; line_length_guideline_col = 80;
draw_breakpoint_gutter = false; draw_breakpoint_gutter = false;
draw_fold_gutter = false; draw_fold_gutter = false;
draw_info_gutter = false;
hiding_enabled = false; hiding_enabled = false;
next_operation_is_complex = false; next_operation_is_complex = false;
scroll_past_end_of_file_enabled = false; scroll_past_end_of_file_enabled = false;

View file

@ -79,6 +79,8 @@ public:
bool safe : 1; bool safe : 1;
int wrap_amount_cache : 24; int wrap_amount_cache : 24;
Map<int, ColorRegionInfo> region_info; Map<int, ColorRegionInfo> region_info;
Ref<Texture> info_icon;
String info;
String data; String data;
}; };
@ -109,6 +111,13 @@ public:
bool is_hidden(int p_line) const { return text[p_line].hidden; } bool is_hidden(int p_line) const { return text[p_line].hidden; }
void set_safe(int p_line, bool p_safe) { text.write[p_line].safe = p_safe; } void set_safe(int p_line, bool p_safe) { text.write[p_line].safe = p_safe; }
bool is_safe(int p_line) const { return text[p_line].safe; } bool is_safe(int p_line) const { return text[p_line].safe; }
void set_info_icon(int p_line, Ref<Texture> p_icon, String p_info) {
text.write[p_line].info_icon = p_icon;
text.write[p_line].info = p_info;
}
bool has_info_icon(int p_line) const { return text[p_line].info_icon.is_valid(); }
const Ref<Texture> &get_info_icon(int p_line) const { return text[p_line].info_icon; }
const String &get_info(int p_line) const { return text[p_line].info; }
void insert(int p_at, const String &p_text); void insert(int p_at, const String &p_text);
void remove(int p_at); void remove(int p_at);
int size() const { return text.size(); } int size() const { return text.size(); }
@ -193,6 +202,7 @@ private:
int line_number_w; int line_number_w;
int breakpoint_gutter_width; int breakpoint_gutter_width;
int fold_gutter_width; int fold_gutter_width;
int info_gutter_width;
} cache; } cache;
Map<int, int> color_region_cache; Map<int, int> color_region_cache;
@ -291,6 +301,8 @@ private:
bool draw_fold_gutter; bool draw_fold_gutter;
int fold_gutter_width; int fold_gutter_width;
bool hiding_enabled; bool hiding_enabled;
bool draw_info_gutter;
int info_gutter_width;
bool highlight_all_occurrences; bool highlight_all_occurrences;
bool scroll_past_end_of_file_enabled; bool scroll_past_end_of_file_enabled;
@ -480,6 +492,9 @@ public:
Array get_breakpoints_array() const; Array get_breakpoints_array() const;
void remove_breakpoints(); void remove_breakpoints();
void set_line_info_icon(int p_line, Ref<Texture> p_icon, String p_info = "");
void clear_info_icons();
void set_line_as_hidden(int p_line, bool p_hidden); void set_line_as_hidden(int p_line, bool p_hidden);
bool is_line_hidden(int p_line) const; bool is_line_hidden(int p_line) const;
void fold_all_lines(); void fold_all_lines();
@ -651,6 +666,12 @@ public:
void set_fold_gutter_width(int p_gutter_width); void set_fold_gutter_width(int p_gutter_width);
int get_fold_gutter_width() const; int get_fold_gutter_width() const;
void set_draw_info_gutter(bool p_draw);
bool is_drawing_info_gutter() const;
void set_info_gutter_width(int p_gutter_width);
int get_info_gutter_width() const;
void set_hiding_enabled(int p_enabled); void set_hiding_enabled(int p_enabled);
int is_hiding_enabled() const; int is_hiding_enabled() const;