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