ring.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 original source is dual-licensed:
 *
 * 1. GNU Lesser General Public License v3.0 (or later)
 *    You may redistribute and/or modify this file under the terms of the
 *    GNU Lesser General Public License as published by the Free Software
 *    Foundation, either version 3 of the License, or (at your option)
 *    any later version.
 *
 * 2. Commercial license
 *    Alternatively, this file may be used under the terms of a commercial
 *    license agreement with the copyright holder
 *    (David C. Manuelda <StormByte@gmail.com>).
 *
 * Both licenses apply only to original StormByte-Buffer source in this
 * repository. They do not cover other StormByte modules or any third-party
 * material shipped with this repository (including everything under
 * thirdparty/, and in particular the bundled StormByte-Logger tree and
 * the rest of the StormByte suite it vendors), which remains under its own
 * license.
 *
 * Neither license grants any patent rights. Any patent licenses required
 * to use this software or third-party components must be obtained separately
 * from the patent holders.
 *
 * 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
 * version 3 along with StormByte-Buffer. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
 */
 
#pragma once
 
#include <StormByte/buffer/generic.hxx>
#include <StormByte/buffer/typedefs.hxx>
#include <StormByte/string/string.hxx>
 
#include <condition_variable>
#include <deque>
#include <shared_mutex>
#include <span>
#include <sstream>
#include <utility>
 
namespace StormByte::Buffer {
    class STORMBYTE_BUFFER_PUBLIC Ring: public ReadWrite {
        public:
            Ring() noexcept = default;
 
            inline explicit Ring(const StormByte::BinaryData& data) noexcept
                : m_buffer(data.begin(), data.end()) {}
 
            inline explicit Ring(StormByte::BinaryData&& data) noexcept
                : m_buffer(std::make_move_iterator(data.begin()),
                        std::make_move_iterator(data.end())) {}
 
            template<Type::ByteInputRange R>
            requires (!Type::SameAs<R, StormByte::BinaryData>)
            inline explicit Ring(const R& r) noexcept {
                auto converted = DataConvert(r);
                m_buffer.assign(converted.begin(), converted.end());
            }
 
            template<Type::ByteInputRange Rr>
            inline explicit Ring(Rr&& r) noexcept {
                auto converted = DataConvert(std::forward<Rr>(r));
                m_buffer.assign(std::make_move_iterator(converted.begin()),
                                std::make_move_iterator(converted.end()));
            }
 
            inline explicit Ring(std::string_view sv) noexcept {
                auto converted = DataConvert(sv);
                m_buffer.assign(converted.begin(), converted.end());
            }
 
            inline explicit Ring(const char* s) noexcept
                : Ring(s ? std::string_view(s) : std::string_view{}) {}
 
            Ring(const Ring&) = delete;
 
            Ring(Ring&& other) noexcept;
 
            virtual ~Ring() noexcept;
 
            Ring& operator=(const Ring&) = delete;
 
            Ring& operator=(Ring&& other) noexcept;
 
            bool operator==(const Ring& other) const noexcept;
 
            inline bool operator!=(const Ring& other) const noexcept {
                return !(*this == other);
            }
 
            StormByte::ByteSize Available() const noexcept override;
 
            const StormByte::BinaryData& Data() const noexcept override;
 
            bool Empty() const noexcept override;
 
            bool EoF() const noexcept override;
 
            bool HasError() const noexcept;
 
            bool IsReadable() const noexcept override;
 
            bool IsWritable() const noexcept override;
 
            StormByte::ByteSize Size() const noexcept override;
 
            void Clean() noexcept override;
 
            void Clear() noexcept override;
 
            void Close() noexcept override;
 
            bool Drop(const StormByte::ByteSize& count) noexcept override;
 
            void Seek(const std::ptrdiff_t& offset, const Position& mode) const noexcept override;
 
            void SetError() noexcept override;
 
            StormByte::String::String HexDump(const StormByte::ByteSize& columns = 16,
                                const StormByte::ByteSize& byte_limit = 0) const noexcept;
 
            bool Peek(const StormByte::ByteSize& count, StormByte::BinaryData& outBuffer) const noexcept override;
 
            bool Peek(const StormByte::ByteSize& count, WriteOnly& outBuffer) const noexcept override;
 
            bool Read(const StormByte::ByteSize& count, StormByte::BinaryData& outBuffer) const noexcept override;
 
            bool Read(const StormByte::ByteSize& count, WriteOnly& outBuffer) const noexcept override;
 
            void ReadUntilEoF(StormByte::BinaryData& outBuffer) const noexcept override;
 
            void ReadUntilEoF(WriteOnly& outBuffer) const noexcept override;
 
            bool Extract(const StormByte::ByteSize& count, StormByte::BinaryData& outBuffer) noexcept override;
 
            bool Extract(const StormByte::ByteSize& count, WriteOnly& outBuffer) noexcept override;
 
            void ExtractUntilEoF(StormByte::BinaryData& outBuffer) noexcept override;
 
            void ExtractUntilEoF(WriteOnly& outBuffer) noexcept override;
 
            bool Write(const StormByte::ByteSize& count, const StormByte::BinaryData& data) noexcept override;
 
            bool Write(const StormByte::ByteSize& count, StormByte::BinaryData&& data) noexcept override;
 
            bool Write(const StormByte::ByteSize& count, const ReadOnly& data) noexcept override;
 
            bool Write(const StormByte::ByteSize& count, ReadOnly&& data) noexcept override;
 
            using WriteOnly::Write;
 
        protected:
            enum class Operation {
                Extract,    
                Read,       
                Peek        
            };
 
            static StormByte::String::String FormatHexLines(std::span<const std::byte> data,
                                            StormByte::ByteSize start_offset,
                                            StormByte::ByteSize columns) noexcept;
 
            virtual std::ostringstream HexDumpHeader() const noexcept;
 
            virtual bool ReadInternal(const StormByte::ByteSize& count, StormByte::BinaryData& outBuffer, Operation flag) noexcept;
 
            virtual bool ReadInternal(const StormByte::ByteSize& count, WriteOnly& outBuffer, Operation flag) noexcept;
 
            virtual void ReadUntilEoFInternal(StormByte::BinaryData& outBuffer, Operation flag) noexcept;
 
            virtual void ReadUntilEoFInternal(WriteOnly& outBuffer, Operation flag) noexcept;
 
            virtual bool WriteInternal(const StormByte::ByteSize& count, const StormByte::BinaryData& src) noexcept;
 
            virtual bool WriteInternal(const StormByte::ByteSize& count, StormByte::BinaryData&& src) noexcept;
 
        private:
            std::deque<std::byte> m_buffer;                 
            mutable StormByte::ByteSize m_position_offset{0};   
            bool m_closed{false};                           
            bool m_error{false};                            
            StormByte::String::String m_error_message;      
 
            mutable StormByte::BinaryData m_data_cache;             
            mutable std::shared_mutex m_mutex;              
            mutable std::condition_variable_any m_cv;       
 
            void Wait(const StormByte::ByteSize& n, std::unique_lock<std::shared_mutex>& lock) const;
    };
}