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