macros.h File Reference

#include <ilog/ports.h>

Macros
#define	IL_EXPLICIT
	Synonym of the C++ keyword explicit. More...
#define	IL_STDPREF
	The prefix for std classes. More...
#define	IL_STDUSE
	Uses the std namespace. More...
#define	IlAbs(v)
	Returns the absolute value of a value. More...
#define	IlFalse
	The constant false. More...
#define	IlMax(v1, v2)
	Returns the maximum of two values. More...
#define	IlMin(v1, v2)
	Returns the minimum of two values. More...
#define	IlTrue
	The constant true. More...

Typedefs
typedef void *	IlAny
	The type that can hold any pointer value. More...
typedef int	IlBoolean
	The type that holds Boolean values. More...
typedef double	IlDouble
	Double precision type. More...
typedef float	IlFloat
	Single precision type. More...
typedef long	IlInt
	The type that can hold all signed 32-bit integer values. More...
typedef short	IlShort
	The type that can hold all signed 16-bit integer values. More...
typedef unsigned char	IlUChar
	The type that can hold all unsigned 8-bit integer values. More...
typedef unsigned long	IlUInt
	The type that can hold all unsigned 32-bit integer values. More...
typedef unsigned short	IlUShort
	The type that can hold all unsigned 16-bit integer values. More...

Detailed Description

Library: ilog
Common declarations for Rogue Wave Views products.

Macro Definition Documentation

IL_EXPLICIT

#define IL_EXPLICIT

Synonym of the C++ keyword explicit.

On compilers that do not support the keyword, this macro does nothing.

IL_STDPREF

#define IL_STDPREF

The prefix for std classes.

This macro is equivalent to std:: otherwise.
This macro can be use before all the class names that are part of the C++ std lib, so that the code is portable, because all platforms do not support the STL yet. This macro is useful only if IL_STD is defined, which is true for all supported platforms since Views 5.7.

IL_STDUSE

#define IL_STDUSE

Uses the std namespace.

This macro is equivalent to using namespace std; otherwise.
Use this macro to declare the std namespace as a current namespace scope. This makes the code more portable from platforms that support the new C++ language definition, and those that do not. This macro is useful only if IL_STD is defined, which is true for all supported platforms since Views 5.7.

IlAbs

#define IlAbs

(

v

)

Returns the absolute value of a value.

This is defined as a macro for the types IlInt, IlUInt, IlShort, IlUShort, IlFloat and IlDouble.

Parameters

v	The input value.

Returns

The absolute value of v that is, v if v is positive, and (-v) if v is negative.

IlFalse

const IlBoolean IlFalse

The constant false.

This constant represents the false value for an IlBoolean value.
It is equivalent to false for compilers that support the internal bool type.

IlMax

#define IlMax	(		v1,
			v2
	)

Returns the maximum of two values.

This is defined as a macro for the types int, long, short, float and double. v1 and v2 must have the same type (or be able to cast themselves to the type of the other).

Parameters

v1	The first input value.
v2	The second input value.

Returns

The maximum value of v1 and v2 that is, v1 if v1 is greater than v2, and v2 if v2 is greater than v1.

IlMin

#define IlMin	(		v1,
			v2
	)

Returns the minimum of two values.

This is defined as a macro for the types int, unsigned int, long, unsigned long, short, unsigned short, float and double.
v1 and v2 must have the same type (or be able to cast themselves to the type of the other).

Parameters

v1	The first input value.
v2	The second input value.

Returns

The minimum value of v1 and v2 that is, v1 if v2 is greater than v1, and v2 if v1 is greater than v2.

IlTrue

const IlBoolean IlTrue

The constant true.

This constant represents the true value for an IlBoolean value.
It is equivalent to true for compilers that support the internal bool type.

Typedef Documentation

IlAny

IlAny

The type that can hold any pointer value.

The IlAny type stores any pointer.

IlBoolean

IlBoolean

The type that holds Boolean values.

The type IlBoolean deals with Boolean entities. Boolean values within Rogue Wave Views are always handled by means of IlBoolean objects. A value is considered to be true when set to IlTrue, and false when set to IlFalse.
Note that this is equivalent to the internal bool type of compilers that support it.

IlDouble

IlDouble

Double precision type.

The IlDouble type is the Rogue Wave Views type used internally for the values that hold double precision numbers.

IlFloat

IlFloat

Single precision type.

The IlFloat type is the Rogue Wave Views type used internally for the values that hold single precision numbers.

IlInt

IlInt

The type that can hold all signed 32-bit integer values.

The IlInt type stores any signed integer value on 32 bits. This type provides a fixed size type that is supported by all the C++ compilers.

IlShort

IlShort

The type that can hold all signed 16-bit integer values.

The IlShort type stores any signed integer value on 16 bits. This type provides a fixed size type that is supported by all the C++ compilers.

IlUChar

IlUChar

The type that can hold all unsigned 8-bit integer values.

The IlUChar type stores any unsigned integer value on 8 bits. This type provides a fixed size type that is supported by all the C++ compilers.

IlUInt

IlUInt

The type that can hold all unsigned 32-bit integer values.

The IlUInt type stores any unsigned integer value on 32 bits. This type provides a fixed size type that is supported by all the C++ compilers.

IlUShort

IlUShort

The type that can hold all unsigned 16-bit integer values.

The IlUShort type stores any unsigned integer value on 16 bits. This type provides a fixed size type that is supported by all the C++ compilers.