[Encode] 1.77 Released
[p5sagit/p5-mst-13.2.git] / op.h
CommitLineData
a0d0e21e 1/* op.h
79072805 2 *
be3c0a43 3 * Copyright (c) 1991-2002, Larry Wall
79072805 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 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 26#ifdef DEBUGGING_OPS
79072805 27#define OPCODE opcode
28#else
29#define OPCODE U16
30#endif
31
0f4eea8f 32#ifdef BASEOP_DEFINITION
33#define BASEOP BASEOP_DEFINITION
34#else
79072805 35#define BASEOP \
36 OP* op_next; \
37 OP* op_sibling; \
4f63d024 38 OP* (CPERLscope(*op_ppaddr))(pTHX); \
79072805 39 PADOFFSET op_targ; \
40 OPCODE op_type; \
41 U16 op_seq; \
a0d0e21e 42 U8 op_flags; \
43 U8 op_private;
0f4eea8f 44#endif
79072805 45
54310121 46#define OP_GIMME(op,dfl) \
47 (((op)->op_flags & OPf_WANT) == OPf_WANT_VOID ? G_VOID : \
48 ((op)->op_flags & OPf_WANT) == OPf_WANT_SCALAR ? G_SCALAR : \
49 ((op)->op_flags & OPf_WANT) == OPf_WANT_LIST ? G_ARRAY : \
50 dfl)
51
954c1994 52/*
ccfc67b7 53=head1 "Gimme" Values
54
954c1994 55=for apidoc Amn|U32|GIMME_V
56The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
91e74348 57C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
954c1994 58respectively.
59
60=for apidoc Amn|U32|GIMME
61A backward-compatible version of C<GIMME_V> which can only return
62C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
63Deprecated. Use C<GIMME_V> instead.
64
65=cut
66*/
67
533c011a 68#define GIMME_V OP_GIMME(PL_op, block_gimme())
79072805 69
70/* Public flags */
54310121 71
72#define OPf_WANT 3 /* Mask for "want" bits: */
73#define OPf_WANT_VOID 1 /* Want nothing */
74#define OPf_WANT_SCALAR 2 /* Want single value */
75#define OPf_WANT_LIST 3 /* Want list of any length */
79072805 76#define OPf_KIDS 4 /* There is a firstborn child. */
77#define OPf_PARENS 8 /* This operator was parenthesized. */
463ee0b2 78 /* (Or block needs explicit scope entry.) */
a0d0e21e 79#define OPf_REF 16 /* Certified reference. */
80 /* (Return container, not containee). */
81#define OPf_MOD 32 /* Will modify (lvalue). */
82#define OPf_STACKED 64 /* Some arg is arriving on the stack. */
79072805 83#define OPf_SPECIAL 128 /* Do something weird for this op: */
84 /* On local LVAL, don't init local value. */
85 /* On OP_SORT, subroutine is inlined. */
86 /* On OP_NOT, inversion was implicit. */
a0d0e21e 87 /* On OP_LEAVE, don't restore curpm. */
79072805 88 /* On truncate, we truncate filehandle */
89 /* On control verbs, we saw no label */
90 /* On flipflop, we saw ... instead of .. */
91 /* On UNOPs, saw bare parens, e.g. eof(). */
a0d0e21e 92 /* On OP_ENTERSUB || OP_NULL, saw a "do". */
afebc493 93 /* On OP_EXISTS, treat av as av, not avhv. */
f2ec2afd 94 /* On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
54b9620d 95 /* On OP_ENTERITER, loop var is per-thread */
497711e7 96 /* On pushre, re is /\s+/ imp. by split " " */
97 /* On regcomp, "use re 'eval'" was in scope */
7c6fadd6 98 /* On OP_READLINE, was <$filehandle> */
4e3399f9 99 /* On RV2[SG]V, don't create GV--in defined()*/
79072805 100
54310121 101/* old names; don't use in new code, but don't break them, either */
d91ab173 102#define OPf_LIST OPf_WANT_LIST
103#define OPf_KNOW OPf_WANT
954c1994 104
54310121 105#define GIMME \
62a559b8 106 (PL_op->op_flags & OPf_WANT \
107 ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \
d91ab173 108 ? G_ARRAY \
109 : G_SCALAR) \
110 : dowantarray())
54310121 111
d41ff1b8 112/* NOTE: OP_NEXTSTATE, OP_DBSTATE, and OP_SETSTATE (i.e. COPs) carry lower
113 * bits of PL_hints in op_private */
114
a0d0e21e 115/* Private for lvalues */
cd06dffe 116#define OPpLVAL_INTRO 128 /* Lvalue must be localized or lvalue sub */
a0d0e21e 117
7934575e 118/* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
119#define OPpREFCOUNTED 64 /* op_targ carries a refcount */
120
a0d0e21e 121/* Private for OP_AASSIGN */
122#define OPpASSIGN_COMMON 64 /* Left & right have syms in common. */
123
124/* Private for OP_SASSIGN */
125#define OPpASSIGN_BACKWARDS 64 /* Left & right switched. */
79072805 126
c90c0ff4 127/* Private for OP_MATCH and OP_SUBST{,CONST} */
128#define OPpRUNTIME 64 /* Pattern coming in on the stack */
129
79072805 130/* Private for OP_TRANS */
4757a243 131#define OPpTRANS_FROM_UTF 1
132#define OPpTRANS_TO_UTF 2
383e7cdd 133#define OPpTRANS_IDENTICAL 4 /* right side is same as left */
4757a243 134#define OPpTRANS_SQUASH 8
135#define OPpTRANS_DELETE 16
136#define OPpTRANS_COMPLEMENT 32
137#define OPpTRANS_GROWS 64
79072805 138
139/* Private for OP_REPEAT */
a0d0e21e 140#define OPpREPEAT_DOLIST 64 /* List replication. */
79072805 141
d3011074 142/* Private for OP_RV2?V, OP_?ELEM */
5f05dabc 143#define OPpDEREF (32|64) /* Want ref to something: */
144#define OPpDEREF_AV 32 /* Want ref to AV. */
145#define OPpDEREF_HV 64 /* Want ref to HV. */
146#define OPpDEREF_SV (32|64) /* Want ref to SV. */
68dc0745 147 /* OP_ENTERSUB only */
148#define OPpENTERSUB_DB 16 /* Debug subroutine. */
d3011074 149#define OPpENTERSUB_HASTARG 32 /* Called from OP tree. */
95f0a2f1 150#define OPpENTERSUB_NOMOD 64 /* Immune to mod() for :attrlist. */
7a52d87a 151 /* OP_RV2CV only */
68dc0745 152#define OPpENTERSUB_AMPER 8 /* Used & form to call. */
9675f7ac 153#define OPpENTERSUB_NOPAREN 128 /* bare sub call (without parens) */
cd06dffe 154#define OPpENTERSUB_INARGS 4 /* Lval used as arg to a sub. */
76cd736e 155 /* OP_GV only */
156#define OPpEARLY_CV 32 /* foo() called before sub foo was parsed */
68dc0745 157 /* OP_?ELEM only */
158#define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */
64aac5a9 159 /* OP_RV2?V, OP_GVSV only */
78f9721b 160#define OPpOUR_INTRO 16 /* Variable was in an our() */
161 /* OP_RV2[AH]V, OP_PAD[AH]V, OP_[AH]ELEM */
162#define OPpMAYBE_LVSUB 8 /* We might be an lvalue to return */
192587c2 163 /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
79072805 164
b162f9ea 165/* Private for OPs with TARGLEX */
166 /* (lower bits may carry MAXARG) */
167#define OPpTARGET_MY 16 /* Target is PADMY. */
168
79072805 169/* Private for OP_CONST */
7a52d87a 170#define OPpCONST_STRICT 8 /* bearword subject to strict 'subs' */
748a9306 171#define OPpCONST_ENTERED 16 /* Has been entered as symbol. */
172#define OPpCONST_ARYBASE 32 /* Was a $[ translated to constant. */
a0d0e21e 173#define OPpCONST_BARE 64 /* Was a bare word (filehandle?). */
599cee73 174#define OPpCONST_WARNING 128 /* Was a $^W translated to constant. */
79072805 175
176/* Private for OP_FLIP/FLOP */
a0d0e21e 177#define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */
79072805 178
ed6116ce 179/* Private for OP_LIST */
a0d0e21e 180#define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */
181
5f05dabc 182/* Private for OP_DELETE */
54310121 183#define OPpSLICE 64 /* Operating on a list of keys */
5f05dabc 184
afebc493 185/* Private for OP_EXISTS */
186#define OPpEXISTS_SUB 64 /* Checking for &sub, not {} or []. */
187
9c007264 188/* Private for OP_SORT */
189#define OPpSORT_NUMERIC 1 /* Optimized away { $a <=> $b } */
190#define OPpSORT_INTEGER 2 /* Ditto while under "use integer" */
191#define OPpSORT_REVERSE 4 /* Descending sort */
224a4551 192/* Private for OP_THREADSV */
193#define OPpDONE_SVREF 64 /* Been through newSVREF once */
554b3eca 194
16fe6d59 195/* Private for OP_OPEN and OP_BACKTICK */
196#define OPpOPEN_IN_RAW 16 /* binmode(F,":raw") on input fh */
197#define OPpOPEN_IN_CRLF 32 /* binmode(F,":crlf") on input fh */
198#define OPpOPEN_OUT_RAW 64 /* binmode(F,":raw") on output fh */
199#define OPpOPEN_OUT_CRLF 128 /* binmode(F,":crlf") on output fh */
200
96e176bf 201/* Private for OP_EXIT, HUSH also for OP_DIE */
202#define OPpHUSH_VMSISH 64 /* hush DCL exit msg vmsish mode*/
d98f61e7 203#define OPpEXIT_VMSISH 128 /* exit(0) vs. exit(1) vmsish mode*/
204
79072805 205struct op {
206 BASEOP
207};
208
209struct unop {
210 BASEOP
211 OP * op_first;
212};
213
214struct binop {
215 BASEOP
216 OP * op_first;
217 OP * op_last;
218};
219
220struct logop {
221 BASEOP
222 OP * op_first;
223 OP * op_other;
224};
225
79072805 226struct listop {
227 BASEOP
228 OP * op_first;
229 OP * op_last;
79072805 230};
231
232struct pmop {
233 BASEOP
234 OP * op_first;
235 OP * op_last;
79072805 236 OP * op_pmreplroot;
237 OP * op_pmreplstart;
238 PMOP * op_pmnext; /* list of all scanpats */
1fcf4c12 239#ifdef USE_ITHREADS
fd1bc7eb 240 IV op_pmoffset;
1fcf4c12 241#else
242 REGEXP * op_pmregexp; /* compiled expression */
243#endif
699a3330 244 U32 op_pmflags;
e2509266 245 U32 op_pmpermflags;
48c036b1 246 U8 op_pmdynflags;
cb55de95 247#ifdef USE_ITHREADS
248 char * op_pmstashpv;
249#else
250 HV * op_pmstash;
251#endif
79072805 252};
a0d0e21e 253
1fcf4c12 254#ifdef USE_ITHREADS
ba89bb6e 255#define PM_GETRE(o) (INT2PTR(REGEXP*,SvIVX(PL_regex_pad[(o)->op_pmoffset])))
dd7d6c2b 256#define PM_SETRE(o,r) STMT_START { SV* sv = PL_regex_pad[(o)->op_pmoffset]; sv_setiv(sv, PTR2IV(r)); } STMT_END
5f8cb046 257#define PM_GETRE_SAFE(o) (PL_regex_pad ? PM_GETRE(o) : (REGEXP*)0)
258#define PM_SETRE_SAFE(o,r) if (PL_regex_pad) PM_SETRE(o,r)
1fcf4c12 259#else
b9ed2502 260#define PM_GETRE(o) ((o)->op_pmregexp)
261#define PM_SETRE(o,r) ((o)->op_pmregexp = (r))
5f8cb046 262#define PM_GETRE_SAFE PM_GETRE
263#define PM_SETRE_SAFE PM_SETRE
1fcf4c12 264#endif
4825b64b 265
48c036b1 266#define PMdf_USED 0x01 /* pm has been used once already */
b3eb6a9b 267#define PMdf_TAINTED 0x02 /* pm compiled from tainted pattern */
84e09d5e 268#define PMdf_UTF8 0x04 /* pm compiled from utf8 data */
269#define PMdf_DYN_UTF8 0x08
270
271#define PMdf_CMP_UTF8 (PMdf_UTF8|PMdf_DYN_UTF8)
48c036b1 272
b3eb6a9b 273#define PMf_RETAINT 0x0001 /* taint $1 etc. if target tainted */
a0d0e21e 274#define PMf_ONCE 0x0002 /* use pattern only once per reset */
699a3330 275#define PMf_UNUSED 0x0004 /* free for use */
ce862d02 276#define PMf_MAYBE_CONST 0x0008 /* replacement contains variables */
a0d0e21e 277#define PMf_SKIPWHITE 0x0010 /* skip leading whitespace for split */
8782bef2 278#define PMf_WHITE 0x0020 /* pattern is \s+ */
a0d0e21e 279#define PMf_CONST 0x0040 /* subst replacement is constant */
280#define PMf_KEEP 0x0080 /* keep 1st runtime pattern forever */
281#define PMf_GLOBAL 0x0100 /* pattern had a g modifier */
c90c0ff4 282#define PMf_CONTINUE 0x0200 /* don't reset pos() if //g fails */
a0d0e21e 283#define PMf_EVAL 0x0400 /* evaluating replacement as expr */
8782bef2 284#define PMf_LOCALE 0x0800 /* use locale for character types */
a0d0e21e 285#define PMf_MULTILINE 0x1000 /* assume multiple lines */
286#define PMf_SINGLELINE 0x2000 /* assume single line */
8782bef2 287#define PMf_FOLD 0x4000 /* case insensitivity */
a0d0e21e 288#define PMf_EXTENDED 0x8000 /* chuck embedded whitespace */
79072805 289
8782bef2 290/* mask of bits stored in regexp->reganch */
291#define PMf_COMPILETIME (PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED)
292
cb55de95 293#ifdef USE_ITHREADS
05ec9bb3 294
cb55de95 295# define PmopSTASHPV(o) ((o)->op_pmstashpv)
05ec9bb3 296# define PmopSTASHPV_set(o,pv) (PmopSTASHPV(o) = savesharedpv(pv))
cb55de95 297# define PmopSTASH(o) (PmopSTASHPV(o) \
298 ? gv_stashpv(PmopSTASHPV(o),GV_ADD) : Nullhv)
05ec9bb3 299# define PmopSTASH_set(o,hv) PmopSTASHPV_set(o, ((hv) ? HvNAME(hv) : Nullch))
300# define PmopSTASH_free(o) PerlMemShared_free(PmopSTASHPV(o))
301
cb55de95 302#else
303# define PmopSTASH(o) ((o)->op_pmstash)
304# define PmopSTASH_set(o,hv) ((o)->op_pmstash = (hv))
305# define PmopSTASHPV(o) (PmopSTASH(o) ? HvNAME(PmopSTASH(o)) : Nullch)
306 /* op_pmstash is not refcounted */
307# define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
05ec9bb3 308# define PmopSTASH_free(o)
cb55de95 309#endif
310
79072805 311struct svop {
312 BASEOP
313 SV * op_sv;
314};
315
7934575e 316struct padop {
79072805 317 BASEOP
7934575e 318 PADOFFSET op_padix;
79072805 319};
320
321struct pvop {
322 BASEOP
323 char * op_pv;
324};
325
79072805 326struct loop {
327 BASEOP
328 OP * op_first;
329 OP * op_last;
79072805 330 OP * op_redoop;
331 OP * op_nextop;
332 OP * op_lastop;
333};
334
350de78d 335#define cUNOPx(o) ((UNOP*)o)
336#define cBINOPx(o) ((BINOP*)o)
337#define cLISTOPx(o) ((LISTOP*)o)
338#define cLOGOPx(o) ((LOGOP*)o)
339#define cPMOPx(o) ((PMOP*)o)
340#define cSVOPx(o) ((SVOP*)o)
341#define cPADOPx(o) ((PADOP*)o)
342#define cPVOPx(o) ((PVOP*)o)
343#define cCOPx(o) ((COP*)o)
344#define cLOOPx(o) ((LOOP*)o)
345
346#define cUNOP cUNOPx(PL_op)
347#define cBINOP cBINOPx(PL_op)
348#define cLISTOP cLISTOPx(PL_op)
349#define cLOGOP cLOGOPx(PL_op)
350#define cPMOP cPMOPx(PL_op)
351#define cSVOP cSVOPx(PL_op)
352#define cPADOP cPADOPx(PL_op)
353#define cPVOP cPVOPx(PL_op)
354#define cCOP cCOPx(PL_op)
355#define cLOOP cLOOPx(PL_op)
356
357#define cUNOPo cUNOPx(o)
358#define cBINOPo cBINOPx(o)
359#define cLISTOPo cLISTOPx(o)
360#define cLOGOPo cLOGOPx(o)
361#define cPMOPo cPMOPx(o)
362#define cSVOPo cSVOPx(o)
363#define cPADOPo cPADOPx(o)
364#define cPVOPo cPVOPx(o)
365#define cCOPo cCOPx(o)
366#define cLOOPo cLOOPx(o)
367
368#define kUNOP cUNOPx(kid)
369#define kBINOP cBINOPx(kid)
370#define kLISTOP cLISTOPx(kid)
371#define kLOGOP cLOGOPx(kid)
372#define kPMOP cPMOPx(kid)
373#define kSVOP cSVOPx(kid)
374#define kPADOP cPADOPx(kid)
375#define kPVOP cPVOPx(kid)
376#define kCOP cCOPx(kid)
377#define kLOOP cLOOPx(kid)
378
379
380#ifdef USE_ITHREADS
dd2155a4 381# define cGVOPx_gv(o) ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
743e66e6 382# define IS_PADGV(v) (v && SvTYPE(v) == SVt_PVGV && GvIN_PAD(v))
7766f137 383# define IS_PADCONST(v) (v && SvREADONLY(v))
384# define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
dd2155a4 385 ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
638eceb6 386# define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
dd2155a4 387 ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
350de78d 388#else
638eceb6 389# define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
743e66e6 390# define IS_PADGV(v) FALSE
7766f137 391# define IS_PADCONST(v) FALSE
392# define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
638eceb6 393# define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
350de78d 394#endif
79072805 395
638eceb6 396#define cGVOP_gv cGVOPx_gv(PL_op)
397#define cGVOPo_gv cGVOPx_gv(o)
398#define kGVOP_gv cGVOPx_gv(kid)
399#define cSVOP_sv cSVOPx_sv(PL_op)
400#define cSVOPo_sv cSVOPx_sv(o)
401#define kSVOP_sv cSVOPx_sv(kid)
7766f137 402
79072805 403#define Nullop Null(OP*)
404
91135acb 405/* Lowest byte-and-a-bit of PL_opargs */
a0d0e21e 406#define OA_MARK 1
407#define OA_FOLDCONST 2
408#define OA_RETSCALAR 4
409#define OA_TARGET 8
410#define OA_RETINTEGER 16
411#define OA_OTHERINT 32
412#define OA_DANGEROUS 64
413#define OA_DEFGV 128
b162f9ea 414#define OA_TARGLEX 256
a0d0e21e 415
db173bac 416/* The next 4 bits encode op class information */
b162f9ea 417#define OCSHIFT 9
418
419#define OA_CLASS_MASK (15 << OCSHIFT)
420
421#define OA_BASEOP (0 << OCSHIFT)
422#define OA_UNOP (1 << OCSHIFT)
423#define OA_BINOP (2 << OCSHIFT)
424#define OA_LOGOP (3 << OCSHIFT)
1a67a97c 425#define OA_LISTOP (4 << OCSHIFT)
426#define OA_PMOP (5 << OCSHIFT)
427#define OA_SVOP (6 << OCSHIFT)
7934575e 428#define OA_PADOP (7 << OCSHIFT)
1a67a97c 429#define OA_PVOP_OR_SVOP (8 << OCSHIFT)
430#define OA_LOOP (9 << OCSHIFT)
431#define OA_COP (10 << OCSHIFT)
432#define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
433#define OA_FILESTATOP (12 << OCSHIFT)
434#define OA_LOOPEXOP (13 << OCSHIFT)
b162f9ea 435
436#define OASHIFT 13
a0d0e21e 437
4369b173 438/* Remaining nybbles of PL_opargs */
a0d0e21e 439#define OA_SCALAR 1
440#define OA_LIST 2
441#define OA_AVREF 3
442#define OA_HVREF 4
443#define OA_CVREF 5
444#define OA_FILEREF 6
445#define OA_SCALARREF 7
446#define OA_OPTIONAL 8
447
534825c4 448#ifdef USE_ITHREADS
449# define OP_REFCNT_INIT MUTEX_INIT(&PL_op_mutex)
450# define OP_REFCNT_LOCK MUTEX_LOCK(&PL_op_mutex)
451# define OP_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_op_mutex)
452# define OP_REFCNT_TERM MUTEX_DESTROY(&PL_op_mutex)
534825c4 453#else
454# define OP_REFCNT_INIT NOOP
455# define OP_REFCNT_LOCK NOOP
456# define OP_REFCNT_UNLOCK NOOP
457# define OP_REFCNT_TERM NOOP
534825c4 458#endif
e4783991 459
282f25c9 460#define OpREFCNT_set(o,n) ((o)->op_targ = (n))
461#define OpREFCNT_inc(o) ((o) ? (++(o)->op_targ, (o)) : Nullop)
462#define OpREFCNT_dec(o) (--(o)->op_targ)
463
e4783991 464/* flags used by Perl_load_module() */
465#define PERL_LOADMOD_DENY 0x1
466#define PERL_LOADMOD_NOIMPORT 0x2
467#define PERL_LOADMOD_IMPORT_OPS 0x4
e5dd39fc 468
469#ifdef USE_REENTRANT_API
10bc17b6 470#include "reentr.h"
e5dd39fc 471#endif
472