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