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