1/***************************************************************************/
2/*                                                                         */
3/*  ftoption.h                                                             */
4/*                                                                         */
5/*    User-selectable configuration macros (specification only).           */
6/*                                                                         */
7/*  Copyright 1996-2013 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
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/config/ftoption.h', where `$BUILD' is the     */
42  /*    name of a directory that is included _before_ the FreeType include */
43  /*    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 <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 <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 wider than   */
89  /* the original size in case this macro isn't defined; however, each     */
90  /* triplet of 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  /* 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  /*  HarfBuzz support.                                                    */
234  /*                                                                       */
235  /*   FreeType uses the HarfBuzz library to improve auto-hinting of       */
236  /*   OpenType fonts.  If available, many glyphs not directly addressable */
237  /*   by a font's character map will be hinted also.                      */
238  /*                                                                       */
239  /*   Define this macro if you want to enable this `feature'.             */
240  /*                                                                       */
241/* #define FT_CONFIG_OPTION_USE_HARFBUZZ */
242
243
244  /*************************************************************************/
245  /*                                                                       */
246  /* DLL export compilation                                                */
247  /*                                                                       */
248  /*   When compiling FreeType as a DLL, some systems/compilers need a     */
249  /*   special keyword in front OR after the return type of function       */
250  /*   declarations.                                                       */
251  /*                                                                       */
252  /*   Two macros are used within the FreeType source code to define       */
253  /*   exported library functions: FT_EXPORT and FT_EXPORT_DEF.            */
254  /*                                                                       */
255  /*     FT_EXPORT( return_type )                                          */
256  /*                                                                       */
257  /*       is used in a function declaration, as in                        */
258  /*                                                                       */
259  /*         FT_EXPORT( FT_Error )                                         */
260  /*         FT_Init_FreeType( FT_Library*  alibrary );                    */
261  /*                                                                       */
262  /*                                                                       */
263  /*     FT_EXPORT_DEF( return_type )                                      */
264  /*                                                                       */
265  /*       is used in a function definition, as in                         */
266  /*                                                                       */
267  /*         FT_EXPORT_DEF( FT_Error )                                     */
268  /*         FT_Init_FreeType( FT_Library*  alibrary )                     */
269  /*         {                                                             */
270  /*           ... some code ...                                           */
271  /*           return FT_Err_Ok;                                           */
272  /*         }                                                             */
273  /*                                                                       */
274  /*   You can provide your own implementation of FT_EXPORT and            */
275  /*   FT_EXPORT_DEF here if you want.  If you leave them undefined, they  */
276  /*   will be later automatically defined as `extern return_type' to      */
277  /*   allow normal compilation.                                           */
278  /*                                                                       */
279  /*   Do not #undef these macros here since the build system might define */
280  /*   them for certain configurations only.                               */
281  /*                                                                       */
282/* #define FT_EXPORT(x)      extern x */
283/* #define FT_EXPORT_DEF(x)  x */
284
285
286  /*************************************************************************/
287  /*                                                                       */
288  /* Glyph Postscript Names handling                                       */
289  /*                                                                       */
290  /*   By default, FreeType 2 is compiled with the `psnames' module.  This */
291  /*   module is in charge of converting a glyph name string into a        */
292  /*   Unicode value, or return a Macintosh standard glyph name for the    */
293  /*   use with the TrueType `post' table.                                 */
294  /*                                                                       */
295  /*   Undefine this macro if you do not want `psnames' compiled in your   */
296  /*   build of FreeType.  This has the following effects:                 */
297  /*                                                                       */
298  /*   - The TrueType driver will provide its own set of glyph names,      */
299  /*     if you build it to support postscript names in the TrueType       */
300  /*     `post' table.                                                     */
301  /*                                                                       */
302  /*   - The Type 1 driver will not be able to synthesize a Unicode        */
303  /*     charmap out of the glyphs found in the fonts.                     */
304  /*                                                                       */
305  /*   You would normally undefine this configuration macro when building  */
306  /*   a version of FreeType that doesn't contain a Type 1 or CFF driver.  */
307  /*                                                                       */
308#define FT_CONFIG_OPTION_POSTSCRIPT_NAMES
309
310
311  /*************************************************************************/
312  /*                                                                       */
313  /* Postscript Names to Unicode Values support                            */
314  /*                                                                       */
315  /*   By default, FreeType 2 is built with the `PSNames' module compiled  */
316  /*   in.  Among other things, the module is used to convert a glyph name */
317  /*   into a Unicode value.  This is especially useful in order to        */
318  /*   synthesize on the fly a Unicode charmap from the CFF/Type 1 driver  */
319  /*   through a big table named the `Adobe Glyph List' (AGL).             */
320  /*                                                                       */
321  /*   Undefine this macro if you do not want the Adobe Glyph List         */
322  /*   compiled in your `PSNames' module.  The Type 1 driver will not be   */
323  /*   able to synthesize a Unicode charmap out of the glyphs found in the */
324  /*   fonts.                                                              */
325  /*                                                                       */
326#define FT_CONFIG_OPTION_ADOBE_GLYPH_LIST
327
328
329  /*************************************************************************/
330  /*                                                                       */
331  /* Support for Mac fonts                                                 */
332  /*                                                                       */
333  /*   Define this macro if you want support for outline fonts in Mac      */
334  /*   format (mac dfont, mac resource, macbinary containing a mac         */
335  /*   resource) on non-Mac platforms.                                     */
336  /*                                                                       */
337  /*   Note that the `FOND' resource isn't checked.                        */
338  /*                                                                       */
339#define FT_CONFIG_OPTION_MAC_FONTS
340
341
342  /*************************************************************************/
343  /*                                                                       */
344  /* Guessing methods to access embedded resource forks                    */
345  /*                                                                       */
346  /*   Enable extra Mac fonts support on non-Mac platforms (e.g.           */
347  /*   GNU/Linux).                                                         */
348  /*                                                                       */
349  /*   Resource forks which include fonts data are stored sometimes in     */
350  /*   locations which users or developers don't expected.  In some cases, */
351  /*   resource forks start with some offset from the head of a file.  In  */
352  /*   other cases, the actual resource fork is stored in file different   */
353  /*   from what the user specifies.  If this option is activated,         */
354  /*   FreeType tries to guess whether such offsets or different file      */
355  /*   names must be used.                                                 */
356  /*                                                                       */
357  /*   Note that normal, direct access of resource forks is controlled via */
358  /*   the FT_CONFIG_OPTION_MAC_FONTS option.                              */
359  /*                                                                       */
360#ifdef FT_CONFIG_OPTION_MAC_FONTS
361#define FT_CONFIG_OPTION_GUESSING_EMBEDDED_RFORK
362#endif
363
364
365  /*************************************************************************/
366  /*                                                                       */
367  /* Allow the use of FT_Incremental_Interface to load typefaces that      */
368  /* contain no glyph data, but supply it via a callback function.         */
369  /* This is required by clients supporting document formats which         */
370  /* supply font data incrementally as the document is parsed, such        */
371  /* as the Ghostscript interpreter for the PostScript language.           */
372  /*                                                                       */
373/* #define FT_CONFIG_OPTION_INCREMENTAL */
374
375
376  /*************************************************************************/
377  /*                                                                       */
378  /* The size in bytes of the render pool used by the scan-line converter  */
379  /* to do all of its work.                                                */
380  /*                                                                       */
381  /* This must be greater than 4KByte if you use FreeType to rasterize     */
382  /* glyphs; otherwise, you may set it to zero to avoid unnecessary        */
383  /* allocation of the render pool.                                        */
384  /*                                                                       */
385#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                                         */
438  /*                                                                       */
439  /*   As an argument, they use another global variable:                   */
440  /*                                                                       */
441  /*     _af_debug_hints                                                   */
442  /*                                                                       */
443  /*   Please have a look at the `ftgrid' demo program to see how those    */
444  /*   variables and macros should be used.                                */
445  /*                                                                       */
446  /*   Do not #undef these macros here since the build system might define */
447  /*   them for certain configurations only.                               */
448  /*                                                                       */
449/* #define FT_DEBUG_AUTOFIT */
450
451
452  /*************************************************************************/
453  /*                                                                       */
454  /* Memory Debugging                                                      */
455  /*                                                                       */
456  /*   FreeType now comes with an integrated memory debugger that is       */
457  /*   capable of detecting simple errors like memory leaks or double      */
458  /*   deletes.  To compile it within your build of the library, you       */
459  /*   should define FT_DEBUG_MEMORY here.                                 */
460  /*                                                                       */
461  /*   Note that the memory debugger is only activated at runtime when     */
462  /*   when the _environment_ variable `FT2_DEBUG_MEMORY' is defined also! */
463  /*                                                                       */
464  /*   Do not #undef this macro here since the build system might define   */
465  /*   it for certain configurations only.                                 */
466  /*                                                                       */
467/* #define FT_DEBUG_MEMORY */
468
469
470  /*************************************************************************/
471  /*                                                                       */
472  /* Module errors                                                         */
473  /*                                                                       */
474  /*   If this macro is set (which is _not_ the default), the higher byte  */
475  /*   of an error code gives the module in which the error has occurred,  */
476  /*   while the lower byte is the real error code.                        */
477  /*                                                                       */
478  /*   Setting this macro makes sense for debugging purposes only, since   */
479  /*   it would break source compatibility of certain programs that use    */
480  /*   FreeType 2.                                                         */
481  /*                                                                       */
482  /*   More details can be found in the files ftmoderr.h and fterrors.h.   */
483  /*                                                                       */
484#undef FT_CONFIG_OPTION_USE_MODULE_ERRORS
485
486
487  /*************************************************************************/
488  /*                                                                       */
489  /* Position Independent Code                                             */
490  /*                                                                       */
491  /*   If this macro is set (which is _not_ the default), FreeType2 will   */
492  /*   avoid creating constants that require address fixups.  Instead the  */
493  /*   constants will be moved into a struct and additional intialization  */
494  /*   code will be used.                                                  */
495  /*                                                                       */
496  /*   Setting this macro is needed for systems that prohibit address      */
497  /*   fixups, such as BREW.                                               */
498  /*                                                                       */
499/* #define FT_CONFIG_OPTION_PIC */
500
501
502  /*************************************************************************/
503  /*************************************************************************/
504  /****                                                                 ****/
505  /****        S F N T   D R I V E R    C O N F I G U R A T I O N       ****/
506  /****                                                                 ****/
507  /*************************************************************************/
508  /*************************************************************************/
509
510
511  /*************************************************************************/
512  /*                                                                       */
513  /* Define TT_CONFIG_OPTION_EMBEDDED_BITMAPS if you want to support       */
514  /* embedded bitmaps in all formats using the SFNT module (namely         */
515  /* TrueType & OpenType).                                                 */
516  /*                                                                       */
517#define TT_CONFIG_OPTION_EMBEDDED_BITMAPS
518
519
520  /*************************************************************************/
521  /*                                                                       */
522  /* Define TT_CONFIG_OPTION_POSTSCRIPT_NAMES if you want to be able to    */
523  /* load and enumerate the glyph Postscript names in a TrueType or        */
524  /* OpenType file.                                                        */
525  /*                                                                       */
526  /* Note that when you do not compile the `PSNames' module by undefining  */
527  /* the above FT_CONFIG_OPTION_POSTSCRIPT_NAMES, the `sfnt' module will   */
528  /* contain additional code used to read the PS Names table from a font.  */
529  /*                                                                       */
530  /* (By default, the module uses `PSNames' to extract glyph names.)       */
531  /*                                                                       */
532#define TT_CONFIG_OPTION_POSTSCRIPT_NAMES
533
534
535  /*************************************************************************/
536  /*                                                                       */
537  /* Define TT_CONFIG_OPTION_SFNT_NAMES if your applications need to       */
538  /* access the internal name table in a SFNT-based format like TrueType   */
539  /* or OpenType.  The name table contains various strings used to         */
540  /* describe the font, like family name, copyright, version, etc.  It     */
541  /* does not contain any glyph name though.                               */
542  /*                                                                       */
543  /* Accessing SFNT names is done through the functions declared in        */
544  /* `ftsnames.h'.                                                         */
545  /*                                                                       */
546#define TT_CONFIG_OPTION_SFNT_NAMES
547
548
549  /*************************************************************************/
550  /*                                                                       */
551  /* TrueType CMap support                                                 */
552  /*                                                                       */
553  /*   Here you can fine-tune which TrueType CMap table format shall be    */
554  /*   supported.                                                          */
555#define TT_CONFIG_CMAP_FORMAT_0
556#define TT_CONFIG_CMAP_FORMAT_2
557#define TT_CONFIG_CMAP_FORMAT_4
558#define TT_CONFIG_CMAP_FORMAT_6
559#define TT_CONFIG_CMAP_FORMAT_8
560#define TT_CONFIG_CMAP_FORMAT_10
561#define TT_CONFIG_CMAP_FORMAT_12
562#define TT_CONFIG_CMAP_FORMAT_13
563#define TT_CONFIG_CMAP_FORMAT_14
564
565
566  /*************************************************************************/
567  /*************************************************************************/
568  /****                                                                 ****/
569  /****    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   ****/
570  /****                                                                 ****/
571  /*************************************************************************/
572  /*************************************************************************/
573
574  /*************************************************************************/
575  /*                                                                       */
576  /* Define TT_CONFIG_OPTION_BYTECODE_INTERPRETER if you want to compile   */
577  /* a bytecode interpreter in the TrueType driver.                        */
578  /*                                                                       */
579  /* By undefining this, you will only compile the code necessary to load  */
580  /* TrueType glyphs without hinting.                                      */
581  /*                                                                       */
582  /*   Do not #undef this macro here, since the build system might         */
583  /*   define it for certain configurations only.                          */
584  /*                                                                       */
585#define TT_CONFIG_OPTION_BYTECODE_INTERPRETER
586
587
588  /*************************************************************************/
589  /*                                                                       */
590  /* Define TT_CONFIG_OPTION_SUBPIXEL_HINTING if you want to compile       */
591  /* EXPERIMENTAL subpixel hinting support into the TrueType driver.  This */
592  /* replaces the native TrueType hinting mechanism when anything but      */
593  /* FT_RENDER_MODE_MONO is requested.                                     */
594  /*                                                                       */
595  /* Enabling this causes the TrueType driver to ignore instructions under */
596  /* certain conditions.  This is done in accordance with the guide here,  */
597  /* with some minor differences:                                          */
598  /*                                                                       */
599  /*  http://www.microsoft.com/typography/cleartype/truetypecleartype.aspx */
600  /*                                                                       */
601  /* By undefining this, you only compile the code necessary to hint       */
602  /* TrueType glyphs with native TT hinting.                               */
603  /*                                                                       */
604  /*   This option requires TT_CONFIG_OPTION_BYTECODE_INTERPRETER to be    */
605  /*   defined.                                                            */
606  /*                                                                       */
607/* #define TT_CONFIG_OPTION_SUBPIXEL_HINTING */
608
609
610  /*************************************************************************/
611  /*                                                                       */
612  /* If you define TT_CONFIG_OPTION_UNPATENTED_HINTING, a special version  */
613  /* of the TrueType bytecode interpreter is used that doesn't implement   */
614  /* any of the patented opcodes and algorithms.  The patents related to   */
615  /* TrueType hinting have expired worldwide since May 2010; this option   */
616  /* is now deprecated.                                                    */
617  /*                                                                       */
618  /* Note that the TT_CONFIG_OPTION_UNPATENTED_HINTING macro is *ignored*  */
619  /* if you define TT_CONFIG_OPTION_BYTECODE_INTERPRETER; in other words,  */
620  /* either define TT_CONFIG_OPTION_BYTECODE_INTERPRETER or                */
621  /* TT_CONFIG_OPTION_UNPATENTED_HINTING but not both at the same time.    */
622  /*                                                                       */
623  /* This macro is only useful for a small number of font files (mostly    */
624  /* for Asian scripts) that require bytecode interpretation to properly   */
625  /* load glyphs.  For all other fonts, this produces unpleasant results,  */
626  /* thus the unpatented interpreter is never used to load glyphs from     */
627  /* TrueType fonts unless one of the following two options is used.       */
628  /*                                                                       */
629  /*   - The unpatented interpreter is explicitly activated by the user    */
630  /*     through the FT_PARAM_TAG_UNPATENTED_HINTING parameter tag         */
631  /*     when opening the FT_Face.                                         */
632  /*                                                                       */
633  /*   - FreeType detects that the FT_Face corresponds to one of the       */
634  /*     `trick' fonts (e.g., `Mingliu') it knows about.  The font engine  */
635  /*     contains a hard-coded list of font names and other matching       */
636  /*     parameters (see function `tt_face_init' in file                   */
637  /*     `src/truetype/ttobjs.c').                                         */
638  /*                                                                       */
639  /* Here a sample code snippet for using FT_PARAM_TAG_UNPATENTED_HINTING. */
640  /*                                                                       */
641  /*   {                                                                   */
642  /*     FT_Parameter  parameter;                                          */
643  /*     FT_Open_Args  open_args;                                          */
644  /*                                                                       */
645  /*                                                                       */
646  /*     parameter.tag = FT_PARAM_TAG_UNPATENTED_HINTING;                  */
647  /*                                                                       */
648  /*     open_args.flags      = FT_OPEN_PATHNAME | FT_OPEN_PARAMS;         */
649  /*     open_args.pathname   = my_font_pathname;                          */
650  /*     open_args.num_params = 1;                                         */
651  /*     open_args.params     = &parameter;                                */
652  /*                                                                       */
653  /*     error = FT_Open_Face( library, &open_args, index, &face );        */
654  /*     ...                                                               */
655  /*   }                                                                   */
656  /*                                                                       */
657/* #define TT_CONFIG_OPTION_UNPATENTED_HINTING */
658
659
660  /*************************************************************************/
661  /*                                                                       */
662  /* Define TT_CONFIG_OPTION_INTERPRETER_SWITCH to compile the TrueType    */
663  /* bytecode interpreter with a huge switch statement, rather than a call */
664  /* table.  This results in smaller and faster code for a number of       */
665  /* architectures.                                                        */
666  /*                                                                       */
667  /* Note however that on some compiler/processor combinations, undefining */
668  /* this macro will generate faster, though larger, code.                 */
669  /*                                                                       */
670#define TT_CONFIG_OPTION_INTERPRETER_SWITCH
671
672
673  /*************************************************************************/
674  /*                                                                       */
675  /* Define TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED to compile the        */
676  /* TrueType glyph loader to use Apple's definition of how to handle      */
677  /* component offsets in composite glyphs.                                */
678  /*                                                                       */
679  /* Apple and MS disagree on the default behavior of component offsets    */
680  /* in composites.  Apple says that they should be scaled by the scaling  */
681  /* factors in the transformation matrix (roughly, it's more complex)     */
682  /* while MS says they should not.  OpenType defines two bits in the      */
683  /* composite flags array which can be used to disambiguate, but old      */
684  /* fonts will not have them.                                             */
685  /*                                                                       */
686  /*   http://www.microsoft.com/typography/otspec/glyf.htm                 */
687  /*   http://fonts.apple.com/TTRefMan/RM06/Chap6glyf.html                 */
688  /*                                                                       */
689#undef TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED
690
691
692  /*************************************************************************/
693  /*                                                                       */
694  /* Define TT_CONFIG_OPTION_GX_VAR_SUPPORT if you want to include         */
695  /* support for Apple's distortable font technology (fvar, gvar, cvar,    */
696  /* and avar tables).  This has many similarities to Type 1 Multiple      */
697  /* Masters support.                                                      */
698  /*                                                                       */
699#define TT_CONFIG_OPTION_GX_VAR_SUPPORT
700
701
702  /*************************************************************************/
703  /*                                                                       */
704  /* Define TT_CONFIG_OPTION_BDF if you want to include support for        */
705  /* an embedded `BDF ' table within SFNT-based bitmap formats.            */
706  /*                                                                       */
707#define TT_CONFIG_OPTION_BDF
708
709
710  /*************************************************************************/
711  /*************************************************************************/
712  /****                                                                 ****/
713  /****      T Y P E 1   D R I V E R    C O N F I G U R A T I O N       ****/
714  /****                                                                 ****/
715  /*************************************************************************/
716  /*************************************************************************/
717
718
719  /*************************************************************************/
720  /*                                                                       */
721  /* T1_MAX_DICT_DEPTH is the maximum depth of nest dictionaries and       */
722  /* arrays in the Type 1 stream (see t1load.c).  A minimum of 4 is        */
723  /* required.                                                             */
724  /*                                                                       */
725#define T1_MAX_DICT_DEPTH  5
726
727
728  /*************************************************************************/
729  /*                                                                       */
730  /* T1_MAX_SUBRS_CALLS details the maximum number of nested sub-routine   */
731  /* calls during glyph loading.                                           */
732  /*                                                                       */
733#define T1_MAX_SUBRS_CALLS  16
734
735
736  /*************************************************************************/
737  /*                                                                       */
738  /* T1_MAX_CHARSTRING_OPERANDS is the charstring stack's capacity.  A     */
739  /* minimum of 16 is required.                                            */
740  /*                                                                       */
741  /* The Chinese font MingTiEG-Medium (CNS 11643 character set) needs 256. */
742  /*                                                                       */
743#define T1_MAX_CHARSTRINGS_OPERANDS  256
744
745
746  /*************************************************************************/
747  /*                                                                       */
748  /* Define this configuration macro if you want to prevent the            */
749  /* compilation of `t1afm', which is in charge of reading Type 1 AFM      */
750  /* files into an existing face.  Note that if set, the T1 driver will be */
751  /* unable to produce kerning distances.                                  */
752  /*                                                                       */
753#undef T1_CONFIG_OPTION_NO_AFM
754
755
756  /*************************************************************************/
757  /*                                                                       */
758  /* Define this configuration macro if you want to prevent the            */
759  /* compilation of the Multiple Masters font support in the Type 1        */
760  /* driver.                                                               */
761  /*                                                                       */
762#undef T1_CONFIG_OPTION_NO_MM_SUPPORT
763
764
765  /*************************************************************************/
766  /*************************************************************************/
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  /*                                                                       */
776  /* CFF_CONFIG_OPTION_OLD_ENGINE controls whether the pre-Adobe CFF       */
777  /* engine gets compiled into FreeType.  If defined, it is possible to    */
778  /* switch between the two engines using the `hinting-engine' property of */
779  /* the cff driver module.                                                */
780  /*                                                                       */
781/* #define CFF_CONFIG_OPTION_OLD_ENGINE */
782
783
784  /*************************************************************************/
785  /*************************************************************************/
786  /****                                                                 ****/
787  /****    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     ****/
788  /****                                                                 ****/
789  /*************************************************************************/
790  /*************************************************************************/
791
792
793  /*************************************************************************/
794  /*                                                                       */
795  /* Compile autofit module with CJK (Chinese, Japanese, Korean) script    */
796  /* support.                                                              */
797  /*                                                                       */
798#define AF_CONFIG_OPTION_CJK
799
800  /*************************************************************************/
801  /*                                                                       */
802  /* Compile autofit module with Indic script support.                     */
803  /*                                                                       */
804#define AF_CONFIG_OPTION_INDIC
805
806  /*************************************************************************/
807  /*                                                                       */
808  /* Compile autofit module with warp hinting.  The idea of the warping    */
809  /* code is to slightly scale and shift a glyph within a single dimension */
810  /* so that as much of its segments are aligned (more or less) on the     */
811  /* grid.  To find out the optimal scaling and shifting value, various    */
812  /* parameter combinations are tried and scored.                          */
813  /*                                                                       */
814  /* This experimental option is only active if the render mode is         */
815  /* FT_RENDER_MODE_LIGHT.                                                 */
816  /*                                                                       */
817/* #define AF_CONFIG_OPTION_USE_WARPER */
818
819  /* */
820
821
822  /*
823   *  This macro is obsolete.  Support has been removed in FreeType
824   *  version 2.5.
825   */
826/* #define FT_CONFIG_OPTION_OLD_INTERNALS */
827
828
829  /*
830   * This macro is defined if either unpatented or native TrueType
831   * hinting is requested by the definitions above.
832   */
833#ifdef TT_CONFIG_OPTION_BYTECODE_INTERPRETER
834#define  TT_USE_BYTECODE_INTERPRETER
835#undef   TT_CONFIG_OPTION_UNPATENTED_HINTING
836#elif defined TT_CONFIG_OPTION_UNPATENTED_HINTING
837#define  TT_USE_BYTECODE_INTERPRETER
838#endif
839
840FT_END_HEADER
841
842
843#endif /* __FTOPTION_H__ */
844
845
846/* END */
847