[OT] Separate map_builder from the actual map
[framework/uifw/harfbuzz.git] / src / hb-ot-shape-private.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_PRIVATE_HH
28 #define HB_OT_SHAPE_PRIVATE_HH
29
30 #include "hb-private.hh"
31
32 #include "hb-ot-shape.h"
33
34 #include "hb-ot-map-private.hh"
35
36 HB_BEGIN_DECLS
37
38
39 /* buffer var allocations */
40 #define general_category() var1.u8[0] /* unicode general_category (hb_unicode_general_category_t) */
41 #define combining_class() var1.u8[1] /* unicode combining_class (uint8_t) */
42
43
44 enum hb_ot_complex_shaper_t {
45   hb_ot_complex_shaper_none,
46   hb_ot_complex_shaper_arabic
47 };
48
49
50 struct hb_ot_shape_plan_t
51 {
52   friend struct hb_ot_shape_planner_t;
53
54   hb_ot_map_t map;
55   hb_ot_complex_shaper_t shaper;
56
57   hb_ot_shape_plan_t (void) : map () {}
58   ~hb_ot_shape_plan_t (void) { map.finish (); }
59
60   private:
61   NO_COPY (hb_ot_shape_plan_t);
62 };
63
64 struct hb_ot_shape_planner_t
65 {
66   hb_ot_map_builder_t map;
67   hb_ot_complex_shaper_t shaper;
68
69   hb_ot_shape_planner_t (void) : map () {}
70   ~hb_ot_shape_planner_t (void) { map.finish (); }
71
72   inline void compile (hb_face_t *face,
73                        const hb_segment_properties_t *props,
74                        struct hb_ot_shape_plan_t &plan)
75   {
76     plan.shaper = shaper;
77     map.compile (face, props, plan.map);
78   }
79
80   private:
81   NO_COPY (hb_ot_shape_planner_t);
82 };
83
84
85 struct hb_ot_shape_context_t
86 {
87   /* Input to hb_ot_shape_execute() */
88   hb_ot_shape_plan_t *plan;
89   hb_font_t *font;
90   hb_face_t *face;
91   hb_buffer_t  *buffer;
92   const hb_feature_t *user_features;
93   unsigned int        num_user_features;
94
95   /* Transient stuff */
96   hb_direction_t target_direction;
97   hb_bool_t applied_substitute_complex;
98   hb_bool_t applied_position_complex;
99 };
100
101
102 HB_END_DECLS
103
104 #endif /* HB_OT_SHAPE_PRIVATE_HH */