Start anew
[msysgit.git] / lib / perl5 / 5.6.1 / msys / CORE / cop.h
blob1865e607779799e42d26019571c889829e76e502
1 /* cop.h
3 * Copyright (c) 1991-2001, Larry Wall
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
8 */
10 struct cop {
11 BASEOP
12 char * cop_label; /* label for this construct */
13 #ifdef USE_ITHREADS
14 char * cop_stashpv; /* package line was compiled in */
15 char * cop_file; /* file name the following line # is from */
16 #else
17 HV * cop_stash; /* package line was compiled in */
18 GV * cop_filegv; /* file the following line # is from */
19 #endif
20 U32 cop_seq; /* parse sequence number */
21 I32 cop_arybase; /* array base this line was compiled with */
22 line_t cop_line; /* line # of this command */
23 SV * cop_warnings; /* lexical warnings bitmask */
26 #define Nullcop Null(COP*)
28 #ifdef USE_ITHREADS
29 # define CopFILE(c) ((c)->cop_file)
30 # define CopFILEGV(c) (CopFILE(c) \
31 ? gv_fetchfile(CopFILE(c)) : Nullgv)
32 # define CopFILE_set(c,pv) ((c)->cop_file = savepv(pv))
33 # define CopFILESV(c) (CopFILE(c) \
34 ? GvSV(gv_fetchfile(CopFILE(c))) : Nullsv)
35 # define CopFILEAV(c) (CopFILE(c) \
36 ? GvAV(gv_fetchfile(CopFILE(c))) : Nullav)
37 # define CopSTASHPV(c) ((c)->cop_stashpv)
38 # define CopSTASHPV_set(c,pv) ((c)->cop_stashpv = ((pv) ? savepv(pv) : Nullch))
39 # define CopSTASH(c) (CopSTASHPV(c) \
40 ? gv_stashpv(CopSTASHPV(c),GV_ADD) : Nullhv)
41 # define CopSTASH_set(c,hv) CopSTASHPV_set(c, (hv) ? HvNAME(hv) : Nullch)
42 # define CopSTASH_eq(c,hv) ((hv) \
43 && (CopSTASHPV(c) == HvNAME(hv) \
44 || (CopSTASHPV(c) && HvNAME(hv) \
45 && strEQ(CopSTASHPV(c), HvNAME(hv)))))
46 #else
47 # define CopFILEGV(c) ((c)->cop_filegv)
48 # define CopFILEGV_set(c,gv) ((c)->cop_filegv = (GV*)SvREFCNT_inc(gv))
49 # define CopFILE_set(c,pv) CopFILEGV_set((c), gv_fetchfile(pv))
50 # define CopFILESV(c) (CopFILEGV(c) ? GvSV(CopFILEGV(c)) : Nullsv)
51 # define CopFILEAV(c) (CopFILEGV(c) ? GvAV(CopFILEGV(c)) : Nullav)
52 # define CopFILE(c) (CopFILESV(c) ? SvPVX(CopFILESV(c)) : Nullch)
53 # define CopSTASH(c) ((c)->cop_stash)
54 # define CopSTASH_set(c,hv) ((c)->cop_stash = (hv))
55 # define CopSTASHPV(c) (CopSTASH(c) ? HvNAME(CopSTASH(c)) : Nullch)
56 /* cop_stash is not refcounted */
57 # define CopSTASHPV_set(c,pv) CopSTASH_set((c), gv_stashpv(pv,GV_ADD))
58 # define CopSTASH_eq(c,hv) (CopSTASH(c) == (hv))
59 #endif /* USE_ITHREADS */
61 #define CopSTASH_ne(c,hv) (!CopSTASH_eq(c,hv))
62 #define CopLINE(c) ((c)->cop_line)
63 #define CopLINE_inc(c) (++CopLINE(c))
64 #define CopLINE_dec(c) (--CopLINE(c))
65 #define CopLINE_set(c,l) (CopLINE(c) = (l))
68 * Here we have some enormously heavy (or at least ponderous) wizardry.
71 /* subroutine context */
72 struct block_sub {
73 CV * cv;
74 GV * gv;
75 GV * dfoutgv;
76 #ifndef USE_THREADS
77 AV * savearray;
78 #endif /* USE_THREADS */
79 AV * argarray;
80 U16 olddepth;
81 U8 hasargs;
82 U8 lval; /* XXX merge lval and hasargs? */
83 SV ** oldcurpad;
86 #define PUSHSUB(cx) \
87 cx->blk_sub.cv = cv; \
88 cx->blk_sub.olddepth = CvDEPTH(cv); \
89 cx->blk_sub.hasargs = hasargs; \
90 cx->blk_sub.lval = PL_op->op_private & \
91 (OPpLVAL_INTRO|OPpENTERSUB_INARGS);
93 #define PUSHFORMAT(cx) \
94 cx->blk_sub.cv = cv; \
95 cx->blk_sub.gv = gv; \
96 cx->blk_sub.hasargs = 0; \
97 cx->blk_sub.dfoutgv = PL_defoutgv; \
98 (void)SvREFCNT_inc(cx->blk_sub.dfoutgv)
100 #ifdef USE_THREADS
101 # define POP_SAVEARRAY() NOOP
102 #else
103 # define POP_SAVEARRAY() \
104 STMT_START { \
105 SvREFCNT_dec(GvAV(PL_defgv)); \
106 GvAV(PL_defgv) = cx->blk_sub.savearray; \
107 } STMT_END
108 #endif /* USE_THREADS */
110 /* junk in @_ spells trouble when cloning CVs and in pp_caller(), so don't
111 * leave any (a fast av_clear(ary), basically) */
112 #define CLEAR_ARGARRAY(ary) \
113 STMT_START { \
114 AvMAX(ary) += AvARRAY(ary) - AvALLOC(ary); \
115 SvPVX(ary) = (char*)AvALLOC(ary); \
116 AvFILLp(ary) = -1; \
117 } STMT_END
119 #define POPSUB(cx,sv) \
120 STMT_START { \
121 if (cx->blk_sub.hasargs) { \
122 POP_SAVEARRAY(); \
123 /* abandon @_ if it got reified */ \
124 if (AvREAL(cx->blk_sub.argarray)) { \
125 SSize_t fill = AvFILLp(cx->blk_sub.argarray); \
126 SvREFCNT_dec(cx->blk_sub.argarray); \
127 cx->blk_sub.argarray = newAV(); \
128 av_extend(cx->blk_sub.argarray, fill); \
129 AvFLAGS(cx->blk_sub.argarray) = AVf_REIFY; \
130 cx->blk_sub.oldcurpad[0] = (SV*)cx->blk_sub.argarray; \
132 else { \
133 CLEAR_ARGARRAY(cx->blk_sub.argarray); \
136 sv = (SV*)cx->blk_sub.cv; \
137 if (sv && (CvDEPTH((CV*)sv) = cx->blk_sub.olddepth)) \
138 sv = Nullsv; \
139 } STMT_END
141 #define LEAVESUB(sv) \
142 STMT_START { \
143 if (sv) \
144 SvREFCNT_dec(sv); \
145 } STMT_END
147 #define POPFORMAT(cx) \
148 setdefout(cx->blk_sub.dfoutgv); \
149 SvREFCNT_dec(cx->blk_sub.dfoutgv);
151 /* eval context */
152 struct block_eval {
153 I32 old_in_eval;
154 I32 old_op_type;
155 SV * old_namesv;
156 OP * old_eval_root;
157 SV * cur_text;
158 CV * cv;
161 #define PUSHEVAL(cx,n,fgv) \
162 STMT_START { \
163 cx->blk_eval.old_in_eval = PL_in_eval; \
164 cx->blk_eval.old_op_type = PL_op->op_type; \
165 cx->blk_eval.old_namesv = (n ? newSVpv(n,0) : Nullsv); \
166 cx->blk_eval.old_eval_root = PL_eval_root; \
167 cx->blk_eval.cur_text = PL_linestr; \
168 cx->blk_eval.cv = Nullcv; /* set by doeval(), as applicable */ \
169 } STMT_END
171 #define POPEVAL(cx) \
172 STMT_START { \
173 PL_in_eval = cx->blk_eval.old_in_eval; \
174 optype = cx->blk_eval.old_op_type; \
175 PL_eval_root = cx->blk_eval.old_eval_root; \
176 if (cx->blk_eval.old_namesv) \
177 sv_2mortal(cx->blk_eval.old_namesv); \
178 } STMT_END
180 /* loop context */
181 struct block_loop {
182 char * label;
183 I32 resetsp;
184 OP * redo_op;
185 OP * next_op;
186 OP * last_op;
187 #ifdef USE_ITHREADS
188 void * iterdata;
189 SV ** oldcurpad;
190 #else
191 SV ** itervar;
192 #endif
193 SV * itersave;
194 SV * iterlval;
195 AV * iterary;
196 IV iterix;
197 IV itermax;
200 #ifdef USE_ITHREADS
201 # define CxITERVAR(c) \
202 ((c)->blk_loop.iterdata \
203 ? (CxPADLOOP(cx) \
204 ? &((c)->blk_loop.oldcurpad)[(PADOFFSET)(c)->blk_loop.iterdata] \
205 : &GvSV((GV*)(c)->blk_loop.iterdata)) \
206 : (SV**)NULL)
207 # define CX_ITERDATA_SET(cx,idata) \
208 cx->blk_loop.oldcurpad = PL_curpad; \
209 if ((cx->blk_loop.iterdata = (idata))) \
210 cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));
211 #else
212 # define CxITERVAR(c) ((c)->blk_loop.itervar)
213 # define CX_ITERDATA_SET(cx,ivar) \
214 if ((cx->blk_loop.itervar = (SV**)(ivar))) \
215 cx->blk_loop.itersave = SvREFCNT_inc(*CxITERVAR(cx));
216 #endif
218 #define PUSHLOOP(cx, dat, s) \
219 cx->blk_loop.label = PL_curcop->cop_label; \
220 cx->blk_loop.resetsp = s - PL_stack_base; \
221 cx->blk_loop.redo_op = cLOOP->op_redoop; \
222 cx->blk_loop.next_op = cLOOP->op_nextop; \
223 cx->blk_loop.last_op = cLOOP->op_lastop; \
224 cx->blk_loop.iterlval = Nullsv; \
225 cx->blk_loop.iterary = Nullav; \
226 cx->blk_loop.iterix = -1; \
227 CX_ITERDATA_SET(cx,dat);
229 #define POPLOOP(cx) \
230 SvREFCNT_dec(cx->blk_loop.iterlval); \
231 if (CxITERVAR(cx)) { \
232 SV **s_v_p = CxITERVAR(cx); \
233 sv_2mortal(*s_v_p); \
234 *s_v_p = cx->blk_loop.itersave; \
236 if (cx->blk_loop.iterary && cx->blk_loop.iterary != PL_curstack)\
237 SvREFCNT_dec(cx->blk_loop.iterary);
239 /* context common to subroutines, evals and loops */
240 struct block {
241 I32 blku_oldsp; /* stack pointer to copy stuff down to */
242 COP * blku_oldcop; /* old curcop pointer */
243 I32 blku_oldretsp; /* return stack index */
244 I32 blku_oldmarksp; /* mark stack index */
245 I32 blku_oldscopesp; /* scope stack index */
246 PMOP * blku_oldpm; /* values of pattern match vars */
247 U8 blku_gimme; /* is this block running in list context? */
249 union {
250 struct block_sub blku_sub;
251 struct block_eval blku_eval;
252 struct block_loop blku_loop;
253 } blk_u;
255 #define blk_oldsp cx_u.cx_blk.blku_oldsp
256 #define blk_oldcop cx_u.cx_blk.blku_oldcop
257 #define blk_oldretsp cx_u.cx_blk.blku_oldretsp
258 #define blk_oldmarksp cx_u.cx_blk.blku_oldmarksp
259 #define blk_oldscopesp cx_u.cx_blk.blku_oldscopesp
260 #define blk_oldpm cx_u.cx_blk.blku_oldpm
261 #define blk_gimme cx_u.cx_blk.blku_gimme
262 #define blk_sub cx_u.cx_blk.blk_u.blku_sub
263 #define blk_eval cx_u.cx_blk.blk_u.blku_eval
264 #define blk_loop cx_u.cx_blk.blk_u.blku_loop
266 /* Enter a block. */
267 #define PUSHBLOCK(cx,t,sp) CXINC, cx = &cxstack[cxstack_ix], \
268 cx->cx_type = t, \
269 cx->blk_oldsp = sp - PL_stack_base, \
270 cx->blk_oldcop = PL_curcop, \
271 cx->blk_oldmarksp = PL_markstack_ptr - PL_markstack, \
272 cx->blk_oldscopesp = PL_scopestack_ix, \
273 cx->blk_oldretsp = PL_retstack_ix, \
274 cx->blk_oldpm = PL_curpm, \
275 cx->blk_gimme = gimme; \
276 DEBUG_l( PerlIO_printf(Perl_debug_log, "Entering block %ld, type %s\n", \
277 (long)cxstack_ix, PL_block_type[CxTYPE(cx)]); )
279 /* Exit a block (RETURN and LAST). */
280 #define POPBLOCK(cx,pm) cx = &cxstack[cxstack_ix--], \
281 newsp = PL_stack_base + cx->blk_oldsp, \
282 PL_curcop = cx->blk_oldcop, \
283 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
284 PL_scopestack_ix = cx->blk_oldscopesp, \
285 PL_retstack_ix = cx->blk_oldretsp, \
286 pm = cx->blk_oldpm, \
287 gimme = cx->blk_gimme; \
288 DEBUG_l( PerlIO_printf(Perl_debug_log, "Leaving block %ld, type %s\n", \
289 (long)cxstack_ix+1,PL_block_type[CxTYPE(cx)]); )
291 /* Continue a block elsewhere (NEXT and REDO). */
292 #define TOPBLOCK(cx) cx = &cxstack[cxstack_ix], \
293 PL_stack_sp = PL_stack_base + cx->blk_oldsp, \
294 PL_markstack_ptr = PL_markstack + cx->blk_oldmarksp, \
295 PL_scopestack_ix = cx->blk_oldscopesp, \
296 PL_retstack_ix = cx->blk_oldretsp, \
297 PL_curpm = cx->blk_oldpm
299 /* substitution context */
300 struct subst {
301 I32 sbu_iters;
302 I32 sbu_maxiters;
303 I32 sbu_rflags;
304 I32 sbu_oldsave;
305 bool sbu_once;
306 bool sbu_rxtainted;
307 char * sbu_orig;
308 SV * sbu_dstr;
309 SV * sbu_targ;
310 char * sbu_s;
311 char * sbu_m;
312 char * sbu_strend;
313 void * sbu_rxres;
314 REGEXP * sbu_rx;
316 #define sb_iters cx_u.cx_subst.sbu_iters
317 #define sb_maxiters cx_u.cx_subst.sbu_maxiters
318 #define sb_rflags cx_u.cx_subst.sbu_rflags
319 #define sb_oldsave cx_u.cx_subst.sbu_oldsave
320 #define sb_once cx_u.cx_subst.sbu_once
321 #define sb_rxtainted cx_u.cx_subst.sbu_rxtainted
322 #define sb_orig cx_u.cx_subst.sbu_orig
323 #define sb_dstr cx_u.cx_subst.sbu_dstr
324 #define sb_targ cx_u.cx_subst.sbu_targ
325 #define sb_s cx_u.cx_subst.sbu_s
326 #define sb_m cx_u.cx_subst.sbu_m
327 #define sb_strend cx_u.cx_subst.sbu_strend
328 #define sb_rxres cx_u.cx_subst.sbu_rxres
329 #define sb_rx cx_u.cx_subst.sbu_rx
331 #define PUSHSUBST(cx) CXINC, cx = &cxstack[cxstack_ix], \
332 cx->sb_iters = iters, \
333 cx->sb_maxiters = maxiters, \
334 cx->sb_rflags = r_flags, \
335 cx->sb_oldsave = oldsave, \
336 cx->sb_once = once, \
337 cx->sb_rxtainted = rxtainted, \
338 cx->sb_orig = orig, \
339 cx->sb_dstr = dstr, \
340 cx->sb_targ = targ, \
341 cx->sb_s = s, \
342 cx->sb_m = m, \
343 cx->sb_strend = strend, \
344 cx->sb_rxres = Null(void*), \
345 cx->sb_rx = rx, \
346 cx->cx_type = CXt_SUBST; \
347 rxres_save(&cx->sb_rxres, rx)
349 #define POPSUBST(cx) cx = &cxstack[cxstack_ix--]; \
350 rxres_free(&cx->sb_rxres)
352 struct context {
353 U32 cx_type; /* what kind of context this is */
354 union {
355 struct block cx_blk;
356 struct subst cx_subst;
357 } cx_u;
360 #define CXTYPEMASK 0xff
361 #define CXt_NULL 0
362 #define CXt_SUB 1
363 #define CXt_EVAL 2
364 #define CXt_LOOP 3
365 #define CXt_SUBST 4
366 #define CXt_BLOCK 5
367 #define CXt_FORMAT 6
369 /* private flags for CXt_EVAL */
370 #define CXp_REAL 0x00000100 /* truly eval'', not a lookalike */
371 #define CXp_TRYBLOCK 0x00000200 /* eval{}, not eval'' or similar */
373 #ifdef USE_ITHREADS
374 /* private flags for CXt_LOOP */
375 # define CXp_PADVAR 0x00000100 /* itervar lives on pad, iterdata
376 has pad offset; if not set,
377 iterdata holds GV* */
378 # define CxPADLOOP(c) (((c)->cx_type & (CXt_LOOP|CXp_PADVAR)) \
379 == (CXt_LOOP|CXp_PADVAR))
380 #endif
382 #define CxTYPE(c) ((c)->cx_type & CXTYPEMASK)
383 #define CxREALEVAL(c) (((c)->cx_type & (CXt_EVAL|CXp_REAL)) \
384 == (CXt_EVAL|CXp_REAL))
385 #define CxTRYBLOCK(c) (((c)->cx_type & (CXt_EVAL|CXp_TRYBLOCK)) \
386 == (CXt_EVAL|CXp_TRYBLOCK))
388 #define CXINC (cxstack_ix < cxstack_max ? ++cxstack_ix : (cxstack_ix = cxinc()))
390 /* "gimme" values */
393 =for apidoc AmU||G_SCALAR
394 Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
395 L<perlcall>.
397 =for apidoc AmU||G_ARRAY
398 Used to indicate list context. See C<GIMME_V>, C<GIMME> and
399 L<perlcall>.
401 =for apidoc AmU||G_VOID
402 Used to indicate void context. See C<GIMME_V> and L<perlcall>.
404 =for apidoc AmU||G_DISCARD
405 Indicates that arguments returned from a callback should be discarded. See
406 L<perlcall>.
408 =for apidoc AmU||G_EVAL
410 Used to force a Perl C<eval> wrapper around a callback. See
411 L<perlcall>.
413 =for apidoc AmU||G_NOARGS
415 Indicates that no arguments are being sent to a callback. See
416 L<perlcall>.
418 =cut
421 #define G_SCALAR 0
422 #define G_ARRAY 1
423 #define G_VOID 128 /* skip this bit when adding flags below */
425 /* extra flags for Perl_call_* routines */
426 #define G_DISCARD 2 /* Call FREETMPS. */
427 #define G_EVAL 4 /* Assume eval {} around subroutine call. */
428 #define G_NOARGS 8 /* Don't construct a @_ array. */
429 #define G_KEEPERR 16 /* Append errors to $@, don't overwrite it */
430 #define G_NODEBUG 32 /* Disable debugging at toplevel. */
431 #define G_METHOD 64 /* Calling method. */
433 /* flag bits for PL_in_eval */
434 #define EVAL_NULL 0 /* not in an eval */
435 #define EVAL_INEVAL 1 /* some enclosing scope is an eval */
436 #define EVAL_WARNONLY 2 /* used by yywarn() when calling yyerror() */
437 #define EVAL_KEEPERR 4 /* set by Perl_call_sv if G_KEEPERR */
438 #define EVAL_INREQUIRE 8 /* The code is being required. */
440 /* Support for switching (stack and block) contexts.
441 * This ensures magic doesn't invalidate local stack and cx pointers.
444 #define PERLSI_UNKNOWN -1
445 #define PERLSI_UNDEF 0
446 #define PERLSI_MAIN 1
447 #define PERLSI_MAGIC 2
448 #define PERLSI_SORT 3
449 #define PERLSI_SIGNAL 4
450 #define PERLSI_OVERLOAD 5
451 #define PERLSI_DESTROY 6
452 #define PERLSI_WARNHOOK 7
453 #define PERLSI_DIEHOOK 8
454 #define PERLSI_REQUIRE 9
456 struct stackinfo {
457 AV * si_stack; /* stack for current runlevel */
458 PERL_CONTEXT * si_cxstack; /* context stack for runlevel */
459 I32 si_cxix; /* current context index */
460 I32 si_cxmax; /* maximum allocated index */
461 I32 si_type; /* type of runlevel */
462 struct stackinfo * si_prev;
463 struct stackinfo * si_next;
464 I32 si_markoff; /* offset where markstack begins for us.
465 * currently used only with DEBUGGING,
466 * but not #ifdef-ed for bincompat */
469 typedef struct stackinfo PERL_SI;
471 #define cxstack (PL_curstackinfo->si_cxstack)
472 #define cxstack_ix (PL_curstackinfo->si_cxix)
473 #define cxstack_max (PL_curstackinfo->si_cxmax)
475 #ifdef DEBUGGING
476 # define SET_MARK_OFFSET \
477 PL_curstackinfo->si_markoff = PL_markstack_ptr - PL_markstack
478 #else
479 # define SET_MARK_OFFSET NOOP
480 #endif
482 #define PUSHSTACKi(type) \
483 STMT_START { \
484 PERL_SI *next = PL_curstackinfo->si_next; \
485 if (!next) { \
486 next = new_stackinfo(32, 2048/sizeof(PERL_CONTEXT) - 1); \
487 next->si_prev = PL_curstackinfo; \
488 PL_curstackinfo->si_next = next; \
490 next->si_type = type; \
491 next->si_cxix = -1; \
492 AvFILLp(next->si_stack) = 0; \
493 SWITCHSTACK(PL_curstack,next->si_stack); \
494 PL_curstackinfo = next; \
495 SET_MARK_OFFSET; \
496 } STMT_END
498 #define PUSHSTACK PUSHSTACKi(PERLSI_UNKNOWN)
500 /* POPSTACK works with PL_stack_sp, so it may need to be bracketed by
501 * PUTBACK/SPAGAIN to flush/refresh any local SP that may be active */
502 #define POPSTACK \
503 STMT_START { \
504 dSP; \
505 PERL_SI *prev = PL_curstackinfo->si_prev; \
506 if (!prev) { \
507 PerlIO_printf(Perl_error_log, "panic: POPSTACK\n"); \
508 my_exit(1); \
510 SWITCHSTACK(PL_curstack,prev->si_stack); \
511 /* don't free prev here, free them all at the END{} */ \
512 PL_curstackinfo = prev; \
513 } STMT_END
515 #define POPSTACK_TO(s) \
516 STMT_START { \
517 while (PL_curstack != s) { \
518 dounwind(-1); \
519 POPSTACK; \
521 } STMT_END