2 * Copyright © 2009 Red Hat, Inc.
3 * Copyright © 2012 Google, Inc.
5 * This is part of HarfBuzz, a text shaping library.
7 * Permission is hereby granted, without written agreement and without
8 * license or royalty fees, to use, copy, modify, and distribute this
9 * software and its documentation for any purpose, provided that the
10 * above copyright notice and the following two paragraphs appear in
11 * all copies of this software.
13 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
14 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
15 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
16 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
19 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
20 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
21 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
22 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
23 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
25 * Red Hat Author(s): Behdad Esfahbod
26 * Google Author(s): Behdad Esfahbod
29 #include "hb-private.hh"
31 #include "hb-shaper-private.hh"
32 #include "hb-shape-plan-private.hh"
33 #include "hb-buffer-private.hh"
34 #include "hb-font-private.hh"
39 * @short_description: Conversion of text strings into positioned glyphs
42 * Shaping is the central operation of HarfBuzz. Shaping operates on buffers,
43 * which are sequences of Unicode characters that use the same font and have
44 * the same text direction, script and language. After shaping the buffer
45 * contains the output glyphs and their positions.
48 static const char **static_shaper_list;
52 void free_static_shaper_list (void)
55 const char **shaper_list = (const char **) hb_atomic_ptr_get (&static_shaper_list);
56 if (!hb_atomic_ptr_cmpexch (&static_shaper_list, shaper_list, nullptr))
64 * hb_shape_list_shapers:
66 * Retrieves the list of shapers supported by HarfBuzz.
68 * Return value: (transfer none) (array zero-terminated=1): an array of
74 hb_shape_list_shapers (void)
77 const char **shaper_list = (const char **) hb_atomic_ptr_get (&static_shaper_list);
79 if (unlikely (!shaper_list))
81 /* Not found; allocate one. */
82 shaper_list = (const char **) calloc (1 + HB_SHAPERS_COUNT, sizeof (const char *));
83 if (unlikely (!shaper_list)) {
84 static const char *nil_shaper_list[] = {nullptr};
85 return nil_shaper_list;
88 const hb_shaper_pair_t *shapers = _hb_shapers_get ();
90 for (i = 0; i < HB_SHAPERS_COUNT; i++)
91 shaper_list[i] = shapers[i].name;
92 shaper_list[i] = nullptr;
94 if (!hb_atomic_ptr_cmpexch (&static_shaper_list, nullptr, shaper_list)) {
100 atexit (free_static_shaper_list); /* First person registers atexit() callback. */
110 * @font: an #hb_font_t to use for shaping
111 * @buffer: an #hb_buffer_t to shape
112 * @features: (array length=num_features) (allow-none): an array of user
113 * specified #hb_feature_t or %NULL
114 * @num_features: the length of @features array
115 * @shaper_list: (array zero-terminated=1) (allow-none): a %NULL-terminated
116 * array of shapers to use or %NULL
118 * See hb_shape() for details. If @shaper_list is not %NULL, the specified
119 * shapers will be used in the given order, otherwise the default shapers list
122 * Return value: false if all shapers failed, true otherwise
127 hb_shape_full (hb_font_t *font,
129 const hb_feature_t *features,
130 unsigned int num_features,
131 const char * const *shaper_list)
133 hb_shape_plan_t *shape_plan = hb_shape_plan_create_cached2 (font->face, &buffer->props,
134 features, num_features,
135 font->coords, font->num_coords,
137 hb_bool_t res = hb_shape_plan_execute (shape_plan, font, buffer, features, num_features);
138 hb_shape_plan_destroy (shape_plan);
141 buffer->content_type = HB_BUFFER_CONTENT_TYPE_GLYPHS;
147 * @font: an #hb_font_t to use for shaping
148 * @buffer: an #hb_buffer_t to shape
149 * @features: (array length=num_features) (allow-none): an array of user
150 * specified #hb_feature_t or %NULL
151 * @num_features: the length of @features array
153 * Shapes @buffer using @font turning its Unicode characters content to
154 * positioned glyphs. If @features is not %NULL, it will be used to control the
155 * features applied during shaping.
160 hb_shape (hb_font_t *font,
162 const hb_feature_t *features,
163 unsigned int num_features)
165 hb_shape_full (font, buffer, features, num_features, nullptr);