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