text_server_fb.h 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878
  1. /**************************************************************************/
  2. /* text_server_fb.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_FB_H
  31. #define TEXT_SERVER_FB_H
  32. /*************************************************************************/
  33. /* Fallback Text Server provides simplified TS functionality, without */
  34. /* BiDi, shaping and advanced font features support. */
  35. /*************************************************************************/
  36. #ifdef GDEXTENSION
  37. // Headers for building as GDExtension plug-in.
  38. #include <godot_cpp/godot.hpp>
  39. #include <godot_cpp/core/class_db.hpp>
  40. #include <godot_cpp/core/ext_wrappers.gen.inc>
  41. #include <godot_cpp/core/mutex_lock.hpp>
  42. #include <godot_cpp/variant/array.hpp>
  43. #include <godot_cpp/variant/dictionary.hpp>
  44. #include <godot_cpp/variant/packed_int32_array.hpp>
  45. #include <godot_cpp/variant/packed_string_array.hpp>
  46. #include <godot_cpp/variant/packed_vector2_array.hpp>
  47. #include <godot_cpp/variant/rect2.hpp>
  48. #include <godot_cpp/variant/rid.hpp>
  49. #include <godot_cpp/variant/string.hpp>
  50. #include <godot_cpp/variant/typed_array.hpp>
  51. #include <godot_cpp/variant/vector2.hpp>
  52. #include <godot_cpp/variant/vector2i.hpp>
  53. #include <godot_cpp/classes/text_server.hpp>
  54. #include <godot_cpp/classes/text_server_extension.hpp>
  55. #include <godot_cpp/classes/text_server_manager.hpp>
  56. #include <godot_cpp/classes/caret_info.hpp>
  57. #include <godot_cpp/classes/global_constants_binds.hpp>
  58. #include <godot_cpp/classes/glyph.hpp>
  59. #include <godot_cpp/classes/image.hpp>
  60. #include <godot_cpp/classes/image_texture.hpp>
  61. #include <godot_cpp/classes/ref.hpp>
  62. #include <godot_cpp/classes/worker_thread_pool.hpp>
  63. #include <godot_cpp/templates/hash_map.hpp>
  64. #include <godot_cpp/templates/hash_set.hpp>
  65. #include <godot_cpp/templates/rid_owner.hpp>
  66. #include <godot_cpp/templates/safe_refcount.hpp>
  67. #include <godot_cpp/templates/vector.hpp>
  68. using namespace godot;
  69. #elif defined(GODOT_MODULE)
  70. // Headers for building as built-in module.
  71. #include "core/extension/ext_wrappers.gen.inc"
  72. #include "core/object/worker_thread_pool.h"
  73. #include "core/templates/hash_map.h"
  74. #include "core/templates/rid_owner.h"
  75. #include "core/templates/safe_refcount.h"
  76. #include "scene/resources/image_texture.h"
  77. #include "servers/text/text_server_extension.h"
  78. #include "modules/modules_enabled.gen.h" // For freetype, msdfgen, svg.
  79. #endif
  80. // Thirdparty headers.
  81. #ifdef MODULE_FREETYPE_ENABLED
  82. #include <ft2build.h>
  83. #include FT_FREETYPE_H
  84. #include FT_TRUETYPE_TABLES_H
  85. #include FT_STROKER_H
  86. #include FT_ADVANCES_H
  87. #include FT_MULTIPLE_MASTERS_H
  88. #include FT_BBOX_H
  89. #include FT_MODULE_H
  90. #include FT_CONFIG_OPTIONS_H
  91. #if !defined(FT_CONFIG_OPTION_USE_BROTLI) && !defined(_MSC_VER)
  92. #warning FreeType is configured without Brotli support, built-in fonts will not be available.
  93. #endif
  94. #endif
  95. /*************************************************************************/
  96. class TextServerFallback : public TextServerExtension {
  97. GDCLASS(TextServerFallback, TextServerExtension);
  98. _THREAD_SAFE_CLASS_
  99. HashMap<StringName, int32_t> feature_sets;
  100. HashMap<int32_t, StringName> feature_sets_inv;
  101. SafeNumeric<TextServer::FontLCDSubpixelLayout> lcd_subpixel_layout{ TextServer::FontLCDSubpixelLayout::FONT_LCD_SUBPIXEL_LAYOUT_NONE };
  102. void _update_settings();
  103. void _insert_feature_sets();
  104. _FORCE_INLINE_ void _insert_feature(const StringName &p_name, int32_t p_tag);
  105. // Font cache data.
  106. #ifdef MODULE_FREETYPE_ENABLED
  107. mutable FT_Library ft_library = nullptr;
  108. #endif
  109. const int rect_range = 1;
  110. struct FontTexturePosition {
  111. int32_t index = -1;
  112. int32_t x = 0;
  113. int32_t y = 0;
  114. FontTexturePosition() {}
  115. FontTexturePosition(int32_t p_id, int32_t p_x, int32_t p_y) :
  116. index(p_id), x(p_x), y(p_y) {}
  117. };
  118. struct Shelf {
  119. int32_t x = 0;
  120. int32_t y = 0;
  121. int32_t w = 0;
  122. int32_t h = 0;
  123. FontTexturePosition alloc_shelf(int32_t p_id, int32_t p_w, int32_t p_h) {
  124. if (p_w > w || p_h > h) {
  125. return FontTexturePosition(-1, 0, 0);
  126. }
  127. int32_t xx = x;
  128. x += p_w;
  129. w -= p_w;
  130. return FontTexturePosition(p_id, xx, y);
  131. }
  132. Shelf() {}
  133. Shelf(int32_t p_x, int32_t p_y, int32_t p_w, int32_t p_h) :
  134. x(p_x), y(p_y), w(p_w), h(p_h) {}
  135. };
  136. struct ShelfPackTexture {
  137. int32_t texture_w = 1024;
  138. int32_t texture_h = 1024;
  139. Ref<Image> image;
  140. Ref<ImageTexture> texture;
  141. bool dirty = true;
  142. List<Shelf> shelves;
  143. FontTexturePosition pack_rect(int32_t p_id, int32_t p_h, int32_t p_w) {
  144. int32_t y = 0;
  145. int32_t waste = 0;
  146. Shelf *best_shelf = nullptr;
  147. int32_t best_waste = std::numeric_limits<std::int32_t>::max();
  148. for (Shelf &E : shelves) {
  149. y += E.h;
  150. if (p_w > E.w) {
  151. continue;
  152. }
  153. if (p_h == E.h) {
  154. return E.alloc_shelf(p_id, p_w, p_h);
  155. }
  156. if (p_h > E.h) {
  157. continue;
  158. }
  159. if (p_h < E.h) {
  160. waste = (E.h - p_h) * p_w;
  161. if (waste < best_waste) {
  162. best_waste = waste;
  163. best_shelf = &E;
  164. }
  165. }
  166. }
  167. if (best_shelf) {
  168. return best_shelf->alloc_shelf(p_id, p_w, p_h);
  169. }
  170. if (p_h <= (texture_h - y) && p_w <= texture_w) {
  171. List<Shelf>::Element *E = shelves.push_back(Shelf(0, y, texture_w, p_h));
  172. return E->get().alloc_shelf(p_id, p_w, p_h);
  173. }
  174. return FontTexturePosition(-1, 0, 0);
  175. }
  176. ShelfPackTexture() {}
  177. ShelfPackTexture(int32_t p_w, int32_t p_h) :
  178. texture_w(p_w), texture_h(p_h) {}
  179. };
  180. struct FontGlyph {
  181. bool found = false;
  182. int texture_idx = -1;
  183. Rect2 rect;
  184. Rect2 uv_rect;
  185. Vector2 advance;
  186. bool from_svg = false;
  187. };
  188. struct FontForSizeFallback {
  189. double ascent = 0.0;
  190. double descent = 0.0;
  191. double underline_position = 0.0;
  192. double underline_thickness = 0.0;
  193. double scale = 1.0;
  194. double oversampling = 1.0;
  195. Vector2i size;
  196. Vector<ShelfPackTexture> textures;
  197. HashMap<int32_t, FontGlyph> glyph_map;
  198. HashMap<Vector2i, Vector2> kerning_map;
  199. #ifdef MODULE_FREETYPE_ENABLED
  200. FT_Face face = nullptr;
  201. FT_StreamRec stream;
  202. #endif
  203. ~FontForSizeFallback() {
  204. #ifdef MODULE_FREETYPE_ENABLED
  205. if (face != nullptr) {
  206. FT_Done_Face(face);
  207. }
  208. #endif
  209. }
  210. };
  211. struct FontFallbackLinkedVariation {
  212. RID base_font;
  213. int extra_spacing[4] = { 0, 0, 0, 0 };
  214. double baseline_offset = 0.0;
  215. };
  216. struct FontFallback {
  217. Mutex mutex;
  218. TextServer::FontAntialiasing antialiasing = TextServer::FONT_ANTIALIASING_GRAY;
  219. bool disable_embedded_bitmaps = true;
  220. bool mipmaps = false;
  221. bool msdf = false;
  222. FixedSizeScaleMode fixed_size_scale_mode = FIXED_SIZE_SCALE_DISABLE;
  223. int msdf_range = 14;
  224. int msdf_source_size = 48;
  225. int fixed_size = 0;
  226. bool force_autohinter = false;
  227. bool allow_system_fallback = true;
  228. TextServer::Hinting hinting = TextServer::HINTING_LIGHT;
  229. TextServer::SubpixelPositioning subpixel_positioning = TextServer::SUBPIXEL_POSITIONING_AUTO;
  230. bool keep_rounding_remainders = true;
  231. Dictionary variation_coordinates;
  232. double oversampling = 0.0;
  233. double embolden = 0.0;
  234. Transform2D transform;
  235. BitField<TextServer::FontStyle> style_flags = 0;
  236. String font_name;
  237. String style_name;
  238. int weight = 400;
  239. int stretch = 100;
  240. int extra_spacing[4] = { 0, 0, 0, 0 };
  241. double baseline_offset = 0.0;
  242. HashMap<Vector2i, FontForSizeFallback *> cache;
  243. bool face_init = false;
  244. Dictionary supported_varaitions;
  245. Dictionary feature_overrides;
  246. // Language/script support override.
  247. HashMap<String, bool> language_support_overrides;
  248. HashMap<String, bool> script_support_overrides;
  249. PackedByteArray data;
  250. const uint8_t *data_ptr;
  251. size_t data_size;
  252. int face_index = 0;
  253. ~FontFallback() {
  254. for (const KeyValue<Vector2i, FontForSizeFallback *> &E : cache) {
  255. memdelete(E.value);
  256. }
  257. cache.clear();
  258. }
  259. };
  260. _FORCE_INLINE_ FontTexturePosition find_texture_pos_for_glyph(FontForSizeFallback *p_data, int p_color_size, Image::Format p_image_format, int p_width, int p_height, bool p_msdf) const;
  261. #ifdef MODULE_MSDFGEN_ENABLED
  262. _FORCE_INLINE_ FontGlyph rasterize_msdf(FontFallback *p_font_data, FontForSizeFallback *p_data, int p_pixel_range, int p_rect_margin, FT_Outline *p_outline, const Vector2 &p_advance) const;
  263. #endif
  264. #ifdef MODULE_FREETYPE_ENABLED
  265. _FORCE_INLINE_ FontGlyph rasterize_bitmap(FontForSizeFallback *p_data, int p_rect_margin, FT_Bitmap p_bitmap, int p_yofs, int p_xofs, const Vector2 &p_advance, bool p_bgra) const;
  266. #endif
  267. _FORCE_INLINE_ bool _ensure_glyph(FontFallback *p_font_data, const Vector2i &p_size, int32_t p_glyph, FontGlyph &r_glyph) const;
  268. _FORCE_INLINE_ bool _ensure_cache_for_size(FontFallback *p_font_data, const Vector2i &p_size, FontForSizeFallback *&r_cache_for_size, bool p_silent = false) const;
  269. _FORCE_INLINE_ bool _font_validate(const RID &p_font_rid) const;
  270. _FORCE_INLINE_ void _font_clear_cache(FontFallback *p_font_data);
  271. static void _generateMTSDF_threaded(void *p_td, uint32_t p_y);
  272. _FORCE_INLINE_ Vector2i _get_size(const FontFallback *p_font_data, int p_size) const {
  273. if (p_font_data->msdf) {
  274. return Vector2i(p_font_data->msdf_source_size, 0);
  275. } else if (p_font_data->fixed_size > 0) {
  276. return Vector2i(p_font_data->fixed_size, 0);
  277. } else {
  278. return Vector2i(p_size, 0);
  279. }
  280. }
  281. _FORCE_INLINE_ Vector2i _get_size_outline(const FontFallback *p_font_data, const Vector2i &p_size) const {
  282. if (p_font_data->msdf) {
  283. return Vector2i(p_font_data->msdf_source_size, 0);
  284. } else if (p_font_data->fixed_size > 0) {
  285. return Vector2i(p_font_data->fixed_size, MIN(p_size.y, 1));
  286. } else {
  287. return p_size;
  288. }
  289. }
  290. _FORCE_INLINE_ int _font_get_weight_by_name(const String &p_sty_name) const {
  291. String sty_name = p_sty_name.replace(" ", "").replace("-", "");
  292. if (sty_name.contains("thin") || sty_name.contains("hairline")) {
  293. return 100;
  294. } else if (sty_name.contains("extralight") || sty_name.contains("ultralight")) {
  295. return 200;
  296. } else if (sty_name.contains("light")) {
  297. return 300;
  298. } else if (sty_name.contains("semilight")) {
  299. return 350;
  300. } else if (sty_name.contains("regular")) {
  301. return 400;
  302. } else if (sty_name.contains("medium")) {
  303. return 500;
  304. } else if (sty_name.contains("semibold") || sty_name.contains("demibold")) {
  305. return 600;
  306. } else if (sty_name.contains("bold")) {
  307. return 700;
  308. } else if (sty_name.contains("extrabold") || sty_name.contains("ultrabold")) {
  309. return 800;
  310. } else if (sty_name.contains("black") || sty_name.contains("heavy")) {
  311. return 900;
  312. } else if (sty_name.contains("extrablack") || sty_name.contains("ultrablack")) {
  313. return 950;
  314. }
  315. return 400;
  316. }
  317. _FORCE_INLINE_ int _font_get_stretch_by_name(const String &p_sty_name) const {
  318. String sty_name = p_sty_name.replace(" ", "").replace("-", "");
  319. if (sty_name.contains("ultracondensed")) {
  320. return 50;
  321. } else if (sty_name.contains("extracondensed")) {
  322. return 63;
  323. } else if (sty_name.contains("condensed")) {
  324. return 75;
  325. } else if (sty_name.contains("semicondensed")) {
  326. return 87;
  327. } else if (sty_name.contains("semiexpanded")) {
  328. return 113;
  329. } else if (sty_name.contains("expanded")) {
  330. return 125;
  331. } else if (sty_name.contains("extraexpanded")) {
  332. return 150;
  333. } else if (sty_name.contains("ultraexpanded")) {
  334. return 200;
  335. }
  336. return 100;
  337. }
  338. _FORCE_INLINE_ bool _is_ital_style(const String &p_sty_name) const {
  339. return p_sty_name.contains("italic") || p_sty_name.contains("oblique");
  340. }
  341. // Shaped text cache data.
  342. struct TrimData {
  343. int trim_pos = -1;
  344. int ellipsis_pos = -1;
  345. Vector<Glyph> ellipsis_glyph_buf;
  346. };
  347. struct ShapedTextDataFallback {
  348. Mutex mutex;
  349. /* Source data */
  350. RID parent; // Substring parent ShapedTextData.
  351. int start = 0; // Substring start offset in the parent string.
  352. int end = 0; // Substring end offset in the parent string.
  353. String text;
  354. String custom_punct;
  355. TextServer::Direction direction = DIRECTION_LTR; // Desired text direction.
  356. TextServer::Orientation orientation = ORIENTATION_HORIZONTAL;
  357. struct Span {
  358. int start = -1;
  359. int end = -1;
  360. Array fonts;
  361. int font_size = 0;
  362. Variant embedded_key;
  363. String language;
  364. Dictionary features;
  365. Variant meta;
  366. };
  367. Vector<Span> spans;
  368. int first_span = 0; // First span in the parent ShapedTextData.
  369. int last_span = 0;
  370. struct EmbeddedObject {
  371. int start = -1;
  372. int end = -1;
  373. InlineAlignment inline_align = INLINE_ALIGNMENT_CENTER;
  374. Rect2 rect;
  375. double baseline = 0;
  376. };
  377. HashMap<Variant, EmbeddedObject, VariantHasher, VariantComparator> objects;
  378. /* Shaped data */
  379. TextServer::Direction para_direction = DIRECTION_LTR; // Detected text direction.
  380. SafeFlag valid{ false }; // String is shaped.
  381. bool line_breaks_valid = false; // Line and word break flags are populated (and virtual zero width spaces inserted).
  382. bool justification_ops_valid = false; // Virtual elongation glyphs are added to the string.
  383. bool sort_valid = false;
  384. bool text_trimmed = false;
  385. bool preserve_invalid = true; // Draw hex code box instead of missing characters.
  386. bool preserve_control = false; // Draw control characters.
  387. double ascent = 0.0; // Ascent for horizontal layout, 1/2 of width for vertical.
  388. double descent = 0.0; // Descent for horizontal layout, 1/2 of width for vertical.
  389. double width = 0.0; // Width for horizontal layout, height for vertical.
  390. double width_trimmed = 0.0;
  391. int extra_spacing[4] = { 0, 0, 0, 0 };
  392. double upos = 0.0;
  393. double uthk = 0.0;
  394. char32_t el_char = 0x2026;
  395. TrimData overrun_trim_data;
  396. bool fit_width_minimum_reached = false;
  397. Vector<Glyph> glyphs;
  398. Vector<Glyph> glyphs_logical;
  399. };
  400. // Common data.
  401. double oversampling = 1.0;
  402. mutable RID_PtrOwner<FontFallbackLinkedVariation> font_var_owner;
  403. mutable RID_PtrOwner<FontFallback> font_owner;
  404. mutable RID_PtrOwner<ShapedTextDataFallback> shaped_owner;
  405. _FORCE_INLINE_ FontFallback *_get_font_data(const RID &p_font_rid) const {
  406. RID rid = p_font_rid;
  407. FontFallbackLinkedVariation *fdv = font_var_owner.get_or_null(rid);
  408. if (unlikely(fdv)) {
  409. rid = fdv->base_font;
  410. }
  411. return font_owner.get_or_null(rid);
  412. }
  413. struct SystemFontKey {
  414. String font_name;
  415. TextServer::FontAntialiasing antialiasing = TextServer::FONT_ANTIALIASING_GRAY;
  416. bool disable_embedded_bitmaps = true;
  417. bool italic = false;
  418. bool mipmaps = false;
  419. bool msdf = false;
  420. bool force_autohinter = false;
  421. int weight = 400;
  422. int stretch = 100;
  423. int msdf_range = 14;
  424. int msdf_source_size = 48;
  425. int fixed_size = 0;
  426. TextServer::Hinting hinting = TextServer::HINTING_LIGHT;
  427. TextServer::SubpixelPositioning subpixel_positioning = TextServer::SUBPIXEL_POSITIONING_AUTO;
  428. bool keep_rounding_remainders = true;
  429. Dictionary variation_coordinates;
  430. double oversampling = 0.0;
  431. double embolden = 0.0;
  432. Transform2D transform;
  433. int extra_spacing[4] = { 0, 0, 0, 0 };
  434. double baseline_offset = 0.0;
  435. bool operator==(const SystemFontKey &p_b) const {
  436. return (font_name == p_b.font_name) && (antialiasing == p_b.antialiasing) && (italic == p_b.italic) && (disable_embedded_bitmaps == p_b.disable_embedded_bitmaps) && (mipmaps == p_b.mipmaps) && (msdf == p_b.msdf) && (force_autohinter == p_b.force_autohinter) && (weight == p_b.weight) && (stretch == p_b.stretch) && (msdf_range == p_b.msdf_range) && (msdf_source_size == p_b.msdf_source_size) && (fixed_size == p_b.fixed_size) && (hinting == p_b.hinting) && (subpixel_positioning == p_b.subpixel_positioning) && (keep_rounding_remainders == p_b.keep_rounding_remainders) && (variation_coordinates == p_b.variation_coordinates) && (oversampling == p_b.oversampling) && (embolden == p_b.embolden) && (transform == p_b.transform) && (extra_spacing[SPACING_TOP] == p_b.extra_spacing[SPACING_TOP]) && (extra_spacing[SPACING_BOTTOM] == p_b.extra_spacing[SPACING_BOTTOM]) && (extra_spacing[SPACING_SPACE] == p_b.extra_spacing[SPACING_SPACE]) && (extra_spacing[SPACING_GLYPH] == p_b.extra_spacing[SPACING_GLYPH]) && (baseline_offset == p_b.baseline_offset);
  437. }
  438. SystemFontKey(const String &p_font_name, bool p_italic, int p_weight, int p_stretch, RID p_font, const TextServerFallback *p_fb) {
  439. font_name = p_font_name;
  440. italic = p_italic;
  441. weight = p_weight;
  442. stretch = p_stretch;
  443. antialiasing = p_fb->_font_get_antialiasing(p_font);
  444. disable_embedded_bitmaps = p_fb->_font_get_disable_embedded_bitmaps(p_font);
  445. mipmaps = p_fb->_font_get_generate_mipmaps(p_font);
  446. msdf = p_fb->_font_is_multichannel_signed_distance_field(p_font);
  447. msdf_range = p_fb->_font_get_msdf_pixel_range(p_font);
  448. msdf_source_size = p_fb->_font_get_msdf_size(p_font);
  449. fixed_size = p_fb->_font_get_fixed_size(p_font);
  450. force_autohinter = p_fb->_font_is_force_autohinter(p_font);
  451. hinting = p_fb->_font_get_hinting(p_font);
  452. subpixel_positioning = p_fb->_font_get_subpixel_positioning(p_font);
  453. keep_rounding_remainders = p_fb->_font_get_keep_rounding_remainders(p_font);
  454. variation_coordinates = p_fb->_font_get_variation_coordinates(p_font);
  455. oversampling = p_fb->_font_get_oversampling(p_font);
  456. embolden = p_fb->_font_get_embolden(p_font);
  457. transform = p_fb->_font_get_transform(p_font);
  458. extra_spacing[SPACING_TOP] = p_fb->_font_get_spacing(p_font, SPACING_TOP);
  459. extra_spacing[SPACING_BOTTOM] = p_fb->_font_get_spacing(p_font, SPACING_BOTTOM);
  460. extra_spacing[SPACING_SPACE] = p_fb->_font_get_spacing(p_font, SPACING_SPACE);
  461. extra_spacing[SPACING_GLYPH] = p_fb->_font_get_spacing(p_font, SPACING_GLYPH);
  462. baseline_offset = p_fb->_font_get_baseline_offset(p_font);
  463. }
  464. };
  465. struct SystemFontCacheRec {
  466. RID rid;
  467. int index = 0;
  468. };
  469. struct SystemFontCache {
  470. Vector<SystemFontCacheRec> var;
  471. int max_var = 0;
  472. };
  473. struct SystemFontKeyHasher {
  474. _FORCE_INLINE_ static uint32_t hash(const SystemFontKey &p_a) {
  475. uint32_t hash = p_a.font_name.hash();
  476. hash = hash_murmur3_one_32(p_a.variation_coordinates.hash(), hash);
  477. hash = hash_murmur3_one_32(p_a.weight, hash);
  478. hash = hash_murmur3_one_32(p_a.stretch, hash);
  479. hash = hash_murmur3_one_32(p_a.msdf_range, hash);
  480. hash = hash_murmur3_one_32(p_a.msdf_source_size, hash);
  481. hash = hash_murmur3_one_32(p_a.fixed_size, hash);
  482. hash = hash_murmur3_one_double(p_a.oversampling, hash);
  483. hash = hash_murmur3_one_double(p_a.embolden, hash);
  484. hash = hash_murmur3_one_real(p_a.transform[0].x, hash);
  485. hash = hash_murmur3_one_real(p_a.transform[0].y, hash);
  486. hash = hash_murmur3_one_real(p_a.transform[1].x, hash);
  487. hash = hash_murmur3_one_real(p_a.transform[1].y, hash);
  488. hash = hash_murmur3_one_32(p_a.extra_spacing[SPACING_TOP], hash);
  489. hash = hash_murmur3_one_32(p_a.extra_spacing[SPACING_BOTTOM], hash);
  490. hash = hash_murmur3_one_32(p_a.extra_spacing[SPACING_SPACE], hash);
  491. hash = hash_murmur3_one_32(p_a.extra_spacing[SPACING_GLYPH], hash);
  492. hash = hash_murmur3_one_double(p_a.baseline_offset, hash);
  493. return hash_fmix32(hash_murmur3_one_32(((int)p_a.mipmaps) | ((int)p_a.msdf << 1) | ((int)p_a.italic << 2) | ((int)p_a.force_autohinter << 3) | ((int)p_a.hinting << 4) | ((int)p_a.subpixel_positioning << 8) | ((int)p_a.antialiasing << 12) | ((int)p_a.disable_embedded_bitmaps << 14) | ((int)p_a.keep_rounding_remainders << 15), hash));
  494. }
  495. };
  496. mutable HashMap<SystemFontKey, SystemFontCache, SystemFontKeyHasher> system_fonts;
  497. mutable HashMap<String, PackedByteArray> system_font_data;
  498. void _realign(ShapedTextDataFallback *p_sd) const;
  499. _FORCE_INLINE_ RID _find_sys_font_for_text(const RID &p_fdef, const String &p_script_code, const String &p_language, const String &p_text);
  500. Mutex ft_mutex;
  501. protected:
  502. static void _bind_methods() {}
  503. void full_copy(ShapedTextDataFallback *p_shaped);
  504. void invalidate(ShapedTextDataFallback *p_shaped);
  505. public:
  506. MODBIND1RC(bool, has_feature, Feature);
  507. MODBIND0RC(String, get_name);
  508. MODBIND0RC(int64_t, get_features);
  509. MODBIND1(free_rid, const RID &);
  510. MODBIND1R(bool, has, const RID &);
  511. MODBIND1R(bool, load_support_data, const String &);
  512. MODBIND0RC(String, get_support_data_filename);
  513. MODBIND0RC(String, get_support_data_info);
  514. MODBIND1RC(bool, save_support_data, const String &);
  515. MODBIND0RC(PackedByteArray, get_support_data);
  516. MODBIND1RC(bool, is_locale_right_to_left, const String &);
  517. MODBIND1RC(int64_t, name_to_tag, const String &);
  518. MODBIND1RC(String, tag_to_name, int64_t);
  519. /* Font interface */
  520. MODBIND0R(RID, create_font);
  521. MODBIND1R(RID, create_font_linked_variation, const RID &);
  522. MODBIND2(font_set_data, const RID &, const PackedByteArray &);
  523. MODBIND3(font_set_data_ptr, const RID &, const uint8_t *, int64_t);
  524. MODBIND2(font_set_face_index, const RID &, int64_t);
  525. MODBIND1RC(int64_t, font_get_face_index, const RID &);
  526. MODBIND1RC(int64_t, font_get_face_count, const RID &);
  527. MODBIND2(font_set_style, const RID &, BitField<FontStyle>);
  528. MODBIND1RC(BitField<FontStyle>, font_get_style, const RID &);
  529. MODBIND2(font_set_style_name, const RID &, const String &);
  530. MODBIND1RC(String, font_get_style_name, const RID &);
  531. MODBIND2(font_set_weight, const RID &, int64_t);
  532. MODBIND1RC(int64_t, font_get_weight, const RID &);
  533. MODBIND2(font_set_stretch, const RID &, int64_t);
  534. MODBIND1RC(int64_t, font_get_stretch, const RID &);
  535. MODBIND2(font_set_name, const RID &, const String &);
  536. MODBIND1RC(String, font_get_name, const RID &);
  537. MODBIND2(font_set_antialiasing, const RID &, TextServer::FontAntialiasing);
  538. MODBIND1RC(TextServer::FontAntialiasing, font_get_antialiasing, const RID &);
  539. MODBIND2(font_set_disable_embedded_bitmaps, const RID &, bool);
  540. MODBIND1RC(bool, font_get_disable_embedded_bitmaps, const RID &);
  541. MODBIND2(font_set_generate_mipmaps, const RID &, bool);
  542. MODBIND1RC(bool, font_get_generate_mipmaps, const RID &);
  543. MODBIND2(font_set_multichannel_signed_distance_field, const RID &, bool);
  544. MODBIND1RC(bool, font_is_multichannel_signed_distance_field, const RID &);
  545. MODBIND2(font_set_msdf_pixel_range, const RID &, int64_t);
  546. MODBIND1RC(int64_t, font_get_msdf_pixel_range, const RID &);
  547. MODBIND2(font_set_msdf_size, const RID &, int64_t);
  548. MODBIND1RC(int64_t, font_get_msdf_size, const RID &);
  549. MODBIND2(font_set_fixed_size, const RID &, int64_t);
  550. MODBIND1RC(int64_t, font_get_fixed_size, const RID &);
  551. MODBIND2(font_set_fixed_size_scale_mode, const RID &, FixedSizeScaleMode);
  552. MODBIND1RC(FixedSizeScaleMode, font_get_fixed_size_scale_mode, const RID &);
  553. MODBIND2(font_set_allow_system_fallback, const RID &, bool);
  554. MODBIND1RC(bool, font_is_allow_system_fallback, const RID &);
  555. MODBIND2(font_set_force_autohinter, const RID &, bool);
  556. MODBIND1RC(bool, font_is_force_autohinter, const RID &);
  557. MODBIND2(font_set_subpixel_positioning, const RID &, SubpixelPositioning);
  558. MODBIND1RC(SubpixelPositioning, font_get_subpixel_positioning, const RID &);
  559. MODBIND2(font_set_keep_rounding_remainders, const RID &, bool);
  560. MODBIND1RC(bool, font_get_keep_rounding_remainders, const RID &);
  561. MODBIND2(font_set_embolden, const RID &, double);
  562. MODBIND1RC(double, font_get_embolden, const RID &);
  563. MODBIND3(font_set_spacing, const RID &, SpacingType, int64_t);
  564. MODBIND2RC(int64_t, font_get_spacing, const RID &, SpacingType);
  565. MODBIND2(font_set_baseline_offset, const RID &, double);
  566. MODBIND1RC(double, font_get_baseline_offset, const RID &);
  567. MODBIND2(font_set_transform, const RID &, const Transform2D &);
  568. MODBIND1RC(Transform2D, font_get_transform, const RID &);
  569. MODBIND2(font_set_variation_coordinates, const RID &, const Dictionary &);
  570. MODBIND1RC(Dictionary, font_get_variation_coordinates, const RID &);
  571. MODBIND2(font_set_hinting, const RID &, TextServer::Hinting);
  572. MODBIND1RC(TextServer::Hinting, font_get_hinting, const RID &);
  573. MODBIND2(font_set_oversampling, const RID &, double);
  574. MODBIND1RC(double, font_get_oversampling, const RID &);
  575. MODBIND1RC(TypedArray<Vector2i>, font_get_size_cache_list, const RID &);
  576. MODBIND1(font_clear_size_cache, const RID &);
  577. MODBIND2(font_remove_size_cache, const RID &, const Vector2i &);
  578. MODBIND3(font_set_ascent, const RID &, int64_t, double);
  579. MODBIND2RC(double, font_get_ascent, const RID &, int64_t);
  580. MODBIND3(font_set_descent, const RID &, int64_t, double);
  581. MODBIND2RC(double, font_get_descent, const RID &, int64_t);
  582. MODBIND3(font_set_underline_position, const RID &, int64_t, double);
  583. MODBIND2RC(double, font_get_underline_position, const RID &, int64_t);
  584. MODBIND3(font_set_underline_thickness, const RID &, int64_t, double);
  585. MODBIND2RC(double, font_get_underline_thickness, const RID &, int64_t);
  586. MODBIND3(font_set_scale, const RID &, int64_t, double);
  587. MODBIND2RC(double, font_get_scale, const RID &, int64_t);
  588. MODBIND2RC(int64_t, font_get_texture_count, const RID &, const Vector2i &);
  589. MODBIND2(font_clear_textures, const RID &, const Vector2i &);
  590. MODBIND3(font_remove_texture, const RID &, const Vector2i &, int64_t);
  591. MODBIND4(font_set_texture_image, const RID &, const Vector2i &, int64_t, const Ref<Image> &);
  592. MODBIND3RC(Ref<Image>, font_get_texture_image, const RID &, const Vector2i &, int64_t);
  593. MODBIND4(font_set_texture_offsets, const RID &, const Vector2i &, int64_t, const PackedInt32Array &);
  594. MODBIND3RC(PackedInt32Array, font_get_texture_offsets, const RID &, const Vector2i &, int64_t);
  595. MODBIND2RC(PackedInt32Array, font_get_glyph_list, const RID &, const Vector2i &);
  596. MODBIND2(font_clear_glyphs, const RID &, const Vector2i &);
  597. MODBIND3(font_remove_glyph, const RID &, const Vector2i &, int64_t);
  598. MODBIND3RC(Vector2, font_get_glyph_advance, const RID &, int64_t, int64_t);
  599. MODBIND4(font_set_glyph_advance, const RID &, int64_t, int64_t, const Vector2 &);
  600. MODBIND3RC(Vector2, font_get_glyph_offset, const RID &, const Vector2i &, int64_t);
  601. MODBIND4(font_set_glyph_offset, const RID &, const Vector2i &, int64_t, const Vector2 &);
  602. MODBIND3RC(Vector2, font_get_glyph_size, const RID &, const Vector2i &, int64_t);
  603. MODBIND4(font_set_glyph_size, const RID &, const Vector2i &, int64_t, const Vector2 &);
  604. MODBIND3RC(Rect2, font_get_glyph_uv_rect, const RID &, const Vector2i &, int64_t);
  605. MODBIND4(font_set_glyph_uv_rect, const RID &, const Vector2i &, int64_t, const Rect2 &);
  606. MODBIND3RC(int64_t, font_get_glyph_texture_idx, const RID &, const Vector2i &, int64_t);
  607. MODBIND4(font_set_glyph_texture_idx, const RID &, const Vector2i &, int64_t, int64_t);
  608. MODBIND3RC(RID, font_get_glyph_texture_rid, const RID &, const Vector2i &, int64_t);
  609. MODBIND3RC(Size2, font_get_glyph_texture_size, const RID &, const Vector2i &, int64_t);
  610. MODBIND3RC(Dictionary, font_get_glyph_contours, const RID &, int64_t, int64_t);
  611. MODBIND2RC(TypedArray<Vector2i>, font_get_kerning_list, const RID &, int64_t);
  612. MODBIND2(font_clear_kerning_map, const RID &, int64_t);
  613. MODBIND3(font_remove_kerning, const RID &, int64_t, const Vector2i &);
  614. MODBIND4(font_set_kerning, const RID &, int64_t, const Vector2i &, const Vector2 &);
  615. MODBIND3RC(Vector2, font_get_kerning, const RID &, int64_t, const Vector2i &);
  616. MODBIND4RC(int64_t, font_get_glyph_index, const RID &, int64_t, int64_t, int64_t);
  617. MODBIND3RC(int64_t, font_get_char_from_glyph_index, const RID &, int64_t, int64_t);
  618. MODBIND2RC(bool, font_has_char, const RID &, int64_t);
  619. MODBIND1RC(String, font_get_supported_chars, const RID &);
  620. MODBIND1RC(PackedInt32Array, font_get_supported_glyphs, const RID &);
  621. MODBIND4(font_render_range, const RID &, const Vector2i &, int64_t, int64_t);
  622. MODBIND3(font_render_glyph, const RID &, const Vector2i &, int64_t);
  623. MODBIND6C(font_draw_glyph, const RID &, const RID &, int64_t, const Vector2 &, int64_t, const Color &);
  624. MODBIND7C(font_draw_glyph_outline, const RID &, const RID &, int64_t, int64_t, const Vector2 &, int64_t, const Color &);
  625. MODBIND2RC(bool, font_is_language_supported, const RID &, const String &);
  626. MODBIND3(font_set_language_support_override, const RID &, const String &, bool);
  627. MODBIND2R(bool, font_get_language_support_override, const RID &, const String &);
  628. MODBIND2(font_remove_language_support_override, const RID &, const String &);
  629. MODBIND1R(PackedStringArray, font_get_language_support_overrides, const RID &);
  630. MODBIND2RC(bool, font_is_script_supported, const RID &, const String &);
  631. MODBIND3(font_set_script_support_override, const RID &, const String &, bool);
  632. MODBIND2R(bool, font_get_script_support_override, const RID &, const String &);
  633. MODBIND2(font_remove_script_support_override, const RID &, const String &);
  634. MODBIND1R(PackedStringArray, font_get_script_support_overrides, const RID &);
  635. MODBIND2(font_set_opentype_feature_overrides, const RID &, const Dictionary &);
  636. MODBIND1RC(Dictionary, font_get_opentype_feature_overrides, const RID &);
  637. MODBIND1RC(Dictionary, font_supported_feature_list, const RID &);
  638. MODBIND1RC(Dictionary, font_supported_variation_list, const RID &);
  639. MODBIND0RC(double, font_get_global_oversampling);
  640. MODBIND1(font_set_global_oversampling, double);
  641. /* Shaped text buffer interface */
  642. MODBIND2R(RID, create_shaped_text, Direction, Orientation);
  643. MODBIND1(shaped_text_clear, const RID &);
  644. MODBIND2(shaped_text_set_direction, const RID &, Direction);
  645. MODBIND1RC(Direction, shaped_text_get_direction, const RID &);
  646. MODBIND1RC(Direction, shaped_text_get_inferred_direction, const RID &);
  647. MODBIND2(shaped_text_set_bidi_override, const RID &, const Array &);
  648. MODBIND2(shaped_text_set_custom_punctuation, const RID &, const String &);
  649. MODBIND1RC(String, shaped_text_get_custom_punctuation, const RID &);
  650. MODBIND2(shaped_text_set_custom_ellipsis, const RID &, int64_t);
  651. MODBIND1RC(int64_t, shaped_text_get_custom_ellipsis, const RID &);
  652. MODBIND2(shaped_text_set_orientation, const RID &, Orientation);
  653. MODBIND1RC(Orientation, shaped_text_get_orientation, const RID &);
  654. MODBIND2(shaped_text_set_preserve_invalid, const RID &, bool);
  655. MODBIND1RC(bool, shaped_text_get_preserve_invalid, const RID &);
  656. MODBIND2(shaped_text_set_preserve_control, const RID &, bool);
  657. MODBIND1RC(bool, shaped_text_get_preserve_control, const RID &);
  658. MODBIND3(shaped_text_set_spacing, const RID &, SpacingType, int64_t);
  659. MODBIND2RC(int64_t, shaped_text_get_spacing, const RID &, SpacingType);
  660. MODBIND7R(bool, shaped_text_add_string, const RID &, const String &, const TypedArray<RID> &, int64_t, const Dictionary &, const String &, const Variant &);
  661. MODBIND6R(bool, shaped_text_add_object, const RID &, const Variant &, const Size2 &, InlineAlignment, int64_t, double);
  662. MODBIND5R(bool, shaped_text_resize_object, const RID &, const Variant &, const Size2 &, InlineAlignment, double);
  663. MODBIND1RC(int64_t, shaped_get_span_count, const RID &);
  664. MODBIND2RC(Variant, shaped_get_span_meta, const RID &, int64_t);
  665. MODBIND2RC(Variant, shaped_get_span_embedded_object, const RID &, int64_t);
  666. MODBIND5(shaped_set_span_update_font, const RID &, int64_t, const TypedArray<RID> &, int64_t, const Dictionary &);
  667. MODBIND3RC(RID, shaped_text_substr, const RID &, int64_t, int64_t);
  668. MODBIND1RC(RID, shaped_text_get_parent, const RID &);
  669. MODBIND3R(double, shaped_text_fit_to_width, const RID &, double, BitField<TextServer::JustificationFlag>);
  670. MODBIND2R(double, shaped_text_tab_align, const RID &, const PackedFloat32Array &);
  671. MODBIND1R(bool, shaped_text_shape, const RID &);
  672. MODBIND1R(bool, shaped_text_update_breaks, const RID &);
  673. MODBIND1R(bool, shaped_text_update_justification_ops, const RID &);
  674. MODBIND1RC(int64_t, shaped_text_get_trim_pos, const RID &);
  675. MODBIND1RC(int64_t, shaped_text_get_ellipsis_pos, const RID &);
  676. MODBIND1RC(const Glyph *, shaped_text_get_ellipsis_glyphs, const RID &);
  677. MODBIND1RC(int64_t, shaped_text_get_ellipsis_glyph_count, const RID &);
  678. MODBIND3(shaped_text_overrun_trim_to_width, const RID &, double, BitField<TextServer::TextOverrunFlag>);
  679. MODBIND1RC(bool, shaped_text_is_ready, const RID &);
  680. MODBIND1RC(const Glyph *, shaped_text_get_glyphs, const RID &);
  681. MODBIND1R(const Glyph *, shaped_text_sort_logical, const RID &);
  682. MODBIND1RC(int64_t, shaped_text_get_glyph_count, const RID &);
  683. MODBIND1RC(Vector2i, shaped_text_get_range, const RID &);
  684. MODBIND1RC(Array, shaped_text_get_objects, const RID &);
  685. MODBIND2RC(Rect2, shaped_text_get_object_rect, const RID &, const Variant &);
  686. MODBIND2RC(Vector2i, shaped_text_get_object_range, const RID &, const Variant &);
  687. MODBIND2RC(int64_t, shaped_text_get_object_glyph, const RID &, const Variant &);
  688. MODBIND1RC(Size2, shaped_text_get_size, const RID &);
  689. MODBIND1RC(double, shaped_text_get_ascent, const RID &);
  690. MODBIND1RC(double, shaped_text_get_descent, const RID &);
  691. MODBIND1RC(double, shaped_text_get_width, const RID &);
  692. MODBIND1RC(double, shaped_text_get_underline_position, const RID &);
  693. MODBIND1RC(double, shaped_text_get_underline_thickness, const RID &);
  694. MODBIND1RC(PackedInt32Array, shaped_text_get_character_breaks, const RID &);
  695. MODBIND3RC(PackedInt32Array, string_get_word_breaks, const String &, const String &, int64_t);
  696. MODBIND2RC(String, string_to_upper, const String &, const String &);
  697. MODBIND2RC(String, string_to_lower, const String &, const String &);
  698. MODBIND2RC(String, string_to_title, const String &, const String &);
  699. MODBIND0(cleanup);
  700. TextServerFallback();
  701. ~TextServerFallback();
  702. };
  703. #endif // TEXT_SERVER_FB_H