FileOperations.hh

Go to the documentation of this file.

#ifndef FILEOPERATIONS_HH
#define FILEOPERATIONS_HH
 
#include "Date.hh"
#include "unistdp.hh" // needed for mode_t definition when building with VC++
#include "statp.hh"
#include "zstring_view.hh"
 
#include <fstream>
#include <memory>
#include <optional>
#include <string_view>
#include <sys/types.h>
 
namespace openmsx::FileOperations {
 
        struct FClose {
                void operator()(FILE* f) const { fclose(f); }
        };
        using FILE_t = std::unique_ptr<FILE, FClose>;
 
        const char nativePathSeparator =
#ifdef _WIN32
                '\\';
#else
                '/';
#endif
 
        [[nodiscard]] std::string expandTilde(std::string path);
 
        [[nodiscard]] bool needsTildeExpansion(std::string_view path);
 
        void mkdir(zstring_view path, mode_t mode);
 
        void mkdirp(std::string path);
 
        int unlink(zstring_view path);
 
        int rmdir(zstring_view path);
 
        int deleteRecursive(zstring_view path);
 
        [[nodiscard]] FILE_t openFile(zstring_view filename, zstring_view mode);
 
        void openOfStream(std::ofstream& stream, zstring_view filename);
 
        void openOfStream(std::ofstream& stream, zstring_view filename,
                          std::ios_base::openmode mode);
 
        [[nodiscard]] std::string_view getFilename(std::string_view path);
 
        [[nodiscard]] std::string_view getDirName(std::string_view path);
 
        [[nodiscard]] std::string_view getExtension(std::string_view path);
 
        [[nodiscard]] std::string_view stripExtension(std::string_view path);
 
        [[nodiscard]] std::string join(std::string_view part1, std::string_view part2);
        [[nodiscard]] std::string join(std::string_view part1, std::string_view part2, std::string_view part3);
        [[nodiscard]] std::string join(std::string_view part1, std::string_view part2,
                                       std::string_view part3, std::string_view part4);
 
#ifdef _WIN32
        [[nodiscard]]              std::string  getConventionalPath(      std::string   path);
#else
        [[nodiscard]] inline const std::string& getConventionalPath(const std::string&  path) { return           path;  }
        [[nodiscard]] inline       std::string  getConventionalPath(      std::string&& path) { return std::move(path); }
#endif
 
#ifdef _WIN32
        [[nodiscard]]              std::string  getNativePath(      std::string   path);
#else
        [[nodiscard]] inline const std::string& getNativePath(const std::string&  path) { return           path;  }
        [[nodiscard]] inline       std::string  getNativePath(      std::string&& path) { return std::move(path); }
#endif
 
#ifdef _WIN32
        [[nodiscard]]              std::string  expandCurrentDirFromDrive(std::string path);
#else
        [[nodiscard]] inline const std::string& expandCurrentDirFromDrive(const std::string&  path) { return           path;  }
        [[nodiscard]] inline       std::string  expandCurrentDirFromDrive(      std::string&& path) { return std::move(path); }
#endif
 
        [[nodiscard]] std::string getCurrentWorkingDirectory();
 
        [[nodiscard]] std::string getAbsolutePath(std::string_view path);
 
        [[nodiscard]] bool isAbsolutePath(std::string_view path);
 
        [[nodiscard]] std::string getUserHomeDir(std::string_view username);
 
        [[nodiscard]] const std::string& getUserOpenMSXDir();
 
        [[nodiscard]] const std::string& getUserDataDir();
 
        [[nodiscard]] const std::string& getSystemDataDir();
 
        [[nodiscard]] const std::string& getSystemDocDir();
 
#ifdef _WIN32
        // using Stat = struct _stat; // doesn't work for some reason
        typedef struct _stat Stat;
#else
        using Stat = struct stat;
#endif
        [[nodiscard]] std::optional<Stat> getStat(zstring_view filename);
 
        [[nodiscard]] bool isRegularFile(zstring_view filename);
        [[nodiscard]] bool isRegularFile(const Stat& st);
 
        [[nodiscard]] bool isDirectory(zstring_view directory);
        [[nodiscard]] bool isDirectory(const Stat& st);
 
        [[nodiscard]] bool exists(zstring_view filename);
 
        [[nodiscard]] inline time_t getModificationDate(const Stat& st) {
                return Date::adjustTimeT(st.st_mtime);
        }
 
        [[nodiscard]] std::string getNextNumberedFileName(
                std::string_view directory, std::string_view prefix, std::string_view extension,
                bool addSeparator = false);
 
        [[nodiscard]] std::string parseCommandFileArgument(
                std::string_view argument, std::string_view directory,
                std::string_view prefix,   std::string_view extension);
 
        [[nodiscard]] std::string getTempDir();
 
        [[nodiscard]] FILE_t openUniqueFile(const std::string& directory, std::string& filename);
 
} // namespace openmsx::FileOperations
 
#endif