misc/libfreetype/devel/ftoption.h
changeset 9372 915436ff64ab
parent 9371 f3840de881bd
child 9373 b769a8e38cbd
equal deleted inserted replaced
9371:f3840de881bd 9372:915436ff64ab
     1 /***************************************************************************/
       
     2 /*                                                                         */
       
     3 /*  ftoption.h (for development)                                           */
       
     4 /*                                                                         */
       
     5 /*    User-selectable configuration macros (specification only).           */
       
     6 /*                                                                         */
       
     7 /*  Copyright 1996-2011 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   /* Uncomment the line below if you want to activate sub-pixel rendering  */
       
    81   /* (a.k.a. LCD rendering, or ClearType) in this build of the library.    */
       
    82   /*                                                                       */
       
    83   /* Note that this feature is covered by several Microsoft patents        */
       
    84   /* and should not be activated in any default build of the library.      */
       
    85   /*                                                                       */
       
    86   /* This macro has no impact on the FreeType API, only on its             */
       
    87   /* _implementation_.  For example, using FT_RENDER_MODE_LCD when calling */
       
    88   /* FT_Render_Glyph still generates a bitmap that is 3 times wider than   */
       
    89   /* the original size in case this macro isn't defined; however, each     */
       
    90   /* triplet of subpixels has R=G=B.                                       */
       
    91   /*                                                                       */
       
    92   /* This is done to allow FreeType clients to run unmodified, forcing     */
       
    93   /* them to display normal gray-level anti-aliased glyphs.                */
       
    94   /*                                                                       */
       
    95 #define FT_CONFIG_OPTION_SUBPIXEL_RENDERING
       
    96 
       
    97 
       
    98   /*************************************************************************/
       
    99   /*                                                                       */
       
   100   /* Many compilers provide a non-ANSI 64-bit data type that can be used   */
       
   101   /* by FreeType to speed up some computations.  However, this will create */
       
   102   /* some problems when compiling the library in strict ANSI mode.         */
       
   103   /*                                                                       */
       
   104   /* For this reason, the use of 64-bit integers is normally disabled when */
       
   105   /* the __STDC__ macro is defined.  You can however disable this by       */
       
   106   /* defining the macro FT_CONFIG_OPTION_FORCE_INT64 here.                 */
       
   107   /*                                                                       */
       
   108   /* For most compilers, this will only create compilation warnings when   */
       
   109   /* building the library.                                                 */
       
   110   /*                                                                       */
       
   111   /* ObNote: The compiler-specific 64-bit integers are detected in the     */
       
   112   /*         file `ftconfig.h' either statically or through the            */
       
   113   /*         `configure' script on supported platforms.                    */
       
   114   /*                                                                       */
       
   115 #undef FT_CONFIG_OPTION_FORCE_INT64
       
   116 
       
   117 
       
   118   /*************************************************************************/
       
   119   /*                                                                       */
       
   120   /* If this macro is defined, do not try to use an assembler version of   */
       
   121   /* performance-critical functions (e.g. FT_MulFix).  You should only do  */
       
   122   /* that to verify that the assembler function works properly, or to      */
       
   123   /* execute benchmark tests of the various implementations.               */
       
   124 /* #define FT_CONFIG_OPTION_NO_ASSEMBLER */
       
   125 
       
   126 
       
   127   /*************************************************************************/
       
   128   /*                                                                       */
       
   129   /* If this macro is defined, try to use an inlined assembler version of  */
       
   130   /* the `FT_MulFix' function, which is a `hotspot' when loading and       */
       
   131   /* hinting glyphs, and which should be executed as fast as possible.     */
       
   132   /*                                                                       */
       
   133   /* Note that if your compiler or CPU is not supported, this will default */
       
   134   /* to the standard and portable implementation found in `ftcalc.c'.      */
       
   135   /*                                                                       */
       
   136 #define FT_CONFIG_OPTION_INLINE_MULFIX
       
   137 
       
   138 
       
   139   /*************************************************************************/
       
   140   /*                                                                       */
       
   141   /* LZW-compressed file support.                                          */
       
   142   /*                                                                       */
       
   143   /*   FreeType now handles font files that have been compressed with the  */
       
   144   /*   `compress' program.  This is mostly used to parse many of the PCF   */
       
   145   /*   files that come with various X11 distributions.  The implementation */
       
   146   /*   uses NetBSD's `zopen' to partially uncompress the file on the fly   */
       
   147   /*   (see src/lzw/ftgzip.c).                                             */
       
   148   /*                                                                       */
       
   149   /*   Define this macro if you want to enable this `feature'.             */
       
   150   /*                                                                       */
       
   151 #define FT_CONFIG_OPTION_USE_LZW
       
   152 
       
   153 
       
   154   /*************************************************************************/
       
   155   /*                                                                       */
       
   156   /* Gzip-compressed file support.                                         */
       
   157   /*                                                                       */
       
   158   /*   FreeType now handles font files that have been compressed with the  */
       
   159   /*   `gzip' program.  This is mostly used to parse many of the PCF files */
       
   160   /*   that come with XFree86.  The implementation uses `zlib' to          */
       
   161   /*   partially uncompress the file on the fly (see src/gzip/ftgzip.c).   */
       
   162   /*                                                                       */
       
   163   /*   Define this macro if you want to enable this `feature'.  See also   */
       
   164   /*   the macro FT_CONFIG_OPTION_SYSTEM_ZLIB below.                       */
       
   165   /*                                                                       */
       
   166 #define FT_CONFIG_OPTION_USE_ZLIB
       
   167 
       
   168 
       
   169   /*************************************************************************/
       
   170   /*                                                                       */
       
   171   /* ZLib library selection                                                */
       
   172   /*                                                                       */
       
   173   /*   This macro is only used when FT_CONFIG_OPTION_USE_ZLIB is defined.  */
       
   174   /*   It allows FreeType's `ftgzip' component to link to the system's     */
       
   175   /*   installation of the ZLib library.  This is useful on systems like   */
       
   176   /*   Unix or VMS where it generally is already available.                */
       
   177   /*                                                                       */
       
   178   /*   If you let it undefined, the component will use its own copy        */
       
   179   /*   of the zlib sources instead.  These have been modified to be        */
       
   180   /*   included directly within the component and *not* export external    */
       
   181   /*   function names.  This allows you to link any program with FreeType  */
       
   182   /*   _and_ ZLib without linking conflicts.                               */
       
   183   /*                                                                       */
       
   184   /*   Do not #undef this macro here since the build system might define   */
       
   185   /*   it for certain configurations only.                                 */
       
   186   /*                                                                       */
       
   187 /* #define FT_CONFIG_OPTION_SYSTEM_ZLIB */
       
   188 
       
   189 
       
   190   /*************************************************************************/
       
   191   /*                                                                       */
       
   192   /* Bzip2-compressed file support.                                        */
       
   193   /*                                                                       */
       
   194   /*   FreeType now handles font files that have been compressed with the  */
       
   195   /*   `bzip2' program.  This is mostly used to parse many of the PCF      */
       
   196   /*   files that come with XFree86.  The implementation uses `libbz2' to  */
       
   197   /*   partially uncompress the file on the fly (see src/bzip2/ftbzip2.c). */
       
   198   /*   Contrary to gzip, bzip2 currently is not included and need to use   */
       
   199   /*   the system available bzip2 implementation.                          */
       
   200   /*                                                                       */
       
   201   /*   Define this macro if you want to enable this `feature'.             */
       
   202   /*                                                                       */
       
   203 #define FT_CONFIG_OPTION_USE_BZIP2
       
   204 
       
   205 
       
   206   /*************************************************************************/
       
   207   /*                                                                       */
       
   208   /* DLL export compilation                                                */
       
   209   /*                                                                       */
       
   210   /*   When compiling FreeType as a DLL, some systems/compilers need a     */
       
   211   /*   special keyword in front OR after the return type of function       */
       
   212   /*   declarations.                                                       */
       
   213   /*                                                                       */
       
   214   /*   Two macros are used within the FreeType source code to define       */
       
   215   /*   exported library functions: FT_EXPORT and FT_EXPORT_DEF.            */
       
   216   /*                                                                       */
       
   217   /*     FT_EXPORT( return_type )                                          */
       
   218   /*                                                                       */
       
   219   /*       is used in a function declaration, as in                        */
       
   220   /*                                                                       */
       
   221   /*         FT_EXPORT( FT_Error )                                         */
       
   222   /*         FT_Init_FreeType( FT_Library*  alibrary );                    */
       
   223   /*                                                                       */
       
   224   /*                                                                       */
       
   225   /*     FT_EXPORT_DEF( return_type )                                      */
       
   226   /*                                                                       */
       
   227   /*       is used in a function definition, as in                         */
       
   228   /*                                                                       */
       
   229   /*         FT_EXPORT_DEF( FT_Error )                                     */
       
   230   /*         FT_Init_FreeType( FT_Library*  alibrary )                     */
       
   231   /*         {                                                             */
       
   232   /*           ... some code ...                                           */
       
   233   /*           return FT_Err_Ok;                                           */
       
   234   /*         }                                                             */
       
   235   /*                                                                       */
       
   236   /*   You can provide your own implementation of FT_EXPORT and            */
       
   237   /*   FT_EXPORT_DEF here if you want.  If you leave them undefined, they  */
       
   238   /*   will be later automatically defined as `extern return_type' to      */
       
   239   /*   allow normal compilation.                                           */
       
   240   /*                                                                       */
       
   241   /*   Do not #undef these macros here since the build system might define */
       
   242   /*   them for certain configurations only.                               */
       
   243   /*                                                                       */
       
   244 /* #define FT_EXPORT(x)      extern x */
       
   245 /* #define FT_EXPORT_DEF(x)  x */
       
   246 
       
   247 
       
   248   /*************************************************************************/
       
   249   /*                                                                       */
       
   250   /* Glyph Postscript Names handling                                       */
       
   251   /*                                                                       */
       
   252   /*   By default, FreeType 2 is compiled with the `psnames' module.  This */
       
   253   /*   module is in charge of converting a glyph name string into a        */
       
   254   /*   Unicode value, or return a Macintosh standard glyph name for the    */
       
   255   /*   use with the TrueType `post' table.                                 */
       
   256   /*                                                                       */
       
   257   /*   Undefine this macro if you do not want `psnames' compiled in your   */
       
   258   /*   build of FreeType.  This has the following effects:                 */
       
   259   /*                                                                       */
       
   260   /*   - The TrueType driver will provide its own set of glyph names,      */
       
   261   /*     if you build it to support postscript names in the TrueType       */
       
   262   /*     `post' table.                                                     */
       
   263   /*                                                                       */
       
   264   /*   - The Type 1 driver will not be able to synthesize a Unicode        */
       
   265   /*     charmap out of the glyphs found in the fonts.                     */
       
   266   /*                                                                       */
       
   267   /*   You would normally undefine this configuration macro when building  */
       
   268   /*   a version of FreeType that doesn't contain a Type 1 or CFF driver.  */
       
   269   /*                                                                       */
       
   270 #define FT_CONFIG_OPTION_POSTSCRIPT_NAMES
       
   271 
       
   272 
       
   273   /*************************************************************************/
       
   274   /*                                                                       */
       
   275   /* Postscript Names to Unicode Values support                            */
       
   276   /*                                                                       */
       
   277   /*   By default, FreeType 2 is built with the `PSNames' module compiled  */
       
   278   /*   in.  Among other things, the module is used to convert a glyph name */
       
   279   /*   into a Unicode value.  This is especially useful in order to        */
       
   280   /*   synthesize on the fly a Unicode charmap from the CFF/Type 1 driver  */
       
   281   /*   through a big table named the `Adobe Glyph List' (AGL).             */
       
   282   /*                                                                       */
       
   283   /*   Undefine this macro if you do not want the Adobe Glyph List         */
       
   284   /*   compiled in your `PSNames' module.  The Type 1 driver will not be   */
       
   285   /*   able to synthesize a Unicode charmap out of the glyphs found in the */
       
   286   /*   fonts.                                                              */
       
   287   /*                                                                       */
       
   288 #define FT_CONFIG_OPTION_ADOBE_GLYPH_LIST
       
   289 
       
   290 
       
   291   /*************************************************************************/
       
   292   /*                                                                       */
       
   293   /* Support for Mac fonts                                                 */
       
   294   /*                                                                       */
       
   295   /*   Define this macro if you want support for outline fonts in Mac      */
       
   296   /*   format (mac dfont, mac resource, macbinary containing a mac         */
       
   297   /*   resource) on non-Mac platforms.                                     */
       
   298   /*                                                                       */
       
   299   /*   Note that the `FOND' resource isn't checked.                        */
       
   300   /*                                                                       */
       
   301 #define FT_CONFIG_OPTION_MAC_FONTS
       
   302 
       
   303 
       
   304   /*************************************************************************/
       
   305   /*                                                                       */
       
   306   /* Guessing methods to access embedded resource forks                    */
       
   307   /*                                                                       */
       
   308   /*   Enable extra Mac fonts support on non-Mac platforms (e.g.           */
       
   309   /*   GNU/Linux).                                                         */
       
   310   /*                                                                       */
       
   311   /*   Resource forks which include fonts data are stored sometimes in     */
       
   312   /*   locations which users or developers don't expected.  In some cases, */
       
   313   /*   resource forks start with some offset from the head of a file.  In  */
       
   314   /*   other cases, the actual resource fork is stored in file different   */
       
   315   /*   from what the user specifies.  If this option is activated,         */
       
   316   /*   FreeType tries to guess whether such offsets or different file      */
       
   317   /*   names must be used.                                                 */
       
   318   /*                                                                       */
       
   319   /*   Note that normal, direct access of resource forks is controlled via */
       
   320   /*   the FT_CONFIG_OPTION_MAC_FONTS option.                              */
       
   321   /*                                                                       */
       
   322 #ifdef FT_CONFIG_OPTION_MAC_FONTS
       
   323 #define FT_CONFIG_OPTION_GUESSING_EMBEDDED_RFORK
       
   324 #endif
       
   325 
       
   326 
       
   327   /*************************************************************************/
       
   328   /*                                                                       */
       
   329   /* Allow the use of FT_Incremental_Interface to load typefaces that      */
       
   330   /* contain no glyph data, but supply it via a callback function.         */
       
   331   /* This is required by clients supporting document formats which         */
       
   332   /* supply font data incrementally as the document is parsed, such        */
       
   333   /* as the Ghostscript interpreter for the PostScript language.           */
       
   334   /*                                                                       */
       
   335 #define FT_CONFIG_OPTION_INCREMENTAL
       
   336 
       
   337 
       
   338   /*************************************************************************/
       
   339   /*                                                                       */
       
   340   /* The size in bytes of the render pool used by the scan-line converter  */
       
   341   /* to do all of its work.                                                */
       
   342   /*                                                                       */
       
   343   /* This must be greater than 4KByte if you use FreeType to rasterize     */
       
   344   /* glyphs; otherwise, you may set it to zero to avoid unnecessary        */
       
   345   /* allocation of the render pool.                                        */
       
   346   /*                                                                       */
       
   347 #define FT_RENDER_POOL_SIZE  16384L
       
   348 
       
   349 
       
   350   /*************************************************************************/
       
   351   /*                                                                       */
       
   352   /* FT_MAX_MODULES                                                        */
       
   353   /*                                                                       */
       
   354   /*   The maximum number of modules that can be registered in a single    */
       
   355   /*   FreeType library object.  32 is the default.                        */
       
   356   /*                                                                       */
       
   357 #define FT_MAX_MODULES  32
       
   358 
       
   359 
       
   360   /*************************************************************************/
       
   361   /*                                                                       */
       
   362   /* Debug level                                                           */
       
   363   /*                                                                       */
       
   364   /*   FreeType can be compiled in debug or trace mode.  In debug mode,    */
       
   365   /*   errors are reported through the `ftdebug' component.  In trace      */
       
   366   /*   mode, additional messages are sent to the standard output during    */
       
   367   /*   execution.                                                          */
       
   368   /*                                                                       */
       
   369   /*   Define FT_DEBUG_LEVEL_ERROR to build the library in debug mode.     */
       
   370   /*   Define FT_DEBUG_LEVEL_TRACE to build it in trace mode.              */
       
   371   /*                                                                       */
       
   372   /*   Don't define any of these macros to compile in `release' mode!      */
       
   373   /*                                                                       */
       
   374   /*   Do not #undef these macros here since the build system might define */
       
   375   /*   them for certain configurations only.                               */
       
   376   /*                                                                       */
       
   377 #define FT_DEBUG_LEVEL_ERROR
       
   378 #define FT_DEBUG_LEVEL_TRACE
       
   379 
       
   380 
       
   381   /*************************************************************************/
       
   382   /*                                                                       */
       
   383   /* Autofitter debugging                                                  */
       
   384   /*                                                                       */
       
   385   /*   If FT_DEBUG_AUTOFIT is defined, FreeType provides some means to     */
       
   386   /*   control the autofitter behaviour for debugging purposes with global */
       
   387   /*   boolean variables (consequently, you should *never* enable this     */
       
   388   /*   while compiling in `release' mode):                                 */
       
   389   /*                                                                       */
       
   390   /*     _af_debug_disable_horz_hints                                      */
       
   391   /*     _af_debug_disable_vert_hints                                      */
       
   392   /*     _af_debug_disable_blue_hints                                      */
       
   393   /*                                                                       */
       
   394   /*   Additionally, the following functions provide dumps of various      */
       
   395   /*   internal autofit structures to stdout (using `printf'):             */
       
   396   /*                                                                       */
       
   397   /*     af_glyph_hints_dump_points                                        */
       
   398   /*     af_glyph_hints_dump_segments                                      */
       
   399   /*     af_glyph_hints_dump_edges                                         */
       
   400   /*                                                                       */
       
   401   /*   As an argument, they use another global variable:                   */
       
   402   /*                                                                       */
       
   403   /*     _af_debug_hints                                                   */
       
   404   /*                                                                       */
       
   405   /*   Please have a look at the `ftgrid' demo program to see how those    */
       
   406   /*   variables and macros should be used.                                */
       
   407   /*                                                                       */
       
   408   /*   Do not #undef these macros here since the build system might define */
       
   409   /*   them for certain configurations only.                               */
       
   410   /*                                                                       */
       
   411 #define FT_DEBUG_AUTOFIT
       
   412 
       
   413 
       
   414   /*************************************************************************/
       
   415   /*                                                                       */
       
   416   /* Memory Debugging                                                      */
       
   417   /*                                                                       */
       
   418   /*   FreeType now comes with an integrated memory debugger that is       */
       
   419   /*   capable of detecting simple errors like memory leaks or double      */
       
   420   /*   deletes.  To compile it within your build of the library, you       */
       
   421   /*   should define FT_DEBUG_MEMORY here.                                 */
       
   422   /*                                                                       */
       
   423   /*   Note that the memory debugger is only activated at runtime when     */
       
   424   /*   when the _environment_ variable `FT2_DEBUG_MEMORY' is defined also! */
       
   425   /*                                                                       */
       
   426   /*   Do not #undef this macro here since the build system might define   */
       
   427   /*   it for certain configurations only.                                 */
       
   428   /*                                                                       */
       
   429 #define FT_DEBUG_MEMORY
       
   430 
       
   431 
       
   432   /*************************************************************************/
       
   433   /*                                                                       */
       
   434   /* Module errors                                                         */
       
   435   /*                                                                       */
       
   436   /*   If this macro is set (which is _not_ the default), the higher byte  */
       
   437   /*   of an error code gives the module in which the error has occurred,  */
       
   438   /*   while the lower byte is the real error code.                        */
       
   439   /*                                                                       */
       
   440   /*   Setting this macro makes sense for debugging purposes only, since   */
       
   441   /*   it would break source compatibility of certain programs that use    */
       
   442   /*   FreeType 2.                                                         */
       
   443   /*                                                                       */
       
   444   /*   More details can be found in the files ftmoderr.h and fterrors.h.   */
       
   445   /*                                                                       */
       
   446 #undef FT_CONFIG_OPTION_USE_MODULE_ERRORS
       
   447 
       
   448 
       
   449   /*************************************************************************/
       
   450   /*                                                                       */
       
   451   /* Position Independent Code                                             */
       
   452   /*                                                                       */
       
   453   /*   If this macro is set (which is _not_ the default), FreeType2 will   */
       
   454   /*   avoid creating constants that require address fixups.  Instead the  */
       
   455   /*   constants will be moved into a struct and additional intialization  */
       
   456   /*   code will be used.                                                  */
       
   457   /*                                                                       */
       
   458   /*   Setting this macro is needed for systems that prohibit address      */
       
   459   /*   fixups, such as BREW.                                               */
       
   460   /*                                                                       */
       
   461 /* #define FT_CONFIG_OPTION_PIC */
       
   462 
       
   463 
       
   464   /*************************************************************************/
       
   465   /*************************************************************************/
       
   466   /****                                                                 ****/
       
   467   /****        S F N T   D R I V E R    C O N F I G U R A T I O N       ****/
       
   468   /****                                                                 ****/
       
   469   /*************************************************************************/
       
   470   /*************************************************************************/
       
   471 
       
   472 
       
   473   /*************************************************************************/
       
   474   /*                                                                       */
       
   475   /* Define TT_CONFIG_OPTION_EMBEDDED_BITMAPS if you want to support       */
       
   476   /* embedded bitmaps in all formats using the SFNT module (namely         */
       
   477   /* TrueType & OpenType).                                                 */
       
   478   /*                                                                       */
       
   479 #define TT_CONFIG_OPTION_EMBEDDED_BITMAPS
       
   480 
       
   481 
       
   482   /*************************************************************************/
       
   483   /*                                                                       */
       
   484   /* Define TT_CONFIG_OPTION_POSTSCRIPT_NAMES if you want to be able to    */
       
   485   /* load and enumerate the glyph Postscript names in a TrueType or        */
       
   486   /* OpenType file.                                                        */
       
   487   /*                                                                       */
       
   488   /* Note that when you do not compile the `PSNames' module by undefining  */
       
   489   /* the above FT_CONFIG_OPTION_POSTSCRIPT_NAMES, the `sfnt' module will   */
       
   490   /* contain additional code used to read the PS Names table from a font.  */
       
   491   /*                                                                       */
       
   492   /* (By default, the module uses `PSNames' to extract glyph names.)       */
       
   493   /*                                                                       */
       
   494 #define TT_CONFIG_OPTION_POSTSCRIPT_NAMES
       
   495 
       
   496 
       
   497   /*************************************************************************/
       
   498   /*                                                                       */
       
   499   /* Define TT_CONFIG_OPTION_SFNT_NAMES if your applications need to       */
       
   500   /* access the internal name table in a SFNT-based format like TrueType   */
       
   501   /* or OpenType.  The name table contains various strings used to         */
       
   502   /* describe the font, like family name, copyright, version, etc.  It     */
       
   503   /* does not contain any glyph name though.                               */
       
   504   /*                                                                       */
       
   505   /* Accessing SFNT names is done through the functions declared in        */
       
   506   /* `freetype/ftsnames.h'.                                                */
       
   507   /*                                                                       */
       
   508 #define TT_CONFIG_OPTION_SFNT_NAMES
       
   509 
       
   510 
       
   511   /*************************************************************************/
       
   512   /*                                                                       */
       
   513   /* TrueType CMap support                                                 */
       
   514   /*                                                                       */
       
   515   /*   Here you can fine-tune which TrueType CMap table format shall be    */
       
   516   /*   supported.                                                          */
       
   517 #define TT_CONFIG_CMAP_FORMAT_0
       
   518 #define TT_CONFIG_CMAP_FORMAT_2
       
   519 #define TT_CONFIG_CMAP_FORMAT_4
       
   520 #define TT_CONFIG_CMAP_FORMAT_6
       
   521 #define TT_CONFIG_CMAP_FORMAT_8
       
   522 #define TT_CONFIG_CMAP_FORMAT_10
       
   523 #define TT_CONFIG_CMAP_FORMAT_12
       
   524 #define TT_CONFIG_CMAP_FORMAT_13
       
   525 #define TT_CONFIG_CMAP_FORMAT_14
       
   526 
       
   527 
       
   528   /*************************************************************************/
       
   529   /*************************************************************************/
       
   530   /****                                                                 ****/
       
   531   /****    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   ****/
       
   532   /****                                                                 ****/
       
   533   /*************************************************************************/
       
   534   /*************************************************************************/
       
   535 
       
   536   /*************************************************************************/
       
   537   /*                                                                       */
       
   538   /* Define TT_CONFIG_OPTION_BYTECODE_INTERPRETER if you want to compile   */
       
   539   /* a bytecode interpreter in the TrueType driver.                        */
       
   540   /*                                                                       */
       
   541   /* By undefining this, you will only compile the code necessary to load  */
       
   542   /* TrueType glyphs without hinting.                                      */
       
   543   /*                                                                       */
       
   544   /*   Do not #undef this macro here, since the build system might         */
       
   545   /*   define it for certain configurations only.                          */
       
   546   /*                                                                       */
       
   547 #define TT_CONFIG_OPTION_BYTECODE_INTERPRETER
       
   548 
       
   549 
       
   550   /*************************************************************************/
       
   551   /*                                                                       */
       
   552   /* If you define TT_CONFIG_OPTION_UNPATENTED_HINTING, a special version  */
       
   553   /* of the TrueType bytecode interpreter is used that doesn't implement   */
       
   554   /* any of the patented opcodes and algorithms.  The patents related to   */
       
   555   /* TrueType hinting have expired worldwide since May 2010; this option   */
       
   556   /* is now deprecated.                                                    */
       
   557   /*                                                                       */
       
   558   /* Note that the TT_CONFIG_OPTION_UNPATENTED_HINTING macro is *ignored*  */
       
   559   /* if you define TT_CONFIG_OPTION_BYTECODE_INTERPRETER; in other words,  */
       
   560   /* either define TT_CONFIG_OPTION_BYTECODE_INTERPRETER or                */
       
   561   /* TT_CONFIG_OPTION_UNPATENTED_HINTING but not both at the same time.    */
       
   562   /*                                                                       */
       
   563   /* This macro is only useful for a small number of font files (mostly    */
       
   564   /* for Asian scripts) that require bytecode interpretation to properly   */
       
   565   /* load glyphs.  For all other fonts, this produces unpleasant results,  */
       
   566   /* thus the unpatented interpreter is never used to load glyphs from     */
       
   567   /* TrueType fonts unless one of the following two options is used.       */
       
   568   /*                                                                       */
       
   569   /*   - The unpatented interpreter is explicitly activated by the user    */
       
   570   /*     through the FT_PARAM_TAG_UNPATENTED_HINTING parameter tag         */
       
   571   /*     when opening the FT_Face.                                         */
       
   572   /*                                                                       */
       
   573   /*   - FreeType detects that the FT_Face corresponds to one of the       */
       
   574   /*     `trick' fonts (e.g., `Mingliu') it knows about.  The font engine  */
       
   575   /*     contains a hard-coded list of font names and other matching       */
       
   576   /*     parameters (see function `tt_face_init' in file                   */
       
   577   /*     `src/truetype/ttobjs.c').                                         */
       
   578   /*                                                                       */
       
   579   /* Here a sample code snippet for using FT_PARAM_TAG_UNPATENTED_HINTING. */
       
   580   /*                                                                       */
       
   581   /*   {                                                                   */
       
   582   /*     FT_Parameter  parameter;                                          */
       
   583   /*     FT_Open_Args  open_args;                                          */
       
   584   /*                                                                       */
       
   585   /*                                                                       */
       
   586   /*     parameter.tag = FT_PARAM_TAG_UNPATENTED_HINTING;                  */
       
   587   /*                                                                       */
       
   588   /*     open_args.flags      = FT_OPEN_PATHNAME | FT_OPEN_PARAMS;         */
       
   589   /*     open_args.pathname   = my_font_pathname;                          */
       
   590   /*     open_args.num_params = 1;                                         */
       
   591   /*     open_args.params     = &parameter;                                */
       
   592   /*                                                                       */
       
   593   /*     error = FT_Open_Face( library, &open_args, index, &face );        */
       
   594   /*     ...                                                               */
       
   595   /*   }                                                                   */
       
   596   /*                                                                       */
       
   597 /* #define TT_CONFIG_OPTION_UNPATENTED_HINTING */
       
   598 
       
   599 
       
   600   /*************************************************************************/
       
   601   /*                                                                       */
       
   602   /* Define TT_CONFIG_OPTION_INTERPRETER_SWITCH to compile the TrueType    */
       
   603   /* bytecode interpreter with a huge switch statement, rather than a call */
       
   604   /* table.  This results in smaller and faster code for a number of       */
       
   605   /* architectures.                                                        */
       
   606   /*                                                                       */
       
   607   /* Note however that on some compiler/processor combinations, undefining */
       
   608   /* this macro will generate faster, though larger, code.                 */
       
   609   /*                                                                       */
       
   610 #define TT_CONFIG_OPTION_INTERPRETER_SWITCH
       
   611 
       
   612 
       
   613   /*************************************************************************/
       
   614   /*                                                                       */
       
   615   /* Define TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED to compile the        */
       
   616   /* TrueType glyph loader to use Apple's definition of how to handle      */
       
   617   /* component offsets in composite glyphs.                                */
       
   618   /*                                                                       */
       
   619   /* Apple and MS disagree on the default behavior of component offsets    */
       
   620   /* in composites.  Apple says that they should be scaled by the scaling  */
       
   621   /* factors in the transformation matrix (roughly, it's more complex)     */
       
   622   /* while MS says they should not.  OpenType defines two bits in the      */
       
   623   /* composite flags array which can be used to disambiguate, but old      */
       
   624   /* fonts will not have them.                                             */
       
   625   /*                                                                       */
       
   626   /*   http://partners.adobe.com/asn/developer/opentype/glyf.html          */
       
   627   /*   http://fonts.apple.com/TTRefMan/RM06/Chap6glyf.html                 */
       
   628   /*                                                                       */
       
   629 #undef TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED
       
   630 
       
   631 
       
   632   /*************************************************************************/
       
   633   /*                                                                       */
       
   634   /* Define TT_CONFIG_OPTION_GX_VAR_SUPPORT if you want to include         */
       
   635   /* support for Apple's distortable font technology (fvar, gvar, cvar,    */
       
   636   /* and avar tables).  This has many similarities to Type 1 Multiple      */
       
   637   /* Masters support.                                                      */
       
   638   /*                                                                       */
       
   639 #define TT_CONFIG_OPTION_GX_VAR_SUPPORT
       
   640 
       
   641 
       
   642   /*************************************************************************/
       
   643   /*                                                                       */
       
   644   /* Define TT_CONFIG_OPTION_BDF if you want to include support for        */
       
   645   /* an embedded `BDF ' table within SFNT-based bitmap formats.            */
       
   646   /*                                                                       */
       
   647 #define TT_CONFIG_OPTION_BDF
       
   648 
       
   649 
       
   650   /*************************************************************************/
       
   651   /*************************************************************************/
       
   652   /****                                                                 ****/
       
   653   /****      T Y P E 1   D R I V E R    C O N F I G U R A T I O N       ****/
       
   654   /****                                                                 ****/
       
   655   /*************************************************************************/
       
   656   /*************************************************************************/
       
   657 
       
   658 
       
   659   /*************************************************************************/
       
   660   /*                                                                       */
       
   661   /* T1_MAX_DICT_DEPTH is the maximal depth of nest dictionaries and       */
       
   662   /* arrays in the Type 1 stream (see t1load.c).  A minimum of 4 is        */
       
   663   /* required.                                                             */
       
   664   /*                                                                       */
       
   665 #define T1_MAX_DICT_DEPTH  5
       
   666 
       
   667 
       
   668   /*************************************************************************/
       
   669   /*                                                                       */
       
   670   /* T1_MAX_SUBRS_CALLS details the maximum number of nested sub-routine   */
       
   671   /* calls during glyph loading.                                           */
       
   672   /*                                                                       */
       
   673 #define T1_MAX_SUBRS_CALLS  16
       
   674 
       
   675 
       
   676   /*************************************************************************/
       
   677   /*                                                                       */
       
   678   /* T1_MAX_CHARSTRING_OPERANDS is the charstring stack's capacity.  A     */
       
   679   /* minimum of 16 is required.                                            */
       
   680   /*                                                                       */
       
   681   /* The Chinese font MingTiEG-Medium (CNS 11643 character set) needs 256. */
       
   682   /*                                                                       */
       
   683 #define T1_MAX_CHARSTRINGS_OPERANDS  256
       
   684 
       
   685 
       
   686   /*************************************************************************/
       
   687   /*                                                                       */
       
   688   /* Define this configuration macro if you want to prevent the            */
       
   689   /* compilation of `t1afm', which is in charge of reading Type 1 AFM      */
       
   690   /* files into an existing face.  Note that if set, the T1 driver will be */
       
   691   /* unable to produce kerning distances.                                  */
       
   692   /*                                                                       */
       
   693 #undef T1_CONFIG_OPTION_NO_AFM
       
   694 
       
   695 
       
   696   /*************************************************************************/
       
   697   /*                                                                       */
       
   698   /* Define this configuration macro if you want to prevent the            */
       
   699   /* compilation of the Multiple Masters font support in the Type 1        */
       
   700   /* driver.                                                               */
       
   701   /*                                                                       */
       
   702 #undef T1_CONFIG_OPTION_NO_MM_SUPPORT
       
   703 
       
   704 
       
   705   /*************************************************************************/
       
   706   /*************************************************************************/
       
   707   /****                                                                 ****/
       
   708   /****    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     ****/
       
   709   /****                                                                 ****/
       
   710   /*************************************************************************/
       
   711   /*************************************************************************/
       
   712 
       
   713 
       
   714   /*************************************************************************/
       
   715   /*                                                                       */
       
   716   /* Compile autofit module with CJK (Chinese, Japanese, Korean) script    */
       
   717   /* support.                                                              */
       
   718   /*                                                                       */
       
   719 #define AF_CONFIG_OPTION_CJK
       
   720 
       
   721   /*************************************************************************/
       
   722   /*                                                                       */
       
   723   /* Compile autofit module with Indic script support.                     */
       
   724   /*                                                                       */
       
   725 #define AF_CONFIG_OPTION_INDIC
       
   726 
       
   727   /*************************************************************************/
       
   728   /*                                                                       */
       
   729   /* Compile autofit module with warp hinting.  The idea of the warping    */
       
   730   /* code is to slightly scale and shift a glyph within a single dimension */
       
   731   /* so that as much of its segments are aligned (more or less) on the     */
       
   732   /* grid.  To find out the optimal scaling and shifting value, various    */
       
   733   /* parameter combinations are tried and scored.                          */
       
   734   /*                                                                       */
       
   735   /* This experimental option is only active if the render mode is         */
       
   736   /* FT_RENDER_MODE_LIGHT.                                                 */
       
   737   /*                                                                       */
       
   738 #define AF_CONFIG_OPTION_USE_WARPER
       
   739 
       
   740   /* */
       
   741 
       
   742 
       
   743   /*
       
   744    * Define this variable if you want to keep the layout of internal
       
   745    * structures that was used prior to FreeType 2.2.  This also compiles in
       
   746    * a few obsolete functions to avoid linking problems on typical Unix
       
   747    * distributions.
       
   748    *
       
   749    * For embedded systems or building a new distribution from scratch, it
       
   750    * is recommended to disable the macro since it reduces the library's code
       
   751    * size and activates a few memory-saving optimizations as well.
       
   752    */
       
   753 #define FT_CONFIG_OPTION_OLD_INTERNALS
       
   754 
       
   755 
       
   756   /*
       
   757    *  To detect legacy cache-lookup call from a rogue client (<= 2.1.7),
       
   758    *  we restrict the number of charmaps in a font.  The current API of
       
   759    *  FTC_CMapCache_Lookup() takes cmap_index & charcode, but old API
       
   760    *  takes charcode only.  To determine the passed value is for cmap_index
       
   761    *  or charcode, the possible cmap_index is restricted not to exceed
       
   762    *  the minimum possible charcode by a rogue client.  It is also very
       
   763    *  unlikely that a rogue client is interested in Unicode values 0 to 15.
       
   764    *
       
   765    *  NOTE: The original threshold was 4 deduced from popular number of
       
   766    *        cmap subtables in UCS-4 TrueType fonts, but now it is not
       
   767    *        irregular for OpenType fonts to have more than 4 subtables,
       
   768    *        because variation selector subtables are available for Apple
       
   769    *        and Microsoft platforms.
       
   770    */
       
   771 
       
   772 #ifdef FT_CONFIG_OPTION_OLD_INTERNALS
       
   773 #define FT_MAX_CHARMAP_CACHEABLE 15
       
   774 #endif
       
   775 
       
   776 
       
   777   /*
       
   778    * This macro is defined if either unpatented or native TrueType
       
   779    * hinting is requested by the definitions above.
       
   780    */
       
   781 #ifdef TT_CONFIG_OPTION_BYTECODE_INTERPRETER
       
   782 #define  TT_USE_BYTECODE_INTERPRETER
       
   783 #undef   TT_CONFIG_OPTION_UNPATENTED_HINTING
       
   784 #elif defined TT_CONFIG_OPTION_UNPATENTED_HINTING
       
   785 #define  TT_USE_BYTECODE_INTERPRETER
       
   786 #endif
       
   787 
       
   788 FT_END_HEADER
       
   789 
       
   790 
       
   791 #endif /* __FTOPTION_H__ */
       
   792 
       
   793 
       
   794 /* END */