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