[perl5.git] / op.h

/*    op.h
 *
 *    Copyright (c) 1991-1999, 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)

#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_(ENTER|LEAVE)EVAL, don't clear $@ */
				/*  On OP_ENTERITER, loop var is per-thread */
                                /*  On pushre, re is /\s+/ imp. by split " " */

/* 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())

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

/* 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
	/* When CU or UC, means straight latin-1 to utf-8 or vice versa */
	/* Otherwise, IDENTICAL means the right side is the same as the 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_ENTERSUB, 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. */
  /* OP_RV2CV only */
#define OPpENTERSUB_AMPER	8	/* Used & form to call. */
#define OPpENTERSUB_NOPAREN	128	/* bare sub call (without parens) */
  /* 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 */
  /* for OP_RV2?V, lower bits carry hints */

/* 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_SORT, OP_PRTF, OP_SPRINTF, string cmp'n, and case changers */
#define OPpLOCALE		64	/* Use locale */

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

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;
    U32		op_children;
};

struct pmop {
    BASEOP
    OP *	op_first;
    OP *	op_last;
    U32		op_children;
    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;
};

#define PMdf_USED	0x01		/* pm has been used once already */
#define PMdf_TAINTED	0x02		/* pm compiled from tainted pattern */

#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)

struct svop {
    BASEOP
    SV *	op_sv;
};

struct gvop {
    BASEOP
    GV *	op_gv;
};

struct pvop {
    BASEOP
    char *	op_pv;
};

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

#define cUNOP ((UNOP*)PL_op)
#define cBINOP ((BINOP*)PL_op)
#define cLISTOP ((LISTOP*)PL_op)
#define cLOGOP ((LOGOP*)PL_op)
#define cPMOP ((PMOP*)PL_op)
#define cSVOP ((SVOP*)PL_op)
#define cGVOP ((GVOP*)PL_op)
#define cPVOP ((PVOP*)PL_op)
#define cCOP ((COP*)PL_op)
#define cLOOP ((LOOP*)PL_op)

#define cUNOPo ((UNOP*)o)
#define cBINOPo ((BINOP*)o)
#define cLISTOPo ((LISTOP*)o)
#define cLOGOPo ((LOGOP*)o)
#define cPMOPo ((PMOP*)o)
#define cSVOPo ((SVOP*)o)
#define cGVOPo ((GVOP*)o)
#define cPVOPo ((PVOP*)o)
#define cCVOPo ((CVOP*)o)
#define cCOPo ((COP*)o)
#define cLOOPo ((LOOP*)o)

#define kUNOP ((UNOP*)kid)
#define kBINOP ((BINOP*)kid)
#define kLISTOP ((LISTOP*)kid)
#define kLOGOP ((LOGOP*)kid)
#define kPMOP ((PMOP*)kid)
#define kSVOP ((SVOP*)kid)
#define kGVOP ((GVOP*)kid)
#define kPVOP ((PVOP*)kid)
#define kCOP ((COP*)kid)
#define kLOOP ((LOOP*)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_GVOP (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
Commit	Line	Data
a0d0e21e	1	/* op.h
79072805	2	*
4eb8286e	3	* Copyright (c) 1991-1999, 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
533c011a	55	#define GIMME_V OP_GIMME(PL_op, block_gimme())
79072805 LW	56
79072805 LW	57	/* Public flags */
54310121	58
	59	#define OPf_WANT 3 /* Mask for "want" bits: */
	60	#define OPf_WANT_VOID 1 /* Want nothing */
	61	#define OPf_WANT_SCALAR 2 /* Want single value */
	62	#define OPf_WANT_LIST 3 /* Want list of any length */
79072805 LW	63	#define OPf_KIDS 4 /* There is a firstborn child. */
79072805 LW	64	#define OPf_PARENS 8 /* This operator was parenthesized. */
463ee0b2	65	/* (Or block needs explicit scope entry.) */
a0d0e21e LW	66	#define OPf_REF 16 /* Certified reference. */
	67	/* (Return container, not containee). */
	68	#define OPf_MOD 32 /* Will modify (lvalue). */
	69	#define OPf_STACKED 64 /* Some arg is arriving on the stack. */
79072805 LW	70	#define OPf_SPECIAL 128 /* Do something weird for this op: */
	71	/* On local LVAL, don't init local value. */
	72	/* On OP_SORT, subroutine is inlined. */
	73	/* On OP_NOT, inversion was implicit. */
a0d0e21e	74	/* On OP_LEAVE, don't restore curpm. */
79072805 LW	75	/* On truncate, we truncate filehandle */
	76	/* On control verbs, we saw no label */
	77	/* On flipflop, we saw ... instead of .. */
	78	/* On UNOPs, saw bare parens, e.g. eof(). */
a0d0e21e	79	/* On OP_ENTERSUB \|\| OP_NULL, saw a "do". */
f2ec2afd	80	/* On OP_(ENTER\|LEAVE)EVAL, don't clear $@ */
54b9620d	81	/* On OP_ENTERITER, loop var is per-thread */
357694d4	82	/* On pushre, re is /\s+/ imp. by split " " */
79072805	83
54310121	84	/* old names; don't use in new code, but don't break them, either */
d91ab173 GS	85	#define OPf_LIST OPf_WANT_LIST
d91ab173 GS	86	#define OPf_KNOW OPf_WANT
54310121	87	#define GIMME \
62a559b8 NIS	88	(PL_op->op_flags & OPf_WANT \
62a559b8 NIS	89	? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \
d91ab173 GS	90	? G_ARRAY \
	91	: G_SCALAR) \
	92	: dowantarray())
54310121	93
a0d0e21e LW	94	/* Private for lvalues */
	95	#define OPpLVAL_INTRO 128 /* Lvalue must be localized */
	96
	97	/* Private for OP_AASSIGN */
	98	#define OPpASSIGN_COMMON 64 /* Left & right have syms in common. */
	99
	100	/* Private for OP_SASSIGN */
	101	#define OPpASSIGN_BACKWARDS 64 /* Left & right switched. */
79072805	102
c90c0ff4	103	/* Private for OP_MATCH and OP_SUBST{,CONST} */
	104	#define OPpRUNTIME 64 /* Pattern coming in on the stack */
	105
79072805	106	/* Private for OP_TRANS */
4757a243 LW	107	#define OPpTRANS_FROM_UTF 1
	108	#define OPpTRANS_TO_UTF 2
	109	#define OPpTRANS_IDENTICAL 4
	110	/* When CU or UC, means straight latin-1 to utf-8 or vice versa */
	111	/* Otherwise, IDENTICAL means the right side is the same as the left */
	112	#define OPpTRANS_SQUASH 8
	113	#define OPpTRANS_DELETE 16
	114	#define OPpTRANS_COMPLEMENT 32
	115	#define OPpTRANS_GROWS 64
79072805 LW	116
79072805 LW	117	/* Private for OP_REPEAT */
a0d0e21e	118	#define OPpREPEAT_DOLIST 64 /* List replication. */
79072805	119
a0d0e21e	120	/* Private for OP_ENTERSUB, OP_RV2?V, OP_?ELEM */
5f05dabc	121	#define OPpDEREF (32\|64) /* Want ref to something: */
	122	#define OPpDEREF_AV 32 /* Want ref to AV. */
	123	#define OPpDEREF_HV 64 /* Want ref to HV. */
	124	#define OPpDEREF_SV (32\|64) /* Want ref to SV. */
68dc0745	125	/* OP_ENTERSUB only */
68dc0745	126	#define OPpENTERSUB_DB 16 /* Debug subroutine. */
7a52d87a	127	/* OP_RV2CV only */
68dc0745	128	#define OPpENTERSUB_AMPER 8 /* Used & form to call. */
9675f7ac	129	#define OPpENTERSUB_NOPAREN 128 /* bare sub call (without parens) */
76cd736e GS	130	/* OP_GV only */
76cd736e GS	131	#define OPpEARLY_CV 32 /* foo() called before sub foo was parsed */
68dc0745	132	/* OP_?ELEM only */
	133	#define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */
	134	/* for OP_RV2?V, lower bits carry hints */
79072805	135
b162f9ea IZ	136	/* Private for OPs with TARGLEX */
	137	/* (lower bits may carry MAXARG) */
	138	#define OPpTARGET_MY 16 /* Target is PADMY. */
	139
79072805	140	/* Private for OP_CONST */
7a52d87a	141	#define OPpCONST_STRICT 8 /* bearword subject to strict 'subs' */
748a9306 LW	142	#define OPpCONST_ENTERED 16 /* Has been entered as symbol. */
748a9306 LW	143	#define OPpCONST_ARYBASE 32 /* Was a $[ translated to constant. */
a0d0e21e	144	#define OPpCONST_BARE 64 /* Was a bare word (filehandle?). */
599cee73	145	#define OPpCONST_WARNING 128 /* Was a $^W translated to constant. */
79072805 LW	146
79072805 LW	147	/* Private for OP_FLIP/FLOP */
a0d0e21e	148	#define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */
79072805	149
ed6116ce	150	/* Private for OP_LIST */
a0d0e21e LW	151	#define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */
a0d0e21e LW	152
5f05dabc	153	/* Private for OP_DELETE */
54310121	154	#define OPpSLICE 64 /* Operating on a list of keys */
5f05dabc	155
bbce6d69	156	/* Private for OP_SORT, OP_PRTF, OP_SPRINTF, string cmp'n, and case changers */
	157	#define OPpLOCALE 64 /* Use locale */
	158
9c007264 JH	159	/* Private for OP_SORT */
	160	#define OPpSORT_NUMERIC 1 /* Optimized away { $a <=> $b } */
	161	#define OPpSORT_INTEGER 2 /* Ditto while under "use integer" */
	162	#define OPpSORT_REVERSE 4 /* Descending sort */
224a4551 MB	163	/* Private for OP_THREADSV */
224a4551 MB	164	#define OPpDONE_SVREF 64 /* Been through newSVREF once */
554b3eca	165
79072805 LW	166	struct op {
	167	BASEOP
	168	};
	169
	170	struct unop {
	171	BASEOP
	172	OP * op_first;
	173	};
	174
	175	struct binop {
	176	BASEOP
	177	OP * op_first;
	178	OP * op_last;
	179	};
	180
	181	struct logop {
	182	BASEOP
	183	OP * op_first;
	184	OP * op_other;
	185	};
	186
79072805 LW	187	struct listop {
	188	BASEOP
	189	OP * op_first;
	190	OP * op_last;
	191	U32 op_children;
	192	};
	193
	194	struct pmop {
	195	BASEOP
	196	OP * op_first;
	197	OP * op_last;
	198	U32 op_children;
	199	OP * op_pmreplroot;
	200	OP * op_pmreplstart;
	201	PMOP * op_pmnext; /* list of all scanpats */
	202	REGEXP * op_pmregexp; /* compiled expression */
a0d0e21e	203	U16 op_pmflags;
4633a7c4	204	U16 op_pmpermflags;
48c036b1	205	U8 op_pmdynflags;
79072805	206	};
a0d0e21e	207
48c036b1	208	#define PMdf_USED 0x01 /* pm has been used once already */
b3eb6a9b	209	#define PMdf_TAINTED 0x02 /* pm compiled from tainted pattern */
48c036b1	210
b3eb6a9b	211	#define PMf_RETAINT 0x0001 /* taint $1 etc. if target tainted */
a0d0e21e	212	#define PMf_ONCE 0x0002 /* use pattern only once per reset */
c277df42	213	#define PMf_REVERSED 0x0004 /* Should be matched right->left */
ce862d02	214	#define PMf_MAYBE_CONST 0x0008 /* replacement contains variables */
a0d0e21e	215	#define PMf_SKIPWHITE 0x0010 /* skip leading whitespace for split */
8782bef2	216	#define PMf_WHITE 0x0020 /* pattern is \s+ */
a0d0e21e LW	217	#define PMf_CONST 0x0040 /* subst replacement is constant */
	218	#define PMf_KEEP 0x0080 /* keep 1st runtime pattern forever */
	219	#define PMf_GLOBAL 0x0100 /* pattern had a g modifier */
c90c0ff4	220	#define PMf_CONTINUE 0x0200 /* don't reset pos() if //g fails */
a0d0e21e	221	#define PMf_EVAL 0x0400 /* evaluating replacement as expr */
8782bef2	222	#define PMf_LOCALE 0x0800 /* use locale for character types */
a0d0e21e LW	223	#define PMf_MULTILINE 0x1000 /* assume multiple lines */
a0d0e21e LW	224	#define PMf_SINGLELINE 0x2000 /* assume single line */
8782bef2	225	#define PMf_FOLD 0x4000 /* case insensitivity */
a0d0e21e	226	#define PMf_EXTENDED 0x8000 /* chuck embedded whitespace */
79072805	227
8782bef2 GB	228	/* mask of bits stored in regexp->reganch */
	229	#define PMf_COMPILETIME (PMf_MULTILINE\|PMf_SINGLELINE\|PMf_LOCALE\|PMf_FOLD\|PMf_EXTENDED)
	230
79072805 LW	231	struct svop {
	232	BASEOP
	233	SV * op_sv;
	234	};
	235
	236	struct gvop {
	237	BASEOP
	238	GV * op_gv;
	239	};
	240
	241	struct pvop {
	242	BASEOP
	243	char * op_pv;
	244	};
	245
79072805 LW	246	struct loop {
	247	BASEOP
	248	OP * op_first;
	249	OP * op_last;
	250	U32 op_children;
	251	OP * op_redoop;
	252	OP * op_nextop;
	253	OP * op_lastop;
	254	};
	255
533c011a NIS	256	#define cUNOP ((UNOP*)PL_op)
	257	#define cBINOP ((BINOP*)PL_op)
	258	#define cLISTOP ((LISTOP*)PL_op)
	259	#define cLOGOP ((LOGOP*)PL_op)
533c011a NIS	260	#define cPMOP ((PMOP*)PL_op)
	261	#define cSVOP ((SVOP*)PL_op)
	262	#define cGVOP ((GVOP*)PL_op)
	263	#define cPVOP ((PVOP*)PL_op)
	264	#define cCOP ((COP*)PL_op)
	265	#define cLOOP ((LOOP*)PL_op)
79072805	266
11343788 MB	267	#define cUNOPo ((UNOP*)o)
	268	#define cBINOPo ((BINOP*)o)
	269	#define cLISTOPo ((LISTOP*)o)
	270	#define cLOGOPo ((LOGOP*)o)
11343788 MB	271	#define cPMOPo ((PMOP*)o)
	272	#define cSVOPo ((SVOP*)o)
	273	#define cGVOPo ((GVOP*)o)
	274	#define cPVOPo ((PVOP*)o)
	275	#define cCVOPo ((CVOP*)o)
	276	#define cCOPo ((COP*)o)
	277	#define cLOOPo ((LOOP*)o)
	278
79072805 LW	279	#define kUNOP ((UNOP*)kid)
	280	#define kBINOP ((BINOP*)kid)
	281	#define kLISTOP ((LISTOP*)kid)
	282	#define kLOGOP ((LOGOP*)kid)
79072805 LW	283	#define kPMOP ((PMOP*)kid)
	284	#define kSVOP ((SVOP*)kid)
	285	#define kGVOP ((GVOP*)kid)
	286	#define kPVOP ((PVOP*)kid)
79072805 LW	287	#define kCOP ((COP*)kid)
	288	#define kLOOP ((LOOP*)kid)
	289
	290	#define Nullop Null(OP*)
	291
4369b173	292	/* Lowest byte of PL_opargs */
a0d0e21e LW	293	#define OA_MARK 1
	294	#define OA_FOLDCONST 2
	295	#define OA_RETSCALAR 4
	296	#define OA_TARGET 8
	297	#define OA_RETINTEGER 16
	298	#define OA_OTHERINT 32
	299	#define OA_DANGEROUS 64
	300	#define OA_DEFGV 128
b162f9ea	301	#define OA_TARGLEX 256
a0d0e21e	302
db173bac	303	/* The next 4 bits encode op class information */
b162f9ea IZ	304	#define OCSHIFT 9
	305
	306	#define OA_CLASS_MASK (15 << OCSHIFT)
	307
	308	#define OA_BASEOP (0 << OCSHIFT)
	309	#define OA_UNOP (1 << OCSHIFT)
	310	#define OA_BINOP (2 << OCSHIFT)
	311	#define OA_LOGOP (3 << OCSHIFT)
1a67a97c SM	312	#define OA_LISTOP (4 << OCSHIFT)
	313	#define OA_PMOP (5 << OCSHIFT)
	314	#define OA_SVOP (6 << OCSHIFT)
	315	#define OA_GVOP (7 << OCSHIFT)
	316	#define OA_PVOP_OR_SVOP (8 << OCSHIFT)
	317	#define OA_LOOP (9 << OCSHIFT)
	318	#define OA_COP (10 << OCSHIFT)
	319	#define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
	320	#define OA_FILESTATOP (12 << OCSHIFT)
	321	#define OA_LOOPEXOP (13 << OCSHIFT)
b162f9ea IZ	322
b162f9ea IZ	323	#define OASHIFT 13
a0d0e21e	324
4369b173	325	/* Remaining nybbles of PL_opargs */
a0d0e21e LW	326	#define OA_SCALAR 1
	327	#define OA_LIST 2
	328	#define OA_AVREF 3
	329	#define OA_HVREF 4
	330	#define OA_CVREF 5
	331	#define OA_FILEREF 6
	332	#define OA_SCALARREF 7
	333	#define OA_OPTIONAL 8
	334