IO.h

Go to the documentation of this file.

#pragma once
 
#include "FileContents.h"
#include "FileHandle.h"
 
#if !defined( EMSCRIPTEN )
  #include <filesystem>
  namespace fs = std::filesystem;
#endif
 
namespace Cogs {
  namespace IO {
#if defined( EMSCRIPTEN )
    using RecursiveDirIterator = std::vector<std::string>;
    using DirectoryEntry = std::string;
 
    using FileTimeType = int64_t;
#else
    using RecursiveDirIterator = fs::recursive_directory_iterator;
    using DirectoryEntry = fs::directory_entry;
 
    using FileTimeType = fs::file_time_type;
#endif
 
    // offset=0 and size=0 reads whole file, size!=0 reads a range within the file, offset!=0 and size==0 is an error.
    COGSFOUNDATION_API void                 readFileAsync(const std::string& fileName, const FileContents::Callback& callback, uint64_t offset = 0, uint64_t size = 0, FileContentsHints hints = FileContentsHints::None);
    // offset=0 and size=0 reads whole file, size!=0 reads a range within the file, offset!=0 and size==0 is an error.
    COGSFOUNDATION_API FileContents::Ptr    readFileSync(const std::string& fileName, uint64_t offset = 0, uint64_t size = 0, FileContentsHints hints = FileContentsHints::None);
    COGSFOUNDATION_API bool                 readTextFile(std::string& content, const std::string & fileName);
 
    COGSFOUNDATION_API void                 autoExpandEnvironmentVariables(std::string& text);
    COGSFOUNDATION_API std::string          expandEnvironmentVariables(const std::string& input);
    COGSFOUNDATION_API std::string          expandEnvironmentVariable(const std::string& name);
 
    COGSFOUNDATION_API char                 pathSeparator();
    COGSFOUNDATION_API bool                 exists(std::string_view path);
    COGSFOUNDATION_API bool                 isFile(std::string_view path);
    COGSFOUNDATION_API bool                 isDirectory(std::string_view path);
    COGSFOUNDATION_API std::string          absolute(std::string_view path);
    COGSFOUNDATION_API std::string          canonical(std::string_view path);
 
    COGSFOUNDATION_API bool                 remove(std::string_view path);
 
    COGSFOUNDATION_API std::string          combine(std::string_view path, std::string_view extensionPath);
 
    COGSFOUNDATION_API std::string          expandPath(std::string_view fileName);
    COGSFOUNDATION_API std::string          parentPath(std::string_view str);
    COGSFOUNDATION_API std::string          relativePath(std::string_view str);
    COGSFOUNDATION_API std::string          relativePath(std::string_view str, std::string_view base);
 
    COGSFOUNDATION_API std::string          getPathToExe();
    COGSFOUNDATION_API std::string          getPathRelativeToDll(const std::string& fileName, void* handle);
    COGSFOUNDATION_API std::string          getTempPath();
    COGSFOUNDATION_API std::string          getAppDataPath();
    COGSFOUNDATION_API std::string          getOrgLocalDataPath();
 
    COGSFOUNDATION_API bool                 isAbsolute(std::string_view str);
    COGSFOUNDATION_API bool                 isRelative(std::string_view str);
 
    COGSFOUNDATION_API std::string          fileName(std::string_view str);
    COGSFOUNDATION_API std::string          extension(std::string_view str);
    COGSFOUNDATION_API std::string          stem(std::string_view str);
    COGSFOUNDATION_API void                 replaceAll(std::string& str, std::string_view from, std::string_view to);
    COGSFOUNDATION_API FileTimeType         getFileTime(std::string_view path);
    COGSFOUNDATION_API uint64_t             getFileSize(std::string_view path);
 
    COGSFOUNDATION_API bool                 writeBinaryFile(const std::string& fileName, const void* content, size_t contentSize);
 
    COGSFOUNDATION_API bool                 createDirectories(std::string_view fileName);
    COGSFOUNDATION_API RecursiveDirIterator directoryIterator(std::string_view directory);
    COGSFOUNDATION_API std::string          getPath(const DirectoryEntry& entry);
 
#if !defined( EMSCRIPTEN )
    COGSFOUNDATION_API bool                 copyFile(std::string_view src, std::string_view dest);
 
    COGSFOUNDATION_API void                 backupFile(const std::string& path, int max);
 
    COGSFOUNDATION_API FileHandle::Ptr      openFile(std::string_view path, FileHandle::OpenMode openMode, FileHandle::AccessMode accessMode);
    COGSFOUNDATION_API void                 closeFile(const FileHandle::Ptr& handle);
    COGSFOUNDATION_API size_t               fileSize(const FileHandle::Ptr& handle);
    COGSFOUNDATION_API void*                mapFile(const FileHandle::Ptr& handle, FileHandle::ProtectionMode protectionMode, size_t offset, size_t size);
    COGSFOUNDATION_API void                 unmapFile(const FileHandle::Ptr& handle);
#endif
  };
}