godot/scene/gui/text_edit.cpp
Rémi Verschelde d95794ec8a
One Copyright Update to rule them all
As many open source projects have started doing it, we're removing the
current year from the copyright notice, so that we don't need to bump
it every year.

It seems like only the first year of publication is technically
relevant for copyright notices, and even that seems to be something
that many companies stopped listing altogether (in a version controlled
codebase, the commits are a much better source of date of publication
than a hardcoded copyright statement).

We also now list Godot Engine contributors first as we're collectively
the current maintainers of the project, and we clarify that the
"exclusive" copyright of the co-founders covers the timespan before
opensourcing (their further contributions are included as part of Godot
Engine contributors).

Also fixed "cf." Frenchism - it's meant as "refer to / see".
2023-01-05 13:25:55 +01:00

7751 lines
254 KiB
C++

/**************************************************************************/
/* text_edit.cpp */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
#include "text_edit.h"
#include "core/config/project_settings.h"
#include "core/input/input.h"
#include "core/input/input_map.h"
#include "core/object/message_queue.h"
#include "core/object/script_language.h"
#include "core/os/keyboard.h"
#include "core/os/os.h"
#include "core/string/string_builder.h"
#include "core/string/translation.h"
#include "label.h"
#include "scene/main/window.h"
///////////////////////////////////////////////////////////////////////////////
/// TEXT ///
///////////////////////////////////////////////////////////////////////////////
void TextEdit::Text::set_font(const Ref<Font> &p_font) {
if (font == p_font) {
return;
}
font = p_font;
is_dirty = true;
}
void TextEdit::Text::set_font_size(int p_font_size) {
if (font_size == p_font_size) {
return;
}
font_size = p_font_size;
is_dirty = true;
}
void TextEdit::Text::set_tab_size(int p_tab_size) {
if (tab_size == p_tab_size) {
return;
}
tab_size = p_tab_size;
tab_size_dirty = true;
}
int TextEdit::Text::get_tab_size() const {
return tab_size;
}
void TextEdit::Text::set_direction_and_language(TextServer::Direction p_direction, const String &p_language) {
if (direction == p_direction && language == p_language) {
return;
}
direction = p_direction;
language = p_language;
is_dirty = true;
}
void TextEdit::Text::set_draw_control_chars(bool p_enabled) {
if (draw_control_chars == p_enabled) {
return;
}
draw_control_chars = p_enabled;
is_dirty = true;
}
int TextEdit::Text::get_line_width(int p_line, int p_wrap_index) const {
ERR_FAIL_INDEX_V(p_line, text.size(), 0);
if (p_wrap_index != -1) {
return text[p_line].data_buf->get_line_width(p_wrap_index);
}
return text[p_line].data_buf->get_size().x;
}
int TextEdit::Text::get_line_height() const {
return line_height;
}
void TextEdit::Text::set_width(float p_width) {
width = p_width;
}
float TextEdit::Text::get_width() const {
return width;
}
int TextEdit::Text::get_line_wrap_amount(int p_line) const {
ERR_FAIL_INDEX_V(p_line, text.size(), 0);
return text[p_line].data_buf->get_line_count() - 1;
}
Vector<Vector2i> TextEdit::Text::get_line_wrap_ranges(int p_line) const {
Vector<Vector2i> ret;
ERR_FAIL_INDEX_V(p_line, text.size(), ret);
for (int i = 0; i < text[p_line].data_buf->get_line_count(); i++) {
ret.push_back(text[p_line].data_buf->get_line_range(i));
}
return ret;
}
const Ref<TextParagraph> TextEdit::Text::get_line_data(int p_line) const {
ERR_FAIL_INDEX_V(p_line, text.size(), Ref<TextParagraph>());
return text[p_line].data_buf;
}
_FORCE_INLINE_ const String &TextEdit::Text::operator[](int p_line) const {
return text[p_line].data;
}
void TextEdit::Text::_calculate_line_height() {
int height = 0;
for (const Line &l : text) {
// Found another line with the same height...nothing to update.
if (l.height == line_height) {
height = line_height;
break;
}
height = MAX(height, l.height);
}
line_height = height;
}
void TextEdit::Text::_calculate_max_line_width() {
int line_width = 0;
for (const Line &l : text) {
if (l.hidden) {
continue;
}
// Found another line with the same width...nothing to update.
if (l.width == max_width) {
line_width = max_width;
break;
}
line_width = MAX(line_width, l.width);
}
max_width = line_width;
}
void TextEdit::Text::invalidate_cache(int p_line, int p_column, bool p_text_changed, const String &p_ime_text, const Array &p_bidi_override) {
ERR_FAIL_INDEX(p_line, text.size());
if (font.is_null()) {
return; // Not in tree?
}
if (p_text_changed) {
text.write[p_line].data_buf->clear();
}
text.write[p_line].data_buf->set_width(width);
text.write[p_line].data_buf->set_direction((TextServer::Direction)direction);
text.write[p_line].data_buf->set_preserve_control(draw_control_chars);
if (p_ime_text.length() > 0) {
if (p_text_changed) {
text.write[p_line].data_buf->add_string(p_ime_text, font, font_size, language);
}
if (!p_bidi_override.is_empty()) {
TS->shaped_text_set_bidi_override(text.write[p_line].data_buf->get_rid(), p_bidi_override);
}
} else {
if (p_text_changed) {
text.write[p_line].data_buf->add_string(text[p_line].data, font, font_size, language);
}
if (!text[p_line].bidi_override.is_empty()) {
TS->shaped_text_set_bidi_override(text.write[p_line].data_buf->get_rid(), text[p_line].bidi_override);
}
}
if (!p_text_changed) {
RID r = text.write[p_line].data_buf->get_rid();
int spans = TS->shaped_get_span_count(r);
for (int i = 0; i < spans; i++) {
TS->shaped_set_span_update_font(r, i, font->get_rids(), font_size, font->get_opentype_features());
}
for (int i = 0; i < TextServer::SPACING_MAX; i++) {
TS->shaped_text_set_spacing(r, TextServer::SpacingType(i), font->get_spacing(TextServer::SpacingType(i)));
}
}
// Apply tab align.
if (tab_size > 0) {
Vector<float> tabs;
tabs.push_back(font->get_char_size(' ', font_size).width * tab_size);
text.write[p_line].data_buf->tab_align(tabs);
}
// Update height.
const int old_height = text.write[p_line].height;
const int wrap_amount = get_line_wrap_amount(p_line);
int height = font_height;
for (int i = 0; i <= wrap_amount; i++) {
height = MAX(height, text[p_line].data_buf->get_line_size(i).y);
}
text.write[p_line].height = height;
// If this line has shrunk, this may no longer the the tallest line.
if (old_height == line_height && height < line_height) {
_calculate_line_height();
} else {
line_height = MAX(height, line_height);
}
// Update width.
const int old_width = text.write[p_line].width;
int line_width = get_line_width(p_line);
text.write[p_line].width = line_width;
// If this line has shrunk, this may no longer the the longest line.
if (old_width == max_width && line_width < max_width) {
_calculate_max_line_width();
} else if (!is_hidden(p_line)) {
max_width = MAX(line_width, max_width);
}
}
void TextEdit::Text::invalidate_all_lines() {
for (int i = 0; i < text.size(); i++) {
text.write[i].data_buf->set_width(width);
if (tab_size_dirty) {
if (tab_size > 0) {
Vector<float> tabs;
tabs.push_back(font->get_char_size(' ', font_size).width * tab_size);
text.write[i].data_buf->tab_align(tabs);
}
// Tabs have changes, force width update.
text.write[i].width = get_line_width(i);
}
}
if (tab_size_dirty) {
_calculate_max_line_width();
tab_size_dirty = false;
}
}
void TextEdit::Text::invalidate_font() {
if (!is_dirty) {
return;
}
max_width = -1;
line_height = -1;
if (font.is_valid() && font_size > 0) {
font_height = font->get_height(font_size);
}
for (int i = 0; i < text.size(); i++) {
invalidate_cache(i, -1, false);
}
is_dirty = false;
}
void TextEdit::Text::invalidate_all() {
if (!is_dirty) {
return;
}
max_width = -1;
line_height = -1;
if (font.is_valid() && font_size > 0) {
font_height = font->get_height(font_size);
}
for (int i = 0; i < text.size(); i++) {
invalidate_cache(i, -1, true);
}
is_dirty = false;
}
void TextEdit::Text::clear() {
text.clear();
max_width = -1;
line_height = -1;
Line line;
line.gutters.resize(gutter_count);
line.data = "";
text.insert(0, line);
invalidate_cache(0, -1, true);
}
int TextEdit::Text::get_max_width() const {
return max_width;
}
void TextEdit::Text::set(int p_line, const String &p_text, const Array &p_bidi_override) {
ERR_FAIL_INDEX(p_line, text.size());
text.write[p_line].data = p_text;
text.write[p_line].bidi_override = p_bidi_override;
invalidate_cache(p_line, -1, true);
}
void TextEdit::Text::insert(int p_at, const Vector<String> &p_text, const Vector<Array> &p_bidi_override) {
int new_line_count = p_text.size() - 1;
if (new_line_count > 0) {
text.resize(text.size() + new_line_count);
for (int i = (text.size() - 1); i > p_at; i--) {
if ((i - new_line_count) <= 0) {
break;
}
text.write[i] = text[i - new_line_count];
}
}
for (int i = 0; i < p_text.size(); i++) {
if (i == 0) {
set(p_at + i, p_text[i], p_bidi_override[i]);
continue;
}
Line line;
line.gutters.resize(gutter_count);
line.data = p_text[i];
line.bidi_override = p_bidi_override[i];
text.write[p_at + i] = line;
invalidate_cache(p_at + i, -1, true);
}
}
void TextEdit::Text::remove_range(int p_from_line, int p_to_line) {
if (p_from_line == p_to_line) {
return;
}
bool dirty_height = false;
bool dirty_width = false;
for (int i = p_from_line; i < p_to_line; i++) {
if (!dirty_height && text[i].height == line_height) {
dirty_height = true;
}
if (!dirty_width && text[i].width == max_width) {
dirty_width = true;
}
if (dirty_height && dirty_width) {
break;
}
}
int diff = (p_to_line - p_from_line);
for (int i = p_to_line; i < text.size() - 1; i++) {
text.write[(i - diff) + 1] = text[i + 1];
}
text.resize(text.size() - diff);
if (dirty_height) {
_calculate_line_height();
}
if (dirty_width) {
_calculate_max_line_width();
}
}
void TextEdit::Text::add_gutter(int p_at) {
for (int i = 0; i < text.size(); i++) {
if (p_at < 0 || p_at > gutter_count) {
text.write[i].gutters.push_back(Gutter());
} else {
text.write[i].gutters.insert(p_at, Gutter());
}
}
gutter_count++;
}
void TextEdit::Text::remove_gutter(int p_gutter) {
for (int i = 0; i < text.size(); i++) {
text.write[i].gutters.remove_at(p_gutter);
}
gutter_count--;
}
void TextEdit::Text::move_gutters(int p_from_line, int p_to_line) {
text.write[p_to_line].gutters = text[p_from_line].gutters;
text.write[p_from_line].gutters.clear();
text.write[p_from_line].gutters.resize(gutter_count);
}
///////////////////////////////////////////////////////////////////////////////
/// TEXT EDIT ///
///////////////////////////////////////////////////////////////////////////////
void TextEdit::_notification(int p_what) {
switch (p_what) {
case NOTIFICATION_ENTER_TREE: {
_update_caches();
if (caret_pos_dirty) {
MessageQueue::get_singleton()->push_call(this, "_emit_caret_changed");
}
if (text_changed_dirty) {
MessageQueue::get_singleton()->push_call(this, "_text_changed_emit");
}
_update_wrap_at_column(true);
} break;
case NOTIFICATION_RESIZED: {
_update_scrollbars();
_update_wrap_at_column();
} break;
case NOTIFICATION_VISIBILITY_CHANGED: {
if (is_visible()) {
call_deferred(SNAME("_update_scrollbars"));
call_deferred(SNAME("_update_wrap_at_column"));
}
} break;
case NOTIFICATION_LAYOUT_DIRECTION_CHANGED:
case NOTIFICATION_TRANSLATION_CHANGED:
case NOTIFICATION_THEME_CHANGED: {
if (is_inside_tree()) {
_update_caches();
_update_wrap_at_column(true);
}
} break;
case NOTIFICATION_WM_WINDOW_FOCUS_IN: {
window_has_focus = true;
draw_caret = true;
queue_redraw();
} break;
case NOTIFICATION_WM_WINDOW_FOCUS_OUT: {
window_has_focus = false;
draw_caret = false;
queue_redraw();
} break;
case NOTIFICATION_INTERNAL_PHYSICS_PROCESS: {
if (scrolling && get_v_scroll() != target_v_scroll) {
double target_y = target_v_scroll - get_v_scroll();
double dist = abs(target_y);
// To ensure minimap is responsive override the speed setting.
double vel = ((target_y / dist) * ((minimap_clicked) ? 3000 : v_scroll_speed)) * get_physics_process_delta_time();
// Prevent too small velocity to block scrolling
if (Math::abs(vel) < v_scroll->get_step()) {
vel = v_scroll->get_step() * SIGN(vel);
}
if (Math::abs(vel) >= dist) {
set_v_scroll(target_v_scroll);
scrolling = false;
minimap_clicked = false;
set_physics_process_internal(false);
} else {
set_v_scroll(get_v_scroll() + vel);
}
} else {
scrolling = false;
minimap_clicked = false;
set_physics_process_internal(false);
}
} break;
case NOTIFICATION_DRAW: {
if (first_draw) {
// Size may not be the final one, so attempts to ensure caret was visible may have failed.
adjust_viewport_to_caret();
first_draw = false;
}
/* Prevent the resource getting lost between the editor and game. */
if (Engine::get_singleton()->is_editor_hint()) {
if (syntax_highlighter.is_valid() && syntax_highlighter->get_text_edit() != this) {
syntax_highlighter->set_text_edit(this);
}
}
Size2 size = get_size();
bool rtl = is_layout_rtl();
if ((!has_focus() && !(menu && menu->has_focus())) || !window_has_focus) {
draw_caret = false;
}
_update_scrollbars();
RID ci = get_canvas_item();
RenderingServer::get_singleton()->canvas_item_set_clip(get_canvas_item(), true);
int xmargin_beg = style_normal->get_margin(SIDE_LEFT) + gutters_width + gutter_padding;
int xmargin_end = size.width - style_normal->get_margin(SIDE_RIGHT);
if (draw_minimap) {
xmargin_end -= minimap_width;
}
// Let's do it easy for now.
style_normal->draw(ci, Rect2(Point2(), size));
if (!editable) {
style_readonly->draw(ci, Rect2(Point2(), size));
draw_caret = false;
}
if (has_focus()) {
style_focus->draw(ci, Rect2(Point2(), size));
}
int visible_rows = get_visible_line_count() + 1;
Color color = !editable ? font_readonly_color : font_color;
if (background_color.a > 0.01) {
RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(Point2i(), get_size()), background_color);
}
Vector<BraceMatchingData> brace_matching;
if (highlight_matching_braces_enabled) {
brace_matching.resize(carets.size());
for (int caret = 0; caret < carets.size(); caret++) {
if (get_caret_line(caret) < 0 || get_caret_line(caret) >= text.size() || get_caret_column(caret) < 0) {
continue;
}
if (get_caret_column(caret) < text[get_caret_line(caret)].length()) {
// Check for open.
char32_t c = text[get_caret_line(caret)][get_caret_column(caret)];
char32_t closec = 0;
if (c == '[') {
closec = ']';
} else if (c == '{') {
closec = '}';
} else if (c == '(') {
closec = ')';
}
if (closec != 0) {
int stack = 1;
for (int i = get_caret_line(caret); i < text.size(); i++) {
int from = i == get_caret_line(caret) ? get_caret_column(caret) + 1 : 0;
for (int j = from; j < text[i].length(); j++) {
char32_t cc = text[i][j];
// Ignore any brackets inside a string.
if (cc == '"' || cc == '\'') {
char32_t quotation = cc;
do {
j++;
if (!(j < text[i].length())) {
break;
}
cc = text[i][j];
// Skip over escaped quotation marks inside strings.
if (cc == '\\') {
bool escaped = true;
while (j + 1 < text[i].length() && text[i][j + 1] == '\\') {
escaped = !escaped;
j++;
}
if (escaped) {
j++;
continue;
}
}
} while (cc != quotation);
} else if (cc == c) {
stack++;
} else if (cc == closec) {
stack--;
}
if (stack == 0) {
brace_matching.write[caret].open_match_line = i;
brace_matching.write[caret].open_match_column = j;
brace_matching.write[caret].open_matching = true;
break;
}
}
if (brace_matching.write[caret].open_match_line != -1) {
break;
}
}
if (!brace_matching.write[caret].open_matching) {
brace_matching.write[caret].open_mismatch = true;
}
}
}
if (get_caret_column(caret) > 0) {
char32_t c = text[get_caret_line(caret)][get_caret_column(caret) - 1];
char32_t closec = 0;
if (c == ']') {
closec = '[';
} else if (c == '}') {
closec = '{';
} else if (c == ')') {
closec = '(';
}
if (closec != 0) {
int stack = 1;
for (int i = get_caret_line(caret); i >= 0; i--) {
int from = i == get_caret_line(caret) ? get_caret_column(caret) - 2 : text[i].length() - 1;
for (int j = from; j >= 0; j--) {
char32_t cc = text[i][j];
// Ignore any brackets inside a string.
if (cc == '"' || cc == '\'') {
char32_t quotation = cc;
do {
j--;
if (!(j >= 0)) {
break;
}
cc = text[i][j];
// Skip over escaped quotation marks inside strings.
if (cc == quotation) {
bool escaped = false;
while (j - 1 >= 0 && text[i][j - 1] == '\\') {
escaped = !escaped;
j--;
}
if (escaped) {
cc = '\\';
continue;
}
}
} while (cc != quotation);
} else if (cc == c) {
stack++;
} else if (cc == closec) {
stack--;
}
if (stack == 0) {
brace_matching.write[caret].close_match_line = i;
brace_matching.write[caret].close_match_column = j;
brace_matching.write[caret].close_matching = true;
break;
}
}
if (brace_matching.write[caret].close_match_line != -1) {
break;
}
}
if (!brace_matching.write[caret].close_matching) {
brace_matching.write[caret].close_mismatch = true;
}
}
}
}
}
bool draw_placeholder = text.size() == 1 && text[0].is_empty() && ime_text.is_empty();
// Get the highlighted words.
String highlighted_text = get_selected_text(0);
// Check if highlighted words contain only whitespaces (tabs or spaces).
bool only_whitespaces_highlighted = highlighted_text.strip_edges().is_empty();
HashMap<int, HashSet<int>> caret_line_wrap_index_map;
Vector<int> carets_wrap_index;
carets_wrap_index.resize(carets.size());
for (int i = 0; i < carets.size(); i++) {
carets.write[i].visible = false;
int wrap_index = get_caret_wrap_index(i);
caret_line_wrap_index_map[get_caret_line(i)].insert(wrap_index);
carets_wrap_index.write[i] = wrap_index;
}
int first_vis_line = get_first_visible_line() - 1;
int draw_amount = visible_rows + (smooth_scroll_enabled ? 1 : 0);
draw_amount += draw_placeholder ? placeholder_wraped_rows.size() - 1 : get_line_wrap_count(first_vis_line + 1);
// Draw minimap.
if (draw_minimap) {
int minimap_visible_lines = get_minimap_visible_lines();
int minimap_line_height = (minimap_char_size.y + minimap_line_spacing);
int minimap_tab_size = minimap_char_size.x * text.get_tab_size();
// calculate viewport size and y offset
int viewport_height = (draw_amount - 1) * minimap_line_height;
int control_height = _get_control_height() - viewport_height;
int viewport_offset_y = round(get_scroll_pos_for_line(first_vis_line + 1) * control_height) / ((v_scroll->get_max() <= minimap_visible_lines) ? (minimap_visible_lines - draw_amount) : (v_scroll->get_max() - draw_amount));
// calculate the first line.
int num_lines_before = round((viewport_offset_y) / minimap_line_height);
int minimap_line = (v_scroll->get_max() <= minimap_visible_lines) ? -1 : first_vis_line;
if (minimap_line >= 0) {
minimap_line -= get_next_visible_line_index_offset_from(first_vis_line, 0, -num_lines_before).x;
minimap_line -= (minimap_line > 0 && smooth_scroll_enabled ? 1 : 0);
}
int minimap_draw_amount = minimap_visible_lines + get_line_wrap_count(minimap_line + 1);
// Draw the minimap.
// Add visual feedback when dragging or hovering the the visible area rectangle.
float viewport_alpha;
if (dragging_minimap) {
viewport_alpha = 0.25;
} else if (hovering_minimap) {
viewport_alpha = 0.175;
} else {
viewport_alpha = 0.1;
}
const Color viewport_color = (background_color.get_v() < 0.5) ? Color(1, 1, 1, viewport_alpha) : Color(0, 0, 0, viewport_alpha);
if (rtl) {
RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(size.width - (xmargin_end + 2) - minimap_width, viewport_offset_y, minimap_width, viewport_height), viewport_color);
} else {
RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2((xmargin_end + 2), viewport_offset_y, minimap_width, viewport_height), viewport_color);
}
for (int i = 0; i < minimap_draw_amount; i++) {
minimap_line++;
if (minimap_line < 0 || minimap_line >= (int)text.size()) {
break;
}
while (_is_line_hidden(minimap_line)) {
minimap_line++;
if (minimap_line < 0 || minimap_line >= (int)text.size()) {
break;
}
}
if (minimap_line < 0 || minimap_line >= (int)text.size()) {
break;
}
Dictionary color_map = _get_line_syntax_highlighting(minimap_line);
Color line_background_color = text.get_line_background_color(minimap_line);
line_background_color.a *= 0.6;
Color current_color = font_color;
if (!editable) {
current_color = font_readonly_color;
}
Vector<String> wrap_rows = get_line_wrapped_text(minimap_line);
int line_wrap_amount = get_line_wrap_count(minimap_line);
int last_wrap_column = 0;
for (int line_wrap_index = 0; line_wrap_index < line_wrap_amount + 1; line_wrap_index++) {
if (line_wrap_index != 0) {
i++;
if (i >= minimap_draw_amount) {
break;
}
}
const String &str = wrap_rows[line_wrap_index];
int indent_px = line_wrap_index != 0 ? get_indent_level(minimap_line) : 0;
if (indent_px >= wrap_at_column) {
indent_px = 0;
}
indent_px = minimap_char_size.x * indent_px;
if (line_wrap_index > 0) {
last_wrap_column += wrap_rows[line_wrap_index - 1].length();
}
if (caret_line_wrap_index_map.has(minimap_line) && caret_line_wrap_index_map[minimap_line].has(line_wrap_index) && highlight_current_line) {
if (rtl) {
RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(size.width - (xmargin_end + 2) - minimap_width, i * 3, minimap_width, 2), current_line_color);
} else {
RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2((xmargin_end + 2), i * 3, minimap_width, 2), current_line_color);
}
} else if (line_background_color != Color(0, 0, 0, 0)) {
if (rtl) {
RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(size.width - (xmargin_end + 2) - minimap_width, i * 3, minimap_width, 2), line_background_color);
} else {
RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2((xmargin_end + 2), i * 3, minimap_width, 2), line_background_color);
}
}
Color previous_color;
int characters = 0;
int tabs = 0;
for (int j = 0; j < str.length(); j++) {
const Variant *color_data = color_map.getptr(last_wrap_column + j);
if (color_data != nullptr) {
current_color = (color_data->operator Dictionary()).get("color", font_color);
if (!editable) {
current_color.a = font_readonly_color.a;
}
}
color = current_color;
if (j == 0) {
previous_color = color;
}
int xpos = indent_px + ((xmargin_end + minimap_char_size.x) + (minimap_char_size.x * j)) + tabs;
bool out_of_bounds = (xpos >= xmargin_end + minimap_width);
bool whitespace = is_whitespace(str[j]);
if (!whitespace) {
characters++;
if (j < str.length() - 1 && color == previous_color && !out_of_bounds) {
continue;
}
// If we've changed color we are at the start of a new section, therefore we need to go back to the end
// of the previous section to draw it, we'll also add the character back on.
if (color != previous_color) {
characters--;
j--;
if (str[j] == '\t') {
tabs -= minimap_tab_size;
}
}
}
if (characters > 0) {
previous_color.a *= 0.6;
// take one for zero indexing, and if we hit whitespace / the end of a word.
int chars = MAX(0, (j - (characters - 1)) - (whitespace ? 1 : 0)) + 1;
int char_x_ofs = indent_px + ((xmargin_end + minimap_char_size.x) + (minimap_char_size.x * chars)) + tabs;
if (rtl) {
RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(Point2(size.width - char_x_ofs - minimap_char_size.x * characters, minimap_line_height * i), Point2(minimap_char_size.x * characters, minimap_char_size.y)), previous_color);
} else {
RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(Point2(char_x_ofs, minimap_line_height * i), Point2(minimap_char_size.x * characters, minimap_char_size.y)), previous_color);
}
}
if (out_of_bounds) {
break;
}
if (str[j] == '\t') {
tabs += minimap_tab_size;
}
previous_color = color;
characters = 0;
}
}
}
}
int top_limit_y = 0;
int bottom_limit_y = get_size().height;
if (!editable) {
top_limit_y += style_readonly->get_margin(SIDE_TOP);
bottom_limit_y -= style_readonly->get_margin(SIDE_BOTTOM);
} else {
top_limit_y += style_normal->get_margin(SIDE_TOP);
bottom_limit_y -= style_normal->get_margin(SIDE_BOTTOM);
}
// Draw main text.
line_drawing_cache.clear();
int row_height = draw_placeholder ? placeholder_line_height + line_spacing : get_line_height();
int line = first_vis_line;
for (int i = 0; i < draw_amount; i++) {
line++;
if (line < 0 || line >= (int)text.size()) {
continue;
}
while (_is_line_hidden(line)) {
line++;
if (line < 0 || line >= (int)text.size()) {
break;
}
}
if (line < 0 || line >= (int)text.size()) {
continue;
}
LineDrawingCache cache_entry;
Dictionary color_map = _get_line_syntax_highlighting(line);
// Ensure we at least use the font color.
Color current_color = !editable ? font_readonly_color : font_color;
if (draw_placeholder) {
current_color = font_placeholder_color;
}
const Ref<TextParagraph> ldata = draw_placeholder ? placeholder_data_buf : text.get_line_data(line);
Vector<String> wrap_rows = draw_placeholder ? placeholder_wraped_rows : get_line_wrapped_text(line);
int line_wrap_amount = draw_placeholder ? placeholder_wraped_rows.size() - 1 : get_line_wrap_count(line);
for (int line_wrap_index = 0; line_wrap_index <= line_wrap_amount; line_wrap_index++) {
if (line_wrap_index != 0) {
i++;
if (i >= draw_amount) {
break;
}
}
const String &str = wrap_rows[line_wrap_index];
int char_margin = xmargin_beg - first_visible_col;
int ofs_x = 0;
int ofs_y = 0;
if (!editable) {
ofs_x = style_readonly->get_offset().x / 2;
ofs_x -= style_normal->get_offset().x / 2;
ofs_y = style_readonly->get_offset().y / 2;
} else {
ofs_y = style_normal->get_offset().y / 2;
}
ofs_y += i * row_height + line_spacing / 2;
ofs_y -= first_visible_line_wrap_ofs * row_height;
ofs_y -= _get_v_scroll_offset() * row_height;
bool clipped = false;
if (ofs_y + row_height < top_limit_y) {
// Line is outside the top margin, clip current line.
// Still need to go through the process to prepare color changes for next lines.
clipped = true;
}
if (ofs_y > bottom_limit_y) {
// Line is outside the bottom margin, clip any remaining text.
i = draw_amount;
break;
}
if (text.get_line_background_color(line) != Color(0, 0, 0, 0)) {
if (rtl) {
RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(size.width - ofs_x - xmargin_end, ofs_y, xmargin_end - xmargin_beg, row_height), text.get_line_background_color(line));
} else {
RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(xmargin_beg + ofs_x, ofs_y, xmargin_end - xmargin_beg, row_height), text.get_line_background_color(line));
}
}
if (str.length() == 0) {
// Draw line background if empty as we won't loop at all.
if (caret_line_wrap_index_map.has(line) && caret_line_wrap_index_map[line].has(line_wrap_index) && highlight_current_line) {
if (rtl) {
RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(size.width - ofs_x - xmargin_end, ofs_y, xmargin_end, row_height), current_line_color);
} else {
RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(ofs_x, ofs_y, xmargin_end, row_height), current_line_color);
}
}
// Give visual indication of empty selected line.
for (int c = 0; c < carets.size(); c++) {
if (has_selection(c) && line >= get_selection_from_line(c) && line <= get_selection_to_line(c) && char_margin >= xmargin_beg) {
float char_w = font->get_char_size(' ', font_size).width;
if (rtl) {
RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(size.width - xmargin_beg - ofs_x - char_w, ofs_y, char_w, row_height), selection_color);
} else {
RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(xmargin_beg + ofs_x, ofs_y, char_w, row_height), selection_color);
}
}
}
} else {
// If it has text, then draw current line marker in the margin, as line number etc will draw over it, draw the rest of line marker later.
if (caret_line_wrap_index_map.has(line) && caret_line_wrap_index_map[line].has(line_wrap_index) && highlight_current_line) {
if (rtl) {
RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(size.width - ofs_x - xmargin_end, ofs_y, xmargin_end, row_height), current_line_color);
} else {
RenderingServer::get_singleton()->canvas_item_add_rect(ci, Rect2(ofs_x, ofs_y, xmargin_end, row_height), current_line_color);
}
}
}
if (line_wrap_index == 0) {
// Only do these if we are on the first wrapped part of a line.
cache_entry.y_offset = ofs_y;
int gutter_offset = style_normal->get_margin(SIDE_LEFT);
for (int g = 0; g < gutters.size(); g++) {
const GutterInfo gutter = gutters[g];
if (!gutter.draw || gutter.width <= 0) {
continue;
}
switch (gutter.type) {
case GUTTER_TYPE_STRING: {
const String &txt = get_line_gutter_text(line, g);
if (txt.is_empty()) {
break;
}
Ref<TextLine> tl;
tl.instantiate();
tl->add_string(txt, font, font_size);
int yofs = ofs_y + (row_height - tl->get_size().y) / 2;
if (outline_size > 0 && outline_color.a > 0) {
tl->draw_outline(ci, Point2(gutter_offset + ofs_x, yofs), outline_size, outline_color);
}
tl->draw(ci, Point2(gutter_offset + ofs_x, yofs), get_line_gutter_item_color(line, g));
} break;
case GUTTER_TYPE_ICON: {
const Ref<Texture2D> icon = get_line_gutter_icon(line, g);
if (icon.is_null()) {
break;
}
Rect2 gutter_rect = Rect2(Point2i(gutter_offset, ofs_y), Size2i(gutter.width, row_height));
int horizontal_padding = gutter_rect.size.x / 6;
int vertical_padding = gutter_rect.size.y / 6;
gutter_rect.position += Point2(horizontal_padding, vertical_padding);
gutter_rect.size -= Point2(horizontal_padding, vertical_padding) * 2;
// Correct icon aspect ratio.
float icon_ratio = icon->get_width() / icon->get_height();
float gutter_ratio = gutter_rect.size.x / gutter_rect.size.y;
if (gutter_ratio > icon_ratio) {
gutter_rect.size.x = floor(icon->get_width() * (gutter_rect.size.y / icon->get_height()));
} else {
gutter_rect.size.y = floor(icon->get_height() * (gutter_rect.size.x / icon->get_width()));
}
if (rtl) {
gutter_rect.position.x = size.width - gutter_rect.position.x - gutter_rect.size.x;
}
icon->draw_rect(ci, gutter_rect, false, get_line_gutter_item_color(line, g));
} break;
case GUTTER_TYPE_CUSTOM: {
if (gutter.custom_draw_callback.is_valid()) {
Rect2i gutter_rect = Rect2i(Point2i(gutter_offset, ofs_y), Size2i(gutter.width, row_height));
if (rtl) {
gutter_rect.position.x = size.width - gutter_rect.position.x - gutter_rect.size.x;
}
Variant args[3] = { line, g, Rect2(gutter_rect) };
const Variant *argp[] = { &args[0], &args[1], &args[2] };
Callable::CallError ce;
Variant ret;
gutter.custom_draw_callback.callp(argp, 3, ret, ce);
}
} break;
}
gutter_offset += gutter.width;
}
}
// Draw line.
RID rid = ldata->get_line_rid(line_wrap_index);
float text_height = TS->shaped_text_get_size(rid).y;
if (rtl) {
char_margin = size.width - char_margin - TS->shaped_text_get_size(rid).x;
}
for (int c = 0; c < carets.size(); c++) {
if (!clipped && has_selection(c) && line >= get_selection_from_line(c) && line <= get_selection_to_line(c)) { // Selection
int sel_from = (line > get_selection_from_line(c)) ? TS->shaped_text_get_range(rid).x : get_selection_from_column(c);
int sel_to = (line < get_selection_to_line(c)) ? TS->shaped_text_get_range(rid).y : get_selection_to_column(c);
Vector<Vector2> sel = TS->shaped_text_get_selection(rid, sel_from, sel_to);
for (int j = 0; j < sel.size(); j++) {
Rect2 rect = Rect2(sel[j].x + char_margin + ofs_x, ofs_y, sel[j].y - sel[j].x, row_height);
if (rect.position.x + rect.size.x <= xmargin_beg || rect.position.x > xmargin_end) {
continue;
}
if (rect.position.x < xmargin_beg) {
rect.size.x -= (xmargin_beg - rect.position.x);
rect.position.x = xmargin_beg;
}
if (rect.position.x + rect.size.x > xmargin_end) {
rect.size.x = xmargin_end - rect.position.x;
}
draw_rect(rect, selection_color, true);
}
}
}
int start = TS->shaped_text_get_range(rid).x;
if (!clipped && !search_text.is_empty()) { // Search highhlight
int search_text_col = _get_column_pos_of_word(search_text, str, search_flags, 0);
int search_text_len = search_text.length();
while (search_text_col != -1) {
Vector<Vector2> sel = TS->shaped_text_get_selection(rid, search_text_col + start, search_text_col + search_text_len + start);
for (int j = 0; j < sel.size(); j++) {
Rect2 rect = Rect2(sel[j].x + char_margin + ofs_x, ofs_y, sel[j].y - sel[j].x, row_height);
if (rect.position.x + rect.size.x <= xmargin_beg || rect.position.x > xmargin_end) {
continue;
}
if (rect.position.x < xmargin_beg) {
rect.size.x -= (xmargin_beg - rect.position.x);
rect.position.x = xmargin_beg;
} else if (rect.position.x + rect.size.x > xmargin_end) {
rect.size.x = xmargin_end - rect.position.x;
}
draw_rect(rect, search_result_color, true);
draw_rect(rect, search_result_border_color, false);
}
search_text_col = _get_column_pos_of_word(search_text, str, search_flags, search_text_col + search_text_len);
}
}
if (!clipped && highlight_all_occurrences && !only_whitespaces_highlighted && !highlighted_text.is_empty()) { // Highlight
int highlighted_text_col = _get_column_pos_of_word(highlighted_text, str, SEARCH_MATCH_CASE | SEARCH_WHOLE_WORDS, 0);
int highlighted_text_len = highlighted_text.length();
while (highlighted_text_col != -1) {
Vector<Vector2> sel = TS->shaped_text_get_selection(rid, highlighted_text_col + start, highlighted_text_col + highlighted_text_len + start);
for (int j = 0; j < sel.size(); j++) {
Rect2 rect = Rect2(sel[j].x + char_margin + ofs_x, ofs_y, sel[j].y - sel[j].x, row_height);
if (rect.position.x + rect.size.x <= xmargin_beg || rect.position.x > xmargin_end) {
continue;
}
if (rect.position.x < xmargin_beg) {
rect.size.x -= (xmargin_beg - rect.position.x);
rect.position.x = xmargin_beg;
} else if (rect.position.x + rect.size.x > xmargin_end) {
rect.size.x = xmargin_end - rect.position.x;
}
draw_rect(rect, word_highlighted_color);
}
highlighted_text_col = _get_column_pos_of_word(highlighted_text, str, SEARCH_MATCH_CASE | SEARCH_WHOLE_WORDS, highlighted_text_col + highlighted_text_len);
}
}
if (!clipped && lookup_symbol_word.length() != 0) { // Highlight word
if (is_ascii_char(lookup_symbol_word[0]) || lookup_symbol_word[0] == '_' || lookup_symbol_word[0] == '.') {
int lookup_symbol_word_col = _get_column_pos_of_word(lookup_symbol_word, str, SEARCH_MATCH_CASE | SEARCH_WHOLE_WORDS, 0);
int lookup_symbol_word_len = lookup_symbol_word.length();
while (lookup_symbol_word_col != -1) {
Vector<Vector2> sel = TS->shaped_text_get_selection(rid, lookup_symbol_word_col + start, lookup_symbol_word_col + lookup_symbol_word_len + start);
for (int j = 0; j < sel.size(); j++) {
Rect2 rect = Rect2(sel[j].x + char_margin + ofs_x, ofs_y + (line_spacing / 2), sel[j].y - sel[j].x, row_height);
if (rect.position.x + rect.size.x <= xmargin_beg || rect.position.x > xmargin_end) {
continue;
}
if (rect.position.x < xmargin_beg) {
rect.size.x -= (xmargin_beg - rect.position.x);
rect.position.x = xmargin_beg;
} else if (rect.position.x + rect.size.x > xmargin_end) {
rect.size.x = xmargin_end - rect.position.x;
}
rect.position.y += ceil(TS->shaped_text_get_ascent(rid)) + ceil(font->get_underline_position(font_size));
rect.size.y = MAX(1, font->get_underline_thickness(font_size));
draw_rect(rect, color);
}
lookup_symbol_word_col = _get_column_pos_of_word(lookup_symbol_word, str, SEARCH_MATCH_CASE | SEARCH_WHOLE_WORDS, lookup_symbol_word_col + lookup_symbol_word_len);
}
}
}
ofs_y += (row_height - text_height) / 2;
const Glyph *glyphs = TS->shaped_text_get_glyphs(rid);
int gl_size = TS->shaped_text_get_glyph_count(rid);
ofs_y += ldata->get_line_ascent(line_wrap_index);
int first_visible_char = TS->shaped_text_get_range(rid).y;
int last_visible_char = TS->shaped_text_get_range(rid).x;
float char_ofs = 0;
if (outline_size > 0 && outline_color.a > 0) {
for (int j = 0; j < gl_size; j++) {
for (int k = 0; k < glyphs[j].repeat; k++) {
if ((char_ofs + char_margin) >= xmargin_beg && (char_ofs + glyphs[j].advance + char_margin) <= xmargin_end) {
if (glyphs[j].font_rid != RID()) {
TS->font_draw_glyph_outline(glyphs[j].font_rid, ci, glyphs[j].font_size, outline_size, Vector2(char_margin + char_ofs + ofs_x + glyphs[j].x_off, ofs_y + glyphs[j].y_off), glyphs[j].index, outline_color);
}
}
char_ofs += glyphs[j].advance;
}
if ((char_ofs + char_margin) >= xmargin_end) {
break;
}
}
char_ofs = 0;
}
for (int j = 0; j < gl_size; j++) {
const Variant *color_data = color_map.getptr(glyphs[j].start);
if (color_data != nullptr) {
current_color = (color_data->operator Dictionary()).get("color", font_color);
if (!editable && current_color.a > font_readonly_color.a) {
current_color.a = font_readonly_color.a;
}
}
Color gl_color = current_color;
for (int c = 0; c < carets.size(); c++) {
if (has_selection(c) && line >= get_selection_from_line(c) && line <= get_selection_to_line(c)) { // Selection
int sel_from = (line > get_selection_from_line(c)) ? TS->shaped_text_get_range(rid).x : get_selection_from_column(c);
int sel_to = (line < get_selection_to_line(c)) ? TS->shaped_text_get_range(rid).y : get_selection_to_column(c);
if (glyphs[j].start >= sel_from && glyphs[j].end <= sel_to && use_selected_font_color) {
gl_color = font_selected_color;
}
}
}
float char_pos = char_ofs + char_margin + ofs_x;
if (char_pos >= xmargin_beg) {
if (highlight_matching_braces_enabled) {
for (int c = 0; c < carets.size(); c++) {
if ((brace_matching[c].open_match_line == line && brace_matching[c].open_match_column == glyphs[j].start) ||
(get_caret_column(c) == glyphs[j].start && get_caret_line(c) == line && carets_wrap_index[c] == line_wrap_index && (brace_matching[c].open_matching || brace_matching[c].open_mismatch))) {
if (brace_matching[c].open_mismatch) {
gl_color = brace_mismatch_color;
}
Rect2 rect = Rect2(char_pos, ofs_y + font->get_underline_position(font_size), glyphs[j].advance * glyphs[j].repeat, MAX(font->get_underline_thickness(font_size) * get_theme_default_base_scale(), 1));
draw_rect(rect, gl_color);
}
if ((brace_matching[c].close_match_line == line && brace_matching[c].close_match_column == glyphs[j].start) ||
(get_caret_column(c) == glyphs[j].start + 1 && get_caret_line(c) == line && carets_wrap_index[c] == line_wrap_index && (brace_matching[c].close_matching || brace_matching[c].close_mismatch))) {
if (brace_matching[c].close_mismatch) {
gl_color = brace_mismatch_color;
}
Rect2 rect = Rect2(char_pos, ofs_y + font->get_underline_position(font_size), glyphs[j].advance * glyphs[j].repeat, MAX(font->get_underline_thickness(font_size) * get_theme_default_base_scale(), 1));
draw_rect(rect, gl_color);
}
}
}
if (draw_tabs && ((glyphs[j].flags & TextServer::GRAPHEME_IS_TAB) == TextServer::GRAPHEME_IS_TAB)) {
int yofs = (text_height - tab_icon->get_height()) / 2 - ldata->get_line_ascent(line_wrap_index);
tab_icon->draw(ci, Point2(char_pos, ofs_y + yofs), gl_color);
} else if (draw_spaces && ((glyphs[j].flags & TextServer::GRAPHEME_IS_SPACE) == TextServer::GRAPHEME_IS_SPACE)) {
int yofs = (text_height - space_icon->get_height()) / 2 - ldata->get_line_ascent(line_wrap_index);
int xofs = (glyphs[j].advance * glyphs[j].repeat - space_icon->get_width()) / 2;
space_icon->draw(ci, Point2(char_pos + xofs, ofs_y + yofs), gl_color);
}
}
bool had_glyphs_drawn = false;
for (int k = 0; k < glyphs[j].repeat; k++) {
if (!clipped && (char_ofs + char_margin) >= xmargin_beg && (char_ofs + glyphs[j].advance + char_margin) <= xmargin_end) {
if (glyphs[j].font_rid != RID()) {
TS->font_draw_glyph(glyphs[j].font_rid, ci, glyphs[j].font_size, Vector2(char_margin + char_ofs + ofs_x + glyphs[j].x_off, ofs_y + glyphs[j].y_off), glyphs[j].index, gl_color);
had_glyphs_drawn = true;
} else if ((glyphs[j].flags & TextServer::GRAPHEME_IS_VIRTUAL) != TextServer::GRAPHEME_IS_VIRTUAL) {
TS->draw_hex_code_box(ci, glyphs[j].font_size, Vector2(char_margin + char_ofs + ofs_x + glyphs[j].x_off, ofs_y + glyphs[j].y_off), glyphs[j].index, gl_color);
had_glyphs_drawn = true;
}
}
char_ofs += glyphs[j].advance;
}
if (had_glyphs_drawn) {
if (first_visible_char > glyphs[j].start) {
first_visible_char = glyphs[j].start;
} else if (last_visible_char < glyphs[j].end) {
last_visible_char = glyphs[j].end;
}
}
if ((char_ofs + char_margin) >= xmargin_end) {
break;
}
}
cache_entry.first_visible_chars.push_back(first_visible_char);
cache_entry.last_visible_chars.push_back(last_visible_char);
// is_line_folded
if (line_wrap_index == line_wrap_amount && line < text.size() - 1 && _is_line_hidden(line + 1)) {
int xofs = char_ofs + char_margin + ofs_x + (folded_eol_icon->get_width() / 2);
if (xofs >= xmargin_beg && xofs < xmargin_end) {
int yofs = (text_height - folded_eol_icon->get_height()) / 2 - ldata->get_line_ascent(line_wrap_index);
Color eol_color = code_folding_color;
eol_color.a = 1;
folded_eol_icon->draw(ci, Point2(xofs, ofs_y + yofs), eol_color);
}
}
// Carets.
// Prevent carets from disappearing at theme scales below 1.0 (if the caret width is 1).
const int caret_width = get_theme_constant(SNAME("caret_width")) * MAX(1, get_theme_default_base_scale());
for (int c = 0; c < carets.size(); c++) {
if (!clipped && get_caret_line(c) == line && carets_wrap_index[c] == line_wrap_index) {
carets.write[c].draw_pos.y = ofs_y + ldata->get_line_descent(line_wrap_index);
if (ime_text.length() == 0) {
CaretInfo ts_caret;
if (str.length() != 0) {
// Get carets.
ts_caret = TS->shaped_text_get_carets(rid, get_caret_column(c));
} else {
// No carets, add one at the start.
int h = font->get_height(font_size);
if (rtl) {
ts_caret.l_dir = TextServer::DIRECTION_RTL;
ts_caret.l_caret = Rect2(Vector2(xmargin_end - char_margin + ofs_x, -h / 2), Size2(caret_width * 4, h));
} else {
ts_caret.l_dir = TextServer::DIRECTION_LTR;
ts_caret.l_caret = Rect2(Vector2(char_ofs, -h / 2), Size2(caret_width * 4, h));
}
}
if ((ts_caret.l_caret != Rect2() && (ts_caret.l_dir == TextServer::DIRECTION_AUTO || ts_caret.l_dir == (TextServer::Direction)input_direction)) || (ts_caret.t_caret == Rect2())) {
carets.write[c].draw_pos.x = char_margin + ofs_x + ts_caret.l_caret.position.x;
} else {
carets.write[c].draw_pos.x = char_margin + ofs_x + ts_caret.t_caret.position.x;
}
if (get_caret_draw_pos(c).x >= xmargin_beg && get_caret_draw_pos(c).x < xmargin_end) {
carets.write[c].visible = true;
if (draw_caret || drag_caret_force_displayed) {
if (caret_type == CaretType::CARET_TYPE_BLOCK || overtype_mode) {
//Block or underline caret, draw trailing carets at full height.
int h = font->get_height(font_size);
if (ts_caret.t_caret != Rect2()) {
if (overtype_mode) {
ts_caret.t_caret.position.y = TS->shaped_text_get_descent(rid);
ts_caret.t_caret.size.y = caret_width;
} else {
ts_caret.t_caret.position.y = -TS->shaped_text_get_ascent(rid);
ts_caret.t_caret.size.y = h;
}
ts_caret.t_caret.position += Vector2(char_margin + ofs_x, ofs_y);
draw_rect(ts_caret.t_caret, caret_color, overtype_mode);
if (ts_caret.l_caret != Rect2() && ts_caret.l_dir != ts_caret.t_dir) {
// Draw split caret (leading part).
ts_caret.l_caret.position += Vector2(char_margin + ofs_x, ofs_y);
ts_caret.l_caret.size.x = caret_width;
draw_rect(ts_caret.l_caret, caret_color);
// Draw extra direction marker on top of split caret.
float d = (ts_caret.l_dir == TextServer::DIRECTION_LTR) ? 0.5 : -3;
Rect2 trect = Rect2(ts_caret.l_caret.position.x + d * caret_width, ts_caret.l_caret.position.y + ts_caret.l_caret.size.y - caret_width, 3 * caret_width, caret_width);
RenderingServer::get_singleton()->canvas_item_add_rect(ci, trect, caret_color);
}
} else { // End of the line.
if (gl_size > 0) {
// Adjust for actual line dimensions.
if (overtype_mode) {
ts_caret.l_caret.position.y = TS->shaped_text_get_descent(rid);
ts_caret.l_caret.size.y = caret_width;
} else {
ts_caret.l_caret.position.y = -TS->shaped_text_get_ascent(rid);
ts_caret.l_caret.size.y = h;
}
} else if (overtype_mode) {
ts_caret.l_caret.position.y += ts_caret.l_caret.size.y;
ts_caret.l_caret.size.y = caret_width;
}
if (ts_caret.l_caret.position.x >= TS->shaped_text_get_size(rid).x) {
ts_caret.l_caret.size.x = font->get_char_size('m', font_size).x;
} else {
ts_caret.l_caret.size.x = 3 * caret_width;
}
ts_caret.l_caret.position += Vector2(char_margin + ofs_x, ofs_y);
if (ts_caret.l_dir == TextServer::DIRECTION_RTL) {
ts_caret.l_caret.position.x -= ts_caret.l_caret.size.x;
}
draw_rect(ts_caret.l_caret, caret_color, overtype_mode);
}
} else {
// Normal caret.
if (ts_caret.l_caret != Rect2() && ts_caret.l_dir == TextServer::DIRECTION_AUTO) {
// Draw extra marker on top of mid caret.
Rect2 trect = Rect2(ts_caret.l_caret.position.x - 2.5 * caret_width, ts_caret.l_caret.position.y, 6 * caret_width, caret_width);
trect.position += Vector2(char_margin + ofs_x, ofs_y);
RenderingServer::get_singleton()->canvas_item_add_rect(ci, trect, caret_color);
} else if (ts_caret.l_caret != Rect2() && ts_caret.t_caret != Rect2() && ts_caret.l_dir != ts_caret.t_dir) {
// Draw extra direction marker on top of split caret.
float d = (ts_caret.l_dir == TextServer::DIRECTION_LTR) ? 0.5 : -3;
Rect2 trect = Rect2(ts_caret.l_caret.position.x + d * caret_width, ts_caret.l_caret.position.y + ts_caret.l_caret.size.y - caret_width, 3 * caret_width, caret_width);
trect.position += Vector2(char_margin + ofs_x, ofs_y);
RenderingServer::get_singleton()->canvas_item_add_rect(ci, trect, caret_color);
d = (ts_caret.t_dir == TextServer::DIRECTION_LTR) ? 0.5 : -3;
trect = Rect2(ts_caret.t_caret.position.x + d * caret_width, ts_caret.t_caret.position.y, 3 * caret_width, caret_width);
trect.position += Vector2(char_margin + ofs_x, ofs_y);
RenderingServer::get_singleton()->canvas_item_add_rect(ci, trect, caret_color);
}
ts_caret.l_caret.position += Vector2(char_margin + ofs_x, ofs_y);
ts_caret.l_caret.size.x = caret_width;
draw_rect(ts_caret.l_caret, caret_color);
ts_caret.t_caret.position += Vector2(char_margin + ofs_x, ofs_y);
ts_caret.t_caret.size.x = caret_width;
draw_rect(ts_caret.t_caret, caret_color);
}
}
}
} else {
{
// IME Intermediate text range.
Vector<Vector2> sel = TS->shaped_text_get_selection(rid, get_caret_column(c), get_caret_column(c) + ime_text.length());
for (int j = 0; j < sel.size(); j++) {
Rect2 rect = Rect2(sel[j].x + char_margin + ofs_x, ofs_y, sel[j].y - sel[j].x, text_height);
if (rect.position.x + rect.size.x <= xmargin_beg || rect.position.x > xmargin_end) {
continue;
}
if (rect.position.x < xmargin_beg) {
rect.size.x -= (xmargin_beg - rect.position.x);
rect.position.x = xmargin_beg;
} else if (rect.position.x + rect.size.x > xmargin_end) {
rect.size.x = xmargin_end - rect.position.x;
}
rect.size.y = caret_width;
draw_rect(rect, caret_color);
carets.write[c].draw_pos.x = rect.position.x;
}
}
{
// IME caret.
Vector<Vector2> sel = TS->shaped_text_get_selection(rid, get_caret_column(c) + ime_selection.x, get_caret_column(c) + ime_selection.x + ime_selection.y);
for (int j = 0; j < sel.size(); j++) {
Rect2 rect = Rect2(sel[j].x + char_margin + ofs_x, ofs_y, sel[j].y - sel[j].x, text_height);
if (rect.position.x + rect.size.x <= xmargin_beg || rect.position.x > xmargin_end) {
continue;
}
if (rect.position.x < xmargin_beg) {
rect.size.x -= (xmargin_beg - rect.position.x);
rect.position.x = xmargin_beg;
} else if (rect.position.x + rect.size.x > xmargin_end) {
rect.size.x = xmargin_end - rect.position.x;
}
rect.size.y = caret_width * 3;
draw_rect(rect, caret_color);
carets.write[c].draw_pos.x = rect.position.x;
}
}
}
}
}
}
if (!draw_placeholder) {
line_drawing_cache[line] = cache_entry;
}
}
if (has_focus()) {
if (get_viewport()->get_window_id() != DisplayServer::INVALID_WINDOW_ID && DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_IME)) {
DisplayServer::get_singleton()->window_set_ime_active(true, get_viewport()->get_window_id());
DisplayServer::get_singleton()->window_set_ime_position(get_global_position() + get_caret_draw_pos(), get_viewport()->get_window_id());
}
}
} break;
case NOTIFICATION_FOCUS_ENTER: {
if (caret_blink_enabled) {
caret_blink_timer->start();
} else {
draw_caret = true;
}
if (get_viewport()->get_window_id() != DisplayServer::INVALID_WINDOW_ID && DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_IME)) {
DisplayServer::get_singleton()->window_set_ime_active(true, get_viewport()->get_window_id());
DisplayServer::get_singleton()->window_set_ime_position(get_global_position() + get_caret_draw_pos(), get_viewport()->get_window_id());
}
if (DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_VIRTUAL_KEYBOARD) && virtual_keyboard_enabled) {
int caret_start = -1;
int caret_end = -1;
if (!has_selection(0)) {
String full_text = _base_get_text(0, 0, get_caret_line(), get_caret_column());
caret_start = full_text.length();
} else {
String pre_text = _base_get_text(0, 0, get_selection_from_line(), get_selection_from_column());
String post_text = get_selected_text(0);
caret_start = pre_text.length();
caret_end = caret_start + post_text.length();
}
DisplayServer::get_singleton()->virtual_keyboard_show(get_text(), get_global_rect(), DisplayServer::KEYBOARD_TYPE_MULTILINE, -1, caret_start, caret_end);
}
} break;
case NOTIFICATION_FOCUS_EXIT: {
if (caret_blink_enabled) {
caret_blink_timer->stop();
}
if (get_viewport()->get_window_id() != DisplayServer::INVALID_WINDOW_ID && DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_IME)) {
DisplayServer::get_singleton()->window_set_ime_position(Point2(), get_viewport()->get_window_id());
DisplayServer::get_singleton()->window_set_ime_active(false, get_viewport()->get_window_id());
}
if (!ime_text.is_empty()) {
ime_text = "";
ime_selection = Point2();
for (int i = 0; i < carets.size(); i++) {
text.invalidate_cache(get_caret_line(i), get_caret_column(i), true, ime_text);
}
}
if (DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_VIRTUAL_KEYBOARD) && virtual_keyboard_enabled) {
DisplayServer::get_singleton()->virtual_keyboard_hide();
}
if (deselect_on_focus_loss_enabled && !selection_drag_attempt) {
deselect();
}
} break;
case MainLoop::NOTIFICATION_OS_IME_UPDATE: {
if (has_focus()) {
ime_text = DisplayServer::get_singleton()->ime_get_text();
ime_selection = DisplayServer::get_singleton()->ime_get_selection();
for (int i = 0; i < carets.size(); i++) {
String t;
if (get_caret_column(i) >= 0) {
t = text[get_caret_line(i)].substr(0, get_caret_column(i)) + ime_text + text[get_caret_line(i)].substr(get_caret_column(i), text[get_caret_line(i)].length());
} else {
t = ime_text;
}
text.invalidate_cache(get_caret_line(i), get_caret_column(i), true, t, structured_text_parser(st_parser, st_args, t));
}
queue_redraw();
}
} break;
case NOTIFICATION_DRAG_BEGIN: {
selecting_mode = SelectionMode::SELECTION_MODE_NONE;
drag_action = true;
dragging_minimap = false;
dragging_selection = false;
can_drag_minimap = false;
click_select_held->stop();
} break;
case NOTIFICATION_DRAG_END: {
if (is_drag_successful()) {
if (selection_drag_attempt) {
selection_drag_attempt = false;
if (is_editable() && !Input::get_singleton()->is_key_pressed(Key::CTRL)) {
delete_selection();
} else if (deselect_on_focus_loss_enabled) {
deselect();
}
}
} else {
selection_drag_attempt = false;
}
drag_action = false;
drag_caret_force_displayed = false;
} break;
}
}
void TextEdit::unhandled_key_input(const Ref<InputEvent> &p_event) {
Ref<InputEventKey> k = p_event;
if (k.is_valid()) {
if (!k->is_pressed()) {
return;
}
// Handle Unicode (with modifiers active, process after shortcuts).
if (has_focus() && editable && (k->get_unicode() >= 32)) {
handle_unicode_input(k->get_unicode());
accept_event();
}
}
}
bool TextEdit::alt_input(const Ref<InputEvent> &p_gui_input) {
Ref<InputEventKey> k = p_gui_input;
if (k.is_valid()) {
if (!k->is_pressed()) {
if (alt_start && k->get_keycode() == Key::ALT) {
alt_start = false;
if ((alt_code > 0x31 && alt_code < 0xd800) || (alt_code > 0xdfff && alt_code <= 0x10ffff)) {
handle_unicode_input(alt_code);
}
return true;
}
return false;
}
if (k->is_alt_pressed()) {
if (!alt_start) {
if (k->get_keycode() == Key::KP_ADD) {
alt_start = true;
alt_code = 0;
return true;
}
} else {
if (k->get_keycode() >= Key::KEY_0 && k->get_keycode() <= Key::KEY_9) {
alt_code = alt_code << 4;
alt_code += (uint32_t)(k->get_keycode() - Key::KEY_0);
}
if (k->get_keycode() >= Key::KP_0 && k->get_keycode() <= Key::KP_9) {
alt_code = alt_code << 4;
alt_code += (uint32_t)(k->get_keycode() - Key::KP_0);
}
if (k->get_keycode() >= Key::A && k->get_keycode() <= Key::F) {
alt_code = alt_code << 4;
alt_code += (uint32_t)(k->get_keycode() - Key::A) + 10;
}
return true;
}
}
}
return false;
}
void TextEdit::gui_input(const Ref<InputEvent> &p_gui_input) {
ERR_FAIL_COND(p_gui_input.is_null());
double prev_v_scroll = v_scroll->get_value();
double prev_h_scroll = h_scroll->get_value();
Ref<InputEventMouseButton> mb = p_gui_input;
if (mb.is_valid()) {
Vector2i mpos = mb->get_position();
if (is_layout_rtl()) {
mpos.x = get_size().x - mpos.x;
}
if (ime_text.length() != 0) {
// Ignore mouse clicks in IME input mode.
return;
}
if (mb->is_pressed()) {
if (mb->get_button_index() == MouseButton::WHEEL_UP && !mb->is_command_or_control_pressed()) {
if (mb->is_shift_pressed()) {
h_scroll->set_value(h_scroll->get_value() - (100 * mb->get_factor()));
} else if (mb->is_alt_pressed()) {
// Scroll 5 times as fast as normal (like in Visual Studio Code).
_scroll_up(15 * mb->get_factor());
} else if (v_scroll->is_visible()) {
// Scroll 3 lines.
_scroll_up(3 * mb->get_factor());
}
}
if (mb->get_button_index() == MouseButton::WHEEL_DOWN && !mb->is_command_or_control_pressed()) {
if (mb->is_shift_pressed()) {
h_scroll->set_value(h_scroll->get_value() + (100 * mb->get_factor()));
} else if (mb->is_alt_pressed()) {
// Scroll 5 times as fast as normal (like in Visual Studio Code).
_scroll_down(15 * mb->get_factor());
} else if (v_scroll->is_visible()) {
// Scroll 3 lines.
_scroll_down(3 * mb->get_factor());
}
}
if (mb->get_button_index() == MouseButton::WHEEL_LEFT) {
h_scroll->set_value(h_scroll->get_value() - (100 * mb->get_factor()));
}
if (mb->get_button_index() == MouseButton::WHEEL_RIGHT) {
h_scroll->set_value(h_scroll->get_value() + (100 * mb->get_factor()));
}
if (mb->get_button_index() == MouseButton::LEFT) {
_reset_caret_blink_timer();
Point2i pos = get_line_column_at_pos(mpos);
int row = pos.y;
int col = pos.x;
int left_margin = style_normal->get_margin(SIDE_LEFT);
for (int i = 0; i < gutters.size(); i++) {
if (!gutters[i].draw || gutters[i].width <= 0) {
continue;
}
if (mpos.x >= left_margin && mpos.x <= left_margin + gutters[i].width) {
emit_signal(SNAME("gutter_clicked"), row, i);
return;
}
left_margin += gutters[i].width;
}
// minimap
if (draw_minimap) {
_update_minimap_click();
if (dragging_minimap) {
return;
}
}
int caret = carets.size() - 1;
int prev_col = get_caret_column(caret);
int prev_line = get_caret_line(caret);
const int triple_click_timeout = 600;
const int triple_click_tolerance = 5;
bool is_triple_click = (!mb->is_double_click() && (OS::get_singleton()->get_ticks_msec() - last_dblclk) < triple_click_timeout && mb->get_position().distance_to(last_dblclk_pos) < triple_click_tolerance);
if (!is_mouse_over_selection() && !mb->is_double_click() && !is_triple_click) {
if (mb->is_alt_pressed()) {
prev_line = row;
prev_col = col;
caret = add_caret(row, col);
if (caret == -1) {
return;
}
carets.write[caret].selection.selecting_line = row;
carets.write[caret].selection.selecting_column = col;
last_dblclk = 0;
} else if (!mb->is_shift_pressed()) {
caret = 0;
remove_secondary_carets();
}
}
set_caret_line(row, false, true, 0, caret);
set_caret_column(col, false, caret);
selection_drag_attempt = false;
if (selecting_enabled && mb->is_shift_pressed() && (get_caret_column(caret) != prev_col || get_caret_line(caret) != prev_line)) {
if (!has_selection(caret)) {
carets.write[caret].selection.active = true;
selecting_mode = SelectionMode::SELECTION_MODE_POINTER;
carets.write[caret].selection.from_column = prev_col;
carets.write[caret].selection.from_line = prev_line;
carets.write[caret].selection.to_column = carets[caret].column;
carets.write[caret].selection.to_line = carets[caret].line;
if (carets[caret].selection.from_line > carets[caret].selection.to_line || (carets[caret].selection.from_line == carets[caret].selection.to_line && carets[caret].selection.from_column > carets[caret].selection.to_column)) {
SWAP(carets.write[caret].selection.from_column, carets.write[caret].selection.to_column);
SWAP(carets.write[caret].selection.from_line, carets.write[caret].selection.to_line);
carets.write[caret].selection.shiftclick_left = false;
} else {
carets.write[caret].selection.shiftclick_left = true;
}
carets.write[caret].selection.selecting_line = prev_line;
carets.write[caret].selection.selecting_column = prev_col;
caret_index_edit_dirty = true;
merge_overlapping_carets();
queue_redraw();
} else {
if (carets[caret].line < carets[caret].selection.selecting_line || (carets[caret].line == carets[caret].selection.selecting_line && carets[caret].column < carets[caret].selection.selecting_column)) {
if (carets[caret].selection.shiftclick_left) {
carets.write[caret].selection.shiftclick_left = !carets[caret].selection.shiftclick_left;
}
carets.write[caret].selection.from_column = carets[caret].column;
carets.write[caret].selection.from_line = carets[caret].line;
} else if (carets[caret].line > carets[caret].selection.selecting_line || (carets[caret].line == carets[caret].selection.selecting_line && carets[caret].column > carets[caret].selection.selecting_column)) {
if (!carets[caret].selection.shiftclick_left) {
SWAP(carets.write[caret].selection.from_column, carets.write[caret].selection.to_column);
SWAP(carets.write[caret].selection.from_line, carets.write[caret].selection.to_line);
carets.write[caret].selection.shiftclick_left = !carets[caret].selection.shiftclick_left;
}
carets.write[caret].selection.to_column = carets[caret].column;
carets.write[caret].selection.to_line = carets[caret].line;
} else {
deselect(caret);
}
caret_index_edit_dirty = true;
merge_overlapping_carets();
queue_redraw();
}
} else if (drag_and_drop_selection_enabled && is_mouse_over_selection()) {
set_selection_mode(SelectionMode::SELECTION_MODE_NONE, get_selection_line(caret), get_selection_column(caret), caret);
// We use the main caret for dragging, so reset this one.
set_caret_line(prev_line, false, true, 0, caret);
set_caret_column(prev_col, false, caret);
selection_drag_attempt = true;
} else if (caret == 0) {
deselect();
set_selection_mode(SelectionMode::SELECTION_MODE_POINTER, row, col);
}
if (is_triple_click) {
// Triple-click select line.
selecting_mode = SelectionMode::SELECTION_MODE_LINE;
selection_drag_attempt = false;
_update_selection_mode_line();
last_dblclk = 0;
} else if (mb->is_double_click() && text[get_caret_line(caret)].length()) {
// Double-click select word.
selecting_mode = SelectionMode::SELECTION_MODE_WORD;
_update_selection_mode_word();
last_dblclk = OS::get_singleton()->get_ticks_msec();
last_dblclk_pos = mb->get_position();
}
queue_redraw();
}
if (is_middle_mouse_paste_enabled() && mb->get_button_index() == MouseButton::MIDDLE && DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_CLIPBOARD_PRIMARY)) {
paste_primary_clipboard();
}
if (mb->get_button_index() == MouseButton::RIGHT && (context_menu_enabled || is_move_caret_on_right_click_enabled())) {
_reset_caret_blink_timer();
Point2i pos = get_line_column_at_pos(mpos);
int row = pos.y;
int col = pos.x;
int caret = carets.size() - 1;
if (is_move_caret_on_right_click_enabled()) {
if (has_selection(caret)) {
int from_line = get_selection_from_line(caret);
int to_line = get_selection_to_line(caret);
int from_column = get_selection_from_column(caret);
int to_column = get_selection_to_column(caret);
if (row < from_line || row > to_line || (row == from_line && col < from_column) || (row == to_line && col > to_column)) {
// Right click is outside the selected text.
deselect(caret);
}
}
if (!has_selection(caret)) {
set_caret_line(row, true, false, 0, caret);
set_caret_column(col, true, caret);
}
merge_overlapping_carets();
}
if (context_menu_enabled) {
_generate_context_menu();
menu->set_position(get_screen_position() + mpos);
menu->reset_size();
menu->popup();
grab_focus();
}
}
} else {
if (mb->get_button_index() == MouseButton::LEFT) {
if (selection_drag_attempt && is_mouse_over_selection()) {
remove_secondary_carets();
Point2i pos = get_line_column_at_pos(get_local_mouse_pos());
set_caret_line(pos.y, false, true, 0, 0);
set_caret_column(pos.x, true, 0);
deselect();
}
dragging_minimap = false;
dragging_selection = false;
can_drag_minimap = false;
click_select_held->stop();
if (!drag_action) {
selection_drag_attempt = false;
}
if (DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_CLIPBOARD_PRIMARY)) {
DisplayServer::get_singleton()->clipboard_set_primary(get_selected_text());
}
}
// Notify to show soft keyboard.
notification(NOTIFICATION_FOCUS_ENTER);
}
}
const Ref<InputEventPanGesture> pan_gesture = p_gui_input;
if (pan_gesture.is_valid()) {
const real_t delta = pan_gesture->get_delta().y;
if (delta < 0) {
_scroll_up(-delta);
} else {
_scroll_down(delta);
}
h_scroll->set_value(h_scroll->get_value() + pan_gesture->get_delta().x * 100);
if (v_scroll->get_value() != prev_v_scroll || h_scroll->get_value() != prev_h_scroll) {
accept_event(); // Accept event if scroll changed.
}
return;
}
Ref<InputEventMouseMotion> mm = p_gui_input;
if (mm.is_valid()) {
Vector2i mpos = mm->get_position();
if (is_layout_rtl()) {
mpos.x = get_size().x - mpos.x;
}
if ((mm->get_button_mask() & MouseButton::MASK_LEFT) != MouseButton::NONE && get_viewport()->gui_get_drag_data() == Variant()) { // Ignore if dragging.
_reset_caret_blink_timer();
if (draw_minimap && !dragging_selection) {
_update_minimap_drag();
}
if (!dragging_minimap) {
switch (selecting_mode) {
case SelectionMode::SELECTION_MODE_POINTER: {
_update_selection_mode_pointer();
} break;
case SelectionMode::SELECTION_MODE_WORD: {
_update_selection_mode_word();
} break;
case SelectionMode::SELECTION_MODE_LINE: {
_update_selection_mode_line();
} break;
default: {
break;
}
}
}
}
// Check if user is hovering a different gutter, and update if yes.
Vector2i current_hovered_gutter = Vector2i(-1, -1);
int left_margin = style_normal->get_margin(SIDE_LEFT);
if (mpos.x <= left_margin + gutters_width + gutter_padding) {
int hovered_row = get_line_column_at_pos(mpos).y;
for (int i = 0; i < gutters.size(); i++) {
if (!gutters[i].draw || gutters[i].width <= 0) {
continue;
}
if (mpos.x >= left_margin && mpos.x < left_margin + gutters[i].width) {
// We are in this gutter i's horizontal area.
current_hovered_gutter = Vector2i(i, hovered_row);
break;
}
left_margin += gutters[i].width;
}
}
if (current_hovered_gutter != hovered_gutter) {
hovered_gutter = current_hovered_gutter;
queue_redraw();
}
if (drag_action && can_drop_data(mpos, get_viewport()->gui_get_drag_data())) {
drag_caret_force_displayed = true;
Point2i pos = get_line_column_at_pos(get_local_mouse_pos());
set_caret_line(pos.y, false, true, 0, 0);
set_caret_column(pos.x, true, 0);
dragging_selection = true;
}
}
if (draw_minimap && !dragging_selection) {
_update_minimap_hover();
}
if (v_scroll->get_value() != prev_v_scroll || h_scroll->get_value() != prev_h_scroll) {
accept_event(); // Accept event if scroll changed.
}
Ref<InputEventKey> k = p_gui_input;
if (k.is_valid()) {
if (alt_input(p_gui_input)) {
accept_event();
return;
}
if (!k->is_pressed()) {
return;
}
// If a modifier has been pressed, and nothing else, return.
if (k->get_keycode() == Key::CTRL || k->get_keycode() == Key::ALT || k->get_keycode() == Key::SHIFT || k->get_keycode() == Key::META) {
return;
}
_reset_caret_blink_timer();
// Allow unicode handling if:
// * No Modifiers are pressed (except shift)
bool allow_unicode_handling = !(k->is_command_or_control_pressed() || k->is_ctrl_pressed() || k->is_alt_pressed() || k->is_meta_pressed());
// Check and handle all built in shortcuts.
// NEWLINES.
if (k->is_action("ui_text_newline_above", true)) {
_new_line(false, true);
accept_event();
return;
}
if (k->is_action("ui_text_newline_blank", true)) {
_new_line(false);
accept_event();
return;
}
if (k->is_action("ui_text_newline", true)) {
_new_line();
accept_event();
return;
}
// BACKSPACE AND DELETE.
if (k->is_action("ui_text_backspace_all_to_left", true)) {
_do_backspace(false, true);
accept_event();
return;
}
if (k->is_action("ui_text_backspace_word", true)) {
_do_backspace(true);
accept_event();
return;
}
if (k->is_action("ui_text_backspace", true)) {
_do_backspace();
accept_event();
return;
}
if (k->is_action("ui_text_delete_all_to_right", true)) {
_delete(false, true);
accept_event();
return;
}
if (k->is_action("ui_text_delete_word", true)) {
_delete(true);
accept_event();
return;
}
if (k->is_action("ui_text_delete", true)) {
_delete();
accept_event();
return;
}
// SCROLLING.
if (k->is_action("ui_text_scroll_up", true)) {
_scroll_lines_up();
accept_event();
return;
}
if (k->is_action("ui_text_scroll_down", true)) {
_scroll_lines_down();
accept_event();
return;
}
if (is_shortcut_keys_enabled()) {
// SELECT ALL, SELECT WORD UNDER CARET, ADD SELECTION FOR NEXT OCCURRENCE,
// CLEAR CARETS AND SELECTIONS, CUT, COPY, PASTE.
if (k->is_action("ui_text_select_all", true)) {
select_all();
accept_event();
return;
}
if (k->is_action("ui_text_select_word_under_caret", true)) {
select_word_under_caret();
accept_event();
return;
}
if (k->is_action("ui_text_add_selection_for_next_occurrence", true)) {
add_selection_for_next_occurrence();
accept_event();
return;
}
if (k->is_action("ui_text_clear_carets_and_selection", true)) {
// Since the default shortcut is ESC, accepts the event only if it's actually performed.
if (_clear_carets_and_selection()) {
accept_event();
return;
}
}
if (k->is_action("ui_cut", true)) {
cut();
accept_event();
return;
}
if (k->is_action("ui_copy", true)) {
copy();
accept_event();
return;
}
if (k->is_action("ui_paste", true)) {
paste();
accept_event();
return;
}
// UNDO/REDO.
if (k->is_action("ui_undo", true)) {
undo();
accept_event();
return;
}
if (k->is_action("ui_redo", true)) {
redo();
accept_event();
return;
}
if (k->is_action("ui_text_caret_add_below", true)) {
add_caret_at_carets(true);
accept_event();
return;
}
if (k->is_action("ui_text_caret_add_above", true)) {
add_caret_at_carets(false);
accept_event();
return;
}
}
// MISC.
if (k->is_action("ui_menu", true)) {
if (context_menu_enabled) {
_generate_context_menu();
adjust_viewport_to_caret();
menu->set_position(get_screen_position() + get_caret_draw_pos());
menu->reset_size();
menu->popup();
menu->grab_focus();
}
accept_event();
return;
}
if (k->is_action("ui_text_toggle_insert_mode", true)) {
set_overtype_mode_enabled(!overtype_mode);
accept_event();
return;
}
if (k->is_action("ui_swap_input_direction", true)) {
_swap_current_input_direction();
accept_event();
return;
}
// CARET MOVEMENT
k = k->duplicate();
bool shift_pressed = k->is_shift_pressed();
// Remove shift or else actions will not match. Use above variable for selection.
k->set_shift_pressed(false);
// CARET MOVEMENT - LEFT, RIGHT.
if (k->is_action("ui_text_caret_word_left", true)) {
_move_caret_left(shift_pressed, true);
accept_event();
return;
}
if (k->is_action("ui_text_caret_left", true)) {
_move_caret_left(shift_pressed, false);
accept_event();
return;
}
if (k->is_action("ui_text_caret_word_right", true)) {
_move_caret_right(shift_pressed, true);
accept_event();
return;
}
if (k->is_action("ui_text_caret_right", true)) {
_move_caret_right(shift_pressed, false);
accept_event();
return;
}
// CARET MOVEMENT - UP, DOWN.
if (k->is_action("ui_text_caret_up", true)) {
_move_caret_up(shift_pressed);
accept_event();
return;
}
if (k->is_action("ui_text_caret_down", true)) {
_move_caret_down(shift_pressed);
accept_event();
return;
}
// CARET MOVEMENT - DOCUMENT START/END.
if (k->is_action("ui_text_caret_document_start", true)) { // && shift_pressed) {
_move_caret_document_start(shift_pressed);
accept_event();
return;
}
if (k->is_action("ui_text_caret_document_end", true)) { // && shift_pressed) {
_move_caret_document_end(shift_pressed);
accept_event();
return;
}
// CARET MOVEMENT - LINE START/END.
if (k->is_action("ui_text_caret_line_start", true)) {
_move_caret_to_line_start(shift_pressed);
accept_event();
return;
}
if (k->is_action("ui_text_caret_line_end", true)) {
_move_caret_to_line_end(shift_pressed);
accept_event();
return;
}
// CARET MOVEMENT - PAGE UP/DOWN.
if (k->is_action("ui_text_caret_page_up", true)) {
_move_caret_page_up(shift_pressed);
accept_event();
return;
}
if (k->is_action("ui_text_caret_page_down", true)) {
_move_caret_page_down(shift_pressed);
accept_event();
return;
}
// Handle tab as it has no set unicode value.
if (k->is_action("ui_text_indent", true)) {
if (editable) {
insert_text_at_caret("\t");
}
accept_event();
return;
}
// Handle Unicode (if no modifiers active).
if (allow_unicode_handling && editable && k->get_unicode() >= 32) {
handle_unicode_input(k->get_unicode());
accept_event();
return;
}
}
}
/* Input actions. */
void TextEdit::_swap_current_input_direction() {
if (input_direction == TEXT_DIRECTION_LTR) {
input_direction = TEXT_DIRECTION_RTL;
} else {
input_direction = TEXT_DIRECTION_LTR;
}
for (int i = 0; i < carets.size(); i++) {
set_caret_column(get_caret_column(i), i == 0, i);
}
queue_redraw();
}
void TextEdit::_new_line(bool p_split_current_line, bool p_above) {
if (!editable) {
return;
}
begin_complex_operation();
Vector<int> caret_edit_order = get_caret_index_edit_order();
for (const int &i : caret_edit_order) {
bool first_line = false;
if (!p_split_current_line) {
deselect(i);
if (p_above) {
if (get_caret_line(i) > 0) {
set_caret_line(get_caret_line(i) - 1, false, true, 0, i);
set_caret_column(text[get_caret_line(i)].length(), i == 0, i);
} else {
set_caret_column(0, i == 0, i);
first_line = true;
}
} else {
set_caret_column(text[get_caret_line(i)].length(), i == 0, i);
}
}
insert_text_at_caret("\n", i);
if (first_line) {
set_caret_line(0, i == 0, true, 0, i);
}
}
end_complex_operation();
}
void TextEdit::_move_caret_left(bool p_select, bool p_move_by_word) {
for (int i = 0; i < carets.size(); i++) {
// Handle selection.
if (p_select) {
_pre_shift_selection(i);
} else if (has_selection(i) && !p_move_by_word) {
// If a selection is active, move caret to start of selection.
set_caret_line(get_selection_from_line(i), false, true, 0, i);
set_caret_column(get_selection_from_column(i), i == 0, i);
deselect(i);
continue;
} else {
deselect(i);
}
if (p_move_by_word) {
int cc = get_caret_column(i);
// If the caret is at the start of the line, and not on the first line, move it up to the end of the previous line.
if (cc == 0 && get_caret_line(i) > 0) {
set_caret_line(get_caret_line(i) - 1, false, true, 0, i);
set_caret_column(text[get_caret_line(i)].length(), i == 0, i);
} else {
PackedInt32Array words = TS->shaped_text_get_word_breaks(text.get_line_data(get_caret_line(i))->get_rid());
if (words.is_empty() || cc <= words[0]) {
// This solves the scenario where there are no words but glyfs that can be ignored.
cc = 0;
} else {
for (int j = words.size() - 2; j >= 0; j = j - 2) {
if (words[j] < cc) {
cc = words[j];
break;
}
}
}
set_caret_column(cc, i == 0, i);
}
} else {
// If the caret is at the start of the line, and not on the first line, move it up to the end of the previous line.
if (get_caret_column(i) == 0) {
if (get_caret_line(i) > 0) {
set_caret_line(get_caret_line(i) - get_next_visible_line_offset_from(CLAMP(get_caret_line(i) - 1, 0, text.size() - 1), -1), false, true, 0, i);
set_caret_column(text[get_caret_line(i)].length(), i == 0, i);
}
} else {
if (caret_mid_grapheme_enabled) {
set_caret_column(get_caret_column(i) - 1, i == 0, i);
} else {
set_caret_column(TS->shaped_text_prev_grapheme_pos(text.get_line_data(get_caret_line(i))->get_rid(), get_caret_column(i)), i == 0, i);
}
}
}
if (p_select) {
_post_shift_selection(i);
}
}
merge_overlapping_carets();
}
void TextEdit::_move_caret_right(bool p_select, bool p_move_by_word) {
for (int i = 0; i < carets.size(); i++) {
// Handle selection
if (p_select) {
_pre_shift_selection(i);
} else if (has_selection(i) && !p_move_by_word) {
// If a selection is active, move caret to end of selection
set_caret_line(get_selection_to_line(i), false, true, 0, i);
set_caret_column(get_selection_to_column(i), i == 0, i);
deselect(i);
continue;
} else {
deselect(i);
}
if (p_move_by_word) {
int cc = get_caret_column(i);
// If the caret is at the end of the line, and not on the last line, move it down to the beginning of the next line.
if (cc == text[get_caret_line(i)].length() && get_caret_line(i) < text.size() - 1) {
set_caret_line(get_caret_line(i) + 1, false, true, 0, i);
set_caret_column(0, i == 0, i);
} else {
PackedInt32Array words = TS->shaped_text_get_word_breaks(text.get_line_data(get_caret_line(i))->get_rid());
if (words.is_empty() || cc >= words[words.size() - 1]) {
// This solves the scenario where there are no words but glyfs that can be ignored.
cc = text[get_caret_line(i)].length();
} else {
for (int j = 1; j < words.size(); j = j + 2) {
if (words[j] > cc) {
cc = words[j];
break;
}
}
}
set_caret_column(cc, i == 0, i);
}
} else {
// If we are at the end of the line, move the caret to the next line down.
if (get_caret_column(i) == text[get_caret_line(i)].length()) {
if (get_caret_line(i) < text.size() - 1) {
set_caret_line(get_caret_line(i) + get_next_visible_line_offset_from(CLAMP(get_caret_line(i) + 1, 0, text.size() - 1), 1), false, false, 0, i);
set_caret_column(0, i == 0, i);
}
} else {
if (caret_mid_grapheme_enabled) {
set_caret_column(get_caret_column(i) + 1, i == 0, i);
} else {
set_caret_column(TS->shaped_text_next_grapheme_pos(text.get_line_data(get_caret_line(i))->get_rid(), get_caret_column(i)), i == 0, i);
}
}
}
if (p_select) {
_post_shift_selection(i);
}
}
merge_overlapping_carets();
}
void TextEdit::_move_caret_up(bool p_select) {
for (int i = 0; i < carets.size(); i++) {
if (p_select) {
_pre_shift_selection(i);
} else {
deselect(i);
}
int cur_wrap_index = get_caret_wrap_index(i);
if (cur_wrap_index > 0) {
set_caret_line(get_caret_line(i), true, false, cur_wrap_index - 1, i);
} else if (get_caret_line(i) == 0) {
set_caret_column(0, i == 0, i);
} else {
int new_line = get_caret_line(i) - get_next_visible_line_offset_from(get_caret_line(i) - 1, -1);
if (is_line_wrapped(new_line)) {
set_caret_line(new_line, i == 0, false, get_line_wrap_count(new_line), i);
} else {
set_caret_line(new_line, i == 0, false, 0, i);
}
}
if (p_select) {
_post_shift_selection(i);
}
}
merge_overlapping_carets();
}
void TextEdit::_move_caret_down(bool p_select) {
for (int i = 0; i < carets.size(); i++) {
if (p_select) {
_pre_shift_selection(i);
} else {
deselect(i);
}
int cur_wrap_index = get_caret_wrap_index(i);
if (cur_wrap_index < get_line_wrap_count(get_caret_line(i))) {
set_caret_line(get_caret_line(i), i == 0, false, cur_wrap_index + 1, i);
} else if (get_caret_line(i) == get_last_unhidden_line()) {
set_caret_column(text[get_caret_line(i)].length());
} else {
int new_line = get_caret_line(i) + get_next_visible_line_offset_from(CLAMP(get_caret_line(i) + 1, 0, text.size() - 1), 1);
set_caret_line(new_line, i == 0, false, 0, i);
}
if (p_select) {
_post_shift_selection(i);
}
}
merge_overlapping_carets();
}
void TextEdit::_move_caret_to_line_start(bool p_select) {
for (int i = 0; i < carets.size(); i++) {
if (p_select) {
_pre_shift_selection(i);
} else {
deselect(i);
}
// Move caret column to start of wrapped row and then to start of text.
Vector<String> rows = get_line_wrapped_text(get_caret_line(i));
int wi = get_caret_wrap_index(i);
int row_start_col = 0;
for (int j = 0; j < wi; j++) {
row_start_col += rows[j].length();
}
if (get_caret_column(i) == row_start_col || wi == 0) {
// Compute whitespace symbols sequence length.
int current_line_whitespace_len = get_first_non_whitespace_column(get_caret_line(i));
if (get_caret_column(i) == current_line_whitespace_len) {
set_caret_column(0, i == 0, i);
} else {
set_caret_column(current_line_whitespace_len, i == 0, i);
}
} else {
set_caret_column(row_start_col, i == 0, i);
}
if (p_select) {
_post_shift_selection(i);
}
}
merge_overlapping_carets();
}
void TextEdit::_move_caret_to_line_end(bool p_select) {
for (int i = 0; i < carets.size(); i++) {
if (p_select) {
_pre_shift_selection(i);
} else {
deselect(i);
}
// Move caret column to end of wrapped row and then to end of text.
Vector<String> rows = get_line_wrapped_text(get_caret_line(i));
int wi = get_caret_wrap_index(i);
int row_end_col = -1;
for (int j = 0; j < wi + 1; j++) {
row_end_col += rows[j].length();
}
if (wi == rows.size() - 1 || get_caret_column(i) == row_end_col) {
set_caret_column(text[get_caret_line(i)].length(), i == 0, i);
} else {
set_caret_column(row_end_col, i == 0, i);
}
carets.write[i].last_fit_x = INT_MAX;
if (p_select) {
_post_shift_selection(i);
}
}
merge_overlapping_carets();
}
void TextEdit::_move_caret_page_up(bool p_select) {
for (int i = 0; i < carets.size(); i++) {
if (p_select) {
_pre_shift_selection(i);
} else {
deselect(i);
}
Point2i next_line = get_next_visible_line_index_offset_from(get_caret_line(i), get_caret_wrap_index(i), -get_visible_line_count());
int n_line = get_caret_line(i) - next_line.x + 1;
set_caret_line(n_line, i == 0, false, next_line.y, i);
if (p_select) {
_post_shift_selection(i);
}
}
merge_overlapping_carets();
}
void TextEdit::_move_caret_page_down(bool p_select) {
for (int i = 0; i < carets.size(); i++) {
if (p_select) {
_pre_shift_selection(i);
} else {
deselect(i);
}
Point2i next_line = get_next_visible_line_index_offset_from(get_caret_line(i), get_caret_wrap_index(i), get_visible_line_count());
int n_line = get_caret_line(i) + next_line.x - 1;
set_caret_line(n_line, i == 0, false, next_line.y, i);
if (p_select) {
_post_shift_selection(i);
}
}
merge_overlapping_carets();
}
void TextEdit::_do_backspace(bool p_word, bool p_all_to_left) {
if (!editable) {
return;
}
start_action(EditAction::ACTION_BACKSPACE);
Vector<int> carets_to_remove;
Vector<int> caret_edit_order = get_caret_index_edit_order();
for (int i = 0; i < caret_edit_order.size(); i++) {
int caret_idx = caret_edit_order[i];
if (get_caret_column(caret_idx) == 0 && get_caret_line(caret_idx) == 0 && !has_selection(caret_idx)) {
continue;
}
if (has_selection(caret_idx) || (!p_all_to_left && !p_word) || get_caret_column(caret_idx) == 0) {
backspace(caret_idx);
continue;
}
if (p_all_to_left) {
int caret_current_column = get_caret_column(caret_idx);
set_caret_column(0, caret_idx == 0, caret_idx);
_remove_text(get_caret_line(caret_idx), 0, get_caret_line(caret_idx), caret_current_column);
adjust_carets_after_edit(caret_idx, get_caret_line(caret_idx), caret_current_column, get_caret_line(caret_idx), get_caret_column(caret_idx));
// Check for any overlapping carets since we removed the entire line.
for (int j = i + 1; j < caret_edit_order.size(); j++) {
// Selection only end on this line, only the one as carets cannot overlap.
if (has_selection(caret_edit_order[j]) && get_selection_from_line(caret_edit_order[j]) != get_caret_line(caret_idx) && get_selection_to_line(caret_edit_order[j]) == get_caret_line(caret_idx)) {
carets.write[caret_edit_order[j]].selection.to_column = 0;
break;
}
// Check for caret.
if (get_caret_line(caret_edit_order[j]) != get_caret_line(caret_idx) || (has_selection(caret_edit_order[j]) && get_selection_from_line(caret_edit_order[j]) != get_caret_line(caret_idx))) {
break;
}
deselect(caret_edit_order[j]);
carets_to_remove.push_back(caret_edit_order[j]);
set_caret_column(0, caret_idx == 0, caret_idx);
i = j;
}
continue;
}
if (p_word) {
// Save here as the caret may change when resolving overlaps.
int from_column = get_caret_column(caret_idx);
int column = get_caret_column(caret_idx);
// Check for the case "<word><space><caret>" and ignore the space.
// No need to check for column being 0 since it is checked above.
if (is_whitespace(text[get_caret_line(caret_idx)][get_caret_column(caret_idx) - 1])) {
column -= 1;
}
// Get a list with the indices of the word bounds of the given text line.
const PackedInt32Array words = TS->shaped_text_get_word_breaks(text.get_line_data(get_caret_line(caret_idx))->get_rid());
if (words.is_empty() || column <= words[0]) {
// If "words" is empty, meaning no words are left, we can remove everything until the beginning of the line.
column = 0;
} else {
// Otherwise search for the first word break that is smaller than the index from we're currently deleting.
for (int c = words.size() - 2; c >= 0; c = c - 2) {
if (words[c] < column) {
column = words[c];
break;
}
}
}
// Check for any other carets in this range.
int overlapping_caret_index = -1;
for (int j = i + 1; j < caret_edit_order.size(); j++) {
// Check caret and selection in on the right line.
if (get_caret_line(caret_edit_order[j]) != get_caret_line(caret_idx) && (!has_selection(caret_edit_order[j]) || get_selection_to_line(caret_edit_order[j]) != get_caret_line(caret_idx))) {
break;
}
// If it has a selection, check it ends with in the range.
if ((has_selection(caret_edit_order[j]) && get_selection_to_column(caret_edit_order[j]) < column)) {
break;
}
// If it has a selection and it starts outside our word, we need to adjust the selection, and handle it later to prevent overlap.
if ((has_selection(caret_edit_order[j]) && get_selection_from_column(caret_edit_order[j]) < column)) {
carets.write[caret_edit_order[j]].selection.to_column = column;
overlapping_caret_index = caret_edit_order[j];
break;
}
// Otherwise we can remove it.
if (get_caret_column(caret_edit_order[j]) > column || (has_selection(caret_edit_order[j]) && get_selection_from_column(caret_edit_order[j]) > column)) {
deselect(caret_edit_order[j]);
carets_to_remove.push_back(caret_edit_order[j]);
set_caret_column(0, caret_idx == 0, caret_idx);
i = j;
}
}
_remove_text(get_caret_line(caret_idx), column, get_caret_line(caret_idx), from_column);
set_caret_line(get_caret_line(caret_idx), false, true, 0, caret_idx);
set_caret_column(column, caret_idx == 0, caret_idx);
// Now we can clean up the overlapping caret.
if (overlapping_caret_index != -1) {
backspace(overlapping_caret_index);
i++;
carets_to_remove.push_back(overlapping_caret_index);
set_caret_column(get_caret_column(overlapping_caret_index), caret_idx == 0, caret_idx);
}
continue;
}
}
// Sort and remove backwards to preserve indexes.
carets_to_remove.sort();
for (int i = carets_to_remove.size() - 1; i >= 0; i--) {
remove_caret(carets_to_remove[i]);
}
end_action();
}
void TextEdit::_delete(bool p_word, bool p_all_to_right) {
if (!editable) {
return;
}
start_action(EditAction::ACTION_DELETE);
Vector<int> carets_to_remove;
Vector<int> caret_edit_order = get_caret_index_edit_order();
for (int i = 0; i < caret_edit_order.size(); i++) {
int caret_idx = caret_edit_order[i];
if (has_selection(caret_idx)) {
delete_selection(caret_idx);
continue;
}
int curline_len = text[get_caret_line(caret_idx)].length();
if (get_caret_line(caret_idx) == text.size() - 1 && get_caret_column(caret_idx) == curline_len) {
continue; // Last line, last column: Nothing to do.
}
int next_line = get_caret_column(caret_idx) < curline_len ? get_caret_line(caret_idx) : get_caret_line(caret_idx) + 1;
int next_column;
if (p_all_to_right) {
// Get caret furthest to the left
for (int j = i + 1; j < caret_edit_order.size(); j++) {
if (get_caret_line(caret_edit_order[j]) != get_caret_line(caret_idx)) {
break;
}
if (has_selection(caret_edit_order[j]) && get_selection_from_line(caret_edit_order[j]) != get_caret_line(caret_idx)) {
break;
}
if (!has_selection(caret_edit_order[j])) {
i = j;
caret_idx = caret_edit_order[i];
}
}
if (get_caret_column(caret_idx) == curline_len) {
continue;
}
// Delete everything to right of caret
next_column = curline_len;
next_line = get_caret_line(caret_idx);
// Remove overlapping carets.
for (int j = i - 1; j >= 0; j--) {
if (get_caret_line(caret_edit_order[j]) != get_caret_line(caret_idx)) {
break;
}
carets_to_remove.push_back(caret_edit_order[j]);
}
} else if (p_word && get_caret_column(caret_idx) < curline_len - 1) {
// Delete next word to right of caret
int line = get_caret_line(caret_idx);
int column = get_caret_column(caret_idx);
PackedInt32Array words = TS->shaped_text_get_word_breaks(text.get_line_data(line)->get_rid());
for (int j = 1; j < words.size(); j = j + 2) {
if (words[j] > column) {
column = words[j];
break;
}
}
next_line = line;
next_column = column;
// Remove overlapping carets.
for (int j = i - 1; j >= 0; j--) {
if (get_caret_line(caret_edit_order[j]) != get_caret_line(caret_idx)) {
break;
}
if (get_caret_column(caret_edit_order[j]) > column) {
break;
}
carets_to_remove.push_back(caret_edit_order[j]);
}
} else {
// Delete one character
if (caret_mid_grapheme_enabled) {
next_column = get_caret_column(caret_idx) < curline_len ? (get_caret_column(caret_idx) + 1) : 0;
} else {
next_column = get_caret_column(caret_idx) < curline_len ? TS->shaped_text_next_grapheme_pos(text.get_line_data(get_caret_line(caret_idx))->get_rid(), (get_caret_column(caret_idx))) : 0;
}
// Remove overlapping carets.
if (i > 0) {
int prev_caret_idx = caret_edit_order[i - 1];
if (get_caret_line(prev_caret_idx) == next_line && get_caret_column(prev_caret_idx) == next_column) {
carets_to_remove.push_back(prev_caret_idx);
}
}
}
_remove_text(get_caret_line(caret_idx), get_caret_column(caret_idx), next_line, next_column);
adjust_carets_after_edit(caret_idx, get_caret_line(caret_idx), get_caret_column(caret_idx), next_line, next_column);
}
// Sort and remove backwards to preserve indexes.
carets_to_remove.sort();
for (int i = carets_to_remove.size() - 1; i >= 0; i--) {
remove_caret(carets_to_remove[i]);
}
// If we are deleting from the end of a line, due to column preservation we could still overlap with another caret.
merge_overlapping_carets();
end_action();
queue_redraw();
}
void TextEdit::_move_caret_document_start(bool p_select) {
remove_secondary_carets();
if (p_select) {
_pre_shift_selection(0);
} else {
deselect();
}
set_caret_line(0, false);
set_caret_column(0);
if (p_select) {
_post_shift_selection(0);
}
}
void TextEdit::_move_caret_document_end(bool p_select) {
remove_secondary_carets();
if (p_select) {
_pre_shift_selection(0);
} else {
deselect();
}
set_caret_line(get_last_unhidden_line(), true, false, 9999);
set_caret_column(text[get_caret_line()].length());
if (p_select) {
_post_shift_selection(0);
}
}
bool TextEdit::_clear_carets_and_selection() {
if (get_caret_count() > 1) {
remove_secondary_carets();
return true;
}
if (has_selection()) {
deselect();
return true;
}
return false;
}
void TextEdit::_get_above_below_caret_line_column(int p_old_line, int p_old_wrap_index, int p_old_column, bool p_below, int &p_new_line, int &p_new_column, int p_last_fit_x) const {
if (p_last_fit_x == -1) {
p_last_fit_x = _get_column_x_offset_for_line(p_old_column, p_old_line, p_old_column);
}
// Calculate the new line and wrap index
p_new_line = p_old_line;
int caret_wrap_index = p_old_wrap_index;
if (p_below) {
if (caret_wrap_index < get_line_wrap_count(p_new_line)) {
caret_wrap_index++;
} else {
p_new_line++;
caret_wrap_index = 0;
}
} else {
if (caret_wrap_index == 0) {
p_new_line--;
caret_wrap_index = get_line_wrap_count(p_new_line);
} else {
caret_wrap_index--;
}
}
// Boundary checks
if (p_new_line < 0) {
p_new_line = 0;
}
if (p_new_line >= text.size()) {
p_new_line = text.size() - 1;
}
p_new_column = _get_char_pos_for_line(p_last_fit_x, p_new_line, caret_wrap_index);
if (p_new_column != 0 && get_line_wrapping_mode() != LineWrappingMode::LINE_WRAPPING_NONE && caret_wrap_index < get_line_wrap_count(p_new_line)) {
Vector<String> rows = get_line_wrapped_text(p_new_line);
int row_end_col = 0;
for (int i = 0; i < caret_wrap_index + 1; i++) {
row_end_col += rows[i].length();
}
if (p_new_column >= row_end_col) {
p_new_column -= 1;
}
}
}
void TextEdit::_update_placeholder() {
if (font.is_null() || font_size <= 0) {
return; // Not in tree?
}
// Placeholder is generally smaller then text documents, and updates less so this should be fast enough for now.
placeholder_data_buf->clear();
placeholder_data_buf->set_width(text.get_width());
placeholder_data_buf->set_direction((TextServer::Direction)text_direction);
placeholder_data_buf->set_preserve_control(draw_control_chars);
placeholder_data_buf->add_string(placeholder_text, font, font_size, language);
placeholder_bidi_override = structured_text_parser(st_parser, st_args, placeholder_text);
if (placeholder_bidi_override.is_empty()) {
TS->shaped_text_set_bidi_override(placeholder_data_buf->get_rid(), placeholder_bidi_override);
}
if (get_tab_size() > 0) {
Vector<float> tabs;
tabs.push_back(font->get_char_size(' ', font_size).width * get_tab_size());
placeholder_data_buf->tab_align(tabs);
}
// Update height.
const int wrap_amount = placeholder_data_buf->get_line_count() - 1;
placeholder_line_height = font->get_height(font_size);
for (int i = 0; i <= wrap_amount; i++) {
placeholder_line_height = MAX(placeholder_line_height, placeholder_data_buf->get_line_size(i).y);
}
// Update width.
placeholder_max_width = placeholder_data_buf->get_size().x;
// Update wrapped rows.
placeholder_wraped_rows.clear();
for (int i = 0; i <= wrap_amount; i++) {
Vector2i line_range = placeholder_data_buf->get_line_range(i);
placeholder_wraped_rows.push_back(placeholder_text.substr(line_range.x, line_range.y - line_range.x));
}
}
void TextEdit::_update_caches() {
/* Internal API for CodeEdit. */
brace_mismatch_color = get_theme_color(SNAME("brace_mismatch_color"), SNAME("CodeEdit"));
code_folding_color = get_theme_color(SNAME("code_folding_color"), SNAME("CodeEdit"));
folded_eol_icon = get_theme_icon(SNAME("folded_eol_icon"), SNAME("CodeEdit"));
/* Search */
search_result_color = get_theme_color(SNAME("search_result_color"));
search_result_border_color = get_theme_color(SNAME("search_result_border_color"));
/* Caret */
caret_color = get_theme_color(SNAME("caret_color"));
caret_background_color = get_theme_color(SNAME("caret_background_color"));
/* Selection */
font_selected_color = get_theme_color(SNAME("font_selected_color"));
selection_color = get_theme_color(SNAME("selection_color"));
use_selected_font_color = font_selected_color != Color(0, 0, 0, 0);
/* Visual. */
style_normal = get_theme_stylebox(SNAME("normal"));
style_focus = get_theme_stylebox(SNAME("focus"));
style_readonly = get_theme_stylebox(SNAME("read_only"));
tab_icon = get_theme_icon(SNAME("tab"));
space_icon = get_theme_icon(SNAME("space"));
font = get_theme_font(SNAME("font"));
font_size = get_theme_font_size(SNAME("font_size"));
font_color = get_theme_color(SNAME("font_color"));
font_readonly_color = get_theme_color(SNAME("font_readonly_color"));
font_placeholder_color = get_theme_color(SNAME("font_placeholder_color"));
outline_size = get_theme_constant(SNAME("outline_size"));
outline_color = get_theme_color(SNAME("font_outline_color"));
line_spacing = get_theme_constant(SNAME("line_spacing"));
background_color = get_theme_color(SNAME("background_color"));
current_line_color = get_theme_color(SNAME("current_line_color"));
word_highlighted_color = get_theme_color(SNAME("word_highlighted_color"));
/* Text properties. */
TextServer::Direction dir;
if (text_direction == Control::TEXT_DIRECTION_INHERITED) {
dir = is_layout_rtl() ? TextServer::DIRECTION_RTL : TextServer::DIRECTION_LTR;
} else {
dir = (TextServer::Direction)text_direction;
}
text.set_direction_and_language(dir, (!language.is_empty()) ? language : TranslationServer::get_singleton()->get_tool_locale());
text.set_draw_control_chars(draw_control_chars);
text.set_font(font);
text.set_font_size(font_size);
text.invalidate_font();
_update_placeholder();
/* Syntax highlighting. */
if (syntax_highlighter.is_valid()) {
syntax_highlighter->set_text_edit(this);
}
}
/* General overrides. */
Size2 TextEdit::get_minimum_size() const {
Size2 size = style_normal->get_minimum_size();
if (fit_content_height) {
size.y += content_height_cache;
}
return size;
}
bool TextEdit::is_text_field() const {
return true;
}
Variant TextEdit::get_drag_data(const Point2 &p_point) {
if (has_selection() && selection_drag_attempt) {
String t = get_selected_text();
Label *l = memnew(Label);
l->set_text(t);
set_drag_preview(l);
return t;
}
return Variant();
}
bool TextEdit::can_drop_data(const Point2 &p_point, const Variant &p_data) const {
bool drop_override = Control::can_drop_data(p_point, p_data); // In case user wants to drop custom data.
if (drop_override) {
return drop_override;
}
return is_editable() && p_data.get_type() == Variant::STRING;
}
void TextEdit::drop_data(const Point2 &p_point, const Variant &p_data) {
Control::drop_data(p_point, p_data);
if (p_data.get_type() == Variant::STRING && is_editable()) {
Point2i pos = get_line_column_at_pos(get_local_mouse_pos());
int caret_row_tmp = pos.y;
int caret_column_tmp = pos.x;
if (selection_drag_attempt) {
selection_drag_attempt = false;
if (!is_mouse_over_selection(!Input::get_singleton()->is_key_pressed(Key::CTRL))) {
// Set caret back at selection for undo / redo.
set_caret_line(get_selection_to_line(), false, false);
set_caret_column(get_selection_to_column());
begin_complex_operation();
if (!Input::get_singleton()->is_key_pressed(Key::CTRL)) {
if (caret_row_tmp > get_selection_to_line()) {
caret_row_tmp = caret_row_tmp - (get_selection_to_line() - get_selection_from_line());
} else if (caret_row_tmp == get_selection_to_line() && caret_column_tmp >= get_selection_to_column()) {
caret_column_tmp = caret_column_tmp - (get_selection_to_column() - get_selection_from_column());
}
delete_selection();
} else {
deselect();
}
remove_secondary_carets();
set_caret_line(caret_row_tmp, true, false);
set_caret_column(caret_column_tmp);
insert_text_at_caret(p_data);
end_complex_operation();
}
} else if (is_mouse_over_selection()) {
remove_secondary_carets();
caret_row_tmp = get_selection_from_line();
caret_column_tmp = get_selection_from_column();
set_caret_line(caret_row_tmp, true, false);
set_caret_column(caret_column_tmp);
insert_text_at_caret(p_data);
grab_focus();
} else {
remove_secondary_carets();
deselect();
set_caret_line(caret_row_tmp, true, false);
set_caret_column(caret_column_tmp);
insert_text_at_caret(p_data);
grab_focus();
}
if (caret_row_tmp != get_caret_line() || caret_column_tmp != get_caret_column()) {
select(caret_row_tmp, caret_column_tmp, get_caret_line(), get_caret_column());
}
}
}
Control::CursorShape TextEdit::get_cursor_shape(const Point2 &p_pos) const {
Point2i pos = get_line_column_at_pos(p_pos);
int row = pos.y;
int left_margin = style_normal->get_margin(SIDE_LEFT);
int gutter = left_margin + gutters_width;
if (p_pos.x < gutter) {
for (int i = 0; i < gutters.size(); i++) {
if (!gutters[i].draw) {
continue;
}
if (p_pos.x >= left_margin && p_pos.x < left_margin + gutters[i].width) {
if (gutters[i].clickable || is_line_gutter_clickable(row, i)) {
return CURSOR_POINTING_HAND;
}
}
left_margin += gutters[i].width;
}
return CURSOR_ARROW;
}
int xmargin_end = get_size().width - style_normal->get_margin(SIDE_RIGHT);
if (draw_minimap && p_pos.x > xmargin_end - minimap_width && p_pos.x <= xmargin_end) {
return CURSOR_ARROW;
}
return get_default_cursor_shape();
}
String TextEdit::get_tooltip(const Point2 &p_pos) const {
if (!tooltip_callback.is_valid()) {
return Control::get_tooltip(p_pos);
}
Point2i pos = get_line_column_at_pos(p_pos);
int row = pos.y;
int col = pos.x;
String s = text[row];
if (s.length() == 0) {
return Control::get_tooltip(p_pos);
}
int beg, end;
if (select_word(s, col, beg, end)) {
Variant args[1] = { s.substr(beg, end - beg) };
const Variant *argp[] = { &args[0] };
Callable::CallError ce;
Variant ret;
tooltip_callback.callp(argp, 1, ret, ce);
ERR_FAIL_COND_V_MSG(ce.error != Callable::CallError::CALL_OK, "", "Failed to call custom tooltip.");
return ret;
}
return Control::get_tooltip(p_pos);
}
void TextEdit::set_tooltip_request_func(const Callable &p_tooltip_callback) {
tooltip_callback = p_tooltip_callback;
}
/* Text */
// Text properties.
bool TextEdit::has_ime_text() const {
return !ime_text.is_empty();
}
void TextEdit::set_editable(const bool p_editable) {
if (editable == p_editable) {
return;
}
editable = p_editable;
queue_redraw();
}
bool TextEdit::is_editable() const {
return editable;
}
void TextEdit::set_text_direction(Control::TextDirection p_text_direction) {
ERR_FAIL_COND((int)p_text_direction < -1 || (int)p_text_direction > 3);
if (text_direction != p_text_direction) {
text_direction = p_text_direction;
if (text_direction != TEXT_DIRECTION_AUTO && text_direction != TEXT_DIRECTION_INHERITED) {
input_direction = text_direction;
}
TextServer::Direction dir;
if (text_direction == Control::TEXT_DIRECTION_INHERITED) {
dir = is_layout_rtl() ? TextServer::DIRECTION_RTL : TextServer::DIRECTION_LTR;
} else {
dir = (TextServer::Direction)text_direction;
}
text.set_direction_and_language(dir, (!language.is_empty()) ? language : TranslationServer::get_singleton()->get_tool_locale());
text.invalidate_font();
_update_placeholder();
if (menu_dir) {
menu_dir->set_item_checked(menu_dir->get_item_index(MENU_DIR_INHERITED), text_direction == TEXT_DIRECTION_INHERITED);
menu_dir->set_item_checked(menu_dir->get_item_index(MENU_DIR_AUTO), text_direction == TEXT_DIRECTION_AUTO);
menu_dir->set_item_checked(menu_dir->get_item_index(MENU_DIR_LTR), text_direction == TEXT_DIRECTION_LTR);
menu_dir->set_item_checked(menu_dir->get_item_index(MENU_DIR_RTL), text_direction == TEXT_DIRECTION_RTL);
}
queue_redraw();
}
}
Control::TextDirection TextEdit::get_text_direction() const {
return text_direction;
}
void TextEdit::set_language(const String &p_language) {
if (language != p_language) {
language = p_language;
TextServer::Direction dir;
if (text_direction == Control::TEXT_DIRECTION_INHERITED) {
dir = is_layout_rtl() ? TextServer::DIRECTION_RTL : TextServer::DIRECTION_LTR;
} else {
dir = (TextServer::Direction)text_direction;
}
text.set_direction_and_language(dir, (!language.is_empty()) ? language : TranslationServer::get_singleton()->get_tool_locale());
text.invalidate_all();
_update_placeholder();
queue_redraw();
}
}
String TextEdit::get_language() const {
return language;
}
void TextEdit::set_structured_text_bidi_override(TextServer::StructuredTextParser p_parser) {
if (st_parser != p_parser) {
st_parser = p_parser;
for (int i = 0; i < text.size(); i++) {
text.set(i, text[i], structured_text_parser(st_parser, st_args, text[i]));
}
queue_redraw();
}
}
TextServer::StructuredTextParser TextEdit::get_structured_text_bidi_override() const {
return st_parser;
}
void TextEdit::set_structured_text_bidi_override_options(Array p_args) {
if (st_args == p_args) {
return;
}
st_args = p_args;
for (int i = 0; i < text.size(); i++) {
text.set(i, text[i], structured_text_parser(st_parser, st_args, text[i]));
}
queue_redraw();
}
Array TextEdit::get_structured_text_bidi_override_options() const {
return st_args;
}
void TextEdit::set_tab_size(const int p_size) {
ERR_FAIL_COND_MSG(p_size <= 0, "Tab size must be greater than 0.");
if (p_size == text.get_tab_size()) {
return;
}
text.set_tab_size(p_size);
text.invalidate_all_lines();
_update_placeholder();
queue_redraw();
}
int TextEdit::get_tab_size() const {
return text.get_tab_size();
}
// User controls
void TextEdit::set_overtype_mode_enabled(const bool p_enabled) {
if (overtype_mode == p_enabled) {
return;
}
overtype_mode = p_enabled;
queue_redraw();
}
bool TextEdit::is_overtype_mode_enabled() const {
return overtype_mode;
}
void TextEdit::set_context_menu_enabled(bool p_enabled) {
context_menu_enabled = p_enabled;
}
bool TextEdit::is_context_menu_enabled() const {
return context_menu_enabled;
}
void TextEdit::set_shortcut_keys_enabled(bool p_enabled) {
shortcut_keys_enabled = p_enabled;
}
bool TextEdit::is_shortcut_keys_enabled() const {
return shortcut_keys_enabled;
}
void TextEdit::set_virtual_keyboard_enabled(bool p_enabled) {
virtual_keyboard_enabled = p_enabled;
}
bool TextEdit::is_virtual_keyboard_enabled() const {
return virtual_keyboard_enabled;
}
void TextEdit::set_middle_mouse_paste_enabled(bool p_enabled) {
middle_mouse_paste_enabled = p_enabled;
}
bool TextEdit::is_middle_mouse_paste_enabled() const {
return middle_mouse_paste_enabled;
}
// Text manipulation
void TextEdit::clear() {
setting_text = true;
_clear();
setting_text = false;
emit_signal(SNAME("text_set"));
}
void TextEdit::_clear() {
if (editable && undo_enabled) {
remove_secondary_carets();
_move_caret_document_start(false);
begin_complex_operation();
_remove_text(0, 0, MAX(0, get_line_count() - 1), MAX(get_line(MAX(get_line_count() - 1, 0)).size() - 1, 0));
insert_text_at_caret("");
text.clear();
end_complex_operation();
return;
}
// Cannot merge with above, as we are not part of the tree on creation.
int old_text_size = text.size();
clear_undo_history();
text.clear();
remove_secondary_carets();
set_caret_line(0, false);
set_caret_column(0);
first_visible_col = 0;
first_visible_line = 0;
first_visible_line_wrap_ofs = 0;
carets.write[0].last_fit_x = 0;
deselect();
emit_signal(SNAME("lines_edited_from"), old_text_size, 0);
}
void TextEdit::set_text(const String &p_text) {
setting_text = true;
if (!undo_enabled) {
_clear();
insert_text_at_caret(p_text);
}
if (undo_enabled) {
remove_secondary_carets();
set_caret_line(0);
set_caret_column(0);
begin_complex_operation();
deselect();
_remove_text(0, 0, MAX(0, get_line_count() - 1), MAX(get_line(MAX(get_line_count() - 1, 0)).size() - 1, 0));
insert_text_at_caret(p_text);
end_complex_operation();
}
set_caret_line(0);
set_caret_column(0);
queue_redraw();
setting_text = false;
emit_signal(SNAME("text_set"));
}
String TextEdit::get_text() const {
StringBuilder ret_text;
const int text_size = text.size();
for (int i = 0; i < text_size; i++) {
ret_text += text[i];
if (i != text_size - 1) {
ret_text += "\n";
}
}
return ret_text.as_string();
}
int TextEdit::get_line_count() const {
return text.size();
}
void TextEdit::set_placeholder(const String &p_text) {
if (placeholder_text == p_text) {
return;
}
placeholder_text = p_text;
_update_placeholder();
queue_redraw();
}
String TextEdit::get_placeholder() const {
return placeholder_text;
}
void TextEdit::set_line(int p_line, const String &p_new_text) {
if (p_line < 0 || p_line >= text.size()) {
return;
}
begin_complex_operation();
_remove_text(p_line, 0, p_line, text[p_line].length());
_insert_text(p_line, 0, p_new_text);
for (int i = 0; i < carets.size(); i++) {
if (get_caret_line(i) == p_line && get_caret_column(i) > p_new_text.length()) {
set_caret_column(p_new_text.length(), false, i);
}
if (has_selection(i) && p_line == get_selection_to_line(i) && get_selection_to_column(i) > text[p_line].length()) {
carets.write[i].selection.to_column = text[p_line].length();
}
}
end_complex_operation();
}
String TextEdit::get_line(int p_line) const {
if (p_line < 0 || p_line >= text.size()) {
return "";
}
return text[p_line];
}
int TextEdit::get_line_width(int p_line, int p_wrap_index) const {
ERR_FAIL_INDEX_V(p_line, text.size(), 0);
ERR_FAIL_COND_V(p_wrap_index > get_line_wrap_count(p_line), 0);
return text.get_line_width(p_line, p_wrap_index);
}
int TextEdit::get_line_height() const {
return text.get_line_height() + line_spacing;
}
int TextEdit::get_indent_level(int p_line) const {
ERR_FAIL_INDEX_V(p_line, text.size(), 0);
int tab_count = 0;
int whitespace_count = 0;
int line_length = text[p_line].size();
for (int i = 0; i < line_length - 1; i++) {
if (text[p_line][i] == '\t') {
tab_count++;
} else if (text[p_line][i] == ' ') {
whitespace_count++;
} else {
break;
}
}
return tab_count * text.get_tab_size() + whitespace_count;
}
int TextEdit::get_first_non_whitespace_column(int p_line) const {
ERR_FAIL_INDEX_V(p_line, text.size(), 0);
int col = 0;
while (col < text[p_line].length() && is_whitespace(text[p_line][col])) {
col++;
}
return col;
}
void TextEdit::swap_lines(int p_from_line, int p_to_line) {
ERR_FAIL_INDEX(p_from_line, text.size());
ERR_FAIL_INDEX(p_to_line, text.size());
String tmp = get_line(p_from_line);
String tmp2 = get_line(p_to_line);
begin_complex_operation();
set_line(p_to_line, tmp);
set_line(p_from_line, tmp2);
end_complex_operation();
}
void TextEdit::insert_line_at(int p_at, const String &p_text) {
ERR_FAIL_INDEX(p_at, text.size());
_insert_text(p_at, 0, p_text + "\n");
for (int i = 0; i < carets.size(); i++) {
if (get_caret_line(i) >= p_at) {
// offset caret when located after inserted line
set_caret_line(get_caret_line(i) + 1, false, true, 0, i);
}
if (has_selection(i)) {
if (get_selection_from_line(i) >= p_at) {
// offset selection when located after inserted line
select(get_selection_from_line(i) + 1, get_selection_from_column(i), get_selection_to_line(i) + 1, get_selection_to_column(i), i);
} else if (get_selection_to_line(i) >= p_at) {
// extend selection that includes inserted line
select(get_selection_from_line(i), get_selection_from_column(i), get_selection_to_line(i) + 1, get_selection_to_column(i), i);
}
}
}
// Need to apply the above adjustments to the undo / redo carets.
current_op.end_carets = carets;
queue_redraw();
}
void TextEdit::insert_text_at_caret(const String &p_text, int p_caret) {
ERR_FAIL_COND(p_caret > carets.size());
begin_complex_operation();
Vector<int> caret_edit_order = get_caret_index_edit_order();
for (const int &i : caret_edit_order) {
if (p_caret != -1 && p_caret != i) {
continue;
}
delete_selection(i);
int from_line = get_caret_line(i);
int from_col = get_caret_column(i);
int new_column, new_line;
_insert_text(from_line, from_col, p_text, &new_line, &new_column);
_update_scrollbars();
set_caret_line(new_line, false, true, 0, i);
set_caret_column(new_column, i == 0, i);
adjust_carets_after_edit(i, new_line, new_column, from_line, from_col);
}
end_complex_operation();
queue_redraw();
}
void TextEdit::remove_text(int p_from_line, int p_from_column, int p_to_line, int p_to_column) {
ERR_FAIL_INDEX(p_from_line, text.size());
ERR_FAIL_INDEX(p_from_column, text[p_from_line].length() + 1);
ERR_FAIL_INDEX(p_to_line, text.size());
ERR_FAIL_INDEX(p_to_column, text[p_to_line].length() + 1);
ERR_FAIL_COND(p_to_line < p_from_line);
ERR_FAIL_COND(p_to_line == p_from_line && p_to_column < p_from_column);
_remove_text(p_from_line, p_from_column, p_to_line, p_to_column);
}
int TextEdit::get_last_unhidden_line() const {
// Returns the last line in the text that is not hidden.
if (!_is_hiding_enabled()) {
return text.size() - 1;
}
int last_line;
for (last_line = text.size() - 1; last_line > 0; last_line--) {
if (!_is_line_hidden(last_line)) {
break;
}
}
return last_line;
}
int TextEdit::get_next_visible_line_offset_from(int p_line_from, int p_visible_amount) const {
// Returns the number of lines (hidden and unhidden) from p_line_from to (p_line_from + visible_amount of unhidden lines).
ERR_FAIL_INDEX_V(p_line_from, text.size(), ABS(p_visible_amount));
if (!_is_hiding_enabled()) {
return ABS(p_visible_amount);
}
int num_visible = 0;
int num_total = 0;
if (p_visible_amount >= 0) {
for (int i = p_line_from; i < text.size(); i++) {
num_total++;
if (!_is_line_hidden(i)) {
num_visible++;
}
if (num_visible >= p_visible_amount) {
break;
}
}
} else {
p_visible_amount = ABS(p_visible_amount);
for (int i = p_line_from; i >= 0; i--) {
num_total++;
if (!_is_line_hidden(i)) {
num_visible++;
}
if (num_visible >= p_visible_amount) {
break;
}
}
}
return num_total;
}
Point2i TextEdit::get_next_visible_line_index_offset_from(int p_line_from, int p_wrap_index_from, int p_visible_amount) const {
// Returns the number of lines (hidden and unhidden) from (p_line_from + p_wrap_index_from) row to (p_line_from + visible_amount of unhidden and wrapped rows).
// Wrap index is set to the wrap index of the last line.
int wrap_index = 0;
ERR_FAIL_INDEX_V(p_line_from, text.size(), Point2i(ABS(p_visible_amount), 0));
if (!_is_hiding_enabled() && get_line_wrapping_mode() == LineWrappingMode::LINE_WRAPPING_NONE) {
return Point2i(ABS(p_visible_amount), 0);
}
int num_visible = 0;
int num_total = 0;
if (p_visible_amount == 0) {
num_total = 0;
wrap_index = 0;
} else if (p_visible_amount > 0) {
int i;
num_visible -= p_wrap_index_from;
for (i = p_line_from; i < text.size(); i++) {
num_total++;
if (!_is_line_hidden(i)) {
num_visible++;
num_visible += get_line_wrap_count(i);
}
if (num_visible >= p_visible_amount) {
break;
}
}
wrap_index = get_line_wrap_count(MIN(i, text.size() - 1)) - MAX(0, num_visible - p_visible_amount);
// If we are a hidden line, then we are the last line as we cannot reach "p_visible_amount".
// This means we need to backtrack to get last visible line.
// Currently, line 0 cannot be hidden so this should always be valid.
int line = (p_line_from + num_total) - 1;
if (_is_line_hidden(line)) {
Point2i backtrack = get_next_visible_line_index_offset_from(line, 0, -1);
num_total = num_total - (backtrack.x - 1);
wrap_index = backtrack.y;
}
} else {
p_visible_amount = ABS(p_visible_amount);
int i;
num_visible -= get_line_wrap_count(p_line_from) - p_wrap_index_from;
for (i = p_line_from; i >= 0; i--) {
num_total++;
if (!_is_line_hidden(i)) {
num_visible++;
num_visible += get_line_wrap_count(i);
}
if (num_visible >= p_visible_amount) {
break;
}
}
wrap_index = MAX(0, num_visible - p_visible_amount);
}
wrap_index = MAX(wrap_index, 0);
return Point2i(num_total, wrap_index);
}
// Overridable actions
void TextEdit::handle_unicode_input(const uint32_t p_unicode, int p_caret) {
if (GDVIRTUAL_CALL(_handle_unicode_input, p_unicode, p_caret)) {
return;
}
_handle_unicode_input_internal(p_unicode, p_caret);
}
void TextEdit::backspace(int p_caret) {
if (GDVIRTUAL_CALL(_backspace, p_caret)) {
return;
}
_backspace_internal(p_caret);
}
void TextEdit::cut(int p_caret) {
if (GDVIRTUAL_CALL(_cut, p_caret)) {
return;
}
_cut_internal(p_caret);
}
void TextEdit::copy(int p_caret) {
if (GDVIRTUAL_CALL(_copy, p_caret)) {
return;
}
_copy_internal(p_caret);
}
void TextEdit::paste(int p_caret) {
if (GDVIRTUAL_CALL(_paste, p_caret)) {
return;
}
_paste_internal(p_caret);
}
void TextEdit::paste_primary_clipboard(int p_caret) {
if (GDVIRTUAL_CALL(_paste_primary_clipboard, p_caret)) {
return;
}
_paste_primary_clipboard_internal(p_caret);
}
// Context menu.
PopupMenu *TextEdit::get_menu() const {
const_cast<TextEdit *>(this)->_generate_context_menu();
return menu;
}
bool TextEdit::is_menu_visible() const {
return menu && menu->is_visible();
}
void TextEdit::menu_option(int p_option) {
switch (p_option) {
case MENU_CUT: {
cut();
} break;
case MENU_COPY: {
copy();
} break;
case MENU_PASTE: {
paste();
} break;
case MENU_CLEAR: {
if (editable) {
clear();
}
} break;
case MENU_SELECT_ALL: {
select_all();
} break;
case MENU_UNDO: {
undo();
} break;
case MENU_REDO: {
redo();
} break;
case MENU_DIR_INHERITED: {
set_text_direction(TEXT_DIRECTION_INHERITED);
} break;
case MENU_DIR_AUTO: {
set_text_direction(TEXT_DIRECTION_AUTO);
} break;
case MENU_DIR_LTR: {
set_text_direction(TEXT_DIRECTION_LTR);
} break;
case MENU_DIR_RTL: {
set_text_direction(TEXT_DIRECTION_RTL);
} break;
case MENU_DISPLAY_UCC: {
set_draw_control_chars(!get_draw_control_chars());
} break;
case MENU_INSERT_LRM: {
if (editable) {
insert_text_at_caret(String::chr(0x200E));
}
} break;
case MENU_INSERT_RLM: {
if (editable) {
insert_text_at_caret(String::chr(0x200F));
}
} break;
case MENU_INSERT_LRE: {
if (editable) {
insert_text_at_caret(String::chr(0x202A));
}
} break;
case MENU_INSERT_RLE: {
if (editable) {
insert_text_at_caret(String::chr(0x202B));
}
} break;
case MENU_INSERT_LRO: {
if (editable) {
insert_text_at_caret(String::chr(0x202D));
}
} break;
case MENU_INSERT_RLO: {
if (editable) {
insert_text_at_caret(String::chr(0x202E));
}
} break;
case MENU_INSERT_PDF: {
if (editable) {
insert_text_at_caret(String::chr(0x202C));
}
} break;
case MENU_INSERT_ALM: {
if (editable) {
insert_text_at_caret(String::chr(0x061C));
}
} break;
case MENU_INSERT_LRI: {
if (editable) {
insert_text_at_caret(String::chr(0x2066));
}
} break;
case MENU_INSERT_RLI: {
if (editable) {
insert_text_at_caret(String::chr(0x2067));
}
} break;
case MENU_INSERT_FSI: {
if (editable) {
insert_text_at_caret(String::chr(0x2068));
}
} break;
case MENU_INSERT_PDI: {
if (editable) {
insert_text_at_caret(String::chr(0x2069));
}
} break;
case MENU_INSERT_ZWJ: {
if (editable) {
insert_text_at_caret(String::chr(0x200D));
}
} break;
case MENU_INSERT_ZWNJ: {
if (editable) {
insert_text_at_caret(String::chr(0x200C));
}
} break;
case MENU_INSERT_WJ: {
if (editable) {
insert_text_at_caret(String::chr(0x2060));
}
} break;
case MENU_INSERT_SHY: {
if (editable) {
insert_text_at_caret(String::chr(0x00AD));
}
}
}
}
/* Versioning */
void TextEdit::start_action(EditAction p_action) {
if (current_action != p_action) {
if (current_action != EditAction::ACTION_NONE) {
in_action = false;
pending_action_end = false;
end_complex_operation();
}
if (p_action != EditAction::ACTION_NONE) {
in_action = true;
begin_complex_operation();
}
} else if (current_action != EditAction::ACTION_NONE) {
pending_action_end = false;
}
current_action = p_action;
}
void TextEdit::end_action() {
if (current_action != EditAction::ACTION_NONE) {
pending_action_end = true;
}
}
TextEdit::EditAction TextEdit::get_current_action() const {
return current_action;
}
void TextEdit::begin_complex_operation() {
_push_current_op();
if (complex_operation_count == 0) {
next_operation_is_complex = true;
current_op.start_carets = carets;
}
complex_operation_count++;
}
void TextEdit::end_complex_operation() {
_push_current_op();
complex_operation_count = MAX(complex_operation_count - 1, 0);
if (complex_operation_count > 0) {
return;
}
ERR_FAIL_COND(undo_stack.size() == 0);
undo_stack.back()->get().end_carets = carets;
if (undo_stack.back()->get().chain_forward) {
undo_stack.back()->get().chain_forward = false;
return;
}
undo_stack.back()->get().chain_backward = true;
}
bool TextEdit::has_undo() const {
if (undo_stack_pos == nullptr) {
int pending = current_op.type == TextOperation::TYPE_NONE ? 0 : 1;
return undo_stack.size() + pending > 0;
}
return undo_stack_pos != undo_stack.front();
}
bool TextEdit::has_redo() const {
return undo_stack_pos != nullptr;
}
void TextEdit::undo() {
if (!editable) {
return;
}
if (in_action) {
pending_action_end = true;
}
_push_current_op();
if (undo_stack_pos == nullptr) {
if (!undo_stack.size()) {
return; // Nothing to undo.
}
undo_stack_pos = undo_stack.back();
} else if (undo_stack_pos == undo_stack.front()) {
return; // At the bottom of the undo stack.
} else {
undo_stack_pos = undo_stack_pos->prev();
}
deselect();
TextOperation op = undo_stack_pos->get();
_do_text_op(op, true);
current_op.version = op.prev_version;
if (undo_stack_pos->get().chain_backward) {
while (true) {
ERR_BREAK(!undo_stack_pos->prev());
undo_stack_pos = undo_stack_pos->prev();
op = undo_stack_pos->get();
_do_text_op(op, true);
current_op.version = op.prev_version;
if (undo_stack_pos->get().chain_forward) {
break;
}
}
}
_update_scrollbars();
bool dirty_carets = carets.size() != undo_stack_pos->get().start_carets.size();
if (!dirty_carets) {
for (int i = 0; i < carets.size(); i++) {
if (carets[i].line != undo_stack_pos->get().start_carets[i].line || carets[i].column != undo_stack_pos->get().start_carets[i].column) {
dirty_carets = true;
break;
}
}
}
carets = undo_stack_pos->get().start_carets;
if (dirty_carets && !caret_pos_dirty) {
if (is_inside_tree()) {
MessageQueue::get_singleton()->push_call(this, "_emit_caret_changed");
}
caret_pos_dirty = true;
}
adjust_viewport_to_caret();
}
void TextEdit::redo() {
if (!editable) {
return;
}
if (in_action) {
pending_action_end = true;
}
_push_current_op();
if (undo_stack_pos == nullptr) {
return; // Nothing to do.
}
deselect();
TextOperation op = undo_stack_pos->get();
_do_text_op(op, false);
current_op.version = op.version;
if (undo_stack_pos->get().chain_forward) {
while (true) {
ERR_BREAK(!undo_stack_pos->next());
undo_stack_pos = undo_stack_pos->next();
op = undo_stack_pos->get();
_do_text_op(op, false);
current_op.version = op.version;
if (undo_stack_pos->get().chain_backward) {
break;
}
}
}
_update_scrollbars();
bool dirty_carets = carets.size() != undo_stack_pos->get().end_carets.size();
if (!dirty_carets) {
for (int i = 0; i < carets.size(); i++) {
if (carets[i].line != undo_stack_pos->get().end_carets[i].line || carets[i].column != undo_stack_pos->get().end_carets[i].column) {
dirty_carets = true;
break;
}
}
}
carets = undo_stack_pos->get().end_carets;
undo_stack_pos = undo_stack_pos->next();
if (dirty_carets && !caret_pos_dirty) {
if (is_inside_tree()) {
MessageQueue::get_singleton()->push_call(this, "_emit_caret_changed");
}
caret_pos_dirty = true;
}
adjust_viewport_to_caret();
}
void TextEdit::clear_undo_history() {
saved_version = 0;
current_op.type = TextOperation::TYPE_NONE;
undo_stack_pos = nullptr;
undo_stack.clear();
}
bool TextEdit::is_insert_text_operation() const {
return (current_op.type == TextOperation::TYPE_INSERT || current_action == EditAction::ACTION_TYPING);
}
void TextEdit::tag_saved_version() {
saved_version = get_version();
}
uint32_t TextEdit::get_version() const {
return current_op.version;
}
uint32_t TextEdit::get_saved_version() const {
return saved_version;
}
/* Search */
void TextEdit::set_search_text(const String &p_search_text) {
search_text = p_search_text;
}
void TextEdit::set_search_flags(uint32_t p_flags) {
search_flags = p_flags;
}
Point2i TextEdit::search(const String &p_key, uint32_t p_search_flags, int p_from_line, int p_from_column) const {
if (p_key.length() == 0) {
return Point2(-1, -1);
}
ERR_FAIL_INDEX_V(p_from_line, text.size(), Point2i(-1, -1));
ERR_FAIL_INDEX_V(p_from_column, text[p_from_line].length() + 1, Point2i(-1, -1));
// Search through the whole document, but start by current line.
int line = p_from_line;
int pos = -1;
for (int i = 0; i < text.size() + 1; i++) {
if (line < 0) {
line = text.size() - 1;
}
if (line == text.size()) {
line = 0;
}
String text_line = text[line];
int from_column = 0;
if (line == p_from_line) {
if (i == text.size()) {
// Wrapped.
if (p_search_flags & SEARCH_BACKWARDS) {
from_column = text_line.length();
} else {
from_column = 0;
}
} else {
from_column = p_from_column;
}
} else {
if (p_search_flags & SEARCH_BACKWARDS) {
from_column = text_line.length() - 1;
} else {
from_column = 0;
}
}
pos = -1;
int pos_from = (p_search_flags & SEARCH_BACKWARDS) ? text_line.length() : 0;
int last_pos = -1;
while (true) {
if (p_search_flags & SEARCH_BACKWARDS) {
while ((last_pos = (p_search_flags & SEARCH_MATCH_CASE) ? text_line.rfind(p_key, pos_from) : text_line.rfindn(p_key, pos_from)) != -1) {
if (last_pos <= from_column) {
pos = last_pos;
break;
}
pos_from = last_pos - p_key.length();
if (pos_from < 0) {
break;
}
}
} else {
while ((last_pos = (p_search_flags & SEARCH_MATCH_CASE) ? text_line.find(p_key, pos_from) : text_line.findn(p_key, pos_from)) != -1) {
if (last_pos >= from_column) {
pos = last_pos;
break;
}
pos_from = last_pos + p_key.length();
}
}
bool is_match = true;
if (pos != -1 && (p_search_flags & SEARCH_WHOLE_WORDS)) {
// Validate for whole words.
if (pos > 0 && !is_symbol(text_line[pos - 1])) {
is_match = false;
} else if (pos + p_key.length() < text_line.length() && !is_symbol(text_line[pos + p_key.length()])) {
is_match = false;
}
}
if (pos_from == -1) {
pos = -1;
}
if (is_match || last_pos == -1 || pos == -1) {
break;
}
pos_from = (p_search_flags & SEARCH_BACKWARDS) ? pos - 1 : pos + 1;
pos = -1;
}
if (pos != -1) {
break;
}
if (p_search_flags & SEARCH_BACKWARDS) {
line--;
} else {
line++;
}
}
return (pos == -1) ? Point2i(-1, -1) : Point2i(pos, line);
}
/* Mouse */
Point2 TextEdit::get_local_mouse_pos() const {
Point2 mp = get_local_mouse_position();
if (is_layout_rtl()) {
mp.x = get_size().width - mp.x;
}
return mp;
}
String TextEdit::get_word_at_pos(const Vector2 &p_pos) const {
Point2i pos = get_line_column_at_pos(p_pos);
int row = pos.y;
int col = pos.x;
String s = text[row];
if (s.length() == 0) {
return "";
}
int beg, end;
if (select_word(s, col, beg, end)) {
bool inside_quotes = false;
char32_t selected_quote = '\0';
int qbegin = 0, qend = 0;
for (int i = 0; i < s.length(); i++) {
if (s[i] == '"' || s[i] == '\'') {
if (i == 0 || s[i - 1] != '\\') {
if (inside_quotes && selected_quote == s[i]) {
qend = i;
inside_quotes = false;
selected_quote = '\0';
if (col >= qbegin && col <= qend) {
return s.substr(qbegin, qend - qbegin);
}
} else if (!inside_quotes) {
qbegin = i + 1;
inside_quotes = true;
selected_quote = s[i];
}
}
}
}
return s.substr(beg, end - beg);
}
return String();
}
Point2i TextEdit::get_line_column_at_pos(const Point2i &p_pos, bool p_allow_out_of_bounds) const {
float rows = p_pos.y;
rows -= style_normal->get_margin(SIDE_TOP);
rows /= get_line_height();
rows += _get_v_scroll_offset();
int first_vis_line = get_first_visible_line();
int row = first_vis_line + Math::floor(rows);
int wrap_index = 0;
if (get_line_wrapping_mode() != LineWrappingMode::LINE_WRAPPING_NONE || _is_hiding_enabled()) {
Point2i f_ofs = get_next_visible_line_index_offset_from(first_vis_line, first_visible_line_wrap_ofs, rows + (1 * SIGN(rows)));
wrap_index = f_ofs.y;
if (rows < 0) {
row = first_vis_line - (f_ofs.x - 1);
} else {
row = first_vis_line + (f_ofs.x - 1);
}
}
if (row < 0) {
row = 0;
}
if (row >= text.size()) {
row = text.size() - 1;
}
int visible_lines = get_visible_line_count_in_range(first_vis_line, row);
if (rows > visible_lines) {
if (!p_allow_out_of_bounds) {
return Point2i(-1, -1);
}
return Point2i(text[row].length(), row);
}
int col = 0;
int colx = p_pos.x - (style_normal->get_margin(SIDE_LEFT) + gutters_width + gutter_padding);
colx += first_visible_col;
col = _get_char_pos_for_line(colx, row, wrap_index);
if (get_line_wrapping_mode() != LineWrappingMode::LINE_WRAPPING_NONE && wrap_index < get_line_wrap_count(row)) {
// Move back one if we are at the end of the row.
Vector<String> rows2 = get_line_wrapped_text(row);
int row_end_col = 0;
for (int i = 0; i < wrap_index + 1; i++) {
row_end_col += rows2[i].length();
}
if (col >= row_end_col) {
col -= 1;
}
}
RID text_rid = text.get_line_data(row)->get_line_rid(wrap_index);
if (is_layout_rtl()) {
colx = TS->shaped_text_get_size(text_rid).x - colx;
}
col = TS->shaped_text_hit_test_position(text_rid, colx);
return Point2i(col, row);
}
Point2i TextEdit::get_pos_at_line_column(int p_line, int p_column) const {
Rect2i rect = get_rect_at_line_column(p_line, p_column);
return rect.position.x == -1 ? rect.position : rect.position + Vector2i(0, get_line_height());
}
Rect2i TextEdit::get_rect_at_line_column(int p_line, int p_column) const {
ERR_FAIL_INDEX_V(p_line, text.size(), Rect2i(-1, -1, 0, 0));
ERR_FAIL_COND_V(p_column < 0, Rect2i(-1, -1, 0, 0));
ERR_FAIL_COND_V(p_column > text[p_line].length(), Rect2i(-1, -1, 0, 0));
if (line_drawing_cache.size() == 0 || !line_drawing_cache.has(p_line)) {
// Line is not in the cache, which means it's outside of the viewing area.
return Rect2i(-1, -1, 0, 0);
}
LineDrawingCache cache_entry = line_drawing_cache[p_line];
int wrap_index = get_line_wrap_index_at_column(p_line, p_column);
if (wrap_index >= cache_entry.first_visible_chars.size()) {
// Line seems to be wrapped beyond the viewable area.
return Rect2i(-1, -1, 0, 0);
}
int first_visible_char = cache_entry.first_visible_chars[wrap_index];
int last_visible_char = cache_entry.last_visible_chars[wrap_index];
if (p_column < first_visible_char || p_column > last_visible_char) {
// Character is outside of the viewing area, no point calculating its position.
return Rect2i(-1, -1, 0, 0);
}
Point2i pos, size;
pos.y = cache_entry.y_offset + get_line_height() * wrap_index;
pos.x = get_total_gutter_width() + style_normal->get_margin(SIDE_LEFT) - get_h_scroll();
RID text_rid = text.get_line_data(p_line)->get_line_rid(wrap_index);
Vector2 col_bounds = TS->shaped_text_get_grapheme_bounds(text_rid, p_column);
pos.x += col_bounds.x;
size.x = col_bounds.y - col_bounds.x;
size.y = get_line_height();
return Rect2i(pos, size);
}
int TextEdit::get_minimap_line_at_pos(const Point2i &p_pos) const {
float rows = p_pos.y;
rows -= style_normal->get_margin(SIDE_TOP);
rows /= (minimap_char_size.y + minimap_line_spacing);
rows += _get_v_scroll_offset();
// calculate visible lines
int minimap_visible_lines = get_minimap_visible_lines();
int visible_rows = get_visible_line_count() + 1;
int first_vis_line = get_first_visible_line() - 1;
int draw_amount = visible_rows + (smooth_scroll_enabled ? 1 : 0);
draw_amount += get_line_wrap_count(first_vis_line + 1);
int minimap_line_height = (minimap_char_size.y + minimap_line_spacing);
// calculate viewport size and y offset
int viewport_height = (draw_amount - 1) * minimap_line_height;
int control_height = _get_control_height() - viewport_height;
int viewport_offset_y = round(get_scroll_pos_for_line(first_vis_line + 1) * control_height) / ((v_scroll->get_max() <= minimap_visible_lines) ? (minimap_visible_lines - draw_amount) : (v_scroll->get_max() - draw_amount));
// calculate the first line.
int num_lines_before = round((viewport_offset_y) / minimap_line_height);
int minimap_line = (v_scroll->get_max() <= minimap_visible_lines) ? -1 : first_vis_line;
if (first_vis_line > 0 && minimap_line >= 0) {
minimap_line -= get_next_visible_line_index_offset_from(first_vis_line, 0, -num_lines_before).x;
minimap_line -= (minimap_line > 0 && smooth_scroll_enabled ? 1 : 0);
} else {
minimap_line = 0;
}
int row = minimap_line + Math::floor(rows);
if (get_line_wrapping_mode() != LineWrappingMode::LINE_WRAPPING_NONE || _is_hiding_enabled()) {
int f_ofs = get_next_visible_line_index_offset_from(minimap_line, first_visible_line_wrap_ofs, rows + (1 * SIGN(rows))).x - 1;
if (rows < 0) {
row = minimap_line - f_ofs;
} else {
row = minimap_line + f_ofs;
}
}
if (row < 0) {
row = 0;
}
if (row >= text.size()) {
row = text.size() - 1;
}
return row;
}
bool TextEdit::is_dragging_cursor() const {
return dragging_selection || dragging_minimap;
}
bool TextEdit::is_mouse_over_selection(bool p_edges, int p_caret) const {
for (int i = 0; i < carets.size(); i++) {
if (p_caret != -1 && p_caret != i) {
continue;
}
if (!has_selection(i)) {
continue;
}
Point2i pos = get_line_column_at_pos(get_local_mouse_pos());
int row = pos.y;
int col = pos.x;
if (p_edges) {
if ((row == get_selection_from_line(i) && col == get_selection_from_column(i)) || (row == get_selection_to_line(i) && col == get_selection_to_column(i))) {
return true;
}
}
if (row >= get_selection_from_line(i) && row <= get_selection_to_line(i) && (row > get_selection_from_line(i) || col > get_selection_from_column(i)) && (row < get_selection_to_line(i) || col < get_selection_to_column(i))) {
return true;
}
}
return false;
}
/* Caret */
void TextEdit::set_caret_type(CaretType p_type) {
if (caret_type == p_type) {
return;
}
caret_type = p_type;
queue_redraw();
}
TextEdit::CaretType TextEdit::get_caret_type() const {
return caret_type;
}
void TextEdit::set_caret_blink_enabled(const bool p_enabled) {
if (caret_blink_enabled == p_enabled) {
return;
}
caret_blink_enabled = p_enabled;
if (has_focus()) {
if (p_enabled) {
caret_blink_timer->start();
} else {
caret_blink_timer->stop();
}
}
draw_caret = true;
}
bool TextEdit::is_caret_blink_enabled() const {
return caret_blink_enabled;
}
float TextEdit::get_caret_blink_interval() const {
return caret_blink_timer->get_wait_time();
}
void TextEdit::set_caret_blink_interval(const float p_interval) {
ERR_FAIL_COND(p_interval <= 0);
caret_blink_timer->set_wait_time(p_interval);
}
void TextEdit::set_move_caret_on_right_click_enabled(const bool p_enabled) {
move_caret_on_right_click = p_enabled;
}
bool TextEdit::is_move_caret_on_right_click_enabled() const {
return move_caret_on_right_click;
}
void TextEdit::set_caret_mid_grapheme_enabled(const bool p_enabled) {
caret_mid_grapheme_enabled = p_enabled;
}
bool TextEdit::is_caret_mid_grapheme_enabled() const {
return caret_mid_grapheme_enabled;
}
void TextEdit::set_multiple_carets_enabled(bool p_enabled) {
multi_carets_enabled = p_enabled;
if (!multi_carets_enabled) {
remove_secondary_carets();
}
}
bool TextEdit::is_multiple_carets_enabled() const {
return multi_carets_enabled;
}
int TextEdit::add_caret(int p_line, int p_col) {
if (!multi_carets_enabled) {
return -1;
}
p_line = CLAMP(p_line, 0, text.size() - 1);
p_col = CLAMP(p_col, 0, get_line(p_line).length());
for (int i = 0; i < carets.size(); i++) {
if (get_caret_line(i) == p_line && get_caret_column(i) == p_col) {
return -1;
}
if (has_selection(i)) {
if (p_line >= get_selection_from_line(i) && p_line <= get_selection_to_line(i) && (p_line > get_selection_from_line(i) || p_col >= get_selection_from_column(i)) && (p_line < get_selection_to_line(i) || p_col <= get_selection_to_column(i))) {
return -1;
}
}
}
carets.push_back(Caret());
set_caret_line(p_line, false, false, 0, carets.size() - 1);
set_caret_column(p_col, false, carets.size() - 1);
caret_index_edit_dirty = true;
return carets.size() - 1;
}
void TextEdit::remove_caret(int p_caret) {
ERR_FAIL_COND_MSG(carets.size() <= 1, "The main caret should not be removed.");
ERR_FAIL_INDEX(p_caret, carets.size());
carets.remove_at(p_caret);
caret_index_edit_dirty = true;
}
void TextEdit::remove_secondary_carets() {
carets.resize(1);
caret_index_edit_dirty = true;
queue_redraw();
}
void TextEdit::merge_overlapping_carets() {
Vector<int> caret_edit_order = get_caret_index_edit_order();
for (int i = 0; i < caret_edit_order.size() - 1; i++) {
int first_caret = caret_edit_order[i];
int second_caret = caret_edit_order[i + 1];
// Both have selection.
if (has_selection(first_caret) && has_selection(second_caret)) {
bool should_merge = false;
if (get_selection_from_line(first_caret) >= get_selection_from_line(second_caret) && get_selection_from_line(first_caret) <= get_selection_to_line(second_caret) && (get_selection_from_line(first_caret) > get_selection_from_line(second_caret) || get_selection_from_column(first_caret) >= get_selection_from_column(second_caret)) && (get_selection_from_line(first_caret) < get_selection_to_line(second_caret) || get_selection_from_column(first_caret) <= get_selection_to_column(second_caret))) {
should_merge = true;
}
if (get_selection_to_line(first_caret) >= get_selection_from_line(second_caret) && get_selection_to_line(first_caret) <= get_selection_to_line(second_caret) && (get_selection_to_line(first_caret) > get_selection_from_line(second_caret) || get_selection_to_column(first_caret) >= get_selection_from_column(second_caret)) && (get_selection_to_line(first_caret) < get_selection_to_line(second_caret) || get_selection_to_column(first_caret) <= get_selection_to_column(second_caret))) {
should_merge = true;
}
if (!should_merge) {
continue;
}
// Save the newest one for click+drag.
int caret_to_save = first_caret;
int caret_to_remove = second_caret;
if (first_caret < second_caret) {
caret_to_save = second_caret;
caret_to_remove = first_caret;
}
int from_line = MIN(get_selection_from_line(caret_to_save), get_selection_from_line(caret_to_remove));
int to_line = MAX(get_selection_to_line(caret_to_save), get_selection_to_line(caret_to_remove));
int from_col = get_selection_from_column(caret_to_save);
int to_col = get_selection_to_column(caret_to_save);
int selection_line = get_selection_line(caret_to_save);
int selection_col = get_selection_column(caret_to_save);
bool at_from = (get_caret_line(caret_to_save) == get_selection_from_line(caret_to_save) && get_caret_column(caret_to_save) == get_selection_from_column(caret_to_save));
if (at_from) {
if (get_selection_line(caret_to_remove) > get_selection_line(caret_to_save) || (get_selection_line(caret_to_remove) == get_selection_line(caret_to_save) && get_selection_column(caret_to_remove) >= get_selection_column(caret_to_save))) {
selection_line = get_selection_line(caret_to_remove);
selection_col = get_selection_column(caret_to_remove);
}
} else if (get_selection_line(caret_to_remove) < get_selection_line(caret_to_save) || (get_selection_line(caret_to_remove) == get_selection_line(caret_to_save) && get_selection_column(caret_to_remove) <= get_selection_column(caret_to_save))) {
selection_line = get_selection_line(caret_to_remove);
selection_col = get_selection_column(caret_to_remove);
}
if (get_selection_from_line(caret_to_remove) < get_selection_from_line(caret_to_save) || (get_selection_from_line(caret_to_remove) == get_selection_from_line(caret_to_save) && get_selection_from_column(caret_to_remove) <= get_selection_from_column(caret_to_save))) {
from_col = get_selection_from_column(caret_to_remove);
} else {
to_col = get_selection_to_column(caret_to_remove);
}
select(from_line, from_col, to_line, to_col, caret_to_save);
set_selection_mode(selecting_mode, selection_line, selection_col, caret_to_save);
set_caret_line((at_from ? from_line : to_line), caret_to_save == 0, true, 0, caret_to_save);
set_caret_column((at_from ? from_col : to_col), caret_to_save == 0, caret_to_save);
remove_caret(caret_to_remove);
i--;
caret_edit_order = get_caret_index_edit_order();
continue;
}
// Only first has selection.
if (has_selection(first_caret)) {
if (get_caret_line(second_caret) >= get_selection_from_line(first_caret) && get_caret_line(second_caret) <= get_selection_to_line(first_caret) && (get_caret_line(second_caret) > get_selection_from_line(first_caret) || get_caret_column(second_caret) >= get_selection_from_column(first_caret)) && (get_caret_line(second_caret) < get_selection_to_line(first_caret) || get_caret_column(second_caret) <= get_selection_to_column(first_caret))) {
remove_caret(second_caret);
caret_edit_order = get_caret_index_edit_order();
i--;
}
continue;
}
// Only second has Selection.
if (has_selection(second_caret)) {
if (get_caret_line(first_caret) >= get_selection_from_line(second_caret) && get_caret_line(first_caret) <= get_selection_to_line(second_caret) && (get_caret_line(first_caret) > get_selection_from_line(second_caret) || get_caret_column(first_caret) >= get_selection_from_column(second_caret)) && (get_caret_line(first_caret) < get_selection_to_line(second_caret) || get_caret_column(first_caret) <= get_selection_to_column(second_caret))) {
remove_caret(first_caret);
caret_edit_order = get_caret_index_edit_order();
i--;
}
continue;
}
// Both have no selection.
if (get_caret_line(first_caret) == get_caret_line(second_caret) && get_caret_column(first_caret) == get_caret_column(second_caret)) {
// Save the newest one for click+drag.
if (first_caret < second_caret) {
remove_caret(first_caret);
} else {
remove_caret(second_caret);
}
i--;
caret_edit_order = get_caret_index_edit_order();
continue;
}
}
}
int TextEdit::get_caret_count() const {
return carets.size();
}
void TextEdit::add_caret_at_carets(bool p_below) {
Vector<int> caret_edit_order = get_caret_index_edit_order();
for (const int &caret_index : caret_edit_order) {
const int caret_line = get_caret_line(caret_index);
const int caret_column = get_caret_column(caret_index);
// The last fit x will be cleared if the caret has a selection,
// but if it does not have a selection the last fit x will be
// transferred to the new caret
int caret_from_column = 0, caret_to_column = 0, caret_last_fit_x = carets[caret_index].last_fit_x;
if (has_selection(caret_index)) {
// If the selection goes over multiple lines, deselect it.
if (get_selection_from_line(caret_index) != get_selection_to_line(caret_index)) {
deselect(caret_index);
} else {
caret_from_column = get_selection_from_column(caret_index);
caret_to_column = get_selection_to_column(caret_index);
caret_last_fit_x = -1;
carets.write[caret_index].last_fit_x = _get_column_x_offset_for_line(caret_column, caret_line, caret_column);
}
}
// Get the line and column of the new caret as if you would move the caret by pressing the arrow keys
int new_caret_line, new_caret_column, new_caret_from_column = 0, new_caret_to_column = 0;
_get_above_below_caret_line_column(caret_line, get_caret_wrap_index(caret_index), caret_column, p_below, new_caret_line, new_caret_column, caret_last_fit_x);
// If the caret does have a selection calculate the new from and to columns
if (caret_from_column != caret_to_column) {
// We only need to calculate the selection columns if the column of the caret changed
if (caret_column != new_caret_column) {
int _; // unused placeholder for p_new_line
_get_above_below_caret_line_column(caret_line, get_caret_wrap_index(caret_index), caret_from_column, p_below, _, new_caret_from_column);
_get_above_below_caret_line_column(caret_line, get_caret_wrap_index(caret_index), caret_to_column, p_below, _, new_caret_to_column);
} else {
new_caret_from_column = caret_from_column;
new_caret_to_column = caret_to_column;
}
}
// Add the new caret
const int new_caret_index = add_caret(new_caret_line, new_caret_column);
if (new_caret_index == -1) {
continue;
}
// Also add the selection if there should be one
if (new_caret_from_column != new_caret_to_column) {
select(new_caret_line, new_caret_from_column, new_caret_line, new_caret_to_column, new_caret_index);
// Necessary to properly modify the selection after adding the new caret
carets.write[new_caret_index].selection.selecting_line = new_caret_line;
carets.write[new_caret_index].selection.selecting_column = new_caret_column == new_caret_from_column ? new_caret_to_column : new_caret_from_column;
continue;
}
// Copy the last fit x over
carets.write[new_caret_index].last_fit_x = carets[caret_index].last_fit_x;
}
merge_overlapping_carets();
queue_redraw();
}
Vector<int> TextEdit::get_caret_index_edit_order() {
if (!caret_index_edit_dirty) {
return caret_index_edit_order;
}
caret_index_edit_order.clear();
caret_index_edit_order.push_back(0);
for (int i = 1; i < carets.size(); i++) {
int j = 0;
int line = carets[i].selection.active ? carets[i].selection.to_line : carets[i].line;
int col = carets[i].selection.active ? carets[i].selection.to_column : carets[i].column;
for (; j < caret_index_edit_order.size(); j++) {
int idx = caret_index_edit_order[j];
int other_line = carets[idx].selection.active ? carets[idx].selection.to_line : carets[idx].line;
int other_col = carets[idx].selection.active ? carets[idx].selection.to_column : carets[idx].column;
if (line > other_line || (line == other_line && col > other_col)) {
break;
}
}
caret_index_edit_order.insert(j, i);
}
caret_index_edit_dirty = false;
return caret_index_edit_order;
}
void TextEdit::adjust_carets_after_edit(int p_caret, int p_from_line, int p_from_col, int p_to_line, int p_to_col) {
int edit_height = p_from_line - p_to_line;
int edit_size = ((edit_height == 0) ? p_from_col : 0) - p_to_col;
Vector<int> caret_edit_order = get_caret_index_edit_order();
for (int j = 0; j < caret_edit_order.size(); j++) {
if (caret_edit_order[j] == p_caret) {
return;
}
// Adjust caret.
// set_caret_line could adjust the column, so save here.
int cc = get_caret_column(caret_edit_order[j]);
if (edit_height != 0) {
set_caret_line(get_caret_line(caret_edit_order[j]) + edit_height, false, true, 0, caret_edit_order[j]);
}
if (get_caret_line(p_caret) == get_caret_line(caret_edit_order[j])) {
set_caret_column(cc + edit_size, false, caret_edit_order[j]);
}
// Adjust selection.
if (!has_selection(caret_edit_order[j])) {
continue;
}
if (edit_height != 0) {
carets.write[caret_edit_order[j]].selection.from_line += edit_height;
carets.write[caret_edit_order[j]].selection.to_line += edit_height;
}
if (get_caret_line(p_caret) == carets[caret_edit_order[j]].selection.from_line) {
carets.write[caret_edit_order[j]].selection.from_column += edit_size;
}
}
}
bool TextEdit::is_caret_visible(int p_caret) const {
ERR_FAIL_INDEX_V(p_caret, carets.size(), 0);
return carets[p_caret].visible;
}
Point2 TextEdit::get_caret_draw_pos(int p_caret) const {
ERR_FAIL_INDEX_V(p_caret, carets.size(), Point2(0, 0));
return carets[p_caret].draw_pos;
}
void TextEdit::set_caret_line(int p_line, bool p_adjust_viewport, bool p_can_be_hidden, int p_wrap_index, int p_caret) {
ERR_FAIL_INDEX(p_caret, carets.size());
if (setting_caret_line) {
return;
}
setting_caret_line = true;
if (p_line < 0) {
p_line = 0;
}
if (p_line >= text.size()) {
p_line = text.size() - 1;
}
if (!p_can_be_hidden) {
if (_is_line_hidden(CLAMP(p_line, 0, text.size() - 1))) {
int move_down = get_next_visible_line_offset_from(p_line, 1) - 1;
if (p_line + move_down <= text.size() - 1 && !_is_line_hidden(p_line + move_down)) {
p_line += move_down;
} else {
int move_up = get_next_visible_line_offset_from(p_line, -1) - 1;
if (p_line - move_up > 0 && !_is_line_hidden(p_line - move_up)) {
p_line -= move_up;
} else {
WARN_PRINT(("Caret set to hidden line " + itos(p_line) + " and there are no nonhidden lines."));
}
}
}
}
bool caret_moved = get_caret_line(p_caret) != p_line;
carets.write[p_caret].line = p_line;
int n_col = _get_char_pos_for_line(carets[p_caret].last_fit_x, p_line, p_wrap_index);
if (n_col != 0 && get_line_wrapping_mode() != LineWrappingMode::LINE_WRAPPING_NONE && p_wrap_index < get_line_wrap_count(p_line)) {
Vector<String> rows = get_line_wrapped_text(p_line);
int row_end_col = 0;
for (int i = 0; i < p_wrap_index + 1; i++) {
row_end_col += rows[i].length();
}
if (n_col >= row_end_col) {
n_col -= 1;
}
}
caret_moved = (caret_moved || get_caret_column(p_caret) != n_col);
carets.write[p_caret].column = n_col;
if (is_inside_tree() && p_adjust_viewport) {
adjust_viewport_to_caret(p_caret);
}
setting_caret_line = false;
if (caret_moved && !caret_pos_dirty) {
if (is_inside_tree()) {
MessageQueue::get_singleton()->push_call(this, "_emit_caret_changed");
}
caret_pos_dirty = true;
}
}
int TextEdit::get_caret_line(int p_caret) const {
ERR_FAIL_INDEX_V(p_caret, carets.size(), 0);
return carets[p_caret].line;
}
void TextEdit::set_caret_column(int p_col, bool p_adjust_viewport, int p_caret) {
ERR_FAIL_INDEX(p_caret, carets.size());
if (p_col < 0) {
p_col = 0;
}
if (p_col > get_line(get_caret_line(p_caret)).length()) {
p_col = get_line(get_caret_line(p_caret)).length();
}
bool caret_moved = get_caret_column(p_caret) != p_col;
carets.write[p_caret].column = p_col;
carets.write[p_caret].last_fit_x = _get_column_x_offset_for_line(get_caret_column(p_caret), get_caret_line(p_caret), get_caret_column(p_caret));
if (is_inside_tree() && p_adjust_viewport) {
adjust_viewport_to_caret(p_caret);
}
if (caret_moved && !caret_pos_dirty) {
if (is_inside_tree()) {
MessageQueue::get_singleton()->push_call(this, "_emit_caret_changed");
}
caret_pos_dirty = true;
}
}
int TextEdit::get_caret_column(int p_caret) const {
ERR_FAIL_INDEX_V(p_caret, carets.size(), 0);
return carets[p_caret].column;
}
int TextEdit::get_caret_wrap_index(int p_caret) const {
ERR_FAIL_INDEX_V(p_caret, carets.size(), 0);
return get_line_wrap_index_at_column(get_caret_line(p_caret), get_caret_column(p_caret));
}
String TextEdit::get_word_under_caret(int p_caret) const {
ERR_FAIL_COND_V(p_caret > carets.size(), "");
StringBuilder selected_text;
for (int c = 0; c < carets.size(); c++) {
if (p_caret != -1 && p_caret != c) {
continue;
}
PackedInt32Array words = TS->shaped_text_get_word_breaks(text.get_line_data(get_caret_line(c))->get_rid());
for (int i = 0; i < words.size(); i = i + 2) {
if (words[i] <= get_caret_column(c) && words[i + 1] > get_caret_column(c)) {
selected_text += text[get_caret_line(c)].substr(words[i], words[i + 1] - words[i]);
if (p_caret == -1 && c != carets.size() - 1) {
selected_text += "\n";
}
}
}
}
return selected_text.as_string();
}
/* Selection. */
void TextEdit::set_selecting_enabled(const bool p_enabled) {
if (selecting_enabled == p_enabled) {
return;
}
selecting_enabled = p_enabled;
if (!selecting_enabled) {
deselect();
}
}
bool TextEdit::is_selecting_enabled() const {
return selecting_enabled;
}
void TextEdit::set_deselect_on_focus_loss_enabled(const bool p_enabled) {
if (deselect_on_focus_loss_enabled == p_enabled) {
return;
}
deselect_on_focus_loss_enabled = p_enabled;
if (p_enabled && has_selection() && !has_focus()) {
deselect();
}
}
bool TextEdit::is_deselect_on_focus_loss_enabled() const {
return deselect_on_focus_loss_enabled;
}
void TextEdit::set_drag_and_drop_selection_enabled(const bool p_enabled) {
drag_and_drop_selection_enabled = p_enabled;
}
bool TextEdit::is_drag_and_drop_selection_enabled() const {
return drag_and_drop_selection_enabled;
}
void TextEdit::set_selection_mode(SelectionMode p_mode, int p_line, int p_column, int p_caret) {
ERR_FAIL_INDEX(p_caret, carets.size());
selecting_mode = p_mode;
if (p_line >= 0) {
ERR_FAIL_INDEX(p_line, text.size());
carets.write[p_caret].selection.selecting_line = p_line;
carets.write[p_caret].selection.selecting_column = CLAMP(carets[p_caret].selection.selecting_column, 0, text[carets[p_caret].selection.selecting_line].length());
}
if (p_column >= 0) {
ERR_FAIL_INDEX(carets[p_caret].selection.selecting_line, text.size());
ERR_FAIL_INDEX(p_column, text[carets[p_caret].selection.selecting_line].length() + 1);
carets.write[p_caret].selection.selecting_column = p_column;
}
}
TextEdit::SelectionMode TextEdit::get_selection_mode() const {
return selecting_mode;
}
void TextEdit::select_all() {
if (!selecting_enabled) {
return;
}
if (text.size() == 1 && text[0].length() == 0) {
return;
}
remove_secondary_carets();
select(0, 0, text.size() - 1, text[text.size() - 1].length());
set_selection_mode(SelectionMode::SELECTION_MODE_SHIFT, 0, 0);
carets.write[0].selection.shiftclick_left = true;
set_caret_line(get_selection_to_line(), false);
set_caret_column(get_selection_to_column(), false);
queue_redraw();
}
void TextEdit::select_word_under_caret(int p_caret) {
ERR_FAIL_COND(p_caret > carets.size());
if (!selecting_enabled) {
return;
}
if (text.size() == 1 && text[0].length() == 0) {
return;
}
for (int c = 0; c < carets.size(); c++) {
if (p_caret != -1 && p_caret != c) {
continue;
}
if (has_selection(c)) {
// Allow toggling selection by pressing the shortcut a second time.
// This is also usable as a general-purpose "deselect" shortcut after
// selecting anything.
deselect(c);
continue;
}
int begin = 0;
int end = 0;
const PackedInt32Array words = TS->shaped_text_get_word_breaks(text.get_line_data(get_caret_line(c))->get_rid());
for (int i = 0; i < words.size(); i = i + 2) {
if ((words[i] <= get_caret_column(c) && words[i + 1] >= get_caret_column(c)) || (i == words.size() - 2 && get_caret_column(c) == words[i + 1])) {
begin = words[i];
end = words[i + 1];
break;
}
}
// No word found.
if (begin == 0 && end == 0) {
continue;
}
select(get_caret_line(c), begin, get_caret_line(c), end, c);
// Move the caret to the end of the word for easier editing.
set_caret_column(end, false, c);
}
merge_overlapping_carets();
}
void TextEdit::add_selection_for_next_occurrence() {
if (!selecting_enabled || !is_multiple_carets_enabled()) {
return;
}
if (text.size() == 1 && text[0].length() == 0) {
return;
}
// Always use the last caret, to correctly search for
// the next occurrence that comes after this caret.
int caret = get_caret_count() - 1;
if (!has_selection(caret)) {
select_word_under_caret(caret);
return;
}
const String &highlighted_text = get_selected_text(caret);
int column = get_selection_from_column(caret) + 1;
int line = get_caret_line(caret);
const Point2i next_occurrence = search(highlighted_text, SEARCH_MATCH_CASE, line, column);
if (next_occurrence.x == -1 || next_occurrence.y == -1) {
return;
}
int to_column = get_selection_to_column(caret) + 1;
int end = next_occurrence.x + (to_column - column);
int new_caret = add_caret(next_occurrence.y, end);
if (new_caret != -1) {
select(next_occurrence.y, next_occurrence.x, next_occurrence.y, end, new_caret);
adjust_viewport_to_caret(new_caret);
merge_overlapping_carets();
}
}
void TextEdit::select(int p_from_line, int p_from_column, int p_to_line, int p_to_column, int p_caret) {
ERR_FAIL_INDEX(p_caret, carets.size());
if (!selecting_enabled) {
return;
}
if (p_from_line < 0) {
p_from_line = 0;
} else if (p_from_line >= text.size()) {
p_from_line = text.size() - 1;
}
if (p_from_column >= text[p_from_line].length()) {
p_from_column = text[p_from_line].length();
}
if (p_from_column < 0) {
p_from_column = 0;
}
if (p_to_line < 0) {
p_to_line = 0;
} else if (p_to_line >= text.size()) {
p_to_line = text.size() - 1;
}
if (p_to_column >= text[p_to_line].length()) {
p_to_column = text[p_to_line].length();
}
if (p_to_column < 0) {
p_to_column = 0;
}
carets.write[p_caret].selection.from_line = p_from_line;
carets.write[p_caret].selection.from_column = p_from_column;
carets.write[p_caret].selection.to_line = p_to_line;
carets.write[p_caret].selection.to_column = p_to_column;
carets.write[p_caret].selection.active = true;
if (carets[p_caret].selection.from_line == carets[p_caret].selection.to_line) {
if (carets[p_caret].selection.from_column == carets[p_caret].selection.to_column) {
carets.write[p_caret].selection.active = false;
} else if (carets[p_caret].selection.from_column > carets[p_caret].selection.to_column) {
carets.write[p_caret].selection.shiftclick_left = false;
SWAP(carets.write[p_caret].selection.from_column, carets.write[p_caret].selection.to_column);
} else {
carets.write[p_caret].selection.shiftclick_left = true;
}
} else if (carets[p_caret].selection.from_line > carets[p_caret].selection.to_line) {
carets.write[p_caret].selection.shiftclick_left = false;
SWAP(carets.write[p_caret].selection.from_line, carets.write[p_caret].selection.to_line);
SWAP(carets.write[p_caret].selection.from_column, carets.write[p_caret].selection.to_column);
} else {
carets.write[p_caret].selection.shiftclick_left = true;
}
caret_index_edit_dirty = true;
queue_redraw();
}
bool TextEdit::has_selection(int p_caret) const {
ERR_FAIL_COND_V(p_caret > carets.size(), false);
for (int i = 0; i < carets.size(); i++) {
if (p_caret != -1 && p_caret != i) {
continue;
}
if (carets[i].selection.active) {
return true;
}
}
return false;
}
String TextEdit::get_selected_text(int p_caret) {
ERR_FAIL_COND_V(p_caret > carets.size(), "");
StringBuilder selected_text;
Vector<int> caret_edit_order = get_caret_index_edit_order();
for (int i = caret_edit_order.size() - 1; i >= 0; i--) {
int caret_idx = caret_edit_order[i];
if (p_caret != -1 && p_caret != caret_idx) {
continue;
}
if (!has_selection(caret_idx)) {
continue;
}
selected_text += _base_get_text(get_selection_from_line(caret_idx), get_selection_from_column(caret_idx), get_selection_to_line(caret_idx), get_selection_to_column(caret_idx));
if (p_caret == -1 && i != 0) {
selected_text += "\n";
}
}
return selected_text.as_string();
}
int TextEdit::get_selection_line(int p_caret) const {
ERR_FAIL_INDEX_V(p_caret, carets.size(), -1);
ERR_FAIL_COND_V(!has_selection(p_caret), -1);
return carets[p_caret].selection.selecting_line;
}
int TextEdit::get_selection_column(int p_caret) const {
ERR_FAIL_INDEX_V(p_caret, carets.size(), -1);
ERR_FAIL_COND_V(!has_selection(p_caret), -1);
return carets[p_caret].selection.selecting_column;
}
int TextEdit::get_selection_from_line(int p_caret) const {
ERR_FAIL_INDEX_V(p_caret, carets.size(), -1);
ERR_FAIL_COND_V(!has_selection(p_caret), -1);
return carets[p_caret].selection.from_line;
}
int TextEdit::get_selection_from_column(int p_caret) const {
ERR_FAIL_INDEX_V(p_caret, carets.size(), -1);
ERR_FAIL_COND_V(!has_selection(p_caret), -1);
return carets[p_caret].selection.from_column;
}
int TextEdit::get_selection_to_line(int p_caret) const {
ERR_FAIL_INDEX_V(p_caret, carets.size(), -1);
ERR_FAIL_COND_V(!has_selection(p_caret), -1);
return carets[p_caret].selection.to_line;
}
int TextEdit::get_selection_to_column(int p_caret) const {
ERR_FAIL_INDEX_V(p_caret, carets.size(), -1);
ERR_FAIL_COND_V(!has_selection(p_caret), -1);
return carets[p_caret].selection.to_column;
}
void TextEdit::deselect(int p_caret) {
ERR_FAIL_COND(p_caret > carets.size());
for (int i = 0; i < carets.size(); i++) {
if (p_caret != -1 && p_caret != i) {
continue;
}
carets.write[i].selection.active = false;
}
caret_index_edit_dirty = true;
queue_redraw();
}
void TextEdit::delete_selection(int p_caret) {
ERR_FAIL_COND(p_caret > carets.size());
begin_complex_operation();
Vector<int> caret_edit_order = get_caret_index_edit_order();
for (const int &i : caret_edit_order) {
if (p_caret != -1 && p_caret != i) {
continue;
}
if (!has_selection(i)) {
continue;
}
selecting_mode = SelectionMode::SELECTION_MODE_NONE;
_remove_text(carets[i].selection.from_line, carets[i].selection.from_column, carets[i].selection.to_line, carets[i].selection.to_column);
set_caret_line(carets[i].selection.from_line, false, false, 0, i);
set_caret_column(carets[i].selection.from_column, i == 0, i);
carets.write[i].selection.active = false;
adjust_carets_after_edit(i, carets[i].selection.from_line, carets[i].selection.from_column, carets[i].selection.to_line, carets[i].selection.to_column);
}
end_complex_operation();
queue_redraw();
}
/* Line wrapping. */
void TextEdit::set_line_wrapping_mode(LineWrappingMode p_wrapping_mode) {
if (line_wrapping_mode != p_wrapping_mode) {
line_wrapping_mode = p_wrapping_mode;
_update_wrap_at_column(true);
}
}
TextEdit::LineWrappingMode TextEdit::get_line_wrapping_mode() const {
return line_wrapping_mode;
}
bool TextEdit::is_line_wrapped(int p_line) const {
ERR_FAIL_INDEX_V(p_line, text.size(), 0);
if (get_line_wrapping_mode() == LineWrappingMode::LINE_WRAPPING_NONE) {
return false;
}
return text.get_line_wrap_amount(p_line) > 0;
}
int TextEdit::get_line_wrap_count(int p_line) const {
ERR_FAIL_INDEX_V(p_line, text.size(), 0);
if (!is_line_wrapped(p_line)) {
return 0;
}
return text.get_line_wrap_amount(p_line);
}
int TextEdit::get_line_wrap_index_at_column(int p_line, int p_column) const {
ERR_FAIL_INDEX_V(p_line, text.size(), 0);
ERR_FAIL_COND_V(p_column < 0, 0);
ERR_FAIL_COND_V(p_column > text[p_line].length(), 0);
if (!is_line_wrapped(p_line)) {
return 0;
}
/* Loop through wraps in the line text until we get to the column. */
int wrap_index = 0;
int col = 0;
Vector<String> lines = get_line_wrapped_text(p_line);
for (int i = 0; i < lines.size(); i++) {
wrap_index = i;
String s = lines[wrap_index];
col += s.length();
if (col > p_column) {
break;
}
}
return wrap_index;
}
Vector<String> TextEdit::get_line_wrapped_text(int p_line) const {
ERR_FAIL_INDEX_V(p_line, text.size(), Vector<String>());
Vector<String> lines;
if (!is_line_wrapped(p_line)) {
lines.push_back(text[p_line]);
return lines;
}
const String &line_text = text[p_line];
Vector<Vector2i> line_ranges = text.get_line_wrap_ranges(p_line);
for (int i = 0; i < line_ranges.size(); i++) {
lines.push_back(line_text.substr(line_ranges[i].x, line_ranges[i].y - line_ranges[i].x));
}
return lines;
}
/* Viewport */
// Scrolling.
void TextEdit::set_smooth_scroll_enabled(const bool p_enabled) {
v_scroll->set_smooth_scroll_enabled(p_enabled);
smooth_scroll_enabled = p_enabled;
}
bool TextEdit::is_smooth_scroll_enabled() const {
return smooth_scroll_enabled;
}
void TextEdit::set_scroll_past_end_of_file_enabled(const bool p_enabled) {
if (scroll_past_end_of_file_enabled == p_enabled) {
return;
}
scroll_past_end_of_file_enabled = p_enabled;
queue_redraw();
}
bool TextEdit::is_scroll_past_end_of_file_enabled() const {
return scroll_past_end_of_file_enabled;
}
VScrollBar *TextEdit::get_v_scroll_bar() const {
return v_scroll;
}
HScrollBar *TextEdit::get_h_scroll_bar() const {
return h_scroll;
}
void TextEdit::set_v_scroll(double p_scroll) {
v_scroll->set_value(p_scroll);
int max_v_scroll = v_scroll->get_max() - v_scroll->get_page();
if (p_scroll >= max_v_scroll - 1.0) {
_scroll_moved(v_scroll->get_value());
}
}
double TextEdit::get_v_scroll() const {
return v_scroll->get_value();
}
void TextEdit::set_h_scroll(int p_scroll) {
if (p_scroll < 0) {
p_scroll = 0;
}
h_scroll->set_value(p_scroll);
}
int TextEdit::get_h_scroll() const {
return h_scroll->get_value();
}
void TextEdit::set_v_scroll_speed(float p_speed) {
// Prevent setting a vertical scroll speed value under 1.0
ERR_FAIL_COND(p_speed < 1.0);
v_scroll_speed = p_speed;
}
float TextEdit::get_v_scroll_speed() const {
return v_scroll_speed;
}
void TextEdit::set_fit_content_height_enabled(const bool p_enabled) {
if (fit_content_height == p_enabled) {
return;
}
fit_content_height = p_enabled;
update_minimum_size();
}
bool TextEdit::is_fit_content_height_enabled() const {
return fit_content_height;
}
double TextEdit::get_scroll_pos_for_line(int p_line, int p_wrap_index) const {
ERR_FAIL_INDEX_V(p_line, text.size(), 0);
ERR_FAIL_COND_V(p_wrap_index < 0, 0);
ERR_FAIL_COND_V(p_wrap_index > get_line_wrap_count(p_line), 0);
if (get_line_wrapping_mode() == LineWrappingMode::LINE_WRAPPING_NONE && !_is_hiding_enabled()) {
return p_line;
}
double new_line_scroll_pos = 0.0;
if (p_line > 0) {
new_line_scroll_pos = get_visible_line_count_in_range(0, MIN(p_line - 1, text.size() - 1));
}
new_line_scroll_pos += p_wrap_index;
return new_line_scroll_pos;
}
// Visible lines.
void TextEdit::set_line_as_first_visible(int p_line, int p_wrap_index) {
ERR_FAIL_INDEX(p_line, text.size());
ERR_FAIL_COND(p_wrap_index < 0);
ERR_FAIL_COND(p_wrap_index > get_line_wrap_count(p_line));
set_v_scroll(get_scroll_pos_for_line(p_line, p_wrap_index));
}
int TextEdit::get_first_visible_line() const {
return CLAMP(first_visible_line, 0, text.size() - 1);
}
void TextEdit::set_line_as_center_visible(int p_line, int p_wrap_index) {
ERR_FAIL_INDEX(p_line, text.size());
ERR_FAIL_COND(p_wrap_index < 0);
ERR_FAIL_COND(p_wrap_index > get_line_wrap_count(p_line));
int visible_rows = get_visible_line_count();
Point2i next_line = get_next_visible_line_index_offset_from(p_line, p_wrap_index, (-visible_rows / 2) - 1);
int first_line = p_line - next_line.x + 1;
if (first_line < 0) {
set_v_scroll(0);
return;
}
set_v_scroll(get_scroll_pos_for_line(first_line, next_line.y));
}
void TextEdit::set_line_as_last_visible(int p_line, int p_wrap_index) {
ERR_FAIL_INDEX(p_line, text.size());
ERR_FAIL_COND(p_wrap_index < 0);
ERR_FAIL_COND(p_wrap_index > get_line_wrap_count(p_line));
Point2i next_line = get_next_visible_line_index_offset_from(p_line, p_wrap_index, -get_visible_line_count() - 1);
int first_line = p_line - next_line.x + 1;
// Adding _get_visible_lines_offset is not 100% correct as we end up showing almost p_line + 1, however, it provides a
// better user experience. Therefore we need to special case < visible line count, else showing line 0 is impossible.
if (get_visible_line_count_in_range(0, p_line) < get_visible_line_count() + 1) {
set_v_scroll(0);
return;
}
set_v_scroll(get_scroll_pos_for_line(first_line, next_line.y) + _get_visible_lines_offset());
}
int TextEdit::get_last_full_visible_line() const {
int first_vis_line = get_first_visible_line();
int last_vis_line = 0;
last_vis_line = first_vis_line + get_next_visible_line_index_offset_from(first_vis_line, first_visible_line_wrap_ofs, get_visible_line_count()).x - 1;
last_vis_line = CLAMP(last_vis_line, 0, text.size() - 1);
return last_vis_line;
}
int TextEdit::get_last_full_visible_line_wrap_index() const {
int first_vis_line = get_first_visible_line();
return get_next_visible_line_index_offset_from(first_vis_line, first_visible_line_wrap_ofs, get_visible_line_count()).y;
}
int TextEdit::get_visible_line_count() const {
return _get_control_height() / get_line_height();
}
int TextEdit::get_visible_line_count_in_range(int p_from_line, int p_to_line) const {
ERR_FAIL_INDEX_V(p_from_line, text.size(), 0);
ERR_FAIL_INDEX_V(p_to_line, text.size(), 0);
// So we can handle inputs in whatever order
if (p_from_line > p_to_line) {
SWAP(p_from_line, p_to_line);
}
/* Returns the total number of (lines + wrapped - hidden). */
if (!_is_hiding_enabled() && get_line_wrapping_mode() == LineWrappingMode::LINE_WRAPPING_NONE) {
return (p_to_line - p_from_line) + 1;
}
int total_rows = 0;
for (int i = p_from_line; i <= p_to_line; i++) {
if (!text.is_hidden(i)) {
total_rows++;
total_rows += get_line_wrap_count(i);
}
}
return total_rows;
}
int TextEdit::get_total_visible_line_count() const {
return get_visible_line_count_in_range(0, text.size() - 1);
}
// Auto adjust
void TextEdit::adjust_viewport_to_caret(int p_caret) {
ERR_FAIL_INDEX(p_caret, carets.size());
// Make sure Caret is visible on the screen.
scrolling = false;
minimap_clicked = false;
int cur_line = get_caret_line(p_caret);
int cur_wrap = get_caret_wrap_index(p_caret);
int first_vis_line = get_first_visible_line();
int first_vis_wrap = first_visible_line_wrap_ofs;
int last_vis_line = get_last_full_visible_line();
int last_vis_wrap = get_last_full_visible_line_wrap_index();
if (cur_line < first_vis_line || (cur_line == first_vis_line && cur_wrap < first_vis_wrap)) {
// Caret is above screen.
set_line_as_first_visible(cur_line, cur_wrap);
} else if (cur_line > last_vis_line || (cur_line == last_vis_line && cur_wrap > last_vis_wrap)) {
// Caret is below screen.
set_line_as_last_visible(cur_line, cur_wrap);
}
int visible_width = get_size().width - style_normal->get_minimum_size().width - gutters_width - gutter_padding;
if (draw_minimap) {
visible_width -= minimap_width;
}
if (v_scroll->is_visible_in_tree()) {
visible_width -= v_scroll->get_combined_minimum_size().width;
}
visible_width -= 20; // Give it a little more space.
if (get_line_wrapping_mode() == LineWrappingMode::LINE_WRAPPING_NONE) {
// Adjust x offset.
Vector2i caret_pos;
// Get position of the start of caret.
if (ime_text.length() != 0 && ime_selection.x != 0) {
caret_pos.x = _get_column_x_offset_for_line(get_caret_column(p_caret) + ime_selection.x, get_caret_line(p_caret), get_caret_column(p_caret));
} else {
caret_pos.x = _get_column_x_offset_for_line(get_caret_column(p_caret), get_caret_line(p_caret), get_caret_column(p_caret));
}
// Get position of the end of caret.
if (ime_text.length() != 0) {
if (ime_selection.y != 0) {
caret_pos.y = _get_column_x_offset_for_line(get_caret_column(p_caret) + ime_selection.x + ime_selection.y, get_caret_line(p_caret), get_caret_column(p_caret));
} else {
caret_pos.y = _get_column_x_offset_for_line(get_caret_column(p_caret) + ime_text.size(), get_caret_line(p_caret), get_caret_column(p_caret));
}
} else {
caret_pos.y = caret_pos.x;
}
if (MAX(caret_pos.x, caret_pos.y) > (first_visible_col + visible_width)) {
first_visible_col = MAX(caret_pos.x, caret_pos.y) - visible_width + 1;
}
if (MIN(caret_pos.x, caret_pos.y) < first_visible_col) {
first_visible_col = MIN(caret_pos.x, caret_pos.y);
}
} else {
first_visible_col = 0;
}
h_scroll->set_value(first_visible_col);
queue_redraw();
}
void TextEdit::center_viewport_to_caret(int p_caret) {
ERR_FAIL_INDEX(p_caret, carets.size());
// Move viewport so the caret is in the center of the screen.
scrolling = false;
minimap_clicked = false;
set_line_as_center_visible(get_caret_line(p_caret), get_caret_wrap_index(p_caret));
int visible_width = get_size().width - style_normal->get_minimum_size().width - gutters_width - gutter_padding;
if (draw_minimap) {
visible_width -= minimap_width;
}
if (v_scroll->is_visible_in_tree()) {
visible_width -= v_scroll->get_combined_minimum_size().width;
}
visible_width -= 20; // Give it a little more space.
if (get_line_wrapping_mode() != LineWrappingMode::LINE_WRAPPING_NONE) {
// Center x offset.
Vector2i caret_pos;
// Get position of the start of caret.
if (ime_text.length() != 0 && ime_selection.x != 0) {
caret_pos.x = _get_column_x_offset_for_line(get_caret_column(p_caret) + ime_selection.x, get_caret_line(p_caret), get_caret_column(p_caret));
} else {
caret_pos.x = _get_column_x_offset_for_line(get_caret_column(p_caret), get_caret_line(p_caret), get_caret_column(p_caret));
}
// Get position of the end of caret.
if (ime_text.length() != 0) {
if (ime_selection.y != 0) {
caret_pos.y = _get_column_x_offset_for_line(get_caret_column(p_caret) + ime_selection.x + ime_selection.y, get_caret_line(p_caret), get_caret_column(p_caret));
} else {
caret_pos.y = _get_column_x_offset_for_line(get_caret_column(p_caret) + ime_text.size(), get_caret_line(p_caret), get_caret_column(p_caret));
}
} else {
caret_pos.y = caret_pos.x;
}
if (MAX(caret_pos.x, caret_pos.y) > (first_visible_col + visible_width)) {
first_visible_col = MAX(caret_pos.x, caret_pos.y) - visible_width + 1;
}
if (MIN(caret_pos.x, caret_pos.y) < first_visible_col) {
first_visible_col = MIN(caret_pos.x, caret_pos.y);
}
} else {
first_visible_col = 0;
}
h_scroll->set_value(first_visible_col);
queue_redraw();
}
/* Minimap */
void TextEdit::set_draw_minimap(bool p_enabled) {
if (draw_minimap == p_enabled) {
return;
}
draw_minimap = p_enabled;
_update_wrap_at_column();
queue_redraw();
}
bool TextEdit::is_drawing_minimap() const {
return draw_minimap;
}
void TextEdit::set_minimap_width(int p_minimap_width) {
if (minimap_width == p_minimap_width) {
return;
}
minimap_width = p_minimap_width;
_update_wrap_at_column();
queue_redraw();
}
int TextEdit::get_minimap_width() const {
return minimap_width;
}
int TextEdit::get_minimap_visible_lines() const {
return _get_control_height() / (minimap_char_size.y + minimap_line_spacing);
}
/* Gutters. */
void TextEdit::add_gutter(int p_at) {
if (p_at < 0 || p_at > gutters.size()) {
gutters.push_back(GutterInfo());
} else {
gutters.insert(p_at, GutterInfo());
}
text.add_gutter(p_at);
_update_gutter_width();
emit_signal(SNAME("gutter_added"));
queue_redraw();
}
void TextEdit::remove_gutter(int p_gutter) {
ERR_FAIL_INDEX(p_gutter, gutters.size());
gutters.remove_at(p_gutter);
text.remove_gutter(p_gutter);
_update_gutter_width();
emit_signal(SNAME("gutter_removed"));
queue_redraw();
}
int TextEdit::get_gutter_count() const {
return gutters.size();
}
void TextEdit::set_gutter_name(int p_gutter, const String &p_name) {
ERR_FAIL_INDEX(p_gutter, gutters.size());
gutters.write[p_gutter].name = p_name;
}
String TextEdit::get_gutter_name(int p_gutter) const {
ERR_FAIL_INDEX_V(p_gutter, gutters.size(), "");
return gutters[p_gutter].name;
}
void TextEdit::set_gutter_type(int p_gutter, GutterType p_type) {
ERR_FAIL_INDEX(p_gutter, gutters.size());
if (gutters[p_gutter].type == p_type) {
return;
}
gutters.write[p_gutter].type = p_type;
queue_redraw();
}
TextEdit::GutterType TextEdit::get_gutter_type(int p_gutter) const {
ERR_FAIL_INDEX_V(p_gutter, gutters.size(), GUTTER_TYPE_STRING);
return gutters[p_gutter].type;
}
void TextEdit::set_gutter_width(int p_gutter, int p_width) {
ERR_FAIL_INDEX(p_gutter, gutters.size());
if (gutters[p_gutter].width == p_width) {
return;
}
gutters.write[p_gutter].width = p_width;
_update_gutter_width();
}
int TextEdit::get_gutter_width(int p_gutter) const {
ERR_FAIL_INDEX_V(p_gutter, gutters.size(), -1);
return gutters[p_gutter].width;
}
int TextEdit::get_total_gutter_width() const {
return gutters_width + gutter_padding;
}
void TextEdit::set_gutter_draw(int p_gutter, bool p_draw) {
ERR_FAIL_INDEX(p_gutter, gutters.size());
if (gutters[p_gutter].draw == p_draw) {
return;
}
gutters.write[p_gutter].draw = p_draw;
_update_gutter_width();
}
bool TextEdit::is_gutter_drawn(int p_gutter) const {
ERR_FAIL_INDEX_V(p_gutter, gutters.size(), false);
return gutters[p_gutter].draw;
}
void TextEdit::set_gutter_clickable(int p_gutter, bool p_clickable) {
ERR_FAIL_INDEX(p_gutter, gutters.size());
if (gutters[p_gutter].clickable == p_clickable) {
return;
}
gutters.write[p_gutter].clickable = p_clickable;
queue_redraw();
}
bool TextEdit::is_gutter_clickable(int p_gutter) const {
ERR_FAIL_INDEX_V(p_gutter, gutters.size(), false);
return gutters[p_gutter].clickable;
}
void TextEdit::set_gutter_overwritable(int p_gutter, bool p_overwritable) {
ERR_FAIL_INDEX(p_gutter, gutters.size());
gutters.write[p_gutter].overwritable = p_overwritable;
}
bool TextEdit::is_gutter_overwritable(int p_gutter) const {
ERR_FAIL_INDEX_V(p_gutter, gutters.size(), false);
return gutters[p_gutter].overwritable;
}
void TextEdit::merge_gutters(int p_from_line, int p_to_line) {
ERR_FAIL_INDEX(p_from_line, text.size());
ERR_FAIL_INDEX(p_to_line, text.size());
if (p_from_line == p_to_line) {
return;
}
for (int i = 0; i < gutters.size(); i++) {
if (!gutters[i].overwritable) {
continue;
}
if (text.get_line_gutter_text(p_from_line, i) != "") {
text.set_line_gutter_text(p_to_line, i, text.get_line_gutter_text(p_from_line, i));
text.set_line_gutter_item_color(p_to_line, i, text.get_line_gutter_item_color(p_from_line, i));
}
if (text.get_line_gutter_icon(p_from_line, i).is_valid()) {
text.set_line_gutter_icon(p_to_line, i, text.get_line_gutter_icon(p_from_line, i));
text.set_line_gutter_item_color(p_to_line, i, text.get_line_gutter_item_color(p_from_line, i));
}
if (text.get_line_gutter_metadata(p_from_line, i) != "") {
text.set_line_gutter_metadata(p_to_line, i, text.get_line_gutter_metadata(p_from_line, i));
}
if (text.is_line_gutter_clickable(p_from_line, i)) {
text.set_line_gutter_clickable(p_to_line, i, true);
}
}
queue_redraw();
}
void TextEdit::set_gutter_custom_draw(int p_gutter, const Callable &p_draw_callback) {
ERR_FAIL_INDEX(p_gutter, gutters.size());
if (gutters[p_gutter].custom_draw_callback == p_draw_callback) {
return;
}
gutters.write[p_gutter].custom_draw_callback = p_draw_callback;
queue_redraw();
}
// Line gutters.
void TextEdit::set_line_gutter_metadata(int p_line, int p_gutter, const Variant &p_metadata) {
ERR_FAIL_INDEX(p_line, text.size());
ERR_FAIL_INDEX(p_gutter, gutters.size());
text.set_line_gutter_metadata(p_line, p_gutter, p_metadata);
}
Variant TextEdit::get_line_gutter_metadata(int p_line, int p_gutter) const {
ERR_FAIL_INDEX_V(p_line, text.size(), "");
ERR_FAIL_INDEX_V(p_gutter, gutters.size(), "");
return text.get_line_gutter_metadata(p_line, p_gutter);
}
void TextEdit::set_line_gutter_text(int p_line, int p_gutter, const String &p_text) {
ERR_FAIL_INDEX(p_line, text.size());
ERR_FAIL_INDEX(p_gutter, gutters.size());
if (text.get_line_gutter_text(p_line, p_gutter) == p_text) {
return;
}
text.set_line_gutter_text(p_line, p_gutter, p_text);
queue_redraw();
}
String TextEdit::get_line_gutter_text(int p_line, int p_gutter) const {
ERR_FAIL_INDEX_V(p_line, text.size(), "");
ERR_FAIL_INDEX_V(p_gutter, gutters.size(), "");
return text.get_line_gutter_text(p_line, p_gutter);
}
void TextEdit::set_line_gutter_icon(int p_line, int p_gutter, const Ref<Texture2D> &p_icon) {
ERR_FAIL_INDEX(p_line, text.size());
ERR_FAIL_INDEX(p_gutter, gutters.size());
if (text.get_line_gutter_icon(p_line, p_gutter) == p_icon) {
return;
}
text.set_line_gutter_icon(p_line, p_gutter, p_icon);
queue_redraw();
}
Ref<Texture2D> TextEdit::get_line_gutter_icon(int p_line, int p_gutter) const {
ERR_FAIL_INDEX_V(p_line, text.size(), Ref<Texture2D>());
ERR_FAIL_INDEX_V(p_gutter, gutters.size(), Ref<Texture2D>());
return text.get_line_gutter_icon(p_line, p_gutter);
}
void TextEdit::set_line_gutter_item_color(int p_line, int p_gutter, const Color &p_color) {
ERR_FAIL_INDEX(p_line, text.size());
ERR_FAIL_INDEX(p_gutter, gutters.size());
if (text.get_line_gutter_item_color(p_line, p_gutter) == p_color) {
return;
}
text.set_line_gutter_item_color(p_line, p_gutter, p_color);
queue_redraw();
}
Color TextEdit::get_line_gutter_item_color(int p_line, int p_gutter) const {
ERR_FAIL_INDEX_V(p_line, text.size(), Color());
ERR_FAIL_INDEX_V(p_gutter, gutters.size(), Color());
return text.get_line_gutter_item_color(p_line, p_gutter);
}
void TextEdit::set_line_gutter_clickable(int p_line, int p_gutter, bool p_clickable) {
ERR_FAIL_INDEX(p_line, text.size());
ERR_FAIL_INDEX(p_gutter, gutters.size());
text.set_line_gutter_clickable(p_line, p_gutter, p_clickable);
}
bool TextEdit::is_line_gutter_clickable(int p_line, int p_gutter) const {
ERR_FAIL_INDEX_V(p_line, text.size(), false);
ERR_FAIL_INDEX_V(p_gutter, gutters.size(), false);
return text.is_line_gutter_clickable(p_line, p_gutter);
}
// Line style
void TextEdit::set_line_background_color(int p_line, const Color &p_color) {
ERR_FAIL_INDEX(p_line, text.size());
if (text.get_line_background_color(p_line) == p_color) {
return;
}
text.set_line_background_color(p_line, p_color);
queue_redraw();
}
Color TextEdit::get_line_background_color(int p_line) const {
ERR_FAIL_INDEX_V(p_line, text.size(), Color());
return text.get_line_background_color(p_line);
}
/* Syntax Highlighting. */
void TextEdit::set_syntax_highlighter(Ref<SyntaxHighlighter> p_syntax_highlighter) {
if (syntax_highlighter == p_syntax_highlighter && syntax_highlighter.is_valid() == p_syntax_highlighter.is_valid()) {
return;
}
syntax_highlighter = p_syntax_highlighter;
if (syntax_highlighter.is_valid()) {
syntax_highlighter->set_text_edit(this);
}
queue_redraw();
}
Ref<SyntaxHighlighter> TextEdit::get_syntax_highlighter() const {
return syntax_highlighter;
}
/* Visual. */
void TextEdit::set_highlight_current_line(bool p_enabled) {
if (highlight_current_line == p_enabled) {
return;
}
highlight_current_line = p_enabled;
queue_redraw();
}
bool TextEdit::is_highlight_current_line_enabled() const {
return highlight_current_line;
}
void TextEdit::set_highlight_all_occurrences(const bool p_enabled) {
if (highlight_all_occurrences == p_enabled) {
return;
}
highlight_all_occurrences = p_enabled;
queue_redraw();
}
bool TextEdit::is_highlight_all_occurrences_enabled() const {
return highlight_all_occurrences;
}
void TextEdit::set_draw_control_chars(bool p_enabled) {
if (draw_control_chars != p_enabled) {
draw_control_chars = p_enabled;
if (menu) {
menu->set_item_checked(menu->get_item_index(MENU_DISPLAY_UCC), draw_control_chars);
}
text.set_draw_control_chars(draw_control_chars);
text.invalidate_font();
_update_placeholder();
queue_redraw();
}
}
bool TextEdit::get_draw_control_chars() const {
return draw_control_chars;
}
void TextEdit::set_draw_tabs(bool p_enabled) {
if (draw_tabs == p_enabled) {
return;
}
draw_tabs = p_enabled;
queue_redraw();
}
bool TextEdit::is_drawing_tabs() const {
return draw_tabs;
}
void TextEdit::set_draw_spaces(bool p_enabled) {
if (draw_spaces == p_enabled) {
return;
}
draw_spaces = p_enabled;
queue_redraw();
}
bool TextEdit::is_drawing_spaces() const {
return draw_spaces;
}
void TextEdit::_bind_methods() {
/*Internal. */
ClassDB::bind_method(D_METHOD("_text_changed_emit"), &TextEdit::_text_changed_emit);
/* Text */
// Text properties
ClassDB::bind_method(D_METHOD("has_ime_text"), &TextEdit::has_ime_text);
ClassDB::bind_method(D_METHOD("set_editable", "enabled"), &TextEdit::set_editable);
ClassDB::bind_method(D_METHOD("is_editable"), &TextEdit::is_editable);
ClassDB::bind_method(D_METHOD("set_text_direction", "direction"), &TextEdit::set_text_direction);
ClassDB::bind_method(D_METHOD("get_text_direction"), &TextEdit::get_text_direction);
ClassDB::bind_method(D_METHOD("set_language", "language"), &TextEdit::set_language);
ClassDB::bind_method(D_METHOD("get_language"), &TextEdit::get_language);
ClassDB::bind_method(D_METHOD("set_structured_text_bidi_override", "parser"), &TextEdit::set_structured_text_bidi_override);
ClassDB::bind_method(D_METHOD("get_structured_text_bidi_override"), &TextEdit::get_structured_text_bidi_override);
ClassDB::bind_method(D_METHOD("set_structured_text_bidi_override_options", "args"), &TextEdit::set_structured_text_bidi_override_options);
ClassDB::bind_method(D_METHOD("get_structured_text_bidi_override_options"), &TextEdit::get_structured_text_bidi_override_options);
ClassDB::bind_method(D_METHOD("set_tab_size", "size"), &TextEdit::set_tab_size);
ClassDB::bind_method(D_METHOD("get_tab_size"), &TextEdit::get_tab_size);
// User controls
ClassDB::bind_method(D_METHOD("set_overtype_mode_enabled", "enabled"), &TextEdit::set_overtype_mode_enabled);
ClassDB::bind_method(D_METHOD("is_overtype_mode_enabled"), &TextEdit::is_overtype_mode_enabled);
ClassDB::bind_method(D_METHOD("set_context_menu_enabled", "enabled"), &TextEdit::set_context_menu_enabled);
ClassDB::bind_method(D_METHOD("is_context_menu_enabled"), &TextEdit::is_context_menu_enabled);
ClassDB::bind_method(D_METHOD("set_shortcut_keys_enabled", "enabled"), &TextEdit::set_shortcut_keys_enabled);
ClassDB::bind_method(D_METHOD("is_shortcut_keys_enabled"), &TextEdit::is_shortcut_keys_enabled);
ClassDB::bind_method(D_METHOD("set_virtual_keyboard_enabled", "enabled"), &TextEdit::set_virtual_keyboard_enabled);
ClassDB::bind_method(D_METHOD("is_virtual_keyboard_enabled"), &TextEdit::is_virtual_keyboard_enabled);
ClassDB::bind_method(D_METHOD("set_middle_mouse_paste_enabled", "enabled"), &TextEdit::set_middle_mouse_paste_enabled);
ClassDB::bind_method(D_METHOD("is_middle_mouse_paste_enabled"), &TextEdit::is_middle_mouse_paste_enabled);
// Text manipulation
ClassDB::bind_method(D_METHOD("clear"), &TextEdit::clear);
ClassDB::bind_method(D_METHOD("set_text", "text"), &TextEdit::set_text);
ClassDB::bind_method(D_METHOD("get_text"), &TextEdit::get_text);
ClassDB::bind_method(D_METHOD("get_line_count"), &TextEdit::get_line_count);
ClassDB::bind_method(D_METHOD("set_placeholder", "text"), &TextEdit::set_placeholder);
ClassDB::bind_method(D_METHOD("get_placeholder"), &TextEdit::get_placeholder);
ClassDB::bind_method(D_METHOD("set_line", "line", "new_text"), &TextEdit::set_line);
ClassDB::bind_method(D_METHOD("get_line", "line"), &TextEdit::get_line);
ClassDB::bind_method(D_METHOD("get_line_width", "line", "wrap_index"), &TextEdit::get_line_width, DEFVAL(-1));
ClassDB::bind_method(D_METHOD("get_line_height"), &TextEdit::get_line_height);
ClassDB::bind_method(D_METHOD("get_indent_level", "line"), &TextEdit::get_indent_level);
ClassDB::bind_method(D_METHOD("get_first_non_whitespace_column", "line"), &TextEdit::get_first_non_whitespace_column);
ClassDB::bind_method(D_METHOD("swap_lines", "from_line", "to_line"), &TextEdit::swap_lines);
ClassDB::bind_method(D_METHOD("insert_line_at", "line", "text"), &TextEdit::insert_line_at);
ClassDB::bind_method(D_METHOD("insert_text_at_caret", "text", "caret_index"), &TextEdit::insert_text_at_caret, DEFVAL(-1));
ClassDB::bind_method(D_METHOD("remove_text", "from_line", "from_column", "to_line", "to_column"), &TextEdit::remove_text);
ClassDB::bind_method(D_METHOD("get_last_unhidden_line"), &TextEdit::get_last_unhidden_line);
ClassDB::bind_method(D_METHOD("get_next_visible_line_offset_from", "line", "visible_amount"), &TextEdit::get_next_visible_line_offset_from);
ClassDB::bind_method(D_METHOD("get_next_visible_line_index_offset_from", "line", "wrap_index", "visible_amount"), &TextEdit::get_next_visible_line_index_offset_from);
// Overridable actions
ClassDB::bind_method(D_METHOD("backspace", "caret_index"), &TextEdit::backspace, DEFVAL(-1));
ClassDB::bind_method(D_METHOD("cut", "caret_index"), &TextEdit::cut, DEFVAL(-1));
ClassDB::bind_method(D_METHOD("copy", "caret_index"), &TextEdit::copy, DEFVAL(-1));
ClassDB::bind_method(D_METHOD("paste", "caret_index"), &TextEdit::paste, DEFVAL(-1));
ClassDB::bind_method(D_METHOD("paste_primary_clipboard", "caret_index"), &TextEdit::paste_primary_clipboard, DEFVAL(-1));
GDVIRTUAL_BIND(_handle_unicode_input, "unicode_char", "caret_index")
GDVIRTUAL_BIND(_backspace, "caret_index")
GDVIRTUAL_BIND(_cut, "caret_index")
GDVIRTUAL_BIND(_copy, "caret_index")
GDVIRTUAL_BIND(_paste, "caret_index")
GDVIRTUAL_BIND(_paste_primary_clipboard, "caret_index")
// Context Menu
BIND_ENUM_CONSTANT(MENU_CUT);
BIND_ENUM_CONSTANT(MENU_COPY);
BIND_ENUM_CONSTANT(MENU_PASTE);
BIND_ENUM_CONSTANT(MENU_CLEAR);
BIND_ENUM_CONSTANT(MENU_SELECT_ALL);
BIND_ENUM_CONSTANT(MENU_UNDO);
BIND_ENUM_CONSTANT(MENU_REDO);
BIND_ENUM_CONSTANT(MENU_DIR_INHERITED);
BIND_ENUM_CONSTANT(MENU_DIR_AUTO);
BIND_ENUM_CONSTANT(MENU_DIR_LTR);
BIND_ENUM_CONSTANT(MENU_DIR_RTL);
BIND_ENUM_CONSTANT(MENU_DISPLAY_UCC);
BIND_ENUM_CONSTANT(MENU_INSERT_LRM);
BIND_ENUM_CONSTANT(MENU_INSERT_RLM);
BIND_ENUM_CONSTANT(MENU_INSERT_LRE);
BIND_ENUM_CONSTANT(MENU_INSERT_RLE);
BIND_ENUM_CONSTANT(MENU_INSERT_LRO);
BIND_ENUM_CONSTANT(MENU_INSERT_RLO);
BIND_ENUM_CONSTANT(MENU_INSERT_PDF);
BIND_ENUM_CONSTANT(MENU_INSERT_ALM);
BIND_ENUM_CONSTANT(MENU_INSERT_LRI);
BIND_ENUM_CONSTANT(MENU_INSERT_RLI);
BIND_ENUM_CONSTANT(MENU_INSERT_FSI);
BIND_ENUM_CONSTANT(MENU_INSERT_PDI);
BIND_ENUM_CONSTANT(MENU_INSERT_ZWJ);
BIND_ENUM_CONSTANT(MENU_INSERT_ZWNJ);
BIND_ENUM_CONSTANT(MENU_INSERT_WJ);
BIND_ENUM_CONSTANT(MENU_INSERT_SHY);
BIND_ENUM_CONSTANT(MENU_MAX);
/* Versioning */
BIND_ENUM_CONSTANT(ACTION_NONE);
BIND_ENUM_CONSTANT(ACTION_TYPING);
BIND_ENUM_CONSTANT(ACTION_BACKSPACE);
BIND_ENUM_CONSTANT(ACTION_DELETE);
ClassDB::bind_method(D_METHOD("start_action", "action"), &TextEdit::start_action);
ClassDB::bind_method(D_METHOD("end_action"), &TextEdit::end_complex_operation);
ClassDB::bind_method(D_METHOD("begin_complex_operation"), &TextEdit::begin_complex_operation);
ClassDB::bind_method(D_METHOD("end_complex_operation"), &TextEdit::end_complex_operation);
ClassDB::bind_method(D_METHOD("has_undo"), &TextEdit::has_undo);
ClassDB::bind_method(D_METHOD("has_redo"), &TextEdit::has_redo);
ClassDB::bind_method(D_METHOD("undo"), &TextEdit::undo);
ClassDB::bind_method(D_METHOD("redo"), &TextEdit::redo);
ClassDB::bind_method(D_METHOD("clear_undo_history"), &TextEdit::clear_undo_history);
ClassDB::bind_method(D_METHOD("tag_saved_version"), &TextEdit::tag_saved_version);
ClassDB::bind_method(D_METHOD("get_version"), &TextEdit::get_version);
ClassDB::bind_method(D_METHOD("get_saved_version"), &TextEdit::get_saved_version);
/* Search */
BIND_ENUM_CONSTANT(SEARCH_MATCH_CASE);
BIND_ENUM_CONSTANT(SEARCH_WHOLE_WORDS);
BIND_ENUM_CONSTANT(SEARCH_BACKWARDS);
ClassDB::bind_method(D_METHOD("set_search_text", "search_text"), &TextEdit::set_search_text);
ClassDB::bind_method(D_METHOD("set_search_flags", "flags"), &TextEdit::set_search_flags);
ClassDB::bind_method(D_METHOD("search", "text", "flags", "from_line", "from_colum"), &TextEdit::search);
/* Tooltip */
ClassDB::bind_method(D_METHOD("set_tooltip_request_func", "callback"), &TextEdit::set_tooltip_request_func);
/* Mouse */
ClassDB::bind_method(D_METHOD("get_local_mouse_pos"), &TextEdit::get_local_mouse_pos);
ClassDB::bind_method(D_METHOD("get_word_at_pos", "position"), &TextEdit::get_word_at_pos);
ClassDB::bind_method(D_METHOD("get_line_column_at_pos", "position", "allow_out_of_bounds"), &TextEdit::get_line_column_at_pos, DEFVAL(true));
ClassDB::bind_method(D_METHOD("get_pos_at_line_column", "line", "column"), &TextEdit::get_pos_at_line_column);
ClassDB::bind_method(D_METHOD("get_rect_at_line_column", "line", "column"), &TextEdit::get_rect_at_line_column);
ClassDB::bind_method(D_METHOD("get_minimap_line_at_pos", "position"), &TextEdit::get_minimap_line_at_pos);
ClassDB::bind_method(D_METHOD("is_dragging_cursor"), &TextEdit::is_dragging_cursor);
ClassDB::bind_method(D_METHOD("is_mouse_over_selection", "edges", "caret_index"), &TextEdit::is_mouse_over_selection, DEFVAL(-1));
/* Caret. */
BIND_ENUM_CONSTANT(CARET_TYPE_LINE);
BIND_ENUM_CONSTANT(CARET_TYPE_BLOCK);
// internal.
ClassDB::bind_method(D_METHOD("_emit_caret_changed"), &TextEdit::_emit_caret_changed);
ClassDB::bind_method(D_METHOD("set_caret_type", "type"), &TextEdit::set_caret_type);
ClassDB::bind_method(D_METHOD("get_caret_type"), &TextEdit::get_caret_type);
ClassDB::bind_method(D_METHOD("set_caret_blink_enabled", "enable"), &TextEdit::set_caret_blink_enabled);
ClassDB::bind_method(D_METHOD("is_caret_blink_enabled"), &TextEdit::is_caret_blink_enabled);
ClassDB::bind_method(D_METHOD("set_caret_blink_interval", "interval"), &TextEdit::set_caret_blink_interval);
ClassDB::bind_method(D_METHOD("get_caret_blink_interval"), &TextEdit::get_caret_blink_interval);
ClassDB::bind_method(D_METHOD("set_move_caret_on_right_click_enabled", "enable"), &TextEdit::set_move_caret_on_right_click_enabled);
ClassDB::bind_method(D_METHOD("is_move_caret_on_right_click_enabled"), &TextEdit::is_move_caret_on_right_click_enabled);
ClassDB::bind_method(D_METHOD("set_caret_mid_grapheme_enabled", "enabled"), &TextEdit::set_caret_mid_grapheme_enabled);
ClassDB::bind_method(D_METHOD("is_caret_mid_grapheme_enabled"), &TextEdit::is_caret_mid_grapheme_enabled);
ClassDB::bind_method(D_METHOD("set_multiple_carets_enabled", "enabled"), &TextEdit::set_multiple_carets_enabled);
ClassDB::bind_method(D_METHOD("is_multiple_carets_enabled"), &TextEdit::is_multiple_carets_enabled);
ClassDB::bind_method(D_METHOD("add_caret", "line", "col"), &TextEdit::add_caret);
ClassDB::bind_method(D_METHOD("remove_caret", "caret"), &TextEdit::remove_caret);
ClassDB::bind_method(D_METHOD("remove_secondary_carets"), &TextEdit::remove_secondary_carets);
ClassDB::bind_method(D_METHOD("merge_overlapping_carets"), &TextEdit::merge_overlapping_carets);
ClassDB::bind_method(D_METHOD("get_caret_count"), &TextEdit::get_caret_count);
ClassDB::bind_method(D_METHOD("add_caret_at_carets", "below"), &TextEdit::add_caret_at_carets);
ClassDB::bind_method(D_METHOD("get_caret_index_edit_order"), &TextEdit::get_caret_index_edit_order);
ClassDB::bind_method(D_METHOD("adjust_carets_after_edit", "caret", "from_line", "from_col", "to_line", "to_col"), &TextEdit::adjust_carets_after_edit);
ClassDB::bind_method(D_METHOD("is_caret_visible", "caret_index"), &TextEdit::is_caret_visible, DEFVAL(0));
ClassDB::bind_method(D_METHOD("get_caret_draw_pos", "caret_index"), &TextEdit::get_caret_draw_pos, DEFVAL(0));
ClassDB::bind_method(D_METHOD("set_caret_line", "line", "adjust_viewport", "can_be_hidden", "wrap_index", "caret_index"), &TextEdit::set_caret_line, DEFVAL(true), DEFVAL(true), DEFVAL(0), DEFVAL(0));
ClassDB::bind_method(D_METHOD("get_caret_line", "caret_index"), &TextEdit::get_caret_line, DEFVAL(0));
ClassDB::bind_method(D_METHOD("set_caret_column", "column", "adjust_viewport", "caret_index"), &TextEdit::set_caret_column, DEFVAL(true), DEFVAL(0));
ClassDB::bind_method(D_METHOD("get_caret_column", "caret_index"), &TextEdit::get_caret_column, DEFVAL(0));
ClassDB::bind_method(D_METHOD("get_caret_wrap_index", "caret_index"), &TextEdit::get_caret_wrap_index, DEFVAL(0));
ClassDB::bind_method(D_METHOD("get_word_under_caret", "caret_index"), &TextEdit::get_word_under_caret, DEFVAL(-1));
/* Selection. */
BIND_ENUM_CONSTANT(SELECTION_MODE_NONE);
BIND_ENUM_CONSTANT(SELECTION_MODE_SHIFT);
BIND_ENUM_CONSTANT(SELECTION_MODE_POINTER);
BIND_ENUM_CONSTANT(SELECTION_MODE_WORD);
BIND_ENUM_CONSTANT(SELECTION_MODE_LINE);
ClassDB::bind_method(D_METHOD("set_selecting_enabled", "enable"), &TextEdit::set_selecting_enabled);
ClassDB::bind_method(D_METHOD("is_selecting_enabled"), &TextEdit::is_selecting_enabled);
ClassDB::bind_method(D_METHOD("set_deselect_on_focus_loss_enabled", "enable"), &TextEdit::set_deselect_on_focus_loss_enabled);
ClassDB::bind_method(D_METHOD("is_deselect_on_focus_loss_enabled"), &TextEdit::is_deselect_on_focus_loss_enabled);
ClassDB::bind_method(D_METHOD("set_drag_and_drop_selection_enabled", "enable"), &TextEdit::set_drag_and_drop_selection_enabled);
ClassDB::bind_method(D_METHOD("is_drag_and_drop_selection_enabled"), &TextEdit::is_drag_and_drop_selection_enabled);
ClassDB::bind_method(D_METHOD("set_selection_mode", "mode", "line", "column", "caret_index"), &TextEdit::set_selection_mode, DEFVAL(-1), DEFVAL(-1), DEFVAL(0));
ClassDB::bind_method(D_METHOD("get_selection_mode"), &TextEdit::get_selection_mode);
ClassDB::bind_method(D_METHOD("select_all"), &TextEdit::select_all);
ClassDB::bind_method(D_METHOD("select_word_under_caret", "caret_index"), &TextEdit::select_word_under_caret, DEFVAL(-1));
ClassDB::bind_method(D_METHOD("add_selection_for_next_occurrence"), &TextEdit::add_selection_for_next_occurrence);
ClassDB::bind_method(D_METHOD("select", "from_line", "from_column", "to_line", "to_column", "caret_index"), &TextEdit::select, DEFVAL(0));
ClassDB::bind_method(D_METHOD("has_selection", "caret_index"), &TextEdit::has_selection, DEFVAL(-1));
ClassDB::bind_method(D_METHOD("get_selected_text", "caret_index"), &TextEdit::get_selected_text, DEFVAL(-1));
ClassDB::bind_method(D_METHOD("get_selection_line", "caret_index"), &TextEdit::get_selection_line, DEFVAL(0));
ClassDB::bind_method(D_METHOD("get_selection_column", "caret_index"), &TextEdit::get_selection_column, DEFVAL(0));
ClassDB::bind_method(D_METHOD("get_selection_from_line", "caret_index"), &TextEdit::get_selection_from_line, DEFVAL(0));
ClassDB::bind_method(D_METHOD("get_selection_from_column", "caret_index"), &TextEdit::get_selection_from_column, DEFVAL(0));
ClassDB::bind_method(D_METHOD("get_selection_to_line", "caret_index"), &TextEdit::get_selection_to_line, DEFVAL(0));
ClassDB::bind_method(D_METHOD("get_selection_to_column", "caret_index"), &TextEdit::get_selection_to_column, DEFVAL(0));
ClassDB::bind_method(D_METHOD("deselect", "caret_index"), &TextEdit::deselect, DEFVAL(-1));
ClassDB::bind_method(D_METHOD("delete_selection", "caret_index"), &TextEdit::delete_selection, DEFVAL(-1));
/* Line wrapping. */
BIND_ENUM_CONSTANT(LINE_WRAPPING_NONE);
BIND_ENUM_CONSTANT(LINE_WRAPPING_BOUNDARY);
// internal.
ClassDB::bind_method(D_METHOD("_update_wrap_at_column", "force"), &TextEdit::_update_wrap_at_column, DEFVAL(false));
ClassDB::bind_method(D_METHOD("set_line_wrapping_mode", "mode"), &TextEdit::set_line_wrapping_mode);
ClassDB::bind_method(D_METHOD("get_line_wrapping_mode"), &TextEdit::get_line_wrapping_mode);
ClassDB::bind_method(D_METHOD("is_line_wrapped", "line"), &TextEdit::is_line_wrapped);
ClassDB::bind_method(D_METHOD("get_line_wrap_count", "line"), &TextEdit::get_line_wrap_count);
ClassDB::bind_method(D_METHOD("get_line_wrap_index_at_column", "line", "column"), &TextEdit::get_line_wrap_index_at_column);
ClassDB::bind_method(D_METHOD("get_line_wrapped_text", "line"), &TextEdit::get_line_wrapped_text);
/* Viewport. */
// Scrolling.
ClassDB::bind_method(D_METHOD("set_smooth_scroll_enabled", "enable"), &TextEdit::set_smooth_scroll_enabled);
ClassDB::bind_method(D_METHOD("is_smooth_scroll_enabled"), &TextEdit::is_smooth_scroll_enabled);
ClassDB::bind_method(D_METHOD("get_v_scroll_bar"), &TextEdit::get_v_scroll_bar);
ClassDB::bind_method(D_METHOD("get_h_scroll_bar"), &TextEdit::get_h_scroll_bar);
ClassDB::bind_method(D_METHOD("set_v_scroll", "value"), &TextEdit::set_v_scroll);
ClassDB::bind_method(D_METHOD("get_v_scroll"), &TextEdit::get_v_scroll);
ClassDB::bind_method(D_METHOD("set_h_scroll", "value"), &TextEdit::set_h_scroll);
ClassDB::bind_method(D_METHOD("get_h_scroll"), &TextEdit::get_h_scroll);
ClassDB::bind_method(D_METHOD("set_scroll_past_end_of_file_enabled", "enable"), &TextEdit::set_scroll_past_end_of_file_enabled);
ClassDB::bind_method(D_METHOD("is_scroll_past_end_of_file_enabled"), &TextEdit::is_scroll_past_end_of_file_enabled);
ClassDB::bind_method(D_METHOD("set_v_scroll_speed", "speed"), &TextEdit::set_v_scroll_speed);
ClassDB::bind_method(D_METHOD("get_v_scroll_speed"), &TextEdit::get_v_scroll_speed);
ClassDB::bind_method(D_METHOD("set_fit_content_height_enabled", "enabled"), &TextEdit::set_fit_content_height_enabled);
ClassDB::bind_method(D_METHOD("is_fit_content_height_enabled"), &TextEdit::is_fit_content_height_enabled);
ClassDB::bind_method(D_METHOD("get_scroll_pos_for_line", "line", "wrap_index"), &TextEdit::get_scroll_pos_for_line, DEFVAL(0));
// Visible lines.
ClassDB::bind_method(D_METHOD("set_line_as_first_visible", "line", "wrap_index"), &TextEdit::set_line_as_first_visible, DEFVAL(0));
ClassDB::bind_method(D_METHOD("get_first_visible_line"), &TextEdit::get_first_visible_line);
ClassDB::bind_method(D_METHOD("set_line_as_center_visible", "line", "wrap_index"), &TextEdit::set_line_as_center_visible, DEFVAL(0));
ClassDB::bind_method(D_METHOD("set_line_as_last_visible", "line", "wrap_index"), &TextEdit::set_line_as_last_visible, DEFVAL(0));
ClassDB::bind_method(D_METHOD("get_last_full_visible_line"), &TextEdit::get_last_full_visible_line);
ClassDB::bind_method(D_METHOD("get_last_full_visible_line_wrap_index"), &TextEdit::get_last_full_visible_line_wrap_index);
ClassDB::bind_method(D_METHOD("get_visible_line_count"), &TextEdit::get_visible_line_count);
ClassDB::bind_method(D_METHOD("get_visible_line_count_in_range", "from_line", "to_line"), &TextEdit::get_visible_line_count_in_range);
ClassDB::bind_method(D_METHOD("get_total_visible_line_count"), &TextEdit::get_total_visible_line_count);
// Auto adjust
ClassDB::bind_method(D_METHOD("adjust_viewport_to_caret", "caret_index"), &TextEdit::adjust_viewport_to_caret, DEFVAL(0));
ClassDB::bind_method(D_METHOD("center_viewport_to_caret", "caret_index"), &TextEdit::center_viewport_to_caret, DEFVAL(0));
// Minimap
ClassDB::bind_method(D_METHOD("set_draw_minimap", "enabled"), &TextEdit::set_draw_minimap);
ClassDB::bind_method(D_METHOD("is_drawing_minimap"), &TextEdit::is_drawing_minimap);
ClassDB::bind_method(D_METHOD("set_minimap_width", "width"), &TextEdit::set_minimap_width);
ClassDB::bind_method(D_METHOD("get_minimap_width"), &TextEdit::get_minimap_width);
ClassDB::bind_method(D_METHOD("get_minimap_visible_lines"), &TextEdit::get_minimap_visible_lines);
/* Gutters. */
BIND_ENUM_CONSTANT(GUTTER_TYPE_STRING);
BIND_ENUM_CONSTANT(GUTTER_TYPE_ICON);
BIND_ENUM_CONSTANT(GUTTER_TYPE_CUSTOM);
ClassDB::bind_method(D_METHOD("add_gutter", "at"), &TextEdit::add_gutter, DEFVAL(-1));
ClassDB::bind_method(D_METHOD("remove_gutter", "gutter"), &TextEdit::remove_gutter);
ClassDB::bind_method(D_METHOD("get_gutter_count"), &TextEdit::get_gutter_count);
ClassDB::bind_method(D_METHOD("set_gutter_name", "gutter", "name"), &TextEdit::set_gutter_name);
ClassDB::bind_method(D_METHOD("get_gutter_name", "gutter"), &TextEdit::get_gutter_name);
ClassDB::bind_method(D_METHOD("set_gutter_type", "gutter", "type"), &TextEdit::set_gutter_type);
ClassDB::bind_method(D_METHOD("get_gutter_type", "gutter"), &TextEdit::get_gutter_type);
ClassDB::bind_method(D_METHOD("set_gutter_width", "gutter", "width"), &TextEdit::set_gutter_width);
ClassDB::bind_method(D_METHOD("get_gutter_width", "gutter"), &TextEdit::get_gutter_width);
ClassDB::bind_method(D_METHOD("set_gutter_draw", "gutter", "draw"), &TextEdit::set_gutter_draw);
ClassDB::bind_method(D_METHOD("is_gutter_drawn", "gutter"), &TextEdit::is_gutter_drawn);
ClassDB::bind_method(D_METHOD("set_gutter_clickable", "gutter", "clickable"), &TextEdit::set_gutter_clickable);
ClassDB::bind_method(D_METHOD("is_gutter_clickable", "gutter"), &TextEdit::is_gutter_clickable);
ClassDB::bind_method(D_METHOD("set_gutter_overwritable", "gutter", "overwritable"), &TextEdit::set_gutter_overwritable);
ClassDB::bind_method(D_METHOD("is_gutter_overwritable", "gutter"), &TextEdit::is_gutter_overwritable);
ClassDB::bind_method(D_METHOD("merge_gutters", "from_line", "to_line"), &TextEdit::merge_gutters);
ClassDB::bind_method(D_METHOD("set_gutter_custom_draw", "column", "draw_callback"), &TextEdit::set_gutter_custom_draw);
ClassDB::bind_method(D_METHOD("get_total_gutter_width"), &TextEdit::get_total_gutter_width);
// Line gutters.
ClassDB::bind_method(D_METHOD("set_line_gutter_metadata", "line", "gutter", "metadata"), &TextEdit::set_line_gutter_metadata);
ClassDB::bind_method(D_METHOD("get_line_gutter_metadata", "line", "gutter"), &TextEdit::get_line_gutter_metadata);
ClassDB::bind_method(D_METHOD("set_line_gutter_text", "line", "gutter", "text"), &TextEdit::set_line_gutter_text);
ClassDB::bind_method(D_METHOD("get_line_gutter_text", "line", "gutter"), &TextEdit::get_line_gutter_text);
ClassDB::bind_method(D_METHOD("set_line_gutter_icon", "line", "gutter", "icon"), &TextEdit::set_line_gutter_icon);
ClassDB::bind_method(D_METHOD("get_line_gutter_icon", "line", "gutter"), &TextEdit::get_line_gutter_icon);
ClassDB::bind_method(D_METHOD("set_line_gutter_item_color", "line", "gutter", "color"), &TextEdit::set_line_gutter_item_color);
ClassDB::bind_method(D_METHOD("get_line_gutter_item_color", "line", "gutter"), &TextEdit::get_line_gutter_item_color);
ClassDB::bind_method(D_METHOD("set_line_gutter_clickable", "line", "gutter", "clickable"), &TextEdit::set_line_gutter_clickable);
ClassDB::bind_method(D_METHOD("is_line_gutter_clickable", "line", "gutter"), &TextEdit::is_line_gutter_clickable);
// Line style
ClassDB::bind_method(D_METHOD("set_line_background_color", "line", "color"), &TextEdit::set_line_background_color);
ClassDB::bind_method(D_METHOD("get_line_background_color", "line"), &TextEdit::get_line_background_color);
/* Syntax Highlighting. */
ClassDB::bind_method(D_METHOD("set_syntax_highlighter", "syntax_highlighter"), &TextEdit::set_syntax_highlighter);
ClassDB::bind_method(D_METHOD("get_syntax_highlighter"), &TextEdit::get_syntax_highlighter);
/* Visual. */
ClassDB::bind_method(D_METHOD("set_highlight_current_line", "enabled"), &TextEdit::set_highlight_current_line);
ClassDB::bind_method(D_METHOD("is_highlight_current_line_enabled"), &TextEdit::is_highlight_current_line_enabled);
ClassDB::bind_method(D_METHOD("set_highlight_all_occurrences", "enabled"), &TextEdit::set_highlight_all_occurrences);
ClassDB::bind_method(D_METHOD("is_highlight_all_occurrences_enabled"), &TextEdit::is_highlight_all_occurrences_enabled);
ClassDB::bind_method(D_METHOD("get_draw_control_chars"), &TextEdit::get_draw_control_chars);
ClassDB::bind_method(D_METHOD("set_draw_control_chars", "enabled"), &TextEdit::set_draw_control_chars);
ClassDB::bind_method(D_METHOD("set_draw_tabs", "enabled"), &TextEdit::set_draw_tabs);
ClassDB::bind_method(D_METHOD("is_drawing_tabs"), &TextEdit::is_drawing_tabs);
ClassDB::bind_method(D_METHOD("set_draw_spaces", "enabled"), &TextEdit::set_draw_spaces);
ClassDB::bind_method(D_METHOD("is_drawing_spaces"), &TextEdit::is_drawing_spaces);
ClassDB::bind_method(D_METHOD("get_menu"), &TextEdit::get_menu);
ClassDB::bind_method(D_METHOD("is_menu_visible"), &TextEdit::is_menu_visible);
ClassDB::bind_method(D_METHOD("menu_option", "option"), &TextEdit::menu_option);
/* Inspector */
ADD_PROPERTY(PropertyInfo(Variant::STRING, "text", PROPERTY_HINT_MULTILINE_TEXT), "set_text", "get_text");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "placeholder_text", PROPERTY_HINT_MULTILINE_TEXT), "set_placeholder", "get_placeholder");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "editable"), "set_editable", "is_editable");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "context_menu_enabled"), "set_context_menu_enabled", "is_context_menu_enabled");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "shortcut_keys_enabled"), "set_shortcut_keys_enabled", "is_shortcut_keys_enabled");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "selecting_enabled"), "set_selecting_enabled", "is_selecting_enabled");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "deselect_on_focus_loss_enabled"), "set_deselect_on_focus_loss_enabled", "is_deselect_on_focus_loss_enabled");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "drag_and_drop_selection_enabled"), "set_drag_and_drop_selection_enabled", "is_drag_and_drop_selection_enabled");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "virtual_keyboard_enabled"), "set_virtual_keyboard_enabled", "is_virtual_keyboard_enabled");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "middle_mouse_paste_enabled"), "set_middle_mouse_paste_enabled", "is_middle_mouse_paste_enabled");
ADD_PROPERTY(PropertyInfo(Variant::INT, "wrap_mode", PROPERTY_HINT_ENUM, "None,Boundary"), "set_line_wrapping_mode", "get_line_wrapping_mode");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "highlight_all_occurrences"), "set_highlight_all_occurrences", "is_highlight_all_occurrences_enabled");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "highlight_current_line"), "set_highlight_current_line", "is_highlight_current_line_enabled");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "draw_control_chars"), "set_draw_control_chars", "get_draw_control_chars");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "draw_tabs"), "set_draw_tabs", "is_drawing_tabs");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "draw_spaces"), "set_draw_spaces", "is_drawing_spaces");
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "syntax_highlighter", PROPERTY_HINT_RESOURCE_TYPE, "SyntaxHighlighter", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_DO_NOT_SHARE_ON_DUPLICATE), "set_syntax_highlighter", "get_syntax_highlighter");
ADD_GROUP("Scroll", "scroll_");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "scroll_smooth"), "set_smooth_scroll_enabled", "is_smooth_scroll_enabled");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "scroll_v_scroll_speed", PROPERTY_HINT_NONE, "suffix:px/s"), "set_v_scroll_speed", "get_v_scroll_speed");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "scroll_past_end_of_file"), "set_scroll_past_end_of_file_enabled", "is_scroll_past_end_of_file_enabled");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "scroll_vertical", PROPERTY_HINT_NONE, "suffix:px"), "set_v_scroll", "get_v_scroll");
ADD_PROPERTY(PropertyInfo(Variant::INT, "scroll_horizontal", PROPERTY_HINT_NONE, "suffix:px"), "set_h_scroll", "get_h_scroll");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "scroll_fit_content_height"), "set_fit_content_height_enabled", "is_fit_content_height_enabled");
ADD_GROUP("Minimap", "minimap_");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "minimap_draw"), "set_draw_minimap", "is_drawing_minimap");
ADD_PROPERTY(PropertyInfo(Variant::INT, "minimap_width", PROPERTY_HINT_NONE, "suffix:px"), "set_minimap_width", "get_minimap_width");
ADD_GROUP("Caret", "caret_");
ADD_PROPERTY(PropertyInfo(Variant::INT, "caret_type", PROPERTY_HINT_ENUM, "Line,Block"), "set_caret_type", "get_caret_type");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "caret_blink"), "set_caret_blink_enabled", "is_caret_blink_enabled");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "caret_blink_interval", PROPERTY_HINT_RANGE, "0.1,10,0.01,suffix:s"), "set_caret_blink_interval", "get_caret_blink_interval");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "caret_move_on_right_click"), "set_move_caret_on_right_click_enabled", "is_move_caret_on_right_click_enabled");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "caret_mid_grapheme"), "set_caret_mid_grapheme_enabled", "is_caret_mid_grapheme_enabled");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "caret_multiple"), "set_multiple_carets_enabled", "is_multiple_carets_enabled");
ADD_GROUP("BiDi", "");
ADD_PROPERTY(PropertyInfo(Variant::INT, "text_direction", PROPERTY_HINT_ENUM, "Auto,Left-to-Right,Right-to-Left,Inherited"), "set_text_direction", "get_text_direction");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "language", PROPERTY_HINT_LOCALE_ID, ""), "set_language", "get_language");
ADD_PROPERTY(PropertyInfo(Variant::INT, "structured_text_bidi_override", PROPERTY_HINT_ENUM, "Default,URI,File,Email,List,None,Custom"), "set_structured_text_bidi_override", "get_structured_text_bidi_override");
ADD_PROPERTY(PropertyInfo(Variant::ARRAY, "structured_text_bidi_override_options"), "set_structured_text_bidi_override_options", "get_structured_text_bidi_override_options");
/* Signals */
/* Core. */
ADD_SIGNAL(MethodInfo("text_set"));
ADD_SIGNAL(MethodInfo("text_changed"));
ADD_SIGNAL(MethodInfo("lines_edited_from", PropertyInfo(Variant::INT, "from_line"), PropertyInfo(Variant::INT, "to_line")));
/* Caret. */
ADD_SIGNAL(MethodInfo("caret_changed"));
/* Gutters. */
ADD_SIGNAL(MethodInfo("gutter_clicked", PropertyInfo(Variant::INT, "line"), PropertyInfo(Variant::INT, "gutter")));
ADD_SIGNAL(MethodInfo("gutter_added"));
ADD_SIGNAL(MethodInfo("gutter_removed"));
/* Settings. */
GLOBAL_DEF("gui/timers/text_edit_idle_detect_sec", 3);
ProjectSettings::get_singleton()->set_custom_property_info("gui/timers/text_edit_idle_detect_sec", PropertyInfo(Variant::FLOAT, "gui/timers/text_edit_idle_detect_sec", PROPERTY_HINT_RANGE, "0,10,0.01,or_greater")); // No negative numbers.
GLOBAL_DEF("gui/common/text_edit_undo_stack_max_size", 1024);
ProjectSettings::get_singleton()->set_custom_property_info("gui/common/text_edit_undo_stack_max_size", PropertyInfo(Variant::INT, "gui/common/text_edit_undo_stack_max_size", PROPERTY_HINT_RANGE, "0,10000,1,or_greater")); // No negative numbers.
}
/* Internal API for CodeEdit. */
// Line hiding.
void TextEdit::_set_hiding_enabled(bool p_enabled) {
if (hiding_enabled == p_enabled) {
return;
}
if (!p_enabled) {
_unhide_all_lines();
}
hiding_enabled = p_enabled;
queue_redraw();
}
bool TextEdit::_is_hiding_enabled() const {
return hiding_enabled;
}
bool TextEdit::_is_line_hidden(int p_line) const {
ERR_FAIL_INDEX_V(p_line, text.size(), false);
return text.is_hidden(p_line);
}
void TextEdit::_unhide_all_lines() {
for (int i = 0; i < text.size(); i++) {
text.set_hidden(i, false);
}
_update_scrollbars();
queue_redraw();
}
void TextEdit::_set_line_as_hidden(int p_line, bool p_hidden) {
ERR_FAIL_INDEX(p_line, text.size());
if (text.is_hidden(p_line) == p_hidden) {
return;
}
if (_is_hiding_enabled() || !p_hidden) {
text.set_hidden(p_line, p_hidden);
}
queue_redraw();
}
// Symbol lookup.
void TextEdit::_set_symbol_lookup_word(const String &p_symbol) {
if (lookup_symbol_word == p_symbol) {
return;
}
lookup_symbol_word = p_symbol;
queue_redraw();
}
/* Text manipulation */
// Overridable actions
void TextEdit::_handle_unicode_input_internal(const uint32_t p_unicode, int p_caret) {
ERR_FAIL_COND(p_caret > carets.size());
if (!editable) {
return;
}
start_action(EditAction::ACTION_TYPING);
Vector<int> caret_edit_order = get_caret_index_edit_order();
for (const int &i : caret_edit_order) {
if (p_caret != -1 && p_caret != i) {
continue;
}
/* Remove the old character if in insert mode and no selection. */
if (overtype_mode && !has_selection(i)) {
/* Make sure we don't try and remove empty space. */
int cl = get_caret_line(i);
int cc = get_caret_column(i);
if (cc < get_line(cl).length()) {
_remove_text(cl, cc, cl, cc + 1);
}
}
const char32_t chr[2] = { (char32_t)p_unicode, 0 };
insert_text_at_caret(chr, i);
}
end_action();
}
void TextEdit::_backspace_internal(int p_caret) {
ERR_FAIL_COND(p_caret > carets.size());
if (!editable) {
return;
}
if (has_selection(p_caret)) {
delete_selection(p_caret);
return;
}
begin_complex_operation();
Vector<int> caret_edit_order = get_caret_index_edit_order();
for (const int &i : caret_edit_order) {
if (p_caret != -1 && p_caret != i) {
continue;
}
int cc = get_caret_column(i);
int cl = get_caret_line(i);
if (cc == 0 && cl == 0) {
continue;
}
int prev_line = cc ? cl : cl - 1;
int prev_column = cc ? (cc - 1) : (text[cl - 1].length());
merge_gutters(prev_line, cl);
if (_is_line_hidden(cl)) {
_set_line_as_hidden(prev_line, true);
}
_remove_text(prev_line, prev_column, cl, cc);
set_caret_line(prev_line, false, true, 0, i);
set_caret_column(prev_column, i == 0, i);
adjust_carets_after_edit(i, prev_line, prev_column, cl, cc);
}
merge_overlapping_carets();
end_complex_operation();
}
void TextEdit::_cut_internal(int p_caret) {
ERR_FAIL_COND(p_caret > carets.size());
if (!editable) {
return;
}
if (has_selection(p_caret)) {
DisplayServer::get_singleton()->clipboard_set(get_selected_text(p_caret));
delete_selection(p_caret);
cut_copy_line = "";
return;
}
begin_complex_operation();
Vector<int> carets_to_remove;
StringBuilder clipboard;
// This is the exception and has to edit in reverse order else the string copied to the clipboard will be backwards.
Vector<int> caret_edit_order = get_caret_index_edit_order();
for (int i = caret_edit_order.size() - 1; i >= 0; i--) {
int caret_idx = caret_edit_order[i];
if (p_caret != -1 && p_caret != caret_idx) {
continue;
}
int cl = get_caret_line(caret_idx);
int cc = get_caret_column(caret_idx);
int indent_level = get_indent_level(cl);
double hscroll = get_h_scroll();
// Check for overlapping carets.
// We don't need to worry about selections as that is caught before this entire section.
for (int j = i - 1; j >= 0; j--) {
if (get_caret_line(caret_edit_order[j]) == cl) {
carets_to_remove.push_back(caret_edit_order[j]);
i = j;
}
}
clipboard += text[cl];
if (p_caret == -1 && caret_idx != 0) {
clipboard += "\n";
}
if (cl == 0 && get_line_count() > 1) {
_remove_text(cl, 0, cl + 1, 0);
adjust_carets_after_edit(caret_idx, cl, 0, cl + 1, text[cl].length());
} else {
_remove_text(cl, 0, cl, text[cl].length());
set_caret_column(0, false, caret_idx);
backspace(caret_idx);
set_caret_line(get_caret_line(caret_idx) + 1, caret_idx == 0, 0, 0, caret_idx);
}
// Correct the visually perceived caret column taking care of indentation level of the lines.
int diff_indent = indent_level - get_indent_level(get_caret_line(caret_idx));
cc += diff_indent;
if (diff_indent != 0) {
cc += diff_indent > 0 ? -1 : 1;
}
// Restore horizontal scroll and caret column modified by the backspace() call.
set_h_scroll(hscroll);
set_caret_column(cc, caret_idx == 0, caret_idx);
}
// Sort and remove backwards to preserve indexes.
carets_to_remove.sort();
for (int i = carets_to_remove.size() - 1; i >= 0; i--) {
remove_caret(carets_to_remove[i]);
}
end_complex_operation();
String clipboard_string = clipboard.as_string();
DisplayServer::get_singleton()->clipboard_set(clipboard_string);
cut_copy_line = clipboard_string;
}
void TextEdit::_copy_internal(int p_caret) {
ERR_FAIL_COND(p_caret > carets.size());
if (has_selection(p_caret)) {
DisplayServer::get_singleton()->clipboard_set(get_selected_text(p_caret));
cut_copy_line = "";
return;
}
StringBuilder clipboard;
Vector<int> caret_edit_order = get_caret_index_edit_order();
for (int i = caret_edit_order.size() - 1; i >= 0; i--) {
int caret_idx = caret_edit_order[i];
if (p_caret != -1 && p_caret != caret_idx) {
continue;
}
int cl = get_caret_line(caret_idx);
if (text[cl].length() != 0) {
clipboard += _base_get_text(cl, 0, cl, text[cl].length());
if (p_caret == -1 && i != 0) {
clipboard += "\n";
}
}
}
String clipboard_string = clipboard.as_string();
DisplayServer::get_singleton()->clipboard_set(clipboard_string);
cut_copy_line = clipboard_string;
}
void TextEdit::_paste_internal(int p_caret) {
ERR_FAIL_COND(p_caret > carets.size());
if (!editable) {
return;
}
String clipboard = DisplayServer::get_singleton()->clipboard_get();
Vector<String> clipboad_lines = clipboard.split("\n");
bool insert_line_per_caret = p_caret == -1 && carets.size() > 1 && clipboad_lines.size() == carets.size();
begin_complex_operation();
Vector<int> caret_edit_order = get_caret_index_edit_order();
int clipboad_line = clipboad_lines.size() - 1;
for (const int &i : caret_edit_order) {
if (p_caret != -1 && p_caret != i) {
continue;
}
if (has_selection(i)) {
delete_selection(i);
} else if (!cut_copy_line.is_empty() && cut_copy_line == clipboard) {
set_caret_column(0, i == 0, i);
String ins = "\n";
clipboard += ins;
}
if (insert_line_per_caret) {
clipboard = clipboad_lines[clipboad_line];
}
insert_text_at_caret(clipboard, i);
clipboad_line--;
}
end_complex_operation();
}
void TextEdit::_paste_primary_clipboard_internal(int p_caret) {
ERR_FAIL_COND(p_caret > carets.size());
if (!is_editable() || !DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_CLIPBOARD_PRIMARY)) {
return;
}
String paste_buffer = DisplayServer::get_singleton()->clipboard_get_primary();
if (carets.size() == 1) {
Point2i pos = get_line_column_at_pos(get_local_mouse_pos());
deselect();
set_caret_line(pos.y, true, false);
set_caret_column(pos.x);
}
if (!paste_buffer.is_empty()) {
insert_text_at_caret(paste_buffer);
}
grab_focus();
}
/* Text. */
// Context menu.
void TextEdit::_generate_context_menu() {
if (!menu) {
menu = memnew(PopupMenu);
add_child(menu, false, INTERNAL_MODE_FRONT);
menu_dir = memnew(PopupMenu);
menu_dir->set_name("DirMenu");
menu_dir->add_radio_check_item(RTR("Same as Layout Direction"), MENU_DIR_INHERITED);
menu_dir->add_radio_check_item(RTR("Auto-Detect Direction"), MENU_DIR_AUTO);
menu_dir->add_radio_check_item(RTR("Left-to-Right"), MENU_DIR_LTR);
menu_dir->add_radio_check_item(RTR("Right-to-Left"), MENU_DIR_RTL);
menu->add_child(menu_dir, false, INTERNAL_MODE_FRONT);
menu_ctl = memnew(PopupMenu);
menu_ctl->set_name("CTLMenu");
menu_ctl->add_item(RTR("Left-to-Right Mark (LRM)"), MENU_INSERT_LRM);
menu_ctl->add_item(RTR("Right-to-Left Mark (RLM)"), MENU_INSERT_RLM);
menu_ctl->add_item(RTR("Start of Left-to-Right Embedding (LRE)"), MENU_INSERT_LRE);
menu_ctl->add_item(RTR("Start of Right-to-Left Embedding (RLE)"), MENU_INSERT_RLE);
menu_ctl->add_item(RTR("Start of Left-to-Right Override (LRO)"), MENU_INSERT_LRO);
menu_ctl->add_item(RTR("Start of Right-to-Left Override (RLO)"), MENU_INSERT_RLO);
menu_ctl->add_item(RTR("Pop Direction Formatting (PDF)"), MENU_INSERT_PDF);
menu_ctl->add_separator();
menu_ctl->add_item(RTR("Arabic Letter Mark (ALM)"), MENU_INSERT_ALM);
menu_ctl->add_item(RTR("Left-to-Right Isolate (LRI)"), MENU_INSERT_LRI);
menu_ctl->add_item(RTR("Right-to-Left Isolate (RLI)"), MENU_INSERT_RLI);
menu_ctl->add_item(RTR("First Strong Isolate (FSI)"), MENU_INSERT_FSI);
menu_ctl->add_item(RTR("Pop Direction Isolate (PDI)"), MENU_INSERT_PDI);
menu_ctl->add_separator();
menu_ctl->add_item(RTR("Zero-Width Joiner (ZWJ)"), MENU_INSERT_ZWJ);
menu_ctl->add_item(RTR("Zero-Width Non-Joiner (ZWNJ)"), MENU_INSERT_ZWNJ);
menu_ctl->add_item(RTR("Word Joiner (WJ)"), MENU_INSERT_WJ);
menu_ctl->add_item(RTR("Soft Hyphen (SHY)"), MENU_INSERT_SHY);
menu->add_child(menu_ctl, false, INTERNAL_MODE_FRONT);
menu->connect("id_pressed", callable_mp(this, &TextEdit::menu_option));
menu_dir->connect("id_pressed", callable_mp(this, &TextEdit::menu_option));
menu_ctl->connect("id_pressed", callable_mp(this, &TextEdit::menu_option));
}
// Reorganize context menu.
menu->clear();
if (editable) {
menu->add_item(RTR("Cut"), MENU_CUT, is_shortcut_keys_enabled() ? _get_menu_action_accelerator("ui_cut") : Key::NONE);
}
menu->add_item(RTR("Copy"), MENU_COPY, is_shortcut_keys_enabled() ? _get_menu_action_accelerator("ui_copy") : Key::NONE);
if (editable) {
menu->add_item(RTR("Paste"), MENU_PASTE, is_shortcut_keys_enabled() ? _get_menu_action_accelerator("ui_paste") : Key::NONE);
}
if (selecting_enabled || editable) {
menu->add_separator();
}
if (selecting_enabled) {
menu->add_item(RTR("Select All"), MENU_SELECT_ALL, is_shortcut_keys_enabled() ? _get_menu_action_accelerator("ui_text_select_all") : Key::NONE);
}
if (editable) {
menu->add_item(RTR("Clear"), MENU_CLEAR);
menu->add_separator();
menu->add_item(RTR("Undo"), MENU_UNDO, is_shortcut_keys_enabled() ? _get_menu_action_accelerator("ui_undo") : Key::NONE);
menu->add_item(RTR("Redo"), MENU_REDO, is_shortcut_keys_enabled() ? _get_menu_action_accelerator("ui_redo") : Key::NONE);
}
menu->add_separator();
menu->add_submenu_item(RTR("Text Writing Direction"), "DirMenu");
menu->add_separator();
menu->add_check_item(RTR("Display Control Characters"), MENU_DISPLAY_UCC);
menu->set_item_checked(menu->get_item_index(MENU_DISPLAY_UCC), draw_control_chars);
if (editable) {
menu->add_submenu_item(RTR("Insert Control Character"), "CTLMenu");
}
menu_dir->set_item_checked(menu_dir->get_item_index(MENU_DIR_INHERITED), text_direction == TEXT_DIRECTION_INHERITED);
menu_dir->set_item_checked(menu_dir->get_item_index(MENU_DIR_AUTO), text_direction == TEXT_DIRECTION_AUTO);
menu_dir->set_item_checked(menu_dir->get_item_index(MENU_DIR_LTR), text_direction == TEXT_DIRECTION_LTR);
menu_dir->set_item_checked(menu_dir->get_item_index(MENU_DIR_RTL), text_direction == TEXT_DIRECTION_RTL);
if (editable) {
menu->set_item_disabled(menu->get_item_index(MENU_UNDO), !has_undo());
menu->set_item_disabled(menu->get_item_index(MENU_REDO), !has_redo());
}
}
Key TextEdit::_get_menu_action_accelerator(const String &p_action) {
const List<Ref<InputEvent>> *events = InputMap::get_singleton()->action_get_events(p_action);
if (!events) {
return Key::NONE;
}
// Use first event in the list for the accelerator.
const List<Ref<InputEvent>>::Element *first_event = events->front();
if (!first_event) {
return Key::NONE;
}
const Ref<InputEventKey> event = first_event->get();
if (event.is_null()) {
return Key::NONE;
}
// Use physical keycode if non-zero
if (event->get_physical_keycode() != Key::NONE) {
return event->get_physical_keycode_with_modifiers();
} else {
return event->get_keycode_with_modifiers();
}
}
/* Versioning */
void TextEdit::_push_current_op() {
if (pending_action_end) {
start_action(EditAction::ACTION_NONE);
return;
}
if (current_op.type == TextOperation::TYPE_NONE) {
return; // Nothing to do.
}
if (next_operation_is_complex) {
current_op.chain_forward = true;
next_operation_is_complex = false;
}
undo_stack.push_back(current_op);
current_op.type = TextOperation::TYPE_NONE;
current_op.text = "";
current_op.chain_forward = false;
if (undo_stack.size() > undo_stack_max_size) {
undo_stack.pop_front();
}
}
void TextEdit::_do_text_op(const TextOperation &p_op, bool p_reverse) {
ERR_FAIL_COND(p_op.type == TextOperation::TYPE_NONE);
bool insert = p_op.type == TextOperation::TYPE_INSERT;
if (p_reverse) {
insert = !insert;
}
if (insert) {
int check_line;
int check_column;
_base_insert_text(p_op.from_line, p_op.from_column, p_op.text, check_line, check_column);
ERR_FAIL_COND(check_line != p_op.to_line); // BUG.
ERR_FAIL_COND(check_column != p_op.to_column); // BUG.
} else {
_base_remove_text(p_op.from_line, p_op.from_column, p_op.to_line, p_op.to_column);
}
}
void TextEdit::_clear_redo() {
if (undo_stack_pos == nullptr) {
return; // Nothing to clear.
}
_push_current_op();
while (undo_stack_pos) {
List<TextOperation>::Element *elem = undo_stack_pos;
undo_stack_pos = undo_stack_pos->next();
undo_stack.erase(elem);
}
}
/* Search */
int TextEdit::_get_column_pos_of_word(const String &p_key, const String &p_search, uint32_t p_search_flags, int p_from_column) const {
int col = -1;
if (p_key.length() > 0 && p_search.length() > 0) {
if (p_from_column < 0 || p_from_column > p_search.length()) {
p_from_column = 0;
}
while (col == -1 && p_from_column <= p_search.length()) {
if (p_search_flags & SEARCH_MATCH_CASE) {
col = p_search.find(p_key, p_from_column);
} else {
col = p_search.findn(p_key, p_from_column);
}
// Whole words only.
if (col != -1 && p_search_flags & SEARCH_WHOLE_WORDS) {
p_from_column = col;
if (col > 0 && !is_symbol(p_search[col - 1])) {
col = -1;
} else if ((col + p_key.length()) < p_search.length() && !is_symbol(p_search[col + p_key.length()])) {
col = -1;
}
}
p_from_column += 1;
}
}
return col;
}
/* Mouse */
int TextEdit::_get_char_pos_for_line(int p_px, int p_line, int p_wrap_index) const {
ERR_FAIL_INDEX_V(p_line, text.size(), 0);
p_wrap_index = MIN(p_wrap_index, text.get_line_data(p_line)->get_line_count() - 1);
RID text_rid = text.get_line_data(p_line)->get_line_rid(p_wrap_index);
if (is_layout_rtl()) {
p_px = TS->shaped_text_get_size(text_rid).x - p_px;
}
return TS->shaped_text_hit_test_position(text_rid, p_px);
}
/* Caret */
void TextEdit::_emit_caret_changed() {
emit_signal(SNAME("caret_changed"));
caret_pos_dirty = false;
caret_index_edit_dirty = true;
}
void TextEdit::_reset_caret_blink_timer() {
if (!caret_blink_enabled) {
return;
}
draw_caret = true;
if (has_focus()) {
caret_blink_timer->stop();
caret_blink_timer->start();
queue_redraw();
}
}
void TextEdit::_toggle_draw_caret() {
draw_caret = !draw_caret;
if (is_visible_in_tree() && has_focus() && window_has_focus) {
queue_redraw();
}
}
int TextEdit::_get_column_x_offset_for_line(int p_char, int p_line, int p_column) const {
ERR_FAIL_INDEX_V(p_line, text.size(), 0);
int row = 0;
Vector<Vector2i> rows2 = text.get_line_wrap_ranges(p_line);
for (int i = 0; i < rows2.size(); i++) {
if ((p_char >= rows2[i].x) && (p_char <= rows2[i].y)) {
row = i;
break;
}
}
RID text_rid = text.get_line_data(p_line)->get_line_rid(row);
CaretInfo ts_caret = TS->shaped_text_get_carets(text_rid, p_column);
if ((ts_caret.l_caret != Rect2() && (ts_caret.l_dir == TextServer::DIRECTION_AUTO || ts_caret.l_dir == (TextServer::Direction)input_direction)) || (ts_caret.t_caret == Rect2())) {
return ts_caret.l_caret.position.x;
} else {
return ts_caret.t_caret.position.x;
}
}
/* Selection */
void TextEdit::_click_selection_held() {
// Warning: is_mouse_button_pressed(MouseButton::LEFT) returns false for double+ clicks, so this doesn't work for MODE_WORD
// and MODE_LINE. However, moving the mouse triggers _gui_input, which calls these functions too, so that's not a huge problem.
// I'm unsure if there's an actual fix that doesn't have a ton of side effects.
if (Input::get_singleton()->is_mouse_button_pressed(MouseButton::LEFT) && get_selection_mode() != SelectionMode::SELECTION_MODE_NONE) {
switch (get_selection_mode()) {
case SelectionMode::SELECTION_MODE_POINTER: {
_update_selection_mode_pointer();
} break;
case SelectionMode::SELECTION_MODE_WORD: {
_update_selection_mode_word();
} break;
case SelectionMode::SELECTION_MODE_LINE: {
_update_selection_mode_line();
} break;
default: {
break;
}
}
} else {
click_select_held->stop();
}
}
void TextEdit::_update_selection_mode_pointer() {
dragging_selection = true;
Point2 mp = get_local_mouse_pos();
Point2i pos = get_line_column_at_pos(mp);
int line = pos.y;
int col = pos.x;
int caret_idx = carets.size() - 1;
select(carets[caret_idx].selection.selecting_line, carets[caret_idx].selection.selecting_column, line, col, caret_idx);
set_caret_line(line, false, true, 0, caret_idx);
set_caret_column(col, true, caret_idx);
queue_redraw();
click_select_held->start();
merge_overlapping_carets();
}
void TextEdit::_update_selection_mode_word() {
dragging_selection = true;
Point2 mp = get_local_mouse_pos();
Point2i pos = get_line_column_at_pos(mp);
int line = pos.y;
int col = pos.x;
int caret_idx = carets.size() - 1;
int caret_pos = CLAMP(col, 0, text[line].length());
int beg = caret_pos;
int end = beg;
PackedInt32Array words = TS->shaped_text_get_word_breaks(text.get_line_data(line)->get_rid());
for (int i = 0; i < words.size(); i = i + 2) {
if ((words[i] < caret_pos && words[i + 1] > caret_pos) || (i == words.size() - 2 && caret_pos == words[i + 1])) {
beg = words[i];
end = words[i + 1];
break;
}
}
/* Initial selection. */
if (!has_selection(caret_idx)) {
select(line, beg, line, end, caret_idx);
carets.write[caret_idx].selection.selecting_column = beg;
carets.write[caret_idx].selection.selected_word_beg = beg;
carets.write[caret_idx].selection.selected_word_end = end;
carets.write[caret_idx].selection.selected_word_origin = beg;
set_caret_line(line, false, true, 0, caret_idx);
set_caret_column(end, true, caret_idx);
} else {
if ((col <= carets[caret_idx].selection.selected_word_origin && line == get_selection_line(caret_idx)) || line < get_selection_line(caret_idx)) {
carets.write[caret_idx].selection.selecting_column = carets[caret_idx].selection.selected_word_end;
select(line, beg, get_selection_line(caret_idx), carets[caret_idx].selection.selected_word_end, caret_idx);
set_caret_line(line, false, true, 0, caret_idx);
set_caret_column(beg, true, caret_idx);
} else {
carets.write[caret_idx].selection.selecting_column = carets[caret_idx].selection.selected_word_beg;
select(get_selection_line(caret_idx), carets[caret_idx].selection.selected_word_beg, line, end, caret_idx);
set_caret_line(get_selection_to_line(caret_idx), false, true, 0, caret_idx);
set_caret_column(get_selection_to_column(caret_idx), true, caret_idx);
}
}
if (DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_CLIPBOARD_PRIMARY)) {
DisplayServer::get_singleton()->clipboard_set_primary(get_selected_text());
}
queue_redraw();
click_select_held->start();
merge_overlapping_carets();
}
void TextEdit::_update_selection_mode_line() {
dragging_selection = true;
Point2 mp = get_local_mouse_pos();
Point2i pos = get_line_column_at_pos(mp);
int line = pos.y;
int col = pos.x;
int caret_idx = carets.size() - 1;
col = 0;
if (line < carets[caret_idx].selection.selecting_line) {
/* Caret is above us. */
set_caret_line(line - 1, false, true, 0, caret_idx);
carets.write[caret_idx].selection.selecting_column = text[get_selection_line(caret_idx)].length();
} else {
/* Caret is below us. */
set_caret_line(line + 1, false, true, 0, caret_idx);
carets.write[caret_idx].selection.selecting_column = 0;
col = text[line].length();
}
set_caret_column(0, false, caret_idx);
select(carets[caret_idx].selection.selecting_line, carets[caret_idx].selection.selecting_column, line, col, caret_idx);
if (DisplayServer::get_singleton()->has_feature(DisplayServer::FEATURE_CLIPBOARD_PRIMARY)) {
DisplayServer::get_singleton()->clipboard_set_primary(get_selected_text());
}
queue_redraw();
click_select_held->start();
merge_overlapping_carets();
}
void TextEdit::_pre_shift_selection(int p_caret) {
if (!selecting_enabled) {
return;
}
if (!has_selection(p_caret) || get_selection_mode() == SelectionMode::SELECTION_MODE_NONE) {
carets.write[p_caret].selection.active = true;
set_selection_mode(SelectionMode::SELECTION_MODE_SHIFT, get_caret_line(p_caret), get_caret_column(p_caret), p_caret);
return;
}
set_selection_mode(SelectionMode::SELECTION_MODE_SHIFT, get_selection_line(p_caret), get_selection_column(p_caret), p_caret);
}
void TextEdit::_post_shift_selection(int p_caret) {
if (!selecting_enabled) {
return;
}
if (has_selection(p_caret) && get_selection_mode() == SelectionMode::SELECTION_MODE_SHIFT) {
select(get_selection_line(p_caret), get_selection_column(p_caret), get_caret_line(p_caret), get_caret_column(p_caret), p_caret);
}
}
/* Line Wrapping */
void TextEdit::_update_wrap_at_column(bool p_force) {
int new_wrap_at = get_size().width - style_normal->get_minimum_size().width - gutters_width - gutter_padding;
if (draw_minimap) {
new_wrap_at -= minimap_width;
}
if (v_scroll->is_visible_in_tree()) {
new_wrap_at -= v_scroll->get_combined_minimum_size().width;
}
/* Give it a little more space. */
new_wrap_at -= wrap_right_offset;
if ((wrap_at_column != new_wrap_at) || p_force) {
wrap_at_column = new_wrap_at;
if (line_wrapping_mode) {
text.set_width(wrap_at_column);
} else {
text.set_width(-1);
}
text.invalidate_all_lines();
_update_placeholder();
}
// Update viewport.
int first_vis_line = get_first_visible_line();
if (is_line_wrapped(first_vis_line)) {
first_visible_line_wrap_ofs = MIN(first_visible_line_wrap_ofs, get_line_wrap_count(first_vis_line));
} else {
first_visible_line_wrap_ofs = 0;
}
set_line_as_first_visible(first_visible_line, first_visible_line_wrap_ofs);
}
/* Viewport. */
void TextEdit::_update_scrollbars() {
Size2 size = get_size();
Size2 hmin = h_scroll->get_combined_minimum_size();
Size2 vmin = v_scroll->get_combined_minimum_size();
v_scroll->set_begin(Point2(size.width - vmin.width, style_normal->get_margin(SIDE_TOP)));
v_scroll->set_end(Point2(size.width, size.height - style_normal->get_margin(SIDE_TOP) - style_normal->get_margin(SIDE_BOTTOM)));
h_scroll->set_begin(Point2(0, size.height - hmin.height));
h_scroll->set_end(Point2(size.width - vmin.width, size.height));
bool draw_placeholder = text.size() == 1 && text[0].length() == 0;
int visible_rows = get_visible_line_count();
int total_rows = draw_placeholder ? placeholder_wraped_rows.size() - 1 : get_total_visible_line_count();
if (scroll_past_end_of_file_enabled) {
total_rows += visible_rows - 1;
}
int visible_width = size.width - style_normal->get_minimum_size().width;
int total_width = (draw_placeholder ? placeholder_max_width : text.get_max_width()) + vmin.x + gutters_width + gutter_padding;
if (draw_minimap) {
total_width += minimap_width;
}
content_height_cache = MAX(total_rows, 1) * get_line_height();
if (fit_content_height) {
update_minimum_size();
}
updating_scrolls = true;
if (total_rows > visible_rows) {
v_scroll->show();
v_scroll->set_max(total_rows + _get_visible_lines_offset());
v_scroll->set_page(visible_rows + _get_visible_lines_offset());
if (smooth_scroll_enabled) {
v_scroll->set_step(0.25);
} else {
v_scroll->set_step(1);
}
set_v_scroll(get_v_scroll());
} else {
first_visible_line = 0;
first_visible_line_wrap_ofs = 0;
v_scroll->set_value(0);
v_scroll->set_max(0);
v_scroll->hide();
}
if (total_width > visible_width && get_line_wrapping_mode() == LineWrappingMode::LINE_WRAPPING_NONE) {
h_scroll->show();
h_scroll->set_max(total_width);
h_scroll->set_page(visible_width);
if (first_visible_col > (total_width - visible_width)) {
first_visible_col = (total_width - visible_width);
}
if (fabs(h_scroll->get_value() - (double)first_visible_col) >= 1) {
h_scroll->set_value(first_visible_col);
}
} else {
first_visible_col = 0;
h_scroll->set_value(0);
h_scroll->set_max(0);
h_scroll->hide();
}
updating_scrolls = false;
}
int TextEdit::_get_control_height() const {
int control_height = get_size().height;
control_height -= style_normal->get_minimum_size().height;
if (h_scroll->is_visible_in_tree()) {
control_height -= h_scroll->get_size().height;
}
return control_height;
}
void TextEdit::_v_scroll_input() {
scrolling = false;
minimap_clicked = false;
}
void TextEdit::_scroll_moved(double p_to_val) {
if (updating_scrolls) {
return;
}
if (h_scroll->is_visible_in_tree()) {
first_visible_col = h_scroll->get_value();
}
if (v_scroll->is_visible_in_tree()) {
// Set line ofs and wrap ofs.
bool draw_placeholder = text.size() == 1 && text[0].length() == 0;
int v_scroll_i = floor(get_v_scroll());
int sc = 0;
int n_line;
for (n_line = 0; n_line < text.size(); n_line++) {
if (!_is_line_hidden(n_line)) {
sc++;
sc += draw_placeholder ? placeholder_wraped_rows.size() - 1 : get_line_wrap_count(n_line);
if (sc > v_scroll_i) {
break;
}
}
}
n_line = MIN(n_line, text.size() - 1);
int line_wrap_amount = draw_placeholder ? placeholder_wraped_rows.size() - 1 : get_line_wrap_count(n_line);
int wi = line_wrap_amount - (sc - v_scroll_i - 1);
wi = CLAMP(wi, 0, line_wrap_amount);
first_visible_line = n_line;
first_visible_line_wrap_ofs = wi;
}
queue_redraw();
}
double TextEdit::_get_visible_lines_offset() const {
double total = _get_control_height();
total /= (double)get_line_height();
total = total - floor(total);
total = -CLAMP(total, 0.001, 1) + 1;
return total;
}
double TextEdit::_get_v_scroll_offset() const {
double val = get_v_scroll() - floor(get_v_scroll());
return CLAMP(val, 0, 1);
}
void TextEdit::_scroll_up(real_t p_delta) {
if (scrolling && smooth_scroll_enabled && SIGN(target_v_scroll - v_scroll->get_value()) != SIGN(-p_delta)) {
scrolling = false;
minimap_clicked = false;
}
if (scrolling) {
target_v_scroll = (target_v_scroll - p_delta);
} else {
target_v_scroll = (get_v_scroll() - p_delta);
}
if (smooth_scroll_enabled) {
if (target_v_scroll <= 0) {
target_v_scroll = 0;
}
if (Math::abs(target_v_scroll - v_scroll->get_value()) < 1.0) {
v_scroll->set_value(target_v_scroll);
} else {
scrolling = true;
set_physics_process_internal(true);
}
} else {
set_v_scroll(target_v_scroll);
}
}
void TextEdit::_scroll_down(real_t p_delta) {
if (scrolling && smooth_scroll_enabled && SIGN(target_v_scroll - v_scroll->get_value()) != SIGN(p_delta)) {
scrolling = false;
minimap_clicked = false;
}
if (scrolling) {
target_v_scroll = (target_v_scroll + p_delta);
} else {
target_v_scroll = (get_v_scroll() + p_delta);
}
if (smooth_scroll_enabled) {
int max_v_scroll = round(v_scroll->get_max() - v_scroll->get_page());
if (target_v_scroll > max_v_scroll) {
target_v_scroll = max_v_scroll;
}
if (Math::abs(target_v_scroll - v_scroll->get_value()) < 1.0) {
v_scroll->set_value(target_v_scroll);
} else {
scrolling = true;
set_physics_process_internal(true);
}
} else {
set_v_scroll(target_v_scroll);
}
}
void TextEdit::_scroll_lines_up() {
scrolling = false;
minimap_clicked = false;
// Adjust the vertical scroll.
set_v_scroll(get_v_scroll() - 1);
// Adjust the caret to viewport.
for (int i = 0; i < carets.size(); i++) {
if (has_selection(i)) {
continue;
}
int last_vis_line = get_last_full_visible_line();
int last_vis_wrap = get_last_full_visible_line_wrap_index();
if (get_caret_line(i) > last_vis_line || (get_caret_line(i) == last_vis_line && get_caret_wrap_index(i) > last_vis_wrap)) {
set_caret_line(last_vis_line, false, false, last_vis_wrap, i);
}
}
merge_overlapping_carets();
}
void TextEdit::_scroll_lines_down() {
scrolling = false;
minimap_clicked = false;
// Adjust the vertical scroll.
set_v_scroll(get_v_scroll() + 1);
// Adjust the caret to viewport.
for (int i = 0; i < carets.size(); i++) {
if (has_selection(i)) {
continue;
}
int first_vis_line = get_first_visible_line();
if (get_caret_line(i) < first_vis_line || (get_caret_line(i) == first_vis_line && get_caret_wrap_index(i) < first_visible_line_wrap_ofs)) {
set_caret_line(first_vis_line, false, false, first_visible_line_wrap_ofs, i);
}
}
merge_overlapping_carets();
}
// Minimap
void TextEdit::_update_minimap_hover() {
const Point2 mp = get_local_mouse_pos();
const int xmargin_end = get_size().width - style_normal->get_margin(SIDE_RIGHT);
const bool hovering_sidebar = mp.x > xmargin_end - minimap_width && mp.x < xmargin_end;
if (!hovering_sidebar) {
if (hovering_minimap) {
// Only redraw if the hovering status changed.
hovering_minimap = false;
queue_redraw();
}
// Return early to avoid running the operations below when not needed.
return;
}
const int row = get_minimap_line_at_pos(mp);
const bool new_hovering_minimap = row >= get_first_visible_line() && row <= get_last_full_visible_line();
if (new_hovering_minimap != hovering_minimap) {
// Only redraw if the hovering status changed.
hovering_minimap = new_hovering_minimap;
queue_redraw();
}
}
void TextEdit::_update_minimap_click() {
Point2 mp = get_local_mouse_pos();
int xmargin_end = get_size().width - style_normal->get_margin(SIDE_RIGHT);
if (!dragging_minimap && (mp.x < xmargin_end - minimap_width || mp.y > xmargin_end)) {
minimap_clicked = false;
return;
}
minimap_clicked = true;
dragging_minimap = true;
int row = get_minimap_line_at_pos(mp);
if (row >= get_first_visible_line() && (row < get_last_full_visible_line() || row >= (text.size() - 1))) {
minimap_scroll_ratio = v_scroll->get_as_ratio();
minimap_scroll_click_pos = mp.y;
can_drag_minimap = true;
return;
}
Point2i next_line = get_next_visible_line_index_offset_from(row, 0, -get_visible_line_count() / 2);
int first_line = row - next_line.x + 1;
double delta = get_scroll_pos_for_line(first_line, next_line.y) - get_v_scroll();
if (delta < 0) {
_scroll_up(-delta);
} else {
_scroll_down(delta);
}
}
void TextEdit::_update_minimap_drag() {
if (!can_drag_minimap) {
return;
}
int control_height = _get_control_height();
int scroll_height = v_scroll->get_max() * (minimap_char_size.y + minimap_line_spacing);
if (control_height > scroll_height) {
control_height = scroll_height;
}
Point2 mp = get_local_mouse_pos();
double diff = (mp.y - minimap_scroll_click_pos) / control_height;
v_scroll->set_as_ratio(minimap_scroll_ratio + diff);
}
/* Gutters. */
void TextEdit::_update_gutter_width() {
gutters_width = 0;
for (int i = 0; i < gutters.size(); i++) {
if (gutters[i].draw) {
gutters_width += gutters[i].width;
}
}
if (gutters_width > 0) {
gutter_padding = 2;
}
queue_redraw();
}
/* Syntax highlighting. */
Dictionary TextEdit::_get_line_syntax_highlighting(int p_line) {
return syntax_highlighter.is_null() && !setting_text ? Dictionary() : syntax_highlighter->get_line_syntax_highlighting(p_line);
}
/*** Super internal Core API. Everything builds on it. ***/
void TextEdit::_text_changed_emit() {
emit_signal(SNAME("text_changed"));
text_changed_dirty = false;
}
void TextEdit::_insert_text(int p_line, int p_char, const String &p_text, int *r_end_line, int *r_end_char) {
if (!setting_text && idle_detect->is_inside_tree()) {
idle_detect->start();
}
if (undo_enabled) {
_clear_redo();
}
int retline, retchar;
_base_insert_text(p_line, p_char, p_text, retline, retchar);
if (r_end_line) {
*r_end_line = retline;
}
if (r_end_char) {
*r_end_char = retchar;
}
if (!undo_enabled) {
return;
}
/* UNDO!! */
TextOperation op;
op.type = TextOperation::TYPE_INSERT;
op.from_line = p_line;
op.from_column = p_char;
op.to_line = retline;
op.to_column = retchar;
op.text = p_text;
op.version = ++version;
op.chain_forward = false;
op.chain_backward = false;
op.start_carets = carets;
op.end_carets = carets;
// See if it should just be set as current op.
if (current_op.type != op.type) {
op.prev_version = get_version();
_push_current_op();
current_op = op;
return; // Set as current op, return.
}
// See if it can be merged.
if (current_op.to_line != p_line || current_op.to_column != p_char) {
op.prev_version = get_version();
_push_current_op();
current_op = op;
return; // Set as current op, return.
}
// Merge current op.
current_op.text += p_text;
current_op.to_column = retchar;
current_op.to_line = retline;
current_op.version = op.version;
current_op.end_carets = carets;
}
void TextEdit::_remove_text(int p_from_line, int p_from_column, int p_to_line, int p_to_column) {
if (!setting_text && idle_detect->is_inside_tree()) {
idle_detect->start();
}
String txt;
if (undo_enabled) {
_clear_redo();
txt = _base_get_text(p_from_line, p_from_column, p_to_line, p_to_column);
}
_base_remove_text(p_from_line, p_from_column, p_to_line, p_to_column);
if (!undo_enabled) {
return;
}
/* UNDO! */
TextOperation op;
op.type = TextOperation::TYPE_REMOVE;
op.from_line = p_from_line;
op.from_column = p_from_column;
op.to_line = p_to_line;
op.to_column = p_to_column;
op.text = txt;
op.version = ++version;
op.chain_forward = false;
op.chain_backward = false;
op.start_carets = carets;
op.end_carets = carets;
// See if it should just be set as current op.
if (current_op.type != op.type) {
op.prev_version = get_version();
_push_current_op();
current_op = op;
return; // Set as current op, return.
}
// See if it can be merged.
if (current_op.from_line == p_to_line && current_op.from_column == p_to_column) {
// Backspace or similar.
current_op.text = txt + current_op.text;
current_op.from_line = p_from_line;
current_op.from_column = p_from_column;
current_op.end_carets = carets;
return; // Update current op.
}
op.prev_version = get_version();
_push_current_op();
current_op = op;
}
void TextEdit::_base_insert_text(int p_line, int p_char, const String &p_text, int &r_end_line, int &r_end_column) {
// Save for undo.
ERR_FAIL_INDEX(p_line, text.size());
ERR_FAIL_COND(p_char < 0);
/* STEP 1: Remove \r from source text and separate in substrings. */
const String text_to_insert = p_text.replace("\r", "");
Vector<String> substrings = text_to_insert.split("\n");
// Is this just a new empty line?
bool shift_first_line = p_char == 0 && substrings.size() == 2 && text_to_insert == "\n";
/* STEP 2: Add spaces if the char is greater than the end of the line. */
while (p_char > text[p_line].length()) {
text.set(p_line, text[p_line] + String::chr(' '), structured_text_parser(st_parser, st_args, text[p_line] + String::chr(' ')));
}
/* STEP 3: Separate dest string in pre and post text. */
String postinsert_text = text[p_line].substr(p_char, text[p_line].size());
substrings.write[0] = text[p_line].substr(0, p_char) + substrings[0];
substrings.write[substrings.size() - 1] += postinsert_text;
Vector<Array> bidi_override;
bidi_override.resize(substrings.size());
for (int i = 0; i < substrings.size(); i++) {
bidi_override.write[i] = structured_text_parser(st_parser, st_args, substrings[i]);
}
text.insert(p_line, substrings, bidi_override);
if (shift_first_line) {
text.move_gutters(p_line, p_line + 1);
text.set_hidden(p_line + 1, text.is_hidden(p_line));
text.set_hidden(p_line, false);
}
r_end_line = p_line + substrings.size() - 1;
r_end_column = text[r_end_line].length() - postinsert_text.length();
TextServer::Direction dir = TS->shaped_text_get_dominant_direction_in_range(text.get_line_data(r_end_line)->get_rid(), (r_end_line == p_line) ? carets[0].column : 0, r_end_column);
if (dir != TextServer::DIRECTION_AUTO) {
input_direction = (TextDirection)dir;
}
if (!text_changed_dirty && !setting_text) {
if (is_inside_tree()) {
MessageQueue::get_singleton()->push_call(this, "_text_changed_emit");
}
text_changed_dirty = true;
}
emit_signal(SNAME("lines_edited_from"), p_line, r_end_line);
}
String TextEdit::_base_get_text(int p_from_line, int p_from_column, int p_to_line, int p_to_column) const {
ERR_FAIL_INDEX_V(p_from_line, text.size(), String());
ERR_FAIL_INDEX_V(p_from_column, text[p_from_line].length() + 1, String());
ERR_FAIL_INDEX_V(p_to_line, text.size(), String());
ERR_FAIL_INDEX_V(p_to_column, text[p_to_line].length() + 1, String());
ERR_FAIL_COND_V(p_to_line < p_from_line, String()); // 'from > to'.
ERR_FAIL_COND_V(p_to_line == p_from_line && p_to_column < p_from_column, String()); // 'from > to'.
StringBuilder ret;
for (int i = p_from_line; i <= p_to_line; i++) {
int begin = (i == p_from_line) ? p_from_column : 0;
int end = (i == p_to_line) ? p_to_column : text[i].length();
if (i > p_from_line) {
ret += "\n";
}
ret += text[i].substr(begin, end - begin);
}
return ret.as_string();
}
void TextEdit::_base_remove_text(int p_from_line, int p_from_column, int p_to_line, int p_to_column) {
ERR_FAIL_INDEX(p_from_line, text.size());
ERR_FAIL_INDEX(p_from_column, text[p_from_line].length() + 1);
ERR_FAIL_INDEX(p_to_line, text.size());
ERR_FAIL_INDEX(p_to_column, text[p_to_line].length() + 1);
ERR_FAIL_COND(p_to_line < p_from_line); // 'from > to'.
ERR_FAIL_COND(p_to_line == p_from_line && p_to_column < p_from_column); // 'from > to'.
String pre_text = text[p_from_line].substr(0, p_from_column);
String post_text = text[p_to_line].substr(p_to_column, text[p_to_line].length());
text.remove_range(p_from_line, p_to_line);
text.set(p_from_line, pre_text + post_text, structured_text_parser(st_parser, st_args, pre_text + post_text));
if (!text_changed_dirty && !setting_text) {
if (is_inside_tree()) {
MessageQueue::get_singleton()->push_call(this, "_text_changed_emit");
}
text_changed_dirty = true;
}
emit_signal(SNAME("lines_edited_from"), p_to_line, p_from_line);
}
TextEdit::TextEdit(const String &p_placeholder) {
placeholder_data_buf.instantiate();
carets.push_back(Caret());
clear();
set_focus_mode(FOCUS_ALL);
_update_caches();
set_default_cursor_shape(CURSOR_IBEAM);
set_process_unhandled_key_input(true);
text.set_tab_size(text.get_tab_size());
h_scroll = memnew(HScrollBar);
v_scroll = memnew(VScrollBar);
add_child(h_scroll, false, INTERNAL_MODE_FRONT);
add_child(v_scroll, false, INTERNAL_MODE_FRONT);
h_scroll->connect("value_changed", callable_mp(this, &TextEdit::_scroll_moved));
v_scroll->connect("value_changed", callable_mp(this, &TextEdit::_scroll_moved));
v_scroll->connect("scrolling", callable_mp(this, &TextEdit::_v_scroll_input));
/* Caret. */
caret_blink_timer = memnew(Timer);
add_child(caret_blink_timer, false, INTERNAL_MODE_FRONT);
caret_blink_timer->set_wait_time(0.65);
caret_blink_timer->connect("timeout", callable_mp(this, &TextEdit::_toggle_draw_caret));
set_caret_blink_enabled(false);
/* Selection. */
click_select_held = memnew(Timer);
add_child(click_select_held, false, INTERNAL_MODE_FRONT);
click_select_held->set_wait_time(0.05);
click_select_held->connect("timeout", callable_mp(this, &TextEdit::_click_selection_held));
idle_detect = memnew(Timer);
add_child(idle_detect, false, INTERNAL_MODE_FRONT);
idle_detect->set_one_shot(true);
idle_detect->set_wait_time(GLOBAL_GET("gui/timers/text_edit_idle_detect_sec"));
idle_detect->connect("timeout", callable_mp(this, &TextEdit::_push_current_op));
undo_stack_max_size = GLOBAL_GET("gui/common/text_edit_undo_stack_max_size");
set_placeholder(p_placeholder);
set_editable(true);
}