From 48f93e648ede94232645aadc9274572e86639cd5 Mon Sep 17 00:00:00 2001 From: Werner Lemberg Date: Tue, 4 Sep 2018 21:19:26 +0200 Subject: [PATCH] * devel/ftoption.h: Synchronize with master `ftoption.h'. --- ChangeLog | 4 + devel/ftoption.h | 606 +++++++++++++++++++++++------------------------ 2 files changed, 306 insertions(+), 304 deletions(-) diff --git a/ChangeLog b/ChangeLog index df89cdbbf..a2833aeac 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2018-09-04 Werner Lemberg + + * devel/ftoption.h: Synchronize with master `ftoption.h'. + 2018-09-03 Nikhil Ramakrishnan [docwriter] Don't break code snippets accross lines. diff --git a/devel/ftoption.h b/devel/ftoption.h index ab7968d32..99c1edb3f 100644 --- a/devel/ftoption.h +++ b/devel/ftoption.h @@ -29,39 +29,39 @@ FT_BEGIN_HEADER * * 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: + * 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. + * 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. + * 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/' by default, but you can easily change - * that for your own projects. + * The default FreeType Makefiles and Jamfiles use the build directory + * `builds/` by default, but you can easily change that for your + * own projects. * - * - Copy the file 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, + * - Copy the file 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 * #include - * } + * ``` * - * will use `$BUILD/myftoptions.h' instead of this file for macro + * 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 + * `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 . + * default, this file is ``. * * We highly recommend using the third method whenever possible. * @@ -80,18 +80,18 @@ FT_BEGIN_HEADER /*#************************************************************************ * * If you enable this configuration option, FreeType recognizes an - * environment variable called `FREETYPE_PROPERTIES', which can be used to + * 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' + * 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 + * `FREETYPE_PROPERTIES` has the following syntax form (broken here into * multiple lines for better readability). * - * { + * ``` * * ':' * '=' @@ -99,15 +99,15 @@ FT_BEGIN_HEADER * ':' * '=' * ... - * } + * ``` * * Example: * - * { + * ``` * FREETYPE_PROPERTIES=truetype:interpreter-version=35 \ * cff:no-stem-darkening=1 \ * autofitter:warping=1 - * } + * ``` * */ #define FT_CONFIG_OPTION_ENVIRONMENT_PROPERTIES @@ -117,35 +117,34 @@ FT_BEGIN_HEADER * * 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. + * 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. + * 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. */ /* #define FT_CONFIG_OPTION_SUBPIXEL_RENDERING */ /************************************************************************** * - * 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. + * 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. + * 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. + * file `ftconfig.h` either statically or through the `configure` + * script on supported platforms. */ #undef FT_CONFIG_OPTION_FORCE_INT64 @@ -153,21 +152,21 @@ FT_BEGIN_HEADER /************************************************************************** * * 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. + * 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. */ /* #define FT_CONFIG_OPTION_NO_ASSEMBLER */ /************************************************************************** * - * 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. + * 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'. + * Note that if your compiler or CPU is not supported, this will default to + * the standard and portable implementation found in `ftcalc.c`. */ #define FT_CONFIG_OPTION_INLINE_MULFIX @@ -177,12 +176,12 @@ FT_BEGIN_HEADER * 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 + * `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). + * 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'. + * Define this macro if you want to enable this 'feature'. */ #define FT_CONFIG_OPTION_USE_LZW @@ -192,12 +191,12 @@ FT_BEGIN_HEADER * 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). + * `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. + * Define this macro if you want to enable this 'feature'. See also the + * macro `FT_CONFIG_OPTION_SYSTEM_ZLIB` below. */ #define FT_CONFIG_OPTION_USE_ZLIB @@ -206,23 +205,23 @@ FT_BEGIN_HEADER * * 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 + * 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. + * 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 + * 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. + * 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 FT_CONFIG_OPTION_SYSTEM_ZLIB */ @@ -232,28 +231,28 @@ FT_BEGIN_HEADER * 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. + * `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'. + * 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. + * 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 FT_CONFIG_OPTION_USE_BZIP2 /************************************************************************** * - * 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. + * 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. */ /* #define FT_CONFIG_OPTION_DISABLE_STREAM_SUPPORT */ @@ -264,14 +263,14 @@ FT_BEGIN_HEADER * * 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. + * 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'. + * 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. + * 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 FT_CONFIG_OPTION_USE_PNG @@ -280,15 +279,15 @@ FT_BEGIN_HEADER * * 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. + * 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'. + * 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. + * 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 FT_CONFIG_OPTION_USE_HARFBUZZ @@ -297,23 +296,23 @@ FT_BEGIN_HEADER * * 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. + * 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 + * 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 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. + * - 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. + * You would normally undefine this configuration macro when building a + * version of FreeType that doesn't contain a Type~1 or CFF driver. */ #define FT_CONFIG_OPTION_POSTSCRIPT_NAMES @@ -322,16 +321,15 @@ FT_BEGIN_HEADER * * 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). + * 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. + * 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. */ #define FT_CONFIG_OPTION_ADOBE_GLYPH_LIST @@ -340,11 +338,11 @@ FT_BEGIN_HEADER * * 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. + * 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. + * Note that the `FOND` resource isn't checked. */ #define FT_CONFIG_OPTION_MAC_FONTS @@ -358,13 +356,12 @@ FT_BEGIN_HEADER * 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. + * 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. + * the `FT_CONFIG_OPTION_MAC_FONTS` option. */ #ifdef FT_CONFIG_OPTION_MAC_FONTS #define FT_CONFIG_OPTION_GUESSING_EMBEDDED_RFORK @@ -373,19 +370,19 @@ FT_BEGIN_HEADER /************************************************************************** * - * 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. + * 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. */ #define FT_CONFIG_OPTION_INCREMENTAL /************************************************************************** * - * The size in bytes of the render pool used by the scan-line converter - * to do all of its work. + * The size in bytes of the render pool used by the scan-line converter to + * do all of its work. */ #define FT_RENDER_POOL_SIZE 16384L @@ -395,7 +392,7 @@ FT_BEGIN_HEADER * FT_MAX_MODULES * * The maximum number of modules that can be registered in a single - * FreeType library object. 32 is the default. + * FreeType library object. 32~is the default. */ #define FT_MAX_MODULES 32 @@ -405,16 +402,15 @@ FT_BEGIN_HEADER * 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. + * 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. + * 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! + * Don't define any of these macros to compile in 'release' mode! * - * Do not #undef these macros here since the build system might define + * Do not `#undef` these macros here since the build system might define * them for certain configurations only. */ #define FT_DEBUG_LEVEL_ERROR @@ -425,38 +421,38 @@ FT_BEGIN_HEADER * * Autofitter debugging * - * If FT_DEBUG_AUTOFIT is defined, FreeType provides some means to + * 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): + * 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'): + * 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 + * 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 + * Do not `#undef` these macros here since the build system might define * them for certain configurations only. */ #define FT_DEBUG_AUTOFIT @@ -466,16 +462,16 @@ FT_BEGIN_HEADER * * 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. + * 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! + * 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. + * Do not `#undef` this macro here since the build system might define it + * for certain configurations only. */ #define FT_DEBUG_MEMORY @@ -484,15 +480,15 @@ FT_BEGIN_HEADER * * 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. + * 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. + * 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. + * More details can be found in the files `ftmoderr.h` and `fterrors.h`. */ #undef FT_CONFIG_OPTION_USE_MODULE_ERRORS @@ -501,11 +497,11 @@ FT_BEGIN_HEADER * * Error Strings * - * If this macro is set, `FT_Error_String' will return meaningful + * If this macro is set, `FT_Error_String` will return meaningful * descriptions. This is not enabled by default to reduce the overall * size of FreeType. * - * More details can be found in the file fterrors.h. + * More details can be found in the file `fterrors.h`. */ /* #define FT_CONFIG_OPTION_ERROR_STRINGS */ @@ -521,47 +517,47 @@ FT_BEGIN_HEADER /************************************************************************** * - * Define TT_CONFIG_OPTION_EMBEDDED_BITMAPS if you want to support - * embedded bitmaps in all formats using the SFNT module (namely - * TrueType & OpenType). + * Define `TT_CONFIG_OPTION_EMBEDDED_BITMAPS` if you want to support + * embedded bitmaps in all formats using the 'sfnt' module (namely + * TrueType~& OpenType). */ #define TT_CONFIG_OPTION_EMBEDDED_BITMAPS /************************************************************************** * - * Define TT_CONFIG_OPTION_COLOR_LAYERS if you want to support coloured - * outlines (from the COLR/CPAL tables) in all formats using the SFNT - * module (namely TrueType & OpenType). + * Define `TT_CONFIG_OPTION_COLOR_LAYERS` if you want to support coloured + * outlines (from the `COLR`/`CPAL` tables) in all formats using the 'sfnt' + * module (namely TrueType~& OpenType). */ #define TT_CONFIG_OPTION_COLOR_LAYERS /************************************************************************** * - * Define TT_CONFIG_OPTION_POSTSCRIPT_NAMES if you want to be able to - * load and enumerate the glyph Postscript names in a TrueType or - * OpenType file. + * Define `TT_CONFIG_OPTION_POSTSCRIPT_NAMES` if you want to be able to + * load and enumerate the glyph Postscript names in a TrueType or OpenType + * file. * - * Note that when you do not compile the `PSNames' module by undefining - * the above FT_CONFIG_OPTION_POSTSCRIPT_NAMES, the `sfnt' module will + * Note that when you do not compile the 'psnames' module by undefining the + * above `FT_CONFIG_OPTION_POSTSCRIPT_NAMES`, the 'sfnt' module will * contain additional code used to read the PS Names table from a font. * - * (By default, the module uses `PSNames' to extract glyph names.) + * (By default, the module uses 'psnames' to extract glyph names.) */ #define TT_CONFIG_OPTION_POSTSCRIPT_NAMES /************************************************************************** * - * Define TT_CONFIG_OPTION_SFNT_NAMES if your applications need to - * access the internal name table in a SFNT-based format like TrueType - * or OpenType. The name table contains various strings used to - * describe the font, like family name, copyright, version, etc. It - * does not contain any glyph name though. + * Define `TT_CONFIG_OPTION_SFNT_NAMES` if your applications need to access + * the internal name table in a SFNT-based format like TrueType or + * OpenType. The name table contains various strings used to describe the + * font, like family name, copyright, version, etc. It does not contain + * any glyph name though. * * Accessing SFNT names is done through the functions declared in - * `ftsnames.h'. + * `ftsnames.h`. */ #define TT_CONFIG_OPTION_SFNT_NAMES @@ -594,54 +590,53 @@ FT_BEGIN_HEADER /************************************************************************** * - * Define TT_CONFIG_OPTION_BYTECODE_INTERPRETER if you want to compile - * a bytecode interpreter in the TrueType driver. + * Define `TT_CONFIG_OPTION_BYTECODE_INTERPRETER` if you want to compile a + * bytecode interpreter in the TrueType driver. * * By undefining this, you will only compile the code necessary to load * TrueType glyphs without hinting. * - * Do not #undef this macro here, since the build system might - * define it for certain configurations only. + * Do not `#undef` this macro here, since the build system might define it + * for certain configurations only. */ #define TT_CONFIG_OPTION_BYTECODE_INTERPRETER /************************************************************************** * - * Define TT_CONFIG_OPTION_SUBPIXEL_HINTING if you want to compile + * Define `TT_CONFIG_OPTION_SUBPIXEL_HINTING` if you want to compile * subpixel hinting support into the TrueType driver. This modifies the - * TrueType hinting mechanism when anything but FT_RENDER_MODE_MONO is + * TrueType hinting mechanism when anything but `FT_RENDER_MODE_MONO` is * requested. * * In particular, it modifies the bytecode interpreter to interpret (or - * not) instructions in a certain way so that all TrueType fonts look - * like they do in a Windows ClearType (DirectWrite) environment. See - * [1] for a technical overview on what this means. See `ttinterp.h' - * for more details on the LEAN option. + * not) instructions in a certain way so that all TrueType fonts look like + * they do in a Windows ClearType (DirectWrite) environment. See [1] for a + * technical overview on what this means. See `ttinterp.h` for more + * details on the LEAN option. * * There are three possible values. * * Value 1: - * This value is associated with the `Infinality' moniker, - * contributed by an individual nicknamed Infinality with the goal of - * making TrueType fonts render better than on Windows. A high - * amount of configurability and flexibility, down to rules for - * single glyphs in fonts, but also very slow. Its experimental and - * slow nature and the original developer losing interest meant that - * this option was never enabled in default builds. + * This value is associated with the 'Infinality' moniker, contributed by + * an individual nicknamed Infinality with the goal of making TrueType + * fonts render better than on Windows. A high amount of configurability + * and flexibility, down to rules for single glyphs in fonts, but also + * very slow. Its experimental and slow nature and the original + * developer losing interest meant that this option was never enabled in + * default builds. * * The corresponding interpreter version is v38. * * Value 2: * The new default mode for the TrueType driver. The Infinality code - * base was stripped to the bare minimum and all configurability - * removed in the name of speed and simplicity. The configurability - * was mainly aimed at legacy fonts like Arial, Times New Roman, or - * Courier. Legacy fonts are fonts that modify vertical stems to - * achieve clean black-and-white bitmaps. The new mode focuses on - * applying a minimal set of rules to all fonts indiscriminately so - * that modern and web fonts render well while legacy fonts render - * okay. + * base was stripped to the bare minimum and all configurability removed + * in the name of speed and simplicity. The configurability was mainly + * aimed at legacy fonts like 'Arial', 'Times New Roman', or 'Courier'. + * Legacy fonts are fonts that modify vertical stems to achieve clean + * black-and-white bitmaps. The new mode focuses on applying a minimal + * set of rules to all fonts indiscriminately so that modern and web + * fonts render well while legacy fonts render okay. * * The corresponding interpreter version is v40. * @@ -649,18 +644,18 @@ FT_BEGIN_HEADER * Compile both, making both v38 and v40 available (the latter is the * default). * - * By undefining these, you get rendering behavior like on Windows - * without ClearType, i.e., Windows XP without ClearType enabled and - * Win9x (interpreter version v35). Or not, depending on how much - * hinting blood and testing tears the font designer put into a given - * font. If you define one or both subpixel hinting options, you can - * switch between between v35 and the ones you define (using - * `FT_Property_Set'). + * By undefining these, you get rendering behavior like on Windows without + * ClearType, i.e., Windows XP without ClearType enabled and Win9x + * (interpreter version v35). Or not, depending on how much hinting blood + * and testing tears the font designer put into a given font. If you + * define one or both subpixel hinting options, you can switch between + * between v35 and the ones you define (using `FT_Property_Set`). * - * This option requires TT_CONFIG_OPTION_BYTECODE_INTERPRETER to be + * This option requires `TT_CONFIG_OPTION_BYTECODE_INTERPRETER` to be * defined. * - * [1] https://www.microsoft.com/typography/cleartype/truetypecleartype.aspx + * [1] + * https://www.microsoft.com/typography/cleartype/truetypecleartype.aspx */ /* #define TT_CONFIG_OPTION_SUBPIXEL_HINTING 1 */ /* #define TT_CONFIG_OPTION_SUBPIXEL_HINTING 2 */ @@ -669,16 +664,16 @@ FT_BEGIN_HEADER /************************************************************************** * - * Define TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED to compile the + * Define `TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED` to compile the * TrueType glyph loader to use Apple's definition of how to handle * component offsets in composite glyphs. * - * Apple and MS disagree on the default behavior of component offsets - * in composites. Apple says that they should be scaled by the scaling - * factors in the transformation matrix (roughly, it's more complex) - * while MS says they should not. OpenType defines two bits in the - * composite flags array which can be used to disambiguate, but old - * fonts will not have them. + * Apple and MS disagree on the default behavior of component offsets in + * composites. Apple says that they should be scaled by the scaling + * factors in the transformation matrix (roughly, it's more complex) while + * MS says they should not. OpenType defines two bits in the composite + * flags array which can be used to disambiguate, but old fonts will not + * have them. * * https://www.microsoft.com/typography/otspec/glyf.htm * https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6glyf.html @@ -688,34 +683,34 @@ FT_BEGIN_HEADER /************************************************************************** * - * Define TT_CONFIG_OPTION_GX_VAR_SUPPORT if you want to include - * support for Apple's distortable font technology (fvar, gvar, cvar, - * and avar tables). This has many similarities to Type 1 Multiple - * Masters support. + * Define `TT_CONFIG_OPTION_GX_VAR_SUPPORT` if you want to include support + * for Apple's distortable font technology (`fvar`, `gvar`, `cvar`, and + * `avar` tables). Tagged 'Font Variations', this is now part of OpenType + * also. This has many similarities to Type~1 Multiple Masters support. */ #define TT_CONFIG_OPTION_GX_VAR_SUPPORT /************************************************************************** * - * Define TT_CONFIG_OPTION_BDF if you want to include support for - * an embedded `BDF ' table within SFNT-based bitmap formats. + * Define `TT_CONFIG_OPTION_BDF` if you want to include support for an + * embedded `BDF ` table within SFNT-based bitmap formats. */ #define TT_CONFIG_OPTION_BDF /************************************************************************** * - * Option TT_CONFIG_OPTION_MAX_RUNNABLE_OPCODES controls the maximum + * Option `TT_CONFIG_OPTION_MAX_RUNNABLE_OPCODES` controls the maximum * number of bytecode instructions executed for a single run of the - * bytecode interpreter, needed to prevent infinite loops. You don't - * want to change this except for very special situations (e.g., making - * a library fuzzer spend less time to handle broken fonts). + * bytecode interpreter, needed to prevent infinite loops. You don't want + * to change this except for very special situations (e.g., making a + * library fuzzer spend less time to handle broken fonts). * * It is not expected that this value is ever modified by a configuring - * script; instead, it gets surrounded with #ifndef ... #endif so that - * the value can be set as a preprocessor option on the compiler's - * command line. + * script; instead, it gets surrounded with `#ifndef ... #endif` so that + * the value can be set as a preprocessor option on the compiler's command + * line. */ #ifndef TT_CONFIG_OPTION_MAX_RUNNABLE_OPCODES #define TT_CONFIG_OPTION_MAX_RUNNABLE_OPCODES 1000000L @@ -733,16 +728,15 @@ FT_BEGIN_HEADER /************************************************************************** * - * T1_MAX_DICT_DEPTH is the maximum depth of nest dictionaries and - * arrays in the Type 1 stream (see t1load.c). A minimum of 4 is - * required. + * `T1_MAX_DICT_DEPTH` is the maximum depth of nest dictionaries and arrays + * in the Type~1 stream (see `t1load.c`). A minimum of~4 is required. */ #define T1_MAX_DICT_DEPTH 5 /************************************************************************** * - * T1_MAX_SUBRS_CALLS details the maximum number of nested sub-routine + * `T1_MAX_SUBRS_CALLS` details the maximum number of nested sub-routine * calls during glyph loading. */ #define T1_MAX_SUBRS_CALLS 16 @@ -750,19 +744,20 @@ FT_BEGIN_HEADER /************************************************************************** * - * T1_MAX_CHARSTRING_OPERANDS is the charstring stack's capacity. A - * minimum of 16 is required. + * `T1_MAX_CHARSTRING_OPERANDS` is the charstring stack's capacity. A + * minimum of~16 is required. * - * The Chinese font MingTiEG-Medium (CNS 11643 character set) needs 256. + * The Chinese font 'MingTiEG-Medium' (covering a CNS 11643 character set) + * needs 256. */ #define T1_MAX_CHARSTRINGS_OPERANDS 256 /************************************************************************** * - * Define this configuration macro if you want to prevent the - * compilation of `t1afm', which is in charge of reading Type 1 AFM - * files into an existing face. Note that if set, the T1 driver will be + * Define this configuration macro if you want to prevent the compilation + * of the 't1afm' module, which is in charge of reading Type~1 AFM files + * into an existing face. Note that if set, the Type~1 driver will be * unable to produce kerning distances. */ #undef T1_CONFIG_OPTION_NO_AFM @@ -770,19 +765,18 @@ FT_BEGIN_HEADER /************************************************************************** * - * Define this configuration macro if you want to prevent the - * compilation of the Multiple Masters font support in the Type 1 - * driver. + * Define this configuration macro if you want to prevent the compilation + * of the Multiple Masters font support in the Type~1 driver. */ #undef T1_CONFIG_OPTION_NO_MM_SUPPORT /************************************************************************** * - * T1_CONFIG_OPTION_OLD_ENGINE controls whether the pre-Adobe Type 1 + * `T1_CONFIG_OPTION_OLD_ENGINE` controls whether the pre-Adobe Type~1 * engine gets compiled into FreeType. If defined, it is possible to - * switch between the two engines using the `hinting-engine' property of - * the type1 driver module. + * switch between the two engines using the `hinting-engine` property of + * the 'type1' driver module. */ #define T1_CONFIG_OPTION_OLD_ENGINE @@ -798,14 +792,13 @@ FT_BEGIN_HEADER /************************************************************************** * - * Using CFF_CONFIG_OPTION_DARKENING_PARAMETER_{X,Y}{1,2,3,4} it is + * Using `CFF_CONFIG_OPTION_DARKENING_PARAMETER_{X,Y}{1,2,3,4}` it is * possible to set up the default values of the four control points that - * define the stem darkening behaviour of the (new) CFF engine. For - * more details please read the documentation of the - * `darkening-parameters' property (file `ftdriver.h'), which allows the - * control at run-time. + * define the stem darkening behaviour of the (new) CFF engine. For more + * details please read the documentation of the `darkening-parameters` + * property (file `ftdriver.h`), which allows the control at run-time. * - * Do *not* undefine these macros! + * Do **not** undefine these macros! */ #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_X1 500 #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y1 400 @@ -822,10 +815,10 @@ FT_BEGIN_HEADER /************************************************************************** * - * CFF_CONFIG_OPTION_OLD_ENGINE controls whether the pre-Adobe CFF - * engine gets compiled into FreeType. If defined, it is possible to - * switch between the two engines using the `hinting-engine' property of - * the cff driver module. + * `CFF_CONFIG_OPTION_OLD_ENGINE` controls whether the pre-Adobe CFF engine + * gets compiled into FreeType. If defined, it is possible to switch + * between the two engines using the `hinting-engine` property of the 'cff' + * driver module. */ #define CFF_CONFIG_OPTION_OLD_ENGINE @@ -841,18 +834,18 @@ FT_BEGIN_HEADER /************************************************************************** * - * There are many PCF fonts just called `Fixed' which look completely - * different, and which have nothing to do with each other. When - * selecting `Fixed' in KDE or Gnome one gets results that appear rather - * random, the style changes often if one changes the size and one - * cannot select some fonts at all. This option makes the PCF module - * prepend the foundry name (plus a space) to the family name. + * There are many PCF fonts just called 'Fixed' which look completely + * different, and which have nothing to do with each other. When selecting + * 'Fixed' in KDE or Gnome one gets results that appear rather random, the + * style changes often if one changes the size and one cannot select some + * fonts at all. This option makes the 'pcf' module prepend the foundry + * name (plus a space) to the family name. * - * We also check whether we have `wide' characters; all put together, we - * get family names like `Sony Fixed' or `Misc Fixed Wide'. + * We also check whether we have 'wide' characters; all put together, we + * get family names like 'Sony Fixed' or 'Misc Fixed Wide'. * * If this option is activated, it can be controlled with the - * `no-long-family-names' property of the pcf driver module. + * `no-long-family-names` property of the 'pcf' driver module. */ #define PCF_CONFIG_OPTION_LONG_FAMILY_NAMES @@ -868,51 +861,56 @@ FT_BEGIN_HEADER /************************************************************************** * - * Compile autofit module with CJK (Chinese, Japanese, Korean) script + * Compile 'autofit' module with CJK (Chinese, Japanese, Korean) script * support. */ #define AF_CONFIG_OPTION_CJK + /************************************************************************** * - * Compile autofit module with fallback Indic script support, covering - * some scripts that the `latin' submodule of the autofit module doesn't + * Compile 'autofit' module with fallback Indic script support, covering + * some scripts that the 'latin' submodule of the 'autofit' module doesn't * (yet) handle. */ #define AF_CONFIG_OPTION_INDIC - /************************************************************************** - * - * Compile autofit module with warp hinting. The idea of the warping - * code is to slightly scale and shift a glyph within a single dimension - * so that as much of its segments are aligned (more or less) on the - * grid. To find out the optimal scaling and shifting value, various - * parameter combinations are tried and scored. - * - * This experimental option is active only if the rendering mode is - * FT_RENDER_MODE_LIGHT; you can switch warping on and off with the - * `warping' property of the auto-hinter (see file `ftdriver.h' for more - * information; by default it is switched off). - */ -#define AF_CONFIG_OPTION_USE_WARPER /************************************************************************** * - * Use TrueType-like size metrics for `light' auto-hinting. + * Compile 'autofit' module with warp hinting. The idea of the warping + * code is to slightly scale and shift a glyph within a single dimension so + * that as much of its segments are aligned (more or less) on the grid. To + * find out the optimal scaling and shifting value, various parameter + * combinations are tried and scored. + * + * You can switch warping on and off with the `warping` property of the + * auto-hinter (see file `ftdriver.h` for more information; by default it + * is switched off). + * + * This experimental option is not active if the rendering mode is + * `FT_RENDER_MODE_LIGHT`. + */ +#define AF_CONFIG_OPTION_USE_WARPER + + + /************************************************************************** + * + * Use TrueType-like size metrics for 'light' auto-hinting. * * It is strongly recommended to avoid this option, which exists only to - * help some legacy applications retain its appearance and behaviour - * with respect to auto-hinted TrueType fonts. + * help some legacy applications retain its appearance and behaviour with + * respect to auto-hinted TrueType fonts. * * The very reason this option exists at all are GNU/Linux distributions * like Fedora that did not un-patch the following change (which was * present in FreeType between versions 2.4.6 and 2.7.1, inclusive). * - * { + * ``` * 2011-07-16 Steven Chu * * [truetype] Fix metrics on size request for scalable fonts. - * } + * ``` * * This problematic commit is now reverted (more or less). */ @@ -922,15 +920,15 @@ FT_BEGIN_HEADER /* - * This macro is obsolete. Support has been removed in FreeType - * version 2.5. + * This macro is obsolete. Support has been removed in FreeType version + * 2.5. */ /* #define FT_CONFIG_OPTION_OLD_INTERNALS */ /* - * This macro is defined if native TrueType hinting is requested by the - * definitions above. + * The next three macros are defined if native TrueType hinting is + * requested by the definitions above. Don't change this. */ #ifdef TT_CONFIG_OPTION_BYTECODE_INTERPRETER #define TT_USE_BYTECODE_INTERPRETER @@ -949,7 +947,7 @@ FT_BEGIN_HEADER /* * Check CFF darkening parameters. The checks are the same as in function - * `cff_property_set' in file `cffdrivr.c'. + * `cff_property_set` in file `cffdrivr.c`. */ #if CFF_CONFIG_OPTION_DARKENING_PARAMETER_X1 < 0 || \ CFF_CONFIG_OPTION_DARKENING_PARAMETER_X2 < 0 || \