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