This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
97dea427691ef4ac22c259e9c3c47e9f250b133e
[perl5.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_moresib      this op is is not the last sibling
28  *      op_spare        One spare bit
29  *      op_flags        Flags common to all operations.  See OPf_* below.
30  *      op_private      Flags peculiar to a particular operation (BUT,
31  *                      by default, set to the number of children until
32  *                      the operation is privatized by a check routine,
33  *                      which may or may not check number of children).
34  */
35 #include "op_reg_common.h"
36
37 #define OPCODE U16
38
39 typedef PERL_BITFIELD16 Optype;
40
41 /* this field now either points to the next sibling or to the parent,
42  * depending on op_moresib. So rename it from op_sibling to op_sibparent.
43  */
44 #ifdef PERL_OP_PARENT
45 #  define _OP_SIBPARENT_FIELDNAME op_sibparent
46 #else
47 #  define _OP_SIBPARENT_FIELDNAME op_sibling
48 #endif
49
50 #ifdef BASEOP_DEFINITION
51 #define BASEOP BASEOP_DEFINITION
52 #else
53 #define BASEOP                          \
54     OP*         op_next;                \
55     OP*         _OP_SIBPARENT_FIELDNAME;\
56     OP*         (*op_ppaddr)(pTHX);     \
57     PADOFFSET   op_targ;                \
58     PERL_BITFIELD16 op_type:9;          \
59     PERL_BITFIELD16 op_opt:1;           \
60     PERL_BITFIELD16 op_slabbed:1;       \
61     PERL_BITFIELD16 op_savefree:1;      \
62     PERL_BITFIELD16 op_static:1;        \
63     PERL_BITFIELD16 op_folded:1;        \
64     PERL_BITFIELD16 op_moresib:1;       \
65     PERL_BITFIELD16 op_spare:1;         \
66     U8          op_flags;               \
67     U8          op_private;
68 #endif
69
70 /* If op_type:9 is changed to :10, also change cx_pusheval()
71    Also, if the type of op_type is ever changed (e.g. to PERL_BITFIELD32)
72    then all the other bit-fields before/after it should change their
73    types too to let VC pack them into the same 4 byte integer.*/
74
75 /* for efficiency, requires OPf_WANT_VOID == G_VOID etc */
76 #define OP_GIMME(op,dfl) \
77         (((op)->op_flags & OPf_WANT) ? ((op)->op_flags & OPf_WANT) : dfl)
78
79 #define OP_GIMME_REVERSE(flags) ((flags) & G_WANT)
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.  See L<perlcall> for a usage example.
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, e.g.
117                                  *      /(...)/ while ...>;  */
118                                 /*  On truncate, we truncate filehandle */
119                                 /*  On control verbs, we saw no label */
120                                 /*  On flipflop, we saw ... instead of .. */
121                                 /*  On UNOPs, saw bare parens, e.g. eof(). */
122                                 /*  On OP_CHDIR, handle (or bare parens) */
123                                 /*  On OP_NULL, saw a "do". */
124                                 /*  On OP_EXISTS, treat av as av, not avhv.  */
125                                 /*  On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
126                                 /*  On regcomp, "use re 'eval'" was in scope */
127                                 /*  On RV2[ACGHS]V, don't create GV--in
128                                     defined()*/
129                                 /*  On OP_DBSTATE, indicates breakpoint
130                                  *    (runtime property) */
131                                 /*  On OP_REQUIRE, was seen as CORE::require */
132                                 /*  On OP_(ENTER|LEAVE)WHEN, there's
133                                     no condition */
134                                 /*  On OP_SMARTMATCH, an implicit smartmatch */
135                                 /*  On OP_ANONHASH and OP_ANONLIST, create a
136                                     reference to the new anon hash or array */
137                                 /*  On OP_HELEM, OP_MULTIDEREF and OP_HSLICE,
138                                     localization will be followed by assignment,
139                                     so do not wipe the target if it is special
140                                     (e.g. a glob or a magic SV) */
141                                 /*  On OP_MATCH, OP_SUBST & OP_TRANS, the
142                                     operand of a logical or conditional
143                                     that was optimised away, so it should
144                                     not be bound via =~ */
145                                 /*  On OP_CONST, from a constant CV */
146                                 /*  On OP_GLOB, two meanings:
147                                     - Before ck_glob, called as CORE::glob
148                                     - After ck_glob, use Perl glob function
149                                  */
150                                 /*  On OP_PADRANGE, push @_ */
151                                 /*  On OP_DUMP, has no label */
152                                 /*  On OP_UNSTACK, in a C-style for loop */
153 /* There is no room in op_flags for this one, so it has its own bit-
154    field member (op_folded) instead.  The flag is only used to tell
155    op_convert_list to set op_folded.  */
156 #define OPf_FOLDED      (1<<16)
157
158 /* old names; don't use in new code, but don't break them, either */
159 #define OPf_LIST        OPf_WANT_LIST
160 #define OPf_KNOW        OPf_WANT
161
162 #if !defined(PERL_CORE) && !defined(PERL_EXT)
163 #  define GIMME \
164           (PL_op->op_flags & OPf_WANT                                   \
165            ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST             \
166               ? G_ARRAY                                                 \
167               : G_SCALAR)                                               \
168            : dowantarray())
169 #endif
170
171
172 /* NOTE: OPp* flags are now auto-generated and defined in opcode.h,
173  *       from data in regen/op_private */
174
175
176 #define OPpTRANS_ALL    (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
177
178
179
180 /* Mask for OP_ENTERSUB flags, the absence of which must be propagated
181  in dynamic context */
182 #define OPpENTERSUB_LVAL_MASK (OPpLVAL_INTRO|OPpENTERSUB_INARGS)
183
184
185 /* things that can be elements of op_aux */
186 typedef union  {
187     PADOFFSET pad_offset;
188     SV        *sv;
189     IV        iv;
190     UV        uv;
191 } UNOP_AUX_item;
192
193 #ifdef USE_ITHREADS
194 #  define UNOP_AUX_item_sv(item) PAD_SVl((item)->pad_offset);
195 #else
196 #  define UNOP_AUX_item_sv(item) ((item)->sv);
197 #endif
198
199
200
201
202 struct op {
203     BASEOP
204 };
205
206 struct unop {
207     BASEOP
208     OP *        op_first;
209 };
210
211 struct unop_aux {
212     BASEOP
213     OP            *op_first;
214     UNOP_AUX_item *op_aux;
215 };
216
217 struct binop {
218     BASEOP
219     OP *        op_first;
220     OP *        op_last;
221 };
222
223 struct logop {
224     BASEOP
225     OP *        op_first;
226     OP *        op_other;
227 };
228
229 struct listop {
230     BASEOP
231     OP *        op_first;
232     OP *        op_last;
233 };
234
235 struct methop {
236     BASEOP
237     union {
238         /* op_u.op_first *must* be aligned the same as the op_first
239          * field of the other op types, and op_u.op_meth_sv *must*
240          * be aligned with op_sv */
241         OP* op_first;   /* optree for method name */
242         SV* op_meth_sv; /* static method name */
243     } op_u;
244 #ifdef USE_ITHREADS
245     PADOFFSET op_rclass_targ; /* pad index for redirect class */
246 #else
247     SV*       op_rclass_sv;   /* static redirect class $o->A::meth() */
248 #endif
249 };
250
251 struct pmop {
252     BASEOP
253     OP *        op_first;
254     OP *        op_last;
255 #ifdef USE_ITHREADS
256     PADOFFSET   op_pmoffset;
257 #else
258     REGEXP *    op_pmregexp;            /* compiled expression */
259 #endif
260     U32         op_pmflags;
261     union {
262         OP *    op_pmreplroot;          /* For OP_SUBST */
263         PADOFFSET op_pmtargetoff;       /* For OP_SPLIT lex ary or thr GV */
264         GV *    op_pmtargetgv;          /* For OP_SPLIT non-threaded GV */
265     }   op_pmreplrootu;
266     union {
267         OP *    op_pmreplstart; /* Only used in OP_SUBST */
268 #ifdef USE_ITHREADS
269         PADOFFSET op_pmstashoff; /* Only used in OP_MATCH, with PMf_ONCE set */
270 #else
271         HV *    op_pmstash;
272 #endif
273     }           op_pmstashstartu;
274     OP *        op_code_list;   /* list of (?{}) code blocks */
275 };
276
277 #ifdef USE_ITHREADS
278 #define PM_GETRE(o)     (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
279                          ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
280 /* The assignment is just to enforce type safety (or at least get a warning).
281  */
282 /* With first class regexps not via a reference one needs to assign
283    &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
284    is cheaper. I guess we could allow NULL, but the check above would get
285    more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
286 /* BEWARE - something that calls this macro passes (r) which has a side
287    effect.  */
288 #define PM_SETRE(o,r)   STMT_START {                                    \
289                             REGEXP *const _pm_setre = (r);              \
290                             assert(_pm_setre);                          \
291                             PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
292                         } STMT_END
293 #else
294 #define PM_GETRE(o)     ((o)->op_pmregexp)
295 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
296 #endif
297
298 /* Currently these PMf flags occupy a single 32-bit word.  Not all bits are
299  * currently used.  The lower bits are shared with their corresponding RXf flag
300  * bits, up to but not including _RXf_PMf_SHIFT_NEXT.  The unused bits
301  * immediately follow; finally the used Pmf-only (unshared) bits, so that the
302  * highest bit in the word is used.  This gathers all the unused bits as a pool
303  * in the middle, like so: 11111111111111110000001111111111
304  * where the '1's represent used bits, and the '0's unused.  This design allows
305  * us to allocate off one end of the pool if we need to add a shared bit, and
306  * off the other end if we need a non-shared bit, without disturbing the other
307  * bits.  This maximizes the likelihood of being able to change things without
308  * breaking binary compatibility.
309  *
310  * To add shared bits, do so in op_reg_common.h.  This should change
311  * _RXf_PMf_SHIFT_NEXT so that things won't compile.  Then come to regexp.h and
312  * op.h and adjust the constant adders in the definitions of PMf_BASE_SHIFT and
313  * Pmf_BASE_SHIFT down by the number of shared bits you added.  That's it.
314  * Things should be binary compatible.  But if either of these gets to having
315  * to subtract rather than add, leave at 0 and adjust all the entries below
316  * that are in terms of this according.  But if the first one of those is
317  * already PMf_BASE_SHIFT+0, there are no bits left, and a redesign is in
318  * order.
319  *
320  * To remove unshared bits, just delete its entry.  If you're where breaking
321  * binary compatibility is ok to do, you might want to adjust things to move
322  * the newly opened space so that it gets absorbed into the common pool.
323  *
324  * To add unshared bits, first use up any gaps in the middle.  Otherwise,
325  * allocate off the low end until you get to PMf_BASE_SHIFT+0.  If that isn't
326  * enough, move PMf_BASE_SHIFT down (if possible) and add the new bit at the
327  * other end instead; this preserves binary compatibility. */
328 #define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+2)
329
330 /* 'use re "taint"' in scope: taint $1 etc. if target tainted */
331 #define PMf_RETAINT     (1U<<(PMf_BASE_SHIFT+5))
332
333 /* match successfully only once per reset, with related flag RXf_USED in
334  * re->extflags holding state.  This is used only for ?? matches, and only on
335  * OP_MATCH and OP_QR */
336 #define PMf_ONCE        (1U<<(PMf_BASE_SHIFT+6))
337
338 /* PMf_ONCE, i.e. ?pat?, has matched successfully.  Not used under threading. */
339 #define PMf_USED        (1U<<(PMf_BASE_SHIFT+7))
340
341 /* subst replacement is constant */
342 #define PMf_CONST       (1U<<(PMf_BASE_SHIFT+8))
343
344 /* keep 1st runtime pattern forever */
345 #define PMf_KEEP        (1U<<(PMf_BASE_SHIFT+9))
346
347 #define PMf_GLOBAL      (1U<<(PMf_BASE_SHIFT+10)) /* pattern had a g modifier */
348
349 /* don't reset pos() if //g fails */
350 #define PMf_CONTINUE    (1U<<(PMf_BASE_SHIFT+11))
351
352 /* evaluating replacement as expr */
353 #define PMf_EVAL        (1U<<(PMf_BASE_SHIFT+12))
354
355 /* Return substituted string instead of modifying it. */
356 #define PMf_NONDESTRUCT (1U<<(PMf_BASE_SHIFT+13))
357
358 /* the pattern has a CV attached (currently only under qr/...(?{}).../) */
359 #define PMf_HAS_CV      (1U<<(PMf_BASE_SHIFT+14))
360
361 /* op_code_list is private; don't free it etc. It may well point to
362  * code within another sub, with different pad etc */
363 #define PMf_CODELIST_PRIVATE    (1U<<(PMf_BASE_SHIFT+15))
364
365 /* the PMOP is a QR (we should be able to detect that from the op type,
366  * but the regex compilation API passes just the pm flags, not the op
367  * itself */
368 #define PMf_IS_QR       (1U<<(PMf_BASE_SHIFT+16))
369 #define PMf_USE_RE_EVAL (1U<<(PMf_BASE_SHIFT+17)) /* use re'eval' in scope */
370
371 /* See comments at the beginning of these defines about adding bits.  The
372  * highest bit position should be used, so that if PMf_BASE_SHIFT gets
373  * increased, the #error below will be triggered so that you will be reminded
374  * to adjust things at the other end to keep the bit positions unchanged */
375 #if PMf_BASE_SHIFT+17 > 31
376 #   error Too many PMf_ bits used.  See above and regnodes.h for any spare in middle
377 #endif
378
379 #ifdef USE_ITHREADS
380
381 #  define PmopSTASH(o)         ((o)->op_pmflags & PMf_ONCE                         \
382                                 ? PL_stashpad[(o)->op_pmstashstartu.op_pmstashoff]   \
383                                 : NULL)
384 #  define PmopSTASH_set(o,hv)   \
385         (assert_((o)->op_pmflags & PMf_ONCE)                            \
386          (o)->op_pmstashstartu.op_pmstashoff =                          \
387             (hv) ? alloccopstash(hv) : 0)
388 #else
389 #  define PmopSTASH(o)                                                  \
390     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
391 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
392 #    define PmopSTASH_set(o,hv)         ({                              \
393         assert((o)->op_pmflags & PMf_ONCE);                             \
394         ((o)->op_pmstashstartu.op_pmstash = (hv));                      \
395     })
396 #  else
397 #    define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
398 #  endif
399 #endif
400 #define PmopSTASHPV(o)  (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
401    /* op_pmstashstartu.op_pmstash is not refcounted */
402 #define PmopSTASHPV_set(o,pv)   PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
403
404 struct svop {
405     BASEOP
406     SV *        op_sv;
407 };
408
409 struct padop {
410     BASEOP
411     PADOFFSET   op_padix;
412 };
413
414 struct pvop {
415     BASEOP
416     char *      op_pv;
417 };
418
419 struct loop {
420     BASEOP
421     OP *        op_first;
422     OP *        op_last;
423     OP *        op_redoop;
424     OP *        op_nextop;
425     OP *        op_lastop;
426 };
427
428 #define cUNOPx(o)       ((UNOP*)(o))
429 #define cUNOP_AUXx(o)   ((UNOP_AUX*)(o))
430 #define cBINOPx(o)      ((BINOP*)(o))
431 #define cLISTOPx(o)     ((LISTOP*)(o))
432 #define cLOGOPx(o)      ((LOGOP*)(o))
433 #define cPMOPx(o)       ((PMOP*)(o))
434 #define cSVOPx(o)       ((SVOP*)(o))
435 #define cPADOPx(o)      ((PADOP*)(o))
436 #define cPVOPx(o)       ((PVOP*)(o))
437 #define cCOPx(o)        ((COP*)(o))
438 #define cLOOPx(o)       ((LOOP*)(o))
439 #define cMETHOPx(o)     ((METHOP*)(o))
440
441 #define cUNOP           cUNOPx(PL_op)
442 #define cUNOP_AUX       cUNOP_AUXx(PL_op)
443 #define cBINOP          cBINOPx(PL_op)
444 #define cLISTOP         cLISTOPx(PL_op)
445 #define cLOGOP          cLOGOPx(PL_op)
446 #define cPMOP           cPMOPx(PL_op)
447 #define cSVOP           cSVOPx(PL_op)
448 #define cPADOP          cPADOPx(PL_op)
449 #define cPVOP           cPVOPx(PL_op)
450 #define cCOP            cCOPx(PL_op)
451 #define cLOOP           cLOOPx(PL_op)
452
453 #define cUNOPo          cUNOPx(o)
454 #define cUNOP_AUXo      cUNOP_AUXx(o)
455 #define cBINOPo         cBINOPx(o)
456 #define cLISTOPo        cLISTOPx(o)
457 #define cLOGOPo         cLOGOPx(o)
458 #define cPMOPo          cPMOPx(o)
459 #define cSVOPo          cSVOPx(o)
460 #define cPADOPo         cPADOPx(o)
461 #define cPVOPo          cPVOPx(o)
462 #define cCOPo           cCOPx(o)
463 #define cLOOPo          cLOOPx(o)
464
465 #define kUNOP           cUNOPx(kid)
466 #define kUNOP_AUX       cUNOP_AUXx(kid)
467 #define kBINOP          cBINOPx(kid)
468 #define kLISTOP         cLISTOPx(kid)
469 #define kLOGOP          cLOGOPx(kid)
470 #define kPMOP           cPMOPx(kid)
471 #define kSVOP           cSVOPx(kid)
472 #define kPADOP          cPADOPx(kid)
473 #define kPVOP           cPVOPx(kid)
474 #define kCOP            cCOPx(kid)
475 #define kLOOP           cLOOPx(kid)
476
477
478 typedef enum {
479     OPclass_NULL,     /*  0 */
480     OPclass_BASEOP,   /*  1 */
481     OPclass_UNOP,     /*  2 */
482     OPclass_BINOP,    /*  3 */
483     OPclass_LOGOP,    /*  4 */
484     OPclass_LISTOP,   /*  5 */
485     OPclass_PMOP,     /*  6 */
486     OPclass_SVOP,     /*  7 */
487     OPclass_PADOP,    /*  8 */
488     OPclass_PVOP,     /*  9 */
489     OPclass_LOOP,     /* 10 */
490     OPclass_COP,      /* 11 */
491     OPclass_METHOP,   /* 12 */
492     OPclass_UNOP_AUX  /* 13 */
493 } OPclass;
494
495
496 #ifdef USE_ITHREADS
497 #  define       cGVOPx_gv(o)    ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
498 #  ifndef PERL_CORE
499 #    define     IS_PADGV(v)     (v && isGV(v))
500 #    define     IS_PADCONST(v) \
501         (v && (SvREADONLY(v) || (SvIsCOW(v) && !SvLEN(v))))
502 #  endif
503 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
504                                  ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
505 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
506                                  ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
507 #  define       cMETHOPx_rclass(v) PAD_SVl(cMETHOPx(v)->op_rclass_targ)
508 #else
509 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
510 #  ifndef PERL_CORE
511 #    define     IS_PADGV(v)     FALSE
512 #    define     IS_PADCONST(v)  FALSE
513 #  endif
514 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
515 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
516 #  define       cMETHOPx_rclass(v) (cMETHOPx(v)->op_rclass_sv)
517 #endif
518
519 #  define       cMETHOPx_meth(v)        cSVOPx_sv(v)
520
521 #define cGVOP_gv                cGVOPx_gv(PL_op)
522 #define cGVOPo_gv               cGVOPx_gv(o)
523 #define kGVOP_gv                cGVOPx_gv(kid)
524 #define cSVOP_sv                cSVOPx_sv(PL_op)
525 #define cSVOPo_sv               cSVOPx_sv(o)
526 #define kSVOP_sv                cSVOPx_sv(kid)
527
528 #ifndef PERL_CORE
529 #  define Nullop ((OP*)NULL)
530 #endif
531
532 /* Lowest byte of PL_opargs */
533 #define OA_MARK 1
534 #define OA_FOLDCONST 2
535 #define OA_RETSCALAR 4
536 #define OA_TARGET 8
537 #define OA_TARGLEX 16
538 #define OA_OTHERINT 32
539 #define OA_DANGEROUS 64
540 #define OA_DEFGV 128
541
542 /* The next 4 bits (8..11) encode op class information */
543 #define OCSHIFT 8
544
545 #define OA_CLASS_MASK (15 << OCSHIFT)
546
547 #define OA_BASEOP (0 << OCSHIFT)
548 #define OA_UNOP (1 << OCSHIFT)
549 #define OA_BINOP (2 << OCSHIFT)
550 #define OA_LOGOP (3 << OCSHIFT)
551 #define OA_LISTOP (4 << OCSHIFT)
552 #define OA_PMOP (5 << OCSHIFT)
553 #define OA_SVOP (6 << OCSHIFT)
554 #define OA_PADOP (7 << OCSHIFT)
555 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
556 #define OA_LOOP (9 << OCSHIFT)
557 #define OA_COP (10 << OCSHIFT)
558 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
559 #define OA_FILESTATOP (12 << OCSHIFT)
560 #define OA_LOOPEXOP (13 << OCSHIFT)
561 #define OA_METHOP (14 << OCSHIFT)
562 #define OA_UNOP_AUX (15 << OCSHIFT)
563
564 /* Each remaining nybble of PL_opargs (i.e. bits 12..15, 16..19 etc)
565  * encode the type for each arg */
566 #define OASHIFT 12
567
568 #define OA_SCALAR 1
569 #define OA_LIST 2
570 #define OA_AVREF 3
571 #define OA_HVREF 4
572 #define OA_CVREF 5
573 #define OA_FILEREF 6
574 #define OA_SCALARREF 7
575 #define OA_OPTIONAL 8
576
577 /* Op_REFCNT is a reference count at the head of each op tree: needed
578  * since the tree is shared between threads, and between cloned closure
579  * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
580  * this count.
581  * The same mutex is used to protect the refcounts of the reg_trie_data
582  * and reg_ac_data structures, which are shared between duplicated
583  * regexes.
584  */
585
586 #ifdef USE_ITHREADS
587 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
588 #  ifdef PERL_CORE
589 #    define OP_REFCNT_LOCK              MUTEX_LOCK(&PL_op_mutex)
590 #    define OP_REFCNT_UNLOCK            MUTEX_UNLOCK(&PL_op_mutex)
591 #  else
592 #    define OP_REFCNT_LOCK              op_refcnt_lock()
593 #    define OP_REFCNT_UNLOCK            op_refcnt_unlock()
594 #  endif
595 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
596 #else
597 #  define OP_REFCNT_INIT                NOOP
598 #  define OP_REFCNT_LOCK                NOOP
599 #  define OP_REFCNT_UNLOCK              NOOP
600 #  define OP_REFCNT_TERM                NOOP
601 #endif
602
603 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
604 #ifdef PERL_DEBUG_READONLY_OPS
605 #  define OpREFCNT_inc(o)               Perl_op_refcnt_inc(aTHX_ o)
606 #  define OpREFCNT_dec(o)               Perl_op_refcnt_dec(aTHX_ o)
607 #else
608 #  define OpREFCNT_inc(o)               ((o) ? (++(o)->op_targ, (o)) : NULL)
609 #  define OpREFCNT_dec(o)               (--(o)->op_targ)
610 #endif
611
612 /* flags used by Perl_load_module() */
613 #define PERL_LOADMOD_DENY               0x1     /* no Module */
614 #define PERL_LOADMOD_NOIMPORT           0x2     /* use Module () */
615 #define PERL_LOADMOD_IMPORT_OPS         0x4     /* import arguments
616                                                    are passed as a sin-
617                                                    gle op tree, not a
618                                                    list of SVs */
619
620 #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C) || defined(PERL_IN_TOKE_C)
621 #define ref(o, type) doref(o, type, TRUE)
622 #endif
623
624 /*
625 =head1 Optree Manipulation Functions
626
627 =for apidoc Am|OP*|LINKLIST|OP *o
628 Given the root of an optree, link the tree in execution order using the
629 C<op_next> pointers and return the first op executed.  If this has
630 already been done, it will not be redone, and C<< o->op_next >> will be
631 returned.  If C<< o->op_next >> is not already set, C<o> should be at
632 least an C<UNOP>.
633
634 =cut
635 */
636
637 #define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
638
639 /* no longer used anywhere in core */
640 #ifndef PERL_CORE
641 #define cv_ckproto(cv, gv, p) \
642    cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
643 #endif
644
645 #ifdef PERL_CORE
646 #  define my(o) my_attrs((o), NULL)
647 #endif
648
649 #ifdef USE_REENTRANT_API
650 #include "reentr.h"
651 #endif
652
653 #define NewOp(m,var,c,type)     \
654         (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
655 #define NewOpSz(m,var,size)     \
656         (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
657 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
658
659 /*
660  * The per-CV op slabs consist of a header (the opslab struct) and a bunch
661  * of space for allocating op slots, each of which consists of two pointers
662  * followed by an op.  The first pointer points to the next op slot.  The
663  * second points to the slab.  At the end of the slab is a null pointer,
664  * so that slot->opslot_next - slot can be used to determine the size
665  * of the op.
666  *
667  * Each CV can have multiple slabs; opslab_next points to the next slab, to
668  * form a chain.  All bookkeeping is done on the first slab, which is where
669  * all the op slots point.
670  *
671  * Freed ops are marked as freed and attached to the freed chain
672  * via op_next pointers.
673  *
674  * When there is more than one slab, the second slab in the slab chain is
675  * assumed to be the one with free space available.  It is used when allo-
676  * cating an op if there are no freed ops available or big enough.
677  */
678
679 #ifdef PERL_CORE
680 struct opslot {
681     /* keep opslot_next first */
682     OPSLOT *    opslot_next;            /* next slot */
683     OPSLAB *    opslot_slab;            /* owner */
684     OP          opslot_op;              /* the op itself */
685 };
686
687 struct opslab {
688     OPSLOT *    opslab_first;           /* first op in this slab */
689     OPSLAB *    opslab_next;            /* next slab */
690     OP *        opslab_freed;           /* chain of freed ops */
691     size_t      opslab_refcnt;          /* number of ops */
692 # ifdef PERL_DEBUG_READONLY_OPS
693     U16         opslab_size;            /* size of slab in pointers */
694     bool        opslab_readonly;
695 # endif
696     OPSLOT      opslab_slots;           /* slots begin here */
697 };
698
699 # define OPSLOT_HEADER          STRUCT_OFFSET(OPSLOT, opslot_op)
700 # define OPSLOT_HEADER_P        (OPSLOT_HEADER/sizeof(I32 *))
701 # define OpSLOT(o)              (assert_(o->op_slabbed) \
702                                  (OPSLOT *)(((char *)o)-OPSLOT_HEADER))
703 # define OpSLAB(o)              OpSLOT(o)->opslot_slab
704 # define OpslabREFCNT_dec(slab)      \
705         (((slab)->opslab_refcnt == 1) \
706          ? opslab_free_nopad(slab)     \
707          : (void)--(slab)->opslab_refcnt)
708   /* Variant that does not null out the pads */
709 # define OpslabREFCNT_dec_padok(slab) \
710         (((slab)->opslab_refcnt == 1)  \
711          ? opslab_free(slab)            \
712          : (void)--(slab)->opslab_refcnt)
713 #endif
714
715 struct block_hooks {
716     U32     bhk_flags;
717     void    (*bhk_start)        (pTHX_ int full);
718     void    (*bhk_pre_end)      (pTHX_ OP **seq);
719     void    (*bhk_post_end)     (pTHX_ OP **seq);
720     void    (*bhk_eval)         (pTHX_ OP *const saveop);
721 };
722
723 /*
724 =head1 Compile-time scope hooks
725
726 =for apidoc mx|U32|BhkFLAGS|BHK *hk
727 Return the BHK's flags.
728
729 =for apidoc mx|void *|BhkENTRY|BHK *hk|which
730 Return an entry from the BHK structure.  C<which> is a preprocessor token
731 indicating which entry to return.  If the appropriate flag is not set
732 this will return C<NULL>.  The type of the return value depends on which
733 entry you ask for.
734
735 =for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
736 Set an entry in the BHK structure, and set the flags to indicate it is
737 valid.  C<which> is a preprocessing token indicating which entry to set.
738 The type of C<ptr> depends on the entry.
739
740 =for apidoc Amx|void|BhkDISABLE|BHK *hk|which
741 Temporarily disable an entry in this BHK structure, by clearing the
742 appropriate flag.  C<which> is a preprocessor token indicating which
743 entry to disable.
744
745 =for apidoc Amx|void|BhkENABLE|BHK *hk|which
746 Re-enable an entry in this BHK structure, by setting the appropriate
747 flag.  C<which> is a preprocessor token indicating which entry to enable.
748 This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
749 pointer.
750
751 =for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
752 Call all the registered block hooks for type C<which>.  C<which> is a
753 preprocessing token; the type of C<arg> depends on C<which>.
754
755 =cut
756 */
757
758 #define BhkFLAGS(hk)            ((hk)->bhk_flags)
759
760 #define BHKf_bhk_start      0x01
761 #define BHKf_bhk_pre_end    0x02
762 #define BHKf_bhk_post_end   0x04
763 #define BHKf_bhk_eval       0x08
764
765 #define BhkENTRY(hk, which) \
766     ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
767
768 #define BhkENABLE(hk, which) \
769     STMT_START { \
770         BhkFLAGS(hk) |= BHKf_ ## which; \
771         assert(BhkENTRY(hk, which)); \
772     } STMT_END
773
774 #define BhkDISABLE(hk, which) \
775     STMT_START { \
776         BhkFLAGS(hk) &= ~(BHKf_ ## which); \
777     } STMT_END
778
779 #define BhkENTRY_set(hk, which, ptr) \
780     STMT_START { \
781         (hk)->which = ptr; \
782         BhkENABLE(hk, which); \
783     } STMT_END
784
785 #define CALL_BLOCK_HOOKS(which, arg) \
786     STMT_START { \
787         if (PL_blockhooks) { \
788             SSize_t i; \
789             for (i = av_tindex(PL_blockhooks); i >= 0; i--) { \
790                 SV *sv = AvARRAY(PL_blockhooks)[i]; \
791                 BHK *hk; \
792                 \
793                 assert(SvIOK(sv)); \
794                 if (SvUOK(sv)) \
795                     hk = INT2PTR(BHK *, SvUVX(sv)); \
796                 else \
797                     hk = INT2PTR(BHK *, SvIVX(sv)); \
798                 \
799                 if (BhkENTRY(hk, which)) \
800                     BhkENTRY(hk, which)(aTHX_ arg); \
801             } \
802         } \
803     } STMT_END
804
805 /* flags for rv2cv_op_cv */
806
807 #define RV2CVOPCV_MARK_EARLY     0x00000001
808 #define RV2CVOPCV_RETURN_NAME_GV 0x00000002
809 #define RV2CVOPCV_RETURN_STUB    0x00000004
810 #ifdef PERL_CORE /* behaviour of this flag is subject to change: */
811 # define RV2CVOPCV_MAYBE_NAME_GV  0x00000008
812 #endif
813 #define RV2CVOPCV_FLAG_MASK      0x0000000f /* all of the above */
814
815 #define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
816
817 /* flags for op_lvalue_flags */
818
819 #define OP_LVALUE_NO_CROAK 1
820
821 /*
822 =head1 Custom Operators
823
824 =for apidoc Am|U32|XopFLAGS|XOP *xop
825 Return the XOP's flags.
826
827 =for apidoc Am||XopENTRY|XOP *xop|which
828 Return a member of the XOP structure.  C<which> is a cpp token
829 indicating which entry to return.  If the member is not set
830 this will return a default value.  The return type depends
831 on C<which>.  This macro evaluates its arguments more than
832 once.  If you are using C<Perl_custom_op_xop> to retreive a
833 C<XOP *> from a C<OP *>, use the more efficient L</XopENTRYCUSTOM> instead.
834
835 =for apidoc Am||XopENTRYCUSTOM|const OP *o|which
836 Exactly like C<XopENTRY(XopENTRY(Perl_custom_op_xop(aTHX_ o), which)> but more
837 efficient.  The C<which> parameter is identical to L</XopENTRY>.
838
839 =for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
840 Set a member of the XOP structure.  C<which> is a cpp token
841 indicating which entry to set.  See L<perlguts/"Custom Operators">
842 for details about the available members and how
843 they are used.  This macro evaluates its argument
844 more than once.
845
846 =for apidoc Am|void|XopDISABLE|XOP *xop|which
847 Temporarily disable a member of the XOP, by clearing the appropriate flag.
848
849 =for apidoc Am|void|XopENABLE|XOP *xop|which
850 Reenable a member of the XOP which has been disabled.
851
852 =cut
853 */
854
855 struct custom_op {
856     U32             xop_flags;    
857     const char     *xop_name;
858     const char     *xop_desc;
859     U32             xop_class;
860     void          (*xop_peep)(pTHX_ OP *o, OP *oldop);
861 };
862
863 /* return value of Perl_custom_op_get_field, similar to void * then casting but
864    the U32 doesn't need truncation on 64 bit platforms in the caller, also
865    for easier macro writing */
866 typedef union {
867     const char     *xop_name;
868     const char     *xop_desc;
869     U32             xop_class;
870     void          (*xop_peep)(pTHX_ OP *o, OP *oldop);
871     XOP            *xop_ptr;
872 } XOPRETANY;
873
874 #define XopFLAGS(xop) ((xop)->xop_flags)
875
876 #define XOPf_xop_name   0x01
877 #define XOPf_xop_desc   0x02
878 #define XOPf_xop_class  0x04
879 #define XOPf_xop_peep   0x08
880
881 /* used by Perl_custom_op_get_field for option checking */
882 typedef enum {
883     XOPe_xop_ptr = 0, /* just get the XOP *, don't look inside it */
884     XOPe_xop_name = XOPf_xop_name,
885     XOPe_xop_desc = XOPf_xop_desc,
886     XOPe_xop_class = XOPf_xop_class,
887     XOPe_xop_peep = XOPf_xop_peep
888 } xop_flags_enum;
889
890 #define XOPd_xop_name   PL_op_name[OP_CUSTOM]
891 #define XOPd_xop_desc   PL_op_desc[OP_CUSTOM]
892 #define XOPd_xop_class  OA_BASEOP
893 #define XOPd_xop_peep   ((Perl_cpeep_t)0)
894
895 #define XopENTRY_set(xop, which, to) \
896     STMT_START { \
897         (xop)->which = (to); \
898         (xop)->xop_flags |= XOPf_ ## which; \
899     } STMT_END
900
901 #define XopENTRY(xop, which) \
902     ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
903
904 #define XopENTRYCUSTOM(o, which) \
905     (Perl_custom_op_get_field(aTHX_ o, XOPe_ ## which).which)
906
907 #define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
908 #define XopENABLE(xop, which) \
909     STMT_START { \
910         (xop)->xop_flags |= XOPf_ ## which; \
911         assert(XopENTRY(xop, which)); \
912     } STMT_END
913
914 #define Perl_custom_op_xop(x) \
915     (Perl_custom_op_get_field(x, XOPe_xop_ptr).xop_ptr)
916
917 /*
918 =head1 Optree Manipulation Functions
919
920 =for apidoc Am|const char *|OP_NAME|OP *o
921 Return the name of the provided OP.  For core ops this looks up the name
922 from the op_type; for custom ops from the op_ppaddr.
923
924 =for apidoc Am|const char *|OP_DESC|OP *o
925 Return a short description of the provided OP.
926
927 =for apidoc Am|U32|OP_CLASS|OP *o
928 Return the class of the provided OP: that is, which of the *OP
929 structures it uses.  For core ops this currently gets the information out
930 of C<PL_opargs>, which does not always accurately reflect the type used;
931 in v5.26 onwards, see also the function C<L</op_class>> which can do a better
932 job of determining the used type.
933
934 For custom ops the type is returned from the registration, and it is up
935 to the registree to ensure it is accurate.  The value returned will be
936 one of the C<OA_>* constants from F<op.h>.
937
938 =for apidoc Am|bool|OP_TYPE_IS|OP *o|Optype type
939 Returns true if the given OP is not a C<NULL> pointer
940 and if it is of the given type.
941
942 The negation of this macro, C<OP_TYPE_ISNT> is also available
943 as well as C<OP_TYPE_IS_NN> and C<OP_TYPE_ISNT_NN> which elide
944 the NULL pointer check.
945
946 =for apidoc Am|bool|OP_TYPE_IS_OR_WAS|OP *o|Optype type
947 Returns true if the given OP is not a NULL pointer and
948 if it is of the given type or used to be before being
949 replaced by an OP of type OP_NULL.
950
951 The negation of this macro, C<OP_TYPE_ISNT_AND_WASNT>
952 is also available as well as C<OP_TYPE_IS_OR_WAS_NN>
953 and C<OP_TYPE_ISNT_AND_WASNT_NN> which elide
954 the C<NULL> pointer check.
955
956 =for apidoc Am|bool|OpHAS_SIBLING|OP *o
957 Returns true if C<o> has a sibling
958
959 =for apidoc Am|OP*|OpSIBLING|OP *o
960 Returns the sibling of C<o>, or C<NULL> if there is no sibling
961
962 =for apidoc Am|void|OpMORESIB_set|OP *o|OP *sib
963 Sets the sibling of C<o> to the non-zero value C<sib>. See also C<L</OpLASTSIB_set>>
964 and C<L</OpMAYBESIB_set>>. For a higher-level interface, see
965 C<L</op_sibling_splice>>.
966
967 =for apidoc Am|void|OpLASTSIB_set|OP *o|OP *parent
968 Marks C<o> as having no further siblings. On C<PERL_OP_PARENT> builds, marks
969 o as having the specified parent. See also C<L</OpMORESIB_set>> and
970 C<OpMAYBESIB_set>. For a higher-level interface, see
971 C<L</op_sibling_splice>>.
972
973 =for apidoc Am|void|OpMAYBESIB_set|OP *o|OP *sib|OP *parent
974 Conditionally does C<OpMORESIB_set> or C<OpLASTSIB_set> depending on whether
975 C<sib> is non-null. For a higher-level interface, see C<L</op_sibling_splice>>.
976
977 =cut
978 */
979
980 #define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
981                     ? XopENTRYCUSTOM(o, xop_name) \
982                     : PL_op_name[(o)->op_type])
983 #define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
984                     ? XopENTRYCUSTOM(o, xop_desc) \
985                     : PL_op_desc[(o)->op_type])
986 #define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
987                      ? XopENTRYCUSTOM(o, xop_class) \
988                      : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
989
990 #define OP_TYPE_IS(o, type) ((o) && (o)->op_type == (type))
991 #define OP_TYPE_IS_NN(o, type) ((o)->op_type == (type))
992 #define OP_TYPE_ISNT(o, type) ((o) && (o)->op_type != (type))
993 #define OP_TYPE_ISNT_NN(o, type) ((o)->op_type != (type))
994
995 #define OP_TYPE_IS_OR_WAS_NN(o, type) \
996     ( ((o)->op_type == OP_NULL \
997        ? (o)->op_targ \
998        : (o)->op_type) \
999       == (type) )
1000
1001 #define OP_TYPE_IS_OR_WAS(o, type) \
1002     ( (o) && OP_TYPE_IS_OR_WAS_NN(o, type) )
1003
1004 #define OP_TYPE_ISNT_AND_WASNT_NN(o, type) \
1005     ( ((o)->op_type == OP_NULL \
1006        ? (o)->op_targ \
1007        : (o)->op_type) \
1008       != (type) )
1009
1010 #define OP_TYPE_ISNT_AND_WASNT(o, type) \
1011     ( (o) && OP_TYPE_ISNT_AND_WASNT_NN(o, type) )
1012
1013
1014 #ifdef PERL_OP_PARENT
1015 #  define OpHAS_SIBLING(o)      (cBOOL((o)->op_moresib))
1016 #  define OpSIBLING(o)          (0 + (o)->op_moresib ? (o)->op_sibparent : NULL)
1017 #  define OpMORESIB_set(o, sib) ((o)->op_moresib = 1, (o)->op_sibparent = (sib))
1018 #  define OpLASTSIB_set(o, parent) \
1019        ((o)->op_moresib = 0, (o)->op_sibparent = (parent))
1020 #  define OpMAYBESIB_set(o, sib, parent) \
1021        ((o)->op_sibparent = ((o)->op_moresib = cBOOL(sib)) ? (sib) : (parent))
1022 #else
1023 #  define OpHAS_SIBLING(o)      (cBOOL((o)->op_sibling))
1024 #  define OpSIBLING(o)          (0 + (o)->op_sibling)
1025 #  define OpMORESIB_set(o, sib) ((o)->op_moresib = 1, (o)->op_sibling = (sib))
1026 #  define OpLASTSIB_set(o, parent) \
1027        ((o)->op_moresib = 0, (o)->op_sibling = NULL)
1028 #  define OpMAYBESIB_set(o, sib, parent) \
1029        ((o)->op_moresib = cBOOL(sib), (o)->op_sibling = (sib))
1030 #endif
1031
1032 #if !defined(PERL_CORE) && !defined(PERL_EXT)
1033 /* for backwards compatibility only */
1034 #  define OP_SIBLING(o)         OpSIBLING(o)
1035 #endif
1036
1037 #define newATTRSUB(f, o, p, a, b) Perl_newATTRSUB_x(aTHX_  f, o, p, a, b, FALSE)
1038 #define newSUB(f, o, p, b)      newATTRSUB((f), (o), (p), NULL, (b))
1039
1040 /*
1041 =head1 Hook manipulation
1042 */
1043
1044 #ifdef USE_ITHREADS
1045 #  define OP_CHECK_MUTEX_INIT           MUTEX_INIT(&PL_check_mutex)
1046 #  define OP_CHECK_MUTEX_LOCK           MUTEX_LOCK(&PL_check_mutex)
1047 #  define OP_CHECK_MUTEX_UNLOCK         MUTEX_UNLOCK(&PL_check_mutex)
1048 #  define OP_CHECK_MUTEX_TERM           MUTEX_DESTROY(&PL_check_mutex)
1049 #else
1050 #  define OP_CHECK_MUTEX_INIT           NOOP
1051 #  define OP_CHECK_MUTEX_LOCK           NOOP
1052 #  define OP_CHECK_MUTEX_UNLOCK         NOOP
1053 #  define OP_CHECK_MUTEX_TERM           NOOP
1054 #endif
1055
1056
1057 /* Stuff for OP_MULTDEREF/pp_multideref. */
1058
1059 /* actions */
1060
1061 /* Load another word of actions/flag bits. Must be 0 */
1062 #define MDEREF_reload                       0
1063
1064 #define MDEREF_AV_pop_rv2av_aelem           1
1065 #define MDEREF_AV_gvsv_vivify_rv2av_aelem   2
1066 #define MDEREF_AV_padsv_vivify_rv2av_aelem  3
1067 #define MDEREF_AV_vivify_rv2av_aelem        4
1068 #define MDEREF_AV_padav_aelem               5
1069 #define MDEREF_AV_gvav_aelem                6
1070
1071 #define MDEREF_HV_pop_rv2hv_helem           8
1072 #define MDEREF_HV_gvsv_vivify_rv2hv_helem   9
1073 #define MDEREF_HV_padsv_vivify_rv2hv_helem 10
1074 #define MDEREF_HV_vivify_rv2hv_helem       11
1075 #define MDEREF_HV_padhv_helem              12
1076 #define MDEREF_HV_gvhv_helem               13
1077
1078 #define MDEREF_ACTION_MASK                0xf
1079
1080 /* key / index type */
1081
1082 #define MDEREF_INDEX_none   0x00 /* run external ops to generate index */
1083 #define MDEREF_INDEX_const  0x10 /* index is const PV/UV */
1084 #define MDEREF_INDEX_padsv  0x20 /* index is lexical var */
1085 #define MDEREF_INDEX_gvsv   0x30 /* index is GV */
1086
1087 #define MDEREF_INDEX_MASK   0x30
1088
1089 /* bit flags */
1090
1091 #define MDEREF_FLAG_last    0x40 /* the last [ah]elem; PL_op flags apply */
1092
1093 #define MDEREF_MASK         0x7F
1094 #define MDEREF_SHIFT           7
1095
1096 #if defined(PERL_IN_DOOP_C) || defined(PERL_IN_PP_C)
1097 static const char * const deprecated_above_ff_msg
1098     = "Use of strings with code points over 0xFF as arguments to "
1099       "%s operator is deprecated. This will be a fatal error in "
1100       "Perl 5.28";
1101 #endif
1102
1103
1104 /*
1105  * ex: set ts=8 sts=4 sw=4 et:
1106  */