/*

* Copyright (c) 1994-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\e32def.h

*

* NOTE: THIS FILE SHOULD BE ACCEPTABLE TO A C COMPILER

*/

#ifndef __E32DEF_H__

#define __E32DEF_H__

/*

 * __LEAVE_EQUALS_THROW__ requires the compiler to support C++ exceptions

 */

#ifndef __SUPPORT_CPP_EXCEPTIONS__

#undef __LEAVE_EQUALS_THROW__

#endif

/*

 * RVCT 3.1 and 4.0 read past the end of arrays when the optimiser rotates loops.

 * This only happens when using -O3 -Otime, so force to -O2.

 */

#if __ARMCC_VERSION >= 310000 && !defined(_DEBUG) && !defined(ARMCC_LOOP_ROTATE_DISABLED)

#pragma O2

#endif

#if defined(__VC32__)

/**

@publishedAll

@released

*/

#define __NO_CLASS_CONSTS__

#if (_MSC_VER >= 1200)

/**

@publishedAll

@released

*/

#define __NORETURN__ __declspec(noreturn)

#else

#define __NORETURN__

#endif

/**

@publishedAll

@released

*/

#define __NORETURN_TERMINATOR()

/**

@publishedAll

@released

*/

#define IMPORT_C __declspec(dllexport)

/**

@publishedAll

@released

*/

#define EXPORT_C __declspec(dllexport)

/**

@publishedAll

@released

*/

#define IMPORT_D __declspec(dllexport)

/**

@publishedAll

@released

*/

#define EXPORT_D __declspec(dllexport)

/**

@publishedAll

@released

*/

#define NONSHARABLE_CLASS(x) class x

/**

@publishedAll

@released

*/

#define NONSHARABLE_STRUCT(x) struct x

/**

@publishedAll

@released

*/

#define __NO_THROW throw()

/**

@publishedAll

@released

*/

#define __THROW(t) throw(t)

#pragma warning( disable : 4355 )	/* 'this' used in base member initializer list */

#pragma warning( disable : 4511 )	/* copy constructor could not be generated */

#pragma warning( disable : 4512 )	/* assignment operator could not be generated */

#pragma warning( disable : 4514 )	/* unreferenced inline function has been removed */

#pragma warning( disable : 4699 )	/* Note: Using precompiled header %s */

#pragma warning( disable : 4710 )	/* function not inlined */

#pragma warning( disable : 4121 )	/* alignment sensitive to packing */

#pragma warning( disable : 4273 )

#pragma warning( disable : 4097 )	/* typedef-name 'identifier1' used as synonym for class-name 'identifier2' */

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

#if _MSC_VER  >= 1100

/**

@publishedAll

@released

*/

#define TEMPLATE_SPECIALIZATION template<>

#else

#define TEMPLATE_SPECIALIZATION

#endif

#endif

#if defined(__CW32__)

#undef __embedded_cplusplus

/** @internalTechnology */

#define __embedded_cplusplus	1

#define __NO_CLASS_CONSTS__

#define __NORETURN__

#define __NORETURN_TERMINATOR()

#define IMPORT_C __declspec(dllexport)

#define EXPORT_C __declspec(dllexport)

#define IMPORT_D __declspec(dllexport)

#define EXPORT_D __declspec(dllexport)

#define NONSHARABLE_CLASS(x) class x

#define NONSHARABLE_STRUCT(x) struct x

#define __NO_THROW throw()

#define __THROW(t) throw(t)

#define TEMPLATE_SPECIALIZATION template<>

/**

@publishedAll

@released

*/

#define _asm	asm

#ifndef __int64

#pragma longlong on

/** @internalTechnology */

#define __int64  long long

#endif

#ifndef __SUPPORT_CPP_EXCEPTIONS__

#pragma exceptions off    /* no support for C++ exception handling */

#pragma RTTI off          /* no support for C++ runtime type information */

#endif

#if __MWERKS__ >= 0x3200

#pragma warning off (10480)	/* deleteing void pointer is undefined */

#pragma warning off (10350) /* N pad byte(s) inserted after data member */

#endif

#endif

//

// GCC (ARM) compiler

//

#if defined(__GCC32__) && defined(__MARM__)

#ifndef __GNUC__		/* GCC98r2 doesn't define this for some reason */

#define __GNUC__	2

#endif

#define __NO_CLASS_CONSTS__

#define __NORETURN__  __attribute__ ((noreturn))

#ifdef __GCCV3__

#define __NORETURN_TERMINATOR()

#else

#define __NORETURN_TERMINATOR()		abort()

#endif

#define IMPORT_C

#define IMPORT_D

#if !defined __WINS__ && defined _WIN32 /* VC++ Browser Hack */

#define EXPORT_C

#define EXPORT_D

/** @internalTechnology */

#define asm(x)

#else

#define EXPORT_C __declspec(dllexport)

#define EXPORT_D __declspec(dllexport)

#endif

#define NONSHARABLE_CLASS(x) class x

#define NONSHARABLE_STRUCT(x) struct x

#define __NO_THROW

#define __THROW(t)

#ifdef __EABI__

#define TEMPLATE_SPECIALIZATION template<>

#else

#define TEMPLATE_SPECIALIZATION

#endif

/**

@publishedAll

@released

*/

#define __DOUBLE_WORDS_SWAPPED__

#endif

/** @internalTechnology */

#define __NO_MUTABLE_KEYWORD

#if defined(__NO_MUTABLE_KEYWORD)

/**

@publishedAll

@deprecated

*/

#define __MUTABLE

#else

#define __MUTABLE mutable

#endif

/**

@publishedAll

@deprecated

*/

#define CONST_CAST(type,exp) (const_cast<type>(exp))

/**

@publishedAll

@deprecated

*/

#define STATIC_CAST(type,exp) (static_cast<type>(exp))

/**

@publishedAll

@deprecated

*/

#define REINTERPRET_CAST(type,exp) (reinterpret_cast<type>(exp))

#if defined(__NO_MUTABLE_KEYWORD)

/**

@publishedAll

@deprecated

*/

#define MUTABLE_CAST(type,exp) (const_cast<type>(exp))

#else

#define MUTABLE_CAST(type,exp) (exp)

#endif

/**

@publishedAll

@deprecated

*/

#define GLREF_D extern

/**

@publishedAll

@deprecated

*/

#define GLDEF_D

/**

@publishedAll

@deprecated

*/

#define LOCAL_D static

/**

@publishedAll

@deprecated

*/

#define GLREF_C extern

/**

@publishedAll

@deprecated

*/

#define GLDEF_C

/**

@publishedAll

@deprecated

*/

#define LOCAL_C static

/**

@internalAll

@prototype

*/

#ifndef IMPORT_D

#define IMPORT_D IMPORT_C 

#endif

/**

@publishedAll

@deprecated

*/

#define FOREVER for(;;)

/**

@publishedAll

@released

Symbolic definition for a true value.

*/

#define TRUE 1

/**

@publishedAll

@released

Symbolic definition for a false value.

*/

#define FALSE 0

#ifndef NULL

/**

@publishedAll

@released

Symbolic definition for a NULL value.

*/

#define NULL 0

#endif

#ifndef VA_START

/**

@publishedAll

@released

A macro used by Symbian OS code for handling a variable argument list

in a function call.

Sets a pointer to point to the first of the variable arguments.

Typical usage:

@code

Foo(CAbcdef aAbcdef,...)

   {

   VA_LIST list;

   VA_START(list, aAbcdef);

   // other code

   } 

@endcode

@param ap   A pointer used to hold the address of an argument in

            the variable argument list. After execution of the code generated 

            by this macro, the pointer points to the first argument in

            the variable argument list.

            This symbol is usually declared as a VA_LIST type. 

@param pn   The argument that immediately precedes the variable argument list.

@see VA_LIST

@see VA_ARG

*/

#define VA_START(ap,pn) ((ap)[0]=(TInt8 *)&pn+((sizeof(pn)+sizeof(TInt)-1)&~(sizeof(TInt)-1)),(void)0)

#endif

#ifndef VA_ARG

/**

@publishedAll

@released

A macro used by Symbian OS code for handling a variable argument list

in a function call.

Increments a pointer to a variable argument list to point to the next argument

in the list. The current argument is assumed to be of a type defined by

the second parameter to this macro.

Typical usage:

@code

Foo(CAbcdef aAbcdef,...)

   {

   VA_LIST list;

   VA_START(list, aAbcdef);

   ...

   TInt x = VA_ARG(list,TInt);

   ...

   const TDesC *pS=VA_ARG(aList,const TDesC*);

   ... 

   etc

   } 

@endcode

@param ap   A pointer used to hold the address of an argument in

            the variable argument list. It is assumed to point to the current

            argument in the variable argument list. After execution of the code

            generated by this macro, the pointer points to the next argument in

            the list. This symbol is usually declared as a VA_LIST type. 

@param type The type of the current argument.

            This can be any valid type, for example, TInt, const TDesC*, etc.

@see VA_LIST

@see VA_START            

*/

#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)))))

#endif

#ifndef VA_END

/**

@publishedAll

@released

A macro used by Symbian OS code for handling a variable argument list

in a function call.

Sets a pointer to zero.

@param ap   A pointer used to hold the address of an argument in

            the variable argument list. After execution of the code generated 

            by this macro, the pointer is reset to 0.

            This symbol is usually declared as a VA_LIST type. 

@see VA_LIST

@see VA_START

@see VA_ARG            

*/

#define VA_END(ap) ((ap)[0]=0,(void)0)

#endif

/**

@publishedAll

@released

Calculates the offset of member f within class c.

This is used in the TSglQue and TDblQue constructors to set the offset of

the link object from the start of a list element.

@param c The name of the class.

@param f The name of the member within the specified class.

@see TSglQue

@see TDblQue

*/

#ifndef _FOFF

// provide calculation-based version of _FOFF() for when builtin_offsetof()

// can't be used

#define _FOFF_DYNAMIC(c,f)	(((TInt)&(((c *)0x1000)->f))-0x1000)

#if __GNUC__ < 4

#define _FOFF(c,f)			_FOFF_DYNAMIC(c,f)

#else

#define _FOFF(c,f)			(__builtin_offsetof(c,f))

#endif

#endif

/**

@internalTechnology

@released

*/

#define _ALIGN_DOWN(x,a)	((x)&~((a)-1))

/**

@internalTechnology

@released

*/

#define _ALIGN_UP(x,a)		_ALIGN_DOWN((x)+(a)-1, a)

/** 

@publishedAll

@released

Pointer to any type.

TAny* is equivalent to void* in standard C or C++. TAny* is used in preference 

to void* because it is more suggestive of the actual meaning,

e.g. TAny* foo();.

TAny is not used where it really means "nothing", as in the declaration of 

functions which do not return a value; void is used instead, e.g. void Foo();.

*/

typedef void TAny;

/**

@publishedAll

@released

8-bit signed integer type, used in Symbian OS to mean an 8-bit

signed integer, independent of the implementation.

*/

typedef signed char TInt8;

/**

@publishedAll

@released

8-bit unsigned integer type; used in Symbian OS to mean an 8-bit

unsigned integer, independent of the implementation.

*/

typedef unsigned char TUint8;

/**

@publishedAll

@released