src/hb-cff-interp-common.hh

   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 #ifndef HB_CFF_INTERP_COMMON_HH
  27 #define HB_CFF_INTERP_COMMON_HH
  28
  29 namespace CFF {
  30
  31 using namespace OT;
  32
  33 typedef unsigned int op_code_t;
  34
  35
  36 /* === Dict operators === */
  37
  38 /* One byte operators (0-31) */
  39 #define OpCode_version            0 /* CFF Top */
  40 #define OpCode_Notice             1 /* CFF Top */
  41 #define OpCode_FullName           2 /* CFF Top */
  42 #define OpCode_FamilyName         3 /* CFF Top */
  43 #define OpCode_Weight             4 /* CFF Top */
  44 #define OpCode_FontBBox           5 /* CFF Top */
  45 #define OpCode_BlueValues         6 /* CFF Private, CFF2 Private */
  46 #define OpCode_OtherBlues         7 /* CFF Private, CFF2 Private */
  47 #define OpCode_FamilyBlues        8 /* CFF Private, CFF2 Private */
  48 #define OpCode_FamilyOtherBlues   9 /* CFF Private, CFF2 Private */
  49 #define OpCode_StdHW             10 /* CFF Private, CFF2 Private */
  50 #define OpCode_StdVW             11 /* CFF Private, CFF2 Private */
  51 #define OpCode_escape            12 /* All. Shared with CS */
  52 #define OpCode_UniqueID          13 /* CFF Top */
  53 #define OpCode_XUID              14 /* CFF Top */
  54 #define OpCode_charset           15 /* CFF Top (0) */
  55 #define OpCode_Encoding          16 /* CFF Top (0) */
  56 #define OpCode_CharStrings       17 /* CFF Top, CFF2 Top */
  57 #define OpCode_Private           18 /* CFF Top, CFF2 FD */
  58 #define OpCode_Subrs             19 /* CFF Private, CFF2 Private */
  59 #define OpCode_defaultWidthX     20 /* CFF Private (0) */
  60 #define OpCode_nominalWidthX     21 /* CFF Private (0) */
  61 #define OpCode_vsindexdict       22 /* CFF2 Private/CS */
  62 #define OpCode_blenddict         23 /* CFF2 Private/CS */
  63 #define OpCode_vstore            24 /* CFF2 Top */
  64 #define OpCode_reserved25        25
  65 #define OpCode_reserved26        26
  66 #define OpCode_reserved27        27
  67
  68 /* Numbers */
  69 #define OpCode_shortint          28 /* 16-bit integer, All */
  70 #define OpCode_longintdict       29 /* 32-bit integer, All */
  71 #define OpCode_BCD               30 /* Real number, CFF2 Top/FD */
  72 #define OpCode_reserved31        31
  73
  74 /* 1-byte integers */
  75 #define OpCode_OneByteIntFirst   32 /* All. beginning of the range of first byte ints */
  76 #define OpCode_OneByteIntLast   246 /* All. ending of the range of first byte int */
  77
  78 /* 2-byte integers */
  79 #define OpCode_TwoBytePosInt0   247 /* All. first byte of two byte positive int (+108 to +1131) */
  80 #define OpCode_TwoBytePosInt1   248
  81 #define OpCode_TwoBytePosInt2   249
  82 #define OpCode_TwoBytePosInt3   250
  83
  84 #define OpCode_TwoByteNegInt0   251 /* All. first byte of two byte negative int (-1131 to -108) */
  85 #define OpCode_TwoByteNegInt1   252
  86 #define OpCode_TwoByteNegInt2   253
  87 #define OpCode_TwoByteNegInt3   254
  88
  89 /* Two byte escape operators 12, (0-41) */
  90 #define OpCode_ESC_Base         256
  91 #define Make_OpCode_ESC(byte2)  ((op_code_t)(OpCode_ESC_Base + (byte2)))
  92
  93 inline op_code_t Unmake_OpCode_ESC (op_code_t op)  { return (op_code_t)(op - OpCode_ESC_Base); }
  94 inline bool Is_OpCode_ESC (op_code_t op) { return op >= OpCode_ESC_Base; }
  95 inline unsigned int OpCode_Size (op_code_t op) { return Is_OpCode_ESC (op) ? 2: 1; }
  96
  97 #define OpCode_Copyright        Make_OpCode_ESC(0) /* CFF Top */
  98 #define OpCode_isFixedPitch     Make_OpCode_ESC(1) /* CFF Top (false) */
  99 #define OpCode_ItalicAngle      Make_OpCode_ESC(2) /* CFF Top (0) */
 100 #define OpCode_UnderlinePosition Make_OpCode_ESC(3) /* CFF Top (-100) */
 101 #define OpCode_UnderlineThickness Make_OpCode_ESC(4) /* CFF Top (50) */
 102 #define OpCode_PaintType        Make_OpCode_ESC(5) /* CFF Top (0) */
 103 #define OpCode_CharstringType   Make_OpCode_ESC(6) /* CFF Top (2) */
 104 #define OpCode_FontMatrix       Make_OpCode_ESC(7) /* CFF Top, CFF2 Top (.001 0 0 .001 0 0)*/
 105 #define OpCode_StrokeWidth      Make_OpCode_ESC(8) /* CFF Top (0) */
 106 #define OpCode_BlueScale        Make_OpCode_ESC(9) /* CFF Private, CFF2 Private (0.039625) */
 107 #define OpCode_BlueShift        Make_OpCode_ESC(10) /* CFF Private, CFF2 Private (7) */
 108 #define OpCode_BlueFuzz         Make_OpCode_ESC(11) /* CFF Private, CFF2 Private (1) */
 109 #define OpCode_StemSnapH        Make_OpCode_ESC(12) /* CFF Private, CFF2 Private */
 110 #define OpCode_StemSnapV        Make_OpCode_ESC(13) /* CFF Private, CFF2 Private */
 111 #define OpCode_ForceBold        Make_OpCode_ESC(14) /* CFF Private (false) */
 112 #define OpCode_reservedESC15    Make_OpCode_ESC(15)
 113 #define OpCode_reservedESC16    Make_OpCode_ESC(16)
 114 #define OpCode_LanguageGroup    Make_OpCode_ESC(17) /* CFF Private, CFF2 Private (0) */
 115 #define OpCode_ExpansionFactor  Make_OpCode_ESC(18) /* CFF Private, CFF2 Private (0.06) */
 116 #define OpCode_initialRandomSeed Make_OpCode_ESC(19) /* CFF Private (0) */
 117 #define OpCode_SyntheticBase    Make_OpCode_ESC(20) /* CFF Top */
 118 #define OpCode_PostScript       Make_OpCode_ESC(21) /* CFF Top */
 119 #define OpCode_BaseFontName     Make_OpCode_ESC(22) /* CFF Top */
 120 #define OpCode_BaseFontBlend    Make_OpCode_ESC(23) /* CFF Top */
 121 #define OpCode_reservedESC24    Make_OpCode_ESC(24)
 122 #define OpCode_reservedESC25    Make_OpCode_ESC(25)
 123 #define OpCode_reservedESC26    Make_OpCode_ESC(26)
 124 #define OpCode_reservedESC27    Make_OpCode_ESC(27)
 125 #define OpCode_reservedESC28    Make_OpCode_ESC(28)
 126 #define OpCode_reservedESC29    Make_OpCode_ESC(29)
 127 #define OpCode_ROS              Make_OpCode_ESC(30) /* CFF Top_CID */
 128 #define OpCode_CIDFontVersion   Make_OpCode_ESC(31) /* CFF Top_CID (0) */
 129 #define OpCode_CIDFontRevision  Make_OpCode_ESC(32) /* CFF Top_CID (0) */
 130 #define OpCode_CIDFontType      Make_OpCode_ESC(33) /* CFF Top_CID (0) */
 131 #define OpCode_CIDCount         Make_OpCode_ESC(34) /* CFF Top_CID (8720) */
 132 #define OpCode_UIDBase          Make_OpCode_ESC(35) /* CFF Top_CID */
 133 #define OpCode_FDArray          Make_OpCode_ESC(36) /* CFF Top_CID, CFF2 Top */
 134 #define OpCode_FDSelect         Make_OpCode_ESC(37) /* CFF Top_CID, CFF2 Top */
 135 #define OpCode_FontName         Make_OpCode_ESC(38) /* CFF Top_CID */
 136
 137
 138 /* === CharString operators === */
 139
 140 #define OpCode_hstem              1 /* CFF, CFF2 */
 141 #define OpCode_Reserved2          2
 142 #define OpCode_vstem              3 /* CFF, CFF2 */
 143 #define OpCode_vmoveto            4 /* CFF, CFF2 */
 144 #define OpCode_rlineto            5 /* CFF, CFF2 */
 145 #define OpCode_hlineto            6 /* CFF, CFF2 */
 146 #define OpCode_vlineto            7 /* CFF, CFF2 */
 147 #define OpCode_rrcurveto          8 /* CFF, CFF2 */
 148 #define OpCode_Reserved9          9
 149 #define OpCode_callsubr          10 /* CFF, CFF2 */
 150 #define OpCode_return            11 /* CFF */
 151 //#define OpCode_escape          12 /* CFF, CFF2 */
 152 #define OpCode_Reserved13        13
 153 #define OpCode_endchar           14 /* CFF */
 154 #define OpCode_vsindexcs         15 /* CFF2 */
 155 #define OpCode_blendcs           16 /* CFF2 */
 156 #define OpCode_Reserved17        17
 157 #define OpCode_hstemhm           18 /* CFF, CFF2 */
 158 #define OpCode_hintmask          19 /* CFF, CFF2 */
 159 #define OpCode_cntrmask          20 /* CFF, CFF2 */
 160 #define OpCode_rmoveto           21 /* CFF, CFF2 */
 161 #define OpCode_hmoveto           22 /* CFF, CFF2 */
 162 #define OpCode_vstemhm           23 /* CFF, CFF2 */
 163 #define OpCode_rcurveline        24 /* CFF, CFF2 */
 164 #define OpCode_rlinecurve        25 /* CFF, CFF2 */
 165 #define OpCode_vvcurveto         26 /* CFF, CFF2 */
 166 #define OpCode_hhcurveto         27 /* CFF, CFF2 */
 167 //#define OpCode_shortint        28 /* CFF, CFF2 */
 168 #define OpCode_callgsubr         29 /* CFF, CFF2 */
 169 #define OpCode_vhcurveto         30 /* CFF, CFF2 */
 170 #define OpCode_hvcurveto         31 /* CFF, CFF2 */
 171
 172 #define OpCode_fixedcs          255 /* 32-bit fixed */
 173
 174 /* Two byte escape operators 12, (0-41) */
 175 #define OpCode_dotsection       Make_OpCode_ESC(0) /* CFF (obsoleted) */
 176 #define OpCode_ReservedESC1     Make_OpCode_ESC(1)
 177 #define OpCode_ReservedESC2     Make_OpCode_ESC(2)
 178 #define OpCode_and              Make_OpCode_ESC(3) /* CFF */
 179 #define OpCode_or               Make_OpCode_ESC(4) /* CFF */
 180 #define OpCode_not              Make_OpCode_ESC(5) /* CFF */
 181 #define OpCode_ReservedESC6     Make_OpCode_ESC(6)
 182 #define OpCode_ReservedESC7     Make_OpCode_ESC(7)
 183 #define OpCode_ReservedESC8     Make_OpCode_ESC(8)
 184 #define OpCode_abs              Make_OpCode_ESC(9) /* CFF */
 185 #define OpCode_add              Make_OpCode_ESC(10) /* CFF */
 186 #define OpCode_sub              Make_OpCode_ESC(11) /* CFF */
 187 #define OpCode_div              Make_OpCode_ESC(12) /* CFF */
 188 #define OpCode_ReservedESC13    Make_OpCode_ESC(13)
 189 #define OpCode_neg              Make_OpCode_ESC(14) /* CFF */
 190 #define OpCode_eq               Make_OpCode_ESC(15) /* CFF */
 191 #define OpCode_ReservedESC16    Make_OpCode_ESC(16)
 192 #define OpCode_ReservedESC17    Make_OpCode_ESC(17)
 193 #define OpCode_drop             Make_OpCode_ESC(18) /* CFF */
 194 #define OpCode_ReservedESC19    Make_OpCode_ESC(19)
 195 #define OpCode_put              Make_OpCode_ESC(20) /* CFF */
 196 #define OpCode_get              Make_OpCode_ESC(21) /* CFF */
 197 #define OpCode_ifelse           Make_OpCode_ESC(22) /* CFF */
 198 #define OpCode_random           Make_OpCode_ESC(23) /* CFF */
 199 #define OpCode_mul              Make_OpCode_ESC(24) /* CFF */
 200 //#define OpCode_reservedESC25  Make_OpCode_ESC(25)
 201 #define OpCode_sqrt             Make_OpCode_ESC(26) /* CFF */
 202 #define OpCode_dup              Make_OpCode_ESC(27) /* CFF */
 203 #define OpCode_exch             Make_OpCode_ESC(28) /* CFF */
 204 #define OpCode_index            Make_OpCode_ESC(29) /* CFF */
 205 #define OpCode_roll             Make_OpCode_ESC(30) /* CFF */
 206 #define OpCode_reservedESC31    Make_OpCode_ESC(31)
 207 #define OpCode_reservedESC32    Make_OpCode_ESC(32)
 208 #define OpCode_reservedESC33    Make_OpCode_ESC(33)
 209 #define OpCode_hflex            Make_OpCode_ESC(34) /* CFF, CFF2 */
 210 #define OpCode_flex             Make_OpCode_ESC(35) /* CFF, CFF2 */
 211 #define OpCode_hflex1           Make_OpCode_ESC(36) /* CFF, CFF2 */
 212 #define OpCode_flex1            Make_OpCode_ESC(37) /* CFF, CFF2 */
 213
 214
 215 #define OpCode_Invalid          0xFFFFu
 216
 217
 218 struct number_t
 219 {
 220   void init () { set_real (0.0); }
 221   void fini () {}
 222
 223   void set_int (int v)       { value = v; }
 224   int to_int () const        { return value; }
 225
 226   void set_fixed (int32_t v) { value = v / 65536.0; }
 227   int32_t to_fixed () const  { return value * 65536.0; }
 228
 229   void set_real (double v)   { value = v; }
 230   double to_real () const    { return value; }
 231
 232   bool in_int_range () const
 233   { return ((double) (int16_t) to_int () == value); }
 234
 235   bool operator >  (const number_t &n) const { return value > n.to_real (); }
 236   bool operator <  (const number_t &n) const { return n > *this; }
 237   bool operator >= (const number_t &n) const { return !(*this < n); }
 238   bool operator <= (const number_t &n) const { return !(*this > n); }
 239
 240   const number_t &operator += (const number_t &n)
 241   {
 242     set_real (to_real () + n.to_real ());
 243
 244     return *this;
 245   }
 246
 247   protected:
 248   double value;
 249 };
 250
 251 /* byte string */
 252 struct UnsizedByteStr : UnsizedArrayOf <HBUINT8>
 253 {
 254   // encode 2-byte int (Dict/CharString) or 4-byte int (Dict)
 255   template <typename INTTYPE, int minVal, int maxVal>
 256   static bool serialize_int (hb_serialize_context_t *c, op_code_t intOp, int value)
 257   {
 258     TRACE_SERIALIZE (this);
 259
 260     if (unlikely ((value < minVal || value > maxVal)))
 261       return_trace (false);
 262
 263     HBUINT8 *p = c->allocate_size<HBUINT8> (1);
 264     if (unlikely (p == nullptr)) return_trace (false);
 265     *p = intOp;
 266
 267     INTTYPE *ip = c->allocate_size<INTTYPE> (INTTYPE::static_size);
 268     if (unlikely (ip == nullptr)) return_trace (false);
 269     *ip = (unsigned int) value;
 270
 271     return_trace (true);
 272   }
 273
 274   static bool serialize_int4 (hb_serialize_context_t *c, int value)
 275   { return serialize_int<HBUINT32, 0, 0x7FFFFFFF> (c, OpCode_longintdict, value); }
 276
 277   static bool serialize_int2 (hb_serialize_context_t *c, int value)
 278   { return serialize_int<HBUINT16, 0, 0x7FFF> (c, OpCode_shortint, value); }
 279
 280   /* Defining null_size allows a Null object may be created. Should be safe because:
 281    * A descendent struct Dict uses a Null pointer to indicate a missing table,
 282    * checked before access.
 283    * byte_str_t, a wrapper struct pairing a byte pointer along with its length, always
 284    * checks the length before access. A Null pointer is used as the initial pointer
 285    * along with zero length by the default ctor.
 286    */
 287   DEFINE_SIZE_MIN(0);
 288 };
 289
 290 /* Holder of a section of byte string within a CFFIndex entry */
 291 struct byte_str_t : hb_ubytes_t
 292 {
 293   byte_str_t ()
 294     : hb_ubytes_t () {}
 295   byte_str_t (const UnsizedByteStr& s, unsigned int l)
 296     : hb_ubytes_t ((const unsigned char*)&s, l) {}
 297   byte_str_t (const unsigned char *s, unsigned int l)
 298     : hb_ubytes_t (s, l) {}
 299   byte_str_t (const hb_ubytes_t &ub)    /* conversion from hb_ubytes_t */
 300     : hb_ubytes_t (ub) {}
 301
 302   /* sub-string */
 303   byte_str_t sub_str (unsigned int offset, unsigned int len_) const
 304   { return byte_str_t (hb_ubytes_t::sub_array (offset, len_)); }
 305
 306   bool check_limit (unsigned int offset, unsigned int count) const
 307   { return (offset + count <= length); }
 308 };
 309
 310 /* A byte string associated with the current offset and an error condition */
 311 struct byte_str_ref_t
 312 {
 313   byte_str_ref_t () { init (); }
 314
 315   void init ()
 316   {
 317     str = byte_str_t ();
 318     offset = 0;
 319     error = false;
 320   }
 321
 322   void fini () {}
 323
 324   byte_str_ref_t (const byte_str_t &str_, unsigned int offset_ = 0)
 325     : str (str_), offset (offset_), error (false) {}
 326
 327   void reset (const byte_str_t &str_, unsigned int offset_ = 0)
 328   {
 329     str = str_;
 330     offset = offset_;
 331     error = false;
 332   }
 333
 334   const unsigned char& operator [] (int i) {
 335     if (unlikely ((unsigned int) (offset + i) >= str.length))
 336     {
 337       set_error ();
 338       return Null (unsigned char);
 339     }
 340     return str[offset + i];
 341   }
 342
 343   /* Conversion to byte_str_t */
 344   operator byte_str_t () const { return str.sub_str (offset, str.length - offset); }
 345
 346   byte_str_t sub_str (unsigned int offset_, unsigned int len_) const
 347   { return str.sub_str (offset_, len_); }
 348
 349   bool avail (unsigned int count=1) const
 350   { return (!in_error () && str.check_limit (offset, count)); }
 351   void inc (unsigned int count=1)
 352   {
 353     if (likely (!in_error () && (offset <= str.length) && (offset + count <= str.length)))
 354     {
 355       offset += count;
 356     }
 357     else
 358     {
 359       offset = str.length;
 360       set_error ();
 361     }
 362   }
 363
 364   void set_error ()      { error = true; }
 365   bool in_error () const { return error; }
 366
 367   byte_str_t       str;
 368   unsigned int  offset; /* beginning of the sub-string within str */
 369
 370   protected:
 371   bool    error;
 372 };
 373
 374 typedef hb_vector_t<byte_str_t> byte_str_array_t;
 375
 376 /* stack */
 377 template <typename ELEM, int LIMIT>
 378 struct cff_stack_t
 379 {
 380   void init ()
 381   {
 382     error = false;
 383     count = 0;
 384     elements.init ();
 385     elements.resize (kSizeLimit);
 386     for (unsigned int i = 0; i < elements.length; i++)
 387       elements[i].init ();
 388   }
 389   void fini () { elements.fini_deep (); }
 390
 391   ELEM& operator [] (unsigned int i)
 392   {
 393     if (unlikely (i >= count)) set_error ();
 394     return elements[i];
 395   }
 396
 397   void push (const ELEM &v)
 398   {
 399     if (likely (count < elements.length))
 400       elements[count++] = v;
 401     else
 402       set_error ();
 403   }
 404   ELEM &push ()
 405   {
 406     if (likely (count < elements.length))
 407       return elements[count++];
 408     else
 409     {
 410       set_error ();
 411       return Crap(ELEM);
 412     }
 413   }
 414
 415   ELEM& pop ()
 416   {
 417     if (likely (count > 0))
 418       return elements[--count];
 419     else
 420     {
 421       set_error ();
 422       return Crap(ELEM);
 423     }
 424   }
 425   void pop (unsigned int n)
 426   {
 427     if (likely (count >= n))
 428       count -= n;
 429     else
 430       set_error ();
 431   }
 432
 433   const ELEM& peek ()
 434   {
 435     if (unlikely (count < 0))
 436     {
 437       set_error ();
 438       return Null(ELEM);
 439     }
 440     return elements[count - 1];
 441   }
 442
 443   void unpop ()
 444   {
 445     if (likely (count < elements.length))
 446       count++;
 447     else
 448       set_error ();
 449   }
 450
 451   void clear () { count = 0; }
 452
 453   bool in_error () const { return (error || elements.in_error ()); }
 454   void set_error ()      { error = true; }
 455
 456   unsigned int get_count () const { return count; }
 457   bool is_empty () const          { return !count; }
 458
 459   static constexpr unsigned kSizeLimit = LIMIT;
 460
 461   protected:
 462   bool error;
 463   unsigned int count;
 464   hb_vector_t<ELEM> elements;
 465 };
 466
 467 /* argument stack */
 468 template <typename ARG=number_t>
 469 struct arg_stack_t : cff_stack_t<ARG, 513>
 470 {
 471   void push_int (int v)
 472   {
 473     ARG &n = S::push ();
 474     n.set_int (v);
 475   }
 476
 477   void push_fixed (int32_t v)
 478   {
 479     ARG &n = S::push ();
 480     n.set_fixed (v);
 481   }
 482
 483   void push_real (double v)
 484   {
 485     ARG &n = S::push ();
 486     n.set_real (v);
 487   }
 488
 489   ARG& pop_num () { return this->pop (); }
 490
 491   int pop_int ()  { return this->pop ().to_int (); }
 492
 493   unsigned int pop_uint ()
 494   {
 495     int i = pop_int ();
 496     if (unlikely (i < 0))
 497     {
 498       i = 0;
 499       S::set_error ();
 500     }
 501     return (unsigned) i;
 502   }
 503
 504   void push_longint_from_substr (byte_str_ref_t& str_ref)
 505   {
 506     push_int ((str_ref[0] << 24) | (str_ref[1] << 16) | (str_ref[2] << 8) | (str_ref[3]));
 507     str_ref.inc (4);
 508   }
 509
 510   bool push_fixed_from_substr (byte_str_ref_t& str_ref)
 511   {
 512     if (unlikely (!str_ref.avail (4)))
 513       return false;
 514     push_fixed ((int32_t)*(const HBUINT32*)&str_ref[0]);
 515     str_ref.inc (4);
 516     return true;
 517   }
 518
 519   hb_array_t<const ARG> get_subarray (unsigned int start) const
 520   { return S::elements.sub_array (start); }
 521
 522   private:
 523   typedef cff_stack_t<ARG, 513> S;
 524 };
 525
 526 /* an operator prefixed by its operands in a byte string */
 527 struct op_str_t
 528 {
 529   void init () {}
 530   void fini () {}
 531
 532   op_code_t  op;
 533   byte_str_t str;
 534 };
 535
 536 /* base of OP_SERIALIZER */
 537 struct op_serializer_t
 538 {
 539   protected:
 540   bool copy_opstr (hb_serialize_context_t *c, const op_str_t& opstr) const
 541   {
 542     TRACE_SERIALIZE (this);
 543
 544     HBUINT8 *d = c->allocate_size<HBUINT8> (opstr.str.length);
 545     if (unlikely (d == nullptr)) return_trace (false);
 546     memcpy (d, &opstr.str[0], opstr.str.length);
 547     return_trace (true);
 548   }
 549 };
 550
 551 template <typename VAL>
 552 struct parsed_values_t
 553 {
 554   void init ()
 555   {
 556     opStart = 0;
 557     values.init ();
 558   }
 559   void fini () { values.fini_deep (); }
 560
 561   void add_op (op_code_t op, const byte_str_ref_t& str_ref = byte_str_ref_t ())
 562   {
 563     VAL *val = values.push ();
 564     val->op = op;
 565     val->str = str_ref.str.sub_str (opStart, str_ref.offset - opStart);
 566     opStart = str_ref.offset;
 567   }
 568
 569   void add_op (op_code_t op, const byte_str_ref_t& str_ref, const VAL &v)
 570   {
 571     VAL *val = values.push (v);
 572     val->op = op;
 573     val->str = str_ref.sub_str ( opStart, str_ref.offset - opStart);
 574     opStart = str_ref.offset;
 575   }
 576
 577   bool has_op (op_code_t op) const
 578   {
 579     for (unsigned int i = 0; i < get_count (); i++)
 580       if (get_value (i).op == op) return true;
 581     return false;
 582   }
 583
 584   unsigned get_count () const { return values.length; }
 585   const VAL &get_value (unsigned int i)   const { return values[i]; }
 586   const VAL &operator [] (unsigned int i) const { return get_value (i); }
 587
 588   unsigned int       opStart;
 589   hb_vector_t<VAL>   values;
 590 };
 591
 592 template <typename ARG=number_t>
 593 struct interp_env_t
 594 {
 595   void init (const byte_str_t &str_)
 596   {
 597     str_ref.reset (str_);
 598     argStack.init ();
 599     error = false;
 600   }
 601   void fini () { argStack.fini (); }
 602
 603   bool in_error () const
 604   { return error || str_ref.in_error () || argStack.in_error (); }
 605
 606   void set_error () { error = true; }
 607
 608   op_code_t fetch_op ()
 609   {
 610     op_code_t  op = OpCode_Invalid;
 611     if (unlikely (!str_ref.avail ()))
 612       return OpCode_Invalid;
 613     op = (op_code_t)(unsigned char)str_ref[0];
 614     if (op == OpCode_escape) {
 615       if (unlikely (!str_ref.avail ()))
 616         return OpCode_Invalid;
 617       op = Make_OpCode_ESC(str_ref[1]);
 618       str_ref.inc ();
 619     }
 620     str_ref.inc ();
 621     return op;
 622   }
 623
 624   const ARG& eval_arg (unsigned int i) { return argStack[i]; }
 625
 626   ARG& pop_arg () { return argStack.pop (); }
 627   void pop_n_args (unsigned int n) { argStack.pop (n); }
 628
 629   void clear_args () { pop_n_args (argStack.get_count ()); }
 630
 631   byte_str_ref_t
 632                 str_ref;
 633   arg_stack_t<ARG>
 634                 argStack;
 635   protected:
 636   bool          error;
 637 };
 638
 639 typedef interp_env_t<> num_interp_env_t;
 640
 641 template <typename ARG=number_t>
 642 struct opset_t
 643 {
 644   static void process_op (op_code_t op, interp_env_t<ARG>& env)
 645   {
 646     switch (op) {
 647       case OpCode_shortint:
 648         env.argStack.push_int ((int16_t)((env.str_ref[0] << 8) | env.str_ref[1]));
 649         env.str_ref.inc (2);
 650         break;
 651
 652       case OpCode_TwoBytePosInt0: case OpCode_TwoBytePosInt1:
 653       case OpCode_TwoBytePosInt2: case OpCode_TwoBytePosInt3:
 654         env.argStack.push_int ((int16_t)((op - OpCode_TwoBytePosInt0) * 256 + env.str_ref[0] + 108));
 655         env.str_ref.inc ();
 656         break;
 657
 658       case OpCode_TwoByteNegInt0: case OpCode_TwoByteNegInt1:
 659       case OpCode_TwoByteNegInt2: case OpCode_TwoByteNegInt3:
 660         env.argStack.push_int ((-(int16_t)(op - OpCode_TwoByteNegInt0) * 256 - env.str_ref[0] - 108));
 661         env.str_ref.inc ();
 662         break;
 663
 664       default:
 665         /* 1-byte integer */
 666         if (likely ((OpCode_OneByteIntFirst <= op) && (op <= OpCode_OneByteIntLast)))
 667         {
 668           env.argStack.push_int ((int)op - 139);
 669         } else {
 670           /* invalid unknown operator */
 671           env.clear_args ();
 672           env.set_error ();
 673         }
 674         break;
 675     }
 676   }
 677 };
 678
 679 template <typename ENV>
 680 struct interpreter_t
 681 {
 682   ~interpreter_t() { fini (); }
 683
 684   void fini () { env.fini (); }
 685
 686   ENV env;
 687 };
 688
 689 } /* namespace CFF */
 690
 691 #endif /* HB_CFF_INTERP_COMMON_HH */