This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
op_lvalue .= _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.
7e5d8ed2
DM
22 *
23 * See the comments in S_clear_yystack() for more
24 * details on the following three flags:
85594c31 25 *
670f3923
DM
26 * op_latefree tell op_free() to clear this op (and free any kids)
27 * but not yet deallocate the struct. This means that
28 * the op may be safely op_free()d multiple times
29 * op_latefreed an op_latefree op has been op_free()d
7e5d8ed2
DM
30 * op_attached this op (sub)tree has been attached to a CV
31 *
85594c31 32 * op_spare three spare bits!
79072805
LW
33 * op_flags Flags common to all operations. See OPf_* below.
34 * op_private Flags peculiar to a particular operation (BUT,
35 * by default, set to the number of children until
36 * the operation is privatized by a check routine,
37 * which may or may not check number of children).
38 */
1850c8f9 39#include "op_reg_common.h"
79072805 40
79072805 41#define OPCODE U16
79072805 42
598921a7
NC
43#ifdef PERL_MAD
44# define MADPROP_IN_BASEOP MADPROP* op_madprop;
45#else
46# define MADPROP_IN_BASEOP
47#endif
48
61a59f30 49typedef PERL_BITFIELD16 Optype;
0053d415 50
0f4eea8f
DL
51#ifdef BASEOP_DEFINITION
52#define BASEOP BASEOP_DEFINITION
53#else
79072805
LW
54#define BASEOP \
55 OP* op_next; \
56 OP* op_sibling; \
16c91539 57 OP* (*op_ppaddr)(pTHX); \
598921a7 58 MADPROP_IN_BASEOP \
79072805 59 PADOFFSET op_targ; \
654eccd5
JD
60 PERL_BITFIELD16 op_type:9; \
61 PERL_BITFIELD16 op_opt:1; \
62 PERL_BITFIELD16 op_latefree:1; \
63 PERL_BITFIELD16 op_latefreed:1; \
64 PERL_BITFIELD16 op_attached:1; \
65 PERL_BITFIELD16 op_spare:3; \
a0d0e21e
LW
66 U8 op_flags; \
67 U8 op_private;
0f4eea8f 68#endif
79072805 69
0053d415
JD
70/* If op_type:9 is changed to :10, also change PUSHEVAL in cop.h.
71 Also, if the type of op_type is ever changed (e.g. to PERL_BITFIELD32)
72 then all the other bit-fields before/after it should change their
73 types too to let VC pack them into the same 4 byte integer.*/
17347a51 74
54310121
PP
75#define OP_GIMME(op,dfl) \
76 (((op)->op_flags & OPf_WANT) == OPf_WANT_VOID ? G_VOID : \
77 ((op)->op_flags & OPf_WANT) == OPf_WANT_SCALAR ? G_SCALAR : \
78 ((op)->op_flags & OPf_WANT) == OPf_WANT_LIST ? G_ARRAY : \
79 dfl)
80
2f8edad0 81#define OP_GIMME_REVERSE(flags) ((flags) & G_WANT)
4f911530 82
954c1994 83/*
ccfc67b7
JH
84=head1 "Gimme" Values
85
954c1994
GS
86=for apidoc Amn|U32|GIMME_V
87The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
91e74348 88C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
683d9ad1 89respectively. See L<perlcall> for a usage example.
954c1994
GS
90
91=for apidoc Amn|U32|GIMME
92A backward-compatible version of C<GIMME_V> which can only return
93C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
94Deprecated. Use C<GIMME_V> instead.
95
96=cut
97*/
98
533c011a 99#define GIMME_V OP_GIMME(PL_op, block_gimme())
79072805
LW
100
101/* Public flags */
54310121
PP
102
103#define OPf_WANT 3 /* Mask for "want" bits: */
104#define OPf_WANT_VOID 1 /* Want nothing */
105#define OPf_WANT_SCALAR 2 /* Want single value */
106#define OPf_WANT_LIST 3 /* Want list of any length */
79072805
LW
107#define OPf_KIDS 4 /* There is a firstborn child. */
108#define OPf_PARENS 8 /* This operator was parenthesized. */
463ee0b2 109 /* (Or block needs explicit scope entry.) */
a0d0e21e
LW
110#define OPf_REF 16 /* Certified reference. */
111 /* (Return container, not containee). */
112#define OPf_MOD 32 /* Will modify (lvalue). */
113#define OPf_STACKED 64 /* Some arg is arriving on the stack. */
79072805
LW
114#define OPf_SPECIAL 128 /* Do something weird for this op: */
115 /* On local LVAL, don't init local value. */
116 /* On OP_SORT, subroutine is inlined. */
117 /* On OP_NOT, inversion was implicit. */
a0d0e21e 118 /* On OP_LEAVE, don't restore curpm. */
79072805
LW
119 /* On truncate, we truncate filehandle */
120 /* On control verbs, we saw no label */
121 /* On flipflop, we saw ... instead of .. */
122 /* On UNOPs, saw bare parens, e.g. eof(). */
a0d0e21e 123 /* On OP_ENTERSUB || OP_NULL, saw a "do". */
afebc493 124 /* On OP_EXISTS, treat av as av, not avhv. */
f2ec2afd 125 /* On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
0ac6acae 126 /* On pushre, rx is used as part of split, e.g. split " " */
497711e7 127 /* On regcomp, "use re 'eval'" was in scope */
7c6fadd6 128 /* On OP_READLINE, was <$filehandle> */
17fda545
NC
129 /* On RV2[ACGHS]V, don't create GV--in
130 defined()*/
5df8de69
DM
131 /* On OP_DBSTATE, indicates breakpoint
132 * (runtime property) */
6b514a0d 133 /* On OP_REQUIRE, was seen as CORE::require */
0d863452
RH
134 /* On OP_ENTERWHEN, there's no condition */
135 /* On OP_BREAK, an implicit break */
136 /* On OP_SMARTMATCH, an implicit smartmatch */
78c72037
NC
137 /* On OP_ANONHASH and OP_ANONLIST, create a
138 reference to the new anon hash or array */
e91684bf 139 /* On OP_ENTER, store caller context */
9711599e
CS
140 /* On OP_HELEM and OP_HSLICE, localization will be followed
141 by assignment, so do not wipe the target if it is special
142 (e.g. a glob or a magic SV) */
2474a784
FC
143 /* On OP_MATCH, OP_SUBST & OP_TRANS, the
144 operand of a logical or conditional
145 that was optimised away, so it should
146 not be bound via =~ */
6b7c6d95 147 /* On OP_CONST, from a constant CV */
d1bea3d8 148 /* On OP_GLOB, use Perl glob function */
79072805 149
54310121 150/* old names; don't use in new code, but don't break them, either */
d91ab173
GS
151#define OPf_LIST OPf_WANT_LIST
152#define OPf_KNOW OPf_WANT
954c1994 153
54310121 154#define GIMME \
62a559b8
NIS
155 (PL_op->op_flags & OPf_WANT \
156 ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \
d91ab173
GS
157 ? G_ARRAY \
158 : G_SCALAR) \
159 : dowantarray())
54310121 160
51a68671 161/* NOTE: OP_NEXTSTATE and OP_DBSTATE (i.e. COPs) carry lower
d41ff1b8
GS
162 * bits of PL_hints in op_private */
163
a0d0e21e 164/* Private for lvalues */
cd06dffe 165#define OPpLVAL_INTRO 128 /* Lvalue must be localized or lvalue sub */
a0d0e21e 166
7934575e
GS
167/* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
168#define OPpREFCOUNTED 64 /* op_targ carries a refcount */
169
a0d0e21e
LW
170/* Private for OP_AASSIGN */
171#define OPpASSIGN_COMMON 64 /* Left & right have syms in common. */
172
173/* Private for OP_SASSIGN */
174#define OPpASSIGN_BACKWARDS 64 /* Left & right switched. */
e26df76a 175#define OPpASSIGN_CV_TO_GV 128 /* Possible optimisation for constants. */
79072805 176
c90c0ff4
PP
177/* Private for OP_MATCH and OP_SUBST{,CONST} */
178#define OPpRUNTIME 64 /* Pattern coming in on the stack */
179
79072805 180/* Private for OP_TRANS */
4757a243
LW
181#define OPpTRANS_FROM_UTF 1
182#define OPpTRANS_TO_UTF 2
383e7cdd 183#define OPpTRANS_IDENTICAL 4 /* right side is same as left */
4757a243 184#define OPpTRANS_SQUASH 8
59f00321 185 /* 16 is used for OPpTARGET_MY */
4757a243
LW
186#define OPpTRANS_COMPLEMENT 32
187#define OPpTRANS_GROWS 64
59f00321
RGS
188#define OPpTRANS_DELETE 128
189#define OPpTRANS_ALL (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
79072805
LW
190
191/* Private for OP_REPEAT */
a0d0e21e 192#define OPpREPEAT_DOLIST 64 /* List replication. */
79072805 193
cf2dc985 194/* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
314d4778 195#define OPpDEREF (32|64) /* autovivify: Want ref to something: */
5f05dabc
PP
196#define OPpDEREF_AV 32 /* Want ref to AV. */
197#define OPpDEREF_HV 64 /* Want ref to HV. */
198#define OPpDEREF_SV (32|64) /* Want ref to SV. */
0824d667
DM
199/* Private for OP_RV2SV, OP_RV2AV, OP_RV2AV */
200#define OPpDEREFed 4 /* prev op was OPpDEREF */
68dc0745
PP
201 /* OP_ENTERSUB only */
202#define OPpENTERSUB_DB 16 /* Debug subroutine. */
d3011074 203#define OPpENTERSUB_HASTARG 32 /* Called from OP tree. */
3ad73efd 204#define OPpENTERSUB_NOMOD 64 /* Immune to op_lvalue() for :attrlist. */
d4ddbae8 205#define OPpENTERSUB_INARGS 4 /* Lval used as arg to a sub. */
767eda44 206#define OPpENTERSUB_DEREF 1 /* Lval call that autovivifies. */
d4ddbae8 207 /* OP_RV2CV only */
68dc0745 208#define OPpENTERSUB_AMPER 8 /* Used & form to call. */
9675f7ac 209#define OPpENTERSUB_NOPAREN 128 /* bare sub call (without parens) */
d4ddbae8
FC
210#define OPpMAY_RETURN_CONSTANT 1 /* If a constant sub, return the constant */
211
76cd736e
GS
212 /* OP_GV only */
213#define OPpEARLY_CV 32 /* foo() called before sub foo was parsed */
68dc0745
PP
214 /* OP_?ELEM only */
215#define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */
241416b8 216 /* OP_RV2?V, OP_GVSV, OP_ENTERITER only */
78f9721b 217#define OPpOUR_INTRO 16 /* Variable was in an our() */
6a8709a6
FC
218 /* OP_RV2[AGH]V, OP_PAD[AH]V, OP_[AH]ELEM, OP_[AH]SLICE OP_AV2ARYLEN,
219 OP_R?KEYS, OP_SUBSTR, OP_POS, OP_VEC */
78f9721b 220#define OPpMAYBE_LVSUB 8 /* We might be an lvalue to return */
952306ac
RGS
221 /* OP_PADSV only */
222#define OPpPAD_STATE 16 /* is a "state" pad */
192587c2 223 /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
79072805 224
e26df76a 225 /* OP_RV2GV only */
cb0d96b9 226#define OPpDONT_INIT_GV 4 /* Call gv_fetchpv with GV_NOINIT */
e26df76a
NC
227/* (Therefore will return whatever is currently in the symbol table, not
228 guaranteed to be a PVGV) */
229
b162f9ea
IZ
230/* Private for OPs with TARGLEX */
231 /* (lower bits may carry MAXARG) */
232#define OPpTARGET_MY 16 /* Target is PADMY. */
233
ef3e5ea9
NC
234/* Private for OP_ENTERITER and OP_ITER */
235#define OPpITER_REVERSED 4 /* for (reverse ...) */
0d863452 236#define OPpITER_DEF 8 /* for $_ or for my $_ */
ef3e5ea9 237
79072805 238/* Private for OP_CONST */
468aa647 239#define OPpCONST_NOVER 2 /* no 6; */
e7fec78e 240#define OPpCONST_SHORTCIRCUIT 4 /* eg the constant 5 in (5 || foo) */
486ec47a 241#define OPpCONST_STRICT 8 /* bareword subject to strict 'subs' */
748a9306
LW
242#define OPpCONST_ENTERED 16 /* Has been entered as symbol. */
243#define OPpCONST_ARYBASE 32 /* Was a $[ translated to constant. */
a0d0e21e 244#define OPpCONST_BARE 64 /* Was a bare word (filehandle?). */
599cee73 245#define OPpCONST_WARNING 128 /* Was a $^W translated to constant. */
79072805
LW
246
247/* Private for OP_FLIP/FLOP */
a0d0e21e 248#define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */
79072805 249
ed6116ce 250/* Private for OP_LIST */
a0d0e21e
LW
251#define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */
252
5f05dabc 253/* Private for OP_DELETE */
54310121 254#define OPpSLICE 64 /* Operating on a list of keys */
7332a6c4 255/* Also OPpLVAL_INTRO (128) */
5f05dabc 256
afebc493
GS
257/* Private for OP_EXISTS */
258#define OPpEXISTS_SUB 64 /* Checking for &sub, not {} or []. */
259
9c007264
JH
260/* Private for OP_SORT */
261#define OPpSORT_NUMERIC 1 /* Optimized away { $a <=> $b } */
262#define OPpSORT_INTEGER 2 /* Ditto while under "use integer" */
eb209983 263#define OPpSORT_REVERSE 4 /* Reversed sort */
fe1bc4cf 264#define OPpSORT_INPLACE 8 /* sort in-place; eg @a = sort @a */
eb209983 265#define OPpSORT_DESCEND 16 /* Descending sort */
7b9ef140
RH
266#define OPpSORT_QSORT 32 /* Use quicksort (not mergesort) */
267#define OPpSORT_STABLE 64 /* Use a stable algorithm */
268
484c818f
VP
269/* Private for OP_REVERSE */
270#define OPpREVERSE_INPLACE 8 /* reverse in-place (@a = reverse @a) */
271
16fe6d59
GS
272/* Private for OP_OPEN and OP_BACKTICK */
273#define OPpOPEN_IN_RAW 16 /* binmode(F,":raw") on input fh */
274#define OPpOPEN_IN_CRLF 32 /* binmode(F,":crlf") on input fh */
275#define OPpOPEN_OUT_RAW 64 /* binmode(F,":raw") on output fh */
276#define OPpOPEN_OUT_CRLF 128 /* binmode(F,":crlf") on output fh */
277
96e176bf
CL
278/* Private for OP_EXIT, HUSH also for OP_DIE */
279#define OPpHUSH_VMSISH 64 /* hush DCL exit msg vmsish mode*/
d98f61e7
GS
280#define OPpEXIT_VMSISH 128 /* exit(0) vs. exit(1) vmsish mode*/
281
0d863452 282/* Private for OP_FTXXX */
1af34c76 283#define OPpFT_ACCESS 2 /* use filetest 'access' */
fbb0b3b3 284#define OPpFT_STACKED 4 /* stacked filetest, as in "-f -x $f" */
1af34c76 285
59f00321
RGS
286/* Private for OP_(MAP|GREP)(WHILE|START) */
287#define OPpGREP_LEX 2 /* iterate over lexical $_ */
288
0d863452
RH
289/* Private for OP_ENTEREVAL */
290#define OPpEVAL_HAS_HH 2 /* Does it have a copy of %^H */
291
79072805
LW
292struct op {
293 BASEOP
294};
295
296struct unop {
297 BASEOP
298 OP * op_first;
299};
300
301struct binop {
302 BASEOP
303 OP * op_first;
304 OP * op_last;
305};
306
307struct logop {
308 BASEOP
309 OP * op_first;
310 OP * op_other;
311};
312
79072805
LW
313struct listop {
314 BASEOP
315 OP * op_first;
316 OP * op_last;
79072805
LW
317};
318
319struct pmop {
320 BASEOP
321 OP * op_first;
322 OP * op_last;
1fcf4c12 323#ifdef USE_ITHREADS
fd1bc7eb 324 IV op_pmoffset;
1fcf4c12
AB
325#else
326 REGEXP * op_pmregexp; /* compiled expression */
327#endif
69bdead3 328 U32 op_pmflags;
29f2e912 329 union {
20e98b0f
NC
330 OP * op_pmreplroot; /* For OP_SUBST */
331#ifdef USE_ITHREADS
332 PADOFFSET op_pmtargetoff; /* For OP_PUSHRE */
333#else
334 GV * op_pmtargetgv;
335#endif
336 } op_pmreplrootu;
337 union {
29f2e912 338 OP * op_pmreplstart; /* Only used in OP_SUBST */
cb55de95 339#ifdef USE_ITHREADS
29f2e912 340 char * op_pmstashpv; /* Only used in OP_MATCH, with PMf_ONCE set */
cb55de95 341#else
29f2e912 342 HV * op_pmstash;
cb55de95 343#endif
29f2e912 344 } op_pmstashstartu;
79072805 345};
a0d0e21e 346
1fcf4c12 347#ifdef USE_ITHREADS
14a49a24
NC
348#define PM_GETRE(o) (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
349 ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
ede1273d
NC
350/* The assignment is just to enforce type safety (or at least get a warning).
351 */
14a49a24
NC
352/* With first class regexps not via a reference one needs to assign
353 &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
354 is cheaper. I guess we could allow NULL, but the check above would get
355 more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
356/* BEWARE - something that calls this macro passes (r) which has a side
357 effect. */
ede1273d 358#define PM_SETRE(o,r) STMT_START { \
b1bc3f34 359 REGEXP *const _pm_setre = (r); \
7948fc08 360 assert(_pm_setre); \
b1bc3f34 361 PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
ede1273d 362 } STMT_END
1fcf4c12 363#else
b9ed2502
AB
364#define PM_GETRE(o) ((o)->op_pmregexp)
365#define PM_SETRE(o,r) ((o)->op_pmregexp = (r))
1fcf4c12 366#endif
4825b64b 367
beae72ee
KW
368/* Leave some space, so future bit allocations can go either in the shared or
369 * unshared area without affecting binary compatibility */
df7a8460 370#define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+6)
f4a4cecb 371
ef07e810 372/* 'use re "taint"' in scope: taint $1 etc. if target tainted */
1ad4ec54 373#define PMf_RETAINT (1<<(PMf_BASE_SHIFT+0))
c737faaf 374
c0f1c194
KW
375/* match successfully only once per reset, with related flag RXf_USED in
376 * re->extflags holding state. This is used only for ?? matches, and only on
377 * OP_MATCH and OP_QR */
1ad4ec54 378#define PMf_ONCE (1<<(PMf_BASE_SHIFT+1))
1850c8f9
KW
379
380/* replacement contains variables */
1ad4ec54 381#define PMf_MAYBE_CONST (1<<(PMf_BASE_SHIFT+2))
1850c8f9
KW
382
383/* PMf_ONCE has matched successfully. Not used under threading. */
1ad4ec54 384#define PMf_USED (1<<(PMf_BASE_SHIFT+3))
1850c8f9
KW
385
386/* subst replacement is constant */
1ad4ec54 387#define PMf_CONST (1<<(PMf_BASE_SHIFT+4))
c737faaf 388
1850c8f9 389/* keep 1st runtime pattern forever */
1ad4ec54 390#define PMf_KEEP (1<<(PMf_BASE_SHIFT+5))
4da3eb8b 391
1ad4ec54 392#define PMf_GLOBAL (1<<(PMf_BASE_SHIFT+6)) /* pattern had a g modifier */
c737faaf 393
1850c8f9 394/* don't reset pos() if //g fails */
1ad4ec54 395#define PMf_CONTINUE (1<<(PMf_BASE_SHIFT+7))
1850c8f9
KW
396
397/* evaluating replacement as expr */
1ad4ec54 398#define PMf_EVAL (1<<(PMf_BASE_SHIFT+8))
c0f1c194
KW
399
400/* Return substituted string instead of modifying it. */
1ad4ec54 401#define PMf_NONDESTRUCT (1<<(PMf_BASE_SHIFT+9))
e357fc67 402
1ad4ec54 403#if PMf_BASE_SHIFT+9 > 31
32cdcf9d 404# error Too many PMf_ bits used. See above and regnodes.h for any spare in middle
1850c8f9 405#endif
79072805 406
cb55de95 407#ifdef USE_ITHREADS
05ec9bb3 408
29f2e912
NC
409# define PmopSTASHPV(o) \
410 (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstashpv : NULL)
411# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
412# define PmopSTASHPV_set(o,pv) ({ \
413 assert((o)->op_pmflags & PMf_ONCE); \
414 ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv)); \
415 })
416# else
417# define PmopSTASHPV_set(o,pv) \
418 ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv))
419# endif
cb55de95 420# define PmopSTASH(o) (PmopSTASHPV(o) \
29f2e912 421 ? gv_stashpv((o)->op_pmstashstartu.op_pmstashpv,GV_ADD) : NULL)
bd61b366 422# define PmopSTASH_set(o,hv) PmopSTASHPV_set(o, ((hv) ? HvNAME_get(hv) : NULL))
05ec9bb3
NIS
423# define PmopSTASH_free(o) PerlMemShared_free(PmopSTASHPV(o))
424
cb55de95 425#else
29f2e912
NC
426# define PmopSTASH(o) \
427 (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
428# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
429# define PmopSTASH_set(o,hv) ({ \
430 assert((o)->op_pmflags & PMf_ONCE); \
431 ((o)->op_pmstashstartu.op_pmstash = (hv)); \
432 })
433# else
434# define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
435# endif
bd61b366 436# define PmopSTASHPV(o) (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
29f2e912 437 /* op_pmstashstartu.op_pmstash is not refcounted */
cb55de95 438# define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
c4bd3ae5
NC
439/* Note that if this becomes non-empty, then S_forget_pmop in op.c will need
440 changing */
05ec9bb3 441# define PmopSTASH_free(o)
cb55de95
JH
442#endif
443
79072805
LW
444struct svop {
445 BASEOP
446 SV * op_sv;
447};
448
7934575e 449struct padop {
79072805 450 BASEOP
7934575e 451 PADOFFSET op_padix;
79072805
LW
452};
453
454struct pvop {
455 BASEOP
456 char * op_pv;
457};
458
79072805
LW
459struct loop {
460 BASEOP
461 OP * op_first;
462 OP * op_last;
79072805
LW
463 OP * op_redoop;
464 OP * op_nextop;
465 OP * op_lastop;
466};
467
350de78d
GS
468#define cUNOPx(o) ((UNOP*)o)
469#define cBINOPx(o) ((BINOP*)o)
470#define cLISTOPx(o) ((LISTOP*)o)
471#define cLOGOPx(o) ((LOGOP*)o)
472#define cPMOPx(o) ((PMOP*)o)
473#define cSVOPx(o) ((SVOP*)o)
474#define cPADOPx(o) ((PADOP*)o)
475#define cPVOPx(o) ((PVOP*)o)
476#define cCOPx(o) ((COP*)o)
477#define cLOOPx(o) ((LOOP*)o)
478
479#define cUNOP cUNOPx(PL_op)
480#define cBINOP cBINOPx(PL_op)
481#define cLISTOP cLISTOPx(PL_op)
482#define cLOGOP cLOGOPx(PL_op)
483#define cPMOP cPMOPx(PL_op)
484#define cSVOP cSVOPx(PL_op)
485#define cPADOP cPADOPx(PL_op)
486#define cPVOP cPVOPx(PL_op)
487#define cCOP cCOPx(PL_op)
488#define cLOOP cLOOPx(PL_op)
489
490#define cUNOPo cUNOPx(o)
491#define cBINOPo cBINOPx(o)
492#define cLISTOPo cLISTOPx(o)
493#define cLOGOPo cLOGOPx(o)
494#define cPMOPo cPMOPx(o)
495#define cSVOPo cSVOPx(o)
496#define cPADOPo cPADOPx(o)
497#define cPVOPo cPVOPx(o)
498#define cCOPo cCOPx(o)
499#define cLOOPo cLOOPx(o)
500
501#define kUNOP cUNOPx(kid)
502#define kBINOP cBINOPx(kid)
503#define kLISTOP cLISTOPx(kid)
504#define kLOGOP cLOGOPx(kid)
505#define kPMOP cPMOPx(kid)
506#define kSVOP cSVOPx(kid)
507#define kPADOP cPADOPx(kid)
508#define kPVOP cPVOPx(kid)
509#define kCOP cCOPx(kid)
510#define kLOOP cLOOPx(kid)
511
512
513#ifdef USE_ITHREADS
dd2155a4 514# define cGVOPx_gv(o) ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
cecf5685
NC
515# define IS_PADGV(v) (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
516 && GvIN_PAD(v))
7766f137
GS
517# define IS_PADCONST(v) (v && SvREADONLY(v))
518# define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
dd2155a4 519 ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
638eceb6 520# define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
dd2155a4 521 ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
350de78d 522#else
638eceb6 523# define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
743e66e6 524# define IS_PADGV(v) FALSE
7766f137
GS
525# define IS_PADCONST(v) FALSE
526# define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
638eceb6 527# define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
350de78d 528#endif
79072805 529
638eceb6
GS
530#define cGVOP_gv cGVOPx_gv(PL_op)
531#define cGVOPo_gv cGVOPx_gv(o)
532#define kGVOP_gv cGVOPx_gv(kid)
533#define cSVOP_sv cSVOPx_sv(PL_op)
534#define cSVOPo_sv cSVOPx_sv(o)
535#define kSVOP_sv cSVOPx_sv(kid)
7766f137 536
bcabcc50
NC
537#ifndef PERL_CORE
538# define Nullop ((OP*)NULL)
539#endif
79072805 540
91135acb 541/* Lowest byte-and-a-bit of PL_opargs */
a0d0e21e
LW
542#define OA_MARK 1
543#define OA_FOLDCONST 2
544#define OA_RETSCALAR 4
545#define OA_TARGET 8
903fd87c 546#define OA_TARGLEX 16
a0d0e21e
LW
547#define OA_OTHERINT 32
548#define OA_DANGEROUS 64
549#define OA_DEFGV 128
550
db173bac 551/* The next 4 bits encode op class information */
903fd87c 552#define OCSHIFT 8
b162f9ea
IZ
553
554#define OA_CLASS_MASK (15 << OCSHIFT)
555
556#define OA_BASEOP (0 << OCSHIFT)
557#define OA_UNOP (1 << OCSHIFT)
558#define OA_BINOP (2 << OCSHIFT)
559#define OA_LOGOP (3 << OCSHIFT)
1a67a97c
SM
560#define OA_LISTOP (4 << OCSHIFT)
561#define OA_PMOP (5 << OCSHIFT)
562#define OA_SVOP (6 << OCSHIFT)
7934575e 563#define OA_PADOP (7 << OCSHIFT)
1a67a97c
SM
564#define OA_PVOP_OR_SVOP (8 << OCSHIFT)
565#define OA_LOOP (9 << OCSHIFT)
566#define OA_COP (10 << OCSHIFT)
567#define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
568#define OA_FILESTATOP (12 << OCSHIFT)
569#define OA_LOOPEXOP (13 << OCSHIFT)
b162f9ea 570
903fd87c 571#define OASHIFT 12
a0d0e21e 572
4369b173 573/* Remaining nybbles of PL_opargs */
a0d0e21e
LW
574#define OA_SCALAR 1
575#define OA_LIST 2
576#define OA_AVREF 3
577#define OA_HVREF 4
578#define OA_CVREF 5
579#define OA_FILEREF 6
580#define OA_SCALARREF 7
581#define OA_OPTIONAL 8
582
d3c72c2a
DM
583/* Op_REFCNT is a reference count at the head of each op tree: needed
584 * since the tree is shared between threads, and between cloned closure
585 * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
586 * this count.
587 * The same mutex is used to protect the refcounts of the reg_trie_data
588 * and reg_ac_data structures, which are shared between duplicated
589 * regexes.
590 */
591
534825c4
GS
592#ifdef USE_ITHREADS
593# define OP_REFCNT_INIT MUTEX_INIT(&PL_op_mutex)
4026c95a
SH
594# ifdef PERL_CORE
595# define OP_REFCNT_LOCK MUTEX_LOCK(&PL_op_mutex)
596# define OP_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_op_mutex)
597# else
598# define OP_REFCNT_LOCK op_refcnt_lock()
599# define OP_REFCNT_UNLOCK op_refcnt_unlock()
600# endif
534825c4 601# define OP_REFCNT_TERM MUTEX_DESTROY(&PL_op_mutex)
534825c4
GS
602#else
603# define OP_REFCNT_INIT NOOP
604# define OP_REFCNT_LOCK NOOP
605# define OP_REFCNT_UNLOCK NOOP
606# define OP_REFCNT_TERM NOOP
534825c4 607#endif
e4783991 608
282f25c9 609#define OpREFCNT_set(o,n) ((o)->op_targ = (n))
fc97af9c
NC
610#ifdef PERL_DEBUG_READONLY_OPS
611# define OpREFCNT_inc(o) Perl_op_refcnt_inc(aTHX_ o)
612# define OpREFCNT_dec(o) Perl_op_refcnt_dec(aTHX_ o)
613#else
614# define OpREFCNT_inc(o) ((o) ? (++(o)->op_targ, (o)) : NULL)
615# define OpREFCNT_dec(o) (--(o)->op_targ)
616#endif
282f25c9 617
e4783991 618/* flags used by Perl_load_module() */
ec6d81ab
RGS
619#define PERL_LOADMOD_DENY 0x1 /* no Module */
620#define PERL_LOADMOD_NOIMPORT 0x2 /* use Module () */
621#define PERL_LOADMOD_IMPORT_OPS 0x4 /* use Module (...) */
e5dd39fc 622
a0c21aa1 623#if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C)
e4c5ccf3 624#define ref(o, type) doref(o, type, TRUE)
a0c21aa1 625#endif
e4c5ccf3 626
5983a79d
BM
627/*
628=head1 Optree Manipulation Functions
629
630=for apidoc Am|OP*|LINKLIST|OP *o
631Given the root of an optree, link the tree in execution order using the
632C<op_next> pointers and return the first op executed. If this has
633already been done, it will not be redone, and C<< o->op_next >> will be
634returned. If C<< o->op_next >> is not already set, I<o> should be at
635least an C<UNOP>.
636
637=cut
638*/
639
640#define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
641
33f36c71
NC
642/* no longer used anywhere in core */
643#ifndef PERL_CORE
46471bde
NC
644#define cv_ckproto(cv, gv, p) \
645 cv_ckproto_len((cv), (gv), (p), (p) ? strlen(p) : 0)
33f36c71
NC
646#endif
647
7d0905b9
NC
648#ifdef PERL_CORE
649# define my(o) my_attrs((o), NULL)
650#endif
651
e5dd39fc 652#ifdef USE_REENTRANT_API
10bc17b6 653#include "reentr.h"
e5dd39fc
AB
654#endif
655
c7e45529
AE
656#if defined(PL_OP_SLAB_ALLOC)
657#define NewOp(m,var,c,type) \
e91d68d5 658 (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
c7e45529 659#define NewOpSz(m,var,size) \
e91d68d5 660 (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
c7e45529
AE
661#define FreeOp(p) Perl_Slab_Free(aTHX_ p)
662#else
04e62e51
NC
663#define NewOp(m, var, c, type) \
664 (var = (MEM_WRAP_CHECK_(c,type) \
665 (type*)PerlMemShared_calloc(c, sizeof(type))))
113b9ccf 666#define NewOpSz(m, var, size) \
04e62e51
NC
667 (var = (OP*)PerlMemShared_calloc(1, size))
668#define FreeOp(p) PerlMemShared_free(p)
c7e45529 669#endif
598921a7 670
1930840b 671struct block_hooks {
52db365a 672 U32 bhk_flags;
1930840b
BM
673 void (*bhk_start) (pTHX_ int full);
674 void (*bhk_pre_end) (pTHX_ OP **seq);
675 void (*bhk_post_end) (pTHX_ OP **seq);
52db365a 676 void (*bhk_eval) (pTHX_ OP *const saveop);
1930840b
BM
677};
678
fd85fad2
BM
679/*
680=head1 Compile-time scope hooks
681
3e4ddde5 682=for apidoc mx|U32|BhkFLAGS|BHK *hk
fd85fad2
BM
683Return the BHK's flags.
684
3e4ddde5 685=for apidoc mx|void *|BhkENTRY|BHK *hk|which
fd85fad2
BM
686Return an entry from the BHK structure. I<which> is a preprocessor token
687indicating which entry to return. If the appropriate flag is not set
688this will return NULL. The type of the return value depends on which
689entry you ask for.
690
3e4ddde5 691=for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
fd85fad2
BM
692Set an entry in the BHK structure, and set the flags to indicate it is
693valid. I<which> is a preprocessing token indicating which entry to set.
694The type of I<ptr> depends on the entry.
695
3e4ddde5 696=for apidoc Amx|void|BhkDISABLE|BHK *hk|which
a3e07c87
BM
697Temporarily disable an entry in this BHK structure, by clearing the
698appropriate flag. I<which> is a preprocessor token indicating which
699entry to disable.
700
3e4ddde5 701=for apidoc Amx|void|BhkENABLE|BHK *hk|which
a3e07c87
BM
702Re-enable an entry in this BHK structure, by setting the appropriate
703flag. I<which> is a preprocessor token indicating which entry to enable.
704This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
705pointer.
706
3e4ddde5 707=for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
fd85fad2
BM
708Call all the registered block hooks for type I<which>. I<which> is a
709preprocessing token; the type of I<arg> depends on I<which>.
710
711=cut
712*/
713
52db365a
BM
714#define BhkFLAGS(hk) ((hk)->bhk_flags)
715
a88d97bf
BM
716#define BHKf_bhk_start 0x01
717#define BHKf_bhk_pre_end 0x02
718#define BHKf_bhk_post_end 0x04
719#define BHKf_bhk_eval 0x08
52db365a
BM
720
721#define BhkENTRY(hk, which) \
a88d97bf 722 ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
52db365a 723
a3e07c87
BM
724#define BhkENABLE(hk, which) \
725 STMT_START { \
726 BhkFLAGS(hk) |= BHKf_ ## which; \
727 assert(BhkENTRY(hk, which)); \
728 } STMT_END
729
730#define BhkDISABLE(hk, which) \
731 STMT_START { \
732 BhkFLAGS(hk) &= ~(BHKf_ ## which); \
733 } STMT_END
734
52db365a
BM
735#define BhkENTRY_set(hk, which, ptr) \
736 STMT_START { \
a88d97bf 737 (hk)->which = ptr; \
a3e07c87 738 BhkENABLE(hk, which); \
52db365a
BM
739 } STMT_END
740
1930840b
BM
741#define CALL_BLOCK_HOOKS(which, arg) \
742 STMT_START { \
743 if (PL_blockhooks) { \
744 I32 i; \
745 for (i = av_len(PL_blockhooks); i >= 0; i--) { \
746 SV *sv = AvARRAY(PL_blockhooks)[i]; \
52db365a 747 BHK *hk; \
1930840b
BM
748 \
749 assert(SvIOK(sv)); \
750 if (SvUOK(sv)) \
52db365a 751 hk = INT2PTR(BHK *, SvUVX(sv)); \
1930840b 752 else \
52db365a 753 hk = INT2PTR(BHK *, SvIVX(sv)); \
1930840b 754 \
52db365a 755 if (BhkENTRY(hk, which)) \
16c91539 756 BhkENTRY(hk, which)(aTHX_ arg); \
1930840b
BM
757 } \
758 } \
759 } STMT_END
760
d9088386
Z
761/* flags for rv2cv_op_cv */
762
763#define RV2CVOPCV_MARK_EARLY 0x00000001
764#define RV2CVOPCV_RETURN_NAME_GV 0x00000002
765
d3d7d28f
FC
766#define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
767
9733086d
BM
768/*
769=head1 Custom Operators
770
771=for apidoc Am|U32|XopFLAGS|XOP *xop
772Return the XOP's flags.
773
774=for apidoc Am||XopENTRY|XOP *xop|which
775Return a member of the XOP structure. I<which> is a cpp token indicating
776which entry to return. If the member is not set this will return a
777default value. The return type depends on I<which>.
778
779=for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
780Set a member of the XOP structure. I<which> is a cpp token indicating
781which entry to set. See L<perlguts/"Custom Operators"> for details about
782the available members and how they are used.
783
784=for apidoc Am|void|XopDISABLE|XOP *xop|which
785Temporarily disable a member of the XOP, by clearing the appropriate flag.
786
787=for apidoc Am|void|XopENABLE|XOP *xop|which
788Reenable a member of the XOP which has been disabled.
789
790=cut
791*/
792
1830b3d9
BM
793struct custom_op {
794 U32 xop_flags;
795 const char *xop_name;
796 const char *xop_desc;
797 U32 xop_class;
798 void (*xop_peep)(pTHX_ OP *o, OP *oldop);
799};
800
801#define XopFLAGS(xop) ((xop)->xop_flags)
802
803#define XOPf_xop_name 0x01
804#define XOPf_xop_desc 0x02
805#define XOPf_xop_class 0x04
806#define XOPf_xop_peep 0x08
807
808#define XOPd_xop_name PL_op_name[OP_CUSTOM]
809#define XOPd_xop_desc PL_op_desc[OP_CUSTOM]
810#define XOPd_xop_class OA_BASEOP
811#define XOPd_xop_peep ((Perl_cpeep_t)0)
812
813#define XopENTRY_set(xop, which, to) \
814 STMT_START { \
815 (xop)->which = (to); \
816 (xop)->xop_flags |= XOPf_ ## which; \
817 } STMT_END
818
819#define XopENTRY(xop, which) \
820 ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
821
822#define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
823#define XopENABLE(xop, which) \
824 STMT_START { \
825 (xop)->xop_flags |= XOPf_ ## which; \
826 assert(XopENTRY(xop, which)); \
827 } STMT_END
828
9733086d
BM
829/*
830=head1 Optree Manipulation Functions
831
832=for apidoc Am|const char *|OP_NAME|OP *o
833Return the name of the provided OP. For core ops this looks up the name
834from the op_type; for custom ops from the op_ppaddr.
835
836=for apidoc Am|const char *|OP_DESC|OP *o
837Return a short description of the provided OP.
838
839=for apidoc Am|U32|OP_CLASS|OP *o
840Return the class of the provided OP: that is, which of the *OP
841structures it uses. For core ops this currently gets the information out
842of PL_opargs, which does not always accurately reflect the type used.
843For custom ops the type is returned from the registration, and it is up
844to the registree to ensure it is accurate. The value returned will be
845one of the OA_* constants from op.h.
846
847=cut
848*/
849
1830b3d9
BM
850#define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
851 ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_name) \
852 : PL_op_name[(o)->op_type])
853#define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
854 ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_desc) \
855 : PL_op_desc[(o)->op_type])
856#define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
857 ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_class) \
858 : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
859
7bff8c33
NC
860#define newSUB(f, o, p, b) Perl_newATTRSUB(aTHX_ (f), (o), (p), NULL, (b))
861
598921a7
NC
862#ifdef PERL_MAD
863# define MAD_NULL 1
864# define MAD_PV 2
865# define MAD_OP 3
866# define MAD_SV 4
867
868struct madprop {
869 MADPROP* mad_next;
d503a9ba 870 void *mad_val;
598921a7
NC
871 U32 mad_vlen;
872/* short mad_count; */
873 char mad_key;
874 char mad_type;
875};
876
877struct token {
878 I32 tk_type;
879 YYSTYPE tk_lval;
880 MADPROP* tk_mad;
881};
882#endif
2d910ff8
RGS
883
884/*
2b3def87 885 * Values that can be held by mad_key :
2d910ff8
RGS
886 * ^ unfilled head spot
887 * , literal ,
888 * ; literal ; (blank if implicit ; at end of block)
889 * : literal : from ?: or attr list
890 * + unary +
891 * ? literal ? from ?:
892 * ( literal (
893 * ) literal )
894 * [ literal [
895 * ] literal ]
896 * { literal {
897 * } literal }
898 * @ literal @ sigil
899 * $ literal $ sigil
900 * * literal * sigil
901 * ! use is source filtered
902 * & & or sub
903 * # whitespace/comment following ; or }
904 * # $# sigil
905 * 1 1st ; from for(;;)
906 * 1 retired protasis
907 * 2 2nd ; from for(;;)
908 * 2 retired apodosis
909 * 3 C-style for list
910 * a sub or var attributes
911 * a non-method arrow operator
912 * A method arrow operator
913 * A use import args
914 * b format block
915 * B retired stub block
916 * C constant conditional op
917 * d declarator
918 * D do block
919 * e unreached "else" (see C)
920 * e expression producing E
921 * E tr/E/R/, /E/
922 * f folded constant op
923 * F peg op for format
63575281 924 * g op was forced to be a word
2d910ff8
RGS
925 * i if/unless modifier
926 * I if/elsif/unless statement
dde83331 927 * k local declarator
2d910ff8
RGS
928 * K retired kid op
929 * l last index of array ($#foo)
930 * L label
931 * m modifier on regex
2d910ff8
RGS
932 * n sub or format name
933 * o current operator/declarator name
934 * o else/continue
935 * O generic optimized op
936 * p peg to hold extra whitespace at statement level
937 * P peg op for package declaration
938 * q opening quote
939 * = quoted material
940 * Q closing quote
941 * Q optimized qw//
942 * r expression producing R
943 * R tr/E/R/ s/E/R/
2d910ff8
RGS
944 * s sub signature
945 * S use import stub (no import)
946 * S retired sort block
947 * t unreached "then" (see C)
948 * U use import op
949 * v private sv of for loop
950 * V use version
951 * w while/until modifier
952 * W while/for statement
953 * x optimized qw
954 * X random thing
955 * _ whitespace/comments preceding anything else
956 * ~ =~ operator
957 */
3f2908ec
NC
958
959/*
960 * Local variables:
961 * c-indentation-style: bsd
962 * c-basic-offset: 4
963 * indent-tabs-mode: t
964 * End:
965 *
966 * ex: set ts=8 sts=4 sw=4 noet:
967 */