123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703 |
- /*************************************************************************/
- /* label.cpp */
- /*************************************************************************/
- /* This file is part of: */
- /* GODOT ENGINE */
- /* https://godotengine.org */
- /*************************************************************************/
- /* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */
- /* Copyright (c) 2014-2017 Godot Engine contributors (cf. AUTHORS.md) */
- /* */
- /* 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 "label.h"
- #include "print_string.h"
- #include "project_settings.h"
- #include "translation.h"
- void Label::set_autowrap(bool p_autowrap) {
- autowrap = p_autowrap;
- word_cache_dirty = true;
- update();
- }
- bool Label::has_autowrap() const {
- return autowrap;
- }
- void Label::set_uppercase(bool p_uppercase) {
- uppercase = p_uppercase;
- word_cache_dirty = true;
- update();
- }
- bool Label::is_uppercase() const {
- return uppercase;
- }
- int Label::get_line_height() const {
- return get_font("font")->get_height();
- }
- void Label::_notification(int p_what) {
- if (p_what == NOTIFICATION_TRANSLATION_CHANGED) {
- String new_text = tr(text);
- if (new_text == xl_text)
- return; //nothing new
- xl_text = new_text;
- regenerate_word_cache();
- update();
- }
- if (p_what == NOTIFICATION_DRAW) {
- if (clip || autowrap) {
- VisualServer::get_singleton()->canvas_item_set_clip(get_canvas_item(), true);
- }
- if (word_cache_dirty)
- regenerate_word_cache();
- RID ci = get_canvas_item();
- Size2 string_size;
- Size2 size = get_size();
- Ref<StyleBox> style = get_stylebox("normal");
- Ref<Font> font = get_font("font");
- Color font_color = get_color("font_color");
- Color font_color_shadow = get_color("font_color_shadow");
- bool use_outline = get_constant("shadow_as_outline");
- Point2 shadow_ofs(get_constant("shadow_offset_x"), get_constant("shadow_offset_y"));
- int line_spacing = get_constant("line_spacing");
- style->draw(ci, Rect2(Point2(0, 0), get_size()));
- VisualServer::get_singleton()->canvas_item_set_distance_field_mode(get_canvas_item(), font.is_valid() && font->is_distance_field_hint());
- int font_h = font->get_height() + line_spacing;
- int lines_visible = (size.y + line_spacing) / font_h;
- int 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;
- }
- if (max_lines_visible >= 0 && lines_visible > max_lines_visible) {
- lines_visible = max_lines_visible;
- }
- if (lines_visible > 0) {
- switch (valign) {
- case VALIGN_TOP: {
- //nothing
- } break;
- case VALIGN_CENTER: {
- vbegin = (size.y - (lines_visible * font_h - line_spacing)) / 2;
- vsep = 0;
- } break;
- case VALIGN_BOTTOM: {
- vbegin = size.y - (lines_visible * font_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);
- } else {
- vsep = 0;
- }
- } break;
- }
- }
- WordCache *wc = word_cache;
- if (!wc)
- return;
- int line = 0;
- int line_to = lines_skipped + (lines_visible > 0 ? lines_visible : 1);
- 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 != from && to->space_count) {
- spaces += to->space_count;
- }
- to = to->next;
- }
- bool can_fill = to && to->char_pos == WordCache::CHAR_WRAPLINE;
- float x_ofs = 0;
- switch (align) {
- case ALIGN_FILL:
- case ALIGN_LEFT: {
- x_ofs = style->get_offset().x;
- } break;
- case ALIGN_CENTER: {
- x_ofs = int(size.width - (taken + spaces * space_w)) / 2;
- } break;
- case ALIGN_RIGHT: {
- x_ofs = int(size.width - style->get_margin(MARGIN_RIGHT) - (taken + spaces * space_w));
- } break;
- }
- int y_ofs = style->get_offset().y;
- y_ofs += (line - lines_skipped) * font_h + font->get_ascent();
- y_ofs += vbegin + line * vsep;
- 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);
- }
- }
- 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) {
- CharType c = xl_text[i + pos];
- CharType n = xl_text[i + pos + 1];
- if (uppercase) {
- c = String::char_uppercase(c);
- n = String::char_uppercase(c);
- }
- float move = font->draw_char(ci, Point2(x_ofs_shadow, y_ofs) + shadow_ofs, c, n, 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_color_shadow);
- font->draw_char(ci, Point2(x_ofs_shadow, y_ofs) + Vector2(shadow_ofs.x, -shadow_ofs.y), c, n, font_color_shadow);
- font->draw_char(ci, Point2(x_ofs_shadow, y_ofs) + Vector2(-shadow_ofs.x, -shadow_ofs.y), c, n, font_color_shadow);
- }
- x_ofs_shadow += move;
- chars_total_shadow++;
- }
- }
- }
- for (int i = 0; i < from->word_len; i++) {
- if (visible_chars < 0 || chars_total < visible_chars) {
- CharType c = xl_text[i + pos];
- CharType n = xl_text[i + pos + 1];
- if (uppercase) {
- c = String::char_uppercase(c);
- n = String::char_uppercase(c);
- }
- x_ofs += font->draw_char(ci, Point2(x_ofs, y_ofs), c, n, font_color);
- chars_total++;
- }
- }
- from = from->next;
- }
- wc = to ? to->next : 0;
- line++;
- }
- }
- if (p_what == NOTIFICATION_THEME_CHANGED) {
- word_cache_dirty = true;
- update();
- }
- if (p_what == NOTIFICATION_RESIZED) {
- word_cache_dirty = true;
- }
- }
- Size2 Label::get_minimum_size() const {
- Size2 min_style = get_stylebox("normal")->get_minimum_size();
- if (autowrap)
- return Size2(1, clip ? 1 : minsize.height) + min_style;
- else {
- // don't want to mutable everything
- if (word_cache_dirty)
- const_cast<Label *>(this)->regenerate_word_cache();
- Size2 ms = minsize;
- if (clip)
- ms.width = 1;
- return ms + min_style;
- }
- }
- int Label::get_longest_line_width() const {
- Ref<Font> font = get_font("font");
- int max_line_width = 0;
- int line_width = 0;
- for (int i = 0; i < xl_text.size(); i++) {
- CharType 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 {
- int 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;
- return 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();
- return line_count;
- }
- int Label::get_visible_line_count() const {
- int line_spacing = get_constant("line_spacing");
- int font_h = get_font("font")->get_height() + line_spacing;
- int lines_visible = (get_size().height - get_stylebox("normal")->get_minimum_size().height + line_spacing) / font_h;
- if (lines_visible > line_count)
- lines_visible = line_count;
- if (max_lines_visible >= 0 && lines_visible > max_lines_visible)
- lines_visible = max_lines_visible;
- return lines_visible;
- }
- void Label::regenerate_word_cache() {
- while (word_cache) {
- WordCache *current = word_cache;
- word_cache = current->next;
- memdelete(current);
- }
- Ref<StyleBox> style = get_stylebox("normal");
- int width = autowrap ? (get_size().width - style->get_minimum_size().width) : get_longest_line_width();
- Ref<Font> font = get_font("font");
- int current_word_size = 0;
- int word_pos = 0;
- int line_width = 0;
- int space_count = 0;
- int space_width = font->get_char_size(' ').width;
- int line_spacing = get_constant("line_spacing");
- line_count = 1;
- total_char_cache = 0;
- WordCache *last = NULL;
- for (int i = 0; i < xl_text.size() + 1; i++) {
- CharType current = i < xl_text.length() ? xl_text[i] : ' '; //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;
- int 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;
- }
- if (current == '\n') {
- insert_newline = true;
- } else {
- total_char_cache++;
- }
- if (i < xl_text.length() && xl_text[i] == ' ') {
- total_char_cache--; // do not count spaces
- if (line_width > 0 || last == NULL || 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++;
- }
- 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;
- space_count = 0;
- 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(p_align, 4);
- align = p_align;
- update();
- }
- Label::Align Label::get_align() const {
- return align;
- }
- void Label::set_valign(VAlign p_align) {
- ERR_FAIL_INDEX(p_align, 4);
- valign = p_align;
- update();
- }
- Label::VAlign Label::get_valign() const {
- return valign;
- }
- void Label::set_text(const String &p_string) {
- if (text == p_string)
- return;
- text = p_string;
- xl_text = tr(p_string);
- word_cache_dirty = true;
- if (percent_visible < 1)
- visible_chars = get_total_character_count() * percent_visible;
- update();
- }
- void Label::set_clip_text(bool p_clip) {
- clip = p_clip;
- update();
- minimum_size_changed();
- }
- bool Label::is_clipping_text() const {
- return clip;
- }
- String Label::get_text() const {
- return text;
- }
- 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;
- }
- update();
- }
- int Label::get_visible_characters() const {
- return visible_chars;
- }
- void Label::set_percent_visible(float p_percent) {
- if (p_percent < 0 || p_percent >= 1) {
- visible_chars = -1;
- percent_visible = 1;
- } else {
- visible_chars = get_total_character_count() * p_percent;
- percent_visible = p_percent;
- }
- update();
- }
- float Label::get_percent_visible() const {
- return percent_visible;
- }
- void Label::set_lines_skipped(int p_lines) {
- lines_skipped = p_lines;
- update();
- }
- int Label::get_lines_skipped() const {
- return lines_skipped;
- }
- void Label::set_max_lines_visible(int p_lines) {
- max_lines_visible = p_lines;
- update();
- }
- int Label::get_max_lines_visible() const {
- return max_lines_visible;
- }
- int Label::get_total_character_count() const {
- if (word_cache_dirty)
- const_cast<Label *>(this)->regenerate_word_cache();
- return total_char_cache;
- }
- void Label::_bind_methods() {
- ClassDB::bind_method(D_METHOD("set_align", "align"), &Label::set_align);
- ClassDB::bind_method(D_METHOD("get_align"), &Label::get_align);
- ClassDB::bind_method(D_METHOD("set_valign", "valign"), &Label::set_valign);
- 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_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_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);
- ClassDB::bind_method(D_METHOD("set_visible_characters", "amount"), &Label::set_visible_characters);
- ClassDB::bind_method(D_METHOD("get_visible_characters"), &Label::get_visible_characters);
- ClassDB::bind_method(D_METHOD("set_percent_visible", "percent_visible"), &Label::set_percent_visible);
- ClassDB::bind_method(D_METHOD("get_percent_visible"), &Label::get_percent_visible);
- ClassDB::bind_method(D_METHOD("set_lines_skipped", "lines_skipped"), &Label::set_lines_skipped);
- 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);
- BIND_ENUM_CONSTANT(ALIGN_LEFT);
- BIND_ENUM_CONSTANT(ALIGN_CENTER);
- BIND_ENUM_CONSTANT(ALIGN_RIGHT);
- BIND_ENUM_CONSTANT(ALIGN_FILL);
- BIND_ENUM_CONSTANT(VALIGN_TOP);
- BIND_ENUM_CONSTANT(VALIGN_CENTER);
- BIND_ENUM_CONSTANT(VALIGN_BOTTOM);
- BIND_ENUM_CONSTANT(VALIGN_FILL);
- ADD_PROPERTYNZ(PropertyInfo(Variant::STRING, "text", PROPERTY_HINT_MULTILINE_TEXT, "", PROPERTY_USAGE_DEFAULT_INTL), "set_text", "get_text");
- ADD_PROPERTYNZ(PropertyInfo(Variant::INT, "align", PROPERTY_HINT_ENUM, "Left,Center,Right,Fill"), "set_align", "get_align");
- ADD_PROPERTYNZ(PropertyInfo(Variant::INT, "valign", PROPERTY_HINT_ENUM, "Top,Center,Bottom,Fill"), "set_valign", "get_valign");
- ADD_PROPERTYNZ(PropertyInfo(Variant::BOOL, "autowrap"), "set_autowrap", "has_autowrap");
- ADD_PROPERTYNZ(PropertyInfo(Variant::BOOL, "clip_text"), "set_clip_text", "is_clipping_text");
- ADD_PROPERTYNZ(PropertyInfo(Variant::BOOL, "uppercase"), "set_uppercase", "is_uppercase");
- ADD_PROPERTY(PropertyInfo(Variant::REAL, "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");
- }
- Label::Label(const String &p_text) {
- align = ALIGN_LEFT;
- valign = VALIGN_TOP;
- xl_text = "";
- word_cache = NULL;
- word_cache_dirty = true;
- autowrap = false;
- line_count = 0;
- set_v_size_flags(0);
- clip = false;
- set_mouse_filter(MOUSE_FILTER_IGNORE);
- total_char_cache = 0;
- visible_chars = -1;
- percent_visible = 1;
- lines_skipped = 0;
- max_lines_visible = -1;
- set_text(p_text);
- uppercase = false;
- set_v_size_flags(SIZE_SHRINK_CENTER);
- }
- Label::~Label() {
- while (word_cache) {
- WordCache *current = word_cache;
- word_cache = current->next;
- memdelete(current);
- }
- }
|