FileSystem.h

#pragma once
 
#include <Foundation/Communication/Event.h>
#include <Foundation/Containers/HybridArray.h>
#include <Foundation/Containers/Map.h>
#include <Foundation/IO/FileSystem/Implementation/DataDirType.h>
#include <Foundation/IO/OSFile.h>
#include <Foundation/Threading/Mutex.h>
 
class PL_FOUNDATION_DLL plFileSystem
{
public:
  struct FileEventType;
 
  struct FileEvent;
 
  static plEventSubscriptionID RegisterEventHandler(plEvent<const FileEvent&>::Handler handler);
 
  static void UnregisterEventHandler(plEvent<const FileEvent&>::Handler handler);
  static void UnregisterEventHandler(plEventSubscriptionID subscriptionId);
 
public:
 
  using plDataDirFactory = plDataDirectoryType* (*)(plStringView, plStringView, plStringView, plDataDirUsage);
 
  static void RegisterDataDirectoryFactory(plDataDirFactory factory, float fPriority = 0); // [tested]
 
  static void ClearAllDataDirectoryFactories() { s_pData->m_DataDirFactories.Clear(); } // [tested]
 
  static plResult AddDataDirectory(plStringView sDataDirectory, plStringView sGroup = {}, plStringView sRootName = {}, plDataDirUsage usage = plDataDirUsage::ReadOnly); // [tested]
 
  static bool RemoveDataDirectory(plStringView sRootName);
 
  static plUInt32 RemoveDataDirectoryGroup(plStringView sGroup); // [tested]
 
  static void ClearAllDataDirectories(); // [tested]
 
  static const plDataDirectoryInfo* FindDataDirectoryWithRoot(plStringView sRootName);
 
  static plUInt32 GetNumDataDirectories(); // [tested]
 
  static plDataDirectoryType* GetDataDirectory(plUInt32 uiDataDirIndex); // [tested]
 
  static const plDataDirectoryInfo& GetDataDirectoryInfo(plUInt32 uiDataDirIndex);
 
  static void ReloadAllExternalDataDirectoryConfigs();
 
 
  static plResult DetectSdkRootDirectory(plStringView sExpectedSubFolder = "Data/Base");
 
  static void SetSdkRootDirectory(plStringView sSdkDir);
 
  static plStringView GetSdkRootDirectory();
 
  static void SetSpecialDirectory(plStringView sName, plStringView sReplacement);
 
  static plResult ResolveSpecialDirectory(plStringView sDirectory, plStringBuilder& out_sPath);
 
 
 
  static plMutex& GetMutex();
 
#if PL_ENABLED(PL_SUPPORTS_FILE_ITERATORS)
  static void StartSearch(plFileSystemIterator& ref_iterator, plStringView sSearchTerm, plBitflags<plFileSystemIteratorFlags> flags = plFileSystemIteratorFlags::Default);
#endif
 
 
  static plResult CreateDirectoryStructure(plStringView sPath);
 
public:
  static void DeleteFile(plStringView sFile); // [tested]
 
  static bool ExistsFile(plStringView sFile); // [tested]
 
  static plResult GetFileStats(plStringView sFileOrFolder, plFileStats& out_stats);
 
  static plResult ResolvePath(plStringView sPath, plStringBuilder* out_pAbsolutePath, plStringBuilder* out_pDataDirRelativePath, const plDataDirectoryInfo** out_pDataDir = nullptr); // [tested]
 
  static plResult FindFolderWithSubPath(plStringBuilder& ref_sResult, plStringView sStartDirectory, plStringView sSubPath, plStringView sRedirectionFileName = {}); // [tested]
 
  static bool ResolveAssetRedirection(plStringView sPathOrAssetGuid, plStringBuilder& out_sRedirection);
 
  static plStringView MigrateFileLocation(plStringView sOldLocation, plStringView sNewLocation);
 
private:
  friend class plDataDirectoryReaderWriterBase;
  friend class plFileReaderBase;
  friend class plFileWriterBase;
 
  static plDataDirectoryReader* GetFileReader(plStringView sFile, plFileShareMode::Enum FileShareMode, bool bAllowFileEvents);
 
  static plDataDirectoryWriter* GetFileWriter(plStringView sFile, plFileShareMode::Enum FileShareMode, bool bAllowFileEvents);
 
 
private:
  PL_MAKE_SUBSYSTEM_STARTUP_FRIEND(Foundation, FileSystem);
 
  static void Startup();
 
  static void Shutdown();
 
private:
  struct Factory
  {
    PL_DECLARE_POD_TYPE();
 
    float m_fPriority;
    plDataDirFactory m_Factory;
  };
 
  struct FileSystemData
  {
    plHybridArray<Factory, 4> m_DataDirFactories;
    plHybridArray<plDataDirectoryInfo, 16> m_DataDirectories;
 
    plEvent<const FileEvent&, plMutex> m_Event;
    plMutex m_FsMutex;
  };
 
  static plStringView ExtractRootName(plStringView sFile, plString& rootName);
 
  static plStringView GetDataDirRelativePath(plStringView sFile, plUInt32 uiDataDir);
 
  static plDataDirectoryInfo* GetDataDirForRoot(const plString& sRoot);
 
  static void CleanUpRootName(plStringBuilder& sRoot);
 
  static plString s_sSdkRootDir;
  static plMap<plString, plString> s_SpecialDirectories;
  static FileSystemData* s_pData;
};
 
struct plFileSystem::FileEventType
{
  enum Enum
  {
    None,                      
    OpenFileAttempt,           
    OpenFileSucceeded,         
    OpenFileFailed,            
    CreateFileAttempt,         
    CreateFileSucceeded,       
    CreateFileFailed,          
    CloseFile,                 
    AddDataDirectorySucceeded, 
    AddDataDirectoryFailed,    
    RemoveDataDirectory,       
    DeleteFile                 
  };
};
 
struct plFileSystem::FileEvent
{
  plFileSystem::FileEventType::Enum m_EventType = FileEventType::None;
 
  plStringView m_sFileOrDirectory;
 
  plStringView m_sOther;
 
  const plDataDirectoryType* m_pDataDir = nullptr;
};