ftoption.h revision 727dee178a392d20eb050d0c446f2fcc29058fa1
1c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/***************************************************************************/ 2c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/* */ 3c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/* ftoption.h */ 4c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/* */ 5c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/* User-selectable configuration macros (specification only). */ 6c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/* */ 7c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/* Copyright 1996-2013 by */ 8c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/* David Turner, Robert Wilhelm, and Werner Lemberg. */ 9c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/* */ 10c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/* This file is part of the FreeType project, and may only be used, */ 11c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/* modified, and distributed under the terms of the FreeType project */ 12a93a17c8d99d686bd4a1511e5504e5e6cc9fcadfTorne (Richard Coles)/* license, LICENSE.TXT. By continuing to use, modify, or distribute */ 13c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/* this file you indicate that you have read the license and */ 14c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/* understand and accept it fully. */ 15c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/* */ 16c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/***************************************************************************/ 17c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 18c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 19c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#ifndef __FTOPTION_H__ 20c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#define __FTOPTION_H__ 21c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 22c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 23c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include <ft2build.h> 24c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 25c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 26c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)FT_BEGIN_HEADER 27c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 28c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /*************************************************************************/ 29c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* */ 30ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /* USER-SELECTABLE CONFIGURATION MACROS */ 31ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /* */ 32ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /* This file contains the default configuration macro definitions for */ 33ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /* a standard build of the FreeType library. There are three ways to */ 34c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* use this file to build project-specific versions of the library: */ 35c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* */ 36c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* - You can modify this file by hand, but this is not recommended in */ 37a93a17c8d99d686bd4a1511e5504e5e6cc9fcadfTorne (Richard Coles) /* cases where you would like to build several versions of the */ 38a93a17c8d99d686bd4a1511e5504e5e6cc9fcadfTorne (Richard Coles) /* library from a single source directory. */ 39c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* */ 40c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* - You can put a copy of this file in your build directory, more */ 41c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* precisely in `$BUILD/freetype/config/ftoption.h', where `$BUILD' */ 42a93a17c8d99d686bd4a1511e5504e5e6cc9fcadfTorne (Richard Coles) /* is the name of a directory that is included _before_ the FreeType */ 43c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* include path during compilation. */ 44c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* */ 45c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* The default FreeType Makefiles and Jamfiles use the build */ 46c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* directory `builds/<system>' by default, but you can easily change */ 47c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* that for your own projects. */ 48c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* */ 49c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* - Copy the file <ft2build.h> to `$BUILD/ft2build.h' and modify it */ 50a93a17c8d99d686bd4a1511e5504e5e6cc9fcadfTorne (Richard Coles) /* slightly to pre-define the macro FT_CONFIG_OPTIONS_H used to */ 51c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* locate this file during the build. For example, */ 52c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* */ 53c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* #define FT_CONFIG_OPTIONS_H <myftoptions.h> */ 54a93a17c8d99d686bd4a1511e5504e5e6cc9fcadfTorne (Richard Coles) /* #include <freetype/config/ftheader.h> */ 55c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* */ 56c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* will use `$BUILD/myftoptions.h' instead of this file for macro */ 57c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* definitions. */ 58c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* */ 59c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* Note also that you can similarly pre-define the macro */ 60c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* FT_CONFIG_MODULES_H used to locate the file listing of the modules */ 61c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* that are statically linked to the library at compile time. By */ 62c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* default, this file is <freetype/config/ftmodule.h>. */ 63c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* */ 64c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* We highly recommend using the third method whenever possible. */ 65c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* */ 66c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /*************************************************************************/ 67c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 68c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 69c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /*************************************************************************/ 70a93a17c8d99d686bd4a1511e5504e5e6cc9fcadfTorne (Richard Coles) /*************************************************************************/ 71a93a17c8d99d686bd4a1511e5504e5e6cc9fcadfTorne (Richard Coles) /**** ****/ 72a93a17c8d99d686bd4a1511e5504e5e6cc9fcadfTorne (Richard Coles) /**** 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 ****/ 73c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /**** ****/ 74c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /*************************************************************************/ 75c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /*************************************************************************/ 76c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 77a93a17c8d99d686bd4a1511e5504e5e6cc9fcadfTorne (Richard Coles) 78c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /*************************************************************************/ 79c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* */ 80c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* Uncomment the line below if you want to activate sub-pixel rendering */ 81010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) /* (a.k.a. LCD rendering, or ClearType) in this build of the library. */ 82010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) /* */ 83c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* Note that this feature is covered by several Microsoft patents */ 84c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* and should not be activated in any default build of the library. */ 85c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* */ 86c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* This macro has no impact on the FreeType API, only on its */ 87c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* _implementation_. For example, using FT_RENDER_MODE_LCD when calling */ 88c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* FT_Render_Glyph still generates a bitmap that is 3 times wider than */ 89c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* the original size in case this macro isn't defined; however, each */ 90c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* triplet of subpixels has R=G=B. */ 91c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /* */ 92 /* This is done to allow FreeType clients to run unmodified, forcing */ 93 /* them to display normal gray-level anti-aliased glyphs. */ 94 /* */ 95/* #define FT_CONFIG_OPTION_SUBPIXEL_RENDERING */ 96 97 98 /*************************************************************************/ 99 /* */ 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. */ 103 /* */ 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. */ 107 /* */ 108 /* For most compilers, this will only create compilation warnings when */ 109 /* building the library. */ 110 /* */ 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. */ 114 /* */ 115#undef FT_CONFIG_OPTION_FORCE_INT64 116 117 118 /*************************************************************************/ 119 /* */ 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 */ 125 126 127 /*************************************************************************/ 128 /* */ 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. */ 132 /* */ 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'. */ 135 /* */ 136#define FT_CONFIG_OPTION_INLINE_MULFIX 137 138 139 /*************************************************************************/ 140 /* */ 141 /* LZW-compressed file support. */ 142 /* */ 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). */ 148 /* */ 149 /* Define this macro if you want to enable this `feature'. */ 150 /* */ 151#define FT_CONFIG_OPTION_USE_LZW 152 153 154 /*************************************************************************/ 155 /* */ 156 /* Gzip-compressed file support. */ 157 /* */ 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). */ 162 /* */ 163 /* Define this macro if you want to enable this `feature'. See also */ 164 /* the macro FT_CONFIG_OPTION_SYSTEM_ZLIB below. */ 165 /* */ 166#define FT_CONFIG_OPTION_USE_ZLIB 167 168 169 /*************************************************************************/ 170 /* */ 171 /* ZLib library selection */ 172 /* */ 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. */ 177 /* */ 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. */ 183 /* */ 184 /* Do not #undef this macro here since the build system might define */ 185 /* it for certain configurations only. */ 186 /* */ 187/* #define FT_CONFIG_OPTION_SYSTEM_ZLIB */ 188 189 190 /*************************************************************************/ 191 /* */ 192 /* Bzip2-compressed file support. */ 193 /* */ 194 /* FreeType now handles font files that have been compressed with the */ 195 /* `bzip2' program. This is mostly used to parse many of the PCF */ 196 /* files that come with XFree86. The implementation uses `libbz2' to */ 197 /* partially uncompress the file on the fly (see src/bzip2/ftbzip2.c). */ 198 /* Contrary to gzip, bzip2 currently is not included and need to use */ 199 /* the system available bzip2 implementation. */ 200 /* */ 201 /* Define this macro if you want to enable this `feature'. */ 202 /* */ 203/* #define FT_CONFIG_OPTION_USE_BZIP2 */ 204 205 206 /*************************************************************************/ 207 /* */ 208 /* Define to disable the use of file stream functions and types, FILE, */ 209 /* fopen() etc. Enables the use of smaller system libraries on embedded */ 210 /* systems that have multiple system libraries, some with or without */ 211 /* file stream support, in the cases where file stream support is not */ 212 /* necessary such as memory loading of font files. */ 213 /* */ 214/* #define FT_CONFIG_OPTION_DISABLE_STREAM_SUPPORT */ 215 216 217 /*************************************************************************/ 218 /* */ 219 /* PNG bitmap support. */ 220 /* */ 221 /* FreeType now handles loading color bitmap glyphs in the PNG format. */ 222 /* This requires help from the external libpng library. Uncompressed */ 223 /* color bitmaps do not need any external libraries and will be */ 224 /* supported regardless of this configuration. */ 225 /* */ 226 /* Define this macro if you want to enable this `feature'. */ 227 /* */ 228/* #define FT_CONFIG_OPTION_USE_PNG */ 229 230 231 /*************************************************************************/ 232 /* */ 233 /* DLL export compilation */ 234 /* */ 235 /* When compiling FreeType as a DLL, some systems/compilers need a */ 236 /* special keyword in front OR after the return type of function */ 237 /* declarations. */ 238 /* */ 239 /* Two macros are used within the FreeType source code to define */ 240 /* exported library functions: FT_EXPORT and FT_EXPORT_DEF. */ 241 /* */ 242 /* FT_EXPORT( return_type ) */ 243 /* */ 244 /* is used in a function declaration, as in */ 245 /* */ 246 /* FT_EXPORT( FT_Error ) */ 247 /* FT_Init_FreeType( FT_Library* alibrary ); */ 248 /* */ 249 /* */ 250 /* FT_EXPORT_DEF( return_type ) */ 251 /* */ 252 /* is used in a function definition, as in */ 253 /* */ 254 /* FT_EXPORT_DEF( FT_Error ) */ 255 /* FT_Init_FreeType( FT_Library* alibrary ) */ 256 /* { */ 257 /* ... some code ... */ 258 /* return FT_Err_Ok; */ 259 /* } */ 260 /* */ 261 /* You can provide your own implementation of FT_EXPORT and */ 262 /* FT_EXPORT_DEF here if you want. If you leave them undefined, they */ 263 /* will be later automatically defined as `extern return_type' to */ 264 /* allow normal compilation. */ 265 /* */ 266 /* Do not #undef these macros here since the build system might define */ 267 /* them for certain configurations only. */ 268 /* */ 269/* #define FT_EXPORT(x) extern x */ 270/* #define FT_EXPORT_DEF(x) x */ 271 272 273 /*************************************************************************/ 274 /* */ 275 /* Glyph Postscript Names handling */ 276 /* */ 277 /* By default, FreeType 2 is compiled with the `psnames' module. This */ 278 /* module is in charge of converting a glyph name string into a */ 279 /* Unicode value, or return a Macintosh standard glyph name for the */ 280 /* use with the TrueType `post' table. */ 281 /* */ 282 /* Undefine this macro if you do not want `psnames' compiled in your */ 283 /* build of FreeType. This has the following effects: */ 284 /* */ 285 /* - The TrueType driver will provide its own set of glyph names, */ 286 /* if you build it to support postscript names in the TrueType */ 287 /* `post' table. */ 288 /* */ 289 /* - The Type 1 driver will not be able to synthesize a Unicode */ 290 /* charmap out of the glyphs found in the fonts. */ 291 /* */ 292 /* You would normally undefine this configuration macro when building */ 293 /* a version of FreeType that doesn't contain a Type 1 or CFF driver. */ 294 /* */ 295#define FT_CONFIG_OPTION_POSTSCRIPT_NAMES 296 297 298 /*************************************************************************/ 299 /* */ 300 /* Postscript Names to Unicode Values support */ 301 /* */ 302 /* By default, FreeType 2 is built with the `PSNames' module compiled */ 303 /* in. Among other things, the module is used to convert a glyph name */ 304 /* into a Unicode value. This is especially useful in order to */ 305 /* synthesize on the fly a Unicode charmap from the CFF/Type 1 driver */ 306 /* through a big table named the `Adobe Glyph List' (AGL). */ 307 /* */ 308 /* Undefine this macro if you do not want the Adobe Glyph List */ 309 /* compiled in your `PSNames' module. The Type 1 driver will not be */ 310 /* able to synthesize a Unicode charmap out of the glyphs found in the */ 311 /* fonts. */ 312 /* */ 313#define FT_CONFIG_OPTION_ADOBE_GLYPH_LIST 314 315 316 /*************************************************************************/ 317 /* */ 318 /* Support for Mac fonts */ 319 /* */ 320 /* Define this macro if you want support for outline fonts in Mac */ 321 /* format (mac dfont, mac resource, macbinary containing a mac */ 322 /* resource) on non-Mac platforms. */ 323 /* */ 324 /* Note that the `FOND' resource isn't checked. */ 325 /* */ 326#define FT_CONFIG_OPTION_MAC_FONTS 327 328 329 /*************************************************************************/ 330 /* */ 331 /* Guessing methods to access embedded resource forks */ 332 /* */ 333 /* Enable extra Mac fonts support on non-Mac platforms (e.g. */ 334 /* GNU/Linux). */ 335 /* */ 336 /* Resource forks which include fonts data are stored sometimes in */ 337 /* locations which users or developers don't expected. In some cases, */ 338 /* resource forks start with some offset from the head of a file. In */ 339 /* other cases, the actual resource fork is stored in file different */ 340 /* from what the user specifies. If this option is activated, */ 341 /* FreeType tries to guess whether such offsets or different file */ 342 /* names must be used. */ 343 /* */ 344 /* Note that normal, direct access of resource forks is controlled via */ 345 /* the FT_CONFIG_OPTION_MAC_FONTS option. */ 346 /* */ 347#ifdef FT_CONFIG_OPTION_MAC_FONTS 348#define FT_CONFIG_OPTION_GUESSING_EMBEDDED_RFORK 349#endif 350 351 352 /*************************************************************************/ 353 /* */ 354 /* Allow the use of FT_Incremental_Interface to load typefaces that */ 355 /* contain no glyph data, but supply it via a callback function. */ 356 /* This is required by clients supporting document formats which */ 357 /* supply font data incrementally as the document is parsed, such */ 358 /* as the Ghostscript interpreter for the PostScript language. */ 359 /* */ 360/* #define FT_CONFIG_OPTION_INCREMENTAL */ 361 362 363 /*************************************************************************/ 364 /* */ 365 /* The size in bytes of the render pool used by the scan-line converter */ 366 /* to do all of its work. */ 367 /* */ 368 /* This must be greater than 4KByte if you use FreeType to rasterize */ 369 /* glyphs; otherwise, you may set it to zero to avoid unnecessary */ 370 /* allocation of the render pool. */ 371 /* */ 372#define FT_RENDER_POOL_SIZE 16384L 373 374 375 /*************************************************************************/ 376 /* */ 377 /* FT_MAX_MODULES */ 378 /* */ 379 /* The maximum number of modules that can be registered in a single */ 380 /* FreeType library object. 32 is the default. */ 381 /* */ 382#define FT_MAX_MODULES 32 383 384 385 /*************************************************************************/ 386 /* */ 387 /* Debug level */ 388 /* */ 389 /* FreeType can be compiled in debug or trace mode. In debug mode, */ 390 /* errors are reported through the `ftdebug' component. In trace */ 391 /* mode, additional messages are sent to the standard output during */ 392 /* execution. */ 393 /* */ 394 /* Define FT_DEBUG_LEVEL_ERROR to build the library in debug mode. */ 395 /* Define FT_DEBUG_LEVEL_TRACE to build it in trace mode. */ 396 /* */ 397 /* Don't define any of these macros to compile in `release' mode! */ 398 /* */ 399 /* Do not #undef these macros here since the build system might define */ 400 /* them for certain configurations only. */ 401 /* */ 402/* #define FT_DEBUG_LEVEL_ERROR */ 403/* #define FT_DEBUG_LEVEL_TRACE */ 404 405 406 /*************************************************************************/ 407 /* */ 408 /* Autofitter debugging */ 409 /* */ 410 /* If FT_DEBUG_AUTOFIT is defined, FreeType provides some means to */ 411 /* control the autofitter behaviour for debugging purposes with global */ 412 /* boolean variables (consequently, you should *never* enable this */ 413 /* while compiling in `release' mode): */ 414 /* */ 415 /* _af_debug_disable_horz_hints */ 416 /* _af_debug_disable_vert_hints */ 417 /* _af_debug_disable_blue_hints */ 418 /* */ 419 /* Additionally, the following functions provide dumps of various */ 420 /* internal autofit structures to stdout (using `printf'): */ 421 /* */ 422 /* af_glyph_hints_dump_points */ 423 /* af_glyph_hints_dump_segments */ 424 /* af_glyph_hints_dump_edges */ 425 /* */ 426 /* As an argument, they use another global variable: */ 427 /* */ 428 /* _af_debug_hints */ 429 /* */ 430 /* Please have a look at the `ftgrid' demo program to see how those */ 431 /* variables and macros should be used. */ 432 /* */ 433 /* Do not #undef these macros here since the build system might define */ 434 /* them for certain configurations only. */ 435 /* */ 436/* #define FT_DEBUG_AUTOFIT */ 437 438 439 /*************************************************************************/ 440 /* */ 441 /* Memory Debugging */ 442 /* */ 443 /* FreeType now comes with an integrated memory debugger that is */ 444 /* capable of detecting simple errors like memory leaks or double */ 445 /* deletes. To compile it within your build of the library, you */ 446 /* should define FT_DEBUG_MEMORY here. */ 447 /* */ 448 /* Note that the memory debugger is only activated at runtime when */ 449 /* when the _environment_ variable `FT2_DEBUG_MEMORY' is defined also! */ 450 /* */ 451 /* Do not #undef this macro here since the build system might define */ 452 /* it for certain configurations only. */ 453 /* */ 454/* #define FT_DEBUG_MEMORY */ 455 456 457 /*************************************************************************/ 458 /* */ 459 /* Module errors */ 460 /* */ 461 /* If this macro is set (which is _not_ the default), the higher byte */ 462 /* of an error code gives the module in which the error has occurred, */ 463 /* while the lower byte is the real error code. */ 464 /* */ 465 /* Setting this macro makes sense for debugging purposes only, since */ 466 /* it would break source compatibility of certain programs that use */ 467 /* FreeType 2. */ 468 /* */ 469 /* More details can be found in the files ftmoderr.h and fterrors.h. */ 470 /* */ 471#undef FT_CONFIG_OPTION_USE_MODULE_ERRORS 472 473 474 /*************************************************************************/ 475 /* */ 476 /* Position Independent Code */ 477 /* */ 478 /* If this macro is set (which is _not_ the default), FreeType2 will */ 479 /* avoid creating constants that require address fixups. Instead the */ 480 /* constants will be moved into a struct and additional intialization */ 481 /* code will be used. */ 482 /* */ 483 /* Setting this macro is needed for systems that prohibit address */ 484 /* fixups, such as BREW. */ 485 /* */ 486/* #define FT_CONFIG_OPTION_PIC */ 487 488 489 /*************************************************************************/ 490 /*************************************************************************/ 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 /* */ 509 /* Define TT_CONFIG_OPTION_POSTSCRIPT_NAMES if you want to be able to */ 510 /* load and enumerate the glyph Postscript names in a TrueType or */ 511 /* OpenType file. */ 512 /* */ 513 /* Note that when you do not compile the `PSNames' module by undefining */ 514 /* the above FT_CONFIG_OPTION_POSTSCRIPT_NAMES, the `sfnt' module will */ 515 /* contain additional code used to read the PS Names table from a font. */ 516 /* */ 517 /* (By default, the module uses `PSNames' to extract glyph names.) */ 518 /* */ 519#define TT_CONFIG_OPTION_POSTSCRIPT_NAMES 520 521 522 /*************************************************************************/ 523 /* */ 524 /* Define TT_CONFIG_OPTION_SFNT_NAMES if your applications need to */ 525 /* access the internal name table in a SFNT-based format like TrueType */ 526 /* or OpenType. The name table contains various strings used to */ 527 /* describe the font, like family name, copyright, version, etc. It */ 528 /* does not contain any glyph name though. */ 529 /* */ 530 /* Accessing SFNT names is done through the functions declared in */ 531 /* `freetype/ftsnames.h'. */ 532 /* */ 533#define TT_CONFIG_OPTION_SFNT_NAMES 534 535 536 /*************************************************************************/ 537 /* */ 538 /* TrueType CMap support */ 539 /* */ 540 /* Here you can fine-tune which TrueType CMap table format shall be */ 541 /* supported. */ 542#define TT_CONFIG_CMAP_FORMAT_0 543#define TT_CONFIG_CMAP_FORMAT_2 544#define TT_CONFIG_CMAP_FORMAT_4 545#define TT_CONFIG_CMAP_FORMAT_6 546#define TT_CONFIG_CMAP_FORMAT_8 547#define TT_CONFIG_CMAP_FORMAT_10 548#define TT_CONFIG_CMAP_FORMAT_12 549#define TT_CONFIG_CMAP_FORMAT_13 550#define TT_CONFIG_CMAP_FORMAT_14 551 552 553 /*************************************************************************/ 554 /*************************************************************************/ 555 /**** ****/ 556 /**** 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 ****/ 557 /**** ****/ 558 /*************************************************************************/ 559 /*************************************************************************/ 560 561 /*************************************************************************/ 562 /* */ 563 /* Define TT_CONFIG_OPTION_BYTECODE_INTERPRETER if you want to compile */ 564 /* a bytecode interpreter in the TrueType driver. */ 565 /* */ 566 /* By undefining this, you will only compile the code necessary to load */ 567 /* TrueType glyphs without hinting. */ 568 /* */ 569 /* Do not #undef this macro here, since the build system might */ 570 /* define it for certain configurations only. */ 571 /* */ 572/* #define TT_CONFIG_OPTION_BYTECODE_INTERPRETER */ 573 574 575 /*************************************************************************/ 576 /* */ 577 /* Define TT_CONFIG_OPTION_SUBPIXEL_HINTING if you want to compile */ 578 /* EXPERIMENTAL subpixel hinting support into the TrueType driver. This */ 579 /* replaces the native TrueType hinting mechanism when anything but */ 580 /* FT_RENDER_MODE_MONO is requested. */ 581 /* */ 582 /* Enabling this causes the TrueType driver to ignore instructions under */ 583 /* certain conditions. This is done in accordance with the guide here, */ 584 /* with some minor differences: */ 585 /* */ 586 /* http://www.microsoft.com/typography/cleartype/truetypecleartype.aspx */ 587 /* */ 588 /* By undefining this, you only compile the code necessary to hint */ 589 /* TrueType glyphs with native TT hinting. */ 590 /* */ 591 /* This option requires TT_CONFIG_OPTION_BYTECODE_INTERPRETER to be */ 592 /* defined. */ 593 /* */ 594/* #define TT_CONFIG_OPTION_SUBPIXEL_HINTING */ 595 596 597 /*************************************************************************/ 598 /* */ 599 /* If you define TT_CONFIG_OPTION_UNPATENTED_HINTING, a special version */ 600 /* of the TrueType bytecode interpreter is used that doesn't implement */ 601 /* any of the patented opcodes and algorithms. The patents related to */ 602 /* TrueType hinting have expired worldwide since May 2010; this option */ 603 /* is now deprecated. */ 604 /* */ 605 /* Note that the TT_CONFIG_OPTION_UNPATENTED_HINTING macro is *ignored* */ 606 /* if you define TT_CONFIG_OPTION_BYTECODE_INTERPRETER; in other words, */ 607 /* either define TT_CONFIG_OPTION_BYTECODE_INTERPRETER or */ 608 /* TT_CONFIG_OPTION_UNPATENTED_HINTING but not both at the same time. */ 609 /* */ 610 /* This macro is only useful for a small number of font files (mostly */ 611 /* for Asian scripts) that require bytecode interpretation to properly */ 612 /* load glyphs. For all other fonts, this produces unpleasant results, */ 613 /* thus the unpatented interpreter is never used to load glyphs from */ 614 /* TrueType fonts unless one of the following two options is used. */ 615 /* */ 616 /* - The unpatented interpreter is explicitly activated by the user */ 617 /* through the FT_PARAM_TAG_UNPATENTED_HINTING parameter tag */ 618 /* when opening the FT_Face. */ 619 /* */ 620 /* - FreeType detects that the FT_Face corresponds to one of the */ 621 /* `trick' fonts (e.g., `Mingliu') it knows about. The font engine */ 622 /* contains a hard-coded list of font names and other matching */ 623 /* parameters (see function `tt_face_init' in file */ 624 /* `src/truetype/ttobjs.c'). */ 625 /* */ 626 /* Here a sample code snippet for using FT_PARAM_TAG_UNPATENTED_HINTING. */ 627 /* */ 628 /* { */ 629 /* FT_Parameter parameter; */ 630 /* FT_Open_Args open_args; */ 631 /* */ 632 /* */ 633 /* parameter.tag = FT_PARAM_TAG_UNPATENTED_HINTING; */ 634 /* */ 635 /* open_args.flags = FT_OPEN_PATHNAME | FT_OPEN_PARAMS; */ 636 /* open_args.pathname = my_font_pathname; */ 637 /* open_args.num_params = 1; */ 638 /* open_args.params = ¶meter; */ 639 /* */ 640 /* error = FT_Open_Face( library, &open_args, index, &face ); */ 641 /* ... */ 642 /* } */ 643 /* */ 644#define TT_CONFIG_OPTION_UNPATENTED_HINTING 645 646 647 /*************************************************************************/ 648 /* */ 649 /* Define TT_CONFIG_OPTION_INTERPRETER_SWITCH to compile the TrueType */ 650 /* bytecode interpreter with a huge switch statement, rather than a call */ 651 /* table. This results in smaller and faster code for a number of */ 652 /* architectures. */ 653 /* */ 654 /* Note however that on some compiler/processor combinations, undefining */ 655 /* this macro will generate faster, though larger, code. */ 656 /* */ 657#define TT_CONFIG_OPTION_INTERPRETER_SWITCH 658 659 660 /*************************************************************************/ 661 /* */ 662 /* Define TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED to compile the */ 663 /* TrueType glyph loader to use Apple's definition of how to handle */ 664 /* component offsets in composite glyphs. */ 665 /* */ 666 /* Apple and MS disagree on the default behavior of component offsets */ 667 /* in composites. Apple says that they should be scaled by the scaling */ 668 /* factors in the transformation matrix (roughly, it's more complex) */ 669 /* while MS says they should not. OpenType defines two bits in the */ 670 /* composite flags array which can be used to disambiguate, but old */ 671 /* fonts will not have them. */ 672 /* */ 673 /* http://www.microsoft.com/typography/otspec/glyf.htm */ 674 /* http://fonts.apple.com/TTRefMan/RM06/Chap6glyf.html */ 675 /* */ 676#undef TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED 677 678 679 /*************************************************************************/ 680 /* */ 681 /* Define TT_CONFIG_OPTION_GX_VAR_SUPPORT if you want to include */ 682 /* support for Apple's distortable font technology (fvar, gvar, cvar, */ 683 /* and avar tables). This has many similarities to Type 1 Multiple */ 684 /* Masters support. */ 685 /* */ 686#define TT_CONFIG_OPTION_GX_VAR_SUPPORT 687 688 689 /*************************************************************************/ 690 /* */ 691 /* Define TT_CONFIG_OPTION_BDF if you want to include support for */ 692 /* an embedded `BDF ' table within SFNT-based bitmap formats. */ 693 /* */ 694#define TT_CONFIG_OPTION_BDF 695 696 697 /*************************************************************************/ 698 /*************************************************************************/ 699 /**** ****/ 700 /**** T Y P E 1 D R I V E R C O N F I G U R A T I O N ****/ 701 /**** ****/ 702 /*************************************************************************/ 703 /*************************************************************************/ 704 705 706 /*************************************************************************/ 707 /* */ 708 /* T1_MAX_DICT_DEPTH is the maximum depth of nest dictionaries and */ 709 /* arrays in the Type 1 stream (see t1load.c). A minimum of 4 is */ 710 /* required. */ 711 /* */ 712#define T1_MAX_DICT_DEPTH 5 713 714 715 /*************************************************************************/ 716 /* */ 717 /* T1_MAX_SUBRS_CALLS details the maximum number of nested sub-routine */ 718 /* calls during glyph loading. */ 719 /* */ 720#define T1_MAX_SUBRS_CALLS 16 721 722 723 /*************************************************************************/ 724 /* */ 725 /* T1_MAX_CHARSTRING_OPERANDS is the charstring stack's capacity. A */ 726 /* minimum of 16 is required. */ 727 /* */ 728 /* The Chinese font MingTiEG-Medium (CNS 11643 character set) needs 256. */ 729 /* */ 730#define T1_MAX_CHARSTRINGS_OPERANDS 256 731 732 733 /*************************************************************************/ 734 /* */ 735 /* Define this configuration macro if you want to prevent the */ 736 /* compilation of `t1afm', which is in charge of reading Type 1 AFM */ 737 /* files into an existing face. Note that if set, the T1 driver will be */ 738 /* unable to produce kerning distances. */ 739 /* */ 740#undef T1_CONFIG_OPTION_NO_AFM 741 742 743 /*************************************************************************/ 744 /* */ 745 /* Define this configuration macro if you want to prevent the */ 746 /* compilation of the Multiple Masters font support in the Type 1 */ 747 /* driver. */ 748 /* */ 749#undef T1_CONFIG_OPTION_NO_MM_SUPPORT 750 751 752 /*************************************************************************/ 753 /*************************************************************************/ 754 /**** ****/ 755 /**** C F F D R I V E R C O N F I G U R A T I O N ****/ 756 /**** ****/ 757 /*************************************************************************/ 758 /*************************************************************************/ 759 760 761 /*************************************************************************/ 762 /* */ 763 /* CFF_CONFIG_OPTION_OLD_ENGINE controls whether the pre-Adobe CFF */ 764 /* engine gets compiled into FreeType. If defined, it is possible to */ 765 /* switch between the two engines using the `hinting-engine' property of */ 766 /* the cff driver module. */ 767 /* */ 768#define CFF_CONFIG_OPTION_OLD_ENGINE 769 770 771 /*************************************************************************/ 772 /*************************************************************************/ 773 /**** ****/ 774 /**** 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 ****/ 775 /**** ****/ 776 /*************************************************************************/ 777 /*************************************************************************/ 778 779 780 /*************************************************************************/ 781 /* */ 782 /* Compile autofit module with CJK (Chinese, Japanese, Korean) script */ 783 /* support. */ 784 /* */ 785#define AF_CONFIG_OPTION_CJK 786 787 /*************************************************************************/ 788 /* */ 789 /* Compile autofit module with Indic script support. */ 790 /* */ 791#define AF_CONFIG_OPTION_INDIC 792 793 /*************************************************************************/ 794 /* */ 795 /* Compile autofit module with warp hinting. The idea of the warping */ 796 /* code is to slightly scale and shift a glyph within a single dimension */ 797 /* so that as much of its segments are aligned (more or less) on the */ 798 /* grid. To find out the optimal scaling and shifting value, various */ 799 /* parameter combinations are tried and scored. */ 800 /* */ 801 /* This experimental option is only active if the render mode is */ 802 /* FT_RENDER_MODE_LIGHT. */ 803 /* */ 804/* #define AF_CONFIG_OPTION_USE_WARPER */ 805 806 /* */ 807 808 809 /* 810 * This macro is obsolete. Support has been removed in FreeType 811 * version 2.5. 812 */ 813/* #define FT_CONFIG_OPTION_OLD_INTERNALS */ 814 815 816 /* 817 * This macro is defined if either unpatented or native TrueType 818 * hinting is requested by the definitions above. 819 */ 820#ifdef TT_CONFIG_OPTION_BYTECODE_INTERPRETER 821#define TT_USE_BYTECODE_INTERPRETER 822#undef TT_CONFIG_OPTION_UNPATENTED_HINTING 823#elif defined TT_CONFIG_OPTION_UNPATENTED_HINTING 824#define TT_USE_BYTECODE_INTERPRETER 825#endif 826 827FT_END_HEADER 828 829 830#endif /* __FTOPTION_H__ */ 831 832 833/* END */ 834