external.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-Buffer.
 *
 * StormByte-Buffer is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * or later, as published by the Free Software Foundation.
 *
 * StormByte-Buffer 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with StormByte-Buffer. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 */
 
#pragma once
 
#include <StormByte/buffer/generic.hxx>
#include <StormByte/buffer/typedefs.hxx>
#include <StormByte/clonable.hxx>
 
#include <functional>
#include <string_view>
 
namespace StormByte::Buffer {
    class STORMBYTE_BUFFER_PUBLIC ExternalReader
        : public Clonable<ExternalReader, std::unique_ptr<ExternalReader>> {
        public:
            ExternalReader() noexcept = default;
            ExternalReader(const ExternalReader&) = default;
            ExternalReader(ExternalReader&&) noexcept = default;
            ~ExternalReader() noexcept override;
 
            ExternalReader& operator=(const ExternalReader&) = default;
            ExternalReader& operator=(ExternalReader&&) noexcept = default;
            virtual std::size_t AvailableBytes() const noexcept = 0;
 
            virtual bool Empty() const noexcept = 0;
 
            virtual bool EoF() const noexcept = 0;
 
            virtual bool IsReadable() const noexcept = 0;
 
            virtual bool Read(std::size_t count, DataType& out) const noexcept = 0;
 
            inline bool Read(DataType& out) const noexcept {
                return Read(0, out);
            }
 
            virtual bool Extract(std::size_t count, DataType& out) noexcept = 0;
 
            inline bool Extract(DataType& out) noexcept {
                return Extract(0, out);
            }
 
            virtual bool Peek(std::size_t count, DataType& out) const noexcept = 0;
 
            virtual void ReadUntilEoF(DataType& out) const noexcept = 0;
 
            virtual void ExtractUntilEoF(DataType& out) noexcept = 0;
 
            virtual void Seek(std::ptrdiff_t offset, Position mode) const noexcept;
 
            virtual void Clean() noexcept;
 
    };
 
    class STORMBYTE_BUFFER_PUBLIC ExternalBufferReader final : public ExternalReader {
        public:
            explicit ExternalBufferReader(ReadOnly& buffer) noexcept
                : m_buffer(buffer) {}
 
            ExternalBufferReader(const ExternalBufferReader&) = default;
            ExternalBufferReader(ExternalBufferReader&&) noexcept = default;
            ~ExternalBufferReader() noexcept override;
 
            ExternalBufferReader& operator=(const ExternalBufferReader&) = default;
            ExternalBufferReader& operator=(ExternalBufferReader&&) noexcept = default;
 
            PointerType Clone() const noexcept override;
 
            PointerType Move() noexcept override;
 
            std::size_t AvailableBytes() const noexcept override;
            bool Empty() const noexcept override;
            bool EoF() const noexcept override;
            bool IsReadable() const noexcept override;
            bool Read(std::size_t count, DataType& out) const noexcept override;
            bool Extract(std::size_t count, DataType& out) noexcept override;
            bool Peek(std::size_t count, DataType& out) const noexcept override;
 
            void ReadUntilEoF(DataType& out) const noexcept override;
            void ExtractUntilEoF(DataType& out) noexcept override;
            void Seek(std::ptrdiff_t offset, Position mode) const noexcept override;
            void Clean() noexcept override;
        private:
            std::reference_wrapper<ReadOnly> m_buffer;  
    };
 
    class STORMBYTE_BUFFER_PUBLIC ExternalWriter
        : public Clonable<ExternalWriter, std::unique_ptr<ExternalWriter>> {
        public:
            ExternalWriter() noexcept = default;
            ExternalWriter(const ExternalWriter&) = default;
            ExternalWriter(ExternalWriter&&) noexcept = default;
            ~ExternalWriter() noexcept override;
 
            ExternalWriter& operator=(const ExternalWriter&) = default;
            ExternalWriter& operator=(ExternalWriter&&) noexcept = default;
            virtual bool IsWritable() const noexcept = 0;
 
            virtual bool Write(const DataType& data) noexcept = 0;
 
            virtual bool Write(DataType&& data) noexcept = 0;
 
            virtual bool Write(std::size_t count, const DataType& data) noexcept = 0;
 
            virtual bool Write(std::size_t count, DataType&& data) noexcept = 0;
 
            bool Write(std::string_view sv) noexcept;
 
            bool Write(const char* s) noexcept;
 
            bool Write(std::size_t count, std::string_view sv) noexcept;
 
            template<std::size_t N>
            bool Write(const char (&s)[N]) noexcept {
                if (N == 0) return Write(DataType{});
                return Write(std::string_view(s, N > 0 ? N - 1 : 0));
            }
 
            virtual void Close() noexcept = 0;
 
            virtual void SetError() noexcept = 0;
 
    };
 
    class STORMBYTE_BUFFER_PUBLIC ExternalBufferWriter final : public ExternalWriter {
        public:
            explicit ExternalBufferWriter(WriteOnly& buffer) noexcept
                : m_buffer(buffer) {}
 
            ExternalBufferWriter(const ExternalBufferWriter&) = default;
            ExternalBufferWriter(ExternalBufferWriter&&) noexcept = default;
            ~ExternalBufferWriter() noexcept override;
 
            ExternalBufferWriter& operator=(const ExternalBufferWriter&) = default;
            ExternalBufferWriter& operator=(ExternalBufferWriter&&) noexcept = default;
 
            PointerType Clone() const noexcept override;
 
            PointerType Move() noexcept override;
 
            bool IsWritable() const noexcept override;
 
            bool Write(const DataType& data) noexcept override;
            bool Write(DataType&& data) noexcept override;
            bool Write(std::size_t count, const DataType& data) noexcept override;
            bool Write(std::size_t count, DataType&& data) noexcept override;
 
            void Close() noexcept override;
            void SetError() noexcept override;
        private:
            std::reference_wrapper<WriteOnly> m_buffer; 
    };
}