1 /***************************************************************************/
5 /* User-selectable configuration macros (specification only). */
7 /* Copyright 1996-2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by */
8 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
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. */
16 /***************************************************************************/
19 #ifndef __FTOPTION_H__
20 #define __FTOPTION_H__
28 /*************************************************************************/
30 /* USER-SELECTABLE CONFIGURATION MACROS */
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: */
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. */
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. */
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. */
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, */
53 /* #define FT_CONFIG_OPTIONS_H <myftoptions.h> */
54 /* #include <freetype/config/ftheader.h> */
56 /* will use `$BUILD/myftoptions.h' instead of this file for macro */
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>. */
64 /* We highly recommend using the third method whenever possible. */
66 /*************************************************************************/
69 /*************************************************************************/
70 /*************************************************************************/
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 ****/
74 /*************************************************************************/
75 /*************************************************************************/
78 /*************************************************************************/
80 /* Uncomment the line below if you want to activate sub-pixel rendering */
81 /* (a.k.a. LCD rendering, or ClearType) in this build of the library. */
83 /* Note that this feature is covered by several Microsoft patents */
84 /* and should not be activated in any default build of the library. */
86 /* This macro has no impact on the FreeType API, only on its */
87 /* _implementation_. For example, using FT_RENDER_MODE_LCD when calling */
88 /* FT_Render_Glyph still generates a bitmap that is 3 times larger than */
89 /* the original size; the difference will be that each triplet of */
90 /* subpixels has R=G=B. */
92 /* This is done to allow FreeType clients to run unmodified, forcing */
93 /* them to display normal gray-level anti-aliased glyphs. */
95 #define FT_CONFIG_OPTION_SUBPIXEL_RENDERING
98 /*************************************************************************/
100 /* Many compilers provide a non-ANSI 64-bit data type that can be used */
101 /* by FreeType to speed up some computations. However, this will create */
102 /* some problems when compiling the library in strict ANSI mode. */
104 /* For this reason, the use of 64-bit integers is normally disabled when */
105 /* the __STDC__ macro is defined. You can however disable this by */
106 /* defining the macro FT_CONFIG_OPTION_FORCE_INT64 here. */
108 /* For most compilers, this will only create compilation warnings when */
109 /* building the library. */
111 /* ObNote: The compiler-specific 64-bit integers are detected in the */
112 /* file `ftconfig.h' either statically or through the */
113 /* `configure' script on supported platforms. */
115 #undef FT_CONFIG_OPTION_FORCE_INT64
118 /*************************************************************************/
120 /* If this macro is defined, do not try to use an assembler version of */
121 /* performance-critical functions (e.g. FT_MulFix). You should only do */
122 /* that to verify that the assembler function works properly, or to */
123 /* execute benchmark tests of the various implementations. */
124 /* #define FT_CONFIG_OPTION_NO_ASSEMBLER */
127 /*************************************************************************/
129 /* If this macro is defined, try to use an inlined assembler version of */
130 /* the `FT_MulFix' function, which is a `hotspot' when loading and */
131 /* hinting glyphs, and which should be executed as fast as possible. */
133 /* Note that if your compiler or CPU is not supported, this will default */
134 /* to the standard and portable implementation found in `ftcalc.c'. */
136 #define FT_CONFIG_OPTION_INLINE_MULFIX
139 /*************************************************************************/
141 /* LZW-compressed file support. */
143 /* FreeType now handles font files that have been compressed with the */
144 /* `compress' program. This is mostly used to parse many of the PCF */
145 /* files that come with various X11 distributions. The implementation */
146 /* uses NetBSD's `zopen' to partially uncompress the file on the fly */
147 /* (see src/lzw/ftgzip.c). */
149 /* Define this macro if you want to enable this `feature'. */
151 #define FT_CONFIG_OPTION_USE_LZW
154 /*************************************************************************/
156 /* Gzip-compressed file support. */
158 /* FreeType now handles font files that have been compressed with the */
159 /* `gzip' program. This is mostly used to parse many of the PCF files */
160 /* that come with XFree86. The implementation uses `zlib' to */
161 /* partially uncompress the file on the fly (see src/gzip/ftgzip.c). */
163 /* Define this macro if you want to enable this `feature'. See also */
164 /* the macro FT_CONFIG_OPTION_SYSTEM_ZLIB below. */
166 #define FT_CONFIG_OPTION_USE_ZLIB
169 /*************************************************************************/
171 /* ZLib library selection */
173 /* This macro is only used when FT_CONFIG_OPTION_USE_ZLIB is defined. */
174 /* It allows FreeType's `ftgzip' component to link to the system's */
175 /* installation of the ZLib library. This is useful on systems like */
176 /* Unix or VMS where it generally is already available. */
178 /* If you let it undefined, the component will use its own copy */
179 /* of the zlib sources instead. These have been modified to be */
180 /* included directly within the component and *not* export external */
181 /* function names. This allows you to link any program with FreeType */
182 /* _and_ ZLib without linking conflicts. */
184 /* Do not #undef this macro here since the build system might define */
185 /* it for certain configurations only. */
187 /* #define FT_CONFIG_OPTION_SYSTEM_ZLIB */
190 /*************************************************************************/
192 /* DLL export compilation */
194 /* When compiling FreeType as a DLL, some systems/compilers need a */
195 /* special keyword in front OR after the return type of function */
198 /* Two macros are used within the FreeType source code to define */
199 /* exported library functions: FT_EXPORT and FT_EXPORT_DEF. */
201 /* FT_EXPORT( return_type ) */
203 /* is used in a function declaration, as in */
205 /* FT_EXPORT( FT_Error ) */
206 /* FT_Init_FreeType( FT_Library* alibrary ); */
209 /* FT_EXPORT_DEF( return_type ) */
211 /* is used in a function definition, as in */
213 /* FT_EXPORT_DEF( FT_Error ) */
214 /* FT_Init_FreeType( FT_Library* alibrary ) */
216 /* ... some code ... */
217 /* return FT_Err_Ok; */
220 /* You can provide your own implementation of FT_EXPORT and */
221 /* FT_EXPORT_DEF here if you want. If you leave them undefined, they */
222 /* will be later automatically defined as `extern return_type' to */
223 /* allow normal compilation. */
225 /* Do not #undef these macros here since the build system might define */
226 /* them for certain configurations only. */
228 /* #define FT_EXPORT(x) extern x */
229 /* #define FT_EXPORT_DEF(x) x */
232 /*************************************************************************/
234 /* Glyph Postscript Names handling */
236 /* By default, FreeType 2 is compiled with the `psnames' module. This */
237 /* module is in charge of converting a glyph name string into a */
238 /* Unicode value, or return a Macintosh standard glyph name for the */
239 /* use with the TrueType `post' table. */
241 /* Undefine this macro if you do not want `psnames' compiled in your */
242 /* build of FreeType. This has the following effects: */
244 /* - The TrueType driver will provide its own set of glyph names, */
245 /* if you build it to support postscript names in the TrueType */
248 /* - The Type 1 driver will not be able to synthesize a Unicode */
249 /* charmap out of the glyphs found in the fonts. */
251 /* You would normally undefine this configuration macro when building */
252 /* a version of FreeType that doesn't contain a Type 1 or CFF driver. */
254 #define FT_CONFIG_OPTION_POSTSCRIPT_NAMES
257 /*************************************************************************/
259 /* Postscript Names to Unicode Values support */
261 /* By default, FreeType 2 is built with the `PSNames' module compiled */
262 /* in. Among other things, the module is used to convert a glyph name */
263 /* into a Unicode value. This is especially useful in order to */
264 /* synthesize on the fly a Unicode charmap from the CFF/Type 1 driver */
265 /* through a big table named the `Adobe Glyph List' (AGL). */
267 /* Undefine this macro if you do not want the Adobe Glyph List */
268 /* compiled in your `PSNames' module. The Type 1 driver will not be */
269 /* able to synthesize a Unicode charmap out of the glyphs found in the */
272 #define FT_CONFIG_OPTION_ADOBE_GLYPH_LIST
275 /*************************************************************************/
277 /* Support for Mac fonts */
279 /* Define this macro if you want support for outline fonts in Mac */
280 /* format (mac dfont, mac resource, macbinary containing a mac */
281 /* resource) on non-Mac platforms. */
283 /* Note that the `FOND' resource isn't checked. */
285 #define FT_CONFIG_OPTION_MAC_FONTS
288 /*************************************************************************/
290 /* Guessing methods to access embedded resource forks */
292 /* Enable extra Mac fonts support on non-Mac platforms (e.g. */
295 /* Resource forks which include fonts data are stored sometimes in */
296 /* locations which users or developers don't expected. In some cases, */
297 /* resource forks start with some offset from the head of a file. In */
298 /* other cases, the actual resource fork is stored in file different */
299 /* from what the user specifies. If this option is activated, */
300 /* FreeType tries to guess whether such offsets or different file */
301 /* names must be used. */
303 /* Note that normal, direct access of resource forks is controlled via */
304 /* the FT_CONFIG_OPTION_MAC_FONTS option. */
306 #ifdef FT_CONFIG_OPTION_MAC_FONTS
307 #define FT_CONFIG_OPTION_GUESSING_EMBEDDED_RFORK
311 /*************************************************************************/
313 /* Allow the use of FT_Incremental_Interface to load typefaces that */
314 /* contain no glyph data, but supply it via a callback function. */
315 /* This allows FreeType to be used with the PostScript language, using */
316 /* the GhostScript interpreter. */
318 /* #define FT_CONFIG_OPTION_INCREMENTAL */
321 /*************************************************************************/
323 /* The size in bytes of the render pool used by the scan-line converter */
324 /* to do all of its work. */
326 /* This must be greater than 4KByte if you use FreeType to rasterize */
327 /* glyphs; otherwise, you may set it to zero to avoid unnecessary */
328 /* allocation of the render pool. */
330 #define FT_RENDER_POOL_SIZE 16384L
333 /*************************************************************************/
337 /* The maximum number of modules that can be registered in a single */
338 /* FreeType library object. 32 is the default. */
340 #define FT_MAX_MODULES 32
343 /*************************************************************************/
347 /* FreeType can be compiled in debug or trace mode. In debug mode, */
348 /* errors are reported through the `ftdebug' component. In trace */
349 /* mode, additional messages are sent to the standard output during */
352 /* Define FT_DEBUG_LEVEL_ERROR to build the library in debug mode. */
353 /* Define FT_DEBUG_LEVEL_TRACE to build it in trace mode. */
355 /* Don't define any of these macros to compile in `release' mode! */
357 /* Do not #undef these macros here since the build system might define */
358 /* them for certain configurations only. */
360 /* #define FT_DEBUG_LEVEL_ERROR */
361 /* #define FT_DEBUG_LEVEL_TRACE */
364 /*************************************************************************/
366 /* Memory Debugging */
368 /* FreeType now comes with an integrated memory debugger that is */
369 /* capable of detecting simple errors like memory leaks or double */
370 /* deletes. To compile it within your build of the library, you */
371 /* should define FT_DEBUG_MEMORY here. */
373 /* Note that the memory debugger is only activated at runtime when */
374 /* when the _environment_ variable `FT2_DEBUG_MEMORY' is defined also! */
376 /* Do not #undef this macro here since the build system might define */
377 /* it for certain configurations only. */
379 /* #define FT_DEBUG_MEMORY */
382 /*************************************************************************/
386 /* If this macro is set (which is _not_ the default), the higher byte */
387 /* of an error code gives the module in which the error has occurred, */
388 /* while the lower byte is the real error code. */
390 /* Setting this macro makes sense for debugging purposes only, since */
391 /* it would break source compatibility of certain programs that use */
394 /* More details can be found in the files ftmoderr.h and fterrors.h. */
396 #undef FT_CONFIG_OPTION_USE_MODULE_ERRORS
399 /*************************************************************************/
401 /* Position Independent Code */
403 /* If this macro is set (which is _not_ the default), FreeType2 will */
404 /* avoid creating constants that require address fixups. Instead the */
405 /* constants will be moved into a struct and additional intialization */
406 /* code will be used. */
408 /* Setting this macro is needed for systems that prohibit address */
409 /* fixups, such as BREW. */
411 /* #define FT_CONFIG_OPTION_PIC */
414 /*************************************************************************/
415 /*************************************************************************/
417 /**** S F N T D R I V E R C O N F I G U R A T I O N ****/
419 /*************************************************************************/
420 /*************************************************************************/
423 /*************************************************************************/
425 /* Define TT_CONFIG_OPTION_EMBEDDED_BITMAPS if you want to support */
426 /* embedded bitmaps in all formats using the SFNT module (namely */
427 /* TrueType & OpenType). */
429 #define TT_CONFIG_OPTION_EMBEDDED_BITMAPS
432 /*************************************************************************/
434 /* Define TT_CONFIG_OPTION_POSTSCRIPT_NAMES if you want to be able to */
435 /* load and enumerate the glyph Postscript names in a TrueType or */
438 /* Note that when you do not compile the `PSNames' module by undefining */
439 /* the above FT_CONFIG_OPTION_POSTSCRIPT_NAMES, the `sfnt' module will */
440 /* contain additional code used to read the PS Names table from a font. */
442 /* (By default, the module uses `PSNames' to extract glyph names.) */
444 #define TT_CONFIG_OPTION_POSTSCRIPT_NAMES
447 /*************************************************************************/
449 /* Define TT_CONFIG_OPTION_SFNT_NAMES if your applications need to */
450 /* access the internal name table in a SFNT-based format like TrueType */
451 /* or OpenType. The name table contains various strings used to */
452 /* describe the font, like family name, copyright, version, etc. It */
453 /* does not contain any glyph name though. */
455 /* Accessing SFNT names is done through the functions declared in */
456 /* `freetype/ftsnames.h'. */
458 #define TT_CONFIG_OPTION_SFNT_NAMES
461 /*************************************************************************/
463 /* TrueType CMap support */
465 /* Here you can fine-tune which TrueType CMap table format shall be */
467 #define TT_CONFIG_CMAP_FORMAT_0
468 #define TT_CONFIG_CMAP_FORMAT_2
469 #define TT_CONFIG_CMAP_FORMAT_4
470 #define TT_CONFIG_CMAP_FORMAT_6
471 #define TT_CONFIG_CMAP_FORMAT_8
472 #define TT_CONFIG_CMAP_FORMAT_10
473 #define TT_CONFIG_CMAP_FORMAT_12
474 #define TT_CONFIG_CMAP_FORMAT_13
475 #define TT_CONFIG_CMAP_FORMAT_14
478 /*************************************************************************/
479 /*************************************************************************/
481 /**** 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 ****/
483 /*************************************************************************/
484 /*************************************************************************/
486 /*************************************************************************/
488 /* Define TT_CONFIG_OPTION_BYTECODE_INTERPRETER if you want to compile */
489 /* a bytecode interpreter in the TrueType driver. Note that there are */
490 /* important patent issues related to the use of the interpreter. */
492 /* By undefining this, you will only compile the code necessary to load */
493 /* TrueType glyphs without hinting. */
495 /* Do not #undef this macro here, since the build system might */
496 /* define it for certain configurations only. */
498 #define TT_CONFIG_OPTION_BYTECODE_INTERPRETER
501 /*************************************************************************/
503 /* If you define TT_CONFIG_OPTION_UNPATENTED_HINTING, a special version */
504 /* of the TrueType bytecode interpreter is used that doesn't implement */
505 /* any of the patented opcodes and algorithms. Note that the */
506 /* TT_CONFIG_OPTION_UNPATENTED_HINTING macro is *ignored* if you define */
507 /* TT_CONFIG_OPTION_BYTECODE_INTERPRETER; in other words, either define */
508 /* TT_CONFIG_OPTION_BYTECODE_INTERPRETER or */
509 /* TT_CONFIG_OPTION_UNPATENTED_HINTING but not both at the same time. */
511 /* This macro is only useful for a small number of font files (mostly */
512 /* for Asian scripts) that require bytecode interpretation to properly */
513 /* load glyphs. For all other fonts, this produces unpleasant results, */
514 /* thus the unpatented interpreter is never used to load glyphs from */
515 /* TrueType fonts unless one of the following two options is used. */
517 /* - The unpatented interpreter is explicitly activated by the user */
518 /* through the FT_PARAM_TAG_UNPATENTED_HINTING parameter tag */
519 /* when opening the FT_Face. */
521 /* - FreeType detects that the FT_Face corresponds to one of the */
522 /* `trick' fonts (e.g., `Mingliu') it knows about. The font engine */
523 /* contains a hard-coded list of font names and other matching */
524 /* parameters (see function `tt_face_init' in file */
525 /* `src/truetype/ttobjs.c'). */
527 /* Here a sample code snippet for using FT_PARAM_TAG_UNPATENTED_HINTING. */
530 /* FT_Parameter parameter; */
531 /* FT_Open_Args open_args; */
534 /* parameter.tag = FT_PARAM_TAG_UNPATENTED_HINTING; */
536 /* open_args.flags = FT_OPEN_PATHNAME | FT_OPEN_PARAMS; */
537 /* open_args.pathname = my_font_pathname; */
538 /* open_args.num_params = 1; */
539 /* open_args.params = ¶meter; */
541 /* error = FT_Open_Face( library, &open_args, index, &face ); */
545 #define TT_CONFIG_OPTION_UNPATENTED_HINTING
548 /*************************************************************************/
550 /* Define TT_CONFIG_OPTION_INTERPRETER_SWITCH to compile the TrueType */
551 /* bytecode interpreter with a huge switch statement, rather than a call */
552 /* table. This results in smaller and faster code for a number of */
555 /* Note however that on some compiler/processor combinations, undefining */
556 /* this macro will generate faster, though larger, code. */
558 #define TT_CONFIG_OPTION_INTERPRETER_SWITCH
561 /*************************************************************************/
563 /* Define TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED to compile the */
564 /* TrueType glyph loader to use Apple's definition of how to handle */
565 /* component offsets in composite glyphs. */
567 /* Apple and MS disagree on the default behavior of component offsets */
568 /* in composites. Apple says that they should be scaled by the scaling */
569 /* factors in the transformation matrix (roughly, it's more complex) */
570 /* while MS says they should not. OpenType defines two bits in the */
571 /* composite flags array which can be used to disambiguate, but old */
572 /* fonts will not have them. */
574 /* http://partners.adobe.com/asn/developer/opentype/glyf.html */
575 /* http://fonts.apple.com/TTRefMan/RM06/Chap6glyf.html */
577 #undef TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED
580 /*************************************************************************/
582 /* Define TT_CONFIG_OPTION_GX_VAR_SUPPORT if you want to include */
583 /* support for Apple's distortable font technology (fvar, gvar, cvar, */
584 /* and avar tables). This has many similarities to Type 1 Multiple */
585 /* Masters support. */
587 #define TT_CONFIG_OPTION_GX_VAR_SUPPORT
590 /*************************************************************************/
592 /* Define TT_CONFIG_OPTION_BDF if you want to include support for */
593 /* an embedded `BDF ' table within SFNT-based bitmap formats. */
595 #define TT_CONFIG_OPTION_BDF
598 /*************************************************************************/
599 /*************************************************************************/
601 /**** T Y P E 1 D R I V E R C O N F I G U R A T I O N ****/
603 /*************************************************************************/
604 /*************************************************************************/
607 /*************************************************************************/
609 /* T1_MAX_DICT_DEPTH is the maximal depth of nest dictionaries and */
610 /* arrays in the Type 1 stream (see t1load.c). A minimum of 4 is */
613 #define T1_MAX_DICT_DEPTH 5
616 /*************************************************************************/
618 /* T1_MAX_SUBRS_CALLS details the maximum number of nested sub-routine */
619 /* calls during glyph loading. */
621 #define T1_MAX_SUBRS_CALLS 16
624 /*************************************************************************/
626 /* T1_MAX_CHARSTRING_OPERANDS is the charstring stack's capacity. A */
627 /* minimum of 16 is required. */
629 /* The Chinese font MingTiEG-Medium (CNS 11643 character set) needs 256. */
631 #define T1_MAX_CHARSTRINGS_OPERANDS 256
634 /*************************************************************************/
636 /* Define this configuration macro if you want to prevent the */
637 /* compilation of `t1afm', which is in charge of reading Type 1 AFM */
638 /* files into an existing face. Note that if set, the T1 driver will be */
639 /* unable to produce kerning distances. */
641 #undef T1_CONFIG_OPTION_NO_AFM
644 /*************************************************************************/
646 /* Define this configuration macro if you want to prevent the */
647 /* compilation of the Multiple Masters font support in the Type 1 */
650 #undef T1_CONFIG_OPTION_NO_MM_SUPPORT
653 /*************************************************************************/
654 /*************************************************************************/
656 /**** 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 ****/
658 /*************************************************************************/
659 /*************************************************************************/
662 /*************************************************************************/
664 /* Compile autofit module with CJK (Chinese, Japanese, Korean) script */
667 #define AF_CONFIG_OPTION_CJK
669 /*************************************************************************/
671 /* Compile autofit module with Indic script support. */
673 #define AF_CONFIG_OPTION_INDIC
679 * Define this variable if you want to keep the layout of internal
680 * structures that was used prior to FreeType 2.2. This also compiles in
681 * a few obsolete functions to avoid linking problems on typical Unix
684 * For embedded systems or building a new distribution from scratch, it
685 * is recommended to disable the macro since it reduces the library's code
686 * size and activates a few memory-saving optimizations as well.
688 #define FT_CONFIG_OPTION_OLD_INTERNALS
692 * This macro is defined if either unpatented or native TrueType
693 * hinting is requested by the definitions above.
695 #ifdef TT_CONFIG_OPTION_BYTECODE_INTERPRETER
696 #define TT_USE_BYTECODE_INTERPRETER
697 #undef TT_CONFIG_OPTION_UNPATENTED_HINTING
698 #elif defined TT_CONFIG_OPTION_UNPATENTED_HINTING
699 #define TT_USE_BYTECODE_INTERPRETER
705 #endif /* __FTOPTION_H__ */