src/hb-buffer.cc

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