Merge branch 'mueller/expand-serialize-if' into mueller/new-object-id-type

src/fsfw/serialize.h

@@ -1,10 +1,10 @@
 #ifndef FSFW_INC_FSFW_SERIALIZE_H_
 #define FSFW_INC_FSFW_SERIALIZE_H_
 
-#include "src/core/serialize/EndianConverter.h"
-#include "src/core/serialize/SerialArrayListAdapter.h"
-#include "src/core/serialize/SerialBufferAdapter.h"
-#include "src/core/serialize/SerialLinkedListAdapter.h"
-#include "src/core/serialize/SerializeElement.h"
+#include "fsfw/serialize/EndianConverter.h"
+#include "fsfw/serialize/SerialArrayListAdapter.h"
+#include "fsfw/serialize/SerialBufferAdapter.h"
+#include "fsfw/serialize/SerialLinkedListAdapter.h"
+#include "fsfw/serialize/SerializeElement.h"
 
 #endif /* FSFW_INC_FSFW_SERIALIZE_H_ */

src/fsfw/serialize/EndianConverter.h

@@ -4,7 +4,7 @@
 #include <cstdint>
 #include <cstring>
 
-#include "../osal/Endiness.h"
+#include "fsfw/osal/Endiness.h"
 
 /**
  * Helper class to convert variables or bitstreams between machine
@@ -36,7 +36,7 @@
  */
 class EndianConverter {
  private:
-  EndianConverter(){};
+  EndianConverter() = default;
 
  public:
   /**
@@ -49,8 +49,8 @@ class EndianConverter {
 #error BYTE_ORDER_SYSTEM not defined
 #elif BYTE_ORDER_SYSTEM == LITTLE_ENDIAN
     T tmp;
-    uint8_t *pointerOut = (uint8_t *)&tmp;
-    uint8_t *pointerIn = (uint8_t *)&in;
+    auto *pointerOut = reinterpret_cast<uint8_t *>(&tmp);
+    auto *pointerIn = reinterpret_cast<uint8_t *>(&in);
     for (size_t count = 0; count < sizeof(T); count++) {
       pointerOut[sizeof(T) - count - 1] = pointerIn[count];
     }
@@ -73,10 +73,8 @@ class EndianConverter {
     for (size_t count = 0; count < size; count++) {
       out[size - count - 1] = in[count];
     }
-    return;
 #elif BYTE_ORDER_SYSTEM == BIG_ENDIAN
     memcpy(out, in, size);
-    return;
 #endif
   }
 
@@ -90,8 +88,8 @@ class EndianConverter {
 #error BYTE_ORDER_SYSTEM not defined
 #elif BYTE_ORDER_SYSTEM == BIG_ENDIAN
     T tmp;
-    uint8_t *pointerOut = (uint8_t *)&tmp;
-    uint8_t *pointerIn = (uint8_t *)&in;
+    auto *pointerOut = reinterpret_cast<uint8_t *>(&tmp);
+    auto *pointerIn = reinterpret_cast<uint8_t *>(&in);
     for (size_t count = 0; count < sizeof(T); count++) {
       pointerOut[sizeof(T) - count - 1] = pointerIn[count];
     }
@@ -113,10 +111,8 @@ class EndianConverter {
     for (size_t count = 0; count < size; count++) {
       out[size - count - 1] = in[count];
     }
-    return;
 #elif BYTE_ORDER_SYSTEM == LITTLE_ENDIAN
     memcpy(out, in, size);
-    return;
 #endif
   }
 };

src/fsfw/serialize/SerializeIF.h

@@ -3,7 +3,7 @@
 
 #include <cstddef>
 
-#include "../returnvalues/HasReturnvaluesIF.h"
+#include "fsfw/returnvalues/HasReturnvaluesIF.h"
 
 /**
  * @defgroup serialize Serialization
@@ -34,7 +34,7 @@ class SerializeIF {
   static const ReturnValue_t TOO_MANY_ELEMENTS =
       MAKE_RETURN_CODE(3);  // !< There are too many elements to be deserialized
 
-  virtual ~SerializeIF() {}
+  virtual ~SerializeIF() = default;
   /**
    * @brief
    * Function to serialize the object into a buffer with maxSize. Size represents the written
@@ -59,14 +59,28 @@ class SerializeIF {
    * 		- @c RETURN_FAILED Generic error
    * 		- @c RETURN_OK Successful serialization
    */
-  virtual ReturnValue_t serialize(uint8_t **buffer, size_t *size, size_t maxSize,
-                                  Endianness streamEndianness) const = 0;
+  [[nodiscard]] virtual ReturnValue_t serialize(uint8_t **buffer, size_t *size, size_t maxSize,
+                                                Endianness streamEndianness) const = 0;
+  /**
+   * Forwards to regular @serialize call with big (network) endianness
+   */
+  [[nodiscard]] virtual ReturnValue_t serializeBe(uint8_t **buffer, size_t *size,
+                                                  size_t maxSize) const {
+    return serialize(buffer, size, maxSize, SerializeIF::Endianness::NETWORK);
+  }
+  /**
+   * If endianness is not explicitly specified, use machine endianness
+   */
+  [[nodiscard]] virtual ReturnValue_t serialize(uint8_t **buffer, size_t *size,
+                                                size_t maxSize) const {
+    return serialize(buffer, size, maxSize, SerializeIF::Endianness::MACHINE);
+  }
 
   /**
    * Gets the size of a object if it would be serialized in a buffer
    * @return Size of serialized object
    */
-  virtual size_t getSerializedSize() const = 0;
+  [[nodiscard]] virtual size_t getSerializedSize() const = 0;
 
   /**
    * @brief
@@ -90,6 +104,69 @@ class SerializeIF {
    */
   virtual ReturnValue_t deSerialize(const uint8_t **buffer, size_t *size,
                                     Endianness streamEndianness) = 0;
+  /**
+   * Forwards to regular @deSerialize call with big (network) endianness
+   */
+  virtual ReturnValue_t deSerializeBe(const uint8_t **buffer, size_t *size) {
+    return deSerialize(buffer, size, SerializeIF::Endianness::NETWORK);
+  }
+  /**
+   * If endianness is not explicitly specified, use machine endianness
+   */
+  virtual ReturnValue_t deSerialize(const uint8_t **buffer, size_t *size) {
+    return deSerialize(buffer, size, SerializeIF::Endianness::MACHINE);
+  }
+
+  /**
+   * Helper method which can be used if serialization should be performed without any additional
+   * pointer arithmetic on a passed buffer pointer
+   * @param buffer
+   * @param maxSize
+   * @param streamEndianness
+   * @return
+   */
+  [[nodiscard]] virtual ReturnValue_t serialize(uint8_t *buffer, size_t maxSize,
+                                                Endianness streamEndianness) const {
+    size_t tmpSize = 0;
+    return serialize(&buffer, &tmpSize, maxSize, streamEndianness);
+  }
+  /**
+   * Forwards to regular @serialize call with big (network) endianness
+   */
+  [[nodiscard]] virtual ReturnValue_t serializeBe(uint8_t *buffer, size_t maxSize) const {
+    return serialize(buffer, maxSize, SerializeIF::Endianness::NETWORK);
+  }
+  /**
+   * If endianness is not explicitly specified, use machine endianness
+   */
+  [[nodiscard]] virtual ReturnValue_t serialize(uint8_t *buffer, size_t maxSize) const {
+    return serialize(buffer, maxSize, SerializeIF::Endianness::MACHINE);
+  }
+
+  /**
+   * Helper methods which can be used if deserialization should be performed without any additional
+   * pointer arithmetic on a passed buffer pointer
+   * @param buffer
+   * @param maxSize
+   * @param streamEndianness
+   * @return
+   */
+  virtual ReturnValue_t deSerialize(const uint8_t *buffer, size_t maxSize,
+                                    Endianness streamEndianness) {
+    return deSerialize(&buffer, &maxSize, streamEndianness);
+  }
+  /**
+   * Forwards to regular @serialize call with big (network) endianness
+   */
+  virtual ReturnValue_t deSerializeBe(const uint8_t *buffer, size_t maxSize) {
+    return deSerialize(buffer, maxSize, SerializeIF::Endianness::NETWORK);
+  }
+  /**
+   * If endianness is not explicitly specified, use machine endianness
+   */
+  virtual ReturnValue_t deSerialize(const uint8_t *buffer, size_t maxSize) {
+    return deSerialize(buffer, maxSize, SerializeIF::Endianness::MACHINE);
+  }
 };
 
 #endif /* FSFW_SERIALIZE_SERIALIZEIF_H_ */