ByteBuffer.h

Go to the documentation of this file.

/*
* Copyright (C) 2005-2011 MaNGOS <http://getmangos.com/>
*
* 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 2 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, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/*
Copyright (c) 2018 DIVIDE-Studio
Copyright (c) 2009 Ionut Cava
 
This file is part of DIVIDE Framework.
 
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software
and associated documentation files (the "Software"), to deal in the Software
without restriction,
including without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software
is furnished to do so,
subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
*/
#pragma once
#ifndef DVD_CORE_BYTE_BUFFER_H_
#define DVD_CORE_BYTE_BUFFER_H_
 
namespace Divide {
 
class ByteBufferException {
   public:
    ByteBufferException(bool add, size_t pos, size_t esize, size_t size);
    void printPosError() const;
 
   private:
    bool   _add;
    size_t _pos;
    size_t _esize;
    size_t _size;
};
 
template <typename T>
struct Unused {
    Unused()
    {
    }
};
 
class ByteBuffer {
   public:
    static const U8 BUFFER_FORMAT_VERSION { 10u };
    static const size_t DEFAULT_SIZE { 0x1000 };
 
    ByteBuffer() noexcept = default;
 
    void clear() noexcept;
 
    template<class T, size_t N>
    void addMarker(const T (&pattern)[N]);
 
    template<class T, size_t N>
    void readSkipToMarker(const T ( &pattern )[N]);
 
    template <typename T>
    void put(size_t pos, const T& value);
 
    template <typename T>
    ByteBuffer& operator<<(const T& value);
 
    template <typename T>
    ByteBuffer& operator>>(T& value);
 
    template <typename U>
    ByteBuffer& operator>>(Unused<U>& value);
 
    template <typename T>
    void readSkip();
 
    void readSkip(size_t skip) noexcept;
 
    template <typename T>
    void readNoSkip(T& value);
 
    template <typename T>
    void read(T& out);
 
    template <typename T>
    void readNoSkipFrom(size_t pos, T& out) const;
 
    void read(Byte *dest, size_t len);
 
    void readPackXYZ(F32& x, F32& y, F32& z);
    void appendPackXYZ(F32 x, F32 y, F32 z);
 
    U64  readPackGUID();
    void appendPackGUID(U64 guid);
 
    void append(const Byte *src, size_t cnt);
 
    template <typename T>
    void append(const T* src, const size_t cnt);
 
    [[nodiscard]] Byte operator[](size_t pos) const;
 
    [[nodiscard]] size_t rpos() const noexcept;
    [[nodiscard]] size_t rpos(size_t rpos_) noexcept;
    [[nodiscard]] size_t wpos() const noexcept;
    [[nodiscard]] size_t wpos(size_t wpos_) noexcept;
    [[nodiscard]] size_t bufferSize() const noexcept;
    [[nodiscard]] bool   bufferEmpty() const noexcept;
    [[nodiscard]] size_t storageSize() const noexcept;
    [[nodiscard]] bool   storageEmpty() const noexcept;
 
    void resize(size_t newsize);
    void reserve(size_t resize);
 
    [[nodiscard]] const Byte* contents() const noexcept;
 
    void put(size_t pos, const Byte *src, size_t cnt);
 
    [[nodiscard]] bool dumpToFile(const ResourcePath& path, std::string_view fileName, const U8 version = BUFFER_FORMAT_VERSION);
    [[nodiscard]] bool loadFromFile(const ResourcePath& path, std::string_view fileName, const U8 version = BUFFER_FORMAT_VERSION);
 
   private:
    template <typename T>
    void append(const T& value);
 
   protected:
    size_t _rpos = 0u, _wpos = 0u;
    vector<Byte> _storage;
};
 
}  // namespace Divide
#endif //DVD_CORE_BYTE_BUFFER_H_
 
#include "ByteBuffer.inl"