file.h

// =====================================================================================================================
//  fennec, a free and open source game engine
//  Copyright © 2025  Medusa Slockbower
//
//  This program is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program.  If not, see <https://www.gnu.org/licenses/>.
// =====================================================================================================================
 
#ifndef FENNEC_FILESYSTEM_FILE_H
#define FENNEC_FILESYSTEM_FILE_H
 
#include <fennec/filesystem/path.h>
#include <fennec/format/format.h>
 
#include <fennec/string/cstring.h>
#include <fennec/string/string.h>
#include <fennec/string/wstring.h>
 
namespace fennec
{
 
enum fmode_ : uint8_t
{
    fmode_read      = 0b00000001 
,   fmode_write     = 0b00000010 
,   fmode_trunc     = 0b00000100 
,   fmode_exclusive = 0b00001000 
,   fmode_binary    = 0b00010000 
,   fmode_wide      = 0b00100000 
};
 
class file
{
public:
    static constexpr size_t npos = -1;
 
    static constexpr bool is_valid(uint8_t mode) {
        const bool t = mode & fmode_trunc;
        const bool x = mode & fmode_exclusive;
        const bool w = mode & fmode_write;
 
        // when x is true, t must be true
        // when t is true, w must be true
        return (t && x && w)
        ||     (t && w)
        ||    !(t || x);
    }
 
    static file& cout();
 
    static file& cin();
 
    static file& cerr();
 
    file();
 
    file(const cstring& path, uint8_t mode)
        : file() {
        open(path, mode);
    }
 
    file(const string& path, uint8_t mode)
        : file() {
        open(path, mode);
    }
 
    file(const path& path, uint8_t mode)
        : file() {
        open(path, mode);
    }
 
    ~file();
 
    file(file&& file) noexcept;
 
    file& operator=(file&& file) noexcept;
 
    // don't allow copying streams
    file(const file&) = delete;
 
 
// Properties ==========================================================================================================
 
    const path& get_path() const {
        return _path;
    }
 
    uint8_t mode() const {
        return _mode;
    }
 
    bool is_open() const {
        return _handle != nullptr;
    }
 
 
// File Access =========================================================================================================
 
    bool open(const cstring& path, uint8_t mode);
 
    bool open(const string& path, uint8_t mode);
 
    bool open(const path& path, uint8_t mode);
 
    bool close();
 
    bool commit();
 
 
// File Operations =====================================================================================================
 
    bool erase();
 
    bool rename(const cstring& path);
 
    bool rename(const string& path);
 
    bool rename(const path& path);
 
    file copy(const cstring& path);
 
    file copy(const string& path);
 
    file copy(const path& path);
 
 
// File Positioning ====================================================================================================
 
    size_t get_pos() const;
    bool   set_pos(size_t i);
    bool   rewind();
    bool   eof() const;
 
 
// Binary Read Operations ==============================================================================================
 
    size_t read(void* data, size_t size, size_t n);
 
    template<typename T>
    size_t read(T* data, size_t n) {
        return read(static_cast<void*>(data), sizeof(T), n);
    }
 
    template<typename T, size_t n>
    size_t read(T (&data)[n]) {
        return read(static_cast<void*>(data), sizeof(T), n);
    }
 
 
// Binary Write Operations =============================================================================================
 
    bool putc(char c);
    bool putwc(wchar_t c);
 
    size_t write(const void* data, size_t size, size_t n);
 
    template<size_t n>
    size_t write(const char (&data)[n]) {
        return write(data, sizeof(char), n - 1);
    }
 
    template<size_t n>
    size_t write(const wchar_t (&data)[n]) {
        return write(data, sizeof(wchar_t), n - 1);
    }
 
    template<typename T>
    size_t write(const T* data, size_t n) {
        return write(static_cast<const void*>(data), sizeof(T), n);
    }
 
    template<typename T, size_t n>
    size_t write(const T (&data)[n]) {
        return write(static_cast<const void*>(data), sizeof(T), n);
    }
 
 
// Read Operations =====================================================================================================
 
    char getc();
    wchar_t getwc();
 
    string getline();
    wstring getwline();
 
 
// Printing Operations =================================================================================================
 
    void print(const cstring& str);
    void print(const string&  str);
 
    void println(const cstring& str);
    void println(const string&  str);
 
    template<typename...ArgsT>
    void printf(const cstring& str, ArgsT&&...args) {
        string fmt = fennec::format(str, fennec::forward<ArgsT>(args)...);
        this->print(cstring(fmt.cstr(), fmt.length()));
    }
 
 
 
 
// Error Handling ======================================================================================================
 
    const char* get_error() const { return _error; }
    void clear_error() { _error = nullptr; }
 
private:
    FILE* _handle;
    path    _path;
    uint8_t _mode;
    char*  _error;
};
 
}
 
#endif // FENNEC_FILESYSTEM_FILE_H