Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-24 21:22:48 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

[Complex Text Layouts] Refactor Label and LineEdit controls.

Browse Source
This commit is contained in:
bruvzg 2020-09-09 16:00:32 +03:00
parent 99666de00f
commit d66eb77c9c
No known key found for this signature in database
GPG Key ID: FCED35F1CECE0D3A
4 changed files with 1238 additions and 768 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

718
scene/gui/label.cpp
View File

@ -34,13 +34,13 @@
#include "core/string/print_string.h"
#include "core/string/translation.h"
void Label::set_autowrap(bool p_autowrap) {
if (autowrap == p_autowrap) {
return;
}
#include "servers/text_server.h"
autowrap = p_autowrap;
word_cache_dirty = true;
void Label::set_autowrap(bool p_autowrap) {
if (autowrap != p_autowrap) {
autowrap = p_autowrap;
lines_dirty = true;
}
update();
if (clip) {
@ -54,7 +54,8 @@ bool Label::has_autowrap() const {
void Label::set_uppercase(bool p_uppercase) {
uppercase = p_uppercase;
word_cache_dirty = true;
dirty = true;
update();
}
@ -62,8 +63,95 @@ bool Label::is_uppercase() const {
return uppercase;
}
int Label::get_line_height() const {
return get_theme_font("font")->get_height();
int Label::get_line_height(int p_line) const {
if (p_line >= 0 && p_line < lines_rid.size()) {
return TS->shaped_text_get_size(lines_rid[p_line]).y;
} else if (lines_rid.size() > 0) {
int h = 0;
for (int i = 0; i < lines_rid.size(); i++) {
h = MAX(h, TS->shaped_text_get_size(lines_rid[i]).y);
}
return h;
} else {
return get_theme_font("font")->get_height(get_theme_font_size("font_size"));
}
}
void Label::_shape() {
Ref<StyleBox> style = get_theme_stylebox("normal", "Label");
int width = (get_size().width - style->get_minimum_size().width);
if (dirty) {
TS->shaped_text_clear(text_rid);
if (text_direction == Control::TEXT_DIRECTION_INHERITED) {
TS->shaped_text_set_direction(text_rid, is_layout_rtl() ? TextServer::DIRECTION_RTL : TextServer::DIRECTION_LTR);
} else {
TS->shaped_text_set_direction(text_rid, (TextServer::Direction)text_direction);
}
TS->shaped_text_add_string(text_rid, (uppercase) ? xl_text.to_upper() : xl_text, get_theme_font("font")->get_rids(), get_theme_font_size("font_size"), opentype_features, (language != "") ? language : TranslationServer::get_singleton()->get_tool_locale());
TS->shaped_text_set_bidi_override(text_rid, structured_text_parser(st_parser, st_args, xl_text));
dirty = false;
lines_dirty = true;
}
if (lines_dirty) {
for (int i = 0; i < lines_rid.size(); i++) {
TS->free(lines_rid[i]);
}
lines_rid.clear();
Vector<Vector2i> lines = TS->shaped_text_get_line_breaks(text_rid, width, 0, (autowrap) ? (TextServer::BREAK_MANDATORY | TextServer::BREAK_WORD_BOUND) : TextServer::BREAK_MANDATORY);
for (int i = 0; i < lines.size(); i++) {
RID line = TS->shaped_text_substr(text_rid, lines[i].x, lines[i].y - lines[i].x);
lines_rid.push_back(line);
}
}
if (xl_text.length() == 0) {
minsize = Size2(1, get_line_height());
return;
}
if (!autowrap) {
minsize.width = 0.0f;
for (int i = 0; i < lines_rid.size(); i++) {
if (minsize.width < TS->shaped_text_get_size(lines_rid[i]).x) {
minsize.width = TS->shaped_text_get_size(lines_rid[i]).x;
}
}
}
if (lines_dirty) { // Fill after min_size calculation.
if (align == ALIGN_FILL) {
for (int i = 0; i < lines_rid.size(); i++) {
TS->shaped_text_fit_to_width(lines_rid.write[i], width);
}
}
lines_dirty = false;
}
_update_visible();
if (!autowrap || !clip) {
minimum_size_changed();
}
}
void Label::_update_visible() {
int line_spacing = get_theme_constant("line_spacing", "Label");
Ref<StyleBox> style = get_theme_stylebox("normal", "Label");
int lines_visible = lines_rid.size();
if (max_lines_visible >= 0 && lines_visible > max_lines_visible) {
lines_visible = max_lines_visible;
}
minsize.height = 0;
int last_line = MIN(lines_rid.size(), lines_visible + lines_skipped);
for (int64_t i = lines_skipped; i < last_line; i++) {
minsize.height += TS->shaped_text_get_size(lines_rid[i]).y + line_spacing;
if (minsize.height > (get_size().height - style->get_minimum_size().height + line_spacing)) {
break;
}
}
}
void Label::_notification(int p_what) {
@ -73,8 +161,8 @@ void Label::_notification(int p_what) {
return; //nothing new
}
xl_text = new_text;
dirty = true;
regenerate_word_cache();
update();
}
@ -83,8 +171,8 @@ void Label::_notification(int p_what) {
RenderingServer::get_singleton()->canvas_item_set_clip(get_canvas_item(), true);
}
if (word_cache_dirty) {
regenerate_word_cache();
if (dirty || lines_dirty) {
_shape();
}
RID ci = get_canvas_item();
@ -93,54 +181,61 @@ void Label::_notification(int p_what) {
Size2 size = get_size();
Ref<StyleBox> style = get_theme_stylebox("normal");
Ref<Font> font = get_theme_font("font");
int font_size = get_theme_font_size("font_size");
Color font_color = get_theme_color("font_color");
Color font_color_shadow = get_theme_color("font_color_shadow");
bool use_outline = get_theme_constant("shadow_as_outline");
Point2 shadow_ofs(get_theme_constant("shadow_offset_x"), get_theme_constant("shadow_offset_y"));
int line_spacing = get_theme_constant("line_spacing");
//Color font_outline_modulate = get_theme_color("font_outline_modulate");
Color font_outline_modulate = get_theme_color("font_outline_modulate");
int outline_size = get_theme_constant("outline_size");
int shadow_outline_size = get_theme_constant("shadow_outline_size");
bool rtl = is_layout_rtl();
style->draw(ci, Rect2(Point2(0, 0), get_size()));
//RenderingServer::get_singleton()->canvas_item_set_distance_field_mode(get_canvas_item(), font.is_valid() && font->is_distance_field_hint());
float total_h = 0;
int lines_visible = 0;
int font_h = font->get_height() + line_spacing;
int lines_visible = (size.y + line_spacing) / font_h;
real_t space_w = font->get_char_size(' ').width;
int chars_total = 0;
int vbegin = 0, vsep = 0;
if (lines_visible > line_count) {
lines_visible = line_count;
// Get number of lines to fit to the height.
for (int64_t i = lines_skipped; i < lines_rid.size(); i++) {
total_h += TS->shaped_text_get_size(lines_rid[i]).y + line_spacing;
if (total_h > (get_size().height - style->get_minimum_size().height + line_spacing)) {
break;
}
lines_visible++;
}
if (max_lines_visible >= 0 && lines_visible > max_lines_visible) {
lines_visible = max_lines_visible;
}
int last_line = MIN(lines_rid.size(), lines_visible + lines_skipped);
// Get real total height.
total_h = 0;
for (int64_t i = lines_skipped; i < last_line; i++) {
total_h += TS->shaped_text_get_size(lines_rid[i]).y + line_spacing;
}
int vbegin = 0, vsep = 0;
if (lines_visible > 0) {
switch (valign) {
case VALIGN_TOP: {
//nothing
} break;
case VALIGN_CENTER: {
vbegin = (size.y - (lines_visible * font_h - line_spacing)) / 2;
vbegin = (size.y - (total_h - line_spacing)) / 2;
vsep = 0;
} break;
case VALIGN_BOTTOM: {
vbegin = size.y - (lines_visible * font_h - line_spacing);
vbegin = size.y - (total_h - line_spacing);
vsep = 0;
} break;
case VALIGN_FILL: {
vbegin = 0;
if (lines_visible > 1) {
vsep = (size.y - (lines_visible * font_h - line_spacing)) / (lines_visible - 1);
vsep = (size.y - (total_h - line_spacing)) / (lines_visible - 1);
} else {
vsep = 0;
}
@ -149,139 +244,109 @@ void Label::_notification(int p_what) {
}
}
WordCache *wc = word_cache;
if (!wc) {
return;
int visible_glyphs = -1;
int glyhps_drawn = 0;
if (percent_visible < 1) {
int total_glyphs = 0;
for (int i = lines_skipped; i < last_line; i++) {
const Vector<TextServer::Glyph> glyphs = TS->shaped_text_get_glyphs(lines_rid[i]);
for (int j = 0; j < glyphs.size(); j++) {
if ((glyphs[j].flags & TextServer::GRAPHEME_IS_VIRTUAL) != TextServer::GRAPHEME_IS_VIRTUAL) {
total_glyphs++;
}
}
}
visible_glyphs = total_glyphs * percent_visible;
}
int line = 0;
int line_to = lines_skipped + (lines_visible > 0 ? lines_visible : 1);
//FontDrawer drawer(font, font_outline_modulate);
while (wc) {
/* handle lines not meant to be drawn quickly */
if (line >= line_to) {
break;
}
if (line < lines_skipped) {
while (wc && wc->char_pos >= 0) {
wc = wc->next;
}
if (wc) {
wc = wc->next;
}
line++;
continue;
}
/* handle lines normally */
if (wc->char_pos < 0) {
//empty line
wc = wc->next;
line++;
continue;
}
WordCache *from = wc;
WordCache *to = wc;
int taken = 0;
int spaces = 0;
while (to && to->char_pos >= 0) {
taken += to->pixel_width;
if (to->space_count) {
spaces += to->space_count;
}
to = to->next;
}
bool can_fill = to && to->char_pos == WordCache::CHAR_WRAPLINE;
float x_ofs = 0;
Vector2 ofs;
ofs.y = style->get_offset().y + vbegin;
for (int i = lines_skipped; i < last_line; i++) {
ofs.x = 0;
ofs.y += TS->shaped_text_get_ascent(lines_rid[i]);
switch (align) {
case ALIGN_FILL:
case ALIGN_LEFT: {
x_ofs = style->get_offset().x;
if (rtl) {
ofs.x = int(size.width - style->get_margin(MARGIN_RIGHT) - TS->shaped_text_get_size(lines_rid[i]).x);
} else {
ofs.x = style->get_offset().x;
}
} break;
case ALIGN_CENTER: {
x_ofs = int(size.width - (taken + spaces * space_w)) / 2;
ofs.x = int(size.width - TS->shaped_text_get_size(lines_rid[i]).x) / 2;
} break;
case ALIGN_RIGHT: {
x_ofs = int(size.width - style->get_margin(MARGIN_RIGHT) - (taken + spaces * space_w));
if (rtl) {
ofs.x = style->get_offset().x;
} else {
ofs.x = int(size.width - style->get_margin(MARGIN_RIGHT) - TS->shaped_text_get_size(lines_rid[i]).x);
}
} break;
}
float y_ofs = style->get_offset().y;
y_ofs += (line - lines_skipped) * font_h + font->get_ascent();
y_ofs += vbegin + line * vsep;
const Vector<TextServer::Glyph> glyphs = TS->shaped_text_get_glyphs(lines_rid[i]);
while (from != to) {
// draw a word
int pos = from->char_pos;
if (from->char_pos < 0) {
ERR_PRINT("BUG");
return;
}
if (from->space_count) {
/* spacing */
x_ofs += space_w * from->space_count;
if (can_fill && align == ALIGN_FILL && spaces) {
x_ofs += int((size.width - (taken + space_w * spaces)) / spaces);
float x = ofs.x;
int outlines_drawn = glyhps_drawn;
for (int j = 0; j < glyphs.size(); j++) {
for (int k = 0; k < glyphs[j].repeat; k++) {
if (glyphs[j].font_rid != RID()) {
if (font_color_shadow.a > 0) {
TS->font_draw_glyph(glyphs[j].font_rid, ci, glyphs[j].font_size, ofs + Vector2(glyphs[j].x_off, glyphs[j].y_off) + shadow_ofs, glyphs[j].index, font_color_shadow);
if (shadow_outline_size > 0) {
//draw shadow
TS->font_draw_glyph_outline(glyphs[j].font_rid, ci, glyphs[j].font_size, shadow_outline_size, ofs + Vector2(glyphs[j].x_off, glyphs[j].y_off) + Vector2(-shadow_ofs.x, shadow_ofs.y), glyphs[j].index, font_color_shadow);
TS->font_draw_glyph_outline(glyphs[j].font_rid, ci, glyphs[j].font_size, shadow_outline_size, ofs + Vector2(glyphs[j].x_off, glyphs[j].y_off) + Vector2(shadow_ofs.x, -shadow_ofs.y), glyphs[j].index, font_color_shadow);
TS->font_draw_glyph_outline(glyphs[j].font_rid, ci, glyphs[j].font_size, shadow_outline_size, ofs + Vector2(glyphs[j].x_off, glyphs[j].y_off) + Vector2(-shadow_ofs.x, -shadow_ofs.y), glyphs[j].index, font_color_shadow);
}
}
if (font_outline_modulate.a != 0.0 && outline_size > 0) {
TS->font_draw_glyph_outline(glyphs[j].font_rid, ci, glyphs[j].font_size, outline_size, ofs + Vector2(glyphs[j].x_off, glyphs[j].y_off), glyphs[j].index, font_outline_modulate);
}
}
ofs.x += glyphs[j].advance;
}
if (font_color_shadow.a > 0) {
int chars_total_shadow = chars_total; //save chars drawn
float x_ofs_shadow = x_ofs;
for (int i = 0; i < from->word_len; i++) {
if (visible_chars < 0 || chars_total_shadow < visible_chars) {
char32_t c = xl_text[i + pos];
char32_t n = xl_text[i + pos + 1];
if (uppercase) {
c = String::char_uppercase(c);
n = String::char_uppercase(n);
}
//TODO replace with TS
float move = font->draw_char(ci, Point2(x_ofs_shadow, y_ofs) + shadow_ofs, c, n, font_size, font_color_shadow);
if (use_outline) {
font->draw_char(ci, Point2(x_ofs_shadow, y_ofs) + Vector2(-shadow_ofs.x, shadow_ofs.y), c, n, font_size, font_color_shadow);
font->draw_char(ci, Point2(x_ofs_shadow, y_ofs) + Vector2(shadow_ofs.x, -shadow_ofs.y), c, n, font_size, font_color_shadow);
font->draw_char(ci, Point2(x_ofs_shadow, y_ofs) + Vector2(-shadow_ofs.x, -shadow_ofs.y), c, n, font_size, font_color_shadow);
}
x_ofs_shadow += move;
chars_total_shadow++;
if (visible_glyphs != -1) {
if ((glyphs[j].flags & TextServer::GRAPHEME_IS_VIRTUAL) != TextServer::GRAPHEME_IS_VIRTUAL) {
outlines_drawn++;
if (outlines_drawn >= visible_glyphs) {
break;
}
}
}
for (int i = 0; i < from->word_len; i++) {
if (visible_chars < 0 || chars_total < visible_chars) {
char32_t c = xl_text[i + pos];
char32_t n = xl_text[i + pos + 1];
if (uppercase) {
c = String::char_uppercase(c);
n = String::char_uppercase(n);
}
}
ofs.x = x;
x_ofs += font->draw_char(ci, Point2(x_ofs, y_ofs), c, n, font_size, font_color);
chars_total++;
for (int j = 0; j < glyphs.size(); j++) {
for (int k = 0; k < glyphs[j].repeat; k++) {
if (glyphs[j].font_rid != RID()) {
TS->font_draw_glyph(glyphs[j].font_rid, ci, glyphs[j].font_size, ofs + Vector2(glyphs[j].x_off, glyphs[j].y_off), glyphs[j].index, font_color);
} else if ((glyphs[j].flags & TextServer::GRAPHEME_IS_VIRTUAL) != TextServer::GRAPHEME_IS_VIRTUAL) {
TS->draw_hex_code_box(ci, glyphs[j].font_size, ofs + Vector2(glyphs[j].x_off, glyphs[j].y_off), glyphs[j].index, font_color);
}
ofs.x += glyphs[j].advance;
}
if (visible_glyphs != -1) {
if ((glyphs[j].flags & TextServer::GRAPHEME_IS_VIRTUAL) != TextServer::GRAPHEME_IS_VIRTUAL) {
glyhps_drawn++;
if (glyhps_drawn >= visible_glyphs) {
return;
}
}
}
from = from->next;
}
wc = to ? to->next : nullptr;
line++;
ofs.y += TS->shaped_text_get_descent(lines_rid[i]) + vsep + line_spacing;
}
}
if (p_what == NOTIFICATION_THEME_CHANGED) {
word_cache_dirty = true;
dirty = true;
update();
}
if (p_what == NOTIFICATION_RESIZED) {
word_cache_dirty = true;
lines_dirty = true;
}
}
@ -289,8 +354,8 @@ Size2 Label::get_minimum_size() const {
Size2 min_style = get_theme_stylebox("normal")->get_minimum_size();
// don't want to mutable everything
if (word_cache_dirty) {
const_cast<Label *>(this)->regenerate_word_cache();
if (dirty || lines_dirty) {
const_cast<Label *>(this)->_shape();
}
if (autowrap) {
@ -304,56 +369,32 @@ Size2 Label::get_minimum_size() const {
}
}
int Label::get_longest_line_width() const {
Ref<Font> font = get_theme_font("font");
real_t max_line_width = 0;
real_t line_width = 0;
for (int i = 0; i < xl_text.size(); i++) {
char32_t current = xl_text[i];
if (uppercase) {
current = String::char_uppercase(current);
}
if (current < 32) {
if (current == '\n') {
if (line_width > max_line_width) {
max_line_width = line_width;
}
line_width = 0;
}
} else {
real_t char_width = font->get_char_size(current, xl_text[i + 1]).width;
line_width += char_width;
}
}
if (line_width > max_line_width) {
max_line_width = line_width;
}
// ceiling to ensure autowrapping does not cut text
return Math::ceil(max_line_width);
}
int Label::get_line_count() const {
if (!is_inside_tree()) {
return 1;
}
if (word_cache_dirty) {
const_cast<Label *>(this)->regenerate_word_cache();
if (dirty || lines_dirty) {
const_cast<Label *>(this)->_shape();
}
return line_count;
return lines_rid.size();
}
int Label::get_visible_line_count() const {
Ref<StyleBox> style = get_theme_stylebox("normal");
int line_spacing = get_theme_constant("line_spacing");
int font_h = get_theme_font("font")->get_height() + line_spacing;
int lines_visible = (get_size().height - get_theme_stylebox("normal")->get_minimum_size().height + line_spacing) / font_h;
int lines_visible = 0;
float total_h = 0;
for (int64_t i = lines_skipped; i < lines_rid.size(); i++) {
total_h += TS->shaped_text_get_size(lines_rid[i]).y + line_spacing;
if (total_h > (get_size().height - style->get_minimum_size().height + line_spacing)) {
break;
}
lines_visible++;
}
if (lines_visible > line_count) {
lines_visible = line_count;
if (lines_visible > lines_rid.size()) {
lines_visible = lines_rid.size();
}
if (max_lines_visible >= 0 && lines_visible > max_lines_visible) {
@ -363,171 +404,14 @@ int Label::get_visible_line_count() const {
return lines_visible;
}
void Label::regenerate_word_cache() {
while (word_cache) {
WordCache *current = word_cache;
word_cache = current->next;
memdelete(current);
}
int width;
if (autowrap) {
Ref<StyleBox> style = get_theme_stylebox("normal");
width = MAX(get_size().width, get_custom_minimum_size().width) - style->get_minimum_size().width;
} else {
width = get_longest_line_width();
}
Ref<Font> font = get_theme_font("font");
real_t current_word_size = 0;
int word_pos = 0;
real_t line_width = 0;
int space_count = 0;
real_t space_width = font->get_char_size(' ').width;
int line_spacing = get_theme_constant("line_spacing");
line_count = 1;
total_char_cache = 0;
WordCache *last = nullptr;
for (int i = 0; i <= xl_text.length(); i++) {
char32_t current = i < xl_text.length() ? xl_text[i] : L' '; //always a space at the end, so the algo works
if (uppercase) {
current = String::char_uppercase(current);
}
// ranges taken from http://www.unicodemap.org/
// if your language is not well supported, consider helping improve
// the unicode support in Godot.
bool separatable = (current >= 0x2E08 && current <= 0xFAFF) || (current >= 0xFE30 && current <= 0xFE4F);
//current>=33 && (current < 65||current >90) && (current<97||current>122) && (current<48||current>57);
bool insert_newline = false;
real_t char_width = 0;
if (current < 33) {
if (current_word_size > 0) {
WordCache *wc = memnew(WordCache);
if (word_cache) {
last->next = wc;
} else {
word_cache = wc;
}
last = wc;
wc->pixel_width = current_word_size;
wc->char_pos = word_pos;
wc->word_len = i - word_pos;
wc->space_count = space_count;
current_word_size = 0;
space_count = 0;
} else if ((i == xl_text.length() || current == '\n') && last != nullptr && space_count != 0) {
//in case there are trailing white spaces we add a placeholder word cache with just the spaces
WordCache *wc = memnew(WordCache);
if (word_cache) {
last->next = wc;
} else {
word_cache = wc;
}
last = wc;
wc->pixel_width = 0;
wc->char_pos = 0;
wc->word_len = 0;
wc->space_count = space_count;
current_word_size = 0;
space_count = 0;
}
if (current == '\n') {
insert_newline = true;
} else if (current != ' ') {
total_char_cache++;
}
if (i < xl_text.length() && xl_text[i] == ' ') {
if (line_width > 0 || last == nullptr || last->char_pos != WordCache::CHAR_WRAPLINE) {
space_count++;
line_width += space_width;
} else {
space_count = 0;
}
}
} else {
// latin characters
if (current_word_size == 0) {
word_pos = i;
}
char_width = font->get_char_size(current, xl_text[i + 1]).width;
current_word_size += char_width;
line_width += char_width;
total_char_cache++;
// allow autowrap to cut words when they exceed line width
if (autowrap && (current_word_size > width)) {
separatable = true;
}
}
if ((autowrap && (line_width >= width) && ((last && last->char_pos >= 0) || separatable)) || insert_newline) {
if (separatable) {
if (current_word_size > 0) {
WordCache *wc = memnew(WordCache);
if (word_cache) {
last->next = wc;
} else {
word_cache = wc;
}
last = wc;
wc->pixel_width = current_word_size - char_width;
wc->char_pos = word_pos;
wc->word_len = i - word_pos;
wc->space_count = space_count;
current_word_size = char_width;
word_pos = i;
}
}
WordCache *wc = memnew(WordCache);
if (word_cache) {
last->next = wc;
} else {
word_cache = wc;
}
last = wc;
wc->pixel_width = 0;
wc->char_pos = insert_newline ? WordCache::CHAR_NEWLINE : WordCache::CHAR_WRAPLINE;
line_width = current_word_size;
line_count++;
space_count = 0;
}
}
if (!autowrap) {
minsize.width = width;
}
if (max_lines_visible > 0 && line_count > max_lines_visible) {
minsize.height = (font->get_height() * max_lines_visible) + (line_spacing * (max_lines_visible - 1));
} else {
minsize.height = (font->get_height() * line_count) + (line_spacing * (line_count - 1));
}
if (!autowrap || !clip) {
//helps speed up some labels that may change a lot, as no resizing is requested. Do not change.
minimum_size_changed();
}
word_cache_dirty = false;
}
void Label::set_align(Align p_align) {
ERR_FAIL_INDEX((int)p_align, 4);
align = p_align;
if (align != p_align) {
if (align == ALIGN_FILL || p_align == ALIGN_FILL) {
lines_dirty = true; // Reshape lines.
}
align = p_align;
}
update();
}
@ -551,13 +435,83 @@ void Label::set_text(const String &p_string) {
}
text = p_string;
xl_text = tr(p_string);
word_cache_dirty = true;
dirty = true;
if (percent_visible < 1) {
visible_chars = get_total_character_count() * percent_visible;
}
update();
}
void Label::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;
dirty = true;
update();
}
}
void Label::set_structured_text_bidi_override(Control::StructuredTextParser p_parser) {
if (st_parser != p_parser) {
st_parser = p_parser;
dirty = true;
update();
}
}
Control::StructuredTextParser Label::get_structured_text_bidi_override() const {
return st_parser;
}
void Label::set_structured_text_bidi_override_options(Array p_args) {
st_args = p_args;
dirty = true;
update();
}
Array Label::get_structured_text_bidi_override_options() const {
return st_args;
}
Control::TextDirection Label::get_text_direction() const {
return text_direction;
}
void Label::clear_opentype_features() {
opentype_features.clear();
dirty = true;
update();
}
void Label::set_opentype_feature(const String &p_name, int p_value) {
int32_t tag = TS->name_to_tag(p_name);
if (!opentype_features.has(tag) || (int)opentype_features[tag] != p_value) {
opentype_features[tag] = p_value;
dirty = true;
update();
}
}
int Label::get_opentype_feature(const String &p_name) const {
int32_t tag = TS->name_to_tag(p_name);
if (!opentype_features.has(tag)) {
return -1;
}
return opentype_features[tag];
}
void Label::set_language(const String &p_language) {
if (language != p_language) {
language = p_language;
dirty = true;
update();
}
}
String Label::get_language() const {
return language;
}
void Label::set_clip_text(bool p_clip) {
clip = p_clip;
update();
@ -575,7 +529,7 @@ String Label::get_text() const {
void Label::set_visible_characters(int p_amount) {
visible_chars = p_amount;
if (get_total_character_count() > 0) {
percent_visible = (float)p_amount / (float)total_char_cache;
percent_visible = (float)p_amount / (float)get_total_character_count();
}
_change_notify("percent_visible");
update();
@ -604,6 +558,7 @@ float Label::get_percent_visible() const {
void Label::set_lines_skipped(int p_lines) {
lines_skipped = p_lines;
_update_visible();
update();
}
@ -613,6 +568,7 @@ int Label::get_lines_skipped() const {
void Label::set_max_lines_visible(int p_lines) {
max_lines_visible = p_lines;
_update_visible();
update();
}
@ -621,11 +577,61 @@ int Label::get_max_lines_visible() const {
}
int Label::get_total_character_count() const {
if (word_cache_dirty) {
const_cast<Label *>(this)->regenerate_word_cache();
if (dirty || lines_dirty) {
const_cast<Label *>(this)->_shape();
}
return total_char_cache;
return xl_text.length();
}
bool Label::_set(const StringName &p_name, const Variant &p_value) {
String str = p_name;
if (str.begins_with("opentype_features/")) {
String name = str.get_slicec('/', 1);
int32_t tag = TS->name_to_tag(name);
double value = p_value;
if (value == -1) {
if (opentype_features.has(tag)) {
opentype_features.erase(tag);
dirty = true;
update();
}
} else {
if ((double)opentype_features[tag] != value) {
opentype_features[tag] = value;
dirty = true;
update();
}
}
_change_notify();
return true;
}
return false;
}
bool Label::_get(const StringName &p_name, Variant &r_ret) const {
String str = p_name;
if (str.begins_with("opentype_features/")) {
String name = str.get_slicec('/', 1);
int32_t tag = TS->name_to_tag(name);
if (opentype_features.has(tag)) {
r_ret = opentype_features[tag];
return true;
} else {
r_ret = -1;
return true;
}
}
return false;
}
void Label::_get_property_list(List<PropertyInfo> *p_list) const {
for (const Variant *ftr = opentype_features.next(nullptr); ftr != nullptr; ftr = opentype_features.next(ftr)) {
String name = TS->tag_to_name(*ftr);
p_list->push_back(PropertyInfo(Variant::FLOAT, "opentype_features/" + name));
}
p_list->push_back(PropertyInfo(Variant::NIL, "opentype_features/_new", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_EDITOR));
}
void Label::_bind_methods() {
@ -635,13 +641,20 @@ void Label::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_valign"), &Label::get_valign);
ClassDB::bind_method(D_METHOD("set_text", "text"), &Label::set_text);
ClassDB::bind_method(D_METHOD("get_text"), &Label::get_text);
ClassDB::bind_method(D_METHOD("set_text_direction", "direction"), &Label::set_text_direction);
ClassDB::bind_method(D_METHOD("get_text_direction"), &Label::get_text_direction);
ClassDB::bind_method(D_METHOD("set_opentype_feature", "tag", "value"), &Label::set_opentype_feature);
ClassDB::bind_method(D_METHOD("get_opentype_feature", "tag"), &Label::get_opentype_feature);
ClassDB::bind_method(D_METHOD("clear_opentype_features"), &Label::clear_opentype_features);
ClassDB::bind_method(D_METHOD("set_language", "language"), &Label::set_language);
ClassDB::bind_method(D_METHOD("get_language"), &Label::get_language);
ClassDB::bind_method(D_METHOD("set_autowrap", "enable"), &Label::set_autowrap);
ClassDB::bind_method(D_METHOD("has_autowrap"), &Label::has_autowrap);
ClassDB::bind_method(D_METHOD("set_clip_text", "enable"), &Label::set_clip_text);
ClassDB::bind_method(D_METHOD("is_clipping_text"), &Label::is_clipping_text);
ClassDB::bind_method(D_METHOD("set_uppercase", "enable"), &Label::set_uppercase);
ClassDB::bind_method(D_METHOD("is_uppercase"), &Label::is_uppercase);
ClassDB::bind_method(D_METHOD("get_line_height"), &Label::get_line_height);
ClassDB::bind_method(D_METHOD("get_line_height", "line"), &Label::get_line_height, DEFVAL(-1));
ClassDB::bind_method(D_METHOD("get_line_count"), &Label::get_line_count);
ClassDB::bind_method(D_METHOD("get_visible_line_count"), &Label::get_visible_line_count);
ClassDB::bind_method(D_METHOD("get_total_character_count"), &Label::get_total_character_count);
@ -653,6 +666,10 @@ void Label::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_lines_skipped"), &Label::get_lines_skipped);
ClassDB::bind_method(D_METHOD("set_max_lines_visible", "lines_visible"), &Label::set_max_lines_visible);
ClassDB::bind_method(D_METHOD("get_max_lines_visible"), &Label::get_max_lines_visible);
ClassDB::bind_method(D_METHOD("set_structured_text_bidi_override", "parser"), &Label::set_structured_text_bidi_override);
ClassDB::bind_method(D_METHOD("get_structured_text_bidi_override"), &Label::get_structured_text_bidi_override);
ClassDB::bind_method(D_METHOD("set_structured_text_bidi_override_options", "args"), &Label::set_structured_text_bidi_override_options);
ClassDB::bind_method(D_METHOD("get_structured_text_bidi_override_options"), &Label::get_structured_text_bidi_override_options);
BIND_ENUM_CONSTANT(ALIGN_LEFT);
BIND_ENUM_CONSTANT(ALIGN_CENTER);
@ -665,6 +682,8 @@ void Label::_bind_methods() {
BIND_ENUM_CONSTANT(VALIGN_FILL);
ADD_PROPERTY(PropertyInfo(Variant::STRING, "text", PROPERTY_HINT_MULTILINE_TEXT, "", PROPERTY_USAGE_DEFAULT_INTL), "set_text", "get_text");
ADD_PROPERTY(PropertyInfo(Variant::INT, "text_direction", PROPERTY_HINT_ENUM, "Auto,LTR,RTL,Inherited"), "set_text_direction", "get_text_direction");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "language"), "set_language", "get_language");
ADD_PROPERTY(PropertyInfo(Variant::INT, "align", PROPERTY_HINT_ENUM, "Left,Center,Right,Fill"), "set_align", "get_align");
ADD_PROPERTY(PropertyInfo(Variant::INT, "valign", PROPERTY_HINT_ENUM, "Top,Center,Bottom,Fill"), "set_valign", "get_valign");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "autowrap"), "set_autowrap", "has_autowrap");
@ -674,18 +693,23 @@ void Label::_bind_methods() {
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "percent_visible", PROPERTY_HINT_RANGE, "0,1,0.001"), "set_percent_visible", "get_percent_visible");
ADD_PROPERTY(PropertyInfo(Variant::INT, "lines_skipped", PROPERTY_HINT_RANGE, "0,999,1"), "set_lines_skipped", "get_lines_skipped");
ADD_PROPERTY(PropertyInfo(Variant::INT, "max_lines_visible", PROPERTY_HINT_RANGE, "-1,999,1"), "set_max_lines_visible", "get_max_lines_visible");
ADD_GROUP("Structured Text", "structured_text_");
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");
}
Label::Label(const String &p_text) {
text_rid = TS->create_shaped_text();
set_mouse_filter(MOUSE_FILTER_IGNORE);
set_text(p_text);
set_v_size_flags(SIZE_SHRINK_CENTER);
}
Label::~Label() {
while (word_cache) {
WordCache *current = word_cache;
word_cache = current->next;
memdelete(current);
for (int i = 0; i < lines_rid.size(); i++) {
TS->free(lines_rid[i]);
}
lines_rid.clear();
TS->free(text_rid);
}

54
scene/gui/label.h
View File

@ -59,39 +59,37 @@ private:
bool autowrap = false;
bool clip = false;
Size2 minsize;
int line_count = 0;
bool uppercase = false;
int get_longest_line_width() const;
bool lines_dirty = true;
bool dirty = true;
RID text_rid;
Vector<RID> lines_rid;
struct WordCache {
enum {
CHAR_NEWLINE = -1,
CHAR_WRAPLINE = -2
};
int char_pos = 0; // if -1, then newline
int word_len = 0;
int pixel_width = 0;
int space_count = 0;
WordCache *next = nullptr;
};
bool word_cache_dirty = true;
void regenerate_word_cache();
Dictionary opentype_features;
String language;
TextDirection text_direction = TEXT_DIRECTION_AUTO;
Control::StructuredTextParser st_parser = STRUCTURED_TEXT_DEFAULT;
Array st_args;
float percent_visible = 1;
WordCache *word_cache = nullptr;
int total_char_cache = 0;
int visible_chars = -1;
int lines_skipped = 0;
int max_lines_visible = -1;
void _update_visible();
void _shape();
protected:
void _notification(int p_what);
static void _bind_methods();
// bind helpers
bool _set(const StringName &p_name, const Variant &p_value);
bool _get(const StringName &p_name, Variant &r_ret) const;
void _get_property_list(List<PropertyInfo> *p_list) const;
public:
virtual Size2 get_minimum_size() const override;
@ -104,6 +102,22 @@ public:
void set_text(const String &p_string);
String get_text() const;
void set_text_direction(TextDirection p_text_direction);
TextDirection get_text_direction() const;
void set_opentype_feature(const String &p_name, int p_value);
int get_opentype_feature(const String &p_name) const;
void clear_opentype_features();
void set_language(const String &p_language);
String get_language() const;
void set_structured_text_bidi_override(Control::StructuredTextParser p_parser);
Control::StructuredTextParser get_structured_text_bidi_override() const;
void set_structured_text_bidi_override_options(Array p_args);
Array get_structured_text_bidi_override_options() const;
void set_autowrap(bool p_autowrap);
bool has_autowrap() const;
@ -126,7 +140,7 @@ public:
void set_max_lines_visible(int p_lines);
int get_max_lines_visible() const;
int get_line_height() const;
int get_line_height(int p_line = -1) const;
int get_line_count() const;
int get_visible_line_count() const;

1107
scene/gui/line_edit.cpp
View File

File diff suppressed because it is too large Load Diff

127
scene/gui/line_edit.h
View File

@ -53,41 +53,76 @@ public:
MENU_SELECT_ALL,
MENU_UNDO,
MENU_REDO,
MENU_DIR_INHERITED,
MENU_DIR_AUTO,
MENU_DIR_LTR,
MENU_DIR_RTL,
MENU_DISPLAY_UCC,
MENU_INSERT_LRM,
MENU_INSERT_RLM,
MENU_INSERT_LRE,
MENU_INSERT_RLE,
MENU_INSERT_LRO,
MENU_INSERT_RLO,
MENU_INSERT_PDF,
MENU_INSERT_ALM,
MENU_INSERT_LRI,
MENU_INSERT_RLI,
MENU_INSERT_FSI,
MENU_INSERT_PDI,
MENU_INSERT_ZWJ,
MENU_INSERT_ZWNJ,
MENU_INSERT_WJ,
MENU_INSERT_SHY,
MENU_MAX
};
private:
Align align;
Align align = ALIGN_LEFT;
bool editable;
bool pass;
bool text_changed_dirty;
bool editable = false;
bool pass = false;
bool text_changed_dirty = false;
String undo_text;
String text;
String placeholder;
String placeholder_translated;
String secret_character;
float placeholder_alpha;
String secret_character = "*";
float placeholder_alpha = 0.6;
String ime_text;
Point2 ime_selection;
bool selecting_enabled;
RID text_rid;
float full_width = 0;
bool context_menu_enabled;
PopupMenu *menu;
bool selecting_enabled = true;
int cursor_pos;
int scroll_offset;
int max_length; // 0 for no maximum.
bool context_menu_enabled = true;
PopupMenu *menu = nullptr;
PopupMenu *menu_dir = nullptr;
PopupMenu *menu_ctl = nullptr;
int cached_width;
int cached_placeholder_width;
bool mid_grapheme_caret_enabled = false;
bool clear_button_enabled;
int cursor_pos = 0;
int scroll_offset = 0;
int max_length = 0; // 0 for no maximum.
bool shortcut_keys_enabled;
Dictionary opentype_features;
String language;
TextDirection text_direction = TEXT_DIRECTION_AUTO;
TextDirection input_direction = TEXT_DIRECTION_LTR;
Control::StructuredTextParser st_parser = STRUCTURED_TEXT_DEFAULT;
Array st_args;
bool draw_control_chars = false;
bool expand_to_text_length = false;
bool window_has_focus = true;
bool clear_button_enabled = false;
bool shortcut_keys_enabled = true;
bool virtual_keyboard_enabled = true;
@ -110,13 +145,18 @@ private:
String text;
};
List<TextOperation> undo_stack;
List<TextOperation>::Element *undo_stack_pos;
List<TextOperation>::Element *undo_stack_pos = nullptr;
struct ClearButtonStatus {
bool press_attempt;
bool pressing_inside;
bool press_attempt = false;
bool pressing_inside = false;
} clear_button_status;
bool caret_blink_enabled = false;
bool caret_force_displayed = false;
bool draw_caret = true;
Timer *caret_blink_timer = nullptr;
bool _is_over_clear_button(const Point2 &p_pos) const;
void _clear_undo_stack();
@ -125,19 +165,10 @@ private:
void _generate_context_menu();
Timer *caret_blink_timer;
void _shape();
void _fit_to_width();
void _text_changed();
void _emit_text_change();
bool expand_to_text_length;
void update_cached_width();
void update_placeholder_width();
bool caret_blink_enabled;
bool caret_force_displayed;
bool draw_caret;
bool window_has_focus;
void shift_selection_check_pre(bool);
void shift_selection_check_post(bool);
@ -147,7 +178,7 @@ private:
int get_scroll_offset() const;
void set_cursor_at_pixel_pos(int p_x);
int get_cursor_pixel_pos();
Vector2i get_cursor_pixel_pos();
void _reset_caret_blink_timer();
void _toggle_draw_caret();
@ -163,6 +194,10 @@ private:
protected:
static void _bind_methods();
bool _set(const StringName &p_name, const Variant &p_value);
bool _get(const StringName &p_name, Variant &r_ret) const;
void _get_property_list(List<PropertyInfo> *p_list) const;
public:
void set_align(Align p_align);
Align get_align() const;
@ -185,19 +220,47 @@ public:
void delete_char();
void delete_text(int p_from_column, int p_to_column);
void set_text(String p_text);
String get_text() const;
void set_text_direction(TextDirection p_text_direction);
TextDirection get_text_direction() const;
void set_opentype_feature(const String &p_name, int p_value);
int get_opentype_feature(const String &p_name) const;
void clear_opentype_features();
void set_language(const String &p_language);
String get_language() const;
void set_draw_control_chars(bool p_draw_control_chars);
bool get_draw_control_chars() const;
void set_structured_text_bidi_override(Control::StructuredTextParser p_parser);
Control::StructuredTextParser get_structured_text_bidi_override() const;
void set_structured_text_bidi_override_options(Array p_args);
Array get_structured_text_bidi_override_options() const;
void set_placeholder(String p_text);
String get_placeholder() const;
void set_placeholder_alpha(float p_alpha);
float get_placeholder_alpha() const;
void set_cursor_position(int p_pos);
int get_cursor_position() const;
void set_max_length(int p_max_length);
int get_max_length() const;
void append_at_cursor(String p_text);
void clear();
void set_mid_grapheme_caret_enabled(const bool p_enabled);
bool get_mid_grapheme_caret_enabled() const;
bool cursor_get_blink_enabled() const;
void cursor_set_blink_enabled(const bool p_enabled);