This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[asperl] add AS patch#13
[perl5.git] / scope.h
CommitLineData
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
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
PP
23#define SAVEt_STACK_POS 22
24#define SAVEt_I16 23
161b7d16
SM
25#define SAVEt_AELEM 24
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
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", \
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", \
54 scopestack_ix, __FILE__, __LINE__))); \
f46d017c
GS
55 pop_scope(); \
56 } STMT_END
57#else
a0d0e21e
LW
58#define ENTER push_scope()
59#define LEAVE pop_scope()
f46d017c 60#endif
8990e307 61#define LEAVE_SCOPE(old) if (savestack_ix > old) leave_scope(old)
a0d0e21e 62
55497cff
PP
63/*
64 * Not using SOFT_CAST on SAVEFREESV and SAVEFREESV
65 * because these are used for several kinds of pointer values
66 */
4fdae800
PP
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
PP
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) \
565764a8 83 save_destructor((DESTRUCTORFUNC)(f),SOFT_CAST(void*)(p))
76e3520e 84#else
565764a8 85#define CALLDESTRUCTOR *SSPOPDPTR
55497cff
PP
86#define SAVEDESTRUCTOR(f,p) \
87 save_destructor(SOFT_CAST(void(*)_((void*)))(f),SOFT_CAST(void*)(p))
76e3520e 88#endif
55497cff
PP
89#define SAVESTACK_POS() STMT_START { \
90 SSCHECK(2); \
91 SSPUSHINT(stack_sp - stack_base); \
92 SSPUSHINT(SAVEt_STACK_POS); \
93 } STMT_END
462e5cf6 94#define SAVEOP() save_op()
54310121
PP
95
96/* A jmpenv packages the state required to perform a proper non-local jump.
97 * Note that there is a start_env initialized when perl starts, and top_env
98 * points to this initially, so top_env should always be non-null.
99 *
100 * Existence of a non-null top_env->je_prev implies it is valid to call
101 * longjmp() at that runlevel (we make sure start_env.je_prev is always
102 * null to ensure this).
103 *
104 * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
105 * establish a local jmpenv to handle exception traps. Care must be taken
106 * to restore the previous value of je_mustcatch before exiting the
107 * stack frame iff JMPENV_PUSH was not called in that stack frame.
108 * GSAR 97-03-27
109 */
110
111struct jmpenv {
112 struct jmpenv * je_prev;
113 Sigjmp_buf je_buf;
114 int je_ret; /* return value of last setjmp() */
115 bool je_mustcatch; /* longjmp()s must be caught locally */
116};
117
118typedef struct jmpenv JMPENV;
119
462e5cf6
MB
120#ifdef OP_IN_REGISTER
121#define OP_REG_TO_MEM opsave = op
122#define OP_MEM_TO_REG op = opsave
123#else
124#define OP_REG_TO_MEM NOOP
125#define OP_MEM_TO_REG NOOP
126#endif
127
54310121 128#define dJMPENV JMPENV cur_env
22921e25
CS
129#define JMPENV_PUSH(v) \
130 STMT_START { \
131 cur_env.je_prev = top_env; \
462e5cf6 132 OP_REG_TO_MEM; \
6ad3d225 133 cur_env.je_ret = PerlProc_setjmp(cur_env.je_buf, 1); \
462e5cf6 134 OP_MEM_TO_REG; \
22921e25
CS
135 top_env = &cur_env; \
136 cur_env.je_mustcatch = FALSE; \
137 (v) = cur_env.je_ret; \
138 } STMT_END
139#define JMPENV_POP \
140 STMT_START { top_env = cur_env.je_prev; } STMT_END
141#define JMPENV_JUMP(v) \
142 STMT_START { \
462e5cf6 143 OP_REG_TO_MEM; \
22921e25 144 if (top_env->je_prev) \
6ad3d225 145 PerlProc_longjmp(top_env->je_buf, (v)); \
22921e25 146 if ((v) == 2) \
6ad3d225 147 PerlProc_exit(STATUS_NATIVE_EXPORT); \
22921e25 148 PerlIO_printf(PerlIO_stderr(), "panic: top_env\n"); \
6ad3d225 149 PerlProc_exit(1); \
22921e25 150 } STMT_END
54310121
PP
151
152#define CATCH_GET (top_env->je_mustcatch)
153#define CATCH_SET(v) (top_env->je_mustcatch = (v))
154