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