This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
op_reg_common.h: Continue refactoring
[perl5.git] / op.h
CommitLineData
a0d0e21e 1/* op.h
79072805 2 *
1129b882
NC
3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 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 */
1850c8f9 39#include "op_reg_common.h"
79072805 40
79072805 41#define OPCODE U16
79072805 42
598921a7
NC
43#ifdef PERL_MAD
44# define MADPROP_IN_BASEOP MADPROP* op_madprop;
45#else
46# define MADPROP_IN_BASEOP
47#endif
48
61a59f30 49typedef PERL_BITFIELD16 Optype;
0053d415 50
0f4eea8f
DL
51#ifdef BASEOP_DEFINITION
52#define BASEOP BASEOP_DEFINITION
53#else
79072805
LW
54#define BASEOP \
55 OP* op_next; \
56 OP* op_sibling; \
4f63d024 57 OP* (CPERLscope(*op_ppaddr))(pTHX); \
598921a7 58 MADPROP_IN_BASEOP \
79072805 59 PADOFFSET op_targ; \
654eccd5
JD
60 PERL_BITFIELD16 op_type:9; \
61 PERL_BITFIELD16 op_opt:1; \
62 PERL_BITFIELD16 op_latefree:1; \
63 PERL_BITFIELD16 op_latefreed:1; \
64 PERL_BITFIELD16 op_attached:1; \
65 PERL_BITFIELD16 op_spare:3; \
a0d0e21e
LW
66 U8 op_flags; \
67 U8 op_private;
0f4eea8f 68#endif
79072805 69
0053d415
JD
70/* If op_type:9 is changed to :10, also change PUSHEVAL in cop.h.
71 Also, if the type of op_type is ever changed (e.g. to PERL_BITFIELD32)
72 then all the other bit-fields before/after it should change their
73 types too to let VC pack them into the same 4 byte integer.*/
17347a51 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
2f8edad0 81#define OP_GIMME_REVERSE(flags) ((flags) & G_WANT)
4f911530 82
954c1994 83/*
ccfc67b7
JH
84=head1 "Gimme" Values
85
954c1994
GS
86=for apidoc Amn|U32|GIMME_V
87The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
91e74348 88C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
683d9ad1 89respectively. See L<perlcall> for a usage example.
954c1994
GS
90
91=for apidoc Amn|U32|GIMME
92A backward-compatible version of C<GIMME_V> which can only return
93C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
94Deprecated. Use C<GIMME_V> instead.
95
96=cut
97*/
98
533c011a 99#define GIMME_V OP_GIMME(PL_op, block_gimme())
79072805
LW
100
101/* Public flags */
54310121
PP
102
103#define OPf_WANT 3 /* Mask for "want" bits: */
104#define OPf_WANT_VOID 1 /* Want nothing */
105#define OPf_WANT_SCALAR 2 /* Want single value */
106#define OPf_WANT_LIST 3 /* Want list of any length */
79072805
LW
107#define OPf_KIDS 4 /* There is a firstborn child. */
108#define OPf_PARENS 8 /* This operator was parenthesized. */
463ee0b2 109 /* (Or block needs explicit scope entry.) */
a0d0e21e
LW
110#define OPf_REF 16 /* Certified reference. */
111 /* (Return container, not containee). */
112#define OPf_MOD 32 /* Will modify (lvalue). */
113#define OPf_STACKED 64 /* Some arg is arriving on the stack. */
79072805
LW
114#define OPf_SPECIAL 128 /* Do something weird for this op: */
115 /* On local LVAL, don't init local value. */
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 */
0ac6acae 127 /* On pushre, rx is used as part of split, e.g. split " " */
497711e7 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 */
e91684bf 141 /* On OP_ENTER, store caller context */
9711599e
CS
142 /* On OP_HELEM and OP_HSLICE, localization will be followed
143 by assignment, so do not wipe the target if it is special
144 (e.g. a glob or a magic SV) */
79072805 145
54310121 146/* old names; don't use in new code, but don't break them, either */
d91ab173
GS
147#define OPf_LIST OPf_WANT_LIST
148#define OPf_KNOW OPf_WANT
954c1994 149
54310121 150#define GIMME \
62a559b8
NIS
151 (PL_op->op_flags & OPf_WANT \
152 ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \
d91ab173
GS
153 ? G_ARRAY \
154 : G_SCALAR) \
155 : dowantarray())
54310121 156
51a68671 157/* NOTE: OP_NEXTSTATE and OP_DBSTATE (i.e. COPs) carry lower
d41ff1b8
GS
158 * bits of PL_hints in op_private */
159
a0d0e21e 160/* Private for lvalues */
cd06dffe 161#define OPpLVAL_INTRO 128 /* Lvalue must be localized or lvalue sub */
a0d0e21e 162
7934575e
GS
163/* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
164#define OPpREFCOUNTED 64 /* op_targ carries a refcount */
165
a0d0e21e
LW
166/* Private for OP_AASSIGN */
167#define OPpASSIGN_COMMON 64 /* Left & right have syms in common. */
168
169/* Private for OP_SASSIGN */
170#define OPpASSIGN_BACKWARDS 64 /* Left & right switched. */
e26df76a 171#define OPpASSIGN_CV_TO_GV 128 /* Possible optimisation for constants. */
79072805 172
c90c0ff4
PP
173/* Private for OP_MATCH and OP_SUBST{,CONST} */
174#define OPpRUNTIME 64 /* Pattern coming in on the stack */
175
79072805 176/* Private for OP_TRANS */
4757a243
LW
177#define OPpTRANS_FROM_UTF 1
178#define OPpTRANS_TO_UTF 2
383e7cdd 179#define OPpTRANS_IDENTICAL 4 /* right side is same as left */
4757a243 180#define OPpTRANS_SQUASH 8
59f00321 181 /* 16 is used for OPpTARGET_MY */
4757a243
LW
182#define OPpTRANS_COMPLEMENT 32
183#define OPpTRANS_GROWS 64
59f00321
RGS
184#define OPpTRANS_DELETE 128
185#define OPpTRANS_ALL (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
79072805
LW
186
187/* Private for OP_REPEAT */
a0d0e21e 188#define OPpREPEAT_DOLIST 64 /* List replication. */
79072805 189
cf2dc985 190/* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
314d4778 191#define OPpDEREF (32|64) /* autovivify: Want ref to something: */
5f05dabc
PP
192#define OPpDEREF_AV 32 /* Want ref to AV. */
193#define OPpDEREF_HV 64 /* Want ref to HV. */
194#define OPpDEREF_SV (32|64) /* Want ref to SV. */
0824d667
DM
195/* Private for OP_RV2SV, OP_RV2AV, OP_RV2AV */
196#define OPpDEREFed 4 /* prev op was OPpDEREF */
68dc0745
PP
197 /* OP_ENTERSUB only */
198#define OPpENTERSUB_DB 16 /* Debug subroutine. */
d3011074 199#define OPpENTERSUB_HASTARG 32 /* Called from OP tree. */
95f0a2f1 200#define OPpENTERSUB_NOMOD 64 /* Immune to mod() for :attrlist. */
b900987b 201 /* OP_ENTERSUB and OP_RV2CV only */
68dc0745 202#define OPpENTERSUB_AMPER 8 /* Used & form to call. */
9675f7ac 203#define OPpENTERSUB_NOPAREN 128 /* bare sub call (without parens) */
cd06dffe 204#define OPpENTERSUB_INARGS 4 /* Lval used as arg to a sub. */
76cd736e
GS
205 /* OP_GV only */
206#define OPpEARLY_CV 32 /* foo() called before sub foo was parsed */
68dc0745
PP
207 /* OP_?ELEM only */
208#define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */
241416b8 209 /* OP_RV2?V, OP_GVSV, OP_ENTERITER only */
78f9721b 210#define OPpOUR_INTRO 16 /* Variable was in an our() */
cb0d96b9 211 /* OP_RV2[AGH]V, OP_PAD[AH]V, OP_[AH]ELEM */
78f9721b 212#define OPpMAYBE_LVSUB 8 /* We might be an lvalue to return */
952306ac
RGS
213 /* OP_PADSV only */
214#define OPpPAD_STATE 16 /* is a "state" pad */
192587c2 215 /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
79072805 216
e26df76a 217 /* OP_RV2GV only */
cb0d96b9 218#define OPpDONT_INIT_GV 4 /* Call gv_fetchpv with GV_NOINIT */
e26df76a
NC
219/* (Therefore will return whatever is currently in the symbol table, not
220 guaranteed to be a PVGV) */
221
222 /* OP_RV2CV only */
223#define OPpMAY_RETURN_CONSTANT 1 /* If a constant sub, return the constant */
224
b162f9ea
IZ
225/* Private for OPs with TARGLEX */
226 /* (lower bits may carry MAXARG) */
227#define OPpTARGET_MY 16 /* Target is PADMY. */
228
ef3e5ea9
NC
229/* Private for OP_ENTERITER and OP_ITER */
230#define OPpITER_REVERSED 4 /* for (reverse ...) */
0d863452 231#define OPpITER_DEF 8 /* for $_ or for my $_ */
ef3e5ea9 232
79072805 233/* Private for OP_CONST */
468aa647 234#define OPpCONST_NOVER 2 /* no 6; */
e7fec78e 235#define OPpCONST_SHORTCIRCUIT 4 /* eg the constant 5 in (5 || foo) */
7a52d87a 236#define OPpCONST_STRICT 8 /* bearword subject to strict 'subs' */
748a9306
LW
237#define OPpCONST_ENTERED 16 /* Has been entered as symbol. */
238#define OPpCONST_ARYBASE 32 /* Was a $[ translated to constant. */
a0d0e21e 239#define OPpCONST_BARE 64 /* Was a bare word (filehandle?). */
599cee73 240#define OPpCONST_WARNING 128 /* Was a $^W translated to constant. */
79072805
LW
241
242/* Private for OP_FLIP/FLOP */
a0d0e21e 243#define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */
79072805 244
ed6116ce 245/* Private for OP_LIST */
a0d0e21e
LW
246#define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */
247
5f05dabc 248/* Private for OP_DELETE */
54310121 249#define OPpSLICE 64 /* Operating on a list of keys */
7332a6c4 250/* Also OPpLVAL_INTRO (128) */
5f05dabc 251
afebc493
GS
252/* Private for OP_EXISTS */
253#define OPpEXISTS_SUB 64 /* Checking for &sub, not {} or []. */
254
9c007264
JH
255/* Private for OP_SORT */
256#define OPpSORT_NUMERIC 1 /* Optimized away { $a <=> $b } */
257#define OPpSORT_INTEGER 2 /* Ditto while under "use integer" */
eb209983 258#define OPpSORT_REVERSE 4 /* Reversed sort */
fe1bc4cf 259#define OPpSORT_INPLACE 8 /* sort in-place; eg @a = sort @a */
eb209983 260#define OPpSORT_DESCEND 16 /* Descending sort */
7b9ef140
RH
261#define OPpSORT_QSORT 32 /* Use quicksort (not mergesort) */
262#define OPpSORT_STABLE 64 /* Use a stable algorithm */
263
484c818f
VP
264/* Private for OP_REVERSE */
265#define OPpREVERSE_INPLACE 8 /* reverse in-place (@a = reverse @a) */
266
16fe6d59
GS
267/* Private for OP_OPEN and OP_BACKTICK */
268#define OPpOPEN_IN_RAW 16 /* binmode(F,":raw") on input fh */
269#define OPpOPEN_IN_CRLF 32 /* binmode(F,":crlf") on input fh */
270#define OPpOPEN_OUT_RAW 64 /* binmode(F,":raw") on output fh */
271#define OPpOPEN_OUT_CRLF 128 /* binmode(F,":crlf") on output fh */
272
96e176bf
CL
273/* Private for OP_EXIT, HUSH also for OP_DIE */
274#define OPpHUSH_VMSISH 64 /* hush DCL exit msg vmsish mode*/
d98f61e7
GS
275#define OPpEXIT_VMSISH 128 /* exit(0) vs. exit(1) vmsish mode*/
276
0d863452 277/* Private for OP_FTXXX */
1af34c76 278#define OPpFT_ACCESS 2 /* use filetest 'access' */
fbb0b3b3 279#define OPpFT_STACKED 4 /* stacked filetest, as in "-f -x $f" */
1af34c76 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
14a49a24
NC
343#define PM_GETRE(o) (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
344 ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
ede1273d
NC
345/* The assignment is just to enforce type safety (or at least get a warning).
346 */
14a49a24
NC
347/* With first class regexps not via a reference one needs to assign
348 &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
349 is cheaper. I guess we could allow NULL, but the check above would get
350 more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
351/* BEWARE - something that calls this macro passes (r) which has a side
352 effect. */
ede1273d 353#define PM_SETRE(o,r) STMT_START { \
b1bc3f34 354 REGEXP *const _pm_setre = (r); \
7948fc08 355 assert(_pm_setre); \
b1bc3f34 356 PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
ede1273d 357 } STMT_END
1fcf4c12 358#else
b9ed2502
AB
359#define PM_GETRE(o) ((o)->op_pmregexp)
360#define PM_SETRE(o,r) ((o)->op_pmregexp = (r))
1fcf4c12 361#endif
4825b64b 362
3214c85f 363#define PMf_BASE_SHIFT ((_RXf_PMf_SHIFT_NEXT)-1)
f4a4cecb 364
1850c8f9 365/* taint $1 etc. if target tainted */
f4a4cecb 366#define PMf_RETAINT (1<<(PMf_BASE_SHIFT+1))
c737faaf 367
c0f1c194
KW
368/* match successfully only once per reset, with related flag RXf_USED in
369 * re->extflags holding state. This is used only for ?? matches, and only on
370 * OP_MATCH and OP_QR */
f4a4cecb 371#define PMf_ONCE (1<<(PMf_BASE_SHIFT+2))
1850c8f9
KW
372
373/* replacement contains variables */
f4a4cecb 374#define PMf_MAYBE_CONST (1<<(PMf_BASE_SHIFT+3))
1850c8f9
KW
375
376/* PMf_ONCE has matched successfully. Not used under threading. */
f4a4cecb 377#define PMf_USED (1<<(PMf_BASE_SHIFT+4))
1850c8f9
KW
378
379/* subst replacement is constant */
f4a4cecb 380#define PMf_CONST (1<<(PMf_BASE_SHIFT+5))
c737faaf 381
1850c8f9 382/* keep 1st runtime pattern forever */
f4a4cecb
KW
383#define PMf_KEEP (1<<(PMf_BASE_SHIFT+6))
384#define PMf_GLOBAL (1<<(PMf_BASE_SHIFT+7)) /* pattern had a g modifier */
c737faaf 385
1850c8f9 386/* don't reset pos() if //g fails */
f4a4cecb 387#define PMf_CONTINUE (1<<(PMf_BASE_SHIFT+8))
1850c8f9
KW
388
389/* evaluating replacement as expr */
f4a4cecb 390#define PMf_EVAL (1<<(PMf_BASE_SHIFT+9))
c0f1c194
KW
391
392/* Return substituted string instead of modifying it. */
f4a4cecb 393#define PMf_NONDESTRUCT (1<<(PMf_BASE_SHIFT+10))
e357fc67 394
f4a4cecb 395#if PMf_BASE_SHIFT+10 > 31
32cdcf9d 396# error Too many PMf_ bits used. See above and regnodes.h for any spare in middle
1850c8f9 397#endif
79072805 398
cb55de95 399#ifdef USE_ITHREADS
05ec9bb3 400
29f2e912
NC
401# define PmopSTASHPV(o) \
402 (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstashpv : NULL)
403# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
404# define PmopSTASHPV_set(o,pv) ({ \
405 assert((o)->op_pmflags & PMf_ONCE); \
406 ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv)); \
407 })
408# else
409# define PmopSTASHPV_set(o,pv) \
410 ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv))
411# endif
cb55de95 412# define PmopSTASH(o) (PmopSTASHPV(o) \
29f2e912 413 ? gv_stashpv((o)->op_pmstashstartu.op_pmstashpv,GV_ADD) : NULL)
bd61b366 414# define PmopSTASH_set(o,hv) PmopSTASHPV_set(o, ((hv) ? HvNAME_get(hv) : NULL))
05ec9bb3
NIS
415# define PmopSTASH_free(o) PerlMemShared_free(PmopSTASHPV(o))
416
cb55de95 417#else
29f2e912
NC
418# define PmopSTASH(o) \
419 (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
420# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
421# define PmopSTASH_set(o,hv) ({ \
422 assert((o)->op_pmflags & PMf_ONCE); \
423 ((o)->op_pmstashstartu.op_pmstash = (hv)); \
424 })
425# else
426# define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
427# endif
bd61b366 428# define PmopSTASHPV(o) (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
29f2e912 429 /* op_pmstashstartu.op_pmstash is not refcounted */
cb55de95 430# define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
c4bd3ae5
NC
431/* Note that if this becomes non-empty, then S_forget_pmop in op.c will need
432 changing */
05ec9bb3 433# define PmopSTASH_free(o)
cb55de95
JH
434#endif
435
79072805
LW
436struct svop {
437 BASEOP
438 SV * op_sv;
439};
440
7934575e 441struct padop {
79072805 442 BASEOP
7934575e 443 PADOFFSET op_padix;
79072805
LW
444};
445
446struct pvop {
447 BASEOP
448 char * op_pv;
449};
450
79072805
LW
451struct loop {
452 BASEOP
453 OP * op_first;
454 OP * op_last;
79072805
LW
455 OP * op_redoop;
456 OP * op_nextop;
457 OP * op_lastop;
458};
459
350de78d
GS
460#define cUNOPx(o) ((UNOP*)o)
461#define cBINOPx(o) ((BINOP*)o)
462#define cLISTOPx(o) ((LISTOP*)o)
463#define cLOGOPx(o) ((LOGOP*)o)
464#define cPMOPx(o) ((PMOP*)o)
465#define cSVOPx(o) ((SVOP*)o)
466#define cPADOPx(o) ((PADOP*)o)
467#define cPVOPx(o) ((PVOP*)o)
468#define cCOPx(o) ((COP*)o)
469#define cLOOPx(o) ((LOOP*)o)
470
471#define cUNOP cUNOPx(PL_op)
472#define cBINOP cBINOPx(PL_op)
473#define cLISTOP cLISTOPx(PL_op)
474#define cLOGOP cLOGOPx(PL_op)
475#define cPMOP cPMOPx(PL_op)
476#define cSVOP cSVOPx(PL_op)
477#define cPADOP cPADOPx(PL_op)
478#define cPVOP cPVOPx(PL_op)
479#define cCOP cCOPx(PL_op)
480#define cLOOP cLOOPx(PL_op)
481
482#define cUNOPo cUNOPx(o)
483#define cBINOPo cBINOPx(o)
484#define cLISTOPo cLISTOPx(o)
485#define cLOGOPo cLOGOPx(o)
486#define cPMOPo cPMOPx(o)
487#define cSVOPo cSVOPx(o)
488#define cPADOPo cPADOPx(o)
489#define cPVOPo cPVOPx(o)
490#define cCOPo cCOPx(o)
491#define cLOOPo cLOOPx(o)
492
493#define kUNOP cUNOPx(kid)
494#define kBINOP cBINOPx(kid)
495#define kLISTOP cLISTOPx(kid)
496#define kLOGOP cLOGOPx(kid)
497#define kPMOP cPMOPx(kid)
498#define kSVOP cSVOPx(kid)
499#define kPADOP cPADOPx(kid)
500#define kPVOP cPVOPx(kid)
501#define kCOP cCOPx(kid)
502#define kLOOP cLOOPx(kid)
503
504
505#ifdef USE_ITHREADS
dd2155a4 506# define cGVOPx_gv(o) ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
cecf5685
NC
507# define IS_PADGV(v) (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
508 && GvIN_PAD(v))
7766f137
GS
509# define IS_PADCONST(v) (v && SvREADONLY(v))
510# define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
dd2155a4 511 ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
638eceb6 512# define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
dd2155a4 513 ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
350de78d 514#else
638eceb6 515# define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
743e66e6 516# define IS_PADGV(v) FALSE
7766f137
GS
517# define IS_PADCONST(v) FALSE
518# define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
638eceb6 519# define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
350de78d 520#endif
79072805 521
638eceb6
GS
522#define cGVOP_gv cGVOPx_gv(PL_op)
523#define cGVOPo_gv cGVOPx_gv(o)
524#define kGVOP_gv cGVOPx_gv(kid)
525#define cSVOP_sv cSVOPx_sv(PL_op)
526#define cSVOPo_sv cSVOPx_sv(o)
527#define kSVOP_sv cSVOPx_sv(kid)
7766f137 528
bcabcc50
NC
529#ifndef PERL_CORE
530# define Nullop ((OP*)NULL)
531#endif
79072805 532
91135acb 533/* Lowest byte-and-a-bit of PL_opargs */
a0d0e21e
LW
534#define OA_MARK 1
535#define OA_FOLDCONST 2
536#define OA_RETSCALAR 4
537#define OA_TARGET 8
538#define OA_RETINTEGER 16
539#define OA_OTHERINT 32
540#define OA_DANGEROUS 64
541#define OA_DEFGV 128
b162f9ea 542#define OA_TARGLEX 256
a0d0e21e 543
db173bac 544/* The next 4 bits encode op class information */
b162f9ea
IZ
545#define OCSHIFT 9
546
547#define OA_CLASS_MASK (15 << OCSHIFT)
548
549#define OA_BASEOP (0 << OCSHIFT)
550#define OA_UNOP (1 << OCSHIFT)
551#define OA_BINOP (2 << OCSHIFT)
552#define OA_LOGOP (3 << OCSHIFT)
1a67a97c
SM
553#define OA_LISTOP (4 << OCSHIFT)
554#define OA_PMOP (5 << OCSHIFT)
555#define OA_SVOP (6 << OCSHIFT)
7934575e 556#define OA_PADOP (7 << OCSHIFT)
1a67a97c
SM
557#define OA_PVOP_OR_SVOP (8 << OCSHIFT)
558#define OA_LOOP (9 << OCSHIFT)
559#define OA_COP (10 << OCSHIFT)
560#define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
561#define OA_FILESTATOP (12 << OCSHIFT)
562#define OA_LOOPEXOP (13 << OCSHIFT)
b162f9ea
IZ
563
564#define OASHIFT 13
a0d0e21e 565
4369b173 566/* Remaining nybbles of PL_opargs */
a0d0e21e
LW
567#define OA_SCALAR 1
568#define OA_LIST 2
569#define OA_AVREF 3
570#define OA_HVREF 4
571#define OA_CVREF 5
572#define OA_FILEREF 6
573#define OA_SCALARREF 7
574#define OA_OPTIONAL 8
575
d3c72c2a
DM
576/* Op_REFCNT is a reference count at the head of each op tree: needed
577 * since the tree is shared between threads, and between cloned closure
578 * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
579 * this count.
580 * The same mutex is used to protect the refcounts of the reg_trie_data
581 * and reg_ac_data structures, which are shared between duplicated
582 * regexes.
583 */
584
534825c4
GS
585#ifdef USE_ITHREADS
586# define OP_REFCNT_INIT MUTEX_INIT(&PL_op_mutex)
4026c95a
SH
587# ifdef PERL_CORE
588# define OP_REFCNT_LOCK MUTEX_LOCK(&PL_op_mutex)
589# define OP_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_op_mutex)
590# else
591# define OP_REFCNT_LOCK op_refcnt_lock()
592# define OP_REFCNT_UNLOCK op_refcnt_unlock()
593# endif
534825c4 594# define OP_REFCNT_TERM MUTEX_DESTROY(&PL_op_mutex)
534825c4
GS
595#else
596# define OP_REFCNT_INIT NOOP
597# define OP_REFCNT_LOCK NOOP
598# define OP_REFCNT_UNLOCK NOOP
599# define OP_REFCNT_TERM NOOP
534825c4 600#endif
e4783991 601
282f25c9 602#define OpREFCNT_set(o,n) ((o)->op_targ = (n))
fc97af9c
NC
603#ifdef PERL_DEBUG_READONLY_OPS
604# define OpREFCNT_inc(o) Perl_op_refcnt_inc(aTHX_ o)
605# define OpREFCNT_dec(o) Perl_op_refcnt_dec(aTHX_ o)
606#else
607# define OpREFCNT_inc(o) ((o) ? (++(o)->op_targ, (o)) : NULL)
608# define OpREFCNT_dec(o) (--(o)->op_targ)
609#endif
282f25c9 610
e4783991 611/* flags used by Perl_load_module() */
ec6d81ab
RGS
612#define PERL_LOADMOD_DENY 0x1 /* no Module */
613#define PERL_LOADMOD_NOIMPORT 0x2 /* use Module () */
614#define PERL_LOADMOD_IMPORT_OPS 0x4 /* use Module (...) */
e5dd39fc 615
a0c21aa1 616#if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C)
e4c5ccf3 617#define ref(o, type) doref(o, type, TRUE)
a0c21aa1 618#endif
e4c5ccf3 619
33f36c71
NC
620/* no longer used anywhere in core */
621#ifndef PERL_CORE
46471bde
NC
622#define cv_ckproto(cv, gv, p) \
623 cv_ckproto_len((cv), (gv), (p), (p) ? strlen(p) : 0)
33f36c71
NC
624#endif
625
7d0905b9
NC
626#ifdef PERL_CORE
627# define my(o) my_attrs((o), NULL)
628#endif
629
e5dd39fc 630#ifdef USE_REENTRANT_API
10bc17b6 631#include "reentr.h"
e5dd39fc
AB
632#endif
633
c7e45529
AE
634#if defined(PL_OP_SLAB_ALLOC)
635#define NewOp(m,var,c,type) \
e91d68d5 636 (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
c7e45529 637#define NewOpSz(m,var,size) \
e91d68d5 638 (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
c7e45529
AE
639#define FreeOp(p) Perl_Slab_Free(aTHX_ p)
640#else
04e62e51
NC
641#define NewOp(m, var, c, type) \
642 (var = (MEM_WRAP_CHECK_(c,type) \
643 (type*)PerlMemShared_calloc(c, sizeof(type))))
113b9ccf 644#define NewOpSz(m, var, size) \
04e62e51
NC
645 (var = (OP*)PerlMemShared_calloc(1, size))
646#define FreeOp(p) PerlMemShared_free(p)
c7e45529 647#endif
598921a7 648
1930840b 649struct block_hooks {
52db365a 650 U32 bhk_flags;
1930840b
BM
651 void (*bhk_start) (pTHX_ int full);
652 void (*bhk_pre_end) (pTHX_ OP **seq);
653 void (*bhk_post_end) (pTHX_ OP **seq);
52db365a 654 void (*bhk_eval) (pTHX_ OP *const saveop);
1930840b
BM
655};
656
fd85fad2
BM
657/*
658=head1 Compile-time scope hooks
659
660=for apidoc m|U32|BhkFLAGS|BHK *hk
661Return the BHK's flags.
662
663=for apidoc m|void *|BhkENTRY|BHK *hk|which
664Return an entry from the BHK structure. I<which> is a preprocessor token
665indicating which entry to return. If the appropriate flag is not set
666this will return NULL. The type of the return value depends on which
667entry you ask for.
668
669=for apidoc Am|void|BhkENTRY_set|BHK *hk|which|void *ptr
670Set an entry in the BHK structure, and set the flags to indicate it is
671valid. I<which> is a preprocessing token indicating which entry to set.
672The type of I<ptr> depends on the entry.
673
a3e07c87
BM
674=for apidoc Am|void|BhkDISABLE|BHK *hk|which
675Temporarily disable an entry in this BHK structure, by clearing the
676appropriate flag. I<which> is a preprocessor token indicating which
677entry to disable.
678
679=for apidoc Am|void|BhkENABLE|BHK *hk|which
680Re-enable an entry in this BHK structure, by setting the appropriate
681flag. I<which> is a preprocessor token indicating which entry to enable.
682This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
683pointer.
684
fd85fad2
BM
685=for apidoc m|void|CALL_BLOCK_HOOKS|which|arg
686Call all the registered block hooks for type I<which>. I<which> is a
687preprocessing token; the type of I<arg> depends on I<which>.
688
689=cut
690*/
691
52db365a
BM
692#define BhkFLAGS(hk) ((hk)->bhk_flags)
693
694#define BHKf_start 0x01
695#define BHKf_pre_end 0x02
696#define BHKf_post_end 0x04
697#define BHKf_eval 0x08
698
699#define BhkENTRY(hk, which) \
700 ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->bhk_ ## which) : NULL)
701
a3e07c87
BM
702#define BhkENABLE(hk, which) \
703 STMT_START { \
704 BhkFLAGS(hk) |= BHKf_ ## which; \
705 assert(BhkENTRY(hk, which)); \
706 } STMT_END
707
708#define BhkDISABLE(hk, which) \
709 STMT_START { \
710 BhkFLAGS(hk) &= ~(BHKf_ ## which); \
711 } STMT_END
712
52db365a
BM
713#define BhkENTRY_set(hk, which, ptr) \
714 STMT_START { \
715 (hk)->bhk_ ## which = ptr; \
a3e07c87 716 BhkENABLE(hk, which); \
52db365a
BM
717 } STMT_END
718
1930840b
BM
719#define CALL_BLOCK_HOOKS(which, arg) \
720 STMT_START { \
721 if (PL_blockhooks) { \
722 I32 i; \
723 for (i = av_len(PL_blockhooks); i >= 0; i--) { \
724 SV *sv = AvARRAY(PL_blockhooks)[i]; \
52db365a 725 BHK *hk; \
1930840b
BM
726 \
727 assert(SvIOK(sv)); \
728 if (SvUOK(sv)) \
52db365a 729 hk = INT2PTR(BHK *, SvUVX(sv)); \
1930840b 730 else \
52db365a 731 hk = INT2PTR(BHK *, SvIVX(sv)); \
1930840b 732 \
52db365a
BM
733 if (BhkENTRY(hk, which)) \
734 CALL_FPTR(BhkENTRY(hk, which))(aTHX_ arg); \
1930840b
BM
735 } \
736 } \
737 } STMT_END
738
598921a7
NC
739#ifdef PERL_MAD
740# define MAD_NULL 1
741# define MAD_PV 2
742# define MAD_OP 3
743# define MAD_SV 4
744
745struct madprop {
746 MADPROP* mad_next;
d503a9ba 747 void *mad_val;
598921a7
NC
748 U32 mad_vlen;
749/* short mad_count; */
750 char mad_key;
751 char mad_type;
752};
753
754struct token {
755 I32 tk_type;
756 YYSTYPE tk_lval;
757 MADPROP* tk_mad;
758};
759#endif
2d910ff8
RGS
760
761/*
2b3def87 762 * Values that can be held by mad_key :
2d910ff8
RGS
763 * ^ unfilled head spot
764 * , literal ,
765 * ; literal ; (blank if implicit ; at end of block)
766 * : literal : from ?: or attr list
767 * + unary +
768 * ? literal ? from ?:
769 * ( literal (
770 * ) literal )
771 * [ literal [
772 * ] literal ]
773 * { literal {
774 * } literal }
775 * @ literal @ sigil
776 * $ literal $ sigil
777 * * literal * sigil
778 * ! use is source filtered
779 * & & or sub
780 * # whitespace/comment following ; or }
781 * # $# sigil
782 * 1 1st ; from for(;;)
783 * 1 retired protasis
784 * 2 2nd ; from for(;;)
785 * 2 retired apodosis
786 * 3 C-style for list
787 * a sub or var attributes
788 * a non-method arrow operator
789 * A method arrow operator
790 * A use import args
791 * b format block
792 * B retired stub block
793 * C constant conditional op
794 * d declarator
795 * D do block
796 * e unreached "else" (see C)
797 * e expression producing E
798 * E tr/E/R/, /E/
799 * f folded constant op
800 * F peg op for format
63575281 801 * g op was forced to be a word
2d910ff8
RGS
802 * i if/unless modifier
803 * I if/elsif/unless statement
dde83331 804 * k local declarator
2d910ff8
RGS
805 * K retired kid op
806 * l last index of array ($#foo)
807 * L label
808 * m modifier on regex
2d910ff8
RGS
809 * n sub or format name
810 * o current operator/declarator name
811 * o else/continue
812 * O generic optimized op
813 * p peg to hold extra whitespace at statement level
814 * P peg op for package declaration
815 * q opening quote
816 * = quoted material
817 * Q closing quote
818 * Q optimized qw//
819 * r expression producing R
820 * R tr/E/R/ s/E/R/
2d910ff8
RGS
821 * s sub signature
822 * S use import stub (no import)
823 * S retired sort block
824 * t unreached "then" (see C)
825 * U use import op
826 * v private sv of for loop
827 * V use version
828 * w while/until modifier
829 * W while/for statement
830 * x optimized qw
831 * X random thing
832 * _ whitespace/comments preceding anything else
833 * ~ =~ operator
834 */
3f2908ec
NC
835
836/*
837 * Local variables:
838 * c-indentation-style: bsd
839 * c-basic-offset: 4
840 * indent-tabs-mode: t
841 * End:
842 *
843 * ex: set ts=8 sts=4 sw=4 noet:
844 */