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