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