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