PageRenderTime 55ms CodeModel.GetById 25ms RepoModel.GetById 0ms app.codeStats 0ms

/modules/freetype2/docs/reference/ft2-ot_validation.html

https://bitbucket.org/soko/mozilla-central
HTML | 208 lines | 190 code | 18 blank | 0 comment | 0 complexity | 31aa4bbd245ec4fe39f39f87a1f08783 MD5 | raw file
Possible License(s): GPL-2.0, JSON, 0BSD, LGPL-3.0, AGPL-1.0, MIT, MPL-2.0-no-copyleft-exception, BSD-3-Clause, LGPL-2.1, Apache-2.0 
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
    2. 

  2. "http://www.w3.org/TR/html4/loose.dtd">
    3. 

  3. <html>
    4. 

  4. <head>
    5. 

  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    6. 

  6. <title>FreeType-2.4.9 API Reference</title>
    7. 

  7. <style type="text/css">
    8. 

  8.   body { font-family: Verdana, Geneva, Arial, Helvetica, serif;
    9. 

  9.          color: #000000;
    10. 

  10.          background: #FFFFFF; }
    11. 

  11. 

  12.   p { text-align: justify; }
    13. 

  13.   h1 { text-align: center; }
    14. 

  14.   li { text-align: justify; }
    15. 

  15.   td { padding: 0 0.5em 0 0.5em; }
    16. 

  16.   td.left { padding: 0 0.5em 0 0.5em;
    17. 

  17.             text-align: left; }
    18. 

  18. 

  19.   a:link { color: #0000EF; }
    20. 

  20.   a:visited { color: #51188E; }
    21. 

  21.   a:hover { color: #FF0000; }
    22. 

  22. 

  23.   span.keyword { font-family: monospace;
    24. 

  24.                  text-align: left;
    25. 

  25.                  white-space: pre;
    26. 

  26.                  color: darkblue; }
    27. 

  27. 

  28.   pre.colored { color: blue; }
    29. 

  29. 

  30.   ul.empty { list-style-type: none; }
    31. 

  31. </style>
    32. 

  32. </head>
    33. 

  33. <body>
    34. 

  34. 

  35. <table align=center><tr><td><font size=-1>[<a href="ft2-index.html">Index</a>]</font></td>
    36. 

  36. <td width="100%"></td>
    37. 

  37. <td><font size=-1>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
    38. 

  38. <center><h1>FreeType-2.4.9 API Reference</h1></center>
    39. 

  39. 

  40. <center><h1>
    41. 

  41. OpenType Validation
    42. 

  42. </h1></center>
    43. 

  43. <h2>Synopsis</h2>
    44. 

  44. <table align=center cellspacing=5 cellpadding=0 border=0>
    45. 

  45. <tr><td></td><td><a href="#FT_VALIDATE_OTXXX">FT_VALIDATE_OTXXX</a></td><td></td><td><a href="#FT_OpenType_Validate">FT_OpenType_Validate</a></td><td></td><td><a href="#FT_OpenType_Free">FT_OpenType_Free</a></td></tr>
    46. 

  46. </table><br><br>
    47. 

  47. 

  48. <table align=center width="87%"><tr><td>
    49. 

  49. <p>This section contains the declaration of functions to validate some OpenType tables (BASE, GDEF, GPOS, GSUB, JSTF, MATH).</p>
    50. 

  50. </td></tr></table><br>
    51. 

  51. <table align=center width="75%"><tr><td>
    52. 

  52. <h4><a name="FT_VALIDATE_OTXXX">FT_VALIDATE_OTXXX</a></h4>
    53. 

  53. <table align=center width="87%"><tr><td>
    54. 

  54. Defined in FT_OPENTYPE_VALIDATE_H (freetype/ftotval.h).
    55. 

  55. </td></tr></table><br>
    56. 

  56. <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
    57. 

  57. 

  58. #define <a href="ft2-ot_validation.html#FT_VALIDATE_OTXXX">FT_VALIDATE_BASE</a>  0x0100
    59. 

  59. #define <a href="ft2-ot_validation.html#FT_VALIDATE_OTXXX">FT_VALIDATE_GDEF</a>  0x0200
    60. 

  60. #define <a href="ft2-ot_validation.html#FT_VALIDATE_OTXXX">FT_VALIDATE_GPOS</a>  0x0400
    61. 

  61. #define <a href="ft2-ot_validation.html#FT_VALIDATE_OTXXX">FT_VALIDATE_GSUB</a>  0x0800
    62. 

  62. #define <a href="ft2-ot_validation.html#FT_VALIDATE_OTXXX">FT_VALIDATE_JSTF</a>  0x1000
    63. 

  63. #define <a href="ft2-ot_validation.html#FT_VALIDATE_OTXXX">FT_VALIDATE_MATH</a>  0x2000
    64. 

  64. 

  65. #define <a href="ft2-ot_validation.html#FT_VALIDATE_OTXXX">FT_VALIDATE_OT</a>  <a href="ft2-ot_validation.html#FT_VALIDATE_OTXXX">FT_VALIDATE_BASE</a> | \
    66. 

  66.                         <a href="ft2-ot_validation.html#FT_VALIDATE_OTXXX">FT_VALIDATE_GDEF</a> | \
    67. 

  67.                         <a href="ft2-ot_validation.html#FT_VALIDATE_OTXXX">FT_VALIDATE_GPOS</a> | \
    68. 

  68.                         <a href="ft2-ot_validation.html#FT_VALIDATE_OTXXX">FT_VALIDATE_GSUB</a> | \
    69. 

  69.                         <a href="ft2-ot_validation.html#FT_VALIDATE_OTXXX">FT_VALIDATE_JSTF</a> | \
    70. 

  70.                         <a href="ft2-ot_validation.html#FT_VALIDATE_OTXXX">FT_VALIDATE_MATH</a>
    71. 

  71. 

  72. </pre></table><br>
    73. 

  73. <table align=center width="87%"><tr><td>
    74. 

  74. <p>A list of bit-field constants used with <a href="ft2-ot_validation.html#FT_OpenType_Validate">FT_OpenType_Validate</a> to indicate which OpenType tables should be validated.</p>
    75. 

  75. </td></tr></table><br>
    76. 

  76. <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>values</b></em></td></tr><tr><td>
    77. 

  77. <p></p>
    78. 

  78. <table cellpadding=3 border=0>
    79. 

  79. <tr valign=top><td><b>FT_VALIDATE_BASE</b></td><td>
    80. 

  80. <p>Validate BASE table.</p>
    81. 

  81. </td></tr>
    82. 

  82. <tr valign=top><td><b>FT_VALIDATE_GDEF</b></td><td>
    83. 

  83. <p>Validate GDEF table.</p>
    84. 

  84. </td></tr>
    85. 

  85. <tr valign=top><td><b>FT_VALIDATE_GPOS</b></td><td>
    86. 

  86. <p>Validate GPOS table.</p>
    87. 

  87. </td></tr>
    88. 

  88. <tr valign=top><td><b>FT_VALIDATE_GSUB</b></td><td>
    89. 

  89. <p>Validate GSUB table.</p>
    90. 

  90. </td></tr>
    91. 

  91. <tr valign=top><td><b>FT_VALIDATE_JSTF</b></td><td>
    92. 

  92. <p>Validate JSTF table.</p>
    93. 

  93. </td></tr>
    94. 

  94. <tr valign=top><td><b>FT_VALIDATE_MATH</b></td><td>
    95. 

  95. <p>Validate MATH table.</p>
    96. 

  96. </td></tr>
    97. 

  97. <tr valign=top><td><b>FT_VALIDATE_OT</b></td><td>
    98. 

  98. <p>Validate all OpenType tables (BASE, GDEF, GPOS, GSUB, JSTF, MATH).</p>
    99. 

  99. </td></tr>
    100. 

  100. </table>
    101. 

  101. </td></tr></table>
    102. 

  102. </td></tr></table>
    103. 

  103. <hr width="75%">
    104. 

  104. <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
    105. 

  105. <td width="100%"></td>
    106. 

  106. <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
    107. 

  107. 

  108. <table align=center width="75%"><tr><td>
    109. 

  109. <h4><a name="FT_OpenType_Validate">FT_OpenType_Validate</a></h4>
    110. 

  110. <table align=center width="87%"><tr><td>
    111. 

  111. Defined in FT_OPENTYPE_VALIDATE_H (freetype/ftotval.h).
    112. 

  112. </td></tr></table><br>
    113. 

  113. <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
    114. 

  114. 

  115.   FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> )
    116. 

  116.   <b>FT_OpenType_Validate</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a>    face,
    117. 

  117.                         <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a>    validation_flags,
    118. 

  118.                         <a href="ft2-basic_types.html#FT_Bytes">FT_Bytes</a>  *BASE_table,
    119. 

  119.                         <a href="ft2-basic_types.html#FT_Bytes">FT_Bytes</a>  *GDEF_table,
    120. 

  120.                         <a href="ft2-basic_types.html#FT_Bytes">FT_Bytes</a>  *GPOS_table,
    121. 

  121.                         <a href="ft2-basic_types.html#FT_Bytes">FT_Bytes</a>  *GSUB_table,
    122. 

  122.                         <a href="ft2-basic_types.html#FT_Bytes">FT_Bytes</a>  *JSTF_table );
    123. 

  123. 

  124. </pre></table><br>
    125. 

  125. <table align=center width="87%"><tr><td>
    126. 

  126. <p>Validate various OpenType tables to assure that all offsets and indices are valid. The idea is that a higher-level library which actually does the text layout can access those tables without error checking (which can be quite time consuming).</p>
    127. 

  127. </td></tr></table><br>
    128. 

  128. <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
    129. 

  129. <p></p>
    130. 

  130. <table cellpadding=3 border=0>
    131. 

  131. <tr valign=top><td><b>face</b></td><td>
    132. 

  132. <p>A handle to the input face.</p>
    133. 

  133. </td></tr>
    134. 

  134. <tr valign=top><td><b>validation_flags</b></td><td>
    135. 

  135. <p>A bit field which specifies the tables to be validated. See <a href="ft2-ot_validation.html#FT_VALIDATE_OTXXX">FT_VALIDATE_OTXXX</a> for possible values.</p>
    136. 

  136. </td></tr>
    137. 

  137. </table>
    138. 

  138. </td></tr></table>
    139. 

  139. <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>output</b></em></td></tr><tr><td>
    140. 

  140. <p></p>
    141. 

  141. <table cellpadding=3 border=0>
    142. 

  142. <tr valign=top><td><b>BASE_table</b></td><td>
    143. 

  143. <p>A pointer to the BASE table.</p>
    144. 

  144. </td></tr>
    145. 

  145. <tr valign=top><td><b>GDEF_table</b></td><td>
    146. 

  146. <p>A pointer to the GDEF table.</p>
    147. 

  147. </td></tr>
    148. 

  148. <tr valign=top><td><b>GPOS_table</b></td><td>
    149. 

  149. <p>A pointer to the GPOS table.</p>
    150. 

  150. </td></tr>
    151. 

  151. <tr valign=top><td><b>GSUB_table</b></td><td>
    152. 

  152. <p>A pointer to the GSUB table.</p>
    153. 

  153. </td></tr>
    154. 

  154. <tr valign=top><td><b>JSTF_table</b></td><td>
    155. 

  155. <p>A pointer to the JSTF table.</p>
    156. 

  156. </td></tr>
    157. 

  157. </table>
    158. 

  158. </td></tr></table>
    159. 

  159. <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
    160. 

  160. <p>FreeType error code. 0&nbsp;means success.</p>
    161. 

  161. </td></tr></table>
    162. 

  162. <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td>
    163. 

  163. <p>This function only works with OpenType fonts, returning an error otherwise.</p>
    164. 

  164. <p>After use, the application should deallocate the five tables with <a href="ft2-ot_validation.html#FT_OpenType_Free">FT_OpenType_Free</a>. A NULL value indicates that the table either doesn't exist in the font, or the application hasn't asked for validation.</p>
    165. 

  165. </td></tr></table>
    166. 

  166. </td></tr></table>
    167. 

  167. <hr width="75%">
    168. 

  168. <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
    169. 

  169. <td width="100%"></td>
    170. 

  170. <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
    171. 

  171. 

  172. <table align=center width="75%"><tr><td>
    173. 

  173. <h4><a name="FT_OpenType_Free">FT_OpenType_Free</a></h4>
    174. 

  174. <table align=center width="87%"><tr><td>
    175. 

  175. Defined in FT_OPENTYPE_VALIDATE_H (freetype/ftotval.h).
    176. 

  176. </td></tr></table><br>
    177. 

  177. <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
    178. 

  178. 

  179.   FT_EXPORT( <span class="keyword">void</span> )
    180. 

  180.   <b>FT_OpenType_Free</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a>   face,
    181. 

  181.                     <a href="ft2-basic_types.html#FT_Bytes">FT_Bytes</a>  table );
    182. 

  182. 

  183. </pre></table><br>
    184. 

  184. <table align=center width="87%"><tr><td>
    185. 

  185. <p>Free the buffer allocated by OpenType validator.</p>
    186. 

  186. </td></tr></table><br>
    187. 

  187. <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
    188. 

  188. <p></p>
    189. 

  189. <table cellpadding=3 border=0>
    190. 

  190. <tr valign=top><td><b>face</b></td><td>
    191. 

  191. <p>A handle to the input face.</p>
    192. 

  192. </td></tr>
    193. 

  193. <tr valign=top><td><b>table</b></td><td>
    194. 

  194. <p>The pointer to the buffer that is allocated by <a href="ft2-ot_validation.html#FT_OpenType_Validate">FT_OpenType_Validate</a>.</p>
    195. 

  195. </td></tr>
    196. 

  196. </table>
    197. 

  197. </td></tr></table>
    198. 

  198. <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td>
    199. 

  199. <p>This function must be used to free the buffer allocated by <a href="ft2-ot_validation.html#FT_OpenType_Validate">FT_OpenType_Validate</a> only.</p>
    200. 

  200. </td></tr></table>
    201. 

  201. </td></tr></table>
    202. 

  202. <hr width="75%">
    203. 

  203. <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
    204. 

  204. <td width="100%"></td>
    205. 

  205. <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
    206. 

  206. 

  207. </body>
    208. 

  208. </html>
    209. 

  209.