This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Introduce macro PERL_MAX_SUB_DEPTH
[perl5.git] / op.h
CommitLineData
a0d0e21e 1/* op.h
79072805 2 *
4bb101f2 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
663f364b 4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 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 */
39
79072805 40#define OPCODE U16
79072805 41
598921a7
NC
42#ifdef PERL_MAD
43# define MADPROP_IN_BASEOP MADPROP* op_madprop;
44#else
45# define MADPROP_IN_BASEOP
46#endif
47
0f4eea8f
DL
48#ifdef BASEOP_DEFINITION
49#define BASEOP BASEOP_DEFINITION
50#else
79072805
LW
51#define BASEOP \
52 OP* op_next; \
53 OP* op_sibling; \
4f63d024 54 OP* (CPERLscope(*op_ppaddr))(pTHX); \
598921a7 55 MADPROP_IN_BASEOP \
79072805 56 PADOFFSET op_targ; \
e57fbd1f 57 unsigned op_type:9; \
2814eb74 58 unsigned op_opt:1; \
670f3923
DM
59 unsigned op_latefree:1; \
60 unsigned op_latefreed:1; \
7e5d8ed2 61 unsigned op_attached:1; \
85594c31 62 unsigned op_spare:3; \
a0d0e21e
LW
63 U8 op_flags; \
64 U8 op_private;
0f4eea8f 65#endif
79072805 66
54310121
PP
67#define OP_GIMME(op,dfl) \
68 (((op)->op_flags & OPf_WANT) == OPf_WANT_VOID ? G_VOID : \
69 ((op)->op_flags & OPf_WANT) == OPf_WANT_SCALAR ? G_SCALAR : \
70 ((op)->op_flags & OPf_WANT) == OPf_WANT_LIST ? G_ARRAY : \
71 dfl)
72
954c1994 73/*
ccfc67b7
JH
74=head1 "Gimme" Values
75
954c1994
GS
76=for apidoc Amn|U32|GIMME_V
77The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
91e74348 78C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
954c1994
GS
79respectively.
80
81=for apidoc Amn|U32|GIMME
82A backward-compatible version of C<GIMME_V> which can only return
83C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
84Deprecated. Use C<GIMME_V> instead.
85
86=cut
87*/
88
533c011a 89#define GIMME_V OP_GIMME(PL_op, block_gimme())
79072805
LW
90
91/* Public flags */
54310121
PP
92
93#define OPf_WANT 3 /* Mask for "want" bits: */
94#define OPf_WANT_VOID 1 /* Want nothing */
95#define OPf_WANT_SCALAR 2 /* Want single value */
96#define OPf_WANT_LIST 3 /* Want list of any length */
79072805
LW
97#define OPf_KIDS 4 /* There is a firstborn child. */
98#define OPf_PARENS 8 /* This operator was parenthesized. */
463ee0b2 99 /* (Or block needs explicit scope entry.) */
a0d0e21e
LW
100#define OPf_REF 16 /* Certified reference. */
101 /* (Return container, not containee). */
102#define OPf_MOD 32 /* Will modify (lvalue). */
103#define OPf_STACKED 64 /* Some arg is arriving on the stack. */
79072805
LW
104#define OPf_SPECIAL 128 /* Do something weird for this op: */
105 /* On local LVAL, don't init local value. */
0282be92
RGS
106 /* On OP_CONST, value is the hints hash for
107 eval, so return a copy from pp_const() */
79072805
LW
108 /* On OP_SORT, subroutine is inlined. */
109 /* On OP_NOT, inversion was implicit. */
a0d0e21e 110 /* On OP_LEAVE, don't restore curpm. */
79072805
LW
111 /* On truncate, we truncate filehandle */
112 /* On control verbs, we saw no label */
113 /* On flipflop, we saw ... instead of .. */
114 /* On UNOPs, saw bare parens, e.g. eof(). */
a0d0e21e 115 /* On OP_ENTERSUB || OP_NULL, saw a "do". */
afebc493 116 /* On OP_EXISTS, treat av as av, not avhv. */
f2ec2afd 117 /* On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
54b9620d 118 /* On OP_ENTERITER, loop var is per-thread */
0ac6acae 119 /* On pushre, rx is used as part of split, e.g. split " " */
497711e7 120 /* On regcomp, "use re 'eval'" was in scope */
7c6fadd6 121 /* On OP_READLINE, was <$filehandle> */
17fda545
NC
122 /* On RV2[ACGHS]V, don't create GV--in
123 defined()*/
5df8de69
DM
124 /* On OP_DBSTATE, indicates breakpoint
125 * (runtime property) */
6a077020 126 /* On OP_AELEMFAST, indiciates pad var */
6b514a0d 127 /* On OP_REQUIRE, was seen as CORE::require */
0d863452
RH
128 /* On OP_ENTERWHEN, there's no condition */
129 /* On OP_BREAK, an implicit break */
130 /* On OP_SMARTMATCH, an implicit smartmatch */
78c72037
NC
131 /* On OP_ANONHASH and OP_ANONLIST, create a
132 reference to the new anon hash or array */
79072805 133
54310121 134/* old names; don't use in new code, but don't break them, either */
d91ab173
GS
135#define OPf_LIST OPf_WANT_LIST
136#define OPf_KNOW OPf_WANT
954c1994 137
54310121 138#define GIMME \
62a559b8
NIS
139 (PL_op->op_flags & OPf_WANT \
140 ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \
d91ab173
GS
141 ? G_ARRAY \
142 : G_SCALAR) \
143 : dowantarray())
54310121 144
d41ff1b8
GS
145/* NOTE: OP_NEXTSTATE, OP_DBSTATE, and OP_SETSTATE (i.e. COPs) carry lower
146 * bits of PL_hints in op_private */
147
a0d0e21e 148/* Private for lvalues */
cd06dffe 149#define OPpLVAL_INTRO 128 /* Lvalue must be localized or lvalue sub */
a0d0e21e 150
7934575e
GS
151/* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
152#define OPpREFCOUNTED 64 /* op_targ carries a refcount */
153
a0d0e21e
LW
154/* Private for OP_AASSIGN */
155#define OPpASSIGN_COMMON 64 /* Left & right have syms in common. */
156
157/* Private for OP_SASSIGN */
158#define OPpASSIGN_BACKWARDS 64 /* Left & right switched. */
e26df76a 159#define OPpASSIGN_CV_TO_GV 128 /* Possible optimisation for constants. */
79072805 160
c90c0ff4
PP
161/* Private for OP_MATCH and OP_SUBST{,CONST} */
162#define OPpRUNTIME 64 /* Pattern coming in on the stack */
163
79072805 164/* Private for OP_TRANS */
4757a243
LW
165#define OPpTRANS_FROM_UTF 1
166#define OPpTRANS_TO_UTF 2
383e7cdd 167#define OPpTRANS_IDENTICAL 4 /* right side is same as left */
4757a243 168#define OPpTRANS_SQUASH 8
59f00321 169 /* 16 is used for OPpTARGET_MY */
4757a243
LW
170#define OPpTRANS_COMPLEMENT 32
171#define OPpTRANS_GROWS 64
59f00321
RGS
172#define OPpTRANS_DELETE 128
173#define OPpTRANS_ALL (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
79072805
LW
174
175/* Private for OP_REPEAT */
a0d0e21e 176#define OPpREPEAT_DOLIST 64 /* List replication. */
79072805 177
cf2dc985 178/* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
314d4778 179#define OPpDEREF (32|64) /* autovivify: Want ref to something: */
5f05dabc
PP
180#define OPpDEREF_AV 32 /* Want ref to AV. */
181#define OPpDEREF_HV 64 /* Want ref to HV. */
182#define OPpDEREF_SV (32|64) /* Want ref to SV. */
68dc0745
PP
183 /* OP_ENTERSUB only */
184#define OPpENTERSUB_DB 16 /* Debug subroutine. */
d3011074 185#define OPpENTERSUB_HASTARG 32 /* Called from OP tree. */
95f0a2f1 186#define OPpENTERSUB_NOMOD 64 /* Immune to mod() for :attrlist. */
7a52d87a 187 /* OP_RV2CV only */
68dc0745 188#define OPpENTERSUB_AMPER 8 /* Used & form to call. */
9675f7ac 189#define OPpENTERSUB_NOPAREN 128 /* bare sub call (without parens) */
cd06dffe 190#define OPpENTERSUB_INARGS 4 /* Lval used as arg to a sub. */
76cd736e
GS
191 /* OP_GV only */
192#define OPpEARLY_CV 32 /* foo() called before sub foo was parsed */
68dc0745
PP
193 /* OP_?ELEM only */
194#define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */
241416b8 195 /* OP_RV2?V, OP_GVSV, OP_ENTERITER only */
78f9721b 196#define OPpOUR_INTRO 16 /* Variable was in an our() */
cb0d96b9 197 /* OP_RV2[AGH]V, OP_PAD[AH]V, OP_[AH]ELEM */
78f9721b 198#define OPpMAYBE_LVSUB 8 /* We might be an lvalue to return */
952306ac
RGS
199 /* OP_PADSV only */
200#define OPpPAD_STATE 16 /* is a "state" pad */
192587c2 201 /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
79072805 202
e26df76a 203 /* OP_RV2GV only */
cb0d96b9 204#define OPpDONT_INIT_GV 4 /* Call gv_fetchpv with GV_NOINIT */
e26df76a
NC
205/* (Therefore will return whatever is currently in the symbol table, not
206 guaranteed to be a PVGV) */
207
208 /* OP_RV2CV only */
209#define OPpMAY_RETURN_CONSTANT 1 /* If a constant sub, return the constant */
210
b162f9ea
IZ
211/* Private for OPs with TARGLEX */
212 /* (lower bits may carry MAXARG) */
213#define OPpTARGET_MY 16 /* Target is PADMY. */
214
ef3e5ea9
NC
215/* Private for OP_ENTERITER and OP_ITER */
216#define OPpITER_REVERSED 4 /* for (reverse ...) */
0d863452 217#define OPpITER_DEF 8 /* for $_ or for my $_ */
ef3e5ea9 218
79072805 219/* Private for OP_CONST */
468aa647 220#define OPpCONST_NOVER 2 /* no 6; */
e7fec78e 221#define OPpCONST_SHORTCIRCUIT 4 /* eg the constant 5 in (5 || foo) */
7a52d87a 222#define OPpCONST_STRICT 8 /* bearword subject to strict 'subs' */
748a9306
LW
223#define OPpCONST_ENTERED 16 /* Has been entered as symbol. */
224#define OPpCONST_ARYBASE 32 /* Was a $[ translated to constant. */
a0d0e21e 225#define OPpCONST_BARE 64 /* Was a bare word (filehandle?). */
599cee73 226#define OPpCONST_WARNING 128 /* Was a $^W translated to constant. */
79072805
LW
227
228/* Private for OP_FLIP/FLOP */
a0d0e21e 229#define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */
79072805 230
ed6116ce 231/* Private for OP_LIST */
a0d0e21e
LW
232#define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */
233
5f05dabc 234/* Private for OP_DELETE */
54310121 235#define OPpSLICE 64 /* Operating on a list of keys */
5f05dabc 236
afebc493
GS
237/* Private for OP_EXISTS */
238#define OPpEXISTS_SUB 64 /* Checking for &sub, not {} or []. */
239
9c007264
JH
240/* Private for OP_SORT */
241#define OPpSORT_NUMERIC 1 /* Optimized away { $a <=> $b } */
242#define OPpSORT_INTEGER 2 /* Ditto while under "use integer" */
eb209983 243#define OPpSORT_REVERSE 4 /* Reversed sort */
fe1bc4cf 244#define OPpSORT_INPLACE 8 /* sort in-place; eg @a = sort @a */
eb209983 245#define OPpSORT_DESCEND 16 /* Descending sort */
7b9ef140
RH
246#define OPpSORT_QSORT 32 /* Use quicksort (not mergesort) */
247#define OPpSORT_STABLE 64 /* Use a stable algorithm */
248
16fe6d59
GS
249/* Private for OP_OPEN and OP_BACKTICK */
250#define OPpOPEN_IN_RAW 16 /* binmode(F,":raw") on input fh */
251#define OPpOPEN_IN_CRLF 32 /* binmode(F,":crlf") on input fh */
252#define OPpOPEN_OUT_RAW 64 /* binmode(F,":raw") on output fh */
253#define OPpOPEN_OUT_CRLF 128 /* binmode(F,":crlf") on output fh */
254
96e176bf
CL
255/* Private for OP_EXIT, HUSH also for OP_DIE */
256#define OPpHUSH_VMSISH 64 /* hush DCL exit msg vmsish mode*/
d98f61e7
GS
257#define OPpEXIT_VMSISH 128 /* exit(0) vs. exit(1) vmsish mode*/
258
0d863452 259/* Private for OP_FTXXX */
1af34c76 260#define OPpFT_ACCESS 2 /* use filetest 'access' */
fbb0b3b3 261#define OPpFT_STACKED 4 /* stacked filetest, as in "-f -x $f" */
1af34c76
JH
262#define OP_IS_FILETEST_ACCESS(op) \
263 (((op)->op_type) == OP_FTRREAD || \
264 ((op)->op_type) == OP_FTRWRITE || \
265 ((op)->op_type) == OP_FTREXEC || \
266 ((op)->op_type) == OP_FTEREAD || \
267 ((op)->op_type) == OP_FTEWRITE || \
268 ((op)->op_type) == OP_FTEEXEC)
269
59f00321
RGS
270/* Private for OP_(MAP|GREP)(WHILE|START) */
271#define OPpGREP_LEX 2 /* iterate over lexical $_ */
272
0d863452
RH
273/* Private for OP_ENTEREVAL */
274#define OPpEVAL_HAS_HH 2 /* Does it have a copy of %^H */
275
79072805
LW
276struct op {
277 BASEOP
278};
279
280struct unop {
281 BASEOP
282 OP * op_first;
283};
284
285struct binop {
286 BASEOP
287 OP * op_first;
288 OP * op_last;
289};
290
291struct logop {
292 BASEOP
293 OP * op_first;
294 OP * op_other;
295};
296
79072805
LW
297struct listop {
298 BASEOP
299 OP * op_first;
300 OP * op_last;
79072805
LW
301};
302
303struct pmop {
304 BASEOP
305 OP * op_first;
306 OP * op_last;
1fcf4c12 307#ifdef USE_ITHREADS
fd1bc7eb 308 IV op_pmoffset;
1fcf4c12
AB
309#else
310 REGEXP * op_pmregexp; /* compiled expression */
311#endif
69bdead3 312 U32 op_pmflags;
29f2e912 313 union {
20e98b0f
NC
314 OP * op_pmreplroot; /* For OP_SUBST */
315#ifdef USE_ITHREADS
316 PADOFFSET op_pmtargetoff; /* For OP_PUSHRE */
317#else
318 GV * op_pmtargetgv;
319#endif
320 } op_pmreplrootu;
321 union {
29f2e912 322 OP * op_pmreplstart; /* Only used in OP_SUBST */
cb55de95 323#ifdef USE_ITHREADS
29f2e912 324 char * op_pmstashpv; /* Only used in OP_MATCH, with PMf_ONCE set */
cb55de95 325#else
29f2e912 326 HV * op_pmstash;
cb55de95 327#endif
29f2e912 328 } op_pmstashstartu;
79072805 329};
a0d0e21e 330
1fcf4c12 331#ifdef USE_ITHREADS
10599a69
NC
332#define PM_GETRE(o) (SvROK(PL_regex_pad[(o)->op_pmoffset]) ? \
333 (REGEXP*)SvRV(PL_regex_pad[(o)->op_pmoffset]) : NULL)
ede1273d
NC
334/* The assignment is just to enforce type safety (or at least get a warning).
335 */
336#define PM_SETRE(o,r) STMT_START { \
337 const REGEXP *const slosh = (r); \
10599a69
NC
338 SV *const whap = PL_regex_pad[(o)->op_pmoffset]; \
339 SvIOK_off(whap); \
340 SvROK_on(whap); \
341 SvRV_set(whap, (SV*)slosh); \
ede1273d
NC
342 } STMT_END
343/* Actually you can assign any IV, not just an offset. And really should it be
344 UV? */
10599a69
NC
345/* Need to turn the SvOK off as the regexp code is quite carefully manually
346 reference counting the thing pointed to, so don't want sv_setiv also
347 deciding to clear a reference count because it sees an SV. */
ede1273d
NC
348#define PM_SETRE_OFFSET(o,iv) \
349 STMT_START { \
0bd48802 350 SV* const sv = PL_regex_pad[(o)->op_pmoffset]; \
10599a69 351 SvROK_off(sv); \
ede1273d 352 sv_setiv(sv, (iv)); \
0bd48802 353 } STMT_END
ede1273d 354
9cddf794
NC
355# ifndef PERL_CORE
356/* No longer used anywhere in the core. Migrate to Devel::PPPort? */
5f8cb046
DM
357#define PM_GETRE_SAFE(o) (PL_regex_pad ? PM_GETRE(o) : (REGEXP*)0)
358#define PM_SETRE_SAFE(o,r) if (PL_regex_pad) PM_SETRE(o,r)
9cddf794 359# endif
1fcf4c12 360#else
b9ed2502
AB
361#define PM_GETRE(o) ((o)->op_pmregexp)
362#define PM_SETRE(o,r) ((o)->op_pmregexp = (r))
9cddf794 363# ifndef PERL_CORE
5f8cb046
DM
364#define PM_GETRE_SAFE PM_GETRE
365#define PM_SETRE_SAFE PM_SETRE
9cddf794 366# endif
1fcf4c12 367#endif
4825b64b 368
48c036b1 369
52d81aa8
NC
370#define PMf_RETAINT 0x00000040 /* taint $1 etc. if target tainted */
371#define PMf_ONCE 0x00000080 /* match successfully only once per
c737faaf 372 reset, with related flag RXf_USED
29f2e912
NC
373 in re->extflags holding state.
374 This is used only for ?? matches,
375 and only on OP_MATCH and OP_QR */
c737faaf 376
52d81aa8
NC
377#define PMf_UNUSED 0x00000100 /* free for use */
378#define PMf_MAYBE_CONST 0x00000200 /* replacement contains variables */
c737faaf 379
52d81aa8 380#define PMf_USED 0x00000400 /* PMf_ONCE has matched successfully.
c737faaf
YO
381 Not used under threading. */
382
52d81aa8
NC
383#define PMf_CONST 0x00000800 /* subst replacement is constant */
384#define PMf_KEEP 0x00001000 /* keep 1st runtime pattern forever */
385#define PMf_GLOBAL 0x00002000 /* pattern had a g modifier */
386#define PMf_CONTINUE 0x00004000 /* don't reset pos() if //g fails */
387#define PMf_EVAL 0x00008000 /* evaluating replacement as expr */
e357fc67
YO
388
389/* The following flags have exact equivalents in regcomp.h with the prefix RXf_
a1cf41cd
NC
390 * which are stored in the regexp->extflags member. If you change them here,
391 * you have to change them there, and vice versa.
e357fc67 392 */
52d81aa8
NC
393#define PMf_MULTILINE 0x00000001 /* assume multiple lines */
394#define PMf_SINGLELINE 0x00000002 /* assume single line */
395#define PMf_FOLD 0x00000004 /* case insensitivity */
396#define PMf_EXTENDED 0x00000008 /* chuck embedded whitespace */
397#define PMf_KEEPCOPY 0x00000010 /* copy the string when matching */
398#define PMf_LOCALE 0x00000020 /* use locale for character types */
79072805 399
e357fc67 400/* mask of bits that need to be transfered to re->extflags */
cde0cee5 401#define PMf_COMPILETIME (PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED|PMf_KEEPCOPY)
8782bef2 402
cb55de95 403#ifdef USE_ITHREADS
05ec9bb3 404
29f2e912
NC
405# define PmopSTASHPV(o) \
406 (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstashpv : NULL)
407# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
408# define PmopSTASHPV_set(o,pv) ({ \
409 assert((o)->op_pmflags & PMf_ONCE); \
410 ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv)); \
411 })
412# else
413# define PmopSTASHPV_set(o,pv) \
414 ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv))
415# endif
cb55de95 416# define PmopSTASH(o) (PmopSTASHPV(o) \
29f2e912 417 ? gv_stashpv((o)->op_pmstashstartu.op_pmstashpv,GV_ADD) : NULL)
bd61b366 418# define PmopSTASH_set(o,hv) PmopSTASHPV_set(o, ((hv) ? HvNAME_get(hv) : NULL))
05ec9bb3
NIS
419# define PmopSTASH_free(o) PerlMemShared_free(PmopSTASHPV(o))
420
cb55de95 421#else
29f2e912
NC
422# define PmopSTASH(o) \
423 (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
424# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
425# define PmopSTASH_set(o,hv) ({ \
426 assert((o)->op_pmflags & PMf_ONCE); \
427 ((o)->op_pmstashstartu.op_pmstash = (hv)); \
428 })
429# else
430# define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
431# endif
bd61b366 432# define PmopSTASHPV(o) (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
29f2e912 433 /* op_pmstashstartu.op_pmstash is not refcounted */
cb55de95 434# define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
c4bd3ae5
NC
435/* Note that if this becomes non-empty, then S_forget_pmop in op.c will need
436 changing */
05ec9bb3 437# define PmopSTASH_free(o)
cb55de95
JH
438#endif
439
79072805
LW
440struct svop {
441 BASEOP
442 SV * op_sv;
443};
444
7934575e 445struct padop {
79072805 446 BASEOP
7934575e 447 PADOFFSET op_padix;
79072805
LW
448};
449
450struct pvop {
451 BASEOP
452 char * op_pv;
453};
454
79072805
LW
455struct loop {
456 BASEOP
457 OP * op_first;
458 OP * op_last;
79072805
LW
459 OP * op_redoop;
460 OP * op_nextop;
461 OP * op_lastop;
462};
463
350de78d
GS
464#define cUNOPx(o) ((UNOP*)o)
465#define cBINOPx(o) ((BINOP*)o)
466#define cLISTOPx(o) ((LISTOP*)o)
467#define cLOGOPx(o) ((LOGOP*)o)
468#define cPMOPx(o) ((PMOP*)o)
469#define cSVOPx(o) ((SVOP*)o)
470#define cPADOPx(o) ((PADOP*)o)
471#define cPVOPx(o) ((PVOP*)o)
472#define cCOPx(o) ((COP*)o)
473#define cLOOPx(o) ((LOOP*)o)
474
475#define cUNOP cUNOPx(PL_op)
476#define cBINOP cBINOPx(PL_op)
477#define cLISTOP cLISTOPx(PL_op)
478#define cLOGOP cLOGOPx(PL_op)
479#define cPMOP cPMOPx(PL_op)
480#define cSVOP cSVOPx(PL_op)
481#define cPADOP cPADOPx(PL_op)
482#define cPVOP cPVOPx(PL_op)
483#define cCOP cCOPx(PL_op)
484#define cLOOP cLOOPx(PL_op)
485
486#define cUNOPo cUNOPx(o)
487#define cBINOPo cBINOPx(o)
488#define cLISTOPo cLISTOPx(o)
489#define cLOGOPo cLOGOPx(o)
490#define cPMOPo cPMOPx(o)
491#define cSVOPo cSVOPx(o)
492#define cPADOPo cPADOPx(o)
493#define cPVOPo cPVOPx(o)
494#define cCOPo cCOPx(o)
495#define cLOOPo cLOOPx(o)
496
497#define kUNOP cUNOPx(kid)
498#define kBINOP cBINOPx(kid)
499#define kLISTOP cLISTOPx(kid)
500#define kLOGOP cLOGOPx(kid)
501#define kPMOP cPMOPx(kid)
502#define kSVOP cSVOPx(kid)
503#define kPADOP cPADOPx(kid)
504#define kPVOP cPVOPx(kid)
505#define kCOP cCOPx(kid)
506#define kLOOP cLOOPx(kid)
507
508
509#ifdef USE_ITHREADS
dd2155a4 510# define cGVOPx_gv(o) ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
cecf5685
NC
511# define IS_PADGV(v) (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
512 && GvIN_PAD(v))
7766f137
GS
513# define IS_PADCONST(v) (v && SvREADONLY(v))
514# define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
dd2155a4 515 ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
638eceb6 516# define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
dd2155a4 517 ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
350de78d 518#else
638eceb6 519# define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
743e66e6 520# define IS_PADGV(v) FALSE
7766f137
GS
521# define IS_PADCONST(v) FALSE
522# define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
638eceb6 523# define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
350de78d 524#endif
79072805 525
638eceb6
GS
526#define cGVOP_gv cGVOPx_gv(PL_op)
527#define cGVOPo_gv cGVOPx_gv(o)
528#define kGVOP_gv cGVOPx_gv(kid)
529#define cSVOP_sv cSVOPx_sv(PL_op)
530#define cSVOPo_sv cSVOPx_sv(o)
531#define kSVOP_sv cSVOPx_sv(kid)
7766f137 532
24792b8d 533#define Nullop ((OP*)NULL)
79072805 534
91135acb 535/* Lowest byte-and-a-bit of PL_opargs */
a0d0e21e
LW
536#define OA_MARK 1
537#define OA_FOLDCONST 2
538#define OA_RETSCALAR 4
539#define OA_TARGET 8
540#define OA_RETINTEGER 16
541#define OA_OTHERINT 32
542#define OA_DANGEROUS 64
543#define OA_DEFGV 128
b162f9ea 544#define OA_TARGLEX 256
a0d0e21e 545
db173bac 546/* The next 4 bits encode op class information */
b162f9ea
IZ
547#define OCSHIFT 9
548
549#define OA_CLASS_MASK (15 << OCSHIFT)
550
551#define OA_BASEOP (0 << OCSHIFT)
552#define OA_UNOP (1 << OCSHIFT)
553#define OA_BINOP (2 << OCSHIFT)
554#define OA_LOGOP (3 << OCSHIFT)
1a67a97c
SM
555#define OA_LISTOP (4 << OCSHIFT)
556#define OA_PMOP (5 << OCSHIFT)
557#define OA_SVOP (6 << OCSHIFT)
7934575e 558#define OA_PADOP (7 << OCSHIFT)
1a67a97c
SM
559#define OA_PVOP_OR_SVOP (8 << OCSHIFT)
560#define OA_LOOP (9 << OCSHIFT)
561#define OA_COP (10 << OCSHIFT)
562#define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
563#define OA_FILESTATOP (12 << OCSHIFT)
564#define OA_LOOPEXOP (13 << OCSHIFT)
b162f9ea
IZ
565
566#define OASHIFT 13
a0d0e21e 567
4369b173 568/* Remaining nybbles of PL_opargs */
a0d0e21e
LW
569#define OA_SCALAR 1
570#define OA_LIST 2
571#define OA_AVREF 3
572#define OA_HVREF 4
573#define OA_CVREF 5
574#define OA_FILEREF 6
575#define OA_SCALARREF 7
576#define OA_OPTIONAL 8
577
d3c72c2a
DM
578/* Op_REFCNT is a reference count at the head of each op tree: needed
579 * since the tree is shared between threads, and between cloned closure
580 * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
581 * this count.
582 * The same mutex is used to protect the refcounts of the reg_trie_data
583 * and reg_ac_data structures, which are shared between duplicated
584 * regexes.
585 */
586
534825c4
GS
587#ifdef USE_ITHREADS
588# define OP_REFCNT_INIT MUTEX_INIT(&PL_op_mutex)
4026c95a
SH
589# ifdef PERL_CORE
590# define OP_REFCNT_LOCK MUTEX_LOCK(&PL_op_mutex)
591# define OP_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_op_mutex)
592# else
593# define OP_REFCNT_LOCK op_refcnt_lock()
594# define OP_REFCNT_UNLOCK op_refcnt_unlock()
595# endif
534825c4 596# define OP_REFCNT_TERM MUTEX_DESTROY(&PL_op_mutex)
534825c4
GS
597#else
598# define OP_REFCNT_INIT NOOP
599# define OP_REFCNT_LOCK NOOP
600# define OP_REFCNT_UNLOCK NOOP
601# define OP_REFCNT_TERM NOOP
534825c4 602#endif
e4783991 603
282f25c9 604#define OpREFCNT_set(o,n) ((o)->op_targ = (n))
fc97af9c
NC
605#ifdef PERL_DEBUG_READONLY_OPS
606# define OpREFCNT_inc(o) Perl_op_refcnt_inc(aTHX_ o)
607# define OpREFCNT_dec(o) Perl_op_refcnt_dec(aTHX_ o)
608#else
609# define OpREFCNT_inc(o) ((o) ? (++(o)->op_targ, (o)) : NULL)
610# define OpREFCNT_dec(o) (--(o)->op_targ)
611#endif
282f25c9 612
e4783991
GS
613/* flags used by Perl_load_module() */
614#define PERL_LOADMOD_DENY 0x1
615#define PERL_LOADMOD_NOIMPORT 0x2
616#define PERL_LOADMOD_IMPORT_OPS 0x4
e5dd39fc 617
a0c21aa1 618#if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C)
e4c5ccf3 619#define ref(o, type) doref(o, type, TRUE)
a0c21aa1 620#endif
e4c5ccf3 621
33f36c71
NC
622/* no longer used anywhere in core */
623#ifndef PERL_CORE
46471bde
NC
624#define cv_ckproto(cv, gv, p) \
625 cv_ckproto_len((cv), (gv), (p), (p) ? strlen(p) : 0)
33f36c71
NC
626#endif
627
e5dd39fc 628#ifdef USE_REENTRANT_API
10bc17b6 629#include "reentr.h"
e5dd39fc
AB
630#endif
631
c7e45529
AE
632#if defined(PL_OP_SLAB_ALLOC)
633#define NewOp(m,var,c,type) \
e91d68d5 634 (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
c7e45529 635#define NewOpSz(m,var,size) \
e91d68d5 636 (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
c7e45529
AE
637#define FreeOp(p) Perl_Slab_Free(aTHX_ p)
638#else
04e62e51
NC
639#define NewOp(m, var, c, type) \
640 (var = (MEM_WRAP_CHECK_(c,type) \
641 (type*)PerlMemShared_calloc(c, sizeof(type))))
113b9ccf 642#define NewOpSz(m, var, size) \
04e62e51
NC
643 (var = (OP*)PerlMemShared_calloc(1, size))
644#define FreeOp(p) PerlMemShared_free(p)
c7e45529 645#endif
598921a7
NC
646
647#ifdef PERL_MAD
648# define MAD_NULL 1
649# define MAD_PV 2
650# define MAD_OP 3
651# define MAD_SV 4
652
653struct madprop {
654 MADPROP* mad_next;
594c10dc 655 const void *mad_val;
598921a7
NC
656 U32 mad_vlen;
657/* short mad_count; */
658 char mad_key;
659 char mad_type;
660};
661
662struct token {
663 I32 tk_type;
664 YYSTYPE tk_lval;
665 MADPROP* tk_mad;
666};
667#endif
2d910ff8
RGS
668
669/*
2b3def87 670 * Values that can be held by mad_key :
2d910ff8
RGS
671 * ^ unfilled head spot
672 * , literal ,
673 * ; literal ; (blank if implicit ; at end of block)
674 * : literal : from ?: or attr list
675 * + unary +
676 * ? literal ? from ?:
677 * ( literal (
678 * ) literal )
679 * [ literal [
680 * ] literal ]
681 * { literal {
682 * } literal }
683 * @ literal @ sigil
684 * $ literal $ sigil
685 * * literal * sigil
686 * ! use is source filtered
687 * & & or sub
688 * # whitespace/comment following ; or }
689 * # $# sigil
690 * 1 1st ; from for(;;)
691 * 1 retired protasis
692 * 2 2nd ; from for(;;)
693 * 2 retired apodosis
694 * 3 C-style for list
695 * a sub or var attributes
696 * a non-method arrow operator
697 * A method arrow operator
698 * A use import args
699 * b format block
700 * B retired stub block
701 * C constant conditional op
702 * d declarator
703 * D do block
704 * e unreached "else" (see C)
705 * e expression producing E
706 * E tr/E/R/, /E/
707 * f folded constant op
708 * F peg op for format
63575281 709 * g op was forced to be a word
2d910ff8
RGS
710 * i if/unless modifier
711 * I if/elsif/unless statement
dde83331 712 * k local declarator
2d910ff8
RGS
713 * K retired kid op
714 * l last index of array ($#foo)
715 * L label
716 * m modifier on regex
2d910ff8
RGS
717 * n sub or format name
718 * o current operator/declarator name
719 * o else/continue
720 * O generic optimized op
721 * p peg to hold extra whitespace at statement level
722 * P peg op for package declaration
723 * q opening quote
724 * = quoted material
725 * Q closing quote
726 * Q optimized qw//
727 * r expression producing R
728 * R tr/E/R/ s/E/R/
2d910ff8
RGS
729 * s sub signature
730 * S use import stub (no import)
731 * S retired sort block
732 * t unreached "then" (see C)
733 * U use import op
734 * v private sv of for loop
735 * V use version
736 * w while/until modifier
737 * W while/for statement
738 * x optimized qw
739 * X random thing
740 * _ whitespace/comments preceding anything else
741 * ~ =~ operator
742 */
3f2908ec
NC
743
744/*
745 * Local variables:
746 * c-indentation-style: bsd
747 * c-basic-offset: 4
748 * indent-tabs-mode: t
749 * End:
750 *
751 * ex: set ts=8 sts=4 sw=4 noet:
752 */