From f51ddfac7b8948a43a40894185238c8a1ceeb5c4 Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Fri, 15 Nov 2024 17:25:12 +0100
Subject: wrap lines at column 95 instead of 80

---
 src/crepe/ComponentManager.h | 26 +++++++++++---------------
 1 file changed, 11 insertions(+), 15 deletions(-)

(limited to 'src/crepe/ComponentManager.h')

diff --git a/src/crepe/ComponentManager.h b/src/crepe/ComponentManager.h
index c8c196c..9a2aa1d 100644
--- a/src/crepe/ComponentManager.h
+++ b/src/crepe/ComponentManager.h
@@ -13,8 +13,7 @@ namespace crepe {
 /**
  * \brief Manages all components
  * 
- * This class manages all components. It provides methods to add, delete and get
- * components.
+ * This class manages all components. It provides methods to add, delete and get components.
  */
 class ComponentManager {
 public:
@@ -33,8 +32,8 @@ public:
 	/**
 	 * \brief Add a component to the ComponentManager
 	 * 
-	 * This method adds a component to the ComponentManager. The component is
-	 * created with the given arguments and added to the ComponentManager.
+	 * This method adds a component to the ComponentManager. The component is created with the
+	 * given arguments and added to the ComponentManager.
 	 * 
 	 * \tparam T The type of the component
 	 * \tparam Args The types of the arguments
@@ -87,8 +86,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;
+	std::vector<std::reference_wrapper<T>> get_components_by_id(game_object_id_t id) const;
 	/**
 	 * \brief Get all components of a specific type
 	 * 
@@ -107,16 +105,14 @@ private:
 	/**
 	 * \brief The components
 	 * 
-	 * This unordered_map stores all components. The key is the type of the
-	 * component and the value is a vector of vectors of unique pointers to the
-	 * components.
-	 * Every component type has its own vector of vectors of unique pointers to
-	 * the components. The first vector is for the ids of the GameObjects and the
-	 * second vector is for the components (because a GameObject might have multiple
-	 * components).
+	 * This unordered_map stores all components. The key is the type of the component and the
+	 * value is a vector of vectors of unique pointers to the components.
+	 *
+	 * Every component type has its own vector of vectors of unique pointers to the components.
+	 * The first vector is for the ids of the GameObjects and the second vector is for the
+	 * components (because a GameObject might have multiple components).
 	 */
-	std::unordered_map<std::type_index,
-					   std::vector<std::vector<std::unique_ptr<Component>>>>
+	std::unordered_map<std::type_index, std::vector<std::vector<std::unique_ptr<Component>>>>
 		components;
 };
 
-- 
cgit v1.2.3


From 5bee4515c1089ce3499bc3b74780db94f0c02306 Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Fri, 15 Nov 2024 20:26:26 +0100
Subject: process feedback on #26

---
 src/crepe/CMakeLists.txt        |  3 ---
 src/crepe/Component.h           |  2 ++
 src/crepe/ComponentManager.cpp  | 11 +++++------
 src/crepe/ComponentManager.h    |  3 ++-
 src/crepe/ComponentManager.hpp  |  1 -
 src/crepe/Exception.cpp         |  8 --------
 src/crepe/Exception.h           | 31 -------------------------------
 src/crepe/Exception.hpp         | 12 ------------
 src/crepe/api/Animator.cpp      |  2 --
 src/crepe/api/Animator.h        |  2 --
 src/crepe/api/BehaviorScript.h  |  3 +--
 src/crepe/api/CMakeLists.txt    |  1 -
 src/crepe/api/Camera.h          |  2 --
 src/crepe/api/Config.h          | 17 +++++++++++------
 src/crepe/api/LoopManager.hpp   |  4 ++--
 src/crepe/api/LoopTimer.h       |  1 -
 src/crepe/api/Rigidbody.h       |  2 --
 src/crepe/api/SceneManager.h    |  3 ---
 src/crepe/api/Script.cpp        |  3 ---
 src/crepe/api/Script.hpp        |  8 +++-----
 src/crepe/api/Sprite.h          |  1 -
 src/crepe/api/Transform.h       |  8 +++++---
 src/crepe/facade/DB.cpp         | 24 +++++++++++++++---------
 src/crepe/facade/DB.h           |  7 ++++---
 src/crepe/facade/SDLContext.cpp |  5 ++---
 src/crepe/util/Log.cpp          |  9 ++++-----
 src/crepe/util/Log.h            |  2 ++
 src/crepe/util/LogColor.cpp     |  1 +
 src/crepe/util/LogColor.h       | 24 +++++++++++++++++++++++-
 src/example/particles.cpp       |  3 ++-
 30 files changed, 84 insertions(+), 119 deletions(-)
 delete mode 100644 src/crepe/Exception.cpp
 delete mode 100644 src/crepe/Exception.h
 delete mode 100644 src/crepe/Exception.hpp
 delete mode 100644 src/crepe/api/Script.cpp

(limited to 'src/crepe/ComponentManager.h')

diff --git a/src/crepe/CMakeLists.txt b/src/crepe/CMakeLists.txt
index 52a781e..3b05742 100644
--- a/src/crepe/CMakeLists.txt
+++ b/src/crepe/CMakeLists.txt
@@ -4,7 +4,6 @@ target_sources(crepe PUBLIC
 	ComponentManager.cpp
 	Component.cpp
 	Collider.cpp
-	Exception.cpp
 )
 
 target_sources(crepe PUBLIC FILE_SET HEADERS FILES
@@ -15,8 +14,6 @@ target_sources(crepe PUBLIC FILE_SET HEADERS FILES
 	Collider.h
 	ValueBroker.h
 	ValueBroker.hpp
-	Exception.h
-	Exception.hpp
 )
 
 add_subdirectory(api)
diff --git a/src/crepe/Component.h b/src/crepe/Component.h
index 12c10cb..670446f 100644
--- a/src/crepe/Component.h
+++ b/src/crepe/Component.h
@@ -26,6 +26,8 @@ protected:
 	Component(game_object_id_t id);
 	//! Only the ComponentManager can create components
 	friend class ComponentManager;
+public:
+	virtual ~Component() = default;
 
 public:
 	/**
diff --git a/src/crepe/ComponentManager.cpp b/src/crepe/ComponentManager.cpp
index 7af0380..67c6fc7 100644
--- a/src/crepe/ComponentManager.cpp
+++ b/src/crepe/ComponentManager.cpp
@@ -6,6 +6,9 @@
 using namespace crepe;
 using namespace std;
 
+ComponentManager::ComponentManager() { dbg_trace(); }
+ComponentManager::~ComponentManager() { dbg_trace(); }
+
 void ComponentManager::delete_all_components_of_id(game_object_id_t id) {
 	// Loop through all the types (in the unordered_map<>)
 	for (auto & [type, componentArray] : this->components) {
@@ -18,18 +21,14 @@ void ComponentManager::delete_all_components_of_id(game_object_id_t id) {
 }
 
 void ComponentManager::delete_all_components() {
-	// Clear the whole unordered_map<>
 	this->components.clear();
+	this->next_id = 0;
 }
 
-ComponentManager::ComponentManager() { dbg_trace(); }
-ComponentManager::~ComponentManager() { dbg_trace(); }
-
 GameObject ComponentManager::new_object(const string & name, const string & tag,
 										const Vector2 & position,
 										double rotation, double scale) {
-	GameObject object{*this,	this->next_id, name, tag,
-					  position, rotation,	   scale};
+	GameObject object{*this, this->next_id, name, tag, position, rotation, scale};
 	this->next_id++;
 	return object;
 }
diff --git a/src/crepe/ComponentManager.h b/src/crepe/ComponentManager.h
index 51c84a4..ca2e7c6 100644
--- a/src/crepe/ComponentManager.h
+++ b/src/crepe/ComponentManager.h
@@ -6,9 +6,10 @@
 #include <unordered_map>
 #include <vector>
 
-#include "Component.h"
 #include "api/Vector2.h"
 
+#include "Component.h"
+
 namespace crepe {
 
 class GameObject;
diff --git a/src/crepe/ComponentManager.hpp b/src/crepe/ComponentManager.hpp
index 98efb49..0a84468 100644
--- a/src/crepe/ComponentManager.hpp
+++ b/src/crepe/ComponentManager.hpp
@@ -40,7 +40,6 @@ T & ComponentManager::add_component(game_object_id_t id, Args &&... args) {
 	// Check if the vector size is not greater than get_instances_max
 	int max_instances = instance->get_instances_max();
 	if (max_instances != -1 && components[type][id].size() >= max_instances) {
-		// TODO: Exception
 		throw std::runtime_error(
 			"Exceeded maximum number of instances for this component type");
 	}
diff --git a/src/crepe/Exception.cpp b/src/crepe/Exception.cpp
deleted file mode 100644
index 5a24e7e..0000000
--- a/src/crepe/Exception.cpp
+++ /dev/null
@@ -1,8 +0,0 @@
-#include "Exception.h"
-
-using namespace crepe;
-using namespace std;
-
-const char * Exception::what() const noexcept { return error.c_str(); }
-
-Exception::Exception(const string & msg) { this->error = msg; }
diff --git a/src/crepe/Exception.h b/src/crepe/Exception.h
deleted file mode 100644
index 580fc16..0000000
--- a/src/crepe/Exception.h
+++ /dev/null
@@ -1,31 +0,0 @@
-#pragma once
-
-#include <exception>
-#include <format>
-#include <string>
-
-namespace crepe {
-
-//! Exception class
-class Exception : public std::exception {
-public:
-	//! Exception with plain message
-	Exception(const std::string & msg);
-
-	//! Exception with \c std::format message
-	template <class... Args>
-	Exception(std::format_string<Args...> fmt, Args &&... args);
-
-	//! Get formatted error message
-	const char * what() const noexcept;
-
-protected:
-	Exception() = default;
-
-	//! Formatted error message
-	std::string error;
-};
-
-} // namespace crepe
-
-#include "Exception.hpp"
diff --git a/src/crepe/Exception.hpp b/src/crepe/Exception.hpp
deleted file mode 100644
index 7c462a3..0000000
--- a/src/crepe/Exception.hpp
+++ /dev/null
@@ -1,12 +0,0 @@
-#pragma once
-
-#include "Exception.h"
-
-namespace crepe {
-
-template <class... Args>
-Exception::Exception(std::format_string<Args...> fmt, Args &&... args) {
-	this->error = std::format(fmt, std::forward<Args>(args)...);
-}
-
-} // namespace crepe
diff --git a/src/crepe/api/Animator.cpp b/src/crepe/api/Animator.cpp
index 54b2ec3..cccbc67 100644
--- a/src/crepe/api/Animator.cpp
+++ b/src/crepe/api/Animator.cpp
@@ -1,6 +1,4 @@
 
-#include <cstdint>
-
 #include "util/Log.h"
 
 #include "Animator.h"
diff --git a/src/crepe/api/Animator.h b/src/crepe/api/Animator.h
index 75b8139..3573403 100644
--- a/src/crepe/api/Animator.h
+++ b/src/crepe/api/Animator.h
@@ -1,7 +1,5 @@
 #pragma once
 
-#include <cstdint>
-
 #include "Component.h"
 #include "Sprite.h"
 
diff --git a/src/crepe/api/BehaviorScript.h b/src/crepe/api/BehaviorScript.h
index 2982358..1a8910d 100644
--- a/src/crepe/api/BehaviorScript.h
+++ b/src/crepe/api/BehaviorScript.h
@@ -3,6 +3,7 @@
 #include <memory>
 
 #include "../Component.h"
+
 #include "GameObject.h"
 
 namespace crepe {
@@ -47,8 +48,6 @@ protected:
 	std::unique_ptr<Script> script = nullptr;
 	//! Reference to component manager
 	ComponentManager & component_manager;
-
-private:
 	//! Script accesses the component manager directly via its parent
 	// (BehaviorScript) reference
 	friend class Script;
diff --git a/src/crepe/api/CMakeLists.txt b/src/crepe/api/CMakeLists.txt
index 85696c4..f9b370f 100644
--- a/src/crepe/api/CMakeLists.txt
+++ b/src/crepe/api/CMakeLists.txt
@@ -1,7 +1,6 @@
 target_sources(crepe PUBLIC
 	# AudioSource.cpp
 	BehaviorScript.cpp
-	Script.cpp
 	GameObject.cpp
 	Rigidbody.cpp
 	ParticleEmitter.cpp
diff --git a/src/crepe/api/Camera.h b/src/crepe/api/Camera.h
index d8c08a6..bf97731 100644
--- a/src/crepe/api/Camera.h
+++ b/src/crepe/api/Camera.h
@@ -1,7 +1,5 @@
 #pragma once
 
-#include <cstdint>
-
 #include "Color.h"
 #include "Component.h"
 
diff --git a/src/crepe/api/Config.h b/src/crepe/api/Config.h
index e3f86bf..92b20b7 100644
--- a/src/crepe/api/Config.h
+++ b/src/crepe/api/Config.h
@@ -4,16 +4,21 @@
 
 namespace crepe {
 
+/**
+ * \brief Global configuration interface
+ *
+ * This class stores engine default settings. Properties on this class are only
+ * supposed to be modified *before* execution is handed over from the game
+ * programmer to the engine (i.e. the main loop is started).
+ */
 class Config {
-private:
-	Config() = default;
-
-public:
-	~Config() = default;
-
 public:
 	//! Retrieve handle to global Config instance
 	static Config & get_instance();
+
+private:
+	Config() = default;
+
 	// singleton
 	Config(const Config &) = delete;
 	Config(Config &&) = delete;
diff --git a/src/crepe/api/LoopManager.hpp b/src/crepe/api/LoopManager.hpp
index 8fb9aa3..85a329b 100644
--- a/src/crepe/api/LoopManager.hpp
+++ b/src/crepe/api/LoopManager.hpp
@@ -2,8 +2,8 @@
 
 #include <cassert>
 #include <memory>
+#include <format>
 
-#include "../Exception.h"
 #include "../system/System.h"
 
 #include "LoopManager.h"
@@ -18,7 +18,7 @@ T & LoopManager::get_system() {
 
 	const type_info & type = typeid(T);
 	if (!this->systems.contains(type))
-		throw Exception("LoopManager: %s is not initialized", type.name());
+		throw runtime_error(format("LoopManager: {} is not initialized", type.name()));
 
 	System * system = this->systems.at(type).get();
 	T * concrete_system = dynamic_cast<T *>(system);
diff --git a/src/crepe/api/LoopTimer.h b/src/crepe/api/LoopTimer.h
index 85687be..aff4bf7 100644
--- a/src/crepe/api/LoopTimer.h
+++ b/src/crepe/api/LoopTimer.h
@@ -1,7 +1,6 @@
 #pragma once
 
 #include <chrono>
-#include <cstdint>
 
 namespace crepe {
 
diff --git a/src/crepe/api/Rigidbody.h b/src/crepe/api/Rigidbody.h
index 2e20288..11544e5 100644
--- a/src/crepe/api/Rigidbody.h
+++ b/src/crepe/api/Rigidbody.h
@@ -1,7 +1,5 @@
 #pragma once
 
-#include <cstdint>
-
 #include "../Component.h"
 
 #include "Vector2.h"
diff --git a/src/crepe/api/SceneManager.h b/src/crepe/api/SceneManager.h
index 553194f..e854794 100644
--- a/src/crepe/api/SceneManager.h
+++ b/src/crepe/api/SceneManager.h
@@ -13,7 +13,6 @@ class ComponentManager;
 class SceneManager {
 public:
 	SceneManager(ComponentManager & mgr);
-	virtual ~SceneManager() = default;
 
 public:
 	/**
@@ -38,8 +37,6 @@ public:
 private:
 	std::vector<std::unique_ptr<Scene>> scenes;
 	std::string next_scene;
-
-protected:
 	ComponentManager & component_manager;
 };
 
diff --git a/src/crepe/api/Script.cpp b/src/crepe/api/Script.cpp
deleted file mode 100644
index 390cec7..0000000
--- a/src/crepe/api/Script.cpp
+++ /dev/null
@@ -1,3 +0,0 @@
-#include "Script.h"
-
-using namespace crepe;
diff --git a/src/crepe/api/Script.hpp b/src/crepe/api/Script.hpp
index aceb38b..13b8077 100644
--- a/src/crepe/api/Script.hpp
+++ b/src/crepe/api/Script.hpp
@@ -1,7 +1,6 @@
 #pragma once
 
 #include "../ComponentManager.h"
-#include "../Exception.h"
 
 #include "BehaviorScript.h"
 #include "Script.h"
@@ -10,11 +9,10 @@ namespace crepe {
 
 template <typename T>
 T & Script::get_component() const {
-	std::vector<std::reference_wrapper<T>> all_components
-		= this->get_components<T>();
+	using namespace std;
+	vector<reference_wrapper<T>> all_components = this->get_components<T>();
 	if (all_components.size() < 1)
-		throw Exception("Script: no component found with type = {}",
-						typeid(T).name());
+		throw runtime_error(format("Script: no component found with type = {}", typeid(T).name()));
 
 	return all_components.back().get();
 }
diff --git a/src/crepe/api/Sprite.h b/src/crepe/api/Sprite.h
index deb3f93..754184b 100644
--- a/src/crepe/api/Sprite.h
+++ b/src/crepe/api/Sprite.h
@@ -1,6 +1,5 @@
 #pragma once
 
-#include <cstdint>
 #include <memory>
 
 #include "Color.h"
diff --git a/src/crepe/api/Transform.h b/src/crepe/api/Transform.h
index 902dafa..7d6f785 100644
--- a/src/crepe/api/Transform.h
+++ b/src/crepe/api/Transform.h
@@ -28,9 +28,11 @@ protected:
 	 * \param rotation The rotation of the GameObject
 	 * \param scale The scale of the GameObject
 	 */
-	Transform(game_object_id_t id, const Vector2 & point, double rotation = 0,
-			  double scale = 0);
-	//! There is always exactly one transform component per entity
+	Transform(game_object_id_t id, const Vector2 & point, double rotation, double scale);
+	/**
+	 * There is always exactly one transform component per entity
+	 * \return 1
+	 */
 	virtual int get_instances_max() const { return 1; }
 	//! ComponentManager instantiates all components
 	friend class ComponentManager;
diff --git a/src/crepe/facade/DB.cpp b/src/crepe/facade/DB.cpp
index 80047a6..322ecc0 100644
--- a/src/crepe/facade/DB.cpp
+++ b/src/crepe/facade/DB.cpp
@@ -1,6 +1,5 @@
 #include <cstring>
 
-#include "Exception.h"
 #include "util/Log.h"
 
 #include "DB.h"
@@ -15,18 +14,18 @@ DB::DB(const string & path) {
 	// init database struct
 	libdb::DB * db;
 	if ((ret = libdb::db_create(&db, NULL, 0)) != 0)
-		throw Exception("db_create: {}", libdb::db_strerror(ret));
+		throw runtime_error(format("db_create: {}", libdb::db_strerror(ret)));
 	this->db = {db, [](libdb::DB * db) { db->close(db, 0); }};
 
 	// load or create database file
 	ret = this->db->open(this->db.get(), NULL, path.c_str(), NULL,
 						 libdb::DB_BTREE, DB_CREATE, 0);
-	if (ret != 0) throw Exception("db->open: {}", libdb::db_strerror(ret));
+	if (ret != 0) throw runtime_error(format("db->open: {}", libdb::db_strerror(ret)));
 
 	// create cursor
 	libdb::DBC * cursor;
 	ret = this->db->cursor(this->db.get(), NULL, &cursor, 0);
-	if (ret != 0) throw Exception("db->cursor: {}", libdb::db_strerror(ret));
+	if (ret != 0) throw runtime_error(format("db->cursor: {}", libdb::db_strerror(ret)));
 	this->cursor = {cursor, [](libdb::DBC * cursor) { cursor->close(cursor); }};
 }
 
@@ -44,21 +43,28 @@ string DB::get(const string & key) {
 	memset(&db_val, 0, sizeof(libdb::DBT));
 
 	int ret = this->cursor->get(this->cursor.get(), &db_key, &db_val, DB_FIRST);
-	if (ret != 0) throw Exception("cursor->get: {}", libdb::db_strerror(ret));
-	return {static_cast<char *>(db_val.data), db_val.size};
+	if (ret == 0)
+		return {static_cast<char *>(db_val.data), db_val.size};
+
+	string err = format("cursor->get: {}", libdb::db_strerror(ret));
+	if (ret == DB_NOTFOUND)
+		throw out_of_range(err);
+	else
+		throw runtime_error(err);
 }
 
 void DB::set(const string & key, const string & value) {
 	libdb::DBT db_key = this->to_thing(key);
 	libdb::DBT db_val = this->to_thing(value);
 	int ret = this->db->put(this->db.get(), NULL, &db_key, &db_val, 0);
-	if (ret != 0) throw Exception("cursor->get: {}", libdb::db_strerror(ret));
+	if (ret != 0)
+		throw runtime_error(format("cursor->get: {}", libdb::db_strerror(ret)));
 }
 
-bool DB::has(const std::string & key) noexcept {
+bool DB::has(const std::string & key) {
 	try {
 		this->get(key);
-	} catch (...) {
+	} catch (std::out_of_range &) {
 		return false;
 	}
 	return true;
diff --git a/src/crepe/facade/DB.h b/src/crepe/facade/DB.h
index 7c757a2..2112216 100644
--- a/src/crepe/facade/DB.h
+++ b/src/crepe/facade/DB.h
@@ -34,7 +34,8 @@ public:
 	 *
 	 * \return The value
 	 *
-	 * \throws Exception if value is not found in DB or other error occurs
+	 * \throws std::out_of_range if value is not found in DB
+	 * \throws std::runtime_error if other error occurs
 	 */
 	std::string get(const std::string & key);
 	/**
@@ -43,7 +44,7 @@ public:
 	 * \param key  The value key
 	 * \param value  The value to store
 	 *
-	 * \throws Exception if an error occurs
+	 * \throws std::runtime_error if an error occurs
 	 */
 	void set(const std::string & key, const std::string & value);
 	/**
@@ -53,7 +54,7 @@ public:
 	 *
 	 * \returns True if the key exists, or false if it does not
 	 */
-	bool has(const std::string & key) noexcept;
+	bool has(const std::string & key);
 
 private:
 	//! RAII wrapper around \c DB struct
diff --git a/src/crepe/facade/SDLContext.cpp b/src/crepe/facade/SDLContext.cpp
index a68d940..65ea962 100644
--- a/src/crepe/facade/SDLContext.cpp
+++ b/src/crepe/facade/SDLContext.cpp
@@ -10,17 +10,16 @@
 #include <iostream>
 #include <memory>
 #include <string>
-#include <utility>
 
 #include "../api/Sprite.h"
 #include "../api/Texture.h"
 #include "../api/Transform.h"
 #include "../util/Log.h"
-#include "Exception.h"
 
 #include "SDLContext.h"
 
 using namespace crepe;
+using namespace std;
 
 SDLContext & SDLContext::get_instance() {
 	static SDLContext instance;
@@ -171,7 +170,7 @@ SDLContext::texture_from_path(const std::string & path) {
 		this->game_renderer.get(), img_surface.get());
 
 	if (tmp_texture == nullptr) {
-		throw Exception("Texture cannot be load from {}", path);
+		throw runtime_error(format("Texture cannot be load from {}", path));
 	}
 
 	std::unique_ptr<SDL_Texture, std::function<void(SDL_Texture *)>>
diff --git a/src/crepe/util/Log.cpp b/src/crepe/util/Log.cpp
index e583734..84d80a8 100644
--- a/src/crepe/util/Log.cpp
+++ b/src/crepe/util/Log.cpp
@@ -1,9 +1,8 @@
-#include <cstdarg>
-#include <cstdio>
-#include <cstdlib>
+#include <iostream>
 #include <string>
 
 #include "../api/Config.h"
+
 #include "Log.h"
 
 using namespace crepe;
@@ -33,6 +32,6 @@ void Log::log(const Level & level, const string & msg) {
 	if (!out.ends_with("\n")) out += "\n";
 
 	// TODO: also log to file or smth
-	fwrite(out.c_str(), 1, out.size(), stdout);
-	fflush(stdout);
+	cout.write(out.data(), out.size());
+	cout.flush();
 }
diff --git a/src/crepe/util/Log.h b/src/crepe/util/Log.h
index 01452b2..e0844ca 100644
--- a/src/crepe/util/Log.h
+++ b/src/crepe/util/Log.h
@@ -76,6 +76,8 @@ private:
 	 * \brief Output a message prefix depending on the log level
 	 *
 	 * \param level Message severity
+	 *
+	 * \return Colored message severity prefix string
 	 */
 	static std::string prefix(const Level & level);
 };
diff --git a/src/crepe/util/LogColor.cpp b/src/crepe/util/LogColor.cpp
index ae44d72..170ddcf 100644
--- a/src/crepe/util/LogColor.cpp
+++ b/src/crepe/util/LogColor.cpp
@@ -1,6 +1,7 @@
 #include <cstdarg>
 
 #include "../api/Config.h"
+
 #include "LogColor.h"
 
 using namespace crepe;
diff --git a/src/crepe/util/LogColor.h b/src/crepe/util/LogColor.h
index 4b65127..132fb94 100644
--- a/src/crepe/util/LogColor.h
+++ b/src/crepe/util/LogColor.h
@@ -12,7 +12,13 @@ namespace crepe {
  */
 class LogColor {
 public:
-	//! Get color code as stl string (or color content string)
+	/**
+	 * \brief Get color code as STL string
+	 *
+	 * \param content If given, color this string and append a color reset escape sequence.
+	 *
+	 * \returns Color escape sequence
+	 */
 	const std::string str(const std::string & content = "") const;
 
 public:
@@ -20,6 +26,13 @@ public:
 	LogColor & reset();
 
 public:
+	/**
+	 * \name Foreground colors
+	 *
+	 * These functions set the foreground (text) color. The \c bright parameter
+	 * makes the color brighter, or bold on some terminals.
+	 * \{
+	 */
 	LogColor & fg_black(bool bright = false);
 	LogColor & fg_red(bool bright = false);
 	LogColor & fg_green(bool bright = false);
@@ -28,8 +41,16 @@ public:
 	LogColor & fg_magenta(bool bright = false);
 	LogColor & fg_cyan(bool bright = false);
 	LogColor & fg_white(bool bright = false);
+	/// \}
 
 public:
+	/**
+	 * \name Background colors
+	 *
+	 * These functions set the background color. The \c bright parameter makes
+	 * the color brighter.
+	 * \{
+	 */
 	LogColor & bg_black(bool bright = false);
 	LogColor & bg_red(bool bright = false);
 	LogColor & bg_green(bool bright = false);
@@ -38,6 +59,7 @@ public:
 	LogColor & bg_magenta(bool bright = false);
 	LogColor & bg_cyan(bool bright = false);
 	LogColor & bg_white(bool bright = false);
+	/// \}
 
 private:
 	/**
diff --git a/src/example/particles.cpp b/src/example/particles.cpp
index 6eab046..35faab0 100644
--- a/src/example/particles.cpp
+++ b/src/example/particles.cpp
@@ -14,7 +14,8 @@ using namespace crepe;
 using namespace std;
 
 int main(int argc, char * argv[]) {
-	GameObject game_object(0, "", "", Vector2{0, 0}, 0, 0);
+	ComponentManager mgr{};
+	GameObject game_object = mgr.new_object("", "", Vector2{0, 0}, 0, 0);
 	Color color(0, 0, 0, 0);
 	Sprite test_sprite = game_object.add_component<Sprite>(
 		make_shared<Texture>("../asset/texture/img.png"), color,
-- 
cgit v1.2.3


From fdd5c471dffd4a204a91e8d1d70567fa56ea29a5 Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Fri, 15 Nov 2024 20:49:37 +0100
Subject: `make format`

---
 src/crepe/Component.h             |  1 +
 src/crepe/ComponentManager.cpp    |  4 ++--
 src/crepe/ComponentManager.h      |  7 +++----
 src/crepe/api/Animator.cpp        |  3 +--
 src/crepe/api/Camera.cpp          |  4 +++-
 src/crepe/api/GameObject.cpp      | 12 +++++++++---
 src/crepe/api/GameObject.h        |  4 +++-
 src/crepe/api/LoopManager.cpp     |  4 +---
 src/crepe/api/LoopManager.hpp     |  2 +-
 src/crepe/api/Script.hpp          |  3 ++-
 src/crepe/api/Vector2.cpp         | 20 +++++---------------
 src/crepe/facade/DB.cpp           | 15 ++++++---------
 src/crepe/facade/Sound.cpp        |  4 +---
 src/crepe/system/RenderSystem.cpp |  4 +---
 src/crepe/util/Log.h              | 15 ++++++---------
 src/crepe/util/Log.hpp            |  3 +--
 src/example/ecs.cpp               | 12 ++++--------
 src/example/scene_manager.cpp     | 21 +++++++--------------
 src/test/PhysicsTest.cpp          | 12 ++++--------
 19 files changed, 61 insertions(+), 89 deletions(-)

(limited to 'src/crepe/ComponentManager.h')

diff --git a/src/crepe/Component.h b/src/crepe/Component.h
index 68b28ef..5279fb3 100644
--- a/src/crepe/Component.h
+++ b/src/crepe/Component.h
@@ -26,6 +26,7 @@ protected:
 	Component(game_object_id_t id);
 	//! Only the ComponentManager can create components
 	friend class ComponentManager;
+
 public:
 	virtual ~Component() = default;
 
diff --git a/src/crepe/ComponentManager.cpp b/src/crepe/ComponentManager.cpp
index 67c6fc7..e310577 100644
--- a/src/crepe/ComponentManager.cpp
+++ b/src/crepe/ComponentManager.cpp
@@ -26,8 +26,8 @@ void ComponentManager::delete_all_components() {
 }
 
 GameObject ComponentManager::new_object(const string & name, const string & tag,
-										const Vector2 & position,
-										double rotation, double scale) {
+										const Vector2 & position, double rotation,
+										double scale) {
 	GameObject object{*this, this->next_id, name, tag, position, rotation, scale};
 	this->next_id++;
 	return object;
diff --git a/src/crepe/ComponentManager.h b/src/crepe/ComponentManager.h
index a14cb46..99d45d9 100644
--- a/src/crepe/ComponentManager.h
+++ b/src/crepe/ComponentManager.h
@@ -100,10 +100,9 @@ public:
 	std::vector<std::reference_wrapper<T>> get_components_by_type() const;
 
 	// TODO: doxygen
-	GameObject new_object(const std::string & name,
-						  const std::string & tag = "",
-						  const Vector2 & position = {0, 0},
-						  double rotation = 0, double scale = 0);
+	GameObject new_object(const std::string & name, const std::string & tag = "",
+						  const Vector2 & position = {0, 0}, double rotation = 0,
+						  double scale = 0);
 
 private:
 	/**
diff --git a/src/crepe/api/Animator.cpp b/src/crepe/api/Animator.cpp
index cccbc67..464b0fd 100644
--- a/src/crepe/api/Animator.cpp
+++ b/src/crepe/api/Animator.cpp
@@ -7,8 +7,7 @@
 
 using namespace crepe;
 
-Animator::Animator(game_object_id_t id, Sprite & ss, int row, int col,
-				   int col_animator)
+Animator::Animator(game_object_id_t id, Sprite & ss, int row, int col, int col_animator)
 	: Component(id),
 	  spritesheet(ss),
 	  row(row),
diff --git a/src/crepe/api/Camera.cpp b/src/crepe/api/Camera.cpp
index eb99f7f..5835bdd 100644
--- a/src/crepe/api/Camera.cpp
+++ b/src/crepe/api/Camera.cpp
@@ -6,7 +6,9 @@
 
 using namespace crepe;
 
-Camera::Camera(game_object_id_t id, const Color & bg_color) : Component(id), bg_color(bg_color) {
+Camera::Camera(game_object_id_t id, const Color & bg_color)
+	: Component(id),
+	  bg_color(bg_color) {
 	dbg_trace();
 }
 
diff --git a/src/crepe/api/GameObject.cpp b/src/crepe/api/GameObject.cpp
index 2b836e1..287e81d 100644
--- a/src/crepe/api/GameObject.cpp
+++ b/src/crepe/api/GameObject.cpp
@@ -7,7 +7,11 @@
 using namespace crepe;
 using namespace std;
 
-GameObject::GameObject(ComponentManager & component_manager, game_object_id_t id, const std::string & name, const std::string & tag, const Vector2 & position, double rotation, double scale) : id(id), component_manager(component_manager) {
+GameObject::GameObject(ComponentManager & component_manager, game_object_id_t id,
+					   const std::string & name, const std::string & tag,
+					   const Vector2 & position, double rotation, double scale)
+	: id(id),
+	  component_manager(component_manager) {
 
 	// Add Transform and Metadata components
 	ComponentManager & mgr = this->component_manager;
@@ -19,10 +23,12 @@ void GameObject::set_parent(const GameObject & parent) {
 	ComponentManager & mgr = this->component_manager;
 
 	// Set parent on own Metadata component
-	vector<reference_wrapper<Metadata>> this_metadata = mgr.get_components_by_id<Metadata>(this->id);
+	vector<reference_wrapper<Metadata>> this_metadata
+		= mgr.get_components_by_id<Metadata>(this->id);
 	this_metadata.at(0).get().parent = parent.id;
 
 	// Add own id to children list of parent's Metadata component
-	vector<reference_wrapper<Metadata>> parent_metadata = mgr.get_components_by_id<Metadata>(parent.id);
+	vector<reference_wrapper<Metadata>> parent_metadata
+		= mgr.get_components_by_id<Metadata>(parent.id);
 	parent_metadata.at(0).get().children.push_back(this->id);
 }
diff --git a/src/crepe/api/GameObject.h b/src/crepe/api/GameObject.h
index cf6765a..34ef8bb 100644
--- a/src/crepe/api/GameObject.h
+++ b/src/crepe/api/GameObject.h
@@ -29,7 +29,9 @@ private:
 	 * \param rotation The rotation of the GameObject
 	 * \param scale The scale of the GameObject
 	 */
-	GameObject(ComponentManager & component_manager, game_object_id_t id, const std::string & name, const std::string & tag, const Vector2 & position, double rotation, double scale);
+	GameObject(ComponentManager & component_manager, game_object_id_t id,
+			   const std::string & name, const std::string & tag, const Vector2 & position,
+			   double rotation, double scale);
 	//! ComponentManager instances GameObject
 	friend class ComponentManager;
 
diff --git a/src/crepe/api/LoopManager.cpp b/src/crepe/api/LoopManager.cpp
index f0788ab..6303e2b 100644
--- a/src/crepe/api/LoopManager.cpp
+++ b/src/crepe/api/LoopManager.cpp
@@ -22,9 +22,7 @@ LoopManager::LoopManager() {
 	this->load_system<ScriptSystem>();
 }
 
-ComponentManager & LoopManager::get_component_manager() {
-	return this->component_manager;
-}
+ComponentManager & LoopManager::get_component_manager() { return this->component_manager; }
 
 void LoopManager::process_input() {
 	SDLContext::get_instance().handle_events(this->game_running);
diff --git a/src/crepe/api/LoopManager.hpp b/src/crepe/api/LoopManager.hpp
index 85a329b..0b14fdb 100644
--- a/src/crepe/api/LoopManager.hpp
+++ b/src/crepe/api/LoopManager.hpp
@@ -1,8 +1,8 @@
 #pragma once
 
 #include <cassert>
-#include <memory>
 #include <format>
+#include <memory>
 
 #include "../system/System.h"
 
diff --git a/src/crepe/api/Script.hpp b/src/crepe/api/Script.hpp
index 13b8077..c4e07e8 100644
--- a/src/crepe/api/Script.hpp
+++ b/src/crepe/api/Script.hpp
@@ -12,7 +12,8 @@ T & Script::get_component() const {
 	using namespace std;
 	vector<reference_wrapper<T>> all_components = this->get_components<T>();
 	if (all_components.size() < 1)
-		throw runtime_error(format("Script: no component found with type = {}", typeid(T).name()));
+		throw runtime_error(
+			format("Script: no component found with type = {}", typeid(T).name()));
 
 	return all_components.back().get();
 }
diff --git a/src/crepe/api/Vector2.cpp b/src/crepe/api/Vector2.cpp
index 97b74ac..30b968e 100644
--- a/src/crepe/api/Vector2.cpp
+++ b/src/crepe/api/Vector2.cpp
@@ -2,17 +2,11 @@
 
 using namespace crepe;
 
-Vector2 Vector2::operator-(const Vector2 & other) const {
-	return {x - other.x, y - other.y};
-}
+Vector2 Vector2::operator-(const Vector2 & other) const { return {x - other.x, y - other.y}; }
 
-Vector2 Vector2::operator+(const Vector2 & other) const {
-	return {x + other.x, y + other.y};
-}
+Vector2 Vector2::operator+(const Vector2 & other) const { return {x + other.x, y + other.y}; }
 
-Vector2 Vector2::operator*(double scalar) const {
-	return {x * scalar, y * scalar};
-}
+Vector2 Vector2::operator*(double scalar) const { return {x * scalar, y * scalar}; }
 
 Vector2 & Vector2::operator*=(const Vector2 & other) {
 	x *= other.x;
@@ -34,10 +28,6 @@ Vector2 & Vector2::operator+=(double other) {
 
 Vector2 Vector2::operator-() const { return {-x, -y}; }
 
-bool Vector2::operator==(const Vector2 & other) const {
-	return x == other.x && y == other.y;
-}
+bool Vector2::operator==(const Vector2 & other) const { return x == other.x && y == other.y; }
 
-bool Vector2::operator!=(const Vector2 & other) const {
-	return !(*this == other);
-}
+bool Vector2::operator!=(const Vector2 & other) const { return !(*this == other); }
diff --git a/src/crepe/facade/DB.cpp b/src/crepe/facade/DB.cpp
index 00acf04..d5d19dc 100644
--- a/src/crepe/facade/DB.cpp
+++ b/src/crepe/facade/DB.cpp
@@ -18,7 +18,8 @@ DB::DB(const string & path) {
 	this->db = {db, [](libdb::DB * db) { db->close(db, 0); }};
 
 	// load or create database file
-	ret = this->db->open(this->db.get(), NULL, path.c_str(), NULL, libdb::DB_BTREE, DB_CREATE, 0);
+	ret = this->db->open(this->db.get(), NULL, path.c_str(), NULL, libdb::DB_BTREE, DB_CREATE,
+						 0);
 	if (ret != 0) throw runtime_error(format("db->open: {}", libdb::db_strerror(ret)));
 
 	// create cursor
@@ -42,22 +43,18 @@ string DB::get(const string & key) {
 	memset(&db_val, 0, sizeof(libdb::DBT));
 
 	int ret = this->cursor->get(this->cursor.get(), &db_key, &db_val, DB_FIRST);
-	if (ret == 0)
-		return {static_cast<char *>(db_val.data), db_val.size};
+	if (ret == 0) return {static_cast<char *>(db_val.data), db_val.size};
 
 	string err = format("cursor->get: {}", libdb::db_strerror(ret));
-	if (ret == DB_NOTFOUND)
-		throw out_of_range(err);
-	else
-		throw runtime_error(err);
+	if (ret == DB_NOTFOUND) throw out_of_range(err);
+	else throw runtime_error(err);
 }
 
 void DB::set(const string & key, const string & value) {
 	libdb::DBT db_key = this->to_thing(key);
 	libdb::DBT db_val = this->to_thing(value);
 	int ret = this->db->put(this->db.get(), NULL, &db_key, &db_val, 0);
-	if (ret != 0)
-		throw runtime_error(format("cursor->get: {}", libdb::db_strerror(ret)));
+	if (ret != 0) throw runtime_error(format("cursor->get: {}", libdb::db_strerror(ret)));
 }
 
 bool DB::has(const std::string & key) {
diff --git a/src/crepe/facade/Sound.cpp b/src/crepe/facade/Sound.cpp
index a65b052..7aa89a9 100644
--- a/src/crepe/facade/Sound.cpp
+++ b/src/crepe/facade/Sound.cpp
@@ -16,9 +16,7 @@ Sound::Sound(const char * src) {
 	this->load(make_unique<Asset>(src));
 }
 
-void Sound::load(unique_ptr<Asset> res) {
-	this->sample.load(res->get_canonical().c_str());
-}
+void Sound::load(unique_ptr<Asset> res) { this->sample.load(res->get_canonical().c_str()); }
 
 void Sound::play() {
 	SoundContext & ctx = SoundContext::get_instance();
diff --git a/src/crepe/system/RenderSystem.cpp b/src/crepe/system/RenderSystem.cpp
index 19493f7..fa3d0de 100644
--- a/src/crepe/system/RenderSystem.cpp
+++ b/src/crepe/system/RenderSystem.cpp
@@ -11,9 +11,7 @@
 
 using namespace crepe;
 
-void RenderSystem::clear_screen() const {
-	SDLContext::get_instance().clear_screen();
-}
+void RenderSystem::clear_screen() const { SDLContext::get_instance().clear_screen(); }
 
 void RenderSystem::present_screen() const { SDLContext::get_instance().present_screen(); }
 void RenderSystem::update_camera() {
diff --git a/src/crepe/util/Log.h b/src/crepe/util/Log.h
index e0844ca..d55b11e 100644
--- a/src/crepe/util/Log.h
+++ b/src/crepe/util/Log.h
@@ -9,16 +9,14 @@
 
 // utility macros
 #define _crepe_logf_here(level, fmt, ...) \
-	crepe::Log::logf( \
-		level, "{}" fmt, \
-		crepe::LogColor().fg_white(false).str(std::format( \
-			"{} ({}:{})", __PRETTY_FUNCTION__, __FILE_NAME__, __LINE__)), \
-		__VA_ARGS__)
+	crepe::Log::logf(level, "{}" fmt, \
+					 crepe::LogColor().fg_white(false).str(std::format( \
+						 "{} ({}:{})", __PRETTY_FUNCTION__, __FILE_NAME__, __LINE__)), \
+					 __VA_ARGS__)
 
 // very illegal global function-style macros
 // NOLINTBEGIN
-#define dbg_logf(fmt, ...) \
-	_crepe_logf_here(crepe::Log::Level::DEBUG, ": " fmt, __VA_ARGS__)
+#define dbg_logf(fmt, ...) _crepe_logf_here(crepe::Log::Level::DEBUG, ": " fmt, __VA_ARGS__)
 #define dbg_log(str) _crepe_logf_here(crepe::Log::Level::DEBUG, ": {}", str)
 #define dbg_trace() _crepe_logf_here(crepe::Log::Level::TRACE, "", "")
 // NOLINTEND
@@ -59,8 +57,7 @@ public:
 	 * \param args Format arguments
 	 */
 	template <class... Args>
-	static void logf(const Level & level, std::format_string<Args...> fmt,
-					 Args &&... args);
+	static void logf(const Level & level, std::format_string<Args...> fmt, Args &&... args);
 
 	/**
 	 * \brief Format a message and log it (with default severity \c INFO)
diff --git a/src/crepe/util/Log.hpp b/src/crepe/util/Log.hpp
index 651f076..c2156cd 100644
--- a/src/crepe/util/Log.hpp
+++ b/src/crepe/util/Log.hpp
@@ -10,8 +10,7 @@ void Log::logf(std::format_string<Args...> fmt, Args &&... args) {
 }
 
 template <class... Args>
-void Log::logf(const Level & level, std::format_string<Args...> fmt,
-			   Args &&... args) {
+void Log::logf(const Level & level, std::format_string<Args...> fmt, Args &&... args) {
 	Log::log(level, std::format(fmt, std::forward<Args>(args)...));
 }
 
diff --git a/src/example/ecs.cpp b/src/example/ecs.cpp
index 711bde6..d5ba51b 100644
--- a/src/example/ecs.cpp
+++ b/src/example/ecs.cpp
@@ -14,14 +14,10 @@ int main() {
 	// Create a few GameObjects
 	try {
 		GameObject body = mgr.new_object("body", "person", Vector2{0, 0}, 0, 1);
-		GameObject right_leg
-			= mgr.new_object("rightLeg", "person", Vector2{1, 1}, 0, 1);
-		GameObject left_leg
-			= mgr.new_object("leftLeg", "person", Vector2{1, 1}, 0, 1);
-		GameObject right_foot
-			= mgr.new_object("rightFoot", "person", Vector2{2, 2}, 0, 1);
-		GameObject left_foot
-			= mgr.new_object("leftFoot", "person", Vector2{2, 2}, 0, 1);
+		GameObject right_leg = mgr.new_object("rightLeg", "person", Vector2{1, 1}, 0, 1);
+		GameObject left_leg = mgr.new_object("leftLeg", "person", Vector2{1, 1}, 0, 1);
+		GameObject right_foot = mgr.new_object("rightFoot", "person", Vector2{2, 2}, 0, 1);
+		GameObject left_foot = mgr.new_object("leftFoot", "person", Vector2{2, 2}, 0, 1);
 
 		// Set the parent of each GameObject
 		right_foot.set_parent(right_leg);
diff --git a/src/example/scene_manager.cpp b/src/example/scene_manager.cpp
index 62720eb..accec7d 100644
--- a/src/example/scene_manager.cpp
+++ b/src/example/scene_manager.cpp
@@ -16,12 +16,9 @@ public:
 
 	void load_scene() {
 		auto & mgr = this->component_manager;
-		GameObject object1
-			= mgr.new_object("scene_1", "tag_scene_1", Vector2{0, 0}, 0, 1);
-		GameObject object2
-			= mgr.new_object("scene_1", "tag_scene_1", Vector2{1, 0}, 0, 1);
-		GameObject object3
-			= mgr.new_object("scene_1", "tag_scene_1", Vector2{2, 0}, 0, 1);
+		GameObject object1 = mgr.new_object("scene_1", "tag_scene_1", Vector2{0, 0}, 0, 1);
+		GameObject object2 = mgr.new_object("scene_1", "tag_scene_1", Vector2{1, 0}, 0, 1);
+		GameObject object3 = mgr.new_object("scene_1", "tag_scene_1", Vector2{2, 0}, 0, 1);
 	}
 };
 
@@ -31,14 +28,10 @@ public:
 
 	void load_scene() {
 		auto & mgr = this->component_manager;
-		GameObject object1
-			= mgr.new_object("scene_2", "tag_scene_2", Vector2{0, 0}, 0, 1);
-		GameObject object2
-			= mgr.new_object("scene_2", "tag_scene_2", Vector2{0, 1}, 0, 1);
-		GameObject object3
-			= mgr.new_object("scene_2", "tag_scene_2", Vector2{0, 2}, 0, 1);
-		GameObject object4
-			= mgr.new_object("scene_2", "tag_scene_2", Vector2{0, 3}, 0, 1);
+		GameObject object1 = mgr.new_object("scene_2", "tag_scene_2", Vector2{0, 0}, 0, 1);
+		GameObject object2 = mgr.new_object("scene_2", "tag_scene_2", Vector2{0, 1}, 0, 1);
+		GameObject object3 = mgr.new_object("scene_2", "tag_scene_2", Vector2{0, 2}, 0, 1);
+		GameObject object4 = mgr.new_object("scene_2", "tag_scene_2", Vector2{0, 3}, 0, 1);
 	}
 };
 
diff --git a/src/test/PhysicsTest.cpp b/src/test/PhysicsTest.cpp
index edb76e9..1e37c26 100644
--- a/src/test/PhysicsTest.cpp
+++ b/src/test/PhysicsTest.cpp
@@ -49,8 +49,7 @@ public:
 TEST_F(PhysicsTest, gravity) {
 	Config::get_instance().physics.gravity = 1;
 	ComponentManager & mgr = this->component_manager;
-	vector<reference_wrapper<Transform>> transforms
-		= mgr.get_components_by_id<Transform>(0);
+	vector<reference_wrapper<Transform>> transforms = mgr.get_components_by_id<Transform>(0);
 	const Transform & transform = transforms.front().get();
 	ASSERT_FALSE(transforms.empty());
 	EXPECT_EQ(transform.position.y, 0);
@@ -64,8 +63,7 @@ TEST_F(PhysicsTest, gravity) {
 
 TEST_F(PhysicsTest, max_velocity) {
 	ComponentManager & mgr = this->component_manager;
-	vector<reference_wrapper<Rigidbody>> rigidbodies
-		= mgr.get_components_by_id<Rigidbody>(0);
+	vector<reference_wrapper<Rigidbody>> rigidbodies = mgr.get_components_by_id<Rigidbody>(0);
 	Rigidbody & rigidbody = rigidbodies.front().get();
 	ASSERT_FALSE(rigidbodies.empty());
 	EXPECT_EQ(rigidbody.data.linear_velocity.y, 0);
@@ -88,11 +86,9 @@ TEST_F(PhysicsTest, max_velocity) {
 TEST_F(PhysicsTest, movement) {
 	Config::get_instance().physics.gravity = 0;
 	ComponentManager & mgr = this->component_manager;
-	vector<reference_wrapper<Rigidbody>> rigidbodies
-		= mgr.get_components_by_id<Rigidbody>(0);
+	vector<reference_wrapper<Rigidbody>> rigidbodies = mgr.get_components_by_id<Rigidbody>(0);
 	Rigidbody & rigidbody = rigidbodies.front().get();
-	vector<reference_wrapper<Transform>> transforms
-		= mgr.get_components_by_id<Transform>(0);
+	vector<reference_wrapper<Transform>> transforms = mgr.get_components_by_id<Transform>(0);
 	const Transform & transform = transforms.front().get();
 	ASSERT_FALSE(rigidbodies.empty());
 	ASSERT_FALSE(transforms.empty());
-- 
cgit v1.2.3


From fc5dfd2873279d5003f8a02187a71b05a44892fa Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Sat, 16 Nov 2024 16:46:18 +0100
Subject: final touchups 2 for #26

---
 src/crepe/ComponentManager.h      | 45 ++++++++++++++++++++++++++++-----------
 src/crepe/api/BehaviorScript.h    | 37 ++++++++++++++++++--------------
 src/crepe/api/BehaviorScript.hpp  |  2 +-
 src/crepe/api/LoopManager.cpp     |  2 --
 src/crepe/api/LoopManager.h       | 26 ++++++++++++++++------
 src/crepe/api/Scene.h             |  8 ++++---
 src/crepe/api/Script.h            | 44 +++++++++++++++++++++-----------------
 src/crepe/api/Script.hpp          |  3 +--
 src/crepe/system/ParticleSystem.h |  2 --
 src/crepe/system/ScriptSystem.cpp |  5 ++---
 10 files changed, 106 insertions(+), 68 deletions(-)

(limited to 'src/crepe/ComponentManager.h')

diff --git a/src/crepe/ComponentManager.h b/src/crepe/ComponentManager.h
index 99d45d9..2107453 100644
--- a/src/crepe/ComponentManager.h
+++ b/src/crepe/ComponentManager.h
@@ -1,6 +1,5 @@
 #pragma once
 
-#include <forward_list>
 #include <memory>
 #include <typeindex>
 #include <unordered_map>
@@ -20,11 +19,40 @@ class GameObject;
  * This class manages all components. It provides methods to add, delete and get components.
  */
 class ComponentManager {
+	// TODO: This relation should be removed! I (loek) believe that the scene manager should
+	// create/destroy components because the GameObject's are stored in concrete Scene classes,
+	// which will in turn call GameObject's destructor, which will in turn call
+	// ComponentManager::delete_components_by_id or something. This is a pretty major change, so
+	// here is a comment and temporary fix instead :tada:
+	friend class SceneManager;
+
 public:
 	ComponentManager(); // dbg_trace
 	~ComponentManager(); // dbg_trace
 
+	/**
+	 * \brief Create a new game object using the component manager
+	 *
+	 * \param name Metadata::name (required)
+	 * \param tag Metadata::tag (optional, empty by default)
+	 * \param position Transform::position (optional, origin by default)
+	 * \param rotation Transform::rotation (optional, 0 by default)
+	 * \param scale Transform::scale (optional, 1 by default)
+	 *
+	 * \returns GameObject interface
+	 *
+	 * \note This method automatically assigns a new entity ID
+	 */
+	GameObject new_object(const std::string & name, const std::string & tag = "",
+						  const Vector2 & position = {0, 0}, double rotation = 0,
+						  double scale = 1);
+
 protected:
+	/**
+	 * GameObject is used as an interface to add/remove components, and the game programmer is
+	 * supposed to use it instead of interfacing with the component manager directly.
+	 */
+	friend class GameObject;
 	/**
 	 * \brief Add a component to the ComponentManager
 	 * 
@@ -39,11 +67,6 @@ protected:
 	 */
 	template <typename T, typename... Args>
 	T & add_component(game_object_id_t id, Args &&... args);
-	//! GameObject is used as an interface to add components instead of the
-	// component manager directly
-	friend class GameObject;
-
-public:
 	/**
 	 * \brief Delete all components of a specific type and id
 	 * 
@@ -77,6 +100,8 @@ public:
 	 * This method deletes all components.
 	 */
 	void delete_all_components();
+
+public:
 	/**
 	 * \brief Get all components of a specific type and id
 	 * 
@@ -99,11 +124,6 @@ public:
 	template <typename T>
 	std::vector<std::reference_wrapper<T>> get_components_by_type() const;
 
-	// TODO: doxygen
-	GameObject new_object(const std::string & name, const std::string & tag = "",
-						  const Vector2 & position = {0, 0}, double rotation = 0,
-						  double scale = 0);
-
 private:
 	/**
 	 * \brief The components
@@ -118,9 +138,8 @@ private:
 	std::unordered_map<std::type_index, std::vector<std::vector<std::unique_ptr<Component>>>>
 		components;
 
-	//! ID of next GameObject
+	//! ID of next GameObject allocated by \c ComponentManager::new_object
 	game_object_id_t next_id = 0;
-	std::forward_list<std::unique_ptr<GameObject>> objects;
 };
 
 } // namespace crepe
diff --git a/src/crepe/api/BehaviorScript.h b/src/crepe/api/BehaviorScript.h
index f7d484a..9d85d4c 100644
--- a/src/crepe/api/BehaviorScript.h
+++ b/src/crepe/api/BehaviorScript.h
@@ -15,12 +15,21 @@ class Script;
 /**
  * \brief Script component
  *
- * This class acts as a (component) wrapper around an instance of (a class
- * derivatived from) \c Script. \c BehaviorScript is the only ECS component
- * that stores member function implementations as data.
+ * This class acts as a (component) wrapper around an instance of (a class derivatived from) \c
+ * Script. \c BehaviorScript is the only ECS component that stores member function
+ * implementations as data.
  */
 class BehaviorScript : public Component {
 protected:
+	/**
+	 * \param id Parent \c GameObject id
+	 * \param component_manager Reference to component manager (passed through to \c Script
+	 * instance)
+	 *
+	 * \note Calls to this constructor (should) always pass through \c GameObject::add_component,
+	 * which has an exception for this specific component type. This was done so the user does
+	 * not have to pass references used within \c Script to each \c BehaviorScript instance.
+	 */
 	BehaviorScript(game_object_id_t id, ComponentManager & component_manager);
 	//! Only ComponentManager is allowed to instantiate BehaviorScript
 	friend class ComponentManager;
@@ -37,27 +46,23 @@ public:
 	BehaviorScript & set_script();
 
 protected:
-	//! ScriptSystem needs direct access to the script instance
-	friend class ScriptSystem;
-	//! Flag to indicate if script->init() has been called already
-	bool initialized = false;
 	//! Script instance
 	std::unique_ptr<Script> script = nullptr;
-	//! Reference to component manager
+	//! ScriptSystem needs direct access to the script instance
+	friend class ScriptSystem;
+
+protected:
+	//! Reference to component manager (passed to Script)
 	ComponentManager & component_manager;
-	//! Script accesses the component manager directly via its parent
-	// (BehaviorScript) reference
-	friend class Script;
 };
 
 /**
  * \brief Add a BehaviorScript component to this game object
  *
- * The \c BehaviorScript class is the only exception to the ECS harmony, and
- * requires a reference to the component manager passed to its constructor in
- * order to function normally. This is because the \c BehaviorScript (and \c
- * Script) classes are the only component-related classes that store
- * implemented member functions as data.
+ * The \c BehaviorScript class is the only exception to the ECS harmony, and requires a
+ * reference to the component manager passed to its constructor in order to function normally.
+ * This is because the \c BehaviorScript (and \c Script) classes are the only component-related
+ * classes that store implemented member functions as data.
  */
 template <>
 BehaviorScript & GameObject::add_component<BehaviorScript>();
diff --git a/src/crepe/api/BehaviorScript.hpp b/src/crepe/api/BehaviorScript.hpp
index eec26da..d80321d 100644
--- a/src/crepe/api/BehaviorScript.hpp
+++ b/src/crepe/api/BehaviorScript.hpp
@@ -14,7 +14,7 @@ BehaviorScript & BehaviorScript::set_script() {
 	dbg_trace();
 	static_assert(std::is_base_of<Script, T>::value);
 	Script * s = new T();
-	s->parent_ref = this;
+	s->game_object_id = this->game_object_id;
 	s->component_manager_ref = &this->component_manager;
 	this->script = std::unique_ptr<Script>(s);
 	return *this;
diff --git a/src/crepe/api/LoopManager.cpp b/src/crepe/api/LoopManager.cpp
index 6303e2b..a64366f 100644
--- a/src/crepe/api/LoopManager.cpp
+++ b/src/crepe/api/LoopManager.cpp
@@ -22,8 +22,6 @@ LoopManager::LoopManager() {
 	this->load_system<ScriptSystem>();
 }
 
-ComponentManager & LoopManager::get_component_manager() { return this->component_manager; }
-
 void LoopManager::process_input() {
 	SDLContext::get_instance().handle_events(this->game_running);
 }
diff --git a/src/crepe/api/LoopManager.h b/src/crepe/api/LoopManager.h
index 288dca2..f6904be 100644
--- a/src/crepe/api/LoopManager.h
+++ b/src/crepe/api/LoopManager.h
@@ -68,18 +68,32 @@ private:
 
 	bool game_running = false;
 
-protected:
-	ComponentManager & get_component_manager();
-	template <class T>
-	T & get_system();
-
 private:
+	//! Component manager instance
 	ComponentManager component_manager{};
-	std::unordered_map<std::type_index, std::unique_ptr<System>> systems;
 
 private:
+	/**
+	 * \brief Collection of System instances
+	 *
+	 * This map holds System instances indexed by the system's class typeid. It is filled in the
+	 * constructor of \c LoopManager using LoopManager::load_system.
+	 */
+	std::unordered_map<std::type_index, std::unique_ptr<System>> systems;
+	/**
+	 * \brief Initialize a system
+	 * \tparam T System type (must be derivative of \c System)
+	 */
 	template <class T>
 	void load_system();
+	/**
+	 * \brief Retrieve a reference to ECS system
+	 * \tparam T System type
+	 * \returns Reference to system instance
+	 * \throws std::runtime_error if the System is not initialized
+	 */
+	template <class T>
+	T & get_system();
 };
 
 } // namespace crepe
diff --git a/src/crepe/api/Scene.h b/src/crepe/api/Scene.h
index 334f306..422fffb 100644
--- a/src/crepe/api/Scene.h
+++ b/src/crepe/api/Scene.h
@@ -4,16 +4,18 @@
 
 namespace crepe {
 
+class SceneManager;
 class ComponentManager;
 
 class Scene {
-public:
+protected:
 	Scene(ComponentManager & mgr, const std::string & name);
+	friend class SceneManager;
+public:
 	virtual ~Scene() = default;
 
-	virtual void load_scene() = 0;
-
 public:
+	virtual void load_scene() = 0;
 	const std::string name;
 
 protected:
diff --git a/src/crepe/api/Script.h b/src/crepe/api/Script.h
index 12ec7f1..1435581 100644
--- a/src/crepe/api/Script.h
+++ b/src/crepe/api/Script.h
@@ -2,6 +2,8 @@
 
 #include <vector>
 
+#include "../types.h"
+
 namespace crepe {
 
 class ScriptSystem;
@@ -11,32 +13,31 @@ class ComponentManager;
 /**
  * \brief Script interface
  *
- * This class is used as a base class for user-defined scripts that can be
- * added to game objects using the \c BehaviorScript component.
+ * This class is used as a base class for user-defined scripts that can be added to game
+ * objects using the \c BehaviorScript component.
+ *
+ * \note Additional *events* (like Unity's OnDisable and OnEnable) should be implemented as
+ * member or lambda methods in derivative user script classes and registered in \c init().
  */
 class Script {
-	//! ScriptSystem calls \c update()
-	friend class crepe::ScriptSystem;
-
 protected:
 	/**
 	 * \brief Script initialization function
 	 *
 	 * 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 holding this script instance is active.
+	 * Script::update() if it (a) has not yet been called and (b) the \c BehaviorScript component
+	 * holding this script instance is active.
 	 */
 	virtual void init() {}
 	/**
 	 * \brief Script update function
 	 *
-	 * This function is called during the ScriptSystem::update() routine if the
-	 * \c BehaviorScript component holding this script instance is active.
+	 * This function is called during the ScriptSystem::update() routine if the \c BehaviorScript
+	 * component holding this script instance is active.
 	 */
 	virtual void update() {}
-	// NOTE: additional *events* (like unity's OnDisable and OnEnable) should be implemented as
-	// member methods in derivative user script classes and registered in init(), otherwise this
-	// class will balloon in size with each added event.
+	//! ScriptSystem calls \c init() and \c update()
+	friend class crepe::ScriptSystem;
 
 protected:
 	/**
@@ -46,8 +47,7 @@ protected:
 	 *
 	 * \returns Reference to component
 	 *
-	 * \throws nullptr if this game object does not have a component matching
-	 * type \c T
+	 * \throws nullptr if this game object does not have a component matching type \c T
 	 */
 	template <typename T>
 	T & get_component() const;
@@ -63,18 +63,22 @@ protected:
 	std::vector<std::reference_wrapper<T>> get_components() const;
 
 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.
+	// 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.
 	Script() = default;
 	//! Only \c BehaviorScript instantiates Script
 	friend class BehaviorScript;
 
 private:
-	// These references are set by BehaviorScript immediately after calling the
-	// constructor of Script.
-	BehaviorScript * parent_ref = nullptr;
+	// These references are set by BehaviorScript immediately after calling the constructor of
+	// Script.
+	game_object_id_t game_object_id = -1;
 	ComponentManager * component_manager_ref = nullptr;
+	// TODO: use OptionalRef instead of pointer
+
+private:
+	//! Flag to indicate if \c init() has been called already
+	bool initialized = false;
 };
 
 } // namespace crepe
diff --git a/src/crepe/api/Script.hpp b/src/crepe/api/Script.hpp
index c4e07e8..a064a90 100644
--- a/src/crepe/api/Script.hpp
+++ b/src/crepe/api/Script.hpp
@@ -20,10 +20,9 @@ T & Script::get_component() const {
 
 template <typename T>
 std::vector<std::reference_wrapper<T>> Script::get_components() const {
-	auto & parent = *this->parent_ref;
 	auto & mgr = *this->component_manager_ref;
 
-	return mgr.get_components_by_id<T>(parent.game_object_id);
+	return mgr.get_components_by_id<T>(this->game_object_id);
 }
 
 } // namespace crepe
diff --git a/src/crepe/system/ParticleSystem.h b/src/crepe/system/ParticleSystem.h
index 0a2dde1..c647284 100644
--- a/src/crepe/system/ParticleSystem.h
+++ b/src/crepe/system/ParticleSystem.h
@@ -4,8 +4,6 @@
 
 #include "System.h"
 
-#include "System.h"
-
 namespace crepe {
 
 class ParticleEmitter;
diff --git a/src/crepe/system/ScriptSystem.cpp b/src/crepe/system/ScriptSystem.cpp
index f4a826b..c4d724c 100644
--- a/src/crepe/system/ScriptSystem.cpp
+++ b/src/crepe/system/ScriptSystem.cpp
@@ -18,10 +18,9 @@ void ScriptSystem::update() {
 
 	for (auto & script_ref : scripts) {
 		Script & script = script_ref.get();
-		BehaviorScript & component = *script.parent_ref;
-		if (!component.initialized) {
+		if (!script.initialized) {
 			script.init();
-			component.initialized = true;
+			script.initialized = true;
 		}
 		script.update();
 	}
-- 
cgit v1.2.3