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