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