1/*
2 * Copyright © 2009 Red Hat, Inc.
3 * Copyright © 2012 Google, Inc.
4 *
5 * This is part of HarfBuzz, a text shaping library.
6 *
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.
12 *
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
17 * DAMAGE.
18 *
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.
24 *
25 * Red Hat Author(s): Behdad Esfahbod
26 * Google Author(s): Behdad Esfahbod
27 */
28
29#include "hb.hh"
30
31#include "hb-shaper.hh"
32#include "hb-shape-plan.hh"
33#include "hb-buffer.hh"
34#include "hb-font.hh"
35#include "hb-machinery.hh"
36
37/**
38 * SECTION:hb-shape
39 * @title: Shaping
40 * @short_description: Conversion of text strings into positioned glyphs
41 * @include: hb.h
42 *
43 * Shaping is the central operation of HarfBuzz. Shaping operates on buffers,
44 * which are sequences of Unicode characters that use the same font and have
45 * the same text direction, script and language. After shaping the buffer
46 * contains the output glyphs and their positions.
47 **/
48
49#ifdef HB_USE_ATEXIT
50static void free_static_shaper_list (void);
51#endif
52
53static const char *nil_shaper_list[] = {nullptr};
54
55static struct hb_shaper_list_lazy_loader_t : hb_lazy_loader_t<const char *,
56 hb_shaper_list_lazy_loader_t>
57{
58 static inline const char ** create (void)
59 {
60 const char **shaper_list = (const char **) calloc (1 + HB_SHAPERS_COUNT, sizeof (const char *));
61 if (unlikely (!shaper_list))
62 return nullptr;
63
64 const hb_shaper_pair_t *shapers = _hb_shapers_get ();
65 unsigned int i;
66 for (i = 0; i < HB_SHAPERS_COUNT; i++)
67 shaper_list[i] = shapers[i].name;
68 shaper_list[i] = nullptr;
69
70#ifdef HB_USE_ATEXIT
71 atexit (free_static_shaper_list);
72#endif
73
74 return shaper_list;
75 }
76 static inline void destroy (const char **l)
77 {
78 free (l);
79 }
80 static inline const char ** get_null (void)
81 {
82 return nil_shaper_list;
83 }
84} static_shaper_list;
85
86#ifdef HB_USE_ATEXIT
87static
88void free_static_shaper_list (void)
89{
90 static_shaper_list.free_instance ();
91}
92#endif
93
94
95/**
96 * hb_shape_list_shapers:
97 *
98 * Retrieves the list of shapers supported by HarfBuzz.
99 *
100 * Return value: (transfer none) (array zero-terminated=1): an array of
101 * constant strings
102 *
103 * Since: 0.9.2
104 **/
105const char **
106hb_shape_list_shapers (void)
107{
108 return static_shaper_list.get_unconst ();
109}
110
111
112/**
113 * hb_shape_full:
114 * @font: an #hb_font_t to use for shaping
115 * @buffer: an #hb_buffer_t to shape
116 * @features: (array length=num_features) (allow-none): an array of user
117 * specified #hb_feature_t or %NULL
118 * @num_features: the length of @features array
119 * @shaper_list: (array zero-terminated=1) (allow-none): a %NULL-terminated
120 * array of shapers to use or %NULL
121 *
122 * See hb_shape() for details. If @shaper_list is not %NULL, the specified
123 * shapers will be used in the given order, otherwise the default shapers list
124 * will be used.
125 *
126 * Return value: false if all shapers failed, true otherwise
127 *
128 * Since: 0.9.2
129 **/
130hb_bool_t
131hb_shape_full (hb_font_t *font,
132 hb_buffer_t *buffer,
133 const hb_feature_t *features,
134 unsigned int num_features,
135 const char * const *shaper_list)
136{
137 hb_shape_plan_t *shape_plan = hb_shape_plan_create_cached2 (font->face, &buffer->props,
138 features, num_features,
139 font->coords, font->num_coords,
140 shaper_list);
141 hb_bool_t res = hb_shape_plan_execute (shape_plan, font, buffer, features, num_features);
142 hb_shape_plan_destroy (shape_plan);
143
144 if (res)
145 buffer->content_type = HB_BUFFER_CONTENT_TYPE_GLYPHS;
146 return res;
147}
148
149/**
150 * hb_shape:
151 * @font: an #hb_font_t to use for shaping
152 * @buffer: an #hb_buffer_t to shape
153 * @features: (array length=num_features) (allow-none): an array of user
154 * specified #hb_feature_t or %NULL
155 * @num_features: the length of @features array
156 *
157 * Shapes @buffer using @font turning its Unicode characters content to
158 * positioned glyphs. If @features is not %NULL, it will be used to control the
159 * features applied during shaping.
160 *
161 * Since: 0.9.2
162 **/
163void
164hb_shape (hb_font_t *font,
165 hb_buffer_t *buffer,
166 const hb_feature_t *features,
167 unsigned int num_features)
168{
169 hb_shape_full (font, buffer, features, num_features, nullptr);
170}
171