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