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

/*    scope.h
 *
 *    Copyright (C) 1993, 1994, 1996, 1997, 1998, 1999, 2000, 2001,
 *    2002, 2004, 2005, 2006, 2007, 2008 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.
 *
 */

#define SAVEt_ITEM		0
#define SAVEt_SV		1
#define SAVEt_AV		2
#define SAVEt_HV		3
#define SAVEt_INT		4
#define SAVEt_LONG		5
#define SAVEt_I32		6
#define SAVEt_IV		7
#define SAVEt_SPTR		8
#define SAVEt_APTR		9
#define SAVEt_HPTR		10
#define SAVEt_PPTR		11
#define SAVEt_NSTAB		12
#define SAVEt_SVREF		13
#define SAVEt_GP		14
#define SAVEt_FREESV		15
#define SAVEt_FREEOP		16
#define SAVEt_FREEPV		17
#define SAVEt_CLEARSV		18
#define SAVEt_DELETE		19
#define SAVEt_DESTRUCTOR	20
#define SAVEt_REGCONTEXT	21
#define SAVEt_STACK_POS		22
#define SAVEt_I16		23
#define SAVEt_AELEM		24
#define SAVEt_HELEM		25
#define SAVEt_OP		26
#define SAVEt_HINTS		27
#define SAVEt_ALLOC		28
#define SAVEt_GENERIC_SVREF	29
#define SAVEt_DESTRUCTOR_X	30
#define SAVEt_VPTR		31
#define SAVEt_I8		32
#define SAVEt_COMPPAD		33
#define SAVEt_GENERIC_PVREF	34
#define SAVEt_PADSV_AND_MORTALIZE	35
#define SAVEt_MORTALIZESV	36
#define SAVEt_SHARED_PVREF	37
#define SAVEt_BOOL		38
#define SAVEt_SET_SVFLAGS	39
#define SAVEt_SAVESWITCHSTACK	40
#define SAVEt_COP_ARYBASE	41
#define SAVEt_RE_STATE		42
#define SAVEt_COMPILE_WARNINGS	43
#define SAVEt_STACK_CXPOS	44
#define SAVEt_PARSER		45
#define SAVEt_ADELETE		46

#define SAVEf_SETMAGIC		1
#define SAVEf_KEEPOLDELEM	2

#define SAVE_TIGHT_SHIFT	6
#define SAVE_MASK		0x3F

#define save_aelem(av,idx,sptr)	save_aelem_flags(av,idx,sptr,SAVEf_SETMAGIC)
#define save_helem(hv,key,sptr)	save_helem_flags(hv,key,sptr,SAVEf_SETMAGIC)

#ifndef SCOPE_SAVES_SIGNAL_MASK
#define SCOPE_SAVES_SIGNAL_MASK 0
#endif

#define SSCHECK(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow()
#define SSGROW(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow_cnt(need)
#define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
#define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
#define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
#define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
#define SSPUSHUV(u) (PL_savestack[PL_savestack_ix++].any_uv = (UV)(u))
#define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
#define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
#define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
#define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
#define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
#define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
#define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
#define SSPOPUV (PL_savestack[--PL_savestack_ix].any_uv)
#define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
#define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
#define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)

/*
=head1 Callback Functions

=for apidoc Ams||SAVETMPS
Opening bracket for temporaries on a callback.  See C<FREETMPS> and
L<perlcall>.

=for apidoc Ams||FREETMPS
Closing bracket for temporaries on a callback.  See C<SAVETMPS> and
L<perlcall>.

=for apidoc Ams||ENTER
Opening bracket on a callback.  See C<LEAVE> and L<perlcall>.

=for apidoc Ams||LEAVE
Closing bracket on a callback.  See C<ENTER> and L<perlcall>.

=over

=item ENTER_with_name(name)

Same as C<ENTER>, but when debugging is enabled it also associates the
given literal string with the new scope.

=item LEAVE_with_name(name)

Same as C<LEAVE>, but when debugging is enabled it first checks that the
scope has the given name. Name must be a literal string.

=back

=cut
*/

#define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
#define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()

#ifdef DEBUGGING
#define ENTER							\
    STMT_START {						\
	push_scope();						\
	DEBUG_SCOPE("ENTER")					\
    } STMT_END
#define LEAVE							\
    STMT_START {						\
	DEBUG_SCOPE("LEAVE")					\
	pop_scope();						\
    } STMT_END
#define ENTER_with_name(name)						\
    STMT_START {							\
	push_scope();							\
	if (PL_scopestack_name)						\
	    PL_scopestack_name[PL_scopestack_ix-1] = name;		\
	DEBUG_SCOPE("ENTER \"" name "\"")				\
    } STMT_END
#define LEAVE_with_name(name)						\
    STMT_START {							\
	DEBUG_SCOPE("LEAVE \"" name "\"")				\
	if (PL_scopestack_name)	{					\
	    assert(((char*)PL_scopestack_name[PL_scopestack_ix-1]	\
			== (char*)name)					\
		    || strEQ(PL_scopestack_name[PL_scopestack_ix-1], name));        \
	}								\
	pop_scope();							\
    } STMT_END
#else
#define ENTER push_scope()
#define LEAVE pop_scope()
#define ENTER_with_name(name) ENTER
#define LEAVE_with_name(name) LEAVE
#endif
#define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)

#define SAVEI8(i)	save_I8((I8*)&(i))
#define SAVEI16(i)	save_I16((I16*)&(i))
#define SAVEI32(i)	save_I32((I32*)&(i))
#define SAVEINT(i)	save_int((int*)&(i))
#define SAVEIV(i)	save_iv((IV*)&(i))
#define SAVELONG(l)	save_long((long*)&(l))
#define SAVEBOOL(b)	save_bool(&(b))
#define SAVESPTR(s)	save_sptr((SV**)&(s))
#define SAVEPPTR(s)	save_pptr((char**)&(s))
#define SAVEVPTR(s)	save_vptr((void*)&(s))
#define SAVEPADSVANDMORTALIZE(s)	save_padsv_and_mortalize(s)
#define SAVEFREESV(s)	save_freesv(MUTABLE_SV(s))
#define SAVEMORTALIZESV(s)	save_mortalizesv(MUTABLE_SV(s))
#define SAVEFREEOP(o)	save_freeop((OP*)(o))
#define SAVEFREEPV(p)	save_freepv((char*)(p))
#define SAVECLEARSV(sv)	save_clearsv((SV**)&(sv))
#define SAVEGENERICSV(s)	save_generic_svref((SV**)&(s))
#define SAVEGENERICPV(s)	save_generic_pvref((char**)&(s))
#define SAVESHAREDPV(s)		save_shared_pvref((char**)&(s))
#define SAVESETSVFLAGS(sv,mask,val)	save_set_svflags(sv,mask,val)
#define SAVEDELETE(h,k,l) \
	  save_delete(MUTABLE_HV(h), (char*)(k), (I32)(l))
#define SAVEHDELETE(h,s) \
	  save_hdelete(MUTABLE_HV(h), (s))
#define SAVEADELETE(a,k) \
	  save_adelete(MUTABLE_AV(a), (I32)(k))
#define SAVEDESTRUCTOR(f,p) \
	  save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))

#define SAVEDESTRUCTOR_X(f,p) \
	  save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))

#define SAVESTACK_POS() \
    STMT_START {				\
	SSCHECK(2);				\
	SSPUSHINT(PL_stack_sp - PL_stack_base);	\
	SSPUSHUV(SAVEt_STACK_POS);		\
    } STMT_END

#define SAVEOP()	save_op()

#define SAVEHINTS()	save_hints()

#define SAVECOMPPAD() save_pushptr(MUTABLE_SV(PL_comppad), SAVEt_COMPPAD)

#define SAVESWITCHSTACK(f,t) \
    STMT_START {					\
	save_pushptrptr(MUTABLE_SV(f), MUTABLE_SV(t), SAVEt_SAVESWITCHSTACK); \
	SWITCHSTACK((f),(t));				\
	PL_curstackinfo->si_stack = (t);		\
    } STMT_END

#define SAVECOPARYBASE(c) save_pushi32ptr(CopARYBASE_get(c), c, SAVEt_COP_ARYBASE);

/* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
   because realloc() means that the value can actually change. Possibly
   could have done savefreesharedpvREF, but this way actually seems cleaner,
   as it simplifies the code that does the saves, and reduces the load on the
   save stack.  */
#define SAVECOMPILEWARNINGS() save_pushptr(PL_compiling.cop_warnings, SAVEt_COMPILE_WARNINGS)

#define SAVESTACK_CXPOS() \
    STMT_START {                                  \
        SSCHECK(3);                               \
        SSPUSHINT(cxstack[cxstack_ix].blk_oldsp); \
        SSPUSHINT(cxstack_ix);                    \
        SSPUSHUV(SAVEt_STACK_CXPOS);              \
    } STMT_END

#define SAVEPARSER(p) save_pushptr((p), SAVEt_PARSER)

#ifdef USE_ITHREADS
#  define SAVECOPSTASH(c)	SAVEPPTR(CopSTASHPV(c))
#  define SAVECOPSTASH_FREE(c)	SAVESHAREDPV(CopSTASHPV(c))
#  define SAVECOPFILE(c)	SAVEPPTR(CopFILE(c))
#  define SAVECOPFILE_FREE(c)	SAVESHAREDPV(CopFILE(c))
#else
#  define SAVECOPSTASH(c)	SAVESPTR(CopSTASH(c))
#  define SAVECOPSTASH_FREE(c)	SAVECOPSTASH(c)	/* XXX not refcounted */
#  define SAVECOPFILE(c)	SAVESPTR(CopFILEGV(c))
#  define SAVECOPFILE_FREE(c)	SAVEGENERICSV(CopFILEGV(c))
#endif

#define SAVECOPLINE(c)		SAVEI32(CopLINE(c))

/* SSNEW() temporarily allocates a specified number of bytes of data on the
 * savestack.  It returns an integer index into the savestack, because a
 * pointer would get broken if the savestack is moved on reallocation.
 * SSNEWa() works like SSNEW(), but also aligns the data to the specified
 * number of bytes.  MEM_ALIGNBYTES is perhaps the most useful.  The
 * alignment will be preserved therough savestack reallocation *only* if
 * realloc returns data aligned to a size divisible by "align"!
 *
 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
 */

#define SSNEW(size)             Perl_save_alloc(aTHX_ (size), 0)
#define SSNEWt(n,t)             SSNEW((n)*sizeof(t))
#define SSNEWa(size,align)	Perl_save_alloc(aTHX_ (size), \
    (I32)(align - ((size_t)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
#define SSNEWat(n,t,align)	SSNEWa((n)*sizeof(t), align)

#define SSPTR(off,type)         ((type)  ((char*)PL_savestack + off))
#define SSPTRt(off,type)        ((type*) ((char*)PL_savestack + off))

#define save_freesv(op)		save_pushptr((void *)(op), SAVEt_FREESV)
#define save_mortalizesv(op)	save_pushptr((void *)(op), SAVEt_MORTALIZESV)
#define save_freeop(op)		save_pushptr((void *)(op), SAVEt_FREEOP)
#define save_freepv(pv)		save_pushptr((void *)(pv), SAVEt_FREEPV)
#define save_op()		save_pushptr((void *)(PL_op), SAVEt_OP)

/*
 * Local variables:
 * c-indentation-style: bsd
 * c-basic-offset: 4
 * indent-tabs-mode: t
 * End:
 *
 * ex: set ts=8 sts=4 sw=4 noet:
 */
Commit	Line	Data
d6376244	1	/* scope.h
d6376244	2	*
1129b882	3	* Copyright (C) 1993, 1994, 1996, 1997, 1998, 1999, 2000, 2001,
1129b882	4	* 2002, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
d6376244	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	*
	9	*/
	10
b9d12d37	11	#define SAVEt_ITEM 0
	12	#define SAVEt_SV 1
	13	#define SAVEt_AV 2
	14	#define SAVEt_HV 3
	15	#define SAVEt_INT 4
	16	#define SAVEt_LONG 5
	17	#define SAVEt_I32 6
	18	#define SAVEt_IV 7
	19	#define SAVEt_SPTR 8
	20	#define SAVEt_APTR 9
	21	#define SAVEt_HPTR 10
	22	#define SAVEt_PPTR 11
	23	#define SAVEt_NSTAB 12
	24	#define SAVEt_SVREF 13
	25	#define SAVEt_GP 14
	26	#define SAVEt_FREESV 15
	27	#define SAVEt_FREEOP 16
	28	#define SAVEt_FREEPV 17
	29	#define SAVEt_CLEARSV 18
	30	#define SAVEt_DELETE 19
	31	#define SAVEt_DESTRUCTOR 20
	32	#define SAVEt_REGCONTEXT 21
	33	#define SAVEt_STACK_POS 22
	34	#define SAVEt_I16 23
	35	#define SAVEt_AELEM 24
	36	#define SAVEt_HELEM 25
	37	#define SAVEt_OP 26
	38	#define SAVEt_HINTS 27
	39	#define SAVEt_ALLOC 28
	40	#define SAVEt_GENERIC_SVREF 29
c76ac1ee	41	#define SAVEt_DESTRUCTOR_X 30
7766f137	42	#define SAVEt_VPTR 31
e8347627	43	#define SAVEt_I8 32
354992b1	44	#define SAVEt_COMPPAD 33
f4dd75d9	45	#define SAVEt_GENERIC_PVREF 34
09edbca0	46	#define SAVEt_PADSV_AND_MORTALIZE 35
26d9b02f	47	#define SAVEt_MORTALIZESV 36
05ec9bb3	48	#define SAVEt_SHARED_PVREF 37
9febdf04	49	#define SAVEt_BOOL 38
14f338dc	50	#define SAVEt_SET_SVFLAGS 39
8b7059b1	51	#define SAVEt_SAVESWITCHSTACK 40
fc15ae8f	52	#define SAVEt_COP_ARYBASE 41
1ade1aa1	53	#define SAVEt_RE_STATE 42
68da3b2f	54	#define SAVEt_COMPILE_WARNINGS 43
ea8d6ae1	55	#define SAVEt_STACK_CXPOS 44
7c197c94	56	#define SAVEt_PARSER 45
c68ec7a9	57	#define SAVEt_ADELETE 46
79072805	58
af7df257	59	#define SAVEf_SETMAGIC 1
75d34a09	60	#define SAVEf_KEEPOLDELEM 2
af7df257	61
c6bf6a65	62	#define SAVE_TIGHT_SHIFT 6
	63	#define SAVE_MASK 0x3F
	64
91d1c79f	65	#define save_aelem(av,idx,sptr) save_aelem_flags(av,idx,sptr,SAVEf_SETMAGIC)
af7df257	66	#define save_helem(hv,key,sptr) save_helem_flags(hv,key,sptr,SAVEf_SETMAGIC)
af7df257	67
b03c0a3a	68	#ifndef SCOPE_SAVES_SIGNAL_MASK
1b266415	69	#define SCOPE_SAVES_SIGNAL_MASK 0
b03c0a3a	70	#endif
b03c0a3a	71
bb7a0f54	72	#define SSCHECK(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow()
bb7a0f54	73	#define SSGROW(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow_cnt(need)
3280af22	74	#define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
3280af22	75	#define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
9febdf04	76	#define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
3280af22	77	#define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
c6bf6a65	78	#define SSPUSHUV(u) (PL_savestack[PL_savestack_ix++].any_uv = (UV)(u))
3280af22	79	#define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
3280af22	80	#define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
c76ac1ee	81	#define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
3280af22	82	#define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
3280af22	83	#define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
9febdf04	84	#define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
3280af22	85	#define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
c6bf6a65	86	#define SSPOPUV (PL_savestack[--PL_savestack_ix].any_uv)
3280af22	87	#define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
3280af22	88	#define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
c76ac1ee	89	#define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
8990e307	90
954c1994	91	/*
ccfc67b7	92	=head1 Callback Functions
ccfc67b7	93
954c1994	94	=for apidoc Ams\|\|SAVETMPS
	95	Opening bracket for temporaries on a callback. See C<FREETMPS> and
	96	L<perlcall>.
	97
	98	=for apidoc Ams\|\|FREETMPS
	99	Closing bracket for temporaries on a callback. See C<SAVETMPS> and
	100	L<perlcall>.
	101
	102	=for apidoc Ams\|\|ENTER
	103	Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
	104
	105	=for apidoc Ams\|\|LEAVE
	106	Closing bracket on a callback. See C<ENTER> and L<perlcall>.
	107
d343c3ef	108	=over
	109
	110	=item ENTER_with_name(name)
	111
	112	Same as C<ENTER>, but when debugging is enabled it also associates the
	113	given literal string with the new scope.
	114
	115	=item LEAVE_with_name(name)
	116
	117	Same as C<LEAVE>, but when debugging is enabled it first checks that the
	118	scope has the given name. Name must be a literal string.
	119
	120	=back
	121
954c1994	122	=cut
	123	*/
	124
3280af22	125	#define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
3280af22	126	#define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
a0d0e21e	127
f46d017c	128	#ifdef DEBUGGING
	129	#define ENTER \
	130	STMT_START { \
	131	push_scope(); \
b4ab917c	132	DEBUG_SCOPE("ENTER") \
f46d017c	133	} STMT_END
	134	#define LEAVE \
	135	STMT_START { \
b4ab917c	136	DEBUG_SCOPE("LEAVE") \
f46d017c	137	pop_scope(); \
f46d017c	138	} STMT_END
d343c3ef	139	#define ENTER_with_name(name) \
	140	STMT_START { \
	141	push_scope(); \
a09dc31d	142	if (PL_scopestack_name) \
a09dc31d	143	PL_scopestack_name[PL_scopestack_ix-1] = name; \
d343c3ef	144	DEBUG_SCOPE("ENTER \"" name "\"") \
	145	} STMT_END
	146	#define LEAVE_with_name(name) \
	147	STMT_START { \
	148	DEBUG_SCOPE("LEAVE \"" name "\"") \
a09dc31d	149	if (PL_scopestack_name) { \
	150	assert(((char*)PL_scopestack_name[PL_scopestack_ix-1] \
	151	== (char*)name) \
	152	\|\| strEQ(PL_scopestack_name[PL_scopestack_ix-1], name)); \
	153	} \
d343c3ef	154	pop_scope(); \
d343c3ef	155	} STMT_END
f46d017c	156	#else
a0d0e21e	157	#define ENTER push_scope()
a0d0e21e	158	#define LEAVE pop_scope()
d343c3ef	159	#define ENTER_with_name(name) ENTER
d343c3ef	160	#define LEAVE_with_name(name) LEAVE
f46d017c	161	#endif
3280af22	162	#define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
a0d0e21e	163
3f26ef39	164	#define SAVEI8(i) save_I8((I8*)&(i))
	165	#define SAVEI16(i) save_I16((I16*)&(i))
	166	#define SAVEI32(i) save_I32((I32*)&(i))
	167	#define SAVEINT(i) save_int((int*)&(i))
	168	#define SAVEIV(i) save_iv((IV*)&(i))
	169	#define SAVELONG(l) save_long((long*)&(l))
02644217	170	#define SAVEBOOL(b) save_bool(&(b))
55497cff	171	#define SAVESPTR(s) save_sptr((SV**)&(s))
3f26ef39	172	#define SAVEPPTR(s) save_pptr((char**)&(s))
57b2e452	173	#define SAVEVPTR(s) save_vptr((void*)&(s))
09edbca0	174	#define SAVEPADSVANDMORTALIZE(s) save_padsv_and_mortalize(s)
b1bc3f34	175	#define SAVEFREESV(s) save_freesv(MUTABLE_SV(s))
b1bc3f34	176	#define SAVEMORTALIZESV(s) save_mortalizesv(MUTABLE_SV(s))
3f26ef39	177	#define SAVEFREEOP(o) save_freeop((OP*)(o))
	178	#define SAVEFREEPV(p) save_freepv((char*)(p))
	179	#define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
b9d12d37	180	#define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
f4dd75d9	181	#define SAVEGENERICPV(s) save_generic_pvref((char**)&(s))
05ec9bb3	182	#define SAVESHAREDPV(s) save_shared_pvref((char**)&(s))
14f338dc	183	#define SAVESETSVFLAGS(sv,mask,val) save_set_svflags(sv,mask,val)
55497cff	184	#define SAVEDELETE(h,k,l) \
dbebbdb4	185	save_delete(MUTABLE_HV(h), (char*)(k), (I32)(l))
af097752	186	#define SAVEHDELETE(h,s) \
af097752	187	save_hdelete(MUTABLE_HV(h), (s))
c68ec7a9	188	#define SAVEADELETE(a,k) \
c68ec7a9	189	save_adelete(MUTABLE_AV(a), (I32)(k))
55497cff	190	#define SAVEDESTRUCTOR(f,p) \
3f26ef39	191	save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
c76ac1ee	192
c76ac1ee	193	#define SAVEDESTRUCTOR_X(f,p) \
3f26ef39	194	save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
25eaa213	195
	196	#define SAVESTACK_POS() \
	197	STMT_START { \
	198	SSCHECK(2); \
3280af22	199	SSPUSHINT(PL_stack_sp - PL_stack_base); \
c6bf6a65	200	SSPUSHUV(SAVEt_STACK_POS); \
25eaa213	201	} STMT_END
25eaa213	202
462e5cf6	203	#define SAVEOP() save_op()
25eaa213	204
da8315f8	205	#define SAVEHINTS() save_hints()
354992b1	206
747e2fae	207	#define SAVECOMPPAD() save_pushptr(MUTABLE_SV(PL_comppad), SAVEt_COMPPAD)
a9332b4a	208
8b7059b1	209	#define SAVESWITCHSTACK(f,t) \
8b7059b1	210	STMT_START { \
dfcd3de5	211	save_pushptrptr(MUTABLE_SV(f), MUTABLE_SV(t), SAVEt_SAVESWITCHSTACK); \
8b7059b1	212	SWITCHSTACK((f),(t)); \
	213	PL_curstackinfo->si_stack = (t); \
	214	} STMT_END
	215
7623d426	216	#define SAVECOPARYBASE(c) save_pushi32ptr(CopARYBASE_get(c), c, SAVEt_COP_ARYBASE);
fc15ae8f	217
c88c823b	218	/* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
72dc9ed5	219	because realloc() means that the value can actually change. Possibly
	220	could have done savefreesharedpvREF, but this way actually seems cleaner,
	221	as it simplifies the code that does the saves, and reduces the load on the
	222	save stack. */
747e2fae	223	#define SAVECOMPILEWARNINGS() save_pushptr(PL_compiling.cop_warnings, SAVEt_COMPILE_WARNINGS)
fc15ae8f	224
ea8d6ae1	225	#define SAVESTACK_CXPOS() \
	226	STMT_START { \
	227	SSCHECK(3); \
	228	SSPUSHINT(cxstack[cxstack_ix].blk_oldsp); \
	229	SSPUSHINT(cxstack_ix); \
c6bf6a65	230	SSPUSHUV(SAVEt_STACK_CXPOS); \
ea8d6ae1	231	} STMT_END
ea8d6ae1	232
747e2fae	233	#define SAVEPARSER(p) save_pushptr((p), SAVEt_PARSER)
7c197c94	234
57843af0	235	#ifdef USE_ITHREADS
f4dd75d9	236	# define SAVECOPSTASH(c) SAVEPPTR(CopSTASHPV(c))
05ec9bb3	237	# define SAVECOPSTASH_FREE(c) SAVESHAREDPV(CopSTASHPV(c))
f4dd75d9	238	# define SAVECOPFILE(c) SAVEPPTR(CopFILE(c))
05ec9bb3	239	# define SAVECOPFILE_FREE(c) SAVESHAREDPV(CopFILE(c))
57843af0	240	#else
f4dd75d9	241	# define SAVECOPSTASH(c) SAVESPTR(CopSTASH(c))
	242	# define SAVECOPSTASH_FREE(c) SAVECOPSTASH(c) /* XXX not refcounted */
	243	# define SAVECOPFILE(c) SAVESPTR(CopFILEGV(c))
	244	# define SAVECOPFILE_FREE(c) SAVEGENERICSV(CopFILEGV(c))
57843af0	245	#endif
57843af0	246
dea28490	247	#define SAVECOPLINE(c) SAVEI32(CopLINE(c))
57843af0	248
455ece5e	249	/* SSNEW() temporarily allocates a specified number of bytes of data on the
	250	* savestack. It returns an integer index into the savestack, because a
	251	* pointer would get broken if the savestack is moved on reallocation.
	252	* SSNEWa() works like SSNEW(), but also aligns the data to the specified
	253	* number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The
	254	* alignment will be preserved therough savestack reallocation only if
a0288114	255	* realloc returns data aligned to a size divisible by "align"!
455ece5e	256	*
	257	* SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
	258	*/
	259
f2b2c1a7	260	#define SSNEW(size) Perl_save_alloc(aTHX_ (size), 0)
02db2b7b	261	#define SSNEWt(n,t) SSNEW((n)*sizeof(t))
f2b2c1a7	262	#define SSNEWa(size,align) Perl_save_alloc(aTHX_ (size), \
6b99f28a	263	(I32)(align - ((size_t)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
02db2b7b	264	#define SSNEWat(n,t,align) SSNEWa((n)*sizeof(t), align)
455ece5e	265
02db2b7b	266	#define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
02db2b7b	267	#define SSPTRt(off,type) ((type) ((char)PL_savestack + off))
455ece5e	268
2fd8beea	269	#define save_freesv(op) save_pushptr((void *)(op), SAVEt_FREESV)
	270	#define save_mortalizesv(op) save_pushptr((void *)(op), SAVEt_MORTALIZESV)
	271	#define save_freeop(op) save_pushptr((void *)(op), SAVEt_FREEOP)
	272	#define save_freepv(pv) save_pushptr((void *)(pv), SAVEt_FREEPV)
	273	#define save_op() save_pushptr((void *)(PL_op), SAVEt_OP)
	274
e9a8c099	275	/*
	276	* Local variables:
	277	* c-indentation-style: bsd
	278	* c-basic-offset: 4
	279	* indent-tabs-mode: t
	280	* End:
	281	*
	282	* ex: set ts=8 sts=4 sw=4 noet:
	283	*/