wfio.h File Reference

Information about this WFIO installation. More...

Go to the source code of this file.

Namespaces
	wfio
	The root namespace for WFIO.

Macros
#define	WFIO_VERSION_MAJOR   0
	Obtain the major version of this WFIO installation. More...
#define	WFIO_VERSION_MINOR   0
	Obtain the minor version of this WFIO installation. More...
#define	WFIO_VERSION_PATCH   5
	Obtain the patchlevel version of this WFIO installation. More...
#define	WFIO_VERSION_EQ(MAJOR, MINOR)   ((WFIO_VERSION_MAJOR == MAJOR) & (WFIO_VERSION_MINOR == MINOR))
	Determine if the WFIO version is equal to MAJOR.MINOR. More...
#define	WFIO_VERSION_EQ3(MAJOR, MINOR, PATCH)
	Determine if the WFIO version is equal to MAJOR.MINOR. More...
#define	WFIO_VERSION_NE(MAJOR, MINOR)   ((WFIO_VERSION_MAJOR != MAJOR) | (WFIO_VERSION_MINOR != MINOR))
	Determine if the WFIO version is not equal to MAJOR.MINOR. More...
#define	WFIO_VERSION_NE3(MAJOR, MINOR, PATCH)
	Determine if the WFIO version is not equal to MAJOR.MINOR. More...
#define	WFIO_VERSION_AT_LEAST(MAJOR, MINOR)
	Determine if the WFIO version is at least MAJOR.MINOR. More...
#define	WFIO_VERSION_AT_LEAST3(MAJOR, MINOR, PATCH)
	Determine if the WFIO version is at least MAJOR.MINOR.PATCH. More...
#define	WFIO_VERSION_NO_GREATER(MAJOR, MINOR)
	Determine if the WFIO version is no greater than MAJOR.MINOR. More...
#define	WFIO_VERSION_NO_GREATER3(MAJOR, MINOR, PATCH)
	Determine if the WFIO version is no greater than MAJOR.MINOR.PATCH. More...
#define	WFIO_VERSION_IN_RANGE(MINMAJ, MINMIN, MAXMAJ, MAXMIN)
	Determine if the WFIO version is between MINMAJ.MINMAX and MAXMAJ.MAXMIN inclusive. More...
#define	WFIO_VERSION_IN_RANGE3(MINMAJ, MINMIN, MINPATCH, MAXMAJ, MAXMIN, MAXPATCH)
	Determine if the WFIO version is between MINMAJ.MINMAX.MINPATCH and MAXMAJ.MAXMIN.MAXPATCH inclusive. More...

Detailed Description

Information about this WFIO installation.

This file contains macros that can be used to obtain information about this particular installation of WFIO. It can be used by the preprocessor to reflect on the installation so that code can be conditionally compiled against different versions. It is used as follows:

#if WFIO_VERSION_AT_LEAST(0,1)
...
#endif

Since

0.0.1

Macro Definition Documentation

WFIO_VERSION_AT_LEAST

#define WFIO_VERSION_AT_LEAST	(		MAJOR,
			MINOR
	)

Value:

(\
    ((WFIO_VERSION_MAJOR > MAJOR)) | \
    ((WFIO_VERSION_MAJOR == MAJOR) & (WFIO_VERSION_MINOR >= MINOR)))

Determine if the WFIO version is at least MAJOR.MINOR.

Parameters

MAJOR	the minimum required major version.
MINOR	the minimum required minimum version.

Returns

Whether or not this version is greater than or equal to the minimum supplied version.

WFIO_VERSION_AT_LEAST3

#define WFIO_VERSION_AT_LEAST3	(		MAJOR,
			MINOR,
			PATCH
	)

Value:

(\
    ((WFIO_VERSION_MAJOR > MAJOR)) | \
    ((WFIO_VERSION_MAJOR == MAJOR) & (WFIO_VERSION_MINOR > MINOR)) | \
    ((WFIO_VERSION_MAJOR == MAJOR) & (WFIO_VERSION_MINOR == MINOR) &\
        (WFIO_VERSION_PATCH >= PATCH)))

Determine if the WFIO version is at least MAJOR.MINOR.PATCH.

Parameters

MAJOR	the minimum required major version.
MINOR	the minimum required minor version.
PATCH	the minimum required patchlevel version.

Returns

Whether or not this version is greater than or equal to the minimum supplied version.

WFIO_VERSION_EQ

#define WFIO_VERSION_EQ	(		MAJOR,
			MINOR
	)		((WFIO_VERSION_MAJOR == MAJOR) & (WFIO_VERSION_MINOR == MINOR))

Determine if the WFIO version is equal to MAJOR.MINOR.

Parameters

MAJOR	the required major version.
MINOR	the required minor version.

Returns

Whether or not this version is equal to the supplied version (not including the patchlevel).

WFIO_VERSION_EQ3

#define WFIO_VERSION_EQ3	(		MAJOR,
			MINOR,
			PATCH
	)

Value:

((WFIO_VERSION_MAJOR == MAJOR) & (WFIO_VERSION_MINOR == MINOR) &\
     (WFIO_VERSION_PATCH == PATCH))

Determine if the WFIO version is equal to MAJOR.MINOR.

Parameters

MAJOR	the required major version.
MINOR	the required minor version.
PATCH	the required patchlevel version.

Returns

Whether or not this version is equal to the supplied version.

WFIO_VERSION_IN_RANGE

#define WFIO_VERSION_IN_RANGE	(		MINMAJ,
			MINMIN,
			MAXMAJ,
			MAXMIN
	)

Value:

(\
    WFIO_VERSION_AT_LEAST(MINMAJ, MINMIN) &\
    WFIO_VERSION_NO_GREATER(MAXMAJ, MAXMIN))

Determine if the WFIO version is between MINMAJ.MINMAX and MAXMAJ.MAXMIN inclusive.

Parameters

MINMAJ	The minimum required major version.
MINMIN	The minimum required minor version.
MAXMAJ	The maximum required major version.
MAXMIN	The maximum required minor version.

Returns

Whether or not this version is between the two specified versions.

WFIO_VERSION_IN_RANGE3

#define WFIO_VERSION_IN_RANGE3	(		MINMAJ,
			MINMIN,
			MINPATCH,
			MAXMAJ,
			MAXMIN,
			MAXPATCH
	)

Value:

(\
    WFIO_VERSION_AT_LEAST3(MINMAJ, MINMIN, MINPATCH) &\
    WFIO_VERSION_NO_GREATER3(MAXMAJ, MAXMIN, MAXPATH))

Determine if the WFIO version is between MINMAJ.MINMAX.MINPATCH and MAXMAJ.MAXMIN.MAXPATCH inclusive.

Parameters

MINMAJ	The minimum required major version.
MINMIN	The minimum required minor version.
MINPATCH	The minimum required minor version.
MAXMAJ	The maximum required major version.
MAXMIN	The maximum required minor version.
MAXPATCH	The maximum required patchlevel version.

Returns

Whether or not this version is between the two specified versions.

WFIO_VERSION_MAJOR

#define WFIO_VERSION_MAJOR   0

Obtain the major version of this WFIO installation.

This function represents X in the version string X.Y.Z.

WFIO_VERSION_MINOR

#define WFIO_VERSION_MINOR   0

Obtain the minor version of this WFIO installation.

This function represents Y in the version string X.Y.Z.

WFIO_VERSION_NE

#define WFIO_VERSION_NE	(		MAJOR,
			MINOR
	)		((WFIO_VERSION_MAJOR != MAJOR) | (WFIO_VERSION_MINOR != MINOR))

Determine if the WFIO version is not equal to MAJOR.MINOR.

Parameters

MAJOR	the forbidden major version.
MINOR	the forbidden minor version.

Returns

Whether or not this version is not equal to the supplied version (not including the patchlevel).

WFIO_VERSION_NE3

#define WFIO_VERSION_NE3	(		MAJOR,
			MINOR,
			PATCH
	)

Value:

((WFIO_VERSION_MAJOR != MAJOR) | (WFIO_VERSION_MINOR != MINOR) |\
     (WFIO_VERSION_PATCH != PATCH))

Determine if the WFIO version is not equal to MAJOR.MINOR.

Parameters

MAJOR	the forbidden major version.
MINOR	the forbidden minor version.
PATCH	the forbidden patchlevel version.

Returns

Whether or not this version is not equal to the supplied version.

WFIO_VERSION_NO_GREATER

#define WFIO_VERSION_NO_GREATER	(		MAJOR,
			MINOR
	)

Value:

(\
    ((WFIO_VERSION_MAJOR < MAJOR)) | \
    ((WFIO_VERSION_MAJOR == MAJOR) & (WFIO_VERSION_MINOR <= MINOR)))

Determine if the WFIO version is no greater than MAJOR.MINOR.

Parameters

MAJOR	the maximum required major version.
MINOR	the maximum required minor version.

Returns

Whether or not this version is less than or equal to the minimum supplied version.

WFIO_VERSION_NO_GREATER3

#define WFIO_VERSION_NO_GREATER3	(		MAJOR,
			MINOR,
			PATCH
	)

Value:

(\
    ((WFIO_VERSION_MAJOR < MAJOR)) | \
    ((WFIO_VERSION_MAJOR == MAJOR) & (WFIO_VERSION_MINOR < MINOR)) | \
    ((WFIO_VERSION_MAJOR == MAJOR) & (WFIO_VERSION_MINOR == MINOR) &\
        (WFIO_VERSION_PATCH <= PATCH)))

Determine if the WFIO version is no greater than MAJOR.MINOR.PATCH.

Parameters

MAJOR	the maximum required major version.
MINOR	the maximum required minor version.
PATCH	the maximum required patchlevel version.

Returns

Whether or not this version is less than or equal to the minimum supplied version.

WFIO_VERSION_PATCH

#define WFIO_VERSION_PATCH   5

Obtain the patchlevel version of this WFIO installation.

This function represents Z in the version string X.Y.Z.