[perl5.git] / scope.h

#define SAVEt_ITEM	0
#define SAVEt_SV	1
#define SAVEt_AV	2
#define SAVEt_HV	3
#define SAVEt_INT	4
#define SAVEt_LONG	5
#define SAVEt_I32	6
#define SAVEt_IV	7
#define SAVEt_SPTR	8
#define SAVEt_APTR	9
#define SAVEt_HPTR	10
#define SAVEt_PPTR	11
#define SAVEt_NSTAB	12
#define SAVEt_SVREF	13
#define SAVEt_GP	14
#define SAVEt_FREESV	15
#define SAVEt_FREEOP	16
#define SAVEt_FREEPV	17
#define SAVEt_CLEARSV	18
#define SAVEt_DELETE	19
#define SAVEt_DESTRUCTOR 20
#define SAVEt_REGCONTEXT 21
#define SAVEt_STACK_POS  22
#define SAVEt_I16	23
#define SAVEt_AELEM     24
#define SAVEt_HELEM     25
#define SAVEt_OP	26

#define SSCHECK(need) if (savestack_ix + need > savestack_max) savestack_grow()
#define SSPUSHINT(i) (savestack[savestack_ix++].any_i32 = (I32)(i))
#define SSPUSHLONG(i) (savestack[savestack_ix++].any_long = (long)(i))
#define SSPUSHIV(i) (savestack[savestack_ix++].any_iv = (IV)(i))
#define SSPUSHPTR(p) (savestack[savestack_ix++].any_ptr = (void*)(p))
#define SSPUSHDPTR(p) (savestack[savestack_ix++].any_dptr = (p))
#define SSPOPINT (savestack[--savestack_ix].any_i32)
#define SSPOPLONG (savestack[--savestack_ix].any_long)
#define SSPOPIV (savestack[--savestack_ix].any_iv)
#define SSPOPPTR (savestack[--savestack_ix].any_ptr)
#define SSPOPDPTR (savestack[--savestack_ix].any_dptr)

#define SAVETMPS save_int((int*)&tmps_floor), tmps_floor = tmps_ix
#define FREETMPS if (tmps_ix > tmps_floor) free_tmps()

#ifdef DEBUGGING
#define ENTER							\
    STMT_START {						\
	push_scope();						\
	DEBUG_l(WITH_THR(deb("ENTER scope %ld at %s:%d\n",	\
		    scopestack_ix, __FILE__, __LINE__)));	\
    } STMT_END
#define LEAVE							\
    STMT_START {						\
	DEBUG_l(WITH_THR(deb("LEAVE scope %ld at %s:%d\n",	\
		    scopestack_ix, __FILE__, __LINE__)));	\
	pop_scope();						\
    } STMT_END
#else
#define ENTER push_scope()
#define LEAVE pop_scope()
#endif
#define LEAVE_SCOPE(old) if (savestack_ix > old) leave_scope(old)

/*
 * Not using SOFT_CAST on SAVEFREESV and SAVEFREESV
 * because these are used for several kinds of pointer values
 */
#define SAVEI16(i)	save_I16(SOFT_CAST(I16*)&(i))
#define SAVEI32(i)	save_I32(SOFT_CAST(I32*)&(i))
#define SAVEINT(i)	save_int(SOFT_CAST(int*)&(i))
#define SAVEIV(i)	save_iv(SOFT_CAST(IV*)&(i))
#define SAVELONG(l)	save_long(SOFT_CAST(long*)&(l))
#define SAVESPTR(s)	save_sptr((SV**)&(s))
#define SAVEPPTR(s)	save_pptr(SOFT_CAST(char**)&(s))
#define SAVEFREESV(s)	save_freesv((SV*)(s))
#define SAVEFREEOP(o)	save_freeop(SOFT_CAST(OP*)(o))
#define SAVEFREEPV(p)	save_freepv(SOFT_CAST(char*)(p))
#define SAVECLEARSV(sv)	save_clearsv(SOFT_CAST(SV**)&(sv))
#define SAVEDELETE(h,k,l) \
	  save_delete(SOFT_CAST(HV*)(h), SOFT_CAST(char*)(k), (I32)(l))
#ifdef PERL_OBJECT
#define CALLDESTRUCTOR this->*SSPOPDPTR
#define SAVEDESTRUCTOR(f,p) \
	  save_destructor((DESTRUCTORFUNC)(FUNC_NAME_TO_PTR(f)),	\
			  SOFT_CAST(void*)(p))
#else
#define CALLDESTRUCTOR *SSPOPDPTR
#define SAVEDESTRUCTOR(f,p) \
	  save_destructor(SOFT_CAST(void(*)_((void*)))(FUNC_NAME_TO_PTR(f)), \
			  SOFT_CAST(void*)(p))
#endif
#define SAVESTACK_POS() STMT_START {	\
    SSCHECK(2);				\
    SSPUSHINT(stack_sp - stack_base);	\
    SSPUSHINT(SAVEt_STACK_POS);		\
 } STMT_END
#define SAVEOP()	save_op()

/* A jmpenv packages the state required to perform a proper non-local jump.
 * Note that there is a start_env initialized when perl starts, and top_env
 * points to this initially, so top_env should always be non-null.
 *
 * Existence of a non-null top_env->je_prev implies it is valid to call
 * (*je_jump)() at that runlevel.  Always use the macros below!  They
 * manage most of the complexity for you.
 *
 * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
 * establish a local jmpenv to handle exception traps.  Care must be taken
 * to restore the previous value of je_mustcatch before exiting the
 * stack frame iff JMPENV_PUSH was not called in that stack frame.
 *
 * The support for C++ try/throw causes a small loss of flexibility.
 * No longer is it possible to place the body of exception-protected
 * code in the same C function as JMPENV_PUSH &etc.  Older code that
 * does this will continue to work with set/longjmp, but cannot use
 * C++ exceptions.
 *
 * GSAR  19970327
 * JPRIT 19980613 (C++ update)
 */

#define JMP_NORMAL	0
#define JMP_ABNORMAL	1	/* shouldn't happen */
#define JMP_MYEXIT	2	/* exit */
#define JMP_EXCEPTION	3	/* die */

/* None of the JMPENV fields should be accessed directly.
   Please use the macros below! */
struct jmpenv {
    struct jmpenv *	je_prev;
    int			je_stat;	/* JMP_* reason for setjmp() */
    bool		je_mustcatch;	/* will need a new TRYBLOCK? */
    void		(*je_jump) _((CPERLproto));
};
typedef struct jmpenv JMPENV;

struct tryvtbl {
    /* [0] executed before JMPENV_POP
       [1] executed after JMPENV_POP
           (NULL pointers are OK) */
    char *try_context;
    void (*try_normal    [2]) _((CPERLproto_ void*));
    void (*try_abnormal  [2]) _((CPERLproto_ void*));
    void (*try_exception [2]) _((CPERLproto_ void*));
    void (*try_myexit    [2]) _((CPERLproto_ void*));
};
typedef struct tryvtbl TRYVTBL;

typedef void (*tryblock_f) _((CPERLproto_ TRYVTBL *vtbl, void *locals));
#define TRYBLOCK(mytry,vars) \
	(*tryblock_function)(PERL_OBJECT_THIS_ &mytry, &vars)

#ifdef OP_IN_REGISTER
#define OP_REG_TO_MEM	opsave = op
#define OP_MEM_TO_REG	op = opsave
#else
#define OP_REG_TO_MEM	NOOP
#define OP_MEM_TO_REG	NOOP
#endif

#define JMPENV_TOPINIT(top)			\
STMT_START {					\
    top.je_prev = NULL;				\
    top.je_stat = JMP_ABNORMAL;			\
    top.je_mustcatch = TRUE;			\
    top_env = &top;				\
} STMT_END

#define JMPENV_INIT(env, jmp)			\
STMT_START {					\
    ((JMPENV*)&env)->je_prev = top_env;		\
    ((JMPENV*)&env)->je_stat = JMP_NORMAL;	\
    ((JMPENV*)&env)->je_jump = jmp;		\
    OP_REG_TO_MEM;				\
} STMT_END

#define JMPENV_TRY(env)				\
STMT_START {					\
    OP_MEM_TO_REG;				\
    ((JMPENV*)&env)->je_mustcatch = FALSE;	\
    top_env = (JMPENV*)&env;			\
} STMT_END

#define JMPENV_POP_JE(env)			\
STMT_START {					\
	assert(top_env == (JMPENV*)&env);	\
	top_env = ((JMPENV*)&env)->je_prev;	\
} STMT_END

#define JMPENV_STAT(env) ((JMPENV*)&env)->je_stat

#define JMPENV_JUMP(v) \
    STMT_START {						\
	assert((v) != JMP_NORMAL);				\
	OP_REG_TO_MEM;						\
	if (top_env->je_prev) {					\
	    top_env->je_stat = (v);				\
	    (*top_env->je_jump)(PERL_OBJECT_THIS);		\
	}							\
	if ((v) == JMP_MYEXIT)					\
	    PerlProc_exit(STATUS_NATIVE_EXPORT);		\
	PerlIO_printf(PerlIO_stderr(), no_top_env);		\
	PerlProc_exit(1);					\
    } STMT_END
   
#define CATCH_GET	(top_env->je_mustcatch)
#define CATCH_SET(v)	(top_env->je_mustcatch = (v))


/*******************************************************************
 * JMPENV_PUSH is the old depreciated API.  See perl.c for examples
 *  of the new API.
 */

struct setjmpenv {
    /* move to scope.c once JMPENV_PUSH is no longer needed XXX */
    JMPENV		je0;
    Sigjmp_buf		je_buf;		
};
typedef struct setjmpenv SETJMPENV;

#define dJMPENV		SETJMPENV cur_env

extern void setjmp_jump();

#define JMPENV_PUSH(v) \
    STMT_START {					\
	JMPENV_INIT(cur_env, setjmp_jump);		\
	PerlProc_setjmp(cur_env.je_buf, 1);		\
	JMPENV_TRY(cur_env);				\
	(v) = JMPENV_STAT(cur_env);			\
    } STMT_END

#define JMPENV_POP				\
STMT_START {					\
	assert(top_env == (JMPENV*) &cur_env);	\
	top_env = cur_env.je0.je_prev;		\
} STMT_END
Commit	Line	Data
79072805 LW	1	#define SAVEt_ITEM 0
	2	#define SAVEt_SV 1
	3	#define SAVEt_AV 2
	4	#define SAVEt_HV 3
	5	#define SAVEt_INT 4
85e6fe83 LW	6	#define SAVEt_LONG 5
85e6fe83 LW	7	#define SAVEt_I32 6
a0d0e21e LW	8	#define SAVEt_IV 7
	9	#define SAVEt_SPTR 8
	10	#define SAVEt_APTR 9
	11	#define SAVEt_HPTR 10
	12	#define SAVEt_PPTR 11
	13	#define SAVEt_NSTAB 12
	14	#define SAVEt_SVREF 13
	15	#define SAVEt_GP 14
	16	#define SAVEt_FREESV 15
	17	#define SAVEt_FREEOP 16
	18	#define SAVEt_FREEPV 17
	19	#define SAVEt_CLEARSV 18
	20	#define SAVEt_DELETE 19
	21	#define SAVEt_DESTRUCTOR 20
	22	#define SAVEt_REGCONTEXT 21
55497cff	23	#define SAVEt_STACK_POS 22
55497cff	24	#define SAVEt_I16 23
161b7d16 SM	25	#define SAVEt_AELEM 24
161b7d16 SM	26	#define SAVEt_HELEM 25
5d863698	27	#define SAVEt_OP 26
79072805 LW	28
	29	#define SSCHECK(need) if (savestack_ix + need > savestack_max) savestack_grow()
	30	#define SSPUSHINT(i) (savestack[savestack_ix++].any_i32 = (I32)(i))
85e6fe83	31	#define SSPUSHLONG(i) (savestack[savestack_ix++].any_long = (long)(i))
a0d0e21e	32	#define SSPUSHIV(i) (savestack[savestack_ix++].any_iv = (IV)(i))
79072805	33	#define SSPUSHPTR(p) (savestack[savestack_ix++].any_ptr = (void*)(p))
a0d0e21e	34	#define SSPUSHDPTR(p) (savestack[savestack_ix++].any_dptr = (p))
79072805	35	#define SSPOPINT (savestack[--savestack_ix].any_i32)
85e6fe83	36	#define SSPOPLONG (savestack[--savestack_ix].any_long)
a0d0e21e	37	#define SSPOPIV (savestack[--savestack_ix].any_iv)
79072805	38	#define SSPOPPTR (savestack[--savestack_ix].any_ptr)
a0d0e21e	39	#define SSPOPDPTR (savestack[--savestack_ix].any_dptr)
8990e307	40
a0d0e21e LW	41	#define SAVETMPS save_int((int*)&tmps_floor), tmps_floor = tmps_ix
a0d0e21e LW	42	#define FREETMPS if (tmps_ix > tmps_floor) free_tmps()
a0d0e21e	43
f46d017c GS	44	#ifdef DEBUGGING
	45	#define ENTER \
	46	STMT_START { \
	47	push_scope(); \
f3dc24a5 MB	48	DEBUG_l(WITH_THR(deb("ENTER scope %ld at %s:%d\n", \
f3dc24a5 MB	49	scopestack_ix, __FILE__, __LINE__))); \
f46d017c GS	50	} STMT_END
	51	#define LEAVE \
	52	STMT_START { \
f3dc24a5 MB	53	DEBUG_l(WITH_THR(deb("LEAVE scope %ld at %s:%d\n", \
f3dc24a5 MB	54	scopestack_ix, __FILE__, __LINE__))); \
f46d017c GS	55	pop_scope(); \
	56	} STMT_END
	57	#else
a0d0e21e LW	58	#define ENTER push_scope()
a0d0e21e LW	59	#define LEAVE pop_scope()
f46d017c	60	#endif
8990e307	61	#define LEAVE_SCOPE(old) if (savestack_ix > old) leave_scope(old)
a0d0e21e	62
55497cff	63	/*
	64	* Not using SOFT_CAST on SAVEFREESV and SAVEFREESV
	65	* because these are used for several kinds of pointer values
	66	*/
4fdae800	67	#define SAVEI16(i) save_I16(SOFT_CAST(I16*)&(i))
	68	#define SAVEI32(i) save_I32(SOFT_CAST(I32*)&(i))
	69	#define SAVEINT(i) save_int(SOFT_CAST(int*)&(i))
	70	#define SAVEIV(i) save_iv(SOFT_CAST(IV*)&(i))
	71	#define SAVELONG(l) save_long(SOFT_CAST(long*)&(l))
55497cff	72	#define SAVESPTR(s) save_sptr((SV**)&(s))
	73	#define SAVEPPTR(s) save_pptr(SOFT_CAST(char**)&(s))
	74	#define SAVEFREESV(s) save_freesv((SV*)(s))
	75	#define SAVEFREEOP(o) save_freeop(SOFT_CAST(OP*)(o))
	76	#define SAVEFREEPV(p) save_freepv(SOFT_CAST(char*)(p))
	77	#define SAVECLEARSV(sv) save_clearsv(SOFT_CAST(SV**)&(sv))
	78	#define SAVEDELETE(h,k,l) \
	79	save_delete(SOFT_CAST(HV)(h), SOFT_CAST(char)(k), (I32)(l))
76e3520e	80	#ifdef PERL_OBJECT
565764a8	81	#define CALLDESTRUCTOR this->*SSPOPDPTR
76e3520e	82	#define SAVEDESTRUCTOR(f,p) \
ac4c12e7 GS	83	save_destructor((DESTRUCTORFUNC)(FUNC_NAME_TO_PTR(f)), \
ac4c12e7 GS	84	SOFT_CAST(void*)(p))
76e3520e	85	#else
565764a8	86	#define CALLDESTRUCTOR *SSPOPDPTR
55497cff	87	#define SAVEDESTRUCTOR(f,p) \
ac4c12e7 GS	88	save_destructor(SOFT_CAST(void()_((void)))(FUNC_NAME_TO_PTR(f)), \
ac4c12e7 GS	89	SOFT_CAST(void*)(p))
76e3520e	90	#endif
55497cff	91	#define SAVESTACK_POS() STMT_START { \
	92	SSCHECK(2); \
	93	SSPUSHINT(stack_sp - stack_base); \
	94	SSPUSHINT(SAVEt_STACK_POS); \
	95	} STMT_END
462e5cf6	96	#define SAVEOP() save_op()
54310121	97
	98	/* A jmpenv packages the state required to perform a proper non-local jump.
	99	* Note that there is a start_env initialized when perl starts, and top_env
	100	* points to this initially, so top_env should always be non-null.
	101	*
	102	* Existence of a non-null top_env->je_prev implies it is valid to call
1163b5c4 JP	103	* (*je_jump)() at that runlevel. Always use the macros below! They
1163b5c4 JP	104	* manage most of the complexity for you.
54310121	105	*
	106	* je_mustcatch, when set at any runlevel to TRUE, means eval ops must
	107	* establish a local jmpenv to handle exception traps. Care must be taken
	108	* to restore the previous value of je_mustcatch before exiting the
	109	* stack frame iff JMPENV_PUSH was not called in that stack frame.
1163b5c4 JP	110	*
	111	* The support for C++ try/throw causes a small loss of flexibility.
	112	* No longer is it possible to place the body of exception-protected
	113	* code in the same C function as JMPENV_PUSH &etc. Older code that
	114	* does this will continue to work with set/longjmp, but cannot use
	115	* C++ exceptions.
	116	*
	117	* GSAR 19970327
	118	* JPRIT 19980613 (C++ update)
54310121	119	*/
54310121	120
1163b5c4 JP	121	#define JMP_NORMAL 0
	122	#define JMP_ABNORMAL 1 /* shouldn't happen */
	123	#define JMP_MYEXIT 2 /* exit */
	124	#define JMP_EXCEPTION 3 /* die */
	125
	126	/* None of the JMPENV fields should be accessed directly.
	127	Please use the macros below! */
54310121	128	struct jmpenv {
54310121	129	struct jmpenv * je_prev;
1163b5c4 JP	130	int je_stat; /* JMP_* reason for setjmp() */
	131	bool je_mustcatch; /* will need a new TRYBLOCK? */
	132	void (*je_jump) _((CPERLproto));
54310121	133	};
54310121	134	typedef struct jmpenv JMPENV;
54310121	135
1163b5c4 JP	136	struct tryvtbl {
	137	/* [0] executed before JMPENV_POP
	138	[1] executed after JMPENV_POP
	139	(NULL pointers are OK) */
	140	char *try_context;
	141	void (try_normal [2]) _((CPERLproto_ void));
	142	void (try_abnormal [2]) _((CPERLproto_ void));
	143	void (try_exception [2]) _((CPERLproto_ void));
	144	void (try_myexit [2]) _((CPERLproto_ void));
	145	};
	146	typedef struct tryvtbl TRYVTBL;
	147
	148	typedef void (tryblock_f) _((CPERLproto_ TRYVTBL vtbl, void *locals));
	149	#define TRYBLOCK(mytry,vars) \
	150	(*tryblock_function)(PERL_OBJECT_THIS_ &mytry, &vars)
	151
462e5cf6 MB	152	#ifdef OP_IN_REGISTER
	153	#define OP_REG_TO_MEM opsave = op
	154	#define OP_MEM_TO_REG op = opsave
	155	#else
	156	#define OP_REG_TO_MEM NOOP
	157	#define OP_MEM_TO_REG NOOP
	158	#endif
	159
1163b5c4 JP	160	#define JMPENV_TOPINIT(top) \
	161	STMT_START { \
	162	top.je_prev = NULL; \
	163	top.je_stat = JMP_ABNORMAL; \
	164	top.je_mustcatch = TRUE; \
	165	top_env = &top; \
	166	} STMT_END
	167
	168	#define JMPENV_INIT(env, jmp) \
	169	STMT_START { \
	170	((JMPENV*)&env)->je_prev = top_env; \
	171	((JMPENV*)&env)->je_stat = JMP_NORMAL; \
	172	((JMPENV*)&env)->je_jump = jmp; \
	173	OP_REG_TO_MEM; \
	174	} STMT_END
	175
	176	#define JMPENV_TRY(env) \
	177	STMT_START { \
	178	OP_MEM_TO_REG; \
	179	((JMPENV*)&env)->je_mustcatch = FALSE; \
	180	top_env = (JMPENV*)&env; \
	181	} STMT_END
	182
	183	#define JMPENV_POP_JE(env) \
	184	STMT_START { \
	185	assert(top_env == (JMPENV*)&env); \
	186	top_env = ((JMPENV*)&env)->je_prev; \
	187	} STMT_END
	188
	189	#define JMPENV_STAT(env) ((JMPENV*)&env)->je_stat
	190
22921e25 CS	191	#define JMPENV_JUMP(v) \
22921e25 CS	192	STMT_START { \
1163b5c4	193	assert((v) != JMP_NORMAL); \
462e5cf6	194	OP_REG_TO_MEM; \
1163b5c4 JP	195	if (top_env->je_prev) { \
	196	top_env->je_stat = (v); \
	197	(*top_env->je_jump)(PERL_OBJECT_THIS); \
	198	} \
	199	if ((v) == JMP_MYEXIT) \
	200	PerlProc_exit(STATUS_NATIVE_EXPORT); \
	201	PerlIO_printf(PerlIO_stderr(), no_top_env); \
	202	PerlProc_exit(1); \
22921e25	203	} STMT_END
54310121	204
	205	#define CATCH_GET (top_env->je_mustcatch)
	206	#define CATCH_SET(v) (top_env->je_mustcatch = (v))
1163b5c4 JP	207
	208
	209
	210	/*******************************************************************
	211	* JMPENV_PUSH is the old depreciated API. See perl.c for examples
	212	* of the new API.
	213	*/
	214
	215	struct setjmpenv {
	216	/* move to scope.c once JMPENV_PUSH is no longer needed XXX */
	217	JMPENV je0;
	218	Sigjmp_buf je_buf;
	219	};
	220	typedef struct setjmpenv SETJMPENV;
	221
	222	#define dJMPENV SETJMPENV cur_env
	223
	224	extern void setjmp_jump();
	225
	226	#define JMPENV_PUSH(v) \
	227	STMT_START { \
	228	JMPENV_INIT(cur_env, setjmp_jump); \
	229	PerlProc_setjmp(cur_env.je_buf, 1); \
	230	JMPENV_TRY(cur_env); \
	231	(v) = JMPENV_STAT(cur_env); \
	232	} STMT_END
	233
	234	#define JMPENV_POP \
	235	STMT_START { \
	236	assert(top_env == (JMPENV*) &cur_env); \
	237	top_env = cur_env.je0.je_prev; \
	238	} STMT_END
	239