Symaptic: os/kernelhwsrv/kernel/eka/include/e32def.h@bde4ae8d615e (annotated)

sl@0	1	/*
sl@0	2	* Copyright (c) 1994-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0	3	* All rights reserved.
sl@0	4	* This component and the accompanying materials are made available
sl@0	5	* under the terms of the License "Eclipse Public License v1.0"
sl@0	6	* which accompanies this distribution, and is available
sl@0	7	* at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0	8	*
sl@0	9	* Initial Contributors:
sl@0	10	* Nokia Corporation - initial contribution.
sl@0	11	*
sl@0	12	* Contributors:
sl@0	13	*
sl@0	14	* Description:
sl@0	15	* e32\include\e32def.h
sl@0	16	* NOTE: THIS FILE SHOULD BE ACCEPTABLE TO A C COMPILER
sl@0	17	*
sl@0	18	*
sl@0	19	*/
sl@0	20
sl@0	21
sl@0	22
sl@0	23	#ifndef __E32DEF_H__
sl@0	24	#define __E32DEF_H__
sl@0	25
sl@0	26	/*
sl@0	27	* __LEAVE_EQUALS_THROW__ requires the compiler to support C++ exceptions
sl@0	28	*/
sl@0	29	#ifndef __SUPPORT_CPP_EXCEPTIONS__
sl@0	30	#undef __LEAVE_EQUALS_THROW__
sl@0	31	#endif
sl@0	32
sl@0	33
sl@0	34	#if defined(__VC32__)
sl@0	35	/**
sl@0	36	@publishedAll
sl@0	37	@released
sl@0	38	*/
sl@0	39	#define __NO_CLASS_CONSTS__
sl@0	40	#if (_MSC_VER >= 1200)
sl@0	41	/**
sl@0	42	@publishedAll
sl@0	43	@released
sl@0	44	*/
sl@0	45	#define __NORETURN__ __declspec(noreturn)
sl@0	46	#else
sl@0	47	#define __NORETURN__
sl@0	48	#endif
sl@0	49	/**
sl@0	50	@publishedAll
sl@0	51	@released
sl@0	52	*/
sl@0	53	#define __NORETURN_TERMINATOR()
sl@0	54	/**
sl@0	55	@publishedAll
sl@0	56	@released
sl@0	57	*/
sl@0	58	#define IMPORT_C __declspec(dllexport)
sl@0	59	/**
sl@0	60	@publishedAll
sl@0	61	@released
sl@0	62	*/
sl@0	63	#define EXPORT_C __declspec(dllexport)
sl@0	64	/**
sl@0	65	@publishedAll
sl@0	66	@released
sl@0	67	*/
sl@0	68	#define IMPORT_D __declspec(dllexport)
sl@0	69	/**
sl@0	70	@publishedAll
sl@0	71	@released
sl@0	72	*/
sl@0	73	#define EXPORT_D __declspec(dllexport)
sl@0	74	/**
sl@0	75	@publishedAll
sl@0	76	@released
sl@0	77	*/
sl@0	78	#define NONSHARABLE_CLASS(x) class x
sl@0	79	/**
sl@0	80	@publishedAll
sl@0	81	@released
sl@0	82	*/
sl@0	83	#define NONSHARABLE_STRUCT(x) struct x
sl@0	84	/**
sl@0	85	@publishedAll
sl@0	86	@released
sl@0	87	*/
sl@0	88	#define __NO_THROW throw()
sl@0	89	/**
sl@0	90	@publishedAll
sl@0	91	@released
sl@0	92	*/
sl@0	93	#define __THROW(t) throw(t)
sl@0	94	#pragma warning( disable : 4355 ) /* 'this' used in base member initializer list */
sl@0	95	#pragma warning( disable : 4511 ) /* copy constructor could not be generated */
sl@0	96	#pragma warning( disable : 4512 ) /* assignment operator could not be generated */
sl@0	97	#pragma warning( disable : 4514 ) /* unreferenced inline function has been removed */
sl@0	98	#pragma warning( disable : 4699 ) /* Note: Using precompiled header %s */
sl@0	99	#pragma warning( disable : 4710 ) /* function not inlined */
sl@0	100	#pragma warning( disable : 4121 ) /* alignment sensitive to packing */
sl@0	101	#pragma warning( disable : 4273 )
sl@0	102	#pragma warning( disable : 4097 ) /* typedef-name 'identifier1' used as synonym for class-name 'identifier2' */
sl@0	103	#pragma warning( disable : 4291 ) /* 'TAny CBase::operator new(TUint,TLeave)' : no matching operator delete found; memory will not be freed if initialization throws an exception /
sl@0	104
sl@0	105	#if _MSC_VER >= 1100
sl@0	106	/**
sl@0	107	@publishedAll
sl@0	108	@released
sl@0	109	*/
sl@0	110	#define TEMPLATE_SPECIALIZATION template<>
sl@0	111	#else
sl@0	112	#define TEMPLATE_SPECIALIZATION
sl@0	113	#endif
sl@0	114	#endif
sl@0	115
sl@0	116
sl@0	117
sl@0	118	#if defined(__CW32__)
sl@0	119	#undef __embedded_cplusplus
sl@0	120	/** @internalTechnology */
sl@0	121	#define __embedded_cplusplus 1
sl@0	122	#define __NO_CLASS_CONSTS__
sl@0	123	#define __NORETURN__
sl@0	124	#define __NORETURN_TERMINATOR()
sl@0	125	#define IMPORT_C __declspec(dllexport)
sl@0	126	#define EXPORT_C __declspec(dllexport)
sl@0	127	#define IMPORT_D __declspec(dllexport)
sl@0	128	#define EXPORT_D __declspec(dllexport)
sl@0	129	#define NONSHARABLE_CLASS(x) class x
sl@0	130	#define NONSHARABLE_STRUCT(x) struct x
sl@0	131	#define __NO_THROW throw()
sl@0	132	#define __THROW(t) throw(t)
sl@0	133
sl@0	134	#define TEMPLATE_SPECIALIZATION template<>
sl@0	135	/**
sl@0	136	@publishedAll
sl@0	137	@released
sl@0	138	*/
sl@0	139	#define _asm asm
sl@0	140	#ifndef __int64
sl@0	141	#pragma longlong on
sl@0	142	/** @internalTechnology */
sl@0	143	#define __int64 long long
sl@0	144	#endif
sl@0	145	#ifndef __SUPPORT_CPP_EXCEPTIONS__
sl@0	146	#pragma exceptions off /* no support for C++ exception handling */
sl@0	147	#pragma RTTI off /* no support for C++ runtime type information */
sl@0	148	#endif
sl@0	149	#if __MWERKS__ >= 0x3200
sl@0	150	#pragma warning off (10480) /* deleteing void pointer is undefined */
sl@0	151	#pragma warning off (10350) /* N pad byte(s) inserted after data member */
sl@0	152	#endif
sl@0	153	#endif
sl@0	154
sl@0	155
sl@0	156	//
sl@0	157	// GCC (ARM) compiler
sl@0	158	//
sl@0	159	#if defined(__GCC32__) && defined(__MARM__)
sl@0	160	#ifndef __GNUC__ /* GCC98r2 doesn't define this for some reason */
sl@0	161	#define __GNUC__ 2
sl@0	162	#endif
sl@0	163	#define __NO_CLASS_CONSTS__
sl@0	164	#define __NORETURN__ __attribute__ ((noreturn))
sl@0	165	#ifdef __GCCV3__
sl@0	166	#define __NORETURN_TERMINATOR()
sl@0	167	#else
sl@0	168	#define __NORETURN_TERMINATOR() abort()
sl@0	169	#endif
sl@0	170	#define IMPORT_C
sl@0	171	#define IMPORT_D
sl@0	172	#if !defined __WINS__ && defined _WIN32 /* VC++ Browser Hack */
sl@0	173	#define EXPORT_C
sl@0	174	#define EXPORT_D
sl@0	175	/** @internalTechnology */
sl@0	176	#define asm(x)
sl@0	177	#else
sl@0	178	#define EXPORT_C __declspec(dllexport)
sl@0	179	#define EXPORT_D __declspec(dllexport)
sl@0	180	#endif
sl@0	181	#define NONSHARABLE_CLASS(x) class x
sl@0	182	#define NONSHARABLE_STRUCT(x) struct x
sl@0	183	#define __NO_THROW
sl@0	184	#define __THROW(t)
sl@0	185	#ifdef __EABI__
sl@0	186	#define TEMPLATE_SPECIALIZATION template<>
sl@0	187	#else
sl@0	188	#define TEMPLATE_SPECIALIZATION
sl@0	189	#endif
sl@0	190	/**
sl@0	191	@publishedAll
sl@0	192	@released
sl@0	193	*/
sl@0	194	#define __DOUBLE_WORDS_SWAPPED__
sl@0	195	#endif
sl@0	196
sl@0	197
sl@0	198	/** @internalTechnology */
sl@0	199	#define __NO_MUTABLE_KEYWORD
sl@0	200	#if defined(__NO_MUTABLE_KEYWORD)
sl@0	201	/**
sl@0	202	@publishedAll
sl@0	203	@deprecated
sl@0	204	*/
sl@0	205	#define __MUTABLE
sl@0	206	#else
sl@0	207	#define __MUTABLE mutable
sl@0	208	#endif
sl@0	209
sl@0	210
sl@0	211
sl@0	212	/**
sl@0	213	@publishedAll
sl@0	214	@deprecated
sl@0	215	*/
sl@0	216	#define CONST_CAST(type,exp) (const_cast<type>(exp))
sl@0	217
sl@0	218	/**
sl@0	219	@publishedAll
sl@0	220	@deprecated
sl@0	221	*/
sl@0	222	#define STATIC_CAST(type,exp) (static_cast<type>(exp))
sl@0	223
sl@0	224	/**
sl@0	225	@publishedAll
sl@0	226	@deprecated
sl@0	227	*/
sl@0	228	#define REINTERPRET_CAST(type,exp) (reinterpret_cast<type>(exp))
sl@0	229
sl@0	230	#if defined(__NO_MUTABLE_KEYWORD)
sl@0	231	/**
sl@0	232	@publishedAll
sl@0	233	@deprecated
sl@0	234	*/
sl@0	235	#define MUTABLE_CAST(type,exp) (const_cast<type>(exp))
sl@0	236	#else
sl@0	237	#define MUTABLE_CAST(type,exp) (exp)
sl@0	238	#endif
sl@0	239
sl@0	240	/**
sl@0	241	@publishedAll
sl@0	242	@deprecated
sl@0	243	*/
sl@0	244	#define GLREF_D extern
sl@0	245	/**
sl@0	246	@publishedAll
sl@0	247	@deprecated
sl@0	248	*/
sl@0	249	#define GLDEF_D
sl@0	250	/**
sl@0	251	@publishedAll
sl@0	252	@deprecated
sl@0	253	*/
sl@0	254	#define LOCAL_D static
sl@0	255	/**
sl@0	256	@publishedAll
sl@0	257	@deprecated
sl@0	258	*/
sl@0	259	#define GLREF_C extern
sl@0	260	/**
sl@0	261	@publishedAll
sl@0	262	@deprecated
sl@0	263	*/
sl@0	264	#define GLDEF_C
sl@0	265	/**
sl@0	266	@publishedAll
sl@0	267	@deprecated
sl@0	268	*/
sl@0	269	#define LOCAL_C static
sl@0	270	/**
sl@0	271	@internalAll
sl@0	272	@prototype
sl@0	273	*/
sl@0	274	#ifndef IMPORT_D
sl@0	275	#define IMPORT_D IMPORT_C
sl@0	276	#endif
sl@0	277
sl@0	278	/**
sl@0	279	@publishedAll
sl@0	280	@deprecated
sl@0	281	*/
sl@0	282	#define FOREVER for(;;)
sl@0	283
sl@0	284
sl@0	285
sl@0	286
sl@0	287	/**
sl@0	288	@publishedAll
sl@0	289	@released
sl@0	290
sl@0	291	Symbolic definition for a true value.
sl@0	292	*/
sl@0	293	#define TRUE 1
sl@0	294
sl@0	295
sl@0	296
sl@0	297
sl@0	298	/**
sl@0	299	@publishedAll
sl@0	300	@released
sl@0	301
sl@0	302	Symbolic definition for a false value.
sl@0	303	*/
sl@0	304	#define FALSE 0
sl@0	305	#ifndef NULL
sl@0	306
sl@0	307
sl@0	308
sl@0	309
sl@0	310	/**
sl@0	311	@publishedAll
sl@0	312	@released
sl@0	313
sl@0	314	Symbolic definition for a NULL value.
sl@0	315	*/
sl@0	316	#define NULL 0
sl@0	317	#endif
sl@0	318
sl@0	319
sl@0	320
sl@0	321
sl@0	322	#ifndef VA_START
sl@0	323	/**
sl@0	324	@publishedAll
sl@0	325	@released
sl@0	326
sl@0	327	A macro used by Symbian OS code for handling a variable argument list
sl@0	328	in a function call.
sl@0	329
sl@0	330	Sets a pointer to point to the first of the variable arguments.
sl@0	331
sl@0	332	Typical usage:
sl@0	333
sl@0	334	@code
sl@0	335	Foo(CAbcdef aAbcdef,...)
sl@0	336	{
sl@0	337	VA_LIST list;
sl@0	338	VA_START(list, aAbcdef);
sl@0	339	// other code
sl@0	340	}
sl@0	341	@endcode
sl@0	342
sl@0	343	@param ap A pointer used to hold the address of an argument in
sl@0	344	the variable argument list. After execution of the code generated
sl@0	345	by this macro, the pointer points to the first argument in
sl@0	346	the variable argument list.
sl@0	347	This symbol is usually declared as a VA_LIST type.
sl@0	348
sl@0	349	@param pn The argument that immediately precedes the variable argument list.
sl@0	350
sl@0	351	@see VA_LIST
sl@0	352	@see VA_ARG
sl@0	353	*/
sl@0	354	#define VA_START(ap,pn) ((ap)[0]=(TInt8 *)&pn+((sizeof(pn)+sizeof(TInt)-1)&~(sizeof(TInt)-1)),(void)0)
sl@0	355	#endif
sl@0	356
sl@0	357
sl@0	358
sl@0	359
sl@0	360	#ifndef VA_ARG
sl@0	361	/**
sl@0	362	@publishedAll
sl@0	363	@released
sl@0	364
sl@0	365	A macro used by Symbian OS code for handling a variable argument list
sl@0	366	in a function call.
sl@0	367
sl@0	368	Increments a pointer to a variable argument list to point to the next argument
sl@0	369	in the list. The current argument is assumed to be of a type defined by
sl@0	370	the second parameter to this macro.
sl@0	371
sl@0	372	Typical usage:
sl@0	373
sl@0	374	@code
sl@0	375	Foo(CAbcdef aAbcdef,...)
sl@0	376	{
sl@0	377	VA_LIST list;
sl@0	378	VA_START(list, aAbcdef);
sl@0	379	...
sl@0	380	TInt x = VA_ARG(list,TInt);
sl@0	381	...
sl@0	382	const TDesC pS=VA_ARG(aList,const TDesC);
sl@0	383	...
sl@0	384	etc
sl@0	385	}
sl@0	386	@endcode
sl@0	387
sl@0	388	@param ap A pointer used to hold the address of an argument in
sl@0	389	the variable argument list. It is assumed to point to the current
sl@0	390	argument in the variable argument list. After execution of the code
sl@0	391	generated by this macro, the pointer points to the next argument in
sl@0	392	the list. This symbol is usually declared as a VA_LIST type.
sl@0	393
sl@0	394	@param type The type of the current argument.
sl@0	395	This can be any valid type, for example, TInt, const TDesC*, etc.
sl@0	396
sl@0	397	@see VA_LIST
sl@0	398	@see VA_START
sl@0	399	*/
sl@0	400	#define VA_ARG(ap,type) ((ap)[0]+=((sizeof(type)+sizeof(TInt)-1)&~(sizeof(TInt)-1)),((type )((ap)[0]-((sizeof(type)+sizeof(TInt)-1)&~(sizeof(TInt)-1)))))
sl@0	401	#endif
sl@0	402
sl@0	403
sl@0	404
sl@0	405
sl@0	406	#ifndef VA_END
sl@0	407	/**
sl@0	408	@publishedAll
sl@0	409	@released
sl@0	410
sl@0	411	A macro used by Symbian OS code for handling a variable argument list
sl@0	412	in a function call.
sl@0	413
sl@0	414	Sets a pointer to zero.
sl@0	415
sl@0	416	@param ap A pointer used to hold the address of an argument in
sl@0	417	the variable argument list. After execution of the code generated
sl@0	418	by this macro, the pointer is reset to 0.
sl@0	419	This symbol is usually declared as a VA_LIST type.
sl@0	420
sl@0	421	@see VA_LIST
sl@0	422	@see VA_START
sl@0	423	@see VA_ARG
sl@0	424	*/
sl@0	425	#define VA_END(ap) ((ap)[0]=0,(void)0)
sl@0	426	#endif
sl@0	427
sl@0	428
sl@0	429
sl@0	430	/**
sl@0	431	@publishedAll
sl@0	432	@released
sl@0	433
sl@0	434	Calculates the offset of member f within class c.
sl@0	435
sl@0	436	This is used in the TSglQue and TDblQue constructors to set the offset of
sl@0	437	the link object from the start of a list element.
sl@0	438
sl@0	439	@param c The name of the class.
sl@0	440	@param f The name of the member within the specified class.
sl@0	441
sl@0	442	@see TSglQue
sl@0	443	@see TDblQue
sl@0	444	*/
sl@0	445	#ifndef _FOFF
sl@0	446	#if __GNUC__ < 4
sl@0	447	#define _FOFF(c,f) (((TInt)&(((c *)0x1000)->f))-0x1000)
sl@0	448	#else
sl@0	449	#define _FOFF(c,f) __builtin_offsetof(c,f)
sl@0	450	#endif
sl@0	451	#endif
sl@0	452
sl@0	453
sl@0	454
sl@0	455	/**
sl@0	456	@internalTechnology
sl@0	457	@released
sl@0	458	*/
sl@0	459	#define _ALIGN_DOWN(x,a) ((x)&~((a)-1))
sl@0	460	/**
sl@0	461	@internalTechnology
sl@0	462	@released
sl@0	463	*/
sl@0	464	#define _ALIGN_UP(x,a) _ALIGN_DOWN((x)+(a)-1, a)
sl@0	465
sl@0	466
sl@0	467
sl@0	468
sl@0	469	/**
sl@0	470	@publishedAll
sl@0	471	@released
sl@0	472
sl@0	473	Pointer to any type.
sl@0	474
sl@0	475	TAny* is equivalent to void* in standard C or C++. TAny* is used in preference
sl@0	476	to void* because it is more suggestive of the actual meaning,
sl@0	477	e.g. TAny* foo();.
sl@0	478
sl@0	479	TAny is not used where it really means "nothing", as in the declaration of
sl@0	480	functions which do not return a value; void is used instead, e.g. void Foo();.
sl@0	481	*/
sl@0	482	typedef void TAny;
sl@0	483
sl@0	484
sl@0	485
sl@0	486
sl@0	487	/**
sl@0	488	@publishedAll
sl@0	489	@released
sl@0	490
sl@0	491	8-bit signed integer type, used in Symbian OS to mean an 8-bit
sl@0	492	signed integer, independent of the implementation.
sl@0	493	*/
sl@0	494	typedef signed char TInt8;
sl@0	495
sl@0	496
sl@0	497
sl@0	498
sl@0	499	/**
sl@0	500	@publishedAll
sl@0	501	@released
sl@0	502
sl@0	503	8-bit unsigned integer type; used in Symbian OS to mean an 8-bit
sl@0	504	unsigned integer, independent of the implementation.
sl@0	505	*/
sl@0	506	typedef unsigned char TUint8;
sl@0	507
sl@0	508
sl@0	509
sl@0	510
sl@0	511	/**
sl@0	512	@publishedAll
sl@0	513	@released
sl@0	514
sl@0	515	16-bit signed integer type, used in Symbian OS to mean a 16-bit
sl@0	516	signed integer, independent of the implementation.
sl@0	517	*/
sl@0	518	typedef short int TInt16;
sl@0	519
sl@0	520
sl@0	521
sl@0	522
sl@0	523	/**
sl@0	524	@publishedAll
sl@0	525	@released
sl@0	526
sl@0	527	16-bit unsigned integer type. used in Symbian OS to mean a 16-bit
sl@0	528	unsigned integer, independent of the implementation.
sl@0	529	*/
sl@0	530	typedef unsigned short int TUint16;
sl@0	531
sl@0	532
sl@0	533
sl@0	534
sl@0	535	/**
sl@0	536	@publishedAll
sl@0	537	@released
sl@0	538
sl@0	539	32-bit signed integer type, used in Symbian OS to mean a 32-bit
sl@0	540	signed integer, independent of the implementation.
sl@0	541	*/
sl@0	542	typedef long int TInt32;
sl@0	543
sl@0	544
sl@0	545
sl@0	546
sl@0	547	/**
sl@0	548	@publishedAll
sl@0	549	@released
sl@0	550
sl@0	551	A signed integer type of the same size as a pointer.
sl@0	552	*/
sl@0	553	typedef TInt32 T_IntPtr;
sl@0	554	typedef TInt32 TIntPtr;
sl@0	555
sl@0	556
sl@0	557
sl@0	558
sl@0	559	/**
sl@0	560	@publishedAll
sl@0	561	@released
sl@0	562
sl@0	563	32-bit unsigned integer type; used in Symbian OS to mean a 32-bit
sl@0	564	unsigned integer, independent of the implementation.
sl@0	565	*/
sl@0	566	typedef unsigned long int TUint32;
sl@0	567
sl@0	568
sl@0	569
sl@0	570
sl@0	571	/**
sl@0	572	@publishedAll
sl@0	573	@released
sl@0	574
sl@0	575	An unsigned integer type of the same size as a pointer.
sl@0	576	*/
sl@0	577	typedef TUint32 T_UintPtr;
sl@0	578	typedef TUint32 TUintPtr;
sl@0	579
sl@0	580
sl@0	581
sl@0	582
sl@0	583	/**
sl@0	584	@publishedAll
sl@0	585	@released
sl@0	586
sl@0	587	Signed integer type of the natural machine word length.
sl@0	588
sl@0	589	This is as defined by the C++ implementation's int type. In all
sl@0	590	implementations, this is guaranteed to be at least 32 bits.
sl@0	591
sl@0	592	A TInt should be used in preference to a sized integer (TInt32, TInt16) for
sl@0	593	all general use. Sized integers should only be used when packing is essential.
sl@0	594	C++'s type conversion rules imply that all sized integers smaller than the
sl@0	595	natural machine word are in any case broadened to the natural machine word
sl@0	596	size when passed as function parameters.
sl@0	597
sl@0	598	A TInt should be used in preference to an unsigned integer (TUint) for all
sl@0	599	general use. Unsigned integers should only be used for flags (which use Boolean
sl@0	600	operations but not arithmetic) and, in very rare cases, for numbers whose
sl@0	601	range exceeds that available from signed integers. Although it is natural
sl@0	602	to attempt to use unsigned integers for quantities which cannot by nature
sl@0	603	be negative, the C++ language does not provide the support necessary to enforce
sl@0	604	the "expected" behaviour in these circumstances, and experience has shown
sl@0	605	that it is better to use signed integers unless there is good reason not to.
sl@0	606
sl@0	607	@see TUint
sl@0	608	@see TInt32
sl@0	609	@see TInt16
sl@0	610	*/
sl@0	611	typedef signed int TInt;
sl@0	612
sl@0	613
sl@0	614
sl@0	615
sl@0	616	/**
sl@0	617	@publishedAll
sl@0	618	@released
sl@0	619
sl@0	620	Unsigned integer type of the natural machine word length.
sl@0	621
sl@0	622	This is guaranteed to be at least 32 bits in all implementations.
sl@0	623
sl@0	624	In almost all circumstances, a TInt should be used in preference to a TUint.
sl@0	625	The main exception is in flags bytes.
sl@0	626
sl@0	627	@see TInt
sl@0	628	*/
sl@0	629	typedef unsigned int TUint;
sl@0	630
sl@0	631
sl@0	632
sl@0	633
sl@0	634	/**
sl@0	635	@publishedAll
sl@0	636	@released
sl@0	637
sl@0	638	32-bit floating point number, providing IEEE754 single precision on all Symbian
sl@0	639	OS implementations.
sl@0	640
sl@0	641	TReal should normally be used in preference to TReal32.
sl@0	642
sl@0	643	Use of floating-point numbers should generally be avoided unless a natural
sl@0	644	part of the problem specification. Most Symbian OS implementations do not
sl@0	645	have a hardware floating point unit: as a result, their floating-point performance
sl@0	646	is hundreds of times slower than integer performance.
sl@0	647	*/
sl@0	648	typedef float TReal32;
sl@0	649
sl@0	650
sl@0	651
sl@0	652
sl@0	653	/**
sl@0	654	@publishedAll
sl@0	655	@released
sl@0	656
sl@0	657	64-bit floating point number, providing IEEE754 double precision on all Symbian
sl@0	658	OS implementations.
sl@0	659
sl@0	660	Use of floating-point numbers should generally be avoided unless a natural
sl@0	661	part of the problem specification. Most Symbian OS implementations do not
sl@0	662	have a hardware floating point unit: as a result, their floating-point performance
sl@0	663	is hundreds of times slower than integer performance.
sl@0	664
sl@0	665	This type is identical to TReal.
sl@0	666
sl@0	667	@see TReal
sl@0	668	*/
sl@0	669	typedef double TReal64;
sl@0	670
sl@0	671
sl@0	672
sl@0	673
sl@0	674	/**
sl@0	675	@publishedAll
sl@0	676	@released
sl@0	677
sl@0	678	64-bit floating point number; identical to TReal64.
sl@0	679
sl@0	680	Use of floating-point numbers should generally be avoided unless a natural
sl@0	681	part of the problem specification. Most Symbian OS implementations do not
sl@0	682	have a hardware floating point unit: as a result, their floating-point performance
sl@0	683	is hundreds of times slower than integer performance.
sl@0	684
sl@0	685	Most serious floating-point calculations require double-precision. All standard
sl@0	686	math functions (see Math class) take double-precision arguments. Single-precision
sl@0	687	should only be used where space and performance are at a premium, and when
sl@0	688	their limited precision is acceptable.
sl@0	689
sl@0	690	@see TReal64
sl@0	691	@see Math
sl@0	692	*/
sl@0	693	typedef double TReal;
sl@0	694
sl@0	695
sl@0	696
sl@0	697
sl@0	698	/**
sl@0	699	@publishedAll
sl@0	700	@released
sl@0	701
sl@0	702	8-bit unsigned character.
sl@0	703
sl@0	704	Use instead of C++ built-in char type because it is guaranteed to be unsigned.
sl@0	705	Use instead of TInt8 where the application is really for text rather than
sl@0	706	8-bit arithmetic or binary quantities.
sl@0	707
sl@0	708	For most purposes, you should use TText rather than TText8. TText is mapped
sl@0	709	onto either TText8 or TText16 depending on whether a non-Unicode or Unicode
sl@0	710	variant is being built. Use TText8 only when you are dealing explicitly with
sl@0	711	8-bit text, regardless of build.
sl@0	712
sl@0	713	@see TText */
sl@0	714	typedef unsigned char TText8;
sl@0	715
sl@0	716
sl@0	717
sl@0	718
sl@0	719	/**
sl@0	720	@publishedAll
sl@0	721	@released
sl@0	722
sl@0	723	16-bit unsigned character.
sl@0	724
sl@0	725	Use instead of C++ wchar_t type because it is guaranteed to be unsigned. Use
sl@0	726	instead of TInt16 where the application is really for text rather than 8-bit
sl@0	727	arithmetic or binary quantities.
sl@0	728
sl@0	729	For most purposes, you should use TText rather than TText16. TText is mapped
sl@0	730	onto either TText8 or TText16 depending on whether a non-Unicode or Unicode
sl@0	731	variant is being built. Use TText16 only when you are dealing explicitly with
sl@0	732	16-bit text, regardless of build.
sl@0	733
sl@0	734	@see TText
sl@0	735	*/
sl@0	736	typedef unsigned short int TText16;
sl@0	737
sl@0	738
sl@0	739
sl@0	740
sl@0	741	/**
sl@0	742	@publishedAll
sl@0	743	@released
sl@0	744
sl@0	745	Boolean type which takes the value either ETrue or EFalse.
sl@0	746
sl@0	747	Although only a single bit would theoretically be necessary to represent a
sl@0	748	Boolean, a machine word is used instead, so that these quantities can be easily
sl@0	749	passed. Also, TBool must map onto int because of C++'s interpretation of
sl@0	750	operands in conditional expressions.
sl@0	751	*/
sl@0	752	typedef int TBool;
sl@0	753
sl@0	754
sl@0	755
sl@0	756
sl@0	757	/**
sl@0	758	@publishedPartner
sl@0	759	@released
sl@0	760
sl@0	761	Defines a linear (virtual) address type.
sl@0	762	*/
sl@0	763	typedef T_UintPtr TLinAddr;
sl@0	764
sl@0	765
sl@0	766
sl@0	767	#if defined(__GCC32__)
sl@0	768
sl@0	769
sl@0	770
sl@0	771
sl@0	772	/**
sl@0	773	@publishedAll
sl@0	774	@released
sl@0	775
sl@0	776	Defines a 64-bit signed integer type.
sl@0	777	*/
sl@0	778	typedef long long Int64;
sl@0	779
sl@0	780
sl@0	781
sl@0	782
sl@0	783	/**
sl@0	784	@publishedAll
sl@0	785	@released
sl@0	786
sl@0	787	Defines a 64-bit unsigned integer type.
sl@0	788	*/
sl@0	789	typedef unsigned long long Uint64;
sl@0	790
sl@0	791
sl@0	792
sl@0	793
sl@0	794	/**
sl@0	795	@publishedAll
sl@0	796	@released
sl@0	797	*/
sl@0	798	#define I64LIT(x) x##LL
sl@0	799	/**
sl@0	800	@publishedAll
sl@0	801	@released
sl@0	802	*/
sl@0	803	#define UI64LIT(x) x##ULL
sl@0	804
sl@0	805	#elif defined(__VC32__)
sl@0	806	typedef __int64 Int64;
sl@0	807	typedef unsigned __int64 Uint64;
sl@0	808	#define I64LIT(x) (__int64)##x
sl@0	809	#define UI64LIT(x) (unsigned __int64)##x
sl@0	810
sl@0	811	#elif defined(__CW32__)
sl@0	812	#pragma longlong on
sl@0	813	typedef long long Int64;
sl@0	814	typedef unsigned long long Uint64;
sl@0	815	#define I64LIT(x) x##LL
sl@0	816	#define UI64LIT(x) x##ULL
sl@0	817	#endif
sl@0	818
sl@0	819
sl@0	820
sl@0	821
sl@0	822	/**
sl@0	823	@publishedAll
sl@0	824	@released
sl@0	825
sl@0	826	Defines a 64-bit signed integer type.
sl@0	827
sl@0	828	NOTE: For those migrating from versions of Symbian OS before 8.1b (i.e. 8.1a, 7.0s etc)
sl@0	829	TInt64 is now defined as a built-in type instead of as a class type. This means
sl@0	830	that the member functions of the old TInt64 class are no longer exported
sl@0	831	from EUSER.LIB, and represents a compatibility break.
sl@0	832
sl@0	833	To ease migration of source code, a number of macros are provided. Similar
sl@0	834	macros have also been defined in Symbian OS versions 7.0s and 8.1a, but
sl@0	835	implemented in terms of the old TInt64 class. This is important for code that
sl@0	836	is common to : one or both of these Symbian OS versions, and to 8.1b and
sl@0	837	subsequent versions.
sl@0	838
sl@0	839	The following list shows the new macros and the functions that they replace.
sl@0	840	It also shows some alternative techniques.
sl@0	841	In this list: x, v and r are declared as TInt64, c is declared as TInt, High
sl@0	842	and Low are declared as TUint.
sl@0	843
sl@0	844	@code
sl@0	845	OLD USAGE REPLACEMENT
sl@0	846
sl@0	847	TInt64(High,Low); MAKE_TINT64(High,Low);
sl@0	848	x.Set(High,Low); MAKE_TINT64(High,Low);
sl@0	849	x.Low(); I64LOW(x);
sl@0	850	x.High(); I64HIGH(x);
sl@0	851	x.GetTInt(); I64INT(x);
sl@0	852	x.GetTReal(); I64REAL(x);
sl@0	853	x.Lsr(c); I64LSR(x,c);
sl@0	854	x.Mul10(); x*=10;
sl@0	855	x.MulTop(a); I64MULTOP(x,a);
sl@0	856	x.DivMod(v,r); r=x%v; x/=v;
sl@0	857	@endcode
sl@0	858	*/
sl@0	859	typedef Int64 TInt64;
sl@0	860
sl@0	861
sl@0	862
sl@0	863
sl@0	864	/**
sl@0	865	@publishedAll
sl@0	866	@released
sl@0	867
sl@0	868	Defines a 64-bit unsigned integer type.
sl@0	869	*/
sl@0	870	typedef Uint64 TUint64;
sl@0	871
sl@0	872
sl@0	873
sl@0	874
sl@0	875	/** @internalComponent */
sl@0	876	#define _MAKE_TINT64_ZX(x) ((TInt64)((TUint32)(x)))
sl@0	877
sl@0	878	/** @internalComponent */
sl@0	879	#define _MAKE_TUINT64_ZX(x) ((TUint64)((TUint32)(x)))
sl@0	880
sl@0	881
sl@0	882
sl@0	883
sl@0	884	/**
sl@0	885	@publishedAll
sl@0	886	@released
sl@0	887	*/
sl@0	888	#define MAKE_TINT64(h,l) ( (_MAKE_TINT64_ZX(h)<<32) \| _MAKE_TINT64_ZX(l) )
sl@0	889
sl@0	890
sl@0	891
sl@0	892
sl@0	893	/**
sl@0	894	@publishedAll
sl@0	895	@released
sl@0	896	*/
sl@0	897	#define MAKE_TUINT64(h,l) ( (_MAKE_TUINT64_ZX(h)<<32) \| _MAKE_TUINT64_ZX(l) )
sl@0	898
sl@0	899
sl@0	900
sl@0	901
sl@0	902	/**
sl@0	903	@publishedAll
sl@0	904	@released
sl@0	905
sl@0	906	Generates code to access the high order 32 bits of a 64 bit number.
sl@0	907	*/
sl@0	908	#define I64HIGH(x) ( (TUint32)((x)>>32) )
sl@0	909
sl@0	910
sl@0	911
sl@0	912
sl@0	913	/**
sl@0	914	@publishedAll
sl@0	915	@released
sl@0	916
sl@0	917	Generates code to access the low order 32 bits of a 64 bit number.
sl@0	918	*/
sl@0	919	#define I64LOW(x) ( (TUint32)(x) )
sl@0	920
sl@0	921
sl@0	922
sl@0	923
sl@0	924	/**
sl@0	925	@publishedAll
sl@0	926	@released
sl@0	927
sl@0	928	Generates code to cast a 64 bit value as an signed integer.
sl@0	929	*/
sl@0	930	#define I64INT(x) ( (TInt)(x) )
sl@0	931
sl@0	932
sl@0	933
sl@0	934
sl@0	935	/**
sl@0	936	@publishedAll
sl@0	937	@released
sl@0	938
sl@0	939	Generates code to cast a 64 bit value as a TReal type.
sl@0	940	*/
sl@0	941	#define I64REAL(x) ( (TReal)(x) )
sl@0	942
sl@0	943
sl@0	944
sl@0	945
sl@0	946	/**
sl@0	947	@publishedAll
sl@0	948	@released
sl@0	949
sl@0	950	Generates code to logically shift a 64 bit integer right.
sl@0	951	*/
sl@0	952	#define I64LSR(x, shift) ( reinterpret_cast<TUint64>(&(x)) >>= (shift) )
sl@0	953
sl@0	954
sl@0	955
sl@0	956	/**
sl@0	957	@publishedAll
sl@0	958	@released
sl@0	959
sl@0	960	Generates code to multiply a 64 bit integer by 10.
sl@0	961	*/
sl@0	962	#define I64MUL10(x) ( (x) *= 10 )
sl@0	963
sl@0	964
sl@0	965
sl@0	966	/**
sl@0	967	@publishedAll
sl@0	968	@released
sl@0	969
sl@0	970	Generates code to divide a 64 bit integer by another and find the remainder.
sl@0	971	*/
sl@0	972	#define I64DIVMOD(x, divisor, remainder) ( ((remainder) = (x) % (divisor), (x) /= (divisor)) )
sl@0	973
sl@0	974
sl@0	975
sl@0	976
sl@0	977	/**
sl@0	978	@publishedAll
sl@0	979	@released
sl@0	980
sl@0	981	Generates code to cast a double to a 64 bit integer.
sl@0	982	*/
sl@0	983	#define I64DOUBLECAST(x) ( static_cast<TInt64>(x) )
sl@0	984
sl@0	985
sl@0	986
sl@0	987
sl@0	988	/**
sl@0	989	@publishedAll
sl@0	990	@deprecated Use _LIT8 instead.
sl@0	991
sl@0	992	8-bit literal.
sl@0	993
sl@0	994	The macro defines an explicit 8-bit constant literal which is suitable
sl@0	995	for non-Unicode literal text, regardless of the build.
sl@0	996
sl@0	997	@see _L
sl@0	998	@see _LIT8
sl@0	999	@see _LIT
sl@0	1000	*/
sl@0	1001	#define _L8(a) (TPtrC8((const TText8 *)(a)))
sl@0	1002
sl@0	1003
sl@0	1004
sl@0	1005
sl@0	1006	/**
sl@0	1007	@publishedAll
sl@0	1008	@released
sl@0	1009
sl@0	1010	Defines an explicit 8-bit string which is suitable when non-Unicode text
sl@0	1011	is required, regardless of the build.
sl@0	1012
sl@0	1013	This is used by the deprecated literal descriptor _L8.
sl@0	1014	*/
sl@0	1015	#define _S8(a) ((const TText8 *)a)
sl@0	1016
sl@0	1017
sl@0	1018
sl@0	1019
sl@0	1020	/**
sl@0	1021	@publishedAll
sl@0	1022	@released
sl@0	1023
sl@0	1024	Constructs a constant literal descriptor of type TLitC8<TInt> with
sl@0	1025	the specified name and text.
sl@0	1026
sl@0	1027	The 8-bit build variant is generated for both non-Unicode and Unicode builds.
sl@0	1028
sl@0	1029	@param name The name of the C++ variable to be generated.
sl@0	1030	@param s The literal text enclosed within a pair of double quotes.
sl@0	1031
sl@0	1032	@see _LIT
sl@0	1033	*/
sl@0	1034	#define _LIT8(name,s) const static TLitC8<sizeof(s)> name={sizeof(s)-1,s}
sl@0	1035
sl@0	1036
sl@0	1037
sl@0	1038
sl@0	1039	/**
sl@0	1040	@publishedAll
sl@0	1041	@deprecated Use _LIT16 instead.
sl@0	1042
sl@0	1043	16-bit literal.
sl@0	1044
sl@0	1045	The macro defines an explicit 16-bit constant literal which is suitable
sl@0	1046	for Unicode literal text, regardless of the build.
sl@0	1047
sl@0	1048	@see _L
sl@0	1049	@see _LIT16
sl@0	1050	@see _LIT
sl@0	1051	*/
sl@0	1052	#define _L16(a) (TPtrC16((const TText16 *)L ## a))
sl@0	1053
sl@0	1054
sl@0	1055
sl@0	1056	/**
sl@0	1057	@publishedAll
sl@0	1058	@released
sl@0	1059
sl@0	1060	Defines an explicit 16-bit string which is suitable when Unicode text
sl@0	1061	is required, regardless of the build.
sl@0	1062
sl@0	1063	This is used by the deprecated literal descriptor _L16.
sl@0	1064	*/
sl@0	1065	#define _S16(a) ((const TText16 *)L ## a)
sl@0	1066
sl@0	1067
sl@0	1068
sl@0	1069
sl@0	1070	/**
sl@0	1071	@publishedAll
sl@0	1072	@released
sl@0	1073
sl@0	1074	Constructs a constant literal descriptor of type TLitC16<TInt> with
sl@0	1075	the specified name and text.
sl@0	1076
sl@0	1077	The 16-bit build variant is generated for both non-Unicode and Unicode builds.
sl@0	1078
sl@0	1079	@param name The name of the C++ variable to be generated.
sl@0	1080	@param s The literal text enclosed within a pair of double quotes.
sl@0	1081
sl@0	1082	@see _LIT
sl@0	1083	*/
sl@0	1084	#define _LIT16(name,s) const static TLitC16<sizeof(L##s)/2> name={sizeof(L##s)/2-1,L##s}
sl@0	1085
sl@0	1086
sl@0	1087
sl@0	1088
sl@0	1089	#if defined(_UNICODE) && !defined(__KERNEL_MODE__)
sl@0	1090	/**
sl@0	1091	@publishedAll
sl@0	1092	@released
sl@0	1093
sl@0	1094	Build independent general text character.
sl@0	1095
sl@0	1096	In non-Unicode builds, this is mapped to TText8. In Unicode builds, this is
sl@0	1097	mapped to TText16. Use the classes with explicit width only when you wish
sl@0	1098	the width to be independent of the build variant.
sl@0	1099
sl@0	1100	Use this class rather than TChar for general use.
sl@0	1101	*/
sl@0	1102	typedef TText16 TText;
sl@0	1103
sl@0	1104
sl@0	1105
sl@0	1106	/**
sl@0	1107	@publishedAll
sl@0	1108	@deprecated Use _LIT instead.
sl@0	1109
sl@0	1110	Build independent literal.
sl@0	1111
sl@0	1112	The macro defines either an 8-bit constant literal (for non-Unicode text),
sl@0	1113	or a 16-bit constant literal (for Unicode text) depending on the build.
sl@0	1114
sl@0	1115	@see _LIT
sl@0	1116	@see _L16
sl@0	1117	@see _L8
sl@0	1118	*/
sl@0	1119	#define _L(a) (TPtrC((const TText *)L ## a))
sl@0	1120
sl@0	1121
sl@0	1122
sl@0	1123
sl@0	1124	/**
sl@0	1125	@publishedAll
sl@0	1126	@released
sl@0	1127
sl@0	1128	Defines either an 8-bit string (for non-Unicode text),
sl@0	1129	or a 16-bit string (for Unicode text) depending on the build.
sl@0	1130
sl@0	1131	This is used by the deprecated build independent literal _L.
sl@0	1132	*/
sl@0	1133	#define _S(a) ((const TText *)L ## a)
sl@0	1134
sl@0	1135
sl@0	1136
sl@0	1137
sl@0	1138	/**
sl@0	1139	@publishedAll
sl@0	1140	@released
sl@0	1141
sl@0	1142	Constructs a build independent constant literal descriptor of type TLitC<TInt>
sl@0	1143	with the specified name and text.
sl@0	1144
sl@0	1145	An 8-bit build variant is generated for a non-Unicode build;
sl@0	1146	A 16-bit build variant is generated for a Unicode build.
sl@0	1147
sl@0	1148	@param name The name of the C++ variable to be generated.
sl@0	1149	@param s The literal text enclosed within a pair of double quotes.
sl@0	1150
sl@0	1151	@see _LIT16
sl@0	1152	@see _LIT8
sl@0	1153	*/
sl@0	1154	#define _LIT(name,s) const static TLitC<sizeof(L##s)/2> name={sizeof(L##s)/2-1,L##s}
sl@0	1155
sl@0	1156
sl@0	1157
sl@0	1158
sl@0	1159	#else
sl@0	1160	/**
sl@0	1161	@publishedAll
sl@0	1162	@released
sl@0	1163
sl@0	1164	Build independent general text character.
sl@0	1165
sl@0	1166	In non-Unicode builds, this is mapped to TText8. In Unicode builds, this is
sl@0	1167	mapped to TText16. Use the classes with explicit width only when you wish
sl@0	1168	the width to be independent of the build variant.
sl@0	1169
sl@0	1170	Use this class rather than TChar for general use.
sl@0	1171	*/
sl@0	1172	typedef TText8 TText;
sl@0	1173
sl@0	1174
sl@0	1175
sl@0	1176	/**
sl@0	1177	@publishedAll
sl@0	1178	@released
sl@0	1179
sl@0	1180	@deprecated Use _LIT instead.
sl@0	1181
sl@0	1182	Build independent literal.
sl@0	1183
sl@0	1184	The macro defines either an 8-bit constant literal (for non-Unicode text),
sl@0	1185	or a 16-bit constant literal (for Unicode text) depending on the build.
sl@0	1186
sl@0	1187	@see _LIT
sl@0	1188	@see _L16
sl@0	1189	@see _L8
sl@0	1190	*/
sl@0	1191	#define _L(a) (TPtrC((const TText *)(a)))
sl@0	1192
sl@0	1193
sl@0	1194
sl@0	1195
sl@0	1196	/**
sl@0	1197	@publishedAll
sl@0	1198	@released
sl@0	1199
sl@0	1200	Defines either an 8-bit string (for non-Unicode text),
sl@0	1201	or a 16-bit string (for Unicode text) depending on the build.
sl@0	1202
sl@0	1203	This is used by the deprecated build independent literal _L.
sl@0	1204	*/
sl@0	1205	#define _S(a) ((const TText *)a)
sl@0	1206
sl@0	1207
sl@0	1208
sl@0	1209
sl@0	1210	/**
sl@0	1211	@publishedAll
sl@0	1212	@released
sl@0	1213
sl@0	1214	Constructs a build independent constant literal descriptor of type TLitC<TInt>
sl@0	1215	with the specified name and text.
sl@0	1216
sl@0	1217	An 8-bit build variant is generated for a non-Unicode build;
sl@0	1218	A 16-bit build variant is generated for a Unicode build.
sl@0	1219
sl@0	1220	@param name The name of the C++ variable to be generated.
sl@0	1221	@param s The literal text enclosed within a pair of double quotes.
sl@0	1222
sl@0	1223	@see _LIT16
sl@0	1224	@see _LIT8
sl@0	1225	*/
sl@0	1226	#define _LIT(name,s) const static TLitC<sizeof(s)> name={sizeof(s)-1,s}
sl@0	1227	#endif
sl@0	1228
sl@0	1229
sl@0	1230
sl@0	1231
sl@0	1232	#ifndef __VA_LIST_defined
sl@0	1233	/**
sl@0	1234	@publishedAll
sl@0	1235	@released
sl@0	1236
sl@0	1237	Defines a 'C' style array of pointers to TInt8 types.
sl@0	1238
sl@0	1239	The type is most commonly used by code that needs to deal with a variable
sl@0	1240	number of arguments passed to a function.
sl@0	1241
sl@0	1242	@see TInt8
sl@0	1243	*/
sl@0	1244	typedef TInt8 *VA_LIST[1];
sl@0	1245	#endif
sl@0	1246
sl@0	1247	/**
sl@0	1248	@publishedAll
sl@0	1249	@released
sl@0	1250
sl@0	1251	Asserts that a condition is true.
sl@0	1252
sl@0	1253	Code is generated for all builds.
sl@0	1254
sl@0	1255	This macro is used as a C++ statement to assert the truth of some condition,
sl@0	1256	and to take appropriate action if the condition is false. Unlike __ASSERT_DEBUG
sl@0	1257	it is defined in both release and debug builds.
sl@0	1258
sl@0	1259	The most common use for this macro is to check that the external environment of
sl@0	1260	a function or class is behaving as expected; for example, that parameters
sl@0	1261	passed to a function are credible, or that called functions are behaving as
sl@0	1262	expected; the macro is commonly placed at the beginning of a function.
sl@0	1263
sl@0	1264	The effect of the macro is to generate code which tests
sl@0	1265	the conditional expression c; if the expression is false, then
sl@0	1266	function p is called. In the majority of cases, the function p is one that
sl@0	1267	raises a panic.
sl@0	1268
sl@0	1269	Note that the macro definition is, in effect, equivalent to:
sl@0	1270
sl@0	1271	@code
sl@0	1272	if !(c)p;
sl@0	1273	@endcode
sl@0	1274
sl@0	1275	@param c a conditional expression which results in true or false.
sl@0	1276	@param p a function which is called if the conditional expression c is false.
sl@0	1277
sl@0	1278	@see __ASSERT_DEBUG
sl@0	1279	*/
sl@0	1280	#define __ASSERT_ALWAYS(c,p) (void)((c)\|\|(p,0))
sl@0	1281
sl@0	1282
sl@0	1283
sl@0	1284	#ifdef __WINS__
sl@0	1285	#ifdef __CW32__
sl@0	1286	/**
sl@0	1287	@internalAll
sl@0	1288	@released
sl@0	1289	*/
sl@0	1290	#define __BREAKPOINT() \
sl@0	1291	{ \
sl@0	1292	__asm { byte 0xcc }; \
sl@0	1293	}
sl@0	1294	#else // !__CW32__
sl@0	1295	/**
sl@0	1296	@internalAll
sl@0	1297	@released
sl@0	1298	*/
sl@0	1299	#define __BREAKPOINT() \
sl@0	1300	{ \
sl@0	1301	__asm { int 3 }; \
sl@0	1302	}
sl@0	1303	#endif //__CW32__
sl@0	1304	#else
sl@0	1305	/**
sl@0	1306	@internalAll
sl@0	1307	@released
sl@0	1308	*/
sl@0	1309	#define __BREAKPOINT()
sl@0	1310	#endif
sl@0	1311
sl@0	1312	#if defined(_DEBUG)
sl@0	1313
sl@0	1314
sl@0	1315	/**
sl@0	1316	@publishedAll
sl@0	1317	@released
sl@0	1318
sl@0	1319	Asserts that a condition is true.
sl@0	1320
sl@0	1321	Code is generated for debug builds only.
sl@0	1322
sl@0	1323	This macro is used as a C++ statement to assert the truth of some condition,
sl@0	1324	and to take appropriate action if the condition is false. It is used in
sl@0	1325	the same way as __ASSERT_ALWAYS, except that it is only defined for debug builds.
sl@0	1326
sl@0	1327	The macro may be used to insert extra checks at various points in source code
sl@0	1328	as desired; the code will only be generated in debug builds and not in release
sl@0	1329	builds.
sl@0	1330
sl@0	1331	@param c A conditional expression which results in true or false.
sl@0	1332	@param p A function which is called if the conditional expression c is false.
sl@0	1333
sl@0	1334	@see __ASSERT_ALWAYS
sl@0	1335	*/
sl@0	1336	#define __ASSERT_DEBUG(c,p) (void)((c)\|\|(p,0))
sl@0	1337
sl@0	1338
sl@0	1339
sl@0	1340	/**
sl@0	1341	@internalAll
sl@0	1342	@removed
sl@0	1343	*/
sl@0	1344	#define __DECLARE_NAME(t)
sl@0	1345
sl@0	1346
sl@0	1347
sl@0	1348
sl@0	1349	/**
sl@0	1350	@publishedAll
sl@0	1351	@released
sl@0	1352
sl@0	1353	Calls the function for testing object invariance.
sl@0	1354
sl@0	1355	Classes can define a standard member function __DbgTestInvariant(),
sl@0	1356	which checks that the object is in a valid state, and panics if it is not.
sl@0	1357	In debug builds, this macro simply expands to call that function. For details on how
sl@0	1358	to define __DbgTestInvariant(), and an example of its use, see __DECLARE_TEST.
sl@0	1359
sl@0	1360	The macro is typically invoked at the beginning of all the member functions of
sl@0	1361	the class. For non-const functions (those which can change the object’s state),
sl@0	1362	you can ensure that the object has been left in a stable state by invoking
sl@0	1363	the macro at the end of the function.
sl@0	1364
sl@0	1365	In release builds, no code is generated for the macro.
sl@0	1366	*/
sl@0	1367	#define __TEST_INVARIANT __DbgTestInvariant()
sl@0	1368
sl@0	1369
sl@0	1370
sl@0	1371
sl@0	1372	/**
sl@0	1373	@publishedAll
sl@0	1374	@released
sl@0	1375
sl@0	1376	Marks the start of checking the current thread's heap.
sl@0	1377
sl@0	1378	This macro is defined only for debug builds.
sl@0	1379
sl@0	1380	This macro must be matched by a corresponding call to __UHEAP_MARKEND or __UHEAP_MARKENDC.
sl@0	1381
sl@0	1382	Calls to this macro can be nested but each call must be matched by corresponding
sl@0	1383	call to __UHEAP_MARKEND or __UHEAP_MARKENDC.
sl@0	1384
sl@0	1385	@see User::__DbgMarkStart()
sl@0	1386	@see __UHEAP_MARKEND
sl@0	1387	@see __UHEAP_MARKENDC
sl@0	1388	*/
sl@0	1389	#define __UHEAP_MARK User::__DbgMarkStart(FALSE)
sl@0	1390
sl@0	1391
sl@0	1392
sl@0	1393
sl@0	1394	/**
sl@0	1395	@publishedAll
sl@0	1396	@released
sl@0	1397
sl@0	1398	Checks that the number of allocated cells at the current nested level on the
sl@0	1399	current thread's heap is the same as the specified value.
sl@0	1400
sl@0	1401	This macro is defined only for debug builds.
sl@0	1402
sl@0	1403	The macro also takes the name of the file containing this source code statement
sl@0	1404	and the line number of this source code statement; they are displayed as part
sl@0	1405	of the panic category, if the checks fail.
sl@0	1406
sl@0	1407	The macro assumes that:
sl@0	1408
sl@0	1409	1. the heap being checked is a user heap
sl@0	1410
sl@0	1411	2. checking is being done for the number of allocated cells at the current nested
sl@0	1412	level; i.e. that aCountAll is set to false
sl@0	1413
sl@0	1414	3. the line number is the line number of this source code statement.
sl@0	1415
sl@0	1416	4. the file name is the full path name of the file containing this source statement
sl@0	1417
sl@0	1418	@param aCount The number of heap cells expected to be allocated at
sl@0	1419	the current nest level.
sl@0	1420
sl@0	1421	@see User::__DbgMarkCheck()
sl@0	1422	@see __KHEAP_CHECK
sl@0	1423	*/
sl@0	1424	#define __UHEAP_CHECK(aCount) User::__DbgMarkCheck(FALSE,FALSE,aCount,(TText8*)__FILE__,__LINE__)
sl@0	1425
sl@0	1426
sl@0	1427
sl@0	1428
sl@0	1429	/**
sl@0	1430	@publishedAll
sl@0	1431	@released
sl@0	1432
sl@0	1433	Checks that the total number of allocated cells on the current thread's heap
sl@0	1434	is the same as the specified value.
sl@0	1435
sl@0	1436	This macro is defined only for debug builds.
sl@0	1437
sl@0	1438	The macro also takes the name of the file containing this source code statement
sl@0	1439	and the line number of this source code statement; they are displayed as part
sl@0	1440	of the panic category, if the checks fail.
sl@0	1441
sl@0	1442	@param aCount The total number of heap cells expected to be allocated.
sl@0	1443
sl@0	1444	@see User::__DbgMarkCheck()
sl@0	1445	@see __KHEAP_CHECKALL
sl@0	1446	*/
sl@0	1447	#define __UHEAP_CHECKALL(aCount) User::__DbgMarkCheck(FALSE,TRUE,aCount,(TText8*)__FILE__,__LINE__)
sl@0	1448
sl@0	1449
sl@0	1450
sl@0	1451
sl@0	1452	/**
sl@0	1453	@publishedAll
sl@0	1454	@released
sl@0	1455
sl@0	1456	Marks the end of checking the current thread's heap.
sl@0	1457
sl@0	1458	The macro expects zero heap cells to remain allocated at the current nest
sl@0	1459	level. This macro is defined only for debug builds.
sl@0	1460
sl@0	1461	This macro must match an earlier call to __UHEAP_MARK.
sl@0	1462
sl@0	1463	@see User::__DbgMarkEnd()
sl@0	1464	@see __UHEAP_MARK
sl@0	1465	*/
sl@0	1466	#define __UHEAP_MARKEND User::__DbgMarkEnd(FALSE,0)
sl@0	1467
sl@0	1468
sl@0	1469
sl@0	1470
sl@0	1471	/**
sl@0	1472	@publishedAll
sl@0	1473	@released
sl@0	1474
sl@0	1475	Marks the end of checking the current thread's heap.
sl@0	1476
sl@0	1477	The macro expects aCount heap cells to remain allocated at the current nest
sl@0	1478	level.
sl@0	1479
sl@0	1480	This macro must match an earlier call to __UHEAP_MARK.
sl@0	1481
sl@0	1482	@param aCount The number of heap cells expected to remain allocated at
sl@0	1483	the current nest level.
sl@0	1484
sl@0	1485	@see User::__DbgMarkEnd()
sl@0	1486	@see __UHEAP_MARK
sl@0	1487	*/
sl@0	1488	#define __UHEAP_MARKENDC(aCount) User::__DbgMarkEnd(FALSE,aCount)
sl@0	1489
sl@0	1490
sl@0	1491
sl@0	1492
sl@0	1493	/**
sl@0	1494	@publishedAll
sl@0	1495	@released
sl@0	1496
sl@0	1497	Simulates heap allocation failure for the current thread's heap.
sl@0	1498
sl@0	1499	The failure occurs on the next call to new or any of the functions which
sl@0	1500	allocate memory from the heap. This macro is defined only for debug builds.
sl@0	1501
sl@0	1502	@param aCount Determines when the allocation will fail.
sl@0	1503	Heap allocation fails on attempt number aCount - later
sl@0	1504	allocations will succeed.
sl@0	1505	For example, if aCount is 3, then heap allocation fails
sl@0	1506	on the 3rd attempt, but all subsequent allocations succeed.
sl@0	1507
sl@0	1508	@see User::__DbgSetAllocFail()
sl@0	1509	*/
sl@0	1510	#define __UHEAP_FAILNEXT(aCount) User::__DbgSetAllocFail(FALSE,RAllocator::EFailNext,aCount)
sl@0	1511
sl@0	1512	/**
sl@0	1513	@publishedAll
sl@0	1514	@released
sl@0	1515
sl@0	1516	Simulates heap allocation failure for the current thread's heap.
sl@0	1517
sl@0	1518	The failures will occur for aBurst times from the next call to new or any of the functions which
sl@0	1519	allocate memory from the heap. This macro is defined only for debug builds.
sl@0	1520
sl@0	1521	@param aCount Determines when the allocation will fail.
sl@0	1522	Heap allocation fails on attempt number aCount - later
sl@0	1523	allocations will succeed.
sl@0	1524	For example, if aCount is 3, then heap allocation fails
sl@0	1525	on the 3rd attempt, but all subsequent allocations succeed.
sl@0	1526	Note when used with RHeap the maximum value aCount can be set
sl@0	1527	to is KMaxTUint16.
sl@0	1528	@param aBurst The number of consecutive allocations that will fail. Note
sl@0	1529	when used with RHeap the maximum value aBurst can be set to
sl@0	1530	is KMaxTUint16.
sl@0	1531
sl@0	1532	@see User::__DbgSetBurstAllocFail()
sl@0	1533	*/
sl@0	1534	#define __UHEAP_BURSTFAILNEXT(aCount,aBurst) User::__DbgSetBurstAllocFail(FALSE,RAllocator::EBurstFailNext,aCount,aBurst)
sl@0	1535
sl@0	1536
sl@0	1537
sl@0	1538	/**
sl@0	1539	@publishedAll
sl@0	1540	@released
sl@0	1541
sl@0	1542	Simulates heap allocation failure for the current thread's heap.
sl@0	1543
sl@0	1544	The failure occurs on subsequent calls to new or any of the functions which
sl@0	1545	allocate memory from the heap. This macro is defined only for debug builds.
sl@0	1546
sl@0	1547	@param aType The type of failure to be simulated.
sl@0	1548	@param aRate The failure rate.
sl@0	1549
sl@0	1550	@see User::__DbgSetAllocFail()
sl@0	1551	@see RAllocator::TAllocFail
sl@0	1552	*/
sl@0	1553	#define __UHEAP_SETFAIL(aType,aRate) User::__DbgSetAllocFail(FALSE, aType, aRate)
sl@0	1554
sl@0	1555	/**
sl@0	1556	@publishedAll
sl@0	1557	@released
sl@0	1558
sl@0	1559	Simulates heap allocation failure for the current thread's heap.
sl@0	1560
sl@0	1561	The failure occurs on subsequent calls to new or any of the functions which
sl@0	1562	allocate memory from the heap. This macro is defined only for debug builds.
sl@0	1563
sl@0	1564	@param aType The type of failure to be simulated.
sl@0	1565	@param aRate The failure rate. Note when used with RHeap the maximum value
sl@0	1566	aRate can be set to is KMaxTUint16.
sl@0	1567	@param aBurst The number of consecutive allocations that will fail. Note
sl@0	1568	when used with RHeap the maximum value aBurst can be set
sl@0	1569	to is KMaxTUint16.
sl@0	1570
sl@0	1571	@see User::__DbgSetBurstAllocFail()
sl@0	1572	@see RAllocator::TAllocFail
sl@0	1573	*/
sl@0	1574	#define __UHEAP_SETBURSTFAIL(aType,aRate,aBurst) User::__DbgSetBurstAllocFail(FALSE, aType, aRate, aBurst)
sl@0	1575
sl@0	1576
sl@0	1577
sl@0	1578	/**
sl@0	1579	@publishedAll
sl@0	1580	@released
sl@0	1581
sl@0	1582	Cancels simulated heap allocation failure for the current thread's heap.
sl@0	1583
sl@0	1584	This macro is defined only for debug builds.
sl@0	1585
sl@0	1586	@see User::__DbgSetAllocFail()
sl@0	1587	*/
sl@0	1588	#define __UHEAP_RESET User::__DbgSetAllocFail(FALSE,RAllocator::ENone,1)
sl@0	1589
sl@0	1590
sl@0	1591	/**
sl@0	1592	@publishedAll
sl@0	1593	@released
sl@0	1594
sl@0	1595	Cancels simulated heap allocation failure for the current thread's heap.
sl@0	1596	It walks the the heap and sets the nesting level for all allocated
sl@0	1597	cells to zero.
sl@0	1598
sl@0	1599	This macro is defined only for debug builds.
sl@0	1600	*/
sl@0	1601	#define __UHEAP_TOTAL_RESET User::__DbgSetAllocFail(FALSE,RAllocator::EReset,1)
sl@0	1602
sl@0	1603	/**
sl@0	1604	@publishedAll
sl@0	1605	@released
sl@0	1606
sl@0	1607	Returns the number of heap allocation failures the current debug allocator fail
sl@0	1608	function has caused so far.
sl@0	1609
sl@0	1610	This is intended to only be used with fail types RAllocator::EFailNext,
sl@0	1611	RAllocator::EBurstFailNext, RAllocator::EDeterministic and
sl@0	1612	RAllocator::EBurstDeterministic. The return value is unreliable for
sl@0	1613	all other fail types.
sl@0	1614
sl@0	1615	@return The number of heap allocation failures the current debug fail
sl@0	1616	function has caused.
sl@0	1617
sl@0	1618	@see RAllocator::TAllocFail
sl@0	1619	*/
sl@0	1620	#define __UHEAP_CHECKFAILURE User::__DbgCheckFailure(FALSE)
sl@0	1621
sl@0	1622	/**
sl@0	1623	@publishedAll
sl@0	1624	@released
sl@0	1625
sl@0	1626	Returns the number of kernel heap allocation failures the current debug
sl@0	1627	allocator fail function has caused so far.
sl@0	1628
sl@0	1629	This is intended to only be used with fail types RAllocator::EFailNext,
sl@0	1630	RAllocator::EBurstFailNext, RAllocator::EDeterministic and
sl@0	1631	RAllocator::EBurstDeterministic. The return value is unreliable for
sl@0	1632	all other fail types.
sl@0	1633
sl@0	1634	@return The number of heap allocation failures the current debug fail
sl@0	1635	function has caused.
sl@0	1636
sl@0	1637	@see RAllocator::TAllocFail
sl@0	1638	*/
sl@0	1639	#define __KHEAP_CHECKFAILURE User::__DbgCheckFailure(TRUE)
sl@0	1640
sl@0	1641
sl@0	1642
sl@0	1643	/**
sl@0	1644	@publishedAll
sl@0	1645	@released
sl@0	1646
sl@0	1647	Marks the start of heap checking for the specific heap.
sl@0	1648
sl@0	1649	This macro is defined only for debug builds.
sl@0	1650
sl@0	1651	This macro must be matched by a corresponding call to __RHEAP_MARKEND or __RHEAP_MARKENDC.
sl@0	1652
sl@0	1653	Calls to this macro can be nested but each call must be matched by corresponding
sl@0	1654	call to __RHEAP_MARKEND or __RHEAP_MARKENDC.
sl@0	1655
sl@0	1656	@param aHeap A pointer to the specific RHeap
sl@0	1657
sl@0	1658	@see RHeap
sl@0	1659	@see RAllocator::__DbgMarkStart()
sl@0	1660	@see __RHEAP_MARKEND
sl@0	1661	@see __RHEAP_MARKENDC
sl@0	1662	*/
sl@0	1663	#define __RHEAP_MARK(aHeap) (aHeap)->__DbgMarkStart()
sl@0	1664
sl@0	1665
sl@0	1666
sl@0	1667
sl@0	1668	/**
sl@0	1669	@publishedAll
sl@0	1670	@released
sl@0	1671
sl@0	1672	Checks that the number of allocated cells at the current nested level on the
sl@0	1673	specified heap is the same as the specified value.
sl@0	1674
sl@0	1675	The macro also takes the name of the file containing this source code statement
sl@0	1676	and the line number of this source code statement; they are displayed as part
sl@0	1677	of the panic category, if the checks fail.
sl@0	1678
sl@0	1679	This macro is defined only for debug builds.
sl@0	1680
sl@0	1681	@param aHeap A pointer to the specific RHeap.
sl@0	1682	@param aCount The number of heap cells expected to be allocated at
sl@0	1683	the current nest level.
sl@0	1684
sl@0	1685	@see RAllocator::__DbgMarkCheck()
sl@0	1686	*/
sl@0	1687	#define __RHEAP_CHECK(aHeap,aCount) (aHeap)->__DbgMarkCheck(FALSE,aCount,(TText8*)__FILE__,__LINE__)
sl@0	1688
sl@0	1689
sl@0	1690
sl@0	1691
sl@0	1692	/**
sl@0	1693	@publishedAll
sl@0	1694	@released
sl@0	1695
sl@0	1696	Checks that the total number of allocated cells on the specified heap is the
sl@0	1697	same as the specified value.
sl@0	1698
sl@0	1699	The macro also takes the name of the file containing this source code statement
sl@0	1700	and the line number of this source code statement; they are displayed as part
sl@0	1701	of the panic category, if the checks fail.
sl@0	1702
sl@0	1703	This macro is defined only for debug builds.
sl@0	1704
sl@0	1705	@param aHeap A pointer to the specific RHeap.
sl@0	1706	@param aCount The total number of heap cells expected to be allocated.
sl@0	1707
sl@0	1708	@see RAllocator::__DbgMarkCheck()
sl@0	1709	*/
sl@0	1710	#define __RHEAP_CHECKALL(aHeap,aCount) (aHeap)->__DbgMarkCheck(TRUE,aCount,(TText8*)__FILE__,__LINE__)
sl@0	1711
sl@0	1712
sl@0	1713
sl@0	1714
sl@0	1715	/**
sl@0	1716	@publishedAll
sl@0	1717	@released
sl@0	1718
sl@0	1719	Marks the end of heap checking for the specific heap.
sl@0	1720
sl@0	1721	The macro expects zero heap cells to remain allocated at the current nest
sl@0	1722	level. This macro is defined only for debug builds.
sl@0	1723
sl@0	1724	This macro must match an earlier call to __RHEAP_MARK.
sl@0	1725
sl@0	1726	@param aHeap A pointer to the specific RHeap.
sl@0	1727
sl@0	1728	@see RAllocator::__DbgMarkEnd()
sl@0	1729	@see __RHEAP_MARK
sl@0	1730	*/
sl@0	1731	#define __RHEAP_MARKEND(aHeap) (aHeap)->__DbgMarkEnd(0)
sl@0	1732
sl@0	1733
sl@0	1734
sl@0	1735
sl@0	1736	/**
sl@0	1737	@publishedAll
sl@0	1738	@released
sl@0	1739
sl@0	1740	Marks the end of heap checking for the specific heap.
sl@0	1741
sl@0	1742	The macro expects aCount heap cells to remain allocated at the current nest
sl@0	1743	level. This macro is defined only for debug builds.
sl@0	1744
sl@0	1745	This macro must match an earlier call to __RHEAP_MARK.
sl@0	1746
sl@0	1747	@param aHeap A pointer to the specific RHeap.
sl@0	1748	@param aCount The number of heap cells expected to remain allocated at
sl@0	1749	the current nest level
sl@0	1750
sl@0	1751	@see RAllocator::__DbgMarkEnd()
sl@0	1752	@see __RHEAP_MARK
sl@0	1753	*/
sl@0	1754	#define __RHEAP_MARKENDC(aHeap,aCount) (aHeap)->__DbgMarkEnd(aCount)
sl@0	1755
sl@0	1756
sl@0	1757
sl@0	1758
sl@0	1759	/**
sl@0	1760	@publishedAll
sl@0	1761	@released
sl@0	1762
sl@0	1763	Simulates an allocation failure for the specific heap.
sl@0	1764
sl@0	1765	The failure occurs on the next call to new or any of the functions which allocate
sl@0	1766	memory from the heap. This macro is defined only for debug builds.
sl@0	1767
sl@0	1768	@param aHeap A pointer to the specific RHeap.
sl@0	1769	@param aCount The rate of failure - heap allocation fails every aCount attempt.
sl@0	1770
sl@0	1771	@see RAllocator::__DbgSetAllocFail()
sl@0	1772	*/
sl@0	1773	#define __RHEAP_FAILNEXT(aHeap,aCount) (aHeap)->__DbgSetAllocFail(RAllocator::EFailNext,aCount)
sl@0	1774
sl@0	1775	/**
sl@0	1776	@publishedAll
sl@0	1777	@released
sl@0	1778
sl@0	1779	Simulates aBurst allocation failures for the specific heap.
sl@0	1780
sl@0	1781	The failure occurs on the next call to new or any of the functions which allocate
sl@0	1782	memory from the heap. This macro is defined only for debug builds.
sl@0	1783
sl@0	1784	@param aHeap A pointer to the specific RHeap.
sl@0	1785	@param aCount The heap allocation will fail after aCount-1 allocation attempts.
sl@0	1786	Note when used with RHeap the maximum value aCount can be set
sl@0	1787	to is KMaxTUint16.
sl@0	1788	@param aBurst The number of consecutive allocations that will fail. Note
sl@0	1789	when used with RHeap the maximum value aBurst can be set
sl@0	1790	to is KMaxTUint16.
sl@0	1791
sl@0	1792	@see RAllocator::__DbgSetBurstAllocFail()
sl@0	1793	*/
sl@0	1794	#define __RHEAP_BURSTFAILNEXT(aHeap,aCount,aBurst) (aHeap)->__DbgSetBurstAllocFail(RAllocator::EBurstFailNext,aCount, aBurst)
sl@0	1795
sl@0	1796
sl@0	1797
sl@0	1798	/**
sl@0	1799	@publishedAll
sl@0	1800	@released
sl@0	1801
sl@0	1802	Simulates an allocation failure for the specific heap.
sl@0	1803
sl@0	1804	The failure occurs on subsequent calls to new or any of the functions which
sl@0	1805	allocate memory from the heap. This macro is defined only for debug builds.
sl@0	1806
sl@0	1807	@param aHeap A pointer to the specific RHeap.
sl@0	1808	@param aType The type of failure to be simulated.
sl@0	1809	@param aRate The failure rate.
sl@0	1810
sl@0	1811	@see RAllocator::__DbgSetAllocFail()
sl@0	1812	*/
sl@0	1813	#define __RHEAP_SETFAIL(aHeap,aType,aRate) (aHeap)->__DbgSetAllocFail(aType,aRate)
sl@0	1814
sl@0	1815	/**
sl@0	1816	@publishedAll
sl@0	1817	@released
sl@0	1818
sl@0	1819	Simulates an allocation failure for the specific heap.
sl@0	1820
sl@0	1821	The failure occurs on subsequent calls to new or any of the functions which
sl@0	1822	allocate memory from the heap. This macro is defined only for debug builds.
sl@0	1823
sl@0	1824	@param aHeap A pointer to the specific RHeap.
sl@0	1825	@param aType The type of failure to be simulated.
sl@0	1826	@param aRate The failure rate. Note when used with RHeap the maximum value
sl@0	1827	aRate can be set to is KMaxTUint16.
sl@0	1828	@param aBurst The number of consecutive allocations that will fail. Note
sl@0	1829	when used with RHeap the maximum value aBurst can be set
sl@0	1830	to is KMaxTUint16.
sl@0	1831
sl@0	1832	@see RAllocator::__DbgSetBurstAllocFail()
sl@0	1833	*/
sl@0	1834	#define __RHEAP_SETBURSTFAIL(aHeap,aType,aRate,aBurst) (aHeap)->__DbgSetBurstAllocFail(aType,aRate,aBurst)
sl@0	1835
sl@0	1836
sl@0	1837
sl@0	1838	/**
sl@0	1839	@publishedAll
sl@0	1840	@released
sl@0	1841
sl@0	1842	Cancels simulated allocation failure for the specific heap.
sl@0	1843
sl@0	1844	This macro is defined only for debug builds.
sl@0	1845
sl@0	1846	@param aHeap A pointer to the specific RHeap.
sl@0	1847
sl@0	1848	@see RAllocator::__DbgSetAllocFail()
sl@0	1849	*/
sl@0	1850	#define __RHEAP_RESET(aHeap) (aHeap)->__DbgSetAllocFail(RAllocator::ENone,1)
sl@0	1851
sl@0	1852
sl@0	1853
sl@0	1854	/**
sl@0	1855	@publishedAll
sl@0	1856	@released
sl@0	1857
sl@0	1858	Cancels simulated allocation failure for the specific heap.
sl@0	1859	It walks the the heap and sets the nesting level for all allocated
sl@0	1860	cells to zero.
sl@0	1861
sl@0	1862	This macro is defined only for debug builds.
sl@0	1863
sl@0	1864	@param aHeap A pointer to the specific RHeap.
sl@0	1865
sl@0	1866	@see RAllocator::__DbgSetAllocFail()
sl@0	1867	*/
sl@0	1868	#define __RHEAP_TOTAL_RESET(aHeap) (aHeap)->__DbgSetAllocFail(RAllocator::EReset,1)
sl@0	1869
sl@0	1870	/**
sl@0	1871	@publishedAll
sl@0	1872	@released
sl@0	1873
sl@0	1874	Returns the number of heap allocation failures the current debug allocator fail
sl@0	1875	function has caused so far.
sl@0	1876
sl@0	1877	This is intended to only be used with fail types RAllocator::EFailNext,
sl@0	1878	RAllocator::EBurstFailNext, RAllocator::EDeterministic and
sl@0	1879	RAllocator::EBurstDeterministic. The return value is unreliable for
sl@0	1880	all other fail types.
sl@0	1881
sl@0	1882	@return The number of heap allocation failures the current debug fail
sl@0	1883	function has caused.
sl@0	1884
sl@0	1885	@see RAllocator::TAllocFail
sl@0	1886	*/
sl@0	1887	#define __RHEAP_CHECKFAILURE(aHeap) (aHeap)->__DbgCheckFailure()
sl@0	1888
sl@0	1889
sl@0	1890	#if defined (__WINS__)
sl@0	1891
sl@0	1892	/**
sl@0	1893	@publishedAll
sl@0	1894	@released
sl@0	1895	*/
sl@0	1896	#define __DEBUGGER() {if (User::JustInTime()) __BREAKPOINT()}
sl@0	1897
sl@0	1898	#else
sl@0	1899	#define __DEBUGGER()
sl@0	1900	#endif
sl@0	1901
sl@0	1902
sl@0	1903	#if defined(__DLL__)
sl@0	1904	/**
sl@0	1905	@publishedAll
sl@0	1906	@released
sl@0	1907
sl@0	1908	Declares a function for testing object invariance.
sl@0	1909
sl@0	1910	For complex classes, it is often useful to provide a function that can
sl@0	1911	be called to check that the object is in a valid state.
sl@0	1912	The __DECLARE_TEST macro supplies a standard prototype for such a function
sl@0	1913	named __DbgTestInvariant(). A companion macro __TEST_INVARIANT is provided
sl@0	1914	to call the function.
sl@0	1915
sl@0	1916	For DLLs, as opposed to EXEs, __DbgTestInvariant() is exported,
sl@0	1917	i.e. the macro expands to:
sl@0	1918
sl@0	1919	@code
sl@0	1920	public: IMPORT_C void __DbgTestInvariant() const; void __DbgTest(TAny *aPtr) const
sl@0	1921	@endcode
sl@0	1922
sl@0	1923	This macro should placed as the last item in a class declaration (as it
sl@0	1924	switches back to public access). Note that a terminating semi-colon must be used.
sl@0	1925
sl@0	1926	You should define the __DbgTestInvariant() function to check that the object
sl@0	1927	is in a healthy state. If it finds an error, it should call User::Invariant(),
sl@0	1928	which will cause a panic.
sl@0	1929
sl@0	1930	If a class is derived from a base class, then the base class __DbgTestInvariant()
sl@0	1931	should be called first, and then any further checking done.
sl@0	1932
sl@0	1933	The second function declared, __DbgTest(), is intended to allow test code a way
sl@0	1934	of directly accessing non-public members of a class. The function is
sl@0	1935	implemented by any test code that requires it, rather than in the class’s own
sl@0	1936	source code. The function is therefore not exported.
sl@0	1937
sl@0	1938	__DECLARE_TEST is defined for both debug and release builds. This point is
sl@0	1939	particularly important for DLLs, as otherwise the exported interfaces would
sl@0	1940	differ between the build versions, giving potential binary compatibility
sl@0	1941	problems. To avoid using memory unnecessarily in release builds, you can,
sl@0	1942	however, use preprocessor directives to define the code within
sl@0	1943	__DbgTestInvariant() only for debug builds. __DbgTestInvariant() is never
sl@0	1944	called in release builds.
sl@0	1945
sl@0	1946	@see __TEST_INVARIANT
sl@0	1947	*/
sl@0	1948	#define __DECLARE_TEST public: IMPORT_C void __DbgTestInvariant() const; void __DbgTest(TAny *aPtr) const
sl@0	1949	#else
sl@0	1950	#define __DECLARE_TEST public: void __DbgTestInvariant() const; void __DbgTest(TAny *aPtr) const
sl@0	1951	#endif
sl@0	1952
sl@0	1953	#else
sl@0	1954	#define __ASSERT_DEBUG(c,p)
sl@0	1955	#define __DECLARE_NAME(t)
sl@0	1956	#define __TEST_INVARIANT
sl@0	1957	#if defined(__DLL__)
sl@0	1958	#define __DECLARE_TEST public: IMPORT_C void __DbgTestInvariant() const; void __DbgTest(TAny *aPtr) const
sl@0	1959	#else
sl@0	1960	#define __DECLARE_TEST public: void __DbgTestInvariant() const; void __DbgTest(TAny *aPtr) const
sl@0	1961	#endif
sl@0	1962
sl@0	1963
sl@0	1964
sl@0	1965
sl@0	1966	/**
sl@0	1967	@publishedAll
sl@0	1968	@released
sl@0	1969
sl@0	1970	Marks the start of checking the current thread's heap.
sl@0	1971
sl@0	1972	This macro is defined only for debug builds.
sl@0	1973
sl@0	1974	This macro must be matched by a corresponding call to __UHEAP_MARKEND or __UHEAP_MARKENDC.
sl@0	1975
sl@0	1976	Calls to this macro can be nested but each call must be matched by corresponding
sl@0	1977	call to __UHEAP_MARKEND or __UHEAP_MARKENDC.
sl@0	1978
sl@0	1979	@see User::__DbgMarkStart()
sl@0	1980	@see __UHEAP_MARKEND
sl@0	1981	@see __UHEAP_MARKENDC
sl@0	1982	*/
sl@0	1983	#define __UHEAP_MARK
sl@0	1984
sl@0	1985
sl@0	1986
sl@0	1987
sl@0	1988	/**
sl@0	1989	@publishedAll
sl@0	1990	@released
sl@0	1991
sl@0	1992	Checks that the number of allocated cells at the current nested level on the
sl@0	1993	current thread's heap is the same as the specified value.
sl@0	1994
sl@0	1995	This macro is defined only for debug builds.
sl@0	1996
sl@0	1997	The macro also takes the name of the file containing this source code statement
sl@0	1998	and the line number of this source code statement; they are displayed as part
sl@0	1999	of the panic category, if the checks fail.
sl@0	2000
sl@0	2001	The macro assumes that:
sl@0	2002
sl@0	2003	1. the heap being checked is a user heap
sl@0	2004
sl@0	2005	2. checking is being done for the number of allocated cells at the current nested
sl@0	2006	level; i.e. that aCountAll is set to false
sl@0	2007
sl@0	2008	3. the line number is the line number of this source code statement.
sl@0	2009
sl@0	2010	4. the file name is the full path name of the file containing this source statement
sl@0	2011
sl@0	2012	@param aCount The number of heap cells expected to be allocated at
sl@0	2013	the current nest level.
sl@0	2014
sl@0	2015	@see User::__DbgMarkCheck()
sl@0	2016	@see __KHEAP_CHECK
sl@0	2017	*/
sl@0	2018	#define __UHEAP_CHECK(aCount)
sl@0	2019
sl@0	2020
sl@0	2021
sl@0	2022
sl@0	2023	/**
sl@0	2024	@publishedAll
sl@0	2025	@released
sl@0	2026
sl@0	2027	Checks that the total number of allocated cells on the current thread's heap
sl@0	2028	is the same as the specified value.
sl@0	2029
sl@0	2030	This macro is defined only for debug builds.
sl@0	2031
sl@0	2032	The macro also takes the name of the file containing this source code statement
sl@0	2033	and the line number of this source code statement; they are displayed as part
sl@0	2034	of the panic category, if the checks fail.
sl@0	2035
sl@0	2036	@param aCount The total number of heap cells expected to be allocated.
sl@0	2037
sl@0	2038	@see User::__DbgMarkCheck()
sl@0	2039	@see __KHEAP_CHECKALL
sl@0	2040	*/
sl@0	2041	#define __UHEAP_CHECKALL(aCount)
sl@0	2042
sl@0	2043
sl@0	2044
sl@0	2045
sl@0	2046	/**
sl@0	2047	@publishedAll
sl@0	2048	@released
sl@0	2049
sl@0	2050	Marks the end of checking the current thread's heap.
sl@0	2051
sl@0	2052	The macro expects zero heap cells to remain allocated at the current nest
sl@0	2053	level. This macro is defined only for debug builds.
sl@0	2054
sl@0	2055	This macro must match an earlier call to __UHEAP_MARK.
sl@0	2056
sl@0	2057	@see User::__DbgMarkEnd()
sl@0	2058	@see __UHEAP_MARK
sl@0	2059	*/
sl@0	2060	#define __UHEAP_MARKEND
sl@0	2061
sl@0	2062
sl@0	2063
sl@0	2064
sl@0	2065	/**
sl@0	2066	@publishedAll
sl@0	2067	@released
sl@0	2068
sl@0	2069	Marks the end of checking the current thread's heap.
sl@0	2070
sl@0	2071	The macro expects aCount heap cells to remain allocated at the current nest
sl@0	2072	level.
sl@0	2073
sl@0	2074	This macro must match an earlier call to __UHEAP_MARK.
sl@0	2075
sl@0	2076	@param aCount The number of heap cells expected to remain allocated at
sl@0	2077	the current nest level.
sl@0	2078
sl@0	2079	@see User::__DbgMarkEnd()
sl@0	2080	@see __UHEAP_MARK
sl@0	2081	*/
sl@0	2082	#define __UHEAP_MARKENDC(aCount)
sl@0	2083
sl@0	2084
sl@0	2085
sl@0	2086
sl@0	2087	/**
sl@0	2088	@publishedAll
sl@0	2089	@released
sl@0	2090
sl@0	2091	Simulates heap allocation failure for the current thread's heap.
sl@0	2092
sl@0	2093	The failure occurs on the next call to new or any of the functions which
sl@0	2094	allocate memory from the heap. This macro is defined only for debug builds.
sl@0	2095
sl@0	2096	@param aCount Determines when the allocation will fail.
sl@0	2097	Heap allocation fails on attempt number aCount - later
sl@0	2098	allocations will succeed.
sl@0	2099	For example, if aCount is 3, then heap allocation fails
sl@0	2100	on the 3rd attempt, but all subsequent allocations succeed.
sl@0	2101
sl@0	2102	@see User::__DbgSetAllocFail()
sl@0	2103	*/
sl@0	2104	#define __UHEAP_FAILNEXT(aCount)
sl@0	2105
sl@0	2106	/**
sl@0	2107	@publishedAll
sl@0	2108	@released
sl@0	2109
sl@0	2110	Simulates heap allocation failure for the current thread's heap.
sl@0	2111
sl@0	2112	The failures will occur for aBurst times from the next call to new or any of the functions which
sl@0	2113	allocate memory from the heap. This macro is defined only for debug builds.
sl@0	2114
sl@0	2115	@param aCount Determines when the allocation will fail.
sl@0	2116	Heap allocation fails on attempt number aCount - later
sl@0	2117	allocations will succeed.
sl@0	2118	For example, if aCount is 3, then heap allocation fails
sl@0	2119	on the 3rd attempt, but all subsequent allocations succeed.
sl@0	2120	Note when used with RHeap the maximum value aBurst can be
sl@0	2121	set to is KMaxTUint16.
sl@0	2122	@param aBurst The number of consecutive allocations that will fail. Note
sl@0	2123	when used with RHeap the maximum value aBurst can be set
sl@0	2124	to is KMaxTUint16.
sl@0	2125
sl@0	2126	@see User::__DbgSetBurstAllocFail()
sl@0	2127	*/
sl@0	2128	#define __UHEAP_BURSTFAILNEXT(aCount,aBurst)
sl@0	2129
sl@0	2130
sl@0	2131
sl@0	2132	/**
sl@0	2133	@publishedAll
sl@0	2134	@released
sl@0	2135
sl@0	2136	Simulates heap allocation failure for the current thread's heap.
sl@0	2137
sl@0	2138	The failure occurs on subsequent calls to new or any of the functions which
sl@0	2139	allocate memory from the heap. This macro is defined only for debug builds.
sl@0	2140
sl@0	2141	@param aType The type of failure to be simulated.
sl@0	2142	@param aRate The failure rate.
sl@0	2143
sl@0	2144	@see User::__DbgSetAllocFail()
sl@0	2145	*/
sl@0	2146	#define __UHEAP_SETFAIL(aType,aRate)
sl@0	2147
sl@0	2148	/**
sl@0	2149	@publishedAll
sl@0	2150	@released
sl@0	2151
sl@0	2152	Simulates heap allocation failure for the current thread's heap.
sl@0	2153
sl@0	2154	The failure occurs on subsequent calls to new or any of the functions which
sl@0	2155	allocate memory from the heap. This macro is defined only for debug builds.
sl@0	2156
sl@0	2157	@param aType The type of failure to be simulated.
sl@0	2158	@param aRate The failure rate. Note when used with RHeap the maximum value
sl@0	2159	aRate can be set to is KMaxTUint16.
sl@0	2160	@param aBurst The number of consecutive allocations that will fail. Note
sl@0	2161	when used with RHeap the maximum value aBurst can be set
sl@0	2162	to is KMaxTUint16.
sl@0	2163
sl@0	2164	@see User::__DbgSetBurstAllocFail()
sl@0	2165	@see RAllocator::TAllocFail
sl@0	2166	*/
sl@0	2167	#define __UHEAP_SETBURSTFAIL(aType,aRate,aBurst)
sl@0	2168
sl@0	2169
sl@0	2170
sl@0	2171	/**
sl@0	2172	@publishedAll
sl@0	2173	@released
sl@0	2174
sl@0	2175	Cancels simulated heap allocation failure for the current thread's heap.
sl@0	2176
sl@0	2177	This macro is defined only for debug builds.
sl@0	2178
sl@0	2179	@see User::__DbgSetAllocFail()
sl@0	2180	*/
sl@0	2181	#define __UHEAP_RESET
sl@0	2182
sl@0	2183
sl@0	2184
sl@0	2185	/**
sl@0	2186	@publishedAll
sl@0	2187	@released
sl@0	2188
sl@0	2189	Cancels simulated heap allocation failure for the current thread's heap.
sl@0	2190	It walks the the heap and sets the nesting level for all allocated
sl@0	2191	cells to zero.
sl@0	2192
sl@0	2193	This macro is defined only for debug builds.
sl@0	2194	*/
sl@0	2195	#define __UHEAP_TOTAL_RESET
sl@0	2196
sl@0	2197	/**
sl@0	2198	@publishedAll
sl@0	2199	@released
sl@0	2200
sl@0	2201	Returns the number of heap allocation failures the current debug allocator fail
sl@0	2202	function has caused so far.
sl@0	2203
sl@0	2204	This is intended to only be used with fail types RAllocator::EFailNext,
sl@0	2205	RAllocator::EBurstFailNext, RAllocator::EDeterministic and
sl@0	2206	RAllocator::EBurstDeterministic. The return value is unreliable for
sl@0	2207	all other fail types.
sl@0	2208
sl@0	2209	@return The number of heap allocation failures the current debug fail
sl@0	2210	function has caused.
sl@0	2211
sl@0	2212	@see RAllocator::TAllocFail
sl@0	2213	*/
sl@0	2214	#define __UHEAP_CHECKFAILURE ((TUint)0)
sl@0	2215
sl@0	2216	/**
sl@0	2217	@publishedAll
sl@0	2218	@released
sl@0	2219
sl@0	2220	Returns the number of kernel heap allocation failures the current debug
sl@0	2221	allocator fail function has caused so far.
sl@0	2222
sl@0	2223	This is intended to only be used with fail types RAllocator::EFailNext,
sl@0	2224	RAllocator::EBurstFailNext, RAllocator::EDeterministic and
sl@0	2225	RAllocator::EBurstDeterministic. The return value is unreliable for
sl@0	2226	all other fail types.
sl@0	2227
sl@0	2228	@return The number of heap allocation failures the current debug fail
sl@0	2229	function has caused.
sl@0	2230
sl@0	2231	@see RAllocator::TAllocFail
sl@0	2232	*/
sl@0	2233	#define __KHEAP_CHECKFAILURE ((TUint)0)
sl@0	2234
sl@0	2235	/**
sl@0	2236	@publishedAll
sl@0	2237	@released
sl@0	2238
sl@0	2239	Marks the start of heap checking for the specific heap.
sl@0	2240
sl@0	2241	This macro is defined only for debug builds.
sl@0	2242
sl@0	2243	This macro must be matched by a corresponding call to __RHEAP_MARKEND or __RHEAP_MARKENDC.
sl@0	2244
sl@0	2245	Calls to this macro can be nested but each call must be matched by corresponding
sl@0	2246	call to __RHEAP_MARKEND or __RHEAP_MARKENDC.
sl@0	2247
sl@0	2248	@param aHeap A pointer to the specific RHeap
sl@0	2249
sl@0	2250	@see RHeap
sl@0	2251	@see RAllocator::__DbgMarkStart()
sl@0	2252	@see __RHEAP_MARKEND
sl@0	2253	@see __RHEAP_MARKENDC
sl@0	2254	*/
sl@0	2255	#define __RHEAP_MARK(aHeap)
sl@0	2256
sl@0	2257
sl@0	2258
sl@0	2259
sl@0	2260	/**
sl@0	2261	@publishedAll
sl@0	2262	@released
sl@0	2263
sl@0	2264	Checks that the number of allocated cells at the current nested level on the
sl@0	2265	specified heap is the same as the specified value.
sl@0	2266
sl@0	2267	The macro also takes the name of the file containing this source code statement
sl@0	2268	and the line number of this source code statement; they are displayed as part
sl@0	2269	of the panic category, if the checks fail.
sl@0	2270
sl@0	2271	This macro is defined only for debug builds.
sl@0	2272
sl@0	2273	@param aHeap A pointer to the specific RHeap.
sl@0	2274	@param aCount The number of heap cells expected to be allocated at
sl@0	2275	the current nest level.
sl@0	2276
sl@0	2277	@see RAllocator::__DbgMarkCheck()
sl@0	2278	*/
sl@0	2279	#define __RHEAP_CHECK(aHeap,aCount)
sl@0	2280
sl@0	2281
sl@0	2282
sl@0	2283
sl@0	2284	/**
sl@0	2285	@publishedAll
sl@0	2286	@released
sl@0	2287
sl@0	2288	Checks that the total number of allocated cells on the specified heap is the
sl@0	2289	same as the specified value.
sl@0	2290
sl@0	2291	The macro also takes the name of the file containing this source code statement
sl@0	2292	and the line number of this source code statement; they are displayed as part
sl@0	2293	of the panic category, if the checks fail.
sl@0	2294
sl@0	2295	This macro is defined only for debug builds.
sl@0	2296
sl@0	2297	@param aHeap A pointer to the specific RHeap.
sl@0	2298	@param aCount The total number of heap cells expected to be allocated.
sl@0	2299
sl@0	2300	@see RAllocator::__DbgMarkCheck()
sl@0	2301	*/
sl@0	2302	#define __RHEAP_CHECKALL(aHeap,aCount)
sl@0	2303
sl@0	2304
sl@0	2305
sl@0	2306
sl@0	2307	/**
sl@0	2308	@publishedAll
sl@0	2309	@released
sl@0	2310
sl@0	2311	Marks the end of heap checking for the specific heap.
sl@0	2312
sl@0	2313	The macro expects zero heap cells to remain allocated at the current nest
sl@0	2314	level. This macro is defined only for debug builds.
sl@0	2315
sl@0	2316	This macro must match an earlier call to __RHEAP_MARK.
sl@0	2317
sl@0	2318	@param aHeap A pointer to the specific RHeap.
sl@0	2319
sl@0	2320	@see RAllocator::__DbgMarkEnd()
sl@0	2321	@see __RHEAP_MARK
sl@0	2322	*/
sl@0	2323	#define __RHEAP_MARKEND(aHeap)
sl@0	2324
sl@0	2325
sl@0	2326
sl@0	2327
sl@0	2328	/**
sl@0	2329	@publishedAll
sl@0	2330	@released
sl@0	2331
sl@0	2332	Marks the end of heap checking for the specific heap.
sl@0	2333
sl@0	2334	The macro expects aCount heap cells to remain allocated at the current nest
sl@0	2335	level. This macro is defined only for debug builds.
sl@0	2336
sl@0	2337	This macro must match an earlier call to __RHEAP_MARK.
sl@0	2338
sl@0	2339	@param aHeap A pointer to the specific RHeap.
sl@0	2340	@param aCount The number of heap cells expected to remain allocated at
sl@0	2341	the current nest level
sl@0	2342
sl@0	2343	@see RAllocator::__DbgMarkEnd()
sl@0	2344	@see __RHEAP_MARK
sl@0	2345	*/
sl@0	2346	#define __RHEAP_MARKENDC(aHeap,aCount)
sl@0	2347
sl@0	2348
sl@0	2349
sl@0	2350
sl@0	2351	/**
sl@0	2352	@publishedAll
sl@0	2353	@released
sl@0	2354
sl@0	2355	Simulates an allocation failure for the specific heap.
sl@0	2356
sl@0	2357	The failure occurs on the next call to new or any of the functions which allocate
sl@0	2358	memory from the heap. This macro is defined only for debug builds.
sl@0	2359
sl@0	2360	@param aHeap A pointer to the specific RHeap.
sl@0	2361	@param aCount The rate of failure - heap allocation fails every aCount attempt.
sl@0	2362
sl@0	2363	@see RAllocator::__DbgSetAllocFail()
sl@0	2364	*/
sl@0	2365	#define __RHEAP_FAILNEXT(aHeap,aCount)
sl@0	2366
sl@0	2367	/**
sl@0	2368	@publishedAll
sl@0	2369	@released
sl@0	2370
sl@0	2371	Simulates aBurst allocation failures for the specific heap.
sl@0	2372
sl@0	2373	The failure occurs on the next call to new or any of the functions which allocate
sl@0	2374	memory from the heap. This macro is defined only for debug builds.
sl@0	2375
sl@0	2376	@param aHeap A pointer to the specific RHeap.
sl@0	2377	@param aCount The heap allocation will fail after aCount-1 allocation attempts.
sl@0	2378	Note when used with RHeap the maximum value aCount can be set
sl@0	2379	to is KMaxTUint16.
sl@0	2380	@param aBurst The number of consecutive allocations that will fail. Note
sl@0	2381	when used with RHeap the maximum value aBurst can be set
sl@0	2382	to is KMaxTUint16.
sl@0	2383
sl@0	2384	@see RAllocator::__DbgSetBurstAllocFail()
sl@0	2385	*/
sl@0	2386	#define __RHEAP_BURSTFAILNEXT(aHeap,aCount,aBurst)
sl@0	2387
sl@0	2388
sl@0	2389
sl@0	2390	/**
sl@0	2391	@publishedAll
sl@0	2392	@released
sl@0	2393
sl@0	2394	Simulates an allocation failure for the specific heap.
sl@0	2395
sl@0	2396	The failure occurs on subsequent calls to new or any of the functions which
sl@0	2397	allocate memory from the heap. This macro is defined only for debug builds.
sl@0	2398
sl@0	2399	@param aHeap A pointer to the specific RHeap.
sl@0	2400	@param aType The type of failure to be simulated.
sl@0	2401	@param aRate The failure rate.
sl@0	2402
sl@0	2403	@see RAllocator::__DbgSetAllocFail()
sl@0	2404	*/
sl@0	2405	#define __RHEAP_SETFAIL(aHeap,aType,aRate)
sl@0	2406
sl@0	2407	/**
sl@0	2408	@publishedAll
sl@0	2409	@released
sl@0	2410
sl@0	2411	Simulates an allocation failure for the specific heap.
sl@0	2412
sl@0	2413	The failure occurs on subsequent calls to new or any of the functions which
sl@0	2414	allocate memory from the heap. This macro is defined only for debug builds.
sl@0	2415
sl@0	2416	@param aHeap A pointer to the specific RHeap.
sl@0	2417	@param aType The type of failure to be simulated.
sl@0	2418	@param aRate The failure rate. Note when used with RHeap the maximum value
sl@0	2419	aRate can be set to is KMaxTUint16.
sl@0	2420	@param aBurst The number of consecutive allocations that will fail. Note
sl@0	2421	when used with RHeap the maximum value aBurst can be set
sl@0	2422	to is KMaxTUint16.
sl@0	2423
sl@0	2424	@see RAllocator::__DbgSetBurstAllocFail()
sl@0	2425	*/
sl@0	2426	#define __RHEAP_SETBURSTFAIL(aHeap,aType,aRate,aBurst)
sl@0	2427
sl@0	2428
sl@0	2429
sl@0	2430	/**
sl@0	2431	@publishedAll
sl@0	2432	@released
sl@0	2433
sl@0	2434	Cancels simulated allocation failure for the specific heap.
sl@0	2435
sl@0	2436	This macro is defined only for debug builds.
sl@0	2437
sl@0	2438	@param aHeap A pointer to the specific RHeap.
sl@0	2439
sl@0	2440	@see RAllocator::__DbgSetAllocFail()
sl@0	2441	*/
sl@0	2442	#define __RHEAP_RESET(aHeap)
sl@0	2443
sl@0	2444
sl@0	2445
sl@0	2446	/**
sl@0	2447	@publishedAll
sl@0	2448	@released
sl@0	2449
sl@0	2450	Cancels simulated allocation failure for the specific heap.
sl@0	2451	It walks the the heap and sets the nesting level for all allocated
sl@0	2452	cells to zero.
sl@0	2453
sl@0	2454	This macro is defined only for debug builds.
sl@0	2455
sl@0	2456	@param aHeap A pointer to the specific RHeap.
sl@0	2457
sl@0	2458	@see RAllocator::__DbgSetAllocFail()
sl@0	2459	*/
sl@0	2460	#define __RHEAP_TOTAL_RESET(aHeap)
sl@0	2461
sl@0	2462
sl@0	2463	/**
sl@0	2464	@publishedAll
sl@0	2465	@released
sl@0	2466
sl@0	2467	Returns the number of heap allocation failures the current debug allocator fail
sl@0	2468	function has caused so far.
sl@0	2469
sl@0	2470	This is intended to only be used with fail types RAllocator::EFailNext,
sl@0	2471	RAllocator::EBurstFailNext, RAllocator::EDeterministic and
sl@0	2472	RAllocator::EBurstDeterministic. The return value is unreliable for
sl@0	2473	all other fail types.
sl@0	2474
sl@0	2475	@return The number of heap allocation failures the current debug fail
sl@0	2476	function has caused.
sl@0	2477
sl@0	2478	@see RAllocator::TAllocFail
sl@0	2479	*/
sl@0	2480	#define __RHEAP_CHECKFAILURE(aHeap) ((TUint)0)
sl@0	2481
sl@0	2482	#define __DEBUGGER()
sl@0	2483	#endif
sl@0	2484
sl@0	2485	#if defined (__WINS__)
sl@0	2486	/** @internalTechnology */
sl@0	2487	#define __EMULATOR_IMAGE_HEADER2(aUid0,aUid1,aUid2,aPriority,aCap0,aCap1,aSid,aVid,aVer,aFlags) TEmulatorImageHeader uid={{aUid0,aUid1,aUid2},aPriority,{aSid,aVid,{aCap0,aCap1}},0,0,aVer,aFlags};
sl@0	2488	/** @internalTechnology */
sl@0	2489	#define __EMULATOR_IMAGE_HEADER(aUid0,aUid1,aUid2,aPriority,aCap,aFlags) TEmulatorImageHeader uid={{aUid0,aUid1,aUid2},aPriority,{aUid2,0,{aCap,0}},0,0,0x00010000u,aFlags};
sl@0	2490	#else
sl@0	2491	#define __EMULATOR_IMAGE_HEADER2(aUid0,aUid1,aUid2,aPriority,aCap0,aCap1,aSid,aVer,aFlags)
sl@0	2492	#define __EMULATOR_IMAGE_HEADER(aUid0,aUid1,aUid2,aPriority,aCap,aFlags)
sl@0	2493	#endif
sl@0	2494
sl@0	2495	#if defined(_UNICODE)
sl@0	2496	#if !defined(UNICODE)
sl@0	2497	/**
sl@0	2498	@publishedAll
sl@0	2499	@deprecated
sl@0	2500	*/
sl@0	2501	#define UNICODE
sl@0	2502	#endif
sl@0	2503	#endif
sl@0	2504
sl@0	2505	#if !defined(ASSERT)
sl@0	2506	/**
sl@0	2507	@publishedAll
sl@0	2508	@released
sl@0	2509
sl@0	2510	Generates _ASSERT_DEBUG code that calls User::Invariant() if the specified
sl@0	2511	condition is not true.
sl@0	2512
sl@0	2513	@param x A conditional expression which results in true or false.
sl@0	2514	*/
sl@0	2515	#define ASSERT(x) __ASSERT_DEBUG(x,User::Invariant())
sl@0	2516	#endif
sl@0	2517
sl@0	2518
sl@0	2519
sl@0	2520
sl@0	2521	#if defined(_DEBUG)
sl@0	2522	/**
sl@0	2523	@publishedAll
sl@0	2524	@released
sl@0	2525	*/
sl@0	2526	#define __DEBUG_ONLY(x) x
sl@0	2527	#else
sl@0	2528	#define __DEBUG_ONLY(x)
sl@0	2529	#endif
sl@0	2530
sl@0	2531
sl@0	2532
sl@0	2533
sl@0	2534	#ifdef __KERNEL_MODE__
sl@0	2535
sl@0	2536	/** @internalComponent */
sl@0	2537	#define KIMPORT_C IMPORT_C
sl@0	2538
sl@0	2539	/** @internalComponent */
sl@0	2540	#define KEXPORT_C EXPORT_C
sl@0	2541
sl@0	2542	/** @internalComponent */
sl@0	2543	#define UIMPORT_C
sl@0	2544
sl@0	2545	/** @internalComponent */
sl@0	2546	#define UEXPORT_C
sl@0	2547	#else
sl@0	2548	#define KIMPORT_C
sl@0	2549	#define KEXPORT_C
sl@0	2550	#define UIMPORT_C IMPORT_C
sl@0	2551	#define UEXPORT_C EXPORT_C
sl@0	2552	#endif
sl@0	2553
sl@0	2554
sl@0	2555
sl@0	2556
sl@0	2557	/**
sl@0	2558	@publishedAll
sl@0	2559	@released
sl@0	2560
sl@0	2561	Asserts that a condition is true at compilation time.
sl@0	2562
sl@0	2563	@param x Condition to assert
sl@0	2564	*/
sl@0	2565	#define __ASSERT_COMPILE(x) void __compile_time_assert(int __check[(x)?1:-1])
sl@0	2566
sl@0	2567	#ifdef __REMOVE_PLATSEC_DIAGNOSTICS__
sl@0	2568	/**
sl@0	2569	@publishedPartner
sl@0	2570	@released
sl@0	2571	*/
sl@0	2572	#ifndef __REMOVE_PLATSEC_DIAGNOSTIC_STRINGS__
sl@0	2573	#define __REMOVE_PLATSEC_DIAGNOSTIC_STRINGS__
sl@0	2574	#endif /__REMOVE_PLATSEC_DIAGNOSTIC_STRINGS__/
sl@0	2575	#endif /__REMOVE_PLATSEC_DIAGNOSTICS__/
sl@0	2576
sl@0	2577	/**
sl@0	2578	@internalComponent
sl@0	2579	*/
sl@0	2580	static const char* const KSuppressPlatSecDiagnosticMagicValue = (const char*)1;
sl@0	2581
sl@0	2582	#ifndef __REMOVE_PLATSEC_DIAGNOSTIC_STRINGS__
sl@0	2583	/**
sl@0	2584	@internalComponent
sl@0	2585	*/
sl@0	2586	#define __PLATSEC_DIAGNOSTIC_FILE_AND_LINE_HELPER(l) #l
sl@0	2587	/**
sl@0	2588	@internalComponent
sl@0	2589	*/
sl@0	2590	#define __PLATSEC_DIAGNOSTIC_FILE_AND_LINE_HELPER2(f,l) f "(" __PLATSEC_DIAGNOSTIC_FILE_AND_LINE_HELPER(l) ")"
sl@0	2591	/**
sl@0	2592	@publishedPartner
sl@0	2593	@released
sl@0	2594	*/
sl@0	2595	#define __PLATSEC_DIAGNOSTIC_FILE_AND_LINE __PLATSEC_DIAGNOSTIC_FILE_AND_LINE_HELPER2(__FILE__,__LINE__)
sl@0	2596
sl@0	2597	/**
sl@0	2598	@publishedPartner
sl@0	2599	@released
sl@0	2600
sl@0	2601	A macro that should be used to enclose a platform security diagnostic
sl@0	2602	'C' style string that can be passed to a capability checking function such
sl@0	2603	as RThread::HasCapability() and Kern::CurrentThreadHasCapability().
sl@0	2604
sl@0	2605	The content of the string is emitted if the capability test finds that
sl@0	2606	the capability is not present.
sl@0	2607
sl@0	2608	The macro provides a convenient mechanism that allows the strings to
sl@0	2609	be removed from future versions of Symbian OS.
sl@0	2610
sl@0	2611	For example:
sl@0	2612
sl@0	2613	@code
sl@0	2614	if(!Kern::CurrentThreadHasCapability(ECapabilityPowerMgmt,__PLATSEC_DIAGNOSTIC_STRING("Checked by Hal function EDisplayHalSetState")))
sl@0	2615	{
sl@0	2616	return KErrPermissionDenied;
sl@0	2617	}
sl@0	2618	@endcode
sl@0	2619
sl@0	2620	In this example, the string:
sl@0	2621
sl@0	2622	@code
sl@0	2623	Checked by Hal function EDisplayHalSetState
sl@0	2624	@endcode
sl@0	2625
sl@0	2626	is emitted if the calling process does not have the ECapabilityPowerMgmt capability.
sl@0	2627
sl@0	2628	@param s A C-style string.
sl@0	2629
sl@0	2630	@see RProcess::HasCapability()
sl@0	2631	@see RThread::HasCapability()
sl@0	2632	@see RMessagePtr2::HasCapability()
sl@0	2633	@see User::CreatorHasCapability()
sl@0	2634	*/
sl@0	2635	#define __PLATSEC_DIAGNOSTIC_STRING(s) s
sl@0	2636
sl@0	2637	/**
sl@0	2638	When this value is used in Platform Security APIs as the value for the aDiagnosticText
sl@0	2639	argument, these APIs will not emit any form of diagnostic message.
sl@0	2640	@publishedPartner
sl@0	2641	@released
sl@0	2642	*/
sl@0	2643	// Note this value is the same as KSuppressPlatSecDiagnosticMagicValue
sl@0	2644	// and used to be a set by it but that caused an error with GCCE compiler
sl@0	2645	static const char* const KSuppressPlatSecDiagnostic = (const char*)1;
sl@0	2646
sl@0	2647	#else /* __REMOVE_PLATSEC_DIAGNOSTIC_STRINGS__ */
sl@0	2648
sl@0	2649	#define __PLATSEC_DIAGNOSTIC_STRING(s) NULL
sl@0	2650
sl@0	2651	#ifndef __KERNEL_MODE__
sl@0	2652	#ifndef __REMOVE_PLATSEC_DIAGNOSTICS__
sl@0	2653	/**
sl@0	2654	When this value is used in Platform Security APIs as the value for the aDiagnostic
sl@0	2655	argument, these APIs will not emit any form of diagnostic message.
sl@0	2656	@publishedPartner
sl@0	2657	@released
sl@0	2658	*/
sl@0	2659	#define KSuppressPlatSecDiagnostic NULL, NULL
sl@0	2660
sl@0	2661	#else /* __REMOVE_PLATSEC_DIAGNOSTICS__ */
sl@0	2662
sl@0	2663	/**
sl@0	2664	When this value is used in Platform Security APIs as the value for the aDiagnostic
sl@0	2665	argument, these APIs will not emit any form of diagnostic message.
sl@0	2666	@publishedPartner
sl@0	2667	@released
sl@0	2668	*/
sl@0	2669	#define KSuppressPlatSecDiagnostic NULL
sl@0	2670
sl@0	2671	#endif /* !__REMOVE_PLATSEC_DIAGNOSTICS__ */
sl@0	2672	#endif /* !__KERNEL_MODE__ */
sl@0	2673	#endif /* !__REMOVE_PLATSEC_DIAGNOSTIC_STRINGS__ */
sl@0	2674
sl@0	2675	/*
sl@0	2676	* MSVC operator new and operator new[] header guards
sl@0	2677	*/
sl@0	2678	#ifdef __PLACEMENT_NEW
sl@0	2679	#define __PLACEMENT_NEW_INLINE
sl@0	2680	#endif /* __PLACEMENT_NEW */
sl@0	2681
sl@0	2682	#if defined(__VC32__) && (_MSC_VER < 1300)
sl@0	2683	#define __PLACEMENT_VEC_NEW_INLINE
sl@0	2684	#define __OMIT_VEC_OPERATOR_NEW_DECL__
sl@0	2685	#endif /* version of MSVC that doesn't support overloaded operator new[] */
sl@0	2686
sl@0	2687	/**
sl@0	2688	Calling convention qualifier for functions involving floating point
sl@0	2689	variables passed or returned by value.
sl@0	2690	@publishedAll
sl@0	2691	@released
sl@0	2692	*/
sl@0	2693	#ifndef __SOFTFP
sl@0	2694	#define __SOFTFP
sl@0	2695	#endif /* __SOFTFP */
sl@0	2696
sl@0	2697	#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
sl@0	2698	#include <e32def_private.h>
sl@0	2699	#endif
sl@0	2700
sl@0	2701	#endif /* __E32DEF_H__ */

author	sl@SLION-WIN7.fritz.box
	Fri, 15 Jun 2012 03:10:57 +0200
changeset 0	bde4ae8d615e
permissions	-rw-r--r--