DocumentManager.h

#pragma once
 
#include <Foundation/Types/Status.h>
#include <ToolsFoundation/Document/Document.h>
#include <ToolsFoundation/ToolsFoundationDLL.h>
 
class PL_TOOLSFOUNDATION_DLL plDocumentManager : public plReflectedClass
{
  PL_ADD_DYNAMIC_REFLECTION(plDocumentManager, plReflectedClass);
 
public:
  virtual ~plDocumentManager() = default;
 
  static const plHybridArray<plDocumentManager*, 16>& GetAllDocumentManagers() { return s_AllDocumentManagers; }
 
  static plResult FindDocumentTypeFromPath(plStringView sPath, bool bForCreation, const plDocumentTypeDescriptor*& out_pTypeDesc);
 
  plStatus CanOpenDocument(plStringView sFilePath) const;
 
  plStatus CreateDocument(
    plStringView sDocumentTypeName, plStringView sPath, plDocument*& out_pDocument, plBitflags<plDocumentFlags> flags = plDocumentFlags::None, const plDocumentObject* pOpenContext = nullptr);
 
  plStatus OpenDocument(plStringView sDocumentTypeName, plStringView sPath, plDocument*& out_pDocument,
    plBitflags<plDocumentFlags> flags = plDocumentFlags::AddToRecentFilesList | plDocumentFlags::RequestWindow,
    const plDocumentObject* pOpenContext = nullptr);
  virtual plStatus CloneDocument(plStringView sPath, plStringView sClonePath, plUuid& inout_cloneGuid);
  void CloseDocument(plDocument* pDocument);
  void EnsureWindowRequested(plDocument* pDocument, const plDocumentObject* pOpenContext = nullptr);
 
  const plDynamicArray<plDocument*>& GetAllOpenDocuments() const { return m_AllOpenDocuments; }
 
  plDocument* GetDocumentByPath(plStringView sPath) const;
 
  static plDocument* GetDocumentByGuid(const plUuid& guid);
 
  static bool EnsureDocumentIsClosedInAllManagers(plStringView sPath);
 
  bool EnsureDocumentIsClosed(plStringView sPath);
 
  void CloseAllDocumentsOfManager();
  static void CloseAllDocuments();
 
  struct Event
  {
    enum class Type
    {
      DocumentTypesRemoved,
      DocumentTypesAdded,
      DocumentOpened,
      DocumentWindowRequested, 
      AfterDocumentWindowRequested, 
      DocumentClosing,
      DocumentClosing2, // sent after DocumentClosing but before removing the document, use this to do stuff that depends on code executed during
                        // DocumentClosing
      DocumentClosed,   // this will not point to a valid document anymore, as the document is deleted, use DocumentClosing to get the event before it
                        // is deleted
    };
 
    Type m_Type;
    plDocument* m_pDocument = nullptr;
    const plDocumentObject* m_pOpenContext = nullptr;
  };
 
  struct Request
  {
    enum class Type
    {
      DocumentAllowedToOpen,
    };
 
    Type m_Type;
    plString m_sDocumentType;
    plString m_sDocumentPath;
    plStatus m_RequestStatus;
  };
 
  static plCopyOnBroadcastEvent<const Event&> s_Events;
  static plEvent<Request&> s_Requests;
 
  static const plDocumentTypeDescriptor* GetDescriptorForDocumentType(plStringView sDocumentType);
  static const plMap<plString, const plDocumentTypeDescriptor*>& GetAllDocumentDescriptors();
 
  void GetSupportedDocumentTypes(plDynamicArray<const plDocumentTypeDescriptor*>& inout_documentTypes) const;
 
  using CustomAction = plVariant (*)(const plDocument*);
  static plMap<plString, CustomAction> s_CustomActions;
 
protected:
  virtual void InternalCloneDocument(plStringView sPath, plStringView sClonePath, const plUuid& documentId, const plUuid& seedGuid, const plUuid& cloneGuid, plAbstractObjectGraph* pHeader, plAbstractObjectGraph* pObjects, plAbstractObjectGraph* pTypes);
 
private:
  virtual void InternalCreateDocument(plStringView sDocumentTypeName, plStringView sPath, bool bCreateNewDocument, plDocument*& out_pDocument, const plDocumentObject* pOpenContext) = 0;
  virtual void InternalGetSupportedDocumentTypes(plDynamicArray<const plDocumentTypeDescriptor*>& inout_DocumentTypes) const = 0;
 
private:
  plStatus CreateOrOpenDocument(bool bCreate, plStringView sDocumentTypeName, plStringView sPath, plDocument*& out_pDocument,
    plBitflags<plDocumentFlags> flags, const plDocumentObject* pOpenContext = nullptr);
 
private:
  PL_MAKE_SUBSYSTEM_STARTUP_FRIEND(ToolsFoundation, DocumentManager);
 
  static void OnPluginEvent(const plPluginEvent& e);
 
  static void UpdateBeforeUnloadingPlugins(const plPluginEvent& e);
  static void UpdatedAfterLoadingPlugins();
 
  plDynamicArray<plDocument*> m_AllOpenDocuments;
 
  static plSet<const plRTTI*> s_KnownManagers;
  static plHybridArray<plDocumentManager*, 16> s_AllDocumentManagers;
 
  static plMap<plString, const plDocumentTypeDescriptor*> s_AllDocumentDescriptors;
};