#include <boost/version.hpp>
#include <boost/serialization/export.hpp>
#include <boost/preprocessor/cat.hpp>
#include <boost/preprocessor/stringize.hpp>

Include dependency graph for SerializationExportWrapper.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	pack< class >

struct	pack< void(T)>

Macros
#define	COVERAGE_IGNORE
	gcov doesn't like this file...

#define	CHASTE_CLASS_EXPORT_TEMPLATED(T, S) BOOST_CLASS_EXPORT(T)

#define	CHASTE_CLASS_EXPORT_INTERNAL(T) BOOST_CLASS_EXPORT(T)

#define	CHASTE_EXPORT_KEY_1(CLASS, P1) BOOST_PP_CAT(CLASS, P1)

#define	CHASTE_EXPORT_KEY_2(CLASS, P1, P2) BOOST_PP_CAT(BOOST_PP_CAT(CLASS, P1), P2)

#define	CHASTE_EXPORT_KEY_3(CLASS, P1, P2, P3) BOOST_PP_CAT(BOOST_PP_CAT(BOOST_PP_CAT(CLASS, P1), P2), P3)

#define	CHASTE_PACK_1(CLASS, P1) pack<void (CLASS< P1 >)>::type

#define	CHASTE_PACK_2(CLASS, P1, P2) pack<void (CLASS< P1,P2 >)>::type

#define	CHASTE_PACK_3(CLASS, P1, P2, P3) pack<void (CLASS< P1,P2,P3 >)>::type

#define	EXPORT_TEMPLATE_CLASS3_INTERNAL(CLASS, E, S, P) CHASTE_CLASS_EXPORT_TEMPLATED( CHASTE_PACK_3(CLASS, E, S, P), CHASTE_EXPORT_KEY_3(CLASS, E, S, P) )

#define	EXPORT_TEMPLATE_CLASS2_INTERNAL(CLASS, E, S) CHASTE_CLASS_EXPORT_TEMPLATED( CHASTE_PACK_2(CLASS, E, S), CHASTE_EXPORT_KEY_2(CLASS, E, S) )

#define	EXPORT_TEMPLATE_CLASS1_INTERNAL(CLASS, D) CHASTE_CLASS_EXPORT_TEMPLATED( CHASTE_PACK_1(CLASS, D), CHASTE_EXPORT_KEY_1(CLASS, D) )

#define	EXPORT_TEMPLATE_CLASS_ALL_DIMS_INTERNAL(CLASS)

#define	EXPORT_TEMPLATE_CLASS_SAME_DIMS_INTERNAL(CLASS)

#define	CHASTE_CLASS_EXPORT(T) CHASTE_CLASS_EXPORT_INTERNAL(T)

#define	EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS) EXPORT_TEMPLATE_CLASS_SAME_DIMS_INTERNAL(CLASS)

#define	EXPORT_TEMPLATE_CLASS_ALL_DIMS(CLASS) EXPORT_TEMPLATE_CLASS_ALL_DIMS_INTERNAL(CLASS)

#define	EXPORT_TEMPLATE_CLASS1(CLASS, D) EXPORT_TEMPLATE_CLASS1_INTERNAL(CLASS, D)

#define	EXPORT_TEMPLATE_CLASS2(CLASS, E, S) EXPORT_TEMPLATE_CLASS2_INTERNAL(CLASS, E, S)

#define	EXPORT_TEMPLATE_CLASS3(CLASS, E, S, P) EXPORT_TEMPLATE_CLASS3_INTERNAL(CLASS, E, S, P)

Detailed Description

Defines some macros to register versions of templated classes with the serialization library, for all space dimensions. Also contains wrappers around BOOST_CLASS_EXPORT and related functionality, which take care of the differences introduced in new versions of Boost.

In Boost 1.33.1 and 1.34, BOOST_CLASS_EXPORT should be placed in the .hpp file for each class, and archive headers included only in tests, or special 'archiver' class header files (e.g. CardiacSimulationArchiver.hpp).

Serialization is broken in Boost 1.35.

In Boost 1.36 (and up to 1.40) both the archive header includes and the BOOST_CLASS_EXPORT should go in .cpp files.

We also support 1.41 and above, which introduce BOOST_CLASS_EXPORT_KEY and BOOST_CLASS_EXPORT_IMPLEMENT. Note 1.41.1 has bugs in serialization. See https://chaste.cs.ox.ac.uk/trac/wiki/InstallGuides/DependencyVersions for recommended versions.

To handle all situations in Chaste: 1. In .hpp files, include this header after the class definition. 2. In .cpp files, after any other includes, include SerializationExportWrapperForCpp.hpp. In both cases, CHASTE_CLASS_EXPORT should be used instead of BOOST_CLASS_EXPORT.

There are also variant macros for common cases of templated classes:

EXPORT_TEMPLATE_CLASS_SAME_DIMS
EXPORT_TEMPLATE_CLASS_ALL_DIMS
EXPORT_TEMPLATE_CLASS1
EXPORT_TEMPLATE_CLASS2
EXPORT_TEMPLATE_CLASS3

The latter 3 macros are usable in any situation where a class has up to 3 template parameters, and you know what values will be needed. Unfortunately a fully general template solution seems to be impossible in any Boost version (the library makes use of either explicit instantiation or singleton class instantiation).

Definition in file SerializationExportWrapper.hpp.

Macro Definition Documentation

#define CHASTE_CLASS_EXPORT ( T ) CHASTE_CLASS_EXPORT_INTERNAL(T)

Define the serialization export key for this class.

Parameters

T the class

Definition at line 386 of file SerializationExportWrapper.hpp.

#define CHASTE_CLASS_EXPORT_INTERNAL ( T ) BOOST_CLASS_EXPORT(T)

What CHASTE_CLASS_EXPORT expands to when it isn't a no-op.

Parameters

T	the class to export

Definition at line 221 of file SerializationExportWrapper.hpp.

#define CHASTE_CLASS_EXPORT_TEMPLATED	(	T,
		S
	)	BOOST_CLASS_EXPORT(T)

General export for templated classes.

Parameters

T	a type
S	a unique string for the class + specific template parameter values

Definition at line 214 of file SerializationExportWrapper.hpp.

#define CHASTE_EXPORT_KEY_1	(	CLASS,
		P1
	)	BOOST_PP_CAT(CLASS, P1)

Defines the export key for a class templated over 1 parameter.

Parameters

CLASS	the class
P1	the template parameter

Definition at line 242 of file SerializationExportWrapper.hpp.

#define CHASTE_EXPORT_KEY_2	(	CLASS,
		P1,
		P2
	)	BOOST_PP_CAT(BOOST_PP_CAT(CLASS, P1), P2)

Defines the export key for a class templated over 2 parameters.

Parameters

CLASS	the class
P1	the first template parameter
P2	the second template parameter

Definition at line 251 of file SerializationExportWrapper.hpp.

#define CHASTE_EXPORT_KEY_3	(	CLASS,
		P1,
		P2,
		P3
	)	BOOST_PP_CAT(BOOST_PP_CAT(BOOST_PP_CAT(CLASS, P1), P2), P3)

Defines the export key for a class templated over 3 parameters.

Parameters

CLASS	the class
P1	the first template parameter
P2	the second template parameter
P3	the third template parameter

Definition at line 261 of file SerializationExportWrapper.hpp.

#define CHASTE_PACK_1	(	CLASS,
		P1
	)	pack<void (CLASS< P1 >)>::type

Defines the export type for a class templated over 1 parameter.

Parameters

CLASS	the class
P1	the template parameter

Definition at line 269 of file SerializationExportWrapper.hpp.

#define CHASTE_PACK_2	(	CLASS,
		P1,
		P2
	)	pack<void (CLASS< P1,P2 >)>::type

Defines the export type for a class templated over 2 parameters.

Parameters

CLASS	the class
P1	the first template parameter
P2	the second template parameter

Definition at line 277 of file SerializationExportWrapper.hpp.

#define CHASTE_PACK_3	(	CLASS,
		P1,
		P2,
		P3
	)	pack<void (CLASS< P1,P2,P3 >)>::type

Defines the export type for a class templated over 3 parameters.

Parameters

CLASS	the class
P1	the first template parameter
P2	the second template parameter
P3	the third template parameter

Definition at line 286 of file SerializationExportWrapper.hpp.

#define EXPORT_TEMPLATE_CLASS1	(	CLASS,
		D
	)	EXPORT_TEMPLATE_CLASS1_INTERNAL(CLASS, D)

Export a templated class with 1 parameter.

Parameters

CLASS	the class (without parameters)
D	template parameter

Definition at line 403 of file SerializationExportWrapper.hpp.

#define EXPORT_TEMPLATE_CLASS1_INTERNAL	(	CLASS,
		D
	)	CHASTE_CLASS_EXPORT_TEMPLATED( CHASTE_PACK_1(CLASS, D), CHASTE_EXPORT_KEY_1(CLASS, D) )

Export a templated class with 1 parameter. This is the definition of EXPORT_TEMPLATE_CLASS1 when it isn't a no-op.

Parameters

CLASS	the class (without parameters)
D	template parameter

Definition at line 333 of file SerializationExportWrapper.hpp.

#define EXPORT_TEMPLATE_CLASS2	(	CLASS,
		E,
		S
	)	EXPORT_TEMPLATE_CLASS2_INTERNAL(CLASS, E, S)

Export a templated class with 2 parameters.

Parameters

CLASS	the class (without parameters)
E	first template parameter
S	second template parameter

Definition at line 410 of file SerializationExportWrapper.hpp.

#define EXPORT_TEMPLATE_CLASS2_INTERNAL	(	CLASS,
		E,
		S
	)	CHASTE_CLASS_EXPORT_TEMPLATED( CHASTE_PACK_2(CLASS, E, S), CHASTE_EXPORT_KEY_2(CLASS, E, S) )

Export a templated class with 2 parameters. This is the definition of EXPORT_TEMPLATE_CLASS2 when it isn't a no-op.

Parameters

CLASS	the class (without parameters)
E	first template parameter
S	second template parameter

Definition at line 324 of file SerializationExportWrapper.hpp.

#define EXPORT_TEMPLATE_CLASS3	(	CLASS,
		E,
		S,
		P
	)	EXPORT_TEMPLATE_CLASS3_INTERNAL(CLASS, E, S, P)

Export a templated class with 3 parameters.

Parameters

CLASS	the class (without parameters)
E	first template parameter
S	second template parameter
P	third template parameter

Definition at line 418 of file SerializationExportWrapper.hpp.

#define EXPORT_TEMPLATE_CLASS3_INTERNAL	(	CLASS,
		E,
		S,
		P
	)	CHASTE_CLASS_EXPORT_TEMPLATED( CHASTE_PACK_3(CLASS, E, S, P), CHASTE_EXPORT_KEY_3(CLASS, E, S, P) )

Export a templated class with 3 parameters. This is the definition of EXPORT_TEMPLATE_CLASS3 when it isn't a no-op.

Parameters

CLASS	the class (without parameters)
E	first template parameter
S	second template parameter
P	third template parameter

Definition at line 314 of file SerializationExportWrapper.hpp.

#define EXPORT_TEMPLATE_CLASS_ALL_DIMS ( CLASS ) EXPORT_TEMPLATE_CLASS_ALL_DIMS_INTERNAL(CLASS)

Export a class templated over both element and space dimension, for all valid combinations.

Parameters

CLASS the class (without parameters)

Definition at line 397 of file SerializationExportWrapper.hpp.

#define EXPORT_TEMPLATE_CLASS_ALL_DIMS_INTERNAL ( CLASS )

Value:

EXPORT_TEMPLATE_CLASS2(CLASS, 1, 1) \
    EXPORT_TEMPLATE_CLASS2(CLASS, 1, 2) \
    EXPORT_TEMPLATE_CLASS2(CLASS, 1, 3) \
    EXPORT_TEMPLATE_CLASS2(CLASS, 2, 2) \
    EXPORT_TEMPLATE_CLASS2(CLASS, 2, 3) \
    EXPORT_TEMPLATE_CLASS2(CLASS, 3, 3)

Export a class templated over both element and space dimension, for all valid combinations. This is the definition of EXPORT_TEMPLATE_CLASS_ALL_DIMS when it isn't a no-op.

Parameters

CLASS the class (without parameters)

Definition at line 342 of file SerializationExportWrapper.hpp.

#define EXPORT_TEMPLATE_CLASS_SAME_DIMS ( CLASS ) EXPORT_TEMPLATE_CLASS_SAME_DIMS_INTERNAL(CLASS)

Export a class templated over a single dimension, for 1, 2 and 3 dimensions.

Parameters

CLASS the class (without parameters)

Definition at line 391 of file SerializationExportWrapper.hpp.

#define EXPORT_TEMPLATE_CLASS_SAME_DIMS_INTERNAL ( CLASS )

Value:

EXPORT_TEMPLATE_CLASS1(CLASS, 1) \
    EXPORT_TEMPLATE_CLASS1(CLASS, 2) \
    EXPORT_TEMPLATE_CLASS1(CLASS, 3)

Export a class templated over a single dimension, for 1, 2 and 3 dimensions. This is the definition of EXPORT_TEMPLATE_CLASS_SAME_DIMS when it isn't a no-op.

Parameters

CLASS the class (without parameters)

Definition at line 355 of file SerializationExportWrapper.hpp.

Classes

Macros

Detailed Description

Macro Definition Documentation