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