From 8d78727d6e7badca16ba7a1328643928a0039569 Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Mon, 18 Nov 2024 18:02:09 +0100
Subject: move utilities from loek/audio

---
 src/crepe/util/CMakeLists.txt  |  2 ++
 src/crepe/util/OptionalRef.h   | 41 ++++++++++++++++++++++++++
 src/crepe/util/OptionalRef.hpp | 67 ++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 110 insertions(+)
 create mode 100644 src/crepe/util/OptionalRef.h
 create mode 100644 src/crepe/util/OptionalRef.hpp

(limited to 'src/crepe/util')

diff --git a/src/crepe/util/CMakeLists.txt b/src/crepe/util/CMakeLists.txt
index 4be738a..94ed906 100644
--- a/src/crepe/util/CMakeLists.txt
+++ b/src/crepe/util/CMakeLists.txt
@@ -9,5 +9,7 @@ target_sources(crepe PUBLIC FILE_SET HEADERS FILES
 	Log.hpp
 	Proxy.h
 	Proxy.hpp
+	OptionalRef.h
+	OptionalRef.hpp
 )
 
diff --git a/src/crepe/util/OptionalRef.h b/src/crepe/util/OptionalRef.h
new file mode 100644
index 0000000..1ad3a6d
--- /dev/null
+++ b/src/crepe/util/OptionalRef.h
@@ -0,0 +1,41 @@
+#pragma once
+
+namespace crepe {
+
+/**
+ * \brief Optional reference utility
+ *
+ * This class doesn't need to know the full definition of \c T to be used.
+ *
+ * \tparam T Value type
+ */
+template <typename T>
+class OptionalRef {
+public:
+	OptionalRef() = default;
+	OptionalRef(T &);
+  OptionalRef<T> & operator=(T &);
+	explicit operator bool() const noexcept;
+
+	void set(T &) noexcept;
+	T & get() const;
+	void clear() noexcept;
+
+  OptionalRef(const OptionalRef<T> &);
+  OptionalRef(OptionalRef<T> &&);
+  OptionalRef<T> & operator=(const OptionalRef<T> &);
+  OptionalRef<T> & operator=(OptionalRef<T> &&);
+
+private:
+	/**
+	 * \brief Reference to the value of type \c T
+	 *
+	 * \note This raw pointer is *not* managed, and only used as a reference!
+	 */
+	T * ref = nullptr;
+};
+
+}
+
+#include "OptionalRef.hpp"
+
diff --git a/src/crepe/util/OptionalRef.hpp b/src/crepe/util/OptionalRef.hpp
new file mode 100644
index 0000000..7b201b0
--- /dev/null
+++ b/src/crepe/util/OptionalRef.hpp
@@ -0,0 +1,67 @@
+#pragma once
+
+#include <stdexcept>
+
+#include "OptionalRef.h"
+
+namespace crepe {
+
+template <typename T>
+OptionalRef<T>::OptionalRef(T & ref) {
+	this->set(ref);
+}
+
+template <typename T>
+OptionalRef<T>::OptionalRef(const OptionalRef<T> & other) {
+	this->ref = other.ref;
+}
+
+template <typename T>
+OptionalRef<T>::OptionalRef(OptionalRef<T> && other) {
+	this->ref = other.ref;
+	other.clear();
+}
+
+template <typename T>
+OptionalRef<T> & OptionalRef<T>::operator=(const OptionalRef<T> & other) {
+	this->ref = other.ref;
+	return *this;
+}
+
+template <typename T>
+OptionalRef<T> & OptionalRef<T>::operator=(OptionalRef<T> && other) {
+	this->ref = other.ref;
+	other.clear();
+	return *this;
+}
+
+template <typename T>
+T & OptionalRef<T>::get() const {
+	if (this->ref == nullptr)
+		throw std::runtime_error("OptionalRef: attempt to dereference nullptr");
+	return *this->ref;
+}
+
+template <typename T>
+void OptionalRef<T>::set(T & ref) noexcept {
+	this->ref = &ref;
+}
+
+template <typename T>
+void OptionalRef<T>::clear() noexcept {
+	this->ref = nullptr;
+}
+
+template <typename T>
+OptionalRef<T> & OptionalRef<T>::operator=(T & ref) {
+	this->set(ref);
+	return *this;
+}
+
+template <typename T>
+OptionalRef<T>::operator bool() const noexcept {
+	return this->ref != nullptr;
+}
+
+}
+
-- 
cgit v1.2.3


From 9770b548c5619821d7b6ea7a017df2b5a6898d0a Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Mon, 18 Nov 2024 18:10:31 +0100
Subject: add doxygen comments

---
 src/crepe/api/Asset.h        | 10 +++++++++-
 src/crepe/util/OptionalRef.h | 37 +++++++++++++++++++++++++++++++++++--
 2 files changed, 44 insertions(+), 3 deletions(-)

(limited to 'src/crepe/util')

diff --git a/src/crepe/api/Asset.h b/src/crepe/api/Asset.h
index 05dccba..685dd3a 100644
--- a/src/crepe/api/Asset.h
+++ b/src/crepe/api/Asset.h
@@ -1,7 +1,6 @@
 #pragma once
 
 #include <string>
-#include <unordered_map>
 
 namespace crepe {
 
@@ -52,7 +51,16 @@ private:
 
 namespace std {
 
+//! Hash helper struct
 template<> struct hash<const crepe::Asset> {
+	/**
+	 * \brief Hash operator for crepe::Asset
+	 *
+	 * This function hashes a crepe::Asset instance, allowing it to be used as a key in an \c
+	 * std::unordered_map.
+	 *
+	 * \returns Hash value
+	 */
 	size_t operator()(const crepe::Asset & asset) const noexcept;
 };
 
diff --git a/src/crepe/util/OptionalRef.h b/src/crepe/util/OptionalRef.h
index 1ad3a6d..8417a25 100644
--- a/src/crepe/util/OptionalRef.h
+++ b/src/crepe/util/OptionalRef.h
@@ -12,18 +12,51 @@ namespace crepe {
 template <typename T>
 class OptionalRef {
 public:
+	//! Initialize empty (nonexistant) reference
 	OptionalRef() = default;
-	OptionalRef(T &);
-  OptionalRef<T> & operator=(T &);
+	//! Initialize reference with value
+	OptionalRef(T & ref);
+	/**
+	 * \brief Assign new reference
+	 *
+	 * \param ref Reference to assign
+	 *
+	 * \return Reference to this (required for operator)
+	 */
+  OptionalRef<T> & operator=(T & ref);
+	/**
+	 * \brief Check if this reference is not empty
+	 *
+	 * \returns `true` if reference is set, or `false` if it is not
+	 */
 	explicit operator bool() const noexcept;
 
+	/**
+	 * \brief Assign new reference
+	 *
+	 * \param ref Reference to assign
+	 */
 	void set(T &) noexcept;
+	/**
+	 * \brief Retrieve this reference
+	 *
+	 * \returns Internal reference if it is set
+	 *
+	 * \throws std::runtime_error if this function is called while the reference it not set
+	 */
 	T & get() const;
+	/**
+	 * \brief Make this reference empty
+	 */
 	void clear() noexcept;
 
+	//! Copy constructor
   OptionalRef(const OptionalRef<T> &);
+	//! Move constructor
   OptionalRef(OptionalRef<T> &&);
+	//! Copy assignment
   OptionalRef<T> & operator=(const OptionalRef<T> &);
+	//! Move assignment
   OptionalRef<T> & operator=(OptionalRef<T> &&);
 
 private:
-- 
cgit v1.2.3


From 02845c3d25130e9473604cb2eeee42a7a7a8eadf Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Wed, 20 Nov 2024 14:01:31 +0100
Subject: `make format`

---
 src/crepe/api/Asset.cpp        | 15 +++++----------
 src/crepe/api/Asset.h          |  8 ++++----
 src/crepe/types.h              |  4 ++--
 src/crepe/util/OptionalRef.h   | 13 ++++++-------
 src/crepe/util/OptionalRef.hpp |  3 +--
 src/example/rendering.cpp      |  5 ++---
 src/test/AssetTest.cpp         | 13 +++----------
 src/test/OptionalRefTest.cpp   |  1 -
 8 files changed, 23 insertions(+), 39 deletions(-)

(limited to 'src/crepe/util')

diff --git a/src/crepe/api/Asset.cpp b/src/crepe/api/Asset.cpp
index 5271cf7..3fe3ceb 100644
--- a/src/crepe/api/Asset.cpp
+++ b/src/crepe/api/Asset.cpp
@@ -8,8 +8,8 @@
 using namespace crepe;
 using namespace std;
 
-Asset::Asset(const string & src) : src(find_asset(src)) { }
-Asset::Asset(const char * src) : src(find_asset(src)) { }
+Asset::Asset(const string & src) : src(find_asset(src)) {}
+Asset::Asset(const char * src) : src(find_asset(src)) {}
 
 const string & Asset::get_path() const noexcept { return this->src; }
 
@@ -22,14 +22,12 @@ string Asset::find_asset(const string & src) const {
 
 	// absolute paths do not need to be resolved, only canonicalized
 	filesystem::path path = src;
-	if (path.is_absolute())
-		return filesystem::canonical(path);
+	if (path.is_absolute()) return filesystem::canonical(path);
 
 	// find directory matching root_pattern
 	filesystem::path root = this->whereami();
 	while (1) {
-		if (filesystem::exists(root / root_pattern))
-			break;
+		if (filesystem::exists(root / root_pattern)) break;
 		if (!root.has_parent_path())
 			throw runtime_error(format("Asset: Cannot find root pattern ({})", root_pattern));
 		root = root.parent_path();
@@ -48,11 +46,8 @@ string Asset::whereami() const noexcept {
 	return path;
 }
 
-bool Asset::operator==(const Asset & other) const noexcept {
-	return this->src == other.src;
-}
+bool Asset::operator==(const Asset & other) const noexcept { return this->src == other.src; }
 
 size_t std::hash<const Asset>::operator()(const Asset & asset) const noexcept {
 	return std::hash<string>{}(asset.get_path());
 };
-
diff --git a/src/crepe/api/Asset.h b/src/crepe/api/Asset.h
index 685dd3a..77596ac 100644
--- a/src/crepe/api/Asset.h
+++ b/src/crepe/api/Asset.h
@@ -33,7 +33,7 @@ public:
 	 * \param other Possibly different instance of \c Asset to test equality against
 	 * \return True if \c this and \c other are equal
 	 */
-	bool operator == (const Asset & other) const noexcept;
+	bool operator==(const Asset & other) const noexcept;
 
 private:
 	//! path to asset
@@ -52,7 +52,8 @@ private:
 namespace std {
 
 //! Hash helper struct
-template<> struct hash<const crepe::Asset> {
+template <>
+struct hash<const crepe::Asset> {
 	/**
 	 * \brief Hash operator for crepe::Asset
 	 *
@@ -64,5 +65,4 @@ template<> struct hash<const crepe::Asset> {
 	size_t operator()(const crepe::Asset & asset) const noexcept;
 };
 
-}
-
+} // namespace std
diff --git a/src/crepe/types.h b/src/crepe/types.h
index 86730cc..914c76c 100644
--- a/src/crepe/types.h
+++ b/src/crepe/types.h
@@ -1,8 +1,8 @@
 #pragma once
 
 #include <cstdint>
-#include <vector>
 #include <functional>
+#include <vector>
 
 namespace crepe {
 
@@ -13,4 +13,4 @@ typedef uint32_t game_object_id_t;
 template <typename T>
 using RefVector = std::vector<std::reference_wrapper<T>>;
 
-}
+} // namespace crepe
diff --git a/src/crepe/util/OptionalRef.h b/src/crepe/util/OptionalRef.h
index 8417a25..0a94ae5 100644
--- a/src/crepe/util/OptionalRef.h
+++ b/src/crepe/util/OptionalRef.h
@@ -23,7 +23,7 @@ public:
 	 *
 	 * \return Reference to this (required for operator)
 	 */
-  OptionalRef<T> & operator=(T & ref);
+	OptionalRef<T> & operator=(T & ref);
 	/**
 	 * \brief Check if this reference is not empty
 	 *
@@ -51,13 +51,13 @@ public:
 	void clear() noexcept;
 
 	//! Copy constructor
-  OptionalRef(const OptionalRef<T> &);
+	OptionalRef(const OptionalRef<T> &);
 	//! Move constructor
-  OptionalRef(OptionalRef<T> &&);
+	OptionalRef(OptionalRef<T> &&);
 	//! Copy assignment
-  OptionalRef<T> & operator=(const OptionalRef<T> &);
+	OptionalRef<T> & operator=(const OptionalRef<T> &);
 	//! Move assignment
-  OptionalRef<T> & operator=(OptionalRef<T> &&);
+	OptionalRef<T> & operator=(OptionalRef<T> &&);
 
 private:
 	/**
@@ -68,7 +68,6 @@ private:
 	T * ref = nullptr;
 };
 
-}
+} // namespace crepe
 
 #include "OptionalRef.hpp"
-
diff --git a/src/crepe/util/OptionalRef.hpp b/src/crepe/util/OptionalRef.hpp
index 7b201b0..ee41f61 100644
--- a/src/crepe/util/OptionalRef.hpp
+++ b/src/crepe/util/OptionalRef.hpp
@@ -63,5 +63,4 @@ OptionalRef<T>::operator bool() const noexcept {
 	return this->ref != nullptr;
 }
 
-}
-
+} // namespace crepe
diff --git a/src/example/rendering.cpp b/src/example/rendering.cpp
index 522ec0f..01794f8 100644
--- a/src/example/rendering.cpp
+++ b/src/example/rendering.cpp
@@ -30,9 +30,8 @@ int main() {
 	// Normal adding components
 	{
 		Color color(0, 0, 0, 0);
-		Sprite & sprite
-			= obj.add_component<Sprite>(make_shared<Texture>("asset/texture/img.png"),
-										color, FlipSettings{false, false});
+		Sprite & sprite = obj.add_component<Sprite>(
+			make_shared<Texture>("asset/texture/img.png"), color, FlipSettings{false, false});
 		sprite.sorting_in_layer = 2;
 		sprite.order_in_layer = 1;
 		obj.add_component<Camera>(Color::RED);
diff --git a/src/test/AssetTest.cpp b/src/test/AssetTest.cpp
index 563a253..8aa7629 100644
--- a/src/test/AssetTest.cpp
+++ b/src/test/AssetTest.cpp
@@ -10,18 +10,12 @@ using namespace testing;
 class AssetTest : public Test {
 public:
 	Config & cfg = Config::get_instance();
-	void SetUp() override {
-		this->cfg.asset.root_pattern = ".crepe-root";
-	}
+	void SetUp() override { this->cfg.asset.root_pattern = ".crepe-root"; }
 };
 
-TEST_F(AssetTest, Existant) {
-	ASSERT_NO_THROW(Asset{"asset/texture/img.png"});
-}
+TEST_F(AssetTest, Existant) { ASSERT_NO_THROW(Asset{"asset/texture/img.png"}); }
 
-TEST_F(AssetTest, Nonexistant) {
-	ASSERT_ANY_THROW(Asset{"asset/nonexistant"});
-}
+TEST_F(AssetTest, Nonexistant) { ASSERT_ANY_THROW(Asset{"asset/nonexistant"}); }
 
 TEST_F(AssetTest, Rootless) {
 	cfg.asset.root_pattern.clear();
@@ -30,4 +24,3 @@ TEST_F(AssetTest, Rootless) {
 	Asset asset{arbitrary};
 	ASSERT_EQ(arbitrary, asset.get_path());
 }
-
diff --git a/src/test/OptionalRefTest.cpp b/src/test/OptionalRefTest.cpp
index 219ccca..2072d56 100644
--- a/src/test/OptionalRefTest.cpp
+++ b/src/test/OptionalRefTest.cpp
@@ -35,4 +35,3 @@ TEST(OptionalRefTest, Implicit) {
 	EXPECT_TRUE(ref);
 	ASSERT_NO_THROW(ref.get());
 }
-
-- 
cgit v1.2.3


From 22a7e9f3c40b4b6eb68a5343e4870e76c4bfcf63 Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Wed, 20 Nov 2024 14:24:08 +0100
Subject: process feedback on #39

---
 readme.md                      |  7 +++++++
 src/crepe/ComponentManager.h   |  5 +++--
 src/crepe/ComponentManager.hpp |  9 ++++-----
 src/crepe/api/Asset.cpp        |  5 +++--
 src/crepe/api/Asset.h          | 16 ++++++++++++++++
 src/crepe/system/System.h      |  2 --
 src/crepe/util/OptionalRef.h   | 11 +----------
 src/crepe/util/OptionalRef.hpp | 24 ------------------------
 8 files changed, 34 insertions(+), 45 deletions(-)

(limited to 'src/crepe/util')

diff --git a/readme.md b/readme.md
index c83853d..d309b30 100644
--- a/readme.md
+++ b/readme.md
@@ -32,6 +32,7 @@ This project uses the following libraries
 |`SoLoud`|(latest git `master` version)|
 |Google Test (`GTest`)|1.15.2|
 |Berkeley DB (`libdb`)|5.3.21|
+|Where Am I?|(latest git `master` version)
 
 > [!NOTE]
 > Most of these libraries are likely available from your package manager if you
@@ -49,6 +50,11 @@ $ git submodule update --init --recursive --depth 1
 
 Then, follow these steps for each library you want to install:
 
+> [!IMPORTANT]
+> A dollar sign prompt (`$`) indicates commands to be run as a regular user,
+> while a hashtag (`#`) is used to denote commands that must be run with
+> privileges (e.g. as root or using `sudo`).
+
 1. Change into the library folder (run **one** of these):
    ```
    $ cd lib/googletest
@@ -56,6 +62,7 @@ Then, follow these steps for each library you want to install:
    $ cd lib/soloud/contrib
    $ cd lib/sdl_image
    $ cd lib/sdl_ttf
+   $ cd lib/whereami
    ```
 2. Use CMake to configure the build, run the build and install (run **all** of
    these):
diff --git a/src/crepe/ComponentManager.h b/src/crepe/ComponentManager.h
index 2107453..0956d1e 100644
--- a/src/crepe/ComponentManager.h
+++ b/src/crepe/ComponentManager.h
@@ -8,6 +8,7 @@
 #include "api/Vector2.h"
 
 #include "Component.h"
+#include "types.h"
 
 namespace crepe {
 
@@ -112,7 +113,7 @@ public:
 	 * \return A vector of all components of the specific type and id
 	 */
 	template <typename T>
-	std::vector<std::reference_wrapper<T>> get_components_by_id(game_object_id_t id) const;
+	RefVector<T> get_components_by_id(game_object_id_t id) const;
 	/**
 	 * \brief Get all components of a specific type
 	 * 
@@ -122,7 +123,7 @@ public:
 	 * \return A vector of all components of the specific type
 	 */
 	template <typename T>
-	std::vector<std::reference_wrapper<T>> get_components_by_type() const;
+	RefVector<T> get_components_by_type() const;
 
 private:
 	/**
diff --git a/src/crepe/ComponentManager.hpp b/src/crepe/ComponentManager.hpp
index be99cac..4d5eaf4 100644
--- a/src/crepe/ComponentManager.hpp
+++ b/src/crepe/ComponentManager.hpp
@@ -81,15 +81,14 @@ void ComponentManager::delete_components() {
 }
 
 template <typename T>
-std::vector<std::reference_wrapper<T>>
-ComponentManager::get_components_by_id(game_object_id_t id) const {
+RefVector<T> ComponentManager::get_components_by_id(game_object_id_t id) const {
 	using namespace std;
 
 	// Determine the type of T (this is used as the key of the unordered_map<>)
 	type_index type = typeid(T);
 
 	// Create an empty vector<>
-	vector<reference_wrapper<T>> component_vector;
+	RefVector<T> component_vector;
 
 	if (this->components.find(type) == this->components.end()) return component_vector;
 
@@ -114,14 +113,14 @@ ComponentManager::get_components_by_id(game_object_id_t id) const {
 }
 
 template <typename T>
-std::vector<std::reference_wrapper<T>> ComponentManager::get_components_by_type() const {
+RefVector<T> ComponentManager::get_components_by_type() const {
 	using namespace std;
 
 	// Determine the type of T (this is used as the key of the unordered_map<>)
 	type_index type = typeid(T);
 
 	// Create an empty vector<>
-	vector<reference_wrapper<T>> component_vector;
+	RefVector<T> component_vector;
 
 	// Find the type (in the unordered_map<>)
 	if (this->components.find(type) == this->components.end()) return component_vector;
diff --git a/src/crepe/api/Asset.cpp b/src/crepe/api/Asset.cpp
index 3fe3ceb..e148367 100644
--- a/src/crepe/api/Asset.cpp
+++ b/src/crepe/api/Asset.cpp
@@ -2,9 +2,10 @@
 #include <stdexcept>
 #include <whereami.h>
 
-#include "Asset.h"
 #include "api/Config.h"
 
+#include "Asset.h"
+
 using namespace crepe;
 using namespace std;
 
@@ -15,7 +16,7 @@ const string & Asset::get_path() const noexcept { return this->src; }
 
 string Asset::find_asset(const string & src) const {
 	auto & cfg = Config::get_instance();
-	auto & root_pattern = cfg.asset.root_pattern;
+	string & root_pattern = cfg.asset.root_pattern;
 
 	// if root_pattern is empty, find_asset must return all paths as-is
 	if (root_pattern.empty()) return src;
diff --git a/src/crepe/api/Asset.h b/src/crepe/api/Asset.h
index 77596ac..bfd0ac7 100644
--- a/src/crepe/api/Asset.h
+++ b/src/crepe/api/Asset.h
@@ -40,6 +40,22 @@ private:
 	const std::string src;
 
 private:
+	/**
+	 * \brief Locate asset path, or throw exception if it cannot be found
+	 *
+	 * This function resolves asset locations relative to crepe::Config::root_pattern if it is
+	 * set and \p src is a relative path. If \p src is an absolute path, it is canonicalized.
+	 * This function only returns if the file can be found.
+	 *
+	 * \param src Arbitrary path to resource file
+	 *
+	 * \returns \p src if crepe::Config::root_pattern is empty
+	 * \returns Canonical path to \p src
+	 *
+	 * \throws std::runtime_error if root_pattern cannot be found
+	 * \throws std::filesystem::filesystem_error if the resolved path does not exist
+	 * \throws std::filesystem::filesystem_error if the path cannot be canonicalized
+	 */
 	std::string find_asset(const std::string & src) const;
 	/**
 	 * \returns The path to the current executable
diff --git a/src/crepe/system/System.h b/src/crepe/system/System.h
index 36f7edc..28ea20e 100644
--- a/src/crepe/system/System.h
+++ b/src/crepe/system/System.h
@@ -1,7 +1,5 @@
 #pragma once
 
-#include "../ComponentManager.h"
-
 namespace crepe {
 
 class ComponentManager;
diff --git a/src/crepe/util/OptionalRef.h b/src/crepe/util/OptionalRef.h
index 0a94ae5..57f9635 100644
--- a/src/crepe/util/OptionalRef.h
+++ b/src/crepe/util/OptionalRef.h
@@ -36,7 +36,7 @@ public:
 	 *
 	 * \param ref Reference to assign
 	 */
-	void set(T &) noexcept;
+	void set(T & ref) noexcept;
 	/**
 	 * \brief Retrieve this reference
 	 *
@@ -50,15 +50,6 @@ public:
 	 */
 	void clear() noexcept;
 
-	//! Copy constructor
-	OptionalRef(const OptionalRef<T> &);
-	//! Move constructor
-	OptionalRef(OptionalRef<T> &&);
-	//! Copy assignment
-	OptionalRef<T> & operator=(const OptionalRef<T> &);
-	//! Move assignment
-	OptionalRef<T> & operator=(OptionalRef<T> &&);
-
 private:
 	/**
 	 * \brief Reference to the value of type \c T
diff --git a/src/crepe/util/OptionalRef.hpp b/src/crepe/util/OptionalRef.hpp
index ee41f61..71e2a39 100644
--- a/src/crepe/util/OptionalRef.hpp
+++ b/src/crepe/util/OptionalRef.hpp
@@ -11,30 +11,6 @@ OptionalRef<T>::OptionalRef(T & ref) {
 	this->set(ref);
 }
 
-template <typename T>
-OptionalRef<T>::OptionalRef(const OptionalRef<T> & other) {
-	this->ref = other.ref;
-}
-
-template <typename T>
-OptionalRef<T>::OptionalRef(OptionalRef<T> && other) {
-	this->ref = other.ref;
-	other.clear();
-}
-
-template <typename T>
-OptionalRef<T> & OptionalRef<T>::operator=(const OptionalRef<T> & other) {
-	this->ref = other.ref;
-	return *this;
-}
-
-template <typename T>
-OptionalRef<T> & OptionalRef<T>::operator=(OptionalRef<T> && other) {
-	this->ref = other.ref;
-	other.clear();
-	return *this;
-}
-
 template <typename T>
 T & OptionalRef<T>::get() const {
 	if (this->ref == nullptr)
-- 
cgit v1.2.3


From d9a51069366650051e644453f5d3ac90f2ab29b5 Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Wed, 20 Nov 2024 16:29:48 +0100
Subject: turn examples into unit tests

---
 src/crepe/util/Proxy.h       |  2 ++
 src/crepe/util/Proxy.hpp     |  6 +++++
 src/example/CMakeLists.txt   |  3 ---
 src/example/log.cpp          | 28 -------------------
 src/example/proxy.cpp        | 45 -------------------------------
 src/example/script.cpp       | 49 ---------------------------------
 src/test/CMakeLists.txt      |  1 +
 src/test/ValueBrokerTest.cpp | 64 ++++++++++++++++++++++++++++++++++++++++++++
 8 files changed, 73 insertions(+), 125 deletions(-)
 delete mode 100644 src/example/log.cpp
 delete mode 100644 src/example/proxy.cpp
 delete mode 100644 src/example/script.cpp
 create mode 100644 src/test/ValueBrokerTest.cpp

(limited to 'src/crepe/util')

diff --git a/src/crepe/util/Proxy.h b/src/crepe/util/Proxy.h
index b34f7c6..789144a 100644
--- a/src/crepe/util/Proxy.h
+++ b/src/crepe/util/Proxy.h
@@ -15,6 +15,8 @@ namespace crepe {
 template <typename T>
 class Proxy {
 public:
+	//! Set operator
+	Proxy & operator=(Proxy &);
 	//! Set operator
 	Proxy & operator=(const T &);
 	//! Get operator
diff --git a/src/crepe/util/Proxy.hpp b/src/crepe/util/Proxy.hpp
index b9923db..ef2b69f 100644
--- a/src/crepe/util/Proxy.hpp
+++ b/src/crepe/util/Proxy.hpp
@@ -13,6 +13,12 @@ Proxy<T> & Proxy<T>::operator=(const T & val) {
 	return *this;
 }
 
+template <typename T>
+Proxy<T> & Proxy<T>::operator=(Proxy & proxy) {
+	this->broker.set(T(proxy));
+	return *this;
+}
+
 template <typename T>
 Proxy<T>::operator const T &() {
 	return this->broker.get();
diff --git a/src/example/CMakeLists.txt b/src/example/CMakeLists.txt
index 30432e5..f21bd24 100644
--- a/src/example/CMakeLists.txt
+++ b/src/example/CMakeLists.txt
@@ -17,13 +17,10 @@ function(add_example target_name)
 endfunction()
 
 add_example(audio_internal)
-add_example(script)
-add_example(log)
 add_example(rendering)
 add_example(asset_manager)
 add_example(physics)
 add_example(savemgr)
-add_example(proxy)
 add_example(db)
 add_example(particles)
 add_example(gameloop)
diff --git a/src/example/log.cpp b/src/example/log.cpp
deleted file mode 100644
index 5baa021..0000000
--- a/src/example/log.cpp
+++ /dev/null
@@ -1,28 +0,0 @@
-/** \file
- * 
- * Standalone example for usage of the logging functions
- */
-
-#include <crepe/api/Config.h>
-#include <crepe/util/Log.h>
-
-using namespace crepe;
-
-// unrelated setup code
-int _ = []() {
-	// make sure all log messages get printed
-	auto & cfg = Config::get_instance();
-	cfg.log.level = Log::Level::TRACE;
-
-	return 0; // satisfy compiler
-}();
-
-int main() {
-	dbg_trace();
-	dbg_log("debug message");
-	Log::logf("info message with variable: {}", 3);
-	Log::logf(Log::Level::WARNING, "warning");
-	Log::logf(Log::Level::ERROR, "error");
-
-	return 0;
-}
diff --git a/src/example/proxy.cpp b/src/example/proxy.cpp
deleted file mode 100644
index 69451f8..0000000
--- a/src/example/proxy.cpp
+++ /dev/null
@@ -1,45 +0,0 @@
-/** \file
- * 
- * Standalone example for usage of the proxy type
- */
-
-#include <crepe/ValueBroker.h>
-#include <crepe/api/Config.h>
-#include <crepe/util/Log.h>
-#include <crepe/util/Proxy.h>
-
-using namespace std;
-using namespace crepe;
-
-void test_ro_ref(const int & val) {}
-void test_rw_ref(int & val) {}
-void test_ro_val(int val) {}
-
-int main() {
-	auto & cfg = Config::get_instance();
-	cfg.log.level = Log::Level::DEBUG;
-
-	int real_value = 0;
-
-	ValueBroker<int> broker{
-		[&real_value](const int & target) {
-			dbg_logf("set {} to {}", real_value, target);
-			real_value = target;
-		},
-		[&real_value]() -> const int & {
-			dbg_logf("get {}", real_value);
-			return real_value;
-		},
-	};
-
-	Proxy<int> proxy{broker};
-
-	broker.set(54);
-	proxy = 84;
-
-	test_ro_ref(proxy); // this is allowed
-	// test_rw_ref(proxy); // this should throw a compile error
-	test_ro_val(proxy);
-
-	return 0;
-}
diff --git a/src/example/script.cpp b/src/example/script.cpp
deleted file mode 100644
index a23295b..0000000
--- a/src/example/script.cpp
+++ /dev/null
@@ -1,49 +0,0 @@
-/** \file
- * 
- * Standalone example for usage of the script component and system
- */
-
-#include <crepe/ComponentManager.h>
-#include <crepe/system/ScriptSystem.h>
-#include <crepe/util/Log.h>
-
-#include <crepe/api/BehaviorScript.h>
-#include <crepe/api/Config.h>
-#include <crepe/api/GameObject.h>
-#include <crepe/api/Script.h>
-#include <crepe/api/Transform.h>
-
-using namespace crepe;
-using namespace std;
-
-// Unrelated stuff that is not part of this POC
-int _ = []() {
-	// Show dbg_trace() output
-	auto & cfg = Config::get_instance();
-	cfg.log.level = Log::Level::TRACE;
-
-	return 0; // satisfy compiler
-}();
-
-// User-defined script:
-class MyScript : public Script {
-	void update() {
-		// Retrieve component from the same GameObject this script is on
-		Transform & test = get_component<Transform>();
-		dbg_logf("Transform({:.2f}, {:.2f})", test.position.x, test.position.y);
-	}
-};
-
-int main() {
-	ComponentManager component_manager{};
-	ScriptSystem system{component_manager};
-
-	// Create game object with Transform and BehaviorScript components
-	GameObject obj = component_manager.new_object("name");
-	obj.add_component<BehaviorScript>().set_script<MyScript>();
-
-	// Update all scripts. This should result in MyScript::update being called
-	system.update();
-
-	return EXIT_SUCCESS;
-}
diff --git a/src/test/CMakeLists.txt b/src/test/CMakeLists.txt
index d56d80f..c1f935d 100644
--- a/src/test/CMakeLists.txt
+++ b/src/test/CMakeLists.txt
@@ -5,5 +5,6 @@ target_sources(test_main PUBLIC
 	ParticleTest.cpp
 	ECSTest.cpp
 	SceneManagerTest.cpp
+	ValueBrokerTest.cpp
 )
 
diff --git a/src/test/ValueBrokerTest.cpp b/src/test/ValueBrokerTest.cpp
new file mode 100644
index 0000000..10a4654
--- /dev/null
+++ b/src/test/ValueBrokerTest.cpp
@@ -0,0 +1,64 @@
+#include <gtest/gtest.h>
+
+#include <crepe/ValueBroker.h>
+#include <crepe/util/Proxy.h>
+
+using namespace std;
+using namespace crepe;
+using namespace testing;
+
+class ValueBrokerTest : public Test {
+public:
+	int read_count = 0;
+	int write_count = 0;
+	int value = 0;
+
+	ValueBroker<int> broker {
+		[this](const int & target) -> void {
+			this->write_count++;
+			this->value = target;
+		},
+		[this]() -> const int & {
+			this->read_count++;
+			return this->value;
+		},
+	};
+	Proxy<int> proxy{broker};
+
+	void SetUp() override {
+		ASSERT_EQ(read_count, 0);
+		ASSERT_EQ(write_count, 0);
+	}
+};
+
+TEST_F(ValueBrokerTest, BrokerWrite) {
+	broker.set(0);
+	EXPECT_EQ(read_count, 0);
+	EXPECT_EQ(write_count, 1);
+}
+
+TEST_F(ValueBrokerTest, BrokerRead) {
+	broker.get();
+	EXPECT_EQ(read_count, 1);
+	EXPECT_EQ(write_count, 0);
+}
+
+TEST_F(ValueBrokerTest, ProxyWrite) {
+	proxy = 0;
+	EXPECT_EQ(read_count, 0);
+	EXPECT_EQ(write_count, 1);
+}
+
+void dummy(int) { }
+TEST_F(ValueBrokerTest, ProxyRead) {
+	dummy(proxy);
+	EXPECT_EQ(read_count, 1);
+	EXPECT_EQ(write_count, 0);
+}
+
+TEST_F(ValueBrokerTest, ProxyReadWrite) {
+	proxy = proxy;
+	ASSERT_EQ(read_count, 1);
+	ASSERT_EQ(write_count, 1);
+}
+
-- 
cgit v1.2.3


From bfb4dffccec0a902586927c41b2454c8ddacd9e3 Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Wed, 20 Nov 2024 19:57:24 +0100
Subject: add Log function to script

---
 src/crepe/api/Script.h   | 33 ++++++++++++++++++++++++++++-----
 src/crepe/api/Script.hpp |  5 +++++
 src/crepe/util/Log.h     | 10 +++++-----
 3 files changed, 38 insertions(+), 10 deletions(-)

(limited to 'src/crepe/util')

diff --git a/src/crepe/api/Script.h b/src/crepe/api/Script.h
index 2b70379..ddb499c 100644
--- a/src/crepe/api/Script.h
+++ b/src/crepe/api/Script.h
@@ -22,7 +22,11 @@ class ComponentManager;
 class Script {
 protected:
 	/**
-	 * \brief Script initialization function
+	 * \name Interface functions
+	 * \{
+	 */
+	/**
+	 * \brief Script initialization function (empty by default)
 	 *
 	 * This function is called during the ScriptSystem::update() routine *before*
 	 * Script::update() if it (a) has not yet been called and (b) the \c BehaviorScript component
@@ -30,24 +34,32 @@ protected:
 	 */
 	virtual void init() {}
 	/**
-	 * \brief Script update function
+	 * \brief Script update function (empty by default)
 	 *
 	 * This function is called during the ScriptSystem::update() routine if the \c BehaviorScript
 	 * component holding this script instance is active.
 	 */
 	virtual void update() {}
+	//! \}
+
 	//! ScriptSystem calls \c init() and \c update()
 	friend class crepe::ScriptSystem;
 
 protected:
 	/**
-	 * \brief Get single component of type \c T on this game object (utility)
+	 * \name Utility functions
+	 * \{
+	 */
+
+	/**
+	 * \brief Get single component of type \c T on this game object
 	 *
 	 * \tparam T Type of component
 	 *
 	 * \returns Reference to component
 	 *
-	 * \throws nullptr if this game object does not have a component matching type \c T
+	 * \throws std::runtime_error if this game object does not have a component matching type \c
+	 * T
 	 */
 	template <typename T>
 	T & get_component() const;
@@ -55,7 +67,7 @@ protected:
 	// cause compile-time errors
 
 	/**
-	 * \brief Get all components of type \c T on this game object (utility)
+	 * \brief Get all components of type \c T on this game object
 	 *
 	 * \tparam T Type of component
 	 *
@@ -64,6 +76,17 @@ protected:
 	template <typename T>
 	std::vector<std::reference_wrapper<T>> get_components() const;
 
+	/**
+	 * \brief Log a message using Log::logf
+	 *
+	 * \tparam Args Log::logf parameters
+	 * \param args  Log::logf parameters
+	 */
+	template <typename... Args>
+	void logf(Args &&... args);
+
+	//! \}
+
 protected:
 	// NOTE: Script must have a constructor without arguments so the game programmer doesn't need
 	// to manually add `using Script::Script` to their concrete script class.
diff --git a/src/crepe/api/Script.hpp b/src/crepe/api/Script.hpp
index a064a90..4593d69 100644
--- a/src/crepe/api/Script.hpp
+++ b/src/crepe/api/Script.hpp
@@ -25,4 +25,9 @@ std::vector<std::reference_wrapper<T>> Script::get_components() const {
 	return mgr.get_components_by_id<T>(this->game_object_id);
 }
 
+template <typename... Args>
+void Script::logf(Args &&... args) {
+	Log::logf(std::forward<Args>(args)...);
+}
+
 } // namespace crepe
diff --git a/src/crepe/util/Log.h b/src/crepe/util/Log.h
index d55b11e..fc0bb3a 100644
--- a/src/crepe/util/Log.h
+++ b/src/crepe/util/Log.h
@@ -34,11 +34,11 @@ class Log {
 public:
 	//! Log message severity
 	enum Level {
-		TRACE, //< Include (internal) function calls
-		DEBUG, //< Include dbg_logf output
-		INFO, //< General-purpose messages
-		WARNING, //< Non-fatal errors
-		ERROR, //< Fatal errors
+		TRACE, //!< Include (internal) function calls
+		DEBUG, //!< Include dbg_logf output
+		INFO, //!< General-purpose messages
+		WARNING, //!< Non-fatal errors
+		ERROR, //!< Fatal errors
 	};
 
 	/**
-- 
cgit v1.2.3


From 9d66b6cfccd15a1600c30af5e744e8b0710eeae6 Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Thu, 21 Nov 2024 09:29:15 +0100
Subject: remove OptionalRef::set and OptionalRef::get

---
 src/crepe/util/OptionalRef.h   | 22 ++++++++--------------
 src/crepe/util/OptionalRef.hpp | 21 ++++++++-------------
 src/test/OptionalRefTest.cpp   | 42 ++++++++++++++++++++++++++----------------
 3 files changed, 42 insertions(+), 43 deletions(-)

(limited to 'src/crepe/util')

diff --git a/src/crepe/util/OptionalRef.h b/src/crepe/util/OptionalRef.h
index 57f9635..253bc07 100644
--- a/src/crepe/util/OptionalRef.h
+++ b/src/crepe/util/OptionalRef.h
@@ -24,19 +24,6 @@ public:
 	 * \return Reference to this (required for operator)
 	 */
 	OptionalRef<T> & operator=(T & ref);
-	/**
-	 * \brief Check if this reference is not empty
-	 *
-	 * \returns `true` if reference is set, or `false` if it is not
-	 */
-	explicit operator bool() const noexcept;
-
-	/**
-	 * \brief Assign new reference
-	 *
-	 * \param ref Reference to assign
-	 */
-	void set(T & ref) noexcept;
 	/**
 	 * \brief Retrieve this reference
 	 *
@@ -44,7 +31,14 @@ public:
 	 *
 	 * \throws std::runtime_error if this function is called while the reference it not set
 	 */
-	T & get() const;
+	operator T & () const;
+	/**
+	 * \brief Check if this reference is not empty
+	 *
+	 * \returns `true` if reference is set, or `false` if it is not
+	 */
+	explicit operator bool() const noexcept;
+
 	/**
 	 * \brief Make this reference empty
 	 */
diff --git a/src/crepe/util/OptionalRef.hpp b/src/crepe/util/OptionalRef.hpp
index 71e2a39..ae7c73e 100644
--- a/src/crepe/util/OptionalRef.hpp
+++ b/src/crepe/util/OptionalRef.hpp
@@ -8,29 +8,19 @@ namespace crepe {
 
 template <typename T>
 OptionalRef<T>::OptionalRef(T & ref) {
-	this->set(ref);
+	this->ref = &ref;
 }
 
 template <typename T>
-T & OptionalRef<T>::get() const {
+OptionalRef<T>::operator T & () const {
 	if (this->ref == nullptr)
 		throw std::runtime_error("OptionalRef: attempt to dereference nullptr");
 	return *this->ref;
 }
 
-template <typename T>
-void OptionalRef<T>::set(T & ref) noexcept {
-	this->ref = &ref;
-}
-
-template <typename T>
-void OptionalRef<T>::clear() noexcept {
-	this->ref = nullptr;
-}
-
 template <typename T>
 OptionalRef<T> & OptionalRef<T>::operator=(T & ref) {
-	this->set(ref);
+	this->ref = &ref;
 	return *this;
 }
 
@@ -39,4 +29,9 @@ OptionalRef<T>::operator bool() const noexcept {
 	return this->ref != nullptr;
 }
 
+template <typename T>
+void OptionalRef<T>::clear() noexcept {
+	this->ref = nullptr;
+}
+
 } // namespace crepe
diff --git a/src/test/OptionalRefTest.cpp b/src/test/OptionalRefTest.cpp
index 2072d56..1c69348 100644
--- a/src/test/OptionalRefTest.cpp
+++ b/src/test/OptionalRefTest.cpp
@@ -6,32 +6,42 @@ using namespace std;
 using namespace crepe;
 using namespace testing;
 
-TEST(OptionalRefTest, Explicit) {
+TEST(OptionalRefTest, Normal) {
 	string value = "foo";
-	OptionalRef<string> ref;
-	EXPECT_FALSE(ref);
-	ASSERT_THROW(ref.get(), runtime_error);
+	OptionalRef<string> ref = value;
 
-	ref.set(value);
 	EXPECT_TRUE(ref);
-	ASSERT_NO_THROW(ref.get());
+	ASSERT_NO_THROW({
+		string & value_ref = ref;
+		EXPECT_EQ(value_ref, value);
+	});
 
 	ref.clear();
 	EXPECT_FALSE(ref);
-	ASSERT_THROW(ref.get(), runtime_error);
+	ASSERT_THROW({
+		string & value_ref = ref;
+	}, runtime_error);
 }
 
-TEST(OptionalRefTest, Implicit) {
+TEST(OptionalRefTest, Empty) {
 	string value = "foo";
-	OptionalRef<string> ref = value;
-	EXPECT_TRUE(ref);
-	ASSERT_NO_THROW(ref.get());
+	OptionalRef<string> ref;
 
-	ref.clear();
 	EXPECT_FALSE(ref);
-	ASSERT_THROW(ref.get(), runtime_error);
+	ASSERT_THROW({
+		string & value_ref = ref;
+	}, runtime_error);
+}
 
-	ref = value;
-	EXPECT_TRUE(ref);
-	ASSERT_NO_THROW(ref.get());
+TEST(OptionalRefTest, Chain) {
+	string value = "foo";
+	OptionalRef<string> ref1 = value;
+	OptionalRef<string> ref2 = ref1;
+
+	EXPECT_TRUE(ref2);
+	string & value_ref = ref2;
+	EXPECT_EQ(value_ref, value);
+	value_ref = "bar";
+	EXPECT_EQ(value_ref, value);
 }
+
-- 
cgit v1.2.3


From 115d6f50152dc018073345800ca90b85846ebaa9 Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Thu, 21 Nov 2024 10:01:04 +0100
Subject: `make format`

---
 src/crepe/util/OptionalRef.h   | 2 +-
 src/crepe/util/OptionalRef.hpp | 2 +-
 src/test/OptionalRefTest.cpp   | 9 ++-------
 src/test/SceneManagerTest.cpp  | 4 ++--
 4 files changed, 6 insertions(+), 11 deletions(-)

(limited to 'src/crepe/util')

diff --git a/src/crepe/util/OptionalRef.h b/src/crepe/util/OptionalRef.h
index 253bc07..3201667 100644
--- a/src/crepe/util/OptionalRef.h
+++ b/src/crepe/util/OptionalRef.h
@@ -31,7 +31,7 @@ public:
 	 *
 	 * \throws std::runtime_error if this function is called while the reference it not set
 	 */
-	operator T & () const;
+	operator T &() const;
 	/**
 	 * \brief Check if this reference is not empty
 	 *
diff --git a/src/crepe/util/OptionalRef.hpp b/src/crepe/util/OptionalRef.hpp
index ae7c73e..4608c9e 100644
--- a/src/crepe/util/OptionalRef.hpp
+++ b/src/crepe/util/OptionalRef.hpp
@@ -12,7 +12,7 @@ OptionalRef<T>::OptionalRef(T & ref) {
 }
 
 template <typename T>
-OptionalRef<T>::operator T & () const {
+OptionalRef<T>::operator T &() const {
 	if (this->ref == nullptr)
 		throw std::runtime_error("OptionalRef: attempt to dereference nullptr");
 	return *this->ref;
diff --git a/src/test/OptionalRefTest.cpp b/src/test/OptionalRefTest.cpp
index 1c69348..83f7b23 100644
--- a/src/test/OptionalRefTest.cpp
+++ b/src/test/OptionalRefTest.cpp
@@ -18,9 +18,7 @@ TEST(OptionalRefTest, Normal) {
 
 	ref.clear();
 	EXPECT_FALSE(ref);
-	ASSERT_THROW({
-		string & value_ref = ref;
-	}, runtime_error);
+	ASSERT_THROW({ string & value_ref = ref; }, runtime_error);
 }
 
 TEST(OptionalRefTest, Empty) {
@@ -28,9 +26,7 @@ TEST(OptionalRefTest, Empty) {
 	OptionalRef<string> ref;
 
 	EXPECT_FALSE(ref);
-	ASSERT_THROW({
-		string & value_ref = ref;
-	}, runtime_error);
+	ASSERT_THROW({ string & value_ref = ref; }, runtime_error);
 }
 
 TEST(OptionalRefTest, Chain) {
@@ -44,4 +40,3 @@ TEST(OptionalRefTest, Chain) {
 	value_ref = "bar";
 	EXPECT_EQ(value_ref, value);
 }
-
diff --git a/src/test/SceneManagerTest.cpp b/src/test/SceneManagerTest.cpp
index dab2ce9..1efcfb2 100644
--- a/src/test/SceneManagerTest.cpp
+++ b/src/test/SceneManagerTest.cpp
@@ -21,7 +21,7 @@ public:
 		GameObject object3 = mgr.new_object("scene_1", "tag_scene_1", Vector2{2, 0}, 0, 1);
 	}
 
-	string get_name() const { return "scene1";}
+	string get_name() const { return "scene1"; }
 };
 
 class ConcreteScene2 : public Scene {
@@ -36,7 +36,7 @@ public:
 		GameObject object4 = mgr.new_object("scene_2", "tag_scene_2", Vector2{0, 3}, 0, 1);
 	}
 
-	string get_name() const { return "scene2";}
+	string get_name() const { return "scene2"; }
 };
 
 class SceneManagerTest : public ::testing::Test {
-- 
cgit v1.2.3