config.h File Reference

LiMaL configuration file. More...

#include <blocxx/BLOCXX_config.h>

Go to the source code of this file.

Macros
#define	LIMAL_LIB_VERSION   "1.5.0"
	LiMaL library version.
#define	LIMAL_API_VERSION   1
	LiMaL API/namespace version.
#define	LIMAL_DEFINE_NAMESPACE_CAT(name, ver)   name ## ver
	Helper macros to define a namespace with version.
#define	LIMAL_DEFINE_NAMESPACE(name, ver)   LIMAL_DEFINE_NAMESPACE_CAT(name,ver)

Functions
const char *	limal_lib_version ()
	The main LiMaL namespace.
unsigned int	limal_api_version ()
	LiMaL API version number function.

Detailed Description

LiMaL configuration file.

This is config file provides compilation time definitions like the version of the library, and the declaration of the main LiMaL namespace.

Macro Definition Documentation

#define LIMAL_API_VERSION   1

LiMaL API/namespace version.

#define LIMAL_DEFINE_NAMESPACE	(		name,
			ver
	)		LIMAL_DEFINE_NAMESPACE_CAT(name,ver)

#define LIMAL_DEFINE_NAMESPACE_CAT	(		name,
			ver
	)		name ## ver

Helper macros to define a namespace with version.

#define LIMAL_LIB_VERSION   "1.5.0"

LiMaL library version.

Function Documentation

unsigned int limal_api_version

(

)

LiMaL API version number function.

Returns

API version number

const char* limal_lib_version

(

)

The main LiMaL namespace.

The limal namespace is only a alias to the real namespace LIMAL_NAMESPACE, that is defined in the config.h file with appended API version number.

The full namespace name should be used if something is declared in the namespace. For example:

namespace LIMAL_NAMESPACE
{
    class MyLiMaLClass
    {
       MyLiMaLClass();
       // ...
    };

    MyLiMaLClass::MyLiMaLClass()
    {
    }
}

The limal alias is to qualify e.g. a class name.

namespace
{
   void somefunction(const limal::Logger &logger);
}

LiMaL library version string function.

Returns

library version string