Bulk busy work towards Reader replacement to inject into DataLoader

7 files changed, 430 insertions, 2 deletions

diff --git a/FoundationEx/CMakeLists.txt b/FoundationEx/CMakeLists.txt
index 045b44e..646ee58 100644
--- a/FoundationEx/CMakeLists.txt
+++ b/FoundationEx/CMakeLists.txt
@@ -1,7 +1,13 @@
 project(FoundationEx)
-add_library(${PROJECT_NAME} STATIC src/Reader.cpp src/Text.cpp src/Utils.cpp)
+add_library(
+	${PROJECT_NAME} STATIC
+	src/Reader_.cpp
+	src/Text.cpp
+	src/Utils.cpp
+	src/reader.cpp
+	)
 target_include_directories(${PROJECT_NAME} PUBLIC include)
-add_executable(${PROJECT_NAME}_test test/Text.cpp)
+add_executable(${PROJECT_NAME}_test test/Text.cpp test/reader.cpp)
 target_link_libraries(${PROJECT_NAME}_test PRIVATE ${PROJECT_NAME} GTest::gtest_main)
 generate_emulator(${PROJECT_NAME}_test)
 gtest_discover_tests(${PROJECT_NAME}_test DISCOVERY_TIMEOUT 60)
diff --git a/FoundationEx/include/starshatter/foundation/reader.h b/FoundationEx/include/starshatter/foundation/reader.h
new file mode 100644
index 0000000..7ec81b4
--- /dev/null
+++ b/FoundationEx/include/starshatter/foundation/reader.h
@@ -0,0 +1,83 @@
+/*  Starshatter: The Open Source Project
+    Copyright (c) 2021-2024, Starshatter: The Open Source Project Contributors
+    Copyright (c) 2011-2012, Starshatter OpenSource Distribution Contributors
+    Copyright (c) 1997-2006, Destroyer Studios LLC.
+*/
+
+#pragma once
+
+#include <cstddef>
+#include <memory>
+
+
+namespace starshatter
+{
+namespace foundation
+{
+
+
+using Count = std::size_t;
+using Offset = std::ptrdiff_t;
+
+
+enum class Direction
+{
+	Start,
+	End,
+	Current,
+};
+
+
+template <typename Char>
+struct BaseReader
+{
+	virtual ~BaseReader() = default;
+	virtual bool valid() const = 0;
+	virtual Count available() const = 0;
+	virtual Count seek(Count pos) = 0;
+	virtual Count seek(Offset offset, Direction dir) = 0;
+	virtual Count read(Char* dest) = 0;
+	virtual Count read(Char* dest, Count bytes) = 0;
+	virtual Count peek(Char* dest) const = 0;
+	virtual Count peek(Char* dest, Count bytes) const = 0;
+	virtual const Char* data() const = 0;
+};
+
+
+struct Reader : public BaseReader<char>
+{
+	using Base = std::unique_ptr<BaseReader>;
+	using Chars = std::unique_ptr<const char[]>;
+
+	Reader();
+
+	Reader(const Reader&) = delete;
+	Reader& operator=(const Reader&) = delete;
+
+	Reader(Reader&& other);
+	Reader& operator=(Reader&& other);
+
+	Reader(Base src);
+	Reader(Chars src);
+	Reader(Chars src, Count bytes);
+	Reader(const char* src);
+	Reader(const char* src, Count bytes);
+
+	~Reader() override = default;
+
+	bool valid() const override;
+	Count available() const override;
+	Count seek(Count pos) override;
+	Count seek(Offset offset, Direction dir) override;
+	Count read(char* dest) override;
+	Count read(char* dest, Count bytes) override;
+	Count peek(char* dest) const override;
+	Count peek(char* dest, Count bytes) const override;
+	const char* data() const override;
+private:
+	Base actual;
+};
+
+
+}  // namespace foundation
+}  // namespace starshatter
diff --git a/FoundationEx/src/Reader.cpp b/FoundationEx/src/Reader_.cpp
index c3e33d5..c3e33d5 100644
--- a/FoundationEx/src/Reader.cpp
+++ b/FoundationEx/src/Reader_.cpp
diff --git a/FoundationEx/src/reader.cpp b/FoundationEx/src/reader.cpp
new file mode 100644
index 0000000..7bce34d
--- /dev/null
+++ b/FoundationEx/src/reader.cpp
@@ -0,0 +1,82 @@
+/*  Starshatter: The Open Source Project
+    Copyright (c) 2021-2024, Starshatter: The Open Source Project Contributors
+    Copyright (c) 2011-2012, Starshatter OpenSource Distribution Contributors
+    Copyright (c) 1997-2006, Destroyer Studios LLC.
+*/
+
+#include <starshatter/foundation/reader.h>
+
+#include <memory>
+#include <utility>
+
+#include "reader/buffer.h"
+
+
+namespace starshatter
+{
+namespace foundation
+{
+
+
+Reader::Reader()
+{
+}
+
+
+Reader::Reader(Reader&& other) :
+	actual {std::move(other.actual)}
+{
+}
+
+
+Reader&
+Reader::operator=(Reader&& other)
+{
+	actual = std::move(other.actual);
+	return *this;
+}
+
+
+Reader::Reader(Base src) :
+	actual {std::move(src)}
+{
+}
+
+
+Reader::Reader(Chars src) :
+	actual {std::make_unique<BufferReader<Chars>>(std::move(src))}
+{
+}
+
+
+Reader::Reader(Chars src, Count bytes) :
+	actual {std::make_unique<BufferReader<Chars>>(std::move(src), bytes)}
+{
+}
+
+
+Reader::Reader(const char* src) :
+	actual {std::make_unique<BufferReader<const char*>>(src)}
+{
+}
+
+
+Reader::Reader(const char* src, Count bytes) :
+	actual {std::make_unique<BufferReader<const char*>>(src, bytes)}
+{
+}
+
+
+bool Reader::valid() const { return static_cast<bool>(actual); }
+Count Reader::available() const { return actual->available(); }
+Count Reader::seek(Count pos) { return actual->seek(pos); }
+Count Reader::seek(Offset offset, Direction dir) { return actual->seek(offset, dir); }
+Count Reader::read(char* dest) { return actual->read(dest); }
+Count Reader::read(char* dest, Count bytes) { return actual->read(dest, bytes); }
+Count Reader::peek(char* dest) const { return actual->peek(dest); }
+Count Reader::peek(char* dest, Count bytes) const { return actual->peek(dest, bytes); }
+const char* Reader::data() const { return actual->data(); }
+
+
+}  // namespace foundation
+}  // namespace starshatter
diff --git a/FoundationEx/src/reader/buffer.h b/FoundationEx/src/reader/buffer.h
new file mode 100644
index 0000000..c36310a
--- /dev/null
+++ b/FoundationEx/src/reader/buffer.h
@@ -0,0 +1,51 @@
+/*  Starshatter: The Open Source Project
+    Copyright (c) 2021-2024, Starshatter: The Open Source Project Contributors
+    Copyright (c) 2011-2012, Starshatter OpenSource Distribution Contributors
+    Copyright (c) 1997-2006, Destroyer Studios LLC.
+*/
+
+#pragma once
+
+#include <starshatter/foundation/reader.h>
+
+
+namespace starshatter
+{
+namespace foundation
+{
+
+
+template <typename Source>
+struct BufferReader : public BaseReader<char>
+{
+	BufferReader();
+	BufferReader(Source src);
+	BufferReader(Source src, Count bytes);
+	BufferReader(const BufferReader& other) = default;
+	BufferReader& operator=(const BufferReader& other) = default;
+	BufferReader(BufferReader&& other) = default;
+	BufferReader& operator=(BufferReader&& other) = default;
+	~BufferReader() override = default;
+
+	bool valid() const override;
+	Count available() const override;
+	Count seek(Count pos) override;
+	Count seek(Offset offset, Direction dir) override;
+	Count read(char* dest) override;
+	Count read(char* dest, Count bytes) override;
+	Count peek(char* dest) const override;
+	Count peek(char* dest, Count bytes) const override;
+	const char* data() const override;
+
+private:
+	Source buffer;
+	Count size;
+	Count position;
+};
+
+
+}  // namespace foundation
+}  // namespace starshatter
+
+
+#include "buffer.inl.h"
diff --git a/FoundationEx/src/reader/buffer.inl.h b/FoundationEx/src/reader/buffer.inl.h
new file mode 100644
index 0000000..3b739e4
--- /dev/null
+++ b/FoundationEx/src/reader/buffer.inl.h
@@ -0,0 +1,141 @@
+/*  Starshatter: The Open Source Project
+    Copyright (c) 2021-2024, Starshatter: The Open Source Project Contributors
+    Copyright (c) 2011-2012, Starshatter OpenSource Distribution Contributors
+    Copyright (c) 1997-2006, Destroyer Studios LLC.
+*/
+
+#include <algorithm>
+#include <cstring>
+#include <memory>
+#include <utility>
+
+#include <starshatter/foundation/reader.h>
+
+
+namespace starshatter
+{
+namespace foundation
+{
+
+
+// If extension is needed, use type_traits or update to C++20 and use concepts
+inline bool ok(const char* data) { return data != nullptr; }
+inline bool ok(const std::unique_ptr<const char[]>& data) { return static_cast<bool>(data); }
+inline const char* at(const char* data) { return data; }
+inline const char* at(const std::unique_ptr<const char[]>& data) { return data.get(); }
+
+
+template <typename Source>
+BufferReader<Source>::BufferReader()
+{
+}
+
+
+template <typename Source>
+BufferReader<Source>::BufferReader(Source src) :
+	buffer {std::move(src)},
+	size {std::strlen(at(buffer)) + 1}
+{
+}
+
+
+template <typename Source>
+BufferReader<Source>::BufferReader(Source src, Count bytes) :
+	buffer {std::move(src)},
+	size {bytes}
+{
+}
+
+
+template <typename Source>
+bool
+BufferReader<Source>::valid() const
+{
+	return ok(buffer);
+}
+
+
+template <typename Source>
+Count
+BufferReader<Source>::available() const
+{
+	return size - position;
+}
+
+
+template <typename Source>
+Count
+BufferReader<Source>::seek(Count pos)
+{
+	position = pos;
+	if (position > size)
+		position = size;
+	return position;
+}
+
+
+template <typename Source>
+Count
+BufferReader<Source>::seek(Offset offset, Direction dir)
+{
+	switch (dir) {
+	case Direction::Start:
+		break;  // no-op
+	case Direction::End:
+		offset = size + offset;
+		break;
+	case Direction::Current:
+		offset = position + offset;
+		break;
+	}
+	position = static_cast<Count>(std::clamp<Offset>(offset, 0, size));
+	return position;
+}
+
+
+template <typename Source>
+Count
+BufferReader<Source>::read(char* dest)
+{
+	return read(dest, available());
+}
+
+
+template <typename Source>
+Count
+BufferReader<Source>::read(char* dest, Count bytes)
+{
+	bytes = peek(dest, bytes);
+	position += bytes;
+	return bytes;
+}
+
+
+template <typename Source>
+Count
+BufferReader<Source>::peek(char* dest) const
+{
+	return peek(dest, available());
+}
+
+
+template <typename Source>
+Count
+BufferReader<Source>::peek(char* dest, Count bytes) const
+{
+	bytes = std::min(bytes, available());
+	std::copy(data(), data() + bytes, dest);
+	return bytes;
+}
+
+
+template <typename Source>
+const char*
+BufferReader<Source>::data() const
+{
+	return at(buffer) + position;
+}
+
+
+}  // namespace foundation
+}  // namespace starshatter
diff --git a/FoundationEx/test/reader.cpp b/FoundationEx/test/reader.cpp
new file mode 100644
index 0000000..395ad81
--- /dev/null
+++ b/FoundationEx/test/reader.cpp
@@ -0,0 +1,65 @@
+#include <cstring>
+#include <memory>
+#include <utility>
+#include <vector>
+
+#include <gtest/gtest.h>
+
+#include <starshatter/foundation/reader.h>
+#include <Text.h>
+
+
+using starshatter::foundation::Direction;
+using starshatter::foundation::Reader;
+
+
+TEST(FoundationEx, ReadFromView)
+{
+	Reader reader("Hello, World!");
+	ASSERT_TRUE(reader.valid());
+	std::vector<char> buffer(reader.available());
+	ASSERT_EQ(14, buffer.size());
+	const auto bytes = reader.read(buffer.data());
+	ASSERT_EQ(14, bytes);
+	ASSERT_EQ(0, reader.available());
+	ASSERT_STREQ("Hello, World!", buffer.data());
+}
+
+
+TEST(FoundationEx, PeekIntoView)
+{
+	Reader reader("Hello, World!");
+	ASSERT_TRUE(reader.valid());
+	reader.seek(7);
+	std::vector<char> buffer(reader.available());
+	ASSERT_EQ(7, buffer.size());
+	const auto bytes = reader.peek(buffer.data());
+	ASSERT_EQ(7, bytes);
+	ASSERT_EQ(7, reader.available());
+	ASSERT_STREQ("World!", buffer.data());
+}
+
+
+TEST(FoundationEx, RelativeSeek)
+{
+	Reader reader("Hello, World!");
+	ASSERT_TRUE(reader.valid());
+	ASSERT_EQ(11, reader.seek(-3, Direction::End));
+	EXPECT_EQ(8, reader.seek(-3, Direction::Current));
+	ASSERT_EQ(5, reader.seek(5, Direction::Start));
+	EXPECT_EQ(7, reader.seek(2, Direction::Current));
+}
+
+
+TEST(FoundationEx, CreateTextFromReader)
+{
+	const char* ref = "Hello!";
+	const auto size = 7;
+	auto ptr = std::make_unique<char[]>(size);
+	for (auto i = 0; i < size; ++i)
+		ptr[i] = ref[i];
+	Reader reader(std::move(ptr));
+	ASSERT_TRUE(reader.valid());
+	Text text(reader.data());
+	ASSERT_EQ("Hello!", text);
+}