CDocumentManagerBase.h

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ImtCore-Commercial
#pragma once
 
 
// Qt includes
#include <QtCore/QMutex>
#include <QtCore/QString>
#include <QtCore/QThread>
 
// STL includes
#include <atomic>
#include <memory>
 
// ACF includes
#include <idoc/IDocumentManager.h>
#include <idoc/IUndoManager.h>
#include <imod/TMultiModelObserverBase.h>
#include <imod/CMultiModelDispatcherBase.h>
 
// ImtCore includes
#include <imtdoc/IDocumentManager.h>
#include <imtdoc/IDocumentManagerEventHandler.h>
 
 
namespace imtdoc
{
 
 
class CDocumentManagerBase:
                     protected imod::TMultiModelObserverBase<istd::IChangeable>,
                     virtual public imtdoc::IDocumentManager
{
public:
       CDocumentManagerBase();
       virtual ~CDocumentManagerBase();
 
       // reimplemented (imtdoc::IDocumentManager)
       virtual DocumentList GetOpenedDocumentList(const QByteArray& userId) const override;
       virtual QByteArray CreateNewDocument(const QByteArray& userId, const QByteArray& documentTypeId) override;
       virtual QByteArray OpenDocument(const QByteArray& userId, const QUrl& url) override;
       virtual OperationStatus GetDocumentName(const QByteArray& userId, const QByteArray& documentId, QString& documentName) const override;
       virtual OperationStatus SetDocumentName(const QByteArray& userId, const QByteArray& documentId, const QString& documentName) override;
       virtual const istd::IChangeable* GetDocumentPtr(const QByteArray& userId, const QByteArray& documentId) const override;
       virtual OperationStatus GetDocumentData(const QByteArray& userId, const QByteArray& documentId, istd::IChangeableSharedPtr& documentPtr) const override;
       virtual OperationStatus SetDocumentData(const QByteArray& userId, const QByteArray& documentId, const istd::IChangeable& document) override;
       virtual OperationStatus SaveDocument(
              const QByteArray& userId,
              const QByteArray& documentId,
              const QString& documentName = QString(),
              QString* errorMessage = nullptr) override;
       virtual OperationStatus CloseDocument(const QByteArray& userId, const QByteArray& documentId) override;
       virtual OperationStatus GetDocumentUndoManager(
              const QByteArray& userId, const QByteArray& documentId, idoc::IUndoManager*& undoManagerPtr) const override;
       virtual OperationStatus RegisterDocumentObserver(const QByteArray& userId, const QByteArray& documentId, imod::IObserver& observer) override;
       virtual OperationStatus UnregisterDocumentObserver(const QByteArray& userId, const QByteArray& documentId, imod::IObserver& observer) override;
       // reimplemented (iser::ISerializable)
       virtual bool Serialize(iser::IArchive& archive) override;
 
       // reimplemented (imod::CMultiModelObserverBase)
       virtual void OnUpdate(imod::IModel* modelPtr, const istd::IChangeable::ChangeSet& changeSet) override;
 
protected:
       struct WorkingDocument;
 
       bool ValidateInputParams(const QByteArray& userId, const QByteArray& documentId, OperationStatus& status) const;
       virtual QString GetDefaultDocumentName(const WorkingDocument& document) const;
       virtual bool HasDocumentNameProvider(const QByteArray& typeId) const;
       virtual bool ValidateDocumentData(
              const WorkingDocument& document,
              OperationStatus& status,
              QString* errorMessage = nullptr) const;
       static QString GetInvalidDocumentMessage();
       void OnUndoManagerChanged(int modelId);
       int GetUndoManagerNextModelId(const QByteArray& userId);
       WorkingDocument* FindDocument(const QByteArray& userId, const QByteArray& documentId);
       const WorkingDocument* FindDocument(const QByteArray& userId, const QByteArray& documentId) const;
       bool FindDocument(int undoManagerModelId, QByteArray& outUserId, QByteArray& outDocumentId);
       void InitializeDocumentObservers(WorkingDocument& document, const QByteArray& userId);
       void OnDocumentDataLoaded(const QByteArray& userId, const QByteArray& documentId);
       QUrl ObjectIdToUrl(const QByteArray& objectId);
 
       virtual QList<imtdoc::IDocumentManagerEventHandler*> GetDocumentManagerEventHandlers() const;
       virtual istd::IChangeableSharedPtr CreateObject(const QByteArray& typeId) const = 0;
       virtual idoc::IUndoManagerSharedPtr CreateUndoManager() const = 0;
 
protected:
       struct WorkingDocument
       {
              QByteArray objectId;
              QByteArray typeId;
              QUrl url;
              QString name;
              istd::IChangeableSharedPtr objectPtr;
              idoc::IUndoManagerSharedPtr undoManagerPtr;
              bool isDirty;
              bool isLoading = false;
              int undoManagerModelId = -1;
       };
 
       class UndoManagerObserver : public imod::CMultiModelDispatcherBase
       {
       public:
              UndoManagerObserver(CDocumentManagerBase& parent);
 
       protected:
              virtual void OnModelChanged(int modelId, const istd::IChangeable::ChangeSet& changeSet) override;
 
       private:
              CDocumentManagerBase& m_parent;
       };
 
       typedef QMap<QByteArray, WorkingDocument> WorkingDocumentList;
       mutable QMap<QByteArray, WorkingDocumentList> m_userDocuments;
       mutable QRecursiveMutex m_mutex;
 
       UndoManagerObserver m_undoManagerObserver;
       std::shared_ptr<std::atomic<bool>> m_isAlive;
 
protected:
       DocumentNotificationPtr CreateDocumentNotification(const QByteArray& userId, const QByteArray& documentId) const;
};
 
 
} // namespace imtdoc