// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of the License "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// e32\include\e32panic.h

// 

//

/**

 @file e32panic.h

 @publishedAll

 @released

*/

#ifndef __E32PANIC_H__

#define __E32PANIC_H__

/**

Defines a set of panic numbers associated with the USER panic category.

Some of these numbers are also associated with panics raised on

the kernel side, and may be associated with 

a number of category names, including KERN-COMMON, KERN-HEAP etc.

*/

enum TCdtPanic

	{

	/**

	A thread has called User::Invariant(). 

    Typically, User::Invariant() is called when a test for a class

    invariant fails, i.e. when a test which checks that the internal data

    of an object is self-consistent, fails. 

    Check the design and implementation of your class.

    @see User

	*/

	EInvariantFalse=0,

	/**

	Not used.

	*/

	ETDateTimeUnderflow=1,

	/**

    Not used.

	*/

	ETDateTimeBadDate=2,

	/**

	A TDateTime object has been constructed with an invalid date or time field.

    @see TDateTime

	*/

	ETDateTimeBadDateTime=3,

    /**

    Not used.

	*/

	ETDateTimeAddDaysRange=4,

	/**

    Not used.

	*/

	ETDateTimeAddMonthsRange=5,

	/**

    Not used.

	*/

	ETDateTimeDaySecNegative=6,

	/**

	A panic raised by the Ptr() member function of a 16-bit descriptor

	if the descriptor is invalid.

	@see TDesC16::Ptr()

	*/

	ETDes16BadDescriptorType=7,

	/**

	The length value passed to a 16-bit variant descriptor member

	function is invalid.

	This panic may be raised by some descriptor constructors and, specifically,

	by the Replace() and Set() descriptor member functions.

	@see TDes16

	*/

	ETDes16LengthOutOfRange=8,

	/**

	The index value passed to the 16-bit variant descriptor Operator[] is

	out of bounds.

	*/

	ETDes16IndexOutOfRange=9,

	/**

	The position value passed to a 16-bit variant descriptor member function

	is out of bounds.

	The panic can be raised by the Left(), Right(), Mid(), Insert(), Delete()

	and Replace() member functions of TDes16.

    @see TDes16

	*/

	ETDes16PosOutOfRange=10,

	/**

	An operation to move or copy data to a 16-bit variant descriptor,

	will cause the length of that descriptor to exceed its maximum length.

	This may be caused by any of the copying, appending or formatting member

	functions but, specifically, by the Insert(), Replace(), Fill(), Fillz(),

	and ZeroTerminate() descriptor member functions. It can also be caused by

	the SetLength() function.

    @see TDes16

	*/

	ETDes16Overflow=11,

	/**

	The format string passed to the 16-bit variant descriptor member functions

	Format() and AppendFormat() has incorrect syntax.

    @see TDes16

	*/

	ETDes16BadFormatDescriptor=12,

	/**

	An invalid variable list has been passed to the AppendFormatList() member

	function of the 16-bit variant descriptor TDes16, when the format is %S or %s.

    This panic is raised in debug builds only.

    @see TDes16

	*/

	ETDes16BadFormatParams=13,

	/**

	This panic is raised when expanding or contracting an HBufC16 buffer using

	the ReAlloc() or ReAllocL() descriptor member functions and the new

	specified length is too small to contain the data.

	@see HBufC16

	*/

	ETDes16ReAllocTooSmall=14,

	/**

	Not used.

	*/

	ETDes16RemoteBadDescriptorType=15,

    /**

	In a call to the Replace() member function of the 16-bit variant

	descriptor TDes16,the length of the source descriptor is negative

	or exceeds the maximum length of the target descriptor.

    @see TDes16

	*/

	ETDes16RemoteLengthOutOfRange=16,

	/**

	A 16-bit variant descriptor is being constructed with a negative

	length value.

	This panic may also be raised if the Set(), Repeat() and the Find() member

	functions are passed negative length values.

	*/

	ETDes16LengthNegative=17,

	/**

	A 16-bit variant descriptor is being constructed with a negative maximum 

	length value.

	*/

	ETDes16MaxLengthNegative=18,

	/**

	A panic raised by the Ptr() member function of an 8-bit descriptor

	if the descriptor is invalid.

	@see TDesC8::Ptr()

	*/

	ETDes8BadDescriptorType=19,

	/**

	The length value passed to an 8-bit variant descriptor member

	function is invalid.

	This panic may be raised by some descriptor constructors and, specifically,

	by the Replace() and Set() descriptor member functions.

	@see TDes8

	*/

	ETDes8LengthOutOfRange=20,

	/**

	The index value passed to the 8-bit variant descriptor Operator[] is

	out of bounds.

	*/

	ETDes8IndexOutOfRange=21,

	/**

	The position value passed to an 8-bit variant descriptor member function

	is out of bounds.

	The panic can be raised by the Left(), Right(), Mid(), Insert(), Delete()

	and Replace() member functions of TDes8

    @see TDes8

	*/

	ETDes8PosOutOfRange=22,

	/**

	An operation to move or copy data to an 8-bit variant descriptor,

	will cause the length of that descriptor to exceed its maximum length.

	This may be caused by any of the copying, appending or formatting member

	functions but, specifically, by the Insert(), Replace(), Fill(), Fillz(),

	and ZeroTerminate() descriptor member functions. It can also be caused by

	the SetLength() function.

    @see TDes8

	*/

    ETDes8Overflow=23,

	/**

	The format string passed to the 8-bit variant descriptor member functions

	Format() and AppendFormat() has incorrect syntax.

    @see TDes8

	*/

	ETDes8BadFormatDescriptor=24,

	/**

	An invalid variable list has been passed to the AppendFormatList() member

	function of the 8-bit variant descriptor TDes8, when the format is %S or %s.

    This panic is raised in debug builds only.

    @see TDes8

	*/

	ETDes8BadFormatParams=25,

	/**

	This panic is raised when expanding or contracting an HBufC8 buffer using

	the ReAlloc() or ReAllocL() descriptor member functions and the new

	specified length is too small to contain the data.

	@see HBufC8

	*/

	ETDes8ReAllocTooSmall=26,

	/**

	Not used.

	*/

	ETDes8RemoteBadDescriptorType=27,

    /**

	In a call to the Replace() member function of the 8-bit variant

	descriptor TDes8,the length of the source descriptor is negative

	or exceeds the maximum length of the target descriptor.

    @see TDes8

	*/

	ETDes8RemoteLengthOutOfRange=28,

	/**

	An 8-bit variant descriptor is being constructed with a negative

	length value.

	This panic may also be raised if the Set(), Repeat() and the Find() member

	functions are passed negative length values.

	*/

	ETDes8LengthNegative=29,

	/**

	An 8-bit variant descriptor is being constructed with a negative maximum 

	length value.

	*/

	ETDes8MaxLengthNegative=30,

	/**

	Not used.

	*/

	ETEntLeaveWithoutEnter=31,

	/**

	It is raised by TRawEvent::Pos() when

	the event is not a mouse/pen type event.

    This panic is raised in debug builds only.

    */

	ETEventNotMoveType=32,

	/**

    It is raised by TRawEvent::ScanCode() when

    the event is not a key down, up or repeat event.

   	This panic is raised in debug builds only.

	*/

	ETEventNotKeyType=33,

	/**

    It is raised by TRawEvent::Modifiers() when

    the event is not a modifier update event.

   	This panic is raised in debug builds only.

	*/

    ETEventNotUpdateModifiersType=34,

    /**

    This panic is raised by the default At() virtual member function of TKey.

    The function is intended to be overridden by a derived class.

    @see TKey

    */

	ETFuncTKeyVirtualAt=35,

	/**

	This panic is raised by the default Swap() virtual member function of TSwap.

	The function is intended to be overridden by a derived class.

	@see TSwap

	*/

	ETFuncTSwapVirtualSwap=36,

	/**

	The index value passed to the operator[] of a TUidType is negative

	or is greater than or equal to KMaxCheckedUid.

	@see KMaxCheckedUid

	@see TUidType

	*/

	ETFuncUidTypeBadIndex=37,

	/**

	The length of the descriptor passed to the Set(TDesC8&) member function of TCheckedUid 

	is not equal to the size of a TCheckedUid object.

	@see TCheckedUid

	*/

	ETFuncCheckedUidBadSet=38,

	/**

	The size specified of a new heap is smaller than the permitted minimum;

	it must be at least the size of a RHeap object.

	On the user side this is associated with the USER category; on the kernel side

	this is associated with the KERN-HEAP category.

	*/

	ETHeapNewBadSize=39,

	/**

	Not used.

	*/

	ETHeapCreateSizeTooSmall=40,

	/**

	In a call to UserHeap::ChunkHeap(), the value defining the minimum length

	of the heap is greater than the value defining the maximum length to

	which the heap can grow.

    @see UserHeap

	*/

	ETHeapCreateMaxLessThanMin=41,

	/**

	In a call to the RHeap member functions, AllocLen(), Free(), FreeZ(),

	ReAlloc(), ReAllocL(), Adjust() and AdjustL(), a pointer passed to these

	functions does not point to a valid cell.

	On the user side this is associated with the USER category; on the kernel side

	this is associated with the KERN-HEAP category.

	*/

	ETHeapBadCellAddress=42,

	/**

	In a call to the Adjust() and AdjustL() member functions of RHeap, a heap

	cell is being shrunk and the amount by which the cell is being shrunk

	is less than the current length of the cell.

	*/

	ETHeapAdjustTooSmall=43,

	/**

	In a call to the Free() and FreeZ() member functions of RHeap,the cell

	being freed overlaps the next cell on the free list (i.e. the first cell

	on the free list with an address higher than the one being freed).

	*/

	ETHeapFreeBadNextCell=44,

	/**

	In a call to the Free() and FreeZ() member functions of RHeap, the cell

	being freed overlaps the previous cell on the free list (i.e. the last cell

	on the free list with an address lower than the one being freed).

	*/

	ETHeapFreeBadPrevCell=45,

	/**

	In a call to the ReAlloc() and ReAllocL() member functions of RHeap, the

	cell being reallocated overlaps the next cell on the free list (i.e. the

	first cell on the free list with an address higher than the one being

	reallocated).

	*/

	ETHeapReAllocBadNextCell=46,

	/**

	In a call to the Alloc(), AllocL() or AllocLC() member functions of RHeap,

	an attempt has been made to allocate a cell from a heap, using an unsigned

	size value which is greater than or equal to the value of KMaxTInt/2.

    This panic may also be raised by the heap walker when it finds a bad

    allocated heap cell size.

    @see User::Check()

    @see RAllocator::Check()

    @see KMaxTInt

	*/

	ETHeapBadAllocatedCellSize=47,

	/**

	This panic is raised by the heap walker when it finds a bad

	allocated heap cell address.

	*/

	ETHeapBadAllocatedCellAddress=48,

	/**

	This panic is raised by the heap walker when it finds a bad

	free heap cell address.

	*/

	ETHeapBadFreeCellAddress=49,

	/**

	Not used.

	*/

	ETHeapDebugBufferOverflow=50,

	/**

	A call has been made to the __DbgMarkEnd() member function of RHeap, when

	there has been no corresponding call to the __DbgMarkStart() member function.

	This panic is also raised when there are more calls to __DbgMarkEnd() than

	to __DbgMarkStart(). These functions are part of the debug assistance provided by

	the RHeap class.

    This panic is raised in debug builds only.

	*/

	ETHeapDebugUnmatchedCallToCheckHeap=51,

	/**

	In a call to the Adjust() and AdjustL() member functions of an RHeap,

	the offset from the start of the cell being stretched or shrunk is

	a negative value.

	*/

	ETHeapAdjustOffsetNegative=52,

	/**

	Not used.

	*/