IArchive.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ACF-Commercial
#pragma once
 
 
// Qt includes
#include <QtCore/QByteArray>
 
// Qt includes
#include <QtCore/QString>
 
 
// ACF includes
#include <istd/IPolymorphic.h>
 
 
namespace iser
{
 
 
class IVersionInfo;
class CArchiveTag;
 
 
class IArchive: virtual public istd::IPolymorphic
{
public:
       enum MessageId
       {
              MI_TAG_ERROR = 0x3f320a0,
              MI_TAG_SKIPPED
       };
 
       virtual bool IsStoring() const = 0;
 
       virtual bool IsTagSkippingSupported() const = 0;
 
       virtual const IVersionInfo& GetVersionInfo() const = 0;
 
       virtual bool BeginTag(const CArchiveTag& tag) = 0;
 
       virtual bool BeginMultiTag(const CArchiveTag& tag, const CArchiveTag& subTag, int& count) = 0;
 
       virtual bool EndTag(const CArchiveTag& tag) = 0;
 
       virtual bool Process(bool& value) = 0;
 
       virtual bool Process(char& value) = 0;
 
       virtual bool Process(quint8& value) = 0;
 
       virtual bool Process(qint8& value) = 0;
 
       virtual bool Process(quint16& value) = 0;
 
       virtual bool Process(qint16& value) = 0;
 
       virtual bool Process(quint32& value) = 0;
 
       virtual bool Process(qint32& value) = 0;
 
       virtual bool Process(quint64& value) = 0;
 
       virtual bool Process(qint64& value) = 0;
 
       virtual bool Process(float& value) = 0;
 
       virtual bool Process(double& value) = 0;
 
       virtual bool Process(QByteArray& value) = 0;
 
       virtual bool Process(QString& value) = 0;
 
       template<typename Primitive>
       bool TagAndProcess(const CArchiveTag& tag, Primitive& value){
              static_assert(!std::is_const_v<Primitive>, "Input value is const-qualified");
              
              return BeginTag(tag) && Process(value) && EndTag(tag);
       }
 
       virtual bool ProcessData(void* dataPtr, int size) = 0;
 
       virtual bool ProcessBits(void* dataPtr, int bitsCount, int bytesCount) = 0;
};
 
 
} // namespace iser