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