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