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