3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005 by Larry Wall and others
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.
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.
20 * op_flags Flags common to all operations. See OPf_* below.
21 * op_private Flags peculiar to a particular operation (BUT,
22 * by default, set to the number of children until
23 * the operation is privatized by a check routine,
24 * which may or may not check number of children).
33 #ifdef BASEOP_DEFINITION
34 #define BASEOP BASEOP_DEFINITION
39 OP* (CPERLscope(*op_ppaddr))(pTHX); \
47 #define OP_GIMME(op,dfl) \
48 (((op)->op_flags & OPf_WANT) == OPf_WANT_VOID ? G_VOID : \
49 ((op)->op_flags & OPf_WANT) == OPf_WANT_SCALAR ? G_SCALAR : \
50 ((op)->op_flags & OPf_WANT) == OPf_WANT_LIST ? G_ARRAY : \
56 =for apidoc Amn|U32|GIMME_V
57 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
58 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
61 =for apidoc Amn|U32|GIMME
62 A backward-compatible version of C<GIMME_V> which can only return
63 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
64 Deprecated. Use C<GIMME_V> instead.
69 #define GIMME_V OP_GIMME(PL_op, block_gimme())
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 */
77 #define OPf_KIDS 4 /* There is a firstborn child. */
78 #define OPf_PARENS 8 /* This operator was parenthesized. */
79 /* (Or block needs explicit scope entry.) */
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. */
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. */
88 /* On OP_LEAVE, don't restore curpm. */
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(). */
93 /* On OP_ENTERSUB || OP_NULL, saw a "do". */
94 /* On OP_EXISTS, treat av as av, not avhv. */
95 /* On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
96 /* On OP_ENTERITER, loop var is per-thread */
97 /* On pushre, re is /\s+/ imp. by split " " */
98 /* On regcomp, "use re 'eval'" was in scope */
99 /* On OP_READLINE, was <$filehandle> */
100 /* On RV2[ACGHS]V, don't create GV--in
102 /* On OP_DBSTATE, indicates breakpoint
103 * (runtime property) */
104 /* On OP_AELEMFAST, indiciates pad var */
105 /* On OP_REQUIRE, was seen as CORE::require */
106 /* On OP_ANONHASH and OP_ANONLIST, create a
107 reference to the new anon hash or array */
109 /* old names; don't use in new code, but don't break them, either */
110 #define OPf_LIST OPf_WANT_LIST
111 #define OPf_KNOW OPf_WANT
114 (PL_op->op_flags & OPf_WANT \
115 ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \
120 /* NOTE: OP_NEXTSTATE, OP_DBSTATE, and OP_SETSTATE (i.e. COPs) carry lower
121 * bits of PL_hints in op_private */
123 /* Private for lvalues */
124 #define OPpLVAL_INTRO 128 /* Lvalue must be localized or lvalue sub */
126 /* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
127 #define OPpREFCOUNTED 64 /* op_targ carries a refcount */
129 /* Private for OP_AASSIGN */
130 #define OPpASSIGN_COMMON 64 /* Left & right have syms in common. */
131 #define OPpASSIGN_HASH 32 /* Assigning to possible pseudohash. */
133 /* Private for OP_SASSIGN */
134 #define OPpASSIGN_BACKWARDS 64 /* Left & right switched. */
135 #define OPpASSIGN_CV_TO_GV 128 /* Possible optimisation for constants. */
137 /* Private for OP_MATCH and OP_SUBST{,CONST} */
138 #define OPpRUNTIME 64 /* Pattern coming in on the stack */
140 /* Private for OP_TRANS */
141 #define OPpTRANS_FROM_UTF 1
142 #define OPpTRANS_TO_UTF 2
143 #define OPpTRANS_IDENTICAL 4 /* right side is same as left */
144 #define OPpTRANS_SQUASH 8
145 #define OPpTRANS_DELETE 16
146 #define OPpTRANS_COMPLEMENT 32
147 #define OPpTRANS_GROWS 64
149 /* Private for OP_REPEAT */
150 #define OPpREPEAT_DOLIST 64 /* List replication. */
152 /* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
153 #define OPpDEREF (32|64) /* autovivify: Want ref to something: */
154 #define OPpDEREF_AV 32 /* Want ref to AV. */
155 #define OPpDEREF_HV 64 /* Want ref to HV. */
156 #define OPpDEREF_SV (32|64) /* Want ref to SV. */
157 /* OP_ENTERSUB only */
158 #define OPpENTERSUB_DB 16 /* Debug subroutine. */
159 #define OPpENTERSUB_HASTARG 32 /* Called from OP tree. */
160 #define OPpENTERSUB_NOMOD 64 /* Immune to mod() for :attrlist. */
162 #define OPpENTERSUB_AMPER 8 /* Used & form to call. */
163 #define OPpENTERSUB_NOPAREN 128 /* bare sub call (without parens) */
164 #define OPpENTERSUB_INARGS 4 /* Lval used as arg to a sub. */
166 #define OPpEARLY_CV 32 /* foo() called before sub foo was parsed */
168 #define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */
169 /* OP_RV2?V, OP_GVSV, OP_ENTERITER only */
170 #define OPpOUR_INTRO 16 /* Variable was in an our() */
171 /* OP_RV2[AH]V, OP_PAD[AH]V, OP_[AH]ELEM */
172 #define OPpMAYBE_LVSUB 8 /* We might be an lvalue to return */
173 /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
176 #define OPpDONT_INIT_GV 8 /* Call gv_fetchpv with GV_NOINIT */
177 /* (Therefore will return whatever is currently in the symbol table, not
178 guaranteed to be a PVGV) */
181 #define OPpMAY_RETURN_CONSTANT 1 /* If a constant sub, return the constant */
183 /* Private for OPs with TARGLEX */
184 /* (lower bits may carry MAXARG) */
185 #define OPpTARGET_MY 16 /* Target is PADMY. */
187 /* Private for OP_ENTERITER and OP_ITER */
188 #define OPpITER_REVERSED 4 /* for (reverse ...) */
190 /* Private for OP_CONST */
191 #define OPpCONST_NOVER 2 /* no 6; */
192 #define OPpCONST_SHORTCIRCUIT 4 /* eg the constant 5 in (5 || foo) */
193 #define OPpCONST_STRICT 8 /* bearword subject to strict 'subs' */
194 #define OPpCONST_ENTERED 16 /* Has been entered as symbol. */
195 #define OPpCONST_ARYBASE 32 /* Was a $[ translated to constant. */
196 #define OPpCONST_BARE 64 /* Was a bare word (filehandle?). */
197 #define OPpCONST_WARNING 128 /* Was a $^W translated to constant. */
199 /* Private for OP_FLIP/FLOP */
200 #define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */
202 /* Private for OP_LIST */
203 #define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */
205 /* Private for OP_DELETE */
206 #define OPpSLICE 64 /* Operating on a list of keys */
208 /* Private for OP_EXISTS */
209 #define OPpEXISTS_SUB 64 /* Checking for &sub, not {} or []. */
211 /* Private for OP_SORT */
212 #define OPpSORT_NUMERIC 1 /* Optimized away { $a <=> $b } */
213 #define OPpSORT_INTEGER 2 /* Ditto while under "use integer" */
214 #define OPpSORT_REVERSE 4 /* Reversed sort */
215 #define OPpSORT_INPLACE 8 /* sort in-place; eg @a = sort @a */
216 #define OPpSORT_DESCEND 16 /* Descending sort */
217 /* Private for OP_THREADSV */
218 #define OPpDONE_SVREF 64 /* Been through newSVREF once */
220 /* Private for OP_OPEN and OP_BACKTICK */
221 #define OPpOPEN_IN_RAW 16 /* binmode(F,":raw") on input fh */
222 #define OPpOPEN_IN_CRLF 32 /* binmode(F,":crlf") on input fh */
223 #define OPpOPEN_OUT_RAW 64 /* binmode(F,":raw") on output fh */
224 #define OPpOPEN_OUT_CRLF 128 /* binmode(F,":crlf") on output fh */
226 /* Private for OP_EXIT, HUSH also for OP_DIE */
227 #define OPpHUSH_VMSISH 64 /* hush DCL exit msg vmsish mode*/
228 #define OPpEXIT_VMSISH 128 /* exit(0) vs. exit(1) vmsish mode*/
230 /* Private of OP_FTXXX */
231 #define OPpFT_ACCESS 2 /* use filetest 'access' */
232 #define OP_IS_FILETEST_ACCESS(op) \
233 (((op)->op_type) == OP_FTRREAD || \
234 ((op)->op_type) == OP_FTRWRITE || \
235 ((op)->op_type) == OP_FTREXEC || \
236 ((op)->op_type) == OP_FTEREAD || \
237 ((op)->op_type) == OP_FTEWRITE || \
238 ((op)->op_type) == OP_FTEEXEC)
271 OP * op_pmreplroot; /* (type is really union {OP*,GV*,PADOFFSET}) */
273 PMOP * op_pmnext; /* list of all scanpats */
277 REGEXP * op_pmregexp; /* compiled expression */
290 #define PM_GETRE(o) (INT2PTR(REGEXP*,SvIVX(PL_regex_pad[(o)->op_pmoffset])))
291 #define PM_SETRE(o,r) STMT_START { \
292 SV* const sv = PL_regex_pad[(o)->op_pmoffset]; \
293 sv_setiv(sv, PTR2IV(r)); \
295 #define PM_GETRE_SAFE(o) (PL_regex_pad ? PM_GETRE(o) : (REGEXP*)0)
296 #define PM_SETRE_SAFE(o,r) if (PL_regex_pad) PM_SETRE(o,r)
298 #define PM_GETRE(o) ((o)->op_pmregexp)
299 #define PM_SETRE(o,r) ((o)->op_pmregexp = (r))
300 #define PM_GETRE_SAFE PM_GETRE
301 #define PM_SETRE_SAFE PM_SETRE
304 #define PMdf_USED 0x01 /* pm has been used once already */
305 #define PMdf_TAINTED 0x02 /* pm compiled from tainted pattern */
306 #define PMdf_UTF8 0x04 /* pm compiled from utf8 data */
307 #define PMdf_DYN_UTF8 0x08
309 #define PMdf_CMP_UTF8 (PMdf_UTF8|PMdf_DYN_UTF8)
311 #define PMf_RETAINT 0x0001 /* taint $1 etc. if target tainted */
312 #define PMf_ONCE 0x0002 /* use pattern only once per reset */
313 #define PMf_UNUSED 0x0004 /* free for use */
314 #define PMf_MAYBE_CONST 0x0008 /* replacement contains variables */
315 #define PMf_SKIPWHITE 0x0010 /* skip leading whitespace for split */
316 #define PMf_WHITE 0x0020 /* pattern is \s+ */
317 #define PMf_CONST 0x0040 /* subst replacement is constant */
318 #define PMf_KEEP 0x0080 /* keep 1st runtime pattern forever */
319 #define PMf_GLOBAL 0x0100 /* pattern had a g modifier */
320 #define PMf_CONTINUE 0x0200 /* don't reset pos() if //g fails */
321 #define PMf_EVAL 0x0400 /* evaluating replacement as expr */
322 #define PMf_LOCALE 0x0800 /* use locale for character types */
323 #define PMf_MULTILINE 0x1000 /* assume multiple lines */
324 #define PMf_SINGLELINE 0x2000 /* assume single line */
325 #define PMf_FOLD 0x4000 /* case insensitivity */
326 #define PMf_EXTENDED 0x8000 /* chuck embedded whitespace */
328 /* mask of bits stored in regexp->reganch */
329 #define PMf_COMPILETIME (PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED)
333 # define PmopSTASHPV(o) ((o)->op_pmstashpv)
334 # define PmopSTASHPV_set(o,pv) (PmopSTASHPV(o) = savesharedpv(pv))
335 # define PmopSTASH(o) (PmopSTASHPV(o) \
336 ? gv_stashpv(PmopSTASHPV(o),GV_ADD) : NULL)
337 # define PmopSTASH_set(o,hv) PmopSTASHPV_set(o, ((hv) ? HvNAME_get(hv) : NULL))
338 # define PmopSTASH_free(o) PerlMemShared_free(PmopSTASHPV(o))
341 # define PmopSTASH(o) ((o)->op_pmstash)
342 # define PmopSTASH_set(o,hv) ((o)->op_pmstash = (hv))
343 # define PmopSTASHPV(o) (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
344 /* op_pmstash is not refcounted */
345 # define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
346 # define PmopSTASH_free(o)
373 #define cUNOPx(o) ((UNOP*)o)
374 #define cBINOPx(o) ((BINOP*)o)
375 #define cLISTOPx(o) ((LISTOP*)o)
376 #define cLOGOPx(o) ((LOGOP*)o)
377 #define cPMOPx(o) ((PMOP*)o)
378 #define cSVOPx(o) ((SVOP*)o)
379 #define cPADOPx(o) ((PADOP*)o)
380 #define cPVOPx(o) ((PVOP*)o)
381 #define cCOPx(o) ((COP*)o)
382 #define cLOOPx(o) ((LOOP*)o)
384 #define cUNOP cUNOPx(PL_op)
385 #define cBINOP cBINOPx(PL_op)
386 #define cLISTOP cLISTOPx(PL_op)
387 #define cLOGOP cLOGOPx(PL_op)
388 #define cPMOP cPMOPx(PL_op)
389 #define cSVOP cSVOPx(PL_op)
390 #define cPADOP cPADOPx(PL_op)
391 #define cPVOP cPVOPx(PL_op)
392 #define cCOP cCOPx(PL_op)
393 #define cLOOP cLOOPx(PL_op)
395 #define cUNOPo cUNOPx(o)
396 #define cBINOPo cBINOPx(o)
397 #define cLISTOPo cLISTOPx(o)
398 #define cLOGOPo cLOGOPx(o)
399 #define cPMOPo cPMOPx(o)
400 #define cSVOPo cSVOPx(o)
401 #define cPADOPo cPADOPx(o)
402 #define cPVOPo cPVOPx(o)
403 #define cCOPo cCOPx(o)
404 #define cLOOPo cLOOPx(o)
406 #define kUNOP cUNOPx(kid)
407 #define kBINOP cBINOPx(kid)
408 #define kLISTOP cLISTOPx(kid)
409 #define kLOGOP cLOGOPx(kid)
410 #define kPMOP cPMOPx(kid)
411 #define kSVOP cSVOPx(kid)
412 #define kPADOP cPADOPx(kid)
413 #define kPVOP cPVOPx(kid)
414 #define kCOP cCOPx(kid)
415 #define kLOOP cLOOPx(kid)
419 # define cGVOPx_gv(o) ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
420 # define IS_PADGV(v) (v && SvTYPE(v) == SVt_PVGV && GvIN_PAD(v))
421 # define IS_PADCONST(v) (v && SvREADONLY(v))
422 # define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
423 ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
424 # define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
425 ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
427 # define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
428 # define IS_PADGV(v) FALSE
429 # define IS_PADCONST(v) FALSE
430 # define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
431 # define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
434 #define cGVOP_gv cGVOPx_gv(PL_op)
435 #define cGVOPo_gv cGVOPx_gv(o)
436 #define kGVOP_gv cGVOPx_gv(kid)
437 #define cSVOP_sv cSVOPx_sv(PL_op)
438 #define cSVOPo_sv cSVOPx_sv(o)
439 #define kSVOP_sv cSVOPx_sv(kid)
441 #define Nullop Null(OP*)
443 /* Lowest byte-and-a-bit of PL_opargs */
445 #define OA_FOLDCONST 2
446 #define OA_RETSCALAR 4
448 #define OA_RETINTEGER 16
449 #define OA_OTHERINT 32
450 #define OA_DANGEROUS 64
452 #define OA_TARGLEX 256
454 /* The next 4 bits encode op class information */
457 #define OA_CLASS_MASK (15 << OCSHIFT)
459 #define OA_BASEOP (0 << OCSHIFT)
460 #define OA_UNOP (1 << OCSHIFT)
461 #define OA_BINOP (2 << OCSHIFT)
462 #define OA_LOGOP (3 << OCSHIFT)
463 #define OA_LISTOP (4 << OCSHIFT)
464 #define OA_PMOP (5 << OCSHIFT)
465 #define OA_SVOP (6 << OCSHIFT)
466 #define OA_PADOP (7 << OCSHIFT)
467 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
468 #define OA_LOOP (9 << OCSHIFT)
469 #define OA_COP (10 << OCSHIFT)
470 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
471 #define OA_FILESTATOP (12 << OCSHIFT)
472 #define OA_LOOPEXOP (13 << OCSHIFT)
476 /* Remaining nybbles of PL_opargs */
483 #define OA_SCALARREF 7
484 #define OA_OPTIONAL 8
487 # define OP_REFCNT_INIT MUTEX_INIT(&PL_op_mutex)
489 # define OP_REFCNT_LOCK MUTEX_LOCK(&PL_op_mutex)
490 # define OP_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_op_mutex)
492 # define OP_REFCNT_LOCK op_refcnt_lock()
493 # define OP_REFCNT_UNLOCK op_refcnt_unlock()
495 # define OP_REFCNT_TERM MUTEX_DESTROY(&PL_op_mutex)
497 # define OP_REFCNT_INIT NOOP
498 # define OP_REFCNT_LOCK NOOP
499 # define OP_REFCNT_UNLOCK NOOP
500 # define OP_REFCNT_TERM NOOP
503 #define OpREFCNT_set(o,n) ((o)->op_targ = (n))
504 #define OpREFCNT_inc(o) ((o) ? (++(o)->op_targ, (o)) : Nullop)
505 #define OpREFCNT_dec(o) (--(o)->op_targ)
507 /* flags used by Perl_load_module() */
508 #define PERL_LOADMOD_DENY 0x1
509 #define PERL_LOADMOD_NOIMPORT 0x2
510 #define PERL_LOADMOD_IMPORT_OPS 0x4
512 /* used in perly.y */
513 #define ref(o, type) doref(o, type, TRUE)
515 #ifdef USE_REENTRANT_API
519 #if defined(PL_OP_SLAB_ALLOC)
520 #define NewOp(m,var,c,type) \
521 (var = (type *) Perl_Slab_Alloc(aTHX_ m,c*sizeof(type)))
522 #define NewOpSz(m,var,size) \
523 (var = (OP *) Perl_Slab_Alloc(aTHX_ m,size))
524 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
526 #define NewOp(m, var, c, type) Newxz(var, c, type)
527 #define NewOpSz(m, var, size) \
528 (var = (OP*)safemalloc(size), memzero(var, size))
529 #define FreeOp(p) Safefree(p)