#pragma once #include #include #include #include namespace esphome { enum Endian { LITTLE, BIG }; /** * A class modelled on the Java ByteBuffer class. It wraps a vector of bytes and permits putting and getting * items of various sizes, with an automatically incremented position. * * There are three variables maintained pointing into the buffer: * * 0 <= position <= limit <= capacity * * capacity: the maximum amount of data that can be stored * limit: the limit of the data currently available to get or put * position: the current insert or extract position * * In addition a mark can be set to the current position with mark(). A subsequent call to reset() will restore * the position to the mark. * * The buffer can be marked to be little-endian (default) or big-endian. All subsequent operations will use that order. * */ class ByteBuffer { public: /** * Create a new Bytebuffer with the given capacity */ static ByteBuffer create(size_t capacity); /** * Wrap an existing vector in a Bytebufffer */ static ByteBuffer wrap(std::vector data); /** * Wrap an existing array in a Bytebufffer */ static ByteBuffer wrap(uint8_t *ptr, size_t len); // Get one byte from the buffer, increment position by 1 uint8_t get_uint8(); // Get a 16 bit unsigned value, increment by 2 uint16_t get_uint16(); // Get a 24 bit unsigned value, increment by 3 uint32_t get_uint24(); // Get a 32 bit unsigned value, increment by 4 uint32_t get_uint32(); // signed versions of the get functions uint8_t get_int8() { return (int8_t) this->get_uint8(); }; int16_t get_int16() { return (int16_t) this->get_uint16(); } uint32_t get_int24(); int32_t get_int32() { return (int32_t) this->get_uint32(); } // Get a float value, increment by 4 float get_float(); // put values into the buffer, increment the position accordingly void put_uint8(uint8_t value); void put_uint16(uint16_t value); void put_uint24(uint32_t value); void put_uint32(uint32_t value); void put_float(float value); inline size_t get_capacity() const { return this->data_.size(); } inline size_t get_position() const { return this->position_; } inline size_t get_limit() const { return this->limit_; } inline size_t get_remaining() const { return this->get_limit() - this->get_position(); } inline Endian get_endianness() const { return this->endianness_; } inline void mark() { this->mark_ = this->position_; } inline void big_endian() { this->endianness_ = BIG; } inline void little_endian() { this->endianness_ = LITTLE; } void set_limit(size_t limit); void set_position(size_t position); // set position to 0, limit to capacity. void clear(); // set limit to current position, postition to zero. Used when swapping from write to read operations. void flip(); // retrieve a pointer to the underlying data. uint8_t *array() { return this->data_.data(); }; void rewind() { this->position_ = 0; } void reset() { this->position_ = this->mark_; } protected: ByteBuffer(std::vector data) : data_(std::move(data)) { this->limit_ = this->get_capacity(); } std::vector data_; Endian endianness_{LITTLE}; size_t position_{0}; size_t mark_{0}; size_t limit_{0}; }; } // namespace esphome