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