[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 */
};

#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 = 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(defgv));					\
	GvAV(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 = in_eval;				\
	cx->blk_eval.old_op_type = op->op_type;				\
	cx->blk_eval.old_name = n;					\
	cx->blk_eval.old_eval_root = eval_root;				\
	cx->blk_eval.cur_text = linestr;

#define POPEVAL(cx)							\
	in_eval = cx->blk_eval.old_in_eval;				\
	optype = cx->blk_eval.old_op_type;				\
	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 = curcop->cop_label;				\
	cx->blk_loop.resetsp = s - 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 = stack_base + cxloop.resetsp;

#define POPLOOP2()							\
	SvREFCNT_dec(cxloop.iterlval);					\
	if (cxloop.itervar) {						\
	    SvREFCNT_dec(*cxloop.itervar);				\
	    *cxloop.itervar = cxloop.itersave;				\
	}								\
	if (cxloop.iterary && cxloop.iterary != 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 - stack_base,			\
	cx->blk_oldcop		= curcop,				\
	cx->blk_oldmarksp	= markstack_ptr - markstack,		\
	cx->blk_oldscopesp	= scopestack_ix,			\
	cx->blk_oldretsp	= retstack_ix,				\
	cx->blk_oldpm		= curpm,				\
	cx->blk_gimme		= gimme;				\
	DEBUG_l( PerlIO_printf(PerlIO_stderr(), "Entering block %ld, type %s\n",	\
		    (long)cxstack_ix, block_type[t]); )

/* Exit a block (RETURN and LAST). */
#define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--],			\
	newsp		= stack_base + cx->blk_oldsp,			\
	curcop		= cx->blk_oldcop,				\
	markstack_ptr	= markstack + cx->blk_oldmarksp,		\
	scopestack_ix	= cx->blk_oldscopesp,				\
	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,block_type[cx->cx_type]); )

/* Continue a block elsewhere (NEXT and REDO). */
#define TOPBLOCK(cx) cx = &cxstack[cxstack_ix],				\
	stack_sp	= stack_base + cx->blk_oldsp,			\
	markstack_ptr	= markstack + cx->blk_oldmarksp,		\
	scopestack_ix	= cx->blk_oldscopesp,				\
	retstack_ix	= cx->blk_oldretsp

/* 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 {
    I32		cx_type;	/* what kind of context this is */
    union {
	struct block	cx_blk;
	struct subst	cx_subst;
    } cx_u;
};
#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 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		(curstackinfo->si_cxstack)
#define cxstack_ix	(curstackinfo->si_cxix)
#define cxstack_max	(curstackinfo->si_cxmax)

#ifdef DEBUGGING
#  define	SET_MARKBASE curstackinfo->si_markbase = markstack_ptr
#else
#  define	SET_MARKBASE NOOP
#endif

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

#define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)

#define POPSTACK \
    STMT_START {							\
	PERL_SI *prev = curstackinfo->si_prev;				\
	if (!prev) {							\
	    PerlIO_printf(PerlIO_stderr(), "panic: POPSTACK\n");	\
	    my_exit(1);							\
	}								\
	SWITCHSTACK(curstack,prev->si_stack);				\
	/* don't free prev here, free them all at the END{} */		\
	curstackinfo = prev;						\
    } STMT_END

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