godot/core/templates/ring_buffer.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

221 lines
5.9 KiB
C++
Raw Normal View History

2014-02-10 09:10:30 +08:00
/**************************************************************************/
/* ring_buffer.h */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
#ifndef RING_BUFFER_H
#define RING_BUFFER_H
2014-02-10 09:10:30 +08:00
#include "core/templates/vector.h"
2014-02-10 09:10:30 +08:00
template <typename T>
class RingBuffer {
Vector<T> data;
int read_pos = 0;
int write_pos = 0;
2014-02-10 09:10:30 +08:00
int size_mask;
2016-03-09 07:00:52 +08:00
inline int inc(int &p_var, int p_size) const {
2014-02-10 09:10:30 +08:00
int ret = p_var;
p_var += p_size;
p_var = p_var & size_mask;
return ret;
}
2016-03-09 07:00:52 +08:00
2014-02-10 09:10:30 +08:00
public:
T read() {
ERR_FAIL_COND_V(space_left() < 1, T());
return data.ptr()[inc(read_pos, 1)];
}
2016-03-09 07:00:52 +08:00
2014-02-10 09:10:30 +08:00
int read(T *p_buf, int p_size, bool p_advance = true) {
int left = data_left();
p_size = MIN(left, p_size);
int pos = read_pos;
int to_read = p_size;
int dst = 0;
while (to_read) {
int end = pos + to_read;
end = MIN(end, size());
int total = end - pos;
const T *read = data.ptr();
2014-02-10 09:10:30 +08:00
for (int i = 0; i < total; i++) {
p_buf[dst++] = read[pos + i];
}
2014-02-10 09:10:30 +08:00
to_read -= total;
pos = 0;
}
2014-02-10 09:10:30 +08:00
if (p_advance) {
inc(read_pos, p_size);
}
2014-02-10 09:10:30 +08:00
return p_size;
}
2014-02-10 09:10:30 +08:00
int copy(T *p_buf, int p_offset, int p_size) const {
2014-02-10 09:10:30 +08:00
int left = data_left();
if ((p_offset + p_size) > left) {
p_size -= left - p_offset;
if (p_size <= 0) {
2014-02-10 09:10:30 +08:00
return 0;
}
2014-02-10 09:10:30 +08:00
}
p_size = MIN(left, p_size);
int pos = read_pos;
inc(pos, p_offset);
int to_read = p_size;
int dst = 0;
while (to_read) {
int end = pos + to_read;
end = MIN(end, size());
int total = end - pos;
for (int i = 0; i < total; i++) {
p_buf[dst++] = data[pos + i];
}
2014-02-10 09:10:30 +08:00
to_read -= total;
pos = 0;
}
2014-02-10 09:10:30 +08:00
return p_size;
}
2014-02-10 09:10:30 +08:00
int find(const T &t, int p_offset, int p_max_size) const {
2017-05-05 08:09:43 +08:00
int left = data_left();
if ((p_offset + p_max_size) > left) {
p_max_size -= left - p_offset;
if (p_max_size <= 0) {
2017-05-05 08:09:43 +08:00
return 0;
}
2017-05-05 08:09:43 +08:00
}
p_max_size = MIN(left, p_max_size);
int pos = read_pos;
inc(pos, p_offset);
int to_read = p_max_size;
while (to_read) {
int end = pos + to_read;
end = MIN(end, size());
int total = end - pos;
for (int i = 0; i < total; i++) {
if (data[pos + i] == t) {
2017-05-05 08:09:43 +08:00
return i + (p_max_size - to_read);
}
}
2017-05-05 08:09:43 +08:00
to_read -= total;
pos = 0;
}
return -1;
}
2014-02-10 09:10:30 +08:00
inline int advance_read(int p_n) {
p_n = MIN(p_n, data_left());
inc(read_pos, p_n);
return p_n;
}
2016-03-09 07:00:52 +08:00
2018-11-06 16:04:37 +08:00
inline int decrease_write(int p_n) {
p_n = MIN(p_n, data_left());
inc(write_pos, size_mask + 1 - p_n);
return p_n;
}
2014-02-10 09:10:30 +08:00
Error write(const T &p_v) {
ERR_FAIL_COND_V(space_left() < 1, FAILED);
data.write[inc(write_pos, 1)] = p_v;
2014-02-10 09:10:30 +08:00
return OK;
}
2016-03-09 07:00:52 +08:00
2014-02-10 09:10:30 +08:00
int write(const T *p_buf, int p_size) {
int left = space_left();
p_size = MIN(left, p_size);
2016-03-09 07:00:52 +08:00
2014-02-10 09:10:30 +08:00
int pos = write_pos;
int to_write = p_size;
int src = 0;
while (to_write) {
int end = pos + to_write;
end = MIN(end, size());
int total = end - pos;
2016-03-09 07:00:52 +08:00
2014-02-10 09:10:30 +08:00
for (int i = 0; i < total; i++) {
data.write[pos + i] = p_buf[src++];
}
2014-02-10 09:10:30 +08:00
to_write -= total;
pos = 0;
}
2014-02-10 09:10:30 +08:00
inc(write_pos, p_size);
return p_size;
}
2016-03-09 07:00:52 +08:00
inline int space_left() const {
2014-02-10 09:10:30 +08:00
int left = read_pos - write_pos;
if (left < 0) {
return size() + left - 1;
}
2014-02-10 09:10:30 +08:00
if (left == 0) {
return size() - 1;
}
return left - 1;
}
inline int data_left() const {
return size() - space_left() - 1;
}
2016-03-09 07:00:52 +08:00
inline int size() const {
2014-02-10 09:10:30 +08:00
return data.size();
}
inline void clear() {
read_pos = 0;
write_pos = 0;
}
2016-03-09 07:00:52 +08:00
2014-02-10 09:10:30 +08:00
void resize(int p_power) {
int old_size = size();
int new_size = 1 << p_power;
int mask = new_size - 1;
data.resize(int64_t(1) << int64_t(p_power));
2014-02-10 09:10:30 +08:00
if (old_size < new_size && read_pos > write_pos) {
for (int i = 0; i < write_pos; i++) {
data.write[(old_size + i) & mask] = data[i];
}
2014-02-10 09:10:30 +08:00
write_pos = (old_size + write_pos) & mask;
} else {
read_pos = read_pos & mask;
write_pos = write_pos & mask;
}
2016-03-09 07:00:52 +08:00
2014-02-10 09:10:30 +08:00
size_mask = mask;
}
2016-03-09 07:00:52 +08:00
RingBuffer(int p_power = 0) {
2014-02-10 09:10:30 +08:00
resize(p_power);
}
~RingBuffer() {}
2014-02-10 09:10:30 +08:00
};
#endif // RING_BUFFER_H