[perl5.git] / cop.h

/*    cop.h
 *
 *    Copyright (c) 1991-2002, 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 */
    SV *	cop_io;		/* lexical IO defaults */
};

#define Nullcop Null(COP*)

#ifdef USE_ITHREADS
#  define CopFILE(c)		((c)->cop_file)
#  define CopFILEGV(c)		(CopFILE(c) \
				 ? gv_fetchfile(CopFILE(c)) : Nullgv)
				 
 #ifdef NETWARE
  #define CopFILE_set(c,pv)	((c)->cop_file = savepv(pv))
 #else
  #define CopFILE_set(c,pv)	((c)->cop_file = savesharedpv(pv))
 #endif

#  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)

  #ifdef NETWARE
    #define CopSTASHPV_set(c,pv)	((c)->cop_stashpv = ((pv) ? savepv(pv) : Nullch))
  #else
    #define CopSTASHPV_set(c,pv)	((c)->cop_stashpv = savesharedpv(pv))
  #endif

#  define CopSTASH(c)		(CopSTASHPV(c) \
				 ? gv_stashpv(CopSTASHPV(c),GV_ADD) : Nullhv)
#  define CopSTASH_set(c,hv)	CopSTASHPV_set(c, (hv) ? HvNAME(hv) : Nullch)
#  define CopSTASH_eq(c,hv)	((hv) 					\
				 && (CopSTASHPV(c) == HvNAME(hv)	\
				     || (CopSTASHPV(c) && HvNAME(hv)	\
					 && strEQ(CopSTASHPV(c), HvNAME(hv)))))
  #ifdef NETWARE
    #define CopSTASH_free(c) SAVECOPSTASH_FREE(c)
  #else
    #define CopSTASH_free(c)	PerlMemShared_free(CopSTASHPV(c))      
  #endif

  #ifdef NETWARE
    #define CopFILE_free(c) SAVECOPFILE_FREE(c)
  #else
    #define CopFILE_free(c)	(PerlMemShared_free(CopFILE(c)),(CopFILE(c) = Nullch))      
  #endif
#else
#  define CopFILEGV(c)		((c)->cop_filegv)
#  define CopFILEGV_set(c,gv)	((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
#  define CopFILE_set(c,pv)	CopFILEGV_set((c), 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)
   /* cop_stash is not refcounted */
#  define CopSTASHPV_set(c,pv)	CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
#  define CopSTASH_eq(c,hv)	(CopSTASH(c) == (hv))
#  define CopSTASH_free(c)	
#  define CopFILE_free(c)	(SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = Nullgv))

#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))

/* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */
#ifdef MACOS_TRADITIONAL
#  define OutCopFILE(c) MacPerl_MPWFileName(CopFILE(c))
#else
#  define OutCopFILE(c) CopFILE(c)
#endif

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

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

#define PUSHSUB(cx)							\
	cx->blk_sub.cv = cv;						\
	cx->blk_sub.olddepth = (U16)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_5005THREADS
#  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_5005THREADS */

/* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
 * leave any (a fast av_clear(ary), basically) */
#define CLEAR_ARGARRAY(ary) \
    STMT_START {							\
	AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary);			\
	SvPVX(ary) = (char*)AvALLOC(ary);				\
	AvFILLp(ary) = -1;						\
    } STMT_END

#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;		\
		cx->blk_sub.oldcurpad[0] = (SV*)cx->blk_sub.argarray;	\
	    }								\
	    else {							\
		CLEAR_ARGARRAY(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;
    SV *	old_namesv;
    OP *	old_eval_root;
    SV *	cur_text;
    CV *	cv;
};

#define PUSHEVAL(cx,n,fgv)						\
    STMT_START {							\
	cx->blk_eval.old_in_eval = PL_in_eval;				\
	cx->blk_eval.old_op_type = PL_op->op_type;			\
	cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : Nullsv);		\
	cx->blk_eval.old_eval_root = PL_eval_root;			\
	cx->blk_eval.cur_text = PL_linestr;				\
	cx->blk_eval.cv = Nullcv; /* set by doeval(), as applicable */	\
    } STMT_END

#define POPEVAL(cx)							\
    STMT_START {							\
	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;			\
	if (cx->blk_eval.old_namesv)					\
	    sv_2mortal(cx->blk_eval.old_namesv);			\
    } STMT_END

/* loop context */
struct block_loop {
    char *	label;
    I32		resetsp;
    OP *	redo_op;
    OP *	next_op;
    OP *	last_op;
#ifdef USE_ITHREADS
    void *	iterdata;
    SV **	oldcurpad;
#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) 						\
	    ? &((c)->blk_loop.oldcurpad)[INT2PTR(PADOFFSET, (c)->blk_loop.iterdata)] \
	    : &GvSV((GV*)(c)->blk_loop.iterdata))			\
	 : (SV**)NULL)
#  define CX_ITERDATA_SET(cx,idata)					\
	cx->blk_loop.oldcurpad = PL_curpad;				\
	if ((cx->blk_loop.iterdata = (idata)))				\
	    cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));	\
	else								\
	    cx->blk_loop.itersave = Nullsv;
#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));	\
	else								\
	    cx->blk_loop.itersave = Nullsv;
#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		= (U8)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 */
#define CXp_TRYBLOCK	0x00000200	/* eval{}, not eval'' or similar */

#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 CxTRYBLOCK(c)	(((c)->cx_type & (CXt_EVAL|CXp_TRYBLOCK))	\
			 == (CXt_EVAL|CXp_TRYBLOCK))

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

/* 
=head1 "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 list 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.  */
#define G_METHOD       64       /* Calling method. */

/* 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 */
#define EVAL_INREQUIRE	8	/* The code is being required. */

/* 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 {							\
	dSP;								\
	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	*
be3c0a43	3	* Copyright (c) 1991-2002, 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 */
ac27b0f5	24	SV * cop_io; /* lexical IO defaults */
79072805 LW	25	};
	26
	27	#define Nullcop Null(COP*)
	28
57843af0 GS	29	#ifdef USE_ITHREADS
	30	# define CopFILE(c) ((c)->cop_file)
	31	# define CopFILEGV(c) (CopFILE(c) \
	32	? gv_fetchfile(CopFILE(c)) : Nullgv)
083fcd59 JH	33
	34	#ifdef NETWARE
	35	#define CopFILE_set(c,pv) ((c)->cop_file = savepv(pv))
	36	#else
	37	#define CopFILE_set(c,pv) ((c)->cop_file = savesharedpv(pv))
	38	#endif
	39
57843af0 GS	40	# define CopFILESV(c) (CopFILE(c) \
	41	? GvSV(gv_fetchfile(CopFILE(c))) : Nullsv)
	42	# define CopFILEAV(c) (CopFILE(c) \
	43	? GvAV(gv_fetchfile(CopFILE(c))) : Nullav)
57843af0	44	# define CopSTASHPV(c) ((c)->cop_stashpv)
083fcd59 JH	45
	46	#ifdef NETWARE
	47	#define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = ((pv) ? savepv(pv) : Nullch))
	48	#else
	49	#define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = savesharedpv(pv))
	50	#endif
	51
11faa288 GS	52	# define CopSTASH(c) (CopSTASHPV(c) \
11faa288 GS	53	? gv_stashpv(CopSTASHPV(c),GV_ADD) : Nullhv)
7b910cb8	54	# define CopSTASH_set(c,hv) CopSTASHPV_set(c, (hv) ? HvNAME(hv) : Nullch)
f4dd75d9	55	# define CopSTASH_eq(c,hv) ((hv) \
ed094faf GS	56	&& (CopSTASHPV(c) == HvNAME(hv) \
	57	\|\| (CopSTASHPV(c) && HvNAME(hv) \
	58	&& strEQ(CopSTASHPV(c), HvNAME(hv)))))
083fcd59 JH	59	#ifdef NETWARE
	60	#define CopSTASH_free(c) SAVECOPSTASH_FREE(c)
	61	#else
	62	#define CopSTASH_free(c) PerlMemShared_free(CopSTASHPV(c))
	63	#endif
	64
	65	#ifdef NETWARE
	66	#define CopFILE_free(c) SAVECOPFILE_FREE(c)
	67	#else
	68	#define CopFILE_free(c) (PerlMemShared_free(CopFILE(c)),(CopFILE(c) = Nullch))
	69	#endif
57843af0 GS	70	#else
57843af0 GS	71	# define CopFILEGV(c) ((c)->cop_filegv)
f4dd75d9 GS	72	# define CopFILEGV_set(c,gv) ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
f4dd75d9 GS	73	# define CopFILE_set(c,pv) CopFILEGV_set((c), gv_fetchfile(pv))
57843af0 GS	74	# define CopFILESV(c) (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : Nullsv)
	75	# define CopFILEAV(c) (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : Nullav)
	76	# define CopFILE(c) (CopFILESV(c) ? SvPVX(CopFILESV(c)) : Nullch)
	77	# define CopSTASH(c) ((c)->cop_stash)
f4dd75d9	78	# define CopSTASH_set(c,hv) ((c)->cop_stash = (hv))
57843af0	79	# define CopSTASHPV(c) (CopSTASH(c) ? HvNAME(CopSTASH(c)) : Nullch)
f4dd75d9 GS	80	/* cop_stash is not refcounted */
	81	# define CopSTASHPV_set(c,pv) CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
	82	# define CopSTASH_eq(c,hv) (CopSTASH(c) == (hv))
05ec9bb3 NIS	83	# define CopSTASH_free(c)
	84	# define CopFILE_free(c) (SvREFCNT_dec(CopFILEGV(c)),(CopFILEGV(c) = Nullgv))
	85
57843af0 GS	86	#endif /* USE_ITHREADS */
57843af0 GS	87
ed094faf	88	#define CopSTASH_ne(c,hv) (!CopSTASH_eq(c,hv))
cc49e20b	89	#define CopLINE(c) ((c)->cop_line)
57843af0 GS	90	#define CopLINE_inc(c) (++CopLINE(c))
	91	#define CopLINE_dec(c) (--CopLINE(c))
	92	#define CopLINE_set(c,l) (CopLINE(c) = (l))
cc49e20b	93
248c2a4d CN	94	/* OutCopFILE() is CopFILE for output (caller, die, warn, etc.) */
	95	#ifdef MACOS_TRADITIONAL
	96	# define OutCopFILE(c) MacPerl_MPWFileName(CopFILE(c))
	97	#else
	98	# define OutCopFILE(c) CopFILE(c)
	99	#endif
	100
79072805 LW	101	/*
	102	* Here we have some enormously heavy (or at least ponderous) wizardry.
	103	*/
	104
	105	/* subroutine context */
	106	struct block_sub {
	107	CV * cv;
	108	GV * gv;
463ee0b2	109	GV * dfoutgv;
4d1ff10f	110	#ifndef USE_5005THREADS
79072805	111	AV * savearray;
4d1ff10f	112	#endif /* USE_5005THREADS */
79072805 LW	113	AV * argarray;
	114	U16 olddepth;
	115	U8 hasargs;
cd06dffe	116	U8 lval; /* XXX merge lval and hasargs? */
7032098e	117	SV ** oldcurpad;
79072805 LW	118	};
	119
	120	#define PUSHSUB(cx) \
	121	cx->blk_sub.cv = cv; \
eb160463	122	cx->blk_sub.olddepth = (U16)CvDEPTH(cv); \
cd06dffe GS	123	cx->blk_sub.hasargs = hasargs; \
	124	cx->blk_sub.lval = PL_op->op_private & \
	125	(OPpLVAL_INTRO\|OPpENTERSUB_INARGS);
79072805 LW	126
	127	#define PUSHFORMAT(cx) \
	128	cx->blk_sub.cv = cv; \
	129	cx->blk_sub.gv = gv; \
4633a7c4	130	cx->blk_sub.hasargs = 0; \
3280af22	131	cx->blk_sub.dfoutgv = PL_defoutgv; \
4633a7c4	132	(void)SvREFCNT_inc(cx->blk_sub.dfoutgv)
79072805	133
4d1ff10f	134	#ifdef USE_5005THREADS
7766f137	135	# define POP_SAVEARRAY() NOOP
6d4ff0d2	136	#else
7766f137	137	# define POP_SAVEARRAY() \
6d4ff0d2	138	STMT_START { \
3280af22	139	SvREFCNT_dec(GvAV(PL_defgv)); \
a8bba7fa	140	GvAV(PL_defgv) = cx->blk_sub.savearray; \
6d4ff0d2	141	} STMT_END
4d1ff10f	142	#endif /* USE_5005THREADS */
6d4ff0d2	143
ecf8e9dd	144	/* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
8e09340b GS	145	* leave any (a fast av_clear(ary), basically) */
	146	#define CLEAR_ARGARRAY(ary) \
	147	STMT_START { \
	148	AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary); \
	149	SvPVX(ary) = (char*)AvALLOC(ary); \
	150	AvFILLp(ary) = -1; \
	151	} STMT_END
7766f137	152
b0d9ce38 GS	153	#define POPSUB(cx,sv) \
b0d9ce38 GS	154	STMT_START { \
a8bba7fa	155	if (cx->blk_sub.hasargs) { \
7766f137	156	POP_SAVEARRAY(); \
d8b46c1b	157	/* abandon @_ if it got reified */ \
a8bba7fa GS	158	if (AvREAL(cx->blk_sub.argarray)) { \
	159	SSize_t fill = AvFILLp(cx->blk_sub.argarray); \
	160	SvREFCNT_dec(cx->blk_sub.argarray); \
	161	cx->blk_sub.argarray = newAV(); \
	162	av_extend(cx->blk_sub.argarray, fill); \
	163	AvFLAGS(cx->blk_sub.argarray) = AVf_REIFY; \
7032098e	164	cx->blk_sub.oldcurpad[0] = (SV*)cx->blk_sub.argarray; \
d8b46c1b	165	} \
7766f137	166	else { \
8e09340b	167	CLEAR_ARGARRAY(cx->blk_sub.argarray); \
7766f137	168	} \
79072805	169	} \
b0d9ce38 GS	170	sv = (SV*)cx->blk_sub.cv; \
	171	if (sv && (CvDEPTH((CV*)sv) = cx->blk_sub.olddepth)) \
	172	sv = Nullsv; \
	173	} STMT_END
	174
	175	#define LEAVESUB(sv) \
	176	STMT_START { \
	177	if (sv) \
	178	SvREFCNT_dec(sv); \
	179	} STMT_END
79072805 LW	180
79072805 LW	181	#define POPFORMAT(cx) \
4633a7c4 LW	182	setdefout(cx->blk_sub.dfoutgv); \
4633a7c4 LW	183	SvREFCNT_dec(cx->blk_sub.dfoutgv);
79072805 LW	184
	185	/* eval context */
	186	struct block_eval {
	187	I32 old_in_eval;
	188	I32 old_op_type;
0f79a09d	189	SV * old_namesv;
79072805	190	OP * old_eval_root;
748a9306	191	SV * cur_text;
2090ab20	192	CV * cv;
79072805 LW	193	};
79072805 LW	194
8990e307	195	#define PUSHEVAL(cx,n,fgv) \
0f79a09d	196	STMT_START { \
3280af22	197	cx->blk_eval.old_in_eval = PL_in_eval; \
a8bba7fa	198	cx->blk_eval.old_op_type = PL_op->op_type; \
0f79a09d	199	cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : Nullsv); \
a8bba7fa	200	cx->blk_eval.old_eval_root = PL_eval_root; \
0f79a09d	201	cx->blk_eval.cur_text = PL_linestr; \
2090ab20	202	cx->blk_eval.cv = Nullcv; /* set by doeval(), as applicable */ \
0f79a09d	203	} STMT_END
79072805 LW	204
79072805 LW	205	#define POPEVAL(cx) \
0f79a09d	206	STMT_START { \
3280af22	207	PL_in_eval = cx->blk_eval.old_in_eval; \
79072805	208	optype = cx->blk_eval.old_op_type; \
7766f137	209	PL_eval_root = cx->blk_eval.old_eval_root; \
0f79a09d GS	210	if (cx->blk_eval.old_namesv) \
	211	sv_2mortal(cx->blk_eval.old_namesv); \
	212	} STMT_END
79072805 LW	213
	214	/* loop context */
	215	struct block_loop {
	216	char * label;
	217	I32 resetsp;
	218	OP * redo_op;
	219	OP * next_op;
	220	OP * last_op;
7766f137 GS	221	#ifdef USE_ITHREADS
7766f137 GS	222	void * iterdata;
9e509370	223	SV ** oldcurpad;
7766f137	224	#else
79072805	225	SV ** itervar;
7766f137	226	#endif
79072805	227	SV * itersave;
5f05dabc	228	SV * iterlval;
79072805	229	AV * iterary;
89ea2908 GA	230	IV iterix;
89ea2908 GA	231	IV itermax;
79072805 LW	232	};
79072805 LW	233
7766f137 GS	234	#ifdef USE_ITHREADS
	235	# define CxITERVAR(c) \
	236	((c)->blk_loop.iterdata \
	237	? (CxPADLOOP(cx) \
e830ead6	238	? &((c)->blk_loop.oldcurpad)[INT2PTR(PADOFFSET, (c)->blk_loop.iterdata)] \
7766f137 GS	239	: &GvSV((GV*)(c)->blk_loop.iterdata)) \
	240	: (SV**)NULL)
	241	# define CX_ITERDATA_SET(cx,idata) \
9e509370	242	cx->blk_loop.oldcurpad = PL_curpad; \
155aba94	243	if ((cx->blk_loop.iterdata = (idata))) \
d10edb75 KC	244	cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx)); \
	245	else \
	246	cx->blk_loop.itersave = Nullsv;
7766f137 GS	247	#else
	248	# define CxITERVAR(c) ((c)->blk_loop.itervar)
	249	# define CX_ITERDATA_SET(cx,ivar) \
155aba94	250	if ((cx->blk_loop.itervar = (SV**)(ivar))) \
d10edb75 KC	251	cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx)); \
	252	else \
	253	cx->blk_loop.itersave = Nullsv;
7766f137 GS	254	#endif
	255
	256	#define PUSHLOOP(cx, dat, s) \
38a230cb GS	257	cx->blk_loop.label = PL_curcop->cop_label; \
38a230cb GS	258	cx->blk_loop.resetsp = s - PL_stack_base; \
79072805 LW	259	cx->blk_loop.redo_op = cLOOP->op_redoop; \
	260	cx->blk_loop.next_op = cLOOP->op_nextop; \
	261	cx->blk_loop.last_op = cLOOP->op_lastop; \
44a8e56a	262	cx->blk_loop.iterlval = Nullsv; \
44a8e56a	263	cx->blk_loop.iterary = Nullav; \
7766f137 GS	264	cx->blk_loop.iterix = -1; \
7766f137 GS	265	CX_ITERDATA_SET(cx,dat);
79072805 LW	266
79072805 LW	267	#define POPLOOP(cx) \
a8bba7fa	268	SvREFCNT_dec(cx->blk_loop.iterlval); \
7766f137 GS	269	if (CxITERVAR(cx)) { \
	270	SV **s_v_p = CxITERVAR(cx); \
	271	sv_2mortal(*s_v_p); \
	272	*s_v_p = cx->blk_loop.itersave; \
44a8e56a	273	} \
a8bba7fa GS	274	if (cx->blk_loop.iterary && cx->blk_loop.iterary != PL_curstack)\
a8bba7fa GS	275	SvREFCNT_dec(cx->blk_loop.iterary);
79072805 LW	276
	277	/* context common to subroutines, evals and loops */
	278	struct block {
	279	I32 blku_oldsp; /* stack pointer to copy stuff down to */
	280	COP * blku_oldcop; /* old curcop pointer */
	281	I32 blku_oldretsp; /* return stack index */
	282	I32 blku_oldmarksp; /* mark stack index */
	283	I32 blku_oldscopesp; /* scope stack index */
	284	PMOP * blku_oldpm; /* values of pattern match vars */
	285	U8 blku_gimme; /* is this block running in list context? */
	286
	287	union {
	288	struct block_sub blku_sub;
	289	struct block_eval blku_eval;
	290	struct block_loop blku_loop;
	291	} blk_u;
	292	};
	293	#define blk_oldsp cx_u.cx_blk.blku_oldsp
	294	#define blk_oldcop cx_u.cx_blk.blku_oldcop
	295	#define blk_oldretsp cx_u.cx_blk.blku_oldretsp
	296	#define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
	297	#define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
	298	#define blk_oldpm cx_u.cx_blk.blku_oldpm
	299	#define blk_gimme cx_u.cx_blk.blku_gimme
	300	#define blk_sub cx_u.cx_blk.blk_u.blku_sub
	301	#define blk_eval cx_u.cx_blk.blk_u.blku_eval
	302	#define blk_loop cx_u.cx_blk.blk_u.blku_loop
	303
	304	/* Enter a block. */
8990e307	305	#define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix], \
79072805	306	cx->cx_type = t, \
3280af22 NIS	307	cx->blk_oldsp = sp - PL_stack_base, \
3280af22 NIS	308	cx->blk_oldcop = PL_curcop, \
1aff0e91	309	cx->blk_oldmarksp = PL_markstack_ptr - PL_markstack, \
3280af22	310	cx->blk_oldscopesp = PL_scopestack_ix, \
1aff0e91	311	cx->blk_oldretsp = PL_retstack_ix, \
3280af22	312	cx->blk_oldpm = PL_curpm, \
eb160463	313	cx->blk_gimme = (U8)gimme; \
bf49b057	314	DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \
1aff0e91	315	(long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )
79072805 LW	316
79072805 LW	317	/* Exit a block (RETURN and LAST). */
a0d0e21e	318	#define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--], \
1aff0e91	319	newsp = PL_stack_base + cx->blk_oldsp, \
3280af22 NIS	320	PL_curcop = cx->blk_oldcop, \
	321	PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
	322	PL_scopestack_ix = cx->blk_oldscopesp, \
	323	PL_retstack_ix = cx->blk_oldretsp, \
	324	pm = cx->blk_oldpm, \
	325	gimme = cx->blk_gimme; \
bf49b057	326	DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n", \
22c35a8c	327	(long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )
79072805 LW	328
79072805 LW	329	/* Continue a block elsewhere (NEXT and REDO). */
3280af22	330	#define TOPBLOCK(cx) cx = &cxstack[cxstack_ix], \
1aff0e91	331	PL_stack_sp = PL_stack_base + cx->blk_oldsp, \
3280af22 NIS	332	PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
3280af22 NIS	333	PL_scopestack_ix = cx->blk_oldscopesp, \
2158dd9b GS	334	PL_retstack_ix = cx->blk_oldretsp, \
2158dd9b GS	335	PL_curpm = cx->blk_oldpm
79072805 LW	336
	337	/* substitution context */
	338	struct subst {
	339	I32 sbu_iters;
	340	I32 sbu_maxiters;
22e551b9	341	I32 sbu_rflags;
4633a7c4	342	I32 sbu_oldsave;
71be2cbc	343	bool sbu_once;
71be2cbc	344	bool sbu_rxtainted;
79072805 LW	345	char * sbu_orig;
	346	SV * sbu_dstr;
	347	SV * sbu_targ;
	348	char * sbu_s;
	349	char * sbu_m;
	350	char * sbu_strend;
c90c0ff4	351	void * sbu_rxres;
c07a80fd	352	REGEXP * sbu_rx;
79072805 LW	353	};
	354	#define sb_iters cx_u.cx_subst.sbu_iters
	355	#define sb_maxiters cx_u.cx_subst.sbu_maxiters
22e551b9	356	#define sb_rflags cx_u.cx_subst.sbu_rflags
4633a7c4	357	#define sb_oldsave cx_u.cx_subst.sbu_oldsave
71be2cbc	358	#define sb_once cx_u.cx_subst.sbu_once
71be2cbc	359	#define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
79072805 LW	360	#define sb_orig cx_u.cx_subst.sbu_orig
	361	#define sb_dstr cx_u.cx_subst.sbu_dstr
	362	#define sb_targ cx_u.cx_subst.sbu_targ
	363	#define sb_s cx_u.cx_subst.sbu_s
	364	#define sb_m cx_u.cx_subst.sbu_m
	365	#define sb_strend cx_u.cx_subst.sbu_strend
c90c0ff4	366	#define sb_rxres cx_u.cx_subst.sbu_rxres
c07a80fd	367	#define sb_rx cx_u.cx_subst.sbu_rx
79072805 LW	368
	369	#define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix], \
	370	cx->sb_iters = iters, \
	371	cx->sb_maxiters = maxiters, \
22e551b9	372	cx->sb_rflags = r_flags, \
4633a7c4	373	cx->sb_oldsave = oldsave, \
71be2cbc	374	cx->sb_once = once, \
71be2cbc	375	cx->sb_rxtainted = rxtainted, \
79072805 LW	376	cx->sb_orig = orig, \
	377	cx->sb_dstr = dstr, \
	378	cx->sb_targ = targ, \
	379	cx->sb_s = s, \
	380	cx->sb_m = m, \
	381	cx->sb_strend = strend, \
c90c0ff4	382	cx->sb_rxres = Null(void*), \
c07a80fd	383	cx->sb_rx = rx, \
c90c0ff4	384	cx->cx_type = CXt_SUBST; \
c90c0ff4	385	rxres_save(&cx->sb_rxres, rx)
79072805	386
c90c0ff4	387	#define POPSUBST(cx) cx = &cxstack[cxstack_ix--]; \
c90c0ff4	388	rxres_free(&cx->sb_rxres)
79072805 LW	389
79072805 LW	390	struct context {
6b35e009	391	U32 cx_type; /* what kind of context this is */
79072805 LW	392	union {
	393	struct block cx_blk;
	394	struct subst cx_subst;
	395	} cx_u;
	396	};
6b35e009 GS	397
6b35e009 GS	398	#define CXTYPEMASK 0xff
79072805 LW	399	#define CXt_NULL 0
	400	#define CXt_SUB 1
	401	#define CXt_EVAL 2
	402	#define CXt_LOOP 3
	403	#define CXt_SUBST 4
	404	#define CXt_BLOCK 5
7766f137	405	#define CXt_FORMAT 6
79072805	406
6b35e009 GS	407	/* private flags for CXt_EVAL */
6b35e009 GS	408	#define CXp_REAL 0x00000100 /* truly eval'', not a lookalike */
1d76a5c3	409	#define CXp_TRYBLOCK 0x00000200 /* eval{}, not eval'' or similar */
6b35e009	410
7766f137 GS	411	#ifdef USE_ITHREADS
	412	/* private flags for CXt_LOOP */
	413	# define CXp_PADVAR 0x00000100 /* itervar lives on pad, iterdata
	414	has pad offset; if not set,
	415	iterdata holds GV* */
	416	# define CxPADLOOP(c) (((c)->cx_type & (CXt_LOOP\|CXp_PADVAR)) \
	417	== (CXt_LOOP\|CXp_PADVAR))
	418	#endif
	419
6b35e009	420	#define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
7766f137 GS	421	#define CxREALEVAL(c) (((c)->cx_type & (CXt_EVAL\|CXp_REAL)) \
7766f137 GS	422	== (CXt_EVAL\|CXp_REAL))
1d76a5c3 GS	423	#define CxTRYBLOCK(c) (((c)->cx_type & (CXt_EVAL\|CXp_TRYBLOCK)) \
1d76a5c3 GS	424	== (CXt_EVAL\|CXp_TRYBLOCK))
6b35e009	425
79072805 LW	426	#define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
79072805 LW	427
ccfc67b7 JH	428	/*
	429	=head1 "Gimme" Values
	430	*/
954c1994 GS	431
	432	/*
	433	=for apidoc AmU\|\|G_SCALAR
	434	Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
	435	L<perlcall>.
	436
	437	=for apidoc AmU\|\|G_ARRAY
91e74348	438	Used to indicate list context. See C<GIMME_V>, C<GIMME> and
954c1994 GS	439	L<perlcall>.
	440
	441	=for apidoc AmU\|\|G_VOID
	442	Used to indicate void context. See C<GIMME_V> and L<perlcall>.
	443
	444	=for apidoc AmU\|\|G_DISCARD
	445	Indicates that arguments returned from a callback should be discarded. See
	446	L<perlcall>.
	447
	448	=for apidoc AmU\|\|G_EVAL
	449
	450	Used to force a Perl C<eval> wrapper around a callback. See
	451	L<perlcall>.
	452
	453	=for apidoc AmU\|\|G_NOARGS
	454
	455	Indicates that no arguments are being sent to a callback. See
	456	L<perlcall>.
	457
	458	=cut
	459	*/
	460
a0d0e21e LW	461	#define G_SCALAR 0
a0d0e21e LW	462	#define G_ARRAY 1
54310121	463	#define G_VOID 128 /* skip this bit when adding flags below */
79072805	464
864dbfa3	465	/* extra flags for Perl_call_* routines */
a0d0e21e LW	466	#define G_DISCARD 2 /* Call FREETMPS. */
	467	#define G_EVAL 4 /* Assume eval {} around subroutine call. */
	468	#define G_NOARGS 8 /* Don't construct a @_ array. */
54310121	469	#define G_KEEPERR 16 /* Append errors to $@, don't overwrite it */
491527d0	470	#define G_NODEBUG 32 /* Disable debugging at toplevel. */
968b3946	471	#define G_METHOD 64 /* Calling method. */
e336de0d	472
faef0170 HS	473	/* flag bits for PL_in_eval */
	474	#define EVAL_NULL 0 /* not in an eval */
	475	#define EVAL_INEVAL 1 /* some enclosing scope is an eval */
	476	#define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */
864dbfa3	477	#define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
6dc8a9e4	478	#define EVAL_INREQUIRE 8 /* The code is being required. */
faef0170	479
e336de0d GS	480	/* Support for switching (stack and block) contexts.
	481	* This ensures magic doesn't invalidate local stack and cx pointers.
	482	*/
	483
e788e7d3 GS	484	#define PERLSI_UNKNOWN -1
	485	#define PERLSI_UNDEF 0
	486	#define PERLSI_MAIN 1
	487	#define PERLSI_MAGIC 2
	488	#define PERLSI_SORT 3
	489	#define PERLSI_SIGNAL 4
	490	#define PERLSI_OVERLOAD 5
	491	#define PERLSI_DESTROY 6
	492	#define PERLSI_WARNHOOK 7
	493	#define PERLSI_DIEHOOK 8
	494	#define PERLSI_REQUIRE 9
e336de0d GS	495
	496	struct stackinfo {
	497	AV * si_stack; /* stack for current runlevel */
	498	PERL_CONTEXT * si_cxstack; /* context stack for runlevel */
	499	I32 si_cxix; /* current context index */
	500	I32 si_cxmax; /* maximum allocated index */
	501	I32 si_type; /* type of runlevel */
	502	struct stackinfo * si_prev;
	503	struct stackinfo * si_next;
ce2f7c3b	504	I32 si_markoff; /* offset where markstack begins for us.
e336de0d GS	505	* currently used only with DEBUGGING,
	506	* but not #ifdef-ed for bincompat */
	507	};
	508
	509	typedef struct stackinfo PERL_SI;
	510
3280af22 NIS	511	#define cxstack (PL_curstackinfo->si_cxstack)
	512	#define cxstack_ix (PL_curstackinfo->si_cxix)
	513	#define cxstack_max (PL_curstackinfo->si_cxmax)
e336de0d GS	514
e336de0d GS	515	#ifdef DEBUGGING
ce2f7c3b GS	516	# define SET_MARK_OFFSET \
ce2f7c3b GS	517	PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
e336de0d	518	#else
ce2f7c3b	519	# define SET_MARK_OFFSET NOOP
e336de0d GS	520	#endif
e336de0d GS	521
d3acc0f7	522	#define PUSHSTACKi(type) \
e336de0d	523	STMT_START { \
3280af22	524	PERL_SI *next = PL_curstackinfo->si_next; \
e336de0d GS	525	if (!next) { \
e336de0d GS	526	next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
3280af22 NIS	527	next->si_prev = PL_curstackinfo; \
3280af22 NIS	528	PL_curstackinfo->si_next = next; \
e336de0d GS	529	} \
	530	next->si_type = type; \
	531	next->si_cxix = -1; \
	532	AvFILLp(next->si_stack) = 0; \
3280af22 NIS	533	SWITCHSTACK(PL_curstack,next->si_stack); \
3280af22 NIS	534	PL_curstackinfo = next; \
ce2f7c3b	535	SET_MARK_OFFSET; \
e336de0d GS	536	} STMT_END
e336de0d GS	537
e788e7d3	538	#define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
d3acc0f7	539
3095d977 GS	540	/* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
3095d977 GS	541	* PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
d3acc0f7	542	#define POPSTACK \
e336de0d	543	STMT_START { \
39644a26	544	dSP; \
3280af22	545	PERL_SI *prev = PL_curstackinfo->si_prev; \
e336de0d	546	if (!prev) { \
bf49b057	547	PerlIO_printf(Perl_error_log, "panic: POPSTACK\n"); \
e336de0d GS	548	my_exit(1); \
e336de0d GS	549	} \
3280af22	550	SWITCHSTACK(PL_curstack,prev->si_stack); \
e336de0d	551	/* don't free prev here, free them all at the END{} */ \
3280af22	552	PL_curstackinfo = prev; \
e336de0d GS	553	} STMT_END
	554
	555	#define POPSTACK_TO(s) \
	556	STMT_START { \
3280af22	557	while (PL_curstack != s) { \
bac4b2ad	558	dounwind(-1); \
d3acc0f7	559	POPSTACK; \
bac4b2ad	560	} \
e336de0d	561	} STMT_END