2 * Copyright © 2018 Adobe Inc.
4 * This is part of HarfBuzz, a text shaping library.
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.
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
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.
24 * Adobe Author(s): Michiharu Ariza
26 #ifndef HB_CFF_INTERP_CS_COMMON_HH
27 #define HB_CFF_INTERP_CS_COMMON_HH
30 #include "hb-cff-interp-common.hh"
44 void init (const byte_str_ref_t substr_=byte_str_ref_t (), cs_type_t type_=CSType_CharString, unsigned int subr_num_=0)
53 byte_str_ref_t str_ref;
55 unsigned int subr_num;
59 const unsigned int kMaxCallLimit = 10;
60 struct call_stack_t : cff_stack_t<call_context_t, kMaxCallLimit> {};
62 template <typename SUBRS>
65 void init (const SUBRS *subrs_)
68 unsigned int nSubrs = get_count ();
71 else if (nSubrs < 33900)
79 unsigned int get_count () const { return (subrs == nullptr) ? 0 : subrs->count; }
80 unsigned int get_bias () const { return bias; }
82 byte_str_t operator [] (unsigned int index) const
84 if (unlikely ((subrs == nullptr) || index >= subrs->count))
85 return Null(byte_str_t);
87 return (*subrs)[index];
103 void set_int (int _x, int _y)
109 void move_x (const number_t &dx) { x += dx; }
110 void move_y (const number_t &dy) { y += dy; }
111 void move (const number_t &dx, const number_t &dy) { move_x (dx); move_y (dy); }
112 void move (const point_t &d) { move_x (d.x); move_y (d.y); }
118 template <typename ARG, typename SUBRS>
119 struct cs_interp_env_t : interp_env_t<ARG>
121 void init (const byte_str_t &str, const SUBRS *globalSubrs_, const SUBRS *localSubrs_)
123 interp_env_t<ARG>::init (str);
125 context.init (str, CSType_CharString);
127 seen_hintmask = false;
133 globalSubrs.init (globalSubrs_);
134 localSubrs.init (localSubrs_);
138 interp_env_t<ARG>::fini ();
145 bool in_error () const
147 return callStack.in_error () || SUPER::in_error ();
150 bool pop_subr_num (const biased_subrs_t<SUBRS>& biasedSubrs, unsigned int &subr_num)
153 int n = SUPER::argStack.pop_int ();
154 n += biasedSubrs.get_bias ();
155 if (unlikely ((n < 0) || ((unsigned int)n >= biasedSubrs.get_count ())))
158 subr_num = (unsigned int)n;
162 void call_subr (const biased_subrs_t<SUBRS>& biasedSubrs, cs_type_t type)
164 unsigned int subr_num = 0;
166 if (unlikely (!pop_subr_num (biasedSubrs, subr_num)
167 || callStack.get_count () >= kMaxCallLimit))
172 context.str_ref = SUPER::str_ref;
173 callStack.push (context);
175 context.init ( biasedSubrs[subr_num], type, subr_num);
176 SUPER::str_ref = context.str_ref;
179 void return_from_subr ()
181 if (unlikely (SUPER::str_ref.in_error ()))
183 context = callStack.pop ();
184 SUPER::str_ref = context.str_ref;
187 void determine_hintmask_size ()
191 vstem_count += SUPER::argStack.get_count() / 2;
192 hintmask_size = (hstem_count + vstem_count + 7) >> 3;
193 seen_hintmask = true;
197 void set_endchar (bool endchar_flag_) { endchar_flag = endchar_flag_; }
198 bool is_endchar () const { return endchar_flag; }
200 const number_t &get_x () const { return pt.x; }
201 const number_t &get_y () const { return pt.y; }
202 const point_t &get_pt () const { return pt; }
204 void moveto (const point_t &pt_ ) { pt = pt_; }
207 call_context_t context;
212 unsigned int hstem_count;
213 unsigned int vstem_count;
214 unsigned int hintmask_size;
215 call_stack_t callStack;
216 biased_subrs_t<SUBRS> globalSubrs;
217 biased_subrs_t<SUBRS> localSubrs;
222 typedef interp_env_t<ARG> SUPER;
225 template <typename ENV, typename PARAM>
226 struct path_procs_null_t
228 static void rmoveto (ENV &env, PARAM& param) {}
229 static void hmoveto (ENV &env, PARAM& param) {}
230 static void vmoveto (ENV &env, PARAM& param) {}
231 static void rlineto (ENV &env, PARAM& param) {}
232 static void hlineto (ENV &env, PARAM& param) {}
233 static void vlineto (ENV &env, PARAM& param) {}
234 static void rrcurveto (ENV &env, PARAM& param) {}
235 static void rcurveline (ENV &env, PARAM& param) {}
236 static void rlinecurve (ENV &env, PARAM& param) {}
237 static void vvcurveto (ENV &env, PARAM& param) {}
238 static void hhcurveto (ENV &env, PARAM& param) {}
239 static void vhcurveto (ENV &env, PARAM& param) {}
240 static void hvcurveto (ENV &env, PARAM& param) {}
241 static void moveto (ENV &env, PARAM& param, const point_t &pt) {}
242 static void line (ENV &env, PARAM& param, const point_t &pt1) {}
243 static void curve (ENV &env, PARAM& param, const point_t &pt1, const point_t &pt2, const point_t &pt3) {}
244 static void hflex (ENV &env, PARAM& param) {}
245 static void flex (ENV &env, PARAM& param) {}
246 static void hflex1 (ENV &env, PARAM& param) {}
247 static void flex1 (ENV &env, PARAM& param) {}
250 template <typename ARG, typename OPSET, typename ENV, typename PARAM, typename PATH=path_procs_null_t<ENV, PARAM>>
251 struct cs_opset_t : opset_t<ARG>
253 static void process_op (op_code_t op, ENV &env, PARAM& param)
258 env.return_from_subr ();
261 OPSET::check_width (op, env, param);
262 env.set_endchar (true);
263 OPSET::flush_args_and_op (op, env, param);
267 env.argStack.push_fixed_from_substr (env.str_ref);
270 case OpCode_callsubr:
271 env.call_subr (env.localSubrs, CSType_LocalSubr);
274 case OpCode_callgsubr:
275 env.call_subr (env.globalSubrs, CSType_GlobalSubr);
280 OPSET::check_width (op, env, param);
281 OPSET::process_hstem (op, env, param);
285 OPSET::check_width (op, env, param);
286 OPSET::process_vstem (op, env, param);
288 case OpCode_hintmask:
289 case OpCode_cntrmask:
290 OPSET::check_width (op, env, param);
291 OPSET::process_hintmask (op, env, param);
294 OPSET::check_width (op, env, param);
295 PATH::rmoveto (env, param);
296 OPSET::process_post_move (op, env, param);
299 OPSET::check_width (op, env, param);
300 PATH::hmoveto (env, param);
301 OPSET::process_post_move (op, env, param);
304 OPSET::check_width (op, env, param);
305 PATH::vmoveto (env, param);
306 OPSET::process_post_move (op, env, param);
309 PATH::rlineto (env, param);
310 process_post_path (op, env, param);
313 PATH::hlineto (env, param);
314 process_post_path (op, env, param);
317 PATH::vlineto (env, param);
318 process_post_path (op, env, param);
320 case OpCode_rrcurveto:
321 PATH::rrcurveto (env, param);
322 process_post_path (op, env, param);
324 case OpCode_rcurveline:
325 PATH::rcurveline (env, param);
326 process_post_path (op, env, param);
328 case OpCode_rlinecurve:
329 PATH::rlinecurve (env, param);
330 process_post_path (op, env, param);
332 case OpCode_vvcurveto:
333 PATH::vvcurveto (env, param);
334 process_post_path (op, env, param);
336 case OpCode_hhcurveto:
337 PATH::hhcurveto (env, param);
338 process_post_path (op, env, param);
340 case OpCode_vhcurveto:
341 PATH::vhcurveto (env, param);
342 process_post_path (op, env, param);
344 case OpCode_hvcurveto:
345 PATH::hvcurveto (env, param);
346 process_post_path (op, env, param);
350 PATH::hflex (env, param);
351 OPSET::process_post_flex (op, env, param);
355 PATH::flex (env, param);
356 OPSET::process_post_flex (op, env, param);
360 PATH::hflex1 (env, param);
361 OPSET::process_post_flex (op, env, param);
365 PATH::flex1 (env, param);
366 OPSET::process_post_flex (op, env, param);
370 SUPER::process_op (op, env);
375 static void process_hstem (op_code_t op, ENV &env, PARAM& param)
377 env.hstem_count += env.argStack.get_count () / 2;
378 OPSET::flush_args_and_op (op, env, param);
381 static void process_vstem (op_code_t op, ENV &env, PARAM& param)
383 env.vstem_count += env.argStack.get_count () / 2;
384 OPSET::flush_args_and_op (op, env, param);
387 static void process_hintmask (op_code_t op, ENV &env, PARAM& param)
389 env.determine_hintmask_size ();
390 if (likely (env.str_ref.avail (env.hintmask_size)))
392 OPSET::flush_hintmask (op, env, param);
393 env.str_ref.inc (env.hintmask_size);
397 static void process_post_flex (op_code_t op, ENV &env, PARAM& param)
399 OPSET::flush_args_and_op (op, env, param);
402 static void check_width (op_code_t op, ENV &env, PARAM& param)
405 static void process_post_move (op_code_t op, ENV &env, PARAM& param)
407 if (!env.seen_moveto)
409 env.determine_hintmask_size ();
410 env.seen_moveto = true;
412 OPSET::flush_args_and_op (op, env, param);
415 static void process_post_path (op_code_t op, ENV &env, PARAM& param)
417 OPSET::flush_args_and_op (op, env, param);
420 static void flush_args_and_op (op_code_t op, ENV &env, PARAM& param)
422 OPSET::flush_args (env, param);
423 OPSET::flush_op (op, env, param);
426 static void flush_args (ENV &env, PARAM& param)
428 env.pop_n_args (env.argStack.get_count ());
431 static void flush_op (op_code_t op, ENV &env, PARAM& param)
435 static void flush_hintmask (op_code_t op, ENV &env, PARAM& param)
437 OPSET::flush_args_and_op (op, env, param);
440 static bool is_number_op (op_code_t op)
444 case OpCode_shortint:
446 case OpCode_TwoBytePosInt0: case OpCode_TwoBytePosInt1:
447 case OpCode_TwoBytePosInt2: case OpCode_TwoBytePosInt3:
448 case OpCode_TwoByteNegInt0: case OpCode_TwoByteNegInt1:
449 case OpCode_TwoByteNegInt2: case OpCode_TwoByteNegInt3:
454 return (OpCode_OneByteIntFirst <= op) && (op <= OpCode_OneByteIntLast);
459 typedef opset_t<ARG> SUPER;
462 template <typename PATH, typename ENV, typename PARAM>
465 static void rmoveto (ENV &env, PARAM& param)
467 point_t pt1 = env.get_pt ();
468 const number_t &dy = env.pop_arg ();
469 const number_t &dx = env.pop_arg ();
471 PATH::moveto (env, param, pt1);
474 static void hmoveto (ENV &env, PARAM& param)
476 point_t pt1 = env.get_pt ();
477 pt1.move_x (env.pop_arg ());
478 PATH::moveto (env, param, pt1);
481 static void vmoveto (ENV &env, PARAM& param)
483 point_t pt1 = env.get_pt ();
484 pt1.move_y (env.pop_arg ());
485 PATH::moveto (env, param, pt1);
488 static void rlineto (ENV &env, PARAM& param)
490 for (unsigned int i = 0; i + 2 <= env.argStack.get_count (); i += 2)
492 point_t pt1 = env.get_pt ();
493 pt1.move (env.eval_arg (i), env.eval_arg (i+1));
494 PATH::line (env, param, pt1);
498 static void hlineto (ENV &env, PARAM& param)
502 for (; i + 2 <= env.argStack.get_count (); i += 2)
505 pt1.move_x (env.eval_arg (i));
506 PATH::line (env, param, pt1);
507 pt1.move_y (env.eval_arg (i+1));
508 PATH::line (env, param, pt1);
510 if (i < env.argStack.get_count ())
513 pt1.move_x (env.eval_arg (i));
514 PATH::line (env, param, pt1);
518 static void vlineto (ENV &env, PARAM& param)
522 for (; i + 2 <= env.argStack.get_count (); i += 2)
525 pt1.move_y (env.eval_arg (i));
526 PATH::line (env, param, pt1);
527 pt1.move_x (env.eval_arg (i+1));
528 PATH::line (env, param, pt1);
530 if (i < env.argStack.get_count ())
533 pt1.move_y (env.eval_arg (i));
534 PATH::line (env, param, pt1);
538 static void rrcurveto (ENV &env, PARAM& param)
540 for (unsigned int i = 0; i + 6 <= env.argStack.get_count (); i += 6)
542 point_t pt1 = env.get_pt ();
543 pt1.move (env.eval_arg (i), env.eval_arg (i+1));
545 pt2.move (env.eval_arg (i+2), env.eval_arg (i+3));
547 pt3.move (env.eval_arg (i+4), env.eval_arg (i+5));
548 PATH::curve (env, param, pt1, pt2, pt3);
552 static void rcurveline (ENV &env, PARAM& param)
555 for (; i + 6 <= env.argStack.get_count (); i += 6)
557 point_t pt1 = env.get_pt ();
558 pt1.move (env.eval_arg (i), env.eval_arg (i+1));
560 pt2.move (env.eval_arg (i+2), env.eval_arg (i+3));
562 pt3.move (env.eval_arg (i+4), env.eval_arg (i+5));
563 PATH::curve (env, param, pt1, pt2, pt3);
565 for (; i + 2 <= env.argStack.get_count (); i += 2)
567 point_t pt1 = env.get_pt ();
568 pt1.move (env.eval_arg (i), env.eval_arg (i+1));
569 PATH::line (env, param, pt1);
573 static void rlinecurve (ENV &env, PARAM& param)
576 unsigned int line_limit = (env.argStack.get_count () % 6);
577 for (; i + 2 <= line_limit; i += 2)
579 point_t pt1 = env.get_pt ();
580 pt1.move (env.eval_arg (i), env.eval_arg (i+1));
581 PATH::line (env, param, pt1);
583 for (; i + 6 <= env.argStack.get_count (); i += 6)
585 point_t pt1 = env.get_pt ();
586 pt1.move (env.eval_arg (i), env.eval_arg (i+1));
588 pt2.move (env.eval_arg (i+2), env.eval_arg (i+3));
590 pt3.move (env.eval_arg (i+4), env.eval_arg (i+5));
591 PATH::curve (env, param, pt1, pt2, pt3);
595 static void vvcurveto (ENV &env, PARAM& param)
598 point_t pt1 = env.get_pt ();
599 if ((env.argStack.get_count () & 1) != 0)
600 pt1.move_x (env.eval_arg (i++));
601 for (; i + 4 <= env.argStack.get_count (); i += 4)
603 pt1.move_y (env.eval_arg (i));
605 pt2.move (env.eval_arg (i+1), env.eval_arg (i+2));
607 pt3.move_y (env.eval_arg (i+3));
608 PATH::curve (env, param, pt1, pt2, pt3);
613 static void hhcurveto (ENV &env, PARAM& param)
616 point_t pt1 = env.get_pt ();
617 if ((env.argStack.get_count () & 1) != 0)
618 pt1.move_y (env.eval_arg (i++));
619 for (; i + 4 <= env.argStack.get_count (); i += 4)
621 pt1.move_x (env.eval_arg (i));
623 pt2.move (env.eval_arg (i+1), env.eval_arg (i+2));
625 pt3.move_x (env.eval_arg (i+3));
626 PATH::curve (env, param, pt1, pt2, pt3);
631 static void vhcurveto (ENV &env, PARAM& param)
633 point_t pt1, pt2, pt3;
635 if ((env.argStack.get_count () % 8) >= 4)
637 point_t pt1 = env.get_pt ();
638 pt1.move_y (env.eval_arg (i));
640 pt2.move (env.eval_arg (i+1), env.eval_arg (i+2));
642 pt3.move_x (env.eval_arg (i+3));
645 for (; i + 8 <= env.argStack.get_count (); i += 8)
647 PATH::curve (env, param, pt1, pt2, pt3);
649 pt1.move_x (env.eval_arg (i));
651 pt2.move (env.eval_arg (i+1), env.eval_arg (i+2));
653 pt3.move_y (env.eval_arg (i+3));
654 PATH::curve (env, param, pt1, pt2, pt3);
657 pt1.move_y (env.eval_arg (i+4));
659 pt2.move (env.eval_arg (i+5), env.eval_arg (i+6));
661 pt3.move_x (env.eval_arg (i+7));
663 if (i < env.argStack.get_count ())
664 pt3.move_y (env.eval_arg (i));
665 PATH::curve (env, param, pt1, pt2, pt3);
669 for (; i + 8 <= env.argStack.get_count (); i += 8)
672 pt1.move_y (env.eval_arg (i));
674 pt2.move (env.eval_arg (i+1), env.eval_arg (i+2));
676 pt3.move_x (env.eval_arg (i+3));
677 PATH::curve (env, param, pt1, pt2, pt3);
680 pt1.move_x (env.eval_arg (i+4));
682 pt2.move (env.eval_arg (i+5), env.eval_arg (i+6));
684 pt3.move_y (env.eval_arg (i+7));
685 if ((env.argStack.get_count () - i < 16) && ((env.argStack.get_count () & 1) != 0))
686 pt3.move_x (env.eval_arg (i+8));
687 PATH::curve (env, param, pt1, pt2, pt3);
692 static void hvcurveto (ENV &env, PARAM& param)
694 point_t pt1, pt2, pt3;
696 if ((env.argStack.get_count () % 8) >= 4)
698 point_t pt1 = env.get_pt ();
699 pt1.move_x (env.eval_arg (i));
701 pt2.move (env.eval_arg (i+1), env.eval_arg (i+2));
703 pt3.move_y (env.eval_arg (i+3));
706 for (; i + 8 <= env.argStack.get_count (); i += 8)
708 PATH::curve (env, param, pt1, pt2, pt3);
710 pt1.move_y (env.eval_arg (i));
712 pt2.move (env.eval_arg (i+1), env.eval_arg (i+2));
714 pt3.move_x (env.eval_arg (i+3));
715 PATH::curve (env, param, pt1, pt2, pt3);
718 pt1.move_x (env.eval_arg (i+4));
720 pt2.move (env.eval_arg (i+5), env.eval_arg (i+6));
722 pt3.move_y (env.eval_arg (i+7));
724 if (i < env.argStack.get_count ())
725 pt3.move_x (env.eval_arg (i));
726 PATH::curve (env, param, pt1, pt2, pt3);
730 for (; i + 8 <= env.argStack.get_count (); i += 8)
733 pt1.move_x (env.eval_arg (i));
735 pt2.move (env.eval_arg (i+1), env.eval_arg (i+2));
737 pt3.move_y (env.eval_arg (i+3));
738 PATH::curve (env, param, pt1, pt2, pt3);
741 pt1.move_y (env.eval_arg (i+4));
743 pt2.move (env.eval_arg (i+5), env.eval_arg (i+6));
745 pt3.move_x (env.eval_arg (i+7));
746 if ((env.argStack.get_count () - i < 16) && ((env.argStack.get_count () & 1) != 0))
747 pt3.move_y (env.eval_arg (i+8));
748 PATH::curve (env, param, pt1, pt2, pt3);
753 /* default actions to be overridden */
754 static void moveto (ENV &env, PARAM& param, const point_t &pt)
757 static void line (ENV &env, PARAM& param, const point_t &pt1)
758 { PATH::moveto (env, param, pt1); }
760 static void curve (ENV &env, PARAM& param, const point_t &pt1, const point_t &pt2, const point_t &pt3)
761 { PATH::moveto (env, param, pt3); }
763 static void hflex (ENV &env, PARAM& param)
765 if (likely (env.argStack.get_count () == 7))
767 point_t pt1 = env.get_pt ();
768 pt1.move_x (env.eval_arg (0));
770 pt2.move (env.eval_arg (1), env.eval_arg (2));
772 pt3.move_x (env.eval_arg (3));
774 pt4.move_x (env.eval_arg (4));
776 pt5.move_x (env.eval_arg (5));
779 pt6.move_x (env.eval_arg (6));
781 curve2 (env, param, pt1, pt2, pt3, pt4, pt5, pt6);
787 static void flex (ENV &env, PARAM& param)
789 if (likely (env.argStack.get_count () == 13))
791 point_t pt1 = env.get_pt ();
792 pt1.move (env.eval_arg (0), env.eval_arg (1));
794 pt2.move (env.eval_arg (2), env.eval_arg (3));
796 pt3.move (env.eval_arg (4), env.eval_arg (5));
798 pt4.move (env.eval_arg (6), env.eval_arg (7));
800 pt5.move (env.eval_arg (8), env.eval_arg (9));
802 pt6.move (env.eval_arg (10), env.eval_arg (11));
804 curve2 (env, param, pt1, pt2, pt3, pt4, pt5, pt6);
810 static void hflex1 (ENV &env, PARAM& param)
812 if (likely (env.argStack.get_count () == 9))
814 point_t pt1 = env.get_pt ();
815 pt1.move (env.eval_arg (0), env.eval_arg (1));
817 pt2.move (env.eval_arg (2), env.eval_arg (3));
819 pt3.move_x (env.eval_arg (4));
821 pt4.move_x (env.eval_arg (5));
823 pt5.move (env.eval_arg (6), env.eval_arg (7));
825 pt6.move_x (env.eval_arg (8));
826 pt6.y = env.get_pt ().y;
828 curve2 (env, param, pt1, pt2, pt3, pt4, pt5, pt6);
834 static void flex1 (ENV &env, PARAM& param)
836 if (likely (env.argStack.get_count () == 11))
840 for (unsigned int i = 0; i < 10; i += 2)
841 d.move (env.eval_arg (i), env.eval_arg (i+1));
843 point_t pt1 = env.get_pt ();
844 pt1.move (env.eval_arg (0), env.eval_arg (1));
846 pt2.move (env.eval_arg (2), env.eval_arg (3));
848 pt3.move (env.eval_arg (4), env.eval_arg (5));
850 pt4.move (env.eval_arg (6), env.eval_arg (7));
852 pt5.move (env.eval_arg (8), env.eval_arg (9));
855 if (fabs (d.x.to_real ()) > fabs (d.y.to_real ()))
857 pt6.move_x (env.eval_arg (10));
858 pt6.y = env.get_pt ().y;
862 pt6.x = env.get_pt ().x;
863 pt6.move_y (env.eval_arg (10));
866 curve2 (env, param, pt1, pt2, pt3, pt4, pt5, pt6);
873 static void curve2 (ENV &env, PARAM& param,
874 const point_t &pt1, const point_t &pt2, const point_t &pt3,
875 const point_t &pt4, const point_t &pt5, const point_t &pt6)
877 PATH::curve (env, param, pt1, pt2, pt3);
878 PATH::curve (env, param, pt4, pt5, pt6);
882 template <typename ENV, typename OPSET, typename PARAM>
883 struct cs_interpreter_t : interpreter_t<ENV>
885 bool interpret (PARAM& param)
887 SUPER::env.set_endchar (false);
890 OPSET::process_op (SUPER::env.fetch_op (), SUPER::env, param);
891 if (unlikely (SUPER::env.in_error ()))
893 if (SUPER::env.is_endchar ())
901 typedef interpreter_t<ENV> SUPER;
904 } /* namespace CFF */
906 #endif /* HB_CFF_INTERP_CS_COMMON_HH */