[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 POP_SAVEARRAY() NOOP
#else
#  define POP_SAVEARRAY()						\
    STMT_START {							\
	SvREFCNT_dec(GvAV(PL_defgv));					\
	GvAV(PL_defgv) = cx->blk_sub.savearray;				\
    } STMT_END
#endif /* USE_THREADS */

#ifdef USE_ITHREADS
   /* junk in @_ spells trouble when cloning CVs, so don't leave any */
#  define CLEAR_ARGARRAY()	av_clear(cx->blk_sub.argarray)
#else
#  define CLEAR_ARGARRAY()	NOOP
#endif /* USE_ITHREADS */


#define POPSUB(cx,sv)							\
    STMT_START {							\
	if (cx->blk_sub.hasargs) {					\
	    POP_SAVEARRAY();						\
	    /* 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;		\
	    }								\
	    else {							\
		CLEAR_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 ? savepv(n) : Nullch);		\
	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;			\
	Safefree(cx->blk_eval.old_name);

/* loop context */
struct block_loop {
    char *	label;
    I32		resetsp;
    OP *	redo_op;
    OP *	next_op;
    OP *	last_op;
#ifdef USE_ITHREADS
    void *	iterdata;
#else
    SV **	itervar;
#endif
    SV *	itersave;
    SV *	iterlval;
    AV *	iterary;
    IV		iterix;
    IV		itermax;
};

#ifdef USE_ITHREADS
#  define CxITERVAR(c)							\
	((c)->blk_loop.iterdata						\
	 ? (CxPADLOOP(cx) 						\
	    ? &PL_curpad[(PADOFFSET)(c)->blk_loop.iterdata]		\
	    : &GvSV((GV*)(c)->blk_loop.iterdata))			\
	 : (SV**)NULL)
#  define CX_ITERDATA_SET(cx,idata)					\
	if (cx->blk_loop.iterdata = (idata))				\
	    cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));
#else
#  define CxITERVAR(c)		((c)->blk_loop.itervar)
#  define CX_ITERDATA_SET(cx,ivar)					\
	if (cx->blk_loop.itervar = (SV**)(ivar))			\
	    cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));
#endif

#define PUSHLOOP(cx, dat, 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;			\
	cx->blk_loop.iterlval = Nullsv;					\
	cx->blk_loop.iterary = Nullav;					\
	cx->blk_loop.iterix = -1;					\
	CX_ITERDATA_SET(cx,dat);

#define POPLOOP(cx)							\
	SvREFCNT_dec(cx->blk_loop.iterlval);				\
	if (CxITERVAR(cx)) {						\
	    SV **s_v_p = CxITERVAR(cx);					\
	    sv_2mortal(*s_v_p);						\
	    *s_v_p = 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
#define CXt_FORMAT	6

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

#ifdef USE_ITHREADS
/* private flags for CXt_LOOP */
#  define CXp_PADVAR	0x00000100	/* itervar lives on pad, iterdata
					   has pad offset; if not set,
					   iterdata holds GV* */
#  define CxPADLOOP(c)	(((c)->cx_type & (CXt_LOOP|CXp_PADVAR))		\
			 == (CXt_LOOP|CXp_PADVAR))
#endif

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

/*
=for apidoc AmU||G_SCALAR
Used to indicate scalar context.  See C<GIMME_V>, C<GIMME>, and
L<perlcall>.

=for apidoc AmU||G_ARRAY
Used to indicate array context.  See C<GIMME_V>, C<GIMME> and
L<perlcall>.

=for apidoc AmU||G_VOID
Used to indicate void context.  See C<GIMME_V> and L<perlcall>.

=for apidoc AmU||G_DISCARD
Indicates that arguments returned from a callback should be discarded.  See
L<perlcall>.

=for apidoc AmU||G_EVAL

Used to force a Perl C<eval> wrapper around a callback.  See
L<perlcall>.

=for apidoc AmU||G_NOARGS

Indicates that no arguments are being sent to a callback.  See
L<perlcall>.

=cut
*/

#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	98	#ifdef USE_THREADS
7766f137	99	# define POP_SAVEARRAY() NOOP
6d4ff0d2	100	#else
7766f137	101	# define POP_SAVEARRAY() \
6d4ff0d2	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
7766f137 GS	108	#ifdef USE_ITHREADS
	109	/* junk in @_ spells trouble when cloning CVs, so don't leave any */
	110	# define CLEAR_ARGARRAY() av_clear(cx->blk_sub.argarray)
	111	#else
	112	# define CLEAR_ARGARRAY() NOOP
	113	#endif /* USE_ITHREADS */
	114
	115
b0d9ce38 GS	116	#define POPSUB(cx,sv) \
b0d9ce38 GS	117	STMT_START { \
a8bba7fa	118	if (cx->blk_sub.hasargs) { \
7766f137	119	POP_SAVEARRAY(); \
d8b46c1b	120	/* abandon @_ if it got reified */ \
a8bba7fa GS	121	if (AvREAL(cx->blk_sub.argarray)) { \
	122	SSize_t fill = AvFILLp(cx->blk_sub.argarray); \
	123	SvREFCNT_dec(cx->blk_sub.argarray); \
	124	cx->blk_sub.argarray = newAV(); \
	125	av_extend(cx->blk_sub.argarray, fill); \
	126	AvFLAGS(cx->blk_sub.argarray) = AVf_REIFY; \
	127	PL_curpad[0] = (SV*)cx->blk_sub.argarray; \
d8b46c1b	128	} \
7766f137 GS	129	else { \
	130	CLEAR_ARGARRAY(); \
	131	} \
79072805	132	} \
b0d9ce38 GS	133	sv = (SV*)cx->blk_sub.cv; \
	134	if (sv && (CvDEPTH((CV*)sv) = cx->blk_sub.olddepth)) \
	135	sv = Nullsv; \
	136	} STMT_END
	137
	138	#define LEAVESUB(sv) \
	139	STMT_START { \
	140	if (sv) \
	141	SvREFCNT_dec(sv); \
	142	} STMT_END
79072805 LW	143
79072805 LW	144	#define POPFORMAT(cx) \
4633a7c4 LW	145	setdefout(cx->blk_sub.dfoutgv); \
4633a7c4 LW	146	SvREFCNT_dec(cx->blk_sub.dfoutgv);
79072805 LW	147
	148	/* eval context */
	149	struct block_eval {
	150	I32 old_in_eval;
	151	I32 old_op_type;
	152	char * old_name;
	153	OP * old_eval_root;
748a9306	154	SV * cur_text;
79072805 LW	155	};
79072805 LW	156
8990e307	157	#define PUSHEVAL(cx,n,fgv) \
3280af22	158	cx->blk_eval.old_in_eval = PL_in_eval; \
a8bba7fa	159	cx->blk_eval.old_op_type = PL_op->op_type; \
7766f137	160	cx->blk_eval.old_name = (n ? savepv(n) : Nullch); \
a8bba7fa	161	cx->blk_eval.old_eval_root = PL_eval_root; \
3280af22	162	cx->blk_eval.cur_text = PL_linestr;
79072805 LW	163
79072805 LW	164	#define POPEVAL(cx) \
3280af22	165	PL_in_eval = cx->blk_eval.old_in_eval; \
79072805	166	optype = cx->blk_eval.old_op_type; \
7766f137 GS	167	PL_eval_root = cx->blk_eval.old_eval_root; \
7766f137 GS	168	Safefree(cx->blk_eval.old_name);
79072805 LW	169
	170	/* loop context */
	171	struct block_loop {
	172	char * label;
	173	I32 resetsp;
	174	OP * redo_op;
	175	OP * next_op;
	176	OP * last_op;
7766f137 GS	177	#ifdef USE_ITHREADS
	178	void * iterdata;
	179	#else
79072805	180	SV ** itervar;
7766f137	181	#endif
79072805	182	SV * itersave;
5f05dabc	183	SV * iterlval;
79072805	184	AV * iterary;
89ea2908 GA	185	IV iterix;
89ea2908 GA	186	IV itermax;
79072805 LW	187	};
79072805 LW	188
7766f137 GS	189	#ifdef USE_ITHREADS
	190	# define CxITERVAR(c) \
	191	((c)->blk_loop.iterdata \
	192	? (CxPADLOOP(cx) \
	193	? &PL_curpad[(PADOFFSET)(c)->blk_loop.iterdata] \
	194	: &GvSV((GV*)(c)->blk_loop.iterdata)) \
	195	: (SV**)NULL)
	196	# define CX_ITERDATA_SET(cx,idata) \
	197	if (cx->blk_loop.iterdata = (idata)) \
	198	cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));
	199	#else
	200	# define CxITERVAR(c) ((c)->blk_loop.itervar)
	201	# define CX_ITERDATA_SET(cx,ivar) \
	202	if (cx->blk_loop.itervar = (SV**)(ivar)) \
	203	cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));
	204	#endif
	205
	206	#define PUSHLOOP(cx, dat, s) \
38a230cb GS	207	cx->blk_loop.label = PL_curcop->cop_label; \
38a230cb GS	208	cx->blk_loop.resetsp = s - PL_stack_base; \
79072805 LW	209	cx->blk_loop.redo_op = cLOOP->op_redoop; \
	210	cx->blk_loop.next_op = cLOOP->op_nextop; \
	211	cx->blk_loop.last_op = cLOOP->op_lastop; \
44a8e56a	212	cx->blk_loop.iterlval = Nullsv; \
44a8e56a	213	cx->blk_loop.iterary = Nullav; \
7766f137 GS	214	cx->blk_loop.iterix = -1; \
7766f137 GS	215	CX_ITERDATA_SET(cx,dat);
79072805 LW	216
79072805 LW	217	#define POPLOOP(cx) \
a8bba7fa	218	SvREFCNT_dec(cx->blk_loop.iterlval); \
7766f137 GS	219	if (CxITERVAR(cx)) { \
	220	SV **s_v_p = CxITERVAR(cx); \
	221	sv_2mortal(*s_v_p); \
	222	*s_v_p = cx->blk_loop.itersave; \
44a8e56a	223	} \
a8bba7fa GS	224	if (cx->blk_loop.iterary && cx->blk_loop.iterary != PL_curstack)\
a8bba7fa GS	225	SvREFCNT_dec(cx->blk_loop.iterary);
79072805 LW	226
	227	/* context common to subroutines, evals and loops */
	228	struct block {
	229	I32 blku_oldsp; /* stack pointer to copy stuff down to */
	230	COP * blku_oldcop; /* old curcop pointer */
	231	I32 blku_oldretsp; /* return stack index */
	232	I32 blku_oldmarksp; /* mark stack index */
	233	I32 blku_oldscopesp; /* scope stack index */
	234	PMOP * blku_oldpm; /* values of pattern match vars */
	235	U8 blku_gimme; /* is this block running in list context? */
	236
	237	union {
	238	struct block_sub blku_sub;
	239	struct block_eval blku_eval;
	240	struct block_loop blku_loop;
	241	} blk_u;
	242	};
	243	#define blk_oldsp cx_u.cx_blk.blku_oldsp
	244	#define blk_oldcop cx_u.cx_blk.blku_oldcop
	245	#define blk_oldretsp cx_u.cx_blk.blku_oldretsp
	246	#define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
	247	#define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
	248	#define blk_oldpm cx_u.cx_blk.blku_oldpm
	249	#define blk_gimme cx_u.cx_blk.blku_gimme
	250	#define blk_sub cx_u.cx_blk.blk_u.blku_sub
	251	#define blk_eval cx_u.cx_blk.blk_u.blku_eval
	252	#define blk_loop cx_u.cx_blk.blk_u.blku_loop
	253
	254	/* Enter a block. */
8990e307	255	#define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix], \
79072805	256	cx->cx_type = t, \
3280af22 NIS	257	cx->blk_oldsp = sp - PL_stack_base, \
3280af22 NIS	258	cx->blk_oldcop = PL_curcop, \
1aff0e91	259	cx->blk_oldmarksp = PL_markstack_ptr - PL_markstack, \
3280af22	260	cx->blk_oldscopesp = PL_scopestack_ix, \
1aff0e91	261	cx->blk_oldretsp = PL_retstack_ix, \
3280af22	262	cx->blk_oldpm = PL_curpm, \
79072805	263	cx->blk_gimme = gimme; \
bf49b057	264	DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \
1aff0e91	265	(long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )
79072805 LW	266
79072805 LW	267	/* Exit a block (RETURN and LAST). */
a0d0e21e	268	#define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--], \
1aff0e91	269	newsp = PL_stack_base + cx->blk_oldsp, \
3280af22 NIS	270	PL_curcop = cx->blk_oldcop, \
	271	PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
	272	PL_scopestack_ix = cx->blk_oldscopesp, \
	273	PL_retstack_ix = cx->blk_oldretsp, \
	274	pm = cx->blk_oldpm, \
	275	gimme = cx->blk_gimme; \
bf49b057	276	DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n", \
22c35a8c	277	(long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )
79072805 LW	278
79072805 LW	279	/* Continue a block elsewhere (NEXT and REDO). */
3280af22	280	#define TOPBLOCK(cx) cx = &cxstack[cxstack_ix], \
1aff0e91	281	PL_stack_sp = PL_stack_base + cx->blk_oldsp, \
3280af22 NIS	282	PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
3280af22 NIS	283	PL_scopestack_ix = cx->blk_oldscopesp, \
2158dd9b GS	284	PL_retstack_ix = cx->blk_oldretsp, \
2158dd9b GS	285	PL_curpm = cx->blk_oldpm
79072805 LW	286
	287	/* substitution context */
	288	struct subst {
	289	I32 sbu_iters;
	290	I32 sbu_maxiters;
22e551b9	291	I32 sbu_rflags;
4633a7c4	292	I32 sbu_oldsave;
71be2cbc	293	bool sbu_once;
71be2cbc	294	bool sbu_rxtainted;
79072805 LW	295	char * sbu_orig;
	296	SV * sbu_dstr;
	297	SV * sbu_targ;
	298	char * sbu_s;
	299	char * sbu_m;
	300	char * sbu_strend;
c90c0ff4	301	void * sbu_rxres;
c07a80fd	302	REGEXP * sbu_rx;
79072805 LW	303	};
	304	#define sb_iters cx_u.cx_subst.sbu_iters
	305	#define sb_maxiters cx_u.cx_subst.sbu_maxiters
22e551b9	306	#define sb_rflags cx_u.cx_subst.sbu_rflags
4633a7c4	307	#define sb_oldsave cx_u.cx_subst.sbu_oldsave
71be2cbc	308	#define sb_once cx_u.cx_subst.sbu_once
71be2cbc	309	#define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
79072805 LW	310	#define sb_orig cx_u.cx_subst.sbu_orig
	311	#define sb_dstr cx_u.cx_subst.sbu_dstr
	312	#define sb_targ cx_u.cx_subst.sbu_targ
	313	#define sb_s cx_u.cx_subst.sbu_s
	314	#define sb_m cx_u.cx_subst.sbu_m
	315	#define sb_strend cx_u.cx_subst.sbu_strend
c90c0ff4	316	#define sb_rxres cx_u.cx_subst.sbu_rxres
c07a80fd	317	#define sb_rx cx_u.cx_subst.sbu_rx
79072805 LW	318
	319	#define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix], \
	320	cx->sb_iters = iters, \
	321	cx->sb_maxiters = maxiters, \
22e551b9	322	cx->sb_rflags = r_flags, \
4633a7c4	323	cx->sb_oldsave = oldsave, \
71be2cbc	324	cx->sb_once = once, \
71be2cbc	325	cx->sb_rxtainted = rxtainted, \
79072805 LW	326	cx->sb_orig = orig, \
	327	cx->sb_dstr = dstr, \
	328	cx->sb_targ = targ, \
	329	cx->sb_s = s, \
	330	cx->sb_m = m, \
	331	cx->sb_strend = strend, \
c90c0ff4	332	cx->sb_rxres = Null(void*), \
c07a80fd	333	cx->sb_rx = rx, \
c90c0ff4	334	cx->cx_type = CXt_SUBST; \
c90c0ff4	335	rxres_save(&cx->sb_rxres, rx)
79072805	336
c90c0ff4	337	#define POPSUBST(cx) cx = &cxstack[cxstack_ix--]; \
c90c0ff4	338	rxres_free(&cx->sb_rxres)
79072805 LW	339
79072805 LW	340	struct context {
6b35e009	341	U32 cx_type; /* what kind of context this is */
79072805 LW	342	union {
	343	struct block cx_blk;
	344	struct subst cx_subst;
	345	} cx_u;
	346	};
6b35e009 GS	347
6b35e009 GS	348	#define CXTYPEMASK 0xff
79072805 LW	349	#define CXt_NULL 0
	350	#define CXt_SUB 1
	351	#define CXt_EVAL 2
	352	#define CXt_LOOP 3
	353	#define CXt_SUBST 4
	354	#define CXt_BLOCK 5
7766f137	355	#define CXt_FORMAT 6
79072805	356
6b35e009 GS	357	/* private flags for CXt_EVAL */
	358	#define CXp_REAL 0x00000100 /* truly eval'', not a lookalike */
	359
7766f137 GS	360	#ifdef USE_ITHREADS
	361	/* private flags for CXt_LOOP */
	362	# define CXp_PADVAR 0x00000100 /* itervar lives on pad, iterdata
	363	has pad offset; if not set,
	364	iterdata holds GV* */
	365	# define CxPADLOOP(c) (((c)->cx_type & (CXt_LOOP\|CXp_PADVAR)) \
	366	== (CXt_LOOP\|CXp_PADVAR))
	367	#endif
	368
6b35e009	369	#define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
7766f137 GS	370	#define CxREALEVAL(c) (((c)->cx_type & (CXt_EVAL\|CXp_REAL)) \
7766f137 GS	371	== (CXt_EVAL\|CXp_REAL))
6b35e009	372
79072805 LW	373	#define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
	374
	375	/* "gimme" values */
954c1994 GS	376
	377	/*
	378	=for apidoc AmU\|\|G_SCALAR
	379	Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
	380	L<perlcall>.
	381
	382	=for apidoc AmU\|\|G_ARRAY
	383	Used to indicate array context. See C<GIMME_V>, C<GIMME> and
	384	L<perlcall>.
	385
	386	=for apidoc AmU\|\|G_VOID
	387	Used to indicate void context. See C<GIMME_V> and L<perlcall>.
	388
	389	=for apidoc AmU\|\|G_DISCARD
	390	Indicates that arguments returned from a callback should be discarded. See
	391	L<perlcall>.
	392
	393	=for apidoc AmU\|\|G_EVAL
	394
	395	Used to force a Perl C<eval> wrapper around a callback. See
	396	L<perlcall>.
	397
	398	=for apidoc AmU\|\|G_NOARGS
	399
	400	Indicates that no arguments are being sent to a callback. See
	401	L<perlcall>.
	402
	403	=cut
	404	*/
	405
a0d0e21e LW	406	#define G_SCALAR 0
a0d0e21e LW	407	#define G_ARRAY 1
54310121	408	#define G_VOID 128 /* skip this bit when adding flags below */
79072805	409
864dbfa3	410	/* extra flags for Perl_call_* routines */
a0d0e21e LW	411	#define G_DISCARD 2 /* Call FREETMPS. */
	412	#define G_EVAL 4 /* Assume eval {} around subroutine call. */
	413	#define G_NOARGS 8 /* Don't construct a @_ array. */
54310121	414	#define G_KEEPERR 16 /* Append errors to $@, don't overwrite it */
491527d0	415	#define G_NODEBUG 32 /* Disable debugging at toplevel. */
e336de0d	416
faef0170 HS	417	/* flag bits for PL_in_eval */
	418	#define EVAL_NULL 0 /* not in an eval */
	419	#define EVAL_INEVAL 1 /* some enclosing scope is an eval */
	420	#define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */
864dbfa3	421	#define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
faef0170	422
e336de0d GS	423	/* Support for switching (stack and block) contexts.
	424	* This ensures magic doesn't invalidate local stack and cx pointers.
	425	*/
	426
e788e7d3 GS	427	#define PERLSI_UNKNOWN -1
	428	#define PERLSI_UNDEF 0
	429	#define PERLSI_MAIN 1
	430	#define PERLSI_MAGIC 2
	431	#define PERLSI_SORT 3
	432	#define PERLSI_SIGNAL 4
	433	#define PERLSI_OVERLOAD 5
	434	#define PERLSI_DESTROY 6
	435	#define PERLSI_WARNHOOK 7
	436	#define PERLSI_DIEHOOK 8
	437	#define PERLSI_REQUIRE 9
e336de0d GS	438
	439	struct stackinfo {
	440	AV * si_stack; /* stack for current runlevel */
	441	PERL_CONTEXT * si_cxstack; /* context stack for runlevel */
	442	I32 si_cxix; /* current context index */
	443	I32 si_cxmax; /* maximum allocated index */
	444	I32 si_type; /* type of runlevel */
	445	struct stackinfo * si_prev;
	446	struct stackinfo * si_next;
ce2f7c3b	447	I32 si_markoff; /* offset where markstack begins for us.
e336de0d GS	448	* currently used only with DEBUGGING,
	449	* but not #ifdef-ed for bincompat */
	450	};
	451
	452	typedef struct stackinfo PERL_SI;
	453
3280af22 NIS	454	#define cxstack (PL_curstackinfo->si_cxstack)
	455	#define cxstack_ix (PL_curstackinfo->si_cxix)
	456	#define cxstack_max (PL_curstackinfo->si_cxmax)
e336de0d GS	457
e336de0d GS	458	#ifdef DEBUGGING
ce2f7c3b GS	459	# define SET_MARK_OFFSET \
ce2f7c3b GS	460	PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
e336de0d	461	#else
ce2f7c3b	462	# define SET_MARK_OFFSET NOOP
e336de0d GS	463	#endif
e336de0d GS	464
d3acc0f7	465	#define PUSHSTACKi(type) \
e336de0d	466	STMT_START { \
3280af22	467	PERL_SI *next = PL_curstackinfo->si_next; \
e336de0d GS	468	if (!next) { \
e336de0d GS	469	next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
3280af22 NIS	470	next->si_prev = PL_curstackinfo; \
3280af22 NIS	471	PL_curstackinfo->si_next = next; \
e336de0d GS	472	} \
	473	next->si_type = type; \
	474	next->si_cxix = -1; \
	475	AvFILLp(next->si_stack) = 0; \
3280af22 NIS	476	SWITCHSTACK(PL_curstack,next->si_stack); \
3280af22 NIS	477	PL_curstackinfo = next; \
ce2f7c3b	478	SET_MARK_OFFSET; \
e336de0d GS	479	} STMT_END
e336de0d GS	480
e788e7d3	481	#define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
d3acc0f7	482
3095d977 GS	483	/* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
3095d977 GS	484	* PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
d3acc0f7	485	#define POPSTACK \
e336de0d	486	STMT_START { \
de616352	487	djSP; \
3280af22	488	PERL_SI *prev = PL_curstackinfo->si_prev; \
e336de0d	489	if (!prev) { \
bf49b057	490	PerlIO_printf(Perl_error_log, "panic: POPSTACK\n"); \
e336de0d GS	491	my_exit(1); \
e336de0d GS	492	} \
3280af22	493	SWITCHSTACK(PL_curstack,prev->si_stack); \
e336de0d	494	/* don't free prev here, free them all at the END{} */ \
3280af22	495	PL_curstackinfo = prev; \
e336de0d GS	496	} STMT_END
	497
	498	#define POPSTACK_TO(s) \
	499	STMT_START { \
3280af22	500	while (PL_curstack != s) { \
bac4b2ad	501	dounwind(-1); \
d3acc0f7	502	POPSTACK; \
bac4b2ad	503	} \
e336de0d	504	} STMT_END