1 /**************************************************************************** 2 * 3 * ftoption.h 4 * 5 * User-selectable configuration macros (specification only). 6 * 7 * Copyright (C) 1996-2024 by 8 * David Turner, Robert Wilhelm, and Werner Lemberg. 9 * 10 * This file is part of the FreeType project, and may only be used, 11 * modified, and distributed under the terms of the FreeType project 12 * license, LICENSE.TXT. By continuing to use, modify, or distribute 13 * this file you indicate that you have read the license and 14 * understand and accept it fully. 15 * 16 */ 17 18 19 #ifndef FTOPTION_H_ 20 #define FTOPTION_H_ 21 22 23 #include <ft2build.h> 24 25 26 FT_BEGIN_HEADER 27 28 /************************************************************************** 29 * 30 * USER-SELECTABLE CONFIGURATION MACROS 31 * 32 * This file contains the default configuration macro definitions for a 33 * standard build of the FreeType library. There are three ways to use 34 * this file to build project-specific versions of the library: 35 * 36 * - You can modify this file by hand, but this is not recommended in 37 * cases where you would like to build several versions of the library 38 * from a single source directory. 39 * 40 * - You can put a copy of this file in your build directory, more 41 * precisely in `$BUILD/freetype/config/ftoption.h`, where `$BUILD` is 42 * the name of a directory that is included _before_ the FreeType include 43 * path during compilation. 44 * 45 * The default FreeType Makefiles use the build directory 46 * `builds/<system>` by default, but you can easily change that for your 47 * own projects. 48 * 49 * - Copy the file <ft2build.h> to `$BUILD/ft2build.h` and modify it 50 * slightly to pre-define the macro `FT_CONFIG_OPTIONS_H` used to locate 51 * this file during the build. For example, 52 * 53 * ``` 54 * #define FT_CONFIG_OPTIONS_H <myftoptions.h> 55 * #include <freetype/config/ftheader.h> 56 * ``` 57 * 58 * will use `$BUILD/myftoptions.h` instead of this file for macro 59 * definitions. 60 * 61 * Note also that you can similarly pre-define the macro 62 * `FT_CONFIG_MODULES_H` used to locate the file listing of the modules 63 * that are statically linked to the library at compile time. By 64 * default, this file is `<freetype/config/ftmodule.h>`. 65 * 66 * We highly recommend using the third method whenever possible. 67 * 68 */ 69 70 71 /*************************************************************************/ 72 /*************************************************************************/ 73 /**** ****/ 74 /**** G E N E R A L F R E E T Y P E 2 C O N F I G U R A T I O N ****/ 75 /**** ****/ 76 /*************************************************************************/ 77 /*************************************************************************/ 78 79 80 /*#************************************************************************ 81 * 82 * If you enable this configuration option, FreeType recognizes an 83 * environment variable called `FREETYPE_PROPERTIES`, which can be used to 84 * control the various font drivers and modules. The controllable 85 * properties are listed in the section @properties. 86 * 87 * You have to undefine this configuration option on platforms that lack 88 * the concept of environment variables (and thus don't have the `getenv` 89 * function), for example Windows CE. 90 * 91 * `FREETYPE_PROPERTIES` has the following syntax form (broken here into 92 * multiple lines for better readability). 93 * 94 * ``` 95 * <optional whitespace> 96 * <module-name1> ':' 97 * <property-name1> '=' <property-value1> 98 * <whitespace> 99 * <module-name2> ':' 100 * <property-name2> '=' <property-value2> 101 * ... 102 * ``` 103 * 104 * Example: 105 * 106 * ``` 107 * FREETYPE_PROPERTIES=truetype:interpreter-version=35 \ 108 * cff:no-stem-darkening=1 \ 109 * autofitter:warping=1 110 * ``` 111 * 112 */ 113 #define FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES 114 115 116 /************************************************************************** 117 * 118 * Uncomment the line below if you want to activate LCD rendering 119 * technology similar to ClearType in this build of the library. This 120 * technology triples the resolution in the direction color subpixels. To 121 * mitigate color fringes inherent to this technology, you also need to 122 * explicitly set up LCD filtering. 123 * 124 * When this macro is not defined, FreeType offers alternative LCD 125 * rendering technology that produces excellent output. 126 */ 127 /* #define FT_CONFIG_OPTION_SUBPIXEL_RENDERING */ 128 129 130 /************************************************************************** 131 * 132 * Many compilers provide a non-ANSI 64-bit data type that can be used by 133 * FreeType to speed up some computations. However, this will create some 134 * problems when compiling the library in strict ANSI mode. 135 * 136 * For this reason, the use of 64-bit integers is normally disabled when 137 * the `__STDC__` macro is defined. You can however disable this by 138 * defining the macro `FT_CONFIG_OPTION_FORCE_INT64` here. 139 * 140 * For most compilers, this will only create compilation warnings when 141 * building the library. 142 * 143 * ObNote: The compiler-specific 64-bit integers are detected in the 144 * file `ftconfig.h` either statically or through the `configure` 145 * script on supported platforms. 146 */ 147 #undef FT_CONFIG_OPTION_FORCE_INT64 148 149 150 /************************************************************************** 151 * 152 * If this macro is defined, do not try to use an assembler version of 153 * performance-critical functions (e.g., @FT_MulFix). You should only do 154 * that to verify that the assembler function works properly, or to execute 155 * benchmark tests of the various implementations. 156 */ 157 /* #define FT_CONFIG_OPTION_NO_ASSEMBLER */ 158 159 160 /************************************************************************** 161 * 162 * If this macro is defined, try to use an inlined assembler version of the 163 * @FT_MulFix function, which is a 'hotspot' when loading and hinting 164 * glyphs, and which should be executed as fast as possible. 165 * 166 * Note that if your compiler or CPU is not supported, this will default to 167 * the standard and portable implementation found in `ftcalc.c`. 168 */ 169 #define FT_CONFIG_OPTION_INLINE_MULFIX 170 171 172 /************************************************************************** 173 * 174 * LZW-compressed file support. 175 * 176 * FreeType now handles font files that have been compressed with the 177 * `compress` program. This is mostly used to parse many of the PCF 178 * files that come with various X11 distributions. The implementation 179 * uses NetBSD's `zopen` to partially uncompress the file on the fly (see 180 * `src/lzw/ftgzip.c`). 181 * 182 * Define this macro if you want to enable this 'feature'. 183 */ 184 #define FT_CONFIG_OPTION_USE_LZW 185 186 187 /************************************************************************** 188 * 189 * Gzip-compressed file support. 190 * 191 * FreeType now handles font files that have been compressed with the 192 * `gzip` program. This is mostly used to parse many of the PCF files 193 * that come with XFree86. The implementation uses 'zlib' to partially 194 * uncompress the file on the fly (see `src/gzip/ftgzip.c`). 195 * 196 * Define this macro if you want to enable this 'feature'. See also the 197 * macro `FT_CONFIG_OPTION_SYSTEM_ZLIB` below. 198 */ 199 /* #define FT_CONFIG_OPTION_USE_ZLIB */ 200 201 202 /************************************************************************** 203 * 204 * ZLib library selection 205 * 206 * This macro is only used when `FT_CONFIG_OPTION_USE_ZLIB` is defined. 207 * It allows FreeType's 'ftgzip' component to link to the system's 208 * installation of the ZLib library. This is useful on systems like 209 * Unix or VMS where it generally is already available. 210 * 211 * If you let it undefined, the component will use its own copy of the 212 * zlib sources instead. These have been modified to be included 213 * directly within the component and **not** export external function 214 * names. This allows you to link any program with FreeType _and_ ZLib 215 * without linking conflicts. 216 * 217 * Do not `#undef` this macro here since the build system might define 218 * it for certain configurations only. 219 * 220 * If you use a build system like cmake or the `configure` script, 221 * options set by those programs have precedence, overwriting the value 222 * here with the configured one. 223 * 224 * If you use the GNU make build system directly (that is, without the 225 * `configure` script) and you define this macro, you also have to pass 226 * `SYSTEM_ZLIB=yes` as an argument to make. 227 */ 228 /* #define FT_CONFIG_OPTION_SYSTEM_ZLIB */ 229 230 231 /************************************************************************** 232 * 233 * Bzip2-compressed file support. 234 * 235 * FreeType now handles font files that have been compressed with the 236 * `bzip2` program. This is mostly used to parse many of the PCF files 237 * that come with XFree86. The implementation uses `libbz2` to partially 238 * uncompress the file on the fly (see `src/bzip2/ftbzip2.c`). Contrary 239 * to gzip, bzip2 currently is not included and need to use the system 240 * available bzip2 implementation. 241 * 242 * Define this macro if you want to enable this 'feature'. 243 * 244 * If you use a build system like cmake or the `configure` script, 245 * options set by those programs have precedence, overwriting the value 246 * here with the configured one. 247 */ 248 /* #define FT_CONFIG_OPTION_USE_BZIP2 */ 249 250 251 /************************************************************************** 252 * 253 * Define to disable the use of file stream functions and types, `FILE`, 254 * `fopen`, etc. Enables the use of smaller system libraries on embedded 255 * systems that have multiple system libraries, some with or without file 256 * stream support, in the cases where file stream support is not necessary 257 * such as memory loading of font files. 258 */ 259 /* #define FT_CONFIG_OPTION_DISABLE_STREAM_SUPPORT */ 260 261 262 /************************************************************************** 263 * 264 * PNG bitmap support. 265 * 266 * FreeType now handles loading color bitmap glyphs in the PNG format. 267 * This requires help from the external libpng library. Uncompressed 268 * color bitmaps do not need any external libraries and will be supported 269 * regardless of this configuration. 270 * 271 * Define this macro if you want to enable this 'feature'. 272 * 273 * If you use a build system like cmake or the `configure` script, 274 * options set by those programs have precedence, overwriting the value 275 * here with the configured one. 276 */ 277 #define FT_CONFIG_OPTION_USE_PNG 278 279 280 /************************************************************************** 281 * 282 * HarfBuzz support. 283 * 284 * FreeType uses the HarfBuzz library to improve auto-hinting of OpenType 285 * fonts. If available, many glyphs not directly addressable by a font's 286 * character map will be hinted also. 287 * 288 * Define this macro if you want to enable this 'feature'. 289 * 290 * If you use a build system like cmake or the `configure` script, 291 * options set by those programs have precedence, overwriting the value 292 * here with the configured one. 293 */ 294 /* #define FT_CONFIG_OPTION_USE_HARFBUZZ */ 295 296 297 /************************************************************************** 298 * 299 * Brotli support. 300 * 301 * FreeType uses the Brotli library to provide support for decompressing 302 * WOFF2 streams. 303 * 304 * Define this macro if you want to enable this 'feature'. 305 * 306 * If you use a build system like cmake or the `configure` script, 307 * options set by those programs have precedence, overwriting the value 308 * here with the configured one. 309 */ 310 /* #define FT_CONFIG_OPTION_USE_BROTLI */ 311 312 313 /************************************************************************** 314 * 315 * Glyph Postscript Names handling 316 * 317 * By default, FreeType 2 is compiled with the 'psnames' module. This 318 * module is in charge of converting a glyph name string into a Unicode 319 * value, or return a Macintosh standard glyph name for the use with the 320 * TrueType 'post' table. 321 * 322 * Undefine this macro if you do not want 'psnames' compiled in your 323 * build of FreeType. This has the following effects: 324 * 325 * - The TrueType driver will provide its own set of glyph names, if you 326 * build it to support postscript names in the TrueType 'post' table, 327 * but will not synthesize a missing Unicode charmap. 328 * 329 * - The Type~1 driver will not be able to synthesize a Unicode charmap 330 * out of the glyphs found in the fonts. 331 * 332 * You would normally undefine this configuration macro when building a 333 * version of FreeType that doesn't contain a Type~1 or CFF driver. 334 */ 335 #define FT_CONFIG_OPTION_POSTSCRIPT_NAMES 336 337 338 /************************************************************************** 339 * 340 * Postscript Names to Unicode Values support 341 * 342 * By default, FreeType~2 is built with the 'psnames' module compiled in. 343 * Among other things, the module is used to convert a glyph name into a 344 * Unicode value. This is especially useful in order to synthesize on 345 * the fly a Unicode charmap from the CFF/Type~1 driver through a big 346 * table named the 'Adobe Glyph List' (AGL). 347 * 348 * Undefine this macro if you do not want the Adobe Glyph List compiled 349 * in your 'psnames' module. The Type~1 driver will not be able to 350 * synthesize a Unicode charmap out of the glyphs found in the fonts. 351 */ 352 #define FT_CONFIG_OPTION_ADOBE_GLYPH_LIST 353 354 355 /************************************************************************** 356 * 357 * Support for Mac fonts 358 * 359 * Define this macro if you want support for outline fonts in Mac format 360 * (mac dfont, mac resource, macbinary containing a mac resource) on 361 * non-Mac platforms. 362 * 363 * Note that the 'FOND' resource isn't checked. 364 */ 365 #define FT_CONFIG_OPTION_MAC_FONTS 366 367 368 /************************************************************************** 369 * 370 * Guessing methods to access embedded resource forks 371 * 372 * Enable extra Mac fonts support on non-Mac platforms (e.g., GNU/Linux). 373 * 374 * Resource forks which include fonts data are stored sometimes in 375 * locations which users or developers don't expected. In some cases, 376 * resource forks start with some offset from the head of a file. In 377 * other cases, the actual resource fork is stored in file different from 378 * what the user specifies. If this option is activated, FreeType tries 379 * to guess whether such offsets or different file names must be used. 380 * 381 * Note that normal, direct access of resource forks is controlled via 382 * the `FT_CONFIG_OPTION_MAC_FONTS` option. 383 */ 384 #ifdef FT_CONFIG_OPTION_MAC_FONTS 385 #define FT_CONFIG_OPTION_GUESSING_EMBEDDED_RFORK 386 #endif 387 388 389 /************************************************************************** 390 * 391 * Allow the use of `FT_Incremental_Interface` to load typefaces that 392 * contain no glyph data, but supply it via a callback function. This is 393 * required by clients supporting document formats which supply font data 394 * incrementally as the document is parsed, such as the Ghostscript 395 * interpreter for the PostScript language. 396 */ 397 #define FT_CONFIG_OPTION_INCREMENTAL 398 399 400 /************************************************************************** 401 * 402 * The size in bytes of the render pool used by the scan-line converter to 403 * do all of its work. 404 */ 405 #define FT_RENDER_POOL_SIZE 16384L 406 407 408 /************************************************************************** 409 * 410 * FT_MAX_MODULES 411 * 412 * The maximum number of modules that can be registered in a single 413 * FreeType library object. 32~is the default. 414 */ 415 #define FT_MAX_MODULES 32 416 417 418 /************************************************************************** 419 * 420 * Debug level 421 * 422 * FreeType can be compiled in debug or trace mode. In debug mode, 423 * errors are reported through the 'ftdebug' component. In trace mode, 424 * additional messages are sent to the standard output during execution. 425 * 426 * Define `FT_DEBUG_LEVEL_ERROR` to build the library in debug mode. 427 * Define `FT_DEBUG_LEVEL_TRACE` to build it in trace mode. 428 * 429 * Don't define any of these macros to compile in 'release' mode! 430 * 431 * Do not `#undef` these macros here since the build system might define 432 * them for certain configurations only. 433 */ 434 /* #define FT_DEBUG_LEVEL_ERROR */ 435 /* #define FT_DEBUG_LEVEL_TRACE */ 436 437 438 /************************************************************************** 439 * 440 * Logging 441 * 442 * Compiling FreeType in debug or trace mode makes FreeType write error 443 * and trace log messages to `stderr`. Enabling this macro 444 * automatically forces the `FT_DEBUG_LEVEL_ERROR` and 445 * `FT_DEBUG_LEVEL_TRACE` macros and allows FreeType to write error and 446 * trace log messages to a file instead of `stderr`. For writing logs 447 * to a file, FreeType uses an the external `dlg` library (the source 448 * code is in `src/dlg`). 449 * 450 * This option needs a C99 compiler. 451 */ 452 /* #define FT_DEBUG_LOGGING */ 453 454 455 /************************************************************************** 456 * 457 * Autofitter debugging 458 * 459 * If `FT_DEBUG_AUTOFIT` is defined, FreeType provides some means to 460 * control the autofitter behaviour for debugging purposes with global 461 * boolean variables (consequently, you should **never** enable this 462 * while compiling in 'release' mode): 463 * 464 * ``` 465 * af_debug_disable_horz_hints_ 466 * af_debug_disable_vert_hints_ 467 * af_debug_disable_blue_hints_ 468 * ``` 469 * 470 * Additionally, the following functions provide dumps of various 471 * internal autofit structures to stdout (using `printf`): 472 * 473 * ``` 474 * af_glyph_hints_dump_points 475 * af_glyph_hints_dump_segments 476 * af_glyph_hints_dump_edges 477 * af_glyph_hints_get_num_segments 478 * af_glyph_hints_get_segment_offset 479 * ``` 480 * 481 * As an argument, they use another global variable: 482 * 483 * ``` 484 * af_debug_hints_ 485 * ``` 486 * 487 * Please have a look at the `ftgrid` demo program to see how those 488 * variables and macros should be used. 489 * 490 * Do not `#undef` these macros here since the build system might define 491 * them for certain configurations only. 492 */ 493 /* #define FT_DEBUG_AUTOFIT */ 494 495 496 /************************************************************************** 497 * 498 * Memory Debugging 499 * 500 * FreeType now comes with an integrated memory debugger that is capable 501 * of detecting simple errors like memory leaks or double deletes. To 502 * compile it within your build of the library, you should define 503 * `FT_DEBUG_MEMORY` here. 504 * 505 * Note that the memory debugger is only activated at runtime when when 506 * the _environment_ variable `FT2_DEBUG_MEMORY` is defined also! 507 * 508 * Do not `#undef` this macro here since the build system might define it 509 * for certain configurations only. 510 */ 511 /* #define FT_DEBUG_MEMORY */ 512 513 514 /************************************************************************** 515 * 516 * Module errors 517 * 518 * If this macro is set (which is _not_ the default), the higher byte of 519 * an error code gives the module in which the error has occurred, while 520 * the lower byte is the real error code. 521 * 522 * Setting this macro makes sense for debugging purposes only, since it 523 * would break source compatibility of certain programs that use 524 * FreeType~2. 525 * 526 * More details can be found in the files `ftmoderr.h` and `fterrors.h`. 527 */ 528 #undef FT_CONFIG_OPTION_USE_MODULE_ERRORS 529 530 531 /************************************************************************** 532 * 533 * OpenType SVG Glyph Support 534 * 535 * Setting this macro enables support for OpenType SVG glyphs. By 536 * default, FreeType can only fetch SVG documents. However, it can also 537 * render them if external rendering hook functions are plugged in at 538 * runtime. 539 * 540 * More details on the hooks can be found in file `otsvg.h`. 541 */ 542 /* #define FT_CONFIG_OPTION_SVG */ 543 544 545 /************************************************************************** 546 * 547 * Error Strings 548 * 549 * If this macro is set, `FT_Error_String` will return meaningful 550 * descriptions. This is not enabled by default to reduce the overall 551 * size of FreeType. 552 * 553 * More details can be found in the file `fterrors.h`. 554 */ 555 /* #define FT_CONFIG_OPTION_ERROR_STRINGS */ 556 557 558 /*************************************************************************/ 559 /*************************************************************************/ 560 /**** ****/ 561 /**** S F N T D R I V E R C O N F I G U R A T I O N ****/ 562 /**** ****/ 563 /*************************************************************************/ 564 /*************************************************************************/ 565 566 567 /************************************************************************** 568 * 569 * Define `TT_CONFIG_OPTION_EMBEDDED_BITMAPS` if you want to support 570 * embedded bitmaps in all formats using the 'sfnt' module (namely 571 * TrueType~& OpenType). 572 */ 573 #define TT_CONFIG_OPTION_EMBEDDED_BITMAPS 574 575 576 /************************************************************************** 577 * 578 * Define `TT_CONFIG_OPTION_COLOR_LAYERS` if you want to support colored 579 * outlines (from the 'COLR'/'CPAL' tables) in all formats using the 'sfnt' 580 * module (namely TrueType~& OpenType). 581 */ 582 #define TT_CONFIG_OPTION_COLOR_LAYERS 583 584 585 /************************************************************************** 586 * 587 * Define `TT_CONFIG_OPTION_POSTSCRIPT_NAMES` if you want to be able to 588 * load and enumerate Postscript names of glyphs in a TrueType or OpenType 589 * file. 590 * 591 * Note that if you do not compile the 'psnames' module by undefining the 592 * above `FT_CONFIG_OPTION_POSTSCRIPT_NAMES` macro, the 'sfnt' module will 593 * contain additional code to read the PostScript name table from a font. 594 * 595 * (By default, the module uses 'psnames' to extract glyph names.) 596 */ 597 #define TT_CONFIG_OPTION_POSTSCRIPT_NAMES 598 599 600 /************************************************************************** 601 * 602 * Define `TT_CONFIG_OPTION_SFNT_NAMES` if your applications need to access 603 * the internal name table in a SFNT-based format like TrueType or 604 * OpenType. The name table contains various strings used to describe the 605 * font, like family name, copyright, version, etc. It does not contain 606 * any glyph name though. 607 * 608 * Accessing SFNT names is done through the functions declared in 609 * `ftsnames.h`. 610 */ 611 #define TT_CONFIG_OPTION_SFNT_NAMES 612 613 614 /************************************************************************** 615 * 616 * TrueType CMap support 617 * 618 * Here you can fine-tune which TrueType CMap table format shall be 619 * supported. 620 */ 621 #define TT_CONFIG_CMAP_FORMAT_0 622 #define TT_CONFIG_CMAP_FORMAT_2 623 #define TT_CONFIG_CMAP_FORMAT_4 624 #define TT_CONFIG_CMAP_FORMAT_6 625 #define TT_CONFIG_CMAP_FORMAT_8 626 #define TT_CONFIG_CMAP_FORMAT_10 627 #define TT_CONFIG_CMAP_FORMAT_12 628 #define TT_CONFIG_CMAP_FORMAT_13 629 #define TT_CONFIG_CMAP_FORMAT_14 630 631 632 /*************************************************************************/ 633 /*************************************************************************/ 634 /**** ****/ 635 /**** T R U E T Y P E D R I V E R C O N F I G U R A T I O N ****/ 636 /**** ****/ 637 /*************************************************************************/ 638 /*************************************************************************/ 639 640 /************************************************************************** 641 * 642 * Define `TT_CONFIG_OPTION_BYTECODE_INTERPRETER` if you want to compile a 643 * bytecode interpreter in the TrueType driver. 644 * 645 * By undefining this, you will only compile the code necessary to load 646 * TrueType glyphs without hinting. 647 * 648 * Do not `#undef` this macro here, since the build system might define it 649 * for certain configurations only. 650 */ 651 #define TT_CONFIG_OPTION_BYTECODE_INTERPRETER 652 653 654 /************************************************************************** 655 * 656 * Define `TT_CONFIG_OPTION_SUBPIXEL_HINTING` if you want to compile 657 * subpixel hinting support into the TrueType driver. This modifies the 658 * TrueType hinting mechanism when anything but `FT_RENDER_MODE_MONO` is 659 * requested. 660 * 661 * In particular, it modifies the bytecode interpreter to interpret (or 662 * not) instructions in a certain way so that all TrueType fonts look like 663 * they do in a Windows ClearType (DirectWrite) environment. See [1] for a 664 * technical overview on what this means. See `ttinterp.h` for more 665 * details on this option. 666 * 667 * The new default mode focuses on applying a minimal set of rules to all 668 * fonts indiscriminately so that modern and web fonts render well while 669 * legacy fonts render okay. The corresponding interpreter version is v40. 670 * The so-called Infinality mode (v38) is no longer available in FreeType. 671 * 672 * By undefining these, you get rendering behavior like on Windows without 673 * ClearType, i.e., Windows XP without ClearType enabled and Win9x 674 * (interpreter version v35). Or not, depending on how much hinting blood 675 * and testing tears the font designer put into a given font. If you 676 * define one or both subpixel hinting options, you can switch between 677 * between v35 and the ones you define (using `FT_Property_Set`). 678 * 679 * This option requires `TT_CONFIG_OPTION_BYTECODE_INTERPRETER` to be 680 * defined. 681 * 682 * [1] 683 * https://www.microsoft.com/typography/cleartype/truetypecleartype.aspx 684 */ 685 #define TT_CONFIG_OPTION_SUBPIXEL_HINTING 686 687 688 /************************************************************************** 689 * 690 * Define `TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED` to compile the 691 * TrueType glyph loader to use Apple's definition of how to handle 692 * component offsets in composite glyphs. 693 * 694 * Apple and MS disagree on the default behavior of component offsets in 695 * composites. Apple says that they should be scaled by the scaling 696 * factors in the transformation matrix (roughly, it's more complex) while 697 * MS says they should not. OpenType defines two bits in the composite 698 * flags array which can be used to disambiguate, but old fonts will not 699 * have them. 700 * 701 * https://www.microsoft.com/typography/otspec/glyf.htm 702 * https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6glyf.html 703 */ 704 #undef TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED 705 706 707 /************************************************************************** 708 * 709 * Define `TT_CONFIG_OPTION_GX_VAR_SUPPORT` if you want to include support 710 * for Apple's distortable font technology ('fvar', 'gvar', 'cvar', and 711 * 'avar' tables). Tagged 'Font Variations', this is now part of OpenType 712 * also. This has many similarities to Type~1 Multiple Masters support. 713 */ 714 #define TT_CONFIG_OPTION_GX_VAR_SUPPORT 715 716 717 /************************************************************************** 718 * 719 * Define `TT_CONFIG_OPTION_NO_BORING_EXPANSION` if you want to exclude 720 * support for 'boring' OpenType specification expansions. 721 * 722 * https://github.com/harfbuzz/boring-expansion-spec 723 * 724 * Right now, the following features are covered: 725 * 726 * - 'avar' version 2.0 727 * 728 * Most likely, this is a temporary configuration option to be removed in 729 * the near future, since it is assumed that eventually those features are 730 * added to the OpenType standard. 731 */ 732 #define TT_CONFIG_OPTION_NO_BORING_EXPANSION 733 734 735 /************************************************************************** 736 * 737 * Define `TT_CONFIG_OPTION_BDF` if you want to include support for an 738 * embedded 'BDF~' table within SFNT-based bitmap formats. 739 */ 740 #define TT_CONFIG_OPTION_BDF 741 742 743 /************************************************************************** 744 * 745 * Option `TT_CONFIG_OPTION_MAX_RUNNABLE_OPCODES` controls the maximum 746 * number of bytecode instructions executed for a single run of the 747 * bytecode interpreter, needed to prevent infinite loops. You don't want 748 * to change this except for very special situations (e.g., making a 749 * library fuzzer spend less time to handle broken fonts). 750 * 751 * It is not expected that this value is ever modified by a configuring 752 * script; instead, it gets surrounded with `#ifndef ... #endif` so that 753 * the value can be set as a preprocessor option on the compiler's command 754 * line. 755 */ 756 #ifndef TT_CONFIG_OPTION_MAX_RUNNABLE_OPCODES 757 #define TT_CONFIG_OPTION_MAX_RUNNABLE_OPCODES 1000000L 758 #endif 759 760 761 /************************************************************************** 762 * 763 * Option `TT_CONFIG_OPTION_GPOS_KERNING` enables a basic GPOS kerning 764 * implementation (for TrueType fonts only). With this defined, FreeType 765 * is able to get kerning pair data from the GPOS 'kern' feature as well as 766 * legacy 'kern' tables; without this defined, FreeType will only be able 767 * to use legacy 'kern' tables. 768 * 769 * Note that FreeType does not support more advanced GPOS layout features; 770 * even the 'kern' feature implemented here doesn't handle more 771 * sophisticated kerning variants. Use a higher-level library like 772 * HarfBuzz instead for that. 773 */ 774 /* #define TT_CONFIG_OPTION_GPOS_KERNING */ 775 776 777 /*************************************************************************/ 778 /*************************************************************************/ 779 /**** ****/ 780 /**** T Y P E 1 D R I V E R C O N F I G U R A T I O N ****/ 781 /**** ****/ 782 /*************************************************************************/ 783 /*************************************************************************/ 784 785 786 /************************************************************************** 787 * 788 * `T1_MAX_DICT_DEPTH` is the maximum depth of nest dictionaries and arrays 789 * in the Type~1 stream (see `t1load.c`). A minimum of~4 is required. 790 */ 791 #define T1_MAX_DICT_DEPTH 5 792 793 794 /************************************************************************** 795 * 796 * `T1_MAX_SUBRS_CALLS` details the maximum number of nested sub-routine 797 * calls during glyph loading. 798 */ 799 #define T1_MAX_SUBRS_CALLS 16 800 801 802 /************************************************************************** 803 * 804 * `T1_MAX_CHARSTRING_OPERANDS` is the charstring stack's capacity. A 805 * minimum of~16 is required. 806 * 807 * The Chinese font 'MingTiEG-Medium' (covering the CNS 11643 character 808 * set) needs 256. 809 */ 810 #define T1_MAX_CHARSTRINGS_OPERANDS 256 811 812 813 /************************************************************************** 814 * 815 * Define this configuration macro if you want to prevent the compilation 816 * of the 't1afm' module, which is in charge of reading Type~1 AFM files 817 * into an existing face. Note that if set, the Type~1 driver will be 818 * unable to produce kerning distances. 819 */ 820 #undef T1_CONFIG_OPTION_NO_AFM 821 822 823 /************************************************************************** 824 * 825 * Define this configuration macro if you want to prevent the compilation 826 * of the Multiple Masters font support in the Type~1 driver. 827 */ 828 #undef T1_CONFIG_OPTION_NO_MM_SUPPORT 829 830 831 /************************************************************************** 832 * 833 * `T1_CONFIG_OPTION_OLD_ENGINE` controls whether the pre-Adobe Type~1 834 * engine gets compiled into FreeType. If defined, it is possible to 835 * switch between the two engines using the `hinting-engine` property of 836 * the 'type1' driver module. 837 */ 838 /* #define T1_CONFIG_OPTION_OLD_ENGINE */ 839 840 841 /*************************************************************************/ 842 /*************************************************************************/ 843 /**** ****/ 844 /**** C F F D R I V E R C O N F I G U R A T I O N ****/ 845 /**** ****/ 846 /*************************************************************************/ 847 /*************************************************************************/ 848 849 850 /************************************************************************** 851 * 852 * Using `CFF_CONFIG_OPTION_DARKENING_PARAMETER_{X,Y}{1,2,3,4}` it is 853 * possible to set up the default values of the four control points that 854 * define the stem darkening behaviour of the (new) CFF engine. For more 855 * details please read the documentation of the `darkening-parameters` 856 * property (file `ftdriver.h`), which allows the control at run-time. 857 * 858 * Do **not** undefine these macros! 859 */ 860 #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_X1 500 861 #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y1 400 862 863 #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_X2 1000 864 #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y2 275 865 866 #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_X3 1667 867 #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y3 275 868 869 #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_X4 2333 870 #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y4 0 871 872 873 /************************************************************************** 874 * 875 * `CFF_CONFIG_OPTION_OLD_ENGINE` controls whether the pre-Adobe CFF engine 876 * gets compiled into FreeType. If defined, it is possible to switch 877 * between the two engines using the `hinting-engine` property of the 'cff' 878 * driver module. 879 */ 880 /* #define CFF_CONFIG_OPTION_OLD_ENGINE */ 881 882 883 /*************************************************************************/ 884 /*************************************************************************/ 885 /**** ****/ 886 /**** P C F D R I V E R C O N F I G U R A T I O N ****/ 887 /**** ****/ 888 /*************************************************************************/ 889 /*************************************************************************/ 890 891 892 /************************************************************************** 893 * 894 * There are many PCF fonts just called 'Fixed' which look completely 895 * different, and which have nothing to do with each other. When selecting 896 * 'Fixed' in KDE or Gnome one gets results that appear rather random, the 897 * style changes often if one changes the size and one cannot select some 898 * fonts at all. This option makes the 'pcf' module prepend the foundry 899 * name (plus a space) to the family name. 900 * 901 * We also check whether we have 'wide' characters; all put together, we 902 * get family names like 'Sony Fixed' or 'Misc Fixed Wide'. 903 * 904 * If this option is activated, it can be controlled with the 905 * `no-long-family-names` property of the 'pcf' driver module. 906 */ 907 #define PCF_CONFIG_OPTION_LONG_FAMILY_NAMES 908 909 910 /*************************************************************************/ 911 /*************************************************************************/ 912 /**** ****/ 913 /**** A U T O F I T M O D U L E C O N F I G U R A T I O N ****/ 914 /**** ****/ 915 /*************************************************************************/ 916 /*************************************************************************/ 917 918 919 /************************************************************************** 920 * 921 * Compile 'autofit' module with CJK (Chinese, Japanese, Korean) script 922 * support. 923 */ 924 #define AF_CONFIG_OPTION_CJK 925 926 927 /************************************************************************** 928 * 929 * Compile 'autofit' module with fallback Indic script support, covering 930 * some scripts that the 'latin' submodule of the 'autofit' module doesn't 931 * (yet) handle. Currently, this needs option `AF_CONFIG_OPTION_CJK`. 932 */ 933 #ifdef AF_CONFIG_OPTION_CJK 934 #define AF_CONFIG_OPTION_INDIC 935 #endif 936 937 938 /************************************************************************** 939 * 940 * Compile 'autofit' module with warp hinting. The idea of the warping 941 * code is to slightly scale and shift a glyph within a single dimension so 942 * that as much of its segments are aligned (more or less) on the grid. To 943 * find out the optimal scaling and shifting value, various parameter 944 * combinations are tried and scored. 945 * 946 * You can switch warping on and off with the `warping` property of the 947 * auto-hinter (see file `ftdriver.h` for more information; by default it 948 * is switched off). 949 * 950 * This experimental option is not active if the rendering mode is 951 * `FT_RENDER_MODE_LIGHT`. 952 */ 953 /* #define AF_CONFIG_OPTION_USE_WARPER */ 954 955 956 /************************************************************************** 957 * 958 * Use TrueType-like size metrics for 'light' auto-hinting. 959 * 960 * It is strongly recommended to avoid this option, which exists only to 961 * help some legacy applications retain its appearance and behaviour with 962 * respect to auto-hinted TrueType fonts. 963 * 964 * The very reason this option exists at all are GNU/Linux distributions 965 * like Fedora that did not un-patch the following change (which was 966 * present in FreeType between versions 2.4.6 and 2.7.1, inclusive). 967 * 968 * ``` 969 * 2011-07-16 Steven Chu <steven.f.chu@gmail.com> 970 * 971 * [truetype] Fix metrics on size request for scalable fonts. 972 * ``` 973 * 974 * This problematic commit is now reverted (more or less). 975 */ 976 /* #define AF_CONFIG_OPTION_TT_SIZE_METRICS */ 977 978 /* */ 979 980 981 /* 982 * This macro is obsolete. Support has been removed in FreeType version 983 * 2.5. 984 */ 985 /* #define FT_CONFIG_OPTION_OLD_INTERNALS */ 986 987 988 /* 989 * The next two macros are defined if native TrueType hinting is 990 * requested by the definitions above. Don't change this. 991 */ 992 #ifdef TT_CONFIG_OPTION_BYTECODE_INTERPRETER 993 #define TT_USE_BYTECODE_INTERPRETER 994 #ifdef TT_CONFIG_OPTION_SUBPIXEL_HINTING 995 #define TT_SUPPORT_SUBPIXEL_HINTING_MINIMAL 996 #endif 997 #endif 998 999 1000 /* 1001 * The TT_SUPPORT_COLRV1 macro is defined to indicate to clients that this 1002 * version of FreeType has support for 'COLR' v1 API. This definition is 1003 * useful to FreeType clients that want to build in support for 'COLR' v1 1004 * depending on a tip-of-tree checkout before it is officially released in 1005 * FreeType, and while the feature cannot yet be tested against using 1006 * version macros. Don't change this macro. This may be removed once the 1007 * feature is in a FreeType release version and version macros can be used 1008 * to test for availability. 1009 */ 1010 #ifdef TT_CONFIG_OPTION_COLOR_LAYERS 1011 #define TT_SUPPORT_COLRV1 1012 #endif 1013 1014 1015 /* 1016 * Check CFF darkening parameters. The checks are the same as in function 1017 * `cff_property_set` in file `cffdrivr.c`. 1018 */ 1019 #if CFF_CONFIG_OPTION_DARKENING_PARAMETER_X1 < 0 || \ 1020 CFF_CONFIG_OPTION_DARKENING_PARAMETER_X2 < 0 || \ 1021 CFF_CONFIG_OPTION_DARKENING_PARAMETER_X3 < 0 || \ 1022 CFF_CONFIG_OPTION_DARKENING_PARAMETER_X4 < 0 || \ 1023 \ 1024 CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y1 < 0 || \ 1025 CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y2 < 0 || \ 1026 CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y3 < 0 || \ 1027 CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y4 < 0 || \ 1028 \ 1029 CFF_CONFIG_OPTION_DARKENING_PARAMETER_X1 > \ 1030 CFF_CONFIG_OPTION_DARKENING_PARAMETER_X2 || \ 1031 CFF_CONFIG_OPTION_DARKENING_PARAMETER_X2 > \ 1032 CFF_CONFIG_OPTION_DARKENING_PARAMETER_X3 || \ 1033 CFF_CONFIG_OPTION_DARKENING_PARAMETER_X3 > \ 1034 CFF_CONFIG_OPTION_DARKENING_PARAMETER_X4 || \ 1035 \ 1036 CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y1 > 500 || \ 1037 CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y2 > 500 || \ 1038 CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y3 > 500 || \ 1039 CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y4 > 500 1040 #error "Invalid CFF darkening parameters!" 1041 #endif 1042 1043 1044 FT_END_HEADER 1045 1046 #endif /* FTOPTION_H_ */ 1047 1048 1049 /* END */ 1050