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