This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
.pm: rename variables to reflect expanded usage
[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) */
486ec47a 133 /* On OP_AELEMFAST, indicates pad var */
6b514a0d 134 /* On OP_REQUIRE, was seen as CORE::require */
0d863452
RH
135 /* On OP_ENTERWHEN, there's no condition */
136 /* On OP_BREAK, an implicit break */
137 /* On OP_SMARTMATCH, an implicit smartmatch */
78c72037
NC
138 /* On OP_ANONHASH and OP_ANONLIST, create a
139 reference to the new anon hash or array */
e91684bf 140 /* On OP_ENTER, store caller context */
9711599e
CS
141 /* On OP_HELEM and OP_HSLICE, localization will be followed
142 by assignment, so do not wipe the target if it is special
143 (e.g. a glob or a magic SV) */
2474a784
FC
144 /* On OP_MATCH, OP_SUBST & OP_TRANS, the
145 operand of a logical or conditional
146 that was optimised away, so it should
147 not be bound via =~ */
6b7c6d95 148 /* On OP_CONST, from a constant CV */
d1bea3d8 149 /* On OP_GLOB, use Perl glob function */
79072805 150
54310121 151/* old names; don't use in new code, but don't break them, either */
d91ab173
GS
152#define OPf_LIST OPf_WANT_LIST
153#define OPf_KNOW OPf_WANT
954c1994 154
54310121 155#define GIMME \
62a559b8
NIS
156 (PL_op->op_flags & OPf_WANT \
157 ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \
d91ab173
GS
158 ? G_ARRAY \
159 : G_SCALAR) \
160 : dowantarray())
54310121 161
51a68671 162/* NOTE: OP_NEXTSTATE and OP_DBSTATE (i.e. COPs) carry lower
d41ff1b8
GS
163 * bits of PL_hints in op_private */
164
a0d0e21e 165/* Private for lvalues */
cd06dffe 166#define OPpLVAL_INTRO 128 /* Lvalue must be localized or lvalue sub */
a0d0e21e 167
7934575e
GS
168/* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
169#define OPpREFCOUNTED 64 /* op_targ carries a refcount */
170
a0d0e21e
LW
171/* Private for OP_AASSIGN */
172#define OPpASSIGN_COMMON 64 /* Left & right have syms in common. */
173
174/* Private for OP_SASSIGN */
175#define OPpASSIGN_BACKWARDS 64 /* Left & right switched. */
e26df76a 176#define OPpASSIGN_CV_TO_GV 128 /* Possible optimisation for constants. */
79072805 177
c90c0ff4
PP
178/* Private for OP_MATCH and OP_SUBST{,CONST} */
179#define OPpRUNTIME 64 /* Pattern coming in on the stack */
180
79072805 181/* Private for OP_TRANS */
4757a243
LW
182#define OPpTRANS_FROM_UTF 1
183#define OPpTRANS_TO_UTF 2
383e7cdd 184#define OPpTRANS_IDENTICAL 4 /* right side is same as left */
4757a243 185#define OPpTRANS_SQUASH 8
59f00321 186 /* 16 is used for OPpTARGET_MY */
4757a243
LW
187#define OPpTRANS_COMPLEMENT 32
188#define OPpTRANS_GROWS 64
59f00321
RGS
189#define OPpTRANS_DELETE 128
190#define OPpTRANS_ALL (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
79072805
LW
191
192/* Private for OP_REPEAT */
a0d0e21e 193#define OPpREPEAT_DOLIST 64 /* List replication. */
79072805 194
cf2dc985 195/* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
314d4778 196#define OPpDEREF (32|64) /* autovivify: Want ref to something: */
5f05dabc
PP
197#define OPpDEREF_AV 32 /* Want ref to AV. */
198#define OPpDEREF_HV 64 /* Want ref to HV. */
199#define OPpDEREF_SV (32|64) /* Want ref to SV. */
0824d667
DM
200/* Private for OP_RV2SV, OP_RV2AV, OP_RV2AV */
201#define OPpDEREFed 4 /* prev op was OPpDEREF */
68dc0745
PP
202 /* OP_ENTERSUB only */
203#define OPpENTERSUB_DB 16 /* Debug subroutine. */
d3011074 204#define OPpENTERSUB_HASTARG 32 /* Called from OP tree. */
3ad73efd 205#define OPpENTERSUB_NOMOD 64 /* Immune to op_lvalue() for :attrlist. */
b900987b 206 /* OP_ENTERSUB and OP_RV2CV only */
68dc0745 207#define OPpENTERSUB_AMPER 8 /* Used & form to call. */
9675f7ac 208#define OPpENTERSUB_NOPAREN 128 /* bare sub call (without parens) */
cd06dffe 209#define OPpENTERSUB_INARGS 4 /* Lval used as arg to a sub. */
76cd736e
GS
210 /* OP_GV only */
211#define OPpEARLY_CV 32 /* foo() called before sub foo was parsed */
68dc0745
PP
212 /* OP_?ELEM only */
213#define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */
241416b8 214 /* OP_RV2?V, OP_GVSV, OP_ENTERITER only */
78f9721b 215#define OPpOUR_INTRO 16 /* Variable was in an our() */
cb0d96b9 216 /* OP_RV2[AGH]V, OP_PAD[AH]V, OP_[AH]ELEM */
78f9721b 217#define OPpMAYBE_LVSUB 8 /* We might be an lvalue to return */
952306ac
RGS
218 /* OP_PADSV only */
219#define OPpPAD_STATE 16 /* is a "state" pad */
192587c2 220 /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
79072805 221
e26df76a 222 /* OP_RV2GV only */
cb0d96b9 223#define OPpDONT_INIT_GV 4 /* Call gv_fetchpv with GV_NOINIT */
e26df76a
NC
224/* (Therefore will return whatever is currently in the symbol table, not
225 guaranteed to be a PVGV) */
226
227 /* OP_RV2CV only */
228#define OPpMAY_RETURN_CONSTANT 1 /* If a constant sub, return the constant */
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 */
9de15fec 370#define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+7)
f4a4cecb 371
1850c8f9 372/* 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
KW
390#define PMf_KEEP (1<<(PMf_BASE_SHIFT+5))
391#define PMf_GLOBAL (1<<(PMf_BASE_SHIFT+6)) /* pattern had a g modifier */
c737faaf 392
1850c8f9 393/* don't reset pos() if //g fails */
1ad4ec54 394#define PMf_CONTINUE (1<<(PMf_BASE_SHIFT+7))
1850c8f9
KW
395
396/* evaluating replacement as expr */
1ad4ec54 397#define PMf_EVAL (1<<(PMf_BASE_SHIFT+8))
c0f1c194
KW
398
399/* Return substituted string instead of modifying it. */
1ad4ec54 400#define PMf_NONDESTRUCT (1<<(PMf_BASE_SHIFT+9))
e357fc67 401
1ad4ec54 402#if PMf_BASE_SHIFT+9 > 31
32cdcf9d 403# error Too many PMf_ bits used. See above and regnodes.h for any spare in middle
1850c8f9 404#endif
79072805 405
cb55de95 406#ifdef USE_ITHREADS
05ec9bb3 407
29f2e912
NC
408# define PmopSTASHPV(o) \
409 (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstashpv : NULL)
410# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
411# define PmopSTASHPV_set(o,pv) ({ \
412 assert((o)->op_pmflags & PMf_ONCE); \
413 ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv)); \
414 })
415# else
416# define PmopSTASHPV_set(o,pv) \
417 ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv))
418# endif
cb55de95 419# define PmopSTASH(o) (PmopSTASHPV(o) \
29f2e912 420 ? gv_stashpv((o)->op_pmstashstartu.op_pmstashpv,GV_ADD) : NULL)
bd61b366 421# define PmopSTASH_set(o,hv) PmopSTASHPV_set(o, ((hv) ? HvNAME_get(hv) : NULL))
05ec9bb3
NIS
422# define PmopSTASH_free(o) PerlMemShared_free(PmopSTASHPV(o))
423
cb55de95 424#else
29f2e912
NC
425# define PmopSTASH(o) \
426 (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
427# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
428# define PmopSTASH_set(o,hv) ({ \
429 assert((o)->op_pmflags & PMf_ONCE); \
430 ((o)->op_pmstashstartu.op_pmstash = (hv)); \
431 })
432# else
433# define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
434# endif
bd61b366 435# define PmopSTASHPV(o) (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
29f2e912 436 /* op_pmstashstartu.op_pmstash is not refcounted */
cb55de95 437# define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
c4bd3ae5
NC
438/* Note that if this becomes non-empty, then S_forget_pmop in op.c will need
439 changing */
05ec9bb3 440# define PmopSTASH_free(o)
cb55de95
JH
441#endif
442
79072805
LW
443struct svop {
444 BASEOP
445 SV * op_sv;
446};
447
7934575e 448struct padop {
79072805 449 BASEOP
7934575e 450 PADOFFSET op_padix;
79072805
LW
451};
452
453struct pvop {
454 BASEOP
455 char * op_pv;
456};
457
79072805
LW
458struct loop {
459 BASEOP
460 OP * op_first;
461 OP * op_last;
79072805
LW
462 OP * op_redoop;
463 OP * op_nextop;
464 OP * op_lastop;
465};
466
350de78d
GS
467#define cUNOPx(o) ((UNOP*)o)
468#define cBINOPx(o) ((BINOP*)o)
469#define cLISTOPx(o) ((LISTOP*)o)
470#define cLOGOPx(o) ((LOGOP*)o)
471#define cPMOPx(o) ((PMOP*)o)
472#define cSVOPx(o) ((SVOP*)o)
473#define cPADOPx(o) ((PADOP*)o)
474#define cPVOPx(o) ((PVOP*)o)
475#define cCOPx(o) ((COP*)o)
476#define cLOOPx(o) ((LOOP*)o)
477
478#define cUNOP cUNOPx(PL_op)
479#define cBINOP cBINOPx(PL_op)
480#define cLISTOP cLISTOPx(PL_op)
481#define cLOGOP cLOGOPx(PL_op)
482#define cPMOP cPMOPx(PL_op)
483#define cSVOP cSVOPx(PL_op)
484#define cPADOP cPADOPx(PL_op)
485#define cPVOP cPVOPx(PL_op)
486#define cCOP cCOPx(PL_op)
487#define cLOOP cLOOPx(PL_op)
488
489#define cUNOPo cUNOPx(o)
490#define cBINOPo cBINOPx(o)
491#define cLISTOPo cLISTOPx(o)
492#define cLOGOPo cLOGOPx(o)
493#define cPMOPo cPMOPx(o)
494#define cSVOPo cSVOPx(o)
495#define cPADOPo cPADOPx(o)
496#define cPVOPo cPVOPx(o)
497#define cCOPo cCOPx(o)
498#define cLOOPo cLOOPx(o)
499
500#define kUNOP cUNOPx(kid)
501#define kBINOP cBINOPx(kid)
502#define kLISTOP cLISTOPx(kid)
503#define kLOGOP cLOGOPx(kid)
504#define kPMOP cPMOPx(kid)
505#define kSVOP cSVOPx(kid)
506#define kPADOP cPADOPx(kid)
507#define kPVOP cPVOPx(kid)
508#define kCOP cCOPx(kid)
509#define kLOOP cLOOPx(kid)
510
511
512#ifdef USE_ITHREADS
dd2155a4 513# define cGVOPx_gv(o) ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
cecf5685
NC
514# define IS_PADGV(v) (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
515 && GvIN_PAD(v))
7766f137
GS
516# define IS_PADCONST(v) (v && SvREADONLY(v))
517# define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
dd2155a4 518 ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
638eceb6 519# define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
dd2155a4 520 ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
350de78d 521#else
638eceb6 522# define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
743e66e6 523# define IS_PADGV(v) FALSE
7766f137
GS
524# define IS_PADCONST(v) FALSE
525# define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
638eceb6 526# define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
350de78d 527#endif
79072805 528
638eceb6
GS
529#define cGVOP_gv cGVOPx_gv(PL_op)
530#define cGVOPo_gv cGVOPx_gv(o)
531#define kGVOP_gv cGVOPx_gv(kid)
532#define cSVOP_sv cSVOPx_sv(PL_op)
533#define cSVOPo_sv cSVOPx_sv(o)
534#define kSVOP_sv cSVOPx_sv(kid)
7766f137 535
bcabcc50
NC
536#ifndef PERL_CORE
537# define Nullop ((OP*)NULL)
538#endif
79072805 539
91135acb 540/* Lowest byte-and-a-bit of PL_opargs */
a0d0e21e
LW
541#define OA_MARK 1
542#define OA_FOLDCONST 2
543#define OA_RETSCALAR 4
544#define OA_TARGET 8
903fd87c 545#define OA_TARGLEX 16
a0d0e21e
LW
546#define OA_OTHERINT 32
547#define OA_DANGEROUS 64
548#define OA_DEFGV 128
549
db173bac 550/* The next 4 bits encode op class information */
903fd87c 551#define OCSHIFT 8
b162f9ea
IZ
552
553#define OA_CLASS_MASK (15 << OCSHIFT)
554
555#define OA_BASEOP (0 << OCSHIFT)
556#define OA_UNOP (1 << OCSHIFT)
557#define OA_BINOP (2 << OCSHIFT)
558#define OA_LOGOP (3 << OCSHIFT)
1a67a97c
SM
559#define OA_LISTOP (4 << OCSHIFT)
560#define OA_PMOP (5 << OCSHIFT)
561#define OA_SVOP (6 << OCSHIFT)
7934575e 562#define OA_PADOP (7 << OCSHIFT)
1a67a97c
SM
563#define OA_PVOP_OR_SVOP (8 << OCSHIFT)
564#define OA_LOOP (9 << OCSHIFT)
565#define OA_COP (10 << OCSHIFT)
566#define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
567#define OA_FILESTATOP (12 << OCSHIFT)
568#define OA_LOOPEXOP (13 << OCSHIFT)
b162f9ea 569
903fd87c 570#define OASHIFT 12
a0d0e21e 571
4369b173 572/* Remaining nybbles of PL_opargs */
a0d0e21e
LW
573#define OA_SCALAR 1
574#define OA_LIST 2
575#define OA_AVREF 3
576#define OA_HVREF 4
577#define OA_CVREF 5
578#define OA_FILEREF 6
579#define OA_SCALARREF 7
580#define OA_OPTIONAL 8
581
d3c72c2a
DM
582/* Op_REFCNT is a reference count at the head of each op tree: needed
583 * since the tree is shared between threads, and between cloned closure
584 * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
585 * this count.
586 * The same mutex is used to protect the refcounts of the reg_trie_data
587 * and reg_ac_data structures, which are shared between duplicated
588 * regexes.
589 */
590
534825c4
GS
591#ifdef USE_ITHREADS
592# define OP_REFCNT_INIT MUTEX_INIT(&PL_op_mutex)
4026c95a
SH
593# ifdef PERL_CORE
594# define OP_REFCNT_LOCK MUTEX_LOCK(&PL_op_mutex)
595# define OP_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_op_mutex)
596# else
597# define OP_REFCNT_LOCK op_refcnt_lock()
598# define OP_REFCNT_UNLOCK op_refcnt_unlock()
599# endif
534825c4 600# define OP_REFCNT_TERM MUTEX_DESTROY(&PL_op_mutex)
534825c4
GS
601#else
602# define OP_REFCNT_INIT NOOP
603# define OP_REFCNT_LOCK NOOP
604# define OP_REFCNT_UNLOCK NOOP
605# define OP_REFCNT_TERM NOOP
534825c4 606#endif
e4783991 607
282f25c9 608#define OpREFCNT_set(o,n) ((o)->op_targ = (n))
fc97af9c
NC
609#ifdef PERL_DEBUG_READONLY_OPS
610# define OpREFCNT_inc(o) Perl_op_refcnt_inc(aTHX_ o)
611# define OpREFCNT_dec(o) Perl_op_refcnt_dec(aTHX_ o)
612#else
613# define OpREFCNT_inc(o) ((o) ? (++(o)->op_targ, (o)) : NULL)
614# define OpREFCNT_dec(o) (--(o)->op_targ)
615#endif
282f25c9 616
e4783991 617/* flags used by Perl_load_module() */
ec6d81ab
RGS
618#define PERL_LOADMOD_DENY 0x1 /* no Module */
619#define PERL_LOADMOD_NOIMPORT 0x2 /* use Module () */
620#define PERL_LOADMOD_IMPORT_OPS 0x4 /* use Module (...) */
e5dd39fc 621
a0c21aa1 622#if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C)
e4c5ccf3 623#define ref(o, type) doref(o, type, TRUE)
a0c21aa1 624#endif
e4c5ccf3 625
5983a79d
BM
626/*
627=head1 Optree Manipulation Functions
628
629=for apidoc Am|OP*|LINKLIST|OP *o
630Given the root of an optree, link the tree in execution order using the
631C<op_next> pointers and return the first op executed. If this has
632already been done, it will not be redone, and C<< o->op_next >> will be
633returned. If C<< o->op_next >> is not already set, I<o> should be at
634least an C<UNOP>.
635
636=cut
637*/
638
639#define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
640
33f36c71
NC
641/* no longer used anywhere in core */
642#ifndef PERL_CORE
46471bde
NC
643#define cv_ckproto(cv, gv, p) \
644 cv_ckproto_len((cv), (gv), (p), (p) ? strlen(p) : 0)
33f36c71
NC
645#endif
646
7d0905b9
NC
647#ifdef PERL_CORE
648# define my(o) my_attrs((o), NULL)
649#endif
650
e5dd39fc 651#ifdef USE_REENTRANT_API
10bc17b6 652#include "reentr.h"
e5dd39fc
AB
653#endif
654
c7e45529
AE
655#if defined(PL_OP_SLAB_ALLOC)
656#define NewOp(m,var,c,type) \
e91d68d5 657 (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
c7e45529 658#define NewOpSz(m,var,size) \
e91d68d5 659 (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
c7e45529
AE
660#define FreeOp(p) Perl_Slab_Free(aTHX_ p)
661#else
04e62e51
NC
662#define NewOp(m, var, c, type) \
663 (var = (MEM_WRAP_CHECK_(c,type) \
664 (type*)PerlMemShared_calloc(c, sizeof(type))))
113b9ccf 665#define NewOpSz(m, var, size) \
04e62e51
NC
666 (var = (OP*)PerlMemShared_calloc(1, size))
667#define FreeOp(p) PerlMemShared_free(p)
c7e45529 668#endif
598921a7 669
1930840b 670struct block_hooks {
52db365a 671 U32 bhk_flags;
1930840b
BM
672 void (*bhk_start) (pTHX_ int full);
673 void (*bhk_pre_end) (pTHX_ OP **seq);
674 void (*bhk_post_end) (pTHX_ OP **seq);
52db365a 675 void (*bhk_eval) (pTHX_ OP *const saveop);
1930840b
BM
676};
677
fd85fad2
BM
678/*
679=head1 Compile-time scope hooks
680
3e4ddde5 681=for apidoc mx|U32|BhkFLAGS|BHK *hk
fd85fad2
BM
682Return the BHK's flags.
683
3e4ddde5 684=for apidoc mx|void *|BhkENTRY|BHK *hk|which
fd85fad2
BM
685Return an entry from the BHK structure. I<which> is a preprocessor token
686indicating which entry to return. If the appropriate flag is not set
687this will return NULL. The type of the return value depends on which
688entry you ask for.
689
3e4ddde5 690=for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
fd85fad2
BM
691Set an entry in the BHK structure, and set the flags to indicate it is
692valid. I<which> is a preprocessing token indicating which entry to set.
693The type of I<ptr> depends on the entry.
694
3e4ddde5 695=for apidoc Amx|void|BhkDISABLE|BHK *hk|which
a3e07c87
BM
696Temporarily disable an entry in this BHK structure, by clearing the
697appropriate flag. I<which> is a preprocessor token indicating which
698entry to disable.
699
3e4ddde5 700=for apidoc Amx|void|BhkENABLE|BHK *hk|which
a3e07c87
BM
701Re-enable an entry in this BHK structure, by setting the appropriate
702flag. I<which> is a preprocessor token indicating which entry to enable.
703This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
704pointer.
705
3e4ddde5 706=for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
fd85fad2
BM
707Call all the registered block hooks for type I<which>. I<which> is a
708preprocessing token; the type of I<arg> depends on I<which>.
709
710=cut
711*/
712
52db365a
BM
713#define BhkFLAGS(hk) ((hk)->bhk_flags)
714
a88d97bf
BM
715#define BHKf_bhk_start 0x01
716#define BHKf_bhk_pre_end 0x02
717#define BHKf_bhk_post_end 0x04
718#define BHKf_bhk_eval 0x08
52db365a
BM
719
720#define BhkENTRY(hk, which) \
a88d97bf 721 ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
52db365a 722
a3e07c87
BM
723#define BhkENABLE(hk, which) \
724 STMT_START { \
725 BhkFLAGS(hk) |= BHKf_ ## which; \
726 assert(BhkENTRY(hk, which)); \
727 } STMT_END
728
729#define BhkDISABLE(hk, which) \
730 STMT_START { \
731 BhkFLAGS(hk) &= ~(BHKf_ ## which); \
732 } STMT_END
733
52db365a
BM
734#define BhkENTRY_set(hk, which, ptr) \
735 STMT_START { \
a88d97bf 736 (hk)->which = ptr; \
a3e07c87 737 BhkENABLE(hk, which); \
52db365a
BM
738 } STMT_END
739
1930840b
BM
740#define CALL_BLOCK_HOOKS(which, arg) \
741 STMT_START { \
742 if (PL_blockhooks) { \
743 I32 i; \
744 for (i = av_len(PL_blockhooks); i >= 0; i--) { \
745 SV *sv = AvARRAY(PL_blockhooks)[i]; \
52db365a 746 BHK *hk; \
1930840b
BM
747 \
748 assert(SvIOK(sv)); \
749 if (SvUOK(sv)) \
52db365a 750 hk = INT2PTR(BHK *, SvUVX(sv)); \
1930840b 751 else \
52db365a 752 hk = INT2PTR(BHK *, SvIVX(sv)); \
1930840b 753 \
52db365a 754 if (BhkENTRY(hk, which)) \
16c91539 755 BhkENTRY(hk, which)(aTHX_ arg); \
1930840b
BM
756 } \
757 } \
758 } STMT_END
759
d9088386
Z
760/* flags for rv2cv_op_cv */
761
762#define RV2CVOPCV_MARK_EARLY 0x00000001
763#define RV2CVOPCV_RETURN_NAME_GV 0x00000002
764
9733086d
BM
765/*
766=head1 Custom Operators
767
768=for apidoc Am|U32|XopFLAGS|XOP *xop
769Return the XOP's flags.
770
771=for apidoc Am||XopENTRY|XOP *xop|which
772Return a member of the XOP structure. I<which> is a cpp token indicating
773which entry to return. If the member is not set this will return a
774default value. The return type depends on I<which>.
775
776=for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
777Set a member of the XOP structure. I<which> is a cpp token indicating
778which entry to set. See L<perlguts/"Custom Operators"> for details about
779the available members and how they are used.
780
781=for apidoc Am|void|XopDISABLE|XOP *xop|which
782Temporarily disable a member of the XOP, by clearing the appropriate flag.
783
784=for apidoc Am|void|XopENABLE|XOP *xop|which
785Reenable a member of the XOP which has been disabled.
786
787=cut
788*/
789
1830b3d9
BM
790struct custom_op {
791 U32 xop_flags;
792 const char *xop_name;
793 const char *xop_desc;
794 U32 xop_class;
795 void (*xop_peep)(pTHX_ OP *o, OP *oldop);
796};
797
798#define XopFLAGS(xop) ((xop)->xop_flags)
799
800#define XOPf_xop_name 0x01
801#define XOPf_xop_desc 0x02
802#define XOPf_xop_class 0x04
803#define XOPf_xop_peep 0x08
804
805#define XOPd_xop_name PL_op_name[OP_CUSTOM]
806#define XOPd_xop_desc PL_op_desc[OP_CUSTOM]
807#define XOPd_xop_class OA_BASEOP
808#define XOPd_xop_peep ((Perl_cpeep_t)0)
809
810#define XopENTRY_set(xop, which, to) \
811 STMT_START { \
812 (xop)->which = (to); \
813 (xop)->xop_flags |= XOPf_ ## which; \
814 } STMT_END
815
816#define XopENTRY(xop, which) \
817 ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
818
819#define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
820#define XopENABLE(xop, which) \
821 STMT_START { \
822 (xop)->xop_flags |= XOPf_ ## which; \
823 assert(XopENTRY(xop, which)); \
824 } STMT_END
825
9733086d
BM
826/*
827=head1 Optree Manipulation Functions
828
829=for apidoc Am|const char *|OP_NAME|OP *o
830Return the name of the provided OP. For core ops this looks up the name
831from the op_type; for custom ops from the op_ppaddr.
832
833=for apidoc Am|const char *|OP_DESC|OP *o
834Return a short description of the provided OP.
835
836=for apidoc Am|U32|OP_CLASS|OP *o
837Return the class of the provided OP: that is, which of the *OP
838structures it uses. For core ops this currently gets the information out
839of PL_opargs, which does not always accurately reflect the type used.
840For custom ops the type is returned from the registration, and it is up
841to the registree to ensure it is accurate. The value returned will be
842one of the OA_* constants from op.h.
843
844=cut
845*/
846
1830b3d9
BM
847#define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
848 ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_name) \
849 : PL_op_name[(o)->op_type])
850#define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
851 ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_desc) \
852 : PL_op_desc[(o)->op_type])
853#define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
854 ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_class) \
855 : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
856
7bff8c33
NC
857#define newSUB(f, o, p, b) Perl_newATTRSUB(aTHX_ (f), (o), (p), NULL, (b))
858
598921a7
NC
859#ifdef PERL_MAD
860# define MAD_NULL 1
861# define MAD_PV 2
862# define MAD_OP 3
863# define MAD_SV 4
864
865struct madprop {
866 MADPROP* mad_next;
d503a9ba 867 void *mad_val;
598921a7
NC
868 U32 mad_vlen;
869/* short mad_count; */
870 char mad_key;
871 char mad_type;
872};
873
874struct token {
875 I32 tk_type;
876 YYSTYPE tk_lval;
877 MADPROP* tk_mad;
878};
879#endif
2d910ff8
RGS
880
881/*
2b3def87 882 * Values that can be held by mad_key :
2d910ff8
RGS
883 * ^ unfilled head spot
884 * , literal ,
885 * ; literal ; (blank if implicit ; at end of block)
886 * : literal : from ?: or attr list
887 * + unary +
888 * ? literal ? from ?:
889 * ( literal (
890 * ) literal )
891 * [ literal [
892 * ] literal ]
893 * { literal {
894 * } literal }
895 * @ literal @ sigil
896 * $ literal $ sigil
897 * * literal * sigil
898 * ! use is source filtered
899 * & & or sub
900 * # whitespace/comment following ; or }
901 * # $# sigil
902 * 1 1st ; from for(;;)
903 * 1 retired protasis
904 * 2 2nd ; from for(;;)
905 * 2 retired apodosis
906 * 3 C-style for list
907 * a sub or var attributes
908 * a non-method arrow operator
909 * A method arrow operator
910 * A use import args
911 * b format block
912 * B retired stub block
913 * C constant conditional op
914 * d declarator
915 * D do block
916 * e unreached "else" (see C)
917 * e expression producing E
918 * E tr/E/R/, /E/
919 * f folded constant op
920 * F peg op for format
63575281 921 * g op was forced to be a word
2d910ff8
RGS
922 * i if/unless modifier
923 * I if/elsif/unless statement
dde83331 924 * k local declarator
2d910ff8
RGS
925 * K retired kid op
926 * l last index of array ($#foo)
927 * L label
928 * m modifier on regex
2d910ff8
RGS
929 * n sub or format name
930 * o current operator/declarator name
931 * o else/continue
932 * O generic optimized op
933 * p peg to hold extra whitespace at statement level
934 * P peg op for package declaration
935 * q opening quote
936 * = quoted material
937 * Q closing quote
938 * Q optimized qw//
939 * r expression producing R
940 * R tr/E/R/ s/E/R/
2d910ff8
RGS
941 * s sub signature
942 * S use import stub (no import)
943 * S retired sort block
944 * t unreached "then" (see C)
945 * U use import op
946 * v private sv of for loop
947 * V use version
948 * w while/until modifier
949 * W while/for statement
950 * x optimized qw
951 * X random thing
952 * _ whitespace/comments preceding anything else
953 * ~ =~ operator
954 */
3f2908ec
NC
955
956/*
957 * Local variables:
958 * c-indentation-style: bsd
959 * c-basic-offset: 4
960 * indent-tabs-mode: t
961 * End:
962 *
963 * ex: set ts=8 sts=4 sw=4 noet:
964 */