[p5sagit/p5-mst-13.2.git] / cop.h

/*    cop.h
 *
 *    Copyright (c) 1991-1994, 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;
    AV *	savearray;
    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)

/* We muck with cxstack_ix since _dec may call a DESTROY, overwriting cx. */

#define POPSUB(cx)							\
	if (cx->blk_sub.hasargs) {   /* put back old @_ */		\
	    SvREFCNT_dec(GvAV(defgv));					\
	    GvAV(defgv) = cx->blk_sub.savearray;			\
	}								\
	if (cx->blk_sub.cv) {						\
	    if (!(CvDEPTH(cx->blk_sub.cv) = cx->blk_sub.olddepth)) {	\
		cxstack_ix++;						\
		SvREFCNT_dec((SV*)cx->blk_sub.cv);			\
		cxstack_ix--;						\
	    }								\
	}

#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;
    I32		iterix;
};

#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)							\
	newsp		= stack_base + cx->blk_loop.resetsp;		\
	SvREFCNT_dec(cx->blk_loop.iterlval);				\
	if (cx->blk_loop.itervar) {					\
	    SvREFCNT_dec(*cx->blk_loop.itervar);			\
	    *cx->blk_loop.itervar = cx->blk_loop.itersave;		\
	}								\
	if (cx->blk_loop.iterary && cx->blk_loop.iterary != 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 - 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;
    char *	sbu_subbase;
    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_subbase	cx_u.cx_subst.sbu_subbase
#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_rx		= rx,					\
	cx->cx_type		= CXt_SUBST

#define POPSUBST(cx) cxstack_ix--

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

/* 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 $@ rather than overwriting it */
Commit	Line	Data
a0d0e21e	1	/* cop.h
79072805	2	*
a0d0e21e	3	* Copyright (c) 1991-1994, Larry Wall
79072805	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	8	*/
79072805	9
79072805	10	struct cop {
79072805	11	BASEOP
a0d0e21e	12	char * cop_label; /* label for this construct */
79072805	13	HV * cop_stash; /* package line was compiled in */
79072805	14	GV * cop_filegv; /* file the following line # is from */
a0d0e21e	15	U32 cop_seq; /* parse sequence number */
a0d0e21e	16	I32 cop_arybase; /* array base this line was compiled with */
79072805	17	line_t cop_line; /* line # of this command */
79072805	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;
79072805	31	AV * savearray;
	32	AV * argarray;
	33	U16 olddepth;
	34	U8 hasargs;
	35	};
	36
	37	#define PUSHSUB(cx) \
	38	cx->blk_sub.cv = cv; \
79072805	39	cx->blk_sub.olddepth = CvDEPTH(cv); \
	40	cx->blk_sub.hasargs = hasargs;
	41
	42	#define PUSHFORMAT(cx) \
	43	cx->blk_sub.cv = cv; \
	44	cx->blk_sub.gv = gv; \
4633a7c4	45	cx->blk_sub.hasargs = 0; \
463ee0b2	46	cx->blk_sub.dfoutgv = defoutgv; \
4633a7c4	47	(void)SvREFCNT_inc(cx->blk_sub.dfoutgv)
79072805	48
44a8e56a	49	/* We muck with cxstack_ix since _dec may call a DESTROY, overwriting cx. */
44a8e56a	50
79072805	51	#define POPSUB(cx) \
79072805	52	if (cx->blk_sub.hasargs) { /* put back old @_ */ \
a6006777	53	SvREFCNT_dec(GvAV(defgv)); \
79072805	54	GvAV(defgv) = cx->blk_sub.savearray; \
79072805	55	} \
8990e307	56	if (cx->blk_sub.cv) { \
44a8e56a	57	if (!(CvDEPTH(cx->blk_sub.cv) = cx->blk_sub.olddepth)) { \
44a8e56a	58	cxstack_ix++; \
a0d0e21e	59	SvREFCNT_dec((SV*)cx->blk_sub.cv); \
44a8e56a	60	cxstack_ix--; \
44a8e56a	61	} \
79072805	62	}
	63
	64	#define POPFORMAT(cx) \
4633a7c4	65	setdefout(cx->blk_sub.dfoutgv); \
4633a7c4	66	SvREFCNT_dec(cx->blk_sub.dfoutgv);
79072805	67
	68	/* eval context */
	69	struct block_eval {
	70	I32 old_in_eval;
	71	I32 old_op_type;
	72	char * old_name;
	73	OP * old_eval_root;
748a9306	74	SV * cur_text;
79072805	75	};
79072805	76
8990e307	77	#define PUSHEVAL(cx,n,fgv) \
79072805	78	cx->blk_eval.old_in_eval = in_eval; \
	79	cx->blk_eval.old_op_type = op->op_type; \
	80	cx->blk_eval.old_name = n; \
748a9306	81	cx->blk_eval.old_eval_root = eval_root; \
748a9306	82	cx->blk_eval.cur_text = linestr;
79072805	83
	84	#define POPEVAL(cx) \
	85	in_eval = cx->blk_eval.old_in_eval; \
	86	optype = cx->blk_eval.old_op_type; \
	87	eval_root = cx->blk_eval.old_eval_root;
	88
	89	/* loop context */
	90	struct block_loop {
	91	char * label;
	92	I32 resetsp;
	93	OP * redo_op;
	94	OP * next_op;
	95	OP * last_op;
	96	SV ** itervar;
	97	SV * itersave;
5f05dabc	98	SV * iterlval;
79072805	99	AV * iterary;
	100	I32 iterix;
	101	};
	102
	103	#define PUSHLOOP(cx, ivar, s) \
	104	cx->blk_loop.label = curcop->cop_label; \
	105	cx->blk_loop.resetsp = s - stack_base; \
	106	cx->blk_loop.redo_op = cLOOP->op_redoop; \
	107	cx->blk_loop.next_op = cLOOP->op_nextop; \
	108	cx->blk_loop.last_op = cLOOP->op_lastop; \
7a4c00b4	109	if (cx->blk_loop.itervar = (ivar)) \
44a8e56a	110	cx->blk_loop.itersave = SvREFCNT_inc(*cx->blk_loop.itervar);\
	111	cx->blk_loop.iterlval = Nullsv; \
	112	cx->blk_loop.iterary = Nullav; \
	113	cx->blk_loop.iterix = -1;
79072805	114
79072805	115	#define POPLOOP(cx) \
5f05dabc	116	newsp = stack_base + cx->blk_loop.resetsp; \
7a4c00b4	117	SvREFCNT_dec(cx->blk_loop.iterlval); \
	118	if (cx->blk_loop.itervar) { \
	119	SvREFCNT_dec(*cx->blk_loop.itervar); \
	120	*cx->blk_loop.itervar = cx->blk_loop.itersave; \
44a8e56a	121	} \
	122	if (cx->blk_loop.iterary && cx->blk_loop.iterary != curstack) \
	123	SvREFCNT_dec(cx->blk_loop.iterary);
79072805	124
	125	/* context common to subroutines, evals and loops */
	126	struct block {
	127	I32 blku_oldsp; /* stack pointer to copy stuff down to */
	128	COP * blku_oldcop; /* old curcop pointer */
	129	I32 blku_oldretsp; /* return stack index */
	130	I32 blku_oldmarksp; /* mark stack index */
	131	I32 blku_oldscopesp; /* scope stack index */
	132	PMOP * blku_oldpm; /* values of pattern match vars */
	133	U8 blku_gimme; /* is this block running in list context? */
	134
	135	union {
	136	struct block_sub blku_sub;
	137	struct block_eval blku_eval;
	138	struct block_loop blku_loop;
	139	} blk_u;
	140	};
	141	#define blk_oldsp cx_u.cx_blk.blku_oldsp
	142	#define blk_oldcop cx_u.cx_blk.blku_oldcop
	143	#define blk_oldretsp cx_u.cx_blk.blku_oldretsp
	144	#define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
	145	#define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
	146	#define blk_oldpm cx_u.cx_blk.blku_oldpm
	147	#define blk_gimme cx_u.cx_blk.blku_gimme
	148	#define blk_sub cx_u.cx_blk.blk_u.blku_sub
	149	#define blk_eval cx_u.cx_blk.blk_u.blku_eval
	150	#define blk_loop cx_u.cx_blk.blk_u.blku_loop
	151
	152	/* Enter a block. */
8990e307	153	#define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix], \
79072805	154	cx->cx_type = t, \
8990e307	155	cx->blk_oldsp = sp - stack_base, \
79072805	156	cx->blk_oldcop = curcop, \
	157	cx->blk_oldmarksp = markstack_ptr - markstack, \
	158	cx->blk_oldscopesp = scopestack_ix, \
	159	cx->blk_oldretsp = retstack_ix, \
	160	cx->blk_oldpm = curpm, \
	161	cx->blk_gimme = gimme; \
760ac839	162	DEBUG_l( PerlIO_printf(PerlIO_stderr(), "Entering block %ld, type %s\n", \
a0d0e21e	163	(long)cxstack_ix, block_type[t]); )
79072805	164
79072805	165	/* Exit a block (RETURN and LAST). */
a0d0e21e	166	#define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--], \
79072805	167	newsp = stack_base + cx->blk_oldsp, \
	168	curcop = cx->blk_oldcop, \
	169	markstack_ptr = markstack + cx->blk_oldmarksp, \
	170	scopestack_ix = cx->blk_oldscopesp, \
	171	retstack_ix = cx->blk_oldretsp, \
a0d0e21e	172	pm = cx->blk_oldpm, \
79072805	173	gimme = cx->blk_gimme; \
760ac839	174	DEBUG_l( PerlIO_printf(PerlIO_stderr(), "Leaving block %ld, type %s\n", \
a0d0e21e	175	(long)cxstack_ix+1,block_type[cx->cx_type]); )
79072805	176
	177	/* Continue a block elsewhere (NEXT and REDO). */
	178	#define TOPBLOCK(cx) cx = &cxstack[cxstack_ix], \
	179	stack_sp = stack_base + cx->blk_oldsp, \
	180	markstack_ptr = markstack + cx->blk_oldmarksp, \
	181	scopestack_ix = cx->blk_oldscopesp, \
	182	retstack_ix = cx->blk_oldretsp
	183
	184	/* substitution context */
	185	struct subst {
	186	I32 sbu_iters;
	187	I32 sbu_maxiters;
	188	I32 sbu_safebase;
4633a7c4	189	I32 sbu_oldsave;
71be2cbc	190	bool sbu_once;
71be2cbc	191	bool sbu_rxtainted;
79072805	192	char * sbu_orig;
	193	SV * sbu_dstr;
	194	SV * sbu_targ;
	195	char * sbu_s;
	196	char * sbu_m;
	197	char * sbu_strend;
	198	char * sbu_subbase;
c07a80fd	199	REGEXP * sbu_rx;
79072805	200	};
	201	#define sb_iters cx_u.cx_subst.sbu_iters
	202	#define sb_maxiters cx_u.cx_subst.sbu_maxiters
	203	#define sb_safebase cx_u.cx_subst.sbu_safebase
4633a7c4	204	#define sb_oldsave cx_u.cx_subst.sbu_oldsave
71be2cbc	205	#define sb_once cx_u.cx_subst.sbu_once
71be2cbc	206	#define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
79072805	207	#define sb_orig cx_u.cx_subst.sbu_orig
	208	#define sb_dstr cx_u.cx_subst.sbu_dstr
	209	#define sb_targ cx_u.cx_subst.sbu_targ
	210	#define sb_s cx_u.cx_subst.sbu_s
	211	#define sb_m cx_u.cx_subst.sbu_m
	212	#define sb_strend cx_u.cx_subst.sbu_strend
	213	#define sb_subbase cx_u.cx_subst.sbu_subbase
c07a80fd	214	#define sb_rx cx_u.cx_subst.sbu_rx
79072805	215
	216	#define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix], \
	217	cx->sb_iters = iters, \
	218	cx->sb_maxiters = maxiters, \
	219	cx->sb_safebase = safebase, \
4633a7c4	220	cx->sb_oldsave = oldsave, \
71be2cbc	221	cx->sb_once = once, \
71be2cbc	222	cx->sb_rxtainted = rxtainted, \
79072805	223	cx->sb_orig = orig, \
	224	cx->sb_dstr = dstr, \
	225	cx->sb_targ = targ, \
	226	cx->sb_s = s, \
	227	cx->sb_m = m, \
	228	cx->sb_strend = strend, \
c07a80fd	229	cx->sb_rx = rx, \
79072805	230	cx->cx_type = CXt_SUBST
	231
	232	#define POPSUBST(cx) cxstack_ix--
	233
	234	struct context {
	235	I32 cx_type; /* what kind of context this is */
	236	union {
	237	struct block cx_blk;
	238	struct subst cx_subst;
	239	} cx_u;
	240	};
	241	#define CXt_NULL 0
	242	#define CXt_SUB 1
	243	#define CXt_EVAL 2
	244	#define CXt_LOOP 3
	245	#define CXt_SUBST 4
	246	#define CXt_BLOCK 5
	247
	248	#define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
	249
	250	/* "gimme" values */
a0d0e21e	251	#define G_SCALAR 0
a0d0e21e	252	#define G_ARRAY 1
79072805	253
a0d0e21e	254	/* extra flags for perl_call_* routines */
	255	#define G_DISCARD 2 /* Call FREETMPS. */
	256	#define G_EVAL 4 /* Assume eval {} around subroutine call. */
	257	#define G_NOARGS 8 /* Don't construct a @_ array. */
4633a7c4	258	#define G_KEEPERR 16 /* Append errors to $@ rather than overwriting it */