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