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