[perl5.git] / cop.h

/*    cop.h
 *
 *    Copyright (c) 1991-1999, Larry Wall
 *
 *    You may distribute under the terms of either the GNU General Public
 *    License or the Artistic License, as specified in the README file.
 *
 */

struct cop {
    BASEOP
    char *	cop_label;	/* label for this construct */
    HV *	cop_stash;	/* package line was compiled in */
    GV *	cop_filegv;	/* file the following line # is from */
    U32		cop_seq;	/* parse sequence number */
    I32		cop_arybase;	/* array base this line was compiled with */
    line_t      cop_line;       /* line # of this command */
    SV *	cop_warnings;	/* lexical warnings bitmask */
};

#define Nullcop Null(COP*)

/*
 * Here we have some enormously heavy (or at least ponderous) wizardry.
 */

/* subroutine context */
struct block_sub {
    CV *	cv;
    GV *	gv;
    GV *	dfoutgv;
#ifndef USE_THREADS
    AV *	savearray;
#endif /* USE_THREADS */
    AV *	argarray;
    U16		olddepth;
    U8		hasargs;
    U8		lval;		/* XXX merge lval and hasargs? */
};

#define PUSHSUB(cx)							\
	cx->blk_sub.cv = cv;						\
	cx->blk_sub.olddepth = CvDEPTH(cv);				\
	cx->blk_sub.hasargs = hasargs;					\
	cx->blk_sub.lval = PL_op->op_private &                          \
	                      (OPpLVAL_INTRO|OPpENTERSUB_INARGS);

#define PUSHFORMAT(cx)							\
	cx->blk_sub.cv = cv;						\
	cx->blk_sub.gv = gv;						\
	cx->blk_sub.hasargs = 0;					\
	cx->blk_sub.dfoutgv = PL_defoutgv;				\
	(void)SvREFCNT_inc(cx->blk_sub.dfoutgv)

#define POPSUB(cx)							\
	{ struct block_sub cxsub;					\
	  POPSUB1(cx);							\
	  POPSUB2(); }

#define POPSUB1(cx)							\
	cxsub = cx->blk_sub;	/* because DESTROY may clobber *cx */

#ifdef USE_THREADS
#define POPSAVEARRAY() NOOP
#else
#define POPSAVEARRAY()							\
    STMT_START {							\
	SvREFCNT_dec(GvAV(PL_defgv));					\
	GvAV(PL_defgv) = cxsub.savearray;				\
    } STMT_END
#endif /* USE_THREADS */

#define POPSUB2()							\
	if (cxsub.hasargs) {						\
	    POPSAVEARRAY();						\
	    /* abandon @_ if it got reified */				\
	    if (AvREAL(cxsub.argarray)) {				\
		SSize_t fill = AvFILLp(cxsub.argarray);			\
		SvREFCNT_dec(cxsub.argarray);				\
		cxsub.argarray = newAV();				\
		av_extend(cxsub.argarray, fill);			\
		AvFLAGS(cxsub.argarray) = AVf_REIFY;			\
		PL_curpad[0] = (SV*)cxsub.argarray;			\
	    }								\
	}								\
	if (cxsub.cv) {							\
	    if (!(CvDEPTH(cxsub.cv) = cxsub.olddepth))			\
		SvREFCNT_dec(cxsub.cv);					\
	}

#define POPFORMAT(cx)							\
	setdefout(cx->blk_sub.dfoutgv);					\
	SvREFCNT_dec(cx->blk_sub.dfoutgv);

/* eval context */
struct block_eval {
    I32		old_in_eval;
    I32		old_op_type;
    char *	old_name;
    OP *	old_eval_root;
    SV *	cur_text;
};

#define PUSHEVAL(cx,n,fgv)						\
	cx->blk_eval.old_in_eval = PL_in_eval;				\
	cx->blk_eval.old_op_type = PL_op->op_type;				\
	cx->blk_eval.old_name = n;					\
	cx->blk_eval.old_eval_root = PL_eval_root;				\
	cx->blk_eval.cur_text = PL_linestr;

#define POPEVAL(cx)							\
	PL_in_eval = cx->blk_eval.old_in_eval;				\
	optype = cx->blk_eval.old_op_type;				\
	PL_eval_root = cx->blk_eval.old_eval_root;

/* loop context */
struct block_loop {
    char *	label;
    I32		resetsp;
    OP *	redo_op;
    OP *	next_op;
    OP *	last_op;
    SV **	itervar;
    SV *	itersave;
    SV *	iterlval;
    AV *	iterary;
    IV		iterix;
    IV		itermax;
};

#define PUSHLOOP(cx, ivar, s)						\
	cx->blk_loop.label = PL_curcop->cop_label;				\
	cx->blk_loop.resetsp = s - PL_stack_base;				\
	cx->blk_loop.redo_op = cLOOP->op_redoop;			\
	cx->blk_loop.next_op = cLOOP->op_nextop;			\
	cx->blk_loop.last_op = cLOOP->op_lastop;			\
	if (cx->blk_loop.itervar = (ivar))				\
	    cx->blk_loop.itersave = SvREFCNT_inc(*cx->blk_loop.itervar);\
	cx->blk_loop.iterlval = Nullsv;					\
	cx->blk_loop.iterary = Nullav;					\
	cx->blk_loop.iterix = -1;

#define POPLOOP(cx)							\
	{ struct block_loop cxloop;					\
	  POPLOOP1(cx);							\
	  POPLOOP2(); }

#define POPLOOP1(cx)							\
	cxloop = cx->blk_loop;	/* because DESTROY may clobber *cx */	\
	newsp = PL_stack_base + cxloop.resetsp;

#define POPLOOP2()							\
	SvREFCNT_dec(cxloop.iterlval);					\
	if (cxloop.itervar) {						\
	    sv_2mortal(*cxloop.itervar);				\
	    *cxloop.itervar = cxloop.itersave;				\
	}								\
	if (cxloop.iterary && cxloop.iterary != PL_curstack)		\
	    SvREFCNT_dec(cxloop.iterary);

/* context common to subroutines, evals and loops */
struct block {
    I32		blku_oldsp;	/* stack pointer to copy stuff down to */
    COP *	blku_oldcop;	/* old curcop pointer */
    I32		blku_oldretsp;	/* return stack index */
    I32		blku_oldmarksp;	/* mark stack index */
    I32		blku_oldscopesp;	/* scope stack index */
    PMOP *	blku_oldpm;	/* values of pattern match vars */
    U8		blku_gimme;	/* is this block running in list context? */

    union {
	struct block_sub	blku_sub;
	struct block_eval	blku_eval;
	struct block_loop	blku_loop;
    } blk_u;
};
#define blk_oldsp	cx_u.cx_blk.blku_oldsp
#define blk_oldcop	cx_u.cx_blk.blku_oldcop
#define blk_oldretsp	cx_u.cx_blk.blku_oldretsp
#define blk_oldmarksp	cx_u.cx_blk.blku_oldmarksp
#define blk_oldscopesp	cx_u.cx_blk.blku_oldscopesp
#define blk_oldpm	cx_u.cx_blk.blku_oldpm
#define blk_gimme	cx_u.cx_blk.blku_gimme
#define blk_sub		cx_u.cx_blk.blk_u.blku_sub
#define blk_eval	cx_u.cx_blk.blk_u.blku_eval
#define blk_loop	cx_u.cx_blk.blk_u.blku_loop

/* Enter a block. */
#define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix],		\
	cx->cx_type		= t,					\
	cx->blk_oldsp		= sp - PL_stack_base,			\
	cx->blk_oldcop		= PL_curcop,				\
	cx->blk_oldmarksp	= PL_markstack_ptr - PL_markstack,	\
	cx->blk_oldscopesp	= PL_scopestack_ix,			\
	cx->blk_oldretsp	= PL_retstack_ix,			\
	cx->blk_oldpm		= PL_curpm,				\
	cx->blk_gimme		= gimme;				\
	DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n",	\
		    (long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )

/* Exit a block (RETURN and LAST). */
#define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--],			\
	newsp		 = PL_stack_base + cx->blk_oldsp,		\
	PL_curcop	 = cx->blk_oldcop,				\
	PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp,		\
	PL_scopestack_ix = cx->blk_oldscopesp,				\
	PL_retstack_ix	 = cx->blk_oldretsp,				\
	pm		 = cx->blk_oldpm,				\
	gimme		 = cx->blk_gimme;				\
	DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n",		\
		    (long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )

/* Continue a block elsewhere (NEXT and REDO). */
#define TOPBLOCK(cx) cx  = &cxstack[cxstack_ix],			\
	PL_stack_sp	 = PL_stack_base + cx->blk_oldsp,		\
	PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp,		\
	PL_scopestack_ix = cx->blk_oldscopesp,				\
	PL_retstack_ix	 = cx->blk_oldretsp,				\
	PL_curpm         = cx->blk_oldpm

/* substitution context */
struct subst {
    I32		sbu_iters;
    I32		sbu_maxiters;
    I32		sbu_rflags;
    I32		sbu_oldsave;
    bool	sbu_once;
    bool	sbu_rxtainted;
    char *	sbu_orig;
    SV *	sbu_dstr;
    SV *	sbu_targ;
    char *	sbu_s;
    char *	sbu_m;
    char *	sbu_strend;
    void *	sbu_rxres;
    REGEXP *	sbu_rx;
};
#define sb_iters	cx_u.cx_subst.sbu_iters
#define sb_maxiters	cx_u.cx_subst.sbu_maxiters
#define sb_rflags	cx_u.cx_subst.sbu_rflags
#define sb_oldsave	cx_u.cx_subst.sbu_oldsave
#define sb_once		cx_u.cx_subst.sbu_once
#define sb_rxtainted	cx_u.cx_subst.sbu_rxtainted
#define sb_orig		cx_u.cx_subst.sbu_orig
#define sb_dstr		cx_u.cx_subst.sbu_dstr
#define sb_targ		cx_u.cx_subst.sbu_targ
#define sb_s		cx_u.cx_subst.sbu_s
#define sb_m		cx_u.cx_subst.sbu_m
#define sb_strend	cx_u.cx_subst.sbu_strend
#define sb_rxres	cx_u.cx_subst.sbu_rxres
#define sb_rx		cx_u.cx_subst.sbu_rx

#define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix],			\
	cx->sb_iters		= iters,				\
	cx->sb_maxiters		= maxiters,				\
	cx->sb_rflags		= r_flags,				\
	cx->sb_oldsave		= oldsave,				\
	cx->sb_once		= once,					\
	cx->sb_rxtainted	= rxtainted,				\
	cx->sb_orig		= orig,					\
	cx->sb_dstr		= dstr,					\
	cx->sb_targ		= targ,					\
	cx->sb_s		= s,					\
	cx->sb_m		= m,					\
	cx->sb_strend		= strend,				\
	cx->sb_rxres		= Null(void*),				\
	cx->sb_rx		= rx,					\
	cx->cx_type		= CXt_SUBST;				\
	rxres_save(&cx->sb_rxres, rx)

#define POPSUBST(cx) cx = &cxstack[cxstack_ix--];			\
	rxres_free(&cx->sb_rxres)

struct context {
    U32		cx_type;	/* what kind of context this is */
    union {
	struct block	cx_blk;
	struct subst	cx_subst;
    } cx_u;
};

#define CXTYPEMASK	0xff
#define CXt_NULL	0
#define CXt_SUB		1
#define CXt_EVAL	2
#define CXt_LOOP	3
#define CXt_SUBST	4
#define CXt_BLOCK	5

/* private flags for CXt_EVAL */
#define CXp_REAL	0x00000100	/* truly eval'', not a lookalike */

#define CxTYPE(c)	((c)->cx_type & CXTYPEMASK)
#define CxREALEVAL(c)	(((c)->cx_type & (CXt_EVAL|CXp_REAL)) == (CXt_EVAL|CXp_REAL))

#define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))

/* "gimme" values */
#define G_SCALAR	0
#define G_ARRAY		1
#define G_VOID		128	/* skip this bit when adding flags below */

/* extra flags for Perl_call_* routines */
#define G_DISCARD	2	/* Call FREETMPS. */
#define G_EVAL		4	/* Assume eval {} around subroutine call. */
#define G_NOARGS	8	/* Don't construct a @_ array. */
#define G_KEEPERR      16	/* Append errors to $@, don't overwrite it */
#define G_NODEBUG      32	/* Disable debugging at toplevel.  */
#define G_NOCATCH      64       /* Don't do CATCH_SET() */

/* flag bits for PL_in_eval */
#define EVAL_NULL	0	/* not in an eval */
#define EVAL_INEVAL	1	/* some enclosing scope is an eval */
#define EVAL_WARNONLY	2	/* used by yywarn() when calling yyerror() */
#define EVAL_KEEPERR	4	/* set by Perl_call_sv if G_KEEPERR */

/* Support for switching (stack and block) contexts.
 * This ensures magic doesn't invalidate local stack and cx pointers.
 */

#define PERLSI_UNKNOWN		-1
#define PERLSI_UNDEF		0
#define PERLSI_MAIN		1
#define PERLSI_MAGIC		2
#define PERLSI_SORT		3
#define PERLSI_SIGNAL		4
#define PERLSI_OVERLOAD		5
#define PERLSI_DESTROY		6
#define PERLSI_WARNHOOK		7
#define PERLSI_DIEHOOK		8
#define PERLSI_REQUIRE		9

struct stackinfo {
    AV *		si_stack;	/* stack for current runlevel */
    PERL_CONTEXT *	si_cxstack;	/* context stack for runlevel */
    I32			si_cxix;	/* current context index */
    I32			si_cxmax;	/* maximum allocated index */
    I32			si_type;	/* type of runlevel */
    struct stackinfo *	si_prev;
    struct stackinfo *	si_next;
    I32 *		si_markbase;	/* where markstack begins for us.
					 * currently used only with DEBUGGING,
					 * but not #ifdef-ed for bincompat */
};

typedef struct stackinfo PERL_SI;

#define cxstack		(PL_curstackinfo->si_cxstack)
#define cxstack_ix	(PL_curstackinfo->si_cxix)
#define cxstack_max	(PL_curstackinfo->si_cxmax)

#ifdef DEBUGGING
#  define	SET_MARKBASE PL_curstackinfo->si_markbase = PL_markstack_ptr
#else
#  define	SET_MARKBASE NOOP
#endif

#define PUSHSTACKi(type) \
    STMT_START {							\
	PERL_SI *next = PL_curstackinfo->si_next;			\
	if (!next) {							\
	    next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1);	\
	    next->si_prev = PL_curstackinfo;				\
	    PL_curstackinfo->si_next = next;				\
	}								\
	next->si_type = type;						\
	next->si_cxix = -1;						\
	AvFILLp(next->si_stack) = 0;					\
	SWITCHSTACK(PL_curstack,next->si_stack);			\
	PL_curstackinfo = next;						\
	SET_MARKBASE;							\
    } STMT_END

#define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)

/* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
 * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
#define POPSTACK \
    STMT_START {							\
	djSP;								\
	PERL_SI *prev = PL_curstackinfo->si_prev;			\
	if (!prev) {							\
	    PerlIO_printf(Perl_error_log, "panic: POPSTACK\n");		\
	    my_exit(1);							\
	}								\
	SWITCHSTACK(PL_curstack,prev->si_stack);			\
	/* don't free prev here, free them all at the END{} */		\
	PL_curstackinfo = prev;						\
    } STMT_END

#define POPSTACK_TO(s) \
    STMT_START {							\
	while (PL_curstack != s) {					\
	    dounwind(-1);						\
	    POPSTACK;							\
	}								\
    } STMT_END
Commit	Line	Data
a0d0e21e	1	/* cop.h
79072805	2	*
4eb8286e	3	* Copyright (c) 1991-1999, Larry Wall
79072805 LW	4	*
	5	* You may distribute under the terms of either the GNU General Public
	6	* License or the Artistic License, as specified in the README file.
	7	*
79072805 LW	8	*/
79072805 LW	9
79072805 LW	10	struct cop {
79072805 LW	11	BASEOP
a0d0e21e	12	char * cop_label; /* label for this construct */
79072805 LW	13	HV * cop_stash; /* package line was compiled in */
79072805 LW	14	GV * cop_filegv; /* file the following line # is from */
a0d0e21e LW	15	U32 cop_seq; /* parse sequence number */
a0d0e21e LW	16	I32 cop_arybase; /* array base this line was compiled with */
79072805	17	line_t cop_line; /* line # of this command */
599cee73	18	SV * cop_warnings; /* lexical warnings bitmask */
79072805 LW	19	};
	20
	21	#define Nullcop Null(COP*)
	22
	23	/*
	24	* Here we have some enormously heavy (or at least ponderous) wizardry.
	25	*/
	26
	27	/* subroutine context */
	28	struct block_sub {
	29	CV * cv;
	30	GV * gv;
463ee0b2	31	GV * dfoutgv;
6d4ff0d2	32	#ifndef USE_THREADS
79072805	33	AV * savearray;
6d4ff0d2	34	#endif /* USE_THREADS */
79072805 LW	35	AV * argarray;
	36	U16 olddepth;
	37	U8 hasargs;
cd06dffe	38	U8 lval; /* XXX merge lval and hasargs? */
79072805 LW	39	};
	40
	41	#define PUSHSUB(cx) \
	42	cx->blk_sub.cv = cv; \
79072805	43	cx->blk_sub.olddepth = CvDEPTH(cv); \
cd06dffe GS	44	cx->blk_sub.hasargs = hasargs; \
	45	cx->blk_sub.lval = PL_op->op_private & \
	46	(OPpLVAL_INTRO\|OPpENTERSUB_INARGS);
79072805 LW	47
	48	#define PUSHFORMAT(cx) \
	49	cx->blk_sub.cv = cv; \
	50	cx->blk_sub.gv = gv; \
4633a7c4	51	cx->blk_sub.hasargs = 0; \
3280af22	52	cx->blk_sub.dfoutgv = PL_defoutgv; \
4633a7c4	53	(void)SvREFCNT_inc(cx->blk_sub.dfoutgv)
79072805 LW	54
79072805 LW	55	#define POPSUB(cx) \
f86702cc	56	{ struct block_sub cxsub; \
	57	POPSUB1(cx); \
	58	POPSUB2(); }
	59
	60	#define POPSUB1(cx) \
	61	cxsub = cx->blk_sub; /* because DESTROY may clobber cx /
	62
6d4ff0d2 MB	63	#ifdef USE_THREADS
	64	#define POPSAVEARRAY() NOOP
	65	#else
	66	#define POPSAVEARRAY() \
	67	STMT_START { \
3280af22	68	SvREFCNT_dec(GvAV(PL_defgv)); \
d8b46c1b	69	GvAV(PL_defgv) = cxsub.savearray; \
6d4ff0d2 MB	70	} STMT_END
	71	#endif /* USE_THREADS */
	72
f86702cc	73	#define POPSUB2() \
f86702cc	74	if (cxsub.hasargs) { \
6d4ff0d2	75	POPSAVEARRAY(); \
d8b46c1b GS	76	/* abandon @_ if it got reified */ \
	77	if (AvREAL(cxsub.argarray)) { \
	78	SSize_t fill = AvFILLp(cxsub.argarray); \
	79	SvREFCNT_dec(cxsub.argarray); \
	80	cxsub.argarray = newAV(); \
	81	av_extend(cxsub.argarray, fill); \
	82	AvFLAGS(cxsub.argarray) = AVf_REIFY; \
	83	PL_curpad[0] = (SV*)cxsub.argarray; \
	84	} \
79072805	85	} \
f86702cc	86	if (cxsub.cv) { \
	87	if (!(CvDEPTH(cxsub.cv) = cxsub.olddepth)) \
	88	SvREFCNT_dec(cxsub.cv); \
79072805 LW	89	}
	90
	91	#define POPFORMAT(cx) \
4633a7c4 LW	92	setdefout(cx->blk_sub.dfoutgv); \
4633a7c4 LW	93	SvREFCNT_dec(cx->blk_sub.dfoutgv);
79072805 LW	94
	95	/* eval context */
	96	struct block_eval {
	97	I32 old_in_eval;
	98	I32 old_op_type;
	99	char * old_name;
	100	OP * old_eval_root;
748a9306	101	SV * cur_text;
79072805 LW	102	};
79072805 LW	103
8990e307	104	#define PUSHEVAL(cx,n,fgv) \
3280af22	105	cx->blk_eval.old_in_eval = PL_in_eval; \
533c011a	106	cx->blk_eval.old_op_type = PL_op->op_type; \
79072805	107	cx->blk_eval.old_name = n; \
3280af22 NIS	108	cx->blk_eval.old_eval_root = PL_eval_root; \
3280af22 NIS	109	cx->blk_eval.cur_text = PL_linestr;
79072805 LW	110
79072805 LW	111	#define POPEVAL(cx) \
3280af22	112	PL_in_eval = cx->blk_eval.old_in_eval; \
79072805	113	optype = cx->blk_eval.old_op_type; \
3280af22	114	PL_eval_root = cx->blk_eval.old_eval_root;
79072805 LW	115
	116	/* loop context */
	117	struct block_loop {
	118	char * label;
	119	I32 resetsp;
	120	OP * redo_op;
	121	OP * next_op;
	122	OP * last_op;
	123	SV ** itervar;
	124	SV * itersave;
5f05dabc	125	SV * iterlval;
79072805	126	AV * iterary;
89ea2908 GA	127	IV iterix;
89ea2908 GA	128	IV itermax;
79072805 LW	129	};
	130
	131	#define PUSHLOOP(cx, ivar, s) \
3280af22 NIS	132	cx->blk_loop.label = PL_curcop->cop_label; \
3280af22 NIS	133	cx->blk_loop.resetsp = s - PL_stack_base; \
79072805 LW	134	cx->blk_loop.redo_op = cLOOP->op_redoop; \
	135	cx->blk_loop.next_op = cLOOP->op_nextop; \
	136	cx->blk_loop.last_op = cLOOP->op_lastop; \
7a4c00b4	137	if (cx->blk_loop.itervar = (ivar)) \
44a8e56a	138	cx->blk_loop.itersave = SvREFCNT_inc(*cx->blk_loop.itervar);\
	139	cx->blk_loop.iterlval = Nullsv; \
	140	cx->blk_loop.iterary = Nullav; \
	141	cx->blk_loop.iterix = -1;
79072805 LW	142
79072805 LW	143	#define POPLOOP(cx) \
f86702cc	144	{ struct block_loop cxloop; \
	145	POPLOOP1(cx); \
	146	POPLOOP2(); }
	147
	148	#define POPLOOP1(cx) \
4fdae800	149	cxloop = cx->blk_loop; /* because DESTROY may clobber cx / \
3280af22	150	newsp = PL_stack_base + cxloop.resetsp;
f86702cc	151
f86702cc	152	#define POPLOOP2() \
f86702cc	153	SvREFCNT_dec(cxloop.iterlval); \
f86702cc	154	if (cxloop.itervar) { \
8bb77e1d	155	sv_2mortal(*cxloop.itervar); \
f86702cc	156	*cxloop.itervar = cxloop.itersave; \
44a8e56a	157	} \
3280af22	158	if (cxloop.iterary && cxloop.iterary != PL_curstack) \
f86702cc	159	SvREFCNT_dec(cxloop.iterary);
79072805 LW	160
	161	/* context common to subroutines, evals and loops */
	162	struct block {
	163	I32 blku_oldsp; /* stack pointer to copy stuff down to */
	164	COP * blku_oldcop; /* old curcop pointer */
	165	I32 blku_oldretsp; /* return stack index */
	166	I32 blku_oldmarksp; /* mark stack index */
	167	I32 blku_oldscopesp; /* scope stack index */
	168	PMOP * blku_oldpm; /* values of pattern match vars */
	169	U8 blku_gimme; /* is this block running in list context? */
	170
	171	union {
	172	struct block_sub blku_sub;
	173	struct block_eval blku_eval;
	174	struct block_loop blku_loop;
	175	} blk_u;
	176	};
	177	#define blk_oldsp cx_u.cx_blk.blku_oldsp
	178	#define blk_oldcop cx_u.cx_blk.blku_oldcop
	179	#define blk_oldretsp cx_u.cx_blk.blku_oldretsp
	180	#define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
	181	#define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
	182	#define blk_oldpm cx_u.cx_blk.blku_oldpm
	183	#define blk_gimme cx_u.cx_blk.blku_gimme
	184	#define blk_sub cx_u.cx_blk.blk_u.blku_sub
	185	#define blk_eval cx_u.cx_blk.blk_u.blku_eval
	186	#define blk_loop cx_u.cx_blk.blk_u.blku_loop
	187
	188	/* Enter a block. */
8990e307	189	#define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix], \
79072805	190	cx->cx_type = t, \
3280af22 NIS	191	cx->blk_oldsp = sp - PL_stack_base, \
3280af22 NIS	192	cx->blk_oldcop = PL_curcop, \
1aff0e91	193	cx->blk_oldmarksp = PL_markstack_ptr - PL_markstack, \
3280af22	194	cx->blk_oldscopesp = PL_scopestack_ix, \
1aff0e91	195	cx->blk_oldretsp = PL_retstack_ix, \
3280af22	196	cx->blk_oldpm = PL_curpm, \
79072805	197	cx->blk_gimme = gimme; \
bf49b057	198	DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \
1aff0e91	199	(long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )
79072805 LW	200
79072805 LW	201	/* Exit a block (RETURN and LAST). */
a0d0e21e	202	#define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--], \
1aff0e91	203	newsp = PL_stack_base + cx->blk_oldsp, \
3280af22 NIS	204	PL_curcop = cx->blk_oldcop, \
	205	PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
	206	PL_scopestack_ix = cx->blk_oldscopesp, \
	207	PL_retstack_ix = cx->blk_oldretsp, \
	208	pm = cx->blk_oldpm, \
	209	gimme = cx->blk_gimme; \
bf49b057	210	DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n", \
22c35a8c	211	(long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )
79072805 LW	212
79072805 LW	213	/* Continue a block elsewhere (NEXT and REDO). */
3280af22	214	#define TOPBLOCK(cx) cx = &cxstack[cxstack_ix], \
1aff0e91	215	PL_stack_sp = PL_stack_base + cx->blk_oldsp, \
3280af22 NIS	216	PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
3280af22 NIS	217	PL_scopestack_ix = cx->blk_oldscopesp, \
2158dd9b GS	218	PL_retstack_ix = cx->blk_oldretsp, \
2158dd9b GS	219	PL_curpm = cx->blk_oldpm
79072805 LW	220
	221	/* substitution context */
	222	struct subst {
	223	I32 sbu_iters;
	224	I32 sbu_maxiters;
22e551b9	225	I32 sbu_rflags;
4633a7c4	226	I32 sbu_oldsave;
71be2cbc	227	bool sbu_once;
71be2cbc	228	bool sbu_rxtainted;
79072805 LW	229	char * sbu_orig;
	230	SV * sbu_dstr;
	231	SV * sbu_targ;
	232	char * sbu_s;
	233	char * sbu_m;
	234	char * sbu_strend;
c90c0ff4	235	void * sbu_rxres;
c07a80fd	236	REGEXP * sbu_rx;
79072805 LW	237	};
	238	#define sb_iters cx_u.cx_subst.sbu_iters
	239	#define sb_maxiters cx_u.cx_subst.sbu_maxiters
22e551b9	240	#define sb_rflags cx_u.cx_subst.sbu_rflags
4633a7c4	241	#define sb_oldsave cx_u.cx_subst.sbu_oldsave
71be2cbc	242	#define sb_once cx_u.cx_subst.sbu_once
71be2cbc	243	#define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
79072805 LW	244	#define sb_orig cx_u.cx_subst.sbu_orig
	245	#define sb_dstr cx_u.cx_subst.sbu_dstr
	246	#define sb_targ cx_u.cx_subst.sbu_targ
	247	#define sb_s cx_u.cx_subst.sbu_s
	248	#define sb_m cx_u.cx_subst.sbu_m
	249	#define sb_strend cx_u.cx_subst.sbu_strend
c90c0ff4	250	#define sb_rxres cx_u.cx_subst.sbu_rxres
c07a80fd	251	#define sb_rx cx_u.cx_subst.sbu_rx
79072805 LW	252
	253	#define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix], \
	254	cx->sb_iters = iters, \
	255	cx->sb_maxiters = maxiters, \
22e551b9	256	cx->sb_rflags = r_flags, \
4633a7c4	257	cx->sb_oldsave = oldsave, \
71be2cbc	258	cx->sb_once = once, \
71be2cbc	259	cx->sb_rxtainted = rxtainted, \
79072805 LW	260	cx->sb_orig = orig, \
	261	cx->sb_dstr = dstr, \
	262	cx->sb_targ = targ, \
	263	cx->sb_s = s, \
	264	cx->sb_m = m, \
	265	cx->sb_strend = strend, \
c90c0ff4	266	cx->sb_rxres = Null(void*), \
c07a80fd	267	cx->sb_rx = rx, \
c90c0ff4	268	cx->cx_type = CXt_SUBST; \
c90c0ff4	269	rxres_save(&cx->sb_rxres, rx)
79072805	270
c90c0ff4	271	#define POPSUBST(cx) cx = &cxstack[cxstack_ix--]; \
c90c0ff4	272	rxres_free(&cx->sb_rxres)
79072805 LW	273
79072805 LW	274	struct context {
6b35e009	275	U32 cx_type; /* what kind of context this is */
79072805 LW	276	union {
	277	struct block cx_blk;
	278	struct subst cx_subst;
	279	} cx_u;
	280	};
6b35e009 GS	281
6b35e009 GS	282	#define CXTYPEMASK 0xff
79072805 LW	283	#define CXt_NULL 0
	284	#define CXt_SUB 1
	285	#define CXt_EVAL 2
	286	#define CXt_LOOP 3
	287	#define CXt_SUBST 4
	288	#define CXt_BLOCK 5
	289
6b35e009 GS	290	/* private flags for CXt_EVAL */
	291	#define CXp_REAL 0x00000100 /* truly eval'', not a lookalike */
	292
	293	#define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
	294	#define CxREALEVAL(c) (((c)->cx_type & (CXt_EVAL\|CXp_REAL)) == (CXt_EVAL\|CXp_REAL))
	295
79072805 LW	296	#define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
	297
	298	/* "gimme" values */
a0d0e21e LW	299	#define G_SCALAR 0
a0d0e21e LW	300	#define G_ARRAY 1
54310121	301	#define G_VOID 128 /* skip this bit when adding flags below */
79072805	302
864dbfa3	303	/* extra flags for Perl_call_* routines */
a0d0e21e LW	304	#define G_DISCARD 2 /* Call FREETMPS. */
	305	#define G_EVAL 4 /* Assume eval {} around subroutine call. */
	306	#define G_NOARGS 8 /* Don't construct a @_ array. */
54310121	307	#define G_KEEPERR 16 /* Append errors to $@, don't overwrite it */
491527d0	308	#define G_NODEBUG 32 /* Disable debugging at toplevel. */
a7c6d244	309	#define G_NOCATCH 64 /* Don't do CATCH_SET() */
e336de0d	310
faef0170 HS	311	/* flag bits for PL_in_eval */
	312	#define EVAL_NULL 0 /* not in an eval */
	313	#define EVAL_INEVAL 1 /* some enclosing scope is an eval */
	314	#define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */
864dbfa3	315	#define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
faef0170	316
e336de0d GS	317	/* Support for switching (stack and block) contexts.
	318	* This ensures magic doesn't invalidate local stack and cx pointers.
	319	*/
	320
e788e7d3 GS	321	#define PERLSI_UNKNOWN -1
	322	#define PERLSI_UNDEF 0
	323	#define PERLSI_MAIN 1
	324	#define PERLSI_MAGIC 2
	325	#define PERLSI_SORT 3
	326	#define PERLSI_SIGNAL 4
	327	#define PERLSI_OVERLOAD 5
	328	#define PERLSI_DESTROY 6
	329	#define PERLSI_WARNHOOK 7
	330	#define PERLSI_DIEHOOK 8
	331	#define PERLSI_REQUIRE 9
e336de0d GS	332
	333	struct stackinfo {
	334	AV * si_stack; /* stack for current runlevel */
	335	PERL_CONTEXT * si_cxstack; /* context stack for runlevel */
	336	I32 si_cxix; /* current context index */
	337	I32 si_cxmax; /* maximum allocated index */
	338	I32 si_type; /* type of runlevel */
	339	struct stackinfo * si_prev;
	340	struct stackinfo * si_next;
	341	I32 * si_markbase; /* where markstack begins for us.
	342	* currently used only with DEBUGGING,
	343	* but not #ifdef-ed for bincompat */
	344	};
	345
	346	typedef struct stackinfo PERL_SI;
	347
3280af22 NIS	348	#define cxstack (PL_curstackinfo->si_cxstack)
	349	#define cxstack_ix (PL_curstackinfo->si_cxix)
	350	#define cxstack_max (PL_curstackinfo->si_cxmax)
e336de0d GS	351
e336de0d GS	352	#ifdef DEBUGGING
3280af22	353	# define SET_MARKBASE PL_curstackinfo->si_markbase = PL_markstack_ptr
e336de0d GS	354	#else
	355	# define SET_MARKBASE NOOP
	356	#endif
	357
d3acc0f7	358	#define PUSHSTACKi(type) \
e336de0d	359	STMT_START { \
3280af22	360	PERL_SI *next = PL_curstackinfo->si_next; \
e336de0d GS	361	if (!next) { \
e336de0d GS	362	next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
3280af22 NIS	363	next->si_prev = PL_curstackinfo; \
3280af22 NIS	364	PL_curstackinfo->si_next = next; \
e336de0d GS	365	} \
	366	next->si_type = type; \
	367	next->si_cxix = -1; \
	368	AvFILLp(next->si_stack) = 0; \
3280af22 NIS	369	SWITCHSTACK(PL_curstack,next->si_stack); \
3280af22 NIS	370	PL_curstackinfo = next; \
e336de0d GS	371	SET_MARKBASE; \
	372	} STMT_END
	373
e788e7d3	374	#define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
d3acc0f7	375
3095d977 GS	376	/* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
3095d977 GS	377	* PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
d3acc0f7	378	#define POPSTACK \
e336de0d	379	STMT_START { \
de616352	380	djSP; \
3280af22	381	PERL_SI *prev = PL_curstackinfo->si_prev; \
e336de0d	382	if (!prev) { \
bf49b057	383	PerlIO_printf(Perl_error_log, "panic: POPSTACK\n"); \
e336de0d GS	384	my_exit(1); \
e336de0d GS	385	} \
3280af22	386	SWITCHSTACK(PL_curstack,prev->si_stack); \
e336de0d	387	/* don't free prev here, free them all at the END{} */ \
3280af22	388	PL_curstackinfo = prev; \
e336de0d GS	389	} STMT_END
	390
	391	#define POPSTACK_TO(s) \
	392	STMT_START { \
3280af22	393	while (PL_curstack != s) { \
bac4b2ad	394	dounwind(-1); \
d3acc0f7	395	POPSTACK; \
bac4b2ad	396	} \
e336de0d	397	} STMT_END