ftoption.h 51 KB

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