This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
add more win32 stat tests
[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.
a3815e44 27 * op_moresib this op 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/*
3f620621 73=for apidoc_section $callback
ccfc67b7 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 79
eca111b3 80=for apidoc AmnD|U32|GIMME
954c1994
GS
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
6507ac83
KW
173#define OPpTRANS_ALL (OPpTRANS_USE_SVOP|OPpTRANS_CAN_FORCE_UTF8|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
174#define OPpTRANS_FROM_UTF OPpTRANS_USE_SVOP
175#define OPpTRANS_TO_UTF OPpTRANS_CAN_FORCE_UTF8
97e1065a 176
97e1065a 177
f3574cc6
DM
178/* Mask for OP_ENTERSUB flags, the absence of which must be propagated
179 in dynamic context */
777d9014
FC
180#define OPpENTERSUB_LVAL_MASK (OPpLVAL_INTRO|OPpENTERSUB_INARGS)
181
5db1eb8d 182
2f7c6295 183/* things that can be elements of op_aux */
c0443cc0 184typedef union {
2f7c6295
DM
185 PADOFFSET pad_offset;
186 SV *sv;
187 IV iv;
188 UV uv;
e839e6ed 189 char *pv;
b5bf9f73 190 SSize_t ssize;
2f7c6295
DM
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
7c449856
KW
330/* Set by the parser if it discovers an error, so the regex shouldn't be
331 * compiled */
f0ac8a37 332#define PMf_HAS_ERROR (1U<<(PMf_BASE_SHIFT+3))
7c449856 333
ef07e810 334/* 'use re "taint"' in scope: taint $1 etc. if target tainted */
f0ac8a37 335#define PMf_RETAINT (1U<<(PMf_BASE_SHIFT+4))
c737faaf 336
c0f1c194
KW
337/* match successfully only once per reset, with related flag RXf_USED in
338 * re->extflags holding state. This is used only for ?? matches, and only on
339 * OP_MATCH and OP_QR */
f0ac8a37 340#define PMf_ONCE (1U<<(PMf_BASE_SHIFT+5))
1850c8f9 341
d234778b 342/* PMf_ONCE, i.e. ?pat?, has matched successfully. Not used under threading. */
f0ac8a37 343#define PMf_USED (1U<<(PMf_BASE_SHIFT+6))
1850c8f9
KW
344
345/* subst replacement is constant */
f0ac8a37 346#define PMf_CONST (1U<<(PMf_BASE_SHIFT+7))
c737faaf 347
1850c8f9 348/* keep 1st runtime pattern forever */
f0ac8a37 349#define PMf_KEEP (1U<<(PMf_BASE_SHIFT+8))
4da3eb8b 350
f0ac8a37 351#define PMf_GLOBAL (1U<<(PMf_BASE_SHIFT+9)) /* pattern had a g modifier */
c737faaf 352
1850c8f9 353/* don't reset pos() if //g fails */
f0ac8a37 354#define PMf_CONTINUE (1U<<(PMf_BASE_SHIFT+10))
1850c8f9
KW
355
356/* evaluating replacement as expr */
f0ac8a37 357#define PMf_EVAL (1U<<(PMf_BASE_SHIFT+11))
c0f1c194
KW
358
359/* Return substituted string instead of modifying it. */
f0ac8a37 360#define PMf_NONDESTRUCT (1U<<(PMf_BASE_SHIFT+12))
e357fc67 361
d63c20f2 362/* the pattern has a CV attached (currently only under qr/...(?{}).../) */
f0ac8a37 363#define PMf_HAS_CV (1U<<(PMf_BASE_SHIFT+13))
d63c20f2 364
867940b8
DM
365/* op_code_list is private; don't free it etc. It may well point to
366 * code within another sub, with different pad etc */
f0ac8a37 367#define PMf_CODELIST_PRIVATE (1U<<(PMf_BASE_SHIFT+14))
867940b8 368
2a92a973
DM
369/* the PMOP is a QR (we should be able to detect that from the op type,
370 * but the regex compilation API passes just the pm flags, not the op
371 * itself */
f0ac8a37
KW
372#define PMf_IS_QR (1U<<(PMf_BASE_SHIFT+15))
373#define PMf_USE_RE_EVAL (1U<<(PMf_BASE_SHIFT+16)) /* use re'eval' in scope */
a6cd0fea 374
4829f32d
KW
375/* Means that this is a subpattern being compiled while processing a \p{}
376 * wildcard. This isn't called from op.c, but it is passed as a pm flag. */
377#define PMf_WILDCARD (1U<<(PMf_BASE_SHIFT+17))
378
a6cd0fea
KW
379/* See comments at the beginning of these defines about adding bits. The
380 * highest bit position should be used, so that if PMf_BASE_SHIFT gets
381 * increased, the #error below will be triggered so that you will be reminded
382 * to adjust things at the other end to keep the bit positions unchanged */
383#if PMf_BASE_SHIFT+17 > 31
32cdcf9d 384# error Too many PMf_ bits used. See above and regnodes.h for any spare in middle
1850c8f9 385#endif
79072805 386
cb55de95 387#ifdef USE_ITHREADS
05ec9bb3 388
23083432
FC
389# define PmopSTASH(o) ((o)->op_pmflags & PMf_ONCE \
390 ? PL_stashpad[(o)->op_pmstashstartu.op_pmstashoff] \
391 : NULL)
392# define PmopSTASH_set(o,hv) \
393 (assert_((o)->op_pmflags & PMf_ONCE) \
394 (o)->op_pmstashstartu.op_pmstashoff = \
01f44973 395 (hv) ? alloccopstash(hv) : 0)
cb55de95 396#else
29f2e912
NC
397# define PmopSTASH(o) \
398 (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
041c1a23 399# if defined (DEBUGGING) && defined(PERL_USE_GCC_BRACE_GROUPS)
29f2e912
NC
400# define PmopSTASH_set(o,hv) ({ \
401 assert((o)->op_pmflags & PMf_ONCE); \
402 ((o)->op_pmstashstartu.op_pmstash = (hv)); \
403 })
404# else
405# define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
406# endif
cb55de95 407#endif
23083432
FC
408#define PmopSTASHPV(o) (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
409 /* op_pmstashstartu.op_pmstash is not refcounted */
410#define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
cb55de95 411
79072805
LW
412struct svop {
413 BASEOP
414 SV * op_sv;
415};
416
7934575e 417struct padop {
79072805 418 BASEOP
7934575e 419 PADOFFSET op_padix;
79072805
LW
420};
421
422struct pvop {
423 BASEOP
424 char * op_pv;
425};
426
79072805
LW
427struct loop {
428 BASEOP
429 OP * op_first;
430 OP * op_last;
79072805
LW
431 OP * op_redoop;
432 OP * op_nextop;
433 OP * op_lastop;
434};
435
9524b6e6
FC
436#define cUNOPx(o) ((UNOP*)(o))
437#define cUNOP_AUXx(o) ((UNOP_AUX*)(o))
438#define cBINOPx(o) ((BINOP*)(o))
439#define cLISTOPx(o) ((LISTOP*)(o))
440#define cLOGOPx(o) ((LOGOP*)(o))
441#define cPMOPx(o) ((PMOP*)(o))
442#define cSVOPx(o) ((SVOP*)(o))
443#define cPADOPx(o) ((PADOP*)(o))
444#define cPVOPx(o) ((PVOP*)(o))
445#define cCOPx(o) ((COP*)(o))
446#define cLOOPx(o) ((LOOP*)(o))
447#define cMETHOPx(o) ((METHOP*)(o))
350de78d
GS
448
449#define cUNOP cUNOPx(PL_op)
2f7c6295 450#define cUNOP_AUX cUNOP_AUXx(PL_op)
350de78d
GS
451#define cBINOP cBINOPx(PL_op)
452#define cLISTOP cLISTOPx(PL_op)
453#define cLOGOP cLOGOPx(PL_op)
454#define cPMOP cPMOPx(PL_op)
455#define cSVOP cSVOPx(PL_op)
456#define cPADOP cPADOPx(PL_op)
457#define cPVOP cPVOPx(PL_op)
458#define cCOP cCOPx(PL_op)
459#define cLOOP cLOOPx(PL_op)
460
1d6cadf1
KW
461#if defined(PERL_CORE) || defined(PERL_EXT)
462# define cUNOPo cUNOPx(o)
463# define cUNOP_AUXo cUNOP_AUXx(o)
464# define cBINOPo cBINOPx(o)
465# define cLISTOPo cLISTOPx(o)
466# define cLOGOPo cLOGOPx(o)
467# define cPMOPo cPMOPx(o)
468# define cSVOPo cSVOPx(o)
469# define cPADOPo cPADOPx(o)
470# define cPVOPo cPVOPx(o)
471# define cCOPo cCOPx(o)
472# define cLOOPo cLOOPx(o)
473
474# define kUNOP cUNOPx(kid)
475# define kUNOP_AUX cUNOP_AUXx(kid)
476# define kBINOP cBINOPx(kid)
477# define kLISTOP cLISTOPx(kid)
478# define kLOGOP cLOGOPx(kid)
479# define kPMOP cPMOPx(kid)
480# define kSVOP cSVOPx(kid)
481# define kPADOP cPADOPx(kid)
482# define kPVOP cPVOPx(kid)
483# define kCOP cCOPx(kid)
484# define kLOOP cLOOPx(kid)
485#endif
350de78d 486
1e85b658
DM
487typedef enum {
488 OPclass_NULL, /* 0 */
489 OPclass_BASEOP, /* 1 */
490 OPclass_UNOP, /* 2 */
491 OPclass_BINOP, /* 3 */
492 OPclass_LOGOP, /* 4 */
493 OPclass_LISTOP, /* 5 */
494 OPclass_PMOP, /* 6 */
495 OPclass_SVOP, /* 7 */
496 OPclass_PADOP, /* 8 */
497 OPclass_PVOP, /* 9 */
498 OPclass_LOOP, /* 10 */
499 OPclass_COP, /* 11 */
500 OPclass_METHOP, /* 12 */
501 OPclass_UNOP_AUX /* 13 */
502} OPclass;
503
504
350de78d 505#ifdef USE_ITHREADS
dd2155a4 506# define cGVOPx_gv(o) ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
9429039d
FC
507# ifndef PERL_CORE
508# define IS_PADGV(v) (v && isGV(v))
509# define IS_PADCONST(v) \
f5a0fd1e 510 (v && (SvREADONLY(v) || (SvIsCOW(v) && !SvLEN(v))))
9429039d 511# endif
7766f137 512# define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
dd2155a4 513 ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
638eceb6 514# define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
dd2155a4 515 ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
810bd8b7 516# define cMETHOPx_rclass(v) PAD_SVl(cMETHOPx(v)->op_rclass_targ)
350de78d 517#else
638eceb6 518# define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
9429039d
FC
519# ifndef PERL_CORE
520# define IS_PADGV(v) FALSE
521# define IS_PADCONST(v) FALSE
522# endif
7766f137 523# define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
638eceb6 524# define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
810bd8b7 525# define cMETHOPx_rclass(v) (cMETHOPx(v)->op_rclass_sv)
350de78d 526#endif
79072805 527
f88ca576 528#define cMETHOPx_meth(v) cSVOPx_sv(v)
b46e009d 529
1d6cadf1 530#if defined(PERL_CORE) || defined(PERL_EXT_RE_BUILD)
638eceb6
GS
531#define cGVOP_gv cGVOPx_gv(PL_op)
532#define cGVOPo_gv cGVOPx_gv(o)
533#define kGVOP_gv cGVOPx_gv(kid)
534#define cSVOP_sv cSVOPx_sv(PL_op)
535#define cSVOPo_sv cSVOPx_sv(o)
536#define kSVOP_sv cSVOPx_sv(kid)
1d6cadf1 537#endif
7766f137 538
bcabcc50
NC
539#ifndef PERL_CORE
540# define Nullop ((OP*)NULL)
541#endif
79072805 542
cee4176c 543/* Lowest byte of PL_opargs */
a0d0e21e
LW
544#define OA_MARK 1
545#define OA_FOLDCONST 2
546#define OA_RETSCALAR 4
547#define OA_TARGET 8
903fd87c 548#define OA_TARGLEX 16
a0d0e21e
LW
549#define OA_OTHERINT 32
550#define OA_DANGEROUS 64
551#define OA_DEFGV 128
552
738ec380 553/* The next 4 bits (8..11) encode op class information */
903fd87c 554#define OCSHIFT 8
b162f9ea
IZ
555
556#define OA_CLASS_MASK (15 << OCSHIFT)
557
558#define OA_BASEOP (0 << OCSHIFT)
559#define OA_UNOP (1 << OCSHIFT)
560#define OA_BINOP (2 << OCSHIFT)
561#define OA_LOGOP (3 << OCSHIFT)
1a67a97c
SM
562#define OA_LISTOP (4 << OCSHIFT)
563#define OA_PMOP (5 << OCSHIFT)
564#define OA_SVOP (6 << OCSHIFT)
7934575e 565#define OA_PADOP (7 << OCSHIFT)
1a67a97c
SM
566#define OA_PVOP_OR_SVOP (8 << OCSHIFT)
567#define OA_LOOP (9 << OCSHIFT)
568#define OA_COP (10 << OCSHIFT)
569#define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
570#define OA_FILESTATOP (12 << OCSHIFT)
571#define OA_LOOPEXOP (13 << OCSHIFT)
b46e009d 572#define OA_METHOP (14 << OCSHIFT)
2f7c6295 573#define OA_UNOP_AUX (15 << OCSHIFT)
b162f9ea 574
738ec380
DM
575/* Each remaining nybble of PL_opargs (i.e. bits 12..15, 16..19 etc)
576 * encode the type for each arg */
903fd87c 577#define OASHIFT 12
a0d0e21e 578
a0d0e21e
LW
579#define OA_SCALAR 1
580#define OA_LIST 2
581#define OA_AVREF 3
582#define OA_HVREF 4
583#define OA_CVREF 5
584#define OA_FILEREF 6
585#define OA_SCALARREF 7
586#define OA_OPTIONAL 8
587
d3c72c2a
DM
588/* Op_REFCNT is a reference count at the head of each op tree: needed
589 * since the tree is shared between threads, and between cloned closure
590 * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
591 * this count.
592 * The same mutex is used to protect the refcounts of the reg_trie_data
593 * and reg_ac_data structures, which are shared between duplicated
594 * regexes.
595 */
596
534825c4
GS
597#ifdef USE_ITHREADS
598# define OP_REFCNT_INIT MUTEX_INIT(&PL_op_mutex)
4026c95a
SH
599# ifdef PERL_CORE
600# define OP_REFCNT_LOCK MUTEX_LOCK(&PL_op_mutex)
601# define OP_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_op_mutex)
602# else
603# define OP_REFCNT_LOCK op_refcnt_lock()
604# define OP_REFCNT_UNLOCK op_refcnt_unlock()
605# endif
534825c4 606# define OP_REFCNT_TERM MUTEX_DESTROY(&PL_op_mutex)
534825c4
GS
607#else
608# define OP_REFCNT_INIT NOOP
609# define OP_REFCNT_LOCK NOOP
610# define OP_REFCNT_UNLOCK NOOP
611# define OP_REFCNT_TERM NOOP
534825c4 612#endif
e4783991 613
282f25c9 614#define OpREFCNT_set(o,n) ((o)->op_targ = (n))
fc97af9c
NC
615#ifdef PERL_DEBUG_READONLY_OPS
616# define OpREFCNT_inc(o) Perl_op_refcnt_inc(aTHX_ o)
617# define OpREFCNT_dec(o) Perl_op_refcnt_dec(aTHX_ o)
618#else
619# define OpREFCNT_inc(o) ((o) ? (++(o)->op_targ, (o)) : NULL)
620# define OpREFCNT_dec(o) (--(o)->op_targ)
621#endif
282f25c9 622
e4783991 623/* flags used by Perl_load_module() */
ec6d81ab
RGS
624#define PERL_LOADMOD_DENY 0x1 /* no Module */
625#define PERL_LOADMOD_NOIMPORT 0x2 /* use Module () */
466f50cc
FC
626#define PERL_LOADMOD_IMPORT_OPS 0x4 /* import arguments
627 are passed as a sin-
628 gle op tree, not a
629 list of SVs */
e5dd39fc 630
30d9c59b 631#if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C) || defined(PERL_IN_TOKE_C)
e4c5ccf3 632#define ref(o, type) doref(o, type, TRUE)
a0c21aa1 633#endif
e4c5ccf3 634
c1048fcf 635
0b9a13c3 636/* translation table attached to OP_TRANS/OP_TRANSR ops */
c1048fcf
DM
637
638typedef struct {
0b9a13c3
DM
639 Size_t size; /* number of entries in map[], not including final slot */
640 short map[1]; /* Unwarranted chumminess */
c1048fcf
DM
641} OPtrans_map;
642
c1048fcf 643
5983a79d 644/*
3f620621 645=for apidoc_section $optree_manipulation
5983a79d
BM
646
647=for apidoc Am|OP*|LINKLIST|OP *o
648Given the root of an optree, link the tree in execution order using the
72d33970 649C<op_next> pointers and return the first op executed. If this has
5983a79d 650already been done, it will not be redone, and C<< o->op_next >> will be
2d7f6611 651returned. If C<< o->op_next >> is not already set, C<o> should be at
5983a79d
BM
652least an C<UNOP>.
653
654=cut
655*/
656
657#define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
658
33f36c71
NC
659/* no longer used anywhere in core */
660#ifndef PERL_CORE
46471bde 661#define cv_ckproto(cv, gv, p) \
f717afa7 662 cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
33f36c71
NC
663#endif
664
7d0905b9
NC
665#ifdef PERL_CORE
666# define my(o) my_attrs((o), NULL)
667#endif
668
e5dd39fc 669#ifdef USE_REENTRANT_API
10bc17b6 670#include "reentr.h"
e5dd39fc
AB
671#endif
672
c7e45529 673#define NewOp(m,var,c,type) \
e91d68d5 674 (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
c7e45529 675#define NewOpSz(m,var,size) \
e91d68d5 676 (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
c7e45529 677#define FreeOp(p) Perl_Slab_Free(aTHX_ p)
8be227ab
FC
678
679/*
680 * The per-CV op slabs consist of a header (the opslab struct) and a bunch
681 * of space for allocating op slots, each of which consists of two pointers
682 * followed by an op. The first pointer points to the next op slot. The
683 * second points to the slab. At the end of the slab is a null pointer,
684 * so that slot->opslot_next - slot can be used to determine the size
685 * of the op.
686 *
687 * Each CV can have multiple slabs; opslab_next points to the next slab, to
688 * form a chain. All bookkeeping is done on the first slab, which is where
689 * all the op slots point.
690 *
691 * Freed ops are marked as freed and attached to the freed chain
692 * via op_next pointers.
693 *
694 * When there is more than one slab, the second slab in the slab chain is
695 * assumed to be the one with free space available. It is used when allo-
696 * cating an op if there are no freed ops available or big enough.
697 */
698
7aef8e5b 699#ifdef PERL_CORE
8be227ab 700struct opslot {
8c47b5bc 701 U16 opslot_size; /* size of this slot (in pointers) */
17b8f3a1 702 U16 opslot_offset; /* offset from start of slab (in ptr units) */
8be227ab
FC
703 OP opslot_op; /* the op itself */
704};
705
706struct opslab {
8be227ab 707 OPSLAB * opslab_next; /* next slab */
17b8f3a1 708 OPSLAB * opslab_head; /* first slab in chain */
0bd6eef4 709 OP ** opslab_freed; /* array of sized chains of freed ops (head only)*/
17b8f3a1 710 size_t opslab_refcnt; /* number of ops (head slab only) */
0bd6eef4 711 U16 opslab_freed_size; /* allocated size of opslab_freed */
aa034fa0
DM
712 U16 opslab_size; /* size of slab in pointers,
713 including header */
7b85c12a
DM
714 U16 opslab_free_space; /* space available in this slab
715 for allocating new ops (in ptr
716 units) */
3107b51f 717# ifdef PERL_DEBUG_READONLY_OPS
3107b51f
FC
718 bool opslab_readonly;
719# endif
8be227ab
FC
720 OPSLOT opslab_slots; /* slots begin here */
721};
722
723# define OPSLOT_HEADER STRUCT_OFFSET(OPSLOT, opslot_op)
c7724415 724# define OpSLOT(o) (assert_(o->op_slabbed) \
8be227ab 725 (OPSLOT *)(((char *)o)-OPSLOT_HEADER))
17b8f3a1 726
f0cfed98
TC
727/* the slab that owns this op */
728# define OpMySLAB(o) \
729 ((OPSLAB*)((char *)((I32**)OpSLOT(o) - OpSLOT(o)->opslot_offset)-STRUCT_OFFSET(struct opslab, opslab_slots)))
17b8f3a1
DM
730/* the first (head) opslab of the chain in which this op is allocated */
731# define OpSLAB(o) \
f0cfed98
TC
732 (OpMySLAB(o)->opslab_head)
733/* calculate the slot given the owner slab and an offset */
734#define OpSLOToff(slab, offset) \
735 ((OPSLOT*)(((I32 **)&(slab)->opslab_slots)+(offset)))
17b8f3a1 736
8be227ab
FC
737# define OpslabREFCNT_dec(slab) \
738 (((slab)->opslab_refcnt == 1) \
739 ? opslab_free_nopad(slab) \
740 : (void)--(slab)->opslab_refcnt)
741 /* Variant that does not null out the pads */
742# define OpslabREFCNT_dec_padok(slab) \
743 (((slab)->opslab_refcnt == 1) \
744 ? opslab_free(slab) \
745 : (void)--(slab)->opslab_refcnt)
c7e45529 746#endif
598921a7 747
1930840b 748struct block_hooks {
52db365a 749 U32 bhk_flags;
1930840b
BM
750 void (*bhk_start) (pTHX_ int full);
751 void (*bhk_pre_end) (pTHX_ OP **seq);
752 void (*bhk_post_end) (pTHX_ OP **seq);
52db365a 753 void (*bhk_eval) (pTHX_ OP *const saveop);
1930840b
BM
754};
755
fd85fad2 756/*
3f620621 757=for apidoc_section $scope
fd85fad2 758
3e4ddde5 759=for apidoc mx|U32|BhkFLAGS|BHK *hk
fd85fad2
BM
760Return the BHK's flags.
761
5ec7ac22 762=for apidoc mxu|void *|BhkENTRY|BHK *hk|which
2d7f6611 763Return an entry from the BHK structure. C<which> is a preprocessor token
72d33970 764indicating which entry to return. If the appropriate flag is not set
796b6530 765this will return C<NULL>. The type of the return value depends on which
fd85fad2
BM
766entry you ask for.
767
5ec7ac22 768=for apidoc Amxu|void|BhkENTRY_set|BHK *hk|which|void *ptr
fd85fad2 769Set an entry in the BHK structure, and set the flags to indicate it is
2d7f6611
KW
770valid. C<which> is a preprocessing token indicating which entry to set.
771The type of C<ptr> depends on the entry.
fd85fad2 772
5ec7ac22 773=for apidoc Amxu|void|BhkDISABLE|BHK *hk|which
a3e07c87 774Temporarily disable an entry in this BHK structure, by clearing the
2d7f6611 775appropriate flag. C<which> is a preprocessor token indicating which
a3e07c87
BM
776entry to disable.
777
5ec7ac22 778=for apidoc Amxu|void|BhkENABLE|BHK *hk|which
a3e07c87 779Re-enable an entry in this BHK structure, by setting the appropriate
2d7f6611 780flag. C<which> is a preprocessor token indicating which entry to enable.
a3e07c87
BM
781This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
782pointer.
783
5ec7ac22 784=for apidoc mxu|void|CALL_BLOCK_HOOKS|which|arg
2d7f6611
KW
785Call all the registered block hooks for type C<which>. C<which> is a
786preprocessing token; the type of C<arg> depends on C<which>.
fd85fad2
BM
787
788=cut
789*/
790
52db365a
BM
791#define BhkFLAGS(hk) ((hk)->bhk_flags)
792
a88d97bf
BM
793#define BHKf_bhk_start 0x01
794#define BHKf_bhk_pre_end 0x02
795#define BHKf_bhk_post_end 0x04
796#define BHKf_bhk_eval 0x08
52db365a
BM
797
798#define BhkENTRY(hk, which) \
a88d97bf 799 ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
52db365a 800
a3e07c87
BM
801#define BhkENABLE(hk, which) \
802 STMT_START { \
803 BhkFLAGS(hk) |= BHKf_ ## which; \
804 assert(BhkENTRY(hk, which)); \
805 } STMT_END
806
807#define BhkDISABLE(hk, which) \
808 STMT_START { \
809 BhkFLAGS(hk) &= ~(BHKf_ ## which); \
810 } STMT_END
811
52db365a
BM
812#define BhkENTRY_set(hk, which, ptr) \
813 STMT_START { \
a88d97bf 814 (hk)->which = ptr; \
a3e07c87 815 BhkENABLE(hk, which); \
52db365a
BM
816 } STMT_END
817
1930840b
BM
818#define CALL_BLOCK_HOOKS(which, arg) \
819 STMT_START { \
820 if (PL_blockhooks) { \
c70927a6 821 SSize_t i; \
8272d5bd 822 for (i = av_top_index(PL_blockhooks); i >= 0; i--) { \
1930840b 823 SV *sv = AvARRAY(PL_blockhooks)[i]; \
52db365a 824 BHK *hk; \
1930840b
BM
825 \
826 assert(SvIOK(sv)); \
827 if (SvUOK(sv)) \
52db365a 828 hk = INT2PTR(BHK *, SvUVX(sv)); \
1930840b 829 else \
52db365a 830 hk = INT2PTR(BHK *, SvIVX(sv)); \
1930840b 831 \
52db365a 832 if (BhkENTRY(hk, which)) \
16c91539 833 BhkENTRY(hk, which)(aTHX_ arg); \
1930840b
BM
834 } \
835 } \
836 } STMT_END
837
d9088386
Z
838/* flags for rv2cv_op_cv */
839
840#define RV2CVOPCV_MARK_EARLY 0x00000001
841#define RV2CVOPCV_RETURN_NAME_GV 0x00000002
211a4342 842#define RV2CVOPCV_RETURN_STUB 0x00000004
c6565d4b 843#if defined(PERL_CORE) || defined(PERL_EXT) /* behaviour of this flag is subject to change: */
9c98a81f
FC
844# define RV2CVOPCV_MAYBE_NAME_GV 0x00000008
845#endif
846#define RV2CVOPCV_FLAG_MASK 0x0000000f /* all of the above */
d9088386 847
d3d7d28f
FC
848#define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
849
f5d552b4
FC
850/* flags for op_lvalue_flags */
851
852#define OP_LVALUE_NO_CROAK 1
853
9733086d 854/*
3f620621 855=for apidoc_section $custom
9733086d
BM
856
857=for apidoc Am|U32|XopFLAGS|XOP *xop
858Return the XOP's flags.
859
860=for apidoc Am||XopENTRY|XOP *xop|which
2d7f6611 861Return a member of the XOP structure. C<which> is a cpp token
72d33970
FC
862indicating which entry to return. If the member is not set
863this will return a default value. The return type depends
2d7f6611 864on C<which>. This macro evaluates its arguments more than
f1460a66 865once. If you are using C<Perl_custom_op_xop> to retrieve a
ae103e09
DD
866C<XOP *> from a C<OP *>, use the more efficient L</XopENTRYCUSTOM> instead.
867
868=for apidoc Am||XopENTRYCUSTOM|const OP *o|which
869Exactly like C<XopENTRY(XopENTRY(Perl_custom_op_xop(aTHX_ o), which)> but more
2d7f6611 870efficient. The C<which> parameter is identical to L</XopENTRY>.
9733086d
BM
871
872=for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
2d7f6611 873Set a member of the XOP structure. C<which> is a cpp token
72d33970
FC
874indicating which entry to set. See L<perlguts/"Custom Operators">
875for details about the available members and how
876they are used. This macro evaluates its argument
ae103e09 877more than once.
9733086d
BM
878
879=for apidoc Am|void|XopDISABLE|XOP *xop|which
880Temporarily disable a member of the XOP, by clearing the appropriate flag.
881
882=for apidoc Am|void|XopENABLE|XOP *xop|which
883Reenable a member of the XOP which has been disabled.
884
885=cut
886*/
887
1830b3d9
BM
888struct custom_op {
889 U32 xop_flags;
890 const char *xop_name;
891 const char *xop_desc;
892 U32 xop_class;
893 void (*xop_peep)(pTHX_ OP *o, OP *oldop);
894};
895
ae103e09
DD
896/* return value of Perl_custom_op_get_field, similar to void * then casting but
897 the U32 doesn't need truncation on 64 bit platforms in the caller, also
898 for easier macro writing */
899typedef union {
900 const char *xop_name;
901 const char *xop_desc;
902 U32 xop_class;
903 void (*xop_peep)(pTHX_ OP *o, OP *oldop);
904 XOP *xop_ptr;
905} XOPRETANY;
906
1830b3d9
BM
907#define XopFLAGS(xop) ((xop)->xop_flags)
908
909#define XOPf_xop_name 0x01
910#define XOPf_xop_desc 0x02
911#define XOPf_xop_class 0x04
912#define XOPf_xop_peep 0x08
913
ae103e09
DD
914/* used by Perl_custom_op_get_field for option checking */
915typedef enum {
916 XOPe_xop_ptr = 0, /* just get the XOP *, don't look inside it */
917 XOPe_xop_name = XOPf_xop_name,
918 XOPe_xop_desc = XOPf_xop_desc,
919 XOPe_xop_class = XOPf_xop_class,
4a3798ca 920 XOPe_xop_peep = XOPf_xop_peep
ae103e09
DD
921} xop_flags_enum;
922
1830b3d9
BM
923#define XOPd_xop_name PL_op_name[OP_CUSTOM]
924#define XOPd_xop_desc PL_op_desc[OP_CUSTOM]
925#define XOPd_xop_class OA_BASEOP
926#define XOPd_xop_peep ((Perl_cpeep_t)0)
927
928#define XopENTRY_set(xop, which, to) \
929 STMT_START { \
930 (xop)->which = (to); \
931 (xop)->xop_flags |= XOPf_ ## which; \
932 } STMT_END
933
934#define XopENTRY(xop, which) \
935 ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
936
ae103e09
DD
937#define XopENTRYCUSTOM(o, which) \
938 (Perl_custom_op_get_field(aTHX_ o, XOPe_ ## which).which)
939
1830b3d9
BM
940#define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
941#define XopENABLE(xop, which) \
942 STMT_START { \
943 (xop)->xop_flags |= XOPf_ ## which; \
944 assert(XopENTRY(xop, which)); \
945 } STMT_END
946
ae103e09
DD
947#define Perl_custom_op_xop(x) \
948 (Perl_custom_op_get_field(x, XOPe_xop_ptr).xop_ptr)
949
9733086d 950/*
3f620621 951=for apidoc_section $optree_manipulation
9733086d
BM
952
953=for apidoc Am|const char *|OP_NAME|OP *o
72d33970 954Return the name of the provided OP. For core ops this looks up the name
9733086d
BM
955from the op_type; for custom ops from the op_ppaddr.
956
957=for apidoc Am|const char *|OP_DESC|OP *o
958Return a short description of the provided OP.
959
960=for apidoc Am|U32|OP_CLASS|OP *o
961Return the class of the provided OP: that is, which of the *OP
72d33970 962structures it uses. For core ops this currently gets the information out
e8f6c72a
DM
963of C<PL_opargs>, which does not always accurately reflect the type used;
964in v5.26 onwards, see also the function C<L</op_class>> which can do a better
965job of determining the used type.
966
9733086d 967For custom ops the type is returned from the registration, and it is up
72d33970 968to the registree to ensure it is accurate. The value returned will be
796b6530 969one of the C<OA_>* constants from F<op.h>.
9733086d 970
5bfb0af0 971=for apidoc Am|bool|OP_TYPE_IS|OP *o|Optype type
796b6530 972Returns true if the given OP is not a C<NULL> pointer
11ee9dd6
SM
973and if it is of the given type.
974
975The negation of this macro, C<OP_TYPE_ISNT> is also available
976as well as C<OP_TYPE_IS_NN> and C<OP_TYPE_ISNT_NN> which elide
977the NULL pointer check.
978
5bfb0af0 979=for apidoc Am|bool|OP_TYPE_IS_OR_WAS|OP *o|Optype type
11ee9dd6
SM
980Returns true if the given OP is not a NULL pointer and
981if it is of the given type or used to be before being
982replaced by an OP of type OP_NULL.
983
984The negation of this macro, C<OP_TYPE_ISNT_AND_WASNT>
985is also available as well as C<OP_TYPE_IS_OR_WAS_NN>
986and C<OP_TYPE_ISNT_AND_WASNT_NN> which elide
796b6530 987the C<NULL> pointer check.
11ee9dd6 988
e6dae479 989=for apidoc Am|bool|OpHAS_SIBLING|OP *o
796b6530 990Returns true if C<o> has a sibling
1ed44841 991
5e24af7d 992=for apidoc Am|OP*|OpSIBLING|OP *o
796b6530 993Returns the sibling of C<o>, or C<NULL> if there is no sibling
1ed44841 994
5e24af7d 995=for apidoc Am|void|OpMORESIB_set|OP *o|OP *sib
796b6530 996Sets the sibling of C<o> to the non-zero value C<sib>. See also C<L</OpLASTSIB_set>>
fbe13c60
KW
997and C<L</OpMAYBESIB_set>>. For a higher-level interface, see
998C<L</op_sibling_splice>>.
5e24af7d
DM
999
1000=for apidoc Am|void|OpLASTSIB_set|OP *o|OP *parent
0f9a6232 1001Marks C<o> as having no further siblings and marks
fbe13c60 1002o as having the specified parent. See also C<L</OpMORESIB_set>> and
5e24af7d 1003C<OpMAYBESIB_set>. For a higher-level interface, see
fbe13c60 1004C<L</op_sibling_splice>>.
5e24af7d
DM
1005
1006=for apidoc Am|void|OpMAYBESIB_set|OP *o|OP *sib|OP *parent
1007Conditionally does C<OpMORESIB_set> or C<OpLASTSIB_set> depending on whether
796b6530 1008C<sib> is non-null. For a higher-level interface, see C<L</op_sibling_splice>>.
1ed44841 1009
9733086d
BM
1010=cut
1011*/
1012
1830b3d9 1013#define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
ae103e09 1014 ? XopENTRYCUSTOM(o, xop_name) \
1830b3d9
BM
1015 : PL_op_name[(o)->op_type])
1016#define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
ae103e09 1017 ? XopENTRYCUSTOM(o, xop_desc) \
1830b3d9
BM
1018 : PL_op_desc[(o)->op_type])
1019#define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
ae103e09 1020 ? XopENTRYCUSTOM(o, xop_class) \
1830b3d9
BM
1021 : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
1022
437e3a7d 1023#define OP_TYPE_IS(o, type) ((o) && (o)->op_type == (type))
11ee9dd6
SM
1024#define OP_TYPE_IS_NN(o, type) ((o)->op_type == (type))
1025#define OP_TYPE_ISNT(o, type) ((o) && (o)->op_type != (type))
1026#define OP_TYPE_ISNT_NN(o, type) ((o)->op_type != (type))
1027
1028#define OP_TYPE_IS_OR_WAS_NN(o, type) \
1029 ( ((o)->op_type == OP_NULL \
1030 ? (o)->op_targ \
1031 : (o)->op_type) \
1032 == (type) )
1033
1034#define OP_TYPE_IS_OR_WAS(o, type) \
1035 ( (o) && OP_TYPE_IS_OR_WAS_NN(o, type) )
1036
1037#define OP_TYPE_ISNT_AND_WASNT_NN(o, type) \
1038 ( ((o)->op_type == OP_NULL \
1039 ? (o)->op_targ \
1040 : (o)->op_type) \
1041 != (type) )
1042
1043#define OP_TYPE_ISNT_AND_WASNT(o, type) \
1044 ( (o) && OP_TYPE_ISNT_AND_WASNT_NN(o, type) )
437e3a7d 1045
1d31efef
DIM
1046/* should match anything that uses ck_ftst in regen/opcodes */
1047#define OP_IS_STAT(op) (OP_IS_FILETEST(op) || (op) == OP_LSTAT || (op) == OP_STAT)
5e24af7d 1048
859b78b1
DIM
1049#define OpHAS_SIBLING(o) (cBOOL((o)->op_moresib))
1050#define OpSIBLING(o) (0 + (o)->op_moresib ? (o)->op_sibparent : NULL)
1051#define OpMORESIB_set(o, sib) ((o)->op_moresib = 1, (o)->op_sibparent = (sib))
1052#define OpLASTSIB_set(o, parent) \
1053 ((o)->op_moresib = 0, (o)->op_sibparent = (parent))
1054#define OpMAYBESIB_set(o, sib, parent) \
1055 ((o)->op_sibparent = ((o)->op_moresib = cBOOL(sib)) ? (sib) : (parent))
5e24af7d 1056
e6dae479 1057#if !defined(PERL_CORE) && !defined(PERL_EXT)
5e24af7d 1058/* for backwards compatibility only */
e6dae479 1059# define OP_SIBLING(o) OpSIBLING(o)
29e61fd9 1060#endif
1ed44841 1061
e8f91c91
DD
1062#define newATTRSUB(f, o, p, a, b) Perl_newATTRSUB_x(aTHX_ f, o, p, a, b, FALSE)
1063#define newSUB(f, o, p, b) newATTRSUB((f), (o), (p), NULL, (b))
7bff8c33 1064
e8570548
Z
1065#ifdef USE_ITHREADS
1066# define OP_CHECK_MUTEX_INIT MUTEX_INIT(&PL_check_mutex)
1067# define OP_CHECK_MUTEX_LOCK MUTEX_LOCK(&PL_check_mutex)
1068# define OP_CHECK_MUTEX_UNLOCK MUTEX_UNLOCK(&PL_check_mutex)
1069# define OP_CHECK_MUTEX_TERM MUTEX_DESTROY(&PL_check_mutex)
1070#else
1071# define OP_CHECK_MUTEX_INIT NOOP
1072# define OP_CHECK_MUTEX_LOCK NOOP
1073# define OP_CHECK_MUTEX_UNLOCK NOOP
1074# define OP_CHECK_MUTEX_TERM NOOP
1075#endif
1076
fedf30e1
DM
1077
1078/* Stuff for OP_MULTDEREF/pp_multideref. */
1079
1080/* actions */
1081
1082/* Load another word of actions/flag bits. Must be 0 */
1083#define MDEREF_reload 0
1084
1085#define MDEREF_AV_pop_rv2av_aelem 1
1086#define MDEREF_AV_gvsv_vivify_rv2av_aelem 2
1087#define MDEREF_AV_padsv_vivify_rv2av_aelem 3
1088#define MDEREF_AV_vivify_rv2av_aelem 4
1089#define MDEREF_AV_padav_aelem 5
1090#define MDEREF_AV_gvav_aelem 6
1091
1092#define MDEREF_HV_pop_rv2hv_helem 8
1093#define MDEREF_HV_gvsv_vivify_rv2hv_helem 9
1094#define MDEREF_HV_padsv_vivify_rv2hv_helem 10
1095#define MDEREF_HV_vivify_rv2hv_helem 11
1096#define MDEREF_HV_padhv_helem 12
1097#define MDEREF_HV_gvhv_helem 13
1098
1099#define MDEREF_ACTION_MASK 0xf
1100
1101/* key / index type */
1102
1103#define MDEREF_INDEX_none 0x00 /* run external ops to generate index */
1104#define MDEREF_INDEX_const 0x10 /* index is const PV/UV */
1105#define MDEREF_INDEX_padsv 0x20 /* index is lexical var */
1106#define MDEREF_INDEX_gvsv 0x30 /* index is GV */
1107
1108#define MDEREF_INDEX_MASK 0x30
1109
1110/* bit flags */
1111
1112#define MDEREF_FLAG_last 0x40 /* the last [ah]elem; PL_op flags apply */
1113
1114#define MDEREF_MASK 0x7F
1115#define MDEREF_SHIFT 7
1116
87e05d1a 1117#if defined(PERL_IN_DOOP_C) || defined(PERL_IN_PP_C)
814eedc8
DD
1118# define FATAL_ABOVE_FF_MSG \
1119 "Use of strings with code points over 0xFF as arguments to " \
1120 "%s operator is not allowed"
87e05d1a 1121#endif
f34acfec 1122#if defined(PERL_IN_OP_C) || defined(PERL_IN_DOOP_C) || defined(PERL_IN_PERL_C)
482bf615
KW
1123# define TR_UNMAPPED (UV)-1
1124# define TR_DELETE (UV)-2
1125# define TR_R_EMPTY (UV)-3 /* rhs (replacement) is empty */
47279991 1126# define TR_OOB (UV)-4 /* Something that isn't one of the others */
84ac8fac
KW
1127# define TR_SPECIAL_HANDLING TR_DELETE /* Can occupy same value */
1128# define TR_UNLISTED TR_UNMAPPED /* A synonym whose name is clearer
1129 at times */
482bf615 1130#endif
dc8faf6b
KW
1131#if defined(PERL_IN_OP_C) || defined(PERL_IN_TOKE_C)
1132#define RANGE_INDICATOR ILLEGAL_UTF8_BYTE
1133#endif
87e05d1a 1134
f417cfa9
DM
1135/* stuff for OP_ARGCHECK */
1136
d10cf093 1137struct op_argcheck_aux {
e6158756
DM
1138 UV params; /* number of positional parameters */
1139 UV opt_params; /* number of optional positional parameters */
f417cfa9
DM
1140 char slurpy; /* presence of slurpy: may be '\0', '@' or '%' */
1141};
1142
fedf30e1 1143
e8570548 1144/*
14d04a33 1145 * ex: set ts=8 sts=4 sw=4 et:
3f2908ec 1146 */