FM / harfbuzz

/usr/share/gtk-doc/html/harfbuzz

Name	Size	Mode	Actions
a-clustering-example-for-levels-0-and-1.html	5307	0644	edit dl rm
aat-shaping.html	2359	0644	edit dl rm
adding-text-to-the-buffer.html	5800	0644	edit dl rm
annotation-glossary.html	5644	0644	edit dl rm
api-index-0-9-2.html	44447	0644	edit dl rm
api-index-0-9-5.html	3339	0644	edit dl rm
api-index-0-9-7.html	12306	0644	edit dl rm
api-index-0-9-8.html	2088	0644	edit dl rm
api-index-0-9-10.html	3200	0644	edit dl rm
api-index-0-9-11.html	2070	0644	edit dl rm
api-index-0-9-20.html	2303	0644	edit dl rm
api-index-0-9-22.html	2115	0644	edit dl rm
api-index-0-9-28.html	2062	0644	edit dl rm
api-index-0-9-30.html	2525	0644	edit dl rm
api-index-0-9-31.html	2932	0644	edit dl rm
api-index-0-9-38.html	3822	0644	edit dl rm
api-index-0-9-39.html	2058	0644	edit dl rm
api-index-0-9-41.html	2067	0644	edit dl rm
api-index-0-9-42.html	2587	0644	edit dl rm
api-index-1-0-5.html	2737	0644	edit dl rm
api-index-1-1-2.html	2374	0644	edit dl rm
api-index-1-1-3.html	2957	0644	edit dl rm
api-index-1-2-3.html	2872	0644	edit dl rm
api-index-1-3-3.html	5536	0644	edit dl rm
api-index-1-4-0.html	2347	0644	edit dl rm
api-index-1-4-2.html	5369	0644	edit dl rm
api-index-1-4-3.html	2029	0644	edit dl rm
api-index-1-5-0.html	2900	0644	edit dl rm
api-index-1-6-0.html	2266	0644	edit dl rm
api-index-1-7-5.html	1701	0644	edit dl rm
api-index-1-7-7.html	5550	0644	edit dl rm
api-index-1-8-0.html	2662	0644	edit dl rm
api-index-1-8-1.html	2485	0644	edit dl rm
api-index-1-8-5.html	2088	0644	edit dl rm
api-index-1-8-6.html	3187	0644	edit dl rm
api-index-1-9-0.html	3460	0644	edit dl rm
api-index-2-0-0.html	5926	0644	edit dl rm
api-index-2-1-0.html	8069	0644	edit dl rm
api-index-2-2-0.html	5326	0644	edit dl rm
api-index-2-3-0.html	2650	0644	edit dl rm
api-index-2-4-0.html	2087	0644	edit dl rm
api-index-2-5-0.html	2108	0644	edit dl rm
api-index-2-6-0.html	5240	0644	edit dl rm
api-index-2-7-3.html	2824	0644	edit dl rm
api-index-full.html	140340	0644	edit dl rm
buffers-language-script-and-direction.html	4951	0644	edit dl rm
building.html	15346	0644	edit dl rm
ch01s03.html	4495	0644	edit dl rm
ch03s02.html	6078	0644	edit dl rm
ch03s03.html	4580	0644	edit dl rm
ch12.html	3557	0644	edit dl rm
ch13.html	3078	0644	edit dl rm
ch14.html	1876	0644	edit dl rm
ch15.html	3044	0644	edit dl rm
clusters.html	6499	0644	edit dl rm
complex-scripts.html	3001	0644	edit dl rm
customizing-unicode-functions.html	6400	0644	edit dl rm
deprecated-api-index.html	6223	0644	edit dl rm
fonts-and-faces-custom-functions.html	7398	0644	edit dl rm
fonts-and-faces-native-opentype.html	5196	0644	edit dl rm
fonts-and-faces-variable.html	5304	0644	edit dl rm
fonts-and-faces.html	7671	0644	edit dl rm
getting-started.html	5043	0644	edit dl rm
graphite-shaping.html	2308	0644	edit dl rm
harfbuzz-hb-aat-layout.html	139345	0644	edit dl rm
harfbuzz-hb-blob.html	35902	0644	edit dl rm
harfbuzz-hb-buffer.html	195491	0644	edit dl rm
harfbuzz-hb-common.html	65323	0644	edit dl rm
harfbuzz-hb-coretext.html	11371	0644	edit dl rm
harfbuzz-hb-deprecated.html	25328	0644	edit dl rm
harfbuzz-hb-directwrite.html	6155	0644	edit dl rm
harfbuzz-hb-face.html	52100	0644	edit dl rm
harfbuzz-hb-font.html	262696	0644	edit dl rm
harfbuzz-hb-ft.html	28719	0644	edit dl rm
harfbuzz-hb-gdi.html	4310	0644	edit dl rm
harfbuzz-hb-glib.html	10086	0644	edit dl rm
harfbuzz-hb-gobject.html	2953	0644	edit dl rm
harfbuzz-hb-graphite2.html	5828	0644	edit dl rm
harfbuzz-hb-icu.html	7969	0644	edit dl rm
harfbuzz-hb-map.html	29188	0644	edit dl rm
harfbuzz-hb-ot-color.html	39949	0644	edit dl rm
harfbuzz-hb-ot-font.html	4630	0644	edit dl rm
harfbuzz-hb-ot-layout.html	145088	0644	edit dl rm
harfbuzz-hb-ot-math.html	52886	0644	edit dl rm
harfbuzz-hb-ot-meta.html	10286	0644	edit dl rm
harfbuzz-hb-ot-metrics.html	17927	0644	edit dl rm
harfbuzz-hb-ot-name.html	19603	0644	edit dl rm
harfbuzz-hb-ot-shape.html	6257	0644	edit dl rm
harfbuzz-hb-ot-var.html	36708	0644	edit dl rm
harfbuzz-hb-set.html	59423	0644	edit dl rm
harfbuzz-hb-shape-plan.html	38412	0644	edit dl rm
harfbuzz-hb-shape.html	11702	0644	edit dl rm
harfbuzz-hb-unicode.html	106701	0644	edit dl rm
harfbuzz-hb-uniscribe.html	6099	0644	edit dl rm
harfbuzz-hb-version.html	10415	0644	edit dl rm
harfbuzz.devhelp2	179457	0644	edit dl rm
HarfBuzz.png	6254	0644	edit dl rm
HarfBuzz.svg	6745	0644	edit dl rm
home.png	169	0644	edit dl rm
index.html	19566	0644	edit dl rm
install-harfbuzz.html	3787	0644	edit dl rm
integration-coretext.html	6483	0644	edit dl rm
integration-freetype.html	9293	0644	edit dl rm
integration-icu.html	4186	0644	edit dl rm
integration-python.html	3181	0644	edit dl rm
integration-uniscribe.html	6725	0644	edit dl rm
integration.html	9936	0644	edit dl rm
left-insensitive.png	334	0644	edit dl rm
left.png	185	0644	edit dl rm
level-2.html	7009	0644	edit dl rm
object-model-blobs.html	2902	0644	edit dl rm
object-model-lifecycle.html	4978	0644	edit dl rm
object-model-object-types.html	4111	0644	edit dl rm
object-model-user-data.html	3255	0644	edit dl rm
object-model.html	3978	0644	edit dl rm
opentype-shaping-models.html	4463	0644	edit dl rm
pt01.html	9417	0644	edit dl rm
pt02.html	12674	0644	edit dl rm
reordering-in-levels-0-and-1.html	3102	0644	edit dl rm
right-insensitive.png	233	0644	edit dl rm
right.png	184	0644	edit dl rm
setting-buffer-properties.html	7830	0644	edit dl rm
shaping-and-shape-plans.html	8196	0644	edit dl rm
shaping-concepts.html	3869	0644	edit dl rm
shaping-opentype-features.html	6663	0644	edit dl rm
shaping-operations.html	4537	0644	edit dl rm
shaping-plans-and-caching.html	4641	0644	edit dl rm
shaping-shaper-selection.html	3406	0644	edit dl rm
style.css	11606	0644	edit dl rm
text-runs.html	2533	0644	edit dl rm
the-distinction-between-levels-0-and-1.html	4864	0644	edit dl rm
unicode-character-categories.html	4204	0644	edit dl rm
up-insensitive.png	288	0644	edit dl rm
up.png	186	0644	edit dl rm
utilities-common-types-apis.html	4365	0644	edit dl rm
utilities-ucdn.html	2632	0644	edit dl rm
utilities.html	9274	0644	edit dl rm
what-harfbuzz-doesnt-do.html	5535	0644	edit dl rm
what-is-harfbuzz.html	5503	0644	edit dl rm
why-do-i-need-a-shaping-engine.html	8124	0644	edit dl rm
why-is-it-called-harfbuzz.html	2171	0644	edit dl rm
working-with-harfbuzz-clusters.html	10083	0644	edit dl rm

Edit: /usr/share/gtk-doc/html/harfbuzz/integration.html (9936B)

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Platform Integration Guide: HarfBuzz Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="HarfBuzz Manual">
<link rel="up" href="pt01.html" title="Part I. User's manual">
<link rel="prev" href="utilities-ucdn.html" title="UCDN">
<link rel="next" href="integration-freetype.html" title="FreeType integration">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts"></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="pt01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="utilities-ucdn.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="integration-freetype.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="chapter">
<div class="titlepage"><div><div><h2 class="title">
<a name="integration"></a>Platform Integration Guide</h2></div></div></div>
<div class="toc"><dl class="toc">
<dt><span class="section"><a href="integration.html#integration-glib">GNOME integration, GLib, and GObject</a></span></dt>
<dt><span class="section"><a href="integration-freetype.html">FreeType integration</a></span></dt>
<dt><span class="section"><a href="integration-uniscribe.html">Uniscribe integration</a></span></dt>
<dt><span class="section"><a href="integration-coretext.html">Core Text integration</a></span></dt>
<dt><span class="section"><a href="integration-icu.html">ICU integration</a></span></dt>
<dt><span class="section"><a href="integration-python.html">Python bindings</a></span></dt>
</dl></div>
<p>
    HarfBuzz was first developed for use with the GNOME and GTK
    software stack commonly found in desktop Linux
    distributions. Nevertheless, it can be used on other operating
    systems and platforms, from iOS and macOS to Windows. It can also
    be used with other application frameworks and components, such as
    Android, Qt, or application-specific widget libraries.
  </p>
<p>
    This chapter will look at how HarfBuzz fits into a typical
    text-rendering pipeline, and will discuss the APIs available to
    integrate HarfBuzz with contemporary Linux, Mac, and Windows
    software. It will also show how HarfBuzz integrates with popular
    external libraries like FreeType and International Components for
    Unicode (ICU) and describe the HarfBuzz language bindings for
    Python.
  </p>
<p>
    On a GNOME system, HarfBuzz is designed to tie in with several
    other common system libraries. The most common architecture uses
    Pango at the layer directly "above" HarfBuzz; Pango is responsible
    for text segmentation and for ensuring that each input
    <span class="type">hb_buffer_t</span> passed to HarfBuzz for shaping contains
    Unicode code points that share the same segment properties
    (namely, direction, language, and script, but also higher-level
    properties like the active font, font style, and so on).
  </p>
<p>
    The layer directly "below" HarfBuzz is typically FreeType, which
    is used to rasterize glyph outlines at the necessary optical size,
    hinting settings, and pixel resolution. FreeType provides APIs for
    accessing font and face information, so HarfBuzz includes
    functions to create <span class="type">hb_face_t</span> and
    <span class="type">hb_font_t</span> objects directly from FreeType
    objects. HarfBuzz can use FreeType's built-in functions for
    <em class="structfield"><code>font_funcs</code></em> vtable in an <span class="type">hb_font_t</span>.
  </p>
<p>
    FreeType's output is bitmaps of the rasterized glyphs; on a
    typical Linux system these will then be drawn by a graphics
    library like Cairo, but those details are beyond HarfBuzz's
    control. On the other hand, at the top end of the stack, Pango is
    part of the larger GNOME framework, and HarfBuzz does include APIs
    for working with key components of GNOME's higher-level libraries
    — most notably GLib.
  </p>
<p>
    For other operating systems or application frameworks, the
    critical integration points are where HarfBuzz gets font and face
    information about the font used for shaping and where HarfBuzz
    gets Unicode data about the input-buffer code points.
  </p>
<p>
    The font and face information is necessary for text shaping
    because HarfBuzz needs to retrieve the glyph indices for
    particular code points, and to know the extents and advances of
    glyphs. Note that, in an OpenType variable font, both of those
    types of information can change with different variation-axis
    settings.
  </p>
<p>
    The Unicode information is necessary for shaping because the
    properties of a code point (such as its General Category (gc),
    Canonical Combining Class (ccc), and decomposition) can directly
    impact the shaping moves that HarfBuzz performs.
  </p>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="integration-glib"></a>GNOME integration, GLib, and GObject</h2></div></div></div>
<p>
      As mentioned in the preceding section, HarfBuzz offers
      integration APIs to help client programs using the
      GNOME and GTK framework commonly found in desktop Linux
      distributions. 
    </p>
<p>
      GLib is the main utility library for GNOME applications. It
      provides basic data types and conversions, file abstractions,
      string manipulation, and macros, as well as facilities like
      memory allocation and the main event loop.
    </p>
<p>
      Where text shaping is concerned, GLib provides several utilities
      that HarfBuzz can take advantage of, including a set of
      Unicode-data functions and a data type for script
      information. Both are useful when working with HarfBuzz
      buffers. To make use of them, you will need to include the
      <code class="filename">hb-glib.h</code> header file.
    </p>
<p>
      GLib's <a class="ulink" href="https://developer.gnome.org/glib/stable/glib-Unicode-Manipulation.html" target="_top">Unicode
      manipulation API</a> includes all the functionality
      necessary to retrieve Unicode data for the
      <em class="structfield"><code>unicode_funcs</code></em> structure of a HarfBuzz
      <span class="type">hb_buffer_t</span>. 
    </p>
<p>
      The function <code class="function">hb_glib_get_unicode_funcs()</code>
      sets up a <span class="type">hb_unicode_funcs_t</span> structure configured
      with the GLib Unicode functions and returns a pointer to it.
    </p>
<p>
      You can attach this Unicode-functions structure to your buffer,
      and it will be ready for use with GLib:
    </p>
<pre class="programlisting">
      #include &lt;hb-glib.h&gt;
      ...
      hb_unicode_funcs_t *glibufunctions;
      glibufunctions = hb_glib_get_unicode_funcs();
      hb_buffer_set_unicode_funcs(buf, glibufunctions);
    </pre>
<p>
      For script information, GLib uses the
      <span class="type">GUnicodeScript</span> type. Like HarfBuzz's own
      <span class="type">hb_script_t</span>, this data type is an enumeration
      of Unicode scripts, but text segments passed in from GLib code
      will be tagged with a <span class="type">GUnicodeScript</span>. Therefore,
      when setting the script property on a <span class="type">hb_buffer_t</span>,
      you will need to convert between the <span class="type">GUnicodeScript</span>
      of the input provided by GLib and HarfBuzz's
      <span class="type">hb_script_t</span> type.
    </p>
<p>
      The <code class="function">hb_glib_script_to_script()</code> function
      takes an <span class="type">GUnicodeScript</span> script identifier as its
      sole argument and returns the corresponding <span class="type">hb_script_t</span>.
      The <code class="function">hb_glib_script_from_script()</code> does the
      reverse, taking an <span class="type">hb_script_t</span> and returning the
      <span class="type">GUnicodeScript</span> identifier for GLib.
    </p>
<p>
      Finally, GLib also provides a reference-counted object type called <a class="ulink" href="https://developer.gnome.org/glib/stable/glib-Byte-Arrays.html#GBytes" target="_top"><span class="type">GBytes</span></a>
      that is used for accessing raw memory segments with the benefits
      of GLib's lifecycle management. HarfBuzz provides a
      <code class="function">hb_glib_blob_create()</code> function that lets
      you create an <span class="type">hb_blob_t</span> directly from a
      <span class="type">GBytes</span> object. This function takes only the
      <span class="type">GBytes</span> object as its input; HarfBuzz registers the
      GLib <code class="function">destroy</code> callback automatically.
    </p>
<p>
      The GNOME platform also features an object system called
      GObject. For HarfBuzz, the main advantage of GObject is a
      feature called <a class="ulink" href="https://gi.readthedocs.io/en/latest/" target="_top">GObject
      Introspection</a>. This is a middleware facility that can be
      used to generate language bindings for C libraries. HarfBuzz uses it
      to build its Python bindings, which we will look at in a separate section.
    </p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>

cmd: