1/**************************************************************************/
2/* text_server.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef TEXT_SERVER_H
32#define TEXT_SERVER_H
33
34#include "core/object/ref_counted.h"
35#include "core/os/os.h"
36#include "core/templates/rid.h"
37#include "core/variant/native_ptr.h"
38#include "core/variant/variant.h"
39
40template <typename T>
41class TypedArray;
42
43struct Glyph;
44struct CaretInfo;
45
46class TextServer : public RefCounted {
47 GDCLASS(TextServer, RefCounted);
48
49public:
50 enum FontAntialiasing {
51 FONT_ANTIALIASING_NONE,
52 FONT_ANTIALIASING_GRAY,
53 FONT_ANTIALIASING_LCD,
54 };
55
56 enum FontLCDSubpixelLayout {
57 FONT_LCD_SUBPIXEL_LAYOUT_NONE,
58 FONT_LCD_SUBPIXEL_LAYOUT_HRGB,
59 FONT_LCD_SUBPIXEL_LAYOUT_HBGR,
60 FONT_LCD_SUBPIXEL_LAYOUT_VRGB,
61 FONT_LCD_SUBPIXEL_LAYOUT_VBGR,
62 FONT_LCD_SUBPIXEL_LAYOUT_MAX,
63 };
64
65 enum Direction {
66 DIRECTION_AUTO,
67 DIRECTION_LTR,
68 DIRECTION_RTL,
69 DIRECTION_INHERITED,
70 };
71
72 enum Orientation {
73 ORIENTATION_HORIZONTAL,
74 ORIENTATION_VERTICAL
75 };
76
77 enum JustificationFlag {
78 JUSTIFICATION_NONE = 0,
79 JUSTIFICATION_KASHIDA = 1 << 0,
80 JUSTIFICATION_WORD_BOUND = 1 << 1,
81 JUSTIFICATION_TRIM_EDGE_SPACES = 1 << 2,
82 JUSTIFICATION_AFTER_LAST_TAB = 1 << 3,
83 JUSTIFICATION_CONSTRAIN_ELLIPSIS = 1 << 4,
84 JUSTIFICATION_SKIP_LAST_LINE = 1 << 5,
85 JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS = 1 << 6,
86 JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE = 1 << 7,
87 };
88
89 enum VisibleCharactersBehavior {
90 VC_CHARS_BEFORE_SHAPING,
91 VC_CHARS_AFTER_SHAPING,
92 VC_GLYPHS_AUTO,
93 VC_GLYPHS_LTR,
94 VC_GLYPHS_RTL,
95 };
96
97 enum AutowrapMode {
98 AUTOWRAP_OFF,
99 AUTOWRAP_ARBITRARY,
100 AUTOWRAP_WORD,
101 AUTOWRAP_WORD_SMART
102 };
103
104 enum LineBreakFlag {
105 BREAK_NONE = 0,
106 BREAK_MANDATORY = 1 << 0,
107 BREAK_WORD_BOUND = 1 << 1,
108 BREAK_GRAPHEME_BOUND = 1 << 2,
109 BREAK_ADAPTIVE = 1 << 3,
110 BREAK_TRIM_EDGE_SPACES = 1 << 4,
111 };
112
113 enum OverrunBehavior {
114 OVERRUN_NO_TRIMMING,
115 OVERRUN_TRIM_CHAR,
116 OVERRUN_TRIM_WORD,
117 OVERRUN_TRIM_ELLIPSIS,
118 OVERRUN_TRIM_WORD_ELLIPSIS,
119 };
120
121 enum TextOverrunFlag {
122 OVERRUN_NO_TRIM = 0,
123 OVERRUN_TRIM = 1 << 0,
124 OVERRUN_TRIM_WORD_ONLY = 1 << 1,
125 OVERRUN_ADD_ELLIPSIS = 1 << 2,
126 OVERRUN_ENFORCE_ELLIPSIS = 1 << 3,
127 OVERRUN_JUSTIFICATION_AWARE = 1 << 4,
128 };
129
130 enum GraphemeFlag {
131 GRAPHEME_IS_VALID = 1 << 0, // Grapheme is valid.
132 GRAPHEME_IS_RTL = 1 << 1, // Grapheme is right-to-left.
133 GRAPHEME_IS_VIRTUAL = 1 << 2, // Grapheme is not part of source string (added by fit_to_width function, do not affect caret movement).
134 GRAPHEME_IS_SPACE = 1 << 3, // Is whitespace (for justification and word breaks).
135 GRAPHEME_IS_BREAK_HARD = 1 << 4, // Is line break (mandatory break, e.g. "\n").
136 GRAPHEME_IS_BREAK_SOFT = 1 << 5, // Is line break (optional break, e.g. space).
137 GRAPHEME_IS_TAB = 1 << 6, // Is tab or vertical tab.
138 GRAPHEME_IS_ELONGATION = 1 << 7, // Elongation (e.g. kashida), grapheme can be duplicated or truncated to fit line to width.
139 GRAPHEME_IS_PUNCTUATION = 1 << 8, // Punctuation, except underscore (can be used as word break, but not line break or justifiction).
140 GRAPHEME_IS_UNDERSCORE = 1 << 9, // Underscore (can be used as word break).
141 GRAPHEME_IS_CONNECTED = 1 << 10, // Connected to previous grapheme.
142 GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL = 1 << 11, // It is safe to insert a U+0640 before this grapheme for elongation.
143 GRAPHEME_IS_EMBEDDED_OBJECT = 1 << 12, // Grapheme is an object replacement character for the embedded object.
144 };
145
146 enum Hinting {
147 HINTING_NONE,
148 HINTING_LIGHT,
149 HINTING_NORMAL
150 };
151
152 enum SubpixelPositioning {
153 SUBPIXEL_POSITIONING_DISABLED = 0,
154 SUBPIXEL_POSITIONING_AUTO = 1,
155 SUBPIXEL_POSITIONING_ONE_HALF = 2,
156 SUBPIXEL_POSITIONING_ONE_QUARTER = 3,
157
158 SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE = 20,
159 SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE = 16,
160 };
161
162 enum Feature {
163 FEATURE_SIMPLE_LAYOUT = 1 << 0,
164 FEATURE_BIDI_LAYOUT = 1 << 1,
165 FEATURE_VERTICAL_LAYOUT = 1 << 2,
166 FEATURE_SHAPING = 1 << 3,
167 FEATURE_KASHIDA_JUSTIFICATION = 1 << 4,
168 FEATURE_BREAK_ITERATORS = 1 << 5,
169 FEATURE_FONT_BITMAP = 1 << 6,
170 FEATURE_FONT_DYNAMIC = 1 << 7,
171 FEATURE_FONT_MSDF = 1 << 8,
172 FEATURE_FONT_SYSTEM = 1 << 9,
173 FEATURE_FONT_VARIABLE = 1 << 10,
174 FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION = 1 << 11,
175 FEATURE_USE_SUPPORT_DATA = 1 << 12,
176 FEATURE_UNICODE_IDENTIFIERS = 1 << 13,
177 FEATURE_UNICODE_SECURITY = 1 << 14,
178 };
179
180 enum ContourPointTag {
181 CONTOUR_CURVE_TAG_ON = 0x01,
182 CONTOUR_CURVE_TAG_OFF_CONIC = 0x00,
183 CONTOUR_CURVE_TAG_OFF_CUBIC = 0x02
184 };
185
186 enum SpacingType {
187 SPACING_GLYPH,
188 SPACING_SPACE,
189 SPACING_TOP,
190 SPACING_BOTTOM,
191 SPACING_MAX,
192 };
193
194 enum FontStyle {
195 FONT_BOLD = 1 << 0,
196 FONT_ITALIC = 1 << 1,
197 FONT_FIXED_WIDTH = 1 << 2,
198 };
199
200 enum StructuredTextParser {
201 STRUCTURED_TEXT_DEFAULT,
202 STRUCTURED_TEXT_URI,
203 STRUCTURED_TEXT_FILE,
204 STRUCTURED_TEXT_EMAIL,
205 STRUCTURED_TEXT_LIST,
206 STRUCTURED_TEXT_GDSCRIPT,
207 STRUCTURED_TEXT_CUSTOM
208 };
209
210 void _draw_hex_code_box_number(const RID &p_canvas, int64_t p_size, const Vector2 &p_pos, uint8_t p_index, const Color &p_color) const;
211
212protected:
213 HashMap<char32_t, char32_t> diacritics_map;
214 void _diacritics_map_add(const String &p_from, char32_t p_to);
215 void _init_diacritics_map();
216
217 static void _bind_methods();
218
219public:
220 virtual bool has_feature(Feature p_feature) const = 0;
221 virtual String get_name() const = 0;
222 virtual int64_t get_features() const = 0;
223
224 virtual void free_rid(const RID &p_rid) = 0;
225 virtual bool has(const RID &p_rid) = 0;
226 virtual bool load_support_data(const String &p_filename) = 0;
227
228 virtual String get_support_data_filename() const = 0;
229 virtual String get_support_data_info() const = 0;
230 virtual bool save_support_data(const String &p_filename) const = 0;
231
232 virtual bool is_locale_right_to_left(const String &p_locale) const = 0;
233
234 virtual int64_t name_to_tag(const String &p_name) const { return 0; };
235 virtual String tag_to_name(int64_t p_tag) const { return ""; };
236
237 /* Font interface */
238
239 virtual RID create_font() = 0;
240
241 virtual void font_set_data(const RID &p_font_rid, const PackedByteArray &p_data) = 0;
242 virtual void font_set_data_ptr(const RID &p_font_rid, const uint8_t *p_data_ptr, int64_t p_data_size) = 0;
243
244 virtual void font_set_face_index(const RID &p_font_rid, int64_t p_index) = 0;
245 virtual int64_t font_get_face_index(const RID &p_font_rid) const = 0;
246
247 virtual int64_t font_get_face_count(const RID &p_font_rid) const = 0;
248
249 virtual void font_set_style(const RID &p_font_rid, BitField<FontStyle> p_style) = 0;
250 virtual BitField<FontStyle> font_get_style(const RID &p_font_rid) const = 0;
251
252 virtual void font_set_name(const RID &p_font_rid, const String &p_name) = 0;
253 virtual String font_get_name(const RID &p_font_rid) const = 0;
254 virtual Dictionary font_get_ot_name_strings(const RID &p_font_rid) const { return Dictionary(); }
255
256 virtual void font_set_style_name(const RID &p_font_rid, const String &p_name) = 0;
257 virtual String font_get_style_name(const RID &p_font_rid) const = 0;
258
259 virtual void font_set_weight(const RID &p_font_rid, int64_t p_weight) = 0;
260 virtual int64_t font_get_weight(const RID &p_font_rid) const = 0;
261
262 virtual void font_set_stretch(const RID &p_font_rid, int64_t p_stretch) = 0;
263 virtual int64_t font_get_stretch(const RID &p_font_rid) const = 0;
264
265 virtual void font_set_antialiasing(const RID &p_font_rid, FontAntialiasing p_antialiasing) = 0;
266 virtual FontAntialiasing font_get_antialiasing(const RID &p_font_rid) const = 0;
267
268 virtual void font_set_generate_mipmaps(const RID &p_font_rid, bool p_generate_mipmaps) = 0;
269 virtual bool font_get_generate_mipmaps(const RID &p_font_rid) const = 0;
270
271 virtual void font_set_multichannel_signed_distance_field(const RID &p_font_rid, bool p_msdf) = 0;
272 virtual bool font_is_multichannel_signed_distance_field(const RID &p_font_rid) const = 0;
273
274 virtual void font_set_msdf_pixel_range(const RID &p_font_rid, int64_t p_msdf_pixel_range) = 0;
275 virtual int64_t font_get_msdf_pixel_range(const RID &p_font_rid) const = 0;
276
277 virtual void font_set_msdf_size(const RID &p_font_rid, int64_t p_msdf_size) = 0;
278 virtual int64_t font_get_msdf_size(const RID &p_font_rid) const = 0;
279
280 virtual void font_set_fixed_size(const RID &p_font_rid, int64_t p_fixed_size) = 0;
281 virtual int64_t font_get_fixed_size(const RID &p_font_rid) const = 0;
282
283 virtual void font_set_allow_system_fallback(const RID &p_font_rid, bool p_allow_system_fallback) = 0;
284 virtual bool font_is_allow_system_fallback(const RID &p_font_rid) const = 0;
285
286 virtual void font_set_force_autohinter(const RID &p_font_rid, bool p_force_autohinter) = 0;
287 virtual bool font_is_force_autohinter(const RID &p_font_rid) const = 0;
288
289 virtual void font_set_hinting(const RID &p_font_rid, Hinting p_hinting) = 0;
290 virtual Hinting font_get_hinting(const RID &p_font_rid) const = 0;
291
292 virtual void font_set_subpixel_positioning(const RID &p_font_rid, SubpixelPositioning p_subpixel) = 0;
293 virtual SubpixelPositioning font_get_subpixel_positioning(const RID &p_font_rid) const = 0;
294
295 virtual void font_set_embolden(const RID &p_font_rid, double p_strength) = 0;
296 virtual double font_get_embolden(const RID &p_font_rid) const = 0;
297
298 virtual void font_set_spacing(const RID &p_font_rid, SpacingType p_spacing, int64_t p_value) = 0;
299 virtual int64_t font_get_spacing(const RID &p_font_rid, SpacingType p_spacing) const = 0;
300
301 virtual void font_set_transform(const RID &p_font_rid, const Transform2D &p_transform) = 0;
302 virtual Transform2D font_get_transform(const RID &p_font_rid) const = 0;
303
304 virtual void font_set_variation_coordinates(const RID &p_font_rid, const Dictionary &p_variation_coordinates) = 0;
305 virtual Dictionary font_get_variation_coordinates(const RID &p_font_rid) const = 0;
306
307 virtual void font_set_oversampling(const RID &p_font_rid, double p_oversampling) = 0;
308 virtual double font_get_oversampling(const RID &p_font_rid) const = 0;
309
310 virtual TypedArray<Vector2i> font_get_size_cache_list(const RID &p_font_rid) const = 0;
311 virtual void font_clear_size_cache(const RID &p_font_rid) = 0;
312 virtual void font_remove_size_cache(const RID &p_font_rid, const Vector2i &p_size) = 0;
313
314 virtual void font_set_ascent(const RID &p_font_rid, int64_t p_size, double p_ascent) = 0;
315 virtual double font_get_ascent(const RID &p_font_rid, int64_t p_size) const = 0;
316
317 virtual void font_set_descent(const RID &p_font_rid, int64_t p_size, double p_descent) = 0;
318 virtual double font_get_descent(const RID &p_font_rid, int64_t p_size) const = 0;
319
320 virtual void font_set_underline_position(const RID &p_font_rid, int64_t p_size, double p_underline_position) = 0;
321 virtual double font_get_underline_position(const RID &p_font_rid, int64_t p_size) const = 0;
322
323 virtual void font_set_underline_thickness(const RID &p_font_rid, int64_t p_size, double p_underline_thickness) = 0;
324 virtual double font_get_underline_thickness(const RID &p_font_rid, int64_t p_size) const = 0;
325
326 virtual void font_set_scale(const RID &p_font_rid, int64_t p_size, double p_scale) = 0;
327 virtual double font_get_scale(const RID &p_font_rid, int64_t p_size) const = 0;
328
329 virtual int64_t font_get_texture_count(const RID &p_font_rid, const Vector2i &p_size) const = 0;
330 virtual void font_clear_textures(const RID &p_font_rid, const Vector2i &p_size) = 0;
331 virtual void font_remove_texture(const RID &p_font_rid, const Vector2i &p_size, int64_t p_texture_index) = 0;
332
333 virtual void font_set_texture_image(const RID &p_font_rid, const Vector2i &p_size, int64_t p_texture_index, const Ref<Image> &p_image) = 0;
334 virtual Ref<Image> font_get_texture_image(const RID &p_font_rid, const Vector2i &p_size, int64_t p_texture_index) const = 0;
335
336 virtual void font_set_texture_offsets(const RID &p_font_rid, const Vector2i &p_size, int64_t p_texture_index, const PackedInt32Array &p_offset) = 0;
337 virtual PackedInt32Array font_get_texture_offsets(const RID &p_font_rid, const Vector2i &p_size, int64_t p_texture_index) const = 0;
338
339 virtual PackedInt32Array font_get_glyph_list(const RID &p_font_rid, const Vector2i &p_size) const = 0;
340 virtual void font_clear_glyphs(const RID &p_font_rid, const Vector2i &p_size) = 0;
341 virtual void font_remove_glyph(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) = 0;
342
343 virtual Vector2 font_get_glyph_advance(const RID &p_font_rid, int64_t p_size, int64_t p_glyph) const = 0;
344 virtual void font_set_glyph_advance(const RID &p_font_rid, int64_t p_size, int64_t p_glyph, const Vector2 &p_advance) = 0;
345
346 virtual Vector2 font_get_glyph_offset(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
347 virtual void font_set_glyph_offset(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph, const Vector2 &p_offset) = 0;
348
349 virtual Vector2 font_get_glyph_size(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
350 virtual void font_set_glyph_size(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph, const Vector2 &p_gl_size) = 0;
351
352 virtual Rect2 font_get_glyph_uv_rect(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
353 virtual void font_set_glyph_uv_rect(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph, const Rect2 &p_uv_rect) = 0;
354
355 virtual int64_t font_get_glyph_texture_idx(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
356 virtual void font_set_glyph_texture_idx(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph, int64_t p_texture_idx) = 0;
357 virtual RID font_get_glyph_texture_rid(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
358 virtual Size2 font_get_glyph_texture_size(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
359
360 virtual Dictionary font_get_glyph_contours(const RID &p_font, int64_t p_size, int64_t p_index) const = 0;
361
362 virtual TypedArray<Vector2i> font_get_kerning_list(const RID &p_font_rid, int64_t p_size) const = 0;
363 virtual void font_clear_kerning_map(const RID &p_font_rid, int64_t p_size) = 0;
364 virtual void font_remove_kerning(const RID &p_font_rid, int64_t p_size, const Vector2i &p_glyph_pair) = 0;
365
366 virtual void font_set_kerning(const RID &p_font_rid, int64_t p_size, const Vector2i &p_glyph_pair, const Vector2 &p_kerning) = 0;
367 virtual Vector2 font_get_kerning(const RID &p_font_rid, int64_t p_size, const Vector2i &p_glyph_pair) const = 0;
368
369 virtual int64_t font_get_glyph_index(const RID &p_font_rid, int64_t p_size, int64_t p_char, int64_t p_variation_selector) const = 0;
370 virtual int64_t font_get_char_from_glyph_index(const RID &p_font_rid, int64_t p_size, int64_t p_glyph_index) const = 0;
371
372 virtual bool font_has_char(const RID &p_font_rid, int64_t p_char) const = 0;
373 virtual String font_get_supported_chars(const RID &p_font_rid) const = 0;
374
375 virtual void font_render_range(const RID &p_font, const Vector2i &p_size, int64_t p_start, int64_t p_end) = 0;
376 virtual void font_render_glyph(const RID &p_font_rid, const Vector2i &p_size, int64_t p_index) = 0;
377
378 virtual void font_draw_glyph(const RID &p_font, const RID &p_canvas, int64_t p_size, const Vector2 &p_pos, int64_t p_index, const Color &p_color = Color(1, 1, 1)) const = 0;
379 virtual void font_draw_glyph_outline(const RID &p_font, const RID &p_canvas, int64_t p_size, int64_t p_outline_size, const Vector2 &p_pos, int64_t p_index, const Color &p_color = Color(1, 1, 1)) const = 0;
380
381 virtual bool font_is_language_supported(const RID &p_font_rid, const String &p_language) const = 0;
382 virtual void font_set_language_support_override(const RID &p_font_rid, const String &p_language, bool p_supported) = 0;
383 virtual bool font_get_language_support_override(const RID &p_font_rid, const String &p_language) = 0;
384 virtual void font_remove_language_support_override(const RID &p_font_rid, const String &p_language) = 0;
385 virtual PackedStringArray font_get_language_support_overrides(const RID &p_font_rid) = 0;
386
387 virtual bool font_is_script_supported(const RID &p_font_rid, const String &p_script) const = 0;
388 virtual void font_set_script_support_override(const RID &p_font_rid, const String &p_script, bool p_supported) = 0;
389 virtual bool font_get_script_support_override(const RID &p_font_rid, const String &p_script) = 0;
390 virtual void font_remove_script_support_override(const RID &p_font_rid, const String &p_script) = 0;
391 virtual PackedStringArray font_get_script_support_overrides(const RID &p_font_rid) = 0;
392
393 virtual void font_set_opentype_feature_overrides(const RID &p_font_rid, const Dictionary &p_overrides) = 0;
394 virtual Dictionary font_get_opentype_feature_overrides(const RID &p_font_rid) const = 0;
395
396 virtual Dictionary font_supported_feature_list(const RID &p_font_rid) const = 0;
397 virtual Dictionary font_supported_variation_list(const RID &p_font_rid) const = 0;
398
399 virtual double font_get_global_oversampling() const = 0;
400 virtual void font_set_global_oversampling(double p_oversampling) = 0;
401
402 virtual Vector2 get_hex_code_box_size(int64_t p_size, int64_t p_index) const;
403 virtual void draw_hex_code_box(const RID &p_canvas, int64_t p_size, const Vector2 &p_pos, int64_t p_index, const Color &p_color) const;
404
405 /* Shaped text buffer interface */
406
407 virtual RID create_shaped_text(Direction p_direction = DIRECTION_AUTO, Orientation p_orientation = ORIENTATION_HORIZONTAL) = 0;
408
409 virtual void shaped_text_clear(const RID &p_shaped) = 0;
410
411 virtual void shaped_text_set_direction(const RID &p_shaped, Direction p_direction = DIRECTION_AUTO) = 0;
412 virtual Direction shaped_text_get_direction(const RID &p_shaped) const = 0;
413 virtual Direction shaped_text_get_inferred_direction(const RID &p_shaped) const = 0;
414
415 virtual void shaped_text_set_bidi_override(const RID &p_shaped, const Array &p_override) = 0;
416
417 virtual void shaped_text_set_custom_punctuation(const RID &p_shaped, const String &p_punct) = 0;
418 virtual String shaped_text_get_custom_punctuation(const RID &p_shaped) const = 0;
419
420 virtual void shaped_text_set_orientation(const RID &p_shaped, Orientation p_orientation = ORIENTATION_HORIZONTAL) = 0;
421 virtual Orientation shaped_text_get_orientation(const RID &p_shaped) const = 0;
422
423 virtual void shaped_text_set_preserve_invalid(const RID &p_shaped, bool p_enabled) = 0;
424 virtual bool shaped_text_get_preserve_invalid(const RID &p_shaped) const = 0;
425
426 virtual void shaped_text_set_preserve_control(const RID &p_shaped, bool p_enabled) = 0;
427 virtual bool shaped_text_get_preserve_control(const RID &p_shaped) const = 0;
428
429 virtual void shaped_text_set_spacing(const RID &p_shaped, SpacingType p_spacing, int64_t p_value) = 0;
430 virtual int64_t shaped_text_get_spacing(const RID &p_shaped, SpacingType p_spacing) const = 0;
431
432 virtual bool shaped_text_add_string(const RID &p_shaped, const String &p_text, const TypedArray<RID> &p_fonts, int64_t p_size, const Dictionary &p_opentype_features = Dictionary(), const String &p_language = "", const Variant &p_meta = Variant()) = 0;
433 virtual bool shaped_text_add_object(const RID &p_shaped, const Variant &p_key, const Size2 &p_size, InlineAlignment p_inline_align = INLINE_ALIGNMENT_CENTER, int64_t p_length = 1, double p_baseline = 0.0) = 0;
434 virtual bool shaped_text_resize_object(const RID &p_shaped, const Variant &p_key, const Size2 &p_size, InlineAlignment p_inline_align = INLINE_ALIGNMENT_CENTER, double p_baseline = 0.0) = 0;
435
436 virtual int64_t shaped_get_span_count(const RID &p_shaped) const = 0;
437 virtual Variant shaped_get_span_meta(const RID &p_shaped, int64_t p_index) const = 0;
438 virtual void shaped_set_span_update_font(const RID &p_shaped, int64_t p_index, const TypedArray<RID> &p_fonts, int64_t p_size, const Dictionary &p_opentype_features = Dictionary()) = 0;
439
440 virtual RID shaped_text_substr(const RID &p_shaped, int64_t p_start, int64_t p_length) const = 0; // Copy shaped substring (e.g. line break) without reshaping, but correctly reordered, preservers range.
441 virtual RID shaped_text_get_parent(const RID &p_shaped) const = 0;
442
443 virtual double shaped_text_fit_to_width(const RID &p_shaped, double p_width, BitField<TextServer::JustificationFlag> p_jst_flags = JUSTIFICATION_WORD_BOUND | JUSTIFICATION_KASHIDA) = 0;
444 virtual double shaped_text_tab_align(const RID &p_shaped, const PackedFloat32Array &p_tab_stops) = 0;
445
446 virtual bool shaped_text_shape(const RID &p_shaped) = 0;
447 virtual bool shaped_text_update_breaks(const RID &p_shaped) = 0;
448 virtual bool shaped_text_update_justification_ops(const RID &p_shaped) = 0;
449
450 virtual bool shaped_text_is_ready(const RID &p_shaped) const = 0;
451 bool shaped_text_has_visible_chars(const RID &p_shaped) const;
452
453 virtual const Glyph *shaped_text_get_glyphs(const RID &p_shaped) const = 0;
454 TypedArray<Dictionary> _shaped_text_get_glyphs_wrapper(const RID &p_shaped) const;
455 virtual const Glyph *shaped_text_sort_logical(const RID &p_shaped) = 0;
456 TypedArray<Dictionary> _shaped_text_sort_logical_wrapper(const RID &p_shaped);
457 virtual int64_t shaped_text_get_glyph_count(const RID &p_shaped) const = 0;
458
459 virtual Vector2i shaped_text_get_range(const RID &p_shaped) const = 0;
460
461 virtual PackedInt32Array shaped_text_get_line_breaks_adv(const RID &p_shaped, const PackedFloat32Array &p_width, int64_t p_start = 0, bool p_once = true, BitField<TextServer::LineBreakFlag> p_break_flags = BREAK_MANDATORY | BREAK_WORD_BOUND) const;
462 virtual PackedInt32Array shaped_text_get_line_breaks(const RID &p_shaped, double p_width, int64_t p_start = 0, BitField<TextServer::LineBreakFlag> p_break_flags = BREAK_MANDATORY | BREAK_WORD_BOUND) const;
463 virtual PackedInt32Array shaped_text_get_word_breaks(const RID &p_shaped, BitField<TextServer::GraphemeFlag> p_grapheme_flags = GRAPHEME_IS_SPACE | GRAPHEME_IS_PUNCTUATION) const;
464
465 virtual int64_t shaped_text_get_trim_pos(const RID &p_shaped) const = 0;
466 virtual int64_t shaped_text_get_ellipsis_pos(const RID &p_shaped) const = 0;
467 virtual const Glyph *shaped_text_get_ellipsis_glyphs(const RID &p_shaped) const = 0;
468 TypedArray<Dictionary> _shaped_text_get_ellipsis_glyphs_wrapper(const RID &p_shaped) const;
469 virtual int64_t shaped_text_get_ellipsis_glyph_count(const RID &p_shaped) const = 0;
470
471 virtual void shaped_text_overrun_trim_to_width(const RID &p_shaped, double p_width, BitField<TextServer::TextOverrunFlag> p_trim_flags) = 0;
472
473 virtual Array shaped_text_get_objects(const RID &p_shaped) const = 0;
474 virtual Rect2 shaped_text_get_object_rect(const RID &p_shaped, const Variant &p_key) const = 0;
475
476 virtual Size2 shaped_text_get_size(const RID &p_shaped) const = 0;
477 virtual double shaped_text_get_ascent(const RID &p_shaped) const = 0;
478 virtual double shaped_text_get_descent(const RID &p_shaped) const = 0;
479 virtual double shaped_text_get_width(const RID &p_shaped) const = 0;
480 virtual double shaped_text_get_underline_position(const RID &p_shaped) const = 0;
481 virtual double shaped_text_get_underline_thickness(const RID &p_shaped) const = 0;
482
483 virtual Direction shaped_text_get_dominant_direction_in_range(const RID &p_shaped, int64_t p_start, int64_t p_end) const;
484
485 virtual CaretInfo shaped_text_get_carets(const RID &p_shaped, int64_t p_position) const;
486 Dictionary _shaped_text_get_carets_wrapper(const RID &p_shaped, int64_t p_position) const;
487
488 virtual Vector<Vector2> shaped_text_get_selection(const RID &p_shaped, int64_t p_start, int64_t p_end) const;
489
490 virtual int64_t shaped_text_hit_test_grapheme(const RID &p_shaped, double p_coords) const; // Return grapheme index.
491 virtual int64_t shaped_text_hit_test_position(const RID &p_shaped, double p_coords) const; // Return caret/selection position.
492
493 virtual Vector2 shaped_text_get_grapheme_bounds(const RID &p_shaped, int64_t p_pos) const;
494 virtual int64_t shaped_text_next_grapheme_pos(const RID &p_shaped, int64_t p_pos) const;
495 virtual int64_t shaped_text_prev_grapheme_pos(const RID &p_shaped, int64_t p_pos) const;
496
497 virtual PackedInt32Array shaped_text_get_character_breaks(const RID &p_shaped) const = 0;
498 virtual int64_t shaped_text_next_character_pos(const RID &p_shaped, int64_t p_pos) const;
499 virtual int64_t shaped_text_prev_character_pos(const RID &p_shaped, int64_t p_pos) const;
500 virtual int64_t shaped_text_closest_character_pos(const RID &p_shaped, int64_t p_pos) const;
501
502 // The pen position is always placed on the baseline and moveing left to right.
503 virtual void shaped_text_draw(const RID &p_shaped, const RID &p_canvas, const Vector2 &p_pos, double p_clip_l = -1.0, double p_clip_r = -1.0, const Color &p_color = Color(1, 1, 1)) const;
504 virtual void shaped_text_draw_outline(const RID &p_shaped, const RID &p_canvas, const Vector2 &p_pos, double p_clip_l = -1.0, double p_clip_r = -1.0, int64_t p_outline_size = 1, const Color &p_color = Color(1, 1, 1)) const;
505
506 // Number conversion.
507 virtual String format_number(const String &p_string, const String &p_language = "") const = 0;
508 virtual String parse_number(const String &p_string, const String &p_language = "") const = 0;
509 virtual String percent_sign(const String &p_language = "") const = 0;
510
511 // String functions.
512 virtual PackedInt32Array string_get_word_breaks(const String &p_string, const String &p_language = "", int64_t p_chars_per_line = 0) const = 0;
513 virtual PackedInt32Array string_get_character_breaks(const String &p_string, const String &p_language = "") const;
514
515 virtual int64_t is_confusable(const String &p_string, const PackedStringArray &p_dict) const { return -1; };
516 virtual bool spoof_check(const String &p_string) const { return false; };
517
518 virtual String strip_diacritics(const String &p_string) const;
519 virtual bool is_valid_identifier(const String &p_string) const;
520
521 // Other string operations.
522 virtual String string_to_upper(const String &p_string, const String &p_language = "") const = 0;
523 virtual String string_to_lower(const String &p_string, const String &p_language = "") const = 0;
524
525 TypedArray<Vector3i> parse_structured_text(StructuredTextParser p_parser_type, const Array &p_args, const String &p_text) const;
526
527 virtual void cleanup() {}
528
529 TextServer();
530 ~TextServer();
531};
532
533/*************************************************************************/
534
535struct Glyph {
536 int start = -1; // Start offset in the source string.
537 int end = -1; // End offset in the source string.
538
539 uint8_t count = 0; // Number of glyphs in the grapheme, set in the first glyph only.
540 uint8_t repeat = 1; // Draw multiple times in the row.
541 uint16_t flags = 0; // Grapheme flags (valid, rtl, virtual), set in the first glyph only.
542
543 float x_off = 0.f; // Offset from the origin of the glyph on baseline.
544 float y_off = 0.f;
545 float advance = 0.f; // Advance to the next glyph along baseline(x for horizontal layout, y for vertical).
546
547 RID font_rid; // Font resource.
548 int font_size = 0; // Font size;
549 int32_t index = 0; // Glyph index (font specific) or UTF-32 codepoint (for the invalid glyphs).
550
551 bool operator==(const Glyph &p_a) const;
552 bool operator!=(const Glyph &p_a) const;
553
554 bool operator<(const Glyph &p_a) const;
555 bool operator>(const Glyph &p_a) const;
556};
557
558struct CaretInfo {
559 Rect2 l_caret;
560 Rect2 t_caret;
561 TextServer::Direction l_dir;
562 TextServer::Direction t_dir;
563};
564
565/*************************************************************************/
566
567class TextServerManager : public Object {
568 GDCLASS(TextServerManager, Object);
569
570protected:
571 static void _bind_methods();
572
573private:
574 static TextServerManager *singleton;
575
576 Ref<TextServer> primary_interface;
577 Vector<Ref<TextServer>> interfaces;
578
579public:
580 _FORCE_INLINE_ static TextServerManager *get_singleton() {
581 return singleton;
582 }
583
584 void add_interface(const Ref<TextServer> &p_interface);
585 void remove_interface(const Ref<TextServer> &p_interface);
586 int get_interface_count() const;
587 Ref<TextServer> get_interface(int p_index) const;
588 Ref<TextServer> find_interface(const String &p_name) const;
589 TypedArray<Dictionary> get_interfaces() const;
590
591 _FORCE_INLINE_ Ref<TextServer> get_primary_interface() const {
592 return primary_interface;
593 }
594 void set_primary_interface(const Ref<TextServer> &p_primary_interface);
595
596 TextServerManager();
597 ~TextServerManager();
598};
599
600/*************************************************************************/
601
602#define TS TextServerManager::get_singleton()->get_primary_interface()
603
604VARIANT_ENUM_CAST(TextServer::VisibleCharactersBehavior);
605VARIANT_ENUM_CAST(TextServer::AutowrapMode);
606VARIANT_ENUM_CAST(TextServer::OverrunBehavior);
607VARIANT_ENUM_CAST(TextServer::Direction);
608VARIANT_ENUM_CAST(TextServer::Orientation);
609VARIANT_BITFIELD_CAST(TextServer::JustificationFlag);
610VARIANT_BITFIELD_CAST(TextServer::LineBreakFlag);
611VARIANT_BITFIELD_CAST(TextServer::TextOverrunFlag);
612VARIANT_BITFIELD_CAST(TextServer::GraphemeFlag);
613VARIANT_ENUM_CAST(TextServer::Hinting);
614VARIANT_ENUM_CAST(TextServer::SubpixelPositioning);
615VARIANT_ENUM_CAST(TextServer::Feature);
616VARIANT_ENUM_CAST(TextServer::ContourPointTag);
617VARIANT_ENUM_CAST(TextServer::SpacingType);
618VARIANT_BITFIELD_CAST(TextServer::FontStyle);
619VARIANT_ENUM_CAST(TextServer::StructuredTextParser);
620VARIANT_ENUM_CAST(TextServer::FontAntialiasing);
621VARIANT_ENUM_CAST(TextServer::FontLCDSubpixelLayout);
622
623GDVIRTUAL_NATIVE_PTR(Glyph);
624GDVIRTUAL_NATIVE_PTR(CaretInfo);
625
626#endif // TEXT_SERVER_H
627