2 * Copyright © 1998-2004 David Turner and Werner Lemberg
3 * Copyright © 2004,2007,2009 Red Hat, Inc.
4 * Copyright © 2011,2012 Google, Inc.
6 * This is part of HarfBuzz, a text shaping library.
8 * Permission is hereby granted, without written agreement and without
9 * license or royalty fees, to use, copy, modify, and distribute this
10 * software and its documentation for any purpose, provided that the
11 * above copyright notice and the following two paragraphs appear in
12 * all copies of this software.
14 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
15 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
16 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
17 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
20 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
21 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
22 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
23 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
24 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
26 * Red Hat Author(s): Owen Taylor, Behdad Esfahbod
27 * Google Author(s): Behdad Esfahbod
31 #error "Include <hb.h> instead."
37 #include "hb-common.h"
38 #include "hb-unicode.h"
44 typedef struct hb_glyph_info_t {
45 hb_codepoint_t codepoint;
54 typedef struct hb_glyph_position_t {
55 hb_position_t x_advance;
56 hb_position_t y_advance;
57 hb_position_t x_offset;
58 hb_position_t y_offset;
62 } hb_glyph_position_t;
65 typedef struct hb_segment_properties_t {
66 hb_direction_t direction;
68 hb_language_t language;
72 } hb_segment_properties_t;
74 #define HB_SEGMENT_PROPERTIES_DEFAULT {HB_DIRECTION_INVALID, \
76 HB_LANGUAGE_INVALID, \
81 hb_segment_properties_equal (const hb_segment_properties_t *a,
82 const hb_segment_properties_t *b);
85 hb_segment_properties_hash (const hb_segment_properties_t *p);
93 typedef struct hb_buffer_t hb_buffer_t;
96 hb_buffer_create (void);
99 hb_buffer_get_empty (void);
102 hb_buffer_reference (hb_buffer_t *buffer);
105 hb_buffer_destroy (hb_buffer_t *buffer);
108 hb_buffer_set_user_data (hb_buffer_t *buffer,
109 hb_user_data_key_t *key,
111 hb_destroy_func_t destroy,
115 hb_buffer_get_user_data (hb_buffer_t *buffer,
116 hb_user_data_key_t *key);
120 HB_BUFFER_CONTENT_TYPE_INVALID = 0,
121 HB_BUFFER_CONTENT_TYPE_UNICODE,
122 HB_BUFFER_CONTENT_TYPE_GLYPHS
123 } hb_buffer_content_type_t;
126 hb_buffer_set_content_type (hb_buffer_t *buffer,
127 hb_buffer_content_type_t content_type);
129 hb_buffer_content_type_t
130 hb_buffer_get_content_type (hb_buffer_t *buffer);
134 hb_buffer_set_unicode_funcs (hb_buffer_t *buffer,
135 hb_unicode_funcs_t *unicode_funcs);
138 hb_buffer_get_unicode_funcs (hb_buffer_t *buffer);
141 hb_buffer_set_direction (hb_buffer_t *buffer,
142 hb_direction_t direction);
145 hb_buffer_get_direction (hb_buffer_t *buffer);
148 hb_buffer_set_script (hb_buffer_t *buffer,
152 hb_buffer_get_script (hb_buffer_t *buffer);
155 hb_buffer_set_language (hb_buffer_t *buffer,
156 hb_language_t language);
160 hb_buffer_get_language (hb_buffer_t *buffer);
163 hb_buffer_set_segment_properties (hb_buffer_t *buffer,
164 const hb_segment_properties_t *props);
167 hb_buffer_get_segment_properties (hb_buffer_t *buffer,
168 hb_segment_properties_t *props);
171 hb_buffer_guess_segment_properties (hb_buffer_t *buffer);
175 HB_BUFFER_FLAGS_DEFAULT = 0x00000000,
176 HB_BUFFER_FLAG_BOT = 0x00000001, /* Beginning-of-text */
177 HB_BUFFER_FLAG_EOT = 0x00000002, /* End-of-text */
178 HB_BUFFER_FLAG_PRESERVE_DEFAULT_IGNORABLES = 0x00000004
182 hb_buffer_set_flags (hb_buffer_t *buffer,
183 hb_buffer_flags_t flags);
186 hb_buffer_get_flags (hb_buffer_t *buffer);
189 /* Resets the buffer. Afterwards it's as if it was just created,
190 * except that it has a larger buffer allocated perhaps... */
192 hb_buffer_reset (hb_buffer_t *buffer);
194 /* Like reset, but does NOT clear unicode_funcs. */
196 hb_buffer_clear_contents (hb_buffer_t *buffer);
198 /* Returns false if allocation failed */
200 hb_buffer_pre_allocate (hb_buffer_t *buffer,
204 /* Returns false if allocation has failed before */
206 hb_buffer_allocation_successful (hb_buffer_t *buffer);
209 hb_buffer_reverse (hb_buffer_t *buffer);
212 hb_buffer_reverse_clusters (hb_buffer_t *buffer);
215 /* Filling the buffer in */
218 hb_buffer_add (hb_buffer_t *buffer,
219 hb_codepoint_t codepoint,
220 unsigned int cluster);
223 hb_buffer_add_utf8 (hb_buffer_t *buffer,
226 unsigned int item_offset,
230 hb_buffer_add_utf16 (hb_buffer_t *buffer,
231 const uint16_t *text,
233 unsigned int item_offset,
237 hb_buffer_add_utf32 (hb_buffer_t *buffer,
238 const uint32_t *text,
240 unsigned int item_offset,
244 /* Clears any new items added at the end */
246 hb_buffer_set_length (hb_buffer_t *buffer,
247 unsigned int length);
249 /* Return value valid as long as buffer not modified */
251 hb_buffer_get_length (hb_buffer_t *buffer);
253 /* Getting glyphs out of the buffer */
255 /* Return value valid as long as buffer not modified */
257 hb_buffer_get_glyph_infos (hb_buffer_t *buffer,
258 unsigned int *length);
260 /* Return value valid as long as buffer not modified */
261 hb_glyph_position_t *
262 hb_buffer_get_glyph_positions (hb_buffer_t *buffer,
263 unsigned int *length);
266 /* Reorders a glyph buffer to have canonical in-cluster glyph order / position.
267 * The resulting clusters should behave identical to pre-reordering clusters.
268 * NOTE: This has nothing to do with Unicode normalization. */
270 hb_buffer_normalize_glyphs (hb_buffer_t *buffer);
278 HB_BUFFER_SERIALIZE_FLAGS_DEFAULT = 0x00000000,
279 HB_BUFFER_SERIALIZE_FLAG_NO_CLUSTERS = 0x00000001,
280 HB_BUFFER_SERIALIZE_FLAG_NO_POSITIONS = 0x00000002,
281 HB_BUFFER_SERIALIZE_FLAG_NO_GLYPH_NAMES = 0x00000004
282 } hb_buffer_serialize_flags_t;
285 HB_BUFFER_SERIALIZE_FORMAT_TEXT = HB_TAG('T','E','X','T'),
286 HB_BUFFER_SERIALIZE_FORMAT_JSON = HB_TAG('J','S','O','N'),
287 HB_BUFFER_SERIALIZE_FORMAT_INVALID = HB_TAG_NONE
288 } hb_buffer_serialize_format_t;
290 /* len=-1 means str is NUL-terminated. */
291 hb_buffer_serialize_format_t
292 hb_buffer_serialize_format_from_string (const char *str, int len);
295 hb_buffer_serialize_format_to_string (hb_buffer_serialize_format_t format);
298 hb_buffer_serialize_list_formats (void);
300 /* Returns number of items, starting at start, that were serialized. */
302 hb_buffer_serialize_glyphs (hb_buffer_t *buffer,
306 unsigned int buf_size,
307 unsigned int *buf_consumed, /* May be NULL */
308 hb_font_t *font, /* May be NULL */
309 hb_buffer_serialize_format_t format,
310 hb_buffer_serialize_flags_t flags);
313 hb_buffer_deserialize_glyphs (hb_buffer_t *buffer,
315 int buf_len, /* -1 means nul-terminated */
316 const char **end_ptr, /* May be NULL */
317 hb_font_t *font, /* May be NULL */
318 hb_buffer_serialize_format_t format);
323 #endif /* HB_BUFFER_H */