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