File.h

// Copyright(c) 2019 - 2020, #Momo
// All rights reserved.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met :
// 
// 1. Redistributions of source code must retain the above copyright notice, this
// list of conditions and the following disclaimer.
// 
// 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and /or other materials provided with the distribution.
// 
// 3. Neither the name of the copyright holder nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED.IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#pragma once

#include <filesystem>
#include <fstream>

#include "Utilities/STL/MxString.h"

namespace MxEngine
{
    using FilePath = std::filesystem::path;
    using FileStream = std::fstream;
    using FileSystemTime = std::filesystem::file_time_type;

    class File
    {
        FileStream fileStream;
        FilePath filePath;
    public:
        enum FileMode
        {
            READ = 0x1, // open for reading
            WRITE = 0x2, // open for writing
            BINARY = 0x4, // open as binary
        };
        using FileData = MxString;

        File() = default;
        File(const FilePath& path, int mode = FileMode::READ);
        File(const MxString& path, int mode = FileMode::READ);
        File(const char* path, int mode = FileMode::READ);
        File(const File&) = default;
        File(File&&) = default;
        File& operator=(const File&) = default;
        File& operator=(File&&) = default;
        ~File() = default;

        FileStream& GetStream();
        bool IsOpen() const;
        void Open(FilePath path, int mode = FileMode::READ);
        void Open(const MxString& path, int mode = FileMode::READ);
        void Open(const char* path, int mode = FileMode::READ);
        /*
        closes currently opened std::fstream object (file)
        */
        void Close();
        FileData ReadAllText();
        const FilePath& GetPath() const;

        template<typename T>
        File& operator>>(T&& value);
        template<typename T>
        File& operator<<(T&& value);

        static FileData ReadAllText(const FilePath& path);
        static FileData ReadAllText(const MxString& path);
        static FileData ReadAllText(const char* path);
        static bool Exists(const FilePath& path);
        static bool Exists(const MxString& path);
        static bool Exists(const char* path);
        static bool IsFile(const MxString& path);
        static bool IsFile(const FilePath& path);
        static bool IsFile(const char* path);
        static bool IsDirectory(const MxString& path);
        static bool IsDirectory(const FilePath& path);
        static bool IsDirectory(const char* path);
        static FileSystemTime LastModifiedTime(const FilePath& path);
        static FileSystemTime LastModifiedTime(const MxString& path);
        static FileSystemTime LastModifiedTime(const char* path);
        /*
        creates directory is it is not exist
        \param path path to directory
        */
        static void CreateDirectory(const FilePath& path);
        /*
        creates directory is it is not exist
        \param path path to directory
        */
        static void CreateDirectory(const MxString& path);
        /*
        creates directory is it is not exist
        \param path path to directory
        */
        static void CreateDirectory(const char* path);
        /*
        writes bytes to a file. File must be opened with binary mode
        \param bytes pointer to the first byte to write
        \param size how many bytes to write
        */
        void WriteBytes(const uint8_t* bytes, size_t size);
    };

    template<typename T>
    inline File& File::operator>>(T&& value)
    {
        this->fileStream >> std::forward<T>(value);
        return *this;
    }

    template<typename T>
    inline File& File::operator<<(T&& value)
    {
        this->fileStream << std::forward<T>(value);
        return *this;
    }

    inline auto ToMxString(const FilePath& path)
    {
        return ToMxString(path.string());
    }

    inline auto ToFilePath(const MxString& str)
    {
        return FilePath(str.c_str());
    }
}