#ifndef FileSystem_h
#define FileSystem_h
#include <time.h>
#include <wtf/Forward.h>
#include <wtf/Vector.h>
#include <wtf/text/WTFString.h>
#if USE(CF)
#include <wtf/RetainPtr.h>
#endif
#if USE(CF)
typedef struct __CFBundle* CFBundleRef;
typedef const struct __CFData* CFDataRef;
#endif
#if OS(WINDOWS)
typedef void *HANDLE;
typedef struct HINSTANCE__* HINSTANCE;
typedef HINSTANCE HMODULE;
#endif
#if USE(GLIB)
typedef struct _GFileIOStream GFileIOStream;
typedef struct _GModule GModule;
#endif
namespace WebCore {
#if OS(WINDOWS)
typedef HMODULE PlatformModule;
#elif PLATFORM(EFL)
typedef Eina_Module* PlatformModule;
#elif USE(GLIB)
typedef GModule* PlatformModule;
#elif USE(CF)
typedef CFBundleRef PlatformModule;
#else
typedef void* PlatformModule;
#endif
#if OS(WINDOWS)
struct PlatformModuleVersion {
unsigned leastSig;
unsigned mostSig;
PlatformModuleVersion(unsigned)
: leastSig(0)
, mostSig(0)
{
}
PlatformModuleVersion(unsigned lsb, unsigned msb)
: leastSig(lsb)
, mostSig(msb)
{
}
};
#else
typedef unsigned PlatformModuleVersion;
#endif
#if USE(GLIB) && !PLATFORM(EFL) && !PLATFORM(WIN)
typedef GFileIOStream* PlatformFileHandle;
const PlatformFileHandle invalidPlatformFileHandle = 0;
#elif OS(WINDOWS)
typedef HANDLE PlatformFileHandle;
const PlatformFileHandle invalidPlatformFileHandle = reinterpret_cast<HANDLE>(-1);
#else
typedef int PlatformFileHandle;
const PlatformFileHandle invalidPlatformFileHandle = -1;
#endif
enum FileOpenMode {
OpenForRead = 0,
OpenForWrite
};
enum FileSeekOrigin {
SeekFromBeginning = 0,
SeekFromCurrent,
SeekFromEnd
};
enum FileLockMode {
LockShared = 1,
LockExclusive = 2,
LockNonBlocking = 4
};
#if OS(WINDOWS)
static const char PlatformFilePathSeparator = '\\';
#else
static const char PlatformFilePathSeparator = '/';
#endif
struct FileMetadata;
WEBCORE_EXPORT bool fileExists(const String&);
WEBCORE_EXPORT bool deleteFile(const String&);
WEBCORE_EXPORT bool deleteEmptyDirectory(const String&);
WEBCORE_EXPORT bool moveFile(const String& oldPath, const String& newPath);
WEBCORE_EXPORT bool getFileSize(const String&, long long& result);
WEBCORE_EXPORT bool getFileSize(PlatformFileHandle, long long& result);
WEBCORE_EXPORT bool getFileModificationTime(const String&, time_t& result);
WEBCORE_EXPORT bool getFileCreationTime(const String&, time_t& result); bool getFileMetadata(const String&, FileMetadata&);
WEBCORE_EXPORT String pathByAppendingComponent(const String& path, const String& component);
WEBCORE_EXPORT bool makeAllDirectories(const String& path);
String homeDirectoryPath();
WEBCORE_EXPORT String pathGetFileName(const String&);
WEBCORE_EXPORT String directoryName(const String&);
WEBCORE_EXPORT void setMetadataURL(String& URLString, const String& referrer, const String& path);
bool canExcludeFromBackup(); bool excludeFromBackup(const String&);
WEBCORE_EXPORT Vector<String> listDirectory(const String& path, const String& filter = String());
WEBCORE_EXPORT CString fileSystemRepresentation(const String&);
inline bool isHandleValid(const PlatformFileHandle& handle) { return handle != invalidPlatformFileHandle; }
inline double invalidFileTime() { return std::numeric_limits<double>::quiet_NaN(); }
inline bool isValidFileTime(double time) { return std::isfinite(time); }
WEBCORE_EXPORT String openTemporaryFile(const String& prefix, PlatformFileHandle&);
WEBCORE_EXPORT PlatformFileHandle openFile(const String& path, FileOpenMode);
WEBCORE_EXPORT void closeFile(PlatformFileHandle&);
WEBCORE_EXPORT long long seekFile(PlatformFileHandle, long long offset, FileSeekOrigin);
bool truncateFile(PlatformFileHandle, long long offset);
WEBCORE_EXPORT int writeToFile(PlatformFileHandle, const char* data, int length);
int readFromFile(PlatformFileHandle, char* data, int length);
#if USE(FILE_LOCK)
bool lockFile(PlatformFileHandle, FileLockMode);
bool unlockFile(PlatformFileHandle);
#endif
bool unloadModule(PlatformModule);
WEBCORE_EXPORT String encodeForFileName(const String&);
#if USE(CF)
RetainPtr<CFURLRef> pathAsURL(const String&);
#endif
#if PLATFORM(GTK)
String filenameToString(const char*);
String filenameForDisplay(const String&);
CString applicationDirectoryPath();
CString sharedResourcesPath();
#endif
#if USE(SOUP)
uint64_t getVolumeFreeSizeForPath(const char*);
#endif
#if PLATFORM(WIN)
WEBCORE_EXPORT String localUserSpecificStorageDirectory();
String roamingUserSpecificStorageDirectory();
#endif
class MappedFileData {
public:
MappedFileData() { }
MappedFileData(MappedFileData&&);
WEBCORE_EXPORT MappedFileData(const String& filePath, bool& success);
WEBCORE_EXPORT ~MappedFileData();
MappedFileData& operator=(MappedFileData&&);
explicit operator bool() const { return !!m_fileData; }
const void* data() const { return m_fileData; }
unsigned size() const { return m_fileSize; }
private:
void* m_fileData { nullptr };
unsigned m_fileSize { 0 };
};
inline MappedFileData::MappedFileData(MappedFileData&& other)
: m_fileData(std::exchange(other.m_fileData, nullptr))
, m_fileSize(std::exchange(other.m_fileSize, 0))
{
}
inline MappedFileData& MappedFileData::operator=(MappedFileData&& other)
{
m_fileData = std::exchange(other.m_fileData, nullptr);
m_fileSize = std::exchange(other.m_fileSize, 0);
return *this;
}
}
#endif // FileSystem_h