Bump $Win32API::File::VERSION for change #30409
[perl.git] / op.h
1 /*    op.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4  *    2000, 2001, 2002, 2003, 2004, 2005, 2006 by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10
11 /*
12  * The fields of BASEOP are:
13  *      op_next         Pointer to next ppcode to execute after this one.
14  *                      (Top level pre-grafted op points to first op,
15  *                      but this is replaced when op is grafted in, when
16  *                      this op will point to the real next op, and the new
17  *                      parent takes over role of remembering starting op.)
18  *      op_ppaddr       Pointer to current ppcode's function.
19  *      op_type         The type of the operation.
20  *      op_opt          Whether or not the op has been optimised by the
21  *                      peephole optimiser.
22  *      op_static       Whether or not the op is statically defined.
23  *                      This flag is used by the B::C compiler backend
24  *                      and indicates that the op should not be freed.
25  *
26  *                      See the comments in S_clear_yystack() for more
27  *                      details on the following three flags:
28
29  *      op_latefree     tell op_free() to clear this op (and free any kids)
30  *                      but not yet deallocate the struct. This means that
31  *                      the op may be safely op_free()d multiple times
32  *      op_latefreed    an op_latefree op has been op_free()d
33  *      op_attached     this op (sub)tree has been attached to a CV
34  *
35  *      op_spare        two spare bits!
36  *      op_flags        Flags common to all operations.  See OPf_* below.
37  *      op_private      Flags peculiar to a particular operation (BUT,
38  *                      by default, set to the number of children until
39  *                      the operation is privatized by a check routine,
40  *                      which may or may not check number of children).
41  */
42
43 #ifdef DEBUGGING_OPS
44 #define OPCODE opcode
45 #else
46 #define OPCODE U16
47 #endif
48
49 #ifdef PERL_MAD
50 #  define MADPROP_IN_BASEOP     MADPROP*        op_madprop;
51 #else
52 #  define MADPROP_IN_BASEOP
53 #endif
54
55 #ifdef BASEOP_DEFINITION
56 #define BASEOP BASEOP_DEFINITION
57 #else
58 #define BASEOP                          \
59     OP*         op_next;                \
60     OP*         op_sibling;             \
61     OP*         (CPERLscope(*op_ppaddr))(pTHX);         \
62     MADPROP_IN_BASEOP                   \
63     PADOFFSET   op_targ;                \
64     unsigned    op_type:9;              \
65     unsigned    op_opt:1;               \
66     unsigned    op_static:1;            \
67     unsigned    op_latefree:1;          \
68     unsigned    op_latefreed:1;         \
69     unsigned    op_attached:1;          \
70     unsigned    op_spare:2;             \
71     U8          op_flags;               \
72     U8          op_private;
73 #endif
74
75 #define OP_GIMME(op,dfl) \
76         (((op)->op_flags & OPf_WANT) == OPf_WANT_VOID   ? G_VOID   : \
77          ((op)->op_flags & OPf_WANT) == OPf_WANT_SCALAR ? G_SCALAR : \
78          ((op)->op_flags & OPf_WANT) == OPf_WANT_LIST   ? G_ARRAY   : \
79          dfl)
80
81 /*
82 =head1 "Gimme" Values
83
84 =for apidoc Amn|U32|GIMME_V
85 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_VOID>,
86 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
87 respectively.
88
89 =for apidoc Amn|U32|GIMME
90 A backward-compatible version of C<GIMME_V> which can only return
91 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
92 Deprecated.  Use C<GIMME_V> instead.
93
94 =cut
95 */
96
97 #define GIMME_V         OP_GIMME(PL_op, block_gimme())
98
99 /* Public flags */
100
101 #define OPf_WANT        3       /* Mask for "want" bits: */
102 #define  OPf_WANT_VOID   1      /*   Want nothing */
103 #define  OPf_WANT_SCALAR 2      /*   Want single value */
104 #define  OPf_WANT_LIST   3      /*   Want list of any length */
105 #define OPf_KIDS        4       /* There is a firstborn child. */
106 #define OPf_PARENS      8       /* This operator was parenthesized. */
107                                 /*  (Or block needs explicit scope entry.) */
108 #define OPf_REF         16      /* Certified reference. */
109                                 /*  (Return container, not containee). */
110 #define OPf_MOD         32      /* Will modify (lvalue). */
111 #define OPf_STACKED     64      /* Some arg is arriving on the stack. */
112 #define OPf_SPECIAL     128     /* Do something weird for this op: */
113                                 /*  On local LVAL, don't init local value. */
114                                 /*  On OP_SORT, subroutine is inlined. */
115                                 /*  On OP_NOT, inversion was implicit. */
116                                 /*  On OP_LEAVE, don't restore curpm. */
117                                 /*  On truncate, we truncate filehandle */
118                                 /*  On control verbs, we saw no label */
119                                 /*  On flipflop, we saw ... instead of .. */
120                                 /*  On UNOPs, saw bare parens, e.g. eof(). */
121                                 /*  On OP_ENTERSUB || OP_NULL, saw a "do". */
122                                 /*  On OP_EXISTS, treat av as av, not avhv.  */
123                                 /*  On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
124                                 /*  On OP_ENTERITER, loop var is per-thread */
125                                 /*  On pushre, re is /\s+/ imp. by split " " */
126                                 /*  On regcomp, "use re 'eval'" was in scope */
127                                 /*  On OP_READLINE, was <$filehandle> */
128                                 /*  On RV2[ACGHS]V, don't create GV--in
129                                     defined()*/
130                                 /*  On OP_DBSTATE, indicates breakpoint
131                                  *    (runtime property) */
132                                 /*  On OP_AELEMFAST, indiciates pad var */
133                                 /*  On OP_REQUIRE, was seen as CORE::require */
134                                 /*  On OP_ENTERWHEN, there's no condition */
135                                 /*  On OP_BREAK, an implicit break */
136                                 /*  On OP_SMARTMATCH, an implicit smartmatch */
137                                 /*  On OP_ANONHASH and OP_ANONLIST, create a
138                                     reference to the new anon hash or array */
139
140 /* old names; don't use in new code, but don't break them, either */
141 #define OPf_LIST        OPf_WANT_LIST
142 #define OPf_KNOW        OPf_WANT
143
144 #define GIMME \
145           (PL_op->op_flags & OPf_WANT                                   \
146            ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST             \
147               ? G_ARRAY                                                 \
148               : G_SCALAR)                                               \
149            : dowantarray())
150
151 /* NOTE: OP_NEXTSTATE, OP_DBSTATE, and OP_SETSTATE (i.e. COPs) carry lower
152  * bits of PL_hints in op_private */
153
154 /* Private for lvalues */
155 #define OPpLVAL_INTRO   128     /* Lvalue must be localized or lvalue sub */
156
157 /* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
158 #define OPpREFCOUNTED           64      /* op_targ carries a refcount */
159
160 /* Private for OP_AASSIGN */
161 #define OPpASSIGN_COMMON        64      /* Left & right have syms in common. */
162
163 /* Private for OP_SASSIGN */
164 #define OPpASSIGN_BACKWARDS     64      /* Left & right switched. */
165 #define OPpASSIGN_CV_TO_GV      128     /* Possible optimisation for constants. */
166
167 /* Private for OP_[AS]ASSIGN */
168 #define OPpASSIGN_STATE         32      /* Assign to a "state" variable */
169
170 /* Private for OP_MATCH and OP_SUBST{,CONST} */
171 #define OPpRUNTIME              64      /* Pattern coming in on the stack */
172
173 /* Private for OP_TRANS */
174 #define OPpTRANS_FROM_UTF       1
175 #define OPpTRANS_TO_UTF         2
176 #define OPpTRANS_IDENTICAL      4       /* right side is same as left */
177 #define OPpTRANS_SQUASH         8
178     /* 16 is used for OPpTARGET_MY */
179 #define OPpTRANS_COMPLEMENT     32
180 #define OPpTRANS_GROWS          64
181 #define OPpTRANS_DELETE         128
182 #define OPpTRANS_ALL    (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
183
184 /* Private for OP_REPEAT */
185 #define OPpREPEAT_DOLIST        64      /* List replication. */
186
187 /* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
188 #define OPpDEREF                (32|64) /* autovivify: Want ref to something: */
189 #define OPpDEREF_AV             32      /*   Want ref to AV. */
190 #define OPpDEREF_HV             64      /*   Want ref to HV. */
191 #define OPpDEREF_SV             (32|64) /*   Want ref to SV. */
192   /* OP_ENTERSUB only */
193 #define OPpENTERSUB_DB          16      /* Debug subroutine. */
194 #define OPpENTERSUB_HASTARG     32      /* Called from OP tree. */
195 #define OPpENTERSUB_NOMOD       64      /* Immune to mod() for :attrlist. */
196   /* OP_RV2CV only */
197 #define OPpENTERSUB_AMPER       8       /* Used & form to call. */
198 #define OPpENTERSUB_NOPAREN     128     /* bare sub call (without parens) */
199 #define OPpENTERSUB_INARGS      4       /* Lval used as arg to a sub. */
200   /* OP_GV only */
201 #define OPpEARLY_CV             32      /* foo() called before sub foo was parsed */
202   /* OP_?ELEM only */
203 #define OPpLVAL_DEFER           16      /* Defer creation of array/hash elem */
204   /* OP_RV2?V, OP_GVSV, OP_ENTERITER only */
205 #define OPpOUR_INTRO            16      /* Variable was in an our() */
206   /* OP_RV2[AGH]V, OP_PAD[AH]V, OP_[AH]ELEM */
207 #define OPpMAYBE_LVSUB          8       /* We might be an lvalue to return */
208   /* OP_PADSV only */
209 #define OPpPAD_STATE            16      /* is a "state" pad */
210   /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
211
212   /* OP_RV2GV only */
213 #define OPpDONT_INIT_GV         4       /* Call gv_fetchpv with GV_NOINIT */
214 /* (Therefore will return whatever is currently in the symbol table, not
215    guaranteed to be a PVGV)  */
216
217   /* OP_RV2CV only */
218 #define OPpMAY_RETURN_CONSTANT  1       /* If a constant sub, return the constant */
219
220 /* Private for OPs with TARGLEX */
221   /* (lower bits may carry MAXARG) */
222 #define OPpTARGET_MY            16      /* Target is PADMY. */
223
224 /* Private for OP_ENTERITER and OP_ITER */
225 #define OPpITER_REVERSED        4       /* for (reverse ...) */
226 #define OPpITER_DEF             8       /* for $_ or for my $_ */
227
228 /* Private for OP_CONST */
229 #define OPpCONST_NOVER          2       /* no 6; */
230 #define OPpCONST_SHORTCIRCUIT   4       /* eg the constant 5 in (5 || foo) */
231 #define OPpCONST_STRICT         8       /* bearword subject to strict 'subs' */
232 #define OPpCONST_ENTERED        16      /* Has been entered as symbol. */
233 #define OPpCONST_ARYBASE        32      /* Was a $[ translated to constant. */
234 #define OPpCONST_BARE           64      /* Was a bare word (filehandle?). */
235 #define OPpCONST_WARNING        128     /* Was a $^W translated to constant. */
236
237 /* Private for OP_FLIP/FLOP */
238 #define OPpFLIP_LINENUM         64      /* Range arg potentially a line num. */
239
240 /* Private for OP_LIST */
241 #define OPpLIST_GUESSED         64      /* Guessed that pushmark was needed. */
242
243 /* Private for OP_DELETE */
244 #define OPpSLICE                64      /* Operating on a list of keys */
245
246 /* Private for OP_EXISTS */
247 #define OPpEXISTS_SUB           64      /* Checking for &sub, not {} or [].  */
248
249 /* Private for OP_SORT */
250 #define OPpSORT_NUMERIC         1       /* Optimized away { $a <=> $b } */
251 #define OPpSORT_INTEGER         2       /* Ditto while under "use integer" */
252 #define OPpSORT_REVERSE         4       /* Reversed sort */
253 #define OPpSORT_INPLACE         8       /* sort in-place; eg @a = sort @a */
254 #define OPpSORT_DESCEND         16      /* Descending sort */
255 #define OPpSORT_QSORT           32      /* Use quicksort (not mergesort) */
256 #define OPpSORT_STABLE          64      /* Use a stable algorithm */
257
258 /* Private for OP_THREADSV */
259 #define OPpDONE_SVREF           64      /* Been through newSVREF once */
260
261 /* Private for OP_OPEN and OP_BACKTICK */
262 #define OPpOPEN_IN_RAW          16      /* binmode(F,":raw") on input fh */
263 #define OPpOPEN_IN_CRLF         32      /* binmode(F,":crlf") on input fh */
264 #define OPpOPEN_OUT_RAW         64      /* binmode(F,":raw") on output fh */
265 #define OPpOPEN_OUT_CRLF        128     /* binmode(F,":crlf") on output fh */
266
267 /* Private for OP_EXIT, HUSH also for OP_DIE */
268 #define OPpHUSH_VMSISH          64      /* hush DCL exit msg vmsish mode*/
269 #define OPpEXIT_VMSISH          128     /* exit(0) vs. exit(1) vmsish mode*/
270
271 /* Private for OP_FTXXX */
272 #define OPpFT_ACCESS            2       /* use filetest 'access' */
273 #define OPpFT_STACKED           4       /* stacked filetest, as in "-f -x $f" */
274 #define OP_IS_FILETEST_ACCESS(op)               \
275         (((op)->op_type) == OP_FTRREAD  ||      \
276          ((op)->op_type) == OP_FTRWRITE ||      \
277          ((op)->op_type) == OP_FTREXEC  ||      \
278          ((op)->op_type) == OP_FTEREAD  ||      \
279          ((op)->op_type) == OP_FTEWRITE ||      \
280          ((op)->op_type) == OP_FTEEXEC)
281
282 /* Private for OP_(MAP|GREP)(WHILE|START) */
283 #define OPpGREP_LEX             2       /* iterate over lexical $_ */
284     
285 /* Private for OP_ENTEREVAL */
286 #define OPpEVAL_HAS_HH          2       /* Does it have a copy of %^H */
287     
288 struct op {
289     BASEOP
290 };
291
292 struct unop {
293     BASEOP
294     OP *        op_first;
295 };
296
297 struct binop {
298     BASEOP
299     OP *        op_first;
300     OP *        op_last;
301 };
302
303 struct logop {
304     BASEOP
305     OP *        op_first;
306     OP *        op_other;
307 };
308
309 struct listop {
310     BASEOP
311     OP *        op_first;
312     OP *        op_last;
313 };
314
315 struct pmop {
316     BASEOP
317     OP *        op_first;
318     OP *        op_last;
319     OP *        op_pmreplroot; /* (type is really union {OP*,GV*,PADOFFSET}) */
320     OP *        op_pmreplstart;
321     PMOP *      op_pmnext;              /* list of all scanpats */
322 #ifdef USE_ITHREADS
323     IV          op_pmoffset;
324 #else
325     REGEXP *    op_pmregexp;            /* compiled expression */
326 #endif
327     U32         op_pmflags;
328     U32         op_pmpermflags;
329     U8          op_pmdynflags;
330 #ifdef USE_ITHREADS
331     char *      op_pmstashpv;
332 #else
333     HV *        op_pmstash;
334 #endif
335 };
336
337 #ifdef USE_ITHREADS
338 #define PM_GETRE(o)     (INT2PTR(REGEXP*,SvIVX(PL_regex_pad[(o)->op_pmoffset])))
339 #define PM_SETRE(o,r)   STMT_START { \
340                             SV* const sv = PL_regex_pad[(o)->op_pmoffset]; \
341                             sv_setiv(sv, PTR2IV(r)); \
342                         } STMT_END
343 #define PM_GETRE_SAFE(o) (PL_regex_pad ? PM_GETRE(o) : (REGEXP*)0)
344 #define PM_SETRE_SAFE(o,r) if (PL_regex_pad) PM_SETRE(o,r)
345 #else
346 #define PM_GETRE(o)     ((o)->op_pmregexp)
347 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
348 #define PM_GETRE_SAFE PM_GETRE
349 #define PM_SETRE_SAFE PM_SETRE
350 #endif
351
352 #define PMdf_USED       0x01            /* pm has been used once already */
353 #define PMdf_TAINTED    0x02            /* pm compiled from tainted pattern */
354 #define PMdf_UTF8       0x04            /* pm compiled from utf8 data */
355 #define PMdf_DYN_UTF8   0x08
356
357 #define PMdf_CMP_UTF8   (PMdf_UTF8|PMdf_DYN_UTF8)
358
359 #define PMf_RETAINT     0x0001          /* taint $1 etc. if target tainted */
360 #define PMf_ONCE        0x0002          /* use pattern only once per reset */
361 #define PMf_UNUSED      0x0004          /* free for use */
362 #define PMf_MAYBE_CONST 0x0008          /* replacement contains variables */
363 #define PMf_SKIPWHITE   0x0010          /* skip leading whitespace for split */
364 #define PMf_WHITE       0x0020          /* pattern is \s+ */
365 #define PMf_CONST       0x0040          /* subst replacement is constant */
366 #define PMf_KEEP        0x0080          /* keep 1st runtime pattern forever */
367 #define PMf_GLOBAL      0x0100          /* pattern had a g modifier */
368 #define PMf_CONTINUE    0x0200          /* don't reset pos() if //g fails */
369 #define PMf_EVAL        0x0400          /* evaluating replacement as expr */
370
371 /* The following flags have exact equivalents in regcomp.h with the prefix RXf_
372  * which are stored in the regexp->extflags member.
373  */
374 #define PMf_LOCALE      0x00800         /* use locale for character types */
375 #define PMf_MULTILINE   0x01000         /* assume multiple lines */
376 #define PMf_SINGLELINE  0x02000         /* assume single line */
377 #define PMf_FOLD        0x04000         /* case insensitivity */
378 #define PMf_EXTENDED    0x08000         /* chuck embedded whitespace */
379 #define PMf_KEEPCOPY    0x10000         /* copy the string when matching */
380
381 /* mask of bits that need to be transfered to re->extflags */
382 #define PMf_COMPILETIME (PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED|PMf_KEEPCOPY)
383
384 #ifdef USE_ITHREADS
385
386 #  define PmopSTASHPV(o)        ((o)->op_pmstashpv)
387 #  define PmopSTASHPV_set(o,pv) (PmopSTASHPV(o) = savesharedpv(pv))
388 #  define PmopSTASH(o)          (PmopSTASHPV(o) \
389                                  ? gv_stashpv(PmopSTASHPV(o),GV_ADD) : NULL)
390 #  define PmopSTASH_set(o,hv)   PmopSTASHPV_set(o, ((hv) ? HvNAME_get(hv) : NULL))
391 #  define PmopSTASH_free(o)     PerlMemShared_free(PmopSTASHPV(o))
392
393 #else
394 #  define PmopSTASH(o)          ((o)->op_pmstash)
395 #  define PmopSTASH_set(o,hv)   ((o)->op_pmstash = (hv))
396 #  define PmopSTASHPV(o)        (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
397    /* op_pmstash is not refcounted */
398 #  define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
399 #  define PmopSTASH_free(o)    
400 #endif
401
402 struct svop {
403     BASEOP
404     SV *        op_sv;
405 };
406
407 struct padop {
408     BASEOP
409     PADOFFSET   op_padix;
410 };
411
412 struct pvop {
413     BASEOP
414     char *      op_pv;
415 };
416
417 struct loop {
418     BASEOP
419     OP *        op_first;
420     OP *        op_last;
421     OP *        op_redoop;
422     OP *        op_nextop;
423     OP *        op_lastop;
424 };
425
426 #define cUNOPx(o)       ((UNOP*)o)
427 #define cBINOPx(o)      ((BINOP*)o)
428 #define cLISTOPx(o)     ((LISTOP*)o)
429 #define cLOGOPx(o)      ((LOGOP*)o)
430 #define cPMOPx(o)       ((PMOP*)o)
431 #define cSVOPx(o)       ((SVOP*)o)
432 #define cPADOPx(o)      ((PADOP*)o)
433 #define cPVOPx(o)       ((PVOP*)o)
434 #define cCOPx(o)        ((COP*)o)
435 #define cLOOPx(o)       ((LOOP*)o)
436
437 #define cUNOP           cUNOPx(PL_op)
438 #define cBINOP          cBINOPx(PL_op)
439 #define cLISTOP         cLISTOPx(PL_op)
440 #define cLOGOP          cLOGOPx(PL_op)
441 #define cPMOP           cPMOPx(PL_op)
442 #define cSVOP           cSVOPx(PL_op)
443 #define cPADOP          cPADOPx(PL_op)
444 #define cPVOP           cPVOPx(PL_op)
445 #define cCOP            cCOPx(PL_op)
446 #define cLOOP           cLOOPx(PL_op)
447
448 #define cUNOPo          cUNOPx(o)
449 #define cBINOPo         cBINOPx(o)
450 #define cLISTOPo        cLISTOPx(o)
451 #define cLOGOPo         cLOGOPx(o)
452 #define cPMOPo          cPMOPx(o)
453 #define cSVOPo          cSVOPx(o)
454 #define cPADOPo         cPADOPx(o)
455 #define cPVOPo          cPVOPx(o)
456 #define cCOPo           cCOPx(o)
457 #define cLOOPo          cLOOPx(o)
458
459 #define kUNOP           cUNOPx(kid)
460 #define kBINOP          cBINOPx(kid)
461 #define kLISTOP         cLISTOPx(kid)
462 #define kLOGOP          cLOGOPx(kid)
463 #define kPMOP           cPMOPx(kid)
464 #define kSVOP           cSVOPx(kid)
465 #define kPADOP          cPADOPx(kid)
466 #define kPVOP           cPVOPx(kid)
467 #define kCOP            cCOPx(kid)
468 #define kLOOP           cLOOPx(kid)
469
470
471 #ifdef USE_ITHREADS
472 #  define       cGVOPx_gv(o)    ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
473 #  define       IS_PADGV(v)     (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
474                                  && GvIN_PAD(v))
475 #  define       IS_PADCONST(v)  (v && SvREADONLY(v))
476 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
477                                  ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
478 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
479                                  ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
480 #else
481 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
482 #  define       IS_PADGV(v)     FALSE
483 #  define       IS_PADCONST(v)  FALSE
484 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
485 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
486 #endif
487
488 #define cGVOP_gv                cGVOPx_gv(PL_op)
489 #define cGVOPo_gv               cGVOPx_gv(o)
490 #define kGVOP_gv                cGVOPx_gv(kid)
491 #define cSVOP_sv                cSVOPx_sv(PL_op)
492 #define cSVOPo_sv               cSVOPx_sv(o)
493 #define kSVOP_sv                cSVOPx_sv(kid)
494
495 #define Nullop Null(OP*)
496
497 /* Lowest byte-and-a-bit of PL_opargs */
498 #define OA_MARK 1
499 #define OA_FOLDCONST 2
500 #define OA_RETSCALAR 4
501 #define OA_TARGET 8
502 #define OA_RETINTEGER 16
503 #define OA_OTHERINT 32
504 #define OA_DANGEROUS 64
505 #define OA_DEFGV 128
506 #define OA_TARGLEX 256
507
508 /* The next 4 bits encode op class information */
509 #define OCSHIFT 9
510
511 #define OA_CLASS_MASK (15 << OCSHIFT)
512
513 #define OA_BASEOP (0 << OCSHIFT)
514 #define OA_UNOP (1 << OCSHIFT)
515 #define OA_BINOP (2 << OCSHIFT)
516 #define OA_LOGOP (3 << OCSHIFT)
517 #define OA_LISTOP (4 << OCSHIFT)
518 #define OA_PMOP (5 << OCSHIFT)
519 #define OA_SVOP (6 << OCSHIFT)
520 #define OA_PADOP (7 << OCSHIFT)
521 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
522 #define OA_LOOP (9 << OCSHIFT)
523 #define OA_COP (10 << OCSHIFT)
524 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
525 #define OA_FILESTATOP (12 << OCSHIFT)
526 #define OA_LOOPEXOP (13 << OCSHIFT)
527
528 #define OASHIFT 13
529
530 /* Remaining nybbles of PL_opargs */
531 #define OA_SCALAR 1
532 #define OA_LIST 2
533 #define OA_AVREF 3
534 #define OA_HVREF 4
535 #define OA_CVREF 5
536 #define OA_FILEREF 6
537 #define OA_SCALARREF 7
538 #define OA_OPTIONAL 8
539
540 /* Op_REFCNT is a reference count at the head of each op tree: needed
541  * since the tree is shared between threads, and between cloned closure
542  * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
543  * this count.
544  * The same mutex is used to protect the refcounts of the reg_trie_data
545  * and reg_ac_data structures, which are shared between duplicated
546  * regexes.
547  */
548
549 #ifdef USE_ITHREADS
550 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
551 #  ifdef PERL_CORE
552 #    define OP_REFCNT_LOCK              MUTEX_LOCK(&PL_op_mutex)
553 #    define OP_REFCNT_UNLOCK            MUTEX_UNLOCK(&PL_op_mutex)
554 #  else
555 #    define OP_REFCNT_LOCK              op_refcnt_lock()
556 #    define OP_REFCNT_UNLOCK            op_refcnt_unlock()
557 #  endif
558 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
559 #else
560 #  define OP_REFCNT_INIT                NOOP
561 #  define OP_REFCNT_LOCK                NOOP
562 #  define OP_REFCNT_UNLOCK              NOOP
563 #  define OP_REFCNT_TERM                NOOP
564 #endif
565
566 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
567 #define OpREFCNT_inc(o)                 ((o) ? (++(o)->op_targ, (o)) : NULL)
568 #define OpREFCNT_dec(o)                 (--(o)->op_targ)
569
570 /* flags used by Perl_load_module() */
571 #define PERL_LOADMOD_DENY               0x1
572 #define PERL_LOADMOD_NOIMPORT           0x2
573 #define PERL_LOADMOD_IMPORT_OPS         0x4
574
575 #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C)
576 #define ref(o, type) doref(o, type, TRUE)
577 #endif
578
579 /* no longer used anywhere in core */
580 #ifndef PERL_CORE
581 #define cv_ckproto(cv, gv, p) \
582    cv_ckproto_len((cv), (gv), (p), (p) ? strlen(p) : 0)
583 #endif
584
585 #ifdef USE_REENTRANT_API
586 #include "reentr.h"
587 #endif
588
589 #if defined(PL_OP_SLAB_ALLOC)
590 #define NewOp(m,var,c,type)     \
591         (var = (type *) Perl_Slab_Alloc(aTHX_ m,c*sizeof(type)))
592 #define NewOpSz(m,var,size)     \
593         (var = (OP *) Perl_Slab_Alloc(aTHX_ m,size))
594 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
595 #else
596 #define NewOp(m, var, c, type)  \
597         (var = (MEM_WRAP_CHECK_(c,type) \
598          (type*)PerlMemShared_calloc(c, sizeof(type))))
599 #define NewOpSz(m, var, size)   \
600         (var = (OP*)PerlMemShared_calloc(1, size))
601 #define FreeOp(p) PerlMemShared_free(p)
602 #endif
603
604 #ifdef PERL_MAD
605 #  define MAD_NULL 1
606 #  define MAD_PV 2
607 #  define MAD_OP 3
608 #  define MAD_SV 4
609
610 struct madprop {
611     MADPROP* mad_next;
612     void *mad_val;
613     U32 mad_vlen;
614 /*    short mad_count; */
615     char mad_key;
616     char mad_type;
617 };
618
619 struct token {
620     I32 tk_type;
621     YYSTYPE tk_lval;
622     MADPROP* tk_mad;
623 };
624 #endif
625
626 /*
627  * Values that can be hold by mad_key :
628  * ^       unfilled head spot
629  * ,       literal ,
630  * ;       literal ; (blank if implicit ; at end of block)
631  * :       literal : from ?: or attr list
632  * +       unary +
633  * ?       literal ? from ?:
634  * (       literal (
635  * )       literal )
636  * [       literal [
637  * ]       literal ]
638  * {       literal {
639  * }       literal }
640  * @       literal @ sigil
641  * $       literal $ sigil
642  * *       literal * sigil
643  * !       use is source filtered
644  * &       & or sub
645  * #       whitespace/comment following ; or }
646  * #       $# sigil
647  * 1       1st ; from for(;;)
648  * 1       retired protasis
649  * 2       2nd ; from for(;;)
650  * 2       retired apodosis
651  * 3       C-style for list
652  * a       sub or var attributes
653  * a       non-method arrow operator
654  * A       method arrow operator
655  * A       use import args
656  * b       format block
657  * B       retired stub block
658  * C       constant conditional op
659  * d       declarator
660  * D       do block
661  * e       unreached "else" (see C)
662  * e       expression producing E
663  * E       tr/E/R/, /E/
664  * f       folded constant op
665  * F       peg op for format
666  * i       if/unless modifier
667  * I       if/elsif/unless statement
668  * K       retired kid op
669  * l       last index of array ($#foo)
670  * L       label
671  * m       modifier on regex
672  * M       my assignment slurped into some other operator's target
673  * n       sub or format name
674  * o       current operator/declarator name
675  * o       else/continue
676  * O       generic optimized op
677  * p       peg to hold extra whitespace at statement level
678  * P       peg op for package declaration
679  * q       opening quote
680  * =       quoted material
681  * Q       closing quote
682  * Q       optimized qw//
683  * r       expression producing R
684  * R       tr/E/R/ s/E/R/
685  * R       assign slurped by split
686  * s       sub signature
687  * S       use import stub (no import)
688  * S       retired sort block
689  * t       unreached "then" (see C)
690  * U       use import op
691  * v       private sv of for loop
692  * V       use version
693  * w       while/until modifier
694  * W       while/for statement
695  * x       optimized qw
696  * X       random thing
697  * _       whitespace/comments preceding anything else
698  * ~       =~ operator
699  */