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