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
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_opt Whether or not the op has been optimised by the
22 * op_slabbed allocated via opslab
23 * op_static tell op_free() to skip PerlMemShared_free(), when
25 * op_savefree on savestack via SAVEFREEOP
26 * op_folded Result/remainder of a constant fold operation.
27 * op_lastsib this op is is the last sibling
28 * op_spare One spare bit
29 * op_flags Flags common to all operations. See OPf_* below.
30 * op_private Flags peculiar to a particular operation (BUT,
31 * by default, set to the number of children until
32 * the operation is privatized by a check routine,
33 * which may or may not check number of children).
35 #include "op_reg_common.h"
39 typedef PERL_BITFIELD16 Optype;
41 #ifdef BASEOP_DEFINITION
42 #define BASEOP BASEOP_DEFINITION
47 OP* (*op_ppaddr)(pTHX); \
49 PERL_BITFIELD16 op_type:9; \
50 PERL_BITFIELD16 op_opt:1; \
51 PERL_BITFIELD16 op_slabbed:1; \
52 PERL_BITFIELD16 op_savefree:1; \
53 PERL_BITFIELD16 op_static:1; \
54 PERL_BITFIELD16 op_folded:1; \
55 PERL_BITFIELD16 op_lastsib:1; \
56 PERL_BITFIELD16 op_spare:1; \
61 /* If op_type:9 is changed to :10, also change PUSHEVAL in cop.h.
62 Also, if the type of op_type is ever changed (e.g. to PERL_BITFIELD32)
63 then all the other bit-fields before/after it should change their
64 types too to let VC pack them into the same 4 byte integer.*/
66 /* for efficiency, requires OPf_WANT_VOID == G_VOID etc */
67 #define OP_GIMME(op,dfl) \
68 (((op)->op_flags & OPf_WANT) ? ((op)->op_flags & OPf_WANT) : dfl)
70 #define OP_GIMME_REVERSE(flags) ((flags) & G_WANT)
75 =for apidoc Amn|U32|GIMME_V
76 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
77 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
78 respectively. See L<perlcall> for a usage example.
80 =for apidoc Amn|U32|GIMME
81 A backward-compatible version of C<GIMME_V> which can only return
82 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
83 Deprecated. Use C<GIMME_V> instead.
88 #define GIMME_V OP_GIMME(PL_op, block_gimme())
92 #define OPf_WANT 3 /* Mask for "want" bits: */
93 #define OPf_WANT_VOID 1 /* Want nothing */
94 #define OPf_WANT_SCALAR 2 /* Want single value */
95 #define OPf_WANT_LIST 3 /* Want list of any length */
96 #define OPf_KIDS 4 /* There is a firstborn child. */
97 #define OPf_PARENS 8 /* This operator was parenthesized. */
98 /* (Or block needs explicit scope entry.) */
99 #define OPf_REF 16 /* Certified reference. */
100 /* (Return container, not containee). */
101 #define OPf_MOD 32 /* Will modify (lvalue). */
102 #define OPf_STACKED 64 /* Some arg is arriving on the stack. */
103 #define OPf_SPECIAL 128 /* Do something weird for this op: */
104 /* On local LVAL, don't init local value. */
105 /* On OP_SORT, subroutine is inlined. */
106 /* On OP_NOT, inversion was implicit. */
107 /* On OP_LEAVE, don't restore curpm. */
108 /* On truncate, we truncate filehandle */
109 /* On control verbs, we saw no label */
110 /* On flipflop, we saw ... instead of .. */
111 /* On UNOPs, saw bare parens, e.g. eof(). */
112 /* On OP_ENTERSUB || OP_NULL, saw a "do". */
113 /* On OP_EXISTS, treat av as av, not avhv. */
114 /* On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
115 /* On pushre, rx is used as part of split, e.g. split " " */
116 /* On regcomp, "use re 'eval'" was in scope */
117 /* On RV2[ACGHS]V, don't create GV--in
119 /* On OP_DBSTATE, indicates breakpoint
120 * (runtime property) */
121 /* On OP_REQUIRE, was seen as CORE::require */
122 /* On OP_(ENTER|LEAVE)WHEN, there's
124 /* On OP_SMARTMATCH, an implicit smartmatch */
125 /* On OP_ANONHASH and OP_ANONLIST, create a
126 reference to the new anon hash or array */
127 /* On OP_HELEM and OP_HSLICE, localization will be followed
128 by assignment, so do not wipe the target if it is special
129 (e.g. a glob or a magic SV) */
130 /* On OP_MATCH, OP_SUBST & OP_TRANS, the
131 operand of a logical or conditional
132 that was optimised away, so it should
133 not be bound via =~ */
134 /* On OP_CONST, from a constant CV */
135 /* On OP_GLOB, two meanings:
136 - Before ck_glob, called as CORE::glob
137 - After ck_glob, use Perl glob function
139 /* On OP_PADRANGE, push @_ */
140 /* On OP_DUMP, has no label */
142 /* old names; don't use in new code, but don't break them, either */
143 #define OPf_LIST OPf_WANT_LIST
144 #define OPf_KNOW OPf_WANT
147 (PL_op->op_flags & OPf_WANT \
148 ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \
154 /* NOTE: OPp* flags are now auto-generated and defined in opcode.h,
155 * from data in regen/op_private */
158 #define OPpTRANS_ALL (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
162 /* Mask for OP_ENTERSUB flags, the absence of which must be propagated
163 in dynamic context */
164 #define OPpENTERSUB_LVAL_MASK (OPpLVAL_INTRO|OPpENTERSUB_INARGS)
166 /* VMS-specific hints in COPs */
167 #define OPpHINT_M_VMSISH_MASK (OPpHINT_M_VMSISH_STATUS|OPpHINT_M_VMSISH_TIME)
203 PADOFFSET op_pmoffset;
205 REGEXP * op_pmregexp; /* compiled expression */
209 OP * op_pmreplroot; /* For OP_SUBST */
211 PADOFFSET op_pmtargetoff; /* For OP_PUSHRE */
217 OP * op_pmreplstart; /* Only used in OP_SUBST */
219 PADOFFSET op_pmstashoff; /* Only used in OP_MATCH, with PMf_ONCE set */
224 OP * op_code_list; /* list of (?{}) code blocks */
228 #define PM_GETRE(o) (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
229 ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
230 /* The assignment is just to enforce type safety (or at least get a warning).
232 /* With first class regexps not via a reference one needs to assign
233 &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
234 is cheaper. I guess we could allow NULL, but the check above would get
235 more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
236 /* BEWARE - something that calls this macro passes (r) which has a side
238 #define PM_SETRE(o,r) STMT_START { \
239 REGEXP *const _pm_setre = (r); \
241 PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
244 #define PM_GETRE(o) ((o)->op_pmregexp)
245 #define PM_SETRE(o,r) ((o)->op_pmregexp = (r))
248 /* Currently these PMf flags occupy a single 32-bit word. Not all bits are
249 * currently used. The lower bits are shared with their corresponding RXf flag
250 * bits, up to but not including _RXf_PMf_SHIFT_NEXT. The unused bits
251 * immediately follow; finally the used Pmf-only (unshared) bits, so that the
252 * highest bit in the word is used. This gathers all the unused bits as a pool
253 * in the middle, like so: 11111111111111110000001111111111
254 * where the '1's represent used bits, and the '0's unused. This design allows
255 * us to allocate off one end of the pool if we need to add a shared bit, and
256 * off the other end if we need a non-shared bit, without disturbing the other
257 * bits. This maximizes the likelihood of being able to change things without
258 * breaking binary compatibility.
260 * To add shared bits, do so in op_reg_common.h. This should change
261 * _RXf_PMf_SHIFT_NEXT so that things won't compile. Then come to regexp.h and
262 * op.h and adjust the constant adders in the definitions of PMf_BASE_SHIFT and
263 * Pmf_BASE_SHIFT down by the number of shared bits you added. That's it.
264 * Things should be binary compatible. But if either of these gets to having
265 * to subtract rather than add, leave at 0 and adjust all the entries below
266 * that are in terms of this according. But if the first one of those is
267 * already PMf_BASE_SHIFT+0, there are no bits left, and a redesign is in
270 * To remove unshared bits, just delete its entry. If you're where breaking
271 * binary compatibility is ok to do, you might want to adjust things to move
272 * the newly opened space so that it gets absorbed into the common pool.
274 * To add unshared bits, first use up any gaps in the middle. Otherwise,
275 * allocate off the low end until you get to PMf_BASE_SHIFT+0. If that isn't
276 * enough, move PMf_BASE_SHIFT down (if possible) and add the new bit at the
277 * other end instead; this preserves binary compatibility. */
278 #define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+4)
280 /* 'use re "taint"' in scope: taint $1 etc. if target tainted */
281 #define PMf_RETAINT (1<<(PMf_BASE_SHIFT+5))
283 /* match successfully only once per reset, with related flag RXf_USED in
284 * re->extflags holding state. This is used only for ?? matches, and only on
285 * OP_MATCH and OP_QR */
286 #define PMf_ONCE (1<<(PMf_BASE_SHIFT+6))
288 /* PMf_ONCE, i.e. ?pat?, has matched successfully. Not used under threading. */
289 #define PMf_USED (1<<(PMf_BASE_SHIFT+7))
291 /* subst replacement is constant */
292 #define PMf_CONST (1<<(PMf_BASE_SHIFT+8))
294 /* keep 1st runtime pattern forever */
295 #define PMf_KEEP (1<<(PMf_BASE_SHIFT+9))
297 #define PMf_GLOBAL (1<<(PMf_BASE_SHIFT+10)) /* pattern had a g modifier */
299 /* don't reset pos() if //g fails */
300 #define PMf_CONTINUE (1<<(PMf_BASE_SHIFT+11))
302 /* evaluating replacement as expr */
303 #define PMf_EVAL (1<<(PMf_BASE_SHIFT+12))
305 /* Return substituted string instead of modifying it. */
306 #define PMf_NONDESTRUCT (1<<(PMf_BASE_SHIFT+13))
308 /* the pattern has a CV attached (currently only under qr/...(?{}).../) */
309 #define PMf_HAS_CV (1<<(PMf_BASE_SHIFT+14))
311 /* op_code_list is private; don't free it etc. It may well point to
312 * code within another sub, with different pad etc */
313 #define PMf_CODELIST_PRIVATE (1<<(PMf_BASE_SHIFT+15))
315 /* the PMOP is a QR (we should be able to detect that from the op type,
316 * but the regex compilation API passes just the pm flags, not the op
318 #define PMf_IS_QR (1<<(PMf_BASE_SHIFT+16))
319 #define PMf_USE_RE_EVAL (1<<(PMf_BASE_SHIFT+17)) /* use re'eval' in scope */
321 /* See comments at the beginning of these defines about adding bits. The
322 * highest bit position should be used, so that if PMf_BASE_SHIFT gets
323 * increased, the #error below will be triggered so that you will be reminded
324 * to adjust things at the other end to keep the bit positions unchanged */
325 #if PMf_BASE_SHIFT+17 > 31
326 # error Too many PMf_ bits used. See above and regnodes.h for any spare in middle
331 # define PmopSTASH(o) ((o)->op_pmflags & PMf_ONCE \
332 ? PL_stashpad[(o)->op_pmstashstartu.op_pmstashoff] \
334 # define PmopSTASH_set(o,hv) \
335 (assert_((o)->op_pmflags & PMf_ONCE) \
336 (o)->op_pmstashstartu.op_pmstashoff = \
337 (hv) ? alloccopstash(hv) : 0)
339 # define PmopSTASH(o) \
340 (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
341 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
342 # define PmopSTASH_set(o,hv) ({ \
343 assert((o)->op_pmflags & PMf_ONCE); \
344 ((o)->op_pmstashstartu.op_pmstash = (hv)); \
347 # define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
350 #define PmopSTASHPV(o) (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
351 /* op_pmstashstartu.op_pmstash is not refcounted */
352 #define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
378 #define cUNOPx(o) ((UNOP*)o)
379 #define cBINOPx(o) ((BINOP*)o)
380 #define cLISTOPx(o) ((LISTOP*)o)
381 #define cLOGOPx(o) ((LOGOP*)o)
382 #define cPMOPx(o) ((PMOP*)o)
383 #define cSVOPx(o) ((SVOP*)o)
384 #define cPADOPx(o) ((PADOP*)o)
385 #define cPVOPx(o) ((PVOP*)o)
386 #define cCOPx(o) ((COP*)o)
387 #define cLOOPx(o) ((LOOP*)o)
389 #define cUNOP cUNOPx(PL_op)
390 #define cBINOP cBINOPx(PL_op)
391 #define cLISTOP cLISTOPx(PL_op)
392 #define cLOGOP cLOGOPx(PL_op)
393 #define cPMOP cPMOPx(PL_op)
394 #define cSVOP cSVOPx(PL_op)
395 #define cPADOP cPADOPx(PL_op)
396 #define cPVOP cPVOPx(PL_op)
397 #define cCOP cCOPx(PL_op)
398 #define cLOOP cLOOPx(PL_op)
400 #define cUNOPo cUNOPx(o)
401 #define cBINOPo cBINOPx(o)
402 #define cLISTOPo cLISTOPx(o)
403 #define cLOGOPo cLOGOPx(o)
404 #define cPMOPo cPMOPx(o)
405 #define cSVOPo cSVOPx(o)
406 #define cPADOPo cPADOPx(o)
407 #define cPVOPo cPVOPx(o)
408 #define cCOPo cCOPx(o)
409 #define cLOOPo cLOOPx(o)
411 #define kUNOP cUNOPx(kid)
412 #define kBINOP cBINOPx(kid)
413 #define kLISTOP cLISTOPx(kid)
414 #define kLOGOP cLOGOPx(kid)
415 #define kPMOP cPMOPx(kid)
416 #define kSVOP cSVOPx(kid)
417 #define kPADOP cPADOPx(kid)
418 #define kPVOP cPVOPx(kid)
419 #define kCOP cCOPx(kid)
420 #define kLOOP cLOOPx(kid)
424 # define cGVOPx_gv(o) ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
426 # define IS_PADGV(v) (v && isGV(v))
427 # define IS_PADCONST(v) \
428 (v && (SvREADONLY(v) || (SvIsCOW(v) && !SvLEN(v))))
430 # define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
431 ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
432 # define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
433 ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
435 # define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
437 # define IS_PADGV(v) FALSE
438 # define IS_PADCONST(v) FALSE
440 # define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
441 # define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
444 #define cGVOP_gv cGVOPx_gv(PL_op)
445 #define cGVOPo_gv cGVOPx_gv(o)
446 #define kGVOP_gv cGVOPx_gv(kid)
447 #define cSVOP_sv cSVOPx_sv(PL_op)
448 #define cSVOPo_sv cSVOPx_sv(o)
449 #define kSVOP_sv cSVOPx_sv(kid)
452 # define Nullop ((OP*)NULL)
455 /* Lowest byte of PL_opargs */
457 #define OA_FOLDCONST 2
458 #define OA_RETSCALAR 4
460 #define OA_TARGLEX 16
461 #define OA_OTHERINT 32
462 #define OA_DANGEROUS 64
465 /* The next 4 bits (8..11) encode op class information */
468 #define OA_CLASS_MASK (15 << OCSHIFT)
470 #define OA_BASEOP (0 << OCSHIFT)
471 #define OA_UNOP (1 << OCSHIFT)
472 #define OA_BINOP (2 << OCSHIFT)
473 #define OA_LOGOP (3 << OCSHIFT)
474 #define OA_LISTOP (4 << OCSHIFT)
475 #define OA_PMOP (5 << OCSHIFT)
476 #define OA_SVOP (6 << OCSHIFT)
477 #define OA_PADOP (7 << OCSHIFT)
478 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
479 #define OA_LOOP (9 << OCSHIFT)
480 #define OA_COP (10 << OCSHIFT)
481 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
482 #define OA_FILESTATOP (12 << OCSHIFT)
483 #define OA_LOOPEXOP (13 << OCSHIFT)
485 /* Each remaining nybble of PL_opargs (i.e. bits 12..15, 16..19 etc)
486 * encode the type for each arg */
495 #define OA_SCALARREF 7
496 #define OA_OPTIONAL 8
498 /* Op_REFCNT is a reference count at the head of each op tree: needed
499 * since the tree is shared between threads, and between cloned closure
500 * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
502 * The same mutex is used to protect the refcounts of the reg_trie_data
503 * and reg_ac_data structures, which are shared between duplicated
508 # define OP_REFCNT_INIT MUTEX_INIT(&PL_op_mutex)
510 # define OP_REFCNT_LOCK MUTEX_LOCK(&PL_op_mutex)
511 # define OP_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_op_mutex)
513 # define OP_REFCNT_LOCK op_refcnt_lock()
514 # define OP_REFCNT_UNLOCK op_refcnt_unlock()
516 # define OP_REFCNT_TERM MUTEX_DESTROY(&PL_op_mutex)
518 # define OP_REFCNT_INIT NOOP
519 # define OP_REFCNT_LOCK NOOP
520 # define OP_REFCNT_UNLOCK NOOP
521 # define OP_REFCNT_TERM NOOP
524 #define OpREFCNT_set(o,n) ((o)->op_targ = (n))
525 #ifdef PERL_DEBUG_READONLY_OPS
526 # define OpREFCNT_inc(o) Perl_op_refcnt_inc(aTHX_ o)
527 # define OpREFCNT_dec(o) Perl_op_refcnt_dec(aTHX_ o)
529 # define OpREFCNT_inc(o) ((o) ? (++(o)->op_targ, (o)) : NULL)
530 # define OpREFCNT_dec(o) (--(o)->op_targ)
533 /* flags used by Perl_load_module() */
534 #define PERL_LOADMOD_DENY 0x1 /* no Module */
535 #define PERL_LOADMOD_NOIMPORT 0x2 /* use Module () */
536 #define PERL_LOADMOD_IMPORT_OPS 0x4 /* import arguments
541 #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C) || defined(PERL_IN_TOKE_C)
542 #define ref(o, type) doref(o, type, TRUE)
546 =head1 Optree Manipulation Functions
548 =for apidoc Am|OP*|LINKLIST|OP *o
549 Given the root of an optree, link the tree in execution order using the
550 C<op_next> pointers and return the first op executed. If this has
551 already been done, it will not be redone, and C<< o->op_next >> will be
552 returned. If C<< o->op_next >> is not already set, I<o> should be at
558 #define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
560 /* no longer used anywhere in core */
562 #define cv_ckproto(cv, gv, p) \
563 cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
567 # define my(o) my_attrs((o), NULL)
570 #ifdef USE_REENTRANT_API
574 #define NewOp(m,var,c,type) \
575 (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
576 #define NewOpSz(m,var,size) \
577 (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
578 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
581 * The per-CV op slabs consist of a header (the opslab struct) and a bunch
582 * of space for allocating op slots, each of which consists of two pointers
583 * followed by an op. The first pointer points to the next op slot. The
584 * second points to the slab. At the end of the slab is a null pointer,
585 * so that slot->opslot_next - slot can be used to determine the size
588 * Each CV can have multiple slabs; opslab_next points to the next slab, to
589 * form a chain. All bookkeeping is done on the first slab, which is where
590 * all the op slots point.
592 * Freed ops are marked as freed and attached to the freed chain
593 * via op_next pointers.
595 * When there is more than one slab, the second slab in the slab chain is
596 * assumed to be the one with free space available. It is used when allo-
597 * cating an op if there are no freed ops available or big enough.
602 /* keep opslot_next first */
603 OPSLOT * opslot_next; /* next slot */
604 OPSLAB * opslot_slab; /* owner */
605 OP opslot_op; /* the op itself */
609 OPSLOT * opslab_first; /* first op in this slab */
610 OPSLAB * opslab_next; /* next slab */
611 OP * opslab_freed; /* chain of freed ops */
612 size_t opslab_refcnt; /* number of ops */
613 # ifdef PERL_DEBUG_READONLY_OPS
614 U16 opslab_size; /* size of slab in pointers */
615 bool opslab_readonly;
617 OPSLOT opslab_slots; /* slots begin here */
620 # define OPSLOT_HEADER STRUCT_OFFSET(OPSLOT, opslot_op)
621 # define OPSLOT_HEADER_P (OPSLOT_HEADER/sizeof(I32 *))
622 # define OpSLOT(o) (assert_(o->op_slabbed) \
623 (OPSLOT *)(((char *)o)-OPSLOT_HEADER))
624 # define OpSLAB(o) OpSLOT(o)->opslot_slab
625 # define OpslabREFCNT_dec(slab) \
626 (((slab)->opslab_refcnt == 1) \
627 ? opslab_free_nopad(slab) \
628 : (void)--(slab)->opslab_refcnt)
629 /* Variant that does not null out the pads */
630 # define OpslabREFCNT_dec_padok(slab) \
631 (((slab)->opslab_refcnt == 1) \
632 ? opslab_free(slab) \
633 : (void)--(slab)->opslab_refcnt)
638 void (*bhk_start) (pTHX_ int full);
639 void (*bhk_pre_end) (pTHX_ OP **seq);
640 void (*bhk_post_end) (pTHX_ OP **seq);
641 void (*bhk_eval) (pTHX_ OP *const saveop);
645 =head1 Compile-time scope hooks
647 =for apidoc mx|U32|BhkFLAGS|BHK *hk
648 Return the BHK's flags.
650 =for apidoc mx|void *|BhkENTRY|BHK *hk|which
651 Return an entry from the BHK structure. I<which> is a preprocessor token
652 indicating which entry to return. If the appropriate flag is not set
653 this will return NULL. The type of the return value depends on which
656 =for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
657 Set an entry in the BHK structure, and set the flags to indicate it is
658 valid. I<which> is a preprocessing token indicating which entry to set.
659 The type of I<ptr> depends on the entry.
661 =for apidoc Amx|void|BhkDISABLE|BHK *hk|which
662 Temporarily disable an entry in this BHK structure, by clearing the
663 appropriate flag. I<which> is a preprocessor token indicating which
666 =for apidoc Amx|void|BhkENABLE|BHK *hk|which
667 Re-enable an entry in this BHK structure, by setting the appropriate
668 flag. I<which> is a preprocessor token indicating which entry to enable.
669 This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
672 =for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
673 Call all the registered block hooks for type I<which>. I<which> is a
674 preprocessing token; the type of I<arg> depends on I<which>.
679 #define BhkFLAGS(hk) ((hk)->bhk_flags)
681 #define BHKf_bhk_start 0x01
682 #define BHKf_bhk_pre_end 0x02
683 #define BHKf_bhk_post_end 0x04
684 #define BHKf_bhk_eval 0x08
686 #define BhkENTRY(hk, which) \
687 ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
689 #define BhkENABLE(hk, which) \
691 BhkFLAGS(hk) |= BHKf_ ## which; \
692 assert(BhkENTRY(hk, which)); \
695 #define BhkDISABLE(hk, which) \
697 BhkFLAGS(hk) &= ~(BHKf_ ## which); \
700 #define BhkENTRY_set(hk, which, ptr) \
703 BhkENABLE(hk, which); \
706 #define CALL_BLOCK_HOOKS(which, arg) \
708 if (PL_blockhooks) { \
710 for (i = av_tindex(PL_blockhooks); i >= 0; i--) { \
711 SV *sv = AvARRAY(PL_blockhooks)[i]; \
716 hk = INT2PTR(BHK *, SvUVX(sv)); \
718 hk = INT2PTR(BHK *, SvIVX(sv)); \
720 if (BhkENTRY(hk, which)) \
721 BhkENTRY(hk, which)(aTHX_ arg); \
726 /* flags for rv2cv_op_cv */
728 #define RV2CVOPCV_MARK_EARLY 0x00000001
729 #define RV2CVOPCV_RETURN_NAME_GV 0x00000002
730 #define RV2CVOPCV_RETURN_STUB 0x00000004
731 #ifdef PERL_CORE /* behaviour of this flag is subject to change: */
732 # define RV2CVOPCV_MAYBE_NAME_GV 0x00000008
734 #define RV2CVOPCV_FLAG_MASK 0x0000000f /* all of the above */
736 #define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
738 /* flags for op_lvalue_flags */
740 #define OP_LVALUE_NO_CROAK 1
743 =head1 Custom Operators
745 =for apidoc Am|U32|XopFLAGS|XOP *xop
746 Return the XOP's flags.
748 =for apidoc Am||XopENTRY|XOP *xop|which
749 Return a member of the XOP structure. I<which> is a cpp token
750 indicating which entry to return. If the member is not set
751 this will return a default value. The return type depends
752 on I<which>. This macro evaluates its arguments more than
753 once. If you are using C<Perl_custom_op_xop> to retreive a
754 C<XOP *> from a C<OP *>, use the more efficient L</XopENTRYCUSTOM> instead.
756 =for apidoc Am||XopENTRYCUSTOM|const OP *o|which
757 Exactly like C<XopENTRY(XopENTRY(Perl_custom_op_xop(aTHX_ o), which)> but more
758 efficient. The I<which> parameter is identical to L</XopENTRY>.
760 =for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
761 Set a member of the XOP structure. I<which> is a cpp token
762 indicating which entry to set. See L<perlguts/"Custom Operators">
763 for details about the available members and how
764 they are used. This macro evaluates its argument
767 =for apidoc Am|void|XopDISABLE|XOP *xop|which
768 Temporarily disable a member of the XOP, by clearing the appropriate flag.
770 =for apidoc Am|void|XopENABLE|XOP *xop|which
771 Reenable a member of the XOP which has been disabled.
778 const char *xop_name;
779 const char *xop_desc;
781 void (*xop_peep)(pTHX_ OP *o, OP *oldop);
784 /* return value of Perl_custom_op_get_field, similar to void * then casting but
785 the U32 doesn't need truncation on 64 bit platforms in the caller, also
786 for easier macro writing */
788 const char *xop_name;
789 const char *xop_desc;
791 void (*xop_peep)(pTHX_ OP *o, OP *oldop);
795 #define XopFLAGS(xop) ((xop)->xop_flags)
797 #define XOPf_xop_name 0x01
798 #define XOPf_xop_desc 0x02
799 #define XOPf_xop_class 0x04
800 #define XOPf_xop_peep 0x08
802 /* used by Perl_custom_op_get_field for option checking */
804 XOPe_xop_ptr = 0, /* just get the XOP *, don't look inside it */
805 XOPe_xop_name = XOPf_xop_name,
806 XOPe_xop_desc = XOPf_xop_desc,
807 XOPe_xop_class = XOPf_xop_class,
808 XOPe_xop_peep = XOPf_xop_peep
811 #define XOPd_xop_name PL_op_name[OP_CUSTOM]
812 #define XOPd_xop_desc PL_op_desc[OP_CUSTOM]
813 #define XOPd_xop_class OA_BASEOP
814 #define XOPd_xop_peep ((Perl_cpeep_t)0)
816 #define XopENTRY_set(xop, which, to) \
818 (xop)->which = (to); \
819 (xop)->xop_flags |= XOPf_ ## which; \
822 #define XopENTRY(xop, which) \
823 ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
825 #define XopENTRYCUSTOM(o, which) \
826 (Perl_custom_op_get_field(aTHX_ o, XOPe_ ## which).which)
828 #define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
829 #define XopENABLE(xop, which) \
831 (xop)->xop_flags |= XOPf_ ## which; \
832 assert(XopENTRY(xop, which)); \
835 #define Perl_custom_op_xop(x) \
836 (Perl_custom_op_get_field(x, XOPe_xop_ptr).xop_ptr)
839 =head1 Optree Manipulation Functions
841 =for apidoc Am|const char *|OP_NAME|OP *o
842 Return the name of the provided OP. For core ops this looks up the name
843 from the op_type; for custom ops from the op_ppaddr.
845 =for apidoc Am|const char *|OP_DESC|OP *o
846 Return a short description of the provided OP.
848 =for apidoc Am|U32|OP_CLASS|OP *o
849 Return the class of the provided OP: that is, which of the *OP
850 structures it uses. For core ops this currently gets the information out
851 of PL_opargs, which does not always accurately reflect the type used.
852 For custom ops the type is returned from the registration, and it is up
853 to the registree to ensure it is accurate. The value returned will be
854 one of the OA_* constants from op.h.
856 =for apidoc Am|bool|OP_TYPE_IS|OP *o, Optype type
857 Returns true if the given OP is not a NULL pointer
858 and if it is of the given type.
860 The negation of this macro, C<OP_TYPE_ISNT> is also available
861 as well as C<OP_TYPE_IS_NN> and C<OP_TYPE_ISNT_NN> which elide
862 the NULL pointer check.
864 =for apidoc Am|bool|OP_TYPE_IS_OR_WAS|OP *o, Optype type
865 Returns true if the given OP is not a NULL pointer and
866 if it is of the given type or used to be before being
867 replaced by an OP of type OP_NULL.
869 The negation of this macro, C<OP_TYPE_ISNT_AND_WASNT>
870 is also available as well as C<OP_TYPE_IS_OR_WAS_NN>
871 and C<OP_TYPE_ISNT_AND_WASNT_NN> which elide
872 the NULL pointer check.
874 =for apidoc Am|bool|OP_HAS_SIBLING|OP *o
875 Returns true if o has a sibling
877 =for apidoc Am|bool|OP_SIBLING|OP *o
878 Returns the sibling of o, or NULL if there is no sibling
880 =for apidoc Am|bool|OP_SIBLING_set|OP *o|OP *sib
881 Sets the sibling of o to sib
886 #define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
887 ? XopENTRYCUSTOM(o, xop_name) \
888 : PL_op_name[(o)->op_type])
889 #define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
890 ? XopENTRYCUSTOM(o, xop_desc) \
891 : PL_op_desc[(o)->op_type])
892 #define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
893 ? XopENTRYCUSTOM(o, xop_class) \
894 : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
896 #define OP_TYPE_IS(o, type) ((o) && (o)->op_type == (type))
897 #define OP_TYPE_IS_NN(o, type) ((o)->op_type == (type))
898 #define OP_TYPE_ISNT(o, type) ((o) && (o)->op_type != (type))
899 #define OP_TYPE_ISNT_NN(o, type) ((o)->op_type != (type))
901 #define OP_TYPE_IS_OR_WAS_NN(o, type) \
902 ( ((o)->op_type == OP_NULL \
907 #define OP_TYPE_IS_OR_WAS(o, type) \
908 ( (o) && OP_TYPE_IS_OR_WAS_NN(o, type) )
910 #define OP_TYPE_ISNT_AND_WASNT_NN(o, type) \
911 ( ((o)->op_type == OP_NULL \
916 #define OP_TYPE_ISNT_AND_WASNT(o, type) \
917 ( (o) && OP_TYPE_ISNT_AND_WASNT_NN(o, type) )
919 #ifdef PERL_OP_PARENT
920 # define OP_HAS_SIBLING(o) (!cBOOL((o)->op_lastsib))
921 # define OP_SIBLING(o) (0 + (o)->op_lastsib ? NULL : (o)->op_sibling)
922 # define OP_SIBLING_set(o, sib) ((o)->op_sibling = (sib))
924 # define OP_HAS_SIBLING(o) (cBOOL((o)->op_sibling))
925 # define OP_SIBLING(o) (0 + (o)->op_sibling)
926 # define OP_SIBLING_set(o, sib) ((o)->op_sibling = (sib))
929 #define newATTRSUB(f, o, p, a, b) Perl_newATTRSUB_x(aTHX_ f, o, p, a, b, FALSE)
930 #define newSUB(f, o, p, b) newATTRSUB((f), (o), (p), NULL, (b))
933 =head1 Hook manipulation
937 # define OP_CHECK_MUTEX_INIT MUTEX_INIT(&PL_check_mutex)
938 # define OP_CHECK_MUTEX_LOCK MUTEX_LOCK(&PL_check_mutex)
939 # define OP_CHECK_MUTEX_UNLOCK MUTEX_UNLOCK(&PL_check_mutex)
940 # define OP_CHECK_MUTEX_TERM MUTEX_DESTROY(&PL_check_mutex)
942 # define OP_CHECK_MUTEX_INIT NOOP
943 # define OP_CHECK_MUTEX_LOCK NOOP
944 # define OP_CHECK_MUTEX_UNLOCK NOOP
945 # define OP_CHECK_MUTEX_TERM NOOP
950 * c-indentation-style: bsd
952 * indent-tabs-mode: nil
955 * ex: set ts=8 sts=4 sw=4 et: