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;
146 _hb_buffer_ensure (buffer, pre_alloc_size);
148 hb_buffer_reset (buffer);
154 hb_buffer_reference (hb_buffer_t *buffer)
156 return hb_object_reference (buffer);
160 hb_buffer_destroy (hb_buffer_t *buffer)
162 if (!hb_object_destroy (buffer)) return;
164 hb_unicode_funcs_destroy (buffer->unicode);
173 hb_buffer_set_user_data (hb_buffer_t *buffer,
174 hb_user_data_key_t *key,
176 hb_destroy_func_t destroy)
178 return hb_object_set_user_data (buffer, key, data, destroy);
182 hb_buffer_get_user_data (hb_buffer_t *buffer,
183 hb_user_data_key_t *key)
185 return hb_object_get_user_data (buffer, key);
190 hb_buffer_set_unicode_funcs (hb_buffer_t *buffer,
191 hb_unicode_funcs_t *unicode)
193 if (unlikely (hb_object_is_inert (buffer)))
197 unicode = _hb_buffer_nil.unicode;
199 hb_unicode_funcs_reference (unicode);
200 hb_unicode_funcs_destroy (buffer->unicode);
201 buffer->unicode = unicode;
205 hb_buffer_get_unicode_funcs (hb_buffer_t *buffer)
207 return buffer->unicode;
211 hb_buffer_set_direction (hb_buffer_t *buffer,
212 hb_direction_t direction)
215 if (unlikely (hb_object_is_inert (buffer)))
218 buffer->props.direction = direction;
222 hb_buffer_get_direction (hb_buffer_t *buffer)
224 return buffer->props.direction;
228 hb_buffer_set_script (hb_buffer_t *buffer,
231 if (unlikely (hb_object_is_inert (buffer)))
234 buffer->props.script = script;
238 hb_buffer_get_script (hb_buffer_t *buffer)
240 return buffer->props.script;
244 hb_buffer_set_language (hb_buffer_t *buffer,
245 hb_language_t language)
247 if (unlikely (hb_object_is_inert (buffer)))
250 buffer->props.language = language;
254 hb_buffer_get_language (hb_buffer_t *buffer)
256 return buffer->props.language;
261 hb_buffer_reset (hb_buffer_t *buffer)
263 if (unlikely (hb_object_is_inert (buffer)))
266 hb_unicode_funcs_destroy (buffer->unicode);
267 buffer->unicode = _hb_buffer_nil.unicode;
269 buffer->props = _hb_buffer_nil.props;
271 buffer->in_error = FALSE;
272 buffer->have_output = FALSE;
273 buffer->have_positions = FALSE;
281 buffer->out_info = buffer->info;
285 hb_buffer_pre_allocate (hb_buffer_t *buffer, unsigned int size)
287 return _hb_buffer_ensure (buffer, size);
291 hb_buffer_allocation_successful (hb_buffer_t *buffer)
293 return !buffer->in_error;
297 hb_buffer_add (hb_buffer_t *buffer,
298 hb_codepoint_t codepoint,
300 unsigned int cluster)
302 hb_glyph_info_t *glyph;
304 if (unlikely (!_hb_buffer_ensure (buffer, buffer->len + 1))) return;
306 glyph = &buffer->info[buffer->len];
308 memset (glyph, 0, sizeof (*glyph));
309 glyph->codepoint = codepoint;
311 glyph->cluster = cluster;
316 /* HarfBuzz-Internal API */
319 _hb_buffer_clear_output (hb_buffer_t *buffer)
321 if (unlikely (hb_object_is_inert (buffer)))
324 buffer->have_output = TRUE;
325 buffer->have_positions = FALSE;
328 buffer->out_info = buffer->info;
332 _hb_buffer_clear_positions (hb_buffer_t *buffer)
334 if (unlikely (hb_object_is_inert (buffer)))
337 buffer->have_output = FALSE;
338 buffer->have_positions = TRUE;
340 memset (buffer->pos, 0, sizeof (buffer->pos[0]) * buffer->len);
344 _hb_buffer_swap (hb_buffer_t *buffer)
346 if (unlikely (buffer->in_error)) return;
348 assert (buffer->have_output);
350 if (buffer->out_info != buffer->info)
352 hb_glyph_info_t *tmp_string;
353 tmp_string = buffer->info;
354 buffer->info = buffer->out_info;
355 buffer->out_info = tmp_string;
356 buffer->pos = (hb_glyph_position_t *) buffer->out_info;
361 buffer->len = buffer->out_len;
362 buffer->out_len = tmp;
368 _hb_buffer_replace_glyphs_be16 (hb_buffer_t *buffer,
370 unsigned int num_out,
371 const uint16_t *glyph_data_be)
373 if (buffer->out_info != buffer->info ||
374 buffer->out_len + num_out > buffer->i + num_in)
376 if (unlikely (!_hb_buffer_ensure_separate (buffer, buffer->out_len + num_out)))
380 hb_glyph_info_t orig_info = buffer->info[buffer->i];
382 for (unsigned int i = 0; i < num_out; i++)
384 hb_glyph_info_t *info = &buffer->out_info[buffer->out_len + i];
386 info->codepoint = hb_be_uint16 (glyph_data_be[i]);
390 buffer->out_len += num_out;
394 _hb_buffer_replace_glyph (hb_buffer_t *buffer,
395 hb_codepoint_t glyph_index)
397 hb_glyph_info_t *info;
399 if (buffer->out_info != buffer->info)
401 if (unlikely (!_hb_buffer_ensure (buffer, buffer->out_len + 1))) return;
402 buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
404 else if (buffer->out_len != buffer->i)
405 buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
407 info = &buffer->out_info[buffer->out_len];
408 info->codepoint = glyph_index;
415 _hb_buffer_next_glyph (hb_buffer_t *buffer)
417 if (buffer->have_output)
419 if (buffer->out_info != buffer->info)
421 if (unlikely (!_hb_buffer_ensure (buffer, buffer->out_len + 1))) return;
422 buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
424 else if (buffer->out_len != buffer->i)
425 buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
434 _hb_buffer_reset_masks (hb_buffer_t *buffer,
437 unsigned int count = buffer->len;
438 for (unsigned int i = 0; i < count; i++)
439 buffer->info[i].mask = mask;
443 _hb_buffer_add_masks (hb_buffer_t *buffer,
446 unsigned int count = buffer->len;
447 for (unsigned int i = 0; i < count; i++)
448 buffer->info[i].mask |= mask;
452 _hb_buffer_set_masks (hb_buffer_t *buffer,
455 unsigned int cluster_start,
456 unsigned int cluster_end)
458 hb_mask_t not_mask = ~mask;
464 if (cluster_start == 0 && cluster_end == (unsigned int)-1) {
465 unsigned int count = buffer->len;
466 for (unsigned int i = 0; i < count; i++)
467 buffer->info[i].mask = (buffer->info[i].mask & not_mask) | value;
471 /* XXX can't bsearch since .cluster may not be sorted. */
472 /* Binary search to find the start position and go from there. */
473 unsigned int min = 0, max = buffer->len;
476 unsigned int mid = min + ((max - min) / 2);
477 if (buffer->info[mid].cluster < cluster_start)
482 unsigned int count = buffer->len;
483 for (unsigned int i = min; i < count && buffer->info[i].cluster < cluster_end; i++)
484 buffer->info[i].mask = (buffer->info[i].mask & not_mask) | value;
488 /* Public API again */
491 hb_buffer_set_length (hb_buffer_t *buffer,
494 if (!_hb_buffer_ensure (buffer, length))
497 /* Wipe the new space */
498 if (length > buffer->len) {
499 memset (buffer->info + buffer->len, 0, sizeof (buffer->info[0]) * (length - buffer->len));
500 if (buffer->have_positions)
501 memset (buffer->pos + buffer->len, 0, sizeof (buffer->pos[0]) * (length - buffer->len));
504 buffer->len = length;
509 hb_buffer_get_length (hb_buffer_t *buffer)
514 /* Return value valid as long as buffer not modified */
516 hb_buffer_get_glyph_infos (hb_buffer_t *buffer,
517 unsigned int *length)
520 *length = buffer->len;
522 return (hb_glyph_info_t *) buffer->info;
525 /* Return value valid as long as buffer not modified */
526 hb_glyph_position_t *
527 hb_buffer_get_glyph_positions (hb_buffer_t *buffer,
528 unsigned int *length)
530 if (!buffer->have_positions)
531 _hb_buffer_clear_positions (buffer);
534 *length = buffer->len;
536 return (hb_glyph_position_t *) buffer->pos;
541 reverse_range (hb_buffer_t *buffer,
547 for (i = start, j = end - 1; i < j; i++, j--) {
551 buffer->info[i] = buffer->info[j];
556 for (i = 0, j = end - 1; i < j; i++, j--) {
557 hb_glyph_position_t t;
560 buffer->pos[i] = buffer->pos[j];
567 hb_buffer_reverse (hb_buffer_t *buffer)
569 if (unlikely (!buffer->len))
572 reverse_range (buffer, 0, buffer->len);
576 hb_buffer_reverse_clusters (hb_buffer_t *buffer)
578 unsigned int i, start, count, last_cluster;
580 if (unlikely (!buffer->len))
583 hb_buffer_reverse (buffer);
587 last_cluster = buffer->info[0].cluster;
588 for (i = 1; i < count; i++) {
589 if (last_cluster != buffer->info[i].cluster) {
590 reverse_range (buffer, start, i);
592 last_cluster = buffer->info[i].cluster;
595 reverse_range (buffer, start, i);
601 const T *next = (const T *) text + item_offset; \
602 const T *end = next + item_length; \
603 while (next < end) { \
605 const T *old_next = next; \
606 next = UTF_NEXT (next, end, u); \
607 hb_buffer_add (buffer, u, 1, old_next - (const T *) text); \
612 #define UTF8_COMPUTE(Char, Mask, Len) \
613 if (Char < 128) { Len = 1; Mask = 0x7f; } \
614 else if ((Char & 0xe0) == 0xc0) { Len = 2; Mask = 0x1f; } \
615 else if ((Char & 0xf0) == 0xe0) { Len = 3; Mask = 0x0f; } \
616 else if ((Char & 0xf8) == 0xf0) { Len = 4; Mask = 0x07; } \
619 static inline const uint8_t *
620 hb_utf8_next (const uint8_t *text,
622 hb_codepoint_t *unicode)
625 unsigned int mask, len;
627 /* TODO check for overlong sequences? */
629 UTF8_COMPUTE (c, mask, len);
630 if (unlikely (!len || (unsigned int) (end - text) < len)) {
634 hb_codepoint_t result;
637 for (i = 1; i < len; i++)
639 if (unlikely ((text[i] & 0xc0) != 0x80))
645 result |= (text[i] & 0x3f);
653 hb_buffer_add_utf8 (hb_buffer_t *buffer,
655 unsigned int text_length HB_UNUSED,
656 unsigned int item_offset,
657 unsigned int item_length)
659 #define UTF_NEXT(S, E, U) hb_utf8_next (S, E, &(U))
664 static inline const uint16_t *
665 hb_utf16_next (const uint16_t *text,
667 hb_codepoint_t *unicode)
669 uint16_t c = *text++;
671 if (unlikely (c >= 0xd800 && c < 0xdc00)) {
674 if (text < end && ((l = *text), likely (l >= 0xdc00 && l < 0xe000))) {
676 *unicode = ((hb_codepoint_t) ((c) - 0xd800) * 0x400 + (l) - 0xdc00 + 0x10000);
687 hb_buffer_add_utf16 (hb_buffer_t *buffer,
688 const uint16_t *text,
689 unsigned int text_length HB_UNUSED,
690 unsigned int item_offset,
691 unsigned int item_length)
693 #define UTF_NEXT(S, E, U) hb_utf16_next (S, E, &(U))
699 hb_buffer_add_utf32 (hb_buffer_t *buffer,
700 const uint32_t *text,
701 unsigned int text_length HB_UNUSED,
702 unsigned int item_offset,
703 unsigned int item_length)
705 #define UTF_NEXT(S, E, U) ((U) = *(S), (S)+1)