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