cafSerializer.h

// ##################################################################################################
//
//    Caffa
//    Copyright (C) 2021- 3D-Radar AS
//
//    GNU Lesser General Public License Usage
//    This library is free software; you can redistribute it and/or modify
//    it under the terms of the GNU Lesser General Public License as published by
//    the Free Software Foundation; either version 2.1 of the License, or
//    (at your option) any later version.
//
//    This library is distributed in the hope that it will be useful, but WITHOUT ANY
//    WARRANTY; without even the implied warranty of MERCHANTABILITY or
//    FITNESS FOR A PARTICULAR PURPOSE.
//
//    See the GNU Lesser General Public License at <<http://www.gnu.org/licenses/lgpl-2.1.html>>
//    for more details.
//
#pragma once
 
#include "cafFieldHandle.h"
 
#include <functional>
#include <iostream>
#include <memory>
 
namespace caffa
{
class ObjectHandle;
class ObjectFactory;
 
class Serializer
{
public:
    enum class SerializationType
    {
        DATA_FULL,
        DATA_SKELETON,
        SCHEMA,
    };
 
    using FieldSelector = std::function<bool( const FieldHandle* )>;
 
    static std::string serializationTypeLabel( SerializationType type );
 
    Serializer( ObjectFactory* objectFactory );
 
    virtual std::string readUUIDFromObjectString( const std::string& string ) const = 0;
 
    virtual void readObjectFromString( ObjectHandle* object, const std::string& string ) const = 0;
 
    virtual std::string writeObjectToString( const ObjectHandle* object ) const = 0;
 
    virtual std::shared_ptr<ObjectHandle> copyBySerialization( const ObjectHandle* object ) const = 0;
 
    virtual std::shared_ptr<ObjectHandle>
        copyAndCastBySerialization( const ObjectHandle* object, const std::string& destinationClassKeyword ) const = 0;
 
    virtual std::shared_ptr<ObjectHandle> createObjectFromString( const std::string& string ) const = 0;
 
    virtual void readStream( ObjectHandle* object, std::istream& stream ) const = 0;
 
    virtual void writeStream( const ObjectHandle* object, std::ostream& stream ) const = 0;
 
    Serializer& setFieldSelector( FieldSelector fieldSelector );
 
    Serializer& setSerializationType( SerializationType type );
 
    Serializer& setSerializeUuids( bool serializeUuids );
 
    ObjectFactory* objectFactory() const;
 
    FieldSelector fieldSelector() const;
 
    SerializationType serializationType() const;
 
    bool serializeUuids() const;
 
protected:
    ObjectFactory* m_objectFactory;
    FieldSelector  m_fieldSelector;
 
    SerializationType m_serializationType;
    bool              m_serializeUuids;
};
 
} // End of namespace caffa