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