1/* (c) Magnus Auvinen. See licence.txt in the root of the distribution for more information. */
2/* If you are missing that file, acquire a complete release at teeworlds.com. */
3#ifndef ENGINE_SHARED_RINGBUFFER_H
4#define ENGINE_SHARED_RINGBUFFER_H
5
6#include <cstdlib>
7#include <functional>
8
9class CRingBufferBase
10{
11 class CItem
12 {
13 public:
14 CItem *m_pPrev;
15 CItem *m_pNext;
16 int m_Free;
17 int m_Size;
18 };
19
20 CItem *m_pBuffer;
21
22 CItem *m_pProduce;
23 CItem *m_pConsume;
24
25 CItem *m_pFirst;
26 CItem *m_pLast;
27
28 int m_Size;
29 int m_Flags;
30
31 std::function<void(void *pCurrent)> m_PopCallback = nullptr;
32
33 CItem *NextBlock(CItem *pItem);
34 CItem *PrevBlock(CItem *pItem);
35 CItem *MergeBack(CItem *pItem);
36
37protected:
38 void *Allocate(int Size);
39
40 void *Prev(void *pCurrent);
41 void *Next(void *pCurrent);
42 void *First();
43 void *Last();
44
45 void Init(void *pMemory, int Size, int Flags);
46 int PopFirst();
47 void SetPopCallback(std::function<void(void *pCurrent)> PopCallback);
48
49public:
50 enum
51 {
52 // Will start to destroy items to try to fit the next one
53 FLAG_RECYCLE = 1
54 };
55 static constexpr int ITEM_SIZE = sizeof(CItem);
56
57 void Clear();
58};
59
60template<typename T>
61class CTypedRingBuffer : public CRingBufferBase
62{
63public:
64 T *Allocate(int Size) { return (T *)CRingBufferBase::Allocate(Size); }
65 int PopFirst() { return CRingBufferBase::PopFirst(); }
66 void SetPopCallback(const std::function<void(T *pCurrent)> &PopCallback)
67 {
68 CRingBufferBase::SetPopCallback([PopCallback](void *pCurrent) {
69 PopCallback((T *)pCurrent);
70 });
71 }
72
73 T *Prev(T *pCurrent) { return (T *)CRingBufferBase::Prev(pCurrent); }
74 T *Next(T *pCurrent) { return (T *)CRingBufferBase::Next(pCurrent); }
75 T *First() { return (T *)CRingBufferBase::First(); }
76 T *Last() { return (T *)CRingBufferBase::Last(); }
77};
78
79template<typename T, int TSIZE, int TFLAGS = 0>
80class CStaticRingBuffer : public CTypedRingBuffer<T>
81{
82 unsigned char m_aBuffer[TSIZE];
83
84public:
85 CStaticRingBuffer() { Init(); }
86
87 void Init() { CRingBufferBase::Init(pMemory: m_aBuffer, Size: TSIZE, Flags: TFLAGS); }
88};
89
90template<typename T>
91class CDynamicRingBuffer : public CTypedRingBuffer<T>
92{
93 unsigned char *m_pBuffer = nullptr;
94
95public:
96 CDynamicRingBuffer(int Size, int Flags = 0) { Init(Size, Flags); }
97
98 ~CDynamicRingBuffer()
99 {
100 free(ptr: m_pBuffer);
101 }
102
103 void Init(int Size, int Flags)
104 {
105 free(ptr: m_pBuffer);
106 m_pBuffer = static_cast<unsigned char *>(malloc(size: Size));
107 CRingBufferBase::Init(pMemory: m_pBuffer, Size, Flags);
108 }
109};
110
111#endif
112