Skip to content

Commit b668f45

Browse files
KoyperKoyper
committed
Fix LineEdit and TextEdit composite character backspace delete.
1 parent 9f03bbf commit b668f45

File tree

7 files changed

+139
-5
lines changed

7 files changed

+139
-5
lines changed

‎doc/classes/LineEdit.xml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,22 @@
133133
[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property.
134134
</description>
135135
</method>
136+
<method name="get_next_composite_character_column" qualifiers="const">
137+
<return type="int" />
138+
<param index="0" name="column" type="int" />
139+
<description>
140+
Returns the correct column at the end of a composite character like ❤️‍🩹 (mending heart; Unicode: [code]U+2764 U+FE0F U+200D U+1FA79[/code]) which is comprised of more than one Unicode code point, if the caret is at the start of the composite character. Also returns the correct column with the caret at mid grapheme and for non-composite characters.
141+
[b]Note:[/b] To check at caret location use [code]get_next_composite_character_column(get_caret_column())[/code]
142+
</description>
143+
</method>
144+
<method name="get_previous_composite_character_column" qualifiers="const">
145+
<return type="int" />
146+
<param index="0" name="column" type="int" />
147+
<description>
148+
Returns the correct column at the start of a composite character like ❤️‍🩹 (mending heart; Unicode: [code]U+2764 U+FE0F U+200D U+1FA79[/code]) which is comprised of more than one Unicode code point, if the caret is at the end of the composite character. Also returns the correct column with the caret at mid grapheme and for non-composite characters.
149+
[b]Note:[/b] To check at caret location use [code]get_previous_composite_character_column(get_caret_column())[/code]
150+
</description>
151+
</method>
136152
<method name="get_scroll_offset" qualifiers="const">
137153
<return type="float" />
138154
<description>
@@ -246,6 +262,9 @@
246262
<member name="alignment" type="int" setter="set_horizontal_alignment" getter="get_horizontal_alignment" enum="HorizontalAlignment" default="0">
247263
Text alignment as defined in the [enum HorizontalAlignment] enum.
248264
</member>
265+
<member name="backspace_deletes_composite_character_enabled" type="bool" setter="set_backspace_deletes_composite_character_enabled" getter="is_backspace_deletes_composite_character_enabled" default="false">
266+
If [code]true[/code] and [member caret_mid_grapheme] is [code]false[/code], backspace deletes an entire composite character such as ❤️‍🩹, instead of deleting part of the composite character.
267+
</member>
249268
<member name="caret_blink" type="bool" setter="set_caret_blink_enabled" getter="is_caret_blink_enabled" default="false">
250269
If [code]true[/code], makes the caret blink.
251270
</member>

‎doc/classes/TextEdit.xml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -517,6 +517,15 @@
517517
Returns the number of lines that may be drawn on the minimap.
518518
</description>
519519
</method>
520+
<method name="get_next_composite_character_column" qualifiers="const">
521+
<return type="int" />
522+
<param index="0" name="line" type="int" />
523+
<param index="1" name="column" type="int" />
524+
<description>
525+
Returns the correct column at the end of a composite character like ❤️‍🩹 (mending heart; Unicode: [code]U+2764 U+FE0F U+200D U+1FA79[/code]) which is comprised of more than one Unicode code point, if the caret is at the start of the composite character. Also returns the correct column with the caret at mid grapheme and for non-composite characters.
526+
[b]Note:[/b] To check at caret location use [code]get_next_composite_character_column(get_caret_line(), get_caret_column())[/code]
527+
</description>
528+
</method>
520529
<method name="get_next_visible_line_index_offset_from" qualifiers="const">
521530
<return type="Vector2i" />
522531
<param index="0" name="line" type="int" />
@@ -543,6 +552,15 @@
543552
[b]Note:[/b] The Y position corresponds to the bottom side of the line. Use [method get_rect_at_line_column] to get the top side position.
544553
</description>
545554
</method>
555+
<method name="get_previous_composite_character_column" qualifiers="const">
556+
<return type="int" />
557+
<param index="0" name="line" type="int" />
558+
<param index="1" name="column" type="int" />
559+
<description>
560+
Returns the correct column at the start of a composite character like ❤️‍🩹 (mending heart; Unicode: [code]U+2764 U+FE0F U+200D U+1FA79[/code]) which is comprised of more than one Unicode code point, if the caret is at the end of the composite character. Also returns the correct column with the caret at mid grapheme and for non-composite characters.
561+
[b]Note:[/b] To check at caret location use [code]get_previous_composite_character_column(get_caret_line(), get_caret_column())[/code]
562+
</description>
563+
</method>
546564
<method name="get_rect_at_line_column" qualifiers="const">
547565
<return type="Rect2i" />
548566
<param index="0" name="line" type="int" />
@@ -1265,6 +1283,9 @@
12651283
<member name="autowrap_mode" type="int" setter="set_autowrap_mode" getter="get_autowrap_mode" enum="TextServer.AutowrapMode" default="3">
12661284
If [member wrap_mode] is set to [constant LINE_WRAPPING_BOUNDARY], sets text wrapping mode. To see how each mode behaves, see [enum TextServer.AutowrapMode].
12671285
</member>
1286+
<member name="backspace_deletes_composite_character_enabled" type="bool" setter="set_backspace_deletes_composite_character_enabled" getter="is_backspace_deletes_composite_character_enabled" default="false">
1287+
If [code]true[/code] and [member caret_mid_grapheme] is [code]false[/code], backspace deletes an entire composite character such as ❤️‍🩹, instead of deleting part of the composite character.
1288+
</member>
12681289
<member name="caret_blink" type="bool" setter="set_caret_blink_enabled" getter="is_caret_blink_enabled" default="false">
12691290
If [code]true[/code], makes the caret blink.
12701291
</member>

‎scene/gui/code_edit.cpp‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -808,7 +808,14 @@ void CodeEdit::_backspace_internal(int p_caret) {
808808
}
809809

810810
int from_line = to_column > 0 ? to_line : to_line - 1;
811-
int from_column = to_column > 0 ? (to_column - 1) : (get_line(to_line - 1).length());
811+
int from_column = 0;
812+
if (to_column == 0) {
813+
from_column = get_line(to_line - 1).length();
814+
} else if (TextEdit::is_caret_mid_grapheme_enabled() || !TextEdit::is_backspace_deletes_composite_character_enabled()) {
815+
from_column = to_column - 1;
816+
} else {
817+
from_column = TextEdit::get_previous_composite_character_column(to_line, to_column);
818+
}
812819

813820
merge_gutters(from_line, to_line);
814821

‎scene/gui/line_edit.cpp‎

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1955,11 +1955,14 @@ void LineEdit::delete_char() {
19551955
if (text.is_empty() || caret_column == 0) {
19561956
return;
19571957
}
1958-
1959-
text = text.left(caret_column - 1) + text.substr(caret_column);
1958+
int delete_char_offset = 1;
1959+
if (!caret_mid_grapheme_enabled && backspace_deletes_composite_character_enabled) {
1960+
delete_char_offset = caret_column - get_previous_composite_character_column(caret_column);
1961+
}
1962+
text = text.left(caret_column - delete_char_offset) + text.substr(caret_column);
19601963
_shape();
19611964

1962-
set_caret_column(get_caret_column() - 1);
1965+
set_caret_column(get_caret_column() - delete_char_offset);
19631966

19641967
_text_changed();
19651968
}
@@ -2213,6 +2216,24 @@ int LineEdit::get_caret_column() const {
22132216
return caret_column;
22142217
}
22152218

2219+
int LineEdit::get_next_composite_character_column(int p_column) const {
2220+
ERR_FAIL_INDEX_V(p_column, text.length() + 1, -1);
2221+
if (p_column == text.length()) {
2222+
return p_column;
2223+
} else {
2224+
return TS->shaped_text_next_character_pos(text_rid, p_column);
2225+
}
2226+
}
2227+
2228+
int LineEdit::get_previous_composite_character_column(int p_column) const {
2229+
ERR_FAIL_INDEX_V(p_column, text.length() + 1, -1);
2230+
if (p_column == 0) {
2231+
return 0;
2232+
} else {
2233+
return TS->shaped_text_prev_character_pos(text_rid, p_column);
2234+
}
2235+
}
2236+
22162237
void LineEdit::set_scroll_offset(float p_pos) {
22172238
scroll_offset = p_pos;
22182239
if (scroll_offset < 0.0) {
@@ -2629,6 +2650,14 @@ bool LineEdit::is_emoji_menu_enabled() const {
26292650
return emoji_menu_enabled;
26302651
}
26312652

2653+
void LineEdit::set_backspace_deletes_composite_character_enabled(bool p_enabled) {
2654+
backspace_deletes_composite_character_enabled = p_enabled;
2655+
}
2656+
2657+
bool LineEdit::is_backspace_deletes_composite_character_enabled() const {
2658+
return backspace_deletes_composite_character_enabled;
2659+
}
2660+
26322661
bool LineEdit::is_menu_visible() const {
26332662
return menu && menu->is_visible();
26342663
}
@@ -3092,6 +3121,8 @@ void LineEdit::_bind_methods() {
30923121
ClassDB::bind_method(D_METHOD("get_placeholder"), &LineEdit::get_placeholder);
30933122
ClassDB::bind_method(D_METHOD("set_caret_column", "position"), &LineEdit::set_caret_column);
30943123
ClassDB::bind_method(D_METHOD("get_caret_column"), &LineEdit::get_caret_column);
3124+
ClassDB::bind_method(D_METHOD("get_next_composite_character_column", "column"), &LineEdit::get_next_composite_character_column);
3125+
ClassDB::bind_method(D_METHOD("get_previous_composite_character_column", "column"), &LineEdit::get_previous_composite_character_column);
30953126
ClassDB::bind_method(D_METHOD("get_scroll_offset"), &LineEdit::get_scroll_offset);
30963127
ClassDB::bind_method(D_METHOD("set_expand_to_text_length_enabled", "enabled"), &LineEdit::set_expand_to_text_length_enabled);
30973128
ClassDB::bind_method(D_METHOD("is_expand_to_text_length_enabled"), &LineEdit::is_expand_to_text_length_enabled);
@@ -3124,6 +3155,8 @@ void LineEdit::_bind_methods() {
31243155
ClassDB::bind_method(D_METHOD("is_context_menu_enabled"), &LineEdit::is_context_menu_enabled);
31253156
ClassDB::bind_method(D_METHOD("set_emoji_menu_enabled", "enable"), &LineEdit::set_emoji_menu_enabled);
31263157
ClassDB::bind_method(D_METHOD("is_emoji_menu_enabled"), &LineEdit::is_emoji_menu_enabled);
3158+
ClassDB::bind_method(D_METHOD("set_backspace_deletes_composite_character_enabled", "enable"), &LineEdit::set_backspace_deletes_composite_character_enabled);
3159+
ClassDB::bind_method(D_METHOD("is_backspace_deletes_composite_character_enabled"), &LineEdit::is_backspace_deletes_composite_character_enabled);
31273160
ClassDB::bind_method(D_METHOD("set_virtual_keyboard_enabled", "enable"), &LineEdit::set_virtual_keyboard_enabled);
31283161
ClassDB::bind_method(D_METHOD("is_virtual_keyboard_enabled"), &LineEdit::is_virtual_keyboard_enabled);
31293162
ClassDB::bind_method(D_METHOD("set_virtual_keyboard_type", "type"), &LineEdit::set_virtual_keyboard_type);
@@ -3203,6 +3236,7 @@ void LineEdit::_bind_methods() {
32033236
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "expand_to_text_length"), "set_expand_to_text_length_enabled", "is_expand_to_text_length_enabled");
32043237
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "context_menu_enabled"), "set_context_menu_enabled", "is_context_menu_enabled");
32053238
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "emoji_menu_enabled"), "set_emoji_menu_enabled", "is_emoji_menu_enabled");
3239+
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "backspace_deletes_composite_character_enabled"), "set_backspace_deletes_composite_character_enabled", "is_backspace_deletes_composite_character_enabled");
32063240
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "virtual_keyboard_enabled"), "set_virtual_keyboard_enabled", "is_virtual_keyboard_enabled");
32073241
ADD_PROPERTY(PropertyInfo(Variant::INT, "virtual_keyboard_type", PROPERTY_HINT_ENUM, "Default,Multiline,Number,Decimal,Phone,Email,Password,URL"), "set_virtual_keyboard_type", "get_virtual_keyboard_type");
32083242
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "clear_button_enabled"), "set_clear_button_enabled", "is_clear_button_enabled");

‎scene/gui/line_edit.h‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,7 @@ class LineEdit : public Control {
122122

123123
bool context_menu_enabled = true;
124124
bool emoji_menu_enabled = true;
125+
bool backspace_deletes_composite_character_enabled = false;
125126
PopupMenu *menu = nullptr;
126127
PopupMenu *menu_dir = nullptr;
127128
PopupMenu *menu_ctl = nullptr;
@@ -309,6 +310,9 @@ class LineEdit : public Control {
309310
void set_emoji_menu_enabled(bool p_enabled);
310311
bool is_emoji_menu_enabled() const;
311312

313+
void set_backspace_deletes_composite_character_enabled(bool p_enabled);
314+
bool is_backspace_deletes_composite_character_enabled() const;
315+
312316
void select(int p_from = 0, int p_to = -1);
313317
void select_all();
314318
void selection_delete();
@@ -345,6 +349,8 @@ class LineEdit : public Control {
345349

346350
void set_caret_column(int p_column);
347351
int get_caret_column() const;
352+
int get_next_composite_character_column(int p_column) const;
353+
int get_previous_composite_character_column(int p_column) const;
348354

349355
void set_max_length(int p_max_length);
350356
int get_max_length() const;

‎scene/gui/text_edit.cpp‎

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3723,6 +3723,14 @@ bool TextEdit::is_emoji_menu_enabled() const {
37233723
return emoji_menu_enabled;
37243724
}
37253725

3726+
void TextEdit::set_backspace_deletes_composite_character_enabled(bool p_enabled) {
3727+
backspace_deletes_composite_character_enabled = p_enabled;
3728+
}
3729+
3730+
bool TextEdit::is_backspace_deletes_composite_character_enabled() const {
3731+
return backspace_deletes_composite_character_enabled;
3732+
}
3733+
37263734
void TextEdit::set_shortcut_keys_enabled(bool p_enabled) {
37273735
shortcut_keys_enabled = p_enabled;
37283736
}
@@ -6056,6 +6064,26 @@ int TextEdit::get_selection_origin_column(int p_caret) const {
60566064
return carets[p_caret].selection.origin_column;
60576065
}
60586066

6067+
int TextEdit::get_next_composite_character_column(int p_line, int p_column) const {
6068+
ERR_FAIL_INDEX_V(p_line, text.size(), -1);
6069+
ERR_FAIL_INDEX_V(p_column, text[p_line].length() + 1, -1);
6070+
if (p_column == text[p_line].length()) {
6071+
return p_column;
6072+
} else {
6073+
return TS->shaped_text_next_character_pos(text.get_line_data(p_line)->get_rid(), (p_column));
6074+
}
6075+
}
6076+
6077+
int TextEdit::get_previous_composite_character_column(int p_line, int p_column) const {
6078+
ERR_FAIL_INDEX_V(p_line, text.size(), -1);
6079+
ERR_FAIL_INDEX_V(p_column, text[p_line].length() + 1, -1);
6080+
if (p_column == 0) {
6081+
return 0;
6082+
} else {
6083+
return TS->shaped_text_prev_character_pos(text.get_line_data(p_line)->get_rid(), p_column);
6084+
}
6085+
}
6086+
60596087
int TextEdit::get_selection_from_line(int p_caret) const {
60606088
ERR_FAIL_INDEX_V(p_caret, carets.size(), -1);
60616089
if (!has_selection(p_caret)) {
@@ -6957,6 +6985,9 @@ void TextEdit::_bind_methods() {
69576985
ClassDB::bind_method(D_METHOD("set_emoji_menu_enabled", "enable"), &TextEdit::set_emoji_menu_enabled);
69586986
ClassDB::bind_method(D_METHOD("is_emoji_menu_enabled"), &TextEdit::is_emoji_menu_enabled);
69596987

6988+
ClassDB::bind_method(D_METHOD("set_backspace_deletes_composite_character_enabled", "enable"), &TextEdit::set_backspace_deletes_composite_character_enabled);
6989+
ClassDB::bind_method(D_METHOD("is_backspace_deletes_composite_character_enabled"), &TextEdit::is_backspace_deletes_composite_character_enabled);
6990+
69606991
ClassDB::bind_method(D_METHOD("set_shortcut_keys_enabled", "enabled"), &TextEdit::set_shortcut_keys_enabled);
69616992
ClassDB::bind_method(D_METHOD("is_shortcut_keys_enabled"), &TextEdit::is_shortcut_keys_enabled);
69626993

@@ -7150,6 +7181,8 @@ void TextEdit::_bind_methods() {
71507181

71517182
ClassDB::bind_method(D_METHOD("set_caret_column", "column", "adjust_viewport", "caret_index"), &TextEdit::set_caret_column, DEFVAL(true), DEFVAL(0));
71527183
ClassDB::bind_method(D_METHOD("get_caret_column", "caret_index"), &TextEdit::get_caret_column, DEFVAL(0));
7184+
ClassDB::bind_method(D_METHOD("get_next_composite_character_column", "line", "column"), &TextEdit::get_next_composite_character_column);
7185+
ClassDB::bind_method(D_METHOD("get_previous_composite_character_column", "line", "column"), &TextEdit::get_previous_composite_character_column);
71537186

71547187
ClassDB::bind_method(D_METHOD("get_caret_wrap_index", "caret_index"), &TextEdit::get_caret_wrap_index, DEFVAL(0));
71557188

@@ -7359,6 +7392,7 @@ void TextEdit::_bind_methods() {
73597392
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "editable"), "set_editable", "is_editable");
73607393
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "context_menu_enabled"), "set_context_menu_enabled", "is_context_menu_enabled");
73617394
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "emoji_menu_enabled"), "set_emoji_menu_enabled", "is_emoji_menu_enabled");
7395+
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "backspace_deletes_composite_character_enabled"), "set_backspace_deletes_composite_character_enabled", "is_backspace_deletes_composite_character_enabled");
73627396
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "shortcut_keys_enabled"), "set_shortcut_keys_enabled", "is_shortcut_keys_enabled");
73637397
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "selecting_enabled"), "set_selecting_enabled", "is_selecting_enabled");
73647398
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "deselect_on_focus_loss_enabled"), "set_deselect_on_focus_loss_enabled", "is_deselect_on_focus_loss_enabled");
@@ -7595,7 +7629,14 @@ void TextEdit::_backspace_internal(int p_caret) {
75957629
}
75967630

75977631
int from_line = to_column > 0 ? to_line : to_line - 1;
7598-
int from_column = to_column > 0 ? (to_column - 1) : (text[to_line - 1].length());
7632+
int from_column = 0;
7633+
if (to_column == 0) {
7634+
from_column = text[to_line - 1].length();
7635+
} else if (caret_mid_grapheme_enabled || !backspace_deletes_composite_character_enabled) {
7636+
from_column = to_column - 1;
7637+
} else {
7638+
from_column = get_previous_composite_character_column(to_line, to_column);
7639+
}
75997640

76007641
merge_gutters(from_line, to_line);
76017642

‎scene/gui/text_edit.h‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,6 +340,7 @@ class TextEdit : public Control {
340340
bool overtype_mode = false;
341341
bool context_menu_enabled = true;
342342
bool emoji_menu_enabled = true;
343+
bool backspace_deletes_composite_character_enabled = false;
343344
bool shortcut_keys_enabled = true;
344345
bool virtual_keyboard_enabled = true;
345346
bool middle_mouse_paste_enabled = true;
@@ -813,6 +814,9 @@ class TextEdit : public Control {
813814
void set_emoji_menu_enabled(bool p_enabled);
814815
bool is_emoji_menu_enabled() const;
815816

817+
void set_backspace_deletes_composite_character_enabled(bool p_enabled);
818+
bool is_backspace_deletes_composite_character_enabled() const;
819+
816820
void set_shortcut_keys_enabled(bool p_enabled);
817821
bool is_shortcut_keys_enabled() const;
818822

@@ -960,6 +964,8 @@ class TextEdit : public Control {
960964

961965
void set_caret_column(int p_column, bool p_adjust_viewport = true, int p_caret = 0);
962966
int get_caret_column(int p_caret = 0) const;
967+
int get_next_composite_character_column(int p_line, int p_column) const;
968+
int get_previous_composite_character_column(int p_line, int p_column) const;
963969

964970
int get_caret_wrap_index(int p_caret = 0) const;
965971

0 commit comments

Comments
 (0)