This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
update Changes and perlhist.pod
[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
b3ac6de7 28#define SAVEt_NOHINTS 27
79072805
LW
29
30#define SSCHECK(need) if (savestack_ix + need > savestack_max) savestack_grow()
31#define SSPUSHINT(i) (savestack[savestack_ix++].any_i32 = (I32)(i))
85e6fe83 32#define SSPUSHLONG(i) (savestack[savestack_ix++].any_long = (long)(i))
a0d0e21e 33#define SSPUSHIV(i) (savestack[savestack_ix++].any_iv = (IV)(i))
79072805 34#define SSPUSHPTR(p) (savestack[savestack_ix++].any_ptr = (void*)(p))
a0d0e21e 35#define SSPUSHDPTR(p) (savestack[savestack_ix++].any_dptr = (p))
79072805 36#define SSPOPINT (savestack[--savestack_ix].any_i32)
85e6fe83 37#define SSPOPLONG (savestack[--savestack_ix].any_long)
a0d0e21e 38#define SSPOPIV (savestack[--savestack_ix].any_iv)
79072805 39#define SSPOPPTR (savestack[--savestack_ix].any_ptr)
a0d0e21e 40#define SSPOPDPTR (savestack[--savestack_ix].any_dptr)
8990e307 41
a0d0e21e
LW
42#define SAVETMPS save_int((int*)&tmps_floor), tmps_floor = tmps_ix
43#define FREETMPS if (tmps_ix > tmps_floor) free_tmps()
a0d0e21e 44
f46d017c
GS
45#ifdef DEBUGGING
46#define ENTER \
47 STMT_START { \
48 push_scope(); \
f3dc24a5
MB
49 DEBUG_l(WITH_THR(deb("ENTER scope %ld at %s:%d\n", \
50 scopestack_ix, __FILE__, __LINE__))); \
f46d017c
GS
51 } STMT_END
52#define LEAVE \
53 STMT_START { \
f3dc24a5
MB
54 DEBUG_l(WITH_THR(deb("LEAVE scope %ld at %s:%d\n", \
55 scopestack_ix, __FILE__, __LINE__))); \
f46d017c
GS
56 pop_scope(); \
57 } STMT_END
58#else
a0d0e21e
LW
59#define ENTER push_scope()
60#define LEAVE pop_scope()
f46d017c 61#endif
8990e307 62#define LEAVE_SCOPE(old) if (savestack_ix > old) leave_scope(old)
a0d0e21e 63
55497cff
PP
64/*
65 * Not using SOFT_CAST on SAVEFREESV and SAVEFREESV
66 * because these are used for several kinds of pointer values
67 */
4fdae800
PP
68#define SAVEI16(i) save_I16(SOFT_CAST(I16*)&(i))
69#define SAVEI32(i) save_I32(SOFT_CAST(I32*)&(i))
70#define SAVEINT(i) save_int(SOFT_CAST(int*)&(i))
71#define SAVEIV(i) save_iv(SOFT_CAST(IV*)&(i))
72#define SAVELONG(l) save_long(SOFT_CAST(long*)&(l))
55497cff
PP
73#define SAVESPTR(s) save_sptr((SV**)&(s))
74#define SAVEPPTR(s) save_pptr(SOFT_CAST(char**)&(s))
75#define SAVEFREESV(s) save_freesv((SV*)(s))
76#define SAVEFREEOP(o) save_freeop(SOFT_CAST(OP*)(o))
77#define SAVEFREEPV(p) save_freepv(SOFT_CAST(char*)(p))
78#define SAVECLEARSV(sv) save_clearsv(SOFT_CAST(SV**)&(sv))
79#define SAVEDELETE(h,k,l) \
80 save_delete(SOFT_CAST(HV*)(h), SOFT_CAST(char*)(k), (I32)(l))
76e3520e 81#ifdef PERL_OBJECT
565764a8 82#define CALLDESTRUCTOR this->*SSPOPDPTR
76e3520e 83#define SAVEDESTRUCTOR(f,p) \
ac4c12e7
GS
84 save_destructor((DESTRUCTORFUNC)(FUNC_NAME_TO_PTR(f)), \
85 SOFT_CAST(void*)(p))
76e3520e 86#else
565764a8 87#define CALLDESTRUCTOR *SSPOPDPTR
55497cff 88#define SAVEDESTRUCTOR(f,p) \
ac4c12e7
GS
89 save_destructor(SOFT_CAST(void(*)_((void*)))(FUNC_NAME_TO_PTR(f)), \
90 SOFT_CAST(void*)(p))
76e3520e 91#endif
55497cff
PP
92#define SAVESTACK_POS() STMT_START { \
93 SSCHECK(2); \
94 SSPUSHINT(stack_sp - stack_base); \
95 SSPUSHINT(SAVEt_STACK_POS); \
96 } STMT_END
462e5cf6 97#define SAVEOP() save_op()
b3ac6de7
IZ
98#define SAVEHINTS() STMT_START { \
99 if (hints & HINT_LOCALIZE_HH) \
100 save_hints(); \
101 else { \
a9332b4a 102 SSCHECK(2); \
b3ac6de7
IZ
103 SSPUSHINT(hints); \
104 SSPUSHINT(SAVEt_NOHINTS); \
105 } \
106 } STMT_END
a9332b4a 107
54310121
PP
108/* A jmpenv packages the state required to perform a proper non-local jump.
109 * Note that there is a start_env initialized when perl starts, and top_env
110 * points to this initially, so top_env should always be non-null.
111 *
112 * Existence of a non-null top_env->je_prev implies it is valid to call
6224f72b
GS
113 * longjmp() at that runlevel (we make sure start_env.je_prev is always
114 * null to ensure this).
54310121
PP
115 *
116 * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
117 * establish a local jmpenv to handle exception traps. Care must be taken
118 * to restore the previous value of je_mustcatch before exiting the
119 * stack frame iff JMPENV_PUSH was not called in that stack frame.
6224f72b 120 * GSAR 97-03-27
54310121
PP
121 */
122
123struct jmpenv {
124 struct jmpenv * je_prev;
6224f72b
GS
125 Sigjmp_buf je_buf;
126 int je_ret; /* return value of last setjmp() */
127 bool je_mustcatch; /* longjmp()s must be caught locally */
1163b5c4 128};
1163b5c4 129
6224f72b 130typedef struct jmpenv JMPENV;
1163b5c4 131
462e5cf6
MB
132#ifdef OP_IN_REGISTER
133#define OP_REG_TO_MEM opsave = op
134#define OP_MEM_TO_REG op = opsave
135#else
136#define OP_REG_TO_MEM NOOP
137#define OP_MEM_TO_REG NOOP
138#endif
139
6224f72b
GS
140#define dJMPENV JMPENV cur_env
141#define JMPENV_PUSH(v) \
142 STMT_START { \
143 cur_env.je_prev = top_env; \
144 OP_REG_TO_MEM; \
145 cur_env.je_ret = PerlProc_setjmp(cur_env.je_buf, 1); \
146 OP_MEM_TO_REG; \
147 top_env = &cur_env; \
148 cur_env.je_mustcatch = FALSE; \
149 (v) = cur_env.je_ret; \
150 } STMT_END
151#define JMPENV_POP \
152 STMT_START { top_env = cur_env.je_prev; } STMT_END
22921e25
CS
153#define JMPENV_JUMP(v) \
154 STMT_START { \
462e5cf6 155 OP_REG_TO_MEM; \
6224f72b
GS
156 if (top_env->je_prev) \
157 PerlProc_longjmp(top_env->je_buf, (v)); \
158 if ((v) == 2) \
159 PerlProc_exit(STATUS_NATIVE_EXPORT); \
160 PerlIO_printf(PerlIO_stderr(), "panic: top_env\n"); \
161 PerlProc_exit(1); \
22921e25 162 } STMT_END
54310121
PP
163
164#define CATCH_GET (top_env->je_mustcatch)
165#define CATCH_SET(v) (top_env->je_mustcatch = (v))
6224f72b 166