73a11e1af5b90c2b3705efee80b00b788503cff8
[platform/upstream/harfbuzz.git] / src / hb-ot-shape.hh
1 /*
2  * Copyright © 2010  Google, Inc.
3  *
4  *  This is part of HarfBuzz, a text shaping library.
5  *
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.
11  *
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
16  * DAMAGE.
17  *
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.
23  *
24  * Google Author(s): Behdad Esfahbod
25  */
26
27 #ifndef HB_OT_SHAPE_HH
28 #define HB_OT_SHAPE_HH
29
30 #include "hb.hh"
31
32 #include "hb-ot-map.hh"
33 #include "hb-aat-map.hh"
34
35
36 struct hb_ot_shape_plan_key_t
37 {
38   unsigned int variations_index[2];
39
40   void init (hb_face_t   *face,
41                     const int   *coords,
42                     unsigned int num_coords)
43   {
44     for (unsigned int table_index = 0; table_index < 2; table_index++)
45       hb_ot_layout_table_find_feature_variations (face,
46                                                   table_tags[table_index],
47                                                   coords,
48                                                   num_coords,
49                                                   &variations_index[table_index]);
50   }
51
52   bool equal (const hb_ot_shape_plan_key_t *other)
53   {
54     return 0 == memcmp (this, other, sizeof (*this));
55   }
56 };
57
58
59 struct hb_shape_plan_key_t;
60
61 struct hb_ot_shape_plan_t
62 {
63   hb_segment_properties_t props;
64   const struct hb_ot_complex_shaper_t *shaper;
65   hb_ot_map_t map;
66   hb_aat_map_t aat_map;
67   const void *data;
68   hb_mask_t frac_mask, numr_mask, dnom_mask;
69   hb_mask_t rtlm_mask;
70   hb_mask_t kern_mask;
71   hb_mask_t trak_mask;
72
73   bool requested_kerning : 1;
74   bool requested_tracking : 1;
75   bool has_frac : 1;
76   bool has_gpos_mark : 1;
77   bool zero_marks : 1;
78   bool fallback_glyph_classes : 1;
79   bool fallback_mark_positioning : 1;
80   bool adjust_mark_positioning_when_zeroing : 1;
81
82   bool apply_gpos : 1;
83   bool apply_kerx : 1;
84   bool apply_kern : 1;
85   bool apply_morx : 1;
86   bool apply_trak : 1;
87
88   void collect_lookups (hb_tag_t table_tag, hb_set_t *lookups) const
89   {
90     unsigned int table_index;
91     switch (table_tag) {
92       case HB_OT_TAG_GSUB: table_index = 0; break;
93       case HB_OT_TAG_GPOS: table_index = 1; break;
94       default: return;
95     }
96     map.collect_lookups (table_index, lookups);
97   }
98
99   HB_INTERNAL bool init0 (hb_face_t                     *face,
100                           const hb_shape_plan_key_t     *key);
101   HB_INTERNAL void fini ();
102
103   HB_INTERNAL void substitute (hb_font_t *font, hb_buffer_t *buffer) const;
104   HB_INTERNAL void position (hb_font_t *font, hb_buffer_t *buffer) const;
105 };
106
107 struct hb_shape_plan_t;
108
109 struct hb_ot_shape_planner_t
110 {
111   /* In the order that they are filled in. */
112   hb_face_t *face;
113   hb_segment_properties_t props;
114   hb_ot_map_builder_t map;
115   hb_aat_map_builder_t aat_map;
116   bool apply_morx : 1;
117   bool script_zero_marks : 1;
118   bool script_fallback_mark_positioning : 1;
119   const struct hb_ot_complex_shaper_t *shaper;
120
121   HB_INTERNAL hb_ot_shape_planner_t (hb_face_t                     *face,
122                                      const hb_segment_properties_t *props);
123
124   HB_INTERNAL void compile (hb_ot_shape_plan_t           &plan,
125                             const hb_ot_shape_plan_key_t &key);
126 };
127
128
129 #endif /* HB_OT_SHAPE_HH */