SerializationTemplateSrcMacro.h File Reference

Source part of macros set for template class serialization. More...

#include <IPSDKUtil/Dynamic/DynamicTemplateSrcMacro.h>
#include <IPSDKSerialization/Logger/IPSDKSerializationLog.h>
#include <IPSDKSerialization/Engine/SerializationSrcMacro.h>
#include <IPSDKUtil/TemplateMacro.h>

Go to the source code of this file.

Macros
#define	IPSDK_IMPLEMENT_TEMPLATE_SERIAL_VERSION(className, seqT, version)
	macro enabling to define serialization class version More...
#define	IPSDK_IMPLEMENT_TEMPLATE_SERIAL(libraryName, className, seqT, version)   IPSDK_IMPLEMENT_TEMPLATE_SERIAL_VERSION(className, seqT, version)
	macro enabling class serialization in library class
#define	IPSDK_IMPLEMENT_TEMPLATE_SERIAL_WITH_COPY(libraryName, className, seqT, version)
	macro enabling class serialization in library class More...
#define	IPSDK_IMPLEMENT_TEMPLATE_SERIAL_WITHOUT_COPY(libraryName, className, seqT, version)
	macro enabling class serialization in library class More...
#define	IPSDK_IMPLEMENT_ABSTRACT_TEMPLATE_SERIAL_WITH_COPY(libraryName, className, seqT, version)
	macro enabling class serialization in library class More...
#define	IPSDK_IMPLEMENT_ABSTRACT_TEMPLATE_SERIAL_WITHOUT_COPY(libraryName, className, seqT, version)
	macro enabling class serialization in library class More...
#define	IPSDK_IMPLEMENT_TEMPLATE_SERIAL_READ(className, seqT, baseClassName)
	macros enabling object read from an archive More...
#define	IPSDK_IMPLEMENT_TEMPLATE_SERIAL_WRITE(className, seqT, baseClassName)
	macros enabling object save to an archive More...
#define	IPSDK_EXPORT_TEMPLATE_SERIAL(libraryName, namespaceSeq, className, TYPE_SEQ)
	macro for exporting template class specializations More...
#define	IPSDK_EXPORT_ABSTRACT_TEMPLATE_SERIAL(libraryName, namespaceSeq, className, TYPE_SEQ)
	macro for exporting abstract template class specializations More...

Detailed Description

Source part of macros set for template class serialization.

Author

E. Noirfalise

Date

2013/2/15

Copyright

2013 Reactiv'IP, all right reserved.

Macro Definition Documentation

IPSDK_IMPLEMENT_TEMPLATE_SERIAL_VERSION

#define IPSDK_IMPLEMENT_TEMPLATE_SERIAL_VERSION	(		className,
			seqT,
			version
	)

Value:

IPSDK_TEMPLATE_PARAMS(seqT)                                                         \
    ipUInt32 className<IPSDK_TEMPLATE_ARGS(seqT)>::getVersion() {                       \
        boost::lock_guard<boost::mutex> lock(VersionMutex::get());                      \
        static ipUInt32 g_##className##Version(version);                                \
        return  g_##className##Version;                                                 \
    }

macro enabling to define serialization class version

IPSDK_IMPLEMENT_TEMPLATE_SERIAL_WITH_COPY

#define IPSDK_IMPLEMENT_TEMPLATE_SERIAL_WITH_COPY	(		libraryName,
			className,
			seqT,
			version
	)

Value:

IPSDK_IMPLEMENT_TEMPLATE_DYNAMIC_WITH_COPY(className, seqT)                             \
    IPSDK_IMPLEMENT_TEMPLATE_SERIAL(libraryName, className, seqT, version)

macro enabling class serialization in library class

IPSDK_IMPLEMENT_TEMPLATE_SERIAL_WITHOUT_COPY

#define IPSDK_IMPLEMENT_TEMPLATE_SERIAL_WITHOUT_COPY	(		libraryName,
			className,
			seqT,
			version
	)

Value:

IPSDK_IMPLEMENT_TEMPLATE_DYNAMIC_WITHOUT_COPY(className, seqT)                              \
    IPSDK_IMPLEMENT_TEMPLATE_SERIAL(libraryName, className, seqT, version)

macro enabling class serialization in library class

IPSDK_IMPLEMENT_ABSTRACT_TEMPLATE_SERIAL_WITH_COPY

#define IPSDK_IMPLEMENT_ABSTRACT_TEMPLATE_SERIAL_WITH_COPY	(		libraryName,
			className,
			seqT,
			version
	)

Value:

IPSDK_IMPLEMENT_ABSTRACT_TEMPLATE_DYNAMIC_WITH_COPY(className, seqT)                            \
    IPSDK_IMPLEMENT_TEMPLATE_SERIAL(libraryName, className, seqT, version)

macro enabling class serialization in library class

IPSDK_IMPLEMENT_ABSTRACT_TEMPLATE_SERIAL_WITHOUT_COPY

#define IPSDK_IMPLEMENT_ABSTRACT_TEMPLATE_SERIAL_WITHOUT_COPY	(		libraryName,
			className,
			seqT,
			version
	)

Value:

IPSDK_IMPLEMENT_ABSTRACT_TEMPLATE_DYNAMIC_WITHOUT_COPY(className, seqT)                             \
    IPSDK_IMPLEMENT_TEMPLATE_SERIAL(libraryName, className, seqT, version)

macro enabling class serialization in library class

IPSDK_IMPLEMENT_TEMPLATE_SERIAL_READ

#define IPSDK_IMPLEMENT_TEMPLATE_SERIAL_READ	(		className,
			seqT,
			baseClassName
	)

Value:

IPSDK_TEMPLATE_PARAMS(seqT)                                                                         \
    ipsdk::BoolResult className<IPSDK_TEMPLATE_ARGS(seqT)>::read(ipsdk::BaseIArchive& ar) {             \
        ipsdk::BoolResult baseClassResult = baseClassName::read(ar);                                    \
        if (baseClassResult == false)                                                                   \
            return baseClassResult;                                                                     \
        ipsdk::ipUInt32 version;                                                                        \
        if (ar.isClassVersionRegistred(className<IPSDK_TEMPLATE_ARGS(seqT)>::getClassName()) == true)   \
            version = ar.getRegisterClassVersion(className<IPSDK_TEMPLATE_ARGS(seqT)>::getClassName()); \
        else {                                                                                          \
            IPSDK_START_ARCHIVE_SECTION(ar, className<IPSDK_TEMPLATE_ARGS(seqT)>::getClassName());      \
            ar >> IPSDK_MAKE_IITEM_VALUE(version);                                                      \
            IPSDKSERIALIZATION_CHECK(version <= className<IPSDK_TEMPLATE_ARGS(seqT)>::getVersion(),     \
                [ipsdk::eIPSDKSerializationMessage::eInvalidReadClassVersion] %                         \
                version % className<IPSDK_TEMPLATE_ARGS(seqT)>::getClassName() %                        \
                className<IPSDK_TEMPLATE_ARGS(seqT)>::getVersion());                                    \
            ar.registerClassVersion(className<IPSDK_TEMPLATE_ARGS(seqT)>::getClassName(), version);     \
            IPSDK_END_ARCHIVE_SECTION(className<IPSDK_TEMPLATE_ARGS(seqT)>::getClassName());            \
        }

macros enabling object read from an archive

IPSDK_IMPLEMENT_TEMPLATE_SERIAL_WRITE

#define IPSDK_IMPLEMENT_TEMPLATE_SERIAL_WRITE	(		className,
			seqT,
			baseClassName
	)

Value:

IPSDK_TEMPLATE_PARAMS(seqT)                                                                             \
    ipsdk::BoolResult className<IPSDK_TEMPLATE_ARGS(seqT)>::write(ipsdk::BaseOArchive& ar) const {          \
        ipsdk::BoolResult baseClassResult = baseClassName::write(ar);                                       \
        if (baseClassResult == false)                                                                       \
            return baseClassResult;                                                                         \
        if (ar.isClassVersionRegistred(className<IPSDK_TEMPLATE_ARGS(seqT)>::getClassName()) == false) {    \
            ipsdk::ipUInt32 version = className<IPSDK_TEMPLATE_ARGS(seqT)>::getVersion();                   \
            IPSDK_START_ARCHIVE_SECTION(ar, className<IPSDK_TEMPLATE_ARGS(seqT)>::getClassName());          \
            ar << IPSDK_MAKE_OITEM_VALUE(version);                                                          \
            ar.registerClassVersion(className<IPSDK_TEMPLATE_ARGS(seqT)>::getClassName(), version);         \
            IPSDK_END_ARCHIVE_SECTION(className<IPSDK_TEMPLATE_ARGS(seqT)>::getClassName());                \
        }

macros enabling object save to an archive

IPSDK_EXPORT_TEMPLATE_SERIAL

#define IPSDK_EXPORT_TEMPLATE_SERIAL	(		libraryName,
			namespaceSeq,
			className,
			TYPE_SEQ
	)

Value:

BOOST_PP_SEQ_FOR_EACH(IPSDK_EXPORT_TEMPLATE_DYNAMIC_MACRO,                                                  \
                          (IPSDK_LIB_API(libraryName))                                                          \
                          (IPSDK_START_NAMESPACE(namespaceSeq))                                                 \
                          (className)                                                                           \
                          (IPSDK_END_NAMESPACE(namespaceSeq))                                                   \
                          (IPSDK_FULL_NAMESPACE_STR(namespaceSeq)),                                             \
                          TYPE_SEQ)

macro for exporting template class specializations

IPSDK_EXPORT_ABSTRACT_TEMPLATE_SERIAL

#define IPSDK_EXPORT_ABSTRACT_TEMPLATE_SERIAL	(		libraryName,
			namespaceSeq,
			className,
			TYPE_SEQ
	)

Value:

BOOST_PP_SEQ_FOR_EACH(IPSDK_EXPORT_ABSTRACT_TEMPLATE_DYNAMIC_MACRO,                                         \
                          (IPSDK_LIB_API(libraryName))                                                          \
                          (IPSDK_START_NAMESPACE(namespaceSeq))                                                 \
                          (className)                                                                           \
                          (IPSDK_END_NAMESPACE(namespaceSeq))                                                   \
                          (IPSDK_FULL_NAMESPACE_STR(namespaceSeq)),                                             \
                          TYPE_SEQ)

macro for exporting abstract template class specializations