xref: /aosp_15_r20/external/harfbuzz_ng/src/hb-ot-post-table.hh (revision 2d1272b857b1f7575e6e246373e1cb218663db8a)
1 /*
2  * Copyright © 2016  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_POST_TABLE_HH
28 #define HB_OT_POST_TABLE_HH
29 
30 #include "hb-open-type.hh"
31 #include "hb-ot-var-mvar-table.hh"
32 
33 #define HB_STRING_ARRAY_NAME format1_names
34 #define HB_STRING_ARRAY_LIST "hb-ot-post-macroman.hh"
35 #include "hb-string-array.hh"
36 #undef HB_STRING_ARRAY_LIST
37 #undef HB_STRING_ARRAY_NAME
38 
39 /*
40  * post -- PostScript
41  * https://docs.microsoft.com/en-us/typography/opentype/spec/post
42  */
43 #define HB_OT_TAG_post HB_TAG('p','o','s','t')
44 
45 
46 namespace OT {
47 
48 
49 struct postV2Tail
50 {
51   friend struct post;
52 
sanitizeOT::postV2Tail53   bool sanitize (hb_sanitize_context_t *c) const
54   {
55     TRACE_SANITIZE (this);
56     return_trace (glyphNameIndex.sanitize (c));
57   }
58 
59   template<typename Iterator>
60   bool serialize (hb_serialize_context_t *c,
61                   Iterator it,
62                   const void* _post) const;
63 
64   bool subset (hb_subset_context_t *c) const;
65 
66   protected:
67   Array16Of<HBUINT16>	glyphNameIndex;	/* This is not an offset, but is the
68 					 * ordinal number of the glyph in 'post'
69 					 * string tables. */
70 /*UnsizedArrayOf<HBUINT8>
71 			namesX;*/	/* Glyph names with length bytes [variable]
72 					 * (a Pascal string). */
73 
74   public:
75   DEFINE_SIZE_ARRAY (2, glyphNameIndex);
76 };
77 
78 struct post
79 {
80   static constexpr hb_tag_t tableTag = HB_OT_TAG_post;
81 
serializeOT::post82   bool serialize (hb_serialize_context_t *c, bool glyph_names) const
83   {
84     TRACE_SERIALIZE (this);
85     post *post_prime = c->allocate_min<post> ();
86     if (unlikely (!post_prime))  return_trace (false);
87 
88     hb_memcpy (post_prime, this, post::min_size);
89     if (!glyph_names)
90       return_trace (c->check_assign (post_prime->version.major, 3,
91                                      HB_SERIALIZE_ERROR_INT_OVERFLOW)); // Version 3 does not have any glyph names.
92 
93     return_trace (true);
94   }
95 
subsetOT::post96   bool subset (hb_subset_context_t *c) const
97   {
98     TRACE_SUBSET (this);
99     auto *post_prime = c->serializer->start_embed<post> ();
100 
101     bool glyph_names = c->plan->flags & HB_SUBSET_FLAGS_GLYPH_NAMES;
102     if (!serialize (c->serializer, glyph_names))
103       return_trace (false);
104 
105 #ifndef HB_NO_VAR
106     if (c->plan->normalized_coords)
107     {
108       auto &MVAR = *c->plan->source->table.MVAR;
109       auto *table = post_prime;
110 
111       HB_ADD_MVAR_VAR (HB_OT_METRICS_TAG_UNDERLINE_SIZE,   underlineThickness);
112       HB_ADD_MVAR_VAR (HB_OT_METRICS_TAG_UNDERLINE_OFFSET, underlinePosition);
113     }
114 #endif
115 
116     Triple *axis_range;
117     if (c->plan->user_axes_location.has (HB_TAG ('s','l','n','t'), &axis_range))
118     {
119       float italic_angle = hb_max (-90.0, hb_min (axis_range->middle, 90.0));
120       if (post_prime->italicAngle.to_float () != italic_angle)
121         post_prime->italicAngle.set_float (italic_angle);
122     }
123 
124     if (glyph_names && version.major == 2)
125     {
126       hb_barrier ();
127       return_trace (v2X.subset (c));
128     }
129 
130     return_trace (true);
131   }
132 
133   struct accelerator_t
134   {
135     friend struct postV2Tail;
136 
accelerator_tOT::post::accelerator_t137     accelerator_t (hb_face_t *face)
138     {
139       table = hb_sanitize_context_t ().reference_table<post> (face);
140       unsigned int table_length = table.get_length ();
141 
142       version = table->version.to_int ();
143       if (version != 0x00020000) return;
144       hb_barrier ();
145 
146       const postV2Tail &v2 = table->v2X;
147 
148       glyphNameIndex = &v2.glyphNameIndex;
149       pool = &StructAfter<uint8_t> (v2.glyphNameIndex);
150 
151       const uint8_t *end = (const uint8_t *) (const void *) table + table_length;
152       index_to_offset.alloc (hb_min (face->get_num_glyphs (), table_length / 8));
153       for (const uint8_t *data = pool;
154 	   index_to_offset.length < 65535 && data < end && data + *data < end;
155 	   data += 1 + *data)
156 	index_to_offset.push (data - pool);
157     }
~accelerator_tOT::post::accelerator_t158     ~accelerator_t ()
159     {
160       hb_free (gids_sorted_by_name.get_acquire ());
161       table.destroy ();
162     }
163 
get_glyph_nameOT::post::accelerator_t164     bool get_glyph_name (hb_codepoint_t glyph,
165 			 char *buf, unsigned int buf_len) const
166     {
167       hb_bytes_t s = find_glyph_name (glyph);
168       if (!s.length) return false;
169       if (!buf_len) return true;
170       unsigned int len = hb_min (buf_len - 1, s.length);
171       strncpy (buf, s.arrayZ, len);
172       buf[len] = '\0';
173       return true;
174     }
175 
get_glyph_from_nameOT::post::accelerator_t176     bool get_glyph_from_name (const char *name, int len,
177 			      hb_codepoint_t *glyph) const
178     {
179       unsigned int count = get_glyph_count ();
180       if (unlikely (!count)) return false;
181 
182       if (len < 0) len = strlen (name);
183 
184       if (unlikely (!len)) return false;
185 
186     retry:
187       uint16_t *gids = gids_sorted_by_name.get_acquire ();
188 
189       if (unlikely (!gids))
190       {
191 	gids = (uint16_t *) hb_malloc (count * sizeof (gids[0]));
192 	if (unlikely (!gids))
193 	  return false; /* Anything better?! */
194 
195 	for (unsigned int i = 0; i < count; i++)
196 	  gids[i] = i;
197 	hb_qsort (gids, count, sizeof (gids[0]), cmp_gids, (void *) this);
198 
199 	if (unlikely (!gids_sorted_by_name.cmpexch (nullptr, gids)))
200 	{
201 	  hb_free (gids);
202 	  goto retry;
203 	}
204       }
205 
206       hb_bytes_t st (name, len);
207       auto* gid = hb_bsearch (st, gids, count, sizeof (gids[0]), cmp_key, (void *) this);
208       if (gid)
209       {
210 	*glyph = *gid;
211 	return true;
212       }
213 
214       return false;
215     }
216 
217     hb_blob_ptr_t<post> table;
218 
219     protected:
220 
get_glyph_countOT::post::accelerator_t221     unsigned int get_glyph_count () const
222     {
223       if (version == 0x00010000)
224       {
225         hb_barrier ();
226 	return format1_names_length;
227       }
228 
229       if (version == 0x00020000)
230       {
231         hb_barrier ();
232 	return glyphNameIndex->len;
233       }
234 
235       return 0;
236     }
237 
cmp_gidsOT::post::accelerator_t238     static int cmp_gids (const void *pa, const void *pb, void *arg)
239     {
240       const accelerator_t *thiz = (const accelerator_t *) arg;
241       uint16_t a = * (const uint16_t *) pa;
242       uint16_t b = * (const uint16_t *) pb;
243       return thiz->find_glyph_name (b).cmp (thiz->find_glyph_name (a));
244     }
245 
cmp_keyOT::post::accelerator_t246     static int cmp_key (const void *pk, const void *po, void *arg)
247     {
248       const accelerator_t *thiz = (const accelerator_t *) arg;
249       const hb_bytes_t *key = (const hb_bytes_t *) pk;
250       uint16_t o = * (const uint16_t *) po;
251       return thiz->find_glyph_name (o).cmp (*key);
252     }
253 
find_glyph_nameOT::post::accelerator_t254     hb_bytes_t find_glyph_name (hb_codepoint_t glyph) const
255     {
256       if (version == 0x00010000)
257       {
258         hb_barrier ();
259 	if (glyph >= format1_names_length)
260 	  return hb_bytes_t ();
261 
262 	return format1_names (glyph);
263       }
264 
265       if (version != 0x00020000)
266 	return hb_bytes_t ();
267       hb_barrier ();
268 
269       if (glyph >= glyphNameIndex->len)
270 	return hb_bytes_t ();
271 
272       unsigned int index = glyphNameIndex->arrayZ[glyph];
273       if (index < format1_names_length)
274 	return format1_names (index);
275       index -= format1_names_length;
276 
277       if (index >= index_to_offset.length)
278 	return hb_bytes_t ();
279       unsigned int offset = index_to_offset[index];
280 
281       const uint8_t *data = pool + offset;
282       unsigned int name_length = *data;
283       data++;
284 
285       return hb_bytes_t ((const char *) data, name_length);
286     }
287 
288     private:
289     uint32_t version;
290     const Array16Of<HBUINT16> *glyphNameIndex = nullptr;
291     hb_vector_t<uint32_t> index_to_offset;
292     const uint8_t *pool = nullptr;
293     hb_atomic_ptr_t<uint16_t *> gids_sorted_by_name;
294   };
295 
has_dataOT::post296   bool has_data () const { return version.to_int (); }
297 
sanitizeOT::post298   bool sanitize (hb_sanitize_context_t *c) const
299   {
300     TRACE_SANITIZE (this);
301     return_trace (c->check_struct (this) &&
302 		  hb_barrier () &&
303 		  (version.to_int () == 0x00010000 ||
304 		   (version.to_int () == 0x00020000 && hb_barrier () && v2X.sanitize (c)) ||
305 		   version.to_int () == 0x00030000));
306   }
307 
308   public:
309   FixedVersion<>version;		/* 0x00010000 for version 1.0
310 					 * 0x00020000 for version 2.0
311 					 * 0x00025000 for version 2.5 (deprecated)
312 					 * 0x00030000 for version 3.0 */
313   F16DOT16	italicAngle;		/* Italic angle in counter-clockwise degrees
314 					 * from the vertical. Zero for upright text,
315 					 * negative for text that leans to the right
316 					 * (forward). */
317   FWORD		underlinePosition;	/* This is the suggested distance of the top
318 					 * of the underline from the baseline
319 					 * (negative values indicate below baseline).
320 					 * The PostScript definition of this FontInfo
321 					 * dictionary key (the y coordinate of the
322 					 * center of the stroke) is not used for
323 					 * historical reasons. The value of the
324 					 * PostScript key may be calculated by
325 					 * subtracting half the underlineThickness
326 					 * from the value of this field. */
327   FWORD		underlineThickness;	/* Suggested values for the underline
328 					   thickness. */
329   HBUINT32	isFixedPitch;		/* Set to 0 if the font is proportionally
330 					 * spaced, non-zero if the font is not
331 					 * proportionally spaced (i.e. monospaced). */
332   HBUINT32	minMemType42;		/* Minimum memory usage when an OpenType font
333 					 * is downloaded. */
334   HBUINT32	maxMemType42;		/* Maximum memory usage when an OpenType font
335 					 * is downloaded. */
336   HBUINT32	minMemType1;		/* Minimum memory usage when an OpenType font
337 					 * is downloaded as a Type 1 font. */
338   HBUINT32	maxMemType1;		/* Maximum memory usage when an OpenType font
339 					 * is downloaded as a Type 1 font. */
340   postV2Tail	v2X;
341   DEFINE_SIZE_MIN (32);
342 };
343 
344 struct post_accelerator_t : post::accelerator_t {
post_accelerator_tOT::post_accelerator_t345   post_accelerator_t (hb_face_t *face) : post::accelerator_t (face) {}
346 };
347 
348 
349 } /* namespace OT */
350 
351 
352 #endif /* HB_OT_POST_TABLE_HH */
353