CoCalc -- text

GitHub Repository: godotengine/godot
Path: blob/master/servers/text/text_server.h
²¹¹³⁶ views
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
#pragma once
32

33
#include "core/io/image.h"
34
#include "core/object/ref_counted.h"
35
#include "core/templates/rid.h"
36
#include "core/variant/native_ptr.h"
37
#include "core/variant/variant.h"
38

39
template <typename T>
40
class TypedArray;
41

42
struct Glyph;
43
struct CaretInfo;
44

45
#define OT_TAG(m_c1, m_c2, m_c3, m_c4) ((int32_t)((((uint32_t)(m_c1) & 0xff) << 24) | (((uint32_t)(m_c2) & 0xff) << 16) | (((uint32_t)(m_c3) & 0xff) << 8) | ((uint32_t)(m_c4) & 0xff)))
46

47
class TextServer : public RefCounted {
48
	GDCLASS(TextServer, RefCounted);
49

50
public:
51
	enum FontAntialiasing {
52
		FONT_ANTIALIASING_NONE,
53
		FONT_ANTIALIASING_GRAY,
54
		FONT_ANTIALIASING_LCD,
55
	};
56

57
	enum FontLCDSubpixelLayout {
58
		FONT_LCD_SUBPIXEL_LAYOUT_NONE,
59
		FONT_LCD_SUBPIXEL_LAYOUT_HRGB,
60
		FONT_LCD_SUBPIXEL_LAYOUT_HBGR,
61
		FONT_LCD_SUBPIXEL_LAYOUT_VRGB,
62
		FONT_LCD_SUBPIXEL_LAYOUT_VBGR,
63
		FONT_LCD_SUBPIXEL_LAYOUT_MAX,
64
	};
65

66
	enum Direction {
67
		DIRECTION_AUTO,
68
		DIRECTION_LTR,
69
		DIRECTION_RTL,
70
		DIRECTION_INHERITED,
71
	};
72

73
	enum Orientation {
74
		ORIENTATION_HORIZONTAL,
75
		ORIENTATION_VERTICAL
76
	};
77

78
	enum JustificationFlag {
79
		JUSTIFICATION_NONE = 0,
80
		JUSTIFICATION_KASHIDA = 1 << 0,
81
		JUSTIFICATION_WORD_BOUND = 1 << 1,
82
		JUSTIFICATION_TRIM_EDGE_SPACES = 1 << 2,
83
		JUSTIFICATION_AFTER_LAST_TAB = 1 << 3,
84
		JUSTIFICATION_CONSTRAIN_ELLIPSIS = 1 << 4,
85
		JUSTIFICATION_SKIP_LAST_LINE = 1 << 5,
86
		JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS = 1 << 6,
87
		JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE = 1 << 7,
88
	};
89

90
	enum VisibleCharactersBehavior {
91
		VC_CHARS_BEFORE_SHAPING,
92
		VC_CHARS_AFTER_SHAPING,
93
		VC_GLYPHS_AUTO,
94
		VC_GLYPHS_LTR,
95
		VC_GLYPHS_RTL,
96
	};
97

98
	enum AutowrapMode {
99
		AUTOWRAP_OFF,
100
		AUTOWRAP_ARBITRARY,
101
		AUTOWRAP_WORD,
102
		AUTOWRAP_WORD_SMART
103
	};
104

105
	enum LineBreakFlag {
106
		BREAK_NONE = 0,
107
		BREAK_MANDATORY = 1 << 0,
108
		BREAK_WORD_BOUND = 1 << 1,
109
		BREAK_GRAPHEME_BOUND = 1 << 2,
110
		BREAK_ADAPTIVE = 1 << 3,
111
#ifndef DISABLE_DEPRECATED
112
		BREAK_TRIM_EDGE_SPACES = 1 << 4,
113
#else
114
	// RESERVED = 1 << 4,
115
#endif
116
		BREAK_TRIM_INDENT = 1 << 5,
117
		BREAK_TRIM_START_EDGE_SPACES = 1 << 6,
118
		BREAK_TRIM_END_EDGE_SPACES = 1 << 7,
119

120
		BREAK_TRIM_MASK = BREAK_TRIM_INDENT | BREAK_TRIM_START_EDGE_SPACES | BREAK_TRIM_END_EDGE_SPACES,
121
	};
122

123
	enum OverrunBehavior {
124
		OVERRUN_NO_TRIMMING,
125
		OVERRUN_TRIM_CHAR,
126
		OVERRUN_TRIM_WORD,
127
		OVERRUN_TRIM_ELLIPSIS,
128
		OVERRUN_TRIM_WORD_ELLIPSIS,
129
		OVERRUN_TRIM_ELLIPSIS_FORCE,
130
		OVERRUN_TRIM_WORD_ELLIPSIS_FORCE,
131
	};
132

133
	enum TextOverrunFlag {
134
		OVERRUN_NO_TRIM = 0,
135
		OVERRUN_TRIM = 1 << 0,
136
		OVERRUN_TRIM_WORD_ONLY = 1 << 1,
137
		OVERRUN_ADD_ELLIPSIS = 1 << 2,
138
		OVERRUN_ENFORCE_ELLIPSIS = 1 << 3,
139
		OVERRUN_JUSTIFICATION_AWARE = 1 << 4,
140
		OVERRUN_SHORT_STRING_ELLIPSIS = 1 << 5,
141
	};
142

143
	enum GraphemeFlag {
144
		GRAPHEME_IS_VALID = 1 << 0, // Grapheme is valid.
145
		GRAPHEME_IS_RTL = 1 << 1, // Grapheme is right-to-left.
146
		GRAPHEME_IS_VIRTUAL = 1 << 2, // Grapheme is not part of source string (added by fit_to_width function, do not affect caret movement).
147
		GRAPHEME_IS_SPACE = 1 << 3, // Is whitespace (for justification and word breaks).
148
		GRAPHEME_IS_BREAK_HARD = 1 << 4, // Is line break (mandatory break, e.g. "\n").
149
		GRAPHEME_IS_BREAK_SOFT = 1 << 5, // Is line break (optional break, e.g. space).
150
		GRAPHEME_IS_TAB = 1 << 6, // Is tab or vertical tab.
151
		GRAPHEME_IS_ELONGATION = 1 << 7, // Elongation (e.g. kashida), grapheme can be duplicated or truncated to fit line to width.
152
		GRAPHEME_IS_PUNCTUATION = 1 << 8, // Punctuation, except underscore (can be used as word break, but not line break or justifiction).
153
		GRAPHEME_IS_UNDERSCORE = 1 << 9, // Underscore (can be used as word break).
154
		GRAPHEME_IS_CONNECTED = 1 << 10, // Connected to previous grapheme.
155
		GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL = 1 << 11, // It is safe to insert a U+0640 before this grapheme for elongation.
156
		GRAPHEME_IS_EMBEDDED_OBJECT = 1 << 12, // Grapheme is an object replacement character for the embedded object.
157
		GRAPHEME_IS_SOFT_HYPHEN = 1 << 13, // Grapheme is a soft hyphen.
158
	};
159

160
	enum Hinting {
161
		HINTING_NONE,
162
		HINTING_LIGHT,
163
		HINTING_NORMAL
164
	};
165

166
	enum SubpixelPositioning {
167
		SUBPIXEL_POSITIONING_DISABLED = 0,
168
		SUBPIXEL_POSITIONING_AUTO = 1,
169
		SUBPIXEL_POSITIONING_ONE_HALF = 2,
170
		SUBPIXEL_POSITIONING_ONE_QUARTER = 3,
171

172
		SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE = 20,
173
		SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE = 16,
174
	};
175

176
	enum Feature {
177
		FEATURE_SIMPLE_LAYOUT = 1 << 0,
178
		FEATURE_BIDI_LAYOUT = 1 << 1,
179
		FEATURE_VERTICAL_LAYOUT = 1 << 2,
180
		FEATURE_SHAPING = 1 << 3,
181
		FEATURE_KASHIDA_JUSTIFICATION = 1 << 4,
182
		FEATURE_BREAK_ITERATORS = 1 << 5,
183
		FEATURE_FONT_BITMAP = 1 << 6,
184
		FEATURE_FONT_DYNAMIC = 1 << 7,
185
		FEATURE_FONT_MSDF = 1 << 8,
186
		FEATURE_FONT_SYSTEM = 1 << 9,
187
		FEATURE_FONT_VARIABLE = 1 << 10,
188
		FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION = 1 << 11,
189
		FEATURE_USE_SUPPORT_DATA = 1 << 12,
190
		FEATURE_UNICODE_IDENTIFIERS = 1 << 13,
191
		FEATURE_UNICODE_SECURITY = 1 << 14,
192
	};
193

194
	enum ContourPointTag {
195
		CONTOUR_CURVE_TAG_ON = 0x01,
196
		CONTOUR_CURVE_TAG_OFF_CONIC = 0x00,
197
		CONTOUR_CURVE_TAG_OFF_CUBIC = 0x02
198
	};
199

200
	enum SpacingType {
201
		SPACING_GLYPH,
202
		SPACING_SPACE,
203
		SPACING_TOP,
204
		SPACING_BOTTOM,
205
		SPACING_MAX,
206
	};
207

208
	enum FontStyle {
209
		FONT_BOLD = 1 << 0,
210
		FONT_ITALIC = 1 << 1,
211
		FONT_FIXED_WIDTH = 1 << 2,
212
	};
213

214
	enum StructuredTextParser {
215
		STRUCTURED_TEXT_DEFAULT,
216
		STRUCTURED_TEXT_URI,
217
		STRUCTURED_TEXT_FILE,
218
		STRUCTURED_TEXT_EMAIL,
219
		STRUCTURED_TEXT_LIST,
220
		STRUCTURED_TEXT_GDSCRIPT,
221
		STRUCTURED_TEXT_CUSTOM
222
	};
223

224
	enum FixedSizeScaleMode {
225
		FIXED_SIZE_SCALE_DISABLE,
226
		FIXED_SIZE_SCALE_INTEGER_ONLY,
227
		FIXED_SIZE_SCALE_ENABLED,
228
	};
229

230
	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;
231

232
protected:
233
	static double vp_oversampling;
234
	HashMap<char32_t, char32_t> diacritics_map;
235
	void _diacritics_map_add(const String &p_from, char32_t p_to);
236
	void _init_diacritics_map();
237

238
	static void _bind_methods();
239

240
#ifndef DISABLE_DEPRECATED
241
	void _font_draw_glyph_bind_compat_104872(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;
242
	void _font_draw_glyph_outline_bind_compat_104872(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;
243
	void _shaped_text_draw_bind_compat_104872(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;
244
	void _shaped_text_draw_outline_bind_compat_104872(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;
245
	PackedInt32Array _shaped_text_get_word_breaks_bind_compat_90732(const RID &p_shaped, BitField<TextServer::GraphemeFlag> p_grapheme_flags = GRAPHEME_IS_SPACE | GRAPHEME_IS_PUNCTUATION) const;
246
	static void _bind_compatibility_methods();
247
#endif
248

249
public:
250
	static BitField<TextOverrunFlag> get_overrun_flags_from_behavior(OverrunBehavior p_behavior);
251

252
	virtual bool has_feature(Feature p_feature) const = 0;
253
	virtual String get_name() const = 0;
254
	virtual int64_t get_features() const = 0;
255

256
	virtual void free_rid(const RID &p_rid) = 0;
257
	virtual bool has(const RID &p_rid) = 0;
258
	virtual bool load_support_data(const String &p_filename) = 0;
259

260
	virtual String get_support_data_filename() const = 0;
261
	virtual String get_support_data_info() const = 0;
262
	virtual bool save_support_data(const String &p_filename) const = 0;
263
	virtual PackedByteArray get_support_data() const = 0;
264
	virtual bool is_locale_using_support_data(const String &p_locale) const { return false; }
265

266
	virtual bool is_locale_right_to_left(const String &p_locale) const = 0;
267

268
	virtual int64_t name_to_tag(const String &p_name) const;
269
	virtual String tag_to_name(int64_t p_tag) const;
270

271
	/* Font interface */
272

273
	virtual RID create_font() = 0;
274
	virtual RID create_font_linked_variation(const RID &p_font_rid) = 0;
275

276
	virtual void font_set_data(const RID &p_font_rid, const PackedByteArray &p_data) = 0;
277
	virtual void font_set_data_ptr(const RID &p_font_rid, const uint8_t *p_data_ptr, int64_t p_data_size) = 0;
278

279
	virtual void font_set_face_index(const RID &p_font_rid, int64_t p_index) = 0;
280
	virtual int64_t font_get_face_index(const RID &p_font_rid) const = 0;
281

282
	virtual int64_t font_get_face_count(const RID &p_font_rid) const = 0;
283

284
	virtual void font_set_style(const RID &p_font_rid, BitField<FontStyle> p_style) = 0;
285
	virtual BitField<FontStyle> font_get_style(const RID &p_font_rid) const = 0;
286

287
	virtual void font_set_name(const RID &p_font_rid, const String &p_name) = 0;
288
	virtual String font_get_name(const RID &p_font_rid) const = 0;
289
	virtual Dictionary font_get_ot_name_strings(const RID &p_font_rid) const { return Dictionary(); }
290

291
	virtual void font_set_style_name(const RID &p_font_rid, const String &p_name) = 0;
292
	virtual String font_get_style_name(const RID &p_font_rid) const = 0;
293

294
	virtual void font_set_weight(const RID &p_font_rid, int64_t p_weight) = 0;
295
	virtual int64_t font_get_weight(const RID &p_font_rid) const = 0;
296

297
	virtual void font_set_stretch(const RID &p_font_rid, int64_t p_stretch) = 0;
298
	virtual int64_t font_get_stretch(const RID &p_font_rid) const = 0;
299

300
	virtual void font_set_antialiasing(const RID &p_font_rid, FontAntialiasing p_antialiasing) = 0;
301
	virtual FontAntialiasing font_get_antialiasing(const RID &p_font_rid) const = 0;
302

303
	virtual void font_set_disable_embedded_bitmaps(const RID &p_font_rid, bool p_disable_embedded_bitmaps) = 0;
304
	virtual bool font_get_disable_embedded_bitmaps(const RID &p_font_rid) const = 0;
305

306
	virtual void font_set_generate_mipmaps(const RID &p_font_rid, bool p_generate_mipmaps) = 0;
307
	virtual bool font_get_generate_mipmaps(const RID &p_font_rid) const = 0;
308

309
	virtual void font_set_multichannel_signed_distance_field(const RID &p_font_rid, bool p_msdf) = 0;
310
	virtual bool font_is_multichannel_signed_distance_field(const RID &p_font_rid) const = 0;
311

312
	virtual void font_set_msdf_pixel_range(const RID &p_font_rid, int64_t p_msdf_pixel_range) = 0;
313
	virtual int64_t font_get_msdf_pixel_range(const RID &p_font_rid) const = 0;
314

315
	virtual void font_set_msdf_size(const RID &p_font_rid, int64_t p_msdf_size) = 0;
316
	virtual int64_t font_get_msdf_size(const RID &p_font_rid) const = 0;
317

318
	virtual void font_set_fixed_size(const RID &p_font_rid, int64_t p_fixed_size) = 0;
319
	virtual int64_t font_get_fixed_size(const RID &p_font_rid) const = 0;
320

321
	virtual void font_set_fixed_size_scale_mode(const RID &p_font_rid, FixedSizeScaleMode p_fixed_size_scale) = 0;
322
	virtual FixedSizeScaleMode font_get_fixed_size_scale_mode(const RID &p_font_rid) const = 0;
323

324
	virtual void font_set_allow_system_fallback(const RID &p_font_rid, bool p_allow_system_fallback) = 0;
325
	virtual bool font_is_allow_system_fallback(const RID &p_font_rid) const = 0;
326

327
	virtual void font_clear_system_fallback_cache() {}
328

329
	virtual void font_set_force_autohinter(const RID &p_font_rid, bool p_force_autohinter) = 0;
330
	virtual bool font_is_force_autohinter(const RID &p_font_rid) const = 0;
331

332
	virtual void font_set_modulate_color_glyphs(const RID &p_font_rid, bool p_modulate) = 0;
333
	virtual bool font_is_modulate_color_glyphs(const RID &p_font_rid) const = 0;
334

335
	virtual void font_set_hinting(const RID &p_font_rid, Hinting p_hinting) = 0;
336
	virtual Hinting font_get_hinting(const RID &p_font_rid) const = 0;
337

338
	virtual void font_set_subpixel_positioning(const RID &p_font_rid, SubpixelPositioning p_subpixel) = 0;
339
	virtual SubpixelPositioning font_get_subpixel_positioning(const RID &p_font_rid) const = 0;
340

341
	virtual void font_set_keep_rounding_remainders(const RID &p_font_rid, bool p_keep_rounding_remainders) = 0;
342
	virtual bool font_get_keep_rounding_remainders(const RID &p_font_rid) const = 0;
343

344
	virtual void font_set_embolden(const RID &p_font_rid, double p_strength) = 0;
345
	virtual double font_get_embolden(const RID &p_font_rid) const = 0;
346

347
	virtual void font_set_spacing(const RID &p_font_rid, SpacingType p_spacing, int64_t p_value) = 0;
348
	virtual int64_t font_get_spacing(const RID &p_font_rid, SpacingType p_spacing) const = 0;
349

350
	virtual void font_set_baseline_offset(const RID &p_font_rid, double p_baseline_offset) = 0;
351
	virtual double font_get_baseline_offset(const RID &p_font_rid) const = 0;
352

353
	virtual void font_set_transform(const RID &p_font_rid, const Transform2D &p_transform) = 0;
354
	virtual Transform2D font_get_transform(const RID &p_font_rid) const = 0;
355

356
	virtual void font_set_variation_coordinates(const RID &p_font_rid, const Dictionary &p_variation_coordinates) = 0;
357
	virtual Dictionary font_get_variation_coordinates(const RID &p_font_rid) const = 0;
358

359
	virtual void font_set_oversampling(const RID &p_font_rid, double p_oversampling) = 0;
360
	virtual double font_get_oversampling(const RID &p_font_rid) const = 0;
361

362
	virtual TypedArray<Vector2i> font_get_size_cache_list(const RID &p_font_rid) const = 0;
363
	virtual void font_clear_size_cache(const RID &p_font_rid) = 0;
364
	virtual void font_remove_size_cache(const RID &p_font_rid, const Vector2i &p_size) = 0;
365
	virtual TypedArray<Dictionary> font_get_size_cache_info(const RID &p_font_rid) const = 0;
366

367
	virtual void font_set_ascent(const RID &p_font_rid, int64_t p_size, double p_ascent) = 0;
368
	virtual double font_get_ascent(const RID &p_font_rid, int64_t p_size) const = 0;
369

370
	virtual void font_set_descent(const RID &p_font_rid, int64_t p_size, double p_descent) = 0;
371
	virtual double font_get_descent(const RID &p_font_rid, int64_t p_size) const = 0;
372

373
	virtual void font_set_underline_position(const RID &p_font_rid, int64_t p_size, double p_underline_position) = 0;
374
	virtual double font_get_underline_position(const RID &p_font_rid, int64_t p_size) const = 0;
375

376
	virtual void font_set_underline_thickness(const RID &p_font_rid, int64_t p_size, double p_underline_thickness) = 0;
377
	virtual double font_get_underline_thickness(const RID &p_font_rid, int64_t p_size) const = 0;
378

379
	virtual void font_set_scale(const RID &p_font_rid, int64_t p_size, double p_scale) = 0;
380
	virtual double font_get_scale(const RID &p_font_rid, int64_t p_size) const = 0;
381

382
	virtual int64_t font_get_texture_count(const RID &p_font_rid, const Vector2i &p_size) const = 0;
383
	virtual void font_clear_textures(const RID &p_font_rid, const Vector2i &p_size) = 0;
384
	virtual void font_remove_texture(const RID &p_font_rid, const Vector2i &p_size, int64_t p_texture_index) = 0;
385

386
	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;
387
	virtual Ref<Image> font_get_texture_image(const RID &p_font_rid, const Vector2i &p_size, int64_t p_texture_index) const = 0;
388

389
	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;
390
	virtual PackedInt32Array font_get_texture_offsets(const RID &p_font_rid, const Vector2i &p_size, int64_t p_texture_index) const = 0;
391

392
	virtual PackedInt32Array font_get_glyph_list(const RID &p_font_rid, const Vector2i &p_size) const = 0;
393
	virtual void font_clear_glyphs(const RID &p_font_rid, const Vector2i &p_size) = 0;
394
	virtual void font_remove_glyph(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) = 0;
395

396
	virtual Vector2 font_get_glyph_advance(const RID &p_font_rid, int64_t p_size, int64_t p_glyph) const = 0;
397
	virtual void font_set_glyph_advance(const RID &p_font_rid, int64_t p_size, int64_t p_glyph, const Vector2 &p_advance) = 0;
398

399
	virtual Vector2 font_get_glyph_offset(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
400
	virtual void font_set_glyph_offset(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph, const Vector2 &p_offset) = 0;
401

402
	virtual Vector2 font_get_glyph_size(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
403
	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;
404

405
	virtual Rect2 font_get_glyph_uv_rect(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
406
	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;
407

408
	virtual int64_t font_get_glyph_texture_idx(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
409
	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;
410
	virtual RID font_get_glyph_texture_rid(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
411
	virtual Size2 font_get_glyph_texture_size(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
412

413
	virtual Dictionary font_get_glyph_contours(const RID &p_font, int64_t p_size, int64_t p_index) const = 0;
414

415
	virtual TypedArray<Vector2i> font_get_kerning_list(const RID &p_font_rid, int64_t p_size) const = 0;
416
	virtual void font_clear_kerning_map(const RID &p_font_rid, int64_t p_size) = 0;
417
	virtual void font_remove_kerning(const RID &p_font_rid, int64_t p_size, const Vector2i &p_glyph_pair) = 0;
418

419
	virtual void font_set_kerning(const RID &p_font_rid, int64_t p_size, const Vector2i &p_glyph_pair, const Vector2 &p_kerning) = 0;
420
	virtual Vector2 font_get_kerning(const RID &p_font_rid, int64_t p_size, const Vector2i &p_glyph_pair) const = 0;
421

422
	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;
423
	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;
424

425
	virtual bool font_has_char(const RID &p_font_rid, int64_t p_char) const = 0;
426
	virtual String font_get_supported_chars(const RID &p_font_rid) const = 0;
427
	virtual PackedInt32Array font_get_supported_glyphs(const RID &p_font_rid) const = 0;
428

429
	virtual void font_render_range(const RID &p_font, const Vector2i &p_size, int64_t p_start, int64_t p_end) = 0;
430
	virtual void font_render_glyph(const RID &p_font_rid, const Vector2i &p_size, int64_t p_index) = 0;
431

432
	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), float p_oversampling = 0.0) const = 0;
433
	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), float p_oversampling = 0.0) const = 0;
434

435
	virtual bool font_is_language_supported(const RID &p_font_rid, const String &p_language) const = 0;
436
	virtual void font_set_language_support_override(const RID &p_font_rid, const String &p_language, bool p_supported) = 0;
437
	virtual bool font_get_language_support_override(const RID &p_font_rid, const String &p_language) = 0;
438
	virtual void font_remove_language_support_override(const RID &p_font_rid, const String &p_language) = 0;
439
	virtual PackedStringArray font_get_language_support_overrides(const RID &p_font_rid) = 0;
440

441
	virtual bool font_is_script_supported(const RID &p_font_rid, const String &p_script) const = 0;
442
	virtual void font_set_script_support_override(const RID &p_font_rid, const String &p_script, bool p_supported) = 0;
443
	virtual bool font_get_script_support_override(const RID &p_font_rid, const String &p_script) = 0;
444
	virtual void font_remove_script_support_override(const RID &p_font_rid, const String &p_script) = 0;
445
	virtual PackedStringArray font_get_script_support_overrides(const RID &p_font_rid) = 0;
446

447
	virtual void font_set_opentype_feature_overrides(const RID &p_font_rid, const Dictionary &p_overrides) = 0;
448
	virtual Dictionary font_get_opentype_feature_overrides(const RID &p_font_rid) const = 0;
449

450
	virtual Dictionary font_supported_feature_list(const RID &p_font_rid) const = 0;
451
	virtual Dictionary font_supported_variation_list(const RID &p_font_rid) const = 0;
452

453
#ifndef DISABLE_DEPRECATED
454
	virtual double font_get_global_oversampling() const { return 1.0; }
455
	virtual void font_set_global_oversampling(double p_oversampling) {}
456
#endif
457
	virtual void reference_oversampling_level(double p_oversampling) {}
458
	virtual void unreference_oversampling_level(double p_oversampling) {}
459

460
	virtual Vector2 get_hex_code_box_size(int64_t p_size, int64_t p_index) const;
461
	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;
462

463
	/* Shaped text buffer interface */
464

465
	virtual RID create_shaped_text(Direction p_direction = DIRECTION_AUTO, Orientation p_orientation = ORIENTATION_HORIZONTAL) = 0;
466

467
	virtual void shaped_text_clear(const RID &p_shaped) = 0;
468
	virtual RID shaped_text_duplicate(const RID &p_shaped) = 0;
469

470
	virtual void shaped_text_set_direction(const RID &p_shaped, Direction p_direction = DIRECTION_AUTO) = 0;
471
	virtual Direction shaped_text_get_direction(const RID &p_shaped) const = 0;
472
	virtual Direction shaped_text_get_inferred_direction(const RID &p_shaped) const = 0;
473

474
	virtual void shaped_text_set_bidi_override(const RID &p_shaped, const Array &p_override) = 0;
475

476
	virtual void shaped_text_set_custom_punctuation(const RID &p_shaped, const String &p_punct) = 0;
477
	virtual String shaped_text_get_custom_punctuation(const RID &p_shaped) const = 0;
478

479
	virtual void shaped_text_set_custom_ellipsis(const RID &p_shaped, int64_t p_char) = 0;
480
	virtual int64_t shaped_text_get_custom_ellipsis(const RID &p_shaped) const = 0;
481

482
	virtual void shaped_text_set_orientation(const RID &p_shaped, Orientation p_orientation = ORIENTATION_HORIZONTAL) = 0;
483
	virtual Orientation shaped_text_get_orientation(const RID &p_shaped) const = 0;
484

485
	virtual void shaped_text_set_preserve_invalid(const RID &p_shaped, bool p_enabled) = 0;
486
	virtual bool shaped_text_get_preserve_invalid(const RID &p_shaped) const = 0;
487

488
	virtual void shaped_text_set_preserve_control(const RID &p_shaped, bool p_enabled) = 0;
489
	virtual bool shaped_text_get_preserve_control(const RID &p_shaped) const = 0;
490

491
	virtual void shaped_text_set_spacing(const RID &p_shaped, SpacingType p_spacing, int64_t p_value) = 0;
492
	virtual int64_t shaped_text_get_spacing(const RID &p_shaped, SpacingType p_spacing) const = 0;
493

494
	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;
495
	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;
496
	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;
497
	virtual bool shaped_text_has_object(const RID &p_shaped, const Variant &p_key) const = 0;
498
	virtual String shaped_get_text(const RID &p_shaped) const = 0;
499

500
	virtual int64_t shaped_get_span_count(const RID &p_shaped) const = 0;
501
	virtual Variant shaped_get_span_meta(const RID &p_shaped, int64_t p_index) const = 0;
502
	virtual Variant shaped_get_span_embedded_object(const RID &p_shaped, int64_t p_index) const = 0;
503
	virtual String shaped_get_span_text(const RID &p_shaped, int64_t p_index) const = 0;
504
	virtual Variant shaped_get_span_object(const RID &p_shaped, int64_t p_index) const = 0;
505
	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;
506

507
	virtual int64_t shaped_get_run_count(const RID &p_shaped) const = 0;
508
	virtual String shaped_get_run_text(const RID &p_shaped, int64_t p_index) const = 0;
509
	virtual Vector2i shaped_get_run_range(const RID &p_shaped, int64_t p_index) const = 0;
510
	virtual RID shaped_get_run_font_rid(const RID &p_shaped, int64_t p_index) const = 0;
511
	virtual int shaped_get_run_font_size(const RID &p_shaped, int64_t p_index) const = 0;
512
	virtual String shaped_get_run_language(const RID &p_shaped, int64_t p_index) const = 0;
513
	virtual Direction shaped_get_run_direction(const RID &p_shaped, int64_t p_index) const = 0;
514
	virtual Variant shaped_get_run_object(const RID &p_shaped, int64_t p_index) const = 0;
515

516
	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.
517
	virtual RID shaped_text_get_parent(const RID &p_shaped) const = 0;
518

519
	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;
520
	virtual double shaped_text_tab_align(const RID &p_shaped, const PackedFloat32Array &p_tab_stops) = 0;
521

522
	virtual bool shaped_text_shape(const RID &p_shaped) = 0;
523
	virtual bool shaped_text_update_breaks(const RID &p_shaped) = 0;
524
	virtual bool shaped_text_update_justification_ops(const RID &p_shaped) = 0;
525

526
	virtual bool shaped_text_is_ready(const RID &p_shaped) const = 0;
527
	bool shaped_text_has_visible_chars(const RID &p_shaped) const;
528

529
	virtual const Glyph *shaped_text_get_glyphs(const RID &p_shaped) const = 0;
530
	TypedArray<Dictionary> _shaped_text_get_glyphs_wrapper(const RID &p_shaped) const;
531
	virtual const Glyph *shaped_text_sort_logical(const RID &p_shaped) = 0;
532
	TypedArray<Dictionary> _shaped_text_sort_logical_wrapper(const RID &p_shaped);
533
	virtual int64_t shaped_text_get_glyph_count(const RID &p_shaped) const = 0;
534

535
	virtual Vector2i shaped_text_get_range(const RID &p_shaped) const = 0;
536

537
	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;
538
	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;
539
	virtual PackedInt32Array shaped_text_get_word_breaks(const RID &p_shaped, BitField<TextServer::GraphemeFlag> p_grapheme_flags = GRAPHEME_IS_SPACE | GRAPHEME_IS_PUNCTUATION, BitField<TextServer::GraphemeFlag> p_skip_grapheme_flags = GRAPHEME_IS_VIRTUAL) const;
540

541
	virtual int64_t shaped_text_get_trim_pos(const RID &p_shaped) const = 0;
542
	virtual int64_t shaped_text_get_ellipsis_pos(const RID &p_shaped) const = 0;
543
	virtual const Glyph *shaped_text_get_ellipsis_glyphs(const RID &p_shaped) const = 0;
544
	TypedArray<Dictionary> _shaped_text_get_ellipsis_glyphs_wrapper(const RID &p_shaped) const;
545
	virtual int64_t shaped_text_get_ellipsis_glyph_count(const RID &p_shaped) const = 0;
546

547
	virtual void shaped_text_overrun_trim_to_width(const RID &p_shaped, double p_width, BitField<TextServer::TextOverrunFlag> p_trim_flags) = 0;
548

549
	virtual Array shaped_text_get_objects(const RID &p_shaped) const = 0;
550
	virtual Rect2 shaped_text_get_object_rect(const RID &p_shaped, const Variant &p_key) const = 0;
551
	virtual Vector2i shaped_text_get_object_range(const RID &p_shaped, const Variant &p_key) const = 0;
552
	virtual int64_t shaped_text_get_object_glyph(const RID &p_shaped, const Variant &p_key) const = 0;
553

554
	virtual Size2 shaped_text_get_size(const RID &p_shaped) const = 0;
555
	virtual double shaped_text_get_ascent(const RID &p_shaped) const = 0;
556
	virtual double shaped_text_get_descent(const RID &p_shaped) const = 0;
557
	virtual double shaped_text_get_width(const RID &p_shaped) const = 0;
558
	virtual double shaped_text_get_underline_position(const RID &p_shaped) const = 0;
559
	virtual double shaped_text_get_underline_thickness(const RID &p_shaped) const = 0;
560

561
	virtual Direction shaped_text_get_dominant_direction_in_range(const RID &p_shaped, int64_t p_start, int64_t p_end) const;
562

563
	virtual CaretInfo shaped_text_get_carets(const RID &p_shaped, int64_t p_position) const;
564
	Dictionary _shaped_text_get_carets_wrapper(const RID &p_shaped, int64_t p_position) const;
565

566
	virtual Vector<Vector2> shaped_text_get_selection(const RID &p_shaped, int64_t p_start, int64_t p_end) const;
567

568
	virtual int64_t shaped_text_hit_test_grapheme(const RID &p_shaped, double p_coords) const; // Return grapheme index.
569
	virtual int64_t shaped_text_hit_test_position(const RID &p_shaped, double p_coords) const; // Return caret/selection position.
570

571
	virtual Vector2 shaped_text_get_grapheme_bounds(const RID &p_shaped, int64_t p_pos) const;
572
	virtual int64_t shaped_text_next_grapheme_pos(const RID &p_shaped, int64_t p_pos) const;
573
	virtual int64_t shaped_text_prev_grapheme_pos(const RID &p_shaped, int64_t p_pos) const;
574

575
	virtual PackedInt32Array shaped_text_get_character_breaks(const RID &p_shaped) const = 0;
576
	virtual int64_t shaped_text_next_character_pos(const RID &p_shaped, int64_t p_pos) const;
577
	virtual int64_t shaped_text_prev_character_pos(const RID &p_shaped, int64_t p_pos) const;
578
	virtual int64_t shaped_text_closest_character_pos(const RID &p_shaped, int64_t p_pos) const;
579

580
	// The pen position is always placed on the baseline and moving left to right.
581
	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), float p_oversampling = 0.0) const;
582
	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), float p_oversampling = 0.0) const;
583

584
#ifdef DEBUG_ENABLED
585
	void debug_print_glyph(int p_idx, const Glyph &p_glyph) const;
586
	void shaped_text_debug_print(const RID &p_shaped) const;
587
#endif
588

589
#ifndef DISABLE_DEPRECATED
590
	// Number conversion.
591
	virtual String format_number(const String &p_string, const String &p_language = "") const;
592
	virtual String parse_number(const String &p_string, const String &p_language = "") const;
593
	virtual String percent_sign(const String &p_language = "") const;
594
#endif // DISABLE_DEPRECATED
595

596
	// String functions.
597
	virtual PackedInt32Array string_get_word_breaks(const String &p_string, const String &p_language = "", int64_t p_chars_per_line = 0) const = 0;
598
	virtual PackedInt32Array string_get_character_breaks(const String &p_string, const String &p_language = "") const;
599

600
	virtual int64_t is_confusable(const String &p_string, const PackedStringArray &p_dict) const { return -1; }
601
	virtual bool spoof_check(const String &p_string) const { return false; }
602

603
	virtual String strip_diacritics(const String &p_string) const;
604
	virtual bool is_valid_identifier(const String &p_string) const;
605
	virtual bool is_valid_letter(uint64_t p_unicode) const;
606

607
	// Other string operations.
608
	virtual String string_to_upper(const String &p_string, const String &p_language = "") const = 0;
609
	virtual String string_to_lower(const String &p_string, const String &p_language = "") const = 0;
610
	virtual String string_to_title(const String &p_string, const String &p_language = "") const = 0;
611

612
	TypedArray<Vector3i> parse_structured_text(StructuredTextParser p_parser_type, const Array &p_args, const String &p_text) const;
613

614
	static void set_current_drawn_item_oversampling(double p_vp_oversampling) { vp_oversampling = p_vp_oversampling; }
615
	static double get_current_drawn_item_oversampling() { return vp_oversampling; }
616

617
	virtual void cleanup() {}
618

619
	TextServer();
620
	~TextServer();
621
};
622

623
/*************************************************************************/
624

625
struct Glyph {
626
	int start = -1; // Start offset in the source string.
627
	int end = -1; // End offset in the source string.
628

629
	uint8_t count = 0; // Number of glyphs in the grapheme, set in the first glyph only.
630
	uint8_t repeat = 1; // Draw multiple times in the row.
631
	uint16_t flags = 0; // Grapheme flags (valid, rtl, virtual), set in the first glyph only.
632

633
	float x_off = 0.f; // Offset from the origin of the glyph on baseline.
634
	float y_off = 0.f;
635
	float advance = 0.f; // Advance to the next glyph along baseline(x for horizontal layout, y for vertical).
636

637
	RID font_rid; // Font resource.
638
	int font_size = 0; // Font size.
639
	int32_t index = 0; // Glyph index (font specific) or UTF-32 codepoint (for the invalid glyphs).
640

641
	int span_index = -1;
642

643
	bool operator==(const Glyph &p_a) const;
644
	bool operator!=(const Glyph &p_a) const;
645

646
	bool operator<(const Glyph &p_a) const;
647
	bool operator>(const Glyph &p_a) const;
648
};
649

650
struct CaretInfo {
651
	Rect2 l_caret;
652
	Rect2 t_caret;
653
	TextServer::Direction l_dir;
654
	TextServer::Direction t_dir;
655
};
656

657
/*************************************************************************/
658

659
class TextServerManager : public Object {
660
	GDCLASS(TextServerManager, Object);
661

662
protected:
663
	static void _bind_methods();
664

665
private:
666
	static TextServerManager *singleton;
667

668
	Ref<TextServer> primary_interface;
669
	Vector<Ref<TextServer>> interfaces;
670

671
public:
672
	_FORCE_INLINE_ static TextServerManager *get_singleton() {
673
		return singleton;
674
	}
675

676
	void add_interface(const Ref<TextServer> &p_interface);
677
	void remove_interface(const Ref<TextServer> &p_interface);
678
	int get_interface_count() const;
679
	Ref<TextServer> get_interface(int p_index) const;
680
	Ref<TextServer> find_interface(const String &p_name) const;
681
	TypedArray<Dictionary> get_interfaces() const;
682

683
	_FORCE_INLINE_ Ref<TextServer> get_primary_interface() const {
684
		return primary_interface;
685
	}
686
	void set_primary_interface(const Ref<TextServer> &p_primary_interface);
687

688
	TextServerManager();
689
	~TextServerManager();
690
};
691

692
/*************************************************************************/
693

694
#define TS TextServerManager::get_singleton()->get_primary_interface()
695

696
VARIANT_ENUM_CAST(TextServer::VisibleCharactersBehavior);
697
VARIANT_ENUM_CAST(TextServer::AutowrapMode);
698
VARIANT_ENUM_CAST(TextServer::OverrunBehavior);
699
VARIANT_ENUM_CAST(TextServer::Direction);
700
VARIANT_ENUM_CAST(TextServer::Orientation);
701
VARIANT_BITFIELD_CAST(TextServer::JustificationFlag);
702
VARIANT_BITFIELD_CAST(TextServer::LineBreakFlag);
703
VARIANT_BITFIELD_CAST(TextServer::TextOverrunFlag);
704
VARIANT_BITFIELD_CAST(TextServer::GraphemeFlag);
705
VARIANT_ENUM_CAST(TextServer::Hinting);
706
VARIANT_ENUM_CAST(TextServer::SubpixelPositioning);
707
VARIANT_ENUM_CAST(TextServer::Feature);
708
VARIANT_ENUM_CAST(TextServer::ContourPointTag);
709
VARIANT_ENUM_CAST(TextServer::SpacingType);
710
VARIANT_BITFIELD_CAST(TextServer::FontStyle);
711
VARIANT_ENUM_CAST(TextServer::StructuredTextParser);
712
VARIANT_ENUM_CAST(TextServer::FontAntialiasing);
713
VARIANT_ENUM_CAST(TextServer::FontLCDSubpixelLayout);
714
VARIANT_ENUM_CAST(TextServer::FixedSizeScaleMode);
715

716
GDVIRTUAL_NATIVE_PTR(Glyph);
717
GDVIRTUAL_NATIVE_PTR(CaretInfo);
718

719
Product

Resources

Company
