src/hb-buffer.cc

   1 /*
   2  * Copyright © 1998-2004  David Turner and Werner Lemberg
   3  * Copyright © 2004,2007,2009,2010  Red Hat, Inc.
   4  * Copyright © 2011  Google, Inc.
   5  *
   6  *  This is part of HarfBuzz, a text shaping library.
   7  *
   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.
  13  *
  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
  18  * DAMAGE.
  19  *
  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.
  25  *
  26  * Red Hat Author(s): Owen Taylor, Behdad Esfahbod
  27  * Google Author(s): Behdad Esfahbod
  28  */
  29
  30 #include "hb-buffer-private.hh"
  31
  32 #include <string.h>
  33
  34 HB_BEGIN_DECLS
  35
  36
  37 static hb_buffer_t _hb_buffer_nil = {
  38   HB_OBJECT_HEADER_STATIC,
  39
  40   &_hb_unicode_funcs_default,
  41   {
  42     HB_DIRECTION_INVALID,
  43     HB_SCRIPT_INVALID,
  44     NULL,
  45   },
  46 };
  47
  48 /* Here is how the buffer works internally:
  49  *
  50  * There are two info pointers: info and out_info.  They always have
  51  * the same allocated size, but different lengths.
  52  *
  53  * As an optimization, both info and out_info may point to the
  54  * same piece of memory, which is owned by info.  This remains the
  55  * case as long as out_len doesn't exceed i at any time.
  56  * In that case, swap() is no-op and the glyph operations operate
  57  * mostly in-place.
  58  *
  59  * As soon as out_info gets longer than info, out_info is moved over
  60  * to an alternate buffer (which we reuse the pos buffer for!), and its
  61  * current contents (out_len entries) are copied to the new place.
  62  * This should all remain transparent to the user.  swap() then
  63  * switches info and out_info.
  64  */
  65
  66
  67 static hb_bool_t
  68 _hb_buffer_enlarge (hb_buffer_t *buffer, unsigned int size)
  69 {
  70   if (unlikely (buffer->in_error))
  71     return FALSE;
  72
  73   unsigned int new_allocated = buffer->allocated;
  74   hb_glyph_position_t *new_pos;
  75   hb_glyph_info_t *new_info;
  76   bool separate_out;
  77
  78   separate_out = buffer->out_info != buffer->info;
  79
  80   while (size > new_allocated)
  81     new_allocated += (new_allocated >> 1) + 32;
  82
  83   ASSERT_STATIC (sizeof (buffer->info[0]) == sizeof (buffer->pos[0]));
  84   bool overflows = new_allocated >= ((unsigned int) -1) / sizeof (buffer->info[0]);
  85
  86   if (unlikely (overflows)) {
  87     new_pos = NULL;
  88     new_info = NULL;
  89   } else {
  90     new_pos = (hb_glyph_position_t *) realloc (buffer->pos, new_allocated * sizeof (buffer->pos[0]));
  91     new_info = (hb_glyph_info_t *) realloc (buffer->info, new_allocated * sizeof (buffer->info[0]));
  92   }
  93
  94   if (unlikely (!new_pos || !new_info))
  95     buffer->in_error = TRUE;
  96
  97   if (likely (new_pos))
  98     buffer->pos = new_pos;
  99
 100   if (likely (new_info))
 101     buffer->info = new_info;
 102
 103   buffer->out_info = separate_out ? (hb_glyph_info_t *) buffer->pos : buffer->info;
 104   if (likely (!buffer->in_error))
 105     buffer->allocated = new_allocated;
 106
 107   return likely (!buffer->in_error);
 108 }
 109
 110 static inline hb_bool_t
 111 _hb_buffer_ensure (hb_buffer_t *buffer, unsigned int size)
 112 {
 113   return likely (size <= buffer->allocated) ? TRUE : _hb_buffer_enlarge (buffer, size);
 114 }
 115
 116 static inline hb_bool_t
 117 _hb_buffer_ensure_separate (hb_buffer_t *buffer, unsigned int size)
 118 {
 119   if (unlikely (!_hb_buffer_ensure (buffer, size))) return FALSE;
 120
 121   if (buffer->out_info == buffer->info)
 122   {
 123     assert (buffer->have_output);
 124
 125     buffer->out_info = (hb_glyph_info_t *) buffer->pos;
 126     memcpy (buffer->out_info, buffer->info, buffer->out_len * sizeof (buffer->out_info[0]));
 127   }
 128
 129   return TRUE;
 130 }
 131
 132
 133 /* Public API */
 134
 135 hb_buffer_t *
 136 hb_buffer_create (unsigned int pre_alloc_size)
 137 {
 138   hb_buffer_t *buffer;
 139
 140   if (!(buffer = hb_object_create<hb_buffer_t> ()))
 141     return &_hb_buffer_nil;
 142
 143   if (pre_alloc_size)
 144     _hb_buffer_ensure (buffer, pre_alloc_size);
 145
 146   hb_buffer_reset (buffer);
 147
 148   return buffer;
 149 }
 150
 151 hb_buffer_t *
 152 hb_buffer_reference (hb_buffer_t *buffer)
 153 {
 154   return hb_object_reference (buffer);
 155 }
 156
 157 void
 158 hb_buffer_destroy (hb_buffer_t *buffer)
 159 {
 160   if (!hb_object_destroy (buffer)) return;
 161
 162   hb_unicode_funcs_destroy (buffer->unicode);
 163
 164   free (buffer->info);
 165   free (buffer->pos);
 166
 167   free (buffer);
 168 }
 169
 170 hb_bool_t
 171 hb_buffer_set_user_data (hb_buffer_t        *buffer,
 172                          hb_user_data_key_t *key,
 173                          void *              data,
 174                          hb_destroy_func_t   destroy)
 175 {
 176   return hb_object_set_user_data (buffer, key, data, destroy);
 177 }
 178
 179 void *
 180 hb_buffer_get_user_data (hb_buffer_t        *buffer,
 181                          hb_user_data_key_t *key)
 182 {
 183   return hb_object_get_user_data (buffer, key);
 184 }
 185
 186
 187 void
 188 hb_buffer_set_unicode_funcs (hb_buffer_t        *buffer,
 189                              hb_unicode_funcs_t *unicode)
 190 {
 191   if (!unicode)
 192     unicode = &_hb_unicode_funcs_default;
 193
 194   hb_unicode_funcs_reference (unicode);
 195   hb_unicode_funcs_destroy (buffer->unicode);
 196   buffer->unicode = unicode;
 197 }
 198
 199 hb_unicode_funcs_t *
 200 hb_buffer_get_unicode_funcs (hb_buffer_t        *buffer)
 201 {
 202   return buffer->unicode;
 203 }
 204
 205 void
 206 hb_buffer_set_direction (hb_buffer_t    *buffer,
 207                          hb_direction_t  direction)
 208
 209 {
 210   buffer->props.direction = direction;
 211 }
 212
 213 hb_direction_t
 214 hb_buffer_get_direction (hb_buffer_t    *buffer)
 215 {
 216   return buffer->props.direction;
 217 }
 218
 219 void
 220 hb_buffer_set_script (hb_buffer_t *buffer,
 221                       hb_script_t  script)
 222 {
 223   buffer->props.script = script;
 224 }
 225
 226 hb_script_t
 227 hb_buffer_get_script (hb_buffer_t *buffer)
 228 {
 229   return buffer->props.script;
 230 }
 231
 232 void
 233 hb_buffer_set_language (hb_buffer_t   *buffer,
 234                         hb_language_t  language)
 235 {
 236   buffer->props.language = language;
 237 }
 238
 239 hb_language_t
 240 hb_buffer_get_language (hb_buffer_t *buffer)
 241 {
 242   return buffer->props.language;
 243 }
 244
 245
 246 void
 247 hb_buffer_reset (hb_buffer_t *buffer)
 248 {
 249   hb_unicode_funcs_destroy (buffer->unicode);
 250   buffer->unicode = _hb_buffer_nil.unicode;
 251
 252   buffer->props = _hb_buffer_nil.props;
 253
 254   buffer->have_output = FALSE;
 255   buffer->have_positions = FALSE;
 256   buffer->in_error = FALSE;
 257
 258   buffer->i = 0;
 259   buffer->len = 0;
 260   buffer->out_len = 0;
 261
 262   buffer->serial = 0;
 263
 264   buffer->out_info = buffer->info;
 265 }
 266
 267 hb_bool_t
 268 hb_buffer_pre_allocate (hb_buffer_t *buffer, unsigned int size)
 269 {
 270   return _hb_buffer_ensure (buffer, size);
 271 }
 272
 273 hb_bool_t
 274 hb_buffer_allocation_successful (hb_buffer_t  *buffer)
 275 {
 276   return !buffer->in_error;
 277 }
 278
 279 void
 280 hb_buffer_add (hb_buffer_t    *buffer,
 281                hb_codepoint_t  codepoint,
 282                hb_mask_t       mask,
 283                unsigned int    cluster)
 284 {
 285   hb_glyph_info_t *glyph;
 286
 287   if (unlikely (!_hb_buffer_ensure (buffer, buffer->len + 1))) return;
 288
 289   glyph = &buffer->info[buffer->len];
 290
 291   memset (glyph, 0, sizeof (*glyph));
 292   glyph->codepoint = codepoint;
 293   glyph->mask = mask;
 294   glyph->cluster = cluster;
 295
 296   buffer->len++;
 297 }
 298
 299 /* HarfBuzz-Internal API */
 300
 301 void
 302 _hb_buffer_clear_output (hb_buffer_t *buffer)
 303 {
 304   buffer->have_output = TRUE;
 305   buffer->have_positions = FALSE;
 306
 307   buffer->out_len = 0;
 308   buffer->out_info = buffer->info;
 309 }
 310
 311 void
 312 _hb_buffer_clear_positions (hb_buffer_t *buffer)
 313 {
 314   buffer->have_output = FALSE;
 315   buffer->have_positions = TRUE;
 316
 317   memset (buffer->pos, 0, sizeof (buffer->pos[0]) * buffer->len);
 318 }
 319
 320 void
 321 _hb_buffer_swap (hb_buffer_t *buffer)
 322 {
 323   unsigned int tmp;
 324
 325   assert (buffer->have_output);
 326
 327   if (unlikely (buffer->in_error)) return;
 328
 329   if (buffer->out_info != buffer->info)
 330   {
 331     hb_glyph_info_t *tmp_string;
 332     tmp_string = buffer->info;
 333     buffer->info = buffer->out_info;
 334     buffer->out_info = tmp_string;
 335     buffer->pos = (hb_glyph_position_t *) buffer->out_info;
 336   }
 337
 338   tmp = buffer->len;
 339   buffer->len = buffer->out_len;
 340   buffer->out_len = tmp;
 341
 342   buffer->i = 0;
 343 }
 344
 345 void
 346 _hb_buffer_replace_glyphs_be16 (hb_buffer_t *buffer,
 347                                 unsigned int num_in,
 348                                 unsigned int num_out,
 349                                 const uint16_t *glyph_data_be)
 350 {
 351   if (buffer->out_info != buffer->info ||
 352       buffer->out_len + num_out > buffer->i + num_in)
 353   {
 354     if (unlikely (!_hb_buffer_ensure_separate (buffer, buffer->out_len + num_out)))
 355       return;
 356   }
 357
 358   hb_glyph_info_t orig_info = buffer->info[buffer->i];
 359
 360   for (unsigned int i = 0; i < num_out; i++)
 361   {
 362     hb_glyph_info_t *info = &buffer->out_info[buffer->out_len + i];
 363     *info = orig_info;
 364     info->codepoint = hb_be_uint16 (glyph_data_be[i]);
 365   }
 366
 367   buffer->i  += num_in;
 368   buffer->out_len += num_out;
 369 }
 370
 371 void
 372 _hb_buffer_replace_glyph (hb_buffer_t *buffer,
 373                           hb_codepoint_t glyph_index)
 374 {
 375   hb_glyph_info_t *info;
 376
 377   if (buffer->out_info != buffer->info)
 378   {
 379     if (unlikely (!_hb_buffer_ensure (buffer, buffer->out_len + 1))) return;
 380     buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
 381   }
 382   else if (buffer->out_len != buffer->i)
 383     buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
 384
 385   info = &buffer->out_info[buffer->out_len];
 386   info->codepoint = glyph_index;
 387
 388   buffer->i++;
 389   buffer->out_len++;
 390 }
 391
 392 void
 393 _hb_buffer_next_glyph (hb_buffer_t *buffer)
 394 {
 395   if (buffer->have_output)
 396   {
 397     if (buffer->out_info != buffer->info)
 398     {
 399       if (unlikely (!_hb_buffer_ensure (buffer, buffer->out_len + 1))) return;
 400       buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
 401     }
 402     else if (buffer->out_len != buffer->i)
 403       buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
 404
 405     buffer->out_len++;
 406   }
 407
 408   buffer->i++;
 409 }
 410
 411 void
 412 _hb_buffer_reset_masks (hb_buffer_t *buffer,
 413                         hb_mask_t    mask)
 414 {
 415   unsigned int count = buffer->len;
 416   for (unsigned int i = 0; i < count; i++)
 417     buffer->info[i].mask = mask;
 418 }
 419
 420 void
 421 _hb_buffer_add_masks (hb_buffer_t *buffer,
 422                       hb_mask_t    mask)
 423 {
 424   unsigned int count = buffer->len;
 425   for (unsigned int i = 0; i < count; i++)
 426     buffer->info[i].mask |= mask;
 427 }
 428
 429 void
 430 _hb_buffer_set_masks (hb_buffer_t *buffer,
 431                       hb_mask_t    value,
 432                       hb_mask_t    mask,
 433                       unsigned int cluster_start,
 434                       unsigned int cluster_end)
 435 {
 436   hb_mask_t not_mask = ~mask;
 437   value &= mask;
 438
 439   if (!mask)
 440     return;
 441
 442   if (cluster_start == 0 && cluster_end == (unsigned int)-1) {
 443     unsigned int count = buffer->len;
 444     for (unsigned int i = 0; i < count; i++)
 445       buffer->info[i].mask = (buffer->info[i].mask & not_mask) | value;
 446     return;
 447   }
 448
 449   /* XXX can't bsearch since .cluster may not be sorted. */
 450   /* Binary search to find the start position and go from there. */
 451   unsigned int min = 0, max = buffer->len;
 452   while (min < max)
 453   {
 454     unsigned int mid = min + ((max - min) / 2);
 455     if (buffer->info[mid].cluster < cluster_start)
 456       min = mid + 1;
 457     else
 458       max = mid;
 459   }
 460   unsigned int count = buffer->len;
 461   for (unsigned int i = min; i < count && buffer->info[i].cluster < cluster_end; i++)
 462     buffer->info[i].mask = (buffer->info[i].mask & not_mask) | value;
 463 }
 464
 465
 466 /* Public API again */
 467
 468 hb_bool_t
 469 hb_buffer_set_length (hb_buffer_t  *buffer,
 470                       unsigned int  length)
 471 {
 472   if (!_hb_buffer_ensure (buffer, length))
 473     return FALSE;
 474
 475   /* Wipe the new space */
 476   if (length > buffer->len) {
 477     memset (buffer->info + buffer->len, 0, sizeof (buffer->info[0]) * (length - buffer->len));
 478     if (buffer->have_positions)
 479       memset (buffer->pos + buffer->len, 0, sizeof (buffer->pos[0]) * (length - buffer->len));
 480   }
 481
 482   buffer->len = length;
 483   return TRUE;
 484 }
 485
 486 unsigned int
 487 hb_buffer_get_length (hb_buffer_t *buffer)
 488 {
 489   return buffer->len;
 490 }
 491
 492 /* Return value valid as long as buffer not modified */
 493 hb_glyph_info_t *
 494 hb_buffer_get_glyph_infos (hb_buffer_t  *buffer,
 495                            unsigned int *length)
 496 {
 497   if (length)
 498     *length = buffer->len;
 499
 500   return (hb_glyph_info_t *) buffer->info;
 501 }
 502
 503 /* Return value valid as long as buffer not modified */
 504 hb_glyph_position_t *
 505 hb_buffer_get_glyph_positions (hb_buffer_t  *buffer,
 506                                unsigned int *length)
 507 {
 508   if (!buffer->have_positions)
 509     _hb_buffer_clear_positions (buffer);
 510
 511   if (length)
 512     *length = buffer->len;
 513
 514   return (hb_glyph_position_t *) buffer->pos;
 515 }
 516
 517
 518 static void
 519 reverse_range (hb_buffer_t *buffer,
 520                unsigned int start,
 521                unsigned int end)
 522 {
 523   unsigned int i, j;
 524
 525   for (i = start, j = end - 1; i < j; i++, j--) {
 526     hb_glyph_info_t t;
 527
 528     t = buffer->info[i];
 529     buffer->info[i] = buffer->info[j];
 530     buffer->info[j] = t;
 531   }
 532
 533   if (buffer->pos) {
 534     for (i = 0, j = end - 1; i < j; i++, j--) {
 535       hb_glyph_position_t t;
 536
 537       t = buffer->pos[i];
 538       buffer->pos[i] = buffer->pos[j];
 539       buffer->pos[j] = t;
 540     }
 541   }
 542 }
 543
 544 void
 545 hb_buffer_reverse (hb_buffer_t *buffer)
 546 {
 547   if (unlikely (!buffer->len))
 548     return;
 549
 550   reverse_range (buffer, 0, buffer->len);
 551 }
 552
 553 void
 554 hb_buffer_reverse_clusters (hb_buffer_t *buffer)
 555 {
 556   unsigned int i, start, count, last_cluster;
 557
 558   if (unlikely (!buffer->len))
 559     return;
 560
 561   hb_buffer_reverse (buffer);
 562
 563   count = buffer->len;
 564   start = 0;
 565   last_cluster = buffer->info[0].cluster;
 566   for (i = 1; i < count; i++) {
 567     if (last_cluster != buffer->info[i].cluster) {
 568       reverse_range (buffer, start, i);
 569       start = i;
 570       last_cluster = buffer->info[i].cluster;
 571     }
 572   }
 573   reverse_range (buffer, start, i);
 574 }
 575
 576
 577 #define ADD_UTF(T) \
 578         HB_STMT_START { \
 579           const T *next = (const T *) text + item_offset; \
 580           const T *end = next + item_length; \
 581           while (next < end) { \
 582             hb_codepoint_t u; \
 583             const T *old_next = next; \
 584             next = UTF_NEXT (next, end, u); \
 585             hb_buffer_add (buffer, u, 1,  old_next - (const T *) text); \
 586           } \
 587         } HB_STMT_END
 588
 589
 590 #define UTF8_COMPUTE(Char, Mask, Len) \
 591   if (Char < 128) { Len = 1; Mask = 0x7f; } \
 592   else if ((Char & 0xe0) == 0xc0) { Len = 2; Mask = 0x1f; } \
 593   else if ((Char & 0xf0) == 0xe0) { Len = 3; Mask = 0x0f; } \
 594   else if ((Char & 0xf8) == 0xf0) { Len = 4; Mask = 0x07; } \
 595   else Len = 0;
 596
 597 static inline const uint8_t *
 598 hb_utf8_next (const uint8_t *text,
 599               const uint8_t *end,
 600               hb_codepoint_t *unicode)
 601 {
 602   uint8_t c = *text;
 603   unsigned int mask, len;
 604
 605   /* TODO check for overlong sequences?  also: optimize? */
 606
 607   UTF8_COMPUTE (c, mask, len);
 608   if (unlikely (!len || (unsigned int) (end - text) < len)) {
 609     *unicode = -1;
 610     return text + 1;
 611   } else {
 612     hb_codepoint_t result;
 613     unsigned int i;
 614     result = c & mask;
 615     for (i = 1; i < len; i++)
 616       {
 617         if (unlikely ((text[i] & 0xc0) != 0x80))
 618           {
 619             *unicode = -1;
 620             return text + 1;
 621           }
 622         result <<= 6;
 623         result |= (text[i] & 0x3f);
 624       }
 625     *unicode = result;
 626     return text + len;
 627   }
 628 }
 629
 630 void
 631 hb_buffer_add_utf8 (hb_buffer_t  *buffer,
 632                     const char   *text,
 633                     unsigned int  text_length HB_UNUSED,
 634                     unsigned int  item_offset,
 635                     unsigned int  item_length)
 636 {
 637 #define UTF_NEXT(S, E, U)       hb_utf8_next (S, E, &(U))
 638   ADD_UTF (uint8_t);
 639 #undef UTF_NEXT
 640 }
 641
 642 static inline const uint16_t *
 643 hb_utf16_next (const uint16_t *text,
 644                const uint16_t *end,
 645                hb_codepoint_t *unicode)
 646 {
 647   uint16_t c = *text++;
 648
 649   if (unlikely (c >= 0xd800 && c < 0xdc00)) {
 650     /* high surrogate */
 651     uint16_t l;
 652     if (text < end && ((l = *text), likely (l >= 0xdc00 && l < 0xe000))) {
 653       /* low surrogate */
 654       *unicode = ((hb_codepoint_t) ((c) - 0xd800) * 0x400 + (l) - 0xdc00 + 0x10000);
 655        text++;
 656     } else
 657       *unicode = -1;
 658   } else
 659     *unicode = c;
 660
 661   return text;
 662 }
 663
 664 void
 665 hb_buffer_add_utf16 (hb_buffer_t    *buffer,
 666                      const uint16_t *text,
 667                      unsigned int    text_length HB_UNUSED,
 668                      unsigned int    item_offset,
 669                      unsigned int    item_length)
 670 {
 671 #define UTF_NEXT(S, E, U)       hb_utf16_next (S, E, &(U))
 672   ADD_UTF (uint16_t);
 673 #undef UTF_NEXT
 674 }
 675
 676 void
 677 hb_buffer_add_utf32 (hb_buffer_t    *buffer,
 678                      const uint32_t *text,
 679                      unsigned int    text_length HB_UNUSED,
 680                      unsigned int    item_offset,
 681                      unsigned int    item_length)
 682 {
 683 #define UTF_NEXT(S, E, U)       ((U) = *(S), (S)+1)
 684   ADD_UTF (uint32_t);
 685 #undef UTF_NEXT
 686 }
 687
 688
 689 HB_END_DECLS