fifo.hxx

#pragma once
 
#include <StormByte/buffer/generic.hxx>
#include <StormByte/buffer/typedefs.hxx>
#include <StormByte/string.hxx>
 
#include <vector>
#include <span>
#include <string>
#include <sstream>
#include <utility>
 
namespace StormByte::Buffer {
    class STORMBYTE_BUFFER_PUBLIC FIFO: public ReadWrite {
        public:
            FIFO() noexcept                                         = default;
 
            inline FIFO(const DataType& data) noexcept: ReadWrite(data), m_position_offset(0) {}
 
            inline FIFO(DataType&& data) noexcept: ReadWrite(std::move(data)), m_position_offset(0) {}
 
            template<std::ranges::input_range R>
            requires (!std::is_class_v<std::remove_cv_t<std::ranges::range_value_t<R>>>) &&
                requires(std::ranges::range_value_t<R> v) { static_cast<std::byte>(v); } &&
                (!std::same_as<std::remove_cvref_t<R>, DataType>)
            inline FIFO(const R& r) noexcept: ReadWrite(DataConvert(r)), m_position_offset(0) {}
 
            template<std::ranges::input_range Rr>
            requires (!std::is_class_v<std::remove_cv_t<std::ranges::range_value_t<Rr>>>) &&
                requires(std::ranges::range_value_t<Rr> v) { static_cast<std::byte>(v); }
            inline FIFO(Rr&& r) noexcept: ReadWrite(DataConvert(std::forward<Rr>(r))), m_position_offset(0) {}
 
            inline FIFO(std::string_view sv) noexcept: ReadWrite(DataConvert(sv)), m_position_offset(0) {}
 
            inline FIFO(const char* s) noexcept: FIFO(s ? std::string_view(s) : std::string_view()) {}
 
            FIFO(const FIFO& other) noexcept;
            
            FIFO(FIFO&& other) noexcept;
 
            virtual ~FIFO() noexcept                                = default;
            
            FIFO& operator=(const FIFO& other);
        
            FIFO& operator=(FIFO&& other) noexcept;
 
            inline bool operator==(const FIFO& other) const noexcept {
                return m_buffer == other.m_buffer && m_position_offset == other.m_position_offset;
            }
 
            inline bool operator!=(const FIFO& other) const noexcept {
                return !(*this == other);
            }
 
            inline virtual std::size_t                              AvailableBytes() const noexcept {
                const std::size_t current_size = m_buffer.size();
                return (m_position_offset <= current_size) ? (current_size - m_position_offset) : 0;
            }
 
            virtual void                                            Clean() noexcept override;
 
            inline virtual void                                     Clear() noexcept override {
                m_buffer.clear();
                m_position_offset = 0;
            }
 
            inline virtual const DataType&                          Data() const noexcept override {
                return ReadOnly::Data();
            }
 
            virtual bool                                            Drop(const std::size_t& count) noexcept override;
 
            inline virtual bool                                     Empty() const noexcept override {
                return m_buffer.empty();
            }
 
            inline virtual bool                                     EoF() const noexcept override {
                return AvailableBytes() == 0;
            }
 
            inline bool                                             Extract(const std::size_t& count, DataType& outBuffer) noexcept override {
                return const_cast<FIFO*>(this)->ReadInternal(count, outBuffer, Operation::Extract);
            }
 
            inline bool                                             Extract(const std::size_t& count, WriteOnly& outBuffer) noexcept override {
                return const_cast<FIFO*>(this)->ReadInternal(count, outBuffer, Operation::Extract);
            }
 
            using ReadOnly::Extract;
 
            inline void                                             ExtractUntilEoF(DataType& outBuffer) noexcept override {
                ReadUntilEoFInternal(outBuffer, Operation::Extract);
            }
 
            inline void                                             ExtractUntilEoF(WriteOnly& outBuffer) noexcept override {
                ReadUntilEoFInternal(outBuffer, Operation::Extract);
            }
 
            virtual std::string                                     HexDump(const std::size_t& collumns = 16, const std::size_t& byte_limit = 0) const noexcept;
 
            inline virtual bool                                     IsReadable() const noexcept override {
                return true;
            }
 
            inline virtual bool                                     IsWritable() const noexcept override {
                return true;
            }
 
            inline bool                                             Peek(const std::size_t& count, DataType& outBuffer) const noexcept override {
                return const_cast<FIFO*>(this)->ReadInternal(count, outBuffer, Operation::Peek);
            }
 
            inline bool                                             Peek(const std::size_t& count, WriteOnly& outBuffer) const noexcept override {
                return const_cast<FIFO*>(this)->ReadInternal(count, outBuffer, Operation::Peek);
            }
 
            inline bool                                             Read(const std::size_t& count, DataType& outBuffer) const noexcept override {
                return const_cast<FIFO*>(this)->ReadInternal(count, outBuffer, Operation::Read);
            }
 
            inline bool                                             Read(const std::size_t& count, WriteOnly& outBuffer) const noexcept override {
                return const_cast<FIFO*>(this)->ReadInternal(count, outBuffer, Operation::Read);
            }
 
            using ReadOnly::Read;
 
            inline void                                             ReadUntilEoF(DataType& outBuffer) const noexcept override {
                const_cast<FIFO*>(this)->ReadUntilEoFInternal(outBuffer, Operation::Read);
            }
 
            inline void                                             ReadUntilEoF(WriteOnly& outBuffer) const noexcept override {
                const_cast<FIFO*>(this)->ReadUntilEoFInternal(outBuffer, Operation::Read);
            }
 
            virtual void                                            Seek(const std::ptrdiff_t& offset, const Position& mode) const noexcept override;
 
            inline virtual std::size_t                              Size() const noexcept override {
                return m_buffer.size();
            }
 
            inline bool                                             Write(const std::size_t& count, const DataType& data) noexcept override {
                return WriteInternal(count, data);
            }
 
            inline bool                                             Write(const std::size_t& count, DataType&& data) noexcept override {
                return WriteInternal(count, std::move(data));
            }
 
            inline bool                                             Write(const std::size_t& count, const ReadOnly& data) noexcept override {
                return WriteInternal(count, data);
            }
 
            inline bool                                             Write(const std::size_t& count, ReadOnly&& data) noexcept override {
                return WriteInternal(count, std::move(data));
            }
 
            using WriteOnly::Write;
 
        protected:
            mutable std::size_t m_position_offset {0};
 
            enum class Operation {
                Extract,                                                
                Read,                                                   
                Peek                                                    
            };
 
            static std::string                                          FormatHexLines(std::span<const std::byte>& data, std::size_t start_offset, std::size_t collumns) noexcept;
 
            virtual std::ostringstream                                  HexDumpHeader() const noexcept;
 
            virtual bool                                                ReadInternal(const std::size_t& count, DataType& outBuffer, const Operation& flag) noexcept;
            virtual bool                                                ReadInternal(const std::size_t& count, WriteOnly& outBuffer, const Operation& flag) noexcept;
            
            virtual void                                                ReadUntilEoFInternal(DataType& outBuffer, const Operation& flag) noexcept;
 
            virtual void                                                ReadUntilEoFInternal(WriteOnly& outBuffer, const Operation& flag) noexcept;
 
            virtual bool                                                WriteInternal(const std::size_t& count, const DataType& src) noexcept;
            
            virtual bool                                                WriteInternal(const std::size_t& count, DataType&& src) noexcept;
 
            virtual bool                                                WriteInternal(const std::size_t& count, const ReadOnly& src) noexcept;
 
            virtual bool                                                WriteInternal(const std::size_t& count, ReadOnly&& src) noexcept;
    };
}