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  *
   5  * This is part of HarfBuzz, a text shaping library.
   6  *
   7  * Permission is hereby granted, without written agreement and without
   8  * license or royalty fees, to use, copy, modify, and distribute this
   9  * software and its documentation for any purpose, provided that the
  10  * above copyright notice and the following two paragraphs appear in
  11  * all copies of this software.
  12  *
  13  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  14  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  15  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  16  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  17  * DAMAGE.
  18  *
  19  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  20  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  21  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  22  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  23  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  24  *
  25  * Red Hat Author(s): Owen Taylor, Behdad Esfahbod
  26  */
  27
  28 #include "hb-buffer-private.hh"
  29
  30 #include <string.h>
  31
  32 HB_BEGIN_DECLS
  33
  34
  35 static hb_buffer_t _hb_buffer_nil = {
  36   HB_REFERENCE_COUNT_INVALID, /* ref_count */
  37
  38   &_hb_unicode_funcs_nil  /* unicode */
  39 };
  40
  41 /* Here is how the buffer works internally:
  42  *
  43  * There are two info pointers: info and out_info.  They always have
  44  * the same allocated size, but different lengths.
  45  *
  46  * As an optimization, both info and out_info may point to the
  47  * same piece of memory, which is owned by info.  This remains the
  48  * case as long as out_len doesn't exceed len at any time.
  49  * In that case, swap() is no-op and the glyph operations operate
  50  * mostly in-place.
  51  *
  52  * As soon as out_info gets longer than info, out_info is moved over
  53  * to an alternate buffer (which we reuse the pos buffer for!), and its
  54  * current contents (out_len entries) are copied to the new place.
  55  * This should all remain transparent to the user.  swap() then
  56  * switches info and out_info.
  57  */
  58
  59
  60 static hb_bool_t
  61 _hb_buffer_enlarge (hb_buffer_t *buffer, unsigned int size)
  62 {
  63   if (unlikely (buffer->in_error))
  64     return FALSE;
  65
  66   unsigned int new_allocated = buffer->allocated;
  67   hb_glyph_position_t *new_pos;
  68   hb_glyph_info_t *new_info;
  69   bool separate_out;
  70
  71   separate_out = buffer->out_info != buffer->info;
  72
  73   while (size > new_allocated)
  74     new_allocated += (new_allocated >> 1) + 8;
  75
  76   new_pos = (hb_glyph_position_t *) realloc (buffer->pos, new_allocated * sizeof (buffer->pos[0]));
  77   new_info = (hb_glyph_info_t *) realloc (buffer->info, new_allocated * sizeof (buffer->info[0]));
  78
  79   if (unlikely (!new_pos || !new_info))
  80     buffer->in_error = TRUE;
  81
  82   if (likely (new_pos))
  83     buffer->pos = new_pos;
  84
  85   if (likely (new_info))
  86     buffer->info = new_info;
  87
  88   buffer->out_info = separate_out ? (hb_glyph_info_t *) buffer->pos : buffer->info;
  89   if (likely (!buffer->in_error))
  90     buffer->allocated = new_allocated;
  91
  92   return likely (!buffer->in_error);
  93 }
  94
  95 static inline hb_bool_t
  96 _hb_buffer_ensure (hb_buffer_t *buffer, unsigned int size)
  97 {
  98   return likely (size <= buffer->allocated) ? TRUE : _hb_buffer_enlarge (buffer, size);
  99 }
 100
 101 static inline hb_bool_t
 102 _hb_buffer_ensure_separate (hb_buffer_t *buffer, unsigned int size)
 103 {
 104   if (unlikely (!_hb_buffer_ensure (buffer, size))) return FALSE;
 105
 106   if (buffer->out_info == buffer->info)
 107   {
 108     assert (buffer->have_output);
 109
 110     buffer->out_info = (hb_glyph_info_t *) buffer->pos;
 111     memcpy (buffer->out_info, buffer->info, buffer->out_len * sizeof (buffer->out_info[0]));
 112   }
 113
 114   return TRUE;
 115 }
 116
 117
 118 /* Public API */
 119
 120 hb_buffer_t *
 121 hb_buffer_create (unsigned int pre_alloc_size)
 122 {
 123   hb_buffer_t *buffer;
 124
 125   if (!HB_OBJECT_DO_CREATE (hb_buffer_t, buffer))
 126     return &_hb_buffer_nil;
 127
 128   if (pre_alloc_size)
 129     _hb_buffer_ensure (buffer, pre_alloc_size);
 130
 131   buffer->unicode = &_hb_unicode_funcs_nil;
 132
 133   return buffer;
 134 }
 135
 136 hb_buffer_t *
 137 hb_buffer_reference (hb_buffer_t *buffer)
 138 {
 139   HB_OBJECT_DO_REFERENCE (buffer);
 140 }
 141
 142 unsigned int
 143 hb_buffer_get_reference_count (hb_buffer_t *buffer)
 144 {
 145   HB_OBJECT_DO_GET_REFERENCE_COUNT (buffer);
 146 }
 147
 148 void
 149 hb_buffer_destroy (hb_buffer_t *buffer)
 150 {
 151   HB_OBJECT_DO_DESTROY (buffer);
 152
 153   hb_unicode_funcs_destroy (buffer->unicode);
 154
 155   free (buffer->info);
 156   free (buffer->pos);
 157
 158   free (buffer);
 159 }
 160
 161
 162 void
 163 hb_buffer_set_unicode_funcs (hb_buffer_t        *buffer,
 164                              hb_unicode_funcs_t *unicode)
 165 {
 166   if (!unicode)
 167     unicode = &_hb_unicode_funcs_nil;
 168
 169   hb_unicode_funcs_reference (unicode);
 170   hb_unicode_funcs_destroy (buffer->unicode);
 171   buffer->unicode = unicode;
 172 }
 173
 174 hb_unicode_funcs_t *
 175 hb_buffer_get_unicode_funcs (hb_buffer_t        *buffer)
 176 {
 177   return buffer->unicode;
 178 }
 179
 180 void
 181 hb_buffer_set_direction (hb_buffer_t    *buffer,
 182                          hb_direction_t  direction)
 183
 184 {
 185   buffer->props.direction = direction;
 186 }
 187
 188 hb_direction_t
 189 hb_buffer_get_direction (hb_buffer_t    *buffer)
 190 {
 191   return buffer->props.direction;
 192 }
 193
 194 void
 195 hb_buffer_set_script (hb_buffer_t *buffer,
 196                       hb_script_t  script)
 197 {
 198   buffer->props.script = script;
 199 }
 200
 201 hb_script_t
 202 hb_buffer_get_script (hb_buffer_t *buffer)
 203 {
 204   return buffer->props.script;
 205 }
 206
 207 void
 208 hb_buffer_set_language (hb_buffer_t   *buffer,
 209                         hb_language_t  language)
 210 {
 211   buffer->props.language = language;
 212 }
 213
 214 hb_language_t
 215 hb_buffer_get_language (hb_buffer_t *buffer)
 216 {
 217   return buffer->props.language;
 218 }
 219
 220
 221 void
 222 hb_buffer_clear (hb_buffer_t *buffer)
 223 {
 224   buffer->have_output = FALSE;
 225   buffer->have_positions = FALSE;
 226   buffer->in_error = FALSE;
 227   buffer->len = 0;
 228   buffer->out_len = 0;
 229   buffer->i = 0;
 230   buffer->out_info = buffer->info;
 231   buffer->max_lig_id = 0;
 232 }
 233
 234 hb_bool_t
 235 hb_buffer_ensure (hb_buffer_t *buffer, unsigned int size)
 236 {
 237   return _hb_buffer_ensure (buffer, size);
 238 }
 239
 240 void
 241 hb_buffer_add_glyph (hb_buffer_t    *buffer,
 242                      hb_codepoint_t  codepoint,
 243                      hb_mask_t       mask,
 244                      unsigned int    cluster)
 245 {
 246   hb_glyph_info_t *glyph;
 247
 248   if (unlikely (!_hb_buffer_ensure (buffer, buffer->len + 1))) return;
 249
 250   glyph = &buffer->info[buffer->len];
 251   glyph->codepoint = codepoint;
 252   glyph->mask = mask;
 253   glyph->cluster = cluster;
 254   glyph->component() = 0;
 255   glyph->lig_id() = 0;
 256   glyph->gproperty() = HB_BUFFER_GLYPH_PROPERTIES_UNKNOWN;
 257
 258   buffer->len++;
 259 }
 260
 261 void
 262 hb_buffer_clear_positions (hb_buffer_t *buffer)
 263 {
 264   _hb_buffer_clear_output (buffer);
 265   buffer->have_output = FALSE;
 266   buffer->have_positions = TRUE;
 267
 268   if (unlikely (!buffer->pos))
 269   {
 270     buffer->pos = (hb_glyph_position_t *) calloc (buffer->allocated, sizeof (buffer->pos[0]));
 271     return;
 272   }
 273
 274   memset (buffer->pos, 0, sizeof (buffer->pos[0]) * buffer->len);
 275 }
 276
 277 /* HarfBuzz-Internal API */
 278
 279 void
 280 _hb_buffer_clear_output (hb_buffer_t *buffer)
 281 {
 282   buffer->have_output = TRUE;
 283   buffer->have_positions = FALSE;
 284   buffer->out_len = 0;
 285   buffer->out_info = buffer->info;
 286 }
 287
 288 void
 289 _hb_buffer_swap (hb_buffer_t *buffer)
 290 {
 291   unsigned int tmp;
 292
 293   assert (buffer->have_output);
 294
 295   if (unlikely (buffer->in_error)) return;
 296
 297   if (buffer->out_info != buffer->info)
 298   {
 299     hb_glyph_info_t *tmp_string;
 300     tmp_string = buffer->info;
 301     buffer->info = buffer->out_info;
 302     buffer->out_info = tmp_string;
 303     buffer->pos = (hb_glyph_position_t *) buffer->out_info;
 304   }
 305
 306   tmp = buffer->len;
 307   buffer->len = buffer->out_len;
 308   buffer->out_len = tmp;
 309
 310   buffer->i = 0;
 311 }
 312
 313 void
 314 _hb_buffer_add_output_glyphs (hb_buffer_t *buffer,
 315                               unsigned int num_in,
 316                               unsigned int num_out,
 317                               const hb_codepoint_t *glyph_data,
 318                               unsigned short component,
 319                               unsigned short lig_id)
 320 {
 321   unsigned int i;
 322   unsigned int mask;
 323   unsigned int cluster;
 324
 325   if (buffer->out_info != buffer->info ||
 326       buffer->out_len + num_out > buffer->i + num_in)
 327   {
 328     if (unlikely (!_hb_buffer_ensure_separate (buffer, buffer->out_len + num_out)))
 329       return;
 330   }
 331
 332   mask = buffer->info[buffer->i].mask;
 333   cluster = buffer->info[buffer->i].cluster;
 334   if (component == 0xFFFF)
 335     component = buffer->info[buffer->i].component();
 336   if (lig_id == 0xFFFF)
 337     lig_id = buffer->info[buffer->i].lig_id();
 338
 339   for (i = 0; i < num_out; i++)
 340   {
 341     hb_glyph_info_t *info = &buffer->out_info[buffer->out_len + i];
 342     info->codepoint = glyph_data[i];
 343     info->mask = mask;
 344     info->cluster = cluster;
 345     info->component() = component;
 346     info->lig_id() = lig_id;
 347     info->gproperty() = HB_BUFFER_GLYPH_PROPERTIES_UNKNOWN;
 348   }
 349
 350   buffer->i  += num_in;
 351   buffer->out_len += num_out;
 352 }
 353
 354 void
 355 _hb_buffer_add_output_glyphs_be16 (hb_buffer_t *buffer,
 356                                    unsigned int num_in,
 357                                    unsigned int num_out,
 358                                    const uint16_t *glyph_data_be,
 359                                    unsigned short component,
 360                                    unsigned short lig_id)
 361 {
 362   unsigned int i;
 363   unsigned int mask;
 364   unsigned int cluster;
 365
 366   if (buffer->out_info != buffer->info ||
 367       buffer->out_len + num_out > buffer->i + num_in)
 368   {
 369     if (unlikely (!_hb_buffer_ensure_separate (buffer, buffer->out_len + num_out)))
 370       return;
 371   }
 372
 373   mask = buffer->info[buffer->i].mask;
 374   cluster = buffer->info[buffer->i].cluster;
 375   if (component == 0xFFFF)
 376     component = buffer->info[buffer->i].component();
 377   if (lig_id == 0xFFFF)
 378     lig_id = buffer->info[buffer->i].lig_id();
 379
 380   for (i = 0; i < num_out; i++)
 381   {
 382     hb_glyph_info_t *info = &buffer->out_info[buffer->out_len + i];
 383     info->codepoint = hb_be_uint16 (glyph_data_be[i]);
 384     info->mask = mask;
 385     info->cluster = cluster;
 386     info->component() = component;
 387     info->lig_id() = lig_id;
 388     info->gproperty() = HB_BUFFER_GLYPH_PROPERTIES_UNKNOWN;
 389   }
 390
 391   buffer->i  += num_in;
 392   buffer->out_len += num_out;
 393 }
 394
 395 void
 396 _hb_buffer_add_output_glyph (hb_buffer_t *buffer,
 397                              hb_codepoint_t glyph_index,
 398                              unsigned short component,
 399                              unsigned short lig_id)
 400 {
 401   hb_glyph_info_t *info;
 402
 403   if (buffer->out_info != buffer->info)
 404   {
 405     if (unlikely (!_hb_buffer_ensure (buffer, buffer->out_len + 1))) return;
 406     buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
 407   }
 408   else if (buffer->out_len != buffer->i)
 409     buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
 410
 411   info = &buffer->out_info[buffer->out_len];
 412   info->codepoint = glyph_index;
 413   if (component != 0xFFFF)
 414     info->component() = component;
 415   if (lig_id != 0xFFFF)
 416     info->lig_id() = lig_id;
 417   info->gproperty() = HB_BUFFER_GLYPH_PROPERTIES_UNKNOWN;
 418
 419   buffer->i++;
 420   buffer->out_len++;
 421 }
 422
 423 void
 424 _hb_buffer_next_glyph (hb_buffer_t *buffer)
 425 {
 426   if (buffer->have_output)
 427   {
 428     if (buffer->out_info != buffer->info)
 429     {
 430       if (unlikely (!_hb_buffer_ensure (buffer, buffer->out_len + 1))) return;
 431       buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
 432     }
 433     else if (buffer->out_len != buffer->i)
 434       buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
 435
 436     buffer->out_len++;
 437   }
 438
 439   buffer->i++;
 440 }
 441
 442 void
 443 _hb_buffer_reset_masks (hb_buffer_t *buffer,
 444                         hb_mask_t    mask)
 445 {
 446   unsigned int count = buffer->len;
 447   for (unsigned int i = 0; i < count; i++)
 448     buffer->info[i].mask = mask;
 449 }
 450
 451 void
 452 _hb_buffer_add_masks (hb_buffer_t *buffer,
 453                       hb_mask_t    mask)
 454 {
 455   unsigned int count = buffer->len;
 456   for (unsigned int i = 0; i < count; i++)
 457     buffer->info[i].mask |= mask;
 458 }
 459
 460 void
 461 _hb_buffer_set_masks (hb_buffer_t *buffer,
 462                       hb_mask_t    value,
 463                       hb_mask_t    mask,
 464                       unsigned int cluster_start,
 465                       unsigned int cluster_end)
 466 {
 467   hb_mask_t not_mask = ~mask;
 468   value &= mask;
 469
 470   if (!mask)
 471     return;
 472
 473   if (cluster_start == 0 && cluster_end == (unsigned int)-1) {
 474     unsigned int count = buffer->len;
 475     for (unsigned int i = 0; i < count; i++)
 476       buffer->info[i].mask = (buffer->info[i].mask & not_mask) | value;
 477     return;
 478   }
 479
 480   /* XXX can't bsearch since .cluster may not be sorted. */
 481   /* Binary search to find the start position and go from there. */
 482   unsigned int min = 0, max = buffer->len;
 483   while (min < max)
 484   {
 485     unsigned int mid = min + ((max - min) / 2);
 486     if (buffer->info[mid].cluster < cluster_start)
 487       min = mid + 1;
 488     else
 489       max = mid;
 490   }
 491   unsigned int count = buffer->len;
 492   for (unsigned int i = min; i < count && buffer->info[i].cluster < cluster_end; i++)
 493     buffer->info[i].mask = (buffer->info[i].mask & not_mask) | value;
 494 }
 495
 496
 497 /* Public API again */
 498
 499 unsigned int
 500 hb_buffer_get_length (hb_buffer_t *buffer)
 501 {
 502   return buffer->len;
 503 }
 504
 505 /* Return value valid as long as buffer not modified */
 506 hb_glyph_info_t *
 507 hb_buffer_get_glyph_infos (hb_buffer_t *buffer)
 508 {
 509   return (hb_glyph_info_t *) buffer->info;
 510 }
 511
 512 /* Return value valid as long as buffer not modified */
 513 hb_glyph_position_t *
 514 hb_buffer_get_glyph_positions (hb_buffer_t *buffer)
 515 {
 516   if (!buffer->have_positions)
 517     hb_buffer_clear_positions (buffer);
 518
 519   return (hb_glyph_position_t *) buffer->pos;
 520 }
 521
 522
 523 static void
 524 reverse_range (hb_buffer_t *buffer,
 525                unsigned int start,
 526                unsigned int end)
 527 {
 528   unsigned int i, j;
 529
 530   for (i = start, j = end - 1; i < j; i++, j--) {
 531     hb_glyph_info_t t;
 532
 533     t = buffer->info[i];
 534     buffer->info[i] = buffer->info[j];
 535     buffer->info[j] = t;
 536   }
 537
 538   if (buffer->pos) {
 539     for (i = 0, j = end - 1; i < j; i++, j--) {
 540       hb_glyph_position_t t;
 541
 542       t = buffer->pos[i];
 543       buffer->pos[i] = buffer->pos[j];
 544       buffer->pos[j] = t;
 545     }
 546   }
 547 }
 548
 549 void
 550 hb_buffer_reverse (hb_buffer_t *buffer)
 551 {
 552   if (unlikely (!buffer->len))
 553     return;
 554
 555   reverse_range (buffer, 0, buffer->len);
 556 }
 557
 558 void
 559 hb_buffer_reverse_clusters (hb_buffer_t *buffer)
 560 {
 561   unsigned int i, start, count, last_cluster;
 562
 563   if (unlikely (!buffer->len))
 564     return;
 565
 566   hb_buffer_reverse (buffer);
 567
 568   count = buffer->len;
 569   start = 0;
 570   last_cluster = buffer->info[0].cluster;
 571   for (i = 1; i < count; i++) {
 572     if (last_cluster != buffer->info[i].cluster) {
 573       reverse_range (buffer, start, i);
 574       start = i;
 575       last_cluster = buffer->info[i].cluster;
 576     }
 577   }
 578   reverse_range (buffer, start, i);
 579 }
 580
 581
 582 #define ADD_UTF(T) \
 583         HB_STMT_START { \
 584           const T *next = (const T *) text + item_offset; \
 585           const T *end = next + item_length; \
 586           while (next < end) { \
 587             hb_codepoint_t u; \
 588             const T *old_next = next; \
 589             next = UTF_NEXT (next, end, u); \
 590             hb_buffer_add_glyph (buffer, u, 1,  old_next - (const T *) text); \
 591           } \
 592         } HB_STMT_END
 593
 594
 595 #define UTF8_COMPUTE(Char, Mask, Len) \
 596   if (Char < 128) { Len = 1; Mask = 0x7f; } \
 597   else if ((Char & 0xe0) == 0xc0) { Len = 2; Mask = 0x1f; } \
 598   else if ((Char & 0xf0) == 0xe0) { Len = 3; Mask = 0x0f; } \
 599   else if ((Char & 0xf8) == 0xf0) { Len = 4; Mask = 0x07; } \
 600   else Len = 0;
 601
 602 static inline const uint8_t *
 603 hb_utf8_next (const uint8_t *text,
 604               const uint8_t *end,
 605               hb_codepoint_t *unicode)
 606 {
 607   uint8_t c = *text;
 608   unsigned int mask, len;
 609
 610   /* TODO check for overlong sequences?  also: optimize? */
 611
 612   UTF8_COMPUTE (c, mask, len);
 613   if (unlikely (!len || (unsigned int) (end - text) < len)) {
 614     *unicode = -1;
 615     return text + 1;
 616   } else {
 617     hb_codepoint_t result;
 618     unsigned int i;
 619     result = c & mask;
 620     for (i = 1; i < len; i++)
 621       {
 622         if (unlikely ((text[i] & 0xc0) != 0x80))
 623           {
 624             *unicode = -1;
 625             return text + 1;
 626           }
 627         result <<= 6;
 628         result |= (text[i] & 0x3f);
 629       }
 630     *unicode = result;
 631     return text + len;
 632   }
 633 }
 634
 635 void
 636 hb_buffer_add_utf8 (hb_buffer_t  *buffer,
 637                     const char   *text,
 638                     unsigned int  text_length HB_UNUSED,
 639                     unsigned int  item_offset,
 640                     unsigned int  item_length)
 641 {
 642 #define UTF_NEXT(S, E, U)       hb_utf8_next (S, E, &(U))
 643   ADD_UTF (uint8_t);
 644 #undef UTF_NEXT
 645 }
 646
 647 static inline const uint16_t *
 648 hb_utf16_next (const uint16_t *text,
 649                const uint16_t *end,
 650                hb_codepoint_t *unicode)
 651 {
 652   uint16_t c = *text++;
 653
 654   if (unlikely (c >= 0xd800 && c < 0xdc00)) {
 655     /* high surrogate */
 656     uint16_t l;
 657     if (text < end && ((l = *text), unlikely (l >= 0xdc00 && l < 0xe000))) {
 658       /* low surrogate */
 659       *unicode = ((hb_codepoint_t) ((c) - 0xd800) * 0x400 + (l) - 0xdc00 + 0x10000);
 660        text++;
 661     } else
 662       *unicode = -1;
 663   } else
 664     *unicode = c;
 665
 666   return text;
 667 }
 668
 669 void
 670 hb_buffer_add_utf16 (hb_buffer_t    *buffer,
 671                      const uint16_t *text,
 672                      unsigned int    text_length HB_UNUSED,
 673                      unsigned int    item_offset,
 674                      unsigned int    item_length)
 675 {
 676 #define UTF_NEXT(S, E, U)       hb_utf16_next (S, E, &(U))
 677   ADD_UTF (uint16_t);
 678 #undef UTF_NEXT
 679 }
 680
 681 void
 682 hb_buffer_add_utf32 (hb_buffer_t    *buffer,
 683                      const uint32_t *text,
 684                      unsigned int    text_length HB_UNUSED,
 685                      unsigned int    item_offset,
 686                      unsigned int    item_length)
 687 {
 688 #define UTF_NEXT(S, E, U)       ((U) = *(S), (S)+1)
 689   ADD_UTF (uint32_t);
 690 #undef UTF_NEXT
 691 }
 692
 693
 694 HB_END_DECLS