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