mlVersion.h File Reference

#include "mlUtilsSystemC.h"

Go to the source code of this file.

Macros
Version numbers for checks during COMPILE time.
Public header file for ML version support.
#define	ML_MAJOR_VERSION   2
#define	ML_MAJOR_CAPI_VERSION   3
#define	ML_CPPAPI_VERSION   7
#define	ML_CAPI_REVISION   0
#define	ML_REVISION   0
#define	ML_VERSION_STRING   "2.3.7.0.0"

Functions
Version-related functions for RUNTIME checks.
ML_UTILS_EXPORT void	MLGetVersion (MLint32 *majorVersion, MLint32 *majorCAPIVersion, MLint32 *verCPPAPI, MLint32 *revCAPI, MLint32 *rev, const char **vString)
ML_UTILS_EXPORT MLint32	MLIsCAPILinkCompatible (MLint32 majorVersion, MLint32 majorCAPIVersion, MLint32 revCAPI)
ML_UTILS_EXPORT MLint32	MLIsCPPAPILinkCompatible (MLint32 majorVersion, MLint32 majorCAPIVersion, MLint32 verCPPAPI, MLint32 revCAPI)
ML_UTILS_EXPORT MLint32	MLCheckCPPAPILinkCompatibility (MLint32 majorVersion, MLint32 majorCAPIVersion, MLint32 verCPPAPI, MLint32 revCAPI, const char *mlVersionString, const char *initFunctionName)

Macro Definition Documentation

ML_CAPI_REVISION

#define ML_CAPI_REVISION   0

Changes of this number signalize a revision of the C-API of the ML, which normally does not require a recompilation of applications using the ML via the C-API; this is typically caused by additional functionality in the C-API.

Definition at line 43 of file mlVersion.h.

ML_CPPAPI_VERSION

#define ML_CPPAPI_VERSION   7

Changes of this number signalize binary incompatibilities of the C++ interface of the ML, which require a recompilation of all classes using C++ ML symbols sometimes also C++ header file incompatibilities. Note that the C++ API is also considered to have changed if the C-API has changed.

Definition at line 38 of file mlVersion.h.

ML_MAJOR_CAPI_VERSION

#define ML_MAJOR_CAPI_VERSION   3

Changes of this number signalize binary incompatibilities of the C-API of the ML, which require a recompilation of applications using the ML via the C-API.

Definition at line 32 of file mlVersion.h.

ML_MAJOR_VERSION

#define ML_MAJOR_VERSION   2

The major release number that indicates general and essential changes of the ML, which usually imply binary and header file incompatibilities.

Definition at line 28 of file mlVersion.h.

ML_REVISION

#define ML_REVISION   0

Changes of this number indicates any revision of the ML, which do not influence the binary compatibility (also docs, comments, installers); so dependent classes do not need to be recompiled.

Definition at line 48 of file mlVersion.h.

ML_VERSION_STRING

#define ML_VERSION_STRING   "2.3.7.0.0"

Version string constructed like "ML_MAJOR_VERSION.ML_MAJOR_CAPI_VERSION.ML_CPPAPI_VERSION.ML_CAPI_REVISION.ML_REVISION".

Definition at line 52 of file mlVersion.h.

Function Documentation

MLCheckCPPAPILinkCompatibility()

ML_UTILS_EXPORT MLint32 MLCheckCPPAPILinkCompatibility	(	MLint32	majorVersion,
		MLint32	majorCAPIVersion,
		MLint32	verCPPAPI,
		MLint32	revCAPI,
		const char *	mlVersionString,
		const char *	initFunctionName )

Checks whether the C++-API of the ML is link compatible and post errors to the MLErrorOutput if not. It is NOT legal to call this function before MLInitializeUtils() because error handling system must be initialized. Normally it is not necessary to call this function 'manually' since the ML itself performs these checks automatically when initializing the ML or loading modules. A typical call is like

if (MLCheckCPPAPILinkCompatibility(ML_MAJOR_VERSION,
                                   ML_MAJOR_CAPI_VERSION,
                                   ML_CPPAPI_VERSION,
                                   ML_CAPI_REVISION,
                                   ML_VERSION_STRING,
                                   libraryName,
                                   initFunctionName))
{
  executeInitializeLibraryCode();
}

Returns

Non-zero value true if binary compatibility is given and 0 if not.

Parameters

majorVersion	The major release number of the ML (normally specified by ML_MAJOR_VERSION).
majorCAPIVersion	The major C-API version number of the ML-API (normally specified by ML_MAJOR_CAPI_VERSION).
verCPPAPI	The C++-API version number of the ML (normally specified by ML_CPPAPI_VERSION).
revCAPI	The revision number of the C-API of the ML-API (normally specified by ML_CAPI_REVISION).
mlVersionString	must be the NULL-terminated ML version string (normally specified by ML_VERSION_STRING). If NULL is passed, then "<unknown version string>" is used instead.
initFunctionName	is the NULL-terminated string name of the library-init function which is going to be called on after validating the version If passed as NULL "<unknown init function>" is used instead.

References ML_UTILS_EXPORT.

MLGetVersion()

ML_UTILS_EXPORT void MLGetVersion	(	MLint32 *	majorVersion,
		MLint32 *	majorCAPIVersion,
		MLint32 *	verCPPAPI,
		MLint32 *	revCAPI,
		MLint32 *	rev,
		const char **	vString )

Returns version information about the ML. It is legal to call it before the MLInitializeUtils() is called.

Parameters

majorVersion	Returns the compiled major release number specified by ML_MAJOR_VERSION. NULL is ignored, so it may be passed legally if this value is not needed.
majorCAPIVersion	Returns the compiled major C-API version number specified by ML_MAJOR_CAPI_VERSION. NULL is ignored, so it may be passed legally if this value is not needed.
verCPPAPI	Returns the compiled C++-API version number specified by ML_CPPAPI_VERSION. NULL is ignored, so it may be passed legally if this value is not needed.
rev	Returns the compiled ML revision number specified
revCAPI	Returns the compiled C-API revision number specified by ML_CAPI_REVISION. NULL is ignored, so it may be passed legally if this value is not needed. by ML_REVISION. NULL is ignored, so it may be passed legally if this value is not needed.
vString	Returns a NULL-terminated character string as "majorVersion.majorCAPIVersion.revCAPI.verCPPAPI.rev". NULL is ignored, so it may be passed legally if this value is not needed.

References ML_UTILS_EXPORT.

MLIsCAPILinkCompatible()

ML_UTILS_EXPORT MLint32 MLIsCAPILinkCompatible ( MLint32 majorVersion, MLint32 majorCAPIVersion, MLint32 revCAPI )

nodiscard

Checks whether the ML-API is link compatible. It is legal to call this function before MLInitializeUtils() is called.
Normally it is not necessary to call this function 'manually' since the ML itself performs these checks automatically when initializing the ML or loading modules. A typical call is like

//     if (!MLIsCAPILinkCompatible(ML_MAJOR_VERSION,
//                                 ML_MAJOR_CAPI_VERSION,
//                                 ML_CAPI_REVISION)){ handleErr(); }

Returns

Non zero value (=true) if binary compatibility is given and 0 if not.

Parameters

majorVersion	The major release number of the ML (normally specified by ML_MAJOR_VERSION.
majorCAPIVersion	The major C-API version number of the ML-API (normally specified by ML_MAJOR_CAPI_VERSION).
revCAPI	The revision number of the C-API of the ML-API (normally specified by ML_CAPI_REVISION).

References ML_UTILS_EXPORT.

MLIsCPPAPILinkCompatible()

ML_UTILS_EXPORT MLint32 MLIsCPPAPILinkCompatible ( MLint32 majorVersion, MLint32 majorCAPIVersion, MLint32 verCPPAPI, MLint32 revCAPI )

nodiscard

Checks whether the C++-API of the ML is link compatible. It is legal to call this function before MLInitializeUtils() is called.
Normally it is not necessary to call this function 'manually' since the ML itself performs these checks automatically when initializing the ML or loading modules. A typical call is like

//     if (!MLIsCPPAPILinkCompatible(ML_MAJOR_VERSION,
//                                   ML_MAJOR_CAPI_VERSION,
//                                   ML_CPPAPI_VERSION,
//                                   ML_CAPI_REVISION)){ handleErr(); }

Returns

Non zero value (=true) if binary compatibility is given and 0 if not.

Parameters

majorVersion	The major release number of the ML (normally specified by ML_MAJOR_VERSION).
majorCAPIVersion	The major C-API version number of the ML-API (normally specified by ML_MAJOR_CAPI_VERSION).
verCPPAPI	The C++-API version number of the ML (normally specified by ML_CPPAPI_VERSION).
revCAPI	The revision number of the C-API of the ML-API (normally specified by ML_CAPI_REVISION).

References ML_UTILS_EXPORT.