xref: /aosp_15_r20/external/harfbuzz_ng/src/hb-ot-shape.hh (revision 2d1272b857b1f7575e6e246373e1cb218663db8a)
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 
inithb_ot_shape_plan_key_t40   void init (hb_face_t *face,
41 	     const int *coords,
42 	     unsigned   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 
equalhb_ot_shape_plan_key_t52   bool equal (const hb_ot_shape_plan_key_t *other)
53   {
54     return 0 == hb_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 {
~hb_ot_shape_plan_thb_ot_shape_plan_t63   ~hb_ot_shape_plan_t () { fini (); }
64 
65   hb_segment_properties_t props;
66   const struct hb_ot_shaper_t *shaper;
67   hb_ot_map_t map;
68   const void *data;
69 #ifndef HB_NO_OT_SHAPE_FRACTIONS
70   hb_mask_t frac_mask, numr_mask, dnom_mask;
71 #else
72   static constexpr hb_mask_t frac_mask = 0;
73   static constexpr hb_mask_t numr_mask = 0;
74   static constexpr hb_mask_t dnom_mask = 0;
75 #endif
76   hb_mask_t rtlm_mask;
77 #ifndef HB_NO_OT_KERN
78   hb_mask_t kern_mask;
79 #else
80   static constexpr hb_mask_t kern_mask = 0;
81 #endif
82 #ifndef HB_NO_AAT_SHAPE
83   hb_mask_t trak_mask;
84 #else
85   static constexpr hb_mask_t trak_mask = 0;
86 #endif
87 
88 #ifndef HB_NO_OT_KERN
89   bool requested_kerning : 1;
90 #else
91   static constexpr bool requested_kerning = false;
92 #endif
93 #ifndef HB_NO_AAT_SHAPE
94   bool requested_tracking : 1;
95 #else
96   static constexpr bool requested_tracking = false;
97 #endif
98 #ifndef HB_NO_OT_SHAPE_FRACTIONS
99   bool has_frac : 1;
100 #else
101   static constexpr bool has_frac = false;
102 #endif
103   bool has_vert : 1;
104   bool has_gpos_mark : 1;
105   bool zero_marks : 1;
106   bool fallback_glyph_classes : 1;
107   bool fallback_mark_positioning : 1;
108   bool adjust_mark_positioning_when_zeroing : 1;
109 
110   bool apply_gpos : 1;
111 #ifndef HB_NO_OT_KERN
112   bool apply_kern : 1;
113 #else
114   static constexpr bool apply_kern = false;
115 #endif
116   bool apply_fallback_kern : 1;
117 #ifndef HB_NO_AAT_SHAPE
118   bool apply_kerx : 1;
119   bool apply_morx : 1;
120   bool apply_trak : 1;
121 #else
122   static constexpr bool apply_kerx = false;
123   static constexpr bool apply_morx = false;
124   static constexpr bool apply_trak = false;
125 #endif
126 
collect_lookupshb_ot_shape_plan_t127   void collect_lookups (hb_tag_t table_tag, hb_set_t *lookups) const
128   {
129     unsigned int table_index;
130     switch (table_tag) {
131       case HB_OT_TAG_GSUB: table_index = 0; break;
132       case HB_OT_TAG_GPOS: table_index = 1; break;
133       default: return;
134     }
135     map.collect_lookups (table_index, lookups);
136   }
137 
138   HB_INTERNAL bool init0 (hb_face_t                     *face,
139 			  const hb_shape_plan_key_t     *key);
140   HB_INTERNAL void fini ();
141 
142   HB_INTERNAL void substitute (hb_font_t *font, hb_buffer_t *buffer) const;
143   HB_INTERNAL void position (hb_font_t *font, hb_buffer_t *buffer) const;
144 };
145 
146 struct hb_shape_plan_t;
147 
148 struct hb_ot_shape_planner_t
149 {
150   /* In the order that they are filled in. */
151   hb_face_t *face;
152   hb_segment_properties_t props;
153   hb_ot_map_builder_t map;
154 #ifndef HB_NO_AAT_SHAPE
155   bool apply_morx : 1;
156 #else
157   static constexpr bool apply_morx = false;
158 #endif
159   bool script_zero_marks : 1;
160   bool script_fallback_mark_positioning : 1;
161   const struct hb_ot_shaper_t *shaper;
162 
163   HB_INTERNAL hb_ot_shape_planner_t (hb_face_t                     *face,
164 				     const hb_segment_properties_t &props);
165 
166   HB_INTERNAL void compile (hb_ot_shape_plan_t           &plan,
167 			    const hb_ot_shape_plan_key_t &key);
168 };
169 
170 
171 #endif /* HB_OT_SHAPE_HH */
172