-
-
Notifications
You must be signed in to change notification settings - Fork 21.4k
/
label.cpp
1383 lines (1225 loc) · 51.7 KB
/
label.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**************************************************************************/
/* label.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 "label.h"
#include "scene/gui/container.h"
#include "scene/theme/theme_db.h"
#include "servers/text_server.h"
void Label::set_autowrap_mode(TextServer::AutowrapMode p_mode) {
if (autowrap_mode == p_mode) {
return;
}
autowrap_mode = p_mode;
for (Paragraph ¶ : paragraphs) {
para.lines_dirty = true;
}
queue_redraw();
update_configuration_warnings();
if (clip || overrun_behavior != TextServer::OVERRUN_NO_TRIMMING) {
update_minimum_size();
}
}
TextServer::AutowrapMode Label::get_autowrap_mode() const {
return autowrap_mode;
}
void Label::set_justification_flags(BitField<TextServer::JustificationFlag> p_flags) {
if (jst_flags == p_flags) {
return;
}
jst_flags = p_flags;
for (Paragraph ¶ : paragraphs) {
para.lines_dirty = true;
}
queue_redraw();
}
BitField<TextServer::JustificationFlag> Label::get_justification_flags() const {
return jst_flags;
}
void Label::set_uppercase(bool p_uppercase) {
if (uppercase == p_uppercase) {
return;
}
uppercase = p_uppercase;
text_dirty = true;
queue_redraw();
}
bool Label::is_uppercase() const {
return uppercase;
}
int Label::get_line_height(int p_line) const {
Ref<Font> font = (settings.is_valid() && settings->get_font().is_valid()) ? settings->get_font() : theme_cache.font;
int font_size = settings.is_valid() ? settings->get_font_size() : theme_cache.font_size;
int font_h = font->get_height(font_size);
if (p_line >= 0 && p_line < total_line_count) {
return MAX(font_h, TS->shaped_text_get_size(get_line_rid(p_line)).y);
} else if (total_line_count > 0) {
int h = font_h;
for (const Paragraph ¶ : paragraphs) {
for (const RID &line_rid : para.lines_rid) {
h = MAX(h, TS->shaped_text_get_size(line_rid).y);
}
}
return h;
} else {
return font->get_height(font_size);
}
}
void Label::_shape() const {
Ref<StyleBox> style = theme_cache.normal_style;
int width = (get_size().width - style->get_minimum_size().width);
if (text_dirty) {
for (Paragraph ¶ : paragraphs) {
for (const RID &line_rid : para.lines_rid) {
TS->free_rid(line_rid);
}
para.lines_rid.clear();
TS->free_rid(para.text_rid);
}
paragraphs.clear();
String txt = (uppercase) ? TS->string_to_upper(xl_text, language) : xl_text;
if (visible_chars >= 0 && visible_chars_behavior == TextServer::VC_CHARS_BEFORE_SHAPING) {
txt = txt.substr(0, visible_chars);
}
String ps = paragraph_separator.c_unescape();
Vector<String> para_text = txt.split(ps);
int start = 0;
for (const String &str : para_text) {
Paragraph para;
para.text_rid = TS->create_shaped_text();
para.text = str;
para.start = start;
start += str.length() + ps.length();
paragraphs.push_back(para);
}
text_dirty = false;
}
total_line_count = 0;
for (Paragraph ¶ : paragraphs) {
if (para.dirty || font_dirty) {
if (para.dirty) {
TS->shaped_text_clear(para.text_rid);
}
if (text_direction == Control::TEXT_DIRECTION_INHERITED) {
TS->shaped_text_set_direction(para.text_rid, is_layout_rtl() ? TextServer::DIRECTION_RTL : TextServer::DIRECTION_LTR);
} else {
TS->shaped_text_set_direction(para.text_rid, (TextServer::Direction)text_direction);
}
const Ref<Font> &font = (settings.is_valid() && settings->get_font().is_valid()) ? settings->get_font() : theme_cache.font;
int font_size = settings.is_valid() ? settings->get_font_size() : theme_cache.font_size;
ERR_FAIL_COND(font.is_null());
if (para.dirty) {
TS->shaped_text_add_string(para.text_rid, para.text, font->get_rids(), font_size, font->get_opentype_features(), language);
} else {
int spans = TS->shaped_get_span_count(para.text_rid);
for (int i = 0; i < spans; i++) {
TS->shaped_set_span_update_font(para.text_rid, i, font->get_rids(), font_size, font->get_opentype_features());
}
}
TS->shaped_text_set_bidi_override(para.text_rid, structured_text_parser(st_parser, st_args, para.text));
if (!tab_stops.is_empty()) {
TS->shaped_text_tab_align(para.text_rid, tab_stops);
}
para.dirty = false;
para.lines_dirty = true;
}
if (para.lines_dirty) {
for (const RID &line_rid : para.lines_rid) {
TS->free_rid(line_rid);
}
para.lines_rid.clear();
BitField<TextServer::LineBreakFlag> autowrap_flags = TextServer::BREAK_MANDATORY;
switch (autowrap_mode) {
case TextServer::AUTOWRAP_WORD_SMART:
autowrap_flags = TextServer::BREAK_WORD_BOUND | TextServer::BREAK_ADAPTIVE | TextServer::BREAK_MANDATORY;
break;
case TextServer::AUTOWRAP_WORD:
autowrap_flags = TextServer::BREAK_WORD_BOUND | TextServer::BREAK_MANDATORY;
break;
case TextServer::AUTOWRAP_ARBITRARY:
autowrap_flags = TextServer::BREAK_GRAPHEME_BOUND | TextServer::BREAK_MANDATORY;
break;
case TextServer::AUTOWRAP_OFF:
break;
}
autowrap_flags = autowrap_flags | TextServer::BREAK_TRIM_EDGE_SPACES;
PackedInt32Array line_breaks = TS->shaped_text_get_line_breaks(para.text_rid, width, 0, autowrap_flags);
for (int i = 0; i < line_breaks.size(); i = i + 2) {
RID line = TS->shaped_text_substr(para.text_rid, line_breaks[i], line_breaks[i + 1] - line_breaks[i]);
if (!tab_stops.is_empty()) {
TS->shaped_text_tab_align(line, tab_stops);
}
para.lines_rid.push_back(line);
}
}
total_line_count += para.lines_rid.size();
}
dirty = false;
font_dirty = false;
if (xl_text.length() == 0) {
minsize = Size2(1, get_line_height());
return;
}
int visible_lines = get_visible_line_count();
bool lines_hidden = visible_lines > 0 && visible_lines < total_line_count;
int line_index = 0;
if (autowrap_mode == TextServer::AUTOWRAP_OFF) {
minsize.width = 0.0f;
}
for (Paragraph ¶ : paragraphs) {
if (autowrap_mode == TextServer::AUTOWRAP_OFF) {
for (const RID &line_rid : para.lines_rid) {
if (minsize.width < TS->shaped_text_get_size(line_rid).x) {
minsize.width = TS->shaped_text_get_size(line_rid).x;
}
}
}
if (para.lines_dirty) {
BitField<TextServer::TextOverrunFlag> overrun_flags = TextServer::OVERRUN_NO_TRIM;
switch (overrun_behavior) {
case TextServer::OVERRUN_TRIM_WORD_ELLIPSIS:
overrun_flags.set_flag(TextServer::OVERRUN_TRIM);
overrun_flags.set_flag(TextServer::OVERRUN_TRIM_WORD_ONLY);
overrun_flags.set_flag(TextServer::OVERRUN_ADD_ELLIPSIS);
break;
case TextServer::OVERRUN_TRIM_ELLIPSIS:
overrun_flags.set_flag(TextServer::OVERRUN_TRIM);
overrun_flags.set_flag(TextServer::OVERRUN_ADD_ELLIPSIS);
break;
case TextServer::OVERRUN_TRIM_WORD:
overrun_flags.set_flag(TextServer::OVERRUN_TRIM);
overrun_flags.set_flag(TextServer::OVERRUN_TRIM_WORD_ONLY);
break;
case TextServer::OVERRUN_TRIM_CHAR:
overrun_flags.set_flag(TextServer::OVERRUN_TRIM);
break;
case TextServer::OVERRUN_NO_TRIMMING:
break;
}
// Fill after min_size calculation.
BitField<TextServer::JustificationFlag> line_jst_flags = jst_flags;
if (!tab_stops.is_empty()) {
line_jst_flags.set_flag(TextServer::JUSTIFICATION_AFTER_LAST_TAB);
}
if (autowrap_mode != TextServer::AUTOWRAP_OFF) {
if (lines_hidden) {
overrun_flags.set_flag(TextServer::OVERRUN_ENFORCE_ELLIPSIS);
}
if (horizontal_alignment == HORIZONTAL_ALIGNMENT_FILL) {
int jst_to_line = para.lines_rid.size();
if (para.lines_rid.size() == 1 && line_jst_flags.has_flag(TextServer::JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE)) {
jst_to_line = para.lines_rid.size();
} else {
if (line_jst_flags.has_flag(TextServer::JUSTIFICATION_SKIP_LAST_LINE)) {
jst_to_line = para.lines_rid.size() - 1;
}
if (line_jst_flags.has_flag(TextServer::JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS)) {
for (int i = para.lines_rid.size() - 1; i >= 0; i--) {
if (TS->shaped_text_has_visible_chars(para.lines_rid[i])) {
jst_to_line = i;
break;
}
}
}
}
for (int i = 0; i < para.lines_rid.size(); i++) {
if (i < jst_to_line) {
TS->shaped_text_fit_to_width(para.lines_rid[i], width, line_jst_flags);
} else if (i == (visible_lines - line_index - 1)) {
TS->shaped_text_set_custom_ellipsis(para.lines_rid[i], (el_char.length() > 0) ? el_char[0] : 0x2026);
TS->shaped_text_overrun_trim_to_width(para.lines_rid[i], width, overrun_flags);
}
}
} else if (lines_hidden && (visible_lines - line_index - 1 >= 0) && (visible_lines - line_index - 1) < para.lines_rid.size()) {
TS->shaped_text_set_custom_ellipsis(para.lines_rid[visible_lines - line_index - 1], (el_char.length() > 0) ? el_char[0] : 0x2026);
TS->shaped_text_overrun_trim_to_width(para.lines_rid[visible_lines - line_index - 1], width, overrun_flags);
}
} else {
// Autowrap disabled.
int jst_to_line = para.lines_rid.size();
if (para.lines_rid.size() == 1 && line_jst_flags.has_flag(TextServer::JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE)) {
jst_to_line = para.lines_rid.size();
} else {
if (line_jst_flags.has_flag(TextServer::JUSTIFICATION_SKIP_LAST_LINE)) {
jst_to_line = para.lines_rid.size() - 1;
}
if (line_jst_flags.has_flag(TextServer::JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS)) {
for (int i = para.lines_rid.size() - 1; i >= 0; i--) {
if (TS->shaped_text_has_visible_chars(para.lines_rid[i])) {
jst_to_line = i;
break;
}
}
}
}
for (int i = 0; i < para.lines_rid.size(); i++) {
if (i < jst_to_line && horizontal_alignment == HORIZONTAL_ALIGNMENT_FILL) {
TS->shaped_text_fit_to_width(para.lines_rid[i], width, line_jst_flags);
overrun_flags.set_flag(TextServer::OVERRUN_JUSTIFICATION_AWARE);
TS->shaped_text_set_custom_ellipsis(para.lines_rid[i], (el_char.length() > 0) ? el_char[0] : 0x2026);
TS->shaped_text_overrun_trim_to_width(para.lines_rid[i], width, overrun_flags);
TS->shaped_text_fit_to_width(para.lines_rid[i], width, line_jst_flags | TextServer::JUSTIFICATION_CONSTRAIN_ELLIPSIS);
} else {
TS->shaped_text_set_custom_ellipsis(para.lines_rid[i], (el_char.length() > 0) ? el_char[0] : 0x2026);
TS->shaped_text_overrun_trim_to_width(para.lines_rid[i], width, overrun_flags);
}
}
}
para.lines_dirty = false;
}
line_index += para.lines_rid.size();
}
_update_visible();
if (autowrap_mode == TextServer::AUTOWRAP_OFF || !clip || overrun_behavior == TextServer::OVERRUN_NO_TRIMMING) {
const_cast<Label *>(this)->update_minimum_size();
}
}
void Label::_update_visible() const {
int line_spacing = settings.is_valid() ? settings->get_line_spacing() : theme_cache.line_spacing;
int paragraph_spacing = settings.is_valid() ? settings->get_paragraph_spacing() : theme_cache.paragraph_spacing;
Ref<StyleBox> style = theme_cache.normal_style;
Ref<Font> font = (settings.is_valid() && settings->get_font().is_valid()) ? settings->get_font() : theme_cache.font;
int font_size = settings.is_valid() ? settings->get_font_size() : theme_cache.font_size;
int font_h = font->get_height(font_size);
int lines_visible = total_line_count;
if (max_lines_visible >= 0 && lines_visible > max_lines_visible) {
lines_visible = max_lines_visible;
}
minsize.height = 0;
int last_line = MIN(total_line_count, lines_visible + lines_skipped);
int line_index = 0;
for (const Paragraph ¶ : paragraphs) {
if (line_index + para.lines_rid.size() <= lines_skipped) {
line_index += para.lines_rid.size();
} else {
int start = (line_index < lines_skipped) ? lines_skipped - line_index : 0;
int end = (line_index + para.lines_rid.size() < last_line) ? para.lines_rid.size() : last_line - line_index;
if (end <= 0) {
break;
}
for (int i = start; i < end; i++) {
minsize.height += MAX(font_h, TS->shaped_text_get_size(para.lines_rid[i]).y) + line_spacing;
}
minsize.height += paragraph_spacing;
line_index += para.lines_rid.size();
}
}
if (minsize.height > 0) {
minsize.height -= (line_spacing + paragraph_spacing);
}
}
inline void draw_glyph(const Glyph &p_gl, const RID &p_canvas, const Color &p_font_color, const Vector2 &p_ofs) {
if (p_gl.font_rid != RID()) {
TS->font_draw_glyph(p_gl.font_rid, p_canvas, p_gl.font_size, p_ofs + Vector2(p_gl.x_off, p_gl.y_off), p_gl.index, p_font_color);
} else {
TS->draw_hex_code_box(p_canvas, p_gl.font_size, p_ofs + Vector2(p_gl.x_off, p_gl.y_off), p_gl.index, p_font_color);
}
}
inline void draw_glyph_shadow(const Glyph &p_gl, const RID &p_canvas, const Color &p_font_shadow_color, int p_shadow_outline_size, const Vector2 &p_ofs, const Vector2 &shadow_ofs) {
if (p_gl.font_rid != RID()) {
if (p_font_shadow_color.a > 0) {
TS->font_draw_glyph(p_gl.font_rid, p_canvas, p_gl.font_size, p_ofs + Vector2(p_gl.x_off, p_gl.y_off) + shadow_ofs, p_gl.index, p_font_shadow_color);
}
if (p_font_shadow_color.a > 0 && p_shadow_outline_size > 0) {
TS->font_draw_glyph_outline(p_gl.font_rid, p_canvas, p_gl.font_size, p_shadow_outline_size, p_ofs + Vector2(p_gl.x_off, p_gl.y_off) + shadow_ofs, p_gl.index, p_font_shadow_color);
}
}
}
inline void draw_glyph_outline(const Glyph &p_gl, const RID &p_canvas, const Color &p_font_outline_color, int p_outline_size, const Vector2 &p_ofs) {
if (p_gl.font_rid != RID()) {
if (p_font_outline_color.a != 0.0 && p_outline_size > 0) {
TS->font_draw_glyph_outline(p_gl.font_rid, p_canvas, p_gl.font_size, p_outline_size, p_ofs + Vector2(p_gl.x_off, p_gl.y_off), p_gl.index, p_font_outline_color);
}
}
}
void Label::_ensure_shaped() const {
if (dirty || font_dirty || text_dirty) {
_shape();
} else {
for (const Paragraph ¶ : paragraphs) {
if (para.lines_dirty || para.dirty) {
_shape();
return;
}
}
}
}
RID Label::get_line_rid(int p_line) const {
if (p_line < 0 || p_line >= total_line_count) {
return RID();
}
int line_index = 0;
for (const Paragraph ¶ : paragraphs) {
if (line_index + para.lines_rid.size() <= p_line) {
line_index += para.lines_rid.size();
} else {
return para.lines_rid[p_line - line_index];
}
}
return RID();
}
Rect2 Label::get_line_rect(int p_line) const {
if (p_line < 0 || p_line >= total_line_count) {
return Rect2();
}
int line_index = 0;
for (int p = 0; p < paragraphs.size(); p++) {
const Paragraph ¶ = paragraphs[p];
if (line_index + para.lines_rid.size() <= p_line) {
line_index += para.lines_rid.size();
} else {
return _get_line_rect(p, p_line - line_index);
}
}
return Rect2();
}
Rect2 Label::_get_line_rect(int p_para, int p_line) const {
// Returns a rect providing the line's horizontal offset and total size. To determine the vertical
// offset, use r_offset and r_line_spacing from get_layout_data.
bool rtl = TS->shaped_text_get_inferred_direction(paragraphs[p_para].text_rid) == TextServer::DIRECTION_RTL;
bool rtl_layout = is_layout_rtl();
Ref<StyleBox> style = theme_cache.normal_style;
Ref<Font> font = (settings.is_valid() && settings->get_font().is_valid()) ? settings->get_font() : theme_cache.font;
int font_size = settings.is_valid() ? settings->get_font_size() : theme_cache.font_size;
int font_h = font->get_height(font_size);
Size2 size = get_size();
Size2 line_size = TS->shaped_text_get_size(paragraphs[p_para].lines_rid[p_line]);
line_size.y = MAX(font_h, line_size.y);
Vector2 offset;
switch (horizontal_alignment) {
case HORIZONTAL_ALIGNMENT_FILL:
if (rtl && autowrap_mode != TextServer::AUTOWRAP_OFF) {
offset.x = int(size.width - style->get_margin(SIDE_RIGHT) - line_size.width);
} else {
offset.x = style->get_offset().x;
}
break;
case HORIZONTAL_ALIGNMENT_LEFT: {
if (rtl_layout) {
offset.x = int(size.width - style->get_margin(SIDE_RIGHT) - line_size.width);
} else {
offset.x = style->get_offset().x;
}
} break;
case HORIZONTAL_ALIGNMENT_CENTER: {
offset.x = int(size.width - line_size.width) / 2;
} break;
case HORIZONTAL_ALIGNMENT_RIGHT: {
if (rtl_layout) {
offset.x = style->get_offset().x;
} else {
offset.x = int(size.width - style->get_margin(SIDE_RIGHT) - line_size.width);
}
} break;
}
return Rect2(offset, line_size);
}
int Label::get_layout_data(Vector2 &r_offset, int &r_last_line, int &r_line_spacing) const {
// Computes several common parameters involved in laying out and rendering text set to this label.
// Only vertical margin is considered in r_offset: use get_line_rect to get the horizontal offset
// for a given line of text.
Size2 size = get_size();
Ref<StyleBox> style = theme_cache.normal_style;
Ref<Font> font = (settings.is_valid() && settings->get_font().is_valid()) ? settings->get_font() : theme_cache.font;
int font_size = settings.is_valid() ? settings->get_font_size() : theme_cache.font_size;
int font_h = font->get_height(font_size);
int line_spacing = settings.is_valid() ? settings->get_line_spacing() : theme_cache.line_spacing;
int paragraph_spacing = settings.is_valid() ? settings->get_paragraph_spacing() : theme_cache.paragraph_spacing;
float total_h = 0.0;
int lines_visible = 0;
// Get number of lines to fit to the height.
int line_index = 0;
for (const Paragraph ¶ : paragraphs) {
if (line_index + para.lines_rid.size() <= lines_skipped) {
line_index += para.lines_rid.size();
} else {
int start = (line_index < lines_skipped) ? lines_skipped - line_index : 0;
for (int i = start; i < para.lines_rid.size(); i++) {
total_h += MAX(font_h, TS->shaped_text_get_size(para.lines_rid[i]).y) + line_spacing;
if (total_h > (get_size().height - style->get_minimum_size().height + line_spacing)) {
break;
}
lines_visible++;
}
total_h += paragraph_spacing;
line_index += para.lines_rid.size();
}
}
if (max_lines_visible >= 0 && lines_visible > max_lines_visible) {
lines_visible = max_lines_visible;
}
r_last_line = MIN(total_line_count, lines_visible + lines_skipped);
// Get real total height.
int total_glyphs = 0;
total_h = 0;
line_index = 0;
for (const Paragraph ¶ : paragraphs) {
if (line_index + para.lines_rid.size() <= lines_skipped) {
line_index += para.lines_rid.size();
} else {
int start = (line_index < lines_skipped) ? lines_skipped - line_index : 0;
int end = (line_index + para.lines_rid.size() < r_last_line) ? para.lines_rid.size() : r_last_line - line_index;
if (end <= 0) {
break;
}
for (int i = start; i < end; i++) {
total_h += MAX(font_h, TS->shaped_text_get_size(para.lines_rid[i]).y) + line_spacing;
total_glyphs += TS->shaped_text_get_glyph_count(para.lines_rid[i]) + TS->shaped_text_get_ellipsis_glyph_count(para.lines_rid[i]);
}
total_h += paragraph_spacing;
line_index += para.lines_rid.size();
}
}
total_h += style->get_margin(SIDE_TOP) + style->get_margin(SIDE_BOTTOM);
int vbegin = 0, vsep = 0;
if (lines_visible > 0) {
switch (vertical_alignment) {
case VERTICAL_ALIGNMENT_TOP: {
// Nothing.
} break;
case VERTICAL_ALIGNMENT_CENTER: {
vbegin = (size.y - (total_h - line_spacing - paragraph_spacing)) / 2;
vsep = 0;
} break;
case VERTICAL_ALIGNMENT_BOTTOM: {
vbegin = size.y - (total_h - line_spacing - paragraph_spacing);
vsep = 0;
} break;
case VERTICAL_ALIGNMENT_FILL: {
vbegin = 0;
if (lines_visible > 1) {
vsep = (size.y - (total_h - line_spacing - paragraph_spacing)) / (lines_visible - 1);
} else {
vsep = 0;
}
} break;
}
}
r_offset = { 0, style->get_offset().y + vbegin };
r_line_spacing = line_spacing + vsep;
return total_glyphs;
}
PackedStringArray Label::get_configuration_warnings() const {
PackedStringArray warnings = Control::get_configuration_warnings();
// FIXME: This is not ideal and the sizing model should be fixed,
// but for now we have to warn about this impossible to resolve combination.
// See GH-83546.
if (is_inside_tree() && get_tree()->get_edited_scene_root() != this) {
// If the Label happens to be the root node of the edited scene, we don't need
// to check what its parent is. It's going to be some node from the editor tree
// and it can be a container, but that makes no difference to the user.
Container *parent_container = Object::cast_to<Container>(get_parent_control());
if (parent_container && autowrap_mode != TextServer::AUTOWRAP_OFF && get_custom_minimum_size() == Size2()) {
warnings.push_back(RTR("Labels with autowrapping enabled must have a custom minimum size configured to work correctly inside a container."));
}
}
// Ensure that the font can render all of the required glyphs.
Ref<Font> font;
if (settings.is_valid()) {
font = settings->get_font();
}
if (font.is_null()) {
font = theme_cache.font;
}
if (font.is_valid()) {
_ensure_shaped();
for (const Paragraph ¶ : paragraphs) {
const Glyph *glyph = TS->shaped_text_get_glyphs(para.text_rid);
int64_t glyph_count = TS->shaped_text_get_glyph_count(para.text_rid);
for (int64_t i = 0; i < glyph_count; i++) {
if (glyph[i].font_rid == RID()) {
warnings.push_back(RTR("The current font does not support rendering one or more characters used in this Label's text."));
break;
}
}
}
}
return warnings;
}
void Label::_notification(int p_what) {
switch (p_what) {
case NOTIFICATION_TRANSLATION_CHANGED: {
String new_text = atr(text);
if (new_text == xl_text) {
return; // Nothing new.
}
xl_text = new_text;
if (visible_ratio < 1) {
visible_chars = get_total_character_count() * visible_ratio;
}
text_dirty = true;
queue_redraw();
update_configuration_warnings();
} break;
case NOTIFICATION_LAYOUT_DIRECTION_CHANGED: {
queue_redraw();
} break;
case NOTIFICATION_DRAW: {
if (clip) {
RenderingServer::get_singleton()->canvas_item_set_clip(get_canvas_item(), true);
}
// When a shaped text is invalidated by an external source, we want to reshape it.
for (Paragraph ¶ : paragraphs) {
if (!TS->shaped_text_is_ready(para.text_rid)) {
para.dirty = true;
}
for (const RID &line_rid : para.lines_rid) {
if (!TS->shaped_text_is_ready(line_rid)) {
para.lines_dirty = true;
break;
}
}
}
_ensure_shaped();
RID ci = get_canvas_item();
bool has_settings = settings.is_valid();
Size2 string_size;
Ref<StyleBox> style = theme_cache.normal_style;
Ref<Font> font = (settings.is_valid() && settings->get_font().is_valid()) ? settings->get_font() : theme_cache.font;
int font_size = settings.is_valid() ? settings->get_font_size() : theme_cache.font_size;
int font_h = font->get_height(font_size);
Color font_color = has_settings ? settings->get_font_color() : theme_cache.font_color;
Color font_shadow_color = has_settings ? settings->get_shadow_color() : theme_cache.font_shadow_color;
Point2 shadow_ofs = has_settings ? settings->get_shadow_offset() : theme_cache.font_shadow_offset;
int paragraph_spacing = has_settings ? settings->get_paragraph_spacing() : theme_cache.paragraph_spacing;
Color font_outline_color = has_settings ? settings->get_outline_color() : theme_cache.font_outline_color;
int outline_size = has_settings ? settings->get_outline_size() : theme_cache.font_outline_size;
int shadow_outline_size = has_settings ? settings->get_shadow_size() : theme_cache.font_shadow_outline_size;
bool rtl_layout = is_layout_rtl();
style->draw(ci, Rect2(Point2(0, 0), get_size()));
bool trim_chars = (visible_chars >= 0) && (visible_chars_behavior == TextServer::VC_CHARS_AFTER_SHAPING);
bool trim_glyphs_ltr = (visible_chars >= 0) && ((visible_chars_behavior == TextServer::VC_GLYPHS_LTR) || ((visible_chars_behavior == TextServer::VC_GLYPHS_AUTO) && !rtl_layout));
bool trim_glyphs_rtl = (visible_chars >= 0) && ((visible_chars_behavior == TextServer::VC_GLYPHS_RTL) || ((visible_chars_behavior == TextServer::VC_GLYPHS_AUTO) && rtl_layout));
Vector2 ofs;
int line_spacing;
int last_line;
int total_glyphs = get_layout_data(ofs, last_line, line_spacing);
int processed_glyphs = 0;
int visible_glyphs = total_glyphs * visible_ratio;
int line_index = 0;
for (int p = 0; p < paragraphs.size(); p++) {
const Paragraph ¶ = paragraphs[p];
if (line_index + para.lines_rid.size() <= lines_skipped) {
line_index += para.lines_rid.size();
} else {
int start = (line_index < lines_skipped) ? lines_skipped - line_index : 0;
int end = (line_index + para.lines_rid.size() < last_line) ? para.lines_rid.size() : last_line - line_index;
if (end <= 0) {
break;
}
bool rtl = (TS->shaped_text_get_inferred_direction(para.text_rid) == TextServer::DIRECTION_RTL);
for (int i = start; i < end; i++) {
RID line_rid = para.lines_rid[i];
Vector2 line_offset = _get_line_rect(p, i).position;
ofs.x = line_offset.x;
int asc = TS->shaped_text_get_ascent(line_rid);
int dsc = TS->shaped_text_get_descent(line_rid);
if (asc + dsc < font_h) {
dsc = font_h - asc;
}
const Glyph *glyphs = TS->shaped_text_get_glyphs(line_rid);
int gl_size = TS->shaped_text_get_glyph_count(line_rid);
int ellipsis_pos = TS->shaped_text_get_ellipsis_pos(line_rid);
int trim_pos = TS->shaped_text_get_trim_pos(line_rid);
const Glyph *ellipsis_glyphs = TS->shaped_text_get_ellipsis_glyphs(line_rid);
int ellipsis_gl_size = TS->shaped_text_get_ellipsis_glyph_count(line_rid);
ofs.y += asc;
// Draw shadow, outline and text. Note: Do not merge this into the single loop iteration, to prevent overlaps.
int processed_glyphs_step = 0;
for (int step = DRAW_STEP_SHADOW; step < DRAW_STEP_MAX; step++) {
if (step == DRAW_STEP_SHADOW && (font_shadow_color.a == 0)) {
continue;
}
if (step == DRAW_STEP_OUTLINE && (outline_size <= 0 || font_outline_color.a == 0)) {
continue;
}
processed_glyphs_step = processed_glyphs;
Vector2 offset_step = ofs;
// Draw RTL ellipsis string when necessary.
if (rtl && ellipsis_pos >= 0) {
for (int gl_idx = ellipsis_gl_size - 1; gl_idx >= 0; gl_idx--) {
for (int j = 0; j < ellipsis_glyphs[gl_idx].repeat; j++) {
bool skip = (trim_chars && ellipsis_glyphs[gl_idx].end + para.start > visible_chars) || (trim_glyphs_ltr && (processed_glyphs_step >= visible_glyphs)) || (trim_glyphs_rtl && (processed_glyphs_step < total_glyphs - visible_glyphs));
if (!skip) {
if (step == DRAW_STEP_SHADOW) {
draw_glyph_shadow(ellipsis_glyphs[gl_idx], ci, font_shadow_color, shadow_outline_size, offset_step, shadow_ofs);
} else if (step == DRAW_STEP_OUTLINE) {
draw_glyph_outline(ellipsis_glyphs[gl_idx], ci, font_outline_color, outline_size, offset_step);
} else if (step == DRAW_STEP_TEXT) {
draw_glyph(ellipsis_glyphs[gl_idx], ci, font_color, offset_step);
}
}
processed_glyphs_step++;
offset_step.x += ellipsis_glyphs[gl_idx].advance;
}
}
}
// Draw main text.
for (int j = 0; j < gl_size; j++) {
// Trim when necessary.
if (trim_pos >= 0) {
if (rtl) {
if (j < trim_pos) {
continue;
}
} else {
if (j >= trim_pos) {
break;
}
}
}
for (int k = 0; k < glyphs[j].repeat; k++) {
bool skip = (trim_chars && glyphs[j].end + para.start > visible_chars) || (trim_glyphs_ltr && (processed_glyphs_step >= visible_glyphs)) || (trim_glyphs_rtl && (processed_glyphs_step < total_glyphs - visible_glyphs));
if (!skip) {
if (step == DRAW_STEP_SHADOW) {
draw_glyph_shadow(glyphs[j], ci, font_shadow_color, shadow_outline_size, offset_step, shadow_ofs);
} else if (step == DRAW_STEP_OUTLINE) {
draw_glyph_outline(glyphs[j], ci, font_outline_color, outline_size, offset_step);
} else if (step == DRAW_STEP_TEXT) {
draw_glyph(glyphs[j], ci, font_color, offset_step);
}
}
processed_glyphs_step++;
offset_step.x += glyphs[j].advance;
}
}
// Draw LTR ellipsis string when necessary.
if (!rtl && ellipsis_pos >= 0) {
for (int gl_idx = 0; gl_idx < ellipsis_gl_size; gl_idx++) {
for (int j = 0; j < ellipsis_glyphs[gl_idx].repeat; j++) {
bool skip = (trim_chars && ellipsis_glyphs[gl_idx].end + para.start > visible_chars) || (trim_glyphs_ltr && (processed_glyphs_step >= visible_glyphs)) || (trim_glyphs_rtl && (processed_glyphs_step < total_glyphs - visible_glyphs));
if (!skip) {
if (step == DRAW_STEP_SHADOW) {
draw_glyph_shadow(ellipsis_glyphs[gl_idx], ci, font_shadow_color, shadow_outline_size, offset_step, shadow_ofs);
} else if (step == DRAW_STEP_OUTLINE) {
draw_glyph_outline(ellipsis_glyphs[gl_idx], ci, font_outline_color, outline_size, offset_step);
} else if (step == DRAW_STEP_TEXT) {
draw_glyph(ellipsis_glyphs[gl_idx], ci, font_color, offset_step);
}
}
processed_glyphs_step++;
offset_step.x += ellipsis_glyphs[gl_idx].advance;
}
}
}
}
processed_glyphs = processed_glyphs_step;
ofs.y += dsc + line_spacing;
}
ofs.y += paragraph_spacing;
line_index += para.lines_rid.size();
}
}
} break;
case NOTIFICATION_THEME_CHANGED: {
font_dirty = true;
queue_redraw();
} break;
case NOTIFICATION_RESIZED: {
for (Paragraph ¶ : paragraphs) {
para.lines_dirty = true;
}
} break;
}
}
Rect2 Label::get_character_bounds(int p_pos) const {
_ensure_shaped();
int paragraph_spacing = settings.is_valid() ? settings->get_paragraph_spacing() : theme_cache.paragraph_spacing;
Ref<Font> font = (settings.is_valid() && settings->get_font().is_valid()) ? settings->get_font() : theme_cache.font;
int font_size = settings.is_valid() ? settings->get_font_size() : theme_cache.font_size;
int font_h = font->get_height(font_size);
Vector2 ofs;
int line_spacing;
int last_line;
get_layout_data(ofs, last_line, line_spacing);
int line_index = 0;
for (int p = 0; p < paragraphs.size(); p++) {
const Paragraph ¶ = paragraphs[p];
if (line_index + para.lines_rid.size() <= lines_skipped) {
line_index += para.lines_rid.size();
} else {
int start = (line_index < lines_skipped) ? lines_skipped - line_index : 0;
int end = (line_index + para.lines_rid.size() < last_line) ? para.lines_rid.size() : last_line - line_index;
if (end <= 0) {
break;
}
for (int i = start; i < end; i++) {
RID line_rid = para.lines_rid[i];
Rect2 line_rect = _get_line_rect(p, i);
ofs.x = line_rect.position.x;
int v_size = TS->shaped_text_get_glyph_count(line_rid);
const Glyph *glyphs = TS->shaped_text_get_glyphs(line_rid);
float gl_off = 0.0f;
for (int j = 0; j < v_size; j++) {
if ((glyphs[j].count > 0) && ((glyphs[j].index != 0) || ((glyphs[j].flags & TextServer::GRAPHEME_IS_SPACE) == TextServer::GRAPHEME_IS_SPACE))) {
if (p_pos >= glyphs[j].start + para.start && p_pos < glyphs[j].end + para.start) {
float advance = 0.f;
for (int k = 0; k < glyphs[j].count; k++) {
advance += glyphs[j + k].advance;
}
Rect2 rect;
rect.position = ofs + Vector2(gl_off, 0);
rect.size = Vector2(advance, line_rect.size.y);
return rect;
}
}
gl_off += glyphs[j].advance * glyphs[j].repeat;
}
ofs.y += MAX(font_h, TS->shaped_text_get_ascent(line_rid) + TS->shaped_text_get_descent(line_rid)) + line_spacing;
}
ofs.y += paragraph_spacing;
line_index += para.lines_rid.size();
}
}
return Rect2();
}
Size2 Label::get_minimum_size() const {
_ensure_shaped();
Size2 min_size = minsize;
const Ref<Font> &font = (settings.is_valid() && settings->get_font().is_valid()) ? settings->get_font() : theme_cache.font;
int font_size = settings.is_valid() ? settings->get_font_size() : theme_cache.font_size;
min_size.height = MAX(min_size.height, font->get_height(font_size) + font->get_spacing(TextServer::SPACING_TOP) + font->get_spacing(TextServer::SPACING_BOTTOM));
Size2 min_style = theme_cache.normal_style->get_minimum_size();
if (autowrap_mode != TextServer::AUTOWRAP_OFF) {
return Size2(1, (clip || overrun_behavior != TextServer::OVERRUN_NO_TRIMMING) ? 1 : min_size.height) + min_style;
} else {
if (clip || overrun_behavior != TextServer::OVERRUN_NO_TRIMMING) {
min_size.width = 1;
}
return min_size + min_style;
}
}
#ifndef DISABLE_DEPRECATED
bool Label::_set(const StringName &p_name, const Variant &p_value) {
if (p_name == SNAME("valign")) {
set_vertical_alignment((VerticalAlignment)p_value.operator int());
return true;
} else if (p_name == SNAME("align")) {
set_horizontal_alignment((HorizontalAlignment)p_value.operator int());
return true;
}
return false;
}
#endif
int Label::get_line_count() const {
if (!is_inside_tree()) {
return 1;
}
_ensure_shaped();
return total_line_count;
}
int Label::get_visible_line_count() const {
Ref<StyleBox> style = theme_cache.normal_style;
Ref<Font> font = (settings.is_valid() && settings->get_font().is_valid()) ? settings->get_font() : theme_cache.font;
int font_size = settings.is_valid() ? settings->get_font_size() : theme_cache.font_size;
int font_h = font->get_height(font_size);
int line_spacing = settings.is_valid() ? settings->get_line_spacing() : theme_cache.line_spacing;
int paragraph_spacing = settings.is_valid() ? settings->get_paragraph_spacing() : theme_cache.paragraph_spacing;
int lines_visible = 0;
float total_h = 0.0;
int line_index = 0;
for (const Paragraph ¶ : paragraphs) {
if (line_index + para.lines_rid.size() <= lines_skipped) {
line_index += para.lines_rid.size();
} else {
int start = (line_index < lines_skipped) ? lines_skipped - line_index : 0;
for (int i = start; i < para.lines_rid.size(); i++) {
total_h += MAX(font_h, TS->shaped_text_get_size(para.lines_rid[i]).y) + line_spacing;
if (total_h > (get_size().height - style->get_minimum_size().height + line_spacing)) {
break;
}
lines_visible++;
}
total_h += paragraph_spacing;
line_index += para.lines_rid.size();
}
}
if (max_lines_visible >= 0 && lines_visible > max_lines_visible) {
lines_visible = max_lines_visible;
}
return lines_visible;
}
void Label::set_horizontal_alignment(HorizontalAlignment p_alignment) {
ERR_FAIL_INDEX((int)p_alignment, 4);
if (horizontal_alignment == p_alignment) {
return;
}
if (horizontal_alignment == HORIZONTAL_ALIGNMENT_FILL || p_alignment == HORIZONTAL_ALIGNMENT_FILL) {
for (Paragraph ¶ : paragraphs) {
para.lines_dirty = true; // Reshape lines.
}
}
horizontal_alignment = p_alignment;
queue_redraw();
}
HorizontalAlignment Label::get_horizontal_alignment() const {
return horizontal_alignment;
}
void Label::set_vertical_alignment(VerticalAlignment p_alignment) {
ERR_FAIL_INDEX((int)p_alignment, 4);
if (vertical_alignment == p_alignment) {
return;
}
vertical_alignment = p_alignment;
queue_redraw();
}
VerticalAlignment Label::get_vertical_alignment() const {
return vertical_alignment;
}