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