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