This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
op.h: Describe entersub and rv2cv flags
[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.
8be227ab 22 * op_slabbed allocated via opslab
90840c5d
RU
23 * op_static tell op_free() to skip PerlMemShared_free(), when
24 * !op_slabbed.
bb38a9e0 25 * op_savefree on savestack via SAVEFREEOP
3513c740
NT
26 * op_folded Result/remainder of a constant fold operation.
27 * op_spare Two spare bits
79072805
LW
28 * op_flags Flags common to all operations. See OPf_* below.
29 * op_private Flags peculiar to a particular operation (BUT,
30 * by default, set to the number of children until
31 * the operation is privatized by a check routine,
32 * which may or may not check number of children).
33 */
1850c8f9 34#include "op_reg_common.h"
79072805 35
79072805 36#define OPCODE U16
79072805 37
598921a7
NC
38#ifdef PERL_MAD
39# define MADPROP_IN_BASEOP MADPROP* op_madprop;
40#else
41# define MADPROP_IN_BASEOP
42#endif
43
61a59f30 44typedef PERL_BITFIELD16 Optype;
0053d415 45
0f4eea8f
DL
46#ifdef BASEOP_DEFINITION
47#define BASEOP BASEOP_DEFINITION
48#else
79072805
LW
49#define BASEOP \
50 OP* op_next; \
51 OP* op_sibling; \
16c91539 52 OP* (*op_ppaddr)(pTHX); \
598921a7 53 MADPROP_IN_BASEOP \
79072805 54 PADOFFSET op_targ; \
654eccd5
JD
55 PERL_BITFIELD16 op_type:9; \
56 PERL_BITFIELD16 op_opt:1; \
8be227ab 57 PERL_BITFIELD16 op_slabbed:1; \
bb38a9e0 58 PERL_BITFIELD16 op_savefree:1; \
90840c5d 59 PERL_BITFIELD16 op_static:1; \
3513c740
NT
60 PERL_BITFIELD16 op_folded:1; \
61 PERL_BITFIELD16 op_spare:2; \
a0d0e21e
LW
62 U8 op_flags; \
63 U8 op_private;
0f4eea8f 64#endif
79072805 65
0053d415
JD
66/* If op_type:9 is changed to :10, also change PUSHEVAL in cop.h.
67 Also, if the type of op_type is ever changed (e.g. to PERL_BITFIELD32)
68 then all the other bit-fields before/after it should change their
69 types too to let VC pack them into the same 4 byte integer.*/
17347a51 70
fe615074 71/* for efficiency, requires OPf_WANT_VOID == G_VOID etc */
54310121 72#define OP_GIMME(op,dfl) \
fe615074 73 (((op)->op_flags & OPf_WANT) ? ((op)->op_flags & OPf_WANT) : dfl)
54310121 74
2f8edad0 75#define OP_GIMME_REVERSE(flags) ((flags) & G_WANT)
4f911530 76
954c1994 77/*
ccfc67b7
JH
78=head1 "Gimme" Values
79
954c1994
GS
80=for apidoc Amn|U32|GIMME_V
81The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
91e74348 82C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
683d9ad1 83respectively. See L<perlcall> for a usage example.
954c1994
GS
84
85=for apidoc Amn|U32|GIMME
86A backward-compatible version of C<GIMME_V> which can only return
87C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
88Deprecated. Use C<GIMME_V> instead.
89
90=cut
91*/
92
533c011a 93#define GIMME_V OP_GIMME(PL_op, block_gimme())
79072805
LW
94
95/* Public flags */
54310121
PP
96
97#define OPf_WANT 3 /* Mask for "want" bits: */
98#define OPf_WANT_VOID 1 /* Want nothing */
99#define OPf_WANT_SCALAR 2 /* Want single value */
100#define OPf_WANT_LIST 3 /* Want list of any length */
79072805
LW
101#define OPf_KIDS 4 /* There is a firstborn child. */
102#define OPf_PARENS 8 /* This operator was parenthesized. */
463ee0b2 103 /* (Or block needs explicit scope entry.) */
a0d0e21e
LW
104#define OPf_REF 16 /* Certified reference. */
105 /* (Return container, not containee). */
106#define OPf_MOD 32 /* Will modify (lvalue). */
107#define OPf_STACKED 64 /* Some arg is arriving on the stack. */
79072805
LW
108#define OPf_SPECIAL 128 /* Do something weird for this op: */
109 /* On local LVAL, don't init local value. */
110 /* On OP_SORT, subroutine is inlined. */
111 /* On OP_NOT, inversion was implicit. */
a0d0e21e 112 /* On OP_LEAVE, don't restore curpm. */
79072805
LW
113 /* On truncate, we truncate filehandle */
114 /* On control verbs, we saw no label */
115 /* On flipflop, we saw ... instead of .. */
116 /* On UNOPs, saw bare parens, e.g. eof(). */
a0d0e21e 117 /* On OP_ENTERSUB || OP_NULL, saw a "do". */
afebc493 118 /* On OP_EXISTS, treat av as av, not avhv. */
f2ec2afd 119 /* On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
dbc200c5 120 /* On pushre, rx is used as part of split, e.g. split " " */
497711e7 121 /* On regcomp, "use re 'eval'" was in scope */
7c6fadd6 122 /* On OP_READLINE, was <$filehandle> */
17fda545
NC
123 /* On RV2[ACGHS]V, don't create GV--in
124 defined()*/
5df8de69
DM
125 /* On OP_DBSTATE, indicates breakpoint
126 * (runtime property) */
6b514a0d 127 /* On OP_REQUIRE, was seen as CORE::require */
fc7debfb
FC
128 /* On OP_(ENTER|LEAVE)WHEN, there's
129 no condition */
0d863452 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 */
9711599e
CS
133 /* On OP_HELEM and OP_HSLICE, localization will be followed
134 by assignment, so do not wipe the target if it is special
135 (e.g. a glob or a magic SV) */
2474a784
FC
136 /* On OP_MATCH, OP_SUBST & OP_TRANS, the
137 operand of a logical or conditional
138 that was optimised away, so it should
139 not be bound via =~ */
6b7c6d95 140 /* On OP_CONST, from a constant CV */
d67594ff
FC
141 /* On OP_GLOB, two meanings:
142 - Before ck_glob, called as CORE::glob
143 - After ck_glob, use Perl glob function
144 */
d5524600 145 /* On OP_PADRANGE, push @_ */
7d1d69cb 146 /* On OP_DUMP, has no label */
79072805 147
54310121 148/* old names; don't use in new code, but don't break them, either */
d91ab173
GS
149#define OPf_LIST OPf_WANT_LIST
150#define OPf_KNOW OPf_WANT
954c1994 151
54310121 152#define GIMME \
62a559b8
NIS
153 (PL_op->op_flags & OPf_WANT \
154 ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \
d91ab173
GS
155 ? G_ARRAY \
156 : G_SCALAR) \
157 : dowantarray())
54310121 158
1dafeec8
GG
159/* Lower bits of op_private often carry the number of arguments, as
160 * set by newBINOP, newUNOP and ck_fun */
161
894ea76b
FC
162/* NOTE: OP_NEXTSTATE and OP_DBSTATE (i.e. COPs) carry NATIVE_HINTS
163 * in op_private */
d41ff1b8 164
a0d0e21e 165/* Private for lvalues */
cd06dffe 166#define OPpLVAL_INTRO 128 /* Lvalue must be localized or lvalue sub */
a0d0e21e 167
1dafeec8
GG
168/* Private for OPs with TARGLEX */
169 /* (lower bits may carry MAXARG) */
170#define OPpTARGET_MY 16 /* Target is PADMY. */
171
7934575e
GS
172/* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
173#define OPpREFCOUNTED 64 /* op_targ carries a refcount */
174
a0d0e21e
LW
175/* Private for OP_AASSIGN */
176#define OPpASSIGN_COMMON 64 /* Left & right have syms in common. */
177
178/* Private for OP_SASSIGN */
179#define OPpASSIGN_BACKWARDS 64 /* Left & right switched. */
e26df76a 180#define OPpASSIGN_CV_TO_GV 128 /* Possible optimisation for constants. */
79072805 181
c657ea3a 182/* Private for OP_MATCH and OP_SUBST{,CONT} */
c90c0ff4
PP
183#define OPpRUNTIME 64 /* Pattern coming in on the stack */
184
79072805 185/* Private for OP_TRANS */
4757a243
LW
186#define OPpTRANS_FROM_UTF 1
187#define OPpTRANS_TO_UTF 2
383e7cdd 188#define OPpTRANS_IDENTICAL 4 /* right side is same as left */
4757a243 189#define OPpTRANS_SQUASH 8
59f00321 190 /* 16 is used for OPpTARGET_MY */
4757a243
LW
191#define OPpTRANS_COMPLEMENT 32
192#define OPpTRANS_GROWS 64
59f00321
RGS
193#define OPpTRANS_DELETE 128
194#define OPpTRANS_ALL (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
79072805
LW
195
196/* Private for OP_REPEAT */
a0d0e21e 197#define OPpREPEAT_DOLIST 64 /* List replication. */
79072805 198
cf2dc985 199/* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
314d4778 200#define OPpDEREF (32|64) /* autovivify: Want ref to something: */
5f05dabc
PP
201#define OPpDEREF_AV 32 /* Want ref to AV. */
202#define OPpDEREF_HV 64 /* Want ref to HV. */
203#define OPpDEREF_SV (32|64) /* Want ref to SV. */
777d9014 204
97e1065a
FC
205/* OP_ENTERSUB and OP_RV2CV flags
206
207Flags are set on entersub and rv2cv in three phases:
208 parser - the parser passes the flag to the op constructor
209 check - the check routine called by the op constructor sets the flag
210 context - application of scalar/ref/lvalue context applies the flag
211
212In the third stage, an entersub op might turn into an rv2cv op (undef &foo,
213\&foo, lock &foo, exists &foo, defined &foo). The two places where that
214happens (op_lvalue_flags and doref in op.c) need to make sure the flags do
215not conflict. Flags applied in the context phase are only set when there
216is no conversion of op type.
217
218 bit entersub flag phase rv2cv flag phase
219 --- ------------- ----- ---------- -----
220 1 OPpENTERSUB_INARGS context OPpMAY_RETURN_CONSTANT context
221 2 HINT_STRICT_REFS check HINT_STRICT_REFS check
222 4 OPpENTERSUB_HASTARG check
223 8 OPpENTERSUB_AMPER parser
224 16 OPpENTERSUB_DB check
225 32 OPpDEREF_AV context
226 64 OPpDEREF_HV context
227 128 OPpLVAL_INTRO context OPpENTERSUB_NOPAREN parser
228
229*/
230
68dc0745
PP
231 /* OP_ENTERSUB only */
232#define OPpENTERSUB_DB 16 /* Debug subroutine. */
6c5d4499
GG
233#define OPpENTERSUB_HASTARG 4 /* Called from OP tree. */
234#define OPpENTERSUB_INARGS 1 /* Lval used as arg to a sub. */
0e9700df 235/* used by OPpDEREF (32|64) */
81db4439 236/* used by HINT_STRICT_REFS 2 */
777d9014
FC
237 /* Mask for OP_ENTERSUB flags, the absence of which must be propagated
238 in dynamic context */
239#define OPpENTERSUB_LVAL_MASK (OPpLVAL_INTRO|OPpENTERSUB_INARGS)
240
d4ddbae8 241 /* OP_RV2CV only */
68dc0745 242#define OPpENTERSUB_AMPER 8 /* Used & form to call. */
9675f7ac 243#define OPpENTERSUB_NOPAREN 128 /* bare sub call (without parens) */
d4ddbae8
FC
244#define OPpMAY_RETURN_CONSTANT 1 /* If a constant sub, return the constant */
245
76cd736e
GS
246 /* OP_GV only */
247#define OPpEARLY_CV 32 /* foo() called before sub foo was parsed */
68dc0745
PP
248 /* OP_?ELEM only */
249#define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */
429a2555 250 /* OP_RV2[AH]V OP_KV[AH]SLICE OP_[AH]SLICE */
95a31aad 251#define OPpSLICEWARNING 4 /* warn about %hash{$scalar} */
8dc99089 252 /* OP_RV2[SAH]V, OP_GVSV, OP_ENTERITER only */
78f9721b 253#define OPpOUR_INTRO 16 /* Variable was in an our() */
6a8709a6
FC
254 /* OP_RV2[AGH]V, OP_PAD[AH]V, OP_[AH]ELEM, OP_[AH]SLICE OP_AV2ARYLEN,
255 OP_R?KEYS, OP_SUBSTR, OP_POS, OP_VEC */
78f9721b 256#define OPpMAYBE_LVSUB 8 /* We might be an lvalue to return */
6ea72b3a 257 /* OP_RV2HV and OP_PADHV */
c8fe3bdf
FC
258#define OPpTRUEBOOL 32 /* %hash in (%hash || $foo) in
259 void context */
adc42c31 260#define OPpMAYBE_TRUEBOOL 64 /* %hash in (%hash || $foo) where
6ea72b3a 261 cx is not known till run time */
24fcb59f
FC
262
263 /* OP_SUBSTR only */
264#define OPpSUBSTR_REPL_FIRST 16 /* 1st arg is replacement string */
265
952306ac
RGS
266 /* OP_PADSV only */
267#define OPpPAD_STATE 16 /* is a "state" pad */
192587c2 268 /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
79072805 269
a7fd8ef6
DM
270 /* OP_PADRANGE only */
271 /* bit 7 is OPpLVAL_INTRO */
4e09461c
DM
272#define OPpPADRANGE_COUNTMASK 127 /* bits 6..0 hold target range, */
273#define OPpPADRANGE_COUNTSHIFT 7 /* 7 bits in total */
a7fd8ef6 274
e26df76a 275 /* OP_RV2GV only */
cb0d96b9 276#define OPpDONT_INIT_GV 4 /* Call gv_fetchpv with GV_NOINIT */
e26df76a
NC
277/* (Therefore will return whatever is currently in the symbol table, not
278 guaranteed to be a PVGV) */
8dc99089 279#define OPpALLOW_FAKE 16 /* OK to return fake glob */
e26df76a 280
ef3e5ea9
NC
281/* Private for OP_ENTERITER and OP_ITER */
282#define OPpITER_REVERSED 4 /* for (reverse ...) */
0d863452 283#define OPpITER_DEF 8 /* for $_ or for my $_ */
ef3e5ea9 284
79072805 285/* Private for OP_CONST */
468aa647 286#define OPpCONST_NOVER 2 /* no 6; */
e7fec78e 287#define OPpCONST_SHORTCIRCUIT 4 /* eg the constant 5 in (5 || foo) */
486ec47a 288#define OPpCONST_STRICT 8 /* bareword subject to strict 'subs' */
748a9306 289#define OPpCONST_ENTERED 16 /* Has been entered as symbol. */
a0d0e21e 290#define OPpCONST_BARE 64 /* Was a bare word (filehandle?). */
3513c740 291/* Replaced by op_folded in perl itself, still used by B/B::Concise etc. */
cc2ebcd7 292#define OPpCONST_FOLDED 128 /* Result of constant folding */
79072805
LW
293
294/* Private for OP_FLIP/FLOP */
a0d0e21e 295#define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */
79072805 296
ed6116ce 297/* Private for OP_LIST */
a0d0e21e
LW
298#define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */
299
5f05dabc 300/* Private for OP_DELETE */
54310121 301#define OPpSLICE 64 /* Operating on a list of keys */
7332a6c4 302/* Also OPpLVAL_INTRO (128) */
5f05dabc 303
afebc493
GS
304/* Private for OP_EXISTS */
305#define OPpEXISTS_SUB 64 /* Checking for &sub, not {} or []. */
306
9c007264
JH
307/* Private for OP_SORT */
308#define OPpSORT_NUMERIC 1 /* Optimized away { $a <=> $b } */
309#define OPpSORT_INTEGER 2 /* Ditto while under "use integer" */
eb209983 310#define OPpSORT_REVERSE 4 /* Reversed sort */
fe1bc4cf 311#define OPpSORT_INPLACE 8 /* sort in-place; eg @a = sort @a */
eb209983 312#define OPpSORT_DESCEND 16 /* Descending sort */
7b9ef140
RH
313#define OPpSORT_QSORT 32 /* Use quicksort (not mergesort) */
314#define OPpSORT_STABLE 64 /* Use a stable algorithm */
315
484c818f
VP
316/* Private for OP_REVERSE */
317#define OPpREVERSE_INPLACE 8 /* reverse in-place (@a = reverse @a) */
318
16fe6d59
GS
319/* Private for OP_OPEN and OP_BACKTICK */
320#define OPpOPEN_IN_RAW 16 /* binmode(F,":raw") on input fh */
321#define OPpOPEN_IN_CRLF 32 /* binmode(F,":crlf") on input fh */
322#define OPpOPEN_OUT_RAW 64 /* binmode(F,":raw") on output fh */
323#define OPpOPEN_OUT_CRLF 128 /* binmode(F,":crlf") on output fh */
324
96e176bf
CL
325/* Private for OP_EXIT, HUSH also for OP_DIE */
326#define OPpHUSH_VMSISH 64 /* hush DCL exit msg vmsish mode*/
d98f61e7
GS
327#define OPpEXIT_VMSISH 128 /* exit(0) vs. exit(1) vmsish mode*/
328
0d863452 329/* Private for OP_FTXXX */
1af34c76 330#define OPpFT_ACCESS 2 /* use filetest 'access' */
bbd91306
GG
331#define OPpFT_STACKED 4 /* stacked filetest, as "-f" in "-f -x $f" */
332#define OPpFT_STACKING 8 /* stacking filetest, as "-x" in "-f -x $f" */
8db8f6b6 333#define OPpFT_AFTER_t 16 /* previous op was -t */
1af34c76 334
59f00321
RGS
335/* Private for OP_(MAP|GREP)(WHILE|START) */
336#define OPpGREP_LEX 2 /* iterate over lexical $_ */
337
0d863452
RH
338/* Private for OP_ENTEREVAL */
339#define OPpEVAL_HAS_HH 2 /* Does it have a copy of %^H */
802a15e9 340#define OPpEVAL_UNICODE 4
7d789282
FC
341#define OPpEVAL_BYTES 8
342#define OPpEVAL_COPHH 16 /* Construct %^H from cop hints */
a1941760 343#define OPpEVAL_RE_REPARSING 32 /* eval_sv(..., G_RE_REPARSING) */
0d863452 344
84ed0108 345/* Private for OP_CALLER, OP_WANTARRAY and OP_RUNCV */
93f0bc49
FC
346#define OPpOFFBYONE 128 /* Treat caller(1) as caller(2) */
347
e664e0a4 348/* Private for OP_COREARGS */
8dc99089
FC
349/* These must not conflict with OPpDONT_INIT_GV or OPpALLOW_FAKE.
350 See pp.c:S_rv2gv. */
e664e0a4
FC
351#define OPpCOREARGS_DEREF1 1 /* Arg 1 is a handle constructor */
352#define OPpCOREARGS_DEREF2 2 /* Arg 2 is a handle constructor */
cb85b2db 353#define OPpCOREARGS_SCALARMOD 64 /* \$ rather than \[$@%*] */
0b19d81a 354#define OPpCOREARGS_PUSHMARK 128 /* Call pp_pushmark */
e664e0a4 355
5db1eb8d
BF
356/* Private for OP_(LAST|REDO|NEXT|GOTO|DUMP) */
357#define OPpPV_IS_UTF8 128 /* label is in UTF8 */
358
60041a09
FC
359/* Private for OP_SPLIT */
360#define OPpSPLIT_IMPLIM 128 /* implicit limit */
361
79072805
LW
362struct op {
363 BASEOP
364};
365
366struct unop {
367 BASEOP
368 OP * op_first;
369};
370
371struct binop {
372 BASEOP
373 OP * op_first;
374 OP * op_last;
375};
376
377struct logop {
378 BASEOP
379 OP * op_first;
380 OP * op_other;
381};
382
79072805
LW
383struct listop {
384 BASEOP
385 OP * op_first;
386 OP * op_last;
79072805
LW
387};
388
389struct pmop {
390 BASEOP
391 OP * op_first;
392 OP * op_last;
1fcf4c12 393#ifdef USE_ITHREADS
784e50c8 394 PADOFFSET op_pmoffset;
1fcf4c12
AB
395#else
396 REGEXP * op_pmregexp; /* compiled expression */
397#endif
69bdead3 398 U32 op_pmflags;
29f2e912 399 union {
20e98b0f
NC
400 OP * op_pmreplroot; /* For OP_SUBST */
401#ifdef USE_ITHREADS
402 PADOFFSET op_pmtargetoff; /* For OP_PUSHRE */
403#else
404 GV * op_pmtargetgv;
405#endif
406 } op_pmreplrootu;
407 union {
29f2e912 408 OP * op_pmreplstart; /* Only used in OP_SUBST */
cb55de95 409#ifdef USE_ITHREADS
23083432 410 PADOFFSET op_pmstashoff; /* Only used in OP_MATCH, with PMf_ONCE set */
cb55de95 411#else
29f2e912 412 HV * op_pmstash;
cb55de95 413#endif
29f2e912 414 } op_pmstashstartu;
68e2671b 415 OP * op_code_list; /* list of (?{}) code blocks */
79072805 416};
a0d0e21e 417
1fcf4c12 418#ifdef USE_ITHREADS
14a49a24
NC
419#define PM_GETRE(o) (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
420 ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
ede1273d
NC
421/* The assignment is just to enforce type safety (or at least get a warning).
422 */
14a49a24
NC
423/* With first class regexps not via a reference one needs to assign
424 &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
425 is cheaper. I guess we could allow NULL, but the check above would get
426 more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
427/* BEWARE - something that calls this macro passes (r) which has a side
428 effect. */
ede1273d 429#define PM_SETRE(o,r) STMT_START { \
b1bc3f34 430 REGEXP *const _pm_setre = (r); \
7948fc08 431 assert(_pm_setre); \
b1bc3f34 432 PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
ede1273d 433 } STMT_END
1fcf4c12 434#else
b9ed2502
AB
435#define PM_GETRE(o) ((o)->op_pmregexp)
436#define PM_SETRE(o,r) ((o)->op_pmregexp = (r))
1fcf4c12 437#endif
4825b64b 438
beae72ee
KW
439/* Leave some space, so future bit allocations can go either in the shared or
440 * unshared area without affecting binary compatibility */
df7a8460 441#define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+6)
f4a4cecb 442
ef07e810 443/* 'use re "taint"' in scope: taint $1 etc. if target tainted */
1ad4ec54 444#define PMf_RETAINT (1<<(PMf_BASE_SHIFT+0))
c737faaf 445
c0f1c194
KW
446/* match successfully only once per reset, with related flag RXf_USED in
447 * re->extflags holding state. This is used only for ?? matches, and only on
448 * OP_MATCH and OP_QR */
1ad4ec54 449#define PMf_ONCE (1<<(PMf_BASE_SHIFT+1))
1850c8f9 450
d234778b 451/* PMf_ONCE, i.e. ?pat?, has matched successfully. Not used under threading. */
1ad4ec54 452#define PMf_USED (1<<(PMf_BASE_SHIFT+3))
1850c8f9
KW
453
454/* subst replacement is constant */
1ad4ec54 455#define PMf_CONST (1<<(PMf_BASE_SHIFT+4))
c737faaf 456
1850c8f9 457/* keep 1st runtime pattern forever */
1ad4ec54 458#define PMf_KEEP (1<<(PMf_BASE_SHIFT+5))
4da3eb8b 459
1ad4ec54 460#define PMf_GLOBAL (1<<(PMf_BASE_SHIFT+6)) /* pattern had a g modifier */
c737faaf 461
1850c8f9 462/* don't reset pos() if //g fails */
1ad4ec54 463#define PMf_CONTINUE (1<<(PMf_BASE_SHIFT+7))
1850c8f9
KW
464
465/* evaluating replacement as expr */
1ad4ec54 466#define PMf_EVAL (1<<(PMf_BASE_SHIFT+8))
c0f1c194
KW
467
468/* Return substituted string instead of modifying it. */
1ad4ec54 469#define PMf_NONDESTRUCT (1<<(PMf_BASE_SHIFT+9))
e357fc67 470
d63c20f2
DM
471/* the pattern has a CV attached (currently only under qr/...(?{}).../) */
472#define PMf_HAS_CV (1<<(PMf_BASE_SHIFT+10))
473
867940b8
DM
474/* op_code_list is private; don't free it etc. It may well point to
475 * code within another sub, with different pad etc */
476#define PMf_CODELIST_PRIVATE (1<<(PMf_BASE_SHIFT+11))
477
2a92a973
DM
478/* the PMOP is a QR (we should be able to detect that from the op type,
479 * but the regex compilation API passes just the pm flags, not the op
480 * itself */
481#define PMf_IS_QR (1<<(PMf_BASE_SHIFT+12))
a5ae69f0 482#define PMf_USE_RE_EVAL (1<<(PMf_BASE_SHIFT+13)) /* use re'eval' in scope */
2a92a973 483
a5ae69f0 484#if PMf_BASE_SHIFT+13 > 31
32cdcf9d 485# error Too many PMf_ bits used. See above and regnodes.h for any spare in middle
1850c8f9 486#endif
79072805 487
cb55de95 488#ifdef USE_ITHREADS
05ec9bb3 489
23083432
FC
490# define PmopSTASH(o) ((o)->op_pmflags & PMf_ONCE \
491 ? PL_stashpad[(o)->op_pmstashstartu.op_pmstashoff] \
492 : NULL)
493# define PmopSTASH_set(o,hv) \
494 (assert_((o)->op_pmflags & PMf_ONCE) \
495 (o)->op_pmstashstartu.op_pmstashoff = \
01f44973 496 (hv) ? alloccopstash(hv) : 0)
cb55de95 497#else
29f2e912
NC
498# define PmopSTASH(o) \
499 (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
500# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
501# define PmopSTASH_set(o,hv) ({ \
502 assert((o)->op_pmflags & PMf_ONCE); \
503 ((o)->op_pmstashstartu.op_pmstash = (hv)); \
504 })
505# else
506# define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
507# endif
cb55de95 508#endif
23083432
FC
509#define PmopSTASHPV(o) (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
510 /* op_pmstashstartu.op_pmstash is not refcounted */
511#define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
cb55de95 512
79072805
LW
513struct svop {
514 BASEOP
515 SV * op_sv;
516};
517
7934575e 518struct padop {
79072805 519 BASEOP
7934575e 520 PADOFFSET op_padix;
79072805
LW
521};
522
523struct pvop {
524 BASEOP
525 char * op_pv;
526};
527
79072805
LW
528struct loop {
529 BASEOP
530 OP * op_first;
531 OP * op_last;
79072805
LW
532 OP * op_redoop;
533 OP * op_nextop;
534 OP * op_lastop;
535};
536
350de78d
GS
537#define cUNOPx(o) ((UNOP*)o)
538#define cBINOPx(o) ((BINOP*)o)
539#define cLISTOPx(o) ((LISTOP*)o)
540#define cLOGOPx(o) ((LOGOP*)o)
541#define cPMOPx(o) ((PMOP*)o)
542#define cSVOPx(o) ((SVOP*)o)
543#define cPADOPx(o) ((PADOP*)o)
544#define cPVOPx(o) ((PVOP*)o)
545#define cCOPx(o) ((COP*)o)
546#define cLOOPx(o) ((LOOP*)o)
547
548#define cUNOP cUNOPx(PL_op)
549#define cBINOP cBINOPx(PL_op)
550#define cLISTOP cLISTOPx(PL_op)
551#define cLOGOP cLOGOPx(PL_op)
552#define cPMOP cPMOPx(PL_op)
553#define cSVOP cSVOPx(PL_op)
554#define cPADOP cPADOPx(PL_op)
555#define cPVOP cPVOPx(PL_op)
556#define cCOP cCOPx(PL_op)
557#define cLOOP cLOOPx(PL_op)
558
559#define cUNOPo cUNOPx(o)
560#define cBINOPo cBINOPx(o)
561#define cLISTOPo cLISTOPx(o)
562#define cLOGOPo cLOGOPx(o)
563#define cPMOPo cPMOPx(o)
564#define cSVOPo cSVOPx(o)
565#define cPADOPo cPADOPx(o)
566#define cPVOPo cPVOPx(o)
567#define cCOPo cCOPx(o)
568#define cLOOPo cLOOPx(o)
569
570#define kUNOP cUNOPx(kid)
571#define kBINOP cBINOPx(kid)
572#define kLISTOP cLISTOPx(kid)
573#define kLOGOP cLOGOPx(kid)
574#define kPMOP cPMOPx(kid)
575#define kSVOP cSVOPx(kid)
576#define kPADOP cPADOPx(kid)
577#define kPVOP cPVOPx(kid)
578#define kCOP cCOPx(kid)
579#define kLOOP cLOOPx(kid)
580
581
582#ifdef USE_ITHREADS
dd2155a4 583# define cGVOPx_gv(o) ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
cecf5685
NC
584# define IS_PADGV(v) (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
585 && GvIN_PAD(v))
f5a0fd1e
FC
586# define IS_PADCONST(v) \
587 (v && (SvREADONLY(v) || (SvIsCOW(v) && !SvLEN(v))))
7766f137 588# define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
dd2155a4 589 ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
638eceb6 590# define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
dd2155a4 591 ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
350de78d 592#else
638eceb6 593# define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
743e66e6 594# define IS_PADGV(v) FALSE
7766f137
GS
595# define IS_PADCONST(v) FALSE
596# define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
638eceb6 597# define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
350de78d 598#endif
79072805 599
638eceb6
GS
600#define cGVOP_gv cGVOPx_gv(PL_op)
601#define cGVOPo_gv cGVOPx_gv(o)
602#define kGVOP_gv cGVOPx_gv(kid)
603#define cSVOP_sv cSVOPx_sv(PL_op)
604#define cSVOPo_sv cSVOPx_sv(o)
605#define kSVOP_sv cSVOPx_sv(kid)
7766f137 606
bcabcc50
NC
607#ifndef PERL_CORE
608# define Nullop ((OP*)NULL)
609#endif
79072805 610
cee4176c 611/* Lowest byte of PL_opargs */
a0d0e21e
LW
612#define OA_MARK 1
613#define OA_FOLDCONST 2
614#define OA_RETSCALAR 4
615#define OA_TARGET 8
903fd87c 616#define OA_TARGLEX 16
a0d0e21e
LW
617#define OA_OTHERINT 32
618#define OA_DANGEROUS 64
619#define OA_DEFGV 128
620
db173bac 621/* The next 4 bits encode op class information */
903fd87c 622#define OCSHIFT 8
b162f9ea
IZ
623
624#define OA_CLASS_MASK (15 << OCSHIFT)
625
626#define OA_BASEOP (0 << OCSHIFT)
627#define OA_UNOP (1 << OCSHIFT)
628#define OA_BINOP (2 << OCSHIFT)
629#define OA_LOGOP (3 << OCSHIFT)
1a67a97c
SM
630#define OA_LISTOP (4 << OCSHIFT)
631#define OA_PMOP (5 << OCSHIFT)
632#define OA_SVOP (6 << OCSHIFT)
7934575e 633#define OA_PADOP (7 << OCSHIFT)
1a67a97c
SM
634#define OA_PVOP_OR_SVOP (8 << OCSHIFT)
635#define OA_LOOP (9 << OCSHIFT)
636#define OA_COP (10 << OCSHIFT)
637#define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
638#define OA_FILESTATOP (12 << OCSHIFT)
639#define OA_LOOPEXOP (13 << OCSHIFT)
b162f9ea 640
903fd87c 641#define OASHIFT 12
a0d0e21e 642
4369b173 643/* Remaining nybbles of PL_opargs */
a0d0e21e
LW
644#define OA_SCALAR 1
645#define OA_LIST 2
646#define OA_AVREF 3
647#define OA_HVREF 4
648#define OA_CVREF 5
649#define OA_FILEREF 6
650#define OA_SCALARREF 7
651#define OA_OPTIONAL 8
652
d3c72c2a
DM
653/* Op_REFCNT is a reference count at the head of each op tree: needed
654 * since the tree is shared between threads, and between cloned closure
655 * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
656 * this count.
657 * The same mutex is used to protect the refcounts of the reg_trie_data
658 * and reg_ac_data structures, which are shared between duplicated
659 * regexes.
660 */
661
534825c4
GS
662#ifdef USE_ITHREADS
663# define OP_REFCNT_INIT MUTEX_INIT(&PL_op_mutex)
4026c95a
SH
664# ifdef PERL_CORE
665# define OP_REFCNT_LOCK MUTEX_LOCK(&PL_op_mutex)
666# define OP_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_op_mutex)
667# else
668# define OP_REFCNT_LOCK op_refcnt_lock()
669# define OP_REFCNT_UNLOCK op_refcnt_unlock()
670# endif
534825c4 671# define OP_REFCNT_TERM MUTEX_DESTROY(&PL_op_mutex)
534825c4
GS
672#else
673# define OP_REFCNT_INIT NOOP
674# define OP_REFCNT_LOCK NOOP
675# define OP_REFCNT_UNLOCK NOOP
676# define OP_REFCNT_TERM NOOP
534825c4 677#endif
e4783991 678
282f25c9 679#define OpREFCNT_set(o,n) ((o)->op_targ = (n))
fc97af9c
NC
680#ifdef PERL_DEBUG_READONLY_OPS
681# define OpREFCNT_inc(o) Perl_op_refcnt_inc(aTHX_ o)
682# define OpREFCNT_dec(o) Perl_op_refcnt_dec(aTHX_ o)
683#else
684# define OpREFCNT_inc(o) ((o) ? (++(o)->op_targ, (o)) : NULL)
685# define OpREFCNT_dec(o) (--(o)->op_targ)
686#endif
282f25c9 687
e4783991 688/* flags used by Perl_load_module() */
ec6d81ab
RGS
689#define PERL_LOADMOD_DENY 0x1 /* no Module */
690#define PERL_LOADMOD_NOIMPORT 0x2 /* use Module () */
691#define PERL_LOADMOD_IMPORT_OPS 0x4 /* use Module (...) */
e5dd39fc 692
a0c21aa1 693#if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C)
e4c5ccf3 694#define ref(o, type) doref(o, type, TRUE)
a0c21aa1 695#endif
e4c5ccf3 696
5983a79d
BM
697/*
698=head1 Optree Manipulation Functions
699
700=for apidoc Am|OP*|LINKLIST|OP *o
701Given the root of an optree, link the tree in execution order using the
702C<op_next> pointers and return the first op executed. If this has
703already been done, it will not be redone, and C<< o->op_next >> will be
704returned. If C<< o->op_next >> is not already set, I<o> should be at
705least an C<UNOP>.
706
707=cut
708*/
709
710#define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
711
33f36c71
NC
712/* no longer used anywhere in core */
713#ifndef PERL_CORE
46471bde 714#define cv_ckproto(cv, gv, p) \
f717afa7 715 cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
33f36c71
NC
716#endif
717
7d0905b9
NC
718#ifdef PERL_CORE
719# define my(o) my_attrs((o), NULL)
720#endif
721
e5dd39fc 722#ifdef USE_REENTRANT_API
10bc17b6 723#include "reentr.h"
e5dd39fc
AB
724#endif
725
c7e45529 726#define NewOp(m,var,c,type) \
e91d68d5 727 (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
c7e45529 728#define NewOpSz(m,var,size) \
e91d68d5 729 (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
c7e45529 730#define FreeOp(p) Perl_Slab_Free(aTHX_ p)
8be227ab
FC
731
732/*
733 * The per-CV op slabs consist of a header (the opslab struct) and a bunch
734 * of space for allocating op slots, each of which consists of two pointers
735 * followed by an op. The first pointer points to the next op slot. The
736 * second points to the slab. At the end of the slab is a null pointer,
737 * so that slot->opslot_next - slot can be used to determine the size
738 * of the op.
739 *
740 * Each CV can have multiple slabs; opslab_next points to the next slab, to
741 * form a chain. All bookkeeping is done on the first slab, which is where
742 * all the op slots point.
743 *
744 * Freed ops are marked as freed and attached to the freed chain
745 * via op_next pointers.
746 *
747 * When there is more than one slab, the second slab in the slab chain is
748 * assumed to be the one with free space available. It is used when allo-
749 * cating an op if there are no freed ops available or big enough.
750 */
751
7aef8e5b 752#ifdef PERL_CORE
8be227ab
FC
753struct opslot {
754 /* keep opslot_next first */
755 OPSLOT * opslot_next; /* next slot */
756 OPSLAB * opslot_slab; /* owner */
757 OP opslot_op; /* the op itself */
758};
759
760struct opslab {
761 OPSLOT * opslab_first; /* first op in this slab */
762 OPSLAB * opslab_next; /* next slab */
763 OP * opslab_freed; /* chain of freed ops */
764 size_t opslab_refcnt; /* number of ops */
3107b51f
FC
765# ifdef PERL_DEBUG_READONLY_OPS
766 U16 opslab_size; /* size of slab in pointers */
767 bool opslab_readonly;
768# endif
8be227ab
FC
769 OPSLOT opslab_slots; /* slots begin here */
770};
771
772# define OPSLOT_HEADER STRUCT_OFFSET(OPSLOT, opslot_op)
773# define OPSLOT_HEADER_P (OPSLOT_HEADER/sizeof(I32 *))
c7724415 774# define OpSLOT(o) (assert_(o->op_slabbed) \
8be227ab 775 (OPSLOT *)(((char *)o)-OPSLOT_HEADER))
8be227ab
FC
776# define OpSLAB(o) OpSLOT(o)->opslot_slab
777# define OpslabREFCNT_dec(slab) \
778 (((slab)->opslab_refcnt == 1) \
779 ? opslab_free_nopad(slab) \
780 : (void)--(slab)->opslab_refcnt)
781 /* Variant that does not null out the pads */
782# define OpslabREFCNT_dec_padok(slab) \
783 (((slab)->opslab_refcnt == 1) \
784 ? opslab_free(slab) \
785 : (void)--(slab)->opslab_refcnt)
c7e45529 786#endif
598921a7 787
1930840b 788struct block_hooks {
52db365a 789 U32 bhk_flags;
1930840b
BM
790 void (*bhk_start) (pTHX_ int full);
791 void (*bhk_pre_end) (pTHX_ OP **seq);
792 void (*bhk_post_end) (pTHX_ OP **seq);
52db365a 793 void (*bhk_eval) (pTHX_ OP *const saveop);
1930840b
BM
794};
795
fd85fad2
BM
796/*
797=head1 Compile-time scope hooks
798
3e4ddde5 799=for apidoc mx|U32|BhkFLAGS|BHK *hk
fd85fad2
BM
800Return the BHK's flags.
801
3e4ddde5 802=for apidoc mx|void *|BhkENTRY|BHK *hk|which
fd85fad2
BM
803Return an entry from the BHK structure. I<which> is a preprocessor token
804indicating which entry to return. If the appropriate flag is not set
805this will return NULL. The type of the return value depends on which
806entry you ask for.
807
3e4ddde5 808=for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
fd85fad2
BM
809Set an entry in the BHK structure, and set the flags to indicate it is
810valid. I<which> is a preprocessing token indicating which entry to set.
811The type of I<ptr> depends on the entry.
812
3e4ddde5 813=for apidoc Amx|void|BhkDISABLE|BHK *hk|which
a3e07c87
BM
814Temporarily disable an entry in this BHK structure, by clearing the
815appropriate flag. I<which> is a preprocessor token indicating which
816entry to disable.
817
3e4ddde5 818=for apidoc Amx|void|BhkENABLE|BHK *hk|which
a3e07c87
BM
819Re-enable an entry in this BHK structure, by setting the appropriate
820flag. I<which> is a preprocessor token indicating which entry to enable.
821This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
822pointer.
823
3e4ddde5 824=for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
fd85fad2
BM
825Call all the registered block hooks for type I<which>. I<which> is a
826preprocessing token; the type of I<arg> depends on I<which>.
827
828=cut
829*/
830
52db365a
BM
831#define BhkFLAGS(hk) ((hk)->bhk_flags)
832
a88d97bf
BM
833#define BHKf_bhk_start 0x01
834#define BHKf_bhk_pre_end 0x02
835#define BHKf_bhk_post_end 0x04
836#define BHKf_bhk_eval 0x08
52db365a
BM
837
838#define BhkENTRY(hk, which) \
a88d97bf 839 ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
52db365a 840
a3e07c87
BM
841#define BhkENABLE(hk, which) \
842 STMT_START { \
843 BhkFLAGS(hk) |= BHKf_ ## which; \
844 assert(BhkENTRY(hk, which)); \
845 } STMT_END
846
847#define BhkDISABLE(hk, which) \
848 STMT_START { \
849 BhkFLAGS(hk) &= ~(BHKf_ ## which); \
850 } STMT_END
851
52db365a
BM
852#define BhkENTRY_set(hk, which, ptr) \
853 STMT_START { \
a88d97bf 854 (hk)->which = ptr; \
a3e07c87 855 BhkENABLE(hk, which); \
52db365a
BM
856 } STMT_END
857
1930840b
BM
858#define CALL_BLOCK_HOOKS(which, arg) \
859 STMT_START { \
860 if (PL_blockhooks) { \
c70927a6 861 SSize_t i; \
1930840b
BM
862 for (i = av_len(PL_blockhooks); i >= 0; i--) { \
863 SV *sv = AvARRAY(PL_blockhooks)[i]; \
52db365a 864 BHK *hk; \
1930840b
BM
865 \
866 assert(SvIOK(sv)); \
867 if (SvUOK(sv)) \
52db365a 868 hk = INT2PTR(BHK *, SvUVX(sv)); \
1930840b 869 else \
52db365a 870 hk = INT2PTR(BHK *, SvIVX(sv)); \
1930840b 871 \
52db365a 872 if (BhkENTRY(hk, which)) \
16c91539 873 BhkENTRY(hk, which)(aTHX_ arg); \
1930840b
BM
874 } \
875 } \
876 } STMT_END
877
d9088386
Z
878/* flags for rv2cv_op_cv */
879
880#define RV2CVOPCV_MARK_EARLY 0x00000001
881#define RV2CVOPCV_RETURN_NAME_GV 0x00000002
882
d3d7d28f
FC
883#define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
884
f5d552b4
FC
885/* flags for op_lvalue_flags */
886
887#define OP_LVALUE_NO_CROAK 1
888
9733086d
BM
889/*
890=head1 Custom Operators
891
892=for apidoc Am|U32|XopFLAGS|XOP *xop
893Return the XOP's flags.
894
895=for apidoc Am||XopENTRY|XOP *xop|which
896Return a member of the XOP structure. I<which> is a cpp token indicating
897which entry to return. If the member is not set this will return a
898default value. The return type depends on I<which>.
899
900=for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
901Set a member of the XOP structure. I<which> is a cpp token indicating
902which entry to set. See L<perlguts/"Custom Operators"> for details about
903the available members and how they are used.
904
905=for apidoc Am|void|XopDISABLE|XOP *xop|which
906Temporarily disable a member of the XOP, by clearing the appropriate flag.
907
908=for apidoc Am|void|XopENABLE|XOP *xop|which
909Reenable a member of the XOP which has been disabled.
910
911=cut
912*/
913
1830b3d9
BM
914struct custom_op {
915 U32 xop_flags;
916 const char *xop_name;
917 const char *xop_desc;
918 U32 xop_class;
919 void (*xop_peep)(pTHX_ OP *o, OP *oldop);
920};
921
922#define XopFLAGS(xop) ((xop)->xop_flags)
923
924#define XOPf_xop_name 0x01
925#define XOPf_xop_desc 0x02
926#define XOPf_xop_class 0x04
927#define XOPf_xop_peep 0x08
928
929#define XOPd_xop_name PL_op_name[OP_CUSTOM]
930#define XOPd_xop_desc PL_op_desc[OP_CUSTOM]
931#define XOPd_xop_class OA_BASEOP
932#define XOPd_xop_peep ((Perl_cpeep_t)0)
933
934#define XopENTRY_set(xop, which, to) \
935 STMT_START { \
936 (xop)->which = (to); \
937 (xop)->xop_flags |= XOPf_ ## which; \
938 } STMT_END
939
940#define XopENTRY(xop, which) \
941 ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
942
943#define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
944#define XopENABLE(xop, which) \
945 STMT_START { \
946 (xop)->xop_flags |= XOPf_ ## which; \
947 assert(XopENTRY(xop, which)); \
948 } STMT_END
949
9733086d
BM
950/*
951=head1 Optree Manipulation Functions
952
953=for apidoc Am|const char *|OP_NAME|OP *o
954Return the name of the provided OP. For core ops this looks up the name
955from the op_type; for custom ops from the op_ppaddr.
956
957=for apidoc Am|const char *|OP_DESC|OP *o
958Return a short description of the provided OP.
959
960=for apidoc Am|U32|OP_CLASS|OP *o
961Return the class of the provided OP: that is, which of the *OP
962structures it uses. For core ops this currently gets the information out
963of PL_opargs, which does not always accurately reflect the type used.
964For custom ops the type is returned from the registration, and it is up
965to the registree to ensure it is accurate. The value returned will be
966one of the OA_* constants from op.h.
967
968=cut
969*/
970
1830b3d9
BM
971#define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
972 ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_name) \
973 : PL_op_name[(o)->op_type])
974#define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
975 ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_desc) \
976 : PL_op_desc[(o)->op_type])
977#define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
978 ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_class) \
979 : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
980
7bff8c33
NC
981#define newSUB(f, o, p, b) Perl_newATTRSUB(aTHX_ (f), (o), (p), NULL, (b))
982
598921a7
NC
983#ifdef PERL_MAD
984# define MAD_NULL 1
985# define MAD_PV 2
986# define MAD_OP 3
987# define MAD_SV 4
988
989struct madprop {
990 MADPROP* mad_next;
d503a9ba 991 void *mad_val;
598921a7
NC
992 U32 mad_vlen;
993/* short mad_count; */
994 char mad_key;
995 char mad_type;
996};
997
998struct token {
999 I32 tk_type;
1000 YYSTYPE tk_lval;
1001 MADPROP* tk_mad;
1002};
1003#endif
2d910ff8
RGS
1004
1005/*
2b3def87 1006 * Values that can be held by mad_key :
2d910ff8
RGS
1007 * ^ unfilled head spot
1008 * , literal ,
1009 * ; literal ; (blank if implicit ; at end of block)
1010 * : literal : from ?: or attr list
1011 * + unary +
1012 * ? literal ? from ?:
1013 * ( literal (
1014 * ) literal )
1015 * [ literal [
1016 * ] literal ]
1017 * { literal {
1018 * } literal }
1019 * @ literal @ sigil
1020 * $ literal $ sigil
1021 * * literal * sigil
1022 * ! use is source filtered
1023 * & & or sub
1024 * # whitespace/comment following ; or }
1025 * # $# sigil
1026 * 1 1st ; from for(;;)
1027 * 1 retired protasis
1028 * 2 2nd ; from for(;;)
1029 * 2 retired apodosis
1030 * 3 C-style for list
1031 * a sub or var attributes
1032 * a non-method arrow operator
1033 * A method arrow operator
1034 * A use import args
1035 * b format block
1036 * B retired stub block
1037 * C constant conditional op
1038 * d declarator
1039 * D do block
1040 * e unreached "else" (see C)
1041 * e expression producing E
1042 * E tr/E/R/, /E/
1043 * f folded constant op
1044 * F peg op for format
63575281 1045 * g op was forced to be a word
2d910ff8
RGS
1046 * i if/unless modifier
1047 * I if/elsif/unless statement
dde83331 1048 * k local declarator
2d910ff8
RGS
1049 * K retired kid op
1050 * l last index of array ($#foo)
1051 * L label
1052 * m modifier on regex
2d910ff8
RGS
1053 * n sub or format name
1054 * o current operator/declarator name
1055 * o else/continue
1056 * O generic optimized op
1057 * p peg to hold extra whitespace at statement level
1058 * P peg op for package declaration
1059 * q opening quote
1060 * = quoted material
1061 * Q closing quote
1062 * Q optimized qw//
1063 * r expression producing R
1064 * R tr/E/R/ s/E/R/
2d910ff8
RGS
1065 * s sub signature
1066 * S use import stub (no import)
1067 * S retired sort block
1068 * t unreached "then" (see C)
1069 * U use import op
1070 * v private sv of for loop
1071 * V use version
1072 * w while/until modifier
1073 * W while/for statement
1074 * x optimized qw
1075 * X random thing
1076 * _ whitespace/comments preceding anything else
1077 * ~ =~ operator
1078 */
3f2908ec
NC
1079
1080/*
e8570548
Z
1081=head1 Hook manipulation
1082*/
1083
1084#ifdef USE_ITHREADS
1085# define OP_CHECK_MUTEX_INIT MUTEX_INIT(&PL_check_mutex)
1086# define OP_CHECK_MUTEX_LOCK MUTEX_LOCK(&PL_check_mutex)
1087# define OP_CHECK_MUTEX_UNLOCK MUTEX_UNLOCK(&PL_check_mutex)
1088# define OP_CHECK_MUTEX_TERM MUTEX_DESTROY(&PL_check_mutex)
1089#else
1090# define OP_CHECK_MUTEX_INIT NOOP
1091# define OP_CHECK_MUTEX_LOCK NOOP
1092# define OP_CHECK_MUTEX_UNLOCK NOOP
1093# define OP_CHECK_MUTEX_TERM NOOP
1094#endif
1095
1096/*
3f2908ec
NC
1097 * Local variables:
1098 * c-indentation-style: bsd
1099 * c-basic-offset: 4
14d04a33 1100 * indent-tabs-mode: nil
3f2908ec
NC
1101 * End:
1102 *
14d04a33 1103 * ex: set ts=8 sts=4 sw=4 et:
3f2908ec 1104 */