FileOperations.hh

Go to the documentation of this file.

#ifndef FILEOPERATIONS_HH
#define FILEOPERATIONS_HH

#include "string_ref.hh"
#include "unistdp.hh" // needed for mode_t definition when building with VC++
#include "statp.hh"
#include <sys/types.h>
#include <fstream>

namespace openmsx {
namespace FileOperations {

        const char nativePathSeparator =
#ifdef _WIN32
                '\\';
#else
                '/';
#endif

        std::string expandTilde(string_ref path);

        void mkdir(const std::string& path, mode_t mode);

        void mkdirp(string_ref path);

        int unlink(const std::string& path);

        int rmdir(const std::string& path);

        int deleteRecursive(const std::string& path);

        FILE* openFile(const std::string& filename, const std::string& mode);

        void openofstream(std::ofstream& stream, const std::string& filename);

        void openofstream(std::ofstream& stream, const std::string& filename,
                std::ios_base::openmode mode);

        string_ref getFilename(string_ref path);

        string_ref getBaseName(string_ref path);

        string_ref getExtension(string_ref path);

        string_ref stripExtension(string_ref path);

        std::string join(string_ref part1, string_ref part2);
        std::string join(string_ref part1, string_ref part2, string_ref part3);
        std::string join(string_ref part1, string_ref part2,
                         string_ref part3, string_ref part4);

        std::string getConventionalPath(string_ref path);

        std::string getNativePath(string_ref path);

        std::string getCurrentWorkingDirectory();

        std::string getAbsolutePath(string_ref path);

        bool isAbsolutePath(string_ref path);

        std::string getUserHomeDir(string_ref username);

        const std::string& getUserOpenMSXDir();

        std::string getUserDataDir();

        std::string getSystemDataDir();

        std::string expandCurrentDirFromDrive(string_ref path);

#ifdef _WIN32
        typedef struct _stat Stat;
#else
        typedef struct stat Stat;
#endif

        bool getStat(const std::string& filename, Stat& st);

        bool isRegularFile(const std::string& filename);
        bool isRegularFile(const Stat& st);

        bool isDirectory(const std::string& directory);
        bool isDirectory(const Stat& st);

        bool exists(const std::string& filename);

        time_t getModificationDate(const Stat& st);

        std::string getNextNumberedFileName(
                string_ref directory, string_ref prefix, string_ref extension);

        std::string parseCommandFileArgument(
                string_ref argument, string_ref directory,
                string_ref prefix,   string_ref extension);

        std::string getTempDir();

        FILE* openUniqueFile(const std::string& directory, std::string& filename);

} // namespace FileOperations
} // namespace openmsx

#endif