2 * Copyright © 2007,2008,2009 Red Hat, Inc.
4 * This is part of HarfBuzz, a text shaping library.
6 * Permission is hereby granted, without written agreement and without
7 * license or royalty fees, to use, copy, modify, and distribute this
8 * software and its documentation for any purpose, provided that the
9 * above copyright notice and the following two paragraphs appear in
10 * all copies of this software.
12 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
13 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
14 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
15 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
18 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
19 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
21 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
22 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
24 * Red Hat Author(s): Behdad Esfahbod
27 #ifndef HB_OT_LAYOUT_H
28 #define HB_OT_LAYOUT_H
30 #include "hb-common.h"
31 #include "hb-buffer.h"
34 #include "hb-ot-tag.h"
39 #define HB_OT_TAG_GDEF HB_TAG('G','D','E','F')
40 #define HB_OT_TAG_GSUB HB_TAG('G','S','U','B')
41 #define HB_OT_TAG_GPOS HB_TAG('G','P','O','S')
48 hb_ot_layout_has_glyph_classes (hb_face_t *face);
50 /* Not that useful. Provides list of attach points for a glyph that a
51 * client may want to cache */
53 hb_ot_layout_get_attach_points (hb_face_t *face,
55 unsigned int start_offset,
56 unsigned int *point_count /* IN/OUT */,
57 unsigned int *point_array /* OUT */);
59 /* Ligature caret positions */
61 hb_ot_layout_get_ligature_carets (hb_font_t *font,
62 hb_direction_t direction,
64 unsigned int start_offset,
65 unsigned int *caret_count /* IN/OUT */,
66 hb_position_t *caret_array /* OUT */);
70 * GSUB/GPOS feature query and enumeration interface
73 #define HB_OT_LAYOUT_NO_SCRIPT_INDEX ((unsigned int) 0xFFFF)
74 #define HB_OT_LAYOUT_NO_FEATURE_INDEX ((unsigned int) 0xFFFF)
75 #define HB_OT_LAYOUT_DEFAULT_LANGUAGE_INDEX ((unsigned int) 0xFFFF)
78 hb_ot_layout_table_get_script_tags (hb_face_t *face,
80 unsigned int start_offset,
81 unsigned int *script_count /* IN/OUT */,
82 hb_tag_t *script_tags /* OUT */);
85 hb_ot_layout_table_find_script (hb_face_t *face,
88 unsigned int *script_index);
90 /* Like find_script, but takes zero-terminated array of scripts to test */
92 hb_ot_layout_table_choose_script (hb_face_t *face,
94 const hb_tag_t *script_tags,
95 unsigned int *script_index);
98 hb_ot_layout_table_get_feature_tags (hb_face_t *face,
100 unsigned int start_offset,
101 unsigned int *feature_count /* IN/OUT */,
102 hb_tag_t *feature_tags /* OUT */);
105 hb_ot_layout_script_get_language_tags (hb_face_t *face,
107 unsigned int script_index,
108 unsigned int start_offset,
109 unsigned int *language_count /* IN/OUT */,
110 hb_tag_t *language_tags /* OUT */);
113 hb_ot_layout_script_find_language (hb_face_t *face,
115 unsigned int script_index,
116 hb_tag_t language_tag,
117 unsigned int *language_index);
120 hb_ot_layout_language_get_required_feature_index (hb_face_t *face,
122 unsigned int script_index,
123 unsigned int language_index,
124 unsigned int *feature_index);
127 hb_ot_layout_language_get_feature_indexes (hb_face_t *face,
129 unsigned int script_index,
130 unsigned int language_index,
131 unsigned int start_offset,
132 unsigned int *feature_count /* IN/OUT */,
133 unsigned int *feature_indexes /* OUT */);
136 hb_ot_layout_language_get_feature_tags (hb_face_t *face,
138 unsigned int script_index,
139 unsigned int language_index,
140 unsigned int start_offset,
141 unsigned int *feature_count /* IN/OUT */,
142 hb_tag_t *feature_tags /* OUT */);
145 hb_ot_layout_language_find_feature (hb_face_t *face,
147 unsigned int script_index,
148 unsigned int language_index,
149 hb_tag_t feature_tag,
150 unsigned int *feature_index);
153 hb_ot_layout_feature_get_lookup_indexes (hb_face_t *face,
155 unsigned int feature_index,
156 unsigned int start_offset,
157 unsigned int *lookup_count /* IN/OUT */,
158 unsigned int *lookup_indexes /* OUT */);
166 hb_ot_layout_has_substitution (hb_face_t *face);
168 /* Should be called before all the substitute_lookup's are done. */
170 hb_ot_layout_substitute_start (hb_buffer_t *buffer);
173 hb_ot_layout_substitute_lookup (hb_face_t *face,
175 unsigned int lookup_index,
178 /* Should be called after all the substitute_lookup's are done */
180 hb_ot_layout_substitute_finish (hb_buffer_t *buffer);
187 hb_ot_layout_has_positioning (hb_face_t *face);
189 /* Should be called before all the position_lookup's are done. Resets positions to zero. */
191 hb_ot_layout_position_start (hb_buffer_t *buffer);
194 hb_ot_layout_position_lookup (hb_font_t *font,
196 unsigned int lookup_index,
199 /* Should be called after all the position_lookup's are done */
201 hb_ot_layout_position_finish (hb_buffer_t *buffer);
206 #endif /* HB_OT_LAYOUT_H */