text_server.h 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612
  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. #ifndef TEXT_SERVER_H
  31. #define TEXT_SERVER_H
  32. #include "core/object/ref_counted.h"
  33. #include "core/os/os.h"
  34. #include "core/templates/rid.h"
  35. #include "core/variant/native_ptr.h"
  36. #include "core/variant/variant.h"
  37. template <typename T>
  38. class TypedArray;
  39. struct Glyph;
  40. struct CaretInfo;
  41. class TextServer : public RefCounted {
  42. GDCLASS(TextServer, RefCounted);
  43. public:
  44. enum FontAntialiasing {
  45. FONT_ANTIALIASING_NONE,
  46. FONT_ANTIALIASING_GRAY,
  47. FONT_ANTIALIASING_LCD,
  48. };
  49. enum FontLCDSubpixelLayout {
  50. FONT_LCD_SUBPIXEL_LAYOUT_NONE,
  51. FONT_LCD_SUBPIXEL_LAYOUT_HRGB,
  52. FONT_LCD_SUBPIXEL_LAYOUT_HBGR,
  53. FONT_LCD_SUBPIXEL_LAYOUT_VRGB,
  54. FONT_LCD_SUBPIXEL_LAYOUT_VBGR,
  55. FONT_LCD_SUBPIXEL_LAYOUT_MAX,
  56. };
  57. enum Direction {
  58. DIRECTION_AUTO,
  59. DIRECTION_LTR,
  60. DIRECTION_RTL,
  61. DIRECTION_INHERITED,
  62. };
  63. enum Orientation {
  64. ORIENTATION_HORIZONTAL,
  65. ORIENTATION_VERTICAL
  66. };
  67. enum JustificationFlag {
  68. JUSTIFICATION_NONE = 0,
  69. JUSTIFICATION_KASHIDA = 1 << 0,
  70. JUSTIFICATION_WORD_BOUND = 1 << 1,
  71. JUSTIFICATION_TRIM_EDGE_SPACES = 1 << 2,
  72. JUSTIFICATION_AFTER_LAST_TAB = 1 << 3,
  73. JUSTIFICATION_CONSTRAIN_ELLIPSIS = 1 << 4,
  74. };
  75. enum VisibleCharactersBehavior {
  76. VC_CHARS_BEFORE_SHAPING,
  77. VC_CHARS_AFTER_SHAPING,
  78. VC_GLYPHS_AUTO,
  79. VC_GLYPHS_LTR,
  80. VC_GLYPHS_RTL,
  81. };
  82. enum AutowrapMode {
  83. AUTOWRAP_OFF,
  84. AUTOWRAP_ARBITRARY,
  85. AUTOWRAP_WORD,
  86. AUTOWRAP_WORD_SMART
  87. };
  88. enum LineBreakFlag {
  89. BREAK_NONE = 0,
  90. BREAK_MANDATORY = 1 << 0,
  91. BREAK_WORD_BOUND = 1 << 1,
  92. BREAK_GRAPHEME_BOUND = 1 << 2,
  93. BREAK_ADAPTIVE = 1 << 3,
  94. BREAK_TRIM_EDGE_SPACES = 1 << 4,
  95. };
  96. enum OverrunBehavior {
  97. OVERRUN_NO_TRIMMING,
  98. OVERRUN_TRIM_CHAR,
  99. OVERRUN_TRIM_WORD,
  100. OVERRUN_TRIM_ELLIPSIS,
  101. OVERRUN_TRIM_WORD_ELLIPSIS,
  102. };
  103. enum TextOverrunFlag {
  104. OVERRUN_NO_TRIM = 0,
  105. OVERRUN_TRIM = 1 << 0,
  106. OVERRUN_TRIM_WORD_ONLY = 1 << 1,
  107. OVERRUN_ADD_ELLIPSIS = 1 << 2,
  108. OVERRUN_ENFORCE_ELLIPSIS = 1 << 3,
  109. OVERRUN_JUSTIFICATION_AWARE = 1 << 4,
  110. };
  111. enum GraphemeFlag {
  112. GRAPHEME_IS_VALID = 1 << 0, // Grapheme is valid.
  113. GRAPHEME_IS_RTL = 1 << 1, // Grapheme is right-to-left.
  114. GRAPHEME_IS_VIRTUAL = 1 << 2, // Grapheme is not part of source string (added by fit_to_width function, do not affect caret movement).
  115. GRAPHEME_IS_SPACE = 1 << 3, // Is whitespace (for justification and word breaks).
  116. GRAPHEME_IS_BREAK_HARD = 1 << 4, // Is line break (mandatory break, e.g. "\n").
  117. GRAPHEME_IS_BREAK_SOFT = 1 << 5, // Is line break (optional break, e.g. space).
  118. GRAPHEME_IS_TAB = 1 << 6, // Is tab or vertical tab.
  119. GRAPHEME_IS_ELONGATION = 1 << 7, // Elongation (e.g. kashida), grapheme can be duplicated or truncated to fit line to width.
  120. GRAPHEME_IS_PUNCTUATION = 1 << 8, // Punctuation, except underscore (can be used as word break, but not line break or justifiction).
  121. GRAPHEME_IS_UNDERSCORE = 1 << 9, // Underscore (can be used as word break).
  122. GRAPHEME_IS_CONNECTED = 1 << 10, // Connected to previous grapheme.
  123. GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL = 1 << 11, // It is safe to insert a U+0640 before this grapheme for elongation.
  124. GRAPHEME_IS_EMBEDDED_OBJECT = 1 << 12, // Grapheme is an object replacement character for the embedded object.
  125. };
  126. enum Hinting {
  127. HINTING_NONE,
  128. HINTING_LIGHT,
  129. HINTING_NORMAL
  130. };
  131. enum SubpixelPositioning {
  132. SUBPIXEL_POSITIONING_DISABLED = 0,
  133. SUBPIXEL_POSITIONING_AUTO = 1,
  134. SUBPIXEL_POSITIONING_ONE_HALF = 2,
  135. SUBPIXEL_POSITIONING_ONE_QUARTER = 3,
  136. SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE = 20,
  137. SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE = 16,
  138. };
  139. enum Feature {
  140. FEATURE_SIMPLE_LAYOUT = 1 << 0,
  141. FEATURE_BIDI_LAYOUT = 1 << 1,
  142. FEATURE_VERTICAL_LAYOUT = 1 << 2,
  143. FEATURE_SHAPING = 1 << 3,
  144. FEATURE_KASHIDA_JUSTIFICATION = 1 << 4,
  145. FEATURE_BREAK_ITERATORS = 1 << 5,
  146. FEATURE_FONT_BITMAP = 1 << 6,
  147. FEATURE_FONT_DYNAMIC = 1 << 7,
  148. FEATURE_FONT_MSDF = 1 << 8,
  149. FEATURE_FONT_SYSTEM = 1 << 9,
  150. FEATURE_FONT_VARIABLE = 1 << 10,
  151. FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION = 1 << 11,
  152. FEATURE_USE_SUPPORT_DATA = 1 << 12,
  153. FEATURE_UNICODE_IDENTIFIERS = 1 << 13,
  154. FEATURE_UNICODE_SECURITY = 1 << 14,
  155. };
  156. enum ContourPointTag {
  157. CONTOUR_CURVE_TAG_ON = 0x01,
  158. CONTOUR_CURVE_TAG_OFF_CONIC = 0x00,
  159. CONTOUR_CURVE_TAG_OFF_CUBIC = 0x02
  160. };
  161. enum SpacingType {
  162. SPACING_GLYPH,
  163. SPACING_SPACE,
  164. SPACING_TOP,
  165. SPACING_BOTTOM,
  166. SPACING_MAX,
  167. };
  168. enum FontStyle {
  169. FONT_BOLD = 1 << 0,
  170. FONT_ITALIC = 1 << 1,
  171. FONT_FIXED_WIDTH = 1 << 2,
  172. };
  173. enum StructuredTextParser {
  174. STRUCTURED_TEXT_DEFAULT,
  175. STRUCTURED_TEXT_URI,
  176. STRUCTURED_TEXT_FILE,
  177. STRUCTURED_TEXT_EMAIL,
  178. STRUCTURED_TEXT_LIST,
  179. STRUCTURED_TEXT_GDSCRIPT,
  180. STRUCTURED_TEXT_CUSTOM
  181. };
  182. 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;
  183. protected:
  184. HashMap<char32_t, char32_t> diacritics_map;
  185. void _diacritics_map_add(const String &p_from, char32_t p_to);
  186. void _init_diacritics_map();
  187. static void _bind_methods();
  188. public:
  189. virtual bool has_feature(Feature p_feature) const = 0;
  190. virtual String get_name() const = 0;
  191. virtual int64_t get_features() const = 0;
  192. virtual void free_rid(const RID &p_rid) = 0;
  193. virtual bool has(const RID &p_rid) = 0;
  194. virtual bool load_support_data(const String &p_filename) = 0;
  195. virtual String get_support_data_filename() const = 0;
  196. virtual String get_support_data_info() const = 0;
  197. virtual bool save_support_data(const String &p_filename) const = 0;
  198. virtual bool is_locale_right_to_left(const String &p_locale) const = 0;
  199. virtual int64_t name_to_tag(const String &p_name) const { return 0; };
  200. virtual String tag_to_name(int64_t p_tag) const { return ""; };
  201. /* Font interface */
  202. virtual RID create_font() = 0;
  203. virtual void font_set_data(const RID &p_font_rid, const PackedByteArray &p_data) = 0;
  204. virtual void font_set_data_ptr(const RID &p_font_rid, const uint8_t *p_data_ptr, int64_t p_data_size) = 0;
  205. virtual void font_set_face_index(const RID &p_font_rid, int64_t p_index) = 0;
  206. virtual int64_t font_get_face_index(const RID &p_font_rid) const = 0;
  207. virtual int64_t font_get_face_count(const RID &p_font_rid) const = 0;
  208. virtual void font_set_style(const RID &p_font_rid, BitField<FontStyle> p_style) = 0;
  209. virtual BitField<FontStyle> font_get_style(const RID &p_font_rid) const = 0;
  210. virtual void font_set_name(const RID &p_font_rid, const String &p_name) = 0;
  211. virtual String font_get_name(const RID &p_font_rid) const = 0;
  212. virtual void font_set_style_name(const RID &p_font_rid, const String &p_name) = 0;
  213. virtual String font_get_style_name(const RID &p_font_rid) const = 0;
  214. virtual void font_set_weight(const RID &p_font_rid, int64_t p_weight) = 0;
  215. virtual int64_t font_get_weight(const RID &p_font_rid) const = 0;
  216. virtual void font_set_stretch(const RID &p_font_rid, int64_t p_stretch) = 0;
  217. virtual int64_t font_get_stretch(const RID &p_font_rid) const = 0;
  218. virtual void font_set_antialiasing(const RID &p_font_rid, FontAntialiasing p_antialiasing) = 0;
  219. virtual FontAntialiasing font_get_antialiasing(const RID &p_font_rid) const = 0;
  220. virtual void font_set_generate_mipmaps(const RID &p_font_rid, bool p_generate_mipmaps) = 0;
  221. virtual bool font_get_generate_mipmaps(const RID &p_font_rid) const = 0;
  222. virtual void font_set_multichannel_signed_distance_field(const RID &p_font_rid, bool p_msdf) = 0;
  223. virtual bool font_is_multichannel_signed_distance_field(const RID &p_font_rid) const = 0;
  224. virtual void font_set_msdf_pixel_range(const RID &p_font_rid, int64_t p_msdf_pixel_range) = 0;
  225. virtual int64_t font_get_msdf_pixel_range(const RID &p_font_rid) const = 0;
  226. virtual void font_set_msdf_size(const RID &p_font_rid, int64_t p_msdf_size) = 0;
  227. virtual int64_t font_get_msdf_size(const RID &p_font_rid) const = 0;
  228. virtual void font_set_fixed_size(const RID &p_font_rid, int64_t p_fixed_size) = 0;
  229. virtual int64_t font_get_fixed_size(const RID &p_font_rid) const = 0;
  230. virtual void font_set_allow_system_fallback(const RID &p_font_rid, bool p_allow_system_fallback) = 0;
  231. virtual bool font_is_allow_system_fallback(const RID &p_font_rid) const = 0;
  232. virtual void font_set_force_autohinter(const RID &p_font_rid, bool p_force_autohinter) = 0;
  233. virtual bool font_is_force_autohinter(const RID &p_font_rid) const = 0;
  234. virtual void font_set_hinting(const RID &p_font_rid, Hinting p_hinting) = 0;
  235. virtual Hinting font_get_hinting(const RID &p_font_rid) const = 0;
  236. virtual void font_set_subpixel_positioning(const RID &p_font_rid, SubpixelPositioning p_subpixel) = 0;
  237. virtual SubpixelPositioning font_get_subpixel_positioning(const RID &p_font_rid) const = 0;
  238. virtual void font_set_embolden(const RID &p_font_rid, double p_strength) = 0;
  239. virtual double font_get_embolden(const RID &p_font_rid) const = 0;
  240. virtual void font_set_transform(const RID &p_font_rid, const Transform2D &p_transform) = 0;
  241. virtual Transform2D font_get_transform(const RID &p_font_rid) const = 0;
  242. virtual void font_set_variation_coordinates(const RID &p_font_rid, const Dictionary &p_variation_coordinates) = 0;
  243. virtual Dictionary font_get_variation_coordinates(const RID &p_font_rid) const = 0;
  244. virtual void font_set_oversampling(const RID &p_font_rid, double p_oversampling) = 0;
  245. virtual double font_get_oversampling(const RID &p_font_rid) const = 0;
  246. virtual TypedArray<Vector2i> font_get_size_cache_list(const RID &p_font_rid) const = 0;
  247. virtual void font_clear_size_cache(const RID &p_font_rid) = 0;
  248. virtual void font_remove_size_cache(const RID &p_font_rid, const Vector2i &p_size) = 0;
  249. virtual void font_set_ascent(const RID &p_font_rid, int64_t p_size, double p_ascent) = 0;
  250. virtual double font_get_ascent(const RID &p_font_rid, int64_t p_size) const = 0;
  251. virtual void font_set_descent(const RID &p_font_rid, int64_t p_size, double p_descent) = 0;
  252. virtual double font_get_descent(const RID &p_font_rid, int64_t p_size) const = 0;
  253. virtual void font_set_underline_position(const RID &p_font_rid, int64_t p_size, double p_underline_position) = 0;
  254. virtual double font_get_underline_position(const RID &p_font_rid, int64_t p_size) const = 0;
  255. virtual void font_set_underline_thickness(const RID &p_font_rid, int64_t p_size, double p_underline_thickness) = 0;
  256. virtual double font_get_underline_thickness(const RID &p_font_rid, int64_t p_size) const = 0;
  257. virtual void font_set_scale(const RID &p_font_rid, int64_t p_size, double p_scale) = 0;
  258. virtual double font_get_scale(const RID &p_font_rid, int64_t p_size) const = 0;
  259. virtual int64_t font_get_texture_count(const RID &p_font_rid, const Vector2i &p_size) const = 0;
  260. virtual void font_clear_textures(const RID &p_font_rid, const Vector2i &p_size) = 0;
  261. virtual void font_remove_texture(const RID &p_font_rid, const Vector2i &p_size, int64_t p_texture_index) = 0;
  262. 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;
  263. virtual Ref<Image> font_get_texture_image(const RID &p_font_rid, const Vector2i &p_size, int64_t p_texture_index) const = 0;
  264. 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;
  265. virtual PackedInt32Array font_get_texture_offsets(const RID &p_font_rid, const Vector2i &p_size, int64_t p_texture_index) const = 0;
  266. virtual PackedInt32Array font_get_glyph_list(const RID &p_font_rid, const Vector2i &p_size) const = 0;
  267. virtual void font_clear_glyphs(const RID &p_font_rid, const Vector2i &p_size) = 0;
  268. virtual void font_remove_glyph(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) = 0;
  269. virtual Vector2 font_get_glyph_advance(const RID &p_font_rid, int64_t p_size, int64_t p_glyph) const = 0;
  270. virtual void font_set_glyph_advance(const RID &p_font_rid, int64_t p_size, int64_t p_glyph, const Vector2 &p_advance) = 0;
  271. virtual Vector2 font_get_glyph_offset(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
  272. virtual void font_set_glyph_offset(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph, const Vector2 &p_offset) = 0;
  273. virtual Vector2 font_get_glyph_size(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
  274. 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;
  275. virtual Rect2 font_get_glyph_uv_rect(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
  276. 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;
  277. virtual int64_t font_get_glyph_texture_idx(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
  278. 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;
  279. virtual RID font_get_glyph_texture_rid(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
  280. virtual Size2 font_get_glyph_texture_size(const RID &p_font_rid, const Vector2i &p_size, int64_t p_glyph) const = 0;
  281. virtual Dictionary font_get_glyph_contours(const RID &p_font, int64_t p_size, int64_t p_index) const = 0;
  282. virtual TypedArray<Vector2i> font_get_kerning_list(const RID &p_font_rid, int64_t p_size) const = 0;
  283. virtual void font_clear_kerning_map(const RID &p_font_rid, int64_t p_size) = 0;
  284. virtual void font_remove_kerning(const RID &p_font_rid, int64_t p_size, const Vector2i &p_glyph_pair) = 0;
  285. virtual void font_set_kerning(const RID &p_font_rid, int64_t p_size, const Vector2i &p_glyph_pair, const Vector2 &p_kerning) = 0;
  286. virtual Vector2 font_get_kerning(const RID &p_font_rid, int64_t p_size, const Vector2i &p_glyph_pair) const = 0;
  287. 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;
  288. virtual bool font_has_char(const RID &p_font_rid, int64_t p_char) const = 0;
  289. virtual String font_get_supported_chars(const RID &p_font_rid) const = 0;
  290. virtual void font_render_range(const RID &p_font, const Vector2i &p_size, int64_t p_start, int64_t p_end) = 0;
  291. virtual void font_render_glyph(const RID &p_font_rid, const Vector2i &p_size, int64_t p_index) = 0;
  292. 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;
  293. 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;
  294. virtual bool font_is_language_supported(const RID &p_font_rid, const String &p_language) const = 0;
  295. virtual void font_set_language_support_override(const RID &p_font_rid, const String &p_language, bool p_supported) = 0;
  296. virtual bool font_get_language_support_override(const RID &p_font_rid, const String &p_language) = 0;
  297. virtual void font_remove_language_support_override(const RID &p_font_rid, const String &p_language) = 0;
  298. virtual PackedStringArray font_get_language_support_overrides(const RID &p_font_rid) = 0;
  299. virtual bool font_is_script_supported(const RID &p_font_rid, const String &p_script) const = 0;
  300. virtual void font_set_script_support_override(const RID &p_font_rid, const String &p_script, bool p_supported) = 0;
  301. virtual bool font_get_script_support_override(const RID &p_font_rid, const String &p_script) = 0;
  302. virtual void font_remove_script_support_override(const RID &p_font_rid, const String &p_script) = 0;
  303. virtual PackedStringArray font_get_script_support_overrides(const RID &p_font_rid) = 0;
  304. virtual void font_set_opentype_feature_overrides(const RID &p_font_rid, const Dictionary &p_overrides) = 0;
  305. virtual Dictionary font_get_opentype_feature_overrides(const RID &p_font_rid) const = 0;
  306. virtual Dictionary font_supported_feature_list(const RID &p_font_rid) const = 0;
  307. virtual Dictionary font_supported_variation_list(const RID &p_font_rid) const = 0;
  308. virtual double font_get_global_oversampling() const = 0;
  309. virtual void font_set_global_oversampling(double p_oversampling) = 0;
  310. virtual Vector2 get_hex_code_box_size(int64_t p_size, int64_t p_index) const;
  311. 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;
  312. /* Shaped text buffer interface */
  313. virtual RID create_shaped_text(Direction p_direction = DIRECTION_AUTO, Orientation p_orientation = ORIENTATION_HORIZONTAL) = 0;
  314. virtual void shaped_text_clear(const RID &p_shaped) = 0;
  315. virtual void shaped_text_set_direction(const RID &p_shaped, Direction p_direction = DIRECTION_AUTO) = 0;
  316. virtual Direction shaped_text_get_direction(const RID &p_shaped) const = 0;
  317. virtual Direction shaped_text_get_inferred_direction(const RID &p_shaped) const = 0;
  318. virtual void shaped_text_set_bidi_override(const RID &p_shaped, const Array &p_override) = 0;
  319. virtual void shaped_text_set_custom_punctuation(const RID &p_shaped, const String &p_punct) = 0;
  320. virtual String shaped_text_get_custom_punctuation(const RID &p_shaped) const = 0;
  321. virtual void shaped_text_set_orientation(const RID &p_shaped, Orientation p_orientation = ORIENTATION_HORIZONTAL) = 0;
  322. virtual Orientation shaped_text_get_orientation(const RID &p_shaped) const = 0;
  323. virtual void shaped_text_set_preserve_invalid(const RID &p_shaped, bool p_enabled) = 0;
  324. virtual bool shaped_text_get_preserve_invalid(const RID &p_shaped) const = 0;
  325. virtual void shaped_text_set_preserve_control(const RID &p_shaped, bool p_enabled) = 0;
  326. virtual bool shaped_text_get_preserve_control(const RID &p_shaped) const = 0;
  327. virtual void shaped_text_set_spacing(const RID &p_shaped, SpacingType p_spacing, int64_t p_value) = 0;
  328. virtual int64_t shaped_text_get_spacing(const RID &p_shaped, SpacingType p_spacing) const = 0;
  329. 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;
  330. 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;
  331. 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;
  332. virtual int64_t shaped_get_span_count(const RID &p_shaped) const = 0;
  333. virtual Variant shaped_get_span_meta(const RID &p_shaped, int64_t p_index) const = 0;
  334. 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;
  335. 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.
  336. virtual RID shaped_text_get_parent(const RID &p_shaped) const = 0;
  337. 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;
  338. virtual double shaped_text_tab_align(const RID &p_shaped, const PackedFloat32Array &p_tab_stops) = 0;
  339. virtual bool shaped_text_shape(const RID &p_shaped) = 0;
  340. virtual bool shaped_text_update_breaks(const RID &p_shaped) = 0;
  341. virtual bool shaped_text_update_justification_ops(const RID &p_shaped) = 0;
  342. virtual bool shaped_text_is_ready(const RID &p_shaped) const = 0;
  343. virtual const Glyph *shaped_text_get_glyphs(const RID &p_shaped) const = 0;
  344. TypedArray<Dictionary> _shaped_text_get_glyphs_wrapper(const RID &p_shaped) const;
  345. virtual const Glyph *shaped_text_sort_logical(const RID &p_shaped) = 0;
  346. TypedArray<Dictionary> _shaped_text_sort_logical_wrapper(const RID &p_shaped);
  347. virtual int64_t shaped_text_get_glyph_count(const RID &p_shaped) const = 0;
  348. virtual Vector2i shaped_text_get_range(const RID &p_shaped) const = 0;
  349. 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;
  350. 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;
  351. virtual PackedInt32Array shaped_text_get_word_breaks(const RID &p_shaped, BitField<TextServer::GraphemeFlag> p_grapheme_flags = GRAPHEME_IS_SPACE | GRAPHEME_IS_PUNCTUATION) const;
  352. virtual int64_t shaped_text_get_trim_pos(const RID &p_shaped) const = 0;
  353. virtual int64_t shaped_text_get_ellipsis_pos(const RID &p_shaped) const = 0;
  354. virtual const Glyph *shaped_text_get_ellipsis_glyphs(const RID &p_shaped) const = 0;
  355. TypedArray<Dictionary> _shaped_text_get_ellipsis_glyphs_wrapper(const RID &p_shaped) const;
  356. virtual int64_t shaped_text_get_ellipsis_glyph_count(const RID &p_shaped) const = 0;
  357. virtual void shaped_text_overrun_trim_to_width(const RID &p_shaped, double p_width, BitField<TextServer::TextOverrunFlag> p_trim_flags) = 0;
  358. virtual Array shaped_text_get_objects(const RID &p_shaped) const = 0;
  359. virtual Rect2 shaped_text_get_object_rect(const RID &p_shaped, const Variant &p_key) const = 0;
  360. virtual Size2 shaped_text_get_size(const RID &p_shaped) const = 0;
  361. virtual double shaped_text_get_ascent(const RID &p_shaped) const = 0;
  362. virtual double shaped_text_get_descent(const RID &p_shaped) const = 0;
  363. virtual double shaped_text_get_width(const RID &p_shaped) const = 0;
  364. virtual double shaped_text_get_underline_position(const RID &p_shaped) const = 0;
  365. virtual double shaped_text_get_underline_thickness(const RID &p_shaped) const = 0;
  366. virtual Direction shaped_text_get_dominant_direction_in_range(const RID &p_shaped, int64_t p_start, int64_t p_end) const;
  367. virtual CaretInfo shaped_text_get_carets(const RID &p_shaped, int64_t p_position) const;
  368. Dictionary _shaped_text_get_carets_wrapper(const RID &p_shaped, int64_t p_position) const;
  369. virtual Vector<Vector2> shaped_text_get_selection(const RID &p_shaped, int64_t p_start, int64_t p_end) const;
  370. virtual int64_t shaped_text_hit_test_grapheme(const RID &p_shaped, double p_coords) const; // Return grapheme index.
  371. virtual int64_t shaped_text_hit_test_position(const RID &p_shaped, double p_coords) const; // Return caret/selection position.
  372. virtual Vector2 shaped_text_get_grapheme_bounds(const RID &p_shaped, int64_t p_pos) const;
  373. virtual int64_t shaped_text_next_grapheme_pos(const RID &p_shaped, int64_t p_pos) const;
  374. virtual int64_t shaped_text_prev_grapheme_pos(const RID &p_shaped, int64_t p_pos) const;
  375. // The pen position is always placed on the baseline and moveing left to right.
  376. 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;
  377. 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;
  378. // Number conversion.
  379. virtual String format_number(const String &p_string, const String &p_language = "") const = 0;
  380. virtual String parse_number(const String &p_string, const String &p_language = "") const = 0;
  381. virtual String percent_sign(const String &p_language = "") const = 0;
  382. // String functions.
  383. virtual PackedInt32Array string_get_word_breaks(const String &p_string, const String &p_language = "", int64_t p_chars_per_line = 0) const = 0;
  384. virtual int64_t is_confusable(const String &p_string, const PackedStringArray &p_dict) const { return -1; };
  385. virtual bool spoof_check(const String &p_string) const { return false; };
  386. virtual String strip_diacritics(const String &p_string) const;
  387. virtual bool is_valid_identifier(const String &p_string) const;
  388. // Other string operations.
  389. virtual String string_to_upper(const String &p_string, const String &p_language = "") const = 0;
  390. virtual String string_to_lower(const String &p_string, const String &p_language = "") const = 0;
  391. TypedArray<Vector3i> parse_structured_text(StructuredTextParser p_parser_type, const Array &p_args, const String &p_text) const;
  392. virtual void cleanup() {}
  393. TextServer();
  394. ~TextServer();
  395. };
  396. /*************************************************************************/
  397. struct Glyph {
  398. int start = -1; // Start offset in the source string.
  399. int end = -1; // End offset in the source string.
  400. uint8_t count = 0; // Number of glyphs in the grapheme, set in the first glyph only.
  401. uint8_t repeat = 1; // Draw multiple times in the row.
  402. uint16_t flags = 0; // Grapheme flags (valid, rtl, virtual), set in the first glyph only.
  403. float x_off = 0.f; // Offset from the origin of the glyph on baseline.
  404. float y_off = 0.f;
  405. float advance = 0.f; // Advance to the next glyph along baseline(x for horizontal layout, y for vertical).
  406. RID font_rid; // Font resource.
  407. int font_size = 0; // Font size;
  408. int32_t index = 0; // Glyph index (font specific) or UTF-32 codepoint (for the invalid glyphs).
  409. bool operator==(const Glyph &p_a) const;
  410. bool operator!=(const Glyph &p_a) const;
  411. bool operator<(const Glyph &p_a) const;
  412. bool operator>(const Glyph &p_a) const;
  413. };
  414. struct CaretInfo {
  415. Rect2 l_caret;
  416. Rect2 t_caret;
  417. TextServer::Direction l_dir;
  418. TextServer::Direction t_dir;
  419. };
  420. /*************************************************************************/
  421. class TextServerManager : public Object {
  422. GDCLASS(TextServerManager, Object);
  423. protected:
  424. static void _bind_methods();
  425. private:
  426. static TextServerManager *singleton;
  427. Ref<TextServer> primary_interface;
  428. Vector<Ref<TextServer>> interfaces;
  429. public:
  430. _FORCE_INLINE_ static TextServerManager *get_singleton() {
  431. return singleton;
  432. }
  433. void add_interface(const Ref<TextServer> &p_interface);
  434. void remove_interface(const Ref<TextServer> &p_interface);
  435. int get_interface_count() const;
  436. Ref<TextServer> get_interface(int p_index) const;
  437. Ref<TextServer> find_interface(const String &p_name) const;
  438. TypedArray<Dictionary> get_interfaces() const;
  439. _FORCE_INLINE_ Ref<TextServer> get_primary_interface() const {
  440. return primary_interface;
  441. }
  442. void set_primary_interface(const Ref<TextServer> &p_primary_interface);
  443. TextServerManager();
  444. ~TextServerManager();
  445. };
  446. /*************************************************************************/
  447. #define TS TextServerManager::get_singleton()->get_primary_interface()
  448. VARIANT_ENUM_CAST(TextServer::VisibleCharactersBehavior);
  449. VARIANT_ENUM_CAST(TextServer::AutowrapMode);
  450. VARIANT_ENUM_CAST(TextServer::OverrunBehavior);
  451. VARIANT_ENUM_CAST(TextServer::Direction);
  452. VARIANT_ENUM_CAST(TextServer::Orientation);
  453. VARIANT_BITFIELD_CAST(TextServer::JustificationFlag);
  454. VARIANT_BITFIELD_CAST(TextServer::LineBreakFlag);
  455. VARIANT_BITFIELD_CAST(TextServer::TextOverrunFlag);
  456. VARIANT_BITFIELD_CAST(TextServer::GraphemeFlag);
  457. VARIANT_ENUM_CAST(TextServer::Hinting);
  458. VARIANT_ENUM_CAST(TextServer::SubpixelPositioning);
  459. VARIANT_ENUM_CAST(TextServer::Feature);
  460. VARIANT_ENUM_CAST(TextServer::ContourPointTag);
  461. VARIANT_ENUM_CAST(TextServer::SpacingType);
  462. VARIANT_BITFIELD_CAST(TextServer::FontStyle);
  463. VARIANT_ENUM_CAST(TextServer::StructuredTextParser);
  464. VARIANT_ENUM_CAST(TextServer::FontAntialiasing);
  465. VARIANT_ENUM_CAST(TextServer::FontLCDSubpixelLayout);
  466. GDVIRTUAL_NATIVE_PTR(Glyph);
  467. GDVIRTUAL_NATIVE_PTR(CaretInfo);
  468. #endif // TEXT_SERVER_H