FileStream.h

// ===========================================================================
// Copyright (c) 2015-2024 Toolchefs Ltd. All rights reserved.
//
// Use of this software is subject to the terms of the Toolchefs license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
// ===========================================================================
#pragma once
#pragma once
#include <ToolchefsSTL/Globals.h>
#include <ToolchefsSTL/String.h>
#include <stdio.h>
 
namespace ToolchefsSTL
{
    class TOOLCHEFSSTL_EXPORT FileStream
    {
    public:
 
        enum class Mode: uint8_t
        {
            read = 0,
            write = 1,
            append = 2,
        };
 
        enum class SeekPosition : uint8_t
        {
            Start = 0,
            Current = 1,
            End = 2
        };
 
        FileStream() noexcept;
        
        FileStream(const String& filePath, Mode mode = Mode::read, bool update = false, bool asBinary = true) noexcept;
        
        ~FileStream() noexcept;
 
        FileStream(FileStream&& rhs) noexcept;
 
        FileStream& operator=(FileStream&& rhs) noexcept;
 
        bool open(const String& filePath, Mode mode = Mode::read, bool update = false, bool asBinary = true);
 
        bool openTempFile() noexcept;
 
        void close() noexcept;
 
        bool isOpen() const noexcept;
 
        void seek(int64_t offset, SeekPosition pos = SeekPosition::Current) noexcept;
 
        int64_t tell() const noexcept;
 
        size_t read(void* ptr, size_t size, size_t count) const noexcept;
 
        size_t write(const void* ptr, size_t size, size_t count) noexcept;
 
        fpos_t getPos() const noexcept;
 
        void setPos(const fpos_t& pos) noexcept;
 
        size_t size() noexcept;
 
        FileStream& operator<<(const ToolchefsSTL::String& value);
        FileStream& operator<<(const char* value);
        FileStream& operator<<(const bool value);
        FileStream& operator<<(const int8_t value);
        FileStream& operator<<(const uint8_t value);
        FileStream& operator<<(const int16_t value);
        FileStream& operator<<(const uint16_t value);
        FileStream& operator<<(const int32_t value);
        FileStream& operator<<(const uint32_t value);
        FileStream& operator<<(const int64_t value);
        FileStream& operator<<(const uint64_t value);
        FileStream& operator<<(const float value);
        FileStream& operator<<(const double value);
 
        FileStream& operator>>(ToolchefsSTL::String& value);
        FileStream& operator>>(bool& value);
        FileStream& operator>>(int8_t& value);
        FileStream& operator>>(uint8_t& value);
        FileStream& operator>>(int16_t& value);
        FileStream& operator>>(uint16_t& value);
        FileStream& operator>>(int32_t& value);
        FileStream& operator>>(uint32_t& value);
        FileStream& operator>>(int64_t& value);
        FileStream& operator>>(uint64_t& value);
        FileStream& operator>>(float& value);
        FileStream& operator>>(double& value);
 
        String getLine() noexcept;
 
        String readAll() noexcept;
 
    private:
 
        FileStream(const FileStream&) = delete;
 
        FileStream& operator=(const FileStream&) = delete;
 
    private:
 
        FILE* m_filePtr;
        bool m_isBinary;
    };
}