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