aboutsummaryrefslogtreecommitdiff
path: root/include/cru/common/io/Stream.h
diff options
context:
space:
mode:
authorcrupest <crupest@outlook.com>2024-06-24 00:06:25 +0800
committercrupest <crupest@outlook.com>2024-10-04 19:55:33 +0800
commitf51eb955e188858272230a990565931e7403f23b (patch)
tree04de484bfcd056b6eea56c13c42cce83315c448f /include/cru/common/io/Stream.h
parent1b30150ab79ff1338f209a8ddb54b3dc60cfb599 (diff)
downloadcru-f51eb955e188858272230a990565931e7403f23b.tar.gz
cru-f51eb955e188858272230a990565931e7403f23b.tar.bz2
cru-f51eb955e188858272230a990565931e7403f23b.zip
HALF WORK: Stream refactor.
TODO: Complete refactor of BufferStream and AutoReadStream. NEED TEST: BufferStream, AutoReadStream, SubProcess.
Diffstat (limited to 'include/cru/common/io/Stream.h')
-rw-r--r--include/cru/common/io/Stream.h86
1 files changed, 68 insertions, 18 deletions
diff --git a/include/cru/common/io/Stream.h b/include/cru/common/io/Stream.h
index 014cd472..e0b61627 100644
--- a/include/cru/common/io/Stream.h
+++ b/include/cru/common/io/Stream.h
@@ -6,7 +6,6 @@
#include "../String.h"
#include <cstddef>
-#include <vector>
namespace cru::io {
class CRU_BASE_API StreamOperationNotSupportedException : public Exception {
@@ -36,41 +35,92 @@ class CRU_BASE_API StreamAlreadyClosedException : public Exception {
static void Check(bool closed);
};
+#define CRU_STREAM_IMPLEMENT_CLOSE_BY_DO_CLOSE \
+ void Close() override { DoClose(); }
+
+#define CRU_STREAM_BEGIN_CLOSE \
+ if (GetClosed()) return; \
+ CloseGuard close_guard(this);
+
+/**
+ * All stream is thread-unsafe by default unless being documented.
+ */
class CRU_BASE_API Stream : public Object {
+ protected:
+ struct SupportedOperations {
+ std::optional<bool> can_seek;
+ std::optional<bool> can_read;
+ std::optional<bool> can_write;
+ };
+
+ struct CloseGuard {
+ explicit CloseGuard(Stream* stream) : stream(stream) {}
+ ~CloseGuard() { stream->SetClosed(true); }
+ Stream* stream;
+ };
+
+ protected:
+ explicit Stream(SupportedOperations supported_operations = {});
+ Stream(std::optional<bool> can_seek, std::optional<bool> can_read,
+ std::optional<bool> can_write);
+
public:
enum class SeekOrigin { Current, Begin, End };
- Stream() = default;
-
CRU_DELETE_COPY(Stream)
CRU_DELETE_MOVE(Stream)
~Stream() override = default;
public:
- virtual bool CanSeek() = 0;
- virtual Index Seek(Index offset, SeekOrigin origin = SeekOrigin::Current) = 0;
- virtual Index Tell();
- virtual void Rewind();
- virtual Index GetSize();
-
- virtual bool CanRead() = 0;
- virtual Index Read(std::byte* buffer, Index offset, Index size) = 0;
- virtual Index Read(std::byte* buffer, Index size);
-
- virtual bool CanWrite() = 0;
- virtual Index Write(const std::byte* buffer, Index offset, Index size) = 0;
- virtual Index Write(const std::byte* buffer, Index size);
+ bool CanSeek();
+ Index Seek(Index offset, SeekOrigin origin = SeekOrigin::Current);
+ Index Tell();
+ void Rewind();
+ Index GetSize();
+
+ bool CanRead();
+ Index Read(std::byte* buffer, Index offset, Index size);
+ Index Read(std::byte* buffer, Index size);
+ Index Read(char* buffer, Index offset, Index size);
+ Index Read(char* buffer, Index size);
+
+ bool CanWrite();
+ Index Write(const std::byte* buffer, Index offset, Index size);
+ Index Write(const std::byte* buffer, Index size);
Index Write(const char* buffer, Index offset, Index size);
Index Write(const char* buffer, Index size);
+ void Flush();
+ virtual void Close() = 0;
+
virtual Buffer ReadToEnd(Index grow_size = 256);
// Utf8 encoding.
String ReadToEndAsUtf8String();
- virtual void Flush();
+ protected:
+ virtual bool DoCanSeek();
+ virtual bool DoCanRead();
+ virtual bool DoCanWrite();
+ virtual Index DoSeek(Index offset, SeekOrigin origin);
+ virtual Index DoTell();
+ virtual void DoRewind();
+ virtual Index DoGetSize();
+ virtual Index DoRead(std::byte* buffer, Index offset, Index size);
+ virtual Index DoWrite(const std::byte* buffer, Index offset, Index size);
+ virtual void DoFlush();
+
+ void SetSupportedOperations(SupportedOperations supported_operations) {
+ supported_operations_ = std::move(supported_operations);
+ }
+
+ bool GetClosed() { return closed_; }
+ void SetClosed(bool closed) { closed_ = closed; }
+ void CheckClosed() { StreamAlreadyClosedException::Check(closed_); }
- virtual void Close();
+ private:
+ std::optional<SupportedOperations> supported_operations_;
+ bool closed_;
};
} // namespace cru::io