src/hb-buffer-private.h

   1 /*
   2  * Copyright (C) 1998-2004  David Turner and Werner Lemberg
   3  * Copyright (C) 2004,2007,2009  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; used
  58                                            only internally */
  59 } hb_internal_glyph_position_t;
  60
  61 ASSERT_STATIC (sizeof (hb_glyph_info_t) == sizeof (hb_internal_glyph_info_t));
  62 ASSERT_STATIC (sizeof (hb_glyph_position_t) == sizeof (hb_internal_glyph_position_t));
  63 ASSERT_STATIC (sizeof (hb_glyph_info_t) == sizeof (hb_glyph_position_t));
  64
  65
  66 struct _hb_buffer_t {
  67   hb_reference_count_t ref_count;
  68
  69   /* Information about how the text in the buffer should be treated */
  70   hb_unicode_funcs_t *unicode;
  71   hb_direction_t      direction;
  72   hb_script_t         script;
  73   hb_language_t       language;
  74
  75   /* Buffer contents */
  76
  77   unsigned int allocated;
  78
  79   hb_bool_t    have_output; /* whether we have an output buffer going on */
  80   hb_bool_t    have_positions; /* whether we have positions */
  81   unsigned int in_length;
  82   unsigned int out_length;
  83   unsigned int in_pos;
  84   unsigned int out_pos; /* out_length and out_pos are actually always the same */
  85
  86   hb_internal_glyph_info_t     *in_string;
  87   hb_internal_glyph_info_t     *out_string;
  88   hb_internal_glyph_position_t *positions;
  89
  90   /* Other stuff */
  91
  92   unsigned int         max_lig_id;
  93 };
  94
  95
  96 HB_INTERNAL void
  97 _hb_buffer_swap (hb_buffer_t *buffer);
  98
  99 HB_INTERNAL void
 100 _hb_buffer_clear_output (hb_buffer_t *buffer);
 101
 102 HB_INTERNAL void
 103 _hb_buffer_add_output_glyphs (hb_buffer_t *buffer,
 104                               unsigned int num_in,
 105                               unsigned int num_out,
 106                               const hb_codepoint_t *glyph_data,
 107                               unsigned short component,
 108                               unsigned short ligID);
 109
 110 HB_INTERNAL void
 111 _hb_buffer_add_output_glyphs_be16 (hb_buffer_t *buffer,
 112                                    unsigned int num_in,
 113                                    unsigned int num_out,
 114                                    const uint16_t *glyph_data_be,
 115                                    unsigned short component,
 116                                    unsigned short ligID);
 117
 118 HB_INTERNAL void
 119 _hb_buffer_add_output_glyph (hb_buffer_t *buffer,
 120                              hb_codepoint_t glyph_index,
 121                              unsigned short component,
 122                              unsigned short ligID);
 123
 124 HB_INTERNAL void
 125 _hb_buffer_next_glyph (hb_buffer_t *buffer);
 126
 127 HB_INTERNAL void
 128 _hb_buffer_replace_glyph (hb_buffer_t *buffer,
 129                           hb_codepoint_t glyph_index);
 130
 131 HB_INTERNAL unsigned short
 132 _hb_buffer_allocate_lig_id (hb_buffer_t *buffer);
 133
 134
 135 #ifndef BUFFER
 136 #define BUFFER buffer
 137 #endif
 138
 139 /* convenience macros */
 140 #define IN_GLYPH(pos)           (BUFFER->in_string[(pos)].codepoint)
 141 #define IN_INFO(pos)            (&BUFFER->in_string[(pos)])
 142 #define IN_CURGLYPH()           (BUFFER->in_string[BUFFER->in_pos].codepoint)
 143 #define IN_NEXTGLYPH()          (BUFFER->in_string[BUFFER->in_pos + 1].codepoint)
 144 #define IN_CURINFO()            (&BUFFER->in_string[BUFFER->in_pos])
 145 #define IN_MASK(pos)            (BUFFER->in_string[(pos)].mask)
 146 #define IN_CLUSTER(pos)         (BUFFER->in_string[(pos)].cluster)
 147 #define IN_LIGID(pos)           (BUFFER->in_string[(pos)].lig_id)
 148 #define IN_COMPONENT(pos)       (BUFFER->in_string[(pos)].component)
 149 #define POSITION(pos)           (&BUFFER->positions[(pos)])
 150 #define CURPOSITION()           (&BUFFER->positions[BUFFER->in_pos])
 151 #define OUT_GLYPH(pos)          (BUFFER->out_string[(pos)].codepoint)
 152 #define OUT_INFO(pos)           (&BUFFER->out_string[(pos)])
 153
 154 HB_END_DECLS
 155
 156 #endif /* HB_BUFFER_PRIVATE_H */