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