[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 */
#ifdef USE_ITHREADS
    char *	cop_stashpv;	/* package line was compiled in */
    char *	cop_file;	/* file name the following line # is from */
#else
    HV *	cop_stash;	/* package line was compiled in */
    GV *	cop_filegv;	/* file the following line # is from */
#endif
    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*)

#ifdef USE_ITHREADS
#  define CopFILE(c)		((c)->cop_file)
#  define CopFILEGV(c)		(CopFILE(c) \
				 ? gv_fetchfile(CopFILE(c)) : Nullgv)
#  define CopFILE_set(c,pv)	((c)->cop_file = savepv(pv))	/* XXX */
#  define CopFILESV(c)		(CopFILE(c) \
				 ? GvSV(gv_fetchfile(CopFILE(c))) : Nullsv)
#  define CopFILEAV(c)		(CopFILE(c) \
				 ? GvAV(gv_fetchfile(CopFILE(c))) : Nullav)
#  define CopSTASHPV(c)		((c)->cop_stashpv)
#  define CopSTASHPV_set(c,pv)	((c)->cop_stashpv = savepv(pv))	/* XXX */
#  define CopSTASH(c)		(CopSTASHPV(c) \
				 ? gv_stashpv(CopSTASHPV(c),GV_ADD) : Nullhv)
#  define CopSTASH_set(c,hv)	CopSTASHPV_set(c, HvNAME(hv))
#  define CopSTASH_eq(c,hv)	(hv 					\
				 && (CopSTASHPV(c) == HvNAME(hv)	\
				     || (CopSTASHPV(c) && HvNAME(hv)	\
					 && strEQ(CopSTASHPV(c), HvNAME(hv)))))
#else
#  define CopFILEGV(c)		((c)->cop_filegv)
#  define CopFILEGV_set(c,gv)	((c)->cop_filegv = gv)
#  define CopFILE_set(c,pv)	((c)->cop_filegv = gv_fetchfile(pv))
#  define CopFILESV(c)		(CopFILEGV(c) ? GvSV(CopFILEGV(c)) : Nullsv)
#  define CopFILEAV(c)		(CopFILEGV(c) ? GvAV(CopFILEGV(c)) : Nullav)
#  define CopFILE(c)		(CopFILESV(c) ? SvPVX(CopFILESV(c)) : Nullch)
#  define CopSTASH(c)		((c)->cop_stash)
#  define CopSTASH_set(c,hv)	((c)->cop_stash = hv)
#  define CopSTASHPV(c)		(CopSTASH(c) ? HvNAME(CopSTASH(c)) : Nullch)
#  define CopSTASHPV_set(c,pv)	CopSTASH_set(c, gv_stashpv(pv,GV_ADD))
#  define CopSTASH_eq(c,hv)	(CopSTASH(c) == hv)
#endif /* USE_ITHREADS */

#define CopSTASH_ne(c,hv)	(!CopSTASH_eq(c,hv))
#define CopLINE(c)		((c)->cop_line)
#define CopLINE_inc(c)		(++CopLINE(c))
#define CopLINE_dec(c)		(--CopLINE(c))
#define CopLINE_set(c,l)	(CopLINE(c) = (l))

/*
 * 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)

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

#define POPSUB(cx,sv)							\
    STMT_START {							\
	if (cx->blk_sub.hasargs) {					\
	    POPSAVEARRAY();						\
	    /* abandon @_ if it got reified */				\
	    if (AvREAL(cx->blk_sub.argarray)) {				\
		SSize_t fill = AvFILLp(cx->blk_sub.argarray);		\
		SvREFCNT_dec(cx->blk_sub.argarray);			\
		cx->blk_sub.argarray = newAV();				\
		av_extend(cx->blk_sub.argarray, fill);			\
		AvFLAGS(cx->blk_sub.argarray) = AVf_REIFY;		\
		PL_curpad[0] = (SV*)cx->blk_sub.argarray;		\
	    }								\
	}								\
	sv = (SV*)cx->blk_sub.cv;					\
	if (sv && (CvDEPTH((CV*)sv) = cx->blk_sub.olddepth))		\
	    sv = Nullsv;						\
    } STMT_END

#define LEAVESUB(sv)							\
    STMT_START {							\
	if (sv)								\
	    SvREFCNT_dec(sv);						\
    } STMT_END

#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)							\
	SvREFCNT_dec(cx->blk_loop.iterlval);				\
	if (cx->blk_loop.itervar) {					\
	    sv_2mortal(*(cx->blk_loop.itervar));			\
	    *(cx->blk_loop.itervar) = cx->blk_loop.itersave;		\
	}								\
	if (cx->blk_loop.iterary && cx->blk_loop.iterary != PL_curstack)\
	    SvREFCNT_dec(cx->blk_loop.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.  */

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