2 * Copyright © 1998-2004 David Turner and Werner Lemberg
3 * Copyright © 2004,2007,2009 Red Hat, Inc.
4 * Copyright © 2011 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"
43 typedef struct _hb_buffer_t hb_buffer_t;
45 typedef struct _hb_glyph_info_t {
46 hb_codepoint_t codepoint;
55 typedef struct _hb_glyph_position_t {
56 hb_position_t x_advance;
57 hb_position_t y_advance;
58 hb_position_t x_offset;
59 hb_position_t y_offset;
63 } hb_glyph_position_t;
67 hb_buffer_create (void);
70 hb_buffer_get_empty (void);
73 hb_buffer_reference (hb_buffer_t *buffer);
76 hb_buffer_destroy (hb_buffer_t *buffer);
79 hb_buffer_set_user_data (hb_buffer_t *buffer,
80 hb_user_data_key_t *key,
82 hb_destroy_func_t destroy,
86 hb_buffer_get_user_data (hb_buffer_t *buffer,
87 hb_user_data_key_t *key);
91 hb_buffer_set_unicode_funcs (hb_buffer_t *buffer,
92 hb_unicode_funcs_t *unicode_funcs);
95 hb_buffer_get_unicode_funcs (hb_buffer_t *buffer);
98 hb_buffer_set_direction (hb_buffer_t *buffer,
99 hb_direction_t direction);
102 hb_buffer_get_direction (hb_buffer_t *buffer);
105 hb_buffer_set_script (hb_buffer_t *buffer,
109 hb_buffer_get_script (hb_buffer_t *buffer);
112 hb_buffer_set_language (hb_buffer_t *buffer,
113 hb_language_t language);
116 hb_buffer_get_language (hb_buffer_t *buffer);
119 /* Resets the buffer. Afterwards it's as if it was just created,
120 * except that it has a larger buffer allocated perhaps... */
122 hb_buffer_reset (hb_buffer_t *buffer);
124 /* Returns false if allocation failed */
126 hb_buffer_pre_allocate (hb_buffer_t *buffer,
130 /* Returns false if allocation has failed before */
132 hb_buffer_allocation_successful (hb_buffer_t *buffer);
135 hb_buffer_reverse (hb_buffer_t *buffer);
138 hb_buffer_reverse_clusters (hb_buffer_t *buffer);
141 hb_buffer_guess_properties (hb_buffer_t *buffer);
144 /* Filling the buffer in */
147 hb_buffer_add (hb_buffer_t *buffer,
148 hb_codepoint_t codepoint,
150 unsigned int cluster);
153 hb_buffer_add_utf8 (hb_buffer_t *buffer,
156 unsigned int item_offset,
160 hb_buffer_add_utf16 (hb_buffer_t *buffer,
161 const uint16_t *text,
163 unsigned int item_offset,
167 hb_buffer_add_utf32 (hb_buffer_t *buffer,
168 const uint32_t *text,
170 unsigned int item_offset,
174 /* Clears any new items added at the end */
176 hb_buffer_set_length (hb_buffer_t *buffer,
177 unsigned int length);
179 /* Return value valid as long as buffer not modified */
181 hb_buffer_get_length (hb_buffer_t *buffer);
183 /* Getting glyphs out of the buffer */
185 /* Return value valid as long as buffer not modified */
187 hb_buffer_get_glyph_infos (hb_buffer_t *buffer,
188 unsigned int *length);
190 /* Return value valid as long as buffer not modified */
191 hb_glyph_position_t *
192 hb_buffer_get_glyph_positions (hb_buffer_t *buffer,
193 unsigned int *length);
198 #endif /* HB_BUFFER_H */