Files
externals/linux/include/ActivMiddleware/Misc/Detail/SerializableContainerHelperSpecializations.h

536 lines
18 KiB
C++

/**
* @file include/ActivMiddleware/Misc/Detail/SerializableContainerHelperSpecializations.h
*
* @brief Classes to help serialize STL containers.
*/
#if (!defined ACTIV_MISC_DETAIL_SERIALIZABLE_CONTAINER_HELPER_SPECIALIZATIONS_H)
#define ACTIV_MISC_DETAIL_SERIALIZABLE_CONTAINER_HELPER_SPECIALIZATIONS_H
#include "ActivMiddleware/Misc/StlHelper.h"
#include ACTIV_BOOST_INCLUDE(container/list.hpp)
#include ACTIV_BOOST_INCLUDE(container/map.hpp)
#include ACTIV_BOOST_INCLUDE(container/set.hpp)
#include ACTIV_BOOST_INCLUDE(container/vector.hpp)
//! Activ namespace.
namespace Activ
{
/**
* @brief SerializableContainerHelper specialization for std::vector containers.
*/
template <typename OBJECT_TYPE, typename COUNT_TYPE, COUNT_TYPE MIN_LENGTH, COUNT_TYPE MAX_LENGTH, typename OBJECT_HELPER>
class SerializableContainerHelper<std::vector<OBJECT_TYPE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH, OBJECT_HELPER>
{
public:
typedef std::vector<OBJECT_TYPE> Container;
typedef COUNT_TYPE Count;
typedef OBJECT_HELPER ObjectHelper;
/**
* @brief Serialize a vector.
*
* @param messageBuilder
* @param vector container to serialize.
*
* @retval STATUS_CODE_SUCCESS
* @retval ...
*/
static StatusCode Serialize(MessageBuilder &messageBuilder, const Container &vector)
{
return SerializeContainer<Container, Count, MIN_LENGTH, MAX_LENGTH, ObjectHelper>(messageBuilder, vector);
}
/**
* @brief Deserialize a vector.
*
* @param messageValidator
* @param vector container to deserialize into.
* @param shouldClearContainer whether to empty the container first, or just add new entries.
*
* @retval STATUS_CODE_SUCCESS
* @retval ...
*/
static StatusCode Deserialize(MessageValidator &messageValidator, Container &vector, const bool shouldClearContainer)
{
return DeserializeVector<Container, Count, MIN_LENGTH, MAX_LENGTH, ObjectHelper>(messageValidator, vector,
shouldClearContainer);
}
};
// ---------------------------------------------------------------------------------------------------------------------------------
/**
* @brief SerializableContainerHelper specialization for Boost::container::vector containers.
*/
template <typename OBJECT_TYPE, typename COUNT_TYPE, COUNT_TYPE MIN_LENGTH, COUNT_TYPE MAX_LENGTH, typename OBJECT_HELPER>
class SerializableContainerHelper<Boost::container::vector<OBJECT_TYPE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH, OBJECT_HELPER>
{
public:
typedef Boost::container::vector<OBJECT_TYPE> Container;
typedef COUNT_TYPE Count;
typedef OBJECT_HELPER ObjectHelper;
/**
* @brief Serialize a vector.
*
* @param messageBuilder
* @param vector container to serialize.
*
* @retval STATUS_CODE_SUCCESS
* @retval ...
*/
static StatusCode Serialize(MessageBuilder &messageBuilder, const Container &vector)
{
return SerializeContainer<Container, Count, MIN_LENGTH, MAX_LENGTH, ObjectHelper>(messageBuilder, vector);
}
/**
* @brief Deserialize a vector.
*
* @param messageValidator
* @param vector container to deserialize into.
* @param shouldClearContainer whether to empty the container first, or just add new entries.
*
* @retval STATUS_CODE_SUCCESS
* @retval ...
*/
static StatusCode Deserialize(MessageValidator &messageValidator, Container &vector, const bool shouldClearContainer)
{
return DeserializeVector<Container, Count, MIN_LENGTH, MAX_LENGTH, ObjectHelper>(messageValidator, vector,
shouldClearContainer);
}
};
// ---------------------------------------------------------------------------------------------------------------------------------
/**
* @brief Specialization for list containers.
*/
template <typename OBJECT_TYPE, typename COUNT_TYPE, COUNT_TYPE MIN_LENGTH, COUNT_TYPE MAX_LENGTH, typename OBJECT_HELPER>
class SerializableContainerHelper<std::list<OBJECT_TYPE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH, OBJECT_HELPER>
{
public:
typedef std::list<OBJECT_TYPE> Container;
typedef COUNT_TYPE Count;
typedef OBJECT_HELPER ObjectHelper;
/**
* @brief Serialize a list.
*
* @param messageBuilder
* @param list container to serialize.
*
* @retval STATUS_CODE_SUCCESS
* @retval ...
*/
static StatusCode Serialize(MessageBuilder &messageBuilder, const Container &list)
{
return SerializeContainer<Container, Count, MIN_LENGTH, MAX_LENGTH, ObjectHelper>(messageBuilder, list);
}
/**
* @brief Deserialize a list.
*
* @param messageValidator
* @param list container to deserialize into.
* @param shouldClearContainer whether to empty the container first, or just add new entries.
*
* @retval STATUS_CODE_SUCCESS
* @retval ...
*/
static StatusCode Deserialize(MessageValidator &messageValidator, Container &list, const bool shouldClearContainer)
{
Count count;
ACTIV_RETURN_RESULT_IF_UNLIKELY(STATUS_CODE_SUCCESS, !=,
(messageValidator.ValidateBinaryIntegralRange<sizeof(count), MessageValidator::ENDIAN_LITTLE, COUNT_TYPE, MIN_LENGTH,
MAX_LENGTH>(count)));
// TODO could probably be cleverer here and deserialize into existing members if shouldClearContainer.
if (shouldClearContainer)
list.clear();
const size_t originalSize = list.size();
StatusCode statusCode;
for (size_t i = 0; i < count; ++i)
{
list.push_back(OBJECT_TYPE());
// Deserialize directly into the object in the list.
statusCode = ObjectHelper::Deserialize(messageValidator, list.back());
if (STATUS_CODE_SUCCESS != statusCode)
{
list.resize(originalSize);
return statusCode;
}
}
return STATUS_CODE_SUCCESS;
}
};
// ---------------------------------------------------------------------------------------------------------------------------------
/**
* @brief Specialization for Boost::container::list containers.
*/
template <typename OBJECT_TYPE, typename COUNT_TYPE, COUNT_TYPE MIN_LENGTH, COUNT_TYPE MAX_LENGTH, typename OBJECT_HELPER>
class SerializableContainerHelper<Boost::container::list<OBJECT_TYPE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH, OBJECT_HELPER>
{
public:
typedef Boost::container::list<OBJECT_TYPE> Container;
typedef COUNT_TYPE Count;
typedef OBJECT_HELPER ObjectHelper;
/**
* @brief Serialize a list.
*
* @param messageBuilder
* @param list container to serialize.
*
* @retval STATUS_CODE_SUCCESS
* @retval ...
*/
static StatusCode Serialize(MessageBuilder &messageBuilder, const Container &list)
{
return SerializeContainer<Container, Count, MIN_LENGTH, MAX_LENGTH, ObjectHelper>(messageBuilder, list);
}
/**
* @brief Deserialize a list.
*
* @param messageValidator
* @param list container to deserialize into.
* @param shouldClearContainer whether to empty the container first, or just add new entries.
*
* @retval STATUS_CODE_SUCCESS
* @retval ...
*/
static StatusCode Deserialize(MessageValidator &messageValidator, Container &list, const bool shouldClearContainer)
{
Count count;
ACTIV_RETURN_RESULT_IF_UNLIKELY(STATUS_CODE_SUCCESS, !=,
(messageValidator.ValidateBinaryIntegralRange<sizeof(count), MessageValidator::ENDIAN_LITTLE, COUNT_TYPE, MIN_LENGTH,
MAX_LENGTH>(count)));
// TODO could probably be cleverer here and deserialize into existing members if shouldClearContainer.
if (shouldClearContainer)
list.clear();
const size_t originalSize = list.size();
StatusCode statusCode;
for (size_t i = 0; i < count; ++i)
{
list.push_back(OBJECT_TYPE());
// Deserialize directly into the object in the list.
statusCode = ObjectHelper::Deserialize(messageValidator, list.back());
if (STATUS_CODE_SUCCESS != statusCode)
{
list.resize(originalSize);
return statusCode;
}
}
return STATUS_CODE_SUCCESS;
}
};
// ---------------------------------------------------------------------------------------------------------------------------------
/**
* @brief Specialization for set containers.
*/
template <typename OBJECT_TYPE, typename COUNT_TYPE, COUNT_TYPE MIN_LENGTH, COUNT_TYPE MAX_LENGTH, typename OBJECT_HELPER>
class SerializableContainerHelper<std::set<OBJECT_TYPE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH, OBJECT_HELPER>
{
public:
typedef std::set<OBJECT_TYPE> Container;
typedef COUNT_TYPE Count;
typedef OBJECT_HELPER ObjectHelper;
/**
* @brief Serialize a set.
*
* @param messageBuilder
* @param set container to serialize.
*
* @retval STATUS_CODE_SUCCESS
* @retval ...
*/
static StatusCode Serialize(MessageBuilder &messageBuilder, const Container &set)
{
return SerializeContainer<Container, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH, OBJECT_HELPER>(messageBuilder, set);
}
/**
* @brief Deserialize a set.
*
* @param messageValidator
* @param set container to deserialize into.
* @param shouldClearContainer whether to empty the container first, or just add new entries.
*
* @retval STATUS_CODE_SUCCESS
* @retval ...
*/
static StatusCode Deserialize(MessageValidator &messageValidator, Container &set, const bool shouldClearContainer)
{
Count count;
ACTIV_RETURN_RESULT_IF_UNLIKELY(STATUS_CODE_SUCCESS, !=,
(messageValidator.ValidateBinaryIntegralRange<sizeof(count), MessageValidator::ENDIAN_LITTLE, COUNT_TYPE, MIN_LENGTH,
MAX_LENGTH>(count)));
if (shouldClearContainer)
set.clear();
for (Count i = 0; i < count; ++i)
{
typename Container::value_type object;
ACTIV_RETURN_RESULT_IF_UNLIKELY(STATUS_CODE_SUCCESS, !=, ObjectHelper::Deserialize(messageValidator, object));
(void) set.insert(object);
}
return STATUS_CODE_SUCCESS;
}
};
// ---------------------------------------------------------------------------------------------------------------------------------
/**
* @brief Specialization for Boost::container::set containers.
*/
template <typename OBJECT_TYPE, typename COUNT_TYPE, COUNT_TYPE MIN_LENGTH, COUNT_TYPE MAX_LENGTH, typename OBJECT_HELPER>
class SerializableContainerHelper<Boost::container::set<OBJECT_TYPE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH, OBJECT_HELPER>
{
public:
typedef Boost::container::set<OBJECT_TYPE> Container;
typedef COUNT_TYPE Count;
typedef OBJECT_HELPER ObjectHelper;
/**
* @brief Serialize a set.
*
* @param messageBuilder
* @param set container to serialize.
*
* @retval STATUS_CODE_SUCCESS
* @retval ...
*/
static StatusCode Serialize(MessageBuilder &messageBuilder, const Container &set)
{
return SerializeContainer<Container, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH, OBJECT_HELPER>(messageBuilder, set);
}
/**
* @brief Deserialize a set.
*
* @param messageValidator
* @param set container to deserialize into.
* @param shouldClearContainer whether to empty the container first, or just add new entries.
*
* @retval STATUS_CODE_SUCCESS
* @retval ...
*/
static StatusCode Deserialize(MessageValidator &messageValidator, Container &set, const bool shouldClearContainer)
{
Count count;
ACTIV_RETURN_RESULT_IF_UNLIKELY(STATUS_CODE_SUCCESS, !=,
(messageValidator.ValidateBinaryIntegralRange<sizeof(count), MessageValidator::ENDIAN_LITTLE, COUNT_TYPE, MIN_LENGTH,
MAX_LENGTH>(count)));
if (shouldClearContainer)
set.clear();
for (Count i = 0; i < count; ++i)
{
typename Container::value_type object;
ACTIV_RETURN_RESULT_IF_UNLIKELY(STATUS_CODE_SUCCESS, !=, ObjectHelper::Deserialize(messageValidator, object));
(void) set.insert(object);
}
return STATUS_CODE_SUCCESS;
}
};
// ---------------------------------------------------------------------------------------------------------------------------------
/**
* @brief Specialization for map containers.
*/
template <typename KEY_TYPE, typename MAPPED_TYPE, typename KEY_COMPARE, typename COUNT_TYPE, COUNT_TYPE MIN_LENGTH,
COUNT_TYPE MAX_LENGTH, typename OBJECT_HELPER>
class SerializableContainerHelper<std::map<KEY_TYPE, MAPPED_TYPE, KEY_COMPARE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH, OBJECT_HELPER>
{
public:
typedef std::map<KEY_TYPE, MAPPED_TYPE, KEY_COMPARE> Container;
typedef COUNT_TYPE Count;
typedef OBJECT_HELPER ObjectHelper;
/**
* @brief Serialize a map.
*
* @param messageBuilder
* @param map container to serialize.
*
* @retval STATUS_CODE_SUCCESS
* @retval ...
*/
static StatusCode Serialize(MessageBuilder &messageBuilder, const Container &map)
{
return SerializeAssociativeContainer<Container, Count, MIN_LENGTH, MAX_LENGTH, ObjectHelper>(messageBuilder, map);
}
/**
* @brief Deserialize a map.
*
* @param messageValidator
* @param map container to deserialize into.
* @param shouldClearContainer whether to empty the container first, or just add new entries.
*
* @retval STATUS_CODE_SUCCESS
* @retval ...
*/
static StatusCode Deserialize(MessageValidator &messageValidator, Container &map, const bool shouldClearContainer)
{
return DeserializeAssociativeContainer<Container, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH, OBJECT_HELPER>(messageValidator, map,
shouldClearContainer);
}
};
// ---------------------------------------------------------------------------------------------------------------------------------
/**
* @brief Specialization for Boost::container::map containers.
*/
template <typename KEY_TYPE, typename MAPPED_TYPE, typename COUNT_TYPE, COUNT_TYPE MIN_LENGTH, COUNT_TYPE MAX_LENGTH,
typename OBJECT_HELPER>
class SerializableContainerHelper<Boost::container::map<KEY_TYPE, MAPPED_TYPE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH,
OBJECT_HELPER>
{
public:
typedef Boost::container::map<KEY_TYPE, MAPPED_TYPE> Container;
typedef COUNT_TYPE Count;
typedef OBJECT_HELPER ObjectHelper;
/**
* @brief Serialize a map.
*
* @param messageBuilder
* @param map container to serialize.
*
* @retval STATUS_CODE_SUCCESS
* @retval ...
*/
static StatusCode Serialize(MessageBuilder &messageBuilder, const Container &map)
{
return SerializeAssociativeContainer<Container, Count, MIN_LENGTH, MAX_LENGTH, ObjectHelper>(messageBuilder, map);
}
/**
* @brief Deserialize a map.
*
* @param messageValidator
* @param map container to deserialize into.
* @param shouldClearContainer whether to empty the container first, or just add new entries.
*
* @retval STATUS_CODE_SUCCESS
* @retval ...
*/
static StatusCode Deserialize(MessageValidator &messageValidator, Container &map, const bool shouldClearContainer)
{
return DeserializeAssociativeContainer<Container, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH, OBJECT_HELPER>(messageValidator, map,
shouldClearContainer);
}
};
// ---------------------------------------------------------------------------------------------------------------------------------
// ---------------------------------------------------------------------------------------------------------------------------------
/**
* @brief Partial specialization of SerializableObjectContainerHelper to serialize maps of objects.
*/
template <typename KEY_TYPE, typename MAPPED_TYPE, typename KEY_COMPARE, typename COUNT_TYPE, COUNT_TYPE MIN_LENGTH,
COUNT_TYPE MAX_LENGTH>
class SerializableObjectContainerHelper<std::map<KEY_TYPE, MAPPED_TYPE, KEY_COMPARE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH> :
public SerializableContainerHelper<std::map<KEY_TYPE, MAPPED_TYPE, KEY_COMPARE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH,
SerializableObjectHelper<MAPPED_TYPE> >
{
};
// ---------------------------------------------------------------------------------------------------------------------------------
template <typename KEY_TYPE, typename MAPPED_TYPE, typename COUNT_TYPE, COUNT_TYPE MIN_LENGTH, COUNT_TYPE MAX_LENGTH>
class SerializableObjectContainerHelper<Boost::container::map<KEY_TYPE, MAPPED_TYPE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH> :
public SerializableContainerHelper<Boost::container::map<KEY_TYPE, MAPPED_TYPE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH,
SerializableObjectHelper<MAPPED_TYPE> >
{
};
// ---------------------------------------------------------------------------------------------------------------------------------
// ---------------------------------------------------------------------------------------------------------------------------------
/**
* @brief Partial specialization of SerializableRawPointerContainerHelper to serialize maps of raw pointers to objects.
*
* Note that currently the key type must not be a pointer, the mapped type should be a raw pointer.
*/
template <typename KEY_TYPE, typename MAPPED_TYPE, typename KEY_COMPARE, typename COUNT_TYPE, COUNT_TYPE MIN_LENGTH,
COUNT_TYPE MAX_LENGTH>
class SerializableRawPointerContainerHelper<std::map<KEY_TYPE, MAPPED_TYPE, KEY_COMPARE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH> :
public SerializableContainerHelper<std::map<KEY_TYPE, MAPPED_TYPE, KEY_COMPARE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH,
SerializableRawPointerHelper<MAPPED_TYPE> >
{
};
// ---------------------------------------------------------------------------------------------------------------------------------
template <typename KEY_TYPE, typename MAPPED_TYPE, typename COUNT_TYPE, COUNT_TYPE MIN_LENGTH, COUNT_TYPE MAX_LENGTH>
class SerializableRawPointerContainerHelper<Boost::container::map<KEY_TYPE, MAPPED_TYPE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH> :
public SerializableContainerHelper<Boost::container::map<KEY_TYPE, MAPPED_TYPE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH,
SerializableRawPointerHelper<MAPPED_TYPE> >
{
};
// ---------------------------------------------------------------------------------------------------------------------------------
// ---------------------------------------------------------------------------------------------------------------------------------
/**
* @brief Partial specialization of helper class to serialize maps of smart pointers to objects.
*
* Note that currently the key type must not be a pointer, the mapped type should be a smart pointer.
*/
template <typename KEY_TYPE, typename MAPPED_TYPE, typename KEY_COMPARE, typename COUNT_TYPE, COUNT_TYPE MIN_LENGTH,
COUNT_TYPE MAX_LENGTH>
class SerializableSmartPointerContainerHelper<std::map<KEY_TYPE, MAPPED_TYPE, KEY_COMPARE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH> :
public SerializableContainerHelper<std::map<KEY_TYPE, MAPPED_TYPE, KEY_COMPARE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH,
SerializableSmartPointerHelper<MAPPED_TYPE> >
{
};
// ---------------------------------------------------------------------------------------------------------------------------------
template <typename KEY_TYPE, typename MAPPED_TYPE, typename COUNT_TYPE, COUNT_TYPE MIN_LENGTH, COUNT_TYPE MAX_LENGTH>
class SerializableSmartPointerContainerHelper<Boost::container::map<KEY_TYPE, MAPPED_TYPE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH> :
public SerializableContainerHelper<Boost::container::map<KEY_TYPE, MAPPED_TYPE>, COUNT_TYPE, MIN_LENGTH, MAX_LENGTH,
SerializableSmartPointerHelper<MAPPED_TYPE> >
{
};
} // namespace Activ
#endif // (!defined ACTIV_MISC_DETAIL_SERIALIZABLE_CONTAINER_HELPER_SPECIALIZATIONS_H)