/*
* This file is part of the TrinityCore Project. See AUTHORS file for Copyright information
*
* 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, see .
*/
#ifndef _BYTEBUFFER_H
#define _BYTEBUFFER_H
#include "Define.h"
#include "ByteConverter.h"
#include
#include
#include
class MessageBuffer;
// Root of ByteBuffer exception hierarchy
class TC_SHARED_API ByteBufferException : public std::exception
{
public:
~ByteBufferException() noexcept = default;
char const* what() const noexcept override { return msg_.c_str(); }
protected:
std::string& message() { return msg_; }
private:
std::string msg_;
};
class TC_SHARED_API ByteBufferPositionException : public ByteBufferException
{
public:
ByteBufferPositionException(size_t pos, size_t size, size_t valueSize);
~ByteBufferPositionException() noexcept = default;
};
class TC_SHARED_API ByteBuffer
{
public:
static size_t const DEFAULT_SIZE = 0x1000;
static uint8 const InitialBitPos = 8;
// constructor
ByteBuffer() : _rpos(0), _wpos(0), _bitpos(InitialBitPos), _curbitval(0)
{
_storage.reserve(DEFAULT_SIZE);
}
// reserve/resize tag
struct Reserve { };
struct Resize { };
ByteBuffer(size_t size, Reserve) : _rpos(0), _wpos(0), _bitpos(InitialBitPos), _curbitval(0)
{
_storage.reserve(size);
}
ByteBuffer(size_t size, Resize) : _rpos(0), _wpos(size), _bitpos(InitialBitPos), _curbitval(0)
{
_storage.resize(size);
}
ByteBuffer(ByteBuffer&& buf) noexcept : _rpos(buf._rpos), _wpos(buf._wpos),
_bitpos(buf._bitpos), _curbitval(buf._curbitval), _storage(buf.Move()) { }
ByteBuffer(ByteBuffer const& right) = default;
ByteBuffer(MessageBuffer&& buffer);
std::vector&& Move() noexcept
{
_rpos = 0;
_wpos = 0;
_bitpos = InitialBitPos;
_curbitval = 0;
return std::move(_storage);
}
ByteBuffer& operator=(ByteBuffer const& right)
{
if (this != &right)
{
_rpos = right._rpos;
_wpos = right._wpos;
_bitpos = right._bitpos;
_curbitval = right._curbitval;
_storage = right._storage;
}
return *this;
}
ByteBuffer& operator=(ByteBuffer&& right) noexcept
{
if (this != &right)
{
_rpos = right._rpos;
_wpos = right._wpos;
_bitpos = right._bitpos;
_curbitval = right._curbitval;
_storage = right.Move();
}
return *this;
}
virtual ~ByteBuffer() = default;
void clear()
{
_rpos = 0;
_wpos = 0;
_bitpos = InitialBitPos;
_curbitval = 0;
_storage.clear();
}
template
void append(T value)
{
static_assert(std::is_trivially_copyable::value, "append(T) must be used with trivially copyable types");
EndianConvert(value);
append((uint8 *)&value, sizeof(value));
}
bool HasUnfinishedBitPack() const
{
return _bitpos != 8;
}
void FlushBits()
{
if (_bitpos == 8)
return;
_bitpos = 8;
append((uint8 *)&_curbitval, sizeof(uint8));
_curbitval = 0;
}
void ResetBitPos()
{
if (_bitpos > 7)
return;
_bitpos = 8;
_curbitval = 0;
}
bool WriteBit(bool bit)
{
--_bitpos;
if (bit)
_curbitval |= (1 << (_bitpos));
if (_bitpos == 0)
{
_bitpos = 8;
append((uint8 *)&_curbitval, sizeof(_curbitval));
_curbitval = 0;
}
return bit;
}
bool ReadBit()
{
++_bitpos;
if (_bitpos > 7)
{
_curbitval = read();
_bitpos = 0;
}
return ((_curbitval >> (7-_bitpos)) & 1) != 0;
}
void WriteBits(std::size_t value, int32 bits)
{
for (int32 i = bits - 1; i >= 0; --i)
WriteBit((value >> i) & 1);
}
uint32 ReadBits(int32 bits)
{
uint32 value = 0;
for (int32 i = bits - 1; i >= 0; --i)
if (ReadBit())
value |= (1 << (i));
return value;
}
template
void put(std::size_t pos, T value)
{
static_assert(std::is_trivially_copyable::value, "put(size_t, T) must be used with trivially copyable types");
EndianConvert(value);
put(pos, (uint8 *)&value, sizeof(value));
}
/**
* @name PutBits
* @brief Places specified amount of bits of value at specified position in packet.
* To ensure all bits are correctly written, only call this method after
* bit flush has been performed
* @param pos Position to place the value at, in bits. The entire value must fit in the packet
* It is advised to obtain the position using bitwpos() function.
* @param value Data to write.
* @param bitCount Number of bits to store the value on.
*/
void PutBits(std::size_t pos, std::size_t value, uint32 bitCount);
ByteBuffer &operator<<(uint8 value)
{
append(value);
return *this;
}
ByteBuffer &operator<<(uint16 value)
{
append(value);
return *this;
}
ByteBuffer &operator<<(uint32 value)
{
append(value);
return *this;
}
ByteBuffer &operator<<(uint64 value)
{
append(value);
return *this;
}
// signed as in 2e complement
ByteBuffer &operator<<(int8 value)
{
append(value);
return *this;
}
ByteBuffer &operator<<(int16 value)
{
append(value);
return *this;
}
ByteBuffer &operator<<(int32 value)
{
append(value);
return *this;
}
ByteBuffer &operator<<(int64 value)
{
append(value);
return *this;
}
// floating points
ByteBuffer &operator<<(float value)
{
append(value);
return *this;
}
ByteBuffer &operator<<(double value)
{
append(value);
return *this;
}
ByteBuffer &operator<<(const std::string &value)
{
if (size_t len = value.length())
append((uint8 const*)value.c_str(), len);
append(0);
return *this;
}
ByteBuffer &operator<<(const char *str)
{
if (size_t len = (str ? strlen(str) : 0))
append((uint8 const*)str, len);
append(0);
return *this;
}
ByteBuffer &operator>>(bool &value)
{
value = read() > 0 ? true : false;
return *this;
}
ByteBuffer &operator>>(uint8 &value)
{
value = read();
return *this;
}
ByteBuffer &operator>>(uint16 &value)
{
value = read();
return *this;
}
ByteBuffer &operator>>(uint32 &value)
{
value = read();
return *this;
}
ByteBuffer &operator>>(uint64 &value)
{
value = read();
return *this;
}
//signed as in 2e complement
ByteBuffer &operator>>(int8 &value)
{
value = read();
return *this;
}
ByteBuffer &operator>>(int16 &value)
{
value = read();
return *this;
}
ByteBuffer &operator>>(int32 &value)
{
value = read();
return *this;
}
ByteBuffer &operator>>(int64 &value)
{
value = read();
return *this;
}
ByteBuffer &operator>>(float &value);
ByteBuffer &operator>>(double &value);
ByteBuffer &operator>>(std::string& value)
{
value.clear();
while (rpos() < size()) // prevent crash at wrong string format in packet
{
char c = read();
if (c == 0)
break;
value += c;
}
return *this;
}
uint8& operator[](size_t const pos)
{
if (pos >= size())
throw ByteBufferPositionException(pos, 1, size());
return _storage[pos];
}
uint8 const& operator[](size_t const pos) const
{
if (pos >= size())
throw ByteBufferPositionException(pos, 1, size());
return _storage[pos];
}
size_t rpos() const { return _rpos; }
size_t rpos(size_t rpos_)
{
_rpos = rpos_;
return _rpos;
}
void rfinish()
{
_rpos = wpos();
}
size_t wpos() const { return _wpos; }
size_t wpos(size_t wpos_)
{
_wpos = wpos_;
return _wpos;
}
/// Returns position of last written bit
size_t bitwpos() const { return _wpos * 8 + 8 - _bitpos; }
size_t bitwpos(size_t newPos)
{
_wpos = newPos / 8;
_bitpos = 8 - (newPos % 8);
return _wpos * 8 + 8 - _bitpos;
}
template
void read_skip() { read_skip(sizeof(T)); }
void read_skip(size_t skip)
{
if (_rpos + skip > size())
throw ByteBufferPositionException(_rpos, skip, size());
ResetBitPos();
_rpos += skip;
}
template
T read()
{
ResetBitPos();
T r = read(_rpos);
_rpos += sizeof(Underlying);
return r;
}
template
T read(size_t pos) const
{
if (pos + sizeof(Underlying) > size())
throw ByteBufferPositionException(pos, sizeof(Underlying), size());
Underlying val;
std::memcpy(&val, &_storage[pos], sizeof(Underlying));
EndianConvert(val);
return static_cast(val);
}
template
void read(T* dest, size_t count)
{
static_assert(std::is_trivially_copyable::value, "read(T*, size_t) must be used with trivially copyable types");
return read(reinterpret_cast(dest), count * sizeof(T));
}
void read(uint8 *dest, size_t len)
{
if (_rpos + len > size())
throw ByteBufferPositionException(_rpos, len, size());
ResetBitPos();
std::memcpy(dest, &_storage[_rpos], len);
_rpos += len;
}
void ReadPackedUInt64(uint64& guid)
{
guid = 0;
ReadPackedUInt64(read(), guid);
}
void ReadPackedUInt64(uint8 mask, uint64& value)
{
for (uint32 i = 0; i < 8; ++i)
if (mask & (uint8(1) << i))
value |= (uint64(read()) << (i * 8));
}
std::string ReadString(uint32 length)
{
if (_rpos + length > size())
throw ByteBufferPositionException(_rpos, length, size());
ResetBitPos();
if (!length)
return std::string();
std::string str((char const*)&_storage[_rpos], length);
_rpos += length;
return str;
}
//! Method for writing strings that have their length sent separately in packet
//! without null-terminating the string
void WriteString(std::string const& str)
{
if (size_t len = str.length())
append(str.c_str(), len);
}
void WriteString(char const* str, size_t len)
{
if (len)
append(str, len);
}
uint32 ReadPackedTime();
uint8* contents()
{
if (_storage.empty())
throw ByteBufferException();
return _storage.data();
}
uint8 const* contents() const
{
if (_storage.empty())
throw ByteBufferException();
return _storage.data();
}
size_t size() const { return _storage.size(); }
bool empty() const { return _storage.empty(); }
void resize(size_t newsize)
{
_storage.resize(newsize, 0);
_rpos = 0;
_wpos = size();
}
void reserve(size_t ressize)
{
if (ressize > size())
_storage.reserve(ressize);
}
void append(const char *src, size_t cnt)
{
return append((const uint8 *)src, cnt);
}
template
void append(const T *src, size_t cnt)
{
return append((const uint8 *)src, cnt * sizeof(T));
}
void append(const uint8 *src, size_t cnt);
void append(const ByteBuffer& buffer)
{
if (!buffer.empty())
append(buffer.contents(), buffer.size());
}
// can be used in SMSG_MONSTER_MOVE opcode
void appendPackXYZ(float x, float y, float z)
{
uint32 packed = 0;
packed |= ((int)(x / 0.25f) & 0x7FF);
packed |= ((int)(y / 0.25f) & 0x7FF) << 11;
packed |= ((int)(z / 0.25f) & 0x3FF) << 22;
*this << packed;
}
void AppendPackedUInt64(uint64 guid)
{
uint8 mask = 0;
size_t pos = wpos();
*this << uint8(mask);
uint8 packed[8];
if (size_t packedSize = PackUInt64(guid, &mask, packed))
append(packed, packedSize);
put(pos, mask);
}
static size_t PackUInt64(uint64 value, uint8* mask, uint8* result)
{
size_t resultSize = 0;
*mask = 0;
memset(result, 0, 8);
for (uint8 i = 0; value != 0; ++i)
{
if (value & 0xFF)
{
*mask |= uint8(1 << i);
result[resultSize++] = uint8(value & 0xFF);
}
value >>= 8;
}
return resultSize;
}
void AppendPackedTime(time_t time);
void put(size_t pos, const uint8 *src, size_t cnt);
void print_storage() const;
void textlike() const;
void hexlike() const;
protected:
size_t _rpos, _wpos, _bitpos;
uint8 _curbitval;
std::vector _storage;
};
/// @todo Make a ByteBuffer.cpp and move all this inlining to it.
template<> inline std::string ByteBuffer::read()
{
std::string tmp;
*this >> tmp;
return tmp;
}
template<>
inline void ByteBuffer::read_skip()
{
std::string temp;
*this >> temp;
}
template<>
inline void ByteBuffer::read_skip()
{
read_skip();
}
template<>
inline void ByteBuffer::read_skip()
{
read_skip();
}
#endif