[perl5.git] / op.h

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

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

#define BASEOP				\
    OP*		op_next;		\
    OP*		op_sibling;		\
    OP*		(*op_ppaddr)();		\
    PADOFFSET	op_targ;		\
    OPCODE	op_type;		\
    U16		op_seq;			\
    U8		op_flags;		\
    U8		op_private;

#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(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 $@ */

/* old names; don't use in new code, but don't break them, either */
#define OPf_LIST	1
#define OPf_KNOW	2
#define GIMME \
	  (op->op_flags & OPf_KNOW ? op->op_flags & OPf_LIST : 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_SQUASH		16
#define OPpTRANS_DELETE		32
#define OPpTRANS_COMPLEMENT	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. */
#define OPpENTERSUB_AMPER	8	/* Used & form to call. */
  /* OP_?ELEM only */
#define OPpLVAL_DEFER		16	/* Defer creation of array/hash elem */
  /* for OP_RV2?V, lower bits carry hints */

/* Private for OP_CONST */
#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?). */

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

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 condop {
    BASEOP
    OP *	op_first;
    OP *	op_true;
    OP *	op_false;
};

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 */
    SV *	op_pmshort;		/* for a fast bypass of execute() */
    U16		op_pmflags;
    U16		op_pmpermflags;
    char	op_pmslen;
};

#define PMf_USED	0x0001		/* pm has been used once already */
#define PMf_ONCE	0x0002		/* use pattern only once per reset */
#define PMf_SCANFIRST	0x0004		/* initial constant not anchored */
#define PMf_ALL		0x0008		/* initial constant is whole pat */
#define PMf_SKIPWHITE	0x0010		/* skip leading whitespace for split */
#define PMf_FOLD	0x0020		/* case insensitivity */
#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_WHITE	0x0800		/* pattern is \s+ */
#define PMf_MULTILINE	0x1000		/* assume multiple lines */
#define PMf_SINGLELINE	0x2000		/* assume single line */
#define PMf_LOCALE	0x4000		/* use locale for character types */
#define PMf_EXTENDED	0x8000		/* chuck embedded whitespace */

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*)op)
#define cBINOP ((BINOP*)op)
#define cLISTOP ((LISTOP*)op)
#define cLOGOP ((LOGOP*)op)
#define cCONDOP ((CONDOP*)op)
#define cPMOP ((PMOP*)op)
#define cSVOP ((SVOP*)op)
#define cGVOP ((GVOP*)op)
#define cPVOP ((PVOP*)op)
#define cCOP ((COP*)op)
#define cLOOP ((LOOP*)op)

#define kUNOP ((UNOP*)kid)
#define kBINOP ((BINOP*)kid)
#define kLISTOP ((LISTOP*)kid)
#define kLOGOP ((LOGOP*)kid)
#define kCONDOP ((CONDOP*)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 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 OASHIFT 8

/* Remaining nybbles of 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	*
9607fc9c	3	* Copyright (c) 1991-1997, 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;
79072805	27
4633a7c4	28	#ifdef DEBUGGING_OPS
79072805 LW	29	#define OPCODE opcode
	30	#else
	31	#define OPCODE U16
	32	#endif
	33
	34	#define BASEOP \
	35	OP* op_next; \
	36	OP* op_sibling; \
	37	OP* (*op_ppaddr)(); \
	38	PADOFFSET op_targ; \
	39	OPCODE op_type; \
	40	U16 op_seq; \
a0d0e21e LW	41	U8 op_flags; \
a0d0e21e LW	42	U8 op_private;
79072805	43
54310121	44	#define OP_GIMME(op,dfl) \
	45	(((op)->op_flags & OPf_WANT) == OPf_WANT_VOID ? G_VOID : \
	46	((op)->op_flags & OPf_WANT) == OPf_WANT_SCALAR ? G_SCALAR : \
	47	((op)->op_flags & OPf_WANT) == OPf_WANT_LIST ? G_ARRAY : \
	48	dfl)
	49
	50	#define GIMME_V OP_GIMME(op, block_gimme())
79072805 LW	51
79072805 LW	52	/* Public flags */
54310121	53
	54	#define OPf_WANT 3 /* Mask for "want" bits: */
	55	#define OPf_WANT_VOID 1 /* Want nothing */
	56	#define OPf_WANT_SCALAR 2 /* Want single value */
	57	#define OPf_WANT_LIST 3 /* Want list of any length */
79072805 LW	58	#define OPf_KIDS 4 /* There is a firstborn child. */
79072805 LW	59	#define OPf_PARENS 8 /* This operator was parenthesized. */
463ee0b2	60	/* (Or block needs explicit scope entry.) */
a0d0e21e LW	61	#define OPf_REF 16 /* Certified reference. */
	62	/* (Return container, not containee). */
	63	#define OPf_MOD 32 /* Will modify (lvalue). */
	64	#define OPf_STACKED 64 /* Some arg is arriving on the stack. */
79072805 LW	65	#define OPf_SPECIAL 128 /* Do something weird for this op: */
	66	/* On local LVAL, don't init local value. */
	67	/* On OP_SORT, subroutine is inlined. */
	68	/* On OP_NOT, inversion was implicit. */
a0d0e21e	69	/* On OP_LEAVE, don't restore curpm. */
79072805 LW	70	/* On truncate, we truncate filehandle */
	71	/* On control verbs, we saw no label */
	72	/* On flipflop, we saw ... instead of .. */
	73	/* On UNOPs, saw bare parens, e.g. eof(). */
a0d0e21e	74	/* On OP_ENTERSUB \|\| OP_NULL, saw a "do". */
f2ec2afd	75	/* On OP_(ENTER\|LEAVE)EVAL, don't clear $@ */
79072805	76
54310121	77	/* old names; don't use in new code, but don't break them, either */
	78	#define OPf_LIST 1
	79	#define OPf_KNOW 2
	80	#define GIMME \
	81	(op->op_flags & OPf_KNOW ? op->op_flags & OPf_LIST : dowantarray())
	82
a0d0e21e LW	83	/* Private for lvalues */
	84	#define OPpLVAL_INTRO 128 /* Lvalue must be localized */
	85
	86	/* Private for OP_AASSIGN */
	87	#define OPpASSIGN_COMMON 64 /* Left & right have syms in common. */
	88
	89	/* Private for OP_SASSIGN */
	90	#define OPpASSIGN_BACKWARDS 64 /* Left & right switched. */
79072805	91
c90c0ff4	92	/* Private for OP_MATCH and OP_SUBST{,CONST} */
	93	#define OPpRUNTIME 64 /* Pattern coming in on the stack */
	94
79072805	95	/* Private for OP_TRANS */
a0d0e21e LW	96	#define OPpTRANS_SQUASH 16
	97	#define OPpTRANS_DELETE 32
	98	#define OPpTRANS_COMPLEMENT 64
79072805 LW	99
79072805 LW	100	/* Private for OP_REPEAT */
a0d0e21e	101	#define OPpREPEAT_DOLIST 64 /* List replication. */
79072805	102
a0d0e21e	103	/* Private for OP_ENTERSUB, OP_RV2?V, OP_?ELEM */
5f05dabc	104	#define OPpDEREF (32\|64) /* Want ref to something: */
	105	#define OPpDEREF_AV 32 /* Want ref to AV. */
	106	#define OPpDEREF_HV 64 /* Want ref to HV. */
	107	#define OPpDEREF_SV (32\|64) /* Want ref to SV. */
68dc0745	108	/* OP_ENTERSUB only */
	109	#define OPpENTERSUB_DB 16 /* Debug subroutine. */
	110	#define OPpENTERSUB_AMPER 8 /* Used & form to call. */
	111	/* OP_?ELEM only */
	112	#define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */
	113	/* for OP_RV2?V, lower bits carry hints */
79072805 LW	114
79072805 LW	115	/* Private for OP_CONST */
748a9306 LW	116	#define OPpCONST_ENTERED 16 /* Has been entered as symbol. */
748a9306 LW	117	#define OPpCONST_ARYBASE 32 /* Was a $[ translated to constant. */
a0d0e21e	118	#define OPpCONST_BARE 64 /* Was a bare word (filehandle?). */
79072805 LW	119
79072805 LW	120	/* Private for OP_FLIP/FLOP */
a0d0e21e	121	#define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */
79072805	122
ed6116ce	123	/* Private for OP_LIST */
a0d0e21e LW	124	#define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */
a0d0e21e LW	125
5f05dabc	126	/* Private for OP_DELETE */
54310121	127	#define OPpSLICE 64 /* Operating on a list of keys */
5f05dabc	128
bbce6d69	129	/* Private for OP_SORT, OP_PRTF, OP_SPRINTF, string cmp'n, and case changers */
	130	#define OPpLOCALE 64 /* Use locale */
	131
79072805 LW	132	struct op {
	133	BASEOP
	134	};
	135
	136	struct unop {
	137	BASEOP
	138	OP * op_first;
	139	};
	140
	141	struct binop {
	142	BASEOP
	143	OP * op_first;
	144	OP * op_last;
	145	};
	146
	147	struct logop {
	148	BASEOP
	149	OP * op_first;
	150	OP * op_other;
	151	};
	152
	153	struct condop {
	154	BASEOP
	155	OP * op_first;
	156	OP * op_true;
	157	OP * op_false;
	158	};
	159
	160	struct listop {
	161	BASEOP
	162	OP * op_first;
	163	OP * op_last;
	164	U32 op_children;
	165	};
	166
	167	struct pmop {
	168	BASEOP
	169	OP * op_first;
	170	OP * op_last;
	171	U32 op_children;
	172	OP * op_pmreplroot;
	173	OP * op_pmreplstart;
	174	PMOP * op_pmnext; /* list of all scanpats */
	175	REGEXP * op_pmregexp; /* compiled expression */
	176	SV * op_pmshort; /* for a fast bypass of execute() */
a0d0e21e	177	U16 op_pmflags;
4633a7c4	178	U16 op_pmpermflags;
79072805 LW	179	char op_pmslen;
79072805 LW	180	};
a0d0e21e LW	181
	182	#define PMf_USED 0x0001 /* pm has been used once already */
	183	#define PMf_ONCE 0x0002 /* use pattern only once per reset */
	184	#define PMf_SCANFIRST 0x0004 /* initial constant not anchored */
	185	#define PMf_ALL 0x0008 /* initial constant is whole pat */
	186	#define PMf_SKIPWHITE 0x0010 /* skip leading whitespace for split */
	187	#define PMf_FOLD 0x0020 /* case insensitivity */
	188	#define PMf_CONST 0x0040 /* subst replacement is constant */
	189	#define PMf_KEEP 0x0080 /* keep 1st runtime pattern forever */
	190	#define PMf_GLOBAL 0x0100 /* pattern had a g modifier */
c90c0ff4	191	#define PMf_CONTINUE 0x0200 /* don't reset pos() if //g fails */
a0d0e21e LW	192	#define PMf_EVAL 0x0400 /* evaluating replacement as expr */
	193	#define PMf_WHITE 0x0800 /* pattern is \s+ */
	194	#define PMf_MULTILINE 0x1000 /* assume multiple lines */
	195	#define PMf_SINGLELINE 0x2000 /* assume single line */
bbce6d69	196	#define PMf_LOCALE 0x4000 /* use locale for character types */
a0d0e21e	197	#define PMf_EXTENDED 0x8000 /* chuck embedded whitespace */
79072805 LW	198
	199	struct svop {
	200	BASEOP
	201	SV * op_sv;
	202	};
	203
	204	struct gvop {
	205	BASEOP
	206	GV * op_gv;
	207	};
	208
	209	struct pvop {
	210	BASEOP
	211	char * op_pv;
	212	};
	213
79072805 LW	214	struct loop {
	215	BASEOP
	216	OP * op_first;
	217	OP * op_last;
	218	U32 op_children;
	219	OP * op_redoop;
	220	OP * op_nextop;
	221	OP * op_lastop;
	222	};
	223
	224	#define cUNOP ((UNOP*)op)
	225	#define cBINOP ((BINOP*)op)
	226	#define cLISTOP ((LISTOP*)op)
	227	#define cLOGOP ((LOGOP*)op)
	228	#define cCONDOP ((CONDOP*)op)
	229	#define cPMOP ((PMOP*)op)
	230	#define cSVOP ((SVOP*)op)
	231	#define cGVOP ((GVOP*)op)
	232	#define cPVOP ((PVOP*)op)
79072805 LW	233	#define cCOP ((COP*)op)
	234	#define cLOOP ((LOOP*)op)
	235
	236	#define kUNOP ((UNOP*)kid)
	237	#define kBINOP ((BINOP*)kid)
	238	#define kLISTOP ((LISTOP*)kid)
	239	#define kLOGOP ((LOGOP*)kid)
	240	#define kCONDOP ((CONDOP*)kid)
	241	#define kPMOP ((PMOP*)kid)
	242	#define kSVOP ((SVOP*)kid)
	243	#define kGVOP ((GVOP*)kid)
	244	#define kPVOP ((PVOP*)kid)
79072805 LW	245	#define kCOP ((COP*)kid)
	246	#define kLOOP ((LOOP*)kid)
	247
	248	#define Nullop Null(OP*)
	249
a0d0e21e LW	250	/* Lowest byte of opargs */
	251	#define OA_MARK 1
	252	#define OA_FOLDCONST 2
	253	#define OA_RETSCALAR 4
	254	#define OA_TARGET 8
	255	#define OA_RETINTEGER 16
	256	#define OA_OTHERINT 32
	257	#define OA_DANGEROUS 64
	258	#define OA_DEFGV 128
	259
	260	#define OASHIFT 8
	261
	262	/* Remaining nybbles of opargs */
	263	#define OA_SCALAR 1
	264	#define OA_LIST 2
	265	#define OA_AVREF 3
	266	#define OA_HVREF 4
	267	#define OA_CVREF 5
	268	#define OA_FILEREF 6
	269	#define OA_SCALARREF 7
	270	#define OA_OPTIONAL 8
	271