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