Commit | Line | Data |
---|---|---|
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 | 26 | * op_folded Result/remainder of a constant fold operation. |
87b5a8b9 | 27 | * op_moresib this op is is not the last sibling |
29e61fd9 | 28 | * op_spare One spare bit |
79072805 LW |
29 | * op_flags Flags common to all operations. See OPf_* below. |
30 | * op_private Flags peculiar to a particular operation (BUT, | |
31 | * by default, set to the number of children until | |
32 | * the operation is privatized by a check routine, | |
33 | * which may or may not check number of children). | |
34 | */ | |
1850c8f9 | 35 | #include "op_reg_common.h" |
79072805 | 36 | |
79072805 | 37 | #define OPCODE U16 |
79072805 | 38 | |
61a59f30 | 39 | typedef PERL_BITFIELD16 Optype; |
0053d415 | 40 | |
86cd3a13 | 41 | /* this field now either points to the next sibling or to the parent, |
87b5a8b9 | 42 | * depending on op_moresib. So rename it from op_sibling to op_sibparent. |
86cd3a13 DM |
43 | */ |
44 | #ifdef PERL_OP_PARENT | |
45 | # define _OP_SIBPARENT_FIELDNAME op_sibparent | |
46 | #else | |
47 | # define _OP_SIBPARENT_FIELDNAME op_sibling | |
48 | #endif | |
49 | ||
0f4eea8f DL |
50 | #ifdef BASEOP_DEFINITION |
51 | #define BASEOP BASEOP_DEFINITION | |
52 | #else | |
79072805 LW |
53 | #define BASEOP \ |
54 | OP* op_next; \ | |
86cd3a13 | 55 | OP* _OP_SIBPARENT_FIELDNAME;\ |
16c91539 | 56 | OP* (*op_ppaddr)(pTHX); \ |
79072805 | 57 | PADOFFSET op_targ; \ |
654eccd5 JD |
58 | PERL_BITFIELD16 op_type:9; \ |
59 | PERL_BITFIELD16 op_opt:1; \ | |
8be227ab | 60 | PERL_BITFIELD16 op_slabbed:1; \ |
bb38a9e0 | 61 | PERL_BITFIELD16 op_savefree:1; \ |
90840c5d | 62 | PERL_BITFIELD16 op_static:1; \ |
3513c740 | 63 | PERL_BITFIELD16 op_folded:1; \ |
87b5a8b9 | 64 | PERL_BITFIELD16 op_moresib:1; \ |
29e61fd9 | 65 | PERL_BITFIELD16 op_spare:1; \ |
a0d0e21e LW |
66 | U8 op_flags; \ |
67 | U8 op_private; | |
0f4eea8f | 68 | #endif |
79072805 | 69 | |
13febba5 | 70 | /* If op_type:9 is changed to :10, also change cx_pusheval() |
0053d415 JD |
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 | |
fe615074 | 75 | /* for efficiency, requires OPf_WANT_VOID == G_VOID etc */ |
54310121 | 76 | #define OP_GIMME(op,dfl) \ |
fe615074 | 77 | (((op)->op_flags & OPf_WANT) ? ((op)->op_flags & OPf_WANT) : dfl) |
54310121 | 78 | |
2f8edad0 | 79 | #define OP_GIMME_REVERSE(flags) ((flags) & G_WANT) |
4f911530 | 80 | |
954c1994 | 81 | /* |
ccfc67b7 JH |
82 | =head1 "Gimme" Values |
83 | ||
954c1994 GS |
84 | =for apidoc Amn|U32|GIMME_V |
85 | The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>, | |
91e74348 | 86 | C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context, |
72d33970 | 87 | respectively. See L<perlcall> for a usage example. |
954c1994 GS |
88 | |
89 | =for apidoc Amn|U32|GIMME | |
90 | A backward-compatible version of C<GIMME_V> which can only return | |
91 | C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>. | |
92 | Deprecated. Use C<GIMME_V> instead. | |
93 | ||
94 | =cut | |
95 | */ | |
96 | ||
533c011a | 97 | #define GIMME_V OP_GIMME(PL_op, block_gimme()) |
79072805 LW |
98 | |
99 | /* Public flags */ | |
54310121 | 100 | |
101 | #define OPf_WANT 3 /* Mask for "want" bits: */ | |
102 | #define OPf_WANT_VOID 1 /* Want nothing */ | |
103 | #define OPf_WANT_SCALAR 2 /* Want single value */ | |
104 | #define OPf_WANT_LIST 3 /* Want list of any length */ | |
79072805 LW |
105 | #define OPf_KIDS 4 /* There is a firstborn child. */ |
106 | #define OPf_PARENS 8 /* This operator was parenthesized. */ | |
463ee0b2 | 107 | /* (Or block needs explicit scope entry.) */ |
a0d0e21e LW |
108 | #define OPf_REF 16 /* Certified reference. */ |
109 | /* (Return container, not containee). */ | |
110 | #define OPf_MOD 32 /* Will modify (lvalue). */ | |
111 | #define OPf_STACKED 64 /* Some arg is arriving on the stack. */ | |
79072805 LW |
112 | #define OPf_SPECIAL 128 /* Do something weird for this op: */ |
113 | /* On local LVAL, don't init local value. */ | |
114 | /* On OP_SORT, subroutine is inlined. */ | |
115 | /* On OP_NOT, inversion was implicit. */ | |
c349b9a0 DM |
116 | /* On OP_LEAVE, don't restore curpm, e.g. |
117 | * /(...)/ while ...>; */ | |
79072805 LW |
118 | /* On truncate, we truncate filehandle */ |
119 | /* On control verbs, we saw no label */ | |
120 | /* On flipflop, we saw ... instead of .. */ | |
121 | /* On UNOPs, saw bare parens, e.g. eof(). */ | |
deb92a6c | 122 | /* On OP_CHDIR, handle (or bare parens) */ |
a2167ea9 | 123 | /* On 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 $@ */ |
497711e7 | 126 | /* On regcomp, "use re 'eval'" was in scope */ |
17fda545 NC |
127 | /* On RV2[ACGHS]V, don't create GV--in |
128 | defined()*/ | |
5df8de69 DM |
129 | /* On OP_DBSTATE, indicates breakpoint |
130 | * (runtime property) */ | |
6b514a0d | 131 | /* On OP_REQUIRE, was seen as CORE::require */ |
78c72037 NC |
132 | /* On OP_ANONHASH and OP_ANONLIST, create a |
133 | reference to the new anon hash or array */ | |
fedf30e1 DM |
134 | /* On OP_HELEM, OP_MULTIDEREF and OP_HSLICE, |
135 | localization will be followed by assignment, | |
136 | so do not wipe the target if it is special | |
137 | (e.g. a glob or a magic SV) */ | |
2474a784 FC |
138 | /* On OP_MATCH, OP_SUBST & OP_TRANS, the |
139 | operand of a logical or conditional | |
140 | that was optimised away, so it should | |
141 | not be bound via =~ */ | |
6b7c6d95 | 142 | /* On OP_CONST, from a constant CV */ |
d67594ff FC |
143 | /* On OP_GLOB, two meanings: |
144 | - Before ck_glob, called as CORE::glob | |
145 | - After ck_glob, use Perl glob function | |
146 | */ | |
d5524600 | 147 | /* On OP_PADRANGE, push @_ */ |
7d1d69cb | 148 | /* On OP_DUMP, has no label */ |
205681b5 | 149 | /* On OP_UNSTACK, in a C-style for loop */ |
6d4eed21 FC |
150 | /* There is no room in op_flags for this one, so it has its own bit- |
151 | field member (op_folded) instead. The flag is only used to tell | |
152 | op_convert_list to set op_folded. */ | |
faab18b6 | 153 | #define OPf_FOLDED (1<<16) |
79072805 | 154 | |
54310121 | 155 | /* old names; don't use in new code, but don't break them, either */ |
d91ab173 GS |
156 | #define OPf_LIST OPf_WANT_LIST |
157 | #define OPf_KNOW OPf_WANT | |
954c1994 | 158 | |
7143f21c | 159 | #if !defined(PERL_CORE) && !defined(PERL_EXT) |
82334630 | 160 | # define GIMME \ |
62a559b8 NIS |
161 | (PL_op->op_flags & OPf_WANT \ |
162 | ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \ | |
d91ab173 GS |
163 | ? G_ARRAY \ |
164 | : G_SCALAR) \ | |
165 | : dowantarray()) | |
82334630 | 166 | #endif |
54310121 | 167 | |
1dafeec8 | 168 | |
f3574cc6 DM |
169 | /* NOTE: OPp* flags are now auto-generated and defined in opcode.h, |
170 | * from data in regen/op_private */ | |
d41ff1b8 | 171 | |
a0d0e21e | 172 | |
59f00321 | 173 | #define OPpTRANS_ALL (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE) |
79072805 | 174 | |
97e1065a | 175 | |
97e1065a | 176 | |
f3574cc6 DM |
177 | /* Mask for OP_ENTERSUB flags, the absence of which must be propagated |
178 | in dynamic context */ | |
777d9014 FC |
179 | #define OPpENTERSUB_LVAL_MASK (OPpLVAL_INTRO|OPpENTERSUB_INARGS) |
180 | ||
5db1eb8d | 181 | |
2f7c6295 DM |
182 | /* things that can be elements of op_aux */ |
183 | typedef union { | |
184 | PADOFFSET pad_offset; | |
185 | SV *sv; | |
186 | IV iv; | |
187 | UV uv; | |
e839e6ed | 188 | char *pv; |
b5bf9f73 | 189 | SSize_t ssize; |
2f7c6295 DM |
190 | } UNOP_AUX_item; |
191 | ||
fedf30e1 DM |
192 | #ifdef USE_ITHREADS |
193 | # define UNOP_AUX_item_sv(item) PAD_SVl((item)->pad_offset); | |
194 | #else | |
195 | # define UNOP_AUX_item_sv(item) ((item)->sv); | |
196 | #endif | |
197 | ||
198 | ||
199 | ||
60041a09 | 200 | |
79072805 LW |
201 | struct op { |
202 | BASEOP | |
203 | }; | |
204 | ||
205 | struct unop { | |
206 | BASEOP | |
207 | OP * op_first; | |
208 | }; | |
209 | ||
2f7c6295 DM |
210 | struct unop_aux { |
211 | BASEOP | |
212 | OP *op_first; | |
213 | UNOP_AUX_item *op_aux; | |
214 | }; | |
215 | ||
79072805 LW |
216 | struct binop { |
217 | BASEOP | |
218 | OP * op_first; | |
219 | OP * op_last; | |
220 | }; | |
221 | ||
222 | struct logop { | |
223 | BASEOP | |
224 | OP * op_first; | |
225 | OP * op_other; | |
226 | }; | |
227 | ||
79072805 LW |
228 | struct listop { |
229 | BASEOP | |
230 | OP * op_first; | |
231 | OP * op_last; | |
79072805 LW |
232 | }; |
233 | ||
b46e009d | 234 | struct methop { |
235 | BASEOP | |
236 | union { | |
237 | /* op_u.op_first *must* be aligned the same as the op_first | |
238 | * field of the other op types, and op_u.op_meth_sv *must* | |
239 | * be aligned with op_sv */ | |
240 | OP* op_first; /* optree for method name */ | |
241 | SV* op_meth_sv; /* static method name */ | |
242 | } op_u; | |
810bd8b7 | 243 | #ifdef USE_ITHREADS |
244 | PADOFFSET op_rclass_targ; /* pad index for redirect class */ | |
245 | #else | |
246 | SV* op_rclass_sv; /* static redirect class $o->A::meth() */ | |
247 | #endif | |
b46e009d | 248 | }; |
249 | ||
79072805 LW |
250 | struct pmop { |
251 | BASEOP | |
252 | OP * op_first; | |
253 | OP * op_last; | |
1fcf4c12 | 254 | #ifdef USE_ITHREADS |
784e50c8 | 255 | PADOFFSET op_pmoffset; |
1fcf4c12 AB |
256 | #else |
257 | REGEXP * op_pmregexp; /* compiled expression */ | |
258 | #endif | |
69bdead3 | 259 | U32 op_pmflags; |
29f2e912 | 260 | union { |
20e98b0f | 261 | OP * op_pmreplroot; /* For OP_SUBST */ |
5012eebe DM |
262 | PADOFFSET op_pmtargetoff; /* For OP_SPLIT lex ary or thr GV */ |
263 | GV * op_pmtargetgv; /* For OP_SPLIT non-threaded GV */ | |
20e98b0f NC |
264 | } op_pmreplrootu; |
265 | union { | |
29f2e912 | 266 | OP * op_pmreplstart; /* Only used in OP_SUBST */ |
cb55de95 | 267 | #ifdef USE_ITHREADS |
23083432 | 268 | PADOFFSET op_pmstashoff; /* Only used in OP_MATCH, with PMf_ONCE set */ |
cb55de95 | 269 | #else |
29f2e912 | 270 | HV * op_pmstash; |
cb55de95 | 271 | #endif |
29f2e912 | 272 | } op_pmstashstartu; |
68e2671b | 273 | OP * op_code_list; /* list of (?{}) code blocks */ |
79072805 | 274 | }; |
a0d0e21e | 275 | |
1fcf4c12 | 276 | #ifdef USE_ITHREADS |
14a49a24 NC |
277 | #define PM_GETRE(o) (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \ |
278 | ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL) | |
ede1273d NC |
279 | /* The assignment is just to enforce type safety (or at least get a warning). |
280 | */ | |
14a49a24 NC |
281 | /* With first class regexps not via a reference one needs to assign |
282 | &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL | |
283 | is cheaper. I guess we could allow NULL, but the check above would get | |
284 | more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */ | |
285 | /* BEWARE - something that calls this macro passes (r) which has a side | |
286 | effect. */ | |
ede1273d | 287 | #define PM_SETRE(o,r) STMT_START { \ |
b1bc3f34 | 288 | REGEXP *const _pm_setre = (r); \ |
7948fc08 | 289 | assert(_pm_setre); \ |
b1bc3f34 | 290 | PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \ |
ede1273d | 291 | } STMT_END |
1fcf4c12 | 292 | #else |
b9ed2502 AB |
293 | #define PM_GETRE(o) ((o)->op_pmregexp) |
294 | #define PM_SETRE(o,r) ((o)->op_pmregexp = (r)) | |
1fcf4c12 | 295 | #endif |
4825b64b | 296 | |
a6cd0fea KW |
297 | /* Currently these PMf flags occupy a single 32-bit word. Not all bits are |
298 | * currently used. The lower bits are shared with their corresponding RXf flag | |
299 | * bits, up to but not including _RXf_PMf_SHIFT_NEXT. The unused bits | |
300 | * immediately follow; finally the used Pmf-only (unshared) bits, so that the | |
301 | * highest bit in the word is used. This gathers all the unused bits as a pool | |
302 | * in the middle, like so: 11111111111111110000001111111111 | |
303 | * where the '1's represent used bits, and the '0's unused. This design allows | |
304 | * us to allocate off one end of the pool if we need to add a shared bit, and | |
305 | * off the other end if we need a non-shared bit, without disturbing the other | |
306 | * bits. This maximizes the likelihood of being able to change things without | |
307 | * breaking binary compatibility. | |
308 | * | |
309 | * To add shared bits, do so in op_reg_common.h. This should change | |
310 | * _RXf_PMf_SHIFT_NEXT so that things won't compile. Then come to regexp.h and | |
311 | * op.h and adjust the constant adders in the definitions of PMf_BASE_SHIFT and | |
312 | * Pmf_BASE_SHIFT down by the number of shared bits you added. That's it. | |
313 | * Things should be binary compatible. But if either of these gets to having | |
314 | * to subtract rather than add, leave at 0 and adjust all the entries below | |
315 | * that are in terms of this according. But if the first one of those is | |
316 | * already PMf_BASE_SHIFT+0, there are no bits left, and a redesign is in | |
317 | * order. | |
318 | * | |
319 | * To remove unshared bits, just delete its entry. If you're where breaking | |
320 | * binary compatibility is ok to do, you might want to adjust things to move | |
321 | * the newly opened space so that it gets absorbed into the common pool. | |
322 | * | |
323 | * To add unshared bits, first use up any gaps in the middle. Otherwise, | |
324 | * allocate off the low end until you get to PMf_BASE_SHIFT+0. If that isn't | |
325 | * enough, move PMf_BASE_SHIFT down (if possible) and add the new bit at the | |
326 | * other end instead; this preserves binary compatibility. */ | |
d262c0c7 | 327 | #define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+2) |
f4a4cecb | 328 | |
7c449856 KW |
329 | /* Set by the parser if it discovers an error, so the regex shouldn't be |
330 | * compiled */ | |
331 | #define PMf_HAS_ERROR (1U<<(PMf_BASE_SHIFT+4)) | |
332 | ||
ef07e810 | 333 | /* 'use re "taint"' in scope: taint $1 etc. if target tainted */ |
9cba692b | 334 | #define PMf_RETAINT (1U<<(PMf_BASE_SHIFT+5)) |
c737faaf | 335 | |
c0f1c194 KW |
336 | /* match successfully only once per reset, with related flag RXf_USED in |
337 | * re->extflags holding state. This is used only for ?? matches, and only on | |
338 | * OP_MATCH and OP_QR */ | |
9cba692b | 339 | #define PMf_ONCE (1U<<(PMf_BASE_SHIFT+6)) |
1850c8f9 | 340 | |
d234778b | 341 | /* PMf_ONCE, i.e. ?pat?, has matched successfully. Not used under threading. */ |
9cba692b | 342 | #define PMf_USED (1U<<(PMf_BASE_SHIFT+7)) |
1850c8f9 KW |
343 | |
344 | /* subst replacement is constant */ | |
9cba692b | 345 | #define PMf_CONST (1U<<(PMf_BASE_SHIFT+8)) |
c737faaf | 346 | |
1850c8f9 | 347 | /* keep 1st runtime pattern forever */ |
9cba692b | 348 | #define PMf_KEEP (1U<<(PMf_BASE_SHIFT+9)) |
4da3eb8b | 349 | |
9cba692b | 350 | #define PMf_GLOBAL (1U<<(PMf_BASE_SHIFT+10)) /* pattern had a g modifier */ |
c737faaf | 351 | |
1850c8f9 | 352 | /* don't reset pos() if //g fails */ |
9cba692b | 353 | #define PMf_CONTINUE (1U<<(PMf_BASE_SHIFT+11)) |
1850c8f9 KW |
354 | |
355 | /* evaluating replacement as expr */ | |
9cba692b | 356 | #define PMf_EVAL (1U<<(PMf_BASE_SHIFT+12)) |
c0f1c194 KW |
357 | |
358 | /* Return substituted string instead of modifying it. */ | |
9cba692b | 359 | #define PMf_NONDESTRUCT (1U<<(PMf_BASE_SHIFT+13)) |
e357fc67 | 360 | |
d63c20f2 | 361 | /* the pattern has a CV attached (currently only under qr/...(?{}).../) */ |
9cba692b | 362 | #define PMf_HAS_CV (1U<<(PMf_BASE_SHIFT+14)) |
d63c20f2 | 363 | |
867940b8 DM |
364 | /* op_code_list is private; don't free it etc. It may well point to |
365 | * code within another sub, with different pad etc */ | |
9cba692b | 366 | #define PMf_CODELIST_PRIVATE (1U<<(PMf_BASE_SHIFT+15)) |
867940b8 | 367 | |
2a92a973 DM |
368 | /* the PMOP is a QR (we should be able to detect that from the op type, |
369 | * but the regex compilation API passes just the pm flags, not the op | |
370 | * itself */ | |
9cba692b KW |
371 | #define PMf_IS_QR (1U<<(PMf_BASE_SHIFT+16)) |
372 | #define PMf_USE_RE_EVAL (1U<<(PMf_BASE_SHIFT+17)) /* use re'eval' in scope */ | |
a6cd0fea KW |
373 | |
374 | /* See comments at the beginning of these defines about adding bits. The | |
375 | * highest bit position should be used, so that if PMf_BASE_SHIFT gets | |
376 | * increased, the #error below will be triggered so that you will be reminded | |
377 | * to adjust things at the other end to keep the bit positions unchanged */ | |
378 | #if PMf_BASE_SHIFT+17 > 31 | |
32cdcf9d | 379 | # error Too many PMf_ bits used. See above and regnodes.h for any spare in middle |
1850c8f9 | 380 | #endif |
79072805 | 381 | |
cb55de95 | 382 | #ifdef USE_ITHREADS |
05ec9bb3 | 383 | |
23083432 FC |
384 | # define PmopSTASH(o) ((o)->op_pmflags & PMf_ONCE \ |
385 | ? PL_stashpad[(o)->op_pmstashstartu.op_pmstashoff] \ | |
386 | : NULL) | |
387 | # define PmopSTASH_set(o,hv) \ | |
388 | (assert_((o)->op_pmflags & PMf_ONCE) \ | |
389 | (o)->op_pmstashstartu.op_pmstashoff = \ | |
01f44973 | 390 | (hv) ? alloccopstash(hv) : 0) |
cb55de95 | 391 | #else |
29f2e912 NC |
392 | # define PmopSTASH(o) \ |
393 | (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL) | |
394 | # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) | |
395 | # define PmopSTASH_set(o,hv) ({ \ | |
396 | assert((o)->op_pmflags & PMf_ONCE); \ | |
397 | ((o)->op_pmstashstartu.op_pmstash = (hv)); \ | |
398 | }) | |
399 | # else | |
400 | # define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv)) | |
401 | # endif | |
cb55de95 | 402 | #endif |
23083432 FC |
403 | #define PmopSTASHPV(o) (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL) |
404 | /* op_pmstashstartu.op_pmstash is not refcounted */ | |
405 | #define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD)) | |
cb55de95 | 406 | |
79072805 LW |
407 | struct svop { |
408 | BASEOP | |
409 | SV * op_sv; | |
410 | }; | |
411 | ||
7934575e | 412 | struct padop { |
79072805 | 413 | BASEOP |
7934575e | 414 | PADOFFSET op_padix; |
79072805 LW |
415 | }; |
416 | ||
417 | struct pvop { | |
418 | BASEOP | |
419 | char * op_pv; | |
420 | }; | |
421 | ||
79072805 LW |
422 | struct loop { |
423 | BASEOP | |
424 | OP * op_first; | |
425 | OP * op_last; | |
79072805 LW |
426 | OP * op_redoop; |
427 | OP * op_nextop; | |
428 | OP * op_lastop; | |
429 | }; | |
430 | ||
9524b6e6 FC |
431 | #define cUNOPx(o) ((UNOP*)(o)) |
432 | #define cUNOP_AUXx(o) ((UNOP_AUX*)(o)) | |
433 | #define cBINOPx(o) ((BINOP*)(o)) | |
434 | #define cLISTOPx(o) ((LISTOP*)(o)) | |
435 | #define cLOGOPx(o) ((LOGOP*)(o)) | |
436 | #define cPMOPx(o) ((PMOP*)(o)) | |
437 | #define cSVOPx(o) ((SVOP*)(o)) | |
438 | #define cPADOPx(o) ((PADOP*)(o)) | |
439 | #define cPVOPx(o) ((PVOP*)(o)) | |
440 | #define cCOPx(o) ((COP*)(o)) | |
441 | #define cLOOPx(o) ((LOOP*)(o)) | |
442 | #define cMETHOPx(o) ((METHOP*)(o)) | |
350de78d GS |
443 | |
444 | #define cUNOP cUNOPx(PL_op) | |
2f7c6295 | 445 | #define cUNOP_AUX cUNOP_AUXx(PL_op) |
350de78d GS |
446 | #define cBINOP cBINOPx(PL_op) |
447 | #define cLISTOP cLISTOPx(PL_op) | |
448 | #define cLOGOP cLOGOPx(PL_op) | |
449 | #define cPMOP cPMOPx(PL_op) | |
450 | #define cSVOP cSVOPx(PL_op) | |
451 | #define cPADOP cPADOPx(PL_op) | |
452 | #define cPVOP cPVOPx(PL_op) | |
453 | #define cCOP cCOPx(PL_op) | |
454 | #define cLOOP cLOOPx(PL_op) | |
455 | ||
456 | #define cUNOPo cUNOPx(o) | |
2f7c6295 | 457 | #define cUNOP_AUXo cUNOP_AUXx(o) |
350de78d GS |
458 | #define cBINOPo cBINOPx(o) |
459 | #define cLISTOPo cLISTOPx(o) | |
460 | #define cLOGOPo cLOGOPx(o) | |
461 | #define cPMOPo cPMOPx(o) | |
462 | #define cSVOPo cSVOPx(o) | |
463 | #define cPADOPo cPADOPx(o) | |
464 | #define cPVOPo cPVOPx(o) | |
465 | #define cCOPo cCOPx(o) | |
466 | #define cLOOPo cLOOPx(o) | |
467 | ||
468 | #define kUNOP cUNOPx(kid) | |
2f7c6295 | 469 | #define kUNOP_AUX cUNOP_AUXx(kid) |
350de78d GS |
470 | #define kBINOP cBINOPx(kid) |
471 | #define kLISTOP cLISTOPx(kid) | |
472 | #define kLOGOP cLOGOPx(kid) | |
473 | #define kPMOP cPMOPx(kid) | |
474 | #define kSVOP cSVOPx(kid) | |
475 | #define kPADOP cPADOPx(kid) | |
476 | #define kPVOP cPVOPx(kid) | |
477 | #define kCOP cCOPx(kid) | |
478 | #define kLOOP cLOOPx(kid) | |
479 | ||
480 | ||
1e85b658 DM |
481 | typedef enum { |
482 | OPclass_NULL, /* 0 */ | |
483 | OPclass_BASEOP, /* 1 */ | |
484 | OPclass_UNOP, /* 2 */ | |
485 | OPclass_BINOP, /* 3 */ | |
486 | OPclass_LOGOP, /* 4 */ | |
487 | OPclass_LISTOP, /* 5 */ | |
488 | OPclass_PMOP, /* 6 */ | |
489 | OPclass_SVOP, /* 7 */ | |
490 | OPclass_PADOP, /* 8 */ | |
491 | OPclass_PVOP, /* 9 */ | |
492 | OPclass_LOOP, /* 10 */ | |
493 | OPclass_COP, /* 11 */ | |
494 | OPclass_METHOP, /* 12 */ | |
495 | OPclass_UNOP_AUX /* 13 */ | |
496 | } OPclass; | |
497 | ||
498 | ||
350de78d | 499 | #ifdef USE_ITHREADS |
dd2155a4 | 500 | # define cGVOPx_gv(o) ((GV*)PAD_SVl(cPADOPx(o)->op_padix)) |
9429039d FC |
501 | # ifndef PERL_CORE |
502 | # define IS_PADGV(v) (v && isGV(v)) | |
503 | # define IS_PADCONST(v) \ | |
f5a0fd1e | 504 | (v && (SvREADONLY(v) || (SvIsCOW(v) && !SvLEN(v)))) |
9429039d | 505 | # endif |
7766f137 | 506 | # define cSVOPx_sv(v) (cSVOPx(v)->op_sv \ |
dd2155a4 | 507 | ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ)) |
638eceb6 | 508 | # define cSVOPx_svp(v) (cSVOPx(v)->op_sv \ |
dd2155a4 | 509 | ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ)) |
810bd8b7 | 510 | # define cMETHOPx_rclass(v) PAD_SVl(cMETHOPx(v)->op_rclass_targ) |
350de78d | 511 | #else |
638eceb6 | 512 | # define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv) |
9429039d FC |
513 | # ifndef PERL_CORE |
514 | # define IS_PADGV(v) FALSE | |
515 | # define IS_PADCONST(v) FALSE | |
516 | # endif | |
7766f137 | 517 | # define cSVOPx_sv(v) (cSVOPx(v)->op_sv) |
638eceb6 | 518 | # define cSVOPx_svp(v) (&cSVOPx(v)->op_sv) |
810bd8b7 | 519 | # define cMETHOPx_rclass(v) (cMETHOPx(v)->op_rclass_sv) |
350de78d | 520 | #endif |
79072805 | 521 | |
b46e009d | 522 | # define cMETHOPx_meth(v) cSVOPx_sv(v) |
523 | ||
638eceb6 GS |
524 | #define cGVOP_gv cGVOPx_gv(PL_op) |
525 | #define cGVOPo_gv cGVOPx_gv(o) | |
526 | #define kGVOP_gv cGVOPx_gv(kid) | |
527 | #define cSVOP_sv cSVOPx_sv(PL_op) | |
528 | #define cSVOPo_sv cSVOPx_sv(o) | |
529 | #define kSVOP_sv cSVOPx_sv(kid) | |
7766f137 | 530 | |
bcabcc50 NC |
531 | #ifndef PERL_CORE |
532 | # define Nullop ((OP*)NULL) | |
533 | #endif | |
79072805 | 534 | |
cee4176c | 535 | /* Lowest byte of PL_opargs */ |
a0d0e21e LW |
536 | #define OA_MARK 1 |
537 | #define OA_FOLDCONST 2 | |
538 | #define OA_RETSCALAR 4 | |
539 | #define OA_TARGET 8 | |
903fd87c | 540 | #define OA_TARGLEX 16 |
a0d0e21e LW |
541 | #define OA_OTHERINT 32 |
542 | #define OA_DANGEROUS 64 | |
543 | #define OA_DEFGV 128 | |
544 | ||
738ec380 | 545 | /* The next 4 bits (8..11) encode op class information */ |
903fd87c | 546 | #define OCSHIFT 8 |
b162f9ea IZ |
547 | |
548 | #define OA_CLASS_MASK (15 << OCSHIFT) | |
549 | ||
550 | #define OA_BASEOP (0 << OCSHIFT) | |
551 | #define OA_UNOP (1 << OCSHIFT) | |
552 | #define OA_BINOP (2 << OCSHIFT) | |
553 | #define OA_LOGOP (3 << OCSHIFT) | |
1a67a97c SM |
554 | #define OA_LISTOP (4 << OCSHIFT) |
555 | #define OA_PMOP (5 << OCSHIFT) | |
556 | #define OA_SVOP (6 << OCSHIFT) | |
7934575e | 557 | #define OA_PADOP (7 << OCSHIFT) |
1a67a97c SM |
558 | #define OA_PVOP_OR_SVOP (8 << OCSHIFT) |
559 | #define OA_LOOP (9 << OCSHIFT) | |
560 | #define OA_COP (10 << OCSHIFT) | |
561 | #define OA_BASEOP_OR_UNOP (11 << OCSHIFT) | |
562 | #define OA_FILESTATOP (12 << OCSHIFT) | |
563 | #define OA_LOOPEXOP (13 << OCSHIFT) | |
b46e009d | 564 | #define OA_METHOP (14 << OCSHIFT) |
2f7c6295 | 565 | #define OA_UNOP_AUX (15 << OCSHIFT) |
b162f9ea | 566 | |
738ec380 DM |
567 | /* Each remaining nybble of PL_opargs (i.e. bits 12..15, 16..19 etc) |
568 | * encode the type for each arg */ | |
903fd87c | 569 | #define OASHIFT 12 |
a0d0e21e | 570 | |
a0d0e21e LW |
571 | #define OA_SCALAR 1 |
572 | #define OA_LIST 2 | |
573 | #define OA_AVREF 3 | |
574 | #define OA_HVREF 4 | |
575 | #define OA_CVREF 5 | |
576 | #define OA_FILEREF 6 | |
577 | #define OA_SCALARREF 7 | |
578 | #define OA_OPTIONAL 8 | |
579 | ||
d3c72c2a DM |
580 | /* Op_REFCNT is a reference count at the head of each op tree: needed |
581 | * since the tree is shared between threads, and between cloned closure | |
582 | * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying | |
583 | * this count. | |
584 | * The same mutex is used to protect the refcounts of the reg_trie_data | |
585 | * and reg_ac_data structures, which are shared between duplicated | |
586 | * regexes. | |
587 | */ | |
588 | ||
534825c4 GS |
589 | #ifdef USE_ITHREADS |
590 | # define OP_REFCNT_INIT MUTEX_INIT(&PL_op_mutex) | |
4026c95a SH |
591 | # ifdef PERL_CORE |
592 | # define OP_REFCNT_LOCK MUTEX_LOCK(&PL_op_mutex) | |
593 | # define OP_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_op_mutex) | |
594 | # else | |
595 | # define OP_REFCNT_LOCK op_refcnt_lock() | |
596 | # define OP_REFCNT_UNLOCK op_refcnt_unlock() | |
597 | # endif | |
534825c4 | 598 | # define OP_REFCNT_TERM MUTEX_DESTROY(&PL_op_mutex) |
534825c4 GS |
599 | #else |
600 | # define OP_REFCNT_INIT NOOP | |
601 | # define OP_REFCNT_LOCK NOOP | |
602 | # define OP_REFCNT_UNLOCK NOOP | |
603 | # define OP_REFCNT_TERM NOOP | |
534825c4 | 604 | #endif |
e4783991 | 605 | |
282f25c9 | 606 | #define OpREFCNT_set(o,n) ((o)->op_targ = (n)) |
fc97af9c NC |
607 | #ifdef PERL_DEBUG_READONLY_OPS |
608 | # define OpREFCNT_inc(o) Perl_op_refcnt_inc(aTHX_ o) | |
609 | # define OpREFCNT_dec(o) Perl_op_refcnt_dec(aTHX_ o) | |
610 | #else | |
611 | # define OpREFCNT_inc(o) ((o) ? (++(o)->op_targ, (o)) : NULL) | |
612 | # define OpREFCNT_dec(o) (--(o)->op_targ) | |
613 | #endif | |
282f25c9 | 614 | |
e4783991 | 615 | /* flags used by Perl_load_module() */ |
ec6d81ab RGS |
616 | #define PERL_LOADMOD_DENY 0x1 /* no Module */ |
617 | #define PERL_LOADMOD_NOIMPORT 0x2 /* use Module () */ | |
466f50cc FC |
618 | #define PERL_LOADMOD_IMPORT_OPS 0x4 /* import arguments |
619 | are passed as a sin- | |
620 | gle op tree, not a | |
621 | list of SVs */ | |
e5dd39fc | 622 | |
30d9c59b | 623 | #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C) || defined(PERL_IN_TOKE_C) |
e4c5ccf3 | 624 | #define ref(o, type) doref(o, type, TRUE) |
a0c21aa1 | 625 | #endif |
e4c5ccf3 | 626 | |
5983a79d BM |
627 | /* |
628 | =head1 Optree Manipulation Functions | |
629 | ||
630 | =for apidoc Am|OP*|LINKLIST|OP *o | |
631 | Given the root of an optree, link the tree in execution order using the | |
72d33970 | 632 | C<op_next> pointers and return the first op executed. If this has |
5983a79d | 633 | already been done, it will not be redone, and C<< o->op_next >> will be |
2d7f6611 | 634 | returned. If C<< o->op_next >> is not already set, C<o> should be at |
5983a79d BM |
635 | least an C<UNOP>. |
636 | ||
637 | =cut | |
638 | */ | |
639 | ||
640 | #define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o)) | |
641 | ||
33f36c71 NC |
642 | /* no longer used anywhere in core */ |
643 | #ifndef PERL_CORE | |
46471bde | 644 | #define cv_ckproto(cv, gv, p) \ |
f717afa7 | 645 | cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0) |
33f36c71 NC |
646 | #endif |
647 | ||
7d0905b9 NC |
648 | #ifdef PERL_CORE |
649 | # define my(o) my_attrs((o), NULL) | |
650 | #endif | |
651 | ||
e5dd39fc | 652 | #ifdef USE_REENTRANT_API |
10bc17b6 | 653 | #include "reentr.h" |
e5dd39fc AB |
654 | #endif |
655 | ||
c7e45529 | 656 | #define NewOp(m,var,c,type) \ |
e91d68d5 | 657 | (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type))) |
c7e45529 | 658 | #define NewOpSz(m,var,size) \ |
e91d68d5 | 659 | (var = (OP *) Perl_Slab_Alloc(aTHX_ size)) |
c7e45529 | 660 | #define FreeOp(p) Perl_Slab_Free(aTHX_ p) |
8be227ab FC |
661 | |
662 | /* | |
663 | * The per-CV op slabs consist of a header (the opslab struct) and a bunch | |
664 | * of space for allocating op slots, each of which consists of two pointers | |
665 | * followed by an op. The first pointer points to the next op slot. The | |
666 | * second points to the slab. At the end of the slab is a null pointer, | |
667 | * so that slot->opslot_next - slot can be used to determine the size | |
668 | * of the op. | |
669 | * | |
670 | * Each CV can have multiple slabs; opslab_next points to the next slab, to | |
671 | * form a chain. All bookkeeping is done on the first slab, which is where | |
672 | * all the op slots point. | |
673 | * | |
674 | * Freed ops are marked as freed and attached to the freed chain | |
675 | * via op_next pointers. | |
676 | * | |
677 | * When there is more than one slab, the second slab in the slab chain is | |
678 | * assumed to be the one with free space available. It is used when allo- | |
679 | * cating an op if there are no freed ops available or big enough. | |
680 | */ | |
681 | ||
7aef8e5b | 682 | #ifdef PERL_CORE |
8be227ab FC |
683 | struct opslot { |
684 | /* keep opslot_next first */ | |
685 | OPSLOT * opslot_next; /* next slot */ | |
686 | OPSLAB * opslot_slab; /* owner */ | |
687 | OP opslot_op; /* the op itself */ | |
688 | }; | |
689 | ||
690 | struct opslab { | |
691 | OPSLOT * opslab_first; /* first op in this slab */ | |
692 | OPSLAB * opslab_next; /* next slab */ | |
693 | OP * opslab_freed; /* chain of freed ops */ | |
694 | size_t opslab_refcnt; /* number of ops */ | |
3107b51f FC |
695 | # ifdef PERL_DEBUG_READONLY_OPS |
696 | U16 opslab_size; /* size of slab in pointers */ | |
697 | bool opslab_readonly; | |
698 | # endif | |
8be227ab FC |
699 | OPSLOT opslab_slots; /* slots begin here */ |
700 | }; | |
701 | ||
702 | # define OPSLOT_HEADER STRUCT_OFFSET(OPSLOT, opslot_op) | |
703 | # define OPSLOT_HEADER_P (OPSLOT_HEADER/sizeof(I32 *)) | |
c7724415 | 704 | # define OpSLOT(o) (assert_(o->op_slabbed) \ |
8be227ab | 705 | (OPSLOT *)(((char *)o)-OPSLOT_HEADER)) |
8be227ab FC |
706 | # define OpSLAB(o) OpSLOT(o)->opslot_slab |
707 | # define OpslabREFCNT_dec(slab) \ | |
708 | (((slab)->opslab_refcnt == 1) \ | |
709 | ? opslab_free_nopad(slab) \ | |
710 | : (void)--(slab)->opslab_refcnt) | |
711 | /* Variant that does not null out the pads */ | |
712 | # define OpslabREFCNT_dec_padok(slab) \ | |
713 | (((slab)->opslab_refcnt == 1) \ | |
714 | ? opslab_free(slab) \ | |
715 | : (void)--(slab)->opslab_refcnt) | |
c7e45529 | 716 | #endif |
598921a7 | 717 | |
1930840b | 718 | struct block_hooks { |
52db365a | 719 | U32 bhk_flags; |
1930840b BM |
720 | void (*bhk_start) (pTHX_ int full); |
721 | void (*bhk_pre_end) (pTHX_ OP **seq); | |
722 | void (*bhk_post_end) (pTHX_ OP **seq); | |
52db365a | 723 | void (*bhk_eval) (pTHX_ OP *const saveop); |
1930840b BM |
724 | }; |
725 | ||
fd85fad2 BM |
726 | /* |
727 | =head1 Compile-time scope hooks | |
728 | ||
3e4ddde5 | 729 | =for apidoc mx|U32|BhkFLAGS|BHK *hk |
fd85fad2 BM |
730 | Return the BHK's flags. |
731 | ||
3e4ddde5 | 732 | =for apidoc mx|void *|BhkENTRY|BHK *hk|which |
2d7f6611 | 733 | Return an entry from the BHK structure. C<which> is a preprocessor token |
72d33970 | 734 | indicating which entry to return. If the appropriate flag is not set |
796b6530 | 735 | this will return C<NULL>. The type of the return value depends on which |
fd85fad2 BM |
736 | entry you ask for. |
737 | ||
3e4ddde5 | 738 | =for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr |
fd85fad2 | 739 | Set an entry in the BHK structure, and set the flags to indicate it is |
2d7f6611 KW |
740 | valid. C<which> is a preprocessing token indicating which entry to set. |
741 | The type of C<ptr> depends on the entry. | |
fd85fad2 | 742 | |
3e4ddde5 | 743 | =for apidoc Amx|void|BhkDISABLE|BHK *hk|which |
a3e07c87 | 744 | Temporarily disable an entry in this BHK structure, by clearing the |
2d7f6611 | 745 | appropriate flag. C<which> is a preprocessor token indicating which |
a3e07c87 BM |
746 | entry to disable. |
747 | ||
3e4ddde5 | 748 | =for apidoc Amx|void|BhkENABLE|BHK *hk|which |
a3e07c87 | 749 | Re-enable an entry in this BHK structure, by setting the appropriate |
2d7f6611 | 750 | flag. C<which> is a preprocessor token indicating which entry to enable. |
a3e07c87 BM |
751 | This will assert (under -DDEBUGGING) if the entry doesn't contain a valid |
752 | pointer. | |
753 | ||
3e4ddde5 | 754 | =for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg |
2d7f6611 KW |
755 | Call all the registered block hooks for type C<which>. C<which> is a |
756 | preprocessing token; the type of C<arg> depends on C<which>. | |
fd85fad2 BM |
757 | |
758 | =cut | |
759 | */ | |
760 | ||
52db365a BM |
761 | #define BhkFLAGS(hk) ((hk)->bhk_flags) |
762 | ||
a88d97bf BM |
763 | #define BHKf_bhk_start 0x01 |
764 | #define BHKf_bhk_pre_end 0x02 | |
765 | #define BHKf_bhk_post_end 0x04 | |
766 | #define BHKf_bhk_eval 0x08 | |
52db365a BM |
767 | |
768 | #define BhkENTRY(hk, which) \ | |
a88d97bf | 769 | ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL) |
52db365a | 770 | |
a3e07c87 BM |
771 | #define BhkENABLE(hk, which) \ |
772 | STMT_START { \ | |
773 | BhkFLAGS(hk) |= BHKf_ ## which; \ | |
774 | assert(BhkENTRY(hk, which)); \ | |
775 | } STMT_END | |
776 | ||
777 | #define BhkDISABLE(hk, which) \ | |
778 | STMT_START { \ | |
779 | BhkFLAGS(hk) &= ~(BHKf_ ## which); \ | |
780 | } STMT_END | |
781 | ||
52db365a BM |
782 | #define BhkENTRY_set(hk, which, ptr) \ |
783 | STMT_START { \ | |
a88d97bf | 784 | (hk)->which = ptr; \ |
a3e07c87 | 785 | BhkENABLE(hk, which); \ |
52db365a BM |
786 | } STMT_END |
787 | ||
1930840b BM |
788 | #define CALL_BLOCK_HOOKS(which, arg) \ |
789 | STMT_START { \ | |
790 | if (PL_blockhooks) { \ | |
c70927a6 | 791 | SSize_t i; \ |
b9f2b683 | 792 | for (i = av_tindex(PL_blockhooks); i >= 0; i--) { \ |
1930840b | 793 | SV *sv = AvARRAY(PL_blockhooks)[i]; \ |
52db365a | 794 | BHK *hk; \ |
1930840b BM |
795 | \ |
796 | assert(SvIOK(sv)); \ | |
797 | if (SvUOK(sv)) \ | |
52db365a | 798 | hk = INT2PTR(BHK *, SvUVX(sv)); \ |
1930840b | 799 | else \ |
52db365a | 800 | hk = INT2PTR(BHK *, SvIVX(sv)); \ |
1930840b | 801 | \ |
52db365a | 802 | if (BhkENTRY(hk, which)) \ |
16c91539 | 803 | BhkENTRY(hk, which)(aTHX_ arg); \ |
1930840b BM |
804 | } \ |
805 | } \ | |
806 | } STMT_END | |
807 | ||
d9088386 Z |
808 | /* flags for rv2cv_op_cv */ |
809 | ||
810 | #define RV2CVOPCV_MARK_EARLY 0x00000001 | |
811 | #define RV2CVOPCV_RETURN_NAME_GV 0x00000002 | |
211a4342 | 812 | #define RV2CVOPCV_RETURN_STUB 0x00000004 |
9c98a81f FC |
813 | #ifdef PERL_CORE /* behaviour of this flag is subject to change: */ |
814 | # define RV2CVOPCV_MAYBE_NAME_GV 0x00000008 | |
815 | #endif | |
816 | #define RV2CVOPCV_FLAG_MASK 0x0000000f /* all of the above */ | |
d9088386 | 817 | |
d3d7d28f FC |
818 | #define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0) |
819 | ||
f5d552b4 FC |
820 | /* flags for op_lvalue_flags */ |
821 | ||
822 | #define OP_LVALUE_NO_CROAK 1 | |
823 | ||
9733086d BM |
824 | /* |
825 | =head1 Custom Operators | |
826 | ||
827 | =for apidoc Am|U32|XopFLAGS|XOP *xop | |
828 | Return the XOP's flags. | |
829 | ||
830 | =for apidoc Am||XopENTRY|XOP *xop|which | |
2d7f6611 | 831 | Return a member of the XOP structure. C<which> is a cpp token |
72d33970 FC |
832 | indicating which entry to return. If the member is not set |
833 | this will return a default value. The return type depends | |
2d7f6611 | 834 | on C<which>. This macro evaluates its arguments more than |
72d33970 | 835 | once. If you are using C<Perl_custom_op_xop> to retreive a |
ae103e09 DD |
836 | C<XOP *> from a C<OP *>, use the more efficient L</XopENTRYCUSTOM> instead. |
837 | ||
838 | =for apidoc Am||XopENTRYCUSTOM|const OP *o|which | |
839 | Exactly like C<XopENTRY(XopENTRY(Perl_custom_op_xop(aTHX_ o), which)> but more | |
2d7f6611 | 840 | efficient. The C<which> parameter is identical to L</XopENTRY>. |
9733086d BM |
841 | |
842 | =for apidoc Am|void|XopENTRY_set|XOP *xop|which|value | |
2d7f6611 | 843 | Set a member of the XOP structure. C<which> is a cpp token |
72d33970 FC |
844 | indicating which entry to set. See L<perlguts/"Custom Operators"> |
845 | for details about the available members and how | |
846 | they are used. This macro evaluates its argument | |
ae103e09 | 847 | more than once. |
9733086d BM |
848 | |
849 | =for apidoc Am|void|XopDISABLE|XOP *xop|which | |
850 | Temporarily disable a member of the XOP, by clearing the appropriate flag. | |
851 | ||
852 | =for apidoc Am|void|XopENABLE|XOP *xop|which | |
853 | Reenable a member of the XOP which has been disabled. | |
854 | ||
855 | =cut | |
856 | */ | |
857 | ||
1830b3d9 BM |
858 | struct custom_op { |
859 | U32 xop_flags; | |
860 | const char *xop_name; | |
861 | const char *xop_desc; | |
862 | U32 xop_class; | |
863 | void (*xop_peep)(pTHX_ OP *o, OP *oldop); | |
864 | }; | |
865 | ||
ae103e09 DD |
866 | /* return value of Perl_custom_op_get_field, similar to void * then casting but |
867 | the U32 doesn't need truncation on 64 bit platforms in the caller, also | |
868 | for easier macro writing */ | |
869 | typedef union { | |
870 | const char *xop_name; | |
871 | const char *xop_desc; | |
872 | U32 xop_class; | |
873 | void (*xop_peep)(pTHX_ OP *o, OP *oldop); | |
874 | XOP *xop_ptr; | |
875 | } XOPRETANY; | |
876 | ||
1830b3d9 BM |
877 | #define XopFLAGS(xop) ((xop)->xop_flags) |
878 | ||
879 | #define XOPf_xop_name 0x01 | |
880 | #define XOPf_xop_desc 0x02 | |
881 | #define XOPf_xop_class 0x04 | |
882 | #define XOPf_xop_peep 0x08 | |
883 | ||
ae103e09 DD |
884 | /* used by Perl_custom_op_get_field for option checking */ |
885 | typedef enum { | |
886 | XOPe_xop_ptr = 0, /* just get the XOP *, don't look inside it */ | |
887 | XOPe_xop_name = XOPf_xop_name, | |
888 | XOPe_xop_desc = XOPf_xop_desc, | |
889 | XOPe_xop_class = XOPf_xop_class, | |
4a3798ca | 890 | XOPe_xop_peep = XOPf_xop_peep |
ae103e09 DD |
891 | } xop_flags_enum; |
892 | ||
1830b3d9 BM |
893 | #define XOPd_xop_name PL_op_name[OP_CUSTOM] |
894 | #define XOPd_xop_desc PL_op_desc[OP_CUSTOM] | |
895 | #define XOPd_xop_class OA_BASEOP | |
896 | #define XOPd_xop_peep ((Perl_cpeep_t)0) | |
897 | ||
898 | #define XopENTRY_set(xop, which, to) \ | |
899 | STMT_START { \ | |
900 | (xop)->which = (to); \ | |
901 | (xop)->xop_flags |= XOPf_ ## which; \ | |
902 | } STMT_END | |
903 | ||
904 | #define XopENTRY(xop, which) \ | |
905 | ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which) | |
906 | ||
ae103e09 DD |
907 | #define XopENTRYCUSTOM(o, which) \ |
908 | (Perl_custom_op_get_field(aTHX_ o, XOPe_ ## which).which) | |
909 | ||
1830b3d9 BM |
910 | #define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which) |
911 | #define XopENABLE(xop, which) \ | |
912 | STMT_START { \ | |
913 | (xop)->xop_flags |= XOPf_ ## which; \ | |
914 | assert(XopENTRY(xop, which)); \ | |
915 | } STMT_END | |
916 | ||
ae103e09 DD |
917 | #define Perl_custom_op_xop(x) \ |
918 | (Perl_custom_op_get_field(x, XOPe_xop_ptr).xop_ptr) | |
919 | ||
9733086d BM |
920 | /* |
921 | =head1 Optree Manipulation Functions | |
922 | ||
923 | =for apidoc Am|const char *|OP_NAME|OP *o | |
72d33970 | 924 | Return the name of the provided OP. For core ops this looks up the name |
9733086d BM |
925 | from the op_type; for custom ops from the op_ppaddr. |
926 | ||
927 | =for apidoc Am|const char *|OP_DESC|OP *o | |
928 | Return a short description of the provided OP. | |
929 | ||
930 | =for apidoc Am|U32|OP_CLASS|OP *o | |
931 | Return the class of the provided OP: that is, which of the *OP | |
72d33970 | 932 | structures it uses. For core ops this currently gets the information out |
e8f6c72a DM |
933 | of C<PL_opargs>, which does not always accurately reflect the type used; |
934 | in v5.26 onwards, see also the function C<L</op_class>> which can do a better | |
935 | job of determining the used type. | |
936 | ||
9733086d | 937 | For custom ops the type is returned from the registration, and it is up |
72d33970 | 938 | to the registree to ensure it is accurate. The value returned will be |
796b6530 | 939 | one of the C<OA_>* constants from F<op.h>. |
9733086d | 940 | |
5bfb0af0 | 941 | =for apidoc Am|bool|OP_TYPE_IS|OP *o|Optype type |
796b6530 | 942 | Returns true if the given OP is not a C<NULL> pointer |
11ee9dd6 S |
943 | and if it is of the given type. |
944 | ||
945 | The negation of this macro, C<OP_TYPE_ISNT> is also available | |
946 | as well as C<OP_TYPE_IS_NN> and C<OP_TYPE_ISNT_NN> which elide | |
947 | the NULL pointer check. | |
948 | ||
5bfb0af0 | 949 | =for apidoc Am|bool|OP_TYPE_IS_OR_WAS|OP *o|Optype type |
11ee9dd6 S |
950 | Returns true if the given OP is not a NULL pointer and |
951 | if it is of the given type or used to be before being | |
952 | replaced by an OP of type OP_NULL. | |
953 | ||
954 | The negation of this macro, C<OP_TYPE_ISNT_AND_WASNT> | |
955 | is also available as well as C<OP_TYPE_IS_OR_WAS_NN> | |
956 | and C<OP_TYPE_ISNT_AND_WASNT_NN> which elide | |
796b6530 | 957 | the C<NULL> pointer check. |
11ee9dd6 | 958 | |
e6dae479 | 959 | =for apidoc Am|bool|OpHAS_SIBLING|OP *o |
796b6530 | 960 | Returns true if C<o> has a sibling |
1ed44841 | 961 | |
5e24af7d | 962 | =for apidoc Am|OP*|OpSIBLING|OP *o |
796b6530 | 963 | Returns the sibling of C<o>, or C<NULL> if there is no sibling |
1ed44841 | 964 | |
5e24af7d | 965 | =for apidoc Am|void|OpMORESIB_set|OP *o|OP *sib |
796b6530 | 966 | Sets the sibling of C<o> to the non-zero value C<sib>. See also C<L</OpLASTSIB_set>> |
fbe13c60 KW |
967 | and C<L</OpMAYBESIB_set>>. For a higher-level interface, see |
968 | C<L</op_sibling_splice>>. | |
5e24af7d DM |
969 | |
970 | =for apidoc Am|void|OpLASTSIB_set|OP *o|OP *parent | |
796b6530 | 971 | Marks C<o> as having no further siblings. On C<PERL_OP_PARENT> builds, marks |
fbe13c60 | 972 | o as having the specified parent. See also C<L</OpMORESIB_set>> and |
5e24af7d | 973 | C<OpMAYBESIB_set>. For a higher-level interface, see |
fbe13c60 | 974 | C<L</op_sibling_splice>>. |
5e24af7d DM |
975 | |
976 | =for apidoc Am|void|OpMAYBESIB_set|OP *o|OP *sib|OP *parent | |
977 | Conditionally does C<OpMORESIB_set> or C<OpLASTSIB_set> depending on whether | |
796b6530 | 978 | C<sib> is non-null. For a higher-level interface, see C<L</op_sibling_splice>>. |
1ed44841 | 979 | |
9733086d BM |
980 | =cut |
981 | */ | |
982 | ||
1830b3d9 | 983 | #define OP_NAME(o) ((o)->op_type == OP_CUSTOM \ |
ae103e09 | 984 | ? XopENTRYCUSTOM(o, xop_name) \ |
1830b3d9 BM |
985 | : PL_op_name[(o)->op_type]) |
986 | #define OP_DESC(o) ((o)->op_type == OP_CUSTOM \ | |
ae103e09 | 987 | ? XopENTRYCUSTOM(o, xop_desc) \ |
1830b3d9 BM |
988 | : PL_op_desc[(o)->op_type]) |
989 | #define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \ | |
ae103e09 | 990 | ? XopENTRYCUSTOM(o, xop_class) \ |
1830b3d9 BM |
991 | : (PL_opargs[(o)->op_type] & OA_CLASS_MASK)) |
992 | ||
437e3a7d | 993 | #define OP_TYPE_IS(o, type) ((o) && (o)->op_type == (type)) |
11ee9dd6 S |
994 | #define OP_TYPE_IS_NN(o, type) ((o)->op_type == (type)) |
995 | #define OP_TYPE_ISNT(o, type) ((o) && (o)->op_type != (type)) | |
996 | #define OP_TYPE_ISNT_NN(o, type) ((o)->op_type != (type)) | |
997 | ||
998 | #define OP_TYPE_IS_OR_WAS_NN(o, type) \ | |
999 | ( ((o)->op_type == OP_NULL \ | |
1000 | ? (o)->op_targ \ | |
1001 | : (o)->op_type) \ | |
1002 | == (type) ) | |
1003 | ||
1004 | #define OP_TYPE_IS_OR_WAS(o, type) \ | |
1005 | ( (o) && OP_TYPE_IS_OR_WAS_NN(o, type) ) | |
1006 | ||
1007 | #define OP_TYPE_ISNT_AND_WASNT_NN(o, type) \ | |
1008 | ( ((o)->op_type == OP_NULL \ | |
1009 | ? (o)->op_targ \ | |
1010 | : (o)->op_type) \ | |
1011 | != (type) ) | |
1012 | ||
1013 | #define OP_TYPE_ISNT_AND_WASNT(o, type) \ | |
1014 | ( (o) && OP_TYPE_ISNT_AND_WASNT_NN(o, type) ) | |
437e3a7d | 1015 | |
5e24af7d | 1016 | |
29e61fd9 | 1017 | #ifdef PERL_OP_PARENT |
87b5a8b9 DM |
1018 | # define OpHAS_SIBLING(o) (cBOOL((o)->op_moresib)) |
1019 | # define OpSIBLING(o) (0 + (o)->op_moresib ? (o)->op_sibparent : NULL) | |
5e24af7d DM |
1020 | # define OpMORESIB_set(o, sib) ((o)->op_moresib = 1, (o)->op_sibparent = (sib)) |
1021 | # define OpLASTSIB_set(o, parent) \ | |
1022 | ((o)->op_moresib = 0, (o)->op_sibparent = (parent)) | |
1023 | # define OpMAYBESIB_set(o, sib, parent) \ | |
1024 | ((o)->op_sibparent = ((o)->op_moresib = cBOOL(sib)) ? (sib) : (parent)) | |
29e61fd9 | 1025 | #else |
e6dae479 FC |
1026 | # define OpHAS_SIBLING(o) (cBOOL((o)->op_sibling)) |
1027 | # define OpSIBLING(o) (0 + (o)->op_sibling) | |
5e24af7d DM |
1028 | # define OpMORESIB_set(o, sib) ((o)->op_moresib = 1, (o)->op_sibling = (sib)) |
1029 | # define OpLASTSIB_set(o, parent) \ | |
1030 | ((o)->op_moresib = 0, (o)->op_sibling = NULL) | |
1031 | # define OpMAYBESIB_set(o, sib, parent) \ | |
1032 | ((o)->op_moresib = cBOOL(sib), (o)->op_sibling = (sib)) | |
e6dae479 | 1033 | #endif |
5e24af7d | 1034 | |
e6dae479 | 1035 | #if !defined(PERL_CORE) && !defined(PERL_EXT) |
5e24af7d | 1036 | /* for backwards compatibility only */ |
e6dae479 | 1037 | # define OP_SIBLING(o) OpSIBLING(o) |
29e61fd9 | 1038 | #endif |
1ed44841 | 1039 | |
e8f91c91 DD |
1040 | #define newATTRSUB(f, o, p, a, b) Perl_newATTRSUB_x(aTHX_ f, o, p, a, b, FALSE) |
1041 | #define newSUB(f, o, p, b) newATTRSUB((f), (o), (p), NULL, (b)) | |
7bff8c33 | 1042 | |
3f2908ec | 1043 | /* |
e8570548 Z |
1044 | =head1 Hook manipulation |
1045 | */ | |
1046 | ||
1047 | #ifdef USE_ITHREADS | |
1048 | # define OP_CHECK_MUTEX_INIT MUTEX_INIT(&PL_check_mutex) | |
1049 | # define OP_CHECK_MUTEX_LOCK MUTEX_LOCK(&PL_check_mutex) | |
1050 | # define OP_CHECK_MUTEX_UNLOCK MUTEX_UNLOCK(&PL_check_mutex) | |
1051 | # define OP_CHECK_MUTEX_TERM MUTEX_DESTROY(&PL_check_mutex) | |
1052 | #else | |
1053 | # define OP_CHECK_MUTEX_INIT NOOP | |
1054 | # define OP_CHECK_MUTEX_LOCK NOOP | |
1055 | # define OP_CHECK_MUTEX_UNLOCK NOOP | |
1056 | # define OP_CHECK_MUTEX_TERM NOOP | |
1057 | #endif | |
1058 | ||
fedf30e1 DM |
1059 | |
1060 | /* Stuff for OP_MULTDEREF/pp_multideref. */ | |
1061 | ||
1062 | /* actions */ | |
1063 | ||
1064 | /* Load another word of actions/flag bits. Must be 0 */ | |
1065 | #define MDEREF_reload 0 | |
1066 | ||
1067 | #define MDEREF_AV_pop_rv2av_aelem 1 | |
1068 | #define MDEREF_AV_gvsv_vivify_rv2av_aelem 2 | |
1069 | #define MDEREF_AV_padsv_vivify_rv2av_aelem 3 | |
1070 | #define MDEREF_AV_vivify_rv2av_aelem 4 | |
1071 | #define MDEREF_AV_padav_aelem 5 | |
1072 | #define MDEREF_AV_gvav_aelem 6 | |
1073 | ||
1074 | #define MDEREF_HV_pop_rv2hv_helem 8 | |
1075 | #define MDEREF_HV_gvsv_vivify_rv2hv_helem 9 | |
1076 | #define MDEREF_HV_padsv_vivify_rv2hv_helem 10 | |
1077 | #define MDEREF_HV_vivify_rv2hv_helem 11 | |
1078 | #define MDEREF_HV_padhv_helem 12 | |
1079 | #define MDEREF_HV_gvhv_helem 13 | |
1080 | ||
1081 | #define MDEREF_ACTION_MASK 0xf | |
1082 | ||
1083 | /* key / index type */ | |
1084 | ||
1085 | #define MDEREF_INDEX_none 0x00 /* run external ops to generate index */ | |
1086 | #define MDEREF_INDEX_const 0x10 /* index is const PV/UV */ | |
1087 | #define MDEREF_INDEX_padsv 0x20 /* index is lexical var */ | |
1088 | #define MDEREF_INDEX_gvsv 0x30 /* index is GV */ | |
1089 | ||
1090 | #define MDEREF_INDEX_MASK 0x30 | |
1091 | ||
1092 | /* bit flags */ | |
1093 | ||
1094 | #define MDEREF_FLAG_last 0x40 /* the last [ah]elem; PL_op flags apply */ | |
1095 | ||
1096 | #define MDEREF_MASK 0x7F | |
1097 | #define MDEREF_SHIFT 7 | |
1098 | ||
87e05d1a | 1099 | #if defined(PERL_IN_DOOP_C) || defined(PERL_IN_PP_C) |
5d09ee1c | 1100 | static const char * const fatal_above_ff_msg |
87e05d1a | 1101 | = "Use of strings with code points over 0xFF as arguments to " |
5d09ee1c | 1102 | "%s operator is not allowed"; |
87e05d1a KW |
1103 | #endif |
1104 | ||
fedf30e1 | 1105 | |
e8570548 | 1106 | /* |
14d04a33 | 1107 | * ex: set ts=8 sts=4 sw=4 et: |
3f2908ec | 1108 | */ |