InputArchive.h

Go to the documentation of this file.

/*
Copyright 2007-2025. Algoryx Simulation AB.
 
All AGX source code, intellectual property, documentation, sample code,
tutorials, scene files and technical white papers, are copyrighted, proprietary
and confidential material of Algoryx Simulation AB. You may not download, read,
store, distribute, publish, copy or otherwise disseminate, use or expose this
material unless having a written signed agreement with Algoryx Simulation AB, or having been
advised so by Algoryx Simulation AB for a time limited evaluation, or having purchased a
valid commercial license from Algoryx Simulation AB.
 
Algoryx Simulation AB disclaims all responsibilities for loss or damage caused
from using this software, unless otherwise stated in written agreements with
Algoryx Simulation AB.
*/
#pragma once
 
#ifdef _MSC_VER
# pragma warning(push)
# pragma warning( disable : 4290 )  // C++ exception specification ignored except to indicate a function is not __declspec(nothrow)
#endif
 
#include <agx/agx.h>
#include <agx/agxCore_export.h>
 
#include <agx/Vector.h>
#include <agxStream/Archive.h>
 
#include <agx/String.h>
#include <agx/Name.h>
#include <agx/Vec3.h>
#include <agx/Vec2.h>
#include <agx/Quat.h>
#include <agx/Range.h>
#include <agx/Matrix3x3.h>
#include <agx/SPDMatrix3x3.h>
#include <agxStream/Serializable.h>
#include <agxStream/RestoreListener.h>
#include <agx/Uuid.h>
#include <sstream>
 
namespace agxStream
{
  class Serializable;
  class StorageAgent;
 
  class AGXCORE_EXPORT InputArchive : public Archive
  {
 
  public:
    typedef agx::Event3<agx::UInt32, Serializable *, const std::string&> RestoreEvent;
    RestoreEvent restoreEvent;
 
 
    typedef agx::VectorPOD< Serializable* > IdToObjectVector;
    typedef agx::Vector< std::string > IdToClassNameVector;
    typedef agx::Vector< StorageAgent* > IdToStorageAgentVector;
 
  public:
    InputArchive(std::istream& inputStream);
    InputArchive(std::istream& inputStream, IdToObjectVector& objectCache, IdToClassNameVector& nameCache);
 
    void open();
 
    bool addRestoreListener(RestoreListener *listener);
 
    bool removeRestoreListener(RestoreListener *listener);
 
    std::istream& getStream();
 
    agx::String getAppName() const;
 
    agx::UInt8 getGenerationVersion() const;
 
    agx::UInt8 getMajorVersion() const;
 
    agx::UInt8 getMinorVersion() const;
 
    agx::UInt8 getPatchVersion() const;
 
    agx::String getRevision() const;
 
    agx::String getBuildDate() const;
 
    agx::String getBuildTime() const;
 
    agx::String getArchiveDate() const;
 
 
    agx::UInt16 getSerializationVersion() const;
 
    typedef agx::HashTable<agx::UInt, bool> BuildConfigurationTable;
    const BuildConfigurationTable& getBuildFlags() const;
 
    size_t getVersion() const;
 
    virtual void read(char& val);
    virtual void read(bool& val);
    virtual void read(agx::Int8& val);
    virtual void read(agx::UInt8& val);
    virtual void read(agx::Int16& val);
    virtual void read(agx::UInt16& val);
 
    virtual void read(agx::UInt32& val);
    virtual void read(agx::Int32& val);
 
    virtual void read(std::string& val);
    virtual void read(agx::UInt64& val);
    virtual void read(agx::Int64& val);
    virtual void read(float& val);
    virtual void read(double& val);
 
#ifdef __APPLE__
    virtual void read( size_t& val );
#endif
 
    virtual void read(agx::RangeReal& val);
    virtual void read(agx::Vec2f& val);
    virtual void read(agx::Vec2d& val);
    virtual void read(agx::Vec2i32& val);
    virtual void read(agx::Vec2i64& val);
 
    virtual void read(agx::Vec3f& val);
    virtual void read(agx::Vec3d& val);
    virtual void read(agx::Vec3i32& val);
    virtual void read(agx::Vec3i64& val);
    virtual void read(agx::Vec4f& val);
    virtual void read(agx::Vec4d& val);
 
    virtual void read(agx::Quat& val);
    virtual void read(agx::SPDMatrix3x3& val);
    virtual void read(agx::Matrix3x3d& val);
    virtual void read(agx::Matrix3x3f& val);
    virtual void read(agx::AffineMatrix4x4f& val);
    virtual void read(agx::AffineMatrix4x4d& val);
    virtual void read(agx::Uuid& val);
 
    virtual void read(void* buf, size_t len);
 
 
    virtual void read(agx::String& val);
 
    virtual void read(agx::Name& val);
 
    template<typename T>
    void readRef(T** obj, StorageMode mode)
    {
      if (mode == STORE_BY_REF) {
 
        Serializable* sObj;
 
        sObj = readObjectByRef();
 
        *obj = dynamic_cast<T*>(sObj);
        if (sObj != 0 && *obj == 0) {
          agx::String str = agx::String::format("Type mismatch: read type \'%s\' Expected \'%s\'",
            sObj->getClassName(),
            T::getConstructClassId());
 
          agxThrow ArchiveException(str);
        }
      }
      else
      {
        agxThrow ArchiveException("Invalid storage mode specified for read");
      }
    }
 
    void readVal(Serializable& obj, StorageMode mode);
 
    Serializable* readObjectByRef();
    bool readObjectByVal(Serializable& obj);
 
    void setFinished();
 
    int getNumObjectsRead() const;
 
    bool getEndianMatch() const;
 
    enum RestoreMode
    {
      TRY_BY_VALUE,     
      TRY_BY_REFERENCE, 
      DEFAULT = TRY_BY_REFERENCE
    };
 
    void setRestoreMode(RestoreMode mode);
    RestoreMode getRestoreMode() const;
 
    virtual void beginSection(const char* title) override;
    virtual void endSection(const char* title) override;
 
    virtual void getAttribute(const char *name, double& value);
    virtual void getAttribute(const char *name, float& value);
    virtual void getAttribute(const char *name, bool& value);
    virtual void getAttribute(const char *name, std::string& value);
    virtual void getAttribute(const char *name, char& value);
    virtual void getAttribute(const char *name, agx::UInt16& value);
    virtual void getAttribute(const char *name, agx::UInt64& value);
    virtual void getAttribute(const char *name, agx::UInt32& value);
    virtual void getAttribute(const char *name, agx::Int32& value);
    virtual void getAttribute(const char *name, agx::Int8& value);
    virtual void getAttribute(const char *name, agx::UInt8& value);
    virtual void getAttribute(const char *name, agx::Uuid& value);
 
#ifdef __APPLE__
    virtual void getAttribute(const char *name, size_t& value);
#endif
 
    bool hasModification(const char *str) const;
 
    bool hasModifications(const agx::StringVector& modifications) const;
 
 
    bool eof() const;
 
    template<typename VECTOR_TYPE>
    AGXCORE_EXPORT void read_vector(const agx::String& name, VECTOR_TYPE& val);
 
 
  protected:
    virtual ~InputArchive();
 
    void  readCompareBitSize();
 
    virtual void readArchiveHeader();
    virtual void readObjectHeader(StorageMode& storageMode, StorageAgent*& agent);
    virtual void readTypeHeader(StorageAgent*& agent);
 
 
    virtual size_t getNumBytesRead() const;
 
  protected:
    friend class Serializable;
    friend class StorageAgent;
 
    bool removeObject(Serializable *object);
 
 
    std::istream& m_inputStream;
    IdToObjectVector m_defaultObjectCache;
    IdToObjectVector& m_IdToObjectVector;
    IdToClassNameVector m_defaultNameCache;
    IdToClassNameVector& m_idToClassNameVector;
    IdToStorageAgentVector m_IdToStorageAgentVector;
 
    // copy constructor and assignment operator prohibited
    InputArchive(const InputArchive& inputStream);
    InputArchive& operator=(const InputArchive&);
 
    typedef agx::HashTable<RestoreListener *, RestoreListenerRef> RestoreListenerHash;
    RestoreListenerHash m_restoreListeners;
  protected:
 
    agx::String getVersionStringMessage() const;
 
    agx::String getSerializationVersionStringMessage() const;
 
    void readHeaderData();
    void eof(bool flag);
  private:
 
    template<typename T>
    void readCorrectNumBytes(T& val);
 
    agx::String getSectionStackString() const;
 
    virtual agx::String getErrorMessage(const agx::String& message);
 
 
    BuildConfigurationTable m_buildFlags;
 
 
    agx::String m_appName;
    agx::UInt8 m_generationVersion, m_majorVersion, m_minorVersion, m_patchVersion;
    agx::String m_revision;
    agx::UInt16 m_serialization_version;
 
    size_t m_numBytesRead;
    int m_numObjectsRead; // for diagnostic purposes
 
    bool m_finished;
    char m_endianMatch;
    RestoreMode m_restoreMode;
    bool m_atEof;
    agx::String m_buildDate;
    agx::String m_buildTime;
    agx::Vector<agx::String> m_sectionStack;
    agx::String m_archiveDate;
 
    void readModificationData();
    agx::HashSet<agx::String> m_modificationHash;
  };
 
  typedef agx::ref_ptr<InputArchive> InputArchiveRef;
 
 
  inline bool InputArchive::eof() const
  {
    return m_atEof;
  }
  inline void InputArchive::eof(bool flag)
  {
    m_atEof = flag;
  }
 
  template <typename T>
  struct InputVal {
    InputVal(const char *name, T& obj) : m_name(name), m_obj(obj), m_mode(STORE_BY_VALUE) { m_objPtr = &m_obj; }
    InputVal(const char *name, T* obj) : m_name(name), m_obj(*obj), m_objPtr(obj), m_mode(STORE_BY_REF) {}
 
    const char *m_name;
    T & m_obj;
    T *m_objPtr;
 
    StorageMode m_mode;
    InputVal & operator=(const InputVal& other) { m_obj = other.m_obj; m_name = other.m_name; m_mode = other.m_mode; return *this; }
  };
 
  template <typename T>
  struct InputRef {
    InputRef(const char *name, T& obj) : m_name(name), m_obj(obj), m_mode(STORE_BY_REF) {}
 
    const char *m_name;
    T & m_obj;
 
    StorageMode m_mode;
    InputRef & operator=(const InputRef& other) { m_obj = other.m_obj; m_name = other.m_name; m_mode = other.m_mode; return *this; }
  };
 
 
  template <typename T>
  InputRef<T> in(const char *name, T& obj) { return InputRef<T>(name, obj); }
 
  template <typename T>
  InputVal<T> in_val(const char *name, T& obj) { return InputVal<T>(name, obj); }
 
 
#define DECLARE_INPUT_BASIC_TYPE(TYPE) \
  AGXCORE_EXPORT inline agxStream::InputArchive& operator>>( InputArchive& in, InputVal<TYPE> val ) \
  { \
  in.beginSection(val.m_name);  \
  in.read( val.m_obj ); \
  in.endSection(val.m_name); \
  return in;\
  } \
  inline InputVal<TYPE> in(const char *name, TYPE& obj) { return InputVal<TYPE>(name, obj); }
 
  DECLARE_INPUT_BASIC_TYPE(std::string)
  DECLARE_INPUT_BASIC_TYPE(agx::String)
  DECLARE_INPUT_BASIC_TYPE(agx::Name)
  DECLARE_INPUT_BASIC_TYPE(bool)
  DECLARE_INPUT_BASIC_TYPE(char)
  DECLARE_INPUT_BASIC_TYPE(agx::Int8)
  DECLARE_INPUT_BASIC_TYPE(agx::UInt8)
  DECLARE_INPUT_BASIC_TYPE(agx::Int16)
  DECLARE_INPUT_BASIC_TYPE(agx::UInt16)
  DECLARE_INPUT_BASIC_TYPE(agx::Int32)
  DECLARE_INPUT_BASIC_TYPE(agx::UInt32)
  DECLARE_INPUT_BASIC_TYPE(agx::Int64)
  DECLARE_INPUT_BASIC_TYPE(agx::UInt64)
#ifdef __APPLE__
  DECLARE_INPUT_BASIC_TYPE(size_t)
#endif
 
  DECLARE_INPUT_BASIC_TYPE(float)
  DECLARE_INPUT_BASIC_TYPE(double)
  DECLARE_INPUT_BASIC_TYPE(agx::RangeReal)
  DECLARE_INPUT_BASIC_TYPE(agx::Vec2f)
  DECLARE_INPUT_BASIC_TYPE(agx::Vec2d)
  DECLARE_INPUT_BASIC_TYPE(agx::Vec2i32)
  DECLARE_INPUT_BASIC_TYPE(agx::Vec2i64)
  DECLARE_INPUT_BASIC_TYPE(agx::Vec3f)
  DECLARE_INPUT_BASIC_TYPE(agx::Vec3d)
  DECLARE_INPUT_BASIC_TYPE(agx::Vec3i32)
  DECLARE_INPUT_BASIC_TYPE(agx::Vec3i64)
  DECLARE_INPUT_BASIC_TYPE(agx::Vec4f)
  DECLARE_INPUT_BASIC_TYPE(agx::Vec4d)
  DECLARE_INPUT_BASIC_TYPE(agx::Quat)
  DECLARE_INPUT_BASIC_TYPE(agx::SPDMatrix3x3)
  DECLARE_INPUT_BASIC_TYPE(agx::AffineMatrix4x4)
  DECLARE_INPUT_BASIC_TYPE(agx::Matrix3x3f)
  DECLARE_INPUT_BASIC_TYPE(agx::Matrix3x3d)
  DECLARE_INPUT_BASIC_TYPE(agx::Uuid)
 
  template <typename T>
  inline InputArchive& operator>>(InputArchive& in, InputVal<T> val)
  {
    in.beginSection(val.m_name);
    in.readVal(val.m_obj, val.m_mode);
    in.endSection(val.m_name);
    return in;
  }
  template <typename T>
  inline InputArchive& operator>>(InputArchive& in, InputRef<T> val)
  {
    in.beginSection(val.m_name);
    in.readRef(&(val.m_obj), val.m_mode);
    in.endSection(val.m_name);
    return in;
  }
 
 
 
  template<typename T>
  void restoreRefPtr(agxStream::InputArchive& in, const char* name, agx::ref_ptr<T>& refPtr)
  {
    T* object = nullptr;
    in >> agxStream::in(name, object);
    refPtr = object;
  }
 
  template<typename T>
  void restoreObserverPtr(agxStream::InputArchive& in, const char* name, agx::observer_ptr<T>& observerPtr)
  {
    T* object = nullptr;
    in >> agxStream::in(name, object);
    observerPtr = object;
  }
 
}
 
#ifdef _MSC_VER
# pragma warning(pop)
#endif