ByteBuffer.h

Go to the documentation of this file.

/*
* This file is part of Project SkyFire https://www.projectskyfire.org.
* See LICENSE.md file for Copyright information
*/
 
#ifndef _BYTEBUFFER_H
#define _BYTEBUFFER_H
 
#ifndef SF_TIMEZONE
#if _MSC_VER >= 1900
#define SF_TIMEZONE _timezone
#else
#define SF_TIMEZONE timezone
#endif
#endif
 
#include "ByteConverter.h"
#include "Define.h"
#include "Errors.h"
#include "Platform/TimeUtils.h"
 
#include <cmath>
#include <cstring>
#include <exception>
#include <list>
#include <map>
#include <string>
#include <time.h>
#include <array>
#include <vector>
 
// Root of ByteBuffer exception hierarchy
class ByteBufferException : public std::exception
{
public:
    ~ByteBufferException() throw() { }
 
    char const* what() const throw() { return msg_.c_str(); }
 
protected:
    std::string& message() throw() { return msg_; }
 
private:
    std::string msg_;
};
 
class ByteBufferPositionException : public ByteBufferException
{
public:
    ByteBufferPositionException(bool add, size_t pos, size_t size, size_t valueSize);
 
    ~ByteBufferPositionException() throw() { }
};
 
class ByteBufferSourceException : public ByteBufferException
{
public:
    ByteBufferSourceException(size_t pos, size_t size, size_t valueSize);
 
    ~ByteBufferSourceException() throw() { }
};

struct ObjectGuid
{
public:
    ObjectGuid() { _data.u64 = UI64LIT(0); }
    ObjectGuid(uint64 guid) { _data.u64 = guid; }
    ObjectGuid(ObjectGuid const& other) { _data.u64 = other._data.u64; }
 
    uint8& operator[](uint32 index)
    {
        ASSERT(index < sizeof(uint64));
 
#if SKYFIRE_ENDIAN == SKYFIRE_LITTLEENDIAN
        return _data.byte[index];
#else
        return _data.byte[7 - index];
#endif
    }
 
    uint8 const& operator[](uint32 index) const
    {
        ASSERT(index < sizeof(uint64));
 
#if SKYFIRE_ENDIAN == SKYFIRE_LITTLEENDIAN
        return _data.byte[index];
#else
        return _data.byte[7 - index];
#endif
    }
 
    operator uint64()
    {
        return _data.u64;
    }
 
    ObjectGuid& operator=(uint64 guid)
    {
        _data.u64 = guid;
        return *this;
    }
 
    ObjectGuid& operator=(ObjectGuid const& other)
    {
        _data.u64 = other._data.u64;
        return *this;
    }
 
private:
    union
    {
        uint64 u64;
        uint8 byte[8];
    } _data;
};
 
class ByteBuffer
{
public:
    const static size_t DEFAULT_SIZE = 0x1000;
 
    // constructor
    ByteBuffer() : _rpos(0), _wpos(0), _bitpos(8), _curbitval(0)
    {
        _storage.reserve(DEFAULT_SIZE);
    }
 
    ByteBuffer(size_t reserve) : _rpos(0), _wpos(0), _bitpos(8), _curbitval(0)
    {
        _storage.reserve(reserve);
    }
 
    // copy constructor
    ByteBuffer(const ByteBuffer& buf) : _rpos(buf._rpos), _wpos(buf._wpos),
        _bitpos(buf._bitpos), _curbitval(buf._curbitval), _storage(buf._storage)
    {
    }
    virtual ~ByteBuffer() { }
    void clear()
    {
        _storage.clear();
        _rpos = _wpos = 0;
    }
 
    template <typename T> void append(T value)
    {
        FlushBits();
        EndianConvert(value);
        append((uint8*)&value, sizeof(value));
    }
 
    void FlushBits()
    {
        if (_bitpos == 8)
            return;
 
        append((uint8*)&_curbitval, sizeof(uint8));
        _curbitval = 0;
        _bitpos = 8;
    }
 
    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)
        {
            _bitpos = 0;
            _curbitval = read<uint8>();
        }
 
        return ((_curbitval >> (7 - _bitpos)) & 1) != 0;
    }
 
    template <typename T> void WriteBits(T value, size_t bits)
    {
        for (int32 i = bits - 1; i >= 0; --i)
            WriteBit((value >> i) & 1);
    }
 
    uint32 ReadBits(size_t bits)
    {
        uint32 value = 0;
        for (int32 i = bits - 1; i >= 0; --i)
            if (ReadBit())
                value |= (1 << (i));
 
        return value;
    }
 
    void ReadBytesSeq(ObjectGuid& guid, uint8 order[8])
    {
        for (uint8 i = 0; i < 8; ++i)
            ReadByteSeq(guid[order[i]]);
    }
 
    // Reads a byte (if needed) in-place
    void ReadByteSeq(uint8& b)
    {
        if (b != 0)
            b ^= read<uint8>();
    }
 
    void WriteBytesSeq(ObjectGuid guid, uint8 order[8])
    {
        for (uint8 i = 0; i < 8; ++i)
            WriteByteSeq(guid[order[i]]);
    }
 
    void WriteByteSeq(uint8 b)
    {
        if (b != 0)
            append<uint8>(b ^ 1);
    }
 
    template <typename T> void put(size_t pos, T value)
    {
        EndianConvert(value);
        put(pos, (uint8*)&value, sizeof(value));
    }
 
    template <typename... Offsets>
    void ReadGuidMask(ObjectGuid& guid, Offsets... offsets)
    {
        uint8 const order[] = { uint8(offsets)... };
        for (uint8 offset : order)
            guid[offset] = ReadBit();
    }
 
    template <typename... Offsets>
    void WriteGuidMask(const ObjectGuid& guid, Offsets... offsets)
    {
        uint8 const order[] = { uint8(offsets)... };
        for (uint8 offset : order)
            WriteBit(guid[offset]);
    }
 
    template <typename... Offsets>
    void ReadGuidBytes(ObjectGuid& guid, Offsets... offsets)
    {
        uint8 const order[] = { uint8(offsets)... };
        for (uint8 offset : order)
            ReadByteSeq(guid[offset]);
    }
 
    template <typename... Offsets>
    void WriteGuidBytes(const ObjectGuid& guid, Offsets... offsets)
    {
        uint8 const order[] = { uint8(offsets)... };
        for (uint8 offset : order)
            WriteByteSeq(guid[offset]);
    }

    template <typename T> void PutBits(size_t pos, T value, uint32 bitCount)
    {
        if (!bitCount)
            throw ByteBufferSourceException((pos + bitCount) / 8, size(), 0);
 
        if (pos + bitCount > size() * 8)
            throw ByteBufferPositionException(false, (pos + bitCount) / 8, size(), (bitCount - 1) / 8 + 1);
 
        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<uint8>(value);
        return *this;
    }
 
    ByteBuffer& operator<<(uint16 value)
    {
        append<uint16>(value);
        return *this;
    }
 
    ByteBuffer& operator<<(uint32 value)
    {
        append<uint32>(value);
        return *this;
    }
 
    ByteBuffer& operator<<(uint64 value)
    {
        append<uint64>(value);
        return *this;
    }
 
    // signed as in 2e complement
    ByteBuffer& operator<<(int8 value)
    {
        append<int8>(value);
        return *this;
    }
 
    ByteBuffer& operator<<(int16 value)
    {
        append<int16>(value);
        return *this;
    }
 
    ByteBuffer& operator<<(int32 value)
    {
        append<int32>(value);
        return *this;
    }
 
    ByteBuffer& operator<<(int64 value)
    {
        append<int64>(value);
        return *this;
    }
 
    // floating points
    ByteBuffer& operator<<(float value)
    {
        append<float>(value);
        return *this;
    }
 
    ByteBuffer& operator<<(double value)
    {
        append<double>(value);
        return *this;
    }
 
    ByteBuffer& operator<<(const std::string& value)
    {
        if (size_t len = value.length())
            append((uint8 const*)value.c_str(), len);
        append((uint8)0);
        return *this;
    }
 
    ByteBuffer& operator>>(bool& value)
    {
        value = read<char>() > 0 ? true : false;
        return *this;
    }
 
    ByteBuffer& operator>>(uint8& value)
    {
        value = read<uint8>();
        return *this;
    }
 
    ByteBuffer& operator>>(uint16& value)
    {
        value = read<uint16>();
        return *this;
    }
 
    ByteBuffer& operator>>(uint32& value)
    {
        value = read<uint32>();
        return *this;
    }
 
    ByteBuffer& operator>>(uint64& value)
    {
        value = read<uint64>();
        return *this;
    }
 
    //signed as in 2e complement
    ByteBuffer& operator>>(int8& value)
    {
        value = read<int8>();
        return *this;
    }
 
    ByteBuffer& operator>>(int16& value)
    {
        value = read<int16>();
        return *this;
    }
 
    ByteBuffer& operator>>(int32& value)
    {
        value = read<int32>();
        return *this;
    }
 
    ByteBuffer& operator>>(int64& value)
    {
        value = read<int64>();
        return *this;
    }
 
    ByteBuffer& operator>>(float& value)
    {
        value = read<float>();
        if (!std::isfinite(value))
            throw ByteBufferException();
        return *this;
    }
 
    ByteBuffer& operator>>(double& value)
    {
        value = read<double>();
        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<char>();
            if (c == 0)
                break;
            value += c;
        }
        return *this;
    }
 
    uint8& operator[](size_t const pos)
    {
        if (pos >= size())
            throw ByteBufferPositionException(false, pos, 1, size());
        return _storage[pos];
    }
 
    uint8 const& operator[](size_t const pos) const
    {
        if (pos >= size())
            throw ByteBufferPositionException(false, 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;
    }

    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<typename T>
    void read_skip() { read_skip(sizeof(T)); }
 
    void read_skip(size_t skip)
    {
        if (_rpos + skip > size())
            throw ByteBufferPositionException(false, _rpos, skip, size());
        _rpos += skip;
    }
 
    template <typename T> T read()
    {
        T r = read<T>(_rpos);
        _rpos += sizeof(T);
        return r;
    }
 
    template <typename T> T read(size_t pos) const
    {
        if (pos + sizeof(T) > size())
            throw ByteBufferPositionException(false, 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(false, _rpos, len, size());
        std::memcpy(dest, &_storage[_rpos], len);
        _rpos += len;
    }
 
    template<size_t Size>
    void read(std::array<uint8, Size>& arr)
    {
        read(arr.data(), Size);
    }
 
    void readPackGUID(uint64& guid)
    {
        if (rpos() + 1 > size())
            throw ByteBufferPositionException(false, _rpos, 1, size());
 
        guid = 0;
 
        uint8 guidmark = 0;
        (*this) >> guidmark;
 
        for (int i = 0; i < 8; ++i)
        {
            if (guidmark & (uint8(1) << i))
            {
                if (rpos() + 1 > size())
                    throw ByteBufferPositionException(false, _rpos, 1, size());
 
                uint8 bit;
                (*this) >> bit;
                guid |= (uint64(bit) << (i * 8));
            }
        }
    }
 
    std::string ReadString(size_t length)
    {
        if (!length)
            return std::string();
        char* buffer = new char[length + 1]();
        read((uint8*)buffer, length);
        std::string retval = buffer;
        delete[] buffer;
        return retval;
    }

    void WriteString(std::string const& str)
    {
        if (size_t len = str.length())
            append(str.c_str(), len);
    }
 
    uint32 ReadPackedTime()
    {
        uint32 packedDate = read<uint32>();
        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(&lt) + SF_TIMEZONE);
    }
 
    ByteBuffer& ReadPackedTime(uint32& time)
    {
        time = ReadPackedTime();
        return *this;
    }
 
    uint8* contents() { return &_storage[0]; }
 
    const uint8* contents() const { return &_storage[0]; }
 
    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<class T> void append(const T* src, size_t cnt)
    {
        return append((const uint8*)src, cnt * sizeof(T));
    }
 
    void append(const uint8* src, size_t cnt)
    {
        if (!cnt)
            throw ByteBufferSourceException(_wpos, size(), cnt);
 
        if (!src)
            throw ByteBufferSourceException(_wpos, size(), cnt);
 
        ASSERT(size() < 10000000);
 
        if (_storage.size() < _wpos + cnt)
            _storage.resize(_wpos + cnt);
        std::memcpy(&_storage[_wpos], src, cnt);
        _wpos += cnt;
    }
 
    void append(const ByteBuffer& buffer)
    {
        if (buffer.wpos())
            append(buffer.contents(), buffer.wpos());
    }
 
    void AppendBits(const ByteBuffer& buffer)
    {
        for (uint32 i = 0; i < buffer.wpos(); ++i)
            WriteBits(*(buffer.contents() + i), 8);
 
        WriteBits(buffer._curbitval >> buffer._bitpos, 8 - buffer._bitpos);
    }
 
    template<size_t Size>
    void append(std::array<uint8, Size> const& arr)
    {
        append(arr.data(), Size);
    }
 
    // can be used in SMSG_ON_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 appendPackGUID(uint64 guid)
    {
        uint8 packGUID[8 + 1];
        packGUID[0] = 0;
        size_t size = 1;
        for (uint8 i = 0; guid != 0; ++i)
        {
            if (guid & 0xFF)
            {
                packGUID[0] |= uint8(1 << i);
                packGUID[size] = uint8(guid & 0xFF);
                ++size;
            }
 
            guid >>= 8;
        }
        append(packGUID, size);
    }
 
    void AppendPackedTime(time_t time)
    {
        tm lt;
        Skyfire::LocalTime(time, lt);
        append<uint32>((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)
    {
        if (pos + cnt > size())
            throw ByteBufferPositionException(true, pos, cnt, size());
 
        if (!src)
            throw ByteBufferSourceException(_wpos, size(), cnt);
 
        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<uint8> _storage;
};
 
template <typename T>
inline ByteBuffer& operator<<(ByteBuffer& b, std::vector<T> v)
{
    b << (uint32)v.size();
    for (typename std::vector<T>::iterator i = v.begin(); i != v.end(); ++i)
    {
        b << *i;
    }
    return b;
}
 
template <typename T>
inline ByteBuffer& operator>>(ByteBuffer& b, std::vector<T>& v)
{
    uint32 vsize;
    b >> vsize;
    v.clear();
    while (vsize--)
    {
        T t;
        b >> t;
        v.push_back(t);
    }
    return b;
}
 
template <typename T>
inline ByteBuffer& operator<<(ByteBuffer& b, std::list<T> v)
{
    b << (uint32)v.size();
    for (typename std::list<T>::iterator i = v.begin(); i != v.end(); ++i)
    {
        b << *i;
    }
    return b;
}
 
template <typename T>
inline ByteBuffer& operator>>(ByteBuffer& b, std::list<T>& v)
{
    uint32 vsize;
    b >> vsize;
    v.clear();
    while (vsize--)
    {
        T t;
        b >> t;
        v.push_back(t);
    }
    return b;
}
 
template <typename K, typename V>
inline ByteBuffer& operator<<(ByteBuffer& b, std::map<K, V>& m)
{
    b << (uint32)m.size();
    for (typename std::map<K, V>::iterator i = m.begin(); i != m.end(); ++i)
    {
        b << i->first << i->second;
    }
    return b;
}
 
template <typename K, typename V>
inline ByteBuffer& operator>>(ByteBuffer& b, std::map<K, V>& m)
{
    uint32 msize;
    b >> msize;
    m.clear();
    while (msize--)
    {
        K k;
        V v;
        b >> k >> v;
        m.insert(make_pair(k, v));
    }
    return b;
}

template<> inline std::string ByteBuffer::read<std::string>()
{
    std::string tmp;
    *this >> tmp;
    return tmp;
}
 
template<>
inline void ByteBuffer::read_skip<char*>()
{
    std::string temp;
    *this >> temp;
}
 
template<>
inline void ByteBuffer::read_skip<char const*>()
{
    read_skip<char*>();
}
 
template<>
inline void ByteBuffer::read_skip<std::string>()
{
    read_skip<char*>();
}
 
#endif