FileSystem.h

Go to the documentation of this file.

#pragma once
#include <Ultralight/Defines.h>
#include <Ultralight/String16.h>
#include <time.h>

namespace ultralight {

#if defined(__WIN32__) || defined(_WIN32)
typedef size_t FileHandle;
#else
typedef int FileHandle;
#endif

const FileHandle invalidFileHandle = (FileHandle)-1;

enum FileSeekOrigin {
  kFileSeekOrigin_Beginning = 0,
  kFileSeekOrigin_Current,
  kFileSeekOrigin_End
};

enum MetadataType {
  kMetadataType_Unknown = 0,
  kMetadataType_File,
  kMetadataType_Directory,
};

class UExport FileSystem {
public:
  virtual ~FileSystem();

  virtual bool FileExists(const String16& path) = 0;

  virtual bool DeleteFile_(const String16& path) = 0;

  virtual bool DeleteEmptyDirectory(const String16& path) = 0;

  virtual bool MoveFile_(const String16& old_path, const String16& new_path) = 0;

  virtual bool GetFileSize(const String16& path, int64_t& result) = 0;

  virtual bool GetFileSize(FileHandle handle, int64_t& result) = 0;

  virtual bool GetFileMimeType(const String16& path, String16& result) = 0;

  virtual bool GetFileModificationTime(const String16& path, time_t& result) = 0;

  virtual bool GetFileCreationTime(const String16& path, time_t& result) = 0;

  virtual MetadataType GetMetadataType(const String16& path) = 0;

  virtual String16 GetPathByAppendingComponent(const String16& path, const String16& component) = 0;

  virtual bool CreateDirectory_(const String16& path) = 0;

  virtual String16 GetHomeDirectory() = 0;

  virtual String16 GetFilenameFromPath(const String16& path) = 0;

  virtual String16 GetDirectoryNameFromPath(const String16& path) = 0;

  virtual bool GetVolumeFreeSpace(const String16& path, uint64_t& result) = 0;

  virtual int32_t GetVolumeId(const String16& path) = 0;

  virtual Ref<String16Vector> ListDirectory(const String16& path, const String16& filter) = 0;

  virtual String16 OpenTemporaryFile(const String16& prefix, FileHandle& handle) = 0;

  virtual FileHandle OpenFile(const String16& path, bool open_for_writing) = 0;

  virtual void CloseFile(FileHandle& handle) = 0;

  virtual int64_t SeekFile(FileHandle handle, int64_t offset, FileSeekOrigin origin) = 0;

  virtual bool TruncateFile(FileHandle handle, int64_t offset) = 0;

  virtual int64_t WriteToFile(FileHandle handle, const char* data, int64_t length) = 0;

  virtual int64_t ReadFromFile(FileHandle handle, char* data, int64_t length) = 0;

  virtual bool CopyFile_(const String16& source_path, const String16& destination_path) = 0;
};

}  // namespace ultralight