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 i 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->serial = 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
 252   memset (glyph, 0, sizeof (*glyph));
 253   glyph->codepoint = codepoint;
 254   glyph->mask = mask;
 255   glyph->cluster = cluster;
 256
 257   buffer->len++;
 258 }
 259
 260 void
 261 hb_buffer_clear_positions (hb_buffer_t *buffer)
 262 {
 263   _hb_buffer_clear_output (buffer);
 264   buffer->have_output = FALSE;
 265   buffer->have_positions = TRUE;
 266
 267   memset (buffer->pos, 0, sizeof (buffer->pos[0]) * buffer->len);
 268 }
 269
 270 /* HarfBuzz-Internal API */
 271
 272 void
 273 _hb_buffer_clear_output (hb_buffer_t *buffer)
 274 {
 275   buffer->have_output = TRUE;
 276   buffer->have_positions = FALSE;
 277   buffer->out_len = 0;
 278   buffer->out_info = buffer->info;
 279 }
 280
 281 void
 282 _hb_buffer_swap (hb_buffer_t *buffer)
 283 {
 284   unsigned int tmp;
 285
 286   assert (buffer->have_output);
 287
 288   if (unlikely (buffer->in_error)) return;
 289
 290   if (buffer->out_info != buffer->info)
 291   {
 292     hb_glyph_info_t *tmp_string;
 293     tmp_string = buffer->info;
 294     buffer->info = buffer->out_info;
 295     buffer->out_info = tmp_string;
 296     buffer->pos = (hb_glyph_position_t *) buffer->out_info;
 297   }
 298
 299   tmp = buffer->len;
 300   buffer->len = buffer->out_len;
 301   buffer->out_len = tmp;
 302
 303   buffer->i = 0;
 304 }
 305
 306 void
 307 _hb_buffer_replace_glyphs_be16 (hb_buffer_t *buffer,
 308                                 unsigned int num_in,
 309                                 unsigned int num_out,
 310                                 const uint16_t *glyph_data_be)
 311 {
 312   if (buffer->out_info != buffer->info ||
 313       buffer->out_len + num_out > buffer->i + num_in)
 314   {
 315     if (unlikely (!_hb_buffer_ensure_separate (buffer, buffer->out_len + num_out)))
 316       return;
 317   }
 318
 319   hb_glyph_info_t orig_info = buffer->info[buffer->i];
 320
 321   for (unsigned int i = 0; i < num_out; i++)
 322   {
 323     hb_glyph_info_t *info = &buffer->out_info[buffer->out_len + i];
 324     *info = orig_info;
 325     info->codepoint = hb_be_uint16 (glyph_data_be[i]);
 326   }
 327
 328   buffer->i  += num_in;
 329   buffer->out_len += num_out;
 330 }
 331
 332 void
 333 _hb_buffer_replace_glyph (hb_buffer_t *buffer,
 334                           hb_codepoint_t glyph_index)
 335 {
 336   hb_glyph_info_t *info;
 337
 338   if (buffer->out_info != buffer->info)
 339   {
 340     if (unlikely (!_hb_buffer_ensure (buffer, buffer->out_len + 1))) return;
 341     buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
 342   }
 343   else if (buffer->out_len != buffer->i)
 344     buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
 345
 346   info = &buffer->out_info[buffer->out_len];
 347   info->codepoint = glyph_index;
 348
 349   buffer->i++;
 350   buffer->out_len++;
 351 }
 352
 353 void
 354 _hb_buffer_next_glyph (hb_buffer_t *buffer)
 355 {
 356   if (buffer->have_output)
 357   {
 358     if (buffer->out_info != buffer->info)
 359     {
 360       if (unlikely (!_hb_buffer_ensure (buffer, buffer->out_len + 1))) return;
 361       buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
 362     }
 363     else if (buffer->out_len != buffer->i)
 364       buffer->out_info[buffer->out_len] = buffer->info[buffer->i];
 365
 366     buffer->out_len++;
 367   }
 368
 369   buffer->i++;
 370 }
 371
 372 void
 373 _hb_buffer_reset_masks (hb_buffer_t *buffer,
 374                         hb_mask_t    mask)
 375 {
 376   unsigned int count = buffer->len;
 377   for (unsigned int i = 0; i < count; i++)
 378     buffer->info[i].mask = mask;
 379 }
 380
 381 void
 382 _hb_buffer_add_masks (hb_buffer_t *buffer,
 383                       hb_mask_t    mask)
 384 {
 385   unsigned int count = buffer->len;
 386   for (unsigned int i = 0; i < count; i++)
 387     buffer->info[i].mask |= mask;
 388 }
 389
 390 void
 391 _hb_buffer_set_masks (hb_buffer_t *buffer,
 392                       hb_mask_t    value,
 393                       hb_mask_t    mask,
 394                       unsigned int cluster_start,
 395                       unsigned int cluster_end)
 396 {
 397   hb_mask_t not_mask = ~mask;
 398   value &= mask;
 399
 400   if (!mask)
 401     return;
 402
 403   if (cluster_start == 0 && cluster_end == (unsigned int)-1) {
 404     unsigned int count = buffer->len;
 405     for (unsigned int i = 0; i < count; i++)
 406       buffer->info[i].mask = (buffer->info[i].mask & not_mask) | value;
 407     return;
 408   }
 409
 410   /* XXX can't bsearch since .cluster may not be sorted. */
 411   /* Binary search to find the start position and go from there. */
 412   unsigned int min = 0, max = buffer->len;
 413   while (min < max)
 414   {
 415     unsigned int mid = min + ((max - min) / 2);
 416     if (buffer->info[mid].cluster < cluster_start)
 417       min = mid + 1;
 418     else
 419       max = mid;
 420   }
 421   unsigned int count = buffer->len;
 422   for (unsigned int i = min; i < count && buffer->info[i].cluster < cluster_end; i++)
 423     buffer->info[i].mask = (buffer->info[i].mask & not_mask) | value;
 424 }
 425
 426
 427 /* Public API again */
 428
 429 unsigned int
 430 hb_buffer_get_length (hb_buffer_t *buffer)
 431 {
 432   return buffer->len;
 433 }
 434
 435 /* Return value valid as long as buffer not modified */
 436 hb_glyph_info_t *
 437 hb_buffer_get_glyph_infos (hb_buffer_t *buffer)
 438 {
 439   return (hb_glyph_info_t *) buffer->info;
 440 }
 441
 442 /* Return value valid as long as buffer not modified */
 443 hb_glyph_position_t *
 444 hb_buffer_get_glyph_positions (hb_buffer_t *buffer)
 445 {
 446   if (!buffer->have_positions)
 447     hb_buffer_clear_positions (buffer);
 448
 449   return (hb_glyph_position_t *) buffer->pos;
 450 }
 451
 452
 453 static void
 454 reverse_range (hb_buffer_t *buffer,
 455                unsigned int start,
 456                unsigned int end)
 457 {
 458   unsigned int i, j;
 459
 460   for (i = start, j = end - 1; i < j; i++, j--) {
 461     hb_glyph_info_t t;
 462
 463     t = buffer->info[i];
 464     buffer->info[i] = buffer->info[j];
 465     buffer->info[j] = t;
 466   }
 467
 468   if (buffer->pos) {
 469     for (i = 0, j = end - 1; i < j; i++, j--) {
 470       hb_glyph_position_t t;
 471
 472       t = buffer->pos[i];
 473       buffer->pos[i] = buffer->pos[j];
 474       buffer->pos[j] = t;
 475     }
 476   }
 477 }
 478
 479 void
 480 hb_buffer_reverse (hb_buffer_t *buffer)
 481 {
 482   if (unlikely (!buffer->len))
 483     return;
 484
 485   reverse_range (buffer, 0, buffer->len);
 486 }
 487
 488 void
 489 hb_buffer_reverse_clusters (hb_buffer_t *buffer)
 490 {
 491   unsigned int i, start, count, last_cluster;
 492
 493   if (unlikely (!buffer->len))
 494     return;
 495
 496   hb_buffer_reverse (buffer);
 497
 498   count = buffer->len;
 499   start = 0;
 500   last_cluster = buffer->info[0].cluster;
 501   for (i = 1; i < count; i++) {
 502     if (last_cluster != buffer->info[i].cluster) {
 503       reverse_range (buffer, start, i);
 504       start = i;
 505       last_cluster = buffer->info[i].cluster;
 506     }
 507   }
 508   reverse_range (buffer, start, i);
 509 }
 510
 511
 512 #define ADD_UTF(T) \
 513         HB_STMT_START { \
 514           const T *next = (const T *) text + item_offset; \
 515           const T *end = next + item_length; \
 516           while (next < end) { \
 517             hb_codepoint_t u; \
 518             const T *old_next = next; \
 519             next = UTF_NEXT (next, end, u); \
 520             hb_buffer_add_glyph (buffer, u, 1,  old_next - (const T *) text); \
 521           } \
 522         } HB_STMT_END
 523
 524
 525 #define UTF8_COMPUTE(Char, Mask, Len) \
 526   if (Char < 128) { Len = 1; Mask = 0x7f; } \
 527   else if ((Char & 0xe0) == 0xc0) { Len = 2; Mask = 0x1f; } \
 528   else if ((Char & 0xf0) == 0xe0) { Len = 3; Mask = 0x0f; } \
 529   else if ((Char & 0xf8) == 0xf0) { Len = 4; Mask = 0x07; } \
 530   else Len = 0;
 531
 532 static inline const uint8_t *
 533 hb_utf8_next (const uint8_t *text,
 534               const uint8_t *end,
 535               hb_codepoint_t *unicode)
 536 {
 537   uint8_t c = *text;
 538   unsigned int mask, len;
 539
 540   /* TODO check for overlong sequences?  also: optimize? */
 541
 542   UTF8_COMPUTE (c, mask, len);
 543   if (unlikely (!len || (unsigned int) (end - text) < len)) {
 544     *unicode = -1;
 545     return text + 1;
 546   } else {
 547     hb_codepoint_t result;
 548     unsigned int i;
 549     result = c & mask;
 550     for (i = 1; i < len; i++)
 551       {
 552         if (unlikely ((text[i] & 0xc0) != 0x80))
 553           {
 554             *unicode = -1;
 555             return text + 1;
 556           }
 557         result <<= 6;
 558         result |= (text[i] & 0x3f);
 559       }
 560     *unicode = result;
 561     return text + len;
 562   }
 563 }
 564
 565 void
 566 hb_buffer_add_utf8 (hb_buffer_t  *buffer,
 567                     const char   *text,
 568                     unsigned int  text_length HB_UNUSED,
 569                     unsigned int  item_offset,
 570                     unsigned int  item_length)
 571 {
 572 #define UTF_NEXT(S, E, U)       hb_utf8_next (S, E, &(U))
 573   ADD_UTF (uint8_t);
 574 #undef UTF_NEXT
 575 }
 576
 577 static inline const uint16_t *
 578 hb_utf16_next (const uint16_t *text,
 579                const uint16_t *end,
 580                hb_codepoint_t *unicode)
 581 {
 582   uint16_t c = *text++;
 583
 584   if (unlikely (c >= 0xd800 && c < 0xdc00)) {
 585     /* high surrogate */
 586     uint16_t l;
 587     if (text < end && ((l = *text), unlikely (l >= 0xdc00 && l < 0xe000))) {
 588       /* low surrogate */
 589       *unicode = ((hb_codepoint_t) ((c) - 0xd800) * 0x400 + (l) - 0xdc00 + 0x10000);
 590        text++;
 591     } else
 592       *unicode = -1;
 593   } else
 594     *unicode = c;
 595
 596   return text;
 597 }
 598
 599 void
 600 hb_buffer_add_utf16 (hb_buffer_t    *buffer,
 601                      const uint16_t *text,
 602                      unsigned int    text_length HB_UNUSED,
 603                      unsigned int    item_offset,
 604                      unsigned int    item_length)
 605 {
 606 #define UTF_NEXT(S, E, U)       hb_utf16_next (S, E, &(U))
 607   ADD_UTF (uint16_t);
 608 #undef UTF_NEXT
 609 }
 610
 611 void
 612 hb_buffer_add_utf32 (hb_buffer_t    *buffer,
 613                      const uint32_t *text,
 614                      unsigned int    text_length HB_UNUSED,
 615                      unsigned int    item_offset,
 616                      unsigned int    item_length)
 617 {
 618 #define UTF_NEXT(S, E, U)       ((U) = *(S), (S)+1)
 619   ADD_UTF (uint32_t);
 620 #undef UTF_NEXT
 621 }
 622
 623
 624 HB_END_DECLS