CircularBuffer.h

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/SmingHub/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * CircularBuffer.h
 *
 * Initial code done by Ivan Grokhotkov as part of the esp8266 core for Arduino environment.
 * https://github.com/esp8266/Arduino/blob/master/cores/esp8266/cbuf.h
 *
 * Adapted for Sming by Slavey Karadzhov <slaff@attachix.com>
 *
 ****/

#ifndef _SMING_CORE_DATA_BUFFER_CIRCULAR_BUFFER_H_
#define _SMING_CORE_DATA_BUFFER_CIRCULAR_BUFFER_H_

#include "Stream/ReadWriteStream.h"

class CircularBuffer : public ReadWriteStream
{
public:
    CircularBuffer(int size) : buffer(new char[size]), readPos(buffer), writePos(buffer), size(size)
    {
    }

    ~CircularBuffer()
    {
        delete[] buffer;
    }

    StreamType getStreamType() const override
    {
        return StreamType::eSST_Memory;
    }

    uint16_t readMemoryBlock(char* data, int bufSize) override;

    bool seek(int len) override;

    bool isFinished() override
    {
        return available() < 1;
    }

    int available() override;

    String id() const override
    {
        return String(reinterpret_cast<uint32_t>(&buffer), HEX);
    }

    size_t write(uint8_t charToWrite) override;

    size_t write(const uint8_t* data, size_t size) override;

    size_t room() const;

    // Stream::flush()
    void flush() override
    {
        readPos = buffer;
        writePos = buffer;
    }

private:
    inline char* wrap(char* ptr) const
    {
        return (ptr == buffer + size) ? buffer : ptr;
    }

private:
    char* buffer = nullptr;
    char* readPos = nullptr;
    char* writePos = nullptr;
    int size = 0;
};

#endif /* _SMING_CORE_DATA_BUFFER_CIRCULAR_BUFFER_H_ */