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