src/hb-buffer-private.hh

   1 /*
   2  * Copyright © 1998-2004  David Turner and Werner Lemberg
   3  * Copyright © 2004,2007,2009,2010  Red Hat, Inc.
   4  * Copyright © 2011,2012  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 #ifndef HB_BUFFER_PRIVATE_HH
  31 #define HB_BUFFER_PRIVATE_HH
  32
  33 #include "hb-private.hh"
  34 #include "hb-buffer.h"
  35 #include "hb-object-private.hh"
  36 #include "hb-unicode-private.hh"
  37
  38
  39 ASSERT_STATIC (sizeof (hb_glyph_info_t) == 20);
  40 ASSERT_STATIC (sizeof (hb_glyph_info_t) == sizeof (hb_glyph_position_t));
  41
  42
  43 /*
  44  * hb_buffer_t
  45  */
  46
  47 struct hb_buffer_t {
  48   hb_object_header_t header;
  49   ASSERT_POD ();
  50
  51   /* Information about how the text in the buffer should be treated */
  52
  53   hb_unicode_funcs_t *unicode; /* Unicode functions */
  54   hb_segment_properties_t props; /* Script, language, direction */
  55   hb_buffer_flags_t flags; /* BOT / EOT / etc. */
  56
  57   /* Buffer contents */
  58
  59   hb_buffer_content_type_t content_type;
  60
  61   bool in_error; /* Allocation failed */
  62   bool have_output; /* Whether we have an output buffer going on */
  63   bool have_positions; /* Whether we have positions */
  64
  65   unsigned int idx; /* Cursor into ->info and ->pos arrays */
  66   unsigned int len; /* Length of ->info and ->pos arrays */
  67   unsigned int out_len; /* Length of ->out array if have_output */
  68
  69   unsigned int allocated; /* Length of allocated arrays */
  70   hb_glyph_info_t     *info;
  71   hb_glyph_info_t     *out_info;
  72   hb_glyph_position_t *pos;
  73
  74   inline hb_glyph_info_t &cur (unsigned int i = 0) { return info[idx + i]; }
  75   inline hb_glyph_info_t cur (unsigned int i = 0) const { return info[idx + i]; }
  76
  77   inline hb_glyph_position_t &cur_pos (unsigned int i = 0) { return pos[idx + i]; }
  78   inline hb_glyph_position_t cur_pos (unsigned int i = 0) const { return pos[idx + i]; }
  79
  80   inline hb_glyph_info_t &prev (void) { return out_info[out_len - 1]; }
  81   inline hb_glyph_info_t prev (void) const { return info[out_len - 1]; }
  82
  83   unsigned int serial;
  84
  85   /* These reflect current allocations of the bytes in glyph_info_t's var1 and var2. */
  86   uint8_t allocated_var_bytes[8];
  87   const char *allocated_var_owner[8];
  88
  89   /* Text before / after the main buffer contents.
  90    * Always in Unicode, and ordered outward.
  91    * Index 0 is for "pre-context", 1 for "post-context". */
  92   static const unsigned int CONTEXT_LENGTH = 5;
  93   hb_codepoint_t context[2][CONTEXT_LENGTH];
  94   unsigned int context_len[2];
  95
  96
  97   /* Methods */
  98
  99   HB_INTERNAL void reset (void);
 100   HB_INTERNAL void clear (void);
 101
 102   inline unsigned int backtrack_len (void) const
 103   { return have_output? out_len : idx; }
 104   inline unsigned int next_serial (void) { return serial++; }
 105
 106   HB_INTERNAL void allocate_var (unsigned int byte_i, unsigned int count, const char *owner);
 107   HB_INTERNAL void deallocate_var (unsigned int byte_i, unsigned int count, const char *owner);
 108   HB_INTERNAL void assert_var (unsigned int byte_i, unsigned int count, const char *owner);
 109   HB_INTERNAL void deallocate_var_all (void);
 110
 111   HB_INTERNAL void add (hb_codepoint_t  codepoint,
 112                         unsigned int    cluster);
 113
 114   HB_INTERNAL void reverse_range (unsigned int start, unsigned int end);
 115   HB_INTERNAL void reverse (void);
 116   HB_INTERNAL void reverse_clusters (void);
 117   HB_INTERNAL void guess_segment_properties (void);
 118
 119   HB_INTERNAL void swap_buffers (void);
 120   HB_INTERNAL void remove_output (void);
 121   HB_INTERNAL void clear_output (void);
 122   HB_INTERNAL void clear_positions (void);
 123
 124   HB_INTERNAL void replace_glyphs (unsigned int num_in,
 125                                    unsigned int num_out,
 126                                    const hb_codepoint_t *glyph_data);
 127
 128   HB_INTERNAL void replace_glyph (hb_codepoint_t glyph_index);
 129   /* Makes a copy of the glyph at idx to output and replace glyph_index */
 130   HB_INTERNAL void output_glyph (hb_codepoint_t glyph_index);
 131   HB_INTERNAL void output_info (hb_glyph_info_t &glyph_info);
 132   /* Copies glyph at idx to output but doesn't advance idx */
 133   HB_INTERNAL void copy_glyph (void);
 134   /* Copies glyph at idx to output and advance idx.
 135    * If there's no output, just advance idx. */
 136   inline void
 137   next_glyph (void)
 138   {
 139     if (have_output)
 140     {
 141       if (unlikely (out_info != info || out_len != idx)) {
 142         if (unlikely (!make_room_for (1, 1))) return;
 143         out_info[out_len] = info[idx];
 144       }
 145       out_len++;
 146     }
 147
 148     idx++;
 149   }
 150
 151   /* Advance idx without copying to output. */
 152   inline void skip_glyph (void) { idx++; }
 153
 154   inline void reset_masks (hb_mask_t mask)
 155   {
 156     for (unsigned int j = 0; j < len; j++)
 157       info[j].mask = mask;
 158   }
 159   inline void add_masks (hb_mask_t mask)
 160   {
 161     for (unsigned int j = 0; j < len; j++)
 162       info[j].mask |= mask;
 163   }
 164   HB_INTERNAL void set_masks (hb_mask_t value,
 165                               hb_mask_t mask,
 166                               unsigned int cluster_start,
 167                               unsigned int cluster_end);
 168
 169   HB_INTERNAL void merge_clusters (unsigned int start,
 170                                    unsigned int end);
 171   HB_INTERNAL void merge_out_clusters (unsigned int start,
 172                                        unsigned int end);
 173
 174   /* Internal methods */
 175   HB_INTERNAL bool enlarge (unsigned int size);
 176
 177   inline bool ensure (unsigned int size)
 178   { return likely (size < allocated) ? true : enlarge (size); }
 179
 180   HB_INTERNAL bool make_room_for (unsigned int num_in, unsigned int num_out);
 181
 182   HB_INTERNAL void *get_scratch_buffer (unsigned int *size);
 183
 184   inline void clear_context (unsigned int side) { context_len[side] = 0; }
 185 };
 186
 187
 188 #define HB_BUFFER_XALLOCATE_VAR(b, func, var, owner) \
 189   b->func (offsetof (hb_glyph_info_t, var) - offsetof(hb_glyph_info_t, var1), \
 190            sizeof (b->info[0].var), owner)
 191 #define HB_BUFFER_ALLOCATE_VAR(b, var) \
 192         HB_BUFFER_XALLOCATE_VAR (b, allocate_var, var (), #var)
 193 #define HB_BUFFER_DEALLOCATE_VAR(b, var) \
 194         HB_BUFFER_XALLOCATE_VAR (b, deallocate_var, var (), #var)
 195 #define HB_BUFFER_ASSERT_VAR(b, var) \
 196         HB_BUFFER_XALLOCATE_VAR (b, assert_var, var (), #var)
 197
 198
 199 #endif /* HB_BUFFER_PRIVATE_HH */