This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
t/porting/regen.t: be even more helpful when tests fail
[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.)
18 * op_ppaddr Pointer to current ppcode's function.
19 * op_type The type of the operation.
2814eb74
PJ
20 * op_opt Whether or not the op has been optimised by the
21 * peephole optimiser.
8be227ab 22 * op_slabbed allocated via opslab
90840c5d
RU
23 * op_static tell op_free() to skip PerlMemShared_free(), when
24 * !op_slabbed.
bb38a9e0 25 * op_savefree on savestack via SAVEFREEOP
3513c740 26 * op_folded Result/remainder of a constant fold operation.
87b5a8b9 27 * op_moresib this op is is not the last sibling
29e61fd9 28 * op_spare One spare bit
79072805
LW
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 */
1850c8f9 35#include "op_reg_common.h"
79072805 36
79072805 37#define OPCODE U16
79072805 38
61a59f30 39typedef PERL_BITFIELD16 Optype;
0053d415 40
86cd3a13 41/* this field now either points to the next sibling or to the parent,
87b5a8b9 42 * depending on op_moresib. So rename it from op_sibling to op_sibparent.
86cd3a13
DM
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
0f4eea8f
DL
50#ifdef BASEOP_DEFINITION
51#define BASEOP BASEOP_DEFINITION
52#else
79072805
LW
53#define BASEOP \
54 OP* op_next; \
86cd3a13 55 OP* _OP_SIBPARENT_FIELDNAME;\
16c91539 56 OP* (*op_ppaddr)(pTHX); \
79072805 57 PADOFFSET op_targ; \
654eccd5
JD
58 PERL_BITFIELD16 op_type:9; \
59 PERL_BITFIELD16 op_opt:1; \
8be227ab 60 PERL_BITFIELD16 op_slabbed:1; \
bb38a9e0 61 PERL_BITFIELD16 op_savefree:1; \
90840c5d 62 PERL_BITFIELD16 op_static:1; \
3513c740 63 PERL_BITFIELD16 op_folded:1; \
87b5a8b9 64 PERL_BITFIELD16 op_moresib:1; \
29e61fd9 65 PERL_BITFIELD16 op_spare:1; \
a0d0e21e
LW
66 U8 op_flags; \
67 U8 op_private;
0f4eea8f 68#endif
79072805 69
13febba5 70/* If op_type:9 is changed to :10, also change cx_pusheval()
0053d415
JD
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.*/
17347a51 74
fe615074 75/* for efficiency, requires OPf_WANT_VOID == G_VOID etc */
54310121 76#define OP_GIMME(op,dfl) \
fe615074 77 (((op)->op_flags & OPf_WANT) ? ((op)->op_flags & OPf_WANT) : dfl)
54310121 78
2f8edad0 79#define OP_GIMME_REVERSE(flags) ((flags) & G_WANT)
4f911530 80
954c1994 81/*
ccfc67b7
JH
82=head1 "Gimme" Values
83
954c1994
GS
84=for apidoc Amn|U32|GIMME_V
85The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
91e74348 86C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
72d33970 87respectively. See L<perlcall> for a usage example.
954c1994
GS
88
89=for apidoc Amn|U32|GIMME
90A backward-compatible version of C<GIMME_V> which can only return
91C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
92Deprecated. Use C<GIMME_V> instead.
93
94=cut
95*/
96
533c011a 97#define GIMME_V OP_GIMME(PL_op, block_gimme())
79072805
LW
98
99/* Public flags */
54310121
PP
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 */
79072805
LW
105#define OPf_KIDS 4 /* There is a firstborn child. */
106#define OPf_PARENS 8 /* This operator was parenthesized. */
463ee0b2 107 /* (Or block needs explicit scope entry.) */
a0d0e21e
LW
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. */
79072805
LW
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. */
c349b9a0
DM
116 /* On OP_LEAVE, don't restore curpm, e.g.
117 * /(...)/ while ...>; */
79072805
LW
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(). */
deb92a6c 122 /* On OP_CHDIR, handle (or bare parens) */
a2167ea9 123 /* On OP_NULL, saw a "do". */
afebc493 124 /* On OP_EXISTS, treat av as av, not avhv. */
f2ec2afd 125 /* On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
497711e7 126 /* On regcomp, "use re 'eval'" was in scope */
17fda545
NC
127 /* On RV2[ACGHS]V, don't create GV--in
128 defined()*/
5df8de69
DM
129 /* On OP_DBSTATE, indicates breakpoint
130 * (runtime property) */
6b514a0d 131 /* On OP_REQUIRE, was seen as CORE::require */
fc7debfb
FC
132 /* On OP_(ENTER|LEAVE)WHEN, there's
133 no condition */
0d863452 134 /* On OP_SMARTMATCH, an implicit smartmatch */
78c72037
NC
135 /* On OP_ANONHASH and OP_ANONLIST, create a
136 reference to the new anon hash or array */
fedf30e1
DM
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) */
2474a784
FC
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 =~ */
6b7c6d95 145 /* On OP_CONST, from a constant CV */
d67594ff
FC
146 /* On OP_GLOB, two meanings:
147 - Before ck_glob, called as CORE::glob
148 - After ck_glob, use Perl glob function
149 */
d5524600 150 /* On OP_PADRANGE, push @_ */
7d1d69cb 151 /* On OP_DUMP, has no label */
205681b5 152 /* On OP_UNSTACK, in a C-style for loop */
6d4eed21
FC
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
79072805 157
54310121 158/* old names; don't use in new code, but don't break them, either */
d91ab173
GS
159#define OPf_LIST OPf_WANT_LIST
160#define OPf_KNOW OPf_WANT
954c1994 161
7143f21c 162#if !defined(PERL_CORE) && !defined(PERL_EXT)
82334630 163# define GIMME \
62a559b8
NIS
164 (PL_op->op_flags & OPf_WANT \
165 ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \
d91ab173
GS
166 ? G_ARRAY \
167 : G_SCALAR) \
168 : dowantarray())
82334630 169#endif
54310121 170
1dafeec8 171
f3574cc6
DM
172/* NOTE: OPp* flags are now auto-generated and defined in opcode.h,
173 * from data in regen/op_private */
d41ff1b8 174
a0d0e21e 175
59f00321 176#define OPpTRANS_ALL (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
79072805 177
97e1065a 178
97e1065a 179
f3574cc6
DM
180/* Mask for OP_ENTERSUB flags, the absence of which must be propagated
181 in dynamic context */
777d9014
FC
182#define OPpENTERSUB_LVAL_MASK (OPpLVAL_INTRO|OPpENTERSUB_INARGS)
183
5db1eb8d 184
2f7c6295
DM
185/* things that can be elements of op_aux */
186typedef union {
187 PADOFFSET pad_offset;
188 SV *sv;
189 IV iv;
190 UV uv;
191} UNOP_AUX_item;
192
fedf30e1
DM
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
60041a09 201
79072805
LW
202struct op {
203 BASEOP
204};
205
206struct unop {
207 BASEOP
208 OP * op_first;
209};
210
2f7c6295
DM
211struct unop_aux {
212 BASEOP
213 OP *op_first;
214 UNOP_AUX_item *op_aux;
215};
216
79072805
LW
217struct binop {
218 BASEOP
219 OP * op_first;
220 OP * op_last;
221};
222
223struct logop {
224 BASEOP
225 OP * op_first;
226 OP * op_other;
227};
228
79072805
LW
229struct listop {
230 BASEOP
231 OP * op_first;
232 OP * op_last;
79072805
LW
233};
234
b46e009d 235struct 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;
810bd8b7 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
b46e009d 249};
250
79072805
LW
251struct pmop {
252 BASEOP
253 OP * op_first;
254 OP * op_last;
1fcf4c12 255#ifdef USE_ITHREADS
784e50c8 256 PADOFFSET op_pmoffset;
1fcf4c12
AB
257#else
258 REGEXP * op_pmregexp; /* compiled expression */
259#endif
69bdead3 260 U32 op_pmflags;
29f2e912 261 union {
20e98b0f 262 OP * op_pmreplroot; /* For OP_SUBST */
5012eebe
DM
263 PADOFFSET op_pmtargetoff; /* For OP_SPLIT lex ary or thr GV */
264 GV * op_pmtargetgv; /* For OP_SPLIT non-threaded GV */
20e98b0f
NC
265 } op_pmreplrootu;
266 union {
29f2e912 267 OP * op_pmreplstart; /* Only used in OP_SUBST */
cb55de95 268#ifdef USE_ITHREADS
23083432 269 PADOFFSET op_pmstashoff; /* Only used in OP_MATCH, with PMf_ONCE set */
cb55de95 270#else
29f2e912 271 HV * op_pmstash;
cb55de95 272#endif
29f2e912 273 } op_pmstashstartu;
68e2671b 274 OP * op_code_list; /* list of (?{}) code blocks */
79072805 275};
a0d0e21e 276
1fcf4c12 277#ifdef USE_ITHREADS
14a49a24
NC
278#define PM_GETRE(o) (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
279 ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
ede1273d
NC
280/* The assignment is just to enforce type safety (or at least get a warning).
281 */
14a49a24
NC
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. */
ede1273d 288#define PM_SETRE(o,r) STMT_START { \
b1bc3f34 289 REGEXP *const _pm_setre = (r); \
7948fc08 290 assert(_pm_setre); \
b1bc3f34 291 PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
ede1273d 292 } STMT_END
1fcf4c12 293#else
b9ed2502
AB
294#define PM_GETRE(o) ((o)->op_pmregexp)
295#define PM_SETRE(o,r) ((o)->op_pmregexp = (r))
1fcf4c12 296#endif
4825b64b 297
a6cd0fea
KW
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. */
d262c0c7 328#define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+2)
f4a4cecb 329
ef07e810 330/* 'use re "taint"' in scope: taint $1 etc. if target tainted */
9cba692b 331#define PMf_RETAINT (1U<<(PMf_BASE_SHIFT+5))
c737faaf 332
c0f1c194
KW
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 */
9cba692b 336#define PMf_ONCE (1U<<(PMf_BASE_SHIFT+6))
1850c8f9 337
d234778b 338/* PMf_ONCE, i.e. ?pat?, has matched successfully. Not used under threading. */
9cba692b 339#define PMf_USED (1U<<(PMf_BASE_SHIFT+7))
1850c8f9
KW
340
341/* subst replacement is constant */
9cba692b 342#define PMf_CONST (1U<<(PMf_BASE_SHIFT+8))
c737faaf 343
1850c8f9 344/* keep 1st runtime pattern forever */
9cba692b 345#define PMf_KEEP (1U<<(PMf_BASE_SHIFT+9))
4da3eb8b 346
9cba692b 347#define PMf_GLOBAL (1U<<(PMf_BASE_SHIFT+10)) /* pattern had a g modifier */
c737faaf 348
1850c8f9 349/* don't reset pos() if //g fails */
9cba692b 350#define PMf_CONTINUE (1U<<(PMf_BASE_SHIFT+11))
1850c8f9
KW
351
352/* evaluating replacement as expr */
9cba692b 353#define PMf_EVAL (1U<<(PMf_BASE_SHIFT+12))
c0f1c194
KW
354
355/* Return substituted string instead of modifying it. */
9cba692b 356#define PMf_NONDESTRUCT (1U<<(PMf_BASE_SHIFT+13))
e357fc67 357
d63c20f2 358/* the pattern has a CV attached (currently only under qr/...(?{}).../) */
9cba692b 359#define PMf_HAS_CV (1U<<(PMf_BASE_SHIFT+14))
d63c20f2 360
867940b8
DM
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 */
9cba692b 363#define PMf_CODELIST_PRIVATE (1U<<(PMf_BASE_SHIFT+15))
867940b8 364
2a92a973
DM
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 */
9cba692b
KW
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 */
a6cd0fea
KW
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
32cdcf9d 376# error Too many PMf_ bits used. See above and regnodes.h for any spare in middle
1850c8f9 377#endif
79072805 378
cb55de95 379#ifdef USE_ITHREADS
05ec9bb3 380
23083432
FC
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 = \
01f44973 387 (hv) ? alloccopstash(hv) : 0)
cb55de95 388#else
29f2e912
NC
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
cb55de95 399#endif
23083432
FC
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))
cb55de95 403
79072805
LW
404struct svop {
405 BASEOP
406 SV * op_sv;
407};
408
7934575e 409struct padop {
79072805 410 BASEOP
7934575e 411 PADOFFSET op_padix;
79072805
LW
412};
413
414struct pvop {
415 BASEOP
416 char * op_pv;
417};
418
79072805
LW
419struct loop {
420 BASEOP
421 OP * op_first;
422 OP * op_last;
79072805
LW
423 OP * op_redoop;
424 OP * op_nextop;
425 OP * op_lastop;
426};
427
9524b6e6
FC
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))
350de78d
GS
440
441#define cUNOP cUNOPx(PL_op)
2f7c6295 442#define cUNOP_AUX cUNOP_AUXx(PL_op)
350de78d
GS
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)
2f7c6295 454#define cUNOP_AUXo cUNOP_AUXx(o)
350de78d
GS
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)
2f7c6295 466#define kUNOP_AUX cUNOP_AUXx(kid)
350de78d
GS
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#ifdef USE_ITHREADS
dd2155a4 479# define cGVOPx_gv(o) ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
9429039d
FC
480# ifndef PERL_CORE
481# define IS_PADGV(v) (v && isGV(v))
482# define IS_PADCONST(v) \
f5a0fd1e 483 (v && (SvREADONLY(v) || (SvIsCOW(v) && !SvLEN(v))))
9429039d 484# endif
7766f137 485# define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
dd2155a4 486 ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
638eceb6 487# define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
dd2155a4 488 ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
810bd8b7 489# define cMETHOPx_rclass(v) PAD_SVl(cMETHOPx(v)->op_rclass_targ)
350de78d 490#else
638eceb6 491# define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
9429039d
FC
492# ifndef PERL_CORE
493# define IS_PADGV(v) FALSE
494# define IS_PADCONST(v) FALSE
495# endif
7766f137 496# define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
638eceb6 497# define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
810bd8b7 498# define cMETHOPx_rclass(v) (cMETHOPx(v)->op_rclass_sv)
350de78d 499#endif
79072805 500
b46e009d 501# define cMETHOPx_meth(v) cSVOPx_sv(v)
502
638eceb6
GS
503#define cGVOP_gv cGVOPx_gv(PL_op)
504#define cGVOPo_gv cGVOPx_gv(o)
505#define kGVOP_gv cGVOPx_gv(kid)
506#define cSVOP_sv cSVOPx_sv(PL_op)
507#define cSVOPo_sv cSVOPx_sv(o)
508#define kSVOP_sv cSVOPx_sv(kid)
7766f137 509
bcabcc50
NC
510#ifndef PERL_CORE
511# define Nullop ((OP*)NULL)
512#endif
79072805 513
cee4176c 514/* Lowest byte of PL_opargs */
a0d0e21e
LW
515#define OA_MARK 1
516#define OA_FOLDCONST 2
517#define OA_RETSCALAR 4
518#define OA_TARGET 8
903fd87c 519#define OA_TARGLEX 16
a0d0e21e
LW
520#define OA_OTHERINT 32
521#define OA_DANGEROUS 64
522#define OA_DEFGV 128
523
738ec380 524/* The next 4 bits (8..11) encode op class information */
903fd87c 525#define OCSHIFT 8
b162f9ea
IZ
526
527#define OA_CLASS_MASK (15 << OCSHIFT)
528
529#define OA_BASEOP (0 << OCSHIFT)
530#define OA_UNOP (1 << OCSHIFT)
531#define OA_BINOP (2 << OCSHIFT)
532#define OA_LOGOP (3 << OCSHIFT)
1a67a97c
SM
533#define OA_LISTOP (4 << OCSHIFT)
534#define OA_PMOP (5 << OCSHIFT)
535#define OA_SVOP (6 << OCSHIFT)
7934575e 536#define OA_PADOP (7 << OCSHIFT)
1a67a97c
SM
537#define OA_PVOP_OR_SVOP (8 << OCSHIFT)
538#define OA_LOOP (9 << OCSHIFT)
539#define OA_COP (10 << OCSHIFT)
540#define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
541#define OA_FILESTATOP (12 << OCSHIFT)
542#define OA_LOOPEXOP (13 << OCSHIFT)
b46e009d 543#define OA_METHOP (14 << OCSHIFT)
2f7c6295 544#define OA_UNOP_AUX (15 << OCSHIFT)
b162f9ea 545
738ec380
DM
546/* Each remaining nybble of PL_opargs (i.e. bits 12..15, 16..19 etc)
547 * encode the type for each arg */
903fd87c 548#define OASHIFT 12
a0d0e21e 549
a0d0e21e
LW
550#define OA_SCALAR 1
551#define OA_LIST 2
552#define OA_AVREF 3
553#define OA_HVREF 4
554#define OA_CVREF 5
555#define OA_FILEREF 6
556#define OA_SCALARREF 7
557#define OA_OPTIONAL 8
558
d3c72c2a
DM
559/* Op_REFCNT is a reference count at the head of each op tree: needed
560 * since the tree is shared between threads, and between cloned closure
561 * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
562 * this count.
563 * The same mutex is used to protect the refcounts of the reg_trie_data
564 * and reg_ac_data structures, which are shared between duplicated
565 * regexes.
566 */
567
534825c4
GS
568#ifdef USE_ITHREADS
569# define OP_REFCNT_INIT MUTEX_INIT(&PL_op_mutex)
4026c95a
SH
570# ifdef PERL_CORE
571# define OP_REFCNT_LOCK MUTEX_LOCK(&PL_op_mutex)
572# define OP_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_op_mutex)
573# else
574# define OP_REFCNT_LOCK op_refcnt_lock()
575# define OP_REFCNT_UNLOCK op_refcnt_unlock()
576# endif
534825c4 577# define OP_REFCNT_TERM MUTEX_DESTROY(&PL_op_mutex)
534825c4
GS
578#else
579# define OP_REFCNT_INIT NOOP
580# define OP_REFCNT_LOCK NOOP
581# define OP_REFCNT_UNLOCK NOOP
582# define OP_REFCNT_TERM NOOP
534825c4 583#endif
e4783991 584
282f25c9 585#define OpREFCNT_set(o,n) ((o)->op_targ = (n))
fc97af9c
NC
586#ifdef PERL_DEBUG_READONLY_OPS
587# define OpREFCNT_inc(o) Perl_op_refcnt_inc(aTHX_ o)
588# define OpREFCNT_dec(o) Perl_op_refcnt_dec(aTHX_ o)
589#else
590# define OpREFCNT_inc(o) ((o) ? (++(o)->op_targ, (o)) : NULL)
591# define OpREFCNT_dec(o) (--(o)->op_targ)
592#endif
282f25c9 593
e4783991 594/* flags used by Perl_load_module() */
ec6d81ab
RGS
595#define PERL_LOADMOD_DENY 0x1 /* no Module */
596#define PERL_LOADMOD_NOIMPORT 0x2 /* use Module () */
466f50cc
FC
597#define PERL_LOADMOD_IMPORT_OPS 0x4 /* import arguments
598 are passed as a sin-
599 gle op tree, not a
600 list of SVs */
e5dd39fc 601
30d9c59b 602#if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C) || defined(PERL_IN_TOKE_C)
e4c5ccf3 603#define ref(o, type) doref(o, type, TRUE)
a0c21aa1 604#endif
e4c5ccf3 605
5983a79d
BM
606/*
607=head1 Optree Manipulation Functions
608
609=for apidoc Am|OP*|LINKLIST|OP *o
610Given the root of an optree, link the tree in execution order using the
72d33970 611C<op_next> pointers and return the first op executed. If this has
5983a79d 612already been done, it will not be redone, and C<< o->op_next >> will be
2d7f6611 613returned. If C<< o->op_next >> is not already set, C<o> should be at
5983a79d
BM
614least an C<UNOP>.
615
616=cut
617*/
618
619#define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
620
33f36c71
NC
621/* no longer used anywhere in core */
622#ifndef PERL_CORE
46471bde 623#define cv_ckproto(cv, gv, p) \
f717afa7 624 cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
33f36c71
NC
625#endif
626
7d0905b9
NC
627#ifdef PERL_CORE
628# define my(o) my_attrs((o), NULL)
629#endif
630
e5dd39fc 631#ifdef USE_REENTRANT_API
10bc17b6 632#include "reentr.h"
e5dd39fc
AB
633#endif
634
c7e45529 635#define NewOp(m,var,c,type) \
e91d68d5 636 (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
c7e45529 637#define NewOpSz(m,var,size) \
e91d68d5 638 (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
c7e45529 639#define FreeOp(p) Perl_Slab_Free(aTHX_ p)
8be227ab
FC
640
641/*
642 * The per-CV op slabs consist of a header (the opslab struct) and a bunch
643 * of space for allocating op slots, each of which consists of two pointers
644 * followed by an op. The first pointer points to the next op slot. The
645 * second points to the slab. At the end of the slab is a null pointer,
646 * so that slot->opslot_next - slot can be used to determine the size
647 * of the op.
648 *
649 * Each CV can have multiple slabs; opslab_next points to the next slab, to
650 * form a chain. All bookkeeping is done on the first slab, which is where
651 * all the op slots point.
652 *
653 * Freed ops are marked as freed and attached to the freed chain
654 * via op_next pointers.
655 *
656 * When there is more than one slab, the second slab in the slab chain is
657 * assumed to be the one with free space available. It is used when allo-
658 * cating an op if there are no freed ops available or big enough.
659 */
660
7aef8e5b 661#ifdef PERL_CORE
8be227ab
FC
662struct opslot {
663 /* keep opslot_next first */
664 OPSLOT * opslot_next; /* next slot */
665 OPSLAB * opslot_slab; /* owner */
666 OP opslot_op; /* the op itself */
667};
668
669struct opslab {
670 OPSLOT * opslab_first; /* first op in this slab */
671 OPSLAB * opslab_next; /* next slab */
672 OP * opslab_freed; /* chain of freed ops */
673 size_t opslab_refcnt; /* number of ops */
3107b51f
FC
674# ifdef PERL_DEBUG_READONLY_OPS
675 U16 opslab_size; /* size of slab in pointers */
676 bool opslab_readonly;
677# endif
8be227ab
FC
678 OPSLOT opslab_slots; /* slots begin here */
679};
680
681# define OPSLOT_HEADER STRUCT_OFFSET(OPSLOT, opslot_op)
682# define OPSLOT_HEADER_P (OPSLOT_HEADER/sizeof(I32 *))
c7724415 683# define OpSLOT(o) (assert_(o->op_slabbed) \
8be227ab 684 (OPSLOT *)(((char *)o)-OPSLOT_HEADER))
8be227ab
FC
685# define OpSLAB(o) OpSLOT(o)->opslot_slab
686# define OpslabREFCNT_dec(slab) \
687 (((slab)->opslab_refcnt == 1) \
688 ? opslab_free_nopad(slab) \
689 : (void)--(slab)->opslab_refcnt)
690 /* Variant that does not null out the pads */
691# define OpslabREFCNT_dec_padok(slab) \
692 (((slab)->opslab_refcnt == 1) \
693 ? opslab_free(slab) \
694 : (void)--(slab)->opslab_refcnt)
c7e45529 695#endif
598921a7 696
1930840b 697struct block_hooks {
52db365a 698 U32 bhk_flags;
1930840b
BM
699 void (*bhk_start) (pTHX_ int full);
700 void (*bhk_pre_end) (pTHX_ OP **seq);
701 void (*bhk_post_end) (pTHX_ OP **seq);
52db365a 702 void (*bhk_eval) (pTHX_ OP *const saveop);
1930840b
BM
703};
704
fd85fad2
BM
705/*
706=head1 Compile-time scope hooks
707
3e4ddde5 708=for apidoc mx|U32|BhkFLAGS|BHK *hk
fd85fad2
BM
709Return the BHK's flags.
710
3e4ddde5 711=for apidoc mx|void *|BhkENTRY|BHK *hk|which
2d7f6611 712Return an entry from the BHK structure. C<which> is a preprocessor token
72d33970 713indicating which entry to return. If the appropriate flag is not set
796b6530 714this will return C<NULL>. The type of the return value depends on which
fd85fad2
BM
715entry you ask for.
716
3e4ddde5 717=for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
fd85fad2 718Set an entry in the BHK structure, and set the flags to indicate it is
2d7f6611
KW
719valid. C<which> is a preprocessing token indicating which entry to set.
720The type of C<ptr> depends on the entry.
fd85fad2 721
3e4ddde5 722=for apidoc Amx|void|BhkDISABLE|BHK *hk|which
a3e07c87 723Temporarily disable an entry in this BHK structure, by clearing the
2d7f6611 724appropriate flag. C<which> is a preprocessor token indicating which
a3e07c87
BM
725entry to disable.
726
3e4ddde5 727=for apidoc Amx|void|BhkENABLE|BHK *hk|which
a3e07c87 728Re-enable an entry in this BHK structure, by setting the appropriate
2d7f6611 729flag. C<which> is a preprocessor token indicating which entry to enable.
a3e07c87
BM
730This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
731pointer.
732
3e4ddde5 733=for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
2d7f6611
KW
734Call all the registered block hooks for type C<which>. C<which> is a
735preprocessing token; the type of C<arg> depends on C<which>.
fd85fad2
BM
736
737=cut
738*/
739
52db365a
BM
740#define BhkFLAGS(hk) ((hk)->bhk_flags)
741
a88d97bf
BM
742#define BHKf_bhk_start 0x01
743#define BHKf_bhk_pre_end 0x02
744#define BHKf_bhk_post_end 0x04
745#define BHKf_bhk_eval 0x08
52db365a
BM
746
747#define BhkENTRY(hk, which) \
a88d97bf 748 ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
52db365a 749
a3e07c87
BM
750#define BhkENABLE(hk, which) \
751 STMT_START { \
752 BhkFLAGS(hk) |= BHKf_ ## which; \
753 assert(BhkENTRY(hk, which)); \
754 } STMT_END
755
756#define BhkDISABLE(hk, which) \
757 STMT_START { \
758 BhkFLAGS(hk) &= ~(BHKf_ ## which); \
759 } STMT_END
760
52db365a
BM
761#define BhkENTRY_set(hk, which, ptr) \
762 STMT_START { \
a88d97bf 763 (hk)->which = ptr; \
a3e07c87 764 BhkENABLE(hk, which); \
52db365a
BM
765 } STMT_END
766
1930840b
BM
767#define CALL_BLOCK_HOOKS(which, arg) \
768 STMT_START { \
769 if (PL_blockhooks) { \
c70927a6 770 SSize_t i; \
b9f2b683 771 for (i = av_tindex(PL_blockhooks); i >= 0; i--) { \
1930840b 772 SV *sv = AvARRAY(PL_blockhooks)[i]; \
52db365a 773 BHK *hk; \
1930840b
BM
774 \
775 assert(SvIOK(sv)); \
776 if (SvUOK(sv)) \
52db365a 777 hk = INT2PTR(BHK *, SvUVX(sv)); \
1930840b 778 else \
52db365a 779 hk = INT2PTR(BHK *, SvIVX(sv)); \
1930840b 780 \
52db365a 781 if (BhkENTRY(hk, which)) \
16c91539 782 BhkENTRY(hk, which)(aTHX_ arg); \
1930840b
BM
783 } \
784 } \
785 } STMT_END
786
d9088386
Z
787/* flags for rv2cv_op_cv */
788
789#define RV2CVOPCV_MARK_EARLY 0x00000001
790#define RV2CVOPCV_RETURN_NAME_GV 0x00000002
211a4342 791#define RV2CVOPCV_RETURN_STUB 0x00000004
9c98a81f
FC
792#ifdef PERL_CORE /* behaviour of this flag is subject to change: */
793# define RV2CVOPCV_MAYBE_NAME_GV 0x00000008
794#endif
795#define RV2CVOPCV_FLAG_MASK 0x0000000f /* all of the above */
d9088386 796
d3d7d28f
FC
797#define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
798
f5d552b4
FC
799/* flags for op_lvalue_flags */
800
801#define OP_LVALUE_NO_CROAK 1
802
9733086d
BM
803/*
804=head1 Custom Operators
805
806=for apidoc Am|U32|XopFLAGS|XOP *xop
807Return the XOP's flags.
808
809=for apidoc Am||XopENTRY|XOP *xop|which
2d7f6611 810Return a member of the XOP structure. C<which> is a cpp token
72d33970
FC
811indicating which entry to return. If the member is not set
812this will return a default value. The return type depends
2d7f6611 813on C<which>. This macro evaluates its arguments more than
72d33970 814once. If you are using C<Perl_custom_op_xop> to retreive a
ae103e09
DD
815C<XOP *> from a C<OP *>, use the more efficient L</XopENTRYCUSTOM> instead.
816
817=for apidoc Am||XopENTRYCUSTOM|const OP *o|which
818Exactly like C<XopENTRY(XopENTRY(Perl_custom_op_xop(aTHX_ o), which)> but more
2d7f6611 819efficient. The C<which> parameter is identical to L</XopENTRY>.
9733086d
BM
820
821=for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
2d7f6611 822Set a member of the XOP structure. C<which> is a cpp token
72d33970
FC
823indicating which entry to set. See L<perlguts/"Custom Operators">
824for details about the available members and how
825they are used. This macro evaluates its argument
ae103e09 826more than once.
9733086d
BM
827
828=for apidoc Am|void|XopDISABLE|XOP *xop|which
829Temporarily disable a member of the XOP, by clearing the appropriate flag.
830
831=for apidoc Am|void|XopENABLE|XOP *xop|which
832Reenable a member of the XOP which has been disabled.
833
834=cut
835*/
836
1830b3d9
BM
837struct custom_op {
838 U32 xop_flags;
839 const char *xop_name;
840 const char *xop_desc;
841 U32 xop_class;
842 void (*xop_peep)(pTHX_ OP *o, OP *oldop);
843};
844
ae103e09
DD
845/* return value of Perl_custom_op_get_field, similar to void * then casting but
846 the U32 doesn't need truncation on 64 bit platforms in the caller, also
847 for easier macro writing */
848typedef union {
849 const char *xop_name;
850 const char *xop_desc;
851 U32 xop_class;
852 void (*xop_peep)(pTHX_ OP *o, OP *oldop);
853 XOP *xop_ptr;
854} XOPRETANY;
855
1830b3d9
BM
856#define XopFLAGS(xop) ((xop)->xop_flags)
857
858#define XOPf_xop_name 0x01
859#define XOPf_xop_desc 0x02
860#define XOPf_xop_class 0x04
861#define XOPf_xop_peep 0x08
862
ae103e09
DD
863/* used by Perl_custom_op_get_field for option checking */
864typedef enum {
865 XOPe_xop_ptr = 0, /* just get the XOP *, don't look inside it */
866 XOPe_xop_name = XOPf_xop_name,
867 XOPe_xop_desc = XOPf_xop_desc,
868 XOPe_xop_class = XOPf_xop_class,
4a3798ca 869 XOPe_xop_peep = XOPf_xop_peep
ae103e09
DD
870} xop_flags_enum;
871
1830b3d9
BM
872#define XOPd_xop_name PL_op_name[OP_CUSTOM]
873#define XOPd_xop_desc PL_op_desc[OP_CUSTOM]
874#define XOPd_xop_class OA_BASEOP
875#define XOPd_xop_peep ((Perl_cpeep_t)0)
876
877#define XopENTRY_set(xop, which, to) \
878 STMT_START { \
879 (xop)->which = (to); \
880 (xop)->xop_flags |= XOPf_ ## which; \
881 } STMT_END
882
883#define XopENTRY(xop, which) \
884 ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
885
ae103e09
DD
886#define XopENTRYCUSTOM(o, which) \
887 (Perl_custom_op_get_field(aTHX_ o, XOPe_ ## which).which)
888
1830b3d9
BM
889#define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
890#define XopENABLE(xop, which) \
891 STMT_START { \
892 (xop)->xop_flags |= XOPf_ ## which; \
893 assert(XopENTRY(xop, which)); \
894 } STMT_END
895
ae103e09
DD
896#define Perl_custom_op_xop(x) \
897 (Perl_custom_op_get_field(x, XOPe_xop_ptr).xop_ptr)
898
9733086d
BM
899/*
900=head1 Optree Manipulation Functions
901
902=for apidoc Am|const char *|OP_NAME|OP *o
72d33970 903Return the name of the provided OP. For core ops this looks up the name
9733086d
BM
904from the op_type; for custom ops from the op_ppaddr.
905
906=for apidoc Am|const char *|OP_DESC|OP *o
907Return a short description of the provided OP.
908
909=for apidoc Am|U32|OP_CLASS|OP *o
910Return the class of the provided OP: that is, which of the *OP
72d33970 911structures it uses. For core ops this currently gets the information out
796b6530 912of C<PL_opargs>, which does not always accurately reflect the type used.
9733086d 913For custom ops the type is returned from the registration, and it is up
72d33970 914to the registree to ensure it is accurate. The value returned will be
796b6530 915one of the C<OA_>* constants from F<op.h>.
9733086d 916
5bfb0af0 917=for apidoc Am|bool|OP_TYPE_IS|OP *o|Optype type
796b6530 918Returns true if the given OP is not a C<NULL> pointer
11ee9dd6
SM
919and if it is of the given type.
920
921The negation of this macro, C<OP_TYPE_ISNT> is also available
922as well as C<OP_TYPE_IS_NN> and C<OP_TYPE_ISNT_NN> which elide
923the NULL pointer check.
924
5bfb0af0 925=for apidoc Am|bool|OP_TYPE_IS_OR_WAS|OP *o|Optype type
11ee9dd6
SM
926Returns true if the given OP is not a NULL pointer and
927if it is of the given type or used to be before being
928replaced by an OP of type OP_NULL.
929
930The negation of this macro, C<OP_TYPE_ISNT_AND_WASNT>
931is also available as well as C<OP_TYPE_IS_OR_WAS_NN>
932and C<OP_TYPE_ISNT_AND_WASNT_NN> which elide
796b6530 933the C<NULL> pointer check.
11ee9dd6 934
e6dae479 935=for apidoc Am|bool|OpHAS_SIBLING|OP *o
796b6530 936Returns true if C<o> has a sibling
1ed44841 937
5e24af7d 938=for apidoc Am|OP*|OpSIBLING|OP *o
796b6530 939Returns the sibling of C<o>, or C<NULL> if there is no sibling
1ed44841 940
5e24af7d 941=for apidoc Am|void|OpMORESIB_set|OP *o|OP *sib
796b6530 942Sets the sibling of C<o> to the non-zero value C<sib>. See also C<L</OpLASTSIB_set>>
fbe13c60
KW
943and C<L</OpMAYBESIB_set>>. For a higher-level interface, see
944C<L</op_sibling_splice>>.
5e24af7d
DM
945
946=for apidoc Am|void|OpLASTSIB_set|OP *o|OP *parent
796b6530 947Marks C<o> as having no further siblings. On C<PERL_OP_PARENT> builds, marks
fbe13c60 948o as having the specified parent. See also C<L</OpMORESIB_set>> and
5e24af7d 949C<OpMAYBESIB_set>. For a higher-level interface, see
fbe13c60 950C<L</op_sibling_splice>>.
5e24af7d
DM
951
952=for apidoc Am|void|OpMAYBESIB_set|OP *o|OP *sib|OP *parent
953Conditionally does C<OpMORESIB_set> or C<OpLASTSIB_set> depending on whether
796b6530 954C<sib> is non-null. For a higher-level interface, see C<L</op_sibling_splice>>.
1ed44841 955
9733086d
BM
956=cut
957*/
958
1830b3d9 959#define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
ae103e09 960 ? XopENTRYCUSTOM(o, xop_name) \
1830b3d9
BM
961 : PL_op_name[(o)->op_type])
962#define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
ae103e09 963 ? XopENTRYCUSTOM(o, xop_desc) \
1830b3d9
BM
964 : PL_op_desc[(o)->op_type])
965#define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
ae103e09 966 ? XopENTRYCUSTOM(o, xop_class) \
1830b3d9
BM
967 : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
968
437e3a7d 969#define OP_TYPE_IS(o, type) ((o) && (o)->op_type == (type))
11ee9dd6
SM
970#define OP_TYPE_IS_NN(o, type) ((o)->op_type == (type))
971#define OP_TYPE_ISNT(o, type) ((o) && (o)->op_type != (type))
972#define OP_TYPE_ISNT_NN(o, type) ((o)->op_type != (type))
973
974#define OP_TYPE_IS_OR_WAS_NN(o, type) \
975 ( ((o)->op_type == OP_NULL \
976 ? (o)->op_targ \
977 : (o)->op_type) \
978 == (type) )
979
980#define OP_TYPE_IS_OR_WAS(o, type) \
981 ( (o) && OP_TYPE_IS_OR_WAS_NN(o, type) )
982
983#define OP_TYPE_ISNT_AND_WASNT_NN(o, type) \
984 ( ((o)->op_type == OP_NULL \
985 ? (o)->op_targ \
986 : (o)->op_type) \
987 != (type) )
988
989#define OP_TYPE_ISNT_AND_WASNT(o, type) \
990 ( (o) && OP_TYPE_ISNT_AND_WASNT_NN(o, type) )
437e3a7d 991
5e24af7d 992
29e61fd9 993#ifdef PERL_OP_PARENT
87b5a8b9
DM
994# define OpHAS_SIBLING(o) (cBOOL((o)->op_moresib))
995# define OpSIBLING(o) (0 + (o)->op_moresib ? (o)->op_sibparent : NULL)
5e24af7d
DM
996# define OpMORESIB_set(o, sib) ((o)->op_moresib = 1, (o)->op_sibparent = (sib))
997# define OpLASTSIB_set(o, parent) \
998 ((o)->op_moresib = 0, (o)->op_sibparent = (parent))
999# define OpMAYBESIB_set(o, sib, parent) \
1000 ((o)->op_sibparent = ((o)->op_moresib = cBOOL(sib)) ? (sib) : (parent))
29e61fd9 1001#else
e6dae479
FC
1002# define OpHAS_SIBLING(o) (cBOOL((o)->op_sibling))
1003# define OpSIBLING(o) (0 + (o)->op_sibling)
5e24af7d
DM
1004# define OpMORESIB_set(o, sib) ((o)->op_moresib = 1, (o)->op_sibling = (sib))
1005# define OpLASTSIB_set(o, parent) \
1006 ((o)->op_moresib = 0, (o)->op_sibling = NULL)
1007# define OpMAYBESIB_set(o, sib, parent) \
1008 ((o)->op_moresib = cBOOL(sib), (o)->op_sibling = (sib))
e6dae479 1009#endif
5e24af7d 1010
e6dae479 1011#if !defined(PERL_CORE) && !defined(PERL_EXT)
5e24af7d 1012/* for backwards compatibility only */
e6dae479 1013# define OP_SIBLING(o) OpSIBLING(o)
29e61fd9 1014#endif
1ed44841 1015
e8f91c91
DD
1016#define newATTRSUB(f, o, p, a, b) Perl_newATTRSUB_x(aTHX_ f, o, p, a, b, FALSE)
1017#define newSUB(f, o, p, b) newATTRSUB((f), (o), (p), NULL, (b))
7bff8c33 1018
3f2908ec 1019/*
e8570548
Z
1020=head1 Hook manipulation
1021*/
1022
1023#ifdef USE_ITHREADS
1024# define OP_CHECK_MUTEX_INIT MUTEX_INIT(&PL_check_mutex)
1025# define OP_CHECK_MUTEX_LOCK MUTEX_LOCK(&PL_check_mutex)
1026# define OP_CHECK_MUTEX_UNLOCK MUTEX_UNLOCK(&PL_check_mutex)
1027# define OP_CHECK_MUTEX_TERM MUTEX_DESTROY(&PL_check_mutex)
1028#else
1029# define OP_CHECK_MUTEX_INIT NOOP
1030# define OP_CHECK_MUTEX_LOCK NOOP
1031# define OP_CHECK_MUTEX_UNLOCK NOOP
1032# define OP_CHECK_MUTEX_TERM NOOP
1033#endif
1034
fedf30e1
DM
1035
1036/* Stuff for OP_MULTDEREF/pp_multideref. */
1037
1038/* actions */
1039
1040/* Load another word of actions/flag bits. Must be 0 */
1041#define MDEREF_reload 0
1042
1043#define MDEREF_AV_pop_rv2av_aelem 1
1044#define MDEREF_AV_gvsv_vivify_rv2av_aelem 2
1045#define MDEREF_AV_padsv_vivify_rv2av_aelem 3
1046#define MDEREF_AV_vivify_rv2av_aelem 4
1047#define MDEREF_AV_padav_aelem 5
1048#define MDEREF_AV_gvav_aelem 6
1049
1050#define MDEREF_HV_pop_rv2hv_helem 8
1051#define MDEREF_HV_gvsv_vivify_rv2hv_helem 9
1052#define MDEREF_HV_padsv_vivify_rv2hv_helem 10
1053#define MDEREF_HV_vivify_rv2hv_helem 11
1054#define MDEREF_HV_padhv_helem 12
1055#define MDEREF_HV_gvhv_helem 13
1056
1057#define MDEREF_ACTION_MASK 0xf
1058
1059/* key / index type */
1060
1061#define MDEREF_INDEX_none 0x00 /* run external ops to generate index */
1062#define MDEREF_INDEX_const 0x10 /* index is const PV/UV */
1063#define MDEREF_INDEX_padsv 0x20 /* index is lexical var */
1064#define MDEREF_INDEX_gvsv 0x30 /* index is GV */
1065
1066#define MDEREF_INDEX_MASK 0x30
1067
1068/* bit flags */
1069
1070#define MDEREF_FLAG_last 0x40 /* the last [ah]elem; PL_op flags apply */
1071
1072#define MDEREF_MASK 0x7F
1073#define MDEREF_SHIFT 7
1074
87e05d1a
KW
1075#if defined(PERL_IN_DOOP_C) || defined(PERL_IN_PP_C)
1076static const char * const deprecated_above_ff_msg
1077 = "Use of strings with code points over 0xFF as arguments to "
1078 "%s operator is deprecated";
1079#endif
1080
fedf30e1 1081
e8570548 1082/*
14d04a33 1083 * ex: set ts=8 sts=4 sw=4 et:
3f2908ec 1084 */