[perl5.git] / op.h

/*    op.h
 *
 *    Copyright (c) 1991-2001, Larry Wall
 *
 *    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_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).
 */

typedef U32 PADOFFSET;
#define NOT_IN_PAD ((PADOFFSET) -1)

#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;		\
    OPCODE	op_type;		\
    U16		op_seq;			\
    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)

/*
=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 */

/* 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. */
#define OPpASSIGN_HASH		32	/* Assigning to possible pseudohash. */

/* 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
#define OPpTRANS_DELETE		16
#define OPpTRANS_COMPLEMENT	32
#define OPpTRANS_GROWS		64

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

/* Private for OP_RV2?V, OP_?ELEM */
#define OPpDEREF		(32|64)	/* 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. */
  /* 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 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_CONST */
#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	/* Descending sort */
/* 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 */
#define OPpEXIT_VMSISH		128	/* exit(0) vs. exit(1) vmsish mode*/

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