buffer.hpp

//
// リングバッファ
//
 
#ifndef _COLLECTION2_BUFFER_H_
#define _COLLECTION2_BUFFER_H_
 
#include <stddef.h>
 
#include "common.hpp"
 
namespace collection2 {
 
template <typename Element, typename Size = size_t>
class Buffer {
   private:
    Element* const internalData;
 
    Size internalDataSize;
 
    Size head = 0;
 
    Size tail = 0;
 
    Size count = 0;
 
   public:
    Buffer(Element* const data, const Size& dataSize);
 
    Buffer(const Buffer&) = delete;
    Buffer& operator=(const Buffer&) = delete;
 
    ~Buffer() = default;
 
    OperationResult append(const Element& data);
 
    OperationResult pop(Element* const data);
 
    Size capacity() const {
        return internalDataSize;
    }
 
    Size amount() const {
        return count;
    }
 
    bool hasSpace() const {
        return count < internalDataSize;
    }
 
    bool isEmpty() const {
        return count == 0;
    }
};
 
template <typename Element, typename Size>
Buffer<Element, Size>::Buffer(Element* const data, const Size& dataSize) : internalData(data) {
    // ゼロ長のバッファなら何もしない
    if (dataSize == 0) {
        internalDataSize = dataSize;
        return;
    }
 
    // 与えられたサイズを上回らない最大の2の冪数を探す
    unsigned char maxbitPos = 0;
    Size size = dataSize;
    while ((size >>= 1) != 0) {
        maxbitPos++;
    }
    internalDataSize = 1 << maxbitPos;
};
 
template <typename Element, typename Size>
OperationResult Buffer<Element, Size>::append(const Element& data) {
    // サイズ0のバッファに値を追加することはできない
    if (internalDataSize == 0) {
        return OperationResult::Overflow;
    }
 
    // バッファがいっぱいなら、要素を一つ読み捨てる
    if (!hasSpace()) {
        auto result = pop(nullptr);
    }
 
    // tailの位置にデータを書き込む
    *(internalData + tail) = data;
 
    tail = (tail + 1) & (internalDataSize - 1);
    count++;
 
    return OperationResult::Success;
}
 
template <typename Element, typename Size>
OperationResult Buffer<Element, Size>::pop(Element* const data) {
    // バッファが空なら戻る
    if (isEmpty()) {
        return OperationResult::Empty;
    }
 
    // 読み出して渡す。nullptrなら何もしないでheadを進める。
    if (data != nullptr) {
        *data = *(internalData + head);
    }
 
    head = (head + 1) & (internalDataSize - 1);
    count--;
 
    return OperationResult::Success;
}
 
}  // namespace collection2
 
#endif