ftoption.h 55 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904
  1. /***************************************************************************/
  2. /* */
  3. /* ftoption.h (for development) */
  4. /* */
  5. /* User-selectable configuration macros (specification only). */
  6. /* */
  7. /* Copyright 1996-2015 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. /* PNG bitmap support. */
  191. /* */
  192. /* FreeType now handles loading color bitmap glyphs in the PNG format. */
  193. /* This requires help from the external libpng library. Uncompressed */
  194. /* color bitmaps do not need any external libraries and will be */
  195. /* supported regardless of this configuration. */
  196. /* */
  197. /* Define this macro if you want to enable this `feature'. */
  198. /* */
  199. #define FT_CONFIG_OPTION_USE_PNG
  200. /*************************************************************************/
  201. /* */
  202. /* HarfBuzz support. */
  203. /* */
  204. /* FreeType uses the HarfBuzz library to improve auto-hinting of */
  205. /* OpenType fonts. If available, many glyphs not directly addressable */
  206. /* by a font's character map will be hinted also. */
  207. /* */
  208. /* Define this macro if you want to enable this `feature'. */
  209. /* */
  210. #define FT_CONFIG_OPTION_USE_HARFBUZZ
  211. /*************************************************************************/
  212. /* */
  213. /* DLL export compilation */
  214. /* */
  215. /* When compiling FreeType as a DLL, some systems/compilers need a */
  216. /* special keyword in front OR after the return type of function */
  217. /* declarations. */
  218. /* */
  219. /* Two macros are used within the FreeType source code to define */
  220. /* exported library functions: FT_EXPORT and FT_EXPORT_DEF. */
  221. /* */
  222. /* FT_EXPORT( return_type ) */
  223. /* */
  224. /* is used in a function declaration, as in */
  225. /* */
  226. /* FT_EXPORT( FT_Error ) */
  227. /* FT_Init_FreeType( FT_Library* alibrary ); */
  228. /* */
  229. /* */
  230. /* FT_EXPORT_DEF( return_type ) */
  231. /* */
  232. /* is used in a function definition, as in */
  233. /* */
  234. /* FT_EXPORT_DEF( FT_Error ) */
  235. /* FT_Init_FreeType( FT_Library* alibrary ) */
  236. /* { */
  237. /* ... some code ... */
  238. /* return FT_Err_Ok; */
  239. /* } */
  240. /* */
  241. /* You can provide your own implementation of FT_EXPORT and */
  242. /* FT_EXPORT_DEF here if you want. If you leave them undefined, they */
  243. /* will be later automatically defined as `extern return_type' to */
  244. /* allow normal compilation. */
  245. /* */
  246. /* Do not #undef these macros here since the build system might define */
  247. /* them for certain configurations only. */
  248. /* */
  249. /* #define FT_EXPORT(x) extern x */
  250. /* #define FT_EXPORT_DEF(x) x */
  251. /*************************************************************************/
  252. /* */
  253. /* Glyph Postscript Names handling */
  254. /* */
  255. /* By default, FreeType 2 is compiled with the `psnames' module. This */
  256. /* module is in charge of converting a glyph name string into a */
  257. /* Unicode value, or return a Macintosh standard glyph name for the */
  258. /* use with the TrueType `post' table. */
  259. /* */
  260. /* Undefine this macro if you do not want `psnames' compiled in your */
  261. /* build of FreeType. This has the following effects: */
  262. /* */
  263. /* - The TrueType driver will provide its own set of glyph names, */
  264. /* if you build it to support postscript names in the TrueType */
  265. /* `post' table. */
  266. /* */
  267. /* - The Type 1 driver will not be able to synthesize a Unicode */
  268. /* charmap out of the glyphs found in the fonts. */
  269. /* */
  270. /* You would normally undefine this configuration macro when building */
  271. /* a version of FreeType that doesn't contain a Type 1 or CFF driver. */
  272. /* */
  273. #define FT_CONFIG_OPTION_POSTSCRIPT_NAMES
  274. /*************************************************************************/
  275. /* */
  276. /* Postscript Names to Unicode Values support */
  277. /* */
  278. /* By default, FreeType 2 is built with the `PSNames' module compiled */
  279. /* in. Among other things, the module is used to convert a glyph name */
  280. /* into a Unicode value. This is especially useful in order to */
  281. /* synthesize on the fly a Unicode charmap from the CFF/Type 1 driver */
  282. /* through a big table named the `Adobe Glyph List' (AGL). */
  283. /* */
  284. /* Undefine this macro if you do not want the Adobe Glyph List */
  285. /* compiled in your `PSNames' module. The Type 1 driver will not be */
  286. /* able to synthesize a Unicode charmap out of the glyphs found in the */
  287. /* fonts. */
  288. /* */
  289. #define FT_CONFIG_OPTION_ADOBE_GLYPH_LIST
  290. /*************************************************************************/
  291. /* */
  292. /* Support for Mac fonts */
  293. /* */
  294. /* Define this macro if you want support for outline fonts in Mac */
  295. /* format (mac dfont, mac resource, macbinary containing a mac */
  296. /* resource) on non-Mac platforms. */
  297. /* */
  298. /* Note that the `FOND' resource isn't checked. */
  299. /* */
  300. #define FT_CONFIG_OPTION_MAC_FONTS
  301. /*************************************************************************/
  302. /* */
  303. /* Guessing methods to access embedded resource forks */
  304. /* */
  305. /* Enable extra Mac fonts support on non-Mac platforms (e.g. */
  306. /* GNU/Linux). */
  307. /* */
  308. /* Resource forks which include fonts data are stored sometimes in */
  309. /* locations which users or developers don't expected. In some cases, */
  310. /* resource forks start with some offset from the head of a file. In */
  311. /* other cases, the actual resource fork is stored in file different */
  312. /* from what the user specifies. If this option is activated, */
  313. /* FreeType tries to guess whether such offsets or different file */
  314. /* names must be used. */
  315. /* */
  316. /* Note that normal, direct access of resource forks is controlled via */
  317. /* the FT_CONFIG_OPTION_MAC_FONTS option. */
  318. /* */
  319. #ifdef FT_CONFIG_OPTION_MAC_FONTS
  320. #define FT_CONFIG_OPTION_GUESSING_EMBEDDED_RFORK
  321. #endif
  322. /*************************************************************************/
  323. /* */
  324. /* Allow the use of FT_Incremental_Interface to load typefaces that */
  325. /* contain no glyph data, but supply it via a callback function. */
  326. /* This is required by clients supporting document formats which */
  327. /* supply font data incrementally as the document is parsed, such */
  328. /* as the Ghostscript interpreter for the PostScript language. */
  329. /* */
  330. #define FT_CONFIG_OPTION_INCREMENTAL
  331. /*************************************************************************/
  332. /* */
  333. /* The size in bytes of the render pool used by the scan-line converter */
  334. /* to do all of its work. */
  335. /* */
  336. #define FT_RENDER_POOL_SIZE 16384L
  337. /*************************************************************************/
  338. /* */
  339. /* FT_MAX_MODULES */
  340. /* */
  341. /* The maximum number of modules that can be registered in a single */
  342. /* FreeType library object. 32 is the default. */
  343. /* */
  344. #define FT_MAX_MODULES 32
  345. /*************************************************************************/
  346. /* */
  347. /* Debug level */
  348. /* */
  349. /* FreeType can be compiled in debug or trace mode. In debug mode, */
  350. /* errors are reported through the `ftdebug' component. In trace */
  351. /* mode, additional messages are sent to the standard output during */
  352. /* execution. */
  353. /* */
  354. /* Define FT_DEBUG_LEVEL_ERROR to build the library in debug mode. */
  355. /* Define FT_DEBUG_LEVEL_TRACE to build it in trace mode. */
  356. /* */
  357. /* Don't define any of these macros to compile in `release' mode! */
  358. /* */
  359. /* Do not #undef these macros here since the build system might define */
  360. /* them for certain configurations only. */
  361. /* */
  362. #define FT_DEBUG_LEVEL_ERROR
  363. #define FT_DEBUG_LEVEL_TRACE
  364. /*************************************************************************/
  365. /* */
  366. /* Autofitter debugging */
  367. /* */
  368. /* If FT_DEBUG_AUTOFIT is defined, FreeType provides some means to */
  369. /* control the autofitter behaviour for debugging purposes with global */
  370. /* boolean variables (consequently, you should *never* enable this */
  371. /* while compiling in `release' mode): */
  372. /* */
  373. /* _af_debug_disable_horz_hints */
  374. /* _af_debug_disable_vert_hints */
  375. /* _af_debug_disable_blue_hints */
  376. /* */
  377. /* Additionally, the following functions provide dumps of various */
  378. /* internal autofit structures to stdout (using `printf'): */
  379. /* */
  380. /* af_glyph_hints_dump_points */
  381. /* af_glyph_hints_dump_segments */
  382. /* af_glyph_hints_dump_edges */
  383. /* af_glyph_hints_get_num_segments */
  384. /* af_glyph_hints_get_segment_offset */
  385. /* */
  386. /* As an argument, they use another global variable: */
  387. /* */
  388. /* _af_debug_hints */
  389. /* */
  390. /* Please have a look at the `ftgrid' demo program to see how those */
  391. /* variables and macros should be used. */
  392. /* */
  393. /* Do not #undef these macros here since the build system might define */
  394. /* them for certain configurations only. */
  395. /* */
  396. #define FT_DEBUG_AUTOFIT
  397. /*************************************************************************/
  398. /* */
  399. /* Memory Debugging */
  400. /* */
  401. /* FreeType now comes with an integrated memory debugger that is */
  402. /* capable of detecting simple errors like memory leaks or double */
  403. /* deletes. To compile it within your build of the library, you */
  404. /* should define FT_DEBUG_MEMORY here. */
  405. /* */
  406. /* Note that the memory debugger is only activated at runtime when */
  407. /* when the _environment_ variable `FT2_DEBUG_MEMORY' is defined also! */
  408. /* */
  409. /* Do not #undef this macro here since the build system might define */
  410. /* it for certain configurations only. */
  411. /* */
  412. #define FT_DEBUG_MEMORY
  413. /*************************************************************************/
  414. /* */
  415. /* Module errors */
  416. /* */
  417. /* If this macro is set (which is _not_ the default), the higher byte */
  418. /* of an error code gives the module in which the error has occurred, */
  419. /* while the lower byte is the real error code. */
  420. /* */
  421. /* Setting this macro makes sense for debugging purposes only, since */
  422. /* it would break source compatibility of certain programs that use */
  423. /* FreeType 2. */
  424. /* */
  425. /* More details can be found in the files ftmoderr.h and fterrors.h. */
  426. /* */
  427. #undef FT_CONFIG_OPTION_USE_MODULE_ERRORS
  428. /*************************************************************************/
  429. /* */
  430. /* Position Independent Code */
  431. /* */
  432. /* If this macro is set (which is _not_ the default), FreeType2 will */
  433. /* avoid creating constants that require address fixups. Instead the */
  434. /* constants will be moved into a struct and additional intialization */
  435. /* code will be used. */
  436. /* */
  437. /* Setting this macro is needed for systems that prohibit address */
  438. /* fixups, such as BREW. */
  439. /* */
  440. /* #define FT_CONFIG_OPTION_PIC */
  441. /*************************************************************************/
  442. /*************************************************************************/
  443. /**** ****/
  444. /**** S F N T D R I V E R C O N F I G U R A T I O N ****/
  445. /**** ****/
  446. /*************************************************************************/
  447. /*************************************************************************/
  448. /*************************************************************************/
  449. /* */
  450. /* Define TT_CONFIG_OPTION_EMBEDDED_BITMAPS if you want to support */
  451. /* embedded bitmaps in all formats using the SFNT module (namely */
  452. /* TrueType & OpenType). */
  453. /* */
  454. #define TT_CONFIG_OPTION_EMBEDDED_BITMAPS
  455. /*************************************************************************/
  456. /* */
  457. /* Define TT_CONFIG_OPTION_POSTSCRIPT_NAMES if you want to be able to */
  458. /* load and enumerate the glyph Postscript names in a TrueType or */
  459. /* OpenType file. */
  460. /* */
  461. /* Note that when you do not compile the `PSNames' module by undefining */
  462. /* the above FT_CONFIG_OPTION_POSTSCRIPT_NAMES, the `sfnt' module will */
  463. /* contain additional code used to read the PS Names table from a font. */
  464. /* */
  465. /* (By default, the module uses `PSNames' to extract glyph names.) */
  466. /* */
  467. #define TT_CONFIG_OPTION_POSTSCRIPT_NAMES
  468. /*************************************************************************/
  469. /* */
  470. /* Define TT_CONFIG_OPTION_SFNT_NAMES if your applications need to */
  471. /* access the internal name table in a SFNT-based format like TrueType */
  472. /* or OpenType. The name table contains various strings used to */
  473. /* describe the font, like family name, copyright, version, etc. It */
  474. /* does not contain any glyph name though. */
  475. /* */
  476. /* Accessing SFNT names is done through the functions declared in */
  477. /* `ftsnames.h'. */
  478. /* */
  479. #define TT_CONFIG_OPTION_SFNT_NAMES
  480. /*************************************************************************/
  481. /* */
  482. /* TrueType CMap support */
  483. /* */
  484. /* Here you can fine-tune which TrueType CMap table format shall be */
  485. /* supported. */
  486. #define TT_CONFIG_CMAP_FORMAT_0
  487. #define TT_CONFIG_CMAP_FORMAT_2
  488. #define TT_CONFIG_CMAP_FORMAT_4
  489. #define TT_CONFIG_CMAP_FORMAT_6
  490. #define TT_CONFIG_CMAP_FORMAT_8
  491. #define TT_CONFIG_CMAP_FORMAT_10
  492. #define TT_CONFIG_CMAP_FORMAT_12
  493. #define TT_CONFIG_CMAP_FORMAT_13
  494. #define TT_CONFIG_CMAP_FORMAT_14
  495. /*************************************************************************/
  496. /*************************************************************************/
  497. /**** ****/
  498. /**** 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 ****/
  499. /**** ****/
  500. /*************************************************************************/
  501. /*************************************************************************/
  502. /*************************************************************************/
  503. /* */
  504. /* Define TT_CONFIG_OPTION_BYTECODE_INTERPRETER if you want to compile */
  505. /* a bytecode interpreter in the TrueType driver. */
  506. /* */
  507. /* By undefining this, you will only compile the code necessary to load */
  508. /* TrueType glyphs without hinting. */
  509. /* */
  510. /* Do not #undef this macro here, since the build system might */
  511. /* define it for certain configurations only. */
  512. /* */
  513. #define TT_CONFIG_OPTION_BYTECODE_INTERPRETER
  514. /*************************************************************************/
  515. /* */
  516. /* Define TT_CONFIG_OPTION_SUBPIXEL_HINTING if you want to compile */
  517. /* EXPERIMENTAL subpixel hinting support into the TrueType driver. This */
  518. /* replaces the native TrueType hinting mechanism when anything but */
  519. /* FT_RENDER_MODE_MONO is requested. */
  520. /* */
  521. /* Enabling this causes the TrueType driver to ignore instructions under */
  522. /* certain conditions. This is done in accordance with the guide here, */
  523. /* with some minor differences: */
  524. /* */
  525. /* http://www.microsoft.com/typography/cleartype/truetypecleartype.aspx */
  526. /* */
  527. /* By undefining this, you only compile the code necessary to hint */
  528. /* TrueType glyphs with native TT hinting. */
  529. /* */
  530. /* This option requires TT_CONFIG_OPTION_BYTECODE_INTERPRETER to be */
  531. /* defined. */
  532. /* */
  533. #define TT_CONFIG_OPTION_SUBPIXEL_HINTING
  534. /*************************************************************************/
  535. /* */
  536. /* If you define TT_CONFIG_OPTION_UNPATENTED_HINTING, a special version */
  537. /* of the TrueType bytecode interpreter is used that doesn't implement */
  538. /* any of the patented opcodes and algorithms. The patents related to */
  539. /* TrueType hinting have expired worldwide since May 2010; this option */
  540. /* is now deprecated. */
  541. /* */
  542. /* Note that the TT_CONFIG_OPTION_UNPATENTED_HINTING macro is *ignored* */
  543. /* if you define TT_CONFIG_OPTION_BYTECODE_INTERPRETER; in other words, */
  544. /* either define TT_CONFIG_OPTION_BYTECODE_INTERPRETER or */
  545. /* TT_CONFIG_OPTION_UNPATENTED_HINTING but not both at the same time. */
  546. /* */
  547. /* This macro is only useful for a small number of font files (mostly */
  548. /* for Asian scripts) that require bytecode interpretation to properly */
  549. /* load glyphs. For all other fonts, this produces unpleasant results, */
  550. /* thus the unpatented interpreter is never used to load glyphs from */
  551. /* TrueType fonts unless one of the following two options is used. */
  552. /* */
  553. /* - The unpatented interpreter is explicitly activated by the user */
  554. /* through the FT_PARAM_TAG_UNPATENTED_HINTING parameter tag */
  555. /* when opening the FT_Face. */
  556. /* */
  557. /* - FreeType detects that the FT_Face corresponds to one of the */
  558. /* `trick' fonts (e.g., `Mingliu') it knows about. The font engine */
  559. /* contains a hard-coded list of font names and other matching */
  560. /* parameters (see function `tt_face_init' in file */
  561. /* `src/truetype/ttobjs.c'). */
  562. /* */
  563. /* Here a sample code snippet for using FT_PARAM_TAG_UNPATENTED_HINTING. */
  564. /* */
  565. /* { */
  566. /* FT_Parameter parameter; */
  567. /* FT_Open_Args open_args; */
  568. /* */
  569. /* */
  570. /* parameter.tag = FT_PARAM_TAG_UNPATENTED_HINTING; */
  571. /* */
  572. /* open_args.flags = FT_OPEN_PATHNAME | FT_OPEN_PARAMS; */
  573. /* open_args.pathname = my_font_pathname; */
  574. /* open_args.num_params = 1; */
  575. /* open_args.params = &parameter; */
  576. /* */
  577. /* error = FT_Open_Face( library, &open_args, index, &face ); */
  578. /* ... */
  579. /* } */
  580. /* */
  581. /* #define TT_CONFIG_OPTION_UNPATENTED_HINTING */
  582. /*************************************************************************/
  583. /* */
  584. /* Define TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED to compile the */
  585. /* TrueType glyph loader to use Apple's definition of how to handle */
  586. /* component offsets in composite glyphs. */
  587. /* */
  588. /* Apple and MS disagree on the default behavior of component offsets */
  589. /* in composites. Apple says that they should be scaled by the scaling */
  590. /* factors in the transformation matrix (roughly, it's more complex) */
  591. /* while MS says they should not. OpenType defines two bits in the */
  592. /* composite flags array which can be used to disambiguate, but old */
  593. /* fonts will not have them. */
  594. /* */
  595. /* http://www.microsoft.com/typography/otspec/glyf.htm */
  596. /* https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6glyf.html */
  597. /* */
  598. #undef TT_CONFIG_OPTION_COMPONENT_OFFSET_SCALED
  599. /*************************************************************************/
  600. /* */
  601. /* Define TT_CONFIG_OPTION_GX_VAR_SUPPORT if you want to include */
  602. /* support for Apple's distortable font technology (fvar, gvar, cvar, */
  603. /* and avar tables). This has many similarities to Type 1 Multiple */
  604. /* Masters support. */
  605. /* */
  606. #define TT_CONFIG_OPTION_GX_VAR_SUPPORT
  607. /*************************************************************************/
  608. /* */
  609. /* Define TT_CONFIG_OPTION_BDF if you want to include support for */
  610. /* an embedded `BDF ' table within SFNT-based bitmap formats. */
  611. /* */
  612. #define TT_CONFIG_OPTION_BDF
  613. /*************************************************************************/
  614. /* */
  615. /* Option TT_CONFIG_OPTION_MAX_RUNNABLE_OPCODES controls the maximum */
  616. /* number of bytecode instructions executed for a single run of the */
  617. /* bytecode interpreter, needed to prevent infinite loops. You don't */
  618. /* want to change this except for very special situations (e.g., making */
  619. /* a library fuzzer spend less time to handle broken fonts). */
  620. /* */
  621. /* It is not expected that this value is ever modified by a configuring */
  622. /* script; instead, it gets surrounded with #ifndef ... #endif so that */
  623. /* the value can be set as a preprocessor option on the compiler's */
  624. /* command line. */
  625. /* */
  626. #ifndef TT_CONFIG_OPTION_MAX_RUNNABLE_OPCODES
  627. #define TT_CONFIG_OPTION_MAX_RUNNABLE_OPCODES 1000000L
  628. #endif
  629. /*************************************************************************/
  630. /*************************************************************************/
  631. /**** ****/
  632. /**** T Y P E 1 D R I V E R C O N F I G U R A T I O N ****/
  633. /**** ****/
  634. /*************************************************************************/
  635. /*************************************************************************/
  636. /*************************************************************************/
  637. /* */
  638. /* T1_MAX_DICT_DEPTH is the maximum depth of nest dictionaries and */
  639. /* arrays in the Type 1 stream (see t1load.c). A minimum of 4 is */
  640. /* required. */
  641. /* */
  642. #define T1_MAX_DICT_DEPTH 5
  643. /*************************************************************************/
  644. /* */
  645. /* T1_MAX_SUBRS_CALLS details the maximum number of nested sub-routine */
  646. /* calls during glyph loading. */
  647. /* */
  648. #define T1_MAX_SUBRS_CALLS 16
  649. /*************************************************************************/
  650. /* */
  651. /* T1_MAX_CHARSTRING_OPERANDS is the charstring stack's capacity. A */
  652. /* minimum of 16 is required. */
  653. /* */
  654. /* The Chinese font MingTiEG-Medium (CNS 11643 character set) needs 256. */
  655. /* */
  656. #define T1_MAX_CHARSTRINGS_OPERANDS 256
  657. /*************************************************************************/
  658. /* */
  659. /* Define this configuration macro if you want to prevent the */
  660. /* compilation of `t1afm', which is in charge of reading Type 1 AFM */
  661. /* files into an existing face. Note that if set, the T1 driver will be */
  662. /* unable to produce kerning distances. */
  663. /* */
  664. #undef T1_CONFIG_OPTION_NO_AFM
  665. /*************************************************************************/
  666. /* */
  667. /* Define this configuration macro if you want to prevent the */
  668. /* compilation of the Multiple Masters font support in the Type 1 */
  669. /* driver. */
  670. /* */
  671. #undef T1_CONFIG_OPTION_NO_MM_SUPPORT
  672. /*************************************************************************/
  673. /*************************************************************************/
  674. /**** ****/
  675. /**** C F F D R I V E R C O N F I G U R A T I O N ****/
  676. /**** ****/
  677. /*************************************************************************/
  678. /*************************************************************************/
  679. /*************************************************************************/
  680. /* */
  681. /* Using CFF_CONFIG_OPTION_DARKENING_PARAMETER_{X,Y}{1,2,3,4} it is */
  682. /* possible to set up the default values of the four control points that */
  683. /* define the stem darkening behaviour of the (new) CFF engine. For */
  684. /* more details please read the documentation of the */
  685. /* `darkening-parameters' property of the cff driver module (file */
  686. /* `ftcffdrv.h'), which allows the control at run-time. */
  687. /* */
  688. /* Do *not* undefine these macros! */
  689. /* */
  690. #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_X1 500
  691. #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y1 400
  692. #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_X2 1000
  693. #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y2 275
  694. #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_X3 1667
  695. #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y3 275
  696. #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_X4 2333
  697. #define CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y4 0
  698. /*************************************************************************/
  699. /* */
  700. /* CFF_CONFIG_OPTION_OLD_ENGINE controls whether the pre-Adobe CFF */
  701. /* engine gets compiled into FreeType. If defined, it is possible to */
  702. /* switch between the two engines using the `hinting-engine' property of */
  703. /* the cff driver module. */
  704. /* */
  705. #define CFF_CONFIG_OPTION_OLD_ENGINE
  706. /*************************************************************************/
  707. /*************************************************************************/
  708. /**** ****/
  709. /**** 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 ****/
  710. /**** ****/
  711. /*************************************************************************/
  712. /*************************************************************************/
  713. /*************************************************************************/
  714. /* */
  715. /* Compile autofit module with CJK (Chinese, Japanese, Korean) script */
  716. /* support. */
  717. /* */
  718. #define AF_CONFIG_OPTION_CJK
  719. /*************************************************************************/
  720. /* */
  721. /* Compile autofit module with Indic script support. */
  722. /* */
  723. #define AF_CONFIG_OPTION_INDIC
  724. /*************************************************************************/
  725. /* */
  726. /* Compile autofit module with warp hinting. The idea of the warping */
  727. /* code is to slightly scale and shift a glyph within a single dimension */
  728. /* so that as much of its segments are aligned (more or less) on the */
  729. /* grid. To find out the optimal scaling and shifting value, various */
  730. /* parameter combinations are tried and scored. */
  731. /* */
  732. /* This experimental option is active only if the rendering mode is */
  733. /* FT_RENDER_MODE_LIGHT; you can switch warping on and off with the */
  734. /* `warping' property of the auto-hinter (see file `ftautoh.h' for more */
  735. /* information; by default it is switched off). */
  736. /* */
  737. #define AF_CONFIG_OPTION_USE_WARPER
  738. /* */
  739. /*
  740. * This macro is obsolete. Support has been removed in FreeType
  741. * version 2.5.
  742. */
  743. /* #define FT_CONFIG_OPTION_OLD_INTERNALS */
  744. /*
  745. * This macro is defined if either unpatented or native TrueType
  746. * hinting is requested by the definitions above.
  747. */
  748. #ifdef TT_CONFIG_OPTION_BYTECODE_INTERPRETER
  749. #define TT_USE_BYTECODE_INTERPRETER
  750. #undef TT_CONFIG_OPTION_UNPATENTED_HINTING
  751. #elif defined TT_CONFIG_OPTION_UNPATENTED_HINTING
  752. #define TT_USE_BYTECODE_INTERPRETER
  753. #endif
  754. /*
  755. * Check CFF darkening parameters. The checks are the same as in function
  756. * `cff_property_set' in file `cffdrivr.c'.
  757. */
  758. #if CFF_CONFIG_OPTION_DARKENING_PARAMETER_X1 < 0 || \
  759. CFF_CONFIG_OPTION_DARKENING_PARAMETER_X2 < 0 || \
  760. CFF_CONFIG_OPTION_DARKENING_PARAMETER_X3 < 0 || \
  761. CFF_CONFIG_OPTION_DARKENING_PARAMETER_X4 < 0 || \
  762. \
  763. CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y1 < 0 || \
  764. CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y2 < 0 || \
  765. CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y3 < 0 || \
  766. CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y4 < 0 || \
  767. \
  768. CFF_CONFIG_OPTION_DARKENING_PARAMETER_X1 > \
  769. CFF_CONFIG_OPTION_DARKENING_PARAMETER_X2 || \
  770. CFF_CONFIG_OPTION_DARKENING_PARAMETER_X2 > \
  771. CFF_CONFIG_OPTION_DARKENING_PARAMETER_X3 || \
  772. CFF_CONFIG_OPTION_DARKENING_PARAMETER_X3 > \
  773. CFF_CONFIG_OPTION_DARKENING_PARAMETER_X4 || \
  774. \
  775. CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y1 > 500 || \
  776. CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y2 > 500 || \
  777. CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y3 > 500 || \
  778. CFF_CONFIG_OPTION_DARKENING_PARAMETER_Y4 > 500
  779. #error "Invalid CFF darkening parameters!"
  780. #endif
  781. FT_END_HEADER
  782. #endif /* __FTOPTION_H__ */
  783. /* END */