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