/****************************************************************************

 *

 * ftoption.h

 *

 *   User-selectable configuration macros (specification only).

 *

 * Copyright (C) 1996-2019 by

 * David Turner, Robert Wilhelm, and Werner Lemberg.

 *

 * This file is part of the FreeType project, and may only be used,

 * modified, and distributed under the terms of the FreeType project

 * license, LICENSE.TXT.  By continuing to use, modify, or distribute

 * this file you indicate that you have read the license and

 * understand and accept it fully.

 *

 */

  /**************************************************************************

   *

   *                USER-SELECTABLE CONFIGURATION MACROS

   *

   * This file contains the default configuration macro definitions for a

   * standard build of the FreeType library.  There are three ways to use

   * this file to build project-specific versions of the library:

   *

   * - You can modify this file by hand, but this is not recommended in

   *   cases where you would like to build several versions of the library

   *   from a single source directory.

   *

   * - You can put a copy of this file in your build directory, more

   *   precisely in `$BUILD/freetype/config/ftoption.h`, where `$BUILD` is

   *   the name of a directory that is included _before_ the FreeType include

   *   path during compilation.

   *

   *   The default FreeType Makefiles and Jamfiles use the build directory

   *   `builds/<system>` by default, but you can easily change that for your

   *   own projects.

   *

   * - Copy the file <ft2build.h> to `$BUILD/ft2build.h` and modify it

   *   slightly to pre-define the macro `FT_CONFIG_OPTIONS_H` used to locate

   *   this file during the build.  For example,

   *

   *   ```

   *     #define FT_CONFIG_OPTIONS_H  <myftoptions.h>

   *     #include <freetype/config/ftheader.h>

   *   ```

   *

   *   will use `$BUILD/myftoptions.h` instead of this file for macro

   *   definitions.

   *

   *   Note also that you can similarly pre-define the macro

   *   `FT_CONFIG_MODULES_H` used to locate the file listing of the modules

   *   that are statically linked to the library at compile time.  By

   *   default, this file is `<freetype/config/ftmodule.h>`.

   *

   * We highly recommend using the third method whenever possible.

   *

   */

  /*#************************************************************************

   *

   * If you enable this configuration option, FreeType recognizes an

   * environment variable called `FREETYPE_PROPERTIES`, which can be used to

   * control the various font drivers and modules.  The controllable

   * properties are listed in the section @properties.

   *

   * You have to undefine this configuration option on platforms that lack

   * the concept of environment variables (and thus don't have the `getenv`

   * function), for example Windows CE.

   *

   * `FREETYPE_PROPERTIES` has the following syntax form (broken here into

   * multiple lines for better readability).

   *

   * ```

   *   <optional whitespace>

   *   <module-name1> ':'

   *   <property-name1> '=' <property-value1>

   *   <whitespace>

   *   <module-name2> ':'

   *   <property-name2> '=' <property-value2>

   *   ...

   * ```

   *

   * Example:

   *

   * ```

   *   FREETYPE_PROPERTIES=truetype:interpreter-version=35 \

   *                       cff:no-stem-darkening=1 \

   *                       autofitter:warping=1

   * ```

   *

   */

  /**************************************************************************

   *

   * Uncomment the line below if you want to activate LCD rendering

   * technology similar to ClearType in this build of the library.  This

   * technology triples the resolution in the direction color subpixels.  To

   * mitigate color fringes inherent to this technology, you also need to

   * explicitly set up LCD filtering.

   *

   * Note that this feature is covered by several Microsoft patents and

   * should not be activated in any default build of the library.  When this

   * macro is not defined, FreeType offers alternative LCD rendering

   * technology that produces excellent output without LCD filtering.

   */

  /**************************************************************************

   *

   * Many compilers provide a non-ANSI 64-bit data type that can be used by

   * FreeType to speed up some computations.  However, this will create some

   * problems when compiling the library in strict ANSI mode.

   *

   * For this reason, the use of 64-bit integers is normally disabled when

   * the `__STDC__` macro is defined.  You can however disable this by

   * defining the macro `FT_CONFIG_OPTION_FORCE_INT64` here.

   *

   * For most compilers, this will only create compilation warnings when

   * building the library.

   *

   * ObNote: The compiler-specific 64-bit integers are detected in the

   *         file `ftconfig.h` either statically or through the `configure`

   *         script on supported platforms.

   */

  /**************************************************************************

   *

   * If this macro is defined, do not try to use an assembler version of

   * performance-critical functions (e.g., @FT_MulFix).  You should only do

   * that to verify that the assembler function works properly, or to execute

   * benchmark tests of the various implementations.

   */

  /**************************************************************************

   *

   * If this macro is defined, try to use an inlined assembler version of the

   * @FT_MulFix function, which is a 'hotspot' when loading and hinting

   * glyphs, and which should be executed as fast as possible.

   *

   * Note that if your compiler or CPU is not supported, this will default to

   * the standard and portable implementation found in `ftcalc.c`.

   */

  /**************************************************************************

   *

   * LZW-compressed file support.

   *

   *   FreeType now handles font files that have been compressed with the

   *   `compress` program.  This is mostly used to parse many of the PCF

   *   files that come with various X11 distributions.  The implementation

   *   uses NetBSD's `zopen` to partially uncompress the file on the fly (see

   *   `src/lzw/ftgzip.c`).

   *

   *   Define this macro if you want to enable this 'feature'.

   */

  /**************************************************************************

   *

   * Gzip-compressed file support.

   *

   *   FreeType now handles font files that have been compressed with the

   *   `gzip` program.  This is mostly used to parse many of the PCF files

   *   that come with XFree86.  The implementation uses 'zlib' to partially

   *   uncompress the file on the fly (see `src/gzip/ftgzip.c`).

   *

   *   Define this macro if you want to enable this 'feature'.  See also the

   *   macro `FT_CONFIG_OPTION_SYSTEM_ZLIB` below.

   */

  /**************************************************************************

   *

   * ZLib library selection

   *

   *   This macro is only used when `FT_CONFIG_OPTION_USE_ZLIB` is defined.

   *   It allows FreeType's 'ftgzip' component to link to the system's

   *   installation of the ZLib library.  This is useful on systems like

   *   Unix or VMS where it generally is already available.

   *

   *   If you let it undefined, the component will use its own copy of the

   *   zlib sources instead.  These have been modified to be included

   *   directly within the component and **not** export external function

   *   names.  This allows you to link any program with FreeType _and_ ZLib

   *   without linking conflicts.

   *

   *   Do not `#undef` this macro here since the build system might define

   *   it for certain configurations only.

   *

   *   If you use a build system like cmake or the `configure` script,

   *   options set by those programs have precedence, overwriting the value

   *   here with the configured one.

   */

  /**************************************************************************

   *

   * Bzip2-compressed file support.

   *

   *   FreeType now handles font files that have been compressed with the

   *   `bzip2` program.  This is mostly used to parse many of the PCF files

   *   that come with XFree86.  The implementation uses `libbz2` to partially

   *   uncompress the file on the fly (see `src/bzip2/ftbzip2.c`).  Contrary

   *   to gzip, bzip2 currently is not included and need to use the system

   *   available bzip2 implementation.

   *

   *   Define this macro if you want to enable this 'feature'.

   *

   *   If you use a build system like cmake or the `configure` script,

   *   options set by those programs have precedence, overwriting the value

   *   here with the configured one.

   */

  /**************************************************************************

   *

   * Define to disable the use of file stream functions and types, `FILE`,

   * `fopen`, etc.  Enables the use of smaller system libraries on embedded

   * systems that have multiple system libraries, some with or without file

   * stream support, in the cases where file stream support is not necessary

   * such as memory loading of font files.

   */

  /**************************************************************************

   *

   * PNG bitmap support.

   *

   *   FreeType now handles loading color bitmap glyphs in the PNG format.

   *   This requires help from the external libpng library.  Uncompressed

   *   color bitmaps do not need any external libraries and will be supported

   *   regardless of this configuration.

   *

   *   Define this macro if you want to enable this 'feature'.

   *

   *   If you use a build system like cmake or the `configure` script,

   *   options set by those programs have precedence, overwriting the value

   *   here with the configured one.

   */

  /**************************************************************************

   *

   * HarfBuzz support.

   *

   *   FreeType uses the HarfBuzz library to improve auto-hinting of OpenType

   *   fonts.  If available, many glyphs not directly addressable by a font's

   *   character map will be hinted also.

   *

   *   Define this macro if you want to enable this 'feature'.

   *

   *   If you use a build system like cmake or the `configure` script,

   *   options set by those programs have precedence, overwriting the value

   *   here with the configured one.

   */

  /**************************************************************************

   *

   * Glyph Postscript Names handling

   *

   *   By default, FreeType 2 is compiled with the 'psnames' module.  This

   *   module is in charge of converting a glyph name string into a Unicode

   *   value, or return a Macintosh standard glyph name for the use with the

   *   TrueType 'post' table.

   *

   *   Undefine this macro if you do not want 'psnames' compiled in your

   *   build of FreeType.  This has the following effects:

   *

   *   - The TrueType driver will provide its own set of glyph names, if you

   *     build it to support postscript names in the TrueType 'post' table,

   *     but will not synthesize a missing Unicode charmap.

   *

   *   - The Type~1 driver will not be able to synthesize a Unicode charmap

   *     out of the glyphs found in the fonts.

   *

   *   You would normally undefine this configuration macro when building a

   *   version of FreeType that doesn't contain a Type~1 or CFF driver.

   */

  /**************************************************************************

   *

   * Postscript Names to Unicode Values support

   *

   *   By default, FreeType~2 is built with the 'psnames' module compiled in.

   *   Among other things, the module is used to convert a glyph name into a

   *   Unicode value.  This is especially useful in order to synthesize on

   *   the fly a Unicode charmap from the CFF/Type~1 driver through a big

   *   table named the 'Adobe Glyph List' (AGL).

   *

   *   Undefine this macro if you do not want the Adobe Glyph List compiled

   *   in your 'psnames' module.  The Type~1 driver will not be able to

   *   synthesize a Unicode charmap out of the glyphs found in the fonts.

   */

  /**************************************************************************

   *

   * Support for Mac fonts

   *

   *   Define this macro if you want support for outline fonts in Mac format

   *   (mac dfont, mac resource, macbinary containing a mac resource) on

   *   non-Mac platforms.

   *

   *   Note that the 'FOND' resource isn't checked.

   */

  /**************************************************************************

   *

   * Guessing methods to access embedded resource forks

   *

   *   Enable extra Mac fonts support on non-Mac platforms (e.g., GNU/Linux).

   *

   *   Resource forks which include fonts data are stored sometimes in

   *   locations which users or developers don't expected.  In some cases,

   *   resource forks start with some offset from the head of a file.  In

   *   other cases, the actual resource fork is stored in file different from

   *   what the user specifies.  If this option is activated, FreeType tries

   *   to guess whether such offsets or different file names must be used.

   *

   *   Note that normal, direct access of resource forks is controlled via

   *   the `FT_CONFIG_OPTION_MAC_FONTS` option.

   */

  /**************************************************************************

   *

   * Allow the use of `FT_Incremental_Interface` to load typefaces that

   * contain no glyph data, but supply it via a callback function.  This is

   * required by clients supporting document formats which supply font data

   * incrementally as the document is parsed, such as the Ghostscript

   * interpreter for the PostScript language.

   */

  /**************************************************************************

   *

   * The size in bytes of the render pool used by the scan-line converter to

   * do all of its work.

   */

  /**************************************************************************

   *

   * FT_MAX_MODULES

   *

   *   The maximum number of modules that can be registered in a single

   *   FreeType library object.  32~is the default.

   */

  /**************************************************************************

   *

   * Debug level

   *

   *   FreeType can be compiled in debug or trace mode.  In debug mode,

   *   errors are reported through the 'ftdebug' component.  In trace mode,

   *   additional messages are sent to the standard output during execution.

   *

   *   Define `FT_DEBUG_LEVEL_ERROR` to build the library in debug mode.

   *   Define `FT_DEBUG_LEVEL_TRACE` to build it in trace mode.

   *

   *   Don't define any of these macros to compile in 'release' mode!

   *

   *   Do not `#undef` these macros here since the build system might define

   *   them for certain configurations only.

   */

  /**************************************************************************

   *

   * Autofitter debugging

   *

   *   If `FT_DEBUG_AUTOFIT` is defined, FreeType provides some means to

   *   control the autofitter behaviour for debugging purposes with global

   *   boolean variables (consequently, you should **never** enable this

   *   while compiling in 'release' mode):

   *

   *   ```

   *     _af_debug_disable_horz_hints

   *     _af_debug_disable_vert_hints

   *     _af_debug_disable_blue_hints

   *   ```

   *

   *   Additionally, the following functions provide dumps of various

   *   internal autofit structures to stdout (using `printf`):

   *

   *   ```

   *     af_glyph_hints_dump_points

   *     af_glyph_hints_dump_segments

   *     af_glyph_hints_dump_edges

   *     af_glyph_hints_get_num_segments

   *     af_glyph_hints_get_segment_offset

   *   ```

   *

   *   As an argument, they use another global variable:

   *

   *   ```

   *     _af_debug_hints

   *   ```

   *

   *   Please have a look at the `ftgrid` demo program to see how those

   *   variables and macros should be used.

   *

   *   Do not `#undef` these macros here since the build system might define

   *   them for certain configurations only.

   */

  /**************************************************************************

   *

   * Memory Debugging

   *

   *   FreeType now comes with an integrated memory debugger that is capable

   *   of detecting simple errors like memory leaks or double deletes.  To

   *   compile it within your build of the library, you should define

   *   `FT_DEBUG_MEMORY` here.

   *

   *   Note that the memory debugger is only activated at runtime when when

   *   the _environment_ variable `FT2_DEBUG_MEMORY` is defined also!

   *

   *   Do not `#undef` this macro here since the build system might define it

   *   for certain configurations only.

   */

  /**************************************************************************

   *

   * Module errors

   *

   *   If this macro is set (which is _not_ the default), the higher byte of

   *   an error code gives the module in which the error has occurred, while

   *   the lower byte is the real error code.

   *

   *   Setting this macro makes sense for debugging purposes only, since it

   *   would break source compatibility of certain programs that use

   *   FreeType~2.

   *

   *   More details can be found in the files `ftmoderr.h` and `fterrors.h`.

   */

  /**************************************************************************

   *

   * Error Strings