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