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