docs/html/harfbuzz-hb-common.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>hb-common: HarfBuzz Manual</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="index.html" title="HarfBuzz Manual">
   8 <link rel="up" href="ch08.html" title="HarfBuzz API">
   9 <link rel="prev" href="harfbuzz-hb.html" title="hb">
  10 <link rel="next" href="harfbuzz-hb-unicode.html" title="hb-unicode">
  11 <meta name="generator" content="GTK-Doc V1.27.1 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span>
  18                   <a href="#harfbuzz-hb-common.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
  19                   <a href="#harfbuzz-hb-common.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
  20 </td>
  21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  22 <td><a accesskey="u" href="ch08.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="harfbuzz-hb.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="harfbuzz-hb-unicode.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  25 </tr></table>
  26 <div class="refentry">
  27 <a name="harfbuzz-hb-common"></a><div class="titlepage"></div>
  28 <div class="refnamediv"><table width="100%"><tr>
  29 <td valign="top">
  30 <h2><span class="refentrytitle"><a name="harfbuzz-hb-common.top_of_page"></a>hb-common</span></h2>
  31 <p>hb-common</p>
  32 </td>
  33 <td class="gallery_image" valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsect1">
  36 <a name="harfbuzz-hb-common.functions"></a><h2>Functions</h2>
  37 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  38 <colgroup>
  39 <col width="150px" class="functions_return">
  40 <col class="functions_name">
  41 </colgroup>
  42 <tbody>
  43 <tr>
  44 <td class="function_type">
  45 <a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t"><span class="returnvalue">hb_tag_t</span></a>
  46 </td>
  47 <td class="function_name">
  48 <a class="link" href="harfbuzz-hb-common.html#hb-tag-from-string" title="hb_tag_from_string ()">hb_tag_from_string</a> <span class="c_punctuation">()</span>
  49 </td>
  50 </tr>
  51 <tr>
  52 <td class="function_type">
  53 <span class="returnvalue">void</span>
  54 </td>
  55 <td class="function_name">
  56 <a class="link" href="harfbuzz-hb-common.html#hb-tag-to-string" title="hb_tag_to_string ()">hb_tag_to_string</a> <span class="c_punctuation">()</span>
  57 </td>
  58 </tr>
  59 <tr>
  60 <td class="function_type">
  61 <a class="link" href="harfbuzz-hb-common.html#hb-direction-t" title="enum hb_direction_t"><span class="returnvalue">hb_direction_t</span></a>
  62 </td>
  63 <td class="function_name">
  64 <a class="link" href="harfbuzz-hb-common.html#hb-direction-from-string" title="hb_direction_from_string ()">hb_direction_from_string</a> <span class="c_punctuation">()</span>
  65 </td>
  66 </tr>
  67 <tr>
  68 <td class="function_type">const <span class="returnvalue">char</span> *
  69 </td>
  70 <td class="function_name">
  71 <a class="link" href="harfbuzz-hb-common.html#hb-direction-to-string" title="hb_direction_to_string ()">hb_direction_to_string</a> <span class="c_punctuation">()</span>
  72 </td>
  73 </tr>
  74 <tr>
  75 <td class="function_type">
  76 <a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="returnvalue">hb_script_t</span></a>
  77 </td>
  78 <td class="function_name">
  79 <a class="link" href="harfbuzz-hb-common.html#hb-script-from-iso15924-tag" title="hb_script_from_iso15924_tag ()">hb_script_from_iso15924_tag</a> <span class="c_punctuation">()</span>
  80 </td>
  81 </tr>
  82 <tr>
  83 <td class="function_type">
  84 <a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="returnvalue">hb_script_t</span></a>
  85 </td>
  86 <td class="function_name">
  87 <a class="link" href="harfbuzz-hb-common.html#hb-script-from-string" title="hb_script_from_string ()">hb_script_from_string</a> <span class="c_punctuation">()</span>
  88 </td>
  89 </tr>
  90 <tr>
  91 <td class="function_type">
  92 <a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t"><span class="returnvalue">hb_tag_t</span></a>
  93 </td>
  94 <td class="function_name">
  95 <a class="link" href="harfbuzz-hb-common.html#hb-script-to-iso15924-tag" title="hb_script_to_iso15924_tag ()">hb_script_to_iso15924_tag</a> <span class="c_punctuation">()</span>
  96 </td>
  97 </tr>
  98 <tr>
  99 <td class="function_type">
 100 <a class="link" href="harfbuzz-hb-common.html#hb-direction-t" title="enum hb_direction_t"><span class="returnvalue">hb_direction_t</span></a>
 101 </td>
 102 <td class="function_name">
 103 <a class="link" href="harfbuzz-hb-common.html#hb-script-get-horizontal-direction" title="hb_script_get_horizontal_direction ()">hb_script_get_horizontal_direction</a> <span class="c_punctuation">()</span>
 104 </td>
 105 </tr>
 106 <tr>
 107 <td class="function_type">
 108 <a class="link" href="harfbuzz-hb-common.html#hb-language-t" title="hb_language_t"><span class="returnvalue">hb_language_t</span></a>
 109 </td>
 110 <td class="function_name">
 111 <a class="link" href="harfbuzz-hb-common.html#hb-language-from-string" title="hb_language_from_string ()">hb_language_from_string</a> <span class="c_punctuation">()</span>
 112 </td>
 113 </tr>
 114 <tr>
 115 <td class="function_type">const <span class="returnvalue">char</span> *
 116 </td>
 117 <td class="function_name">
 118 <a class="link" href="harfbuzz-hb-common.html#hb-language-to-string" title="hb_language_to_string ()">hb_language_to_string</a> <span class="c_punctuation">()</span>
 119 </td>
 120 </tr>
 121 <tr>
 122 <td class="function_type">
 123 <a class="link" href="harfbuzz-hb-common.html#hb-language-t" title="hb_language_t"><span class="returnvalue">hb_language_t</span></a>
 124 </td>
 125 <td class="function_name">
 126 <a class="link" href="harfbuzz-hb-common.html#hb-language-get-default" title="hb_language_get_default ()">hb_language_get_default</a> <span class="c_punctuation">()</span>
 127 </td>
 128 </tr>
 129 <tr>
 130 <td class="function_type">
 131 <span class="returnvalue">void</span>
 132 </td>
 133 <td class="function_name">
 134 <span class="c_punctuation">(</span><a class="link" href="harfbuzz-hb-common.html#hb-destroy-func-t" title="hb_destroy_func_t ()">*hb_destroy_func_t</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
 135 </td>
 136 </tr>
 137 <tr>
 138 <td class="define_keyword">#define</td>
 139 <td class="function_name">
 140 <a class="link" href="harfbuzz-hb-common.html#HB-TAG:CAPS" title="HB_TAG()">HB_TAG</a><span class="c_punctuation">()</span>
 141 </td>
 142 </tr>
 143 <tr>
 144 <td class="define_keyword">#define</td>
 145 <td class="function_name">
 146 <a class="link" href="harfbuzz-hb-common.html#HB-UNTAG:CAPS" title="HB_UNTAG()">HB_UNTAG</a><span class="c_punctuation">()</span>
 147 </td>
 148 </tr>
 149 <tr>
 150 <td class="define_keyword">#define</td>
 151 <td class="function_name">
 152 <a class="link" href="harfbuzz-hb-common.html#HB-DIRECTION-REVERSE:CAPS" title="HB_DIRECTION_REVERSE()">HB_DIRECTION_REVERSE</a><span class="c_punctuation">()</span>
 153 </td>
 154 </tr>
 155 <tr>
 156 <td class="define_keyword">#define</td>
 157 <td class="function_name">
 158 <a class="link" href="harfbuzz-hb-common.html#HB-DIRECTION-IS-BACKWARD:CAPS" title="HB_DIRECTION_IS_BACKWARD()">HB_DIRECTION_IS_BACKWARD</a><span class="c_punctuation">()</span>
 159 </td>
 160 </tr>
 161 <tr>
 162 <td class="define_keyword">#define</td>
 163 <td class="function_name">
 164 <a class="link" href="harfbuzz-hb-common.html#HB-DIRECTION-IS-FORWARD:CAPS" title="HB_DIRECTION_IS_FORWARD()">HB_DIRECTION_IS_FORWARD</a><span class="c_punctuation">()</span>
 165 </td>
 166 </tr>
 167 <tr>
 168 <td class="define_keyword">#define</td>
 169 <td class="function_name">
 170 <a class="link" href="harfbuzz-hb-common.html#HB-DIRECTION-IS-HORIZONTAL:CAPS" title="HB_DIRECTION_IS_HORIZONTAL()">HB_DIRECTION_IS_HORIZONTAL</a><span class="c_punctuation">()</span>
 171 </td>
 172 </tr>
 173 <tr>
 174 <td class="define_keyword">#define</td>
 175 <td class="function_name">
 176 <a class="link" href="harfbuzz-hb-common.html#HB-DIRECTION-IS-VALID:CAPS" title="HB_DIRECTION_IS_VALID()">HB_DIRECTION_IS_VALID</a><span class="c_punctuation">()</span>
 177 </td>
 178 </tr>
 179 <tr>
 180 <td class="define_keyword">#define</td>
 181 <td class="function_name">
 182 <a class="link" href="harfbuzz-hb-common.html#HB-DIRECTION-IS-VERTICAL:CAPS" title="HB_DIRECTION_IS_VERTICAL()">HB_DIRECTION_IS_VERTICAL</a><span class="c_punctuation">()</span>
 183 </td>
 184 </tr>
 185 </tbody>
 186 </table></div>
 187 </div>
 188 <a name="hb-user-data-key-t"></a><div class="refsect1">
 189 <a name="harfbuzz-hb-common.other"></a><h2>Types and Values</h2>
 190 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 191 <colgroup>
 192 <col width="150px" class="name">
 193 <col class="description">
 194 </colgroup>
 195 <tbody>
 196 <tr>
 197 <td class="typedef_keyword">typedef</td>
 198 <td class="function_name"><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t">hb_bool_t</a></td>
 199 </tr>
 200 <tr>
 201 <td class="typedef_keyword">typedef</td>
 202 <td class="function_name"><a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t">hb_codepoint_t</a></td>
 203 </tr>
 204 <tr>
 205 <td class="datatype_keyword">enum</td>
 206 <td class="function_name"><a class="link" href="harfbuzz-hb-common.html#hb-direction-t" title="enum hb_direction_t">hb_direction_t</a></td>
 207 </tr>
 208 <tr>
 209 <td class="typedef_keyword">typedef</td>
 210 <td class="function_name"><a class="link" href="harfbuzz-hb-common.html#hb-language-t" title="hb_language_t">hb_language_t</a></td>
 211 </tr>
 212 <tr>
 213 <td class="typedef_keyword">typedef</td>
 214 <td class="function_name"><a class="link" href="harfbuzz-hb-common.html#hb-mask-t" title="hb_mask_t">hb_mask_t</a></td>
 215 </tr>
 216 <tr>
 217 <td class="typedef_keyword">typedef</td>
 218 <td class="function_name"><a class="link" href="harfbuzz-hb-common.html#hb-position-t" title="hb_position_t">hb_position_t</a></td>
 219 </tr>
 220 <tr>
 221 <td class="typedef_keyword">typedef</td>
 222 <td class="function_name"><a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t">hb_tag_t</a></td>
 223 </tr>
 224 <tr>
 225 <td class="datatype_keyword">enum</td>
 226 <td class="function_name"><a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t">hb_script_t</a></td>
 227 </tr>
 228 <tr>
 229 <td class="datatype_keyword"> </td>
 230 <td class="function_name"><a class="link" href="harfbuzz-hb-common.html#hb-user-data-key-t-struct" title="hb_user_data_key_t">hb_user_data_key_t</a></td>
 231 </tr>
 232 <tr>
 233 <td class="datatype_keyword"> </td>
 234 <td class="function_name"><a class="link" href="harfbuzz-hb-common.html#hb-var-int-t" title="hb_var_int_t">hb_var_int_t</a></td>
 235 </tr>
 236 <tr>
 237 <td class="define_keyword">#define</td>
 238 <td class="function_name"><a class="link" href="harfbuzz-hb-common.html#HB-TAG-NONE:CAPS" title="HB_TAG_NONE">HB_TAG_NONE</a></td>
 239 </tr>
 240 <tr>
 241 <td class="define_keyword">#define</td>
 242 <td class="function_name"><a class="link" href="harfbuzz-hb-common.html#HB-TAG-MAX:CAPS" title="HB_TAG_MAX">HB_TAG_MAX</a></td>
 243 </tr>
 244 <tr>
 245 <td class="define_keyword">#define</td>
 246 <td class="function_name"><a class="link" href="harfbuzz-hb-common.html#HB-TAG-MAX-SIGNED:CAPS" title="HB_TAG_MAX_SIGNED">HB_TAG_MAX_SIGNED</a></td>
 247 </tr>
 248 <tr>
 249 <td class="define_keyword">#define</td>
 250 <td class="function_name"><a class="link" href="harfbuzz-hb-common.html#HB-LANGUAGE-INVALID:CAPS" title="HB_LANGUAGE_INVALID">HB_LANGUAGE_INVALID</a></td>
 251 </tr>
 252 </tbody>
 253 </table></div>
 254 </div>
 255 <div class="refsect1">
 256 <a name="harfbuzz-hb-common.object-hierarchy"></a><h2>Object Hierarchy</h2>
 257 <pre class="screen">    <a href="/home/behdad/.local/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a>
 258     <span class="lineart">╰──</span> hb_user_data_key_t
 259     <a href="/home/behdad/.local/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a>
 260     <span class="lineart">├──</span> hb_direction_t
 261     <span class="lineart">╰──</span> hb_script_t
 262 </pre>
 263 </div>
 264 <div class="refsect1">
 265 <a name="harfbuzz-hb-common.description"></a><h2>Description</h2>
 266 </div>
 267 <div class="refsect1">
 268 <a name="harfbuzz-hb-common.functions_details"></a><h2>Functions</h2>
 269 <div class="refsect2">
 270 <a name="hb-tag-from-string"></a><h3>hb_tag_from_string ()</h3>
 271 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t"><span class="returnvalue">hb_tag_t</span></a>
 272 hb_tag_from_string (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
 273                     <em class="parameter"><code><span class="type">int</span> len</code></em>);</pre>
 274 <div class="refsect3">
 275 <a name="hb-tag-from-string.parameters"></a><h4>Parameters</h4>
 276 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 277 <colgroup>
 278 <col width="150px" class="parameters_name">
 279 <col class="parameters_description">
 280 <col width="200px" class="parameters_annotations">
 281 </colgroup>
 282 <tbody><tr>
 283 <td class="parameter_name"><p>str</p></td>
 284 <td class="parameter_description"><p>. </p></td>
 285 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=len][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> uint8_t]</span></td>
 286 </tr></tbody>
 287 </table></div>
 288 </div>
 289 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 290 </div>
 291 <hr>
 292 <div class="refsect2">
 293 <a name="hb-tag-to-string"></a><h3>hb_tag_to_string ()</h3>
 294 <pre class="programlisting"><span class="returnvalue">void</span>
 295 hb_tag_to_string (<em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t"><span class="type">hb_tag_t</span></a> tag</code></em>,
 296                   <em class="parameter"><code><span class="type">char</span> *buf</code></em>);</pre>
 297 <div class="refsect3">
 298 <a name="hb-tag-to-string.parameters"></a><h4>Parameters</h4>
 299 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 300 <colgroup>
 301 <col width="150px" class="parameters_name">
 302 <col class="parameters_description">
 303 <col width="200px" class="parameters_annotations">
 304 </colgroup>
 305 <tbody><tr>
 306 <td class="parameter_name"><p>buf</p></td>
 307 <td class="parameter_description"><p>. </p></td>
 308 <td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> fixed-size=4][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> uint8_t]</span></td>
 309 </tr></tbody>
 310 </table></div>
 311 </div>
 312 <p class="since">Since: <a class="link" href="api-index-0-9-5.html#api-index-0.9.5">0.9.5</a></p>
 313 </div>
 314 <hr>
 315 <div class="refsect2">
 316 <a name="hb-direction-from-string"></a><h3>hb_direction_from_string ()</h3>
 317 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-direction-t" title="enum hb_direction_t"><span class="returnvalue">hb_direction_t</span></a>
 318 hb_direction_from_string (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
 319                           <em class="parameter"><code><span class="type">int</span> len</code></em>);</pre>
 320 <div class="refsect3">
 321 <a name="hb-direction-from-string.parameters"></a><h4>Parameters</h4>
 322 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 323 <colgroup>
 324 <col width="150px" class="parameters_name">
 325 <col class="parameters_description">
 326 <col width="200px" class="parameters_annotations">
 327 </colgroup>
 328 <tbody><tr>
 329 <td class="parameter_name"><p>str</p></td>
 330 <td class="parameter_description"><p>. </p></td>
 331 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=len][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> uint8_t]</span></td>
 332 </tr></tbody>
 333 </table></div>
 334 </div>
 335 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 336 </div>
 337 <hr>
 338 <div class="refsect2">
 339 <a name="hb-direction-to-string"></a><h3>hb_direction_to_string ()</h3>
 340 <pre class="programlisting">const <span class="returnvalue">char</span> *
 341 hb_direction_to_string (<em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-direction-t" title="enum hb_direction_t"><span class="type">hb_direction_t</span></a> direction</code></em>);</pre>
 342 <div class="refsect3">
 343 <a name="hb-direction-to-string.returns"></a><h4>Returns</h4>
 344 <p>. </p>
 345 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 346 </div>
 347 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 348 </div>
 349 <hr>
 350 <div class="refsect2">
 351 <a name="hb-script-from-iso15924-tag"></a><h3>hb_script_from_iso15924_tag ()</h3>
 352 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="returnvalue">hb_script_t</span></a>
 353 hb_script_from_iso15924_tag (<em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t"><span class="type">hb_tag_t</span></a> tag</code></em>);</pre>
 354 <p>Converts an ISO 15924 script tag to a corresponding <a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="type">hb_script_t</span></a>.</p>
 355 <div class="refsect3">
 356 <a name="hb-script-from-iso15924-tag.parameters"></a><h4>Parameters</h4>
 357 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 358 <colgroup>
 359 <col width="150px" class="parameters_name">
 360 <col class="parameters_description">
 361 <col width="200px" class="parameters_annotations">
 362 </colgroup>
 363 <tbody><tr>
 364 <td class="parameter_name"><p>tag</p></td>
 365 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t"><span class="type">hb_tag_t</span></a> representing an ISO 15924 tag.</p></td>
 366 <td class="parameter_annotations"> </td>
 367 </tr></tbody>
 368 </table></div>
 369 </div>
 370 <div class="refsect3">
 371 <a name="hb-script-from-iso15924-tag.returns"></a><h4>Returns</h4>
 372 <p>An <a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="type">hb_script_t</span></a> corresponding to the ISO 15924 tag.</p>
 373 </div>
 374 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 375 </div>
 376 <hr>
 377 <div class="refsect2">
 378 <a name="hb-script-from-string"></a><h3>hb_script_from_string ()</h3>
 379 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="returnvalue">hb_script_t</span></a>
 380 hb_script_from_string (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
 381                        <em class="parameter"><code><span class="type">int</span> len</code></em>);</pre>
 382 <p>Converts a string <em class="parameter"><code>str</code></em>
 383  representing an ISO 15924 script tag to a
 384 corresponding <a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="type">hb_script_t</span></a>. Shorthand for <a class="link" href="harfbuzz-hb-common.html#hb-tag-from-string" title="hb_tag_from_string ()"><code class="function">hb_tag_from_string()</code></a> then
 385 <a class="link" href="harfbuzz-hb-common.html#hb-script-from-iso15924-tag" title="hb_script_from_iso15924_tag ()"><code class="function">hb_script_from_iso15924_tag()</code></a>.</p>
 386 <div class="refsect3">
 387 <a name="hb-script-from-string.parameters"></a><h4>Parameters</h4>
 388 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 389 <colgroup>
 390 <col width="150px" class="parameters_name">
 391 <col class="parameters_description">
 392 <col width="200px" class="parameters_annotations">
 393 </colgroup>
 394 <tbody>
 395 <tr>
 396 <td class="parameter_name"><p>str</p></td>
 397 <td class="parameter_description"><p>a string representing an
 398 ISO 15924 tag. </p></td>
 399 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=len][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> uint8_t]</span></td>
 400 </tr>
 401 <tr>
 402 <td class="parameter_name"><p>len</p></td>
 403 <td class="parameter_description"><p>length of the <em class="parameter"><code>str</code></em>
 404 , or -1 if it is <code class="literal">NULL</code>-terminated.</p></td>
 405 <td class="parameter_annotations"> </td>
 406 </tr>
 407 </tbody>
 408 </table></div>
 409 </div>
 410 <div class="refsect3">
 411 <a name="hb-script-from-string.returns"></a><h4>Returns</h4>
 412 <p>An <a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="type">hb_script_t</span></a> corresponding to the ISO 15924 tag.</p>
 413 </div>
 414 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 415 </div>
 416 <hr>
 417 <div class="refsect2">
 418 <a name="hb-script-to-iso15924-tag"></a><h3>hb_script_to_iso15924_tag ()</h3>
 419 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t"><span class="returnvalue">hb_tag_t</span></a>
 420 hb_script_to_iso15924_tag (<em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="type">hb_script_t</span></a> script</code></em>);</pre>
 421 <p>See <a class="link" href="harfbuzz-hb-common.html#hb-script-from-iso15924-tag" title="hb_script_from_iso15924_tag ()"><code class="function">hb_script_from_iso15924_tag()</code></a>.</p>
 422 <div class="refsect3">
 423 <a name="hb-script-to-iso15924-tag.parameters"></a><h4>Parameters</h4>
 424 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 425 <colgroup>
 426 <col width="150px" class="parameters_name">
 427 <col class="parameters_description">
 428 <col width="200px" class="parameters_annotations">
 429 </colgroup>
 430 <tbody><tr>
 431 <td class="parameter_name"><p>script</p></td>
 432 <td class="parameter_description"><p>an <span class="type">hb_script_</span> to convert.</p></td>
 433 <td class="parameter_annotations"> </td>
 434 </tr></tbody>
 435 </table></div>
 436 </div>
 437 <div class="refsect3">
 438 <a name="hb-script-to-iso15924-tag.returns"></a><h4>Returns</h4>
 439 <p>An <a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t"><span class="type">hb_tag_t</span></a> representing an ISO 15924 script tag.</p>
 440 </div>
 441 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 442 </div>
 443 <hr>
 444 <div class="refsect2">
 445 <a name="hb-script-get-horizontal-direction"></a><h3>hb_script_get_horizontal_direction ()</h3>
 446 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-direction-t" title="enum hb_direction_t"><span class="returnvalue">hb_direction_t</span></a>
 447 hb_script_get_horizontal_direction (<em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="type">hb_script_t</span></a> script</code></em>);</pre>
 448 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 449 </div>
 450 <hr>
 451 <div class="refsect2">
 452 <a name="hb-language-from-string"></a><h3>hb_language_from_string ()</h3>
 453 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-language-t" title="hb_language_t"><span class="returnvalue">hb_language_t</span></a>
 454 hb_language_from_string (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
 455                          <em class="parameter"><code><span class="type">int</span> len</code></em>);</pre>
 456 <p>Converts <em class="parameter"><code>str</code></em>
 457  representing an ISO 639 language code to the corresponding
 458 <a class="link" href="harfbuzz-hb-common.html#hb-language-t" title="hb_language_t"><span class="type">hb_language_t</span></a>.</p>
 459 <div class="refsect3">
 460 <a name="hb-language-from-string.parameters"></a><h4>Parameters</h4>
 461 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 462 <colgroup>
 463 <col width="150px" class="parameters_name">
 464 <col class="parameters_description">
 465 <col width="200px" class="parameters_annotations">
 466 </colgroup>
 467 <tbody>
 468 <tr>
 469 <td class="parameter_name"><p>str</p></td>
 470 <td class="parameter_description"><p>a string representing
 471 ISO 639 language code. </p></td>
 472 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=len][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> uint8_t]</span></td>
 473 </tr>
 474 <tr>
 475 <td class="parameter_name"><p>len</p></td>
 476 <td class="parameter_description"><p>length of the <em class="parameter"><code>str</code></em>
 477 , or -1 if it is <code class="literal">NULL</code>-terminated.</p></td>
 478 <td class="parameter_annotations"> </td>
 479 </tr>
 480 </tbody>
 481 </table></div>
 482 </div>
 483 <div class="refsect3">
 484 <a name="hb-language-from-string.returns"></a><h4>Returns</h4>
 485 <p>The <a class="link" href="harfbuzz-hb-common.html#hb-language-t" title="hb_language_t"><span class="type">hb_language_t</span></a> corresponding to the ISO 639 language code. </p>
 486 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 487 </div>
 488 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 489 </div>
 490 <hr>
 491 <div class="refsect2">
 492 <a name="hb-language-to-string"></a><h3>hb_language_to_string ()</h3>
 493 <pre class="programlisting">const <span class="returnvalue">char</span> *
 494 hb_language_to_string (<em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-language-t" title="hb_language_t"><span class="type">hb_language_t</span></a> language</code></em>);</pre>
 495 <p>See <a class="link" href="harfbuzz-hb-common.html#hb-language-from-string" title="hb_language_from_string ()"><code class="function">hb_language_from_string()</code></a>.</p>
 496 <div class="refsect3">
 497 <a name="hb-language-to-string.parameters"></a><h4>Parameters</h4>
 498 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 499 <colgroup>
 500 <col width="150px" class="parameters_name">
 501 <col class="parameters_description">
 502 <col width="200px" class="parameters_annotations">
 503 </colgroup>
 504 <tbody><tr>
 505 <td class="parameter_name"><p>language</p></td>
 506 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-hb-common.html#hb-language-t" title="hb_language_t"><span class="type">hb_language_t</span></a> to convert.</p></td>
 507 <td class="parameter_annotations"> </td>
 508 </tr></tbody>
 509 </table></div>
 510 </div>
 511 <div class="refsect3">
 512 <a name="hb-language-to-string.returns"></a><h4>Returns</h4>
 513 <p>A <code class="literal">NULL</code>-terminated string representing the <em class="parameter"><code>language</code></em>
 514 . Must not be freed by
 515 the caller. </p>
 516 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 517 </div>
 518 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 519 </div>
 520 <hr>
 521 <div class="refsect2">
 522 <a name="hb-language-get-default"></a><h3>hb_language_get_default ()</h3>
 523 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-language-t" title="hb_language_t"><span class="returnvalue">hb_language_t</span></a>
 524 hb_language_get_default (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 525 <div class="refsect3">
 526 <a name="hb-language-get-default.returns"></a><h4>Returns</h4>
 527 <p>. </p>
 528 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 529 </div>
 530 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 531 </div>
 532 <hr>
 533 <div class="refsect2">
 534 <a name="hb-destroy-func-t"></a><h3>hb_destroy_func_t ()</h3>
 535 <pre class="programlisting"><span class="returnvalue">void</span>
 536 <span class="c_punctuation">(</span>*hb_destroy_func_t<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
 537 </div>
 538 <hr>
 539 <div class="refsect2">
 540 <a name="HB-TAG:CAPS"></a><h3>HB_TAG()</h3>
 541 <pre class="programlisting">#define HB_TAG(c1,c2,c3,c4) ((hb_tag_t)((((uint8_t)(c1))&lt;&lt;24)|(((uint8_t)(c2))&lt;&lt;16)|(((uint8_t)(c3))&lt;&lt;8)|((uint8_t)(c4))))
 542 </pre>
 543 </div>
 544 <hr>
 545 <div class="refsect2">
 546 <a name="HB-UNTAG:CAPS"></a><h3>HB_UNTAG()</h3>
 547 <pre class="programlisting">#define HB_UNTAG(tag)   ((uint8_t)((tag)&gt;&gt;24)), ((uint8_t)((tag)&gt;&gt;16)), ((uint8_t)((tag)&gt;&gt;8)), ((uint8_t)(tag))
 548 </pre>
 549 </div>
 550 <hr>
 551 <div class="refsect2">
 552 <a name="HB-DIRECTION-REVERSE:CAPS"></a><h3>HB_DIRECTION_REVERSE()</h3>
 553 <pre class="programlisting">#define HB_DIRECTION_REVERSE(dir) ((hb_direction_t) (((unsigned int) (dir)) ^ 1))
 554 </pre>
 555 </div>
 556 <hr>
 557 <div class="refsect2">
 558 <a name="HB-DIRECTION-IS-BACKWARD:CAPS"></a><h3>HB_DIRECTION_IS_BACKWARD()</h3>
 559 <pre class="programlisting">#define HB_DIRECTION_IS_BACKWARD(dir) ((((unsigned int) (dir)) &amp; ~2U) == 5)
 560 </pre>
 561 </div>
 562 <hr>
 563 <div class="refsect2">
 564 <a name="HB-DIRECTION-IS-FORWARD:CAPS"></a><h3>HB_DIRECTION_IS_FORWARD()</h3>
 565 <pre class="programlisting">#define HB_DIRECTION_IS_FORWARD(dir) ((((unsigned int) (dir)) &amp; ~2U) == 4)
 566 </pre>
 567 </div>
 568 <hr>
 569 <div class="refsect2">
 570 <a name="HB-DIRECTION-IS-HORIZONTAL:CAPS"></a><h3>HB_DIRECTION_IS_HORIZONTAL()</h3>
 571 <pre class="programlisting">#define HB_DIRECTION_IS_HORIZONTAL(dir) ((((unsigned int) (dir)) &amp; ~1U) == 4)
 572 </pre>
 573 </div>
 574 <hr>
 575 <div class="refsect2">
 576 <a name="HB-DIRECTION-IS-VALID:CAPS"></a><h3>HB_DIRECTION_IS_VALID()</h3>
 577 <pre class="programlisting">#define HB_DIRECTION_IS_VALID(dir) ((((unsigned int) (dir)) &amp; ~3U) == 4)
 578 </pre>
 579 </div>
 580 <hr>
 581 <div class="refsect2">
 582 <a name="HB-DIRECTION-IS-VERTICAL:CAPS"></a><h3>HB_DIRECTION_IS_VERTICAL()</h3>
 583 <pre class="programlisting">#define HB_DIRECTION_IS_VERTICAL(dir) ((((unsigned int) (dir)) &amp; ~1U) == 6)
 584 </pre>
 585 </div>
 586 </div>
 587 <div class="refsect1">
 588 <a name="harfbuzz-hb-common.other_details"></a><h2>Types and Values</h2>
 589 <div class="refsect2">
 590 <a name="hb-bool-t"></a><h3>hb_bool_t</h3>
 591 <pre class="programlisting">typedef int hb_bool_t;
 592 </pre>
 593 </div>
 594 <hr>
 595 <div class="refsect2">
 596 <a name="hb-codepoint-t"></a><h3>hb_codepoint_t</h3>
 597 <pre class="programlisting">typedef uint32_t hb_codepoint_t;
 598 </pre>
 599 </div>
 600 <hr>
 601 <div class="refsect2">
 602 <a name="hb-direction-t"></a><h3>enum hb_direction_t</h3>
 603 <div class="refsect3">
 604 <a name="hb-direction-t.members"></a><h4>Members</h4>
 605 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 606 <colgroup>
 607 <col width="300px" class="enum_members_name">
 608 <col class="enum_members_description">
 609 <col width="200px" class="enum_members_annotations">
 610 </colgroup>
 611 <tbody>
 612 <tr>
 613 <td class="enum_member_name"><p><a name="HB-DIRECTION-INVALID:CAPS"></a>HB_DIRECTION_INVALID</p></td>
 614 <td class="enum_member_description">
 615 <p>Initial, unset direction.</p>
 616 </td>
 617 <td class="enum_member_annotations"> </td>
 618 </tr>
 619 <tr>
 620 <td class="enum_member_name"><p><a name="HB-DIRECTION-LTR:CAPS"></a>HB_DIRECTION_LTR</p></td>
 621 <td class="enum_member_description">
 622 <p>Text is set horizontally from left to right.</p>
 623 </td>
 624 <td class="enum_member_annotations"> </td>
 625 </tr>
 626 <tr>
 627 <td class="enum_member_name"><p><a name="HB-DIRECTION-RTL:CAPS"></a>HB_DIRECTION_RTL</p></td>
 628 <td class="enum_member_description">
 629 <p>Text is set horizontally from right to left.</p>
 630 </td>
 631 <td class="enum_member_annotations"> </td>
 632 </tr>
 633 <tr>
 634 <td class="enum_member_name"><p><a name="HB-DIRECTION-TTB:CAPS"></a>HB_DIRECTION_TTB</p></td>
 635 <td class="enum_member_description">
 636 <p>Text is set vertically from top to bottom.</p>
 637 </td>
 638 <td class="enum_member_annotations"> </td>
 639 </tr>
 640 <tr>
 641 <td class="enum_member_name"><p><a name="HB-DIRECTION-BTT:CAPS"></a>HB_DIRECTION_BTT</p></td>
 642 <td class="enum_member_description">
 643 <p>Text is set vertically from bottom to top.</p>
 644 </td>
 645 <td class="enum_member_annotations"> </td>
 646 </tr>
 647 </tbody>
 648 </table></div>
 649 </div>
 650 </div>
 651 <hr>
 652 <div class="refsect2">
 653 <a name="hb-language-t"></a><h3>hb_language_t</h3>
 654 <pre class="programlisting">typedef const struct hb_language_impl_t *hb_language_t;
 655 </pre>
 656 </div>
 657 <hr>
 658 <div class="refsect2">
 659 <a name="hb-mask-t"></a><h3>hb_mask_t</h3>
 660 <pre class="programlisting">typedef uint32_t hb_mask_t;
 661 </pre>
 662 </div>
 663 <hr>
 664 <div class="refsect2">
 665 <a name="hb-position-t"></a><h3>hb_position_t</h3>
 666 <pre class="programlisting">typedef int32_t hb_position_t;
 667 </pre>
 668 </div>
 669 <hr>
 670 <div class="refsect2">
 671 <a name="hb-tag-t"></a><h3>hb_tag_t</h3>
 672 <pre class="programlisting">typedef uint32_t hb_tag_t;
 673 </pre>
 674 </div>
 675 <hr>
 676 <div class="refsect2">
 677 <a name="hb-script-t"></a><h3>enum hb_script_t</h3>
 678 <div class="refsect3">
 679 <a name="hb-script-t.members"></a><h4>Members</h4>
 680 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 681 <colgroup>
 682 <col width="300px" class="enum_members_name">
 683 <col class="enum_members_description">
 684 <col width="200px" class="enum_members_annotations">
 685 </colgroup>
 686 <tbody>
 687 <tr>
 688 <td class="enum_member_name"><p><a name="HB-SCRIPT-BASSA-VAH:CAPS"></a>HB_SCRIPT_BASSA_VAH</p></td>
 689 <td> </td>
 690 <td> </td>
 691 </tr>
 692 <tr>
 693 <td class="enum_member_name"><p><a name="HB-SCRIPT-ADLAM:CAPS"></a>HB_SCRIPT_ADLAM</p></td>
 694 <td> </td>
 695 <td> </td>
 696 </tr>
 697 <tr>
 698 <td class="enum_member_name"><p><a name="HB-SCRIPT-MASARAM-GONDI:CAPS"></a>HB_SCRIPT_MASARAM_GONDI</p></td>
 699 <td> </td>
 700 <td> </td>
 701 </tr>
 702 <tr>
 703 <td class="enum_member_name"><p><a name="HB-SCRIPT-INVALID:CAPS"></a>HB_SCRIPT_INVALID</p></td>
 704 <td> </td>
 705 <td> </td>
 706 </tr>
 707 <tr>
 708 <td class="enum_member_name"><p><a name="HB-SCRIPT-MAX-VALUE:CAPS"></a>_HB_SCRIPT_MAX_VALUE</p></td>
 709 <td> </td>
 710 <td> </td>
 711 </tr>
 712 <tr>
 713 <td class="enum_member_name"><p><a name="HB-SCRIPT-MAX-VALUE-SIGNED:CAPS"></a>_HB_SCRIPT_MAX_VALUE_SIGNED</p></td>
 714 <td> </td>
 715 <td> </td>
 716 </tr>
 717 </tbody>
 718 </table></div>
 719 </div>
 720 </div>
 721 <hr>
 722 <div class="refsect2">
 723 <a name="hb-user-data-key-t-struct"></a><h3>hb_user_data_key_t</h3>
 724 <pre class="programlisting">typedef struct {
 725 } hb_user_data_key_t;
 726 </pre>
 727 </div>
 728 <hr>
 729 <div class="refsect2">
 730 <a name="hb-var-int-t"></a><h3>hb_var_int_t</h3>
 731 </div>
 732 <hr>
 733 <div class="refsect2">
 734 <a name="HB-TAG-NONE:CAPS"></a><h3>HB_TAG_NONE</h3>
 735 <pre class="programlisting">#define HB_TAG_NONE HB_TAG(0,0,0,0)
 736 </pre>
 737 </div>
 738 <hr>
 739 <div class="refsect2">
 740 <a name="HB-TAG-MAX:CAPS"></a><h3>HB_TAG_MAX</h3>
 741 <pre class="programlisting">#define HB_TAG_MAX HB_TAG(0xff,0xff,0xff,0xff)
 742 </pre>
 743 </div>
 744 <hr>
 745 <div class="refsect2">
 746 <a name="HB-TAG-MAX-SIGNED:CAPS"></a><h3>HB_TAG_MAX_SIGNED</h3>
 747 <pre class="programlisting">#define HB_TAG_MAX_SIGNED HB_TAG(0x7f,0xff,0xff,0xff)
 748 </pre>
 749 </div>
 750 <hr>
 751 <div class="refsect2">
 752 <a name="HB-LANGUAGE-INVALID:CAPS"></a><h3>HB_LANGUAGE_INVALID</h3>
 753 <pre class="programlisting">#define HB_LANGUAGE_INVALID ((hb_language_t) 0)
 754 </pre>
 755 </div>
 756 </div>
 757 </div>
 758 <div class="footer">
 759 <hr>Generated by GTK-Doc V1.27.1</div>
 760 </body>
 761 </html>