2 * Copyright © 1998-2004 David Turner and Werner Lemberg
3 * Copyright © 2004,2007,2009,2010 Red Hat, Inc.
4 * Copyright © 2011 Google, Inc.
6 * This is part of HarfBuzz, a text shaping library.
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.
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
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.
26 * Red Hat Author(s): Owen Taylor, Behdad Esfahbod
27 * Google Author(s): Behdad Esfahbod
30 #ifndef HB_BUFFER_PRIVATE_HH
31 #define HB_BUFFER_PRIVATE_HH
33 #include "hb-private.hh"
34 #include "hb-buffer.h"
35 #include "hb-object-private.hh"
36 #include "hb-unicode-private.hh"
41 ASSERT_STATIC (sizeof (hb_glyph_info_t) == 20);
42 ASSERT_STATIC (sizeof (hb_glyph_info_t) == sizeof (hb_glyph_position_t));
44 typedef struct _hb_segment_properties_t {
45 hb_direction_t direction;
47 hb_language_t language;
48 } hb_segment_properties_t;
52 hb_object_header_t header;
54 /* Information about how the text in the buffer should be treated */
56 hb_unicode_funcs_t *unicode; /* Unicode functions */
57 hb_segment_properties_t props; /* Script, language, direction */
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 */
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 */
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;
75 uint8_t allocated_var_bytes[8];
76 const char *allocated_var_owner[8];
81 HB_INTERNAL void reset (void);
83 inline unsigned int backtrack_len (void) const
84 { return have_output? out_len : idx; }
85 inline unsigned int next_serial (void) { return serial++; }
88 HB_INTERNAL void allocate_var (unsigned int byte_i, unsigned int count, const char *owner);
89 HB_INTERNAL void deallocate_var (unsigned int byte_i, unsigned int count, const char *owner);
90 HB_INTERNAL void deallocate_var_all (void);
92 inline void allocate_var_8 (unsigned int var_num, unsigned int i, const char *owner)
93 { assert (var_num < 2 && i < 4); allocate_var (var_num * 4 + i, 1, owner); }
94 inline void allocate_var_16 (unsigned int var_num, unsigned int i, const char *owner)
95 { assert (var_num < 2 && i < 2); allocate_var (var_num * 4 + i * 2, 2, owner); }
96 inline void allocate_var_32 (unsigned int var_num, const char *owner)
97 { assert (var_num < 2); allocate_var (var_num * 4, 4, owner); }
99 inline void deallocate_var_8 (unsigned int var_num, unsigned int i, const char *owner)
100 { assert (var_num < 2 && i < 4); deallocate_var (var_num * 4 + i, 1, owner); }
101 inline void deallocate_var_16 (unsigned int var_num, unsigned int i, const char *owner)
102 { assert (var_num < 2 && i < 2); deallocate_var (var_num * 4 + i * 2, 2, owner); }
103 inline void deallocate_var_32 (unsigned int var_num, const char *owner)
104 { assert (var_num < 2); deallocate_var (var_num * 4, 4, owner); }
107 HB_INTERNAL void add (hb_codepoint_t codepoint,
109 unsigned int cluster);
111 HB_INTERNAL void reverse_range (unsigned int start, unsigned int end);
112 HB_INTERNAL void reverse (void);
113 HB_INTERNAL void reverse_clusters (void);
115 HB_INTERNAL void swap_buffers (void);
116 HB_INTERNAL void clear_output (void);
117 HB_INTERNAL void clear_positions (void);
118 HB_INTERNAL void replace_glyphs_be16 (unsigned int num_in,
119 unsigned int num_out,
120 const uint16_t *glyph_data_be);
121 HB_INTERNAL void replace_glyph (hb_codepoint_t glyph_index);
122 /* Makes a copy of the glyph at idx to output and replace glyph_index */
123 HB_INTERNAL void output_glyph (hb_codepoint_t glyph_index);
124 /* Copies glyph at idx to output but doesn't advance idx */
125 HB_INTERNAL void copy_glyph (void);
126 /* Copies glyph at idx to output and advance idx.
127 * If there's no output, just advance idx. */
128 HB_INTERNAL void next_glyph (void);
129 /* Advance idx without copying to output. */
130 inline void skip_glyph (void) { idx++; }
132 inline void reset_masks (hb_mask_t mask)
134 for (unsigned int j = 0; j < len; j++)
137 inline void add_masks (hb_mask_t mask)
139 for (unsigned int j = 0; j < len; j++)
140 info[j].mask |= mask;
142 HB_INTERNAL void set_masks (hb_mask_t value,
144 unsigned int cluster_start,
145 unsigned int cluster_end);
147 /* Internal methods */
148 HB_INTERNAL bool enlarge (unsigned int size);
150 inline bool ensure (unsigned int size)
151 { return likely (size <= allocated) ? TRUE : enlarge (size); }
153 HB_INTERNAL bool make_room_for (unsigned int num_in, unsigned int num_out);
159 #endif /* HB_BUFFER_PRIVATE_HH */