fsfw/serialize/SerializeAdapter.h

194 lines
6.5 KiB
C
Raw Normal View History

2020-09-10 15:17:38 +02:00
#ifndef _FSFW_SERIALIZE_SERIALIZEADAPTER_H_
#define _FSFW_SERIALIZE_SERIALIZEADAPTER_H_
2020-09-04 15:56:52 +02:00
2020-09-10 15:17:38 +02:00
#include "../returnvalues/HasReturnvaluesIF.h"
2020-09-04 15:56:52 +02:00
#include "EndianConverter.h"
#include "SerializeIF.h"
2020-09-10 15:17:38 +02:00
#include <cstddef>
#include <type_traits>
2020-08-28 18:33:29 +02:00
2020-09-10 15:25:29 +02:00
/**
* @brief These adapters provides an interface to use the SerializeIF functions
* with arbitrary template objects to facilitate and simplify the
* serialization of classes with different multiple different data types
* into buffers and vice-versa.
* @details
* The correct serialization or deserialization function is chosen at
* compile time with template type deduction.
*
* @ingroup serialize
2020-08-28 18:33:29 +02:00
*/
class SerializeAdapter {
public:
2020-09-10 15:17:38 +02:00
/***
2020-09-10 15:25:29 +02:00
* This function can be used to serialize a trivial copy-able type or a
* child of SerializeIF.
2020-09-10 15:17:38 +02:00
* The right template to be called is determined in the function itself.
2020-09-10 15:25:29 +02:00
* For objects of non trivial copy-able type this function is almost never
* called by the user directly. Instead helpers for specific types like
* SerialArrayListAdapter or SerialLinkedListAdapter is the right choice here.
2020-09-10 15:17:38 +02:00
*
* @param[in] object Object to serialize, the used type is deduced from this pointer
* @param[in/out] buffer Buffer to serialize into. Will be moved by the function.
* @param[in/out] size Size of current written buffer. Will be incremented by the function.
* @param[in] maxSize Max size of Buffer
* @param[in] streamEndianness Endianness of serialized element as in according to SerializeIF::Endianness
* @return
* - @c BUFFER_TOO_SHORT The given buffer in is too short
* - @c RETURN_FAILED Generic Error
* - @c RETURN_OK Successful serialization
*/
2020-08-28 18:33:29 +02:00
template<typename T>
static ReturnValue_t serialize(const T *object, uint8_t **buffer,
2020-09-10 15:17:38 +02:00
size_t *size, size_t maxSize,
SerializeIF::Endianness streamEndianness) {
InternalSerializeAdapter<T, std::is_base_of<SerializeIF, T>::value> adapter;
2020-08-28 18:33:29 +02:00
return adapter.serialize(object, buffer, size, maxSize,
streamEndianness);
}
2020-09-10 15:17:38 +02:00
/**
* Function to return the serialized size of the object in the pointer.
* May be a trivially copy-able object or a Child of SerializeIF
*
* @param object Pointer to Object
* @return Serialized size of object
*/
2020-08-28 18:33:29 +02:00
template<typename T>
2020-09-10 15:17:38 +02:00
static size_t getSerializedSize(const T *object){
InternalSerializeAdapter<T, std::is_base_of<SerializeIF, T>::value> adapter;
2020-08-28 18:33:29 +02:00
return adapter.getSerializedSize(object);
}
2020-09-10 15:17:38 +02:00
/**
* @brief
* Deserializes a object from a given buffer of given size.
* Object Must be trivially copy-able or a child of SerializeIF.
*
* @details
* Buffer will be moved to the current read location. Size will be decreased by the function.
*
* @param[in/out] buffer Buffer to deSerialize from. Will be moved by the function.
* @param[in/out] size Remaining size of the buffer to read from. Will be decreased by function.
* @param[in] streamEndianness Endianness as in according to SerializeIF::Endianness
* @return
* - @c STREAM_TOO_SHORT The input stream is too short to deSerialize the object
* - @c TOO_MANY_ELEMENTS The buffer has more inputs than expected
* - @c RETURN_FAILED Generic Error
* - @c RETURN_OK Successful deserialization
*/
2020-08-28 18:33:29 +02:00
template<typename T>
static ReturnValue_t deSerialize(T *object, const uint8_t **buffer,
size_t *size, SerializeIF::Endianness streamEndianness) {
2020-09-10 15:17:38 +02:00
InternalSerializeAdapter<T, std::is_base_of<SerializeIF, T>::value> adapter;
2020-08-28 18:33:29 +02:00
return adapter.deSerialize(object, buffer, size, streamEndianness);
}
private:
2020-09-10 15:17:38 +02:00
/**
* Internal template to deduce the right function calls at compile time
*/
template<typename T, bool> class InternalSerializeAdapter;
/**
* Template to be used if T is not a child of SerializeIF
*
* @tparam T T must be trivially_copyable
*/
template<typename T>
class InternalSerializeAdapter<T, false> {
static_assert (std::is_trivially_copyable<T>::value,
2020-09-10 15:25:29 +02:00
"If a type needs to be serialized it must be a child of "
"SerializeIF or trivially copy-able");
2020-08-28 18:33:29 +02:00
public:
static ReturnValue_t serialize(const T *object, uint8_t **buffer,
2020-09-04 15:56:52 +02:00
size_t *size, size_t max_size,
SerializeIF::Endianness streamEndianness) {
2020-08-28 18:33:29 +02:00
size_t ignoredSize = 0;
2020-09-04 15:56:52 +02:00
if (size == nullptr) {
2020-08-28 18:33:29 +02:00
size = &ignoredSize;
}
2020-09-10 15:25:29 +02:00
// Check remaining size is large enough and check integer
// overflow of *size
2020-09-10 15:17:38 +02:00
size_t newSize = sizeof(T) + *size;
if ((newSize <= max_size) and (newSize > *size)) {
2020-08-28 18:33:29 +02:00
T tmp;
switch (streamEndianness) {
case SerializeIF::Endianness::BIG:
tmp = EndianConverter::convertBigEndian<T>(*object);
break;
case SerializeIF::Endianness::LITTLE:
tmp = EndianConverter::convertLittleEndian<T>(*object);
break;
default:
case SerializeIF::Endianness::MACHINE:
tmp = *object;
break;
}
2020-09-10 15:25:29 +02:00
std::memcpy(*buffer, &tmp, sizeof(T));
2020-08-28 18:33:29 +02:00
*size += sizeof(T);
(*buffer) += sizeof(T);
return HasReturnvaluesIF::RETURN_OK;
} else {
return SerializeIF::BUFFER_TOO_SHORT;
}
}
ReturnValue_t deSerialize(T *object, const uint8_t **buffer,
size_t *size, SerializeIF::Endianness streamEndianness) {
T tmp;
if (*size >= sizeof(T)) {
*size -= sizeof(T);
2020-09-10 15:25:29 +02:00
std::memcpy(&tmp, *buffer, sizeof(T));
2020-08-28 18:33:29 +02:00
switch (streamEndianness) {
case SerializeIF::Endianness::BIG:
*object = EndianConverter::convertBigEndian<T>(tmp);
break;
case SerializeIF::Endianness::LITTLE:
*object = EndianConverter::convertLittleEndian<T>(tmp);
break;
default:
case SerializeIF::Endianness::MACHINE:
*object = tmp;
break;
}
*buffer += sizeof(T);
return HasReturnvaluesIF::RETURN_OK;
} else {
return SerializeIF::STREAM_TOO_SHORT;
}
}
uint32_t getSerializedSize(const T *object) {
return sizeof(T);
}
};
2020-09-10 15:17:38 +02:00
/**
* Template for objects that inherit from SerializeIF
*
* @tparam T A child of SerializeIF
*/
2020-08-28 18:33:29 +02:00
template<typename T>
2020-09-10 15:17:38 +02:00
class InternalSerializeAdapter<T, true> {
2020-08-28 18:33:29 +02:00
public:
2020-09-10 15:17:38 +02:00
ReturnValue_t serialize(const T *object, uint8_t **buffer, size_t *size,
size_t max_size,
2020-08-28 18:33:29 +02:00
SerializeIF::Endianness streamEndianness) const {
size_t ignoredSize = 0;
2020-09-04 15:56:52 +02:00
if (size == nullptr) {
2020-08-28 18:33:29 +02:00
size = &ignoredSize;
}
return object->serialize(buffer, size, max_size, streamEndianness);
}
2020-09-10 15:17:38 +02:00
size_t getSerializedSize(const T *object) const {
2020-08-28 18:33:29 +02:00
return object->getSerializedSize();
}
ReturnValue_t deSerialize(T *object, const uint8_t **buffer,
size_t *size, SerializeIF::Endianness streamEndianness) {
return object->deSerialize(buffer, size, streamEndianness);
}
};
};
2020-09-10 15:17:38 +02:00
#endif /* _FSFW_SERIALIZE_SERIALIZEADAPTER_H_ */