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