summaryrefslogtreecommitdiff
path: root/src/core/buffer.h
blob: 4485ff1453aa4662cb702ccddcce5af6b25228b5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
#pragma once

#include "error.h"

#include <array>
#include <cstdint>
#include <deque>
#include <list>
#include <string>
#include <vector>

namespace saw {
/*
 * Access class to reduce templated BufferSegments bloat
 */
class buffer {
protected:
	~buffer() = default;

public:
	virtual size_t read_position() const = 0;
	virtual size_t read_composite_length() const = 0;
	virtual size_t read_segment_length(size_t offset = 0) const = 0;
	virtual void read_advance(size_t bytes) = 0;

	virtual uint8_t &read(size_t i = 0) = 0;
	virtual const uint8_t &read(size_t i = 0) const = 0;

	virtual size_t write_position() const = 0;
	virtual size_t write_composite_length() const = 0;
	virtual size_t write_segment_length(size_t offset = 0) const = 0;
	virtual void write_advance(size_t bytes) = 0;

	virtual uint8_t &write(size_t i = 0) = 0;
	virtual const uint8_t &write(size_t i = 0) const = 0;

	/*
	 * Sometime buffers need to grow with a little more control
	 * than with push and pop for more efficient calls.
	 * There is nothing you can do if read hasn't been filled, but at
	 * least write can be increased if it is demanded.
	 */
	virtual error write_require_length(size_t bytes) = 0;

	error push(const uint8_t &value);
	error push(const uint8_t &buffer, size_t size);
	error pop(uint8_t &value);
	error pop(uint8_t &buffer, size_t size);

	/*
	 * Subject to change
	 */
	std::string to_string() const;
	std::string to_hex() const;
};

/*
 *	A viewer class for buffers.
 *	Working on the reference buffer invalidates the buffer view
 */
class buffer_view : public buffer {
private:
	buffer &buffer_;
	size_t read_offset_;
	size_t write_offset_;

public:
	buffer_view(buffer &);

	size_t read_position() const override;
	size_t read_composite_length() const override;
	size_t read_segment_length(size_t offset = 0) const override;
	void read_advance(size_t bytes) override;

	uint8_t &read(size_t i = 0) override;
	const uint8_t &read(size_t i = 0) const override;

	size_t write_position() const override;
	size_t write_composite_length() const override;
	size_t write_segment_length(size_t offset = 0) const override;
	void write_advance(size_t bytes) override;

	uint8_t &write(size_t i = 0) override;
	const uint8_t &write(size_t i = 0) const override;

	error write_require_length(size_t bytes) override;

	size_t read_offset() const;
	size_t write_offset() const;
};

/*
 * Buffer size meant for default allocation size of the ringbuffer since
 * this class currently doesn't support proper resizing
 */
constexpr size_t RING_BUFFER_MAX_SIZE = 4096;
/*
 * Buffer wrapping around if read caught up
 */
class ring_buffer final : public buffer {
private:
	std::vector<uint8_t> buffer_;
	size_t read_position_;
	size_t write_position_;
	bool write_reached_read_ = false;

public:
	ring_buffer();
	ring_buffer(size_t size);

	inline size_t size() const { return buffer_.size(); }

	inline uint8_t &operator[](size_t i) { return buffer_[i]; }
	inline const uint8_t &operator[](size_t i) const { return buffer_[i]; }

	size_t read_position() const override;
	size_t read_composite_length() const override;
	size_t read_segment_length(size_t offset = 0) const override;
	void read_advance(size_t bytes) override;

	uint8_t &read(size_t i = 0) override;
	const uint8_t &read(size_t i = 0) const override;

	size_t write_position() const override;
	size_t write_composite_length() const override;
	size_t write_segment_length(size_t offset = 0) const override;
	void write_advance(size_t bytes) override;

	uint8_t &write(size_t i = 0) override;
	const uint8_t &write(size_t i = 0) const override;

	error write_require_length(size_t bytes) override;
};

/*
 * One time buffer
 */
class array_buffer : public buffer {
private:
	std::vector<uint8_t> buffer_;

	size_t read_position_;
	size_t write_position_;

public:
	array_buffer(size_t size);

	size_t read_position() const override;
	size_t read_composite_length() const override;
	size_t read_segment_length(size_t offset = 0) const override;
	void read_advance(size_t bytes) override;

	uint8_t &read(size_t i = 0) override;
	const uint8_t &read(size_t i = 0) const override;

	size_t write_position() const override;
	size_t write_composite_length() const override;
	size_t write_segment_length(size_t offset = 0) const override;
	void write_advance(size_t bytes) override;

	uint8_t &write(size_t i = 0) override;
	const uint8_t &write(size_t i = 0) const override;

	error write_require_length(size_t bytes) override;
};

class chain_array_buffer : public buffer {
private:
	std::deque<array_buffer> buffer_;

	size_t read_position_;
	size_t write_position_;

public:
	chain_array_buffer();

	size_t read_position() const override;
	size_t read_composite_length() const override;
	size_t read_segment_length(size_t offset = 0) const override;
	void read_advance(size_t bytes) override;

	uint8_t &read(size_t i = 0) override;
	const uint8_t &read(size_t i = 0) const override;

	size_t write_position() const override;
	size_t write_composite_length() const override;
	size_t write_segment_length(size_t offset = 0) const override;
	void write_advance(size_t bytes) override;

	uint8_t &write(size_t i = 0) override;
	const uint8_t &write(size_t i = 0) const override;

	error write_require_length(size_t bytes) override;
};
} // namespace saw