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