This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
More places that could be using G_WANT, not picked up by change 33021.
[perl5.git] / op.h
CommitLineData
a0d0e21e 1/* op.h
79072805 2 *
4bb101f2 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
663f364b 4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 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.
7e5d8ed2
DM
22 *
23 * See the comments in S_clear_yystack() for more
24 * details on the following three flags:
85594c31 25 *
670f3923
DM
26 * op_latefree tell op_free() to clear this op (and free any kids)
27 * but not yet deallocate the struct. This means that
28 * the op may be safely op_free()d multiple times
29 * op_latefreed an op_latefree op has been op_free()d
7e5d8ed2
DM
30 * op_attached this op (sub)tree has been attached to a CV
31 *
85594c31 32 * op_spare three spare bits!
79072805
LW
33 * op_flags Flags common to all operations. See OPf_* below.
34 * op_private Flags peculiar to a particular operation (BUT,
35 * by default, set to the number of children until
36 * the operation is privatized by a check routine,
37 * which may or may not check number of children).
38 */
39
79072805 40#define OPCODE U16
79072805 41
598921a7
NC
42#ifdef PERL_MAD
43# define MADPROP_IN_BASEOP MADPROP* op_madprop;
44#else
45# define MADPROP_IN_BASEOP
46#endif
47
0f4eea8f
DL
48#ifdef BASEOP_DEFINITION
49#define BASEOP BASEOP_DEFINITION
50#else
79072805
LW
51#define BASEOP \
52 OP* op_next; \
53 OP* op_sibling; \
4f63d024 54 OP* (CPERLscope(*op_ppaddr))(pTHX); \
598921a7 55 MADPROP_IN_BASEOP \
79072805 56 PADOFFSET op_targ; \
e57fbd1f 57 unsigned op_type:9; \
2814eb74 58 unsigned op_opt:1; \
670f3923
DM
59 unsigned op_latefree:1; \
60 unsigned op_latefreed:1; \
7e5d8ed2 61 unsigned op_attached:1; \
85594c31 62 unsigned op_spare:3; \
a0d0e21e
LW
63 U8 op_flags; \
64 U8 op_private;
0f4eea8f 65#endif
79072805 66
54310121
PP
67#define OP_GIMME(op,dfl) \
68 (((op)->op_flags & OPf_WANT) == OPf_WANT_VOID ? G_VOID : \
69 ((op)->op_flags & OPf_WANT) == OPf_WANT_SCALAR ? G_SCALAR : \
70 ((op)->op_flags & OPf_WANT) == OPf_WANT_LIST ? G_ARRAY : \
71 dfl)
72
4f911530
NC
73#define OP_GIMME_REVERSE(flags) \
74 ((flags & G_VOID) ? OPf_WANT_VOID : \
75 (flags & G_ARRAY) ? OPf_WANT_LIST : \
76 OPf_WANT_SCALAR)
77
954c1994 78/*
ccfc67b7
JH
79=head1 "Gimme" Values
80
954c1994
GS
81=for apidoc Amn|U32|GIMME_V
82The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
91e74348 83C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
954c1994
GS
84respectively.
85
86=for apidoc Amn|U32|GIMME
87A backward-compatible version of C<GIMME_V> which can only return
88C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
89Deprecated. Use C<GIMME_V> instead.
90
91=cut
92*/
93
533c011a 94#define GIMME_V OP_GIMME(PL_op, block_gimme())
79072805
LW
95
96/* Public flags */
54310121
PP
97
98#define OPf_WANT 3 /* Mask for "want" bits: */
99#define OPf_WANT_VOID 1 /* Want nothing */
100#define OPf_WANT_SCALAR 2 /* Want single value */
101#define OPf_WANT_LIST 3 /* Want list of any length */
79072805
LW
102#define OPf_KIDS 4 /* There is a firstborn child. */
103#define OPf_PARENS 8 /* This operator was parenthesized. */
463ee0b2 104 /* (Or block needs explicit scope entry.) */
a0d0e21e
LW
105#define OPf_REF 16 /* Certified reference. */
106 /* (Return container, not containee). */
107#define OPf_MOD 32 /* Will modify (lvalue). */
108#define OPf_STACKED 64 /* Some arg is arriving on the stack. */
79072805
LW
109#define OPf_SPECIAL 128 /* Do something weird for this op: */
110 /* On local LVAL, don't init local value. */
0282be92
RGS
111 /* On OP_CONST, value is the hints hash for
112 eval, so return a copy from pp_const() */
79072805
LW
113 /* On OP_SORT, subroutine is inlined. */
114 /* On OP_NOT, inversion was implicit. */
a0d0e21e 115 /* On OP_LEAVE, don't restore curpm. */
79072805
LW
116 /* On truncate, we truncate filehandle */
117 /* On control verbs, we saw no label */
118 /* On flipflop, we saw ... instead of .. */
119 /* On UNOPs, saw bare parens, e.g. eof(). */
a0d0e21e 120 /* On OP_ENTERSUB || OP_NULL, saw a "do". */
afebc493 121 /* On OP_EXISTS, treat av as av, not avhv. */
f2ec2afd 122 /* On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
54b9620d 123 /* On OP_ENTERITER, loop var is per-thread */
0ac6acae 124 /* On pushre, rx is used as part of split, e.g. split " " */
497711e7 125 /* On regcomp, "use re 'eval'" was in scope */
7c6fadd6 126 /* On OP_READLINE, was <$filehandle> */
17fda545
NC
127 /* On RV2[ACGHS]V, don't create GV--in
128 defined()*/
5df8de69
DM
129 /* On OP_DBSTATE, indicates breakpoint
130 * (runtime property) */
6a077020 131 /* On OP_AELEMFAST, indiciates pad var */
6b514a0d 132 /* On OP_REQUIRE, was seen as CORE::require */
0d863452
RH
133 /* On OP_ENTERWHEN, there's no condition */
134 /* On OP_BREAK, an implicit break */
135 /* On OP_SMARTMATCH, an implicit smartmatch */
78c72037
NC
136 /* On OP_ANONHASH and OP_ANONLIST, create a
137 reference to the new anon hash or array */
79072805 138
54310121 139/* old names; don't use in new code, but don't break them, either */
d91ab173
GS
140#define OPf_LIST OPf_WANT_LIST
141#define OPf_KNOW OPf_WANT
954c1994 142
54310121 143#define GIMME \
62a559b8
NIS
144 (PL_op->op_flags & OPf_WANT \
145 ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \
d91ab173
GS
146 ? G_ARRAY \
147 : G_SCALAR) \
148 : dowantarray())
54310121 149
d41ff1b8
GS
150/* NOTE: OP_NEXTSTATE, OP_DBSTATE, and OP_SETSTATE (i.e. COPs) carry lower
151 * bits of PL_hints in op_private */
152
a0d0e21e 153/* Private for lvalues */
cd06dffe 154#define OPpLVAL_INTRO 128 /* Lvalue must be localized or lvalue sub */
a0d0e21e 155
7934575e
GS
156/* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
157#define OPpREFCOUNTED 64 /* op_targ carries a refcount */
158
a0d0e21e
LW
159/* Private for OP_AASSIGN */
160#define OPpASSIGN_COMMON 64 /* Left & right have syms in common. */
161
162/* Private for OP_SASSIGN */
163#define OPpASSIGN_BACKWARDS 64 /* Left & right switched. */
e26df76a 164#define OPpASSIGN_CV_TO_GV 128 /* Possible optimisation for constants. */
79072805 165
c90c0ff4
PP
166/* Private for OP_MATCH and OP_SUBST{,CONST} */
167#define OPpRUNTIME 64 /* Pattern coming in on the stack */
168
79072805 169/* Private for OP_TRANS */
4757a243
LW
170#define OPpTRANS_FROM_UTF 1
171#define OPpTRANS_TO_UTF 2
383e7cdd 172#define OPpTRANS_IDENTICAL 4 /* right side is same as left */
4757a243 173#define OPpTRANS_SQUASH 8
59f00321 174 /* 16 is used for OPpTARGET_MY */
4757a243
LW
175#define OPpTRANS_COMPLEMENT 32
176#define OPpTRANS_GROWS 64
59f00321
RGS
177#define OPpTRANS_DELETE 128
178#define OPpTRANS_ALL (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
79072805
LW
179
180/* Private for OP_REPEAT */
a0d0e21e 181#define OPpREPEAT_DOLIST 64 /* List replication. */
79072805 182
cf2dc985 183/* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
314d4778 184#define OPpDEREF (32|64) /* autovivify: Want ref to something: */
5f05dabc
PP
185#define OPpDEREF_AV 32 /* Want ref to AV. */
186#define OPpDEREF_HV 64 /* Want ref to HV. */
187#define OPpDEREF_SV (32|64) /* Want ref to SV. */
68dc0745
PP
188 /* OP_ENTERSUB only */
189#define OPpENTERSUB_DB 16 /* Debug subroutine. */
d3011074 190#define OPpENTERSUB_HASTARG 32 /* Called from OP tree. */
95f0a2f1 191#define OPpENTERSUB_NOMOD 64 /* Immune to mod() for :attrlist. */
7a52d87a 192 /* OP_RV2CV only */
68dc0745 193#define OPpENTERSUB_AMPER 8 /* Used & form to call. */
9675f7ac 194#define OPpENTERSUB_NOPAREN 128 /* bare sub call (without parens) */
cd06dffe 195#define OPpENTERSUB_INARGS 4 /* Lval used as arg to a sub. */
76cd736e
GS
196 /* OP_GV only */
197#define OPpEARLY_CV 32 /* foo() called before sub foo was parsed */
68dc0745
PP
198 /* OP_?ELEM only */
199#define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */
241416b8 200 /* OP_RV2?V, OP_GVSV, OP_ENTERITER only */
78f9721b 201#define OPpOUR_INTRO 16 /* Variable was in an our() */
cb0d96b9 202 /* OP_RV2[AGH]V, OP_PAD[AH]V, OP_[AH]ELEM */
78f9721b 203#define OPpMAYBE_LVSUB 8 /* We might be an lvalue to return */
952306ac
RGS
204 /* OP_PADSV only */
205#define OPpPAD_STATE 16 /* is a "state" pad */
192587c2 206 /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
79072805 207
e26df76a 208 /* OP_RV2GV only */
cb0d96b9 209#define OPpDONT_INIT_GV 4 /* Call gv_fetchpv with GV_NOINIT */
e26df76a
NC
210/* (Therefore will return whatever is currently in the symbol table, not
211 guaranteed to be a PVGV) */
212
213 /* OP_RV2CV only */
214#define OPpMAY_RETURN_CONSTANT 1 /* If a constant sub, return the constant */
215
b162f9ea
IZ
216/* Private for OPs with TARGLEX */
217 /* (lower bits may carry MAXARG) */
218#define OPpTARGET_MY 16 /* Target is PADMY. */
219
ef3e5ea9
NC
220/* Private for OP_ENTERITER and OP_ITER */
221#define OPpITER_REVERSED 4 /* for (reverse ...) */
0d863452 222#define OPpITER_DEF 8 /* for $_ or for my $_ */
ef3e5ea9 223
79072805 224/* Private for OP_CONST */
468aa647 225#define OPpCONST_NOVER 2 /* no 6; */
e7fec78e 226#define OPpCONST_SHORTCIRCUIT 4 /* eg the constant 5 in (5 || foo) */
7a52d87a 227#define OPpCONST_STRICT 8 /* bearword subject to strict 'subs' */
748a9306
LW
228#define OPpCONST_ENTERED 16 /* Has been entered as symbol. */
229#define OPpCONST_ARYBASE 32 /* Was a $[ translated to constant. */
a0d0e21e 230#define OPpCONST_BARE 64 /* Was a bare word (filehandle?). */
599cee73 231#define OPpCONST_WARNING 128 /* Was a $^W translated to constant. */
79072805
LW
232
233/* Private for OP_FLIP/FLOP */
a0d0e21e 234#define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */
79072805 235
ed6116ce 236/* Private for OP_LIST */
a0d0e21e
LW
237#define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */
238
5f05dabc 239/* Private for OP_DELETE */
54310121 240#define OPpSLICE 64 /* Operating on a list of keys */
5f05dabc 241
afebc493
GS
242/* Private for OP_EXISTS */
243#define OPpEXISTS_SUB 64 /* Checking for &sub, not {} or []. */
244
9c007264
JH
245/* Private for OP_SORT */
246#define OPpSORT_NUMERIC 1 /* Optimized away { $a <=> $b } */
247#define OPpSORT_INTEGER 2 /* Ditto while under "use integer" */
eb209983 248#define OPpSORT_REVERSE 4 /* Reversed sort */
fe1bc4cf 249#define OPpSORT_INPLACE 8 /* sort in-place; eg @a = sort @a */
eb209983 250#define OPpSORT_DESCEND 16 /* Descending sort */
7b9ef140
RH
251#define OPpSORT_QSORT 32 /* Use quicksort (not mergesort) */
252#define OPpSORT_STABLE 64 /* Use a stable algorithm */
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;
1fcf4c12 312#ifdef USE_ITHREADS
fd1bc7eb 313 IV op_pmoffset;
1fcf4c12
AB
314#else
315 REGEXP * op_pmregexp; /* compiled expression */
316#endif
69bdead3 317 U32 op_pmflags;
29f2e912 318 union {
20e98b0f
NC
319 OP * op_pmreplroot; /* For OP_SUBST */
320#ifdef USE_ITHREADS
321 PADOFFSET op_pmtargetoff; /* For OP_PUSHRE */
322#else
323 GV * op_pmtargetgv;
324#endif
325 } op_pmreplrootu;
326 union {
29f2e912 327 OP * op_pmreplstart; /* Only used in OP_SUBST */
cb55de95 328#ifdef USE_ITHREADS
29f2e912 329 char * op_pmstashpv; /* Only used in OP_MATCH, with PMf_ONCE set */
cb55de95 330#else
29f2e912 331 HV * op_pmstash;
cb55de95 332#endif
29f2e912 333 } op_pmstashstartu;
79072805 334};
a0d0e21e 335
1fcf4c12 336#ifdef USE_ITHREADS
14a49a24
NC
337#define PM_GETRE(o) (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
338 ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
ede1273d
NC
339/* The assignment is just to enforce type safety (or at least get a warning).
340 */
14a49a24
NC
341/* With first class regexps not via a reference one needs to assign
342 &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
343 is cheaper. I guess we could allow NULL, but the check above would get
344 more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
345/* BEWARE - something that calls this macro passes (r) which has a side
346 effect. */
ede1273d 347#define PM_SETRE(o,r) STMT_START { \
14a49a24
NC
348 const REGEXP *const whap = (r); \
349 assert(whap); \
350 PL_regex_pad[(o)->op_pmoffset] = (SV*)whap; \
ede1273d 351 } STMT_END
1fcf4c12 352#else
b9ed2502
AB
353#define PM_GETRE(o) ((o)->op_pmregexp)
354#define PM_SETRE(o,r) ((o)->op_pmregexp = (r))
1fcf4c12 355#endif
4825b64b 356
48c036b1 357
52d81aa8
NC
358#define PMf_RETAINT 0x00000040 /* taint $1 etc. if target tainted */
359#define PMf_ONCE 0x00000080 /* match successfully only once per
c737faaf 360 reset, with related flag RXf_USED
29f2e912
NC
361 in re->extflags holding state.
362 This is used only for ?? matches,
363 and only on OP_MATCH and OP_QR */
c737faaf 364
52d81aa8
NC
365#define PMf_UNUSED 0x00000100 /* free for use */
366#define PMf_MAYBE_CONST 0x00000200 /* replacement contains variables */
c737faaf 367
52d81aa8 368#define PMf_USED 0x00000400 /* PMf_ONCE has matched successfully.
c737faaf
YO
369 Not used under threading. */
370
52d81aa8
NC
371#define PMf_CONST 0x00000800 /* subst replacement is constant */
372#define PMf_KEEP 0x00001000 /* keep 1st runtime pattern forever */
373#define PMf_GLOBAL 0x00002000 /* pattern had a g modifier */
374#define PMf_CONTINUE 0x00004000 /* don't reset pos() if //g fails */
375#define PMf_EVAL 0x00008000 /* evaluating replacement as expr */
e357fc67
YO
376
377/* The following flags have exact equivalents in regcomp.h with the prefix RXf_
a1cf41cd
NC
378 * which are stored in the regexp->extflags member. If you change them here,
379 * you have to change them there, and vice versa.
e357fc67 380 */
52d81aa8
NC
381#define PMf_MULTILINE 0x00000001 /* assume multiple lines */
382#define PMf_SINGLELINE 0x00000002 /* assume single line */
383#define PMf_FOLD 0x00000004 /* case insensitivity */
384#define PMf_EXTENDED 0x00000008 /* chuck embedded whitespace */
385#define PMf_KEEPCOPY 0x00000010 /* copy the string when matching */
386#define PMf_LOCALE 0x00000020 /* use locale for character types */
79072805 387
e357fc67 388/* mask of bits that need to be transfered to re->extflags */
cde0cee5 389#define PMf_COMPILETIME (PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED|PMf_KEEPCOPY)
8782bef2 390
cb55de95 391#ifdef USE_ITHREADS
05ec9bb3 392
29f2e912
NC
393# define PmopSTASHPV(o) \
394 (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstashpv : NULL)
395# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
396# define PmopSTASHPV_set(o,pv) ({ \
397 assert((o)->op_pmflags & PMf_ONCE); \
398 ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv)); \
399 })
400# else
401# define PmopSTASHPV_set(o,pv) \
402 ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv))
403# endif
cb55de95 404# define PmopSTASH(o) (PmopSTASHPV(o) \
29f2e912 405 ? gv_stashpv((o)->op_pmstashstartu.op_pmstashpv,GV_ADD) : NULL)
bd61b366 406# define PmopSTASH_set(o,hv) PmopSTASHPV_set(o, ((hv) ? HvNAME_get(hv) : NULL))
05ec9bb3
NIS
407# define PmopSTASH_free(o) PerlMemShared_free(PmopSTASHPV(o))
408
cb55de95 409#else
29f2e912
NC
410# define PmopSTASH(o) \
411 (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
412# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
413# define PmopSTASH_set(o,hv) ({ \
414 assert((o)->op_pmflags & PMf_ONCE); \
415 ((o)->op_pmstashstartu.op_pmstash = (hv)); \
416 })
417# else
418# define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
419# endif
bd61b366 420# define PmopSTASHPV(o) (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
29f2e912 421 /* op_pmstashstartu.op_pmstash is not refcounted */
cb55de95 422# define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
c4bd3ae5
NC
423/* Note that if this becomes non-empty, then S_forget_pmop in op.c will need
424 changing */
05ec9bb3 425# define PmopSTASH_free(o)
cb55de95
JH
426#endif
427
79072805
LW
428struct svop {
429 BASEOP
430 SV * op_sv;
431};
432
7934575e 433struct padop {
79072805 434 BASEOP
7934575e 435 PADOFFSET op_padix;
79072805
LW
436};
437
438struct pvop {
439 BASEOP
440 char * op_pv;
441};
442
79072805
LW
443struct loop {
444 BASEOP
445 OP * op_first;
446 OP * op_last;
79072805
LW
447 OP * op_redoop;
448 OP * op_nextop;
449 OP * op_lastop;
450};
451
350de78d
GS
452#define cUNOPx(o) ((UNOP*)o)
453#define cBINOPx(o) ((BINOP*)o)
454#define cLISTOPx(o) ((LISTOP*)o)
455#define cLOGOPx(o) ((LOGOP*)o)
456#define cPMOPx(o) ((PMOP*)o)
457#define cSVOPx(o) ((SVOP*)o)
458#define cPADOPx(o) ((PADOP*)o)
459#define cPVOPx(o) ((PVOP*)o)
460#define cCOPx(o) ((COP*)o)
461#define cLOOPx(o) ((LOOP*)o)
462
463#define cUNOP cUNOPx(PL_op)
464#define cBINOP cBINOPx(PL_op)
465#define cLISTOP cLISTOPx(PL_op)
466#define cLOGOP cLOGOPx(PL_op)
467#define cPMOP cPMOPx(PL_op)
468#define cSVOP cSVOPx(PL_op)
469#define cPADOP cPADOPx(PL_op)
470#define cPVOP cPVOPx(PL_op)
471#define cCOP cCOPx(PL_op)
472#define cLOOP cLOOPx(PL_op)
473
474#define cUNOPo cUNOPx(o)
475#define cBINOPo cBINOPx(o)
476#define cLISTOPo cLISTOPx(o)
477#define cLOGOPo cLOGOPx(o)
478#define cPMOPo cPMOPx(o)
479#define cSVOPo cSVOPx(o)
480#define cPADOPo cPADOPx(o)
481#define cPVOPo cPVOPx(o)
482#define cCOPo cCOPx(o)
483#define cLOOPo cLOOPx(o)
484
485#define kUNOP cUNOPx(kid)
486#define kBINOP cBINOPx(kid)
487#define kLISTOP cLISTOPx(kid)
488#define kLOGOP cLOGOPx(kid)
489#define kPMOP cPMOPx(kid)
490#define kSVOP cSVOPx(kid)
491#define kPADOP cPADOPx(kid)
492#define kPVOP cPVOPx(kid)
493#define kCOP cCOPx(kid)
494#define kLOOP cLOOPx(kid)
495
496
497#ifdef USE_ITHREADS
dd2155a4 498# define cGVOPx_gv(o) ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
cecf5685
NC
499# define IS_PADGV(v) (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
500 && GvIN_PAD(v))
7766f137
GS
501# define IS_PADCONST(v) (v && SvREADONLY(v))
502# define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
dd2155a4 503 ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
638eceb6 504# define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
dd2155a4 505 ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
350de78d 506#else
638eceb6 507# define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
743e66e6 508# define IS_PADGV(v) FALSE
7766f137
GS
509# define IS_PADCONST(v) FALSE
510# define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
638eceb6 511# define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
350de78d 512#endif
79072805 513
638eceb6
GS
514#define cGVOP_gv cGVOPx_gv(PL_op)
515#define cGVOPo_gv cGVOPx_gv(o)
516#define kGVOP_gv cGVOPx_gv(kid)
517#define cSVOP_sv cSVOPx_sv(PL_op)
518#define cSVOPo_sv cSVOPx_sv(o)
519#define kSVOP_sv cSVOPx_sv(kid)
7766f137 520
24792b8d 521#define Nullop ((OP*)NULL)
79072805 522
91135acb 523/* Lowest byte-and-a-bit of PL_opargs */
a0d0e21e
LW
524#define OA_MARK 1
525#define OA_FOLDCONST 2
526#define OA_RETSCALAR 4
527#define OA_TARGET 8
528#define OA_RETINTEGER 16
529#define OA_OTHERINT 32
530#define OA_DANGEROUS 64
531#define OA_DEFGV 128
b162f9ea 532#define OA_TARGLEX 256
a0d0e21e 533
db173bac 534/* The next 4 bits encode op class information */
b162f9ea
IZ
535#define OCSHIFT 9
536
537#define OA_CLASS_MASK (15 << OCSHIFT)
538
539#define OA_BASEOP (0 << OCSHIFT)
540#define OA_UNOP (1 << OCSHIFT)
541#define OA_BINOP (2 << OCSHIFT)
542#define OA_LOGOP (3 << OCSHIFT)
1a67a97c
SM
543#define OA_LISTOP (4 << OCSHIFT)
544#define OA_PMOP (5 << OCSHIFT)
545#define OA_SVOP (6 << OCSHIFT)
7934575e 546#define OA_PADOP (7 << OCSHIFT)
1a67a97c
SM
547#define OA_PVOP_OR_SVOP (8 << OCSHIFT)
548#define OA_LOOP (9 << OCSHIFT)
549#define OA_COP (10 << OCSHIFT)
550#define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
551#define OA_FILESTATOP (12 << OCSHIFT)
552#define OA_LOOPEXOP (13 << OCSHIFT)
b162f9ea
IZ
553
554#define OASHIFT 13
a0d0e21e 555
4369b173 556/* Remaining nybbles of PL_opargs */
a0d0e21e
LW
557#define OA_SCALAR 1
558#define OA_LIST 2
559#define OA_AVREF 3
560#define OA_HVREF 4
561#define OA_CVREF 5
562#define OA_FILEREF 6
563#define OA_SCALARREF 7
564#define OA_OPTIONAL 8
565
d3c72c2a
DM
566/* Op_REFCNT is a reference count at the head of each op tree: needed
567 * since the tree is shared between threads, and between cloned closure
568 * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
569 * this count.
570 * The same mutex is used to protect the refcounts of the reg_trie_data
571 * and reg_ac_data structures, which are shared between duplicated
572 * regexes.
573 */
574
534825c4
GS
575#ifdef USE_ITHREADS
576# define OP_REFCNT_INIT MUTEX_INIT(&PL_op_mutex)
4026c95a
SH
577# ifdef PERL_CORE
578# define OP_REFCNT_LOCK MUTEX_LOCK(&PL_op_mutex)
579# define OP_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_op_mutex)
580# else
581# define OP_REFCNT_LOCK op_refcnt_lock()
582# define OP_REFCNT_UNLOCK op_refcnt_unlock()
583# endif
534825c4 584# define OP_REFCNT_TERM MUTEX_DESTROY(&PL_op_mutex)
534825c4
GS
585#else
586# define OP_REFCNT_INIT NOOP
587# define OP_REFCNT_LOCK NOOP
588# define OP_REFCNT_UNLOCK NOOP
589# define OP_REFCNT_TERM NOOP
534825c4 590#endif
e4783991 591
282f25c9 592#define OpREFCNT_set(o,n) ((o)->op_targ = (n))
fc97af9c
NC
593#ifdef PERL_DEBUG_READONLY_OPS
594# define OpREFCNT_inc(o) Perl_op_refcnt_inc(aTHX_ o)
595# define OpREFCNT_dec(o) Perl_op_refcnt_dec(aTHX_ o)
596#else
597# define OpREFCNT_inc(o) ((o) ? (++(o)->op_targ, (o)) : NULL)
598# define OpREFCNT_dec(o) (--(o)->op_targ)
599#endif
282f25c9 600
e4783991
GS
601/* flags used by Perl_load_module() */
602#define PERL_LOADMOD_DENY 0x1
603#define PERL_LOADMOD_NOIMPORT 0x2
604#define PERL_LOADMOD_IMPORT_OPS 0x4
e5dd39fc 605
a0c21aa1 606#if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C)
e4c5ccf3 607#define ref(o, type) doref(o, type, TRUE)
a0c21aa1 608#endif
e4c5ccf3 609
33f36c71
NC
610/* no longer used anywhere in core */
611#ifndef PERL_CORE
46471bde
NC
612#define cv_ckproto(cv, gv, p) \
613 cv_ckproto_len((cv), (gv), (p), (p) ? strlen(p) : 0)
33f36c71
NC
614#endif
615
e5dd39fc 616#ifdef USE_REENTRANT_API
10bc17b6 617#include "reentr.h"
e5dd39fc
AB
618#endif
619
c7e45529
AE
620#if defined(PL_OP_SLAB_ALLOC)
621#define NewOp(m,var,c,type) \
e91d68d5 622 (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
c7e45529 623#define NewOpSz(m,var,size) \
e91d68d5 624 (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
c7e45529
AE
625#define FreeOp(p) Perl_Slab_Free(aTHX_ p)
626#else
04e62e51
NC
627#define NewOp(m, var, c, type) \
628 (var = (MEM_WRAP_CHECK_(c,type) \
629 (type*)PerlMemShared_calloc(c, sizeof(type))))
113b9ccf 630#define NewOpSz(m, var, size) \
04e62e51
NC
631 (var = (OP*)PerlMemShared_calloc(1, size))
632#define FreeOp(p) PerlMemShared_free(p)
c7e45529 633#endif
598921a7
NC
634
635#ifdef PERL_MAD
636# define MAD_NULL 1
637# define MAD_PV 2
638# define MAD_OP 3
639# define MAD_SV 4
640
641struct madprop {
642 MADPROP* mad_next;
594c10dc 643 const void *mad_val;
598921a7
NC
644 U32 mad_vlen;
645/* short mad_count; */
646 char mad_key;
647 char mad_type;
648};
649
650struct token {
651 I32 tk_type;
652 YYSTYPE tk_lval;
653 MADPROP* tk_mad;
654};
655#endif
2d910ff8
RGS
656
657/*
2b3def87 658 * Values that can be held by mad_key :
2d910ff8
RGS
659 * ^ unfilled head spot
660 * , literal ,
661 * ; literal ; (blank if implicit ; at end of block)
662 * : literal : from ?: or attr list
663 * + unary +
664 * ? literal ? from ?:
665 * ( literal (
666 * ) literal )
667 * [ literal [
668 * ] literal ]
669 * { literal {
670 * } literal }
671 * @ literal @ sigil
672 * $ literal $ sigil
673 * * literal * sigil
674 * ! use is source filtered
675 * & & or sub
676 * # whitespace/comment following ; or }
677 * # $# sigil
678 * 1 1st ; from for(;;)
679 * 1 retired protasis
680 * 2 2nd ; from for(;;)
681 * 2 retired apodosis
682 * 3 C-style for list
683 * a sub or var attributes
684 * a non-method arrow operator
685 * A method arrow operator
686 * A use import args
687 * b format block
688 * B retired stub block
689 * C constant conditional op
690 * d declarator
691 * D do block
692 * e unreached "else" (see C)
693 * e expression producing E
694 * E tr/E/R/, /E/
695 * f folded constant op
696 * F peg op for format
63575281 697 * g op was forced to be a word
2d910ff8
RGS
698 * i if/unless modifier
699 * I if/elsif/unless statement
dde83331 700 * k local declarator
2d910ff8
RGS
701 * K retired kid op
702 * l last index of array ($#foo)
703 * L label
704 * m modifier on regex
2d910ff8
RGS
705 * n sub or format name
706 * o current operator/declarator name
707 * o else/continue
708 * O generic optimized op
709 * p peg to hold extra whitespace at statement level
710 * P peg op for package declaration
711 * q opening quote
712 * = quoted material
713 * Q closing quote
714 * Q optimized qw//
715 * r expression producing R
716 * R tr/E/R/ s/E/R/
2d910ff8
RGS
717 * s sub signature
718 * S use import stub (no import)
719 * S retired sort block
720 * t unreached "then" (see C)
721 * U use import op
722 * v private sv of for loop
723 * V use version
724 * w while/until modifier
725 * W while/for statement
726 * x optimized qw
727 * X random thing
728 * _ whitespace/comments preceding anything else
729 * ~ =~ operator
730 */
3f2908ec
NC
731
732/*
733 * Local variables:
734 * c-indentation-style: bsd
735 * c-basic-offset: 4
736 * indent-tabs-mode: t
737 * End:
738 *
739 * ex: set ts=8 sts=4 sw=4 noet:
740 */