1/***************************************************************************/
2/*                                                                         */
3/*  ftoption.h                                                             */
4/*                                                                         */
5/*    User-selectable configuration macros (specification only).           */
6/*                                                                         */
7/*  Copyright 1996-2018 by                                                 */
8/*  David Turner, Robert Wilhelm, and Werner Lemberg.                      */
9/*                                                                         */
10/*  This file is part of the FreeType project, and may only be used,       */
11/*  modified, and distributed under the terms of the FreeType project      */
12/*  license, LICENSE.TXT.  By continuing to use, modify, or distribute     */
13/*  this file you indicate that you have read the license and              */
14/*  understand and accept it fully.                                        */
15/*                                                                         */
16/***************************************************************************/
17
18
19#ifndef FTOPTION_H_
20#define FTOPTION_H_
21
22
23#include <ft2build.h>
24
25
26FT_BEGIN_HEADER
27
28  /*************************************************************************/
29  /*                                                                       */
30  /*                 USER-SELECTABLE CONFIGURATION MACROS                  */
31  /*                                                                       */
32  /* This file contains the default configuration macro definitions for    */
33  /* a standard build of the FreeType library.  There are three ways to    */
34  /* use this file to build project-specific versions of the library:      */
35  /*                                                                       */
36  /*  - You can modify this file by hand, but this is not recommended in   */
37  /*    cases where you would like to build several versions of the        */
38  /*    library from a single source directory.                            */
39  /*                                                                       */
40  /*  - You can put a copy of this file in your build directory, more      */
41  /*    precisely in `$BUILD/freetype/config/ftoption.h', where `$BUILD'   */
42  /*    is the name of a directory that is included _before_ the FreeType  */
43  /*    include path during compilation.                                   */
44  /*                                                                       */
45  /*    The default FreeType Makefiles and Jamfiles use the build          */
46  /*    directory `builds/<system>' by default, but you can easily change  */
47  /*    that for your own projects.                                        */
48  /*                                                                       */
49  /*  - Copy the file <ft2build.h> to `$BUILD/ft2build.h' and modify it    */
50  /*    slightly to pre-define the macro FT_CONFIG_OPTIONS_H used to       */
51  /*    locate this file during the build.  For example,                   */
52  /*                                                                       */
53  /*      #define FT_CONFIG_OPTIONS_H  <myftoptions.h>                     */
54  /*      #include <freetype/config/ftheader.h>                            */
55  /*                                                                       */
56  /*    will use `$BUILD/myftoptions.h' instead of this file for macro     */
57  /*    definitions.                                                       */
58  /*                                                                       */
59  /*    Note also that you can similarly pre-define the macro              */
60  /*    FT_CONFIG_MODULES_H used to locate the file listing of the modules */
61  /*    that are statically linked to the library at compile time.  By     */
62  /*    default, this file is <freetype/config/ftmodule.h>.                */
63  /*                                                                       */
64  /* We highly recommend using the third method whenever possible.         */
65  /*                                                                       */
66  /*************************************************************************/
67
68
69  /*************************************************************************/
70  /*************************************************************************/
71  /****                                                                 ****/
72  /**** G E N E R A L   F R E E T Y P E   2   C O N F I G U R A T I O N ****/
73  /****                                                                 ****/
74  /*************************************************************************/
75  /*************************************************************************/
76
77
78  /*#***********************************************************************/
79  /*                                                                       */
80  /* If you enable this configuration option, FreeType recognizes an       */
81  /* environment variable called `FREETYPE_PROPERTIES', which can be used  */
82  /* to control the various font drivers and modules.  The controllable    */
83  /* properties are listed in the section @properties.                     */
84  /*                                                                       */
85  /* `FREETYPE_PROPERTIES' has the following syntax form (broken here into */
86  /* multiple lines for better readability).                               */
87  /*                                                                       */
88  /* {                                                                     */
89  /*   <optional whitespace>                                               */
90  /*   <module-name1> ':'                                                  */
91  /*   <property-name1> '=' <property-value1>                              */
92  /*   <whitespace>                                                        */
93  /*   <module-name2> ':'                                                  */
94  /*   <property-name2> '=' <property-value2>                              */
95  /*   ...                                                                 */
96  /* }                                                                     */
97  /*                                                                       */
98  /* Example:                                                              */
99  /*                                                                       */
100  /*   FREETYPE_PROPERTIES=truetype:interpreter-version=35 \               */
101  /*                       cff:no-stem-darkening=1 \                       */
102  /*                       autofitter:warping=1                            */
103  /*                                                                       */
104  /* ANDROID: disabled */
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  /*   If you use a build system like cmake or the `configure' script,     */
215  /*   options set by those programs have precendence, overwriting the     */
216  /*   value here with the configured one.                                 */
217  /*                                                                       */
218/* #define FT_CONFIG_OPTION_SYSTEM_ZLIB */
219
220
221  /*************************************************************************/
222  /*                                                                       */
223  /* Bzip2-compressed file support.                                        */
224  /*                                                                       */
225  /*   FreeType now handles font files that have been compressed with the  */
226  /*   `bzip2' program.  This is mostly used to parse many of the PCF      */
227  /*   files that come with XFree86.  The implementation uses `libbz2' to  */
228  /*   partially uncompress the file on the fly (see src/bzip2/ftbzip2.c). */
229  /*   Contrary to gzip, bzip2 currently is not included and need to use   */
230  /*   the system available bzip2 implementation.                          */
231  /*                                                                       */
232  /*   Define this macro if you want to enable this `feature'.             */
233  /*                                                                       */
234  /*   If you use a build system like cmake or the `configure' script,     */
235  /*   options set by those programs have precendence, overwriting the     */
236  /*   value here with the configured one.                                 */
237  /*                                                                       */
238/* #define FT_CONFIG_OPTION_USE_BZIP2 */
239
240
241  /*************************************************************************/
242  /*                                                                       */
243  /* Define to disable the use of file stream functions and types, FILE,   */
244  /* fopen() etc.  Enables the use of smaller system libraries on embedded */
245  /* systems that have multiple system libraries, some with or without     */
246  /* file stream support, in the cases where file stream support is not    */
247  /* necessary such as memory loading of font files.                       */
248  /*                                                                       */
249/* #define FT_CONFIG_OPTION_DISABLE_STREAM_SUPPORT */
250
251
252  /*************************************************************************/
253  /*                                                                       */
254  /* PNG bitmap support.                                                   */
255  /*                                                                       */
256  /*   FreeType now handles loading color bitmap glyphs in the PNG format. */
257  /*   This requires help from the external libpng library.  Uncompressed  */
258  /*   color bitmaps do not need any external libraries and will be        */
259  /*   supported regardless of this configuration.                         */
260  /*                                                                       */
261  /*   Define this macro if you want to enable this `feature'.             */
262  /*   If you use a build system like cmake or the `configure' script,     */
263  /*   options set by those programs have precendence, overwriting the     */
264  /*   value here with the configured one.                                 */
265  /*                                                                       */
266  /* ANDROID: enabled */
267#define FT_CONFIG_OPTION_USE_PNG
268
269
270  /*************************************************************************/
271  /*                                                                       */
272  /* HarfBuzz support.                                                     */
273  /*                                                                       */
274  /*   FreeType uses the HarfBuzz library to improve auto-hinting of       */
275  /*   OpenType fonts.  If available, many glyphs not directly addressable */
276  /*   by a font's character map will be hinted also.                      */
277  /*                                                                       */
278  /*   Define this macro if you want to enable this `feature'.             */
279  /*                                                                       */
280  /*   If you use a build system like cmake or the `configure' script,     */
281  /*   options set by those programs have precendence, overwriting the     */
282  /*   value here with the configured one.                                 */
283  /*                                                                       */
284/* #define FT_CONFIG_OPTION_USE_HARFBUZZ */
285
286
287  /*************************************************************************/
288  /*                                                                       */
289  /* Glyph Postscript Names handling                                       */
290  /*                                                                       */
291  /*   By default, FreeType 2 is compiled with the `psnames' module.  This */
292  /*   module is in charge of converting a glyph name string into a        */
293  /*   Unicode value, or return a Macintosh standard glyph name for the    */
294  /*   use with the TrueType `post' table.                                 */
295  /*                                                                       */
296  /*   Undefine this macro if you do not want `psnames' compiled in your   */
297  /*   build of FreeType.  This has the following effects:                 */
298  /*                                                                       */
299  /*   - The TrueType driver will provide its own set of glyph names,      */
300  /*     if you build it to support postscript names in the TrueType       */
301  /*     `post' table, but will not synthesize a missing Unicode charmap.  */
302  /*                                                                       */
303  /*   - The Type 1 driver will not be able to synthesize a Unicode        */
304  /*     charmap out of the glyphs found in the fonts.                     */
305  /*                                                                       */
306  /*   You would normally undefine this configuration macro when building  */
307  /*   a version of FreeType that doesn't contain a Type 1 or CFF driver.  */
308  /*                                                                       */
309#define FT_CONFIG_OPTION_POSTSCRIPT_NAMES
310
311
312  /*************************************************************************/
313  /*                                                                       */
314  /* Postscript Names to Unicode Values support                            */
315  /*                                                                       */
316  /*   By default, FreeType 2 is built with the `PSNames' module compiled  */
317  /*   in.  Among other things, the module is used to convert a glyph name */
318  /*   into a Unicode value.  This is especially useful in order to        */
319  /*   synthesize on the fly a Unicode charmap from the CFF/Type 1 driver  */
320  /*   through a big table named the `Adobe Glyph List' (AGL).             */
321  /*                                                                       */
322  /*   Undefine this macro if you do not want the Adobe Glyph List         */
323  /*   compiled in your `PSNames' module.  The Type 1 driver will not be   */
324  /*   able to synthesize a Unicode charmap out of the glyphs found in the */
325  /*   fonts.                                                              */
326  /*                                                                       */
327#define FT_CONFIG_OPTION_ADOBE_GLYPH_LIST
328
329
330  /*************************************************************************/
331  /*                                                                       */
332  /* Support for Mac fonts                                                 */
333  /*                                                                       */
334  /*   Define this macro if you want support for outline fonts in Mac      */
335  /*   format (mac dfont, mac resource, macbinary containing a mac         */
336  /*   resource) on non-Mac platforms.                                     */
337  /*                                                                       */
338  /*   Note that the `FOND' resource isn't checked.                        */
339  /*                                                                       */
340#define FT_CONFIG_OPTION_MAC_FONTS
341
342
343  /*************************************************************************/
344  /*                                                                       */
345  /* Guessing methods to access embedded resource forks                    */
346  /*                                                                       */
347  /*   Enable extra Mac fonts support on non-Mac platforms (e.g.           */
348  /*   GNU/Linux).                                                         */
349  /*                                                                       */
350  /*   Resource forks which include fonts data are stored sometimes in     */
351  /*   locations which users or developers don't expected.  In some cases, */
352  /*   resource forks start with some offset from the head of a file.  In  */
353  /*   other cases, the actual resource fork is stored in file different   */
354  /*   from what the user specifies.  If this option is activated,         */
355  /*   FreeType tries to guess whether such offsets or different file      */
356  /*   names must be used.                                                 */
357  /*                                                                       */
358  /*   Note that normal, direct access of resource forks is controlled via */
359  /*   the FT_CONFIG_OPTION_MAC_FONTS option.                              */
360  /*                                                                       */
361#ifdef FT_CONFIG_OPTION_MAC_FONTS
362#define FT_CONFIG_OPTION_GUESSING_EMBEDDED_RFORK
363#endif
364
365
366  /*************************************************************************/
367  /*                                                                       */
368  /* Allow the use of FT_Incremental_Interface to load typefaces that      */
369  /* contain no glyph data, but supply it via a callback function.         */
370  /* This is required by clients supporting document formats which         */
371  /* supply font data incrementally as the document is parsed, such        */
372  /* as the Ghostscript interpreter for the PostScript language.           */
373  /*                                                                       */
374  /* ANDROID: disabled */
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
660/* ANDROID: disabled */
661/* #define TT_CONFIG_OPTION_SUBPIXEL_HINTING  2         */
662
663/* #define TT_CONFIG_OPTION_SUBPIXEL_HINTING  ( 1 | 2 ) */
664
665
666  /*************************************************************************/
667  /*                                                                       */
668  /* Define TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED to compile the        */
669  /* TrueType glyph loader to use Apple's definition of how to handle      */
670  /* component offsets in composite glyphs.                                */
671  /*                                                                       */
672  /* Apple and MS disagree on the default behavior of component offsets    */
673  /* in composites.  Apple says that they should be scaled by the scaling  */
674  /* factors in the transformation matrix (roughly, it's more complex)     */
675  /* while MS says they should not.  OpenType defines two bits in the      */
676  /* composite flags array which can be used to disambiguate, but old      */
677  /* fonts will not have them.                                             */
678  /*                                                                       */
679  /*   https://www.microsoft.com/typography/otspec/glyf.htm                */
680  /*   https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6glyf.html */
681  /*                                                                       */
682#undef TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED
683
684
685  /*************************************************************************/
686  /*                                                                       */
687  /* Define TT_CONFIG_OPTION_GX_VAR_SUPPORT if you want to include         */
688  /* support for Apple's distortable font technology (fvar, gvar, cvar,    */
689  /* and avar tables).  This has many similarities to Type 1 Multiple      */
690  /* Masters support.                                                      */
691  /*                                                                       */
692#define TT_CONFIG_OPTION_GX_VAR_SUPPORT
693
694
695  /*************************************************************************/
696  /*                                                                       */
697  /* Define TT_CONFIG_OPTION_BDF if you want to include support for        */
698  /* an embedded `BDF ' table within SFNT-based bitmap formats.            */
699  /*                                                                       */
700#define TT_CONFIG_OPTION_BDF
701
702
703  /*************************************************************************/
704  /*                                                                       */
705  /* Option TT_CONFIG_OPTION_MAX_RUNNABLE_OPCODES controls the maximum     */
706  /* number of bytecode instructions executed for a single run of the      */
707  /* bytecode interpreter, needed to prevent infinite loops.  You don't    */
708  /* want to change this except for very special situations (e.g., making  */
709  /* a library fuzzer spend less time to handle broken fonts).             */
710  /*                                                                       */
711  /* It is not expected that this value is ever modified by a configuring  */
712  /* script; instead, it gets surrounded with #ifndef ... #endif so that   */
713  /* the value can be set as a preprocessor option on the compiler's       */
714  /* command line.                                                         */
715  /*                                                                       */
716#ifndef TT_CONFIG_OPTION_MAX_RUNNABLE_OPCODES
717#define TT_CONFIG_OPTION_MAX_RUNNABLE_OPCODES  1000000L
718#endif
719
720
721  /*************************************************************************/
722  /*************************************************************************/
723  /****                                                                 ****/
724  /****      T Y P E 1   D R I V E R    C O N F I G U R A T I O N       ****/
725  /****                                                                 ****/
726  /*************************************************************************/
727  /*************************************************************************/
728
729
730  /*************************************************************************/
731  /*                                                                       */
732  /* T1_MAX_DICT_DEPTH is the maximum depth of nest dictionaries and       */
733  /* arrays in the Type 1 stream (see t1load.c).  A minimum of 4 is        */
734  /* required.                                                             */
735  /*                                                                       */
736#define T1_MAX_DICT_DEPTH  5
737
738
739  /*************************************************************************/
740  /*                                                                       */
741  /* T1_MAX_SUBRS_CALLS details the maximum number of nested sub-routine   */
742  /* calls during glyph loading.                                           */
743  /*                                                                       */
744#define T1_MAX_SUBRS_CALLS  16
745
746
747  /*************************************************************************/
748  /*                                                                       */
749  /* T1_MAX_CHARSTRING_OPERANDS is the charstring stack's capacity.  A     */
750  /* minimum of 16 is required.                                            */
751  /*                                                                       */
752  /* The Chinese font MingTiEG-Medium (CNS 11643 character set) needs 256. */
753  /*                                                                       */
754#define T1_MAX_CHARSTRINGS_OPERANDS  256
755
756
757  /*************************************************************************/
758  /*                                                                       */
759  /* Define this configuration macro if you want to prevent the            */
760  /* compilation of `t1afm', which is in charge of reading Type 1 AFM      */
761  /* files into an existing face.  Note that if set, the T1 driver will be */
762  /* unable to produce kerning distances.                                  */
763  /*                                                                       */
764#undef T1_CONFIG_OPTION_NO_AFM
765
766
767  /*************************************************************************/
768  /*                                                                       */
769  /* Define this configuration macro if you want to prevent the            */
770  /* compilation of the Multiple Masters font support in the Type 1        */
771  /* driver.                                                               */
772  /*                                                                       */
773#undef T1_CONFIG_OPTION_NO_MM_SUPPORT
774
775
776  /*************************************************************************/
777  /*                                                                       */
778  /* T1_CONFIG_OPTION_OLD_ENGINE controls whether the pre-Adobe Type 1     */
779  /* engine gets compiled into FreeType.  If defined, it is possible to    */
780  /* switch between the two engines using the `hinting-engine' property of */
781  /* the type1 driver module.                                              */
782  /*                                                                       */
783/* #define T1_CONFIG_OPTION_OLD_ENGINE */
784
785
786  /*************************************************************************/
787  /*************************************************************************/
788  /****                                                                 ****/
789  /****         C F F   D R I V E R    C O N F I G U R A T I O N        ****/
790  /****                                                                 ****/
791  /*************************************************************************/
792  /*************************************************************************/
793
794
795  /*************************************************************************/
796  /*                                                                       */
797  /* Using CFF_CONFIG_OPTION_DARKENING_PARAMETER_{X,Y}{1,2,3,4} it is      */
798  /* possible to set up the default values of the four control points that */
799  /* define the stem darkening behaviour of the (new) CFF engine.  For     */
800  /* more details please read the documentation of the                     */
801  /* `darkening-parameters' property (file `ftdriver.h'), which allows the */
802  /* control at run-time.                                                  */
803  /*                                                                       */
804  /* Do *not* undefine these macros!                                       */
805  /*                                                                       */
806#define CFF_CONFIG_OPTION_DARKENING_PARAMETER_X1   500
807#define CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y1   400
808
809#define CFF_CONFIG_OPTION_DARKENING_PARAMETER_X2  1000
810#define CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y2   275
811
812#define CFF_CONFIG_OPTION_DARKENING_PARAMETER_X3  1667
813#define CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y3   275
814
815#define CFF_CONFIG_OPTION_DARKENING_PARAMETER_X4  2333
816#define CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y4     0
817
818
819  /*************************************************************************/
820  /*                                                                       */
821  /* CFF_CONFIG_OPTION_OLD_ENGINE controls whether the pre-Adobe CFF       */
822  /* engine gets compiled into FreeType.  If defined, it is possible to    */
823  /* switch between the two engines using the `hinting-engine' property of */
824  /* the cff driver module.                                                */
825  /*                                                                       */
826/* #define CFF_CONFIG_OPTION_OLD_ENGINE */
827
828
829  /*************************************************************************/
830  /*************************************************************************/
831  /****                                                                 ****/
832  /****         P C F   D R I V E R    C O N F I G U R A T I O N        ****/
833  /****                                                                 ****/
834  /*************************************************************************/
835  /*************************************************************************/
836
837
838  /*************************************************************************/
839  /*                                                                       */
840  /* There are many PCF fonts just called `Fixed' which look completely    */
841  /* different, and which have nothing to do with each other.  When        */
842  /* selecting `Fixed' in KDE or Gnome one gets results that appear rather */
843  /* random, the style changes often if one changes the size and one       */
844  /* cannot select some fonts at all.  This option makes the PCF module    */
845  /* prepend the foundry name (plus a space) to the family name.           */
846  /*                                                                       */
847  /* We also check whether we have `wide' characters; all put together, we */
848  /* get family names like `Sony Fixed' or `Misc Fixed Wide'.              */
849  /*                                                                       */
850  /* If this option is activated, it can be controlled with the            */
851  /* `no-long-family-names' property of the pcf driver module.             */
852  /*                                                                       */
853/* #define PCF_CONFIG_OPTION_LONG_FAMILY_NAMES */
854
855
856  /*************************************************************************/
857  /*************************************************************************/
858  /****                                                                 ****/
859  /****    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     ****/
860  /****                                                                 ****/
861  /*************************************************************************/
862  /*************************************************************************/
863
864
865  /*************************************************************************/
866  /*                                                                       */
867  /* Compile autofit module with CJK (Chinese, Japanese, Korean) script    */
868  /* support.                                                              */
869  /*                                                                       */
870#define AF_CONFIG_OPTION_CJK
871
872  /*************************************************************************/
873  /*                                                                       */
874  /* Compile autofit module with fallback Indic script support, covering   */
875  /* some scripts that the `latin' submodule of the autofit module doesn't */
876  /* (yet) handle.                                                         */
877  /*                                                                       */
878#define AF_CONFIG_OPTION_INDIC
879
880  /*************************************************************************/
881  /*                                                                       */
882  /* Compile autofit module with warp hinting.  The idea of the warping    */
883  /* code is to slightly scale and shift a glyph within a single dimension */
884  /* so that as much of its segments are aligned (more or less) on the     */
885  /* grid.  To find out the optimal scaling and shifting value, various    */
886  /* parameter combinations are tried and scored.                          */
887  /*                                                                       */
888  /* This experimental option is active only if the rendering mode is      */
889  /* FT_RENDER_MODE_LIGHT; you can switch warping on and off with the      */
890  /* `warping' property of the auto-hinter (see file `ftdriver.h' for more */
891  /* information; by default it is switched off).                          */
892  /*                                                                       */
893#define AF_CONFIG_OPTION_USE_WARPER
894
895  /*************************************************************************/
896  /*                                                                       */
897  /* Use TrueType-like size metrics for `light' auto-hinting.              */
898  /*                                                                       */
899  /* It is strongly recommended to avoid this option, which exists only to */
900  /* help some legacy applications retain its appearance and behaviour     */
901  /* with respect to auto-hinted TrueType fonts.                           */
902  /*                                                                       */
903  /* The very reason this option exists at all are GNU/Linux distributions */
904  /* like Fedora that did not un-patch the following change (which was     */
905  /* present in FreeType between versions 2.4.6 and 2.7.1, inclusive).     */
906  /*                                                                       */
907  /*   2011-07-16  Steven Chu  <steven.f.chu@gmail.com>                    */
908  /*                                                                       */
909  /*     [truetype] Fix metrics on size request for scalable fonts.        */
910  /*                                                                       */
911  /* This problematic commit is now reverted (more or less).               */
912  /*                                                                       */
913/* #define AF_CONFIG_OPTION_TT_SIZE_METRICS */
914
915  /* */
916
917
918  /*
919   * This macro is obsolete.  Support has been removed in FreeType
920   * version 2.5.
921   */
922/* #define FT_CONFIG_OPTION_OLD_INTERNALS */
923
924
925  /*
926   * This macro is defined if native TrueType hinting is requested by the
927   * definitions above.
928   */
929#ifdef TT_CONFIG_OPTION_BYTECODE_INTERPRETER
930#define  TT_USE_BYTECODE_INTERPRETER
931
932#ifdef TT_CONFIG_OPTION_SUBPIXEL_HINTING
933#if TT_CONFIG_OPTION_SUBPIXEL_HINTING & 1
934#define  TT_SUPPORT_SUBPIXEL_HINTING_INFINALITY
935#endif
936
937#if TT_CONFIG_OPTION_SUBPIXEL_HINTING & 2
938#define  TT_SUPPORT_SUBPIXEL_HINTING_MINIMAL
939#endif
940#endif
941#endif
942
943
944  /*
945   * Check CFF darkening parameters.  The checks are the same as in function
946   * `cff_property_set' in file `cffdrivr.c'.
947   */
948#if CFF_CONFIG_OPTION_DARKENING_PARAMETER_X1 < 0   || \
949    CFF_CONFIG_OPTION_DARKENING_PARAMETER_X2 < 0   || \
950    CFF_CONFIG_OPTION_DARKENING_PARAMETER_X3 < 0   || \
951    CFF_CONFIG_OPTION_DARKENING_PARAMETER_X4 < 0   || \
952                                                      \
953    CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y1 < 0   || \
954    CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y2 < 0   || \
955    CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y3 < 0   || \
956    CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y4 < 0   || \
957                                                      \
958    CFF_CONFIG_OPTION_DARKENING_PARAMETER_X1 >        \
959      CFF_CONFIG_OPTION_DARKENING_PARAMETER_X2     || \
960    CFF_CONFIG_OPTION_DARKENING_PARAMETER_X2 >        \
961      CFF_CONFIG_OPTION_DARKENING_PARAMETER_X3     || \
962    CFF_CONFIG_OPTION_DARKENING_PARAMETER_X3 >        \
963      CFF_CONFIG_OPTION_DARKENING_PARAMETER_X4     || \
964                                                      \
965    CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y1 > 500 || \
966    CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y2 > 500 || \
967    CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y3 > 500 || \
968    CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y4 > 500
969#error "Invalid CFF darkening parameters!"
970#endif
971
972FT_END_HEADER
973
974
975#endif /* FTOPTION_H_ */
976
977
978/* END */
979