pp_match(): skip passing gpos arg to regexec()
[perl.git] / op.h
1 /*    op.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 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_slabbed      allocated via opslab
23  *      op_static       tell op_free() to skip PerlMemShared_free(), when
24  *                      !op_slabbed.
25  *      op_savefree     on savestack via SAVEFREEOP
26  *      op_folded       Result/remainder of a constant fold operation.
27  *      op_spare        Two spare bits
28  *      op_flags        Flags common to all operations.  See OPf_* below.
29  *      op_private      Flags peculiar to a particular operation (BUT,
30  *                      by default, set to the number of children until
31  *                      the operation is privatized by a check routine,
32  *                      which may or may not check number of children).
33  */
34 #include "op_reg_common.h"
35
36 #define OPCODE U16
37
38 #ifdef PERL_MAD
39 #  define MADPROP_IN_BASEOP     MADPROP*        op_madprop;
40 #else
41 #  define MADPROP_IN_BASEOP
42 #endif
43
44 typedef PERL_BITFIELD16 Optype;
45
46 #ifdef BASEOP_DEFINITION
47 #define BASEOP BASEOP_DEFINITION
48 #else
49 #define BASEOP                          \
50     OP*         op_next;                \
51     OP*         op_sibling;             \
52     OP*         (*op_ppaddr)(pTHX);     \
53     MADPROP_IN_BASEOP                   \
54     PADOFFSET   op_targ;                \
55     PERL_BITFIELD16 op_type:9;          \
56     PERL_BITFIELD16 op_opt:1;           \
57     PERL_BITFIELD16 op_slabbed:1;       \
58     PERL_BITFIELD16 op_savefree:1;      \
59     PERL_BITFIELD16 op_static:1;        \
60     PERL_BITFIELD16 op_folded:1;        \
61     PERL_BITFIELD16 op_spare:2;         \
62     U8          op_flags;               \
63     U8          op_private;
64 #endif
65
66 /* If op_type:9 is changed to :10, also change PUSHEVAL in cop.h.
67    Also, if the type of op_type is ever changed (e.g. to PERL_BITFIELD32)
68    then all the other bit-fields before/after it should change their
69    types too to let VC pack them into the same 4 byte integer.*/
70
71 /* for efficiency, requires OPf_WANT_VOID == G_VOID etc */
72 #define OP_GIMME(op,dfl) \
73         (((op)->op_flags & OPf_WANT) ? ((op)->op_flags & OPf_WANT) : dfl)
74
75 #define OP_GIMME_REVERSE(flags) ((flags) & G_WANT)
76
77 /*
78 =head1 "Gimme" Values
79
80 =for apidoc Amn|U32|GIMME_V
81 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_VOID>,
82 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
83 respectively. See L<perlcall> for a usage example.
84
85 =for apidoc Amn|U32|GIMME
86 A backward-compatible version of C<GIMME_V> which can only return
87 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
88 Deprecated.  Use C<GIMME_V> instead.
89
90 =cut
91 */
92
93 #define GIMME_V         OP_GIMME(PL_op, block_gimme())
94
95 /* Public flags */
96
97 #define OPf_WANT        3       /* Mask for "want" bits: */
98 #define  OPf_WANT_VOID   1      /*   Want nothing */
99 #define  OPf_WANT_SCALAR 2      /*   Want single value */
100 #define  OPf_WANT_LIST   3      /*   Want list of any length */
101 #define OPf_KIDS        4       /* There is a firstborn child. */
102 #define OPf_PARENS      8       /* This operator was parenthesized. */
103                                 /*  (Or block needs explicit scope entry.) */
104 #define OPf_REF         16      /* Certified reference. */
105                                 /*  (Return container, not containee). */
106 #define OPf_MOD         32      /* Will modify (lvalue). */
107 #define OPf_STACKED     64      /* Some arg is arriving on the stack. */
108 #define OPf_SPECIAL     128     /* Do something weird for this op: */
109                                 /*  On local LVAL, don't init local value. */
110                                 /*  On OP_SORT, subroutine is inlined. */
111                                 /*  On OP_NOT, inversion was implicit. */
112                                 /*  On OP_LEAVE, don't restore curpm. */
113                                 /*  On truncate, we truncate filehandle */
114                                 /*  On control verbs, we saw no label */
115                                 /*  On flipflop, we saw ... instead of .. */
116                                 /*  On UNOPs, saw bare parens, e.g. eof(). */
117                                 /*  On OP_ENTERSUB || OP_NULL, saw a "do". */
118                                 /*  On OP_EXISTS, treat av as av, not avhv.  */
119                                 /*  On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
120                                 /*  On pushre, rx is used as part of split, e.g. split " " */
121                                 /*  On regcomp, "use re 'eval'" was in scope */
122                                 /*  On OP_READLINE, was <$filehandle> */
123                                 /*  On RV2[ACGHS]V, don't create GV--in
124                                     defined()*/
125                                 /*  On OP_DBSTATE, indicates breakpoint
126                                  *    (runtime property) */
127                                 /*  On OP_REQUIRE, was seen as CORE::require */
128                                 /*  On OP_(ENTER|LEAVE)WHEN, there's
129                                     no condition */
130                                 /*  On OP_SMARTMATCH, an implicit smartmatch */
131                                 /*  On OP_ANONHASH and OP_ANONLIST, create a
132                                     reference to the new anon hash or array */
133                                 /*  On OP_HELEM and OP_HSLICE, localization will be followed
134                                     by assignment, so do not wipe the target if it is special
135                                     (e.g. a glob or a magic SV) */
136                                 /*  On OP_MATCH, OP_SUBST & OP_TRANS, the
137                                     operand of a logical or conditional
138                                     that was optimised away, so it should
139                                     not be bound via =~ */
140                                 /*  On OP_CONST, from a constant CV */
141                                 /*  On OP_GLOB, two meanings:
142                                     - Before ck_glob, called as CORE::glob
143                                     - After ck_glob, use Perl glob function
144                                  */
145                                 /*  On OP_PADRANGE, push @_ */
146
147 /* old names; don't use in new code, but don't break them, either */
148 #define OPf_LIST        OPf_WANT_LIST
149 #define OPf_KNOW        OPf_WANT
150
151 #define GIMME \
152           (PL_op->op_flags & OPf_WANT                                   \
153            ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST             \
154               ? G_ARRAY                                                 \
155               : G_SCALAR)                                               \
156            : dowantarray())
157
158 /* Lower bits of op_private often carry the number of arguments, as
159  * set by newBINOP, newUNOP and ck_fun */
160
161 /* NOTE: OP_NEXTSTATE and OP_DBSTATE (i.e. COPs) carry NATIVE_HINTS
162  * in op_private */
163
164 /* Private for lvalues */
165 #define OPpLVAL_INTRO   128     /* Lvalue must be localized or lvalue sub */
166
167 /* Private for OPs with TARGLEX */
168   /* (lower bits may carry MAXARG) */
169 #define OPpTARGET_MY            16      /* Target is PADMY. */
170
171 /* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
172 #define OPpREFCOUNTED           64      /* op_targ carries a refcount */
173
174 /* Private for OP_AASSIGN */
175 #define OPpASSIGN_COMMON        64      /* Left & right have syms in common. */
176
177 /* Private for OP_SASSIGN */
178 #define OPpASSIGN_BACKWARDS     64      /* Left & right switched. */
179 #define OPpASSIGN_CV_TO_GV      128     /* Possible optimisation for constants. */
180
181 /* Private for OP_MATCH and OP_SUBST{,CONT} */
182 #define OPpRUNTIME              64      /* Pattern coming in on the stack */
183
184 /* Private for OP_TRANS */
185 #define OPpTRANS_FROM_UTF       1
186 #define OPpTRANS_TO_UTF         2
187 #define OPpTRANS_IDENTICAL      4       /* right side is same as left */
188 #define OPpTRANS_SQUASH         8
189     /* 16 is used for OPpTARGET_MY */
190 #define OPpTRANS_COMPLEMENT     32
191 #define OPpTRANS_GROWS          64
192 #define OPpTRANS_DELETE         128
193 #define OPpTRANS_ALL    (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
194
195 /* Private for OP_REPEAT */
196 #define OPpREPEAT_DOLIST        64      /* List replication. */
197
198 /* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
199 #define OPpDEREF                (32|64) /* autovivify: Want ref to something: */
200 #define OPpDEREF_AV             32      /*   Want ref to AV. */
201 #define OPpDEREF_HV             64      /*   Want ref to HV. */
202 #define OPpDEREF_SV             (32|64) /*   Want ref to SV. */
203
204   /* OP_ENTERSUB only */
205 #define OPpENTERSUB_DB          16      /* Debug subroutine. */
206 #define OPpENTERSUB_HASTARG     4       /* Called from OP tree. */
207 #define OPpENTERSUB_INARGS      1       /* Lval used as arg to a sub. */
208 /* used by OPpDEREF             (32|64) */
209 /* used by HINT_STRICT_REFS     2          */
210   /* Mask for OP_ENTERSUB flags, the absence of which must be propagated
211      in dynamic context */
212 #define OPpENTERSUB_LVAL_MASK (OPpLVAL_INTRO|OPpENTERSUB_INARGS)
213
214   /* OP_RV2CV only */
215 #define OPpENTERSUB_AMPER       8       /* Used & form to call. */
216 #define OPpENTERSUB_NOPAREN     128     /* bare sub call (without parens) */
217 #define OPpMAY_RETURN_CONSTANT  1       /* If a constant sub, return the constant */
218
219   /* OP_GV only */
220 #define OPpEARLY_CV             32      /* foo() called before sub foo was parsed */
221   /* OP_?ELEM only */
222 #define OPpLVAL_DEFER           16      /* Defer creation of array/hash elem */
223   /* OP_RV2[SAH]V, OP_GVSV, OP_ENTERITER only */
224 #define OPpOUR_INTRO            16      /* Variable was in an our() */
225   /* OP_RV2[AGH]V, OP_PAD[AH]V, OP_[AH]ELEM, OP_[AH]SLICE OP_AV2ARYLEN,
226      OP_R?KEYS, OP_SUBSTR, OP_POS, OP_VEC */
227 #define OPpMAYBE_LVSUB          8       /* We might be an lvalue to return */
228   /* OP_RV2HV and OP_PADHV */
229 #define OPpTRUEBOOL             32      /* %hash in (%hash || $foo) in
230                                            void context */
231 #define OPpMAYBE_TRUEBOOL       64      /* %hash in (%hash || $foo) where
232                                            cx is not known till run time */
233
234   /* OP_SUBSTR only */
235 #define OPpSUBSTR_REPL_FIRST    16      /* 1st arg is replacement string */
236
237   /* OP_PADSV only */
238 #define OPpPAD_STATE            16      /* is a "state" pad */
239   /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
240
241   /* OP_PADRANGE only */
242   /* bit 7 is OPpLVAL_INTRO */
243 #define OPpPADRANGE_COUNTMASK   127     /* bits 6..0 hold target range, */
244 #define OPpPADRANGE_COUNTSHIFT  7       /* 7 bits in total */
245
246   /* OP_RV2GV only */
247 #define OPpDONT_INIT_GV         4       /* Call gv_fetchpv with GV_NOINIT */
248 /* (Therefore will return whatever is currently in the symbol table, not
249    guaranteed to be a PVGV)  */
250 #define OPpALLOW_FAKE           16      /* OK to return fake glob */
251
252 /* Private for OP_ENTERITER and OP_ITER */
253 #define OPpITER_REVERSED        4       /* for (reverse ...) */
254 #define OPpITER_DEF             8       /* for $_ or for my $_ */
255
256 /* Private for OP_CONST */
257 #define OPpCONST_NOVER          2       /* no 6; */
258 #define OPpCONST_SHORTCIRCUIT   4       /* eg the constant 5 in (5 || foo) */
259 #define OPpCONST_STRICT         8       /* bareword subject to strict 'subs' */
260 #define OPpCONST_ENTERED        16      /* Has been entered as symbol. */
261 #define OPpCONST_BARE           64      /* Was a bare word (filehandle?). */
262 /* Replaced by op_folded in perl itself, still used by B/B::Concise etc. */
263 #define OPpCONST_FOLDED         128     /* Result of constant folding */
264
265 /* Private for OP_FLIP/FLOP */
266 #define OPpFLIP_LINENUM         64      /* Range arg potentially a line num. */
267
268 /* Private for OP_LIST */
269 #define OPpLIST_GUESSED         64      /* Guessed that pushmark was needed. */
270
271 /* Private for OP_DELETE */
272 #define OPpSLICE                64      /* Operating on a list of keys */
273 /* Also OPpLVAL_INTRO (128) */
274
275 /* Private for OP_EXISTS */
276 #define OPpEXISTS_SUB           64      /* Checking for &sub, not {} or [].  */
277
278 /* Private for OP_SORT */
279 #define OPpSORT_NUMERIC         1       /* Optimized away { $a <=> $b } */
280 #define OPpSORT_INTEGER         2       /* Ditto while under "use integer" */
281 #define OPpSORT_REVERSE         4       /* Reversed sort */
282 #define OPpSORT_INPLACE         8       /* sort in-place; eg @a = sort @a */
283 #define OPpSORT_DESCEND         16      /* Descending sort */
284 #define OPpSORT_QSORT           32      /* Use quicksort (not mergesort) */
285 #define OPpSORT_STABLE          64      /* Use a stable algorithm */
286
287 /* Private for OP_REVERSE */
288 #define OPpREVERSE_INPLACE      8       /* reverse in-place (@a = reverse @a) */
289
290 /* Private for OP_OPEN and OP_BACKTICK */
291 #define OPpOPEN_IN_RAW          16      /* binmode(F,":raw") on input fh */
292 #define OPpOPEN_IN_CRLF         32      /* binmode(F,":crlf") on input fh */
293 #define OPpOPEN_OUT_RAW         64      /* binmode(F,":raw") on output fh */
294 #define OPpOPEN_OUT_CRLF        128     /* binmode(F,":crlf") on output fh */
295
296 /* Private for OP_EXIT, HUSH also for OP_DIE */
297 #define OPpHUSH_VMSISH          64      /* hush DCL exit msg vmsish mode*/
298 #define OPpEXIT_VMSISH          128     /* exit(0) vs. exit(1) vmsish mode*/
299
300 /* Private for OP_FTXXX */
301 #define OPpFT_ACCESS            2       /* use filetest 'access' */
302 #define OPpFT_STACKED           4       /* stacked filetest, as "-f" in "-f -x $f" */
303 #define OPpFT_STACKING          8       /* stacking filetest, as "-x" in "-f -x $f" */
304 #define OPpFT_AFTER_t           16      /* previous op was -t */
305
306 /* Private for OP_(MAP|GREP)(WHILE|START) */
307 #define OPpGREP_LEX             2       /* iterate over lexical $_ */
308     
309 /* Private for OP_ENTEREVAL */
310 #define OPpEVAL_HAS_HH          2       /* Does it have a copy of %^H */
311 #define OPpEVAL_UNICODE         4
312 #define OPpEVAL_BYTES           8
313 #define OPpEVAL_COPHH           16      /* Construct %^H from cop hints */
314 #define OPpEVAL_RE_REPARSING    32      /* eval_sv(..., G_RE_REPARSING) */
315     
316 /* Private for OP_CALLER, OP_WANTARRAY and OP_RUNCV */
317 #define OPpOFFBYONE             128     /* Treat caller(1) as caller(2) */
318
319 /* Private for OP_COREARGS */
320 /* These must not conflict with OPpDONT_INIT_GV or OPpALLOW_FAKE.
321    See pp.c:S_rv2gv. */
322 #define OPpCOREARGS_DEREF1      1       /* Arg 1 is a handle constructor */
323 #define OPpCOREARGS_DEREF2      2       /* Arg 2 is a handle constructor */
324 #define OPpCOREARGS_SCALARMOD   64      /* \$ rather than \[$@%*] */
325 #define OPpCOREARGS_PUSHMARK    128     /* Call pp_pushmark */
326
327 /* Private for OP_(LAST|REDO|NEXT|GOTO|DUMP) */
328 #define OPpPV_IS_UTF8           128     /* label is in UTF8 */
329
330 /* Private for OP_SPLIT */
331 #define OPpSPLIT_IMPLIM         128     /* implicit limit */
332
333 struct op {
334     BASEOP
335 };
336
337 struct unop {
338     BASEOP
339     OP *        op_first;
340 };
341
342 struct binop {
343     BASEOP
344     OP *        op_first;
345     OP *        op_last;
346 };
347
348 struct logop {
349     BASEOP
350     OP *        op_first;
351     OP *        op_other;
352 };
353
354 struct listop {
355     BASEOP
356     OP *        op_first;
357     OP *        op_last;
358 };
359
360 struct pmop {
361     BASEOP
362     OP *        op_first;
363     OP *        op_last;
364 #ifdef USE_ITHREADS
365     PADOFFSET   op_pmoffset;
366 #else
367     REGEXP *    op_pmregexp;            /* compiled expression */
368 #endif
369     U32         op_pmflags;
370     union {
371         OP *    op_pmreplroot;          /* For OP_SUBST */
372 #ifdef USE_ITHREADS
373         PADOFFSET  op_pmtargetoff;      /* For OP_PUSHRE */
374 #else
375         GV *    op_pmtargetgv;
376 #endif
377     }   op_pmreplrootu;
378     union {
379         OP *    op_pmreplstart; /* Only used in OP_SUBST */
380 #ifdef USE_ITHREADS
381         PADOFFSET op_pmstashoff; /* Only used in OP_MATCH, with PMf_ONCE set */
382 #else
383         HV *    op_pmstash;
384 #endif
385     }           op_pmstashstartu;
386     OP *        op_code_list;   /* list of (?{}) code blocks */
387 };
388
389 #ifdef USE_ITHREADS
390 #define PM_GETRE(o)     (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
391                          ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
392 /* The assignment is just to enforce type safety (or at least get a warning).
393  */
394 /* With first class regexps not via a reference one needs to assign
395    &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
396    is cheaper. I guess we could allow NULL, but the check above would get
397    more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
398 /* BEWARE - something that calls this macro passes (r) which has a side
399    effect.  */
400 #define PM_SETRE(o,r)   STMT_START {                                    \
401                             REGEXP *const _pm_setre = (r);              \
402                             assert(_pm_setre);                          \
403                             PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
404                         } STMT_END
405 #else
406 #define PM_GETRE(o)     ((o)->op_pmregexp)
407 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
408 #endif
409
410 /* Leave some space, so future bit allocations can go either in the shared or
411  * unshared area without affecting binary compatibility */
412 #define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+6)
413
414 /* 'use re "taint"' in scope: taint $1 etc. if target tainted */
415 #define PMf_RETAINT     (1<<(PMf_BASE_SHIFT+0))
416
417 /* match successfully only once per reset, with related flag RXf_USED in
418  * re->extflags holding state.  This is used only for ?? matches, and only on
419  * OP_MATCH and OP_QR */
420 #define PMf_ONCE        (1<<(PMf_BASE_SHIFT+1))
421
422 /* PMf_ONCE, i.e. ?pat?, has matched successfully.  Not used under threading. */
423 #define PMf_USED        (1<<(PMf_BASE_SHIFT+3))
424
425 /* subst replacement is constant */
426 #define PMf_CONST       (1<<(PMf_BASE_SHIFT+4))
427
428 /* keep 1st runtime pattern forever */
429 #define PMf_KEEP        (1<<(PMf_BASE_SHIFT+5))
430
431 #define PMf_GLOBAL      (1<<(PMf_BASE_SHIFT+6)) /* pattern had a g modifier */
432
433 /* don't reset pos() if //g fails */
434 #define PMf_CONTINUE    (1<<(PMf_BASE_SHIFT+7))
435
436 /* evaluating replacement as expr */
437 #define PMf_EVAL        (1<<(PMf_BASE_SHIFT+8))
438
439 /* Return substituted string instead of modifying it. */
440 #define PMf_NONDESTRUCT (1<<(PMf_BASE_SHIFT+9))
441
442 /* the pattern has a CV attached (currently only under qr/...(?{}).../) */
443 #define PMf_HAS_CV      (1<<(PMf_BASE_SHIFT+10))
444
445 /* op_code_list is private; don't free it etc. It may well point to
446  * code within another sub, with different pad etc */
447 #define PMf_CODELIST_PRIVATE    (1<<(PMf_BASE_SHIFT+11))
448
449 /* the PMOP is a QR (we should be able to detect that from the op type,
450  * but the regex compilation API passes just the pm flags, not the op
451  * itself */
452 #define PMf_IS_QR       (1<<(PMf_BASE_SHIFT+12))
453 #define PMf_USE_RE_EVAL (1<<(PMf_BASE_SHIFT+13)) /* use re'eval' in scope */
454
455 #if PMf_BASE_SHIFT+13 > 31
456 #   error Too many PMf_ bits used.  See above and regnodes.h for any spare in middle
457 #endif
458
459 #ifdef USE_ITHREADS
460
461 #  define PmopSTASH(o)         ((o)->op_pmflags & PMf_ONCE                         \
462                                 ? PL_stashpad[(o)->op_pmstashstartu.op_pmstashoff]   \
463                                 : NULL)
464 #  define PmopSTASH_set(o,hv)   \
465         (assert_((o)->op_pmflags & PMf_ONCE)                            \
466          (o)->op_pmstashstartu.op_pmstashoff =                          \
467             (hv) ? alloccopstash(hv) : 0)
468 #else
469 #  define PmopSTASH(o)                                                  \
470     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
471 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
472 #    define PmopSTASH_set(o,hv)         ({                              \
473         assert((o)->op_pmflags & PMf_ONCE);                             \
474         ((o)->op_pmstashstartu.op_pmstash = (hv));                      \
475     })
476 #  else
477 #    define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
478 #  endif
479 #endif
480 #define PmopSTASHPV(o)  (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
481    /* op_pmstashstartu.op_pmstash is not refcounted */
482 #define PmopSTASHPV_set(o,pv)   PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
483
484 struct svop {
485     BASEOP
486     SV *        op_sv;
487 };
488
489 struct padop {
490     BASEOP
491     PADOFFSET   op_padix;
492 };
493
494 struct pvop {
495     BASEOP
496     char *      op_pv;
497 };
498
499 struct loop {
500     BASEOP
501     OP *        op_first;
502     OP *        op_last;
503     OP *        op_redoop;
504     OP *        op_nextop;
505     OP *        op_lastop;
506 };
507
508 #define cUNOPx(o)       ((UNOP*)o)
509 #define cBINOPx(o)      ((BINOP*)o)
510 #define cLISTOPx(o)     ((LISTOP*)o)
511 #define cLOGOPx(o)      ((LOGOP*)o)
512 #define cPMOPx(o)       ((PMOP*)o)
513 #define cSVOPx(o)       ((SVOP*)o)
514 #define cPADOPx(o)      ((PADOP*)o)
515 #define cPVOPx(o)       ((PVOP*)o)
516 #define cCOPx(o)        ((COP*)o)
517 #define cLOOPx(o)       ((LOOP*)o)
518
519 #define cUNOP           cUNOPx(PL_op)
520 #define cBINOP          cBINOPx(PL_op)
521 #define cLISTOP         cLISTOPx(PL_op)
522 #define cLOGOP          cLOGOPx(PL_op)
523 #define cPMOP           cPMOPx(PL_op)
524 #define cSVOP           cSVOPx(PL_op)
525 #define cPADOP          cPADOPx(PL_op)
526 #define cPVOP           cPVOPx(PL_op)
527 #define cCOP            cCOPx(PL_op)
528 #define cLOOP           cLOOPx(PL_op)
529
530 #define cUNOPo          cUNOPx(o)
531 #define cBINOPo         cBINOPx(o)
532 #define cLISTOPo        cLISTOPx(o)
533 #define cLOGOPo         cLOGOPx(o)
534 #define cPMOPo          cPMOPx(o)
535 #define cSVOPo          cSVOPx(o)
536 #define cPADOPo         cPADOPx(o)
537 #define cPVOPo          cPVOPx(o)
538 #define cCOPo           cCOPx(o)
539 #define cLOOPo          cLOOPx(o)
540
541 #define kUNOP           cUNOPx(kid)
542 #define kBINOP          cBINOPx(kid)
543 #define kLISTOP         cLISTOPx(kid)
544 #define kLOGOP          cLOGOPx(kid)
545 #define kPMOP           cPMOPx(kid)
546 #define kSVOP           cSVOPx(kid)
547 #define kPADOP          cPADOPx(kid)
548 #define kPVOP           cPVOPx(kid)
549 #define kCOP            cCOPx(kid)
550 #define kLOOP           cLOOPx(kid)
551
552
553 #ifdef USE_ITHREADS
554 #  define       cGVOPx_gv(o)    ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
555 #  define       IS_PADGV(v)     (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
556                                  && GvIN_PAD(v))
557 #  define       IS_PADCONST(v) \
558         (v && (SvREADONLY(v) || (SvIsCOW(v) && !SvLEN(v))))
559 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
560                                  ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
561 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
562                                  ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
563 #else
564 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
565 #  define       IS_PADGV(v)     FALSE
566 #  define       IS_PADCONST(v)  FALSE
567 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
568 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
569 #endif
570
571 #define cGVOP_gv                cGVOPx_gv(PL_op)
572 #define cGVOPo_gv               cGVOPx_gv(o)
573 #define kGVOP_gv                cGVOPx_gv(kid)
574 #define cSVOP_sv                cSVOPx_sv(PL_op)
575 #define cSVOPo_sv               cSVOPx_sv(o)
576 #define kSVOP_sv                cSVOPx_sv(kid)
577
578 #ifndef PERL_CORE
579 #  define Nullop ((OP*)NULL)
580 #endif
581
582 /* Lowest byte of PL_opargs */
583 #define OA_MARK 1
584 #define OA_FOLDCONST 2
585 #define OA_RETSCALAR 4
586 #define OA_TARGET 8
587 #define OA_TARGLEX 16
588 #define OA_OTHERINT 32
589 #define OA_DANGEROUS 64
590 #define OA_DEFGV 128
591
592 /* The next 4 bits encode op class information */
593 #define OCSHIFT 8
594
595 #define OA_CLASS_MASK (15 << OCSHIFT)
596
597 #define OA_BASEOP (0 << OCSHIFT)
598 #define OA_UNOP (1 << OCSHIFT)
599 #define OA_BINOP (2 << OCSHIFT)
600 #define OA_LOGOP (3 << OCSHIFT)
601 #define OA_LISTOP (4 << OCSHIFT)
602 #define OA_PMOP (5 << OCSHIFT)
603 #define OA_SVOP (6 << OCSHIFT)
604 #define OA_PADOP (7 << OCSHIFT)
605 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
606 #define OA_LOOP (9 << OCSHIFT)
607 #define OA_COP (10 << OCSHIFT)
608 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
609 #define OA_FILESTATOP (12 << OCSHIFT)
610 #define OA_LOOPEXOP (13 << OCSHIFT)
611
612 #define OASHIFT 12
613
614 /* Remaining nybbles of PL_opargs */
615 #define OA_SCALAR 1
616 #define OA_LIST 2
617 #define OA_AVREF 3
618 #define OA_HVREF 4
619 #define OA_CVREF 5
620 #define OA_FILEREF 6
621 #define OA_SCALARREF 7
622 #define OA_OPTIONAL 8
623
624 /* Op_REFCNT is a reference count at the head of each op tree: needed
625  * since the tree is shared between threads, and between cloned closure
626  * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
627  * this count.
628  * The same mutex is used to protect the refcounts of the reg_trie_data
629  * and reg_ac_data structures, which are shared between duplicated
630  * regexes.
631  */
632
633 #ifdef USE_ITHREADS
634 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
635 #  ifdef PERL_CORE
636 #    define OP_REFCNT_LOCK              MUTEX_LOCK(&PL_op_mutex)
637 #    define OP_REFCNT_UNLOCK            MUTEX_UNLOCK(&PL_op_mutex)
638 #  else
639 #    define OP_REFCNT_LOCK              op_refcnt_lock()
640 #    define OP_REFCNT_UNLOCK            op_refcnt_unlock()
641 #  endif
642 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
643 #else
644 #  define OP_REFCNT_INIT                NOOP
645 #  define OP_REFCNT_LOCK                NOOP
646 #  define OP_REFCNT_UNLOCK              NOOP
647 #  define OP_REFCNT_TERM                NOOP
648 #endif
649
650 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
651 #ifdef PERL_DEBUG_READONLY_OPS
652 #  define OpREFCNT_inc(o)               Perl_op_refcnt_inc(aTHX_ o)
653 #  define OpREFCNT_dec(o)               Perl_op_refcnt_dec(aTHX_ o)
654 #else
655 #  define OpREFCNT_inc(o)               ((o) ? (++(o)->op_targ, (o)) : NULL)
656 #  define OpREFCNT_dec(o)               (--(o)->op_targ)
657 #endif
658
659 /* flags used by Perl_load_module() */
660 #define PERL_LOADMOD_DENY               0x1     /* no Module */
661 #define PERL_LOADMOD_NOIMPORT           0x2     /* use Module () */
662 #define PERL_LOADMOD_IMPORT_OPS         0x4     /* use Module (...) */
663
664 #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C)
665 #define ref(o, type) doref(o, type, TRUE)
666 #endif
667
668 /*
669 =head1 Optree Manipulation Functions
670
671 =for apidoc Am|OP*|LINKLIST|OP *o
672 Given the root of an optree, link the tree in execution order using the
673 C<op_next> pointers and return the first op executed. If this has
674 already been done, it will not be redone, and C<< o->op_next >> will be
675 returned. If C<< o->op_next >> is not already set, I<o> should be at
676 least an C<UNOP>.
677
678 =cut
679 */
680
681 #define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
682
683 /* no longer used anywhere in core */
684 #ifndef PERL_CORE
685 #define cv_ckproto(cv, gv, p) \
686    cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
687 #endif
688
689 #ifdef PERL_CORE
690 #  define my(o) my_attrs((o), NULL)
691 #endif
692
693 #ifdef USE_REENTRANT_API
694 #include "reentr.h"
695 #endif
696
697 #define NewOp(m,var,c,type)     \
698         (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
699 #define NewOpSz(m,var,size)     \
700         (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
701 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
702
703 /*
704  * The per-CV op slabs consist of a header (the opslab struct) and a bunch
705  * of space for allocating op slots, each of which consists of two pointers
706  * followed by an op.  The first pointer points to the next op slot.  The
707  * second points to the slab.  At the end of the slab is a null pointer,
708  * so that slot->opslot_next - slot can be used to determine the size
709  * of the op.
710  *
711  * Each CV can have multiple slabs; opslab_next points to the next slab, to
712  * form a chain.  All bookkeeping is done on the first slab, which is where
713  * all the op slots point.
714  *
715  * Freed ops are marked as freed and attached to the freed chain
716  * via op_next pointers.
717  *
718  * When there is more than one slab, the second slab in the slab chain is
719  * assumed to be the one with free space available.  It is used when allo-
720  * cating an op if there are no freed ops available or big enough.
721  */
722
723 #ifdef PERL_CORE
724 struct opslot {
725     /* keep opslot_next first */
726     OPSLOT *    opslot_next;            /* next slot */
727     OPSLAB *    opslot_slab;            /* owner */
728     OP          opslot_op;              /* the op itself */
729 };
730
731 struct opslab {
732     OPSLOT *    opslab_first;           /* first op in this slab */
733     OPSLAB *    opslab_next;            /* next slab */
734     OP *        opslab_freed;           /* chain of freed ops */
735     size_t      opslab_refcnt;          /* number of ops */
736 # ifdef PERL_DEBUG_READONLY_OPS
737     U16         opslab_size;            /* size of slab in pointers */
738     bool        opslab_readonly;
739 # endif
740     OPSLOT      opslab_slots;           /* slots begin here */
741 };
742
743 # define OPSLOT_HEADER          STRUCT_OFFSET(OPSLOT, opslot_op)
744 # define OPSLOT_HEADER_P        (OPSLOT_HEADER/sizeof(I32 *))
745 # define OpSLOT(o)              (assert_(o->op_slabbed) \
746                                  (OPSLOT *)(((char *)o)-OPSLOT_HEADER))
747 # define OpSLAB(o)              OpSLOT(o)->opslot_slab
748 # define OpslabREFCNT_dec(slab)      \
749         (((slab)->opslab_refcnt == 1) \
750          ? opslab_free_nopad(slab)     \
751          : (void)--(slab)->opslab_refcnt)
752   /* Variant that does not null out the pads */
753 # define OpslabREFCNT_dec_padok(slab) \
754         (((slab)->opslab_refcnt == 1)  \
755          ? opslab_free(slab)            \
756          : (void)--(slab)->opslab_refcnt)
757 #endif
758
759 struct block_hooks {
760     U32     bhk_flags;
761     void    (*bhk_start)        (pTHX_ int full);
762     void    (*bhk_pre_end)      (pTHX_ OP **seq);
763     void    (*bhk_post_end)     (pTHX_ OP **seq);
764     void    (*bhk_eval)         (pTHX_ OP *const saveop);
765 };
766
767 /*
768 =head1 Compile-time scope hooks
769
770 =for apidoc mx|U32|BhkFLAGS|BHK *hk
771 Return the BHK's flags.
772
773 =for apidoc mx|void *|BhkENTRY|BHK *hk|which
774 Return an entry from the BHK structure. I<which> is a preprocessor token
775 indicating which entry to return. If the appropriate flag is not set
776 this will return NULL. The type of the return value depends on which
777 entry you ask for.
778
779 =for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
780 Set an entry in the BHK structure, and set the flags to indicate it is
781 valid. I<which> is a preprocessing token indicating which entry to set.
782 The type of I<ptr> depends on the entry.
783
784 =for apidoc Amx|void|BhkDISABLE|BHK *hk|which
785 Temporarily disable an entry in this BHK structure, by clearing the
786 appropriate flag. I<which> is a preprocessor token indicating which
787 entry to disable.
788
789 =for apidoc Amx|void|BhkENABLE|BHK *hk|which
790 Re-enable an entry in this BHK structure, by setting the appropriate
791 flag. I<which> is a preprocessor token indicating which entry to enable.
792 This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
793 pointer.
794
795 =for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
796 Call all the registered block hooks for type I<which>. I<which> is a
797 preprocessing token; the type of I<arg> depends on I<which>.
798
799 =cut
800 */
801
802 #define BhkFLAGS(hk)            ((hk)->bhk_flags)
803
804 #define BHKf_bhk_start      0x01
805 #define BHKf_bhk_pre_end    0x02
806 #define BHKf_bhk_post_end   0x04
807 #define BHKf_bhk_eval       0x08
808
809 #define BhkENTRY(hk, which) \
810     ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
811
812 #define BhkENABLE(hk, which) \
813     STMT_START { \
814         BhkFLAGS(hk) |= BHKf_ ## which; \
815         assert(BhkENTRY(hk, which)); \
816     } STMT_END
817
818 #define BhkDISABLE(hk, which) \
819     STMT_START { \
820         BhkFLAGS(hk) &= ~(BHKf_ ## which); \
821     } STMT_END
822
823 #define BhkENTRY_set(hk, which, ptr) \
824     STMT_START { \
825         (hk)->which = ptr; \
826         BhkENABLE(hk, which); \
827     } STMT_END
828
829 #define CALL_BLOCK_HOOKS(which, arg) \
830     STMT_START { \
831         if (PL_blockhooks) { \
832             I32 i; \
833             for (i = av_len(PL_blockhooks); i >= 0; i--) { \
834                 SV *sv = AvARRAY(PL_blockhooks)[i]; \
835                 BHK *hk; \
836                 \
837                 assert(SvIOK(sv)); \
838                 if (SvUOK(sv)) \
839                     hk = INT2PTR(BHK *, SvUVX(sv)); \
840                 else \
841                     hk = INT2PTR(BHK *, SvIVX(sv)); \
842                 \
843                 if (BhkENTRY(hk, which)) \
844                     BhkENTRY(hk, which)(aTHX_ arg); \
845             } \
846         } \
847     } STMT_END
848
849 /* flags for rv2cv_op_cv */
850
851 #define RV2CVOPCV_MARK_EARLY     0x00000001
852 #define RV2CVOPCV_RETURN_NAME_GV 0x00000002
853
854 #define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
855
856 /* flags for op_lvalue_flags */
857
858 #define OP_LVALUE_NO_CROAK 1
859
860 /*
861 =head1 Custom Operators
862
863 =for apidoc Am|U32|XopFLAGS|XOP *xop
864 Return the XOP's flags.
865
866 =for apidoc Am||XopENTRY|XOP *xop|which
867 Return a member of the XOP structure. I<which> is a cpp token indicating
868 which entry to return. If the member is not set this will return a
869 default value. The return type depends on I<which>.
870
871 =for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
872 Set a member of the XOP structure. I<which> is a cpp token indicating
873 which entry to set. See L<perlguts/"Custom Operators"> for details about
874 the available members and how they are used.
875
876 =for apidoc Am|void|XopDISABLE|XOP *xop|which
877 Temporarily disable a member of the XOP, by clearing the appropriate flag.
878
879 =for apidoc Am|void|XopENABLE|XOP *xop|which
880 Reenable a member of the XOP which has been disabled.
881
882 =cut
883 */
884
885 struct custom_op {
886     U32             xop_flags;    
887     const char     *xop_name;
888     const char     *xop_desc;
889     U32             xop_class;
890     void          (*xop_peep)(pTHX_ OP *o, OP *oldop);
891 };
892
893 #define XopFLAGS(xop) ((xop)->xop_flags)
894
895 #define XOPf_xop_name   0x01
896 #define XOPf_xop_desc   0x02
897 #define XOPf_xop_class  0x04
898 #define XOPf_xop_peep   0x08
899
900 #define XOPd_xop_name   PL_op_name[OP_CUSTOM]
901 #define XOPd_xop_desc   PL_op_desc[OP_CUSTOM]
902 #define XOPd_xop_class  OA_BASEOP
903 #define XOPd_xop_peep   ((Perl_cpeep_t)0)
904
905 #define XopENTRY_set(xop, which, to) \
906     STMT_START { \
907         (xop)->which = (to); \
908         (xop)->xop_flags |= XOPf_ ## which; \
909     } STMT_END
910
911 #define XopENTRY(xop, which) \
912     ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
913
914 #define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
915 #define XopENABLE(xop, which) \
916     STMT_START { \
917         (xop)->xop_flags |= XOPf_ ## which; \
918         assert(XopENTRY(xop, which)); \
919     } STMT_END
920
921 /*
922 =head1 Optree Manipulation Functions
923
924 =for apidoc Am|const char *|OP_NAME|OP *o
925 Return the name of the provided OP. For core ops this looks up the name
926 from the op_type; for custom ops from the op_ppaddr.
927
928 =for apidoc Am|const char *|OP_DESC|OP *o
929 Return a short description of the provided OP.
930
931 =for apidoc Am|U32|OP_CLASS|OP *o
932 Return the class of the provided OP: that is, which of the *OP
933 structures it uses. For core ops this currently gets the information out
934 of PL_opargs, which does not always accurately reflect the type used.
935 For custom ops the type is returned from the registration, and it is up
936 to the registree to ensure it is accurate. The value returned will be
937 one of the OA_* constants from op.h.
938
939 =cut
940 */
941
942 #define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
943                     ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_name) \
944                     : PL_op_name[(o)->op_type])
945 #define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
946                     ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_desc) \
947                     : PL_op_desc[(o)->op_type])
948 #define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
949                      ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_class) \
950                      : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
951
952 #define newSUB(f, o, p, b)      Perl_newATTRSUB(aTHX_ (f), (o), (p), NULL, (b))
953
954 #ifdef PERL_MAD
955 #  define MAD_NULL 1
956 #  define MAD_PV 2
957 #  define MAD_OP 3
958 #  define MAD_SV 4
959
960 struct madprop {
961     MADPROP* mad_next;
962     void *mad_val;
963     U32 mad_vlen;
964 /*    short mad_count; */
965     char mad_key;
966     char mad_type;
967 };
968
969 struct token {
970     I32 tk_type;
971     YYSTYPE tk_lval;
972     MADPROP* tk_mad;
973 };
974 #endif
975
976 /*
977  * Values that can be held by mad_key :
978  * ^       unfilled head spot
979  * ,       literal ,
980  * ;       literal ; (blank if implicit ; at end of block)
981  * :       literal : from ?: or attr list
982  * +       unary +
983  * ?       literal ? from ?:
984  * (       literal (
985  * )       literal )
986  * [       literal [
987  * ]       literal ]
988  * {       literal {
989  * }       literal }
990  * @       literal @ sigil
991  * $       literal $ sigil
992  * *       literal * sigil
993  * !       use is source filtered
994  * &       & or sub
995  * #       whitespace/comment following ; or }
996  * #       $# sigil
997  * 1       1st ; from for(;;)
998  * 1       retired protasis
999  * 2       2nd ; from for(;;)
1000  * 2       retired apodosis
1001  * 3       C-style for list
1002  * a       sub or var attributes
1003  * a       non-method arrow operator
1004  * A       method arrow operator
1005  * A       use import args
1006  * b       format block
1007  * B       retired stub block
1008  * C       constant conditional op
1009  * d       declarator
1010  * D       do block
1011  * e       unreached "else" (see C)
1012  * e       expression producing E
1013  * E       tr/E/R/, /E/
1014  * f       folded constant op
1015  * F       peg op for format
1016  * g       op was forced to be a word
1017  * i       if/unless modifier
1018  * I       if/elsif/unless statement
1019  * k       local declarator
1020  * K       retired kid op
1021  * l       last index of array ($#foo)
1022  * L       label
1023  * m       modifier on regex
1024  * n       sub or format name
1025  * o       current operator/declarator name
1026  * o       else/continue
1027  * O       generic optimized op
1028  * p       peg to hold extra whitespace at statement level
1029  * P       peg op for package declaration
1030  * q       opening quote
1031  * =       quoted material
1032  * Q       closing quote
1033  * Q       optimized qw//
1034  * r       expression producing R
1035  * R       tr/E/R/ s/E/R/
1036  * s       sub signature
1037  * S       use import stub (no import)
1038  * S       retired sort block
1039  * t       unreached "then" (see C)
1040  * U       use import op
1041  * v       private sv of for loop
1042  * V       use version
1043  * w       while/until modifier
1044  * W       while/for statement
1045  * x       optimized qw
1046  * X       random thing
1047  * _       whitespace/comments preceding anything else
1048  * ~       =~ operator
1049  */
1050
1051 /*
1052 =head1 Hook manipulation
1053 */
1054
1055 #ifdef USE_ITHREADS
1056 #  define OP_CHECK_MUTEX_INIT           MUTEX_INIT(&PL_check_mutex)
1057 #  define OP_CHECK_MUTEX_LOCK           MUTEX_LOCK(&PL_check_mutex)
1058 #  define OP_CHECK_MUTEX_UNLOCK         MUTEX_UNLOCK(&PL_check_mutex)
1059 #  define OP_CHECK_MUTEX_TERM           MUTEX_DESTROY(&PL_check_mutex)
1060 #else
1061 #  define OP_CHECK_MUTEX_INIT           NOOP
1062 #  define OP_CHECK_MUTEX_LOCK           NOOP
1063 #  define OP_CHECK_MUTEX_UNLOCK         NOOP
1064 #  define OP_CHECK_MUTEX_TERM           NOOP
1065 #endif
1066
1067 /*
1068  * Local variables:
1069  * c-indentation-style: bsd
1070  * c-basic-offset: 4
1071  * indent-tabs-mode: nil
1072  * End:
1073  *
1074  * ex: set ts=8 sts=4 sw=4 et:
1075  */