[perl5.git] / cop.h

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

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

#define Nullcop Null(COP*)

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

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

#define PUSHSUB(cx)							\
	cx->blk_sub.cv = cv;						\
	cx->blk_sub.olddepth = CvDEPTH(cv);				\
	cx->blk_sub.hasargs = hasargs;

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

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

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

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

#define POPSUB2()							\
	if (cxsub.hasargs) {						\
	    POPSAVEARRAY();						\
	    /* destroy arg array */					\
	    av_clear(cxsub.argarray);					\
	    AvREAL_off(cxsub.argarray);					\
	}								\
	if (cxsub.cv) {							\
	    if (!(CvDEPTH(cxsub.cv) = cxsub.olddepth))			\
		SvREFCNT_dec(cxsub.cv);					\
	}

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

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

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

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

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

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

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

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

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

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

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

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

/* 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(PerlIO_stderr(), "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_safebase;
    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_safebase	cx_u.cx_subst.sbu_safebase
#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_safebase		= safebase,				\
	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.  */

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

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

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

typedef struct stackinfo PERL_SI;

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

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

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

#define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)

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