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