ToolsProject.h

#pragma once
 
#include <Foundation/Communication/Event.h>
#include <Foundation/Configuration/Singleton.h>
#include <Foundation/Types/Status.h>
#include <Foundation/Types/Uuid.h>
#include <ToolsFoundation/ToolsFoundationDLL.h>
 
class plToolsProject;
class plDocument;
 
struct plToolsProjectEvent
{
  enum class Type
  {
    ProjectCreated,
    ProjectOpened,
    ProjectSaveState,
    ProjectClosing,
    ProjectClosed,
    ProjectConfigChanged, 
    SaveAll,              
  };
 
  plToolsProject* m_pProject;
  Type m_Type;
};
 
struct plToolsProjectRequest
{
  plToolsProjectRequest();
 
  enum class Type
  {
    CanCloseProject,        
    CanCloseDocuments,      
    SuggestContainerWindow, 
    GetPathForDocumentGuid,
  };
 
  Type m_Type;
  bool m_bCanClose;                        
  plDynamicArray<plDocument*> m_Documents; 
  plInt32
    m_iContainerWindowUniqueIdentifier; 
 
  plUuid m_documentGuid;
  plStringBuilder m_sAbsDocumentPath;
};
 
class PL_TOOLSFOUNDATION_DLL plToolsProject
{
  PL_DECLARE_SINGLETON(plToolsProject);
 
public:
  static plEvent<const plToolsProjectEvent&> s_Events;
  static plEvent<plToolsProjectRequest&> s_Requests;
 
public:
  static bool IsProjectOpen() { return GetSingleton() != nullptr; }
  static bool IsProjectClosing() { return (GetSingleton() != nullptr && GetSingleton()->m_bIsClosing); }
  static void CloseProject();
  static void SaveProjectState();
  static bool CanCloseProject();
  static bool CanCloseDocuments(plArrayPtr<plDocument*> documents);
  static plInt32 SuggestContainerWindow(plDocument* pDoc);
  plStringBuilder GetPathForDocumentGuid(const plUuid& guid);
  static plStatus OpenProject(plStringView sProjectPath);
  static plStatus CreateProject(plStringView sProjectPath);
 
  static void BroadcastSaveAll();
 
  static void BroadcastConfigChanged();
 
  const plString& GetProjectFile() const { return m_sProjectPath; }
 
  const plString GetProjectName(bool bSanitize) const;
 
  plString GetProjectDirectory() const;
 
  plString GetProjectDataFolder() const;
 
  static plString FindProjectDirectoryForDocument(plStringView sDocumentPath);
 
  bool IsDocumentInAllowedRoot(plStringView sDocumentPath, plString* out_pRelativePath = nullptr) const;
 
  void AddAllowedDocumentRoot(plStringView sPath);
 
  void CreateSubFolder(plStringView sFolder) const;
 
private:
  static plStatus CreateOrOpenProject(plStringView sProjectPath, bool bCreate);
 
private:
  plToolsProject(plStringView sProjectPath);
  ~plToolsProject();
 
  plStatus Create();
  plStatus Open();
 
private:
  bool m_bIsClosing;
  plString m_sProjectPath;
  plHybridArray<plString, 4> m_AllowedDocumentRoots;
};