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 : 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 popSubrNum (const biased_subrs_t<SUBRS>& biasedSubrs, unsigned int &subr_num)
152 int n = SUPER::argStack.pop_int ();
153 n += biasedSubrs.get_bias ();
154 if (unlikely ((n < 0) || ((unsigned int)n >= biasedSubrs.get_count ())))
157 subr_num = (unsigned int)n;
161 void callSubr (const biased_subrs_t<SUBRS>& biasedSubrs, cs_type_t type)
163 unsigned int subr_num;
165 if (unlikely (!popSubrNum (biasedSubrs, subr_num)
166 || callStack.get_count () >= kMaxCallLimit))
171 context.str_ref = SUPER::str_ref;
172 callStack.push (context);
174 context.init ( biasedSubrs[subr_num], type, subr_num);
175 SUPER::str_ref = context.str_ref;
178 void returnFromSubr ()
180 if (unlikely (SUPER::str_ref.in_error ()))
182 context = callStack.pop ();
183 SUPER::str_ref = context.str_ref;
186 void determine_hintmask_size ()
190 vstem_count += SUPER::argStack.get_count() / 2;
191 hintmask_size = (hstem_count + vstem_count + 7) >> 3;
192 seen_hintmask = true;
196 void set_endchar (bool endchar_flag_) { endchar_flag = endchar_flag_; }
197 bool is_endchar () const { return endchar_flag; }
199 const number_t &get_x () const { return pt.x; }
200 const number_t &get_y () const { return pt.y; }
201 const point_t &get_pt () const { return pt; }
203 void moveto (const point_t &pt_ ) { pt = pt_; }
206 call_context_t context;
211 unsigned int hstem_count;
212 unsigned int vstem_count;
213 unsigned int hintmask_size;
214 call_stack_t callStack;
215 biased_subrs_t<SUBRS> globalSubrs;
216 biased_subrs_t<SUBRS> localSubrs;
221 typedef interp_env_t<ARG> SUPER;
224 template <typename ENV, typename PARAM>
225 struct path_procs_null_t
227 static void rmoveto (ENV &env, PARAM& param) {}
228 static void hmoveto (ENV &env, PARAM& param) {}
229 static void vmoveto (ENV &env, PARAM& param) {}
230 static void rlineto (ENV &env, PARAM& param) {}
231 static void hlineto (ENV &env, PARAM& param) {}
232 static void vlineto (ENV &env, PARAM& param) {}
233 static void rrcurveto (ENV &env, PARAM& param) {}
234 static void rcurveline (ENV &env, PARAM& param) {}
235 static void rlinecurve (ENV &env, PARAM& param) {}
236 static void vvcurveto (ENV &env, PARAM& param) {}
237 static void hhcurveto (ENV &env, PARAM& param) {}
238 static void vhcurveto (ENV &env, PARAM& param) {}
239 static void hvcurveto (ENV &env, PARAM& param) {}
240 static void moveto (ENV &env, PARAM& param, const point_t &pt) {}
241 static void line (ENV &env, PARAM& param, const point_t &pt1) {}
242 static void curve (ENV &env, PARAM& param, const point_t &pt1, const point_t &pt2, const point_t &pt3) {}
243 static void hflex (ENV &env, PARAM& param) {}
244 static void flex (ENV &env, PARAM& param) {}
245 static void hflex1 (ENV &env, PARAM& param) {}
246 static void flex1 (ENV &env, PARAM& param) {}
249 template <typename ARG, typename OPSET, typename ENV, typename PARAM, typename PATH=path_procs_null_t<ENV, PARAM> >
250 struct cs_opset_t : opset_t<ARG>
252 static void process_op (op_code_t op, ENV &env, PARAM& param)
257 env.returnFromSubr ();
260 OPSET::check_width (op, env, param);
261 env.set_endchar (true);
262 OPSET::flush_args_and_op (op, env, param);
266 env.argStack.push_fixed_from_substr (env.str_ref);
269 case OpCode_callsubr:
270 env.callSubr (env.localSubrs, CSType_LocalSubr);
273 case OpCode_callgsubr:
274 env.callSubr (env.globalSubrs, CSType_GlobalSubr);
279 OPSET::check_width (op, env, param);
280 OPSET::process_hstem (op, env, param);
284 OPSET::check_width (op, env, param);
285 OPSET::process_vstem (op, env, param);
287 case OpCode_hintmask:
288 case OpCode_cntrmask:
289 OPSET::check_width (op, env, param);
290 OPSET::process_hintmask (op, env, param);
293 OPSET::check_width (op, env, param);
294 PATH::rmoveto (env, param);
295 OPSET::process_post_move (op, env, param);
298 OPSET::check_width (op, env, param);
299 PATH::hmoveto (env, param);
300 OPSET::process_post_move (op, env, param);
303 OPSET::check_width (op, env, param);
304 PATH::vmoveto (env, param);
305 OPSET::process_post_move (op, env, param);
308 PATH::rlineto (env, param);
309 process_post_path (op, env, param);
312 PATH::hlineto (env, param);
313 process_post_path (op, env, param);
316 PATH::vlineto (env, param);
317 process_post_path (op, env, param);
319 case OpCode_rrcurveto:
320 PATH::rrcurveto (env, param);
321 process_post_path (op, env, param);
323 case OpCode_rcurveline:
324 PATH::rcurveline (env, param);
325 process_post_path (op, env, param);
327 case OpCode_rlinecurve:
328 PATH::rlinecurve (env, param);
329 process_post_path (op, env, param);
331 case OpCode_vvcurveto:
332 PATH::vvcurveto (env, param);
333 process_post_path (op, env, param);
335 case OpCode_hhcurveto:
336 PATH::hhcurveto (env, param);
337 process_post_path (op, env, param);
339 case OpCode_vhcurveto:
340 PATH::vhcurveto (env, param);
341 process_post_path (op, env, param);
343 case OpCode_hvcurveto:
344 PATH::hvcurveto (env, param);
345 process_post_path (op, env, param);
349 PATH::hflex (env, param);
350 OPSET::process_post_flex (op, env, param);
354 PATH::flex (env, param);
355 OPSET::process_post_flex (op, env, param);
359 PATH::hflex1 (env, param);
360 OPSET::process_post_flex (op, env, param);
364 PATH::flex1 (env, param);
365 OPSET::process_post_flex (op, env, param);
369 SUPER::process_op (op, env);
374 static void process_hstem (op_code_t op, ENV &env, PARAM& param)
376 env.hstem_count += env.argStack.get_count () / 2;
377 OPSET::flush_args_and_op (op, env, param);
380 static void process_vstem (op_code_t op, ENV &env, PARAM& param)
382 env.vstem_count += env.argStack.get_count () / 2;
383 OPSET::flush_args_and_op (op, env, param);
386 static void process_hintmask (op_code_t op, ENV &env, PARAM& param)
388 env.determine_hintmask_size ();
389 if (likely (env.str_ref.avail (env.hintmask_size)))
391 OPSET::flush_hintmask (op, env, param);
392 env.str_ref.inc (env.hintmask_size);
396 static void process_post_flex (op_code_t op, ENV &env, PARAM& param)
398 OPSET::flush_args_and_op (op, env, param);
401 static void check_width (op_code_t op, ENV &env, PARAM& param)
404 static void process_post_move (op_code_t op, ENV &env, PARAM& param)
406 if (!env.seen_moveto)
408 env.determine_hintmask_size ();
409 env.seen_moveto = true;
411 OPSET::flush_args_and_op (op, env, param);
414 static void process_post_path (op_code_t op, ENV &env, PARAM& param)
416 OPSET::flush_args_and_op (op, env, param);
419 static void flush_args_and_op (op_code_t op, ENV &env, PARAM& param)
421 OPSET::flush_args (env, param);
422 OPSET::flush_op (op, env, param);
425 static void flush_args (ENV &env, PARAM& param)
427 env.pop_n_args (env.argStack.get_count ());
430 static void flush_op (op_code_t op, ENV &env, PARAM& param)
434 static void flush_hintmask (op_code_t op, ENV &env, PARAM& param)
436 OPSET::flush_args_and_op (op, env, param);
439 static bool is_number_op (op_code_t op)
443 case OpCode_shortint:
445 case OpCode_TwoBytePosInt0: case OpCode_TwoBytePosInt1:
446 case OpCode_TwoBytePosInt2: case OpCode_TwoBytePosInt3:
447 case OpCode_TwoByteNegInt0: case OpCode_TwoByteNegInt1:
448 case OpCode_TwoByteNegInt2: case OpCode_TwoByteNegInt3:
453 return (OpCode_OneByteIntFirst <= op) && (op <= OpCode_OneByteIntLast);
458 typedef opset_t<ARG> SUPER;
461 template <typename PATH, typename ENV, typename PARAM>
464 static void rmoveto (ENV &env, PARAM& param)
466 point_t pt1 = env.get_pt ();
467 const number_t &dy = env.pop_arg ();
468 const number_t &dx = env.pop_arg ();
470 PATH::moveto (env, param, pt1);
473 static void hmoveto (ENV &env, PARAM& param)
475 point_t pt1 = env.get_pt ();
476 pt1.move_x (env.pop_arg ());
477 PATH::moveto (env, param, pt1);
480 static void vmoveto (ENV &env, PARAM& param)
482 point_t pt1 = env.get_pt ();
483 pt1.move_y (env.pop_arg ());
484 PATH::moveto (env, param, pt1);
487 static void rlineto (ENV &env, PARAM& param)
489 for (unsigned int i = 0; i + 2 <= env.argStack.get_count (); i += 2)
491 point_t pt1 = env.get_pt ();
492 pt1.move (env.eval_arg (i), env.eval_arg (i+1));
493 PATH::line (env, param, pt1);
497 static void hlineto (ENV &env, PARAM& param)
501 for (; i + 2 <= env.argStack.get_count (); i += 2)
504 pt1.move_x (env.eval_arg (i));
505 PATH::line (env, param, pt1);
506 pt1.move_y (env.eval_arg (i+1));
507 PATH::line (env, param, pt1);
509 if (i < env.argStack.get_count ())
512 pt1.move_x (env.eval_arg (i));
513 PATH::line (env, param, pt1);
517 static void vlineto (ENV &env, PARAM& param)
521 for (; i + 2 <= env.argStack.get_count (); i += 2)
524 pt1.move_y (env.eval_arg (i));
525 PATH::line (env, param, pt1);
526 pt1.move_x (env.eval_arg (i+1));
527 PATH::line (env, param, pt1);
529 if (i < env.argStack.get_count ())
532 pt1.move_y (env.eval_arg (i));
533 PATH::line (env, param, pt1);
537 static void rrcurveto (ENV &env, PARAM& param)
539 for (unsigned int i = 0; i + 6 <= env.argStack.get_count (); i += 6)
541 point_t pt1 = env.get_pt ();
542 pt1.move (env.eval_arg (i), env.eval_arg (i+1));
544 pt2.move (env.eval_arg (i+2), env.eval_arg (i+3));
546 pt3.move (env.eval_arg (i+4), env.eval_arg (i+5));
547 PATH::curve (env, param, pt1, pt2, pt3);
551 static void rcurveline (ENV &env, PARAM& param)
554 for (; i + 6 <= env.argStack.get_count (); i += 6)
556 point_t pt1 = env.get_pt ();
557 pt1.move (env.eval_arg (i), env.eval_arg (i+1));
559 pt2.move (env.eval_arg (i+2), env.eval_arg (i+3));
561 pt3.move (env.eval_arg (i+4), env.eval_arg (i+5));
562 PATH::curve (env, param, pt1, pt2, pt3);
564 for (; i + 2 <= env.argStack.get_count (); i += 2)
566 point_t pt1 = env.get_pt ();
567 pt1.move (env.eval_arg (i), env.eval_arg (i+1));
568 PATH::line (env, param, pt1);
572 static void rlinecurve (ENV &env, PARAM& param)
575 unsigned int line_limit = (env.argStack.get_count () % 6);
576 for (; i + 2 <= line_limit; i += 2)
578 point_t pt1 = env.get_pt ();
579 pt1.move (env.eval_arg (i), env.eval_arg (i+1));
580 PATH::line (env, param, pt1);
582 for (; i + 6 <= env.argStack.get_count (); i += 6)
584 point_t pt1 = env.get_pt ();
585 pt1.move (env.eval_arg (i), env.eval_arg (i+1));
587 pt2.move (env.eval_arg (i+2), env.eval_arg (i+3));
589 pt3.move (env.eval_arg (i+4), env.eval_arg (i+5));
590 PATH::curve (env, param, pt1, pt2, pt3);
594 static void vvcurveto (ENV &env, PARAM& param)
597 point_t pt1 = env.get_pt ();
598 if ((env.argStack.get_count () & 1) != 0)
599 pt1.move_x (env.eval_arg (i++));
600 for (; i + 4 <= env.argStack.get_count (); i += 4)
602 pt1.move_y (env.eval_arg (i));
604 pt2.move (env.eval_arg (i+1), env.eval_arg (i+2));
606 pt3.move_y (env.eval_arg (i+3));
607 PATH::curve (env, param, pt1, pt2, pt3);
612 static void hhcurveto (ENV &env, PARAM& param)
615 point_t pt1 = env.get_pt ();
616 if ((env.argStack.get_count () & 1) != 0)
617 pt1.move_y (env.eval_arg (i++));
618 for (; i + 4 <= env.argStack.get_count (); i += 4)
620 pt1.move_x (env.eval_arg (i));
622 pt2.move (env.eval_arg (i+1), env.eval_arg (i+2));
624 pt3.move_x (env.eval_arg (i+3));
625 PATH::curve (env, param, pt1, pt2, pt3);
630 static void vhcurveto (ENV &env, PARAM& param)
632 point_t pt1, pt2, pt3;
634 if ((env.argStack.get_count () % 8) >= 4)
636 point_t pt1 = env.get_pt ();
637 pt1.move_y (env.eval_arg (i));
639 pt2.move (env.eval_arg (i+1), env.eval_arg (i+2));
641 pt3.move_x (env.eval_arg (i+3));
644 for (; i + 8 <= env.argStack.get_count (); i += 8)
646 PATH::curve (env, param, pt1, pt2, pt3);
648 pt1.move_x (env.eval_arg (i));
650 pt2.move (env.eval_arg (i+1), env.eval_arg (i+2));
652 pt3.move_y (env.eval_arg (i+3));
653 PATH::curve (env, param, pt1, pt2, pt3);
656 pt1.move_y (env.eval_arg (i+4));
658 pt2.move (env.eval_arg (i+5), env.eval_arg (i+6));
660 pt3.move_x (env.eval_arg (i+7));
662 if (i < env.argStack.get_count ())
663 pt3.move_y (env.eval_arg (i));
664 PATH::curve (env, param, pt1, pt2, pt3);
668 for (; i + 8 <= env.argStack.get_count (); i += 8)
671 pt1.move_y (env.eval_arg (i));
673 pt2.move (env.eval_arg (i+1), env.eval_arg (i+2));
675 pt3.move_x (env.eval_arg (i+3));
676 PATH::curve (env, param, pt1, pt2, pt3);
679 pt1.move_x (env.eval_arg (i+4));
681 pt2.move (env.eval_arg (i+5), env.eval_arg (i+6));
683 pt3.move_y (env.eval_arg (i+7));
684 if ((env.argStack.get_count () - i < 16) && ((env.argStack.get_count () & 1) != 0))
685 pt3.move_x (env.eval_arg (i+8));
686 PATH::curve (env, param, pt1, pt2, pt3);
691 static void hvcurveto (ENV &env, PARAM& param)
693 point_t pt1, pt2, pt3;
695 if ((env.argStack.get_count () % 8) >= 4)
697 point_t pt1 = env.get_pt ();
698 pt1.move_x (env.eval_arg (i));
700 pt2.move (env.eval_arg (i+1), env.eval_arg (i+2));
702 pt3.move_y (env.eval_arg (i+3));
705 for (; i + 8 <= env.argStack.get_count (); i += 8)
707 PATH::curve (env, param, pt1, pt2, pt3);
709 pt1.move_y (env.eval_arg (i));
711 pt2.move (env.eval_arg (i+1), env.eval_arg (i+2));
713 pt3.move_x (env.eval_arg (i+3));
714 PATH::curve (env, param, pt1, pt2, pt3);
717 pt1.move_x (env.eval_arg (i+4));
719 pt2.move (env.eval_arg (i+5), env.eval_arg (i+6));
721 pt3.move_y (env.eval_arg (i+7));
723 if (i < env.argStack.get_count ())
724 pt3.move_x (env.eval_arg (i));
725 PATH::curve (env, param, pt1, pt2, pt3);
729 for (; i + 8 <= env.argStack.get_count (); i += 8)
732 pt1.move_x (env.eval_arg (i));
734 pt2.move (env.eval_arg (i+1), env.eval_arg (i+2));
736 pt3.move_y (env.eval_arg (i+3));
737 PATH::curve (env, param, pt1, pt2, pt3);
740 pt1.move_y (env.eval_arg (i+4));
742 pt2.move (env.eval_arg (i+5), env.eval_arg (i+6));
744 pt3.move_x (env.eval_arg (i+7));
745 if ((env.argStack.get_count () - i < 16) && ((env.argStack.get_count () & 1) != 0))
746 pt3.move_y (env.eval_arg (i+8));
747 PATH::curve (env, param, pt1, pt2, pt3);
752 /* default actions to be overridden */
753 static void moveto (ENV &env, PARAM& param, const point_t &pt)
756 static void line (ENV &env, PARAM& param, const point_t &pt1)
757 { PATH::moveto (env, param, pt1); }
759 static void curve (ENV &env, PARAM& param, const point_t &pt1, const point_t &pt2, const point_t &pt3)
760 { PATH::moveto (env, param, pt3); }
762 static void hflex (ENV &env, PARAM& param)
764 if (likely (env.argStack.get_count () == 7))
766 point_t pt1 = env.get_pt ();
767 pt1.move_x (env.eval_arg (0));
769 pt2.move (env.eval_arg (1), env.eval_arg (2));
771 pt3.move_x (env.eval_arg (3));
773 pt4.move_x (env.eval_arg (4));
775 pt5.move_x (env.eval_arg (5));
778 pt6.move_x (env.eval_arg (6));
780 curve2 (env, param, pt1, pt2, pt3, pt4, pt5, pt6);
786 static void flex (ENV &env, PARAM& param)
788 if (likely (env.argStack.get_count () == 13))
790 point_t pt1 = env.get_pt ();
791 pt1.move (env.eval_arg (0), env.eval_arg (1));
793 pt2.move (env.eval_arg (2), env.eval_arg (3));
795 pt3.move (env.eval_arg (4), env.eval_arg (5));
797 pt4.move (env.eval_arg (6), env.eval_arg (7));
799 pt5.move (env.eval_arg (8), env.eval_arg (9));
801 pt6.move (env.eval_arg (10), env.eval_arg (11));
803 curve2 (env, param, pt1, pt2, pt3, pt4, pt5, pt6);
809 static void hflex1 (ENV &env, PARAM& param)
811 if (likely (env.argStack.get_count () == 9))
813 point_t pt1 = env.get_pt ();
814 pt1.move (env.eval_arg (0), env.eval_arg (1));
816 pt2.move (env.eval_arg (2), env.eval_arg (3));
818 pt3.move_x (env.eval_arg (4));
820 pt4.move_x (env.eval_arg (5));
822 pt5.move (env.eval_arg (6), env.eval_arg (7));
824 pt6.move_x (env.eval_arg (8));
825 pt6.y = env.get_pt ().y;
827 curve2 (env, param, pt1, pt2, pt3, pt4, pt5, pt6);
833 static void flex1 (ENV &env, PARAM& param)
835 if (likely (env.argStack.get_count () == 11))
839 for (unsigned int i = 0; i < 10; i += 2)
840 d.move (env.eval_arg (i), env.eval_arg (i+1));
842 point_t pt1 = env.get_pt ();
843 pt1.move (env.eval_arg (0), env.eval_arg (1));
845 pt2.move (env.eval_arg (2), env.eval_arg (3));
847 pt3.move (env.eval_arg (4), env.eval_arg (5));
849 pt4.move (env.eval_arg (6), env.eval_arg (7));
851 pt5.move (env.eval_arg (8), env.eval_arg (9));
854 if (fabs (d.x.to_real ()) > fabs (d.y.to_real ()))
856 pt6.move_x (env.eval_arg (10));
857 pt6.y = env.get_pt ().y;
861 pt6.x = env.get_pt ().x;
862 pt6.move_y (env.eval_arg (10));
865 curve2 (env, param, pt1, pt2, pt3, pt4, pt5, pt6);
872 static void curve2 (ENV &env, PARAM& param,
873 const point_t &pt1, const point_t &pt2, const point_t &pt3,
874 const point_t &pt4, const point_t &pt5, const point_t &pt6)
876 PATH::curve (env, param, pt1, pt2, pt3);
877 PATH::curve (env, param, pt4, pt5, pt6);
881 template <typename ENV, typename OPSET, typename PARAM>
882 struct cs_interpreter_t : interpreter_t<ENV>
884 bool interpret (PARAM& param)
886 SUPER::env.set_endchar (false);
889 OPSET::process_op (SUPER::env.fetch_op (), SUPER::env, param);
890 if (unlikely (SUPER::env.in_error ()))
892 if (SUPER::env.is_endchar ())
900 typedef interpreter_t<ENV> SUPER;
903 } /* namespace CFF */
905 #endif /* HB_CFF_INTERP_CS_COMMON_HH */