/*
* Copyright (C) 2008-2017 TrinityCore
* Copyright (C) 2005-2009 MaNGOS
*
* 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 "Errors.h"
#include "ByteConverter.h"
#include "Util.h"
#include
class MessageBuffer;
// Root of ByteBuffer exception hierarchy
class TC_SHARED_API ByteBufferException : public std::exception
{
public:
~ByteBufferException() throw() { }
char const* what() const throw() override { return msg_.c_str(); }
protected:
std::string & message() throw() { 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() throw() { }
};
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);
}
ByteBuffer(size_t reserve) : _rpos(0), _wpos(0), _bitpos(InitialBitPos), _curbitval(0)
{
_storage.reserve(reserve);
}
ByteBuffer(ByteBuffer&& buf) : _rpos(buf._rpos), _wpos(buf._wpos),
_bitpos(buf._bitpos), _curbitval(buf._curbitval), _storage(buf.Move()) { }
ByteBuffer(ByteBuffer const& right) : _rpos(right._rpos), _wpos(right._wpos),
_bitpos(right._bitpos), _curbitval(right._curbitval), _storage(right._storage) { }
ByteBuffer(MessageBuffer&& buffer);
std::vector&& Move()
{
_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)
{
if (this != &right)
{
_rpos = right._rpos;
_wpos = right._wpos;
_bitpos = right._bitpos;
_curbitval = right._curbitval;
_storage = right.Move();
}
return *this;
}
virtual ~ByteBuffer() { }
void clear()
{
_rpos = 0;
_wpos = 0;
_bitpos = InitialBitPos;
_curbitval = 0;
_storage.clear();
}
template void append(T value)
{
static_assert(std::is_fundamental::value, "append(compound)");
EndianConvert(value);
append((uint8 *)&value, sizeof(value));
}
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(uint32 bit)
{
--_bitpos;
if (bit)
_curbitval |= (1 << (_bitpos));
if (_bitpos == 0)
{
_bitpos = 8;
append((uint8 *)&_curbitval, sizeof(_curbitval));
_curbitval = 0;
}
return (bit != 0);
}
bool ReadBit()
{
++_bitpos;
if (_bitpos > 7)
{
_curbitval = read();
_bitpos = 0;
}
return ((_curbitval >> (7-_bitpos)) & 1) != 0;
}
template void WriteBits(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;
}
// Reads a byte (if needed) in-place
void ReadByteSeq(uint8& b)
{
if (b != 0)
b ^= read();
}
void WriteByteSeq(uint8 b)
{
if (b != 0)
append(b ^ 1);
}
template void put(size_t pos, T value)
{
static_assert(std::is_fundamental::value, "append(compound)");
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.
*/
template
void PutBits(size_t pos, T value, uint32 bitCount)
{
ASSERT(pos + bitCount <= size() * 8, "Attempted to put " SZFMTD " bits in ByteBuffer (bitpos: " SZFMTD " size: " SZFMTD ")", bitCount, pos, size());
ASSERT(bitCount, "Attempted to put a zero bits in ByteBuffer");
for (uint32 i = 0; i < bitCount; ++i)
{
size_t wp = (pos + i) / 8;
size_t bit = (pos + i) % 8;
if ((value >> (bitCount - i - 1)) & 1)
_storage[wp] |= 1 << (7 - bit);
else
_storage[wp] &= ~(1 << (7 - bit));
}
}
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)
{
value = read();
if (!std::isfinite(value))
throw ByteBufferException();
return *this;
}
ByteBuffer &operator>>(double &value)
{
value = read();
if (!std::isfinite(value))
throw ByteBufferException();
return *this;
}
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(T);
return r;
}
template T read(size_t pos) const
{
if (pos + sizeof(T) > size())
throw ByteBufferPositionException(pos, sizeof(T), size());
T val = *((T const*)&_storage[pos]);
EndianConvert(val);
return val;
}
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()
{
uint32 packedDate = read();
tm lt = tm();
lt.tm_min = packedDate & 0x3F;
lt.tm_hour = (packedDate >> 6) & 0x1F;
//lt.tm_wday = (packedDate >> 11) & 7;
lt.tm_mday = ((packedDate >> 14) & 0x3F) + 1;
lt.tm_mon = (packedDate >> 20) & 0xF;
lt.tm_year = ((packedDate >> 24) & 0x1F) + 100;
return uint32(mktime(<));
}
ByteBuffer& ReadPackedTime(uint32& time)
{
time = ReadPackedTime();
return *this;
}
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)
{
ASSERT(src, "Attempted to put a NULL-pointer in ByteBuffer (pos: " SZFMTD " size: " SZFMTD ")", _wpos, size());
ASSERT(cnt, "Attempted to put a zero-sized value in ByteBuffer (pos: " SZFMTD " size: " SZFMTD ")", _wpos, size());
ASSERT(size() < 10000000);
FlushBits();
_storage.insert(_storage.begin() + _wpos, src, src + cnt);
_wpos += cnt;
}
void append(const ByteBuffer& buffer)
{
if (buffer.wpos())
append(buffer.contents(), buffer.wpos());
}
// 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)
{
tm lt;
localtime_r(&time, <);
append((lt.tm_year - 100) << 24 | lt.tm_mon << 20 | (lt.tm_mday - 1) << 14 | lt.tm_wday << 11 | lt.tm_hour << 6 | lt.tm_min);
}
void put(size_t pos, const uint8 *src, size_t cnt)
{
ASSERT(pos + cnt <= size(), "Attempted to put value with size: " SZFMTD " in ByteBuffer (pos: " SZFMTD " size: " SZFMTD ")", cnt, pos, size());
ASSERT(src, "Attempted to put a NULL-pointer in ByteBuffer (pos: " SZFMTD " size: " SZFMTD ")", pos, size());
ASSERT(cnt, "Attempted to put a zero-sized value in ByteBuffer (pos: " SZFMTD " size: " SZFMTD ")", pos, size());
std::memcpy(&_storage[pos], src, cnt);
}
void print_storage() const;
void textlike() const;
void hexlike() const;
protected:
size_t _rpos, _wpos, _bitpos;
uint8 _curbitval;
std::vector _storage;
};
template
inline ByteBuffer &operator<<(ByteBuffer &b, std::vector v)
{
b << (uint32)v.size();
for (typename std::vector::iterator i = v.begin(); i != v.end(); ++i)
{
b << *i;
}
return b;
}
template
inline ByteBuffer &operator>>(ByteBuffer &b, std::vector &v)
{
uint32 vsize;
b >> vsize;
v.clear();
while (vsize--)
{
T t;
b >> t;
v.push_back(t);
}
return b;
}
template
inline ByteBuffer &operator<<(ByteBuffer &b, std::list v)
{
b << (uint32)v.size();
for (typename std::list::iterator i = v.begin(); i != v.end(); ++i)
{
b << *i;
}
return b;
}
template
inline ByteBuffer &operator>>(ByteBuffer &b, std::list &v)
{
uint32 vsize;
b >> vsize;
v.clear();
while (vsize--)
{
T t;
b >> t;
v.push_back(t);
}
return b;
}
template
inline ByteBuffer &operator<<(ByteBuffer &b, std::map &m)
{
b << (uint32)m.size();
for (typename std::map::iterator i = m.begin(); i != m.end(); ++i)
{
b << i->first << i->second;
}
return b;
}
template
inline ByteBuffer &operator>>(ByteBuffer &b, std::map &m)
{
uint32 msize;
b >> msize;
m.clear();
while (msize--)
{
K k;
V v;
b >> k >> v;
m.insert(make_pair(k, v));
}
return b;
}
/// @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