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