codec_legacy.h

Go to the documentation of this file.

 
#ifndef DDL_CODEC_LEGACY_CLASS_HEADER
#define DDL_CODEC_LEGACY_CLASS_HEADER
 
#include <a_util/preprocessor/deprecated.h> // DEV_ESSENTIAL_DEPRECATED()
#include <a_util/result.h>
#include <ddl/codec/codec.h>
#include <ddl/codec/legacy/static_codec_legacy.h>

#define DEV_ESSENTIAL_DEPRECATED_DECODER                                                           \
    DEV_ESSENTIAL_DEPRECATED("Use the new ddl::codec::Decoder() instead.")
 
#define DEV_ESSENTIAL_DEPRECATED_CODEC                                                             \
    DEV_ESSENTIAL_DEPRECATED("Use the new ddl::codec::Codec() instead.")
 
namespace ddl {
class Codec;

struct LegacyOffsets {
    size_t deserialized; 
    size_t serialized;   
};

class Decoder : public StaticDecoder {
public:
    DEV_ESSENTIAL_DEPRECATED_DECODER
    Decoder() = default;

    Decoder(Decoder&&) = default;

    DEV_ESSENTIAL_DEPRECATED_DECODER
    Decoder& operator=(Decoder&&) = default;

    Decoder(const Decoder&) = delete;

    Decoder& operator=(const Decoder&) = delete;

    a_util::result::Result isValid() const override;

    size_t getElementCount() const override;

    size_t getBufferSize(DataRepresentation rep = deserialized) const;

    Codec makeCodecFor(void* data, size_t data_size, DataRepresentation rep) const;
 
protected:
    friend class CodecFactory;
    virtual const void* getLayoutElement(size_t index) const;
    Decoder(const std::shared_ptr<LegacyCodecAccess>& legacy_codec_access);

    Decoder(std::shared_ptr<const StructLayout>,
            const void* data,
            size_t data_size,
            DataRepresentation rep);
 
private:
    std::shared_ptr<std::vector<int32_t>> _compat_dynamic_elements;
    LegacyOffsets _compat_buffer_sizes;
};

class Codec : public Decoder {
public:
    DEV_ESSENTIAL_DEPRECATED_CODEC
    Codec() = default;

    Codec(Codec&&) = default;

    DEV_ESSENTIAL_DEPRECATED_CODEC
    Codec& operator=(Codec&&) = default;

    a_util::result::Result setElementValue(size_t index, const void* value);

    a_util::result::Result setElementValue(size_t index, const a_util::variant::Variant& value);

    void* getElementAddress(size_t index);
    using StaticDecoder::getElementAddress;

    a_util::result::Result setConstants();
 
protected:
    friend class CodecFactory;
    friend class Decoder;
    Codec(std::shared_ptr<const StructLayout> layout,
          void* data,
          size_t data_size,
          DataRepresentation rep);
    Codec(codec::Codec&& codec);
};
 
} // namespace ddl
 
#endif // DDL_CODEC_LEGACY_CLASS_HEADER