src/hb-buffer-private.hh

   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 #ifndef HB_BUFFER_PRIVATE_H
  29 #define HB_BUFFER_PRIVATE_H
  30
  31 #include "hb-private.h"
  32 #include "hb-buffer.h"
  33 #include "hb-unicode-private.h"
  34
  35 HB_BEGIN_DECLS
  36
  37 #define HB_BUFFER_GLYPH_PROPERTIES_UNKNOWN 0xFFFF
  38
  39
  40 typedef struct _hb_internal_glyph_info_t {
  41   hb_codepoint_t codepoint;
  42   hb_mask_t      mask;
  43   uint32_t       cluster;
  44   uint16_t       component;
  45   uint16_t       lig_id;
  46   uint32_t       gproperty;
  47 } hb_internal_glyph_info_t;
  48
  49 typedef struct _hb_internal_glyph_position_t {
  50   hb_position_t  x_advance;
  51   hb_position_t  y_advance;
  52   hb_position_t  x_offset;
  53   hb_position_t  y_offset;
  54   uint32_t       back : 16;             /* number of glyphs to go back
  55                                            for drawing current glyph */
  56   int32_t        cursive_chain : 16;    /* character to which this connects,
  57                                            may be positive or negative */
  58 } hb_internal_glyph_position_t;
  59
  60 ASSERT_STATIC (sizeof (hb_glyph_info_t) == sizeof (hb_internal_glyph_info_t));
  61 ASSERT_STATIC (sizeof (hb_glyph_position_t) == sizeof (hb_internal_glyph_position_t));
  62 ASSERT_STATIC (sizeof (hb_glyph_info_t) == sizeof (hb_glyph_position_t));
  63
  64
  65
  66 HB_INTERNAL void
  67 _hb_buffer_swap (hb_buffer_t *buffer);
  68
  69 HB_INTERNAL void
  70 _hb_buffer_clear_output (hb_buffer_t *buffer);
  71
  72 HB_INTERNAL void
  73 _hb_buffer_add_output_glyphs (hb_buffer_t *buffer,
  74                               unsigned int num_in,
  75                               unsigned int num_out,
  76                               const hb_codepoint_t *glyph_data,
  77                               unsigned short component,
  78                               unsigned short ligID);
  79
  80 HB_INTERNAL void
  81 _hb_buffer_add_output_glyphs_be16 (hb_buffer_t *buffer,
  82                                    unsigned int num_in,
  83                                    unsigned int num_out,
  84                                    const uint16_t *glyph_data_be,
  85                                    unsigned short component,
  86                                    unsigned short ligID);
  87
  88 HB_INTERNAL void
  89 _hb_buffer_add_output_glyph (hb_buffer_t *buffer,
  90                              hb_codepoint_t glyph_index,
  91                              unsigned short component,
  92                              unsigned short ligID);
  93
  94 HB_INTERNAL void
  95 _hb_buffer_next_glyph (hb_buffer_t *buffer);
  96
  97
  98
  99 struct _hb_buffer_t {
 100   hb_reference_count_t ref_count;
 101
 102   /* Information about how the text in the buffer should be treated */
 103   hb_unicode_funcs_t *unicode;
 104   hb_direction_t      direction;
 105   hb_script_t         script;
 106   hb_language_t       language;
 107
 108   /* Buffer contents */
 109
 110   unsigned int allocated;
 111
 112   hb_bool_t    have_output; /* whether we have an output buffer going on */
 113   hb_bool_t    have_positions; /* whether we have positions */
 114   unsigned int in_length;
 115   unsigned int out_length;
 116   unsigned int in_pos;
 117   unsigned int out_pos; /* out_length and out_pos are actually always the same */
 118
 119   hb_internal_glyph_info_t     *in_string;
 120   hb_internal_glyph_info_t     *out_string;
 121   hb_internal_glyph_position_t *positions;
 122
 123   /* Other stuff */
 124
 125   unsigned int         max_lig_id;
 126
 127
 128   /* Methods */
 129   inline unsigned int allocate_lig_id (void) { return max_lig_id++; }
 130   inline void swap (void) { _hb_buffer_swap (this); }
 131   inline void clear_output (void) { _hb_buffer_clear_output (this); }
 132   inline void next_glyph (void) { _hb_buffer_next_glyph (this); }
 133   inline void add_output_glyphs (unsigned int num_in,
 134                                  unsigned int num_out,
 135                                  const hb_codepoint_t *glyph_data,
 136                                  unsigned short component,
 137                                  unsigned short ligID)
 138   { _hb_buffer_add_output_glyphs (this, num_in, num_out, glyph_data, component, ligID); }
 139   inline void add_output_glyphs_be16 (unsigned int num_in,
 140                                       unsigned int num_out,
 141                                       const uint16_t *glyph_data_be,
 142                                       unsigned short component,
 143                                       unsigned short ligID)
 144   { _hb_buffer_add_output_glyphs_be16 (this, num_in, num_out, glyph_data_be, component, ligID); }
 145   inline void add_output_glyph (hb_codepoint_t glyph_index,
 146                                 unsigned short component = 0xFFFF,
 147                                 unsigned short ligID = 0xFFFF)
 148   { _hb_buffer_add_output_glyph (this, glyph_index, component, ligID); }
 149   inline void replace_glyph (hb_codepoint_t glyph_index) { add_output_glyph (glyph_index); }
 150 };
 151
 152
 153
 154 #ifndef BUFFER
 155 #define BUFFER buffer
 156 #endif
 157
 158 /* convenience macros */
 159 #define IN_GLYPH(pos)           (BUFFER->in_string[(pos)].codepoint)
 160 #define IN_INFO(pos)            (&BUFFER->in_string[(pos)])
 161 #define IN_CURGLYPH()           (BUFFER->in_string[BUFFER->in_pos].codepoint)
 162 #define IN_NEXTGLYPH()          (BUFFER->in_string[BUFFER->in_pos + 1].codepoint)
 163 #define IN_CURINFO()            (&BUFFER->in_string[BUFFER->in_pos])
 164 #define IN_MASK(pos)            (BUFFER->in_string[(pos)].mask)
 165 #define IN_CLUSTER(pos)         (BUFFER->in_string[(pos)].cluster)
 166 #define IN_LIGID(pos)           (BUFFER->in_string[(pos)].lig_id)
 167 #define IN_COMPONENT(pos)       (BUFFER->in_string[(pos)].component)
 168 #define POSITION(pos)           (&BUFFER->positions[(pos)])
 169 #define CURPOSITION()           (&BUFFER->positions[BUFFER->in_pos])
 170 #define OUT_GLYPH(pos)          (BUFFER->out_string[(pos)].codepoint)
 171 #define OUT_INFO(pos)           (&BUFFER->out_string[(pos)])
 172
 173 HB_END_DECLS
 174
 175 #endif /* HB_BUFFER_PRIVATE_H */