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