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  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
  40 ASSERT_STATIC (sizeof (hb_glyph_info_t) == 20);
  41 ASSERT_STATIC (sizeof (hb_glyph_info_t) == sizeof (hb_glyph_position_t));
  42
  43 typedef struct _hb_segment_properties_t {
  44     hb_direction_t      direction;
  45     hb_script_t         script;
  46     hb_language_t       language;
  47     ASSERT_POD ();
  48 } hb_segment_properties_t;
  49
  50
  51 struct _hb_buffer_t {
  52   hb_object_header_t header;
  53   ASSERT_POD ();
  54
  55   /* Information about how the text in the buffer should be treated */
  56
  57   hb_unicode_funcs_t *unicode; /* Unicode functions */
  58   hb_segment_properties_t props; /* Script, language, direction */
  59
  60   /* Buffer contents */
  61
  62   bool in_error; /* Allocation failed */
  63   bool have_output; /* Whether we have an output buffer going on */
  64   bool have_positions; /* Whether we have positions */
  65
  66   unsigned int idx; /* Cursor into ->info and ->pos arrays */
  67   unsigned int len; /* Length of ->info and ->pos arrays */
  68   unsigned int out_len; /* Length of ->out array if have_output */
  69
  70   unsigned int allocated; /* Length of allocated arrays */
  71   hb_glyph_info_t     *info;
  72   hb_glyph_info_t     *out_info;
  73   hb_glyph_position_t *pos;
  74
  75   inline hb_glyph_info_t &cur (unsigned int i = 0) { return info[idx + i]; }
  76   inline hb_glyph_info_t cur (unsigned int i = 0) const { return info[idx + i]; }
  77
  78   inline hb_glyph_position_t &cur_pos (unsigned int i = 0) { return pos[idx + i]; }
  79   inline hb_glyph_position_t cur_pos (unsigned int i = 0) const { return pos[idx + i]; }
  80
  81   inline hb_glyph_info_t &prev (void) { return out_info[out_len - 1]; }
  82   inline hb_glyph_info_t prev (void) const { return info[out_len - 1]; }
  83
  84   unsigned int serial;
  85   uint8_t allocated_var_bytes[8];
  86   const char *allocated_var_owner[8];
  87
  88
  89   /* Methods */
  90
  91   HB_INTERNAL void reset (void);
  92
  93   inline unsigned int backtrack_len (void) const
  94   { return have_output? out_len : idx; }
  95   inline unsigned int next_serial (void) { return serial++; }
  96
  97   HB_INTERNAL void allocate_var (unsigned int byte_i, unsigned int count, const char *owner);
  98   HB_INTERNAL void deallocate_var (unsigned int byte_i, unsigned int count, const char *owner);
  99   HB_INTERNAL void deallocate_var_all (void);
 100
 101   HB_INTERNAL void add (hb_codepoint_t  codepoint,
 102                         hb_mask_t       mask,
 103                         unsigned int    cluster);
 104
 105   HB_INTERNAL void reverse_range (unsigned int start, unsigned int end);
 106   HB_INTERNAL void reverse (void);
 107   HB_INTERNAL void reverse_clusters (void);
 108   HB_INTERNAL void guess_properties (void);
 109
 110   HB_INTERNAL void swap_buffers (void);
 111   HB_INTERNAL void clear_output (void);
 112   HB_INTERNAL void clear_positions (void);
 113   HB_INTERNAL void replace_glyphs_be16 (unsigned int num_in,
 114                                         unsigned int num_out,
 115                                         const uint16_t *glyph_data_be);
 116   HB_INTERNAL void replace_glyphs (unsigned int num_in,
 117                                    unsigned int num_out,
 118                                    const hb_codepoint_t *glyph_data);
 119   HB_INTERNAL void replace_glyph (hb_codepoint_t glyph_index);
 120   /* Makes a copy of the glyph at idx to output and replace glyph_index */
 121   HB_INTERNAL void output_glyph (hb_codepoint_t glyph_index);
 122   /* Copies glyph at idx to output but doesn't advance idx */
 123   HB_INTERNAL void copy_glyph (void);
 124   /* Copies glyph at idx to output and advance idx.
 125    * If there's no output, just advance idx. */
 126   HB_INTERNAL void next_glyph (void);
 127   /* Advance idx without copying to output. */
 128   inline void skip_glyph (void) { idx++; }
 129
 130   inline void reset_masks (hb_mask_t mask)
 131   {
 132     for (unsigned int j = 0; j < len; j++)
 133       info[j].mask = mask;
 134   }
 135   inline void add_masks (hb_mask_t mask)
 136   {
 137     for (unsigned int j = 0; j < len; j++)
 138       info[j].mask |= mask;
 139   }
 140   HB_INTERNAL void set_masks (hb_mask_t value,
 141                               hb_mask_t mask,
 142                               unsigned int cluster_start,
 143                               unsigned int cluster_end);
 144
 145   HB_INTERNAL void merge_clusters (unsigned int start,
 146                                    unsigned int end);
 147   HB_INTERNAL void merge_out_clusters (unsigned int start,
 148                                        unsigned int end);
 149
 150   /* Internal methods */
 151   HB_INTERNAL bool enlarge (unsigned int size);
 152
 153   inline bool ensure (unsigned int size)
 154   { return likely (size <= allocated) ? true : enlarge (size); }
 155
 156   HB_INTERNAL bool make_room_for (unsigned int num_in, unsigned int num_out);
 157
 158   HB_INTERNAL void *get_scratch_buffer (unsigned int *size);
 159 };
 160
 161
 162 #define HB_BUFFER_XALLOCATE_VAR(b, func, var, owner) \
 163   b->func (offsetof (hb_glyph_info_t, var) - offsetof(hb_glyph_info_t, var1), \
 164            sizeof (b->info[0].var), owner)
 165 #define HB_BUFFER_ALLOCATE_VAR(b, var) \
 166         HB_BUFFER_XALLOCATE_VAR (b, allocate_var, var (), #var)
 167 #define HB_BUFFER_DEALLOCATE_VAR(b, var) \
 168         HB_BUFFER_XALLOCATE_VAR (b, deallocate_var, var (), #var)
 169
 170
 171
 172 #endif /* HB_BUFFER_PRIVATE_HH */