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