[p5sagit/p5-mst-13.2.git] / op.h

/*    op.h
 *
 *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
 *    2000, 2001, 2002, 2003, 2004, 2005 by Larry Wall and others
 *
 *    You may distribute under the terms of either the GNU General Public
 *    License or the Artistic License, as specified in the README file.
 *
 */

/*
 * The fields of BASEOP are:
 *	op_next		Pointer to next ppcode to execute after this one.
 *			(Top level pre-grafted op points to first op,
 *			but this is replaced when op is grafted in, when
 *			this op will point to the real next op, and the new
 *			parent takes over role of remembering starting op.)
 *	op_ppaddr	Pointer to current ppcode's function.
 *	op_type		The type of the operation.
 *	op_opt		Whether or not the op has been optimised by the
 *			peephole optimiser.
 *	op_static	Whether or not the op is statically defined.
 *			This flag is used by the B::C compiler backend
 *			and indicates that the op should not be freed.
 *	op_spare	Five spare bits!
 *	op_flags	Flags common to all operations.  See OPf_* below.
 *	op_private	Flags peculiar to a particular operation (BUT,
 *			by default, set to the number of children until
 *			the operation is privatized by a check routine,
 *			which may or may not check number of children).
 */

#ifdef DEBUGGING_OPS
#define OPCODE opcode
#else
#define OPCODE U16
#endif

#ifdef BASEOP_DEFINITION
#define BASEOP BASEOP_DEFINITION
#else
#define BASEOP				\
    OP*		op_next;		\
    OP*		op_sibling;		\
    OP*		(CPERLscope(*op_ppaddr))(pTHX);		\
    PADOFFSET	op_targ;		\
    unsigned	op_type:9;		\
    unsigned	op_opt:1;		\
    unsigned	op_static:1;		\
    unsigned	op_spare:5;		\
    U8		op_flags;		\
    U8		op_private;
#endif

#define OP_GIMME(op,dfl) \
	(((op)->op_flags & OPf_WANT) == OPf_WANT_VOID   ? G_VOID   : \
	 ((op)->op_flags & OPf_WANT) == OPf_WANT_SCALAR ? G_SCALAR : \
	 ((op)->op_flags & OPf_WANT) == OPf_WANT_LIST   ? G_ARRAY   : \
	 dfl)

/*
=head1 "Gimme" Values

=for apidoc Amn|U32|GIMME_V
The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_VOID>,
C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
respectively.

=for apidoc Amn|U32|GIMME
A backward-compatible version of C<GIMME_V> which can only return
C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
Deprecated.  Use C<GIMME_V> instead.

=cut
*/

#define GIMME_V		OP_GIMME(PL_op, block_gimme())

/* Public flags */

#define OPf_WANT	3	/* Mask for "want" bits: */
#define  OPf_WANT_VOID	 1	/*   Want nothing */
#define  OPf_WANT_SCALAR 2	/*   Want single value */
#define  OPf_WANT_LIST	 3	/*   Want list of any length */
#define OPf_KIDS	4	/* There is a firstborn child. */
#define OPf_PARENS	8	/* This operator was parenthesized. */
				/*  (Or block needs explicit scope entry.) */
#define OPf_REF		16	/* Certified reference. */
				/*  (Return container, not containee). */
#define OPf_MOD		32	/* Will modify (lvalue). */
#define OPf_STACKED	64	/* Some arg is arriving on the stack. */
#define OPf_SPECIAL	128	/* Do something weird for this op: */
				/*  On local LVAL, don't init local value. */
				/*  On OP_SORT, subroutine is inlined. */
				/*  On OP_NOT, inversion was implicit. */
				/*  On OP_LEAVE, don't restore curpm. */
				/*  On truncate, we truncate filehandle */
				/*  On control verbs, we saw no label */
				/*  On flipflop, we saw ... instead of .. */
				/*  On UNOPs, saw bare parens, e.g. eof(). */
				/*  On OP_ENTERSUB || OP_NULL, saw a "do". */
				/*  On OP_EXISTS, treat av as av, not avhv.  */
				/*  On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
				/*  On OP_ENTERITER, loop var is per-thread */
				/*  On pushre, re is /\s+/ imp. by split " " */
				/*  On regcomp, "use re 'eval'" was in scope */
				/*  On OP_READLINE, was <$filehandle> */
				/*  On RV2[SG]V, don't create GV--in defined()*/
				/*  On OP_DBSTATE, indicates breakpoint
				 *    (runtime property) */
				/*  On OP_AELEMFAST, indiciates pad var */
				/*  On OP_REQUIRE, was seen as CORE::require */
				/*  On OP_ENTERWHEN, there's no condition */
				/*  On OP_BREAK, an implicit break */
				/*  On OP_SMARTMATCH, an implicit smartmatch */

/* old names; don't use in new code, but don't break them, either */
#define OPf_LIST	OPf_WANT_LIST
#define OPf_KNOW	OPf_WANT

#define GIMME \
	  (PL_op->op_flags & OPf_WANT					\
	   ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST		\
	      ? G_ARRAY							\
	      : G_SCALAR)						\
	   : dowantarray())

/* NOTE: OP_NEXTSTATE, OP_DBSTATE, and OP_SETSTATE (i.e. COPs) carry lower
 * bits of PL_hints in op_private */

/* Private for lvalues */
#define OPpLVAL_INTRO	128	/* Lvalue must be localized or lvalue sub */

/* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
#define OPpREFCOUNTED		64	/* op_targ carries a refcount */

/* Private for OP_AASSIGN */
#define OPpASSIGN_COMMON	64	/* Left & right have syms in common. */

/* Private for OP_SASSIGN */
#define OPpASSIGN_BACKWARDS	64	/* Left & right switched. */

/* Private for OP_MATCH and OP_SUBST{,CONST} */
#define OPpRUNTIME		64	/* Pattern coming in on the stack */

/* Private for OP_TRANS */
#define OPpTRANS_FROM_UTF	1
#define OPpTRANS_TO_UTF		2
#define OPpTRANS_IDENTICAL	4	/* right side is same as left */
#define OPpTRANS_SQUASH		8
    /* 16 is used for OPpTARGET_MY */
#define OPpTRANS_COMPLEMENT	32
#define OPpTRANS_GROWS		64
#define OPpTRANS_DELETE		128
#define OPpTRANS_ALL	(OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)

/* Private for OP_REPEAT */
#define OPpREPEAT_DOLIST	64	/* List replication. */

/* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
#define OPpDEREF		(32|64)	/* autovivify: Want ref to something: */
#define OPpDEREF_AV		32	/*   Want ref to AV. */
#define OPpDEREF_HV		64	/*   Want ref to HV. */
#define OPpDEREF_SV		(32|64)	/*   Want ref to SV. */
  /* OP_ENTERSUB only */
#define OPpENTERSUB_DB		16	/* Debug subroutine. */
#define OPpENTERSUB_HASTARG	32	/* Called from OP tree. */
#define OPpENTERSUB_NOMOD	64	/* Immune to mod() for :attrlist. */
  /* OP_RV2CV only */
#define OPpENTERSUB_AMPER	8	/* Used & form to call. */
#define OPpENTERSUB_NOPAREN	128	/* bare sub call (without parens) */
#define OPpENTERSUB_INARGS	4	/* Lval used as arg to a sub. */
  /* OP_GV only */
#define OPpEARLY_CV		32	/* foo() called before sub foo was parsed */
  /* OP_?ELEM only */
#define OPpLVAL_DEFER		16	/* Defer creation of array/hash elem */
  /* OP_RV2?V, OP_GVSV, OP_ENTERITER only */
#define OPpOUR_INTRO		16	/* Variable was in an our() */
  /* OP_RV2[AH]V, OP_PAD[AH]V, OP_[AH]ELEM */
#define OPpMAYBE_LVSUB		8	/* We might be an lvalue to return */
  /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */

/* Private for OPs with TARGLEX */
  /* (lower bits may carry MAXARG) */
#define OPpTARGET_MY		16	/* Target is PADMY. */

/* Private for OP_ENTERITER and OP_ITER */
#define OPpITER_REVERSED	4	/* for (reverse ...) */
#define OPpITER_DEF		8	/* for $_ or for my $_ */

/* Private for OP_CONST */
#define	OPpCONST_NOVER		2	/* no 6; */
#define	OPpCONST_SHORTCIRCUIT	4	/* eg the constant 5 in (5 || foo) */
#define	OPpCONST_STRICT		8	/* bearword subject to strict 'subs' */
#define OPpCONST_ENTERED	16	/* Has been entered as symbol. */
#define OPpCONST_ARYBASE	32	/* Was a $[ translated to constant. */
#define OPpCONST_BARE		64	/* Was a bare word (filehandle?). */
#define OPpCONST_WARNING	128	/* Was a $^W translated to constant. */

/* Private for OP_FLIP/FLOP */
#define OPpFLIP_LINENUM		64	/* Range arg potentially a line num. */

/* Private for OP_LIST */
#define OPpLIST_GUESSED		64	/* Guessed that pushmark was needed. */

/* Private for OP_DELETE */
#define OPpSLICE		64	/* Operating on a list of keys */

/* Private for OP_EXISTS */
#define OPpEXISTS_SUB		64	/* Checking for &sub, not {} or [].  */

/* Private for OP_SORT */
#define OPpSORT_NUMERIC		1	/* Optimized away { $a <=> $b } */
#define OPpSORT_INTEGER		2	/* Ditto while under "use integer" */
#define OPpSORT_REVERSE		4	/* Reversed sort */
#define OPpSORT_INPLACE		8	/* sort in-place; eg @a = sort @a */
#define OPpSORT_DESCEND		16	/* Descending sort */
#define OPpSORT_QSORT		32	/* Use quicksort (not mergesort) */
#define OPpSORT_STABLE		64	/* Use a stable algorithm */

/* Private for OP_THREADSV */
#define OPpDONE_SVREF		64	/* Been through newSVREF once */

/* Private for OP_OPEN and OP_BACKTICK */
#define OPpOPEN_IN_RAW		16	/* binmode(F,":raw") on input fh */
#define OPpOPEN_IN_CRLF		32	/* binmode(F,":crlf") on input fh */
#define OPpOPEN_OUT_RAW		64	/* binmode(F,":raw") on output fh */
#define OPpOPEN_OUT_CRLF	128	/* binmode(F,":crlf") on output fh */

/* Private for OP_EXIT, HUSH also for OP_DIE */
#define OPpHUSH_VMSISH		64	/* hush DCL exit msg vmsish mode*/
#define OPpEXIT_VMSISH		128	/* exit(0) vs. exit(1) vmsish mode*/

/* Private for OP_FTXXX */
#define OPpFT_ACCESS		2	/* use filetest 'access' */
#define OPpFT_STACKED		4	/* stacked filetest, as in "-f -x $f" */
#define OP_IS_FILETEST_ACCESS(op) 		\
	(((op)->op_type) == OP_FTRREAD  ||	\
	 ((op)->op_type) == OP_FTRWRITE ||	\
	 ((op)->op_type) == OP_FTREXEC  ||	\
	 ((op)->op_type) == OP_FTEREAD  ||	\
	 ((op)->op_type) == OP_FTEWRITE ||	\
	 ((op)->op_type) == OP_FTEEXEC)

/* Private for OP_(MAP|GREP)(WHILE|START) */
#define OPpGREP_LEX		2	/* iterate over lexical $_ */
    
/* Private for OP_ENTEREVAL */
#define OPpEVAL_HAS_HH		2	/* Does it have a copy of %^H */
    
struct op {
    BASEOP
};

struct unop {
    BASEOP
    OP *	op_first;
};

struct binop {
    BASEOP
    OP *	op_first;
    OP *	op_last;
};

struct logop {
    BASEOP
    OP *	op_first;
    OP *	op_other;
};

struct listop {
    BASEOP
    OP *	op_first;
    OP *	op_last;
};

struct pmop {
    BASEOP
    OP *	op_first;
    OP *	op_last;
    OP *	op_pmreplroot; /* (type is really union {OP*,GV*,PADOFFSET}) */
    OP *	op_pmreplstart;
    PMOP *	op_pmnext;		/* list of all scanpats */
#ifdef USE_ITHREADS
    IV          op_pmoffset;
#else
    REGEXP *    op_pmregexp;            /* compiled expression */
#endif
    U32		op_pmflags;
    U32		op_pmpermflags;
    U8		op_pmdynflags;
#ifdef USE_ITHREADS
    char *	op_pmstashpv;
#else
    HV *	op_pmstash;
#endif
};

#ifdef USE_ITHREADS
#define PM_GETRE(o)     (INT2PTR(REGEXP*,SvIVX(PL_regex_pad[(o)->op_pmoffset])))
#define PM_SETRE(o,r)   STMT_START { \
                            SV* const sv = PL_regex_pad[(o)->op_pmoffset]; \
                            sv_setiv(sv, PTR2IV(r)); \
                        } STMT_END
#define PM_GETRE_SAFE(o) (PL_regex_pad ? PM_GETRE(o) : (REGEXP*)0)
#define PM_SETRE_SAFE(o,r) if (PL_regex_pad) PM_SETRE(o,r)
#else
#define PM_GETRE(o)     ((o)->op_pmregexp)
#define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
#define PM_GETRE_SAFE PM_GETRE
#define PM_SETRE_SAFE PM_SETRE
#endif

#define PMdf_USED	0x01		/* pm has been used once already */
#define PMdf_TAINTED	0x02		/* pm compiled from tainted pattern */
#define PMdf_UTF8	0x04		/* pm compiled from utf8 data */
#define PMdf_DYN_UTF8	0x08

#define PMdf_CMP_UTF8	(PMdf_UTF8|PMdf_DYN_UTF8)

#define PMf_RETAINT	0x0001		/* taint $1 etc. if target tainted */
#define PMf_ONCE	0x0002		/* use pattern only once per reset */
#define PMf_UNUSED	0x0004		/* free for use */
#define PMf_MAYBE_CONST	0x0008		/* replacement contains variables */
#define PMf_SKIPWHITE	0x0010		/* skip leading whitespace for split */
#define PMf_WHITE	0x0020		/* pattern is \s+ */
#define PMf_CONST	0x0040		/* subst replacement is constant */
#define PMf_KEEP	0x0080		/* keep 1st runtime pattern forever */
#define PMf_GLOBAL	0x0100		/* pattern had a g modifier */
#define PMf_CONTINUE	0x0200		/* don't reset pos() if //g fails */
#define PMf_EVAL	0x0400		/* evaluating replacement as expr */
#define PMf_LOCALE	0x0800		/* use locale for character types */
#define PMf_MULTILINE	0x1000		/* assume multiple lines */
#define PMf_SINGLELINE	0x2000		/* assume single line */
#define PMf_FOLD	0x4000		/* case insensitivity */
#define PMf_EXTENDED	0x8000		/* chuck embedded whitespace */

/* mask of bits stored in regexp->reganch */
#define PMf_COMPILETIME	(PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED)

#ifdef USE_ITHREADS

#  define PmopSTASHPV(o)	((o)->op_pmstashpv)
#  define PmopSTASHPV_set(o,pv)	(PmopSTASHPV(o) = savesharedpv(pv))
#  define PmopSTASH(o)		(PmopSTASHPV(o) \
				 ? gv_stashpv(PmopSTASHPV(o),GV_ADD) : NULL)
#  define PmopSTASH_set(o,hv)	PmopSTASHPV_set(o, ((hv) ? HvNAME_get(hv) : Nullch))
#  define PmopSTASH_free(o)	PerlMemShared_free(PmopSTASHPV(o))

#else
#  define PmopSTASH(o)		((o)->op_pmstash)
#  define PmopSTASH_set(o,hv)	((o)->op_pmstash = (hv))
#  define PmopSTASHPV(o)	(PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : Nullch)
   /* op_pmstash is not refcounted */
#  define PmopSTASHPV_set(o,pv)	PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
#  define PmopSTASH_free(o)    
#endif

struct svop {
    BASEOP
    SV *	op_sv;
};

struct padop {
    BASEOP
    PADOFFSET	op_padix;
};

struct pvop {
    BASEOP
    char *	op_pv;
};

struct loop {
    BASEOP
    OP *	op_first;
    OP *	op_last;
    OP *	op_redoop;
    OP *	op_nextop;
    OP *	op_lastop;
};

#define cUNOPx(o)	((UNOP*)o)
#define cBINOPx(o)	((BINOP*)o)
#define cLISTOPx(o)	((LISTOP*)o)
#define cLOGOPx(o)	((LOGOP*)o)
#define cPMOPx(o)	((PMOP*)o)
#define cSVOPx(o)	((SVOP*)o)
#define cPADOPx(o)	((PADOP*)o)
#define cPVOPx(o)	((PVOP*)o)
#define cCOPx(o)	((COP*)o)
#define cLOOPx(o)	((LOOP*)o)

#define cUNOP		cUNOPx(PL_op)
#define cBINOP		cBINOPx(PL_op)
#define cLISTOP		cLISTOPx(PL_op)
#define cLOGOP		cLOGOPx(PL_op)
#define cPMOP		cPMOPx(PL_op)
#define cSVOP		cSVOPx(PL_op)
#define cPADOP		cPADOPx(PL_op)
#define cPVOP		cPVOPx(PL_op)
#define cCOP		cCOPx(PL_op)
#define cLOOP		cLOOPx(PL_op)

#define cUNOPo		cUNOPx(o)
#define cBINOPo		cBINOPx(o)
#define cLISTOPo	cLISTOPx(o)
#define cLOGOPo		cLOGOPx(o)
#define cPMOPo		cPMOPx(o)
#define cSVOPo		cSVOPx(o)
#define cPADOPo		cPADOPx(o)
#define cPVOPo		cPVOPx(o)
#define cCOPo		cCOPx(o)
#define cLOOPo		cLOOPx(o)

#define kUNOP		cUNOPx(kid)
#define kBINOP		cBINOPx(kid)
#define kLISTOP		cLISTOPx(kid)
#define kLOGOP		cLOGOPx(kid)
#define kPMOP		cPMOPx(kid)
#define kSVOP		cSVOPx(kid)
#define kPADOP		cPADOPx(kid)
#define kPVOP		cPVOPx(kid)
#define kCOP		cCOPx(kid)
#define kLOOP		cLOOPx(kid)


#ifdef USE_ITHREADS
#  define	cGVOPx_gv(o)	((GV*)PAD_SVl(cPADOPx(o)->op_padix))
#  define	IS_PADGV(v)	(v && SvTYPE(v) == SVt_PVGV && GvIN_PAD(v))
#  define	IS_PADCONST(v)	(v && SvREADONLY(v))
#  define	cSVOPx_sv(v)	(cSVOPx(v)->op_sv \
				 ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
#  define	cSVOPx_svp(v)	(cSVOPx(v)->op_sv \
				 ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
#else
#  define	cGVOPx_gv(o)	((GV*)cSVOPx(o)->op_sv)
#  define	IS_PADGV(v)	FALSE
#  define	IS_PADCONST(v)	FALSE
#  define	cSVOPx_sv(v)	(cSVOPx(v)->op_sv)
#  define	cSVOPx_svp(v)	(&cSVOPx(v)->op_sv)
#endif

#define	cGVOP_gv		cGVOPx_gv(PL_op)
#define	cGVOPo_gv		cGVOPx_gv(o)
#define	kGVOP_gv		cGVOPx_gv(kid)
#define cSVOP_sv		cSVOPx_sv(PL_op)
#define cSVOPo_sv		cSVOPx_sv(o)
#define kSVOP_sv		cSVOPx_sv(kid)

#define Nullop Null(OP*)

/* Lowest byte-and-a-bit of PL_opargs */
#define OA_MARK 1
#define OA_FOLDCONST 2
#define OA_RETSCALAR 4
#define OA_TARGET 8
#define OA_RETINTEGER 16
#define OA_OTHERINT 32
#define OA_DANGEROUS 64
#define OA_DEFGV 128
#define OA_TARGLEX 256

/* The next 4 bits encode op class information */
#define OCSHIFT 9

#define OA_CLASS_MASK (15 << OCSHIFT)

#define OA_BASEOP (0 << OCSHIFT)
#define OA_UNOP (1 << OCSHIFT)
#define OA_BINOP (2 << OCSHIFT)
#define OA_LOGOP (3 << OCSHIFT)
#define OA_LISTOP (4 << OCSHIFT)
#define OA_PMOP (5 << OCSHIFT)
#define OA_SVOP (6 << OCSHIFT)
#define OA_PADOP (7 << OCSHIFT)
#define OA_PVOP_OR_SVOP (8 << OCSHIFT)
#define OA_LOOP (9 << OCSHIFT)
#define OA_COP (10 << OCSHIFT)
#define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
#define OA_FILESTATOP (12 << OCSHIFT)
#define OA_LOOPEXOP (13 << OCSHIFT)

#define OASHIFT 13

/* Remaining nybbles of PL_opargs */
#define OA_SCALAR 1
#define OA_LIST 2
#define OA_AVREF 3
#define OA_HVREF 4
#define OA_CVREF 5
#define OA_FILEREF 6
#define OA_SCALARREF 7
#define OA_OPTIONAL 8

#ifdef USE_ITHREADS
#  define OP_REFCNT_INIT		MUTEX_INIT(&PL_op_mutex)
#  ifdef PERL_CORE
#    define OP_REFCNT_LOCK		MUTEX_LOCK(&PL_op_mutex)
#    define OP_REFCNT_UNLOCK		MUTEX_UNLOCK(&PL_op_mutex)
#  else
#    define OP_REFCNT_LOCK		op_refcnt_lock()
#    define OP_REFCNT_UNLOCK		op_refcnt_unlock()
#  endif
#  define OP_REFCNT_TERM		MUTEX_DESTROY(&PL_op_mutex)
#else
#  define OP_REFCNT_INIT		NOOP
#  define OP_REFCNT_LOCK		NOOP
#  define OP_REFCNT_UNLOCK		NOOP
#  define OP_REFCNT_TERM		NOOP
#endif

#define OpREFCNT_set(o,n)		((o)->op_targ = (n))
#define OpREFCNT_inc(o)			((o) ? (++(o)->op_targ, (o)) : Nullop)
#define OpREFCNT_dec(o)			(--(o)->op_targ)

/* flags used by Perl_load_module() */
#define PERL_LOADMOD_DENY		0x1
#define PERL_LOADMOD_NOIMPORT		0x2
#define PERL_LOADMOD_IMPORT_OPS		0x4

/* used in perly.y */
#define ref(o, type) doref(o, type, TRUE)

#ifdef USE_REENTRANT_API
#include "reentr.h"
#endif

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