This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
better document OA_ flags
[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.
29e61fd9
DM
27 * op_lastsib this op is is the last sibling
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; \
46 OP* op_sibling; \
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; \
ea726588 55 PERL_BITFIELD16 op_lastsib:1; \
29e61fd9 56 PERL_BITFIELD16 op_spare:1; \
a0d0e21e
LW
57 U8 op_flags; \
58 U8 op_private;
0f4eea8f 59#endif
79072805 60
0053d415
JD
61/* If op_type:9 is changed to :10, also change PUSHEVAL in cop.h.
62 Also, if the type of op_type is ever changed (e.g. to PERL_BITFIELD32)
63 then all the other bit-fields before/after it should change their
64 types too to let VC pack them into the same 4 byte integer.*/
17347a51 65
fe615074 66/* for efficiency, requires OPf_WANT_VOID == G_VOID etc */
54310121 67#define OP_GIMME(op,dfl) \
fe615074 68 (((op)->op_flags & OPf_WANT) ? ((op)->op_flags & OPf_WANT) : dfl)
54310121 69
2f8edad0 70#define OP_GIMME_REVERSE(flags) ((flags) & G_WANT)
4f911530 71
954c1994 72/*
ccfc67b7
JH
73=head1 "Gimme" Values
74
954c1994
GS
75=for apidoc Amn|U32|GIMME_V
76The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
91e74348 77C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
72d33970 78respectively. See L<perlcall> for a usage example.
954c1994
GS
79
80=for apidoc Amn|U32|GIMME
81A backward-compatible version of C<GIMME_V> which can only return
82C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
83Deprecated. Use C<GIMME_V> instead.
84
85=cut
86*/
87
533c011a 88#define GIMME_V OP_GIMME(PL_op, block_gimme())
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). */
102#define OPf_STACKED 64 /* Some arg is arriving on the stack. */
79072805
LW
103#define OPf_SPECIAL 128 /* Do something weird for this op: */
104 /* On local LVAL, don't init local value. */
105 /* On OP_SORT, subroutine is inlined. */
106 /* On OP_NOT, inversion was implicit. */
a0d0e21e 107 /* On OP_LEAVE, don't restore curpm. */
79072805
LW
108 /* On truncate, we truncate filehandle */
109 /* On control verbs, we saw no label */
110 /* On flipflop, we saw ... instead of .. */
111 /* On UNOPs, saw bare parens, e.g. eof(). */
a0d0e21e 112 /* On OP_ENTERSUB || OP_NULL, saw a "do". */
afebc493 113 /* On OP_EXISTS, treat av as av, not avhv. */
f2ec2afd 114 /* On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
dbc200c5 115 /* On pushre, rx is used as part of split, e.g. split " " */
497711e7 116 /* On regcomp, "use re 'eval'" was in scope */
17fda545
NC
117 /* On RV2[ACGHS]V, don't create GV--in
118 defined()*/
5df8de69
DM
119 /* On OP_DBSTATE, indicates breakpoint
120 * (runtime property) */
6b514a0d 121 /* On OP_REQUIRE, was seen as CORE::require */
fc7debfb
FC
122 /* On OP_(ENTER|LEAVE)WHEN, there's
123 no condition */
0d863452 124 /* On OP_SMARTMATCH, an implicit smartmatch */
78c72037
NC
125 /* On OP_ANONHASH and OP_ANONLIST, create a
126 reference to the new anon hash or array */
9711599e
CS
127 /* On OP_HELEM and OP_HSLICE, localization will be followed
128 by assignment, so do not wipe the target if it is special
129 (e.g. a glob or a magic SV) */
2474a784
FC
130 /* On OP_MATCH, OP_SUBST & OP_TRANS, the
131 operand of a logical or conditional
132 that was optimised away, so it should
133 not be bound via =~ */
6b7c6d95 134 /* On OP_CONST, from a constant CV */
d67594ff
FC
135 /* On OP_GLOB, two meanings:
136 - Before ck_glob, called as CORE::glob
137 - After ck_glob, use Perl glob function
138 */
d5524600 139 /* On OP_PADRANGE, push @_ */
7d1d69cb 140 /* On OP_DUMP, has no label */
79072805 141
54310121 142/* old names; don't use in new code, but don't break them, either */
d91ab173
GS
143#define OPf_LIST OPf_WANT_LIST
144#define OPf_KNOW OPf_WANT
954c1994 145
54310121 146#define GIMME \
62a559b8
NIS
147 (PL_op->op_flags & OPf_WANT \
148 ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \
d91ab173
GS
149 ? G_ARRAY \
150 : G_SCALAR) \
151 : dowantarray())
54310121 152
1dafeec8
GG
153/* Lower bits of op_private often carry the number of arguments, as
154 * set by newBINOP, newUNOP and ck_fun */
155
894ea76b
FC
156/* NOTE: OP_NEXTSTATE and OP_DBSTATE (i.e. COPs) carry NATIVE_HINTS
157 * in op_private */
d41ff1b8 158
a0d0e21e 159/* Private for lvalues */
cd06dffe 160#define OPpLVAL_INTRO 128 /* Lvalue must be localized or lvalue sub */
a0d0e21e 161
1dafeec8
GG
162/* Private for OPs with TARGLEX */
163 /* (lower bits may carry MAXARG) */
164#define OPpTARGET_MY 16 /* Target is PADMY. */
165
7934575e
GS
166/* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
167#define OPpREFCOUNTED 64 /* op_targ carries a refcount */
168
a373464f 169/* Private for OP_LEAVE and OP_LEAVELOOP */
4c3ed741
FC
170#define OPpLVALUE 128 /* Do not copy return value */
171
a0d0e21e
LW
172/* Private for OP_AASSIGN */
173#define OPpASSIGN_COMMON 64 /* Left & right have syms in common. */
174
175/* Private for OP_SASSIGN */
176#define OPpASSIGN_BACKWARDS 64 /* Left & right switched. */
e26df76a 177#define OPpASSIGN_CV_TO_GV 128 /* Possible optimisation for constants. */
79072805 178
c657ea3a 179/* Private for OP_MATCH and OP_SUBST{,CONT} */
c90c0ff4
PP
180#define OPpRUNTIME 64 /* Pattern coming in on the stack */
181
79072805 182/* Private for OP_TRANS */
4757a243
LW
183#define OPpTRANS_FROM_UTF 1
184#define OPpTRANS_TO_UTF 2
383e7cdd 185#define OPpTRANS_IDENTICAL 4 /* right side is same as left */
4757a243 186#define OPpTRANS_SQUASH 8
59f00321 187 /* 16 is used for OPpTARGET_MY */
4757a243
LW
188#define OPpTRANS_COMPLEMENT 32
189#define OPpTRANS_GROWS 64
59f00321
RGS
190#define OPpTRANS_DELETE 128
191#define OPpTRANS_ALL (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
79072805
LW
192
193/* Private for OP_REPEAT */
a0d0e21e 194#define OPpREPEAT_DOLIST 64 /* List replication. */
79072805 195
cf2dc985 196/* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
314d4778 197#define OPpDEREF (32|64) /* autovivify: Want ref to something: */
5f05dabc
PP
198#define OPpDEREF_AV 32 /* Want ref to AV. */
199#define OPpDEREF_HV 64 /* Want ref to HV. */
200#define OPpDEREF_SV (32|64) /* Want ref to SV. */
777d9014 201
97e1065a
FC
202/* OP_ENTERSUB and OP_RV2CV flags
203
204Flags are set on entersub and rv2cv in three phases:
205 parser - the parser passes the flag to the op constructor
206 check - the check routine called by the op constructor sets the flag
207 context - application of scalar/ref/lvalue context applies the flag
208
209In the third stage, an entersub op might turn into an rv2cv op (undef &foo,
210\&foo, lock &foo, exists &foo, defined &foo). The two places where that
211happens (op_lvalue_flags and doref in op.c) need to make sure the flags do
212not conflict. Flags applied in the context phase are only set when there
213is no conversion of op type.
214
215 bit entersub flag phase rv2cv flag phase
216 --- ------------- ----- ---------- -----
211a4342 217 1 OPpENTERSUB_INARGS context
97e1065a
FC
218 2 HINT_STRICT_REFS check HINT_STRICT_REFS check
219 4 OPpENTERSUB_HASTARG check
220 8 OPpENTERSUB_AMPER parser
221 16 OPpENTERSUB_DB check
222 32 OPpDEREF_AV context
211a4342 223 64 OPpDEREF_HV context OPpMAY_RETURN_CONSTANT context
97e1065a
FC
224 128 OPpLVAL_INTRO context OPpENTERSUB_NOPAREN parser
225
226*/
227
68dc0745
PP
228 /* OP_ENTERSUB only */
229#define OPpENTERSUB_DB 16 /* Debug subroutine. */
6c5d4499
GG
230#define OPpENTERSUB_HASTARG 4 /* Called from OP tree. */
231#define OPpENTERSUB_INARGS 1 /* Lval used as arg to a sub. */
0e9700df 232/* used by OPpDEREF (32|64) */
81db4439 233/* used by HINT_STRICT_REFS 2 */
777d9014
FC
234 /* Mask for OP_ENTERSUB flags, the absence of which must be propagated
235 in dynamic context */
236#define OPpENTERSUB_LVAL_MASK (OPpLVAL_INTRO|OPpENTERSUB_INARGS)
237
d4ddbae8 238 /* OP_RV2CV only */
68dc0745 239#define OPpENTERSUB_AMPER 8 /* Used & form to call. */
9675f7ac 240#define OPpENTERSUB_NOPAREN 128 /* bare sub call (without parens) */
211a4342 241#define OPpMAY_RETURN_CONSTANT 64 /* If a constant sub, return the constant */
d4ddbae8 242
76cd736e
GS
243 /* OP_GV only */
244#define OPpEARLY_CV 32 /* foo() called before sub foo was parsed */
68dc0745
PP
245 /* OP_?ELEM only */
246#define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */
2186f873
FC
247 /* OP_RV2[AH]V OP_[AH]SLICE */
248#define OPpSLICEWARNING 4 /* warn about @hash{$scalar} */
8dc99089 249 /* OP_RV2[SAH]V, OP_GVSV, OP_ENTERITER only */
78f9721b 250#define OPpOUR_INTRO 16 /* Variable was in an our() */
6a8709a6
FC
251 /* OP_RV2[AGH]V, OP_PAD[AH]V, OP_[AH]ELEM, OP_[AH]SLICE OP_AV2ARYLEN,
252 OP_R?KEYS, OP_SUBSTR, OP_POS, OP_VEC */
78f9721b 253#define OPpMAYBE_LVSUB 8 /* We might be an lvalue to return */
6ea72b3a 254 /* OP_RV2HV and OP_PADHV */
c8fe3bdf
FC
255#define OPpTRUEBOOL 32 /* %hash in (%hash || $foo) in
256 void context */
adc42c31 257#define OPpMAYBE_TRUEBOOL 64 /* %hash in (%hash || $foo) where
6ea72b3a 258 cx is not known till run time */
24fcb59f
FC
259
260 /* OP_SUBSTR only */
261#define OPpSUBSTR_REPL_FIRST 16 /* 1st arg is replacement string */
262
952306ac
RGS
263 /* OP_PADSV only */
264#define OPpPAD_STATE 16 /* is a "state" pad */
192587c2 265 /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
79072805 266
a7fd8ef6
DM
267 /* OP_PADRANGE only */
268 /* bit 7 is OPpLVAL_INTRO */
4e09461c
DM
269#define OPpPADRANGE_COUNTMASK 127 /* bits 6..0 hold target range, */
270#define OPpPADRANGE_COUNTSHIFT 7 /* 7 bits in total */
a7fd8ef6 271
e26df76a 272 /* OP_RV2GV only */
cb0d96b9 273#define OPpDONT_INIT_GV 4 /* Call gv_fetchpv with GV_NOINIT */
e26df76a
NC
274/* (Therefore will return whatever is currently in the symbol table, not
275 guaranteed to be a PVGV) */
8dc99089 276#define OPpALLOW_FAKE 16 /* OK to return fake glob */
e26df76a 277
ef3e5ea9
NC
278/* Private for OP_ENTERITER and OP_ITER */
279#define OPpITER_REVERSED 4 /* for (reverse ...) */
0d863452 280#define OPpITER_DEF 8 /* for $_ or for my $_ */
ef3e5ea9 281
79072805 282/* Private for OP_CONST */
468aa647 283#define OPpCONST_NOVER 2 /* no 6; */
e7fec78e 284#define OPpCONST_SHORTCIRCUIT 4 /* eg the constant 5 in (5 || foo) */
486ec47a 285#define OPpCONST_STRICT 8 /* bareword subject to strict 'subs' */
748a9306 286#define OPpCONST_ENTERED 16 /* Has been entered as symbol. */
a0d0e21e 287#define OPpCONST_BARE 64 /* Was a bare word (filehandle?). */
79072805
LW
288
289/* Private for OP_FLIP/FLOP */
a0d0e21e 290#define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */
79072805 291
ed6116ce 292/* Private for OP_LIST */
a0d0e21e
LW
293#define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */
294
5f05dabc 295/* Private for OP_DELETE */
54310121 296#define OPpSLICE 64 /* Operating on a list of keys */
7332a6c4 297/* Also OPpLVAL_INTRO (128) */
5f05dabc 298
afebc493
GS
299/* Private for OP_EXISTS */
300#define OPpEXISTS_SUB 64 /* Checking for &sub, not {} or []. */
301
9c007264
JH
302/* Private for OP_SORT */
303#define OPpSORT_NUMERIC 1 /* Optimized away { $a <=> $b } */
304#define OPpSORT_INTEGER 2 /* Ditto while under "use integer" */
eb209983 305#define OPpSORT_REVERSE 4 /* Reversed sort */
fe1bc4cf 306#define OPpSORT_INPLACE 8 /* sort in-place; eg @a = sort @a */
eb209983 307#define OPpSORT_DESCEND 16 /* Descending sort */
7b9ef140
RH
308#define OPpSORT_QSORT 32 /* Use quicksort (not mergesort) */
309#define OPpSORT_STABLE 64 /* Use a stable algorithm */
310
484c818f
VP
311/* Private for OP_REVERSE */
312#define OPpREVERSE_INPLACE 8 /* reverse in-place (@a = reverse @a) */
313
16fe6d59
GS
314/* Private for OP_OPEN and OP_BACKTICK */
315#define OPpOPEN_IN_RAW 16 /* binmode(F,":raw") on input fh */
316#define OPpOPEN_IN_CRLF 32 /* binmode(F,":crlf") on input fh */
317#define OPpOPEN_OUT_RAW 64 /* binmode(F,":raw") on output fh */
318#define OPpOPEN_OUT_CRLF 128 /* binmode(F,":crlf") on output fh */
319
97124ef6
FC
320/* Private for COPs */
321#define OPpHUSH_VMSISH 32 /* hush DCL exit msg vmsish mode*/
322/* Note: Used for NATIVE_HINTS (shifted from the values in PL_hints),
323 currently defined by vms/vmsish.h:
324 64
325 128
326 */
327
0d863452 328/* Private for OP_FTXXX */
1af34c76 329#define OPpFT_ACCESS 2 /* use filetest 'access' */
bbd91306
GG
330#define OPpFT_STACKED 4 /* stacked filetest, as "-f" in "-f -x $f" */
331#define OPpFT_STACKING 8 /* stacking filetest, as "-x" in "-f -x $f" */
8db8f6b6 332#define OPpFT_AFTER_t 16 /* previous op was -t */
1af34c76 333
59f00321
RGS
334/* Private for OP_(MAP|GREP)(WHILE|START) */
335#define OPpGREP_LEX 2 /* iterate over lexical $_ */
336
0d863452
RH
337/* Private for OP_ENTEREVAL */
338#define OPpEVAL_HAS_HH 2 /* Does it have a copy of %^H */
802a15e9 339#define OPpEVAL_UNICODE 4
7d789282
FC
340#define OPpEVAL_BYTES 8
341#define OPpEVAL_COPHH 16 /* Construct %^H from cop hints */
a1941760 342#define OPpEVAL_RE_REPARSING 32 /* eval_sv(..., G_RE_REPARSING) */
0d863452 343
84ed0108 344/* Private for OP_CALLER, OP_WANTARRAY and OP_RUNCV */
93f0bc49
FC
345#define OPpOFFBYONE 128 /* Treat caller(1) as caller(2) */
346
e664e0a4 347/* Private for OP_COREARGS */
8dc99089
FC
348/* These must not conflict with OPpDONT_INIT_GV or OPpALLOW_FAKE.
349 See pp.c:S_rv2gv. */
e664e0a4
FC
350#define OPpCOREARGS_DEREF1 1 /* Arg 1 is a handle constructor */
351#define OPpCOREARGS_DEREF2 2 /* Arg 2 is a handle constructor */
cb85b2db 352#define OPpCOREARGS_SCALARMOD 64 /* \$ rather than \[$@%*] */
0b19d81a 353#define OPpCOREARGS_PUSHMARK 128 /* Call pp_pushmark */
e664e0a4 354
5db1eb8d
BF
355/* Private for OP_(LAST|REDO|NEXT|GOTO|DUMP) */
356#define OPpPV_IS_UTF8 128 /* label is in UTF8 */
357
60041a09
FC
358/* Private for OP_SPLIT */
359#define OPpSPLIT_IMPLIM 128 /* implicit limit */
360
79072805
LW
361struct op {
362 BASEOP
363};
364
365struct unop {
366 BASEOP
367 OP * op_first;
368};
369
370struct binop {
371 BASEOP
372 OP * op_first;
373 OP * op_last;
374};
375
376struct logop {
377 BASEOP
378 OP * op_first;
379 OP * op_other;
380};
381
79072805
LW
382struct listop {
383 BASEOP
384 OP * op_first;
385 OP * op_last;
79072805
LW
386};
387
388struct pmop {
389 BASEOP
390 OP * op_first;
391 OP * op_last;
1fcf4c12 392#ifdef USE_ITHREADS
784e50c8 393 PADOFFSET op_pmoffset;
1fcf4c12
AB
394#else
395 REGEXP * op_pmregexp; /* compiled expression */
396#endif
69bdead3 397 U32 op_pmflags;
29f2e912 398 union {
20e98b0f
NC
399 OP * op_pmreplroot; /* For OP_SUBST */
400#ifdef USE_ITHREADS
401 PADOFFSET op_pmtargetoff; /* For OP_PUSHRE */
402#else
403 GV * op_pmtargetgv;
404#endif
405 } op_pmreplrootu;
406 union {
29f2e912 407 OP * op_pmreplstart; /* Only used in OP_SUBST */
cb55de95 408#ifdef USE_ITHREADS
23083432 409 PADOFFSET op_pmstashoff; /* Only used in OP_MATCH, with PMf_ONCE set */
cb55de95 410#else
29f2e912 411 HV * op_pmstash;
cb55de95 412#endif
29f2e912 413 } op_pmstashstartu;
68e2671b 414 OP * op_code_list; /* list of (?{}) code blocks */
79072805 415};
a0d0e21e 416
1fcf4c12 417#ifdef USE_ITHREADS
14a49a24
NC
418#define PM_GETRE(o) (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
419 ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
ede1273d
NC
420/* The assignment is just to enforce type safety (or at least get a warning).
421 */
14a49a24
NC
422/* With first class regexps not via a reference one needs to assign
423 &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
424 is cheaper. I guess we could allow NULL, but the check above would get
425 more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
426/* BEWARE - something that calls this macro passes (r) which has a side
427 effect. */
ede1273d 428#define PM_SETRE(o,r) STMT_START { \
b1bc3f34 429 REGEXP *const _pm_setre = (r); \
7948fc08 430 assert(_pm_setre); \
b1bc3f34 431 PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
ede1273d 432 } STMT_END
1fcf4c12 433#else
b9ed2502
AB
434#define PM_GETRE(o) ((o)->op_pmregexp)
435#define PM_SETRE(o,r) ((o)->op_pmregexp = (r))
1fcf4c12 436#endif
4825b64b 437
beae72ee
KW
438/* Leave some space, so future bit allocations can go either in the shared or
439 * unshared area without affecting binary compatibility */
df7a8460 440#define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+6)
f4a4cecb 441
ef07e810 442/* 'use re "taint"' in scope: taint $1 etc. if target tainted */
1ad4ec54 443#define PMf_RETAINT (1<<(PMf_BASE_SHIFT+0))
c737faaf 444
c0f1c194
KW
445/* match successfully only once per reset, with related flag RXf_USED in
446 * re->extflags holding state. This is used only for ?? matches, and only on
447 * OP_MATCH and OP_QR */
1ad4ec54 448#define PMf_ONCE (1<<(PMf_BASE_SHIFT+1))
1850c8f9 449
d234778b 450/* PMf_ONCE, i.e. ?pat?, has matched successfully. Not used under threading. */
1ad4ec54 451#define PMf_USED (1<<(PMf_BASE_SHIFT+3))
1850c8f9
KW
452
453/* subst replacement is constant */
1ad4ec54 454#define PMf_CONST (1<<(PMf_BASE_SHIFT+4))
c737faaf 455
1850c8f9 456/* keep 1st runtime pattern forever */
1ad4ec54 457#define PMf_KEEP (1<<(PMf_BASE_SHIFT+5))
4da3eb8b 458
1ad4ec54 459#define PMf_GLOBAL (1<<(PMf_BASE_SHIFT+6)) /* pattern had a g modifier */
c737faaf 460
1850c8f9 461/* don't reset pos() if //g fails */
1ad4ec54 462#define PMf_CONTINUE (1<<(PMf_BASE_SHIFT+7))
1850c8f9
KW
463
464/* evaluating replacement as expr */
1ad4ec54 465#define PMf_EVAL (1<<(PMf_BASE_SHIFT+8))
c0f1c194
KW
466
467/* Return substituted string instead of modifying it. */
1ad4ec54 468#define PMf_NONDESTRUCT (1<<(PMf_BASE_SHIFT+9))
e357fc67 469
d63c20f2
DM
470/* the pattern has a CV attached (currently only under qr/...(?{}).../) */
471#define PMf_HAS_CV (1<<(PMf_BASE_SHIFT+10))
472
867940b8
DM
473/* op_code_list is private; don't free it etc. It may well point to
474 * code within another sub, with different pad etc */
475#define PMf_CODELIST_PRIVATE (1<<(PMf_BASE_SHIFT+11))
476
2a92a973
DM
477/* the PMOP is a QR (we should be able to detect that from the op type,
478 * but the regex compilation API passes just the pm flags, not the op
479 * itself */
480#define PMf_IS_QR (1<<(PMf_BASE_SHIFT+12))
a5ae69f0 481#define PMf_USE_RE_EVAL (1<<(PMf_BASE_SHIFT+13)) /* use re'eval' in scope */
2a92a973 482
a5ae69f0 483#if PMf_BASE_SHIFT+13 > 31
32cdcf9d 484# error Too many PMf_ bits used. See above and regnodes.h for any spare in middle
1850c8f9 485#endif
79072805 486
cb55de95 487#ifdef USE_ITHREADS
05ec9bb3 488
23083432
FC
489# define PmopSTASH(o) ((o)->op_pmflags & PMf_ONCE \
490 ? PL_stashpad[(o)->op_pmstashstartu.op_pmstashoff] \
491 : NULL)
492# define PmopSTASH_set(o,hv) \
493 (assert_((o)->op_pmflags & PMf_ONCE) \
494 (o)->op_pmstashstartu.op_pmstashoff = \
01f44973 495 (hv) ? alloccopstash(hv) : 0)
cb55de95 496#else
29f2e912
NC
497# define PmopSTASH(o) \
498 (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
499# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
500# define PmopSTASH_set(o,hv) ({ \
501 assert((o)->op_pmflags & PMf_ONCE); \
502 ((o)->op_pmstashstartu.op_pmstash = (hv)); \
503 })
504# else
505# define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
506# endif
cb55de95 507#endif
23083432
FC
508#define PmopSTASHPV(o) (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
509 /* op_pmstashstartu.op_pmstash is not refcounted */
510#define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
cb55de95 511
79072805
LW
512struct svop {
513 BASEOP
514 SV * op_sv;
515};
516
7934575e 517struct padop {
79072805 518 BASEOP
7934575e 519 PADOFFSET op_padix;
79072805
LW
520};
521
522struct pvop {
523 BASEOP
524 char * op_pv;
525};
526
79072805
LW
527struct loop {
528 BASEOP
529 OP * op_first;
530 OP * op_last;
79072805
LW
531 OP * op_redoop;
532 OP * op_nextop;
533 OP * op_lastop;
534};
535
350de78d
GS
536#define cUNOPx(o) ((UNOP*)o)
537#define cBINOPx(o) ((BINOP*)o)
538#define cLISTOPx(o) ((LISTOP*)o)
539#define cLOGOPx(o) ((LOGOP*)o)
540#define cPMOPx(o) ((PMOP*)o)
541#define cSVOPx(o) ((SVOP*)o)
542#define cPADOPx(o) ((PADOP*)o)
543#define cPVOPx(o) ((PVOP*)o)
544#define cCOPx(o) ((COP*)o)
545#define cLOOPx(o) ((LOOP*)o)
546
547#define cUNOP cUNOPx(PL_op)
548#define cBINOP cBINOPx(PL_op)
549#define cLISTOP cLISTOPx(PL_op)
550#define cLOGOP cLOGOPx(PL_op)
551#define cPMOP cPMOPx(PL_op)
552#define cSVOP cSVOPx(PL_op)
553#define cPADOP cPADOPx(PL_op)
554#define cPVOP cPVOPx(PL_op)
555#define cCOP cCOPx(PL_op)
556#define cLOOP cLOOPx(PL_op)
557
558#define cUNOPo cUNOPx(o)
559#define cBINOPo cBINOPx(o)
560#define cLISTOPo cLISTOPx(o)
561#define cLOGOPo cLOGOPx(o)
562#define cPMOPo cPMOPx(o)
563#define cSVOPo cSVOPx(o)
564#define cPADOPo cPADOPx(o)
565#define cPVOPo cPVOPx(o)
566#define cCOPo cCOPx(o)
567#define cLOOPo cLOOPx(o)
568
569#define kUNOP cUNOPx(kid)
570#define kBINOP cBINOPx(kid)
571#define kLISTOP cLISTOPx(kid)
572#define kLOGOP cLOGOPx(kid)
573#define kPMOP cPMOPx(kid)
574#define kSVOP cSVOPx(kid)
575#define kPADOP cPADOPx(kid)
576#define kPVOP cPVOPx(kid)
577#define kCOP cCOPx(kid)
578#define kLOOP cLOOPx(kid)
579
580
581#ifdef USE_ITHREADS
dd2155a4 582# define cGVOPx_gv(o) ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
cecf5685
NC
583# define IS_PADGV(v) (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
584 && GvIN_PAD(v))
f5a0fd1e
FC
585# define IS_PADCONST(v) \
586 (v && (SvREADONLY(v) || (SvIsCOW(v) && !SvLEN(v))))
7766f137 587# define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
dd2155a4 588 ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
638eceb6 589# define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
dd2155a4 590 ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
350de78d 591#else
638eceb6 592# define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
743e66e6 593# define IS_PADGV(v) FALSE
7766f137
GS
594# define IS_PADCONST(v) FALSE
595# define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
638eceb6 596# define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
350de78d 597#endif
79072805 598
638eceb6
GS
599#define cGVOP_gv cGVOPx_gv(PL_op)
600#define cGVOPo_gv cGVOPx_gv(o)
601#define kGVOP_gv cGVOPx_gv(kid)
602#define cSVOP_sv cSVOPx_sv(PL_op)
603#define cSVOPo_sv cSVOPx_sv(o)
604#define kSVOP_sv cSVOPx_sv(kid)
7766f137 605
bcabcc50
NC
606#ifndef PERL_CORE
607# define Nullop ((OP*)NULL)
608#endif
79072805 609
cee4176c 610/* Lowest byte of PL_opargs */
a0d0e21e
LW
611#define OA_MARK 1
612#define OA_FOLDCONST 2
613#define OA_RETSCALAR 4
614#define OA_TARGET 8
903fd87c 615#define OA_TARGLEX 16
a0d0e21e
LW
616#define OA_OTHERINT 32
617#define OA_DANGEROUS 64
618#define OA_DEFGV 128
619
738ec380 620/* The next 4 bits (8..11) encode op class information */
903fd87c 621#define OCSHIFT 8
b162f9ea
IZ
622
623#define OA_CLASS_MASK (15 << OCSHIFT)
624
625#define OA_BASEOP (0 << OCSHIFT)
626#define OA_UNOP (1 << OCSHIFT)
627#define OA_BINOP (2 << OCSHIFT)
628#define OA_LOGOP (3 << OCSHIFT)
1a67a97c
SM
629#define OA_LISTOP (4 << OCSHIFT)
630#define OA_PMOP (5 << OCSHIFT)
631#define OA_SVOP (6 << OCSHIFT)
7934575e 632#define OA_PADOP (7 << OCSHIFT)
1a67a97c
SM
633#define OA_PVOP_OR_SVOP (8 << OCSHIFT)
634#define OA_LOOP (9 << OCSHIFT)
635#define OA_COP (10 << OCSHIFT)
636#define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
637#define OA_FILESTATOP (12 << OCSHIFT)
638#define OA_LOOPEXOP (13 << OCSHIFT)
b162f9ea 639
738ec380
DM
640/* Each remaining nybble of PL_opargs (i.e. bits 12..15, 16..19 etc)
641 * encode the type for each arg */
903fd87c 642#define OASHIFT 12
a0d0e21e 643
a0d0e21e
LW
644#define OA_SCALAR 1
645#define OA_LIST 2
646#define OA_AVREF 3
647#define OA_HVREF 4
648#define OA_CVREF 5
649#define OA_FILEREF 6
650#define OA_SCALARREF 7
651#define OA_OPTIONAL 8
652
d3c72c2a
DM
653/* Op_REFCNT is a reference count at the head of each op tree: needed
654 * since the tree is shared between threads, and between cloned closure
655 * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
656 * this count.
657 * The same mutex is used to protect the refcounts of the reg_trie_data
658 * and reg_ac_data structures, which are shared between duplicated
659 * regexes.
660 */
661
534825c4
GS
662#ifdef USE_ITHREADS
663# define OP_REFCNT_INIT MUTEX_INIT(&PL_op_mutex)
4026c95a
SH
664# ifdef PERL_CORE
665# define OP_REFCNT_LOCK MUTEX_LOCK(&PL_op_mutex)
666# define OP_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_op_mutex)
667# else
668# define OP_REFCNT_LOCK op_refcnt_lock()
669# define OP_REFCNT_UNLOCK op_refcnt_unlock()
670# endif
534825c4 671# define OP_REFCNT_TERM MUTEX_DESTROY(&PL_op_mutex)
534825c4
GS
672#else
673# define OP_REFCNT_INIT NOOP
674# define OP_REFCNT_LOCK NOOP
675# define OP_REFCNT_UNLOCK NOOP
676# define OP_REFCNT_TERM NOOP
534825c4 677#endif
e4783991 678
282f25c9 679#define OpREFCNT_set(o,n) ((o)->op_targ = (n))
fc97af9c
NC
680#ifdef PERL_DEBUG_READONLY_OPS
681# define OpREFCNT_inc(o) Perl_op_refcnt_inc(aTHX_ o)
682# define OpREFCNT_dec(o) Perl_op_refcnt_dec(aTHX_ o)
683#else
684# define OpREFCNT_inc(o) ((o) ? (++(o)->op_targ, (o)) : NULL)
685# define OpREFCNT_dec(o) (--(o)->op_targ)
686#endif
282f25c9 687
e4783991 688/* flags used by Perl_load_module() */
ec6d81ab
RGS
689#define PERL_LOADMOD_DENY 0x1 /* no Module */
690#define PERL_LOADMOD_NOIMPORT 0x2 /* use Module () */
466f50cc
FC
691#define PERL_LOADMOD_IMPORT_OPS 0x4 /* import arguments
692 are passed as a sin-
693 gle op tree, not a
694 list of SVs */
e5dd39fc 695
30d9c59b 696#if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C) || defined(PERL_IN_TOKE_C)
e4c5ccf3 697#define ref(o, type) doref(o, type, TRUE)
a0c21aa1 698#endif
e4c5ccf3 699
5983a79d
BM
700/*
701=head1 Optree Manipulation Functions
702
703=for apidoc Am|OP*|LINKLIST|OP *o
704Given the root of an optree, link the tree in execution order using the
72d33970 705C<op_next> pointers and return the first op executed. If this has
5983a79d 706already been done, it will not be redone, and C<< o->op_next >> will be
72d33970 707returned. If C<< o->op_next >> is not already set, I<o> should be at
5983a79d
BM
708least an C<UNOP>.
709
710=cut
711*/
712
713#define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
714
33f36c71
NC
715/* no longer used anywhere in core */
716#ifndef PERL_CORE
46471bde 717#define cv_ckproto(cv, gv, p) \
f717afa7 718 cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
33f36c71
NC
719#endif
720
7d0905b9
NC
721#ifdef PERL_CORE
722# define my(o) my_attrs((o), NULL)
723#endif
724
e5dd39fc 725#ifdef USE_REENTRANT_API
10bc17b6 726#include "reentr.h"
e5dd39fc
AB
727#endif
728
c7e45529 729#define NewOp(m,var,c,type) \
e91d68d5 730 (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
c7e45529 731#define NewOpSz(m,var,size) \
e91d68d5 732 (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
c7e45529 733#define FreeOp(p) Perl_Slab_Free(aTHX_ p)
8be227ab
FC
734
735/*
736 * The per-CV op slabs consist of a header (the opslab struct) and a bunch
737 * of space for allocating op slots, each of which consists of two pointers
738 * followed by an op. The first pointer points to the next op slot. The
739 * second points to the slab. At the end of the slab is a null pointer,
740 * so that slot->opslot_next - slot can be used to determine the size
741 * of the op.
742 *
743 * Each CV can have multiple slabs; opslab_next points to the next slab, to
744 * form a chain. All bookkeeping is done on the first slab, which is where
745 * all the op slots point.
746 *
747 * Freed ops are marked as freed and attached to the freed chain
748 * via op_next pointers.
749 *
750 * When there is more than one slab, the second slab in the slab chain is
751 * assumed to be the one with free space available. It is used when allo-
752 * cating an op if there are no freed ops available or big enough.
753 */
754
7aef8e5b 755#ifdef PERL_CORE
8be227ab
FC
756struct opslot {
757 /* keep opslot_next first */
758 OPSLOT * opslot_next; /* next slot */
759 OPSLAB * opslot_slab; /* owner */
760 OP opslot_op; /* the op itself */
761};
762
763struct opslab {
764 OPSLOT * opslab_first; /* first op in this slab */
765 OPSLAB * opslab_next; /* next slab */
766 OP * opslab_freed; /* chain of freed ops */
767 size_t opslab_refcnt; /* number of ops */
3107b51f
FC
768# ifdef PERL_DEBUG_READONLY_OPS
769 U16 opslab_size; /* size of slab in pointers */
770 bool opslab_readonly;
771# endif
8be227ab
FC
772 OPSLOT opslab_slots; /* slots begin here */
773};
774
775# define OPSLOT_HEADER STRUCT_OFFSET(OPSLOT, opslot_op)
776# define OPSLOT_HEADER_P (OPSLOT_HEADER/sizeof(I32 *))
c7724415 777# define OpSLOT(o) (assert_(o->op_slabbed) \
8be227ab 778 (OPSLOT *)(((char *)o)-OPSLOT_HEADER))
8be227ab
FC
779# define OpSLAB(o) OpSLOT(o)->opslot_slab
780# define OpslabREFCNT_dec(slab) \
781 (((slab)->opslab_refcnt == 1) \
782 ? opslab_free_nopad(slab) \
783 : (void)--(slab)->opslab_refcnt)
784 /* Variant that does not null out the pads */
785# define OpslabREFCNT_dec_padok(slab) \
786 (((slab)->opslab_refcnt == 1) \
787 ? opslab_free(slab) \
788 : (void)--(slab)->opslab_refcnt)
c7e45529 789#endif
598921a7 790
1930840b 791struct block_hooks {
52db365a 792 U32 bhk_flags;
1930840b
BM
793 void (*bhk_start) (pTHX_ int full);
794 void (*bhk_pre_end) (pTHX_ OP **seq);
795 void (*bhk_post_end) (pTHX_ OP **seq);
52db365a 796 void (*bhk_eval) (pTHX_ OP *const saveop);
1930840b
BM
797};
798
fd85fad2
BM
799/*
800=head1 Compile-time scope hooks
801
3e4ddde5 802=for apidoc mx|U32|BhkFLAGS|BHK *hk
fd85fad2
BM
803Return the BHK's flags.
804
3e4ddde5 805=for apidoc mx|void *|BhkENTRY|BHK *hk|which
72d33970
FC
806Return an entry from the BHK structure. I<which> is a preprocessor token
807indicating which entry to return. If the appropriate flag is not set
808this will return NULL. The type of the return value depends on which
fd85fad2
BM
809entry you ask for.
810
3e4ddde5 811=for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
fd85fad2 812Set an entry in the BHK structure, and set the flags to indicate it is
72d33970 813valid. I<which> is a preprocessing token indicating which entry to set.
fd85fad2
BM
814The type of I<ptr> depends on the entry.
815
3e4ddde5 816=for apidoc Amx|void|BhkDISABLE|BHK *hk|which
a3e07c87 817Temporarily disable an entry in this BHK structure, by clearing the
72d33970 818appropriate flag. I<which> is a preprocessor token indicating which
a3e07c87
BM
819entry to disable.
820
3e4ddde5 821=for apidoc Amx|void|BhkENABLE|BHK *hk|which
a3e07c87 822Re-enable an entry in this BHK structure, by setting the appropriate
72d33970 823flag. I<which> is a preprocessor token indicating which entry to enable.
a3e07c87
BM
824This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
825pointer.
826
3e4ddde5 827=for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
72d33970 828Call all the registered block hooks for type I<which>. I<which> is a
fd85fad2
BM
829preprocessing token; the type of I<arg> depends on I<which>.
830
831=cut
832*/
833
52db365a
BM
834#define BhkFLAGS(hk) ((hk)->bhk_flags)
835
a88d97bf
BM
836#define BHKf_bhk_start 0x01
837#define BHKf_bhk_pre_end 0x02
838#define BHKf_bhk_post_end 0x04
839#define BHKf_bhk_eval 0x08
52db365a
BM
840
841#define BhkENTRY(hk, which) \
a88d97bf 842 ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
52db365a 843
a3e07c87
BM
844#define BhkENABLE(hk, which) \
845 STMT_START { \
846 BhkFLAGS(hk) |= BHKf_ ## which; \
847 assert(BhkENTRY(hk, which)); \
848 } STMT_END
849
850#define BhkDISABLE(hk, which) \
851 STMT_START { \
852 BhkFLAGS(hk) &= ~(BHKf_ ## which); \
853 } STMT_END
854
52db365a
BM
855#define BhkENTRY_set(hk, which, ptr) \
856 STMT_START { \
a88d97bf 857 (hk)->which = ptr; \
a3e07c87 858 BhkENABLE(hk, which); \
52db365a
BM
859 } STMT_END
860
1930840b
BM
861#define CALL_BLOCK_HOOKS(which, arg) \
862 STMT_START { \
863 if (PL_blockhooks) { \
c70927a6 864 SSize_t i; \
b9f2b683 865 for (i = av_tindex(PL_blockhooks); i >= 0; i--) { \
1930840b 866 SV *sv = AvARRAY(PL_blockhooks)[i]; \
52db365a 867 BHK *hk; \
1930840b
BM
868 \
869 assert(SvIOK(sv)); \
870 if (SvUOK(sv)) \
52db365a 871 hk = INT2PTR(BHK *, SvUVX(sv)); \
1930840b 872 else \
52db365a 873 hk = INT2PTR(BHK *, SvIVX(sv)); \
1930840b 874 \
52db365a 875 if (BhkENTRY(hk, which)) \
16c91539 876 BhkENTRY(hk, which)(aTHX_ arg); \
1930840b
BM
877 } \
878 } \
879 } STMT_END
880
d9088386
Z
881/* flags for rv2cv_op_cv */
882
883#define RV2CVOPCV_MARK_EARLY 0x00000001
884#define RV2CVOPCV_RETURN_NAME_GV 0x00000002
211a4342
FC
885#define RV2CVOPCV_RETURN_STUB 0x00000004
886#define RV2CVOPCV_FLAG_MASK 0x00000007 /* all of the above */
d9088386 887
d3d7d28f
FC
888#define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
889
f5d552b4
FC
890/* flags for op_lvalue_flags */
891
892#define OP_LVALUE_NO_CROAK 1
893
9733086d
BM
894/*
895=head1 Custom Operators
896
897=for apidoc Am|U32|XopFLAGS|XOP *xop
898Return the XOP's flags.
899
900=for apidoc Am||XopENTRY|XOP *xop|which
72d33970
FC
901Return a member of the XOP structure. I<which> is a cpp token
902indicating which entry to return. If the member is not set
903this will return a default value. The return type depends
904on I<which>. This macro evaluates its arguments more than
905once. If you are using C<Perl_custom_op_xop> to retreive a
ae103e09
DD
906C<XOP *> from a C<OP *>, use the more efficient L</XopENTRYCUSTOM> instead.
907
908=for apidoc Am||XopENTRYCUSTOM|const OP *o|which
909Exactly like C<XopENTRY(XopENTRY(Perl_custom_op_xop(aTHX_ o), which)> but more
72d33970 910efficient. The I<which> parameter is identical to L</XopENTRY>.
9733086d
BM
911
912=for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
72d33970
FC
913Set a member of the XOP structure. I<which> is a cpp token
914indicating which entry to set. See L<perlguts/"Custom Operators">
915for details about the available members and how
916they are used. This macro evaluates its argument
ae103e09 917more than once.
9733086d
BM
918
919=for apidoc Am|void|XopDISABLE|XOP *xop|which
920Temporarily disable a member of the XOP, by clearing the appropriate flag.
921
922=for apidoc Am|void|XopENABLE|XOP *xop|which
923Reenable a member of the XOP which has been disabled.
924
925=cut
926*/
927
1830b3d9
BM
928struct custom_op {
929 U32 xop_flags;
930 const char *xop_name;
931 const char *xop_desc;
932 U32 xop_class;
933 void (*xop_peep)(pTHX_ OP *o, OP *oldop);
934};
935
ae103e09
DD
936/* return value of Perl_custom_op_get_field, similar to void * then casting but
937 the U32 doesn't need truncation on 64 bit platforms in the caller, also
938 for easier macro writing */
939typedef union {
940 const char *xop_name;
941 const char *xop_desc;
942 U32 xop_class;
943 void (*xop_peep)(pTHX_ OP *o, OP *oldop);
944 XOP *xop_ptr;
945} XOPRETANY;
946
1830b3d9
BM
947#define XopFLAGS(xop) ((xop)->xop_flags)
948
949#define XOPf_xop_name 0x01
950#define XOPf_xop_desc 0x02
951#define XOPf_xop_class 0x04
952#define XOPf_xop_peep 0x08
953
ae103e09
DD
954/* used by Perl_custom_op_get_field for option checking */
955typedef enum {
956 XOPe_xop_ptr = 0, /* just get the XOP *, don't look inside it */
957 XOPe_xop_name = XOPf_xop_name,
958 XOPe_xop_desc = XOPf_xop_desc,
959 XOPe_xop_class = XOPf_xop_class,
4a3798ca 960 XOPe_xop_peep = XOPf_xop_peep
ae103e09
DD
961} xop_flags_enum;
962
1830b3d9
BM
963#define XOPd_xop_name PL_op_name[OP_CUSTOM]
964#define XOPd_xop_desc PL_op_desc[OP_CUSTOM]
965#define XOPd_xop_class OA_BASEOP
966#define XOPd_xop_peep ((Perl_cpeep_t)0)
967
968#define XopENTRY_set(xop, which, to) \
969 STMT_START { \
970 (xop)->which = (to); \
971 (xop)->xop_flags |= XOPf_ ## which; \
972 } STMT_END
973
974#define XopENTRY(xop, which) \
975 ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
976
ae103e09
DD
977#define XopENTRYCUSTOM(o, which) \
978 (Perl_custom_op_get_field(aTHX_ o, XOPe_ ## which).which)
979
1830b3d9
BM
980#define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
981#define XopENABLE(xop, which) \
982 STMT_START { \
983 (xop)->xop_flags |= XOPf_ ## which; \
984 assert(XopENTRY(xop, which)); \
985 } STMT_END
986
ae103e09
DD
987#define Perl_custom_op_xop(x) \
988 (Perl_custom_op_get_field(x, XOPe_xop_ptr).xop_ptr)
989
9733086d
BM
990/*
991=head1 Optree Manipulation Functions
992
993=for apidoc Am|const char *|OP_NAME|OP *o
72d33970 994Return the name of the provided OP. For core ops this looks up the name
9733086d
BM
995from the op_type; for custom ops from the op_ppaddr.
996
997=for apidoc Am|const char *|OP_DESC|OP *o
998Return a short description of the provided OP.
999
1000=for apidoc Am|U32|OP_CLASS|OP *o
1001Return the class of the provided OP: that is, which of the *OP
72d33970 1002structures it uses. For core ops this currently gets the information out
9733086d
BM
1003of PL_opargs, which does not always accurately reflect the type used.
1004For custom ops the type is returned from the registration, and it is up
72d33970 1005to the registree to ensure it is accurate. The value returned will be
9733086d
BM
1006one of the OA_* constants from op.h.
1007
437e3a7d 1008=for apidoc Am|bool|OP_TYPE_IS|OP *o, Optype type
11ee9dd6
SM
1009Returns true if the given OP is not a NULL pointer
1010and if it is of the given type.
1011
1012The negation of this macro, C<OP_TYPE_ISNT> is also available
1013as well as C<OP_TYPE_IS_NN> and C<OP_TYPE_ISNT_NN> which elide
1014the NULL pointer check.
1015
1016=for apidoc Am|bool|OP_TYPE_IS_OR_WAS|OP *o, Optype type
1017Returns true if the given OP is not a NULL pointer and
1018if it is of the given type or used to be before being
1019replaced by an OP of type OP_NULL.
1020
1021The negation of this macro, C<OP_TYPE_ISNT_AND_WASNT>
1022is also available as well as C<OP_TYPE_IS_OR_WAS_NN>
1023and C<OP_TYPE_ISNT_AND_WASNT_NN> which elide
1024the NULL pointer check.
1025
1ed44841
DM
1026=for apidoc Am|bool|OP_HAS_SIBLING|OP *o
1027Returns true if o has a sibling
1028
1029=for apidoc Am|bool|OP_SIBLING|OP *o
1030Returns the sibling of o, or NULL if there is no sibling
1031
1032=for apidoc Am|bool|OP_SIBLING_set|OP *o|OP *sib
1033Sets the sibling of o to sib
1034
9733086d
BM
1035=cut
1036*/
1037
1830b3d9 1038#define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
ae103e09 1039 ? XopENTRYCUSTOM(o, xop_name) \
1830b3d9
BM
1040 : PL_op_name[(o)->op_type])
1041#define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
ae103e09 1042 ? XopENTRYCUSTOM(o, xop_desc) \
1830b3d9
BM
1043 : PL_op_desc[(o)->op_type])
1044#define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
ae103e09 1045 ? XopENTRYCUSTOM(o, xop_class) \
1830b3d9
BM
1046 : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
1047
437e3a7d 1048#define OP_TYPE_IS(o, type) ((o) && (o)->op_type == (type))
11ee9dd6
SM
1049#define OP_TYPE_IS_NN(o, type) ((o)->op_type == (type))
1050#define OP_TYPE_ISNT(o, type) ((o) && (o)->op_type != (type))
1051#define OP_TYPE_ISNT_NN(o, type) ((o)->op_type != (type))
1052
1053#define OP_TYPE_IS_OR_WAS_NN(o, type) \
1054 ( ((o)->op_type == OP_NULL \
1055 ? (o)->op_targ \
1056 : (o)->op_type) \
1057 == (type) )
1058
1059#define OP_TYPE_IS_OR_WAS(o, type) \
1060 ( (o) && OP_TYPE_IS_OR_WAS_NN(o, type) )
1061
1062#define OP_TYPE_ISNT_AND_WASNT_NN(o, type) \
1063 ( ((o)->op_type == OP_NULL \
1064 ? (o)->op_targ \
1065 : (o)->op_type) \
1066 != (type) )
1067
1068#define OP_TYPE_ISNT_AND_WASNT(o, type) \
1069 ( (o) && OP_TYPE_ISNT_AND_WASNT_NN(o, type) )
437e3a7d 1070
29e61fd9
DM
1071#ifdef PERL_OP_PARENT
1072# define OP_HAS_SIBLING(o) (!cBOOL((o)->op_lastsib))
1073# define OP_SIBLING(o) (0 + (o)->op_lastsib ? NULL : (o)->op_sibling)
1074# define OP_SIBLING_set(o, sib) ((o)->op_sibling = (sib))
1075#else
1076# define OP_HAS_SIBLING(o) (cBOOL((o)->op_sibling))
1077# define OP_SIBLING(o) (0 + (o)->op_sibling)
1078# define OP_SIBLING_set(o, sib) ((o)->op_sibling = (sib))
1079#endif
1ed44841 1080
e8f91c91
DD
1081#define newATTRSUB(f, o, p, a, b) Perl_newATTRSUB_x(aTHX_ f, o, p, a, b, FALSE)
1082#define newSUB(f, o, p, b) newATTRSUB((f), (o), (p), NULL, (b))
7bff8c33 1083
3f2908ec 1084/*
e8570548
Z
1085=head1 Hook manipulation
1086*/
1087
1088#ifdef USE_ITHREADS
1089# define OP_CHECK_MUTEX_INIT MUTEX_INIT(&PL_check_mutex)
1090# define OP_CHECK_MUTEX_LOCK MUTEX_LOCK(&PL_check_mutex)
1091# define OP_CHECK_MUTEX_UNLOCK MUTEX_UNLOCK(&PL_check_mutex)
1092# define OP_CHECK_MUTEX_TERM MUTEX_DESTROY(&PL_check_mutex)
1093#else
1094# define OP_CHECK_MUTEX_INIT NOOP
1095# define OP_CHECK_MUTEX_LOCK NOOP
1096# define OP_CHECK_MUTEX_UNLOCK NOOP
1097# define OP_CHECK_MUTEX_TERM NOOP
1098#endif
1099
1100/*
3f2908ec
NC
1101 * Local variables:
1102 * c-indentation-style: bsd
1103 * c-basic-offset: 4
14d04a33 1104 * indent-tabs-mode: nil
3f2908ec
NC
1105 * End:
1106 *
14d04a33 1107 * ex: set ts=8 sts=4 sw=4 et:
3f2908ec 1108 */