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