projects / reactos.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Merge 25584, 25588.
[reactos.git] / reactos / dll / 3rdparty / freetype / devel / ftoption.h
1 /***************************************************************************/
2 /* */
3 /* ftoption.h (for development) */
4 /* */
5 /* User-selectable configuration macros (specification only). */
6 /* */
7 /* Copyright 1996-2001, 2002, 2003, 2004, 2005, 2006, 2007 by */
8 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
9 /* */
10 /* This file is part of the FreeType project, and may only be used, */
11 /* modified, and distributed under the terms of the FreeType project */
12 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */
13 /* this file you indicate that you have read the license and */
14 /* understand and accept it fully. */
15 /* */
16 /***************************************************************************/
17
18
19 #ifndef __FTOPTION_H__
20 #define __FTOPTION_H__
21
22
23 #include <ft2build.h>
24
25
26 FT_BEGIN_HEADER
27
28 /*************************************************************************/
29 /* */
30 /* USER-SELECTABLE CONFIGURATION MACROS */
31 /* */
32 /* This file contains the default configuration macro definitions for */
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 /* */
64 /* We highly recommend using the third method whenever possible. */
65 /* */
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
78 /*************************************************************************/
79 /* */
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. */
82 /* */
83 /* Note that this feature is covered by several Microsoft patents */
84 /* and should not be activated in any default build of the library. */
85 /* */
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. */
91 /* */
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 /* LZW-compressed file support. */
121 /* */
122 /* FreeType now handles font files that have been compressed with the */
123 /* `compress' program. This is mostly used to parse many of the PCF */
124 /* files that come with various X11 distributions. The implementation */
125 /* uses NetBSD's `zopen' to partially uncompress the file on the fly */
126 /* (see src/lzw/ftgzip.c). */
127 /* */
128 /* Define this macro if you want to enable this `feature'. */
129 /* */
130 #define FT_CONFIG_OPTION_USE_LZW
131
132
133 /*************************************************************************/
134 /* */
135 /* Gzip-compressed file support. */
136 /* */
137 /* FreeType now handles font files that have been compressed with the */
138 /* `gzip' program. This is mostly used to parse many of the PCF files */
139 /* that come with XFree86. The implementation uses `zlib' to */
140 /* partially uncompress the file on the fly (see src/gzip/ftgzip.c). */
141 /* */
142 /* Define this macro if you want to enable this `feature'. See also */
143 /* the macro FT_CONFIG_OPTION_SYSTEM_ZLIB below. */
144 /* */
145 #define FT_CONFIG_OPTION_USE_ZLIB
146
147
148 /*************************************************************************/
149 /* */
150 /* ZLib library selection */
151 /* */
152 /* This macro is only used when FT_CONFIG_OPTION_USE_ZLIB is defined. */
153 /* It allows FreeType's `ftgzip' component to link to the system's */
154 /* installation of the ZLib library. This is useful on systems like */
155 /* Unix or VMS where it generally is already available. */
156 /* */
157 /* If you let it undefined, the component will use its own copy */
158 /* of the zlib sources instead. These have been modified to be */
159 /* included directly within the component and *not* export external */
160 /* function names. This allows you to link any program with FreeType */
161 /* _and_ ZLib without linking conflicts. */
162 /* */
163 /* Do not #undef this macro here since the build system might define */
164 /* it for certain configurations only. */
165 /* */
166 /* #define FT_CONFIG_OPTION_SYSTEM_ZLIB */
167
168
169 /*************************************************************************/
170 /* */
171 /* DLL export compilation */
172 /* */
173 /* When compiling FreeType as a DLL, some systems/compilers need a */
174 /* special keyword in front OR after the return type of function */
175 /* declarations. */
176 /* */
177 /* Two macros are used within the FreeType source code to define */
178 /* exported library functions: FT_EXPORT and FT_EXPORT_DEF. */
179 /* */
180 /* FT_EXPORT( return_type ) */
181 /* */
182 /* is used in a function declaration, as in */
183 /* */
184 /* FT_EXPORT( FT_Error ) */
185 /* FT_Init_FreeType( FT_Library* alibrary ); */
186 /* */
187 /* */
188 /* FT_EXPORT_DEF( return_type ) */
189 /* */
190 /* is used in a function definition, as in */
191 /* */
192 /* FT_EXPORT_DEF( FT_Error ) */
193 /* FT_Init_FreeType( FT_Library* alibrary ) */
194 /* { */
195 /* ... some code ... */
196 /* return FT_Err_Ok; */
197 /* } */
198 /* */
199 /* You can provide your own implementation of FT_EXPORT and */
200 /* FT_EXPORT_DEF here if you want. If you leave them undefined, they */
201 /* will be later automatically defined as `extern return_type' to */
202 /* allow normal compilation. */
203 /* */
204 /* Do not #undef these macros here since the build system might define */
205 /* them for certain configurations only. */
206 /* */
207 /* #define FT_EXPORT(x) extern x */
208 /* #define FT_EXPORT_DEF(x) x */
209
210
211 /*************************************************************************/
212 /* */
213 /* Glyph Postscript Names handling */
214 /* */
215 /* By default, FreeType 2 is compiled with the `PSNames' module. This */
216 /* module is in charge of converting a glyph name string into a */
217 /* Unicode value, or return a Macintosh standard glyph name for the */
218 /* use with the TrueType `post' table. */
219 /* */
220 /* Undefine this macro if you do not want `PSNames' compiled in your */
221 /* build of FreeType. This has the following effects: */
222 /* */
223 /* - The TrueType driver will provide its own set of glyph names, */
224 /* if you build it to support postscript names in the TrueType */
225 /* `post' table. */
226 /* */
227 /* - The Type 1 driver will not be able to synthetize a Unicode */
228 /* charmap out of the glyphs found in the fonts. */
229 /* */
230 /* You would normally undefine this configuration macro when building */
231 /* a version of FreeType that doesn't contain a Type 1 or CFF driver. */
232 /* */
233 #define FT_CONFIG_OPTION_POSTSCRIPT_NAMES
234
235
236 /*************************************************************************/
237 /* */
238 /* Postscript Names to Unicode Values support */
239 /* */
240 /* By default, FreeType 2 is built with the `PSNames' module compiled */
241 /* in. Among other things, the module is used to convert a glyph name */
242 /* into a Unicode value. This is especially useful in order to */
243 /* synthetize on the fly a Unicode charmap from the CFF/Type 1 driver */
244 /* through a big table named the `Adobe Glyph List' (AGL). */
245 /* */
246 /* Undefine this macro if you do not want the Adobe Glyph List */
247 /* compiled in your `PSNames' module. The Type 1 driver will not be */
248 /* able to synthetize a Unicode charmap out of the glyphs found in the */
249 /* fonts. */
250 /* */
251 #define FT_CONFIG_OPTION_ADOBE_GLYPH_LIST
252
253
254 /*************************************************************************/
255 /* */
256 /* Support for Mac fonts */
257 /* */
258 /* Define this macro if you want support for outline fonts in Mac */
259 /* format (mac dfont, mac resource, macbinary containing a mac */
260 /* resource) on non-Mac platforms. */
261 /* */
262 /* Note that the `FOND' resource isn't checked. */
263 /* */
264 #define FT_CONFIG_OPTION_MAC_FONTS
265
266
267 /*************************************************************************/
268 /* */
269 /* Guessing methods to access embedded resource forks */
270 /* */
271 /* Enable extra Mac fonts support on non-Mac platforms (e.g. */
272 /* GNU/Linux). */
273 /* */
274 /* Resource forks which include fonts data are stored sometimes in */
275 /* locations which users or developers don't expected. In some cases, */
276 /* resource forks start with some offset from the head of a file. In */
277 /* other cases, the actual resource fork is stored in file different */
278 /* from what the user specifies. If this option is activated, */
279 /* FreeType tries to guess whether such offsets or different file */
280 /* names must be used. */
281 /* */
282 /* Note that normal, direct access of resource forks is controlled via */
283 /* the FT_CONFIG_OPTION_MAC_FONTS option. */
284 /* */
285 #ifdef FT_CONFIG_OPTION_MAC_FONTS
286 #define FT_CONFIG_OPTION_GUESSING_EMBEDDED_RFORK
287 #endif
288
289
290 /*************************************************************************/
291 /* */
292 /* Allow the use of FT_Incremental_Interface to load typefaces that */
293 /* contain no glyph data, but supply it via a callback function. */
294 /* This allows FreeType to be used with the PostScript language, using */
295 /* the GhostScript interpreter. */
296 /* */
297 /* #define FT_CONFIG_OPTION_INCREMENTAL */
298
299
300 /*************************************************************************/
301 /* */
302 /* The size in bytes of the render pool used by the scan-line converter */
303 /* to do all of its work. */
304 /* */
305 /* This must be greater than 4KByte. */
306 /* */
307 #define FT_RENDER_POOL_SIZE 16384L
308
309
310 /*************************************************************************/
311 /* */
312 /* FT_MAX_MODULES */
313 /* */
314 /* The maximum number of modules that can be registered in a single */
315 /* FreeType library object. 32 is the default. */
316 /* */
317 #define FT_MAX_MODULES 32
318
319
320 /*************************************************************************/
321 /* */
322 /* Debug level */
323 /* */
324 /* FreeType can be compiled in debug or trace mode. In debug mode, */
325 /* errors are reported through the `ftdebug' component. In trace */
326 /* mode, additional messages are sent to the standard output during */
327 /* execution. */
328 /* */
329 /* Define FT_DEBUG_LEVEL_ERROR to build the library in debug mode. */
330 /* Define FT_DEBUG_LEVEL_TRACE to build it in trace mode. */
331 /* */
332 /* Don't define any of these macros to compile in `release' mode! */
333 /* */
334 /* Do not #undef these macros here since the build system might define */
335 /* them for certain configurations only. */
336 /* */
337 #define FT_DEBUG_LEVEL_ERROR
338 #define FT_DEBUG_LEVEL_TRACE
339
340
341 /*************************************************************************/
342 /* */
343 /* Memory Debugging */
344 /* */
345 /* FreeType now comes with an integrated memory debugger that is */
346 /* capable of detecting simple errors like memory leaks or double */
347 /* deletes. To compile it within your build of the library, you */
348 /* should define FT_DEBUG_MEMORY here. */
349 /* */
350 /* Note that the memory debugger is only activated at runtime when */
351 /* when the _environment_ variable `FT2_DEBUG_MEMORY' is defined also! */
352 /* */
353 /* Do not #undef this macro here since the build system might define */
354 /* it for certain configurations only. */
355 /* */
356 #define FT_DEBUG_MEMORY
357
358
359 /*************************************************************************/
360 /* */
361 /* Module errors */
362 /* */
363 /* If this macro is set (which is _not_ the default), the higher byte */
364 /* of an error code gives the module in which the error has occurred, */
365 /* while the lower byte is the real error code. */
366 /* */
367 /* Setting this macro makes sense for debugging purposes only, since */
368 /* it would break source compatibility of certain programs that use */
369 /* FreeType 2. */
370 /* */
371 /* More details can be found in the files ftmoderr.h and fterrors.h. */
372 /* */
373 #undef FT_CONFIG_OPTION_USE_MODULE_ERRORS
374
375
376
377 /*************************************************************************/
378 /*************************************************************************/
379 /**** ****/
380 /**** S F N T D R I V E R C O N F I G U R A T I O N ****/
381 /**** ****/
382 /*************************************************************************/
383 /*************************************************************************/
384
385
386 /*************************************************************************/
387 /* */
388 /* Define TT_CONFIG_OPTION_EMBEDDED_BITMAPS if you want to support */
389 /* embedded bitmaps in all formats using the SFNT module (namely */
390 /* TrueType & OpenType). */
391 /* */
392 #define TT_CONFIG_OPTION_EMBEDDED_BITMAPS
393
394
395 /*************************************************************************/
396 /* */
397 /* Define TT_CONFIG_OPTION_POSTSCRIPT_NAMES if you want to be able to */
398 /* load and enumerate the glyph Postscript names in a TrueType or */
399 /* OpenType file. */
400 /* */
401 /* Note that when you do not compile the `PSNames' module by undefining */
402 /* the above FT_CONFIG_OPTION_POSTSCRIPT_NAMES, the `sfnt' module will */
403 /* contain additional code used to read the PS Names table from a font. */
404 /* */
405 /* (By default, the module uses `PSNames' to extract glyph names.) */
406 /* */
407 #define TT_CONFIG_OPTION_POSTSCRIPT_NAMES
408
409
410 /*************************************************************************/
411 /* */
412 /* Define TT_CONFIG_OPTION_SFNT_NAMES if your applications need to */
413 /* access the internal name table in a SFNT-based format like TrueType */
414 /* or OpenType. The name table contains various strings used to */
415 /* describe the font, like family name, copyright, version, etc. It */
416 /* does not contain any glyph name though. */
417 /* */
418 /* Accessing SFNT names is done through the functions declared in */
419 /* `freetype/ftnames.h'. */
420 /* */
421 #define TT_CONFIG_OPTION_SFNT_NAMES
422
423
424 /*************************************************************************/
425 /* */
426 /* TrueType CMap support */
427 /* */
428 /* Here you can fine-tune which TrueType CMap table format shall be */
429 /* supported. */
430 #define TT_CONFIG_CMAP_FORMAT_0
431 #define TT_CONFIG_CMAP_FORMAT_2
432 #define TT_CONFIG_CMAP_FORMAT_4
433 #define TT_CONFIG_CMAP_FORMAT_6
434 #define TT_CONFIG_CMAP_FORMAT_8
435 #define TT_CONFIG_CMAP_FORMAT_10
436 #define TT_CONFIG_CMAP_FORMAT_12
437
438
439 /*************************************************************************/
440 /*************************************************************************/
441 /**** ****/
442 /**** 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 ****/
443 /**** ****/
444 /*************************************************************************/
445 /*************************************************************************/
446
447 /*************************************************************************/
448 /* */
449 /* Define TT_CONFIG_OPTION_BYTECODE_INTERPRETER if you want to compile */
450 /* a bytecode interpreter in the TrueType driver. Note that there are */
451 /* important patent issues related to the use of the interpreter. */
452 /* */
453 /* By undefining this, you will only compile the code necessary to load */
454 /* TrueType glyphs without hinting. */
455 /* */
456 /* Do not #undef this macro here, since the build system might */
457 /* define it for certain configurations only. */
458 /* */
459 /* #define TT_CONFIG_OPTION_BYTECODE_INTERPRETER */
460
461
462 /*************************************************************************/
463 /* */
464 /* Define TT_CONFIG_OPTION_UNPATENTED_HINTING (in addition to */
465 /* TT_CONFIG_OPTION_BYTECODE_INTERPRETER) to compile the unpatented */
466 /* work-around hinting system. Note that for the moment, the algorithm */
467 /* is only used when selected at runtime through the parameter tag */
468 /* FT_PARAM_TAG_UNPATENTED_HINTING; or when the debug hook */
469 /* FT_DEBUG_HOOK_UNPATENTED_HINTING is globally activated. */
470 /* */
471 /* #define TT_CONFIG_OPTION_UNPATENTED_HINTING */
472
473
474 /*************************************************************************/
475 /* */
476 /* Define TT_CONFIG_OPTION_INTERPRETER_SWITCH to compile the TrueType */
477 /* bytecode interpreter with a huge switch statement, rather than a call */
478 /* table. This results in smaller and faster code for a number of */
479 /* architectures. */
480 /* */
481 /* Note however that on some compiler/processor combinations, undefining */
482 /* this macro will generate faster, though larger, code. */
483 /* */
484 #define TT_CONFIG_OPTION_INTERPRETER_SWITCH
485
486
487 /*************************************************************************/
488 /* */
489 /* Define TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED to compile the */
490 /* TrueType glyph loader to use Apple's definition of how to handle */
491 /* component offsets in composite glyphs. */
492 /* */
493 /* Apple and MS disagree on the default behavior of component offsets */
494 /* in composites. Apple says that they should be scaled by the scaling */
495 /* factors in the transformation matrix (roughly, it's more complex) */
496 /* while MS says they should not. OpenType defines two bits in the */
497 /* composite flags array which can be used to disambiguate, but old */
498 /* fonts will not have them. */
499 /* */
500 /* http://partners.adobe.com/asn/developer/opentype/glyf.html */
501 /* http://fonts.apple.com/TTRefMan/RM06/Chap6glyf.html */
502 /* */
503 #undef TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED
504
505
506 /*************************************************************************/
507 /* */
508 /* Define TT_CONFIG_OPTION_GX_VAR_SUPPORT if you want to include */
509 /* support for Apple's distortable font technology (fvar, gvar, cvar, */
510 /* and avar tables). This has many similarities to Type 1 Multiple */
511 /* Masters support. */
512 /* */
513 #define TT_CONFIG_OPTION_GX_VAR_SUPPORT
514
515
516 /*************************************************************************/
517 /* */
518 /* Define TT_CONFIG_OPTION_BDF if you want to include support for */
519 /* an embedded `BDF ' table within SFNT-based bitmap formats. */
520 /* */
521 #define TT_CONFIG_OPTION_BDF
522
523
524 /*************************************************************************/
525 /*************************************************************************/
526 /**** ****/
527 /**** T Y P E 1 D R I V E R C O N F I G U R A T I O N ****/
528 /**** ****/
529 /*************************************************************************/
530 /*************************************************************************/
531
532
533 /*************************************************************************/
534 /* */
535 /* T1_MAX_DICT_DEPTH is the maximal depth of nest dictionaries and */
536 /* arrays in the Type 1 stream (see t1load.c). A minimum of 4 is */
537 /* required. */
538 /* */
539 #define T1_MAX_DICT_DEPTH 5
540
541
542 /*************************************************************************/
543 /* */
544 /* T1_MAX_SUBRS_CALLS details the maximum number of nested sub-routine */
545 /* calls during glyph loading. */
546 /* */
547 #define T1_MAX_SUBRS_CALLS 16
548
549
550 /*************************************************************************/
551 /* */
552 /* T1_MAX_CHARSTRING_OPERANDS is the charstring stack's capacity. A */
553 /* minimum of 16 is required. */
554 /* */
555 /* The Chinese font MingTiEG-Medium (CNS 11643 character set) needs 256. */
556 /* */
557 #define T1_MAX_CHARSTRINGS_OPERANDS 256
558
559
560 /*************************************************************************/
561 /* */
562 /* Define this configuration macro if you want to prevent the */
563 /* compilation of `t1afm', which is in charge of reading Type 1 AFM */
564 /* files into an existing face. Note that if set, the T1 driver will be */
565 /* unable to produce kerning distances. */
566 /* */
567 #undef T1_CONFIG_OPTION_NO_AFM
568
569
570 /*************************************************************************/
571 /* */
572 /* Define this configuration macro if you want to prevent the */
573 /* compilation of the Multiple Masters font support in the Type 1 */
574 /* driver. */
575 /* */
576 #undef T1_CONFIG_OPTION_NO_MM_SUPPORT
577
578
579 /*************************************************************************/
580 /*************************************************************************/
581 /**** ****/
582 /**** 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 ****/
583 /**** ****/
584 /*************************************************************************/
585 /*************************************************************************/
586
587
588 /*************************************************************************/
589 /* */
590 /* Compile autofit module with CJK script support. */
591 /* */
592 #define AF_CONFIG_OPTION_CJK
593
594
595 /* */
596
597
598 /*
599 * Define this variable if you want to keep the layout of internal
600 * structures that was used prior to FreeType 2.2. This also compiles in
601 * a few obsolete functions to avoid linking problems on typical Unix
602 * distributions.
603 *
604 * For embedded systems or building a new distribution from scratch, it
605 * is recommended to disable the macro since it reduces the library's code
606 * size and activates a few memory-saving optimizations as well.
607 */
608 #undef FT_CONFIG_OPTION_OLD_INTERNALS
609
610
611 /*
612 * This variable is defined if either unpatented or native TrueType
613 * hinting is requested by the definitions above.
614 */
615 #ifdef TT_CONFIG_OPTION_BYTECODE_INTERPRETER
616 #define TT_USE_BYTECODE_INTERPRETER
617 #elif defined TT_CONFIG_OPTION_UNPATENTED_HINTING
618 #define TT_USE_BYTECODE_INTERPRETER
619 #endif
620
621 FT_END_HEADER
622
623
624 #endif /* __FTOPTION_H__ */
625
626
627 /* END */
A free Windows-compatible Operating System