RegistrySerializer.h

Go to the documentation of this file.

/* Copyright (c) 2023 Skyward Experimental Rocketry
 * Author: Nicolò Caruso
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#pragma once
 
#include <utils/Debug.h>
 
#include <cstdint>
#include <cstring>
#include <functional>
#include <unordered_map>
#include <vector>
 
#include "RegistryTypes.h"
 
namespace Boardcore
{
 
using RegistryConfiguration =
    std::unordered_map<ConfigurationId, EntryStructsUnion>;
 
struct RegistryHeader
{
    uint64_t startBytes;  
    uint32_t totalSize;   
    uint32_t nrEntries;   
};
 
struct RegistryFooter
{
    uint32_t checksum;
};
 
class RegistrySerializer
{
public:
    explicit RegistrySerializer(std::vector<uint8_t>& vector);
 
    RegistryError serializeConfiguration(RegistryConfiguration& configuration);
 
    RegistryError deserializeConfiguration(
        RegistryConfiguration& configuration);
 
private:
    std::vector<uint8_t>& serializationVector;
    uint32_t vectorWritePosition;
 
    uint32_t computeChecksum();
 
    template <typename T>
    RegistryError deserialize(T& element)
    {
        size_t elSize = sizeof(T);
 
        if (serializationVector.size() < vectorWritePosition + elSize)
            return RegistryError::MALFORMED_SERIALIZED_DATA;
 
        std::memcpy(&element, serializationVector.data() + vectorWritePosition,
                    elSize);
 
        vectorWritePosition += elSize;
        return RegistryError::OK;
    }
 
    template <typename T>
    RegistryError serialize(T& element)
    {
        size_t elSize = sizeof(T);
 
        if (serializationVector.size() < vectorWritePosition + elSize)
            return RegistryError::WRONG_WRITES_SIZE;
 
        std::memcpy(serializationVector.data() + vectorWritePosition, &element,
                    elSize);
 
        vectorWritePosition += elSize;
        return RegistryError::OK;
    }
 
    size_t size(RegistryConfiguration& configuration);
};
 
}  // namespace Boardcore