1 /* 2 * Copyright © 2018 Adobe 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 * Adobe Author(s): Michiharu Ariza 25 */ 26 27 #ifndef HB_OT_CFF2_TABLE_HH 28 #define HB_OT_CFF2_TABLE_HH 29 30 #include "hb-ot-cff-common.hh" 31 #include "hb-subset-cff2.hh" 32 #include "hb-draw.hh" 33 34 namespace CFF { 35 36 /* 37 * CFF2 -- Compact Font Format (CFF) Version 2 38 * https://docs.microsoft.com/en-us/typography/opentype/spec/cff2 39 */ 40 #define HB_OT_TAG_cff2 HB_TAG('C','F','F','2') 41 42 typedef CFFIndex<HBUINT32> CFF2Index; 43 template <typename Type> struct CFF2IndexOf : CFFIndexOf<HBUINT32, Type> {}; 44 45 typedef CFF2Index CFF2CharStrings; 46 typedef Subrs<HBUINT32> CFF2Subrs; 47 48 typedef FDSelect3_4<HBUINT32, HBUINT16> FDSelect4; 49 typedef FDSelect3_4_Range<HBUINT32, HBUINT16> FDSelect4_Range; 50 51 struct CFF2FDSelect 52 { serializeCFF::CFF2FDSelect53 bool serialize (hb_serialize_context_t *c, const CFF2FDSelect &src, unsigned int num_glyphs) 54 { 55 TRACE_SERIALIZE (this); 56 unsigned int size = src.get_size (num_glyphs); 57 CFF2FDSelect *dest = c->allocate_size<CFF2FDSelect> (size); 58 if (unlikely (!dest)) return_trace (false); 59 hb_memcpy (dest, &src, size); 60 return_trace (true); 61 } 62 get_sizeCFF::CFF2FDSelect63 unsigned int get_size (unsigned int num_glyphs) const 64 { 65 switch (format) 66 { 67 case 0: return format.static_size + u.format0.get_size (num_glyphs); 68 case 3: return format.static_size + u.format3.get_size (); 69 case 4: return format.static_size + u.format4.get_size (); 70 default:return 0; 71 } 72 } 73 get_fdCFF::CFF2FDSelect74 hb_codepoint_t get_fd (hb_codepoint_t glyph) const 75 { 76 if (this == &Null (CFF2FDSelect)) 77 return 0; 78 79 switch (format) 80 { 81 case 0: return u.format0.get_fd (glyph); 82 case 3: return u.format3.get_fd (glyph); 83 case 4: return u.format4.get_fd (glyph); 84 default:return 0; 85 } 86 } 87 sanitizeCFF::CFF2FDSelect88 bool sanitize (hb_sanitize_context_t *c, unsigned int fdcount) const 89 { 90 TRACE_SANITIZE (this); 91 if (unlikely (!c->check_struct (this))) 92 return_trace (false); 93 94 switch (format) 95 { 96 case 0: return_trace (u.format0.sanitize (c, fdcount)); 97 case 3: return_trace (u.format3.sanitize (c, fdcount)); 98 case 4: return_trace (u.format4.sanitize (c, fdcount)); 99 default:return_trace (false); 100 } 101 } 102 103 HBUINT8 format; 104 union { 105 FDSelect0 format0; 106 FDSelect3 format3; 107 FDSelect4 format4; 108 } u; 109 public: 110 DEFINE_SIZE_MIN (2); 111 }; 112 113 struct CFF2VariationStore 114 { sanitizeCFF::CFF2VariationStore115 bool sanitize (hb_sanitize_context_t *c) const 116 { 117 TRACE_SANITIZE (this); 118 return_trace (likely (c->check_struct (this)) && c->check_range (&varStore, size) && varStore.sanitize (c)); 119 } 120 serializeCFF::CFF2VariationStore121 bool serialize (hb_serialize_context_t *c, const CFF2VariationStore *varStore) 122 { 123 TRACE_SERIALIZE (this); 124 unsigned int size_ = varStore->get_size (); 125 CFF2VariationStore *dest = c->allocate_size<CFF2VariationStore> (size_); 126 if (unlikely (!dest)) return_trace (false); 127 hb_memcpy (dest, varStore, size_); 128 return_trace (true); 129 } 130 get_sizeCFF::CFF2VariationStore131 unsigned int get_size () const { return HBUINT16::static_size + size; } 132 133 HBUINT16 size; 134 VariationStore varStore; 135 136 DEFINE_SIZE_MIN (2 + VariationStore::min_size); 137 }; 138 139 struct cff2_top_dict_values_t : top_dict_values_t<> 140 { initCFF::cff2_top_dict_values_t141 void init () 142 { 143 top_dict_values_t<>::init (); 144 vstoreOffset = 0; 145 FDSelectOffset = 0; 146 } finiCFF::cff2_top_dict_values_t147 void fini () { top_dict_values_t<>::fini (); } 148 149 unsigned int vstoreOffset; 150 unsigned int FDSelectOffset; 151 }; 152 153 struct cff2_top_dict_opset_t : top_dict_opset_t<> 154 { process_opCFF::cff2_top_dict_opset_t155 static void process_op (op_code_t op, num_interp_env_t& env, cff2_top_dict_values_t& dictval) 156 { 157 switch (op) { 158 case OpCode_FontMatrix: 159 { 160 dict_val_t val; 161 val.init (); 162 dictval.add_op (op, env.str_ref); 163 env.clear_args (); 164 } 165 break; 166 167 case OpCode_vstore: 168 dictval.vstoreOffset = env.argStack.pop_uint (); 169 env.clear_args (); 170 break; 171 case OpCode_FDSelect: 172 dictval.FDSelectOffset = env.argStack.pop_uint (); 173 env.clear_args (); 174 break; 175 176 default: 177 SUPER::process_op (op, env, dictval); 178 /* Record this operand below if stack is empty, otherwise done */ 179 if (!env.argStack.is_empty ()) return; 180 } 181 182 if (unlikely (env.in_error ())) return; 183 184 dictval.add_op (op, env.str_ref); 185 } 186 187 typedef top_dict_opset_t<> SUPER; 188 }; 189 190 struct cff2_font_dict_values_t : dict_values_t<op_str_t> 191 { initCFF::cff2_font_dict_values_t192 void init () 193 { 194 dict_values_t<op_str_t>::init (); 195 privateDictInfo.init (); 196 } finiCFF::cff2_font_dict_values_t197 void fini () { dict_values_t<op_str_t>::fini (); } 198 199 table_info_t privateDictInfo; 200 }; 201 202 struct cff2_font_dict_opset_t : dict_opset_t 203 { process_opCFF::cff2_font_dict_opset_t204 static void process_op (op_code_t op, num_interp_env_t& env, cff2_font_dict_values_t& dictval) 205 { 206 switch (op) { 207 case OpCode_Private: 208 dictval.privateDictInfo.offset = env.argStack.pop_uint (); 209 dictval.privateDictInfo.size = env.argStack.pop_uint (); 210 env.clear_args (); 211 break; 212 213 default: 214 SUPER::process_op (op, env); 215 if (!env.argStack.is_empty ()) 216 return; 217 } 218 219 if (unlikely (env.in_error ())) return; 220 221 dictval.add_op (op, env.str_ref); 222 } 223 224 private: 225 typedef dict_opset_t SUPER; 226 }; 227 228 template <typename VAL> 229 struct cff2_private_dict_values_base_t : dict_values_t<VAL> 230 { initCFF::cff2_private_dict_values_base_t231 void init () 232 { 233 dict_values_t<VAL>::init (); 234 subrsOffset = 0; 235 localSubrs = &Null (CFF2Subrs); 236 ivs = 0; 237 } finiCFF::cff2_private_dict_values_base_t238 void fini () { dict_values_t<VAL>::fini (); } 239 240 unsigned int subrsOffset; 241 const CFF2Subrs *localSubrs; 242 unsigned int ivs; 243 }; 244 245 typedef cff2_private_dict_values_base_t<op_str_t> cff2_private_dict_values_subset_t; 246 typedef cff2_private_dict_values_base_t<num_dict_val_t> cff2_private_dict_values_t; 247 248 struct cff2_priv_dict_interp_env_t : num_interp_env_t 249 { cff2_priv_dict_interp_env_tCFF::cff2_priv_dict_interp_env_t250 cff2_priv_dict_interp_env_t (const hb_ubytes_t &str) : 251 num_interp_env_t (str) {} 252 process_vsindexCFF::cff2_priv_dict_interp_env_t253 void process_vsindex () 254 { 255 if (likely (!seen_vsindex)) 256 { 257 set_ivs (argStack.pop_uint ()); 258 } 259 seen_vsindex = true; 260 } 261 get_ivsCFF::cff2_priv_dict_interp_env_t262 unsigned int get_ivs () const { return ivs; } set_ivsCFF::cff2_priv_dict_interp_env_t263 void set_ivs (unsigned int ivs_) { ivs = ivs_; } 264 265 protected: 266 unsigned int ivs = 0; 267 bool seen_vsindex = false; 268 }; 269 270 struct cff2_private_dict_opset_t : dict_opset_t 271 { process_opCFF::cff2_private_dict_opset_t272 static void process_op (op_code_t op, cff2_priv_dict_interp_env_t& env, cff2_private_dict_values_t& dictval) 273 { 274 num_dict_val_t val; 275 val.init (); 276 277 switch (op) { 278 case OpCode_StdHW: 279 case OpCode_StdVW: 280 case OpCode_BlueScale: 281 case OpCode_BlueShift: 282 case OpCode_BlueFuzz: 283 case OpCode_ExpansionFactor: 284 case OpCode_LanguageGroup: 285 val.single_val = env.argStack.pop_num (); 286 env.clear_args (); 287 break; 288 case OpCode_BlueValues: 289 case OpCode_OtherBlues: 290 case OpCode_FamilyBlues: 291 case OpCode_FamilyOtherBlues: 292 case OpCode_StemSnapH: 293 case OpCode_StemSnapV: 294 env.clear_args (); 295 break; 296 case OpCode_Subrs: 297 dictval.subrsOffset = env.argStack.pop_uint (); 298 env.clear_args (); 299 break; 300 case OpCode_vsindexdict: 301 env.process_vsindex (); 302 dictval.ivs = env.get_ivs (); 303 env.clear_args (); 304 break; 305 case OpCode_blenddict: 306 break; 307 308 default: 309 dict_opset_t::process_op (op, env); 310 if (!env.argStack.is_empty ()) return; 311 break; 312 } 313 314 if (unlikely (env.in_error ())) return; 315 316 dictval.add_op (op, env.str_ref, val); 317 } 318 }; 319 320 struct cff2_private_dict_opset_subset_t : dict_opset_t 321 { process_opCFF::cff2_private_dict_opset_subset_t322 static void process_op (op_code_t op, cff2_priv_dict_interp_env_t& env, cff2_private_dict_values_subset_t& dictval) 323 { 324 switch (op) { 325 case OpCode_BlueValues: 326 case OpCode_OtherBlues: 327 case OpCode_FamilyBlues: 328 case OpCode_FamilyOtherBlues: 329 case OpCode_StdHW: 330 case OpCode_StdVW: 331 case OpCode_BlueScale: 332 case OpCode_BlueShift: 333 case OpCode_BlueFuzz: 334 case OpCode_StemSnapH: 335 case OpCode_StemSnapV: 336 case OpCode_LanguageGroup: 337 case OpCode_ExpansionFactor: 338 env.clear_args (); 339 break; 340 341 case OpCode_blenddict: 342 env.clear_args (); 343 return; 344 345 case OpCode_Subrs: 346 dictval.subrsOffset = env.argStack.pop_uint (); 347 env.clear_args (); 348 break; 349 350 default: 351 SUPER::process_op (op, env); 352 if (!env.argStack.is_empty ()) return; 353 break; 354 } 355 356 if (unlikely (env.in_error ())) return; 357 358 dictval.add_op (op, env.str_ref); 359 } 360 361 private: 362 typedef dict_opset_t SUPER; 363 }; 364 365 typedef dict_interpreter_t<cff2_top_dict_opset_t, cff2_top_dict_values_t> cff2_top_dict_interpreter_t; 366 typedef dict_interpreter_t<cff2_font_dict_opset_t, cff2_font_dict_values_t> cff2_font_dict_interpreter_t; 367 368 struct CFF2FDArray : FDArray<HBUINT32> 369 { 370 /* FDArray::serialize does not compile without this partial specialization */ 371 template <typename ITER, typename OP_SERIALIZER> serializeCFF::CFF2FDArray372 bool serialize (hb_serialize_context_t *c, ITER it, OP_SERIALIZER& opszr) 373 { return FDArray<HBUINT32>::serialize<cff2_font_dict_values_t, table_info_t> (c, it, opszr); } 374 }; 375 376 } /* namespace CFF */ 377 378 namespace OT { 379 380 using namespace CFF; 381 382 struct cff2 383 { 384 static constexpr hb_tag_t tableTag = HB_OT_TAG_cff2; 385 sanitizeOT::cff2386 bool sanitize (hb_sanitize_context_t *c) const 387 { 388 TRACE_SANITIZE (this); 389 return_trace (c->check_struct (this) && 390 likely (version.major == 2)); 391 } 392 393 template <typename PRIVOPSET, typename PRIVDICTVAL> 394 struct accelerator_templ_t 395 { accelerator_templ_tOT::cff2::accelerator_templ_t396 accelerator_templ_t (hb_face_t *face) 397 { 398 topDict.init (); 399 fontDicts.init (); 400 privateDicts.init (); 401 402 this->blob = sc.reference_table<cff2> (face); 403 404 /* setup for run-time santization */ 405 sc.init (this->blob); 406 sc.start_processing (); 407 408 const OT::cff2 *cff2 = this->blob->template as<OT::cff2> (); 409 410 if (cff2 == &Null (OT::cff2)) 411 goto fail; 412 413 { /* parse top dict */ 414 hb_ubytes_t topDictStr = (cff2 + cff2->topDict).as_ubytes (cff2->topDictSize); 415 if (unlikely (!topDictStr.sanitize (&sc))) goto fail; 416 num_interp_env_t env (topDictStr); 417 cff2_top_dict_interpreter_t top_interp (env); 418 topDict.init (); 419 if (unlikely (!top_interp.interpret (topDict))) goto fail; 420 } 421 422 globalSubrs = &StructAtOffset<CFF2Subrs> (cff2, cff2->topDict + cff2->topDictSize); 423 varStore = &StructAtOffsetOrNull<CFF2VariationStore> (cff2, topDict.vstoreOffset); 424 charStrings = &StructAtOffsetOrNull<CFF2CharStrings> (cff2, topDict.charStringsOffset); 425 fdArray = &StructAtOffsetOrNull<CFF2FDArray> (cff2, topDict.FDArrayOffset); 426 fdSelect = &StructAtOffsetOrNull<CFF2FDSelect> (cff2, topDict.FDSelectOffset); 427 428 if (((varStore != &Null (CFF2VariationStore)) && unlikely (!varStore->sanitize (&sc))) || 429 (charStrings == &Null (CFF2CharStrings)) || unlikely (!charStrings->sanitize (&sc)) || 430 (globalSubrs == &Null (CFF2Subrs)) || unlikely (!globalSubrs->sanitize (&sc)) || 431 (fdArray == &Null (CFF2FDArray)) || unlikely (!fdArray->sanitize (&sc)) || 432 (((fdSelect != &Null (CFF2FDSelect)) && unlikely (!fdSelect->sanitize (&sc, fdArray->count))))) 433 goto fail; 434 435 num_glyphs = charStrings->count; 436 if (num_glyphs != sc.get_num_glyphs ()) 437 goto fail; 438 439 fdCount = fdArray->count; 440 if (!privateDicts.resize (fdCount)) 441 goto fail; 442 443 /* parse font dicts and gather private dicts */ 444 for (unsigned int i = 0; i < fdCount; i++) 445 { 446 const hb_ubytes_t fontDictStr = (*fdArray)[i]; 447 if (unlikely (!fontDictStr.sanitize (&sc))) goto fail; 448 cff2_font_dict_values_t *font; 449 num_interp_env_t env (fontDictStr); 450 cff2_font_dict_interpreter_t font_interp (env); 451 font = fontDicts.push (); 452 if (unlikely (font == &Crap (cff2_font_dict_values_t))) goto fail; 453 font->init (); 454 if (unlikely (!font_interp.interpret (*font))) goto fail; 455 456 const hb_ubytes_t privDictStr = StructAtOffsetOrNull<UnsizedByteStr> (cff2, font->privateDictInfo.offset).as_ubytes (font->privateDictInfo.size); 457 if (unlikely (!privDictStr.sanitize (&sc))) goto fail; 458 cff2_priv_dict_interp_env_t env2 (privDictStr); 459 dict_interpreter_t<PRIVOPSET, PRIVDICTVAL, cff2_priv_dict_interp_env_t> priv_interp (env2); 460 privateDicts[i].init (); 461 if (unlikely (!priv_interp.interpret (privateDicts[i]))) goto fail; 462 463 privateDicts[i].localSubrs = &StructAtOffsetOrNull<CFF2Subrs> (&privDictStr[0], privateDicts[i].subrsOffset); 464 if (privateDicts[i].localSubrs != &Null (CFF2Subrs) && 465 unlikely (!privateDicts[i].localSubrs->sanitize (&sc))) 466 goto fail; 467 } 468 469 470 return; 471 472 fail: 473 _fini (); 474 } ~accelerator_templ_tOT::cff2::accelerator_templ_t475 ~accelerator_templ_t () { _fini (); } _finiOT::cff2::accelerator_templ_t476 void _fini () 477 { 478 sc.end_processing (); 479 topDict.fini (); 480 fontDicts.fini (); 481 privateDicts.fini (); 482 hb_blob_destroy (blob); 483 blob = nullptr; 484 } 485 create_glyph_to_sid_mapOT::cff2::accelerator_templ_t486 hb_map_t *create_glyph_to_sid_map () const 487 { 488 return nullptr; 489 } 490 is_validOT::cff2::accelerator_templ_t491 bool is_valid () const { return blob; } 492 493 protected: 494 hb_sanitize_context_t sc; 495 496 public: 497 hb_blob_t *blob = nullptr; 498 cff2_top_dict_values_t topDict; 499 const CFF2Subrs *globalSubrs = nullptr; 500 const CFF2VariationStore *varStore = nullptr; 501 const CFF2CharStrings *charStrings = nullptr; 502 const CFF2FDArray *fdArray = nullptr; 503 const CFF2FDSelect *fdSelect = nullptr; 504 unsigned int fdCount = 0; 505 506 hb_vector_t<cff2_font_dict_values_t> fontDicts; 507 hb_vector_t<PRIVDICTVAL> privateDicts; 508 509 unsigned int num_glyphs = 0; 510 }; 511 512 struct accelerator_t : accelerator_templ_t<cff2_private_dict_opset_t, cff2_private_dict_values_t> 513 { accelerator_tOT::cff2::accelerator_t514 accelerator_t (hb_face_t *face) : accelerator_templ_t (face) {} 515 516 HB_INTERNAL bool get_extents (hb_font_t *font, 517 hb_codepoint_t glyph, 518 hb_glyph_extents_t *extents) const; 519 HB_INTERNAL bool get_path (hb_font_t *font, hb_codepoint_t glyph, hb_draw_session_t &draw_session) const; 520 }; 521 522 typedef accelerator_templ_t<cff2_private_dict_opset_subset_t, cff2_private_dict_values_subset_t> accelerator_subset_t; 523 subsetOT::cff2524 bool subset (hb_subset_context_t *c) const { return hb_subset_cff2 (c); } 525 526 public: 527 FixedVersion<HBUINT8> version; /* Version of CFF2 table. set to 0x0200u */ 528 NNOffsetTo<TopDict, HBUINT8> topDict; /* headerSize = Offset to Top DICT. */ 529 HBUINT16 topDictSize; /* Top DICT size */ 530 531 public: 532 DEFINE_SIZE_STATIC (5); 533 }; 534 535 struct cff2_accelerator_t : cff2::accelerator_t { cff2_accelerator_tOT::cff2_accelerator_t536 cff2_accelerator_t (hb_face_t *face) : cff2::accelerator_t (face) {} 537 }; 538 539 } /* namespace OT */ 540 541 #endif /* HB_OT_CFF2_TABLE_HH */ 542