This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Pod::InputObjects tweak (from Brad Appleton)
[perl5.git] / op.h
CommitLineData
a0d0e21e 1/* op.h
79072805 2 *
3818b22b 3 * Copyright (c) 1991-2000, Larry Wall
79072805
LW
4 *
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
7 *
79072805
LW
8 */
9
10/*
11 * The fields of BASEOP are:
12 * op_next Pointer to next ppcode to execute after this one.
13 * (Top level pre-grafted op points to first op,
14 * but this is replaced when op is grafted in, when
15 * this op will point to the real next op, and the new
16 * parent takes over role of remembering starting op.)
17 * op_ppaddr Pointer to current ppcode's function.
18 * op_type The type of the operation.
19 * op_flags Flags common to all operations. See OPf_* below.
20 * op_private Flags peculiar to a particular operation (BUT,
21 * by default, set to the number of children until
22 * the operation is privatized by a check routine,
23 * which may or may not check number of children).
24 */
25
4633a7c4 26typedef U32 PADOFFSET;
11343788 27#define NOT_IN_PAD ((PADOFFSET) -1)
79072805 28
4633a7c4 29#ifdef DEBUGGING_OPS
79072805
LW
30#define OPCODE opcode
31#else
32#define OPCODE U16
33#endif
34
0f4eea8f
DL
35#ifdef BASEOP_DEFINITION
36#define BASEOP BASEOP_DEFINITION
37#else
79072805
LW
38#define BASEOP \
39 OP* op_next; \
40 OP* op_sibling; \
4f63d024 41 OP* (CPERLscope(*op_ppaddr))(pTHX); \
79072805
LW
42 PADOFFSET op_targ; \
43 OPCODE op_type; \
44 U16 op_seq; \
a0d0e21e
LW
45 U8 op_flags; \
46 U8 op_private;
0f4eea8f 47#endif
79072805 48
54310121
PP
49#define OP_GIMME(op,dfl) \
50 (((op)->op_flags & OPf_WANT) == OPf_WANT_VOID ? G_VOID : \
51 ((op)->op_flags & OPf_WANT) == OPf_WANT_SCALAR ? G_SCALAR : \
52 ((op)->op_flags & OPf_WANT) == OPf_WANT_LIST ? G_ARRAY : \
53 dfl)
54
954c1994
GS
55/*
56=for apidoc Amn|U32|GIMME_V
57The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
58C<G_SCALAR> or C<G_ARRAY> for void, scalar or array context,
59respectively.
60
61=for apidoc Amn|U32|GIMME
62A backward-compatible version of C<GIMME_V> which can only return
63C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
64Deprecated. Use C<GIMME_V> instead.
65
66=cut
67*/
68
533c011a 69#define GIMME_V OP_GIMME(PL_op, block_gimme())
79072805
LW
70
71/* Public flags */
54310121
PP
72
73#define OPf_WANT 3 /* Mask for "want" bits: */
74#define OPf_WANT_VOID 1 /* Want nothing */
75#define OPf_WANT_SCALAR 2 /* Want single value */
76#define OPf_WANT_LIST 3 /* Want list of any length */
79072805
LW
77#define OPf_KIDS 4 /* There is a firstborn child. */
78#define OPf_PARENS 8 /* This operator was parenthesized. */
463ee0b2 79 /* (Or block needs explicit scope entry.) */
a0d0e21e
LW
80#define OPf_REF 16 /* Certified reference. */
81 /* (Return container, not containee). */
82#define OPf_MOD 32 /* Will modify (lvalue). */
83#define OPf_STACKED 64 /* Some arg is arriving on the stack. */
79072805
LW
84#define OPf_SPECIAL 128 /* Do something weird for this op: */
85 /* On local LVAL, don't init local value. */
86 /* On OP_SORT, subroutine is inlined. */
87 /* On OP_NOT, inversion was implicit. */
a0d0e21e 88 /* On OP_LEAVE, don't restore curpm. */
79072805
LW
89 /* On truncate, we truncate filehandle */
90 /* On control verbs, we saw no label */
91 /* On flipflop, we saw ... instead of .. */
92 /* On UNOPs, saw bare parens, e.g. eof(). */
a0d0e21e 93 /* On OP_ENTERSUB || OP_NULL, saw a "do". */
afebc493 94 /* On OP_EXISTS, treat av as av, not avhv. */
f2ec2afd 95 /* On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
54b9620d 96 /* On OP_ENTERITER, loop var is per-thread */
357694d4 97 /* On pushre, re is /\s+/ imp. by split " " */
79072805 98
54310121 99/* old names; don't use in new code, but don't break them, either */
d91ab173
GS
100#define OPf_LIST OPf_WANT_LIST
101#define OPf_KNOW OPf_WANT
954c1994 102
54310121 103#define GIMME \
62a559b8
NIS
104 (PL_op->op_flags & OPf_WANT \
105 ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \
d91ab173
GS
106 ? G_ARRAY \
107 : G_SCALAR) \
108 : dowantarray())
54310121 109
d41ff1b8
GS
110/* NOTE: OP_NEXTSTATE, OP_DBSTATE, and OP_SETSTATE (i.e. COPs) carry lower
111 * bits of PL_hints in op_private */
112
a0d0e21e 113/* Private for lvalues */
cd06dffe 114#define OPpLVAL_INTRO 128 /* Lvalue must be localized or lvalue sub */
a0d0e21e 115
7934575e
GS
116/* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
117#define OPpREFCOUNTED 64 /* op_targ carries a refcount */
118
a0d0e21e
LW
119/* Private for OP_AASSIGN */
120#define OPpASSIGN_COMMON 64 /* Left & right have syms in common. */
10c8fecd 121#define OPpASSIGN_HASH 32 /* Assigning to possible pseudohash. */
a0d0e21e
LW
122
123/* Private for OP_SASSIGN */
124#define OPpASSIGN_BACKWARDS 64 /* Left & right switched. */
79072805 125
c90c0ff4
PP
126/* Private for OP_MATCH and OP_SUBST{,CONST} */
127#define OPpRUNTIME 64 /* Pattern coming in on the stack */
128
79072805 129/* Private for OP_TRANS */
4757a243
LW
130#define OPpTRANS_FROM_UTF 1
131#define OPpTRANS_TO_UTF 2
132#define OPpTRANS_IDENTICAL 4
133 /* When CU or UC, means straight latin-1 to utf-8 or vice versa */
134 /* Otherwise, IDENTICAL means the right side is the same as the left */
135#define OPpTRANS_SQUASH 8
136#define OPpTRANS_DELETE 16
137#define OPpTRANS_COMPLEMENT 32
138#define OPpTRANS_GROWS 64
79072805
LW
139
140/* Private for OP_REPEAT */
a0d0e21e 141#define OPpREPEAT_DOLIST 64 /* List replication. */
79072805 142
1ba6ee2b
GS
143/* Private for OP_LEAVELOOP */
144#define OPpLOOP_CONTINUE 64 /* a continue block is present */
145
d3011074 146/* Private for OP_RV2?V, OP_?ELEM */
5f05dabc
PP
147#define OPpDEREF (32|64) /* Want ref to something: */
148#define OPpDEREF_AV 32 /* Want ref to AV. */
149#define OPpDEREF_HV 64 /* Want ref to HV. */
150#define OPpDEREF_SV (32|64) /* Want ref to SV. */
68dc0745
PP
151 /* OP_ENTERSUB only */
152#define OPpENTERSUB_DB 16 /* Debug subroutine. */
d3011074 153#define OPpENTERSUB_HASTARG 32 /* Called from OP tree. */
7a52d87a 154 /* OP_RV2CV only */
68dc0745 155#define OPpENTERSUB_AMPER 8 /* Used & form to call. */
9675f7ac 156#define OPpENTERSUB_NOPAREN 128 /* bare sub call (without parens) */
cd06dffe 157#define OPpENTERSUB_INARGS 4 /* Lval used as arg to a sub. */
76cd736e
GS
158 /* OP_GV only */
159#define OPpEARLY_CV 32 /* foo() called before sub foo was parsed */
68dc0745
PP
160 /* OP_?ELEM only */
161#define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */
64aac5a9 162 /* OP_RV2?V, OP_GVSV only */
192587c2
GS
163#define OPpOUR_INTRO 16 /* Defer creation of array/hash elem */
164 /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
79072805 165
b162f9ea
IZ
166/* Private for OPs with TARGLEX */
167 /* (lower bits may carry MAXARG) */
168#define OPpTARGET_MY 16 /* Target is PADMY. */
169
79072805 170/* Private for OP_CONST */
7a52d87a 171#define OPpCONST_STRICT 8 /* bearword subject to strict 'subs' */
748a9306
LW
172#define OPpCONST_ENTERED 16 /* Has been entered as symbol. */
173#define OPpCONST_ARYBASE 32 /* Was a $[ translated to constant. */
a0d0e21e 174#define OPpCONST_BARE 64 /* Was a bare word (filehandle?). */
599cee73 175#define OPpCONST_WARNING 128 /* Was a $^W translated to constant. */
79072805
LW
176
177/* Private for OP_FLIP/FLOP */
a0d0e21e 178#define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */
79072805 179
ed6116ce 180/* Private for OP_LIST */
a0d0e21e
LW
181#define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */
182
5f05dabc 183/* Private for OP_DELETE */
54310121 184#define OPpSLICE 64 /* Operating on a list of keys */
5f05dabc 185
afebc493
GS
186/* Private for OP_EXISTS */
187#define OPpEXISTS_SUB 64 /* Checking for &sub, not {} or []. */
188
d0dca557
JD
189/* Private for OP_SORT, OP_PRTF, OP_SPRINTF, OP_FTTEXT, OP_FTBINARY, */
190/* string comparisons, and case changers. */
bbce6d69
PP
191#define OPpLOCALE 64 /* Use locale */
192
9c007264
JH
193/* Private for OP_SORT */
194#define OPpSORT_NUMERIC 1 /* Optimized away { $a <=> $b } */
195#define OPpSORT_INTEGER 2 /* Ditto while under "use integer" */
196#define OPpSORT_REVERSE 4 /* Descending sort */
224a4551
MB
197/* Private for OP_THREADSV */
198#define OPpDONE_SVREF 64 /* Been through newSVREF once */
554b3eca 199
79072805
LW
200struct op {
201 BASEOP
202};
203
204struct unop {
205 BASEOP
206 OP * op_first;
207};
208
209struct binop {
210 BASEOP
211 OP * op_first;
212 OP * op_last;
213};
214
215struct logop {
216 BASEOP
217 OP * op_first;
218 OP * op_other;
219};
220
79072805
LW
221struct listop {
222 BASEOP
223 OP * op_first;
224 OP * op_last;
225 U32 op_children;
226};
227
228struct pmop {
229 BASEOP
230 OP * op_first;
231 OP * op_last;
232 U32 op_children;
233 OP * op_pmreplroot;
234 OP * op_pmreplstart;
235 PMOP * op_pmnext; /* list of all scanpats */
236 REGEXP * op_pmregexp; /* compiled expression */
a0d0e21e 237 U16 op_pmflags;
4633a7c4 238 U16 op_pmpermflags;
48c036b1 239 U8 op_pmdynflags;
79072805 240};
a0d0e21e 241
48c036b1 242#define PMdf_USED 0x01 /* pm has been used once already */
b3eb6a9b 243#define PMdf_TAINTED 0x02 /* pm compiled from tainted pattern */
7e2040f0 244#define PMdf_UTF8 0x04 /* pm compiled from utf8 data */
48c036b1 245
b3eb6a9b 246#define PMf_RETAINT 0x0001 /* taint $1 etc. if target tainted */
a0d0e21e 247#define PMf_ONCE 0x0002 /* use pattern only once per reset */
c277df42 248#define PMf_REVERSED 0x0004 /* Should be matched right->left */
ce862d02 249#define PMf_MAYBE_CONST 0x0008 /* replacement contains variables */
a0d0e21e 250#define PMf_SKIPWHITE 0x0010 /* skip leading whitespace for split */
8782bef2 251#define PMf_WHITE 0x0020 /* pattern is \s+ */
a0d0e21e
LW
252#define PMf_CONST 0x0040 /* subst replacement is constant */
253#define PMf_KEEP 0x0080 /* keep 1st runtime pattern forever */
254#define PMf_GLOBAL 0x0100 /* pattern had a g modifier */
c90c0ff4 255#define PMf_CONTINUE 0x0200 /* don't reset pos() if //g fails */
a0d0e21e 256#define PMf_EVAL 0x0400 /* evaluating replacement as expr */
8782bef2 257#define PMf_LOCALE 0x0800 /* use locale for character types */
a0d0e21e
LW
258#define PMf_MULTILINE 0x1000 /* assume multiple lines */
259#define PMf_SINGLELINE 0x2000 /* assume single line */
8782bef2 260#define PMf_FOLD 0x4000 /* case insensitivity */
a0d0e21e 261#define PMf_EXTENDED 0x8000 /* chuck embedded whitespace */
79072805 262
8782bef2
GB
263/* mask of bits stored in regexp->reganch */
264#define PMf_COMPILETIME (PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED)
265
79072805
LW
266struct svop {
267 BASEOP
268 SV * op_sv;
269};
270
7934575e 271struct padop {
79072805 272 BASEOP
7934575e 273 PADOFFSET op_padix;
79072805
LW
274};
275
276struct pvop {
277 BASEOP
278 char * op_pv;
279};
280
79072805
LW
281struct loop {
282 BASEOP
283 OP * op_first;
284 OP * op_last;
285 U32 op_children;
286 OP * op_redoop;
287 OP * op_nextop;
288 OP * op_lastop;
289};
290
350de78d
GS
291#define cUNOPx(o) ((UNOP*)o)
292#define cBINOPx(o) ((BINOP*)o)
293#define cLISTOPx(o) ((LISTOP*)o)
294#define cLOGOPx(o) ((LOGOP*)o)
295#define cPMOPx(o) ((PMOP*)o)
296#define cSVOPx(o) ((SVOP*)o)
297#define cPADOPx(o) ((PADOP*)o)
298#define cPVOPx(o) ((PVOP*)o)
299#define cCOPx(o) ((COP*)o)
300#define cLOOPx(o) ((LOOP*)o)
301
302#define cUNOP cUNOPx(PL_op)
303#define cBINOP cBINOPx(PL_op)
304#define cLISTOP cLISTOPx(PL_op)
305#define cLOGOP cLOGOPx(PL_op)
306#define cPMOP cPMOPx(PL_op)
307#define cSVOP cSVOPx(PL_op)
308#define cPADOP cPADOPx(PL_op)
309#define cPVOP cPVOPx(PL_op)
310#define cCOP cCOPx(PL_op)
311#define cLOOP cLOOPx(PL_op)
312
313#define cUNOPo cUNOPx(o)
314#define cBINOPo cBINOPx(o)
315#define cLISTOPo cLISTOPx(o)
316#define cLOGOPo cLOGOPx(o)
317#define cPMOPo cPMOPx(o)
318#define cSVOPo cSVOPx(o)
319#define cPADOPo cPADOPx(o)
320#define cPVOPo cPVOPx(o)
321#define cCOPo cCOPx(o)
322#define cLOOPo cLOOPx(o)
323
324#define kUNOP cUNOPx(kid)
325#define kBINOP cBINOPx(kid)
326#define kLISTOP cLISTOPx(kid)
327#define kLOGOP cLOGOPx(kid)
328#define kPMOP cPMOPx(kid)
329#define kSVOP cSVOPx(kid)
330#define kPADOP cPADOPx(kid)
331#define kPVOP cPVOPx(kid)
332#define kCOP cCOPx(kid)
333#define kLOOP cLOOPx(kid)
334
335
336#ifdef USE_ITHREADS
638eceb6 337# define cGVOPx_gv(o) ((GV*)PL_curpad[cPADOPx(o)->op_padix])
743e66e6 338# define IS_PADGV(v) (v && SvTYPE(v) == SVt_PVGV && GvIN_PAD(v))
7766f137
GS
339# define IS_PADCONST(v) (v && SvREADONLY(v))
340# define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
341 ? cSVOPx(v)->op_sv : PL_curpad[(v)->op_targ])
638eceb6
GS
342# define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
343 ? &cSVOPx(v)->op_sv : &PL_curpad[(v)->op_targ])
350de78d 344#else
638eceb6 345# define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
743e66e6 346# define IS_PADGV(v) FALSE
7766f137
GS
347# define IS_PADCONST(v) FALSE
348# define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
638eceb6 349# define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
350de78d 350#endif
79072805 351
638eceb6
GS
352#define cGVOP_gv cGVOPx_gv(PL_op)
353#define cGVOPo_gv cGVOPx_gv(o)
354#define kGVOP_gv cGVOPx_gv(kid)
355#define cSVOP_sv cSVOPx_sv(PL_op)
356#define cSVOPo_sv cSVOPx_sv(o)
357#define kSVOP_sv cSVOPx_sv(kid)
7766f137 358
79072805
LW
359#define Nullop Null(OP*)
360
4369b173 361/* Lowest byte of PL_opargs */
a0d0e21e
LW
362#define OA_MARK 1
363#define OA_FOLDCONST 2
364#define OA_RETSCALAR 4
365#define OA_TARGET 8
366#define OA_RETINTEGER 16
367#define OA_OTHERINT 32
368#define OA_DANGEROUS 64
369#define OA_DEFGV 128
b162f9ea 370#define OA_TARGLEX 256
a0d0e21e 371
db173bac 372/* The next 4 bits encode op class information */
b162f9ea
IZ
373#define OCSHIFT 9
374
375#define OA_CLASS_MASK (15 << OCSHIFT)
376
377#define OA_BASEOP (0 << OCSHIFT)
378#define OA_UNOP (1 << OCSHIFT)
379#define OA_BINOP (2 << OCSHIFT)
380#define OA_LOGOP (3 << OCSHIFT)
1a67a97c
SM
381#define OA_LISTOP (4 << OCSHIFT)
382#define OA_PMOP (5 << OCSHIFT)
383#define OA_SVOP (6 << OCSHIFT)
7934575e 384#define OA_PADOP (7 << OCSHIFT)
1a67a97c
SM
385#define OA_PVOP_OR_SVOP (8 << OCSHIFT)
386#define OA_LOOP (9 << OCSHIFT)
387#define OA_COP (10 << OCSHIFT)
388#define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
389#define OA_FILESTATOP (12 << OCSHIFT)
390#define OA_LOOPEXOP (13 << OCSHIFT)
b162f9ea
IZ
391
392#define OASHIFT 13
a0d0e21e 393
4369b173 394/* Remaining nybbles of PL_opargs */
a0d0e21e
LW
395#define OA_SCALAR 1
396#define OA_LIST 2
397#define OA_AVREF 3
398#define OA_HVREF 4
399#define OA_CVREF 5
400#define OA_FILEREF 6
401#define OA_SCALARREF 7
402#define OA_OPTIONAL 8
403