constants.h File Reference

Copyright © Audi Electronics Venture GmbH. More...

Go to the source code of this file.

Macros
#define	A_UTILS_GLOBAL   /* */ /* g_... */
	prefix for global variables / objects
#define	A_UTILS_MEMBER   /* */ /* m_... */
	prefix for members variables / objects
#define	A_UTILS_LOCAL   auto /* l_... */
	prefix for local variables / objects
#define	A_UTILS_STATIC   static /* s_... */
	prefix for static variables / objects
#define	A_UTILS_EXTERN   extern /* g_... */
	prefix for extern variables / objects
#define	A_UTILS_REGIST   register /* r_... */
	prefix for register variables / objects
#define	IN   /* in */
	definition for an incoming paramater
#define	OUT   /* out */
	definition for an outcoming paramater
#define	INOUT   /* in,out */
	definition for an in and outcoming paramater
#define	OPTIONAL   /* optional */
	definition for an optional paramater
#define	UNUSED   /* unused */
	definition for an in and outcoming paramater to functions
#define	tFalse   false
	Value for tBool.
#define	tTrue   true
	Value for tBool.
#define	INVALID_SIZE   0xFFFFFFFF
	default value for invalid size
#define	INVALID_POS   0xFFFFFFFF
	default value for invalid positions
#define	INVALID_HANDLE   0xFFFFFFFF
	default value for invalid handles
#define	BIT0   0x0001
	Define for the value of bit 0.
#define	BIT1   0x0002
	Define for the value of bit 1.
#define	BIT2   0x0004
	Define for the value of bit 2.
#define	BIT3   0x0008
	Define for the value of bit 3.
#define	BIT4   0x0010
	Define for the value of bit 4.
#define	BIT5   0x0020
	Define for the value of bit 5.
#define	BIT6   0x0040
	Define for the value of bit 6.
#define	BIT7   0x0080
	Define for the value of bit 7.
#define	BIT8   0x0100
	Define for the value of bit 8.
#define	BIT9   0x0200
	Define for the value of bit 9.
#define	BIT10   0x0400
	Define for the value of bit 10.
#define	BIT11   0x0800
	Define for the value of bit 11.
#define	BIT12   0x1000
	Define for the value of bit 12.
#define	BIT13   0x2000
	Define for the value of bit 13.
#define	BIT14   0x4000
	Define for the value of bit 14.
#define	BIT15   0x8000
	Define for the value of bit 15.
#define	BIT16   0x00010000
	Define for the value of bit 16.
#define	BIT17   0x00020000
	Define for the value of bit 17.
#define	BIT18   0x00040000
	Define for the value of bit 18.
#define	BIT19   0x00080000
	Define for the value of bit 19.
#define	BIT20   0x00100000
	Define for the value of bit 20.
#define	BIT21   0x00200000
	Define for the value of bit 21.
#define	BIT22   0x00400000
	Define for the value of bit 22.
#define	BIT23   0x00800000
	Define for the value of bit 23.
#define	BIT24   0x01000000
	Define for the value of bit 24.
#define	BIT25   0x02000000
	Define for the value of bit 25.
#define	BIT26   0x04000000
	Define for the value of bit 26.
#define	BIT27   0x08000000
	Define for the value of bit 27.
#define	BIT28   0x10000000
	Define for the value of bit 28.
#define	BIT29   0x20000000
	Define for the value of bit 29.
#define	BIT30   0x40000000
	Define for the value of bit 30.
#define	BIT31   0x80000000
	Define for the value of bit 31.
#define	fHIGHBYTE(x)   ( (( x ) & 0xFF00) >> 8 )
#define	fLOWBYTE(x)   ( ( x ) & 0x00FF )
#define	fHIGHWORD(x)   ( (( x ) & 0xFFFF0000) >> 16 )
#define	fLOWWORD(x)   ( ( x ) & 0x0000FFFF )
#define	PLATFORM_NOT_SUPPORTED   0x00
	defines a common value for unsupportes platform
#define	PLATFORM_LITTLE_ENDIAN_8   0x01
	defines the little endianess value, that will be retrieved by More...
#define	PLATFORM_BIG_ENDIAN_8   0x02
	defines the big endianess value, that will be retrieved by More...
#define	PLATFORM_BYTEORDER   __get_platform_byteorder()
	defines a link to __get_platform_byteorder.
#define	PLATFORM_COMPILER_MSVC7_RELEASE   1300
	defines the MS VC++ Compiler 7 release value (VS 2003)
#define	PLATFORM_COMPILER_MSVC7_DEBUG   11300
	defines the MS VC++ Compiler 7 debug value (VS 2003)
#define	PLATFORM_COMPILER_MSVC8_RELEASE   1400
	defines the MS VC++ Compiler 8 release value (VS 2005)
#define	PLATFORM_COMPILER_MSVC8_DEBUG   11400
	defines the MS VC++ Compiler 8 debug value (VS 2005)
#define	PLATFORM_COMPILER_MSVC9_RELEASE   1500
	defines the MS VC++ Compiler 9 release value (VS 2008)
#define	PLATFORM_COMPILER_MSVC9_DEBUG   11500
	defines the MS VC++ Compiler 9 debug value (VS 2008)
#define	PLATFORM_COMPILER_MSVC10_RELEASE   1600
	defines the MS VC++ Compiler 10 release value (VS 2010)
#define	PLATFORM_COMPILER_MSVC10_DEBUG   11600
	defines the MS VC++ Compiler 10 debug value (VS 2010)
#define	PLATFORM_COMPILER_MSVC11_RELEASE   1700
	defines the MS VC++ Compiler 11 release value (VS 2012)
#define	PLATFORM_COMPILER_MSVC11_DEBUG   11700
	defines the MS VC++ Compiler 11 debug value (VS 2012)
#define	PLATFORM_COMPILER_MSVC12_RELEASE   1800
	defines the MS VC++ Compiler 12 release value (VS 2013)
#define	PLATFORM_COMPILER_MSVC12_DEBUG   11800
	defines the MS VC++ Compiler 12 debug value (VS 2013)
#define	PLATFORM_COMPILER_MSVC14_RELEASE   1900
	defines the MS VC++ Compiler 14 release value (VS 2015)
#define	PLATFORM_COMPILER_MSVC14_DEBUG   11900
	defines the MS VC++ Compiler 14 debug value (VS 2015)
#define	WINDOWS_SYSTEM_MAJOR_VERSION_VISTA   6
	Major Version for Vista.
#define	WINDOWS_SYSTEM_MINOR_VERSION_VISTA   0
	Minor Version for Vista.
#define	WINDOWS_SYSTEM_MAJOR_VERSION_XP   5
	Major Version for WinXP.
#define	WINDOWS_SYSTEM_MINOR_VERSION_XP   1
	Minor Version for WinXP.
#define	WINDOWS_SYSTEM_MAJOR_VERSION_2000   5
	Major Version for WinXP System.
#define	WINDOWS_SYSTEM_MINOR_VERSION_2000   0
	Minor Version for WinXP System.
#define	PLATFORM_COMPILER_CURRENT   0
	On Windows this define will be set to the current compiler version of MS VC++. More...
#define	_stricmp   strcasecmp
	maps the _stricmp to the unix strcasecmp
#define	_strnicmp   strncasecmp
	maps the _strnicmp to the unix strncasecmp
#define	A_UTILS_DEPRECATED(_func_)   __attribute__ ((deprecated)) _func_
	Mark a function or variable as deprecated. More...
#define	A_UTILS_CLASS_DEPRECATED_BEGIN
	Helper macro for A_UTILS_DEPRECATED.
#define	A_UTILS_CLASS_DEPRECATED_END   __attribute__ ((deprecated))
	Helper macro for A_UTILS_DEPRECATED.
#define	A_UTILS_DEPRECATED_MESSAGE(_depr_message_)   [[deprecated(_depr_message_)]]
	Mark a function or variable as deprecated. More...

Functions
static unsigned char	__get_platform_byteorder ()
	This function retrieves the platform dependent byte order. More...

Detailed Description

Copyright © Audi Electronics Venture GmbH.

All rights reserved

Definition in file constants.h.

Macro Definition Documentation

A_UTILS_DEPRECATED

#define A_UTILS_DEPRECATED

(

_func_

)

__attribute__ ((deprecated)) _func_

Mark a function or variable as deprecated.

To mark the function

void foo(...); 

as deprecated declare

void A_UTILS_DEPRECATED(foo)(...); 

Parameters

[in]

_func_

The function or variable

Definition at line 267 of file constants.h.

A_UTILS_DEPRECATED_MESSAGE

#define A_UTILS_DEPRECATED_MESSAGE

(

_depr_message_

)

[[deprecated(_depr_message_)]]

Mark a function or variable as deprecated.

To mark the function

void foo(...); 

as deprecated declare

void A_UTILS_DEPRECATED_MESSAGE("foo is deprecated") void foo(...); 

Parameters

[in]

_depr_message_

The message

Definition at line 275 of file constants.h.

fHIGHBYTE

#define fHIGHBYTE

(

x

)

( (( x ) & 0xFF00) >> 8 )

Definition at line 108 of file constants.h.

fHIGHWORD

#define fHIGHWORD

(

x

)

( (( x ) & 0xFFFF0000) >> 16 )

Definition at line 111 of file constants.h.

fLOWBYTE

#define fLOWBYTE

(

x

)

( ( x ) & 0x00FF )

Definition at line 109 of file constants.h.

fLOWWORD

#define fLOWWORD

(

x

)

( ( x ) & 0x0000FFFF )

Definition at line 112 of file constants.h.

PLATFORM_BIG_ENDIAN_8

#define PLATFORM_BIG_ENDIAN_8   0x02

defines the big endianess value, that will be retrieved by

See also

__get_platform_byteorder.

Definition at line 121 of file constants.h.

PLATFORM_COMPILER_CURRENT

#define PLATFORM_COMPILER_CURRENT   0

On Windows this define will be set to the current compiler version of MS VC++.

On Linux-Gcc it is set to 0.

See also

PLATFORM_COMPILER_MSVC9_RELEASE,
PLATFORM_COMPILER_MSVC9_DEBUG,
PLATFORM_COMPILER_MSVC8_RELEASE,
PLATFORM_COMPILER_MSVC8_DEBUG.

Definition at line 217 of file constants.h.

PLATFORM_LITTLE_ENDIAN_8

#define PLATFORM_LITTLE_ENDIAN_8   0x01

defines the little endianess value, that will be retrieved by

See also

__get_platform_byteorder.

Definition at line 118 of file constants.h.

Function Documentation

__get_platform_byteorder()

static unsigned char __get_platform_byteorder ( )

inlinestatic

This function retrieves the platform dependent byte order.

Returns

PLATFORM_NOT_SUPPORTED, PLATFORM_LITTLE_ENDIAN_8 or PLATFORM_BIG_ENDIAN_8.

Definition at line 130 of file constants.h.

References PLATFORM_BIG_ENDIAN_8, PLATFORM_LITTLE_ENDIAN_8, and PLATFORM_NOT_SUPPORTED.