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