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