2 * Copyright © 1998-2004 David Turner and Werner Lemberg
3 * Copyright © 2004,2007,2009,2010 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
30 #include "hb-buffer-private.hh"
37 static hb_buffer_t _hb_buffer_nil = {
38 HB_OBJECT_HEADER_STATIC,
40 &_hb_unicode_funcs_default,
48 TRUE, /* have_output */
49 TRUE /* have_positions */
52 /* Here is how the buffer works internally:
54 * There are two info pointers: info and out_info. They always have
55 * the same allocated size, but different lengths.
57 * As an optimization, both info and out_info may point to the
58 * same piece of memory, which is owned by info. This remains the
59 * case as long as out_len doesn't exceed i at any time.
60 * In that case, swap() is no-op and the glyph operations operate
63 * As soon as out_info gets longer than info, out_info is moved over
64 * to an alternate buffer (which we reuse the pos buffer for!), and its
65 * current contents (out_len entries) are copied to the new place.
66 * This should all remain transparent to the user. swap() then
67 * switches info and out_info.
72 _hb_buffer_enlarge (hb_buffer_t *buffer, unsigned int size)
74 if (unlikely (buffer->in_error))
77 unsigned int new_allocated = buffer->allocated;
78 hb_glyph_position_t *new_pos = NULL;
79 hb_glyph_info_t *new_info = NULL;
80 bool separate_out = buffer->out_info != buffer->info;
82 if (unlikely (_hb_unsigned_int_mul_overflows (size, sizeof (buffer->info[0]))))
85 while (size > new_allocated)
86 new_allocated += (new_allocated >> 1) + 32;
88 ASSERT_STATIC (sizeof (buffer->info[0]) == sizeof (buffer->pos[0]));
89 if (unlikely (_hb_unsigned_int_mul_overflows (new_allocated, sizeof (buffer->info[0]))))
92 new_pos = (hb_glyph_position_t *) realloc (buffer->pos, new_allocated * sizeof (buffer->pos[0]));
93 new_info = (hb_glyph_info_t *) realloc (buffer->info, new_allocated * sizeof (buffer->info[0]));
96 if (unlikely (!new_pos || !new_info))
97 buffer->in_error = TRUE;
100 buffer->pos = new_pos;
102 if (likely (new_info))
103 buffer->info = new_info;
105 buffer->out_info = separate_out ? (hb_glyph_info_t *) buffer->pos : buffer->info;
106 if (likely (!buffer->in_error))
107 buffer->allocated = new_allocated;
109 return likely (!buffer->in_error);
112 static inline hb_bool_t
113 _hb_buffer_ensure (hb_buffer_t *buffer, unsigned int size)
115 return likely (size <= buffer->allocated) ? TRUE : _hb_buffer_enlarge (buffer, size);
118 static inline hb_bool_t
119 _hb_buffer_ensure_separate (hb_buffer_t *buffer, unsigned int size)
121 if (unlikely (!size || !_hb_buffer_ensure (buffer, size))) return FALSE;
123 if (buffer->out_info == buffer->info)
125 assert (buffer->have_output);
127 buffer->out_info = (hb_glyph_info_t *) buffer->pos;
128 memcpy (buffer->out_info, buffer->info, buffer->out_len * sizeof (buffer->out_info[0]));
138 hb_buffer_create (unsigned int pre_alloc_size)
142 if (!(buffer = hb_object_create<hb_buffer_t> ()))
143 return &_hb_buffer_nil;
145 hb_buffer_reset (buffer);
147 if (pre_alloc_size && !_hb_buffer_ensure (buffer, pre_alloc_size)) {
148 hb_buffer_destroy (buffer);
149 return &_hb_buffer_nil;
156 hb_buffer_get_empty (void)
158 return &_hb_buffer_nil;
162 hb_buffer_reference (hb_buffer_t *buffer)
164 return hb_object_reference (buffer);
168 hb_buffer_destroy (hb_buffer_t *buffer)
170 if (!hb_object_destroy (buffer)) return;
172 hb_unicode_funcs_destroy (buffer->unicode);
181 hb_buffer_set_user_data (hb_buffer_t *buffer,
182 hb_user_data_key_t *key,
184 hb_destroy_func_t destroy)
186 return hb_object_set_user_data (buffer, key, data, destroy);
190 hb_buffer_get_user_data (hb_buffer_t *buffer,
191 hb_user_data_key_t *key)
193 return hb_object_get_user_data (buffer, key);
198 hb_buffer_set_unicode_funcs (hb_buffer_t *buffer,
199 hb_unicode_funcs_t *unicode)
201 if (unlikely (hb_object_is_inert (buffer)))
205 unicode = _hb_buffer_nil.unicode;
207 hb_unicode_funcs_reference (unicode);
208 hb_unicode_funcs_destroy (buffer->unicode);
209 buffer->unicode = unicode;
213 hb_buffer_get_unicode_funcs (hb_buffer_t *buffer)
215 return buffer->unicode;
219 hb_buffer_set_direction (hb_buffer_t *buffer,
220 hb_direction_t direction)
223 if (unlikely (hb_object_is_inert (buffer)))
226 buffer->props.direction = direction;
230 hb_buffer_get_direction (hb_buffer_t *buffer)
232 return buffer->props.direction;
236 hb_buffer_set_script (hb_buffer_t *buffer,
239 if (unlikely (hb_object_is_inert (buffer)))
242 buffer->props.script = script;
246 hb_buffer_get_script (hb_buffer_t *buffer)
248 return buffer->props.script;
252 hb_buffer_set_language (hb_buffer_t *buffer,
253 hb_language_t language)
255 if (unlikely (hb_object_is_inert (buffer)))
258 buffer->props.language = language;
262 hb_buffer_get_language (hb_buffer_t *buffer)
264 return buffer->props.language;
269 hb_buffer_reset (hb_buffer_t *buffer)
271 if (unlikely (hb_object_is_inert (buffer)))
274 hb_unicode_funcs_destroy (buffer->unicode);
275 buffer->unicode = _hb_buffer_nil.unicode;
277 buffer->props = _hb_buffer_nil.props;
279 buffer->in_error = FALSE;
280 buffer->have_output = FALSE;
281 buffer->have_positions = FALSE;
289 buffer->out_info = buffer->info;
293 hb_buffer_pre_allocate (hb_buffer_t *buffer, unsigned int size)
295 return _hb_buffer_ensure (buffer, size);
299 hb_buffer_allocation_successful (hb_buffer_t *buffer)
301 return !buffer->in_error;
305 hb_buffer_add (hb_buffer_t *buffer,
306 hb_codepoint_t codepoint,
308 unsigned int cluster)
310 hb_glyph_info_t *glyph;
312 if (unlikely (!_hb_buffer_ensure (buffer, buffer->len + 1))) return;
314 glyph = &buffer->info[buffer->len];
316 memset (glyph, 0, sizeof (*glyph));
317 glyph->codepoint = codepoint;
319 glyph->cluster = cluster;
324 /* HarfBuzz-Internal API */
327 _hb_buffer_clear_output (hb_buffer_t *buffer)
329 if (unlikely (hb_object_is_inert (buffer)))
332 buffer->have_output = TRUE;
333 buffer->have_positions = FALSE;
336 buffer->out_info = buffer->info;
340 _hb_buffer_clear_positions (hb_buffer_t *buffer)
342 if (unlikely (hb_object_is_inert (buffer)))
345 buffer->have_output = FALSE;
346 buffer->have_positions = TRUE;
348 memset (buffer->pos, 0, sizeof (buffer->pos[0]) * buffer->len);
352 _hb_buffer_swap (hb_buffer_t *buffer)
354 if (unlikely (buffer->in_error)) return;
356 assert (buffer->have_output);
358 if (buffer->out_info != buffer->info)
360 hb_glyph_info_t *tmp_string;
361 tmp_string = buffer->info;
362 buffer->info = buffer->out_info;
363 buffer->out_info = tmp_string;
364 buffer->pos = (hb_glyph_position_t *) buffer->out_info;
369 buffer->len = buffer->out_len;
370 buffer->out_len = tmp;
376 _hb_buffer_replace_glyphs_be16 (hb_buffer_t *buffer,
378 unsigned int num_out,
379 const uint16_t *glyph_data_be)
381 if (buffer->out_info != buffer->info ||
382 buffer->out_len + num_out > buffer->i + num_in)
384 if (unlikely (!_hb_buffer_ensure_separate (buffer, buffer->out_len + num_out)))
388 hb_glyph_info_t orig_info = buffer->info[buffer->i];
389 for (unsigned int i = 1; i < num_in; i++)
391 hb_glyph_info_t *info = &buffer->info[buffer->i + i];
392 orig_info.cluster = MIN (orig_info.cluster, info->cluster);
395 for (unsigned int i = 0; i < num_out; i++)
397 hb_glyph_info_t *info = &buffer->out_info[buffer->out_len + i];
399 info->codepoint = hb_be_uint16 (glyph_data_be[i]);
403 buffer->out_len += num_out;
407 _hb_buffer_output_glyph (hb_buffer_t *buffer,
408 hb_codepoint_t glyph_index)
410 hb_glyph_info_t *info;
412 if (buffer->out_info != buffer->info)
414 if (unlikely (!_hb_buffer_ensure (buffer, buffer->out_len + 1))) return;
415 buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
417 else if (buffer->out_len != buffer->i)
418 buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
420 info = &buffer->out_info[buffer->out_len];
421 info->codepoint = glyph_index;
427 _hb_buffer_replace_glyph (hb_buffer_t *buffer,
428 hb_codepoint_t glyph_index)
430 _hb_buffer_output_glyph (buffer, glyph_index);
431 _hb_buffer_skip_glyph (buffer);
435 _hb_buffer_skip_glyph (hb_buffer_t *buffer)
441 _hb_buffer_next_glyph (hb_buffer_t *buffer)
443 if (buffer->have_output)
445 if (buffer->out_info != buffer->info)
447 if (unlikely (!_hb_buffer_ensure (buffer, buffer->out_len + 1))) return;
448 buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
450 else if (buffer->out_len != buffer->i)
451 buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
460 _hb_buffer_reset_masks (hb_buffer_t *buffer,
463 unsigned int count = buffer->len;
464 for (unsigned int i = 0; i < count; i++)
465 buffer->info[i].mask = mask;
469 _hb_buffer_add_masks (hb_buffer_t *buffer,
472 unsigned int count = buffer->len;
473 for (unsigned int i = 0; i < count; i++)
474 buffer->info[i].mask |= mask;
478 _hb_buffer_set_masks (hb_buffer_t *buffer,
481 unsigned int cluster_start,
482 unsigned int cluster_end)
484 hb_mask_t not_mask = ~mask;
490 if (cluster_start == 0 && cluster_end == (unsigned int)-1) {
491 unsigned int count = buffer->len;
492 for (unsigned int i = 0; i < count; i++)
493 buffer->info[i].mask = (buffer->info[i].mask & not_mask) | value;
497 unsigned int count = buffer->len;
498 for (unsigned int i = 0; i < count; i++)
499 if (cluster_start <= buffer->info[i].cluster && buffer->info[i].cluster < cluster_end)
500 buffer->info[i].mask = (buffer->info[i].mask & not_mask) | value;
504 /* Public API again */
507 hb_buffer_set_length (hb_buffer_t *buffer,
510 if (!_hb_buffer_ensure (buffer, length))
513 /* Wipe the new space */
514 if (length > buffer->len) {
515 memset (buffer->info + buffer->len, 0, sizeof (buffer->info[0]) * (length - buffer->len));
516 if (buffer->have_positions)
517 memset (buffer->pos + buffer->len, 0, sizeof (buffer->pos[0]) * (length - buffer->len));
520 buffer->len = length;
525 hb_buffer_get_length (hb_buffer_t *buffer)
530 /* Return value valid as long as buffer not modified */
532 hb_buffer_get_glyph_infos (hb_buffer_t *buffer,
533 unsigned int *length)
536 *length = buffer->len;
538 return (hb_glyph_info_t *) buffer->info;
541 /* Return value valid as long as buffer not modified */
542 hb_glyph_position_t *
543 hb_buffer_get_glyph_positions (hb_buffer_t *buffer,
544 unsigned int *length)
546 if (!buffer->have_positions)
547 _hb_buffer_clear_positions (buffer);
550 *length = buffer->len;
552 return (hb_glyph_position_t *) buffer->pos;
557 reverse_range (hb_buffer_t *buffer,
563 if (start == end - 1)
566 for (i = start, j = end - 1; i < j; i++, j--) {
570 buffer->info[i] = buffer->info[j];
575 for (i = start, j = end - 1; i < j; i++, j--) {
576 hb_glyph_position_t t;
579 buffer->pos[i] = buffer->pos[j];
586 hb_buffer_reverse (hb_buffer_t *buffer)
588 if (unlikely (!buffer->len))
591 reverse_range (buffer, 0, buffer->len);
595 hb_buffer_reverse_clusters (hb_buffer_t *buffer)
597 unsigned int i, start, count, last_cluster;
599 if (unlikely (!buffer->len))
602 hb_buffer_reverse (buffer);
606 last_cluster = buffer->info[0].cluster;
607 for (i = 1; i < count; i++) {
608 if (last_cluster != buffer->info[i].cluster) {
609 reverse_range (buffer, start, i);
611 last_cluster = buffer->info[i].cluster;
614 reverse_range (buffer, start, i);
620 const T *next = (const T *) text + item_offset; \
621 const T *end = next + item_length; \
622 while (next < end) { \
624 const T *old_next = next; \
625 next = UTF_NEXT (next, end, u); \
626 hb_buffer_add (buffer, u, 1, old_next - (const T *) text); \
631 #define UTF8_COMPUTE(Char, Mask, Len) \
632 if (Char < 128) { Len = 1; Mask = 0x7f; } \
633 else if ((Char & 0xe0) == 0xc0) { Len = 2; Mask = 0x1f; } \
634 else if ((Char & 0xf0) == 0xe0) { Len = 3; Mask = 0x0f; } \
635 else if ((Char & 0xf8) == 0xf0) { Len = 4; Mask = 0x07; } \
638 static inline const uint8_t *
639 hb_utf8_next (const uint8_t *text,
641 hb_codepoint_t *unicode)
644 unsigned int mask, len;
646 /* TODO check for overlong sequences? */
648 UTF8_COMPUTE (c, mask, len);
649 if (unlikely (!len || (unsigned int) (end - text) < len)) {
653 hb_codepoint_t result;
656 for (i = 1; i < len; i++)
658 if (unlikely ((text[i] & 0xc0) != 0x80))
664 result |= (text[i] & 0x3f);
672 hb_buffer_add_utf8 (hb_buffer_t *buffer,
674 unsigned int text_length HB_UNUSED,
675 unsigned int item_offset,
676 unsigned int item_length)
678 #define UTF_NEXT(S, E, U) hb_utf8_next (S, E, &(U))
683 static inline const uint16_t *
684 hb_utf16_next (const uint16_t *text,
686 hb_codepoint_t *unicode)
688 uint16_t c = *text++;
690 if (unlikely (c >= 0xd800 && c < 0xdc00)) {
693 if (text < end && ((l = *text), likely (l >= 0xdc00 && l < 0xe000))) {
695 *unicode = ((hb_codepoint_t) ((c) - 0xd800) * 0x400 + (l) - 0xdc00 + 0x10000);
706 hb_buffer_add_utf16 (hb_buffer_t *buffer,
707 const uint16_t *text,
708 unsigned int text_length HB_UNUSED,
709 unsigned int item_offset,
710 unsigned int item_length)
712 #define UTF_NEXT(S, E, U) hb_utf16_next (S, E, &(U))
718 hb_buffer_add_utf32 (hb_buffer_t *buffer,
719 const uint32_t *text,
720 unsigned int text_length HB_UNUSED,
721 unsigned int item_offset,
722 unsigned int item_length)
724 #define UTF_NEXT(S, E, U) ((U) = *(S), (S)+1)