From 2de95718a730b17e348a7100d172edf816ca82c6 Mon Sep 17 00:00:00 2001 From: Niels Eppenhof Date: Thu, 19 Dec 2024 16:56:45 +0100 Subject: [PATCH] Code quality --- EppoEngine/Source/Scripting/ScriptEngine.h | 10 +- EppoEngine/Source/Scripting/ScriptField.h | 2 +- EppoEngine/Source/Scripting/ScriptGlue.cpp | 118 +++++++++--------- .../Source/Scripting/ScriptInstance.cpp | 16 +-- EppoEngine/Source/Scripting/ScriptInstance.h | 12 +- EppoEngine/Source/Utility/Random.h | 16 +-- 6 files changed, 87 insertions(+), 87 deletions(-) diff --git a/EppoEngine/Source/Scripting/ScriptEngine.h b/EppoEngine/Source/Scripting/ScriptEngine.h index a8b75ef0..b91bf765 100644 --- a/EppoEngine/Source/Scripting/ScriptEngine.h +++ b/EppoEngine/Source/Scripting/ScriptEngine.h @@ -60,12 +60,12 @@ namespace Eppo static bool LoadCoreAssembly(const std::filesystem::path& filepath); static void LoadAssemblyClasses(); - static void OnAppAssemblyFileSystemEvent(const std::filesystem::path& filepath, const filewatch::Event changeType); + static void OnAppAssemblyFileSystemEvent(const std::filesystem::path& filepath, filewatch::Event changeType); }; namespace Utils { - inline ScriptFieldType ScriptFieldTypeFromString(std::string_view typeString) + inline ScriptFieldType ScriptFieldTypeFromString(const std::string_view typeString) { if (typeString == "Float") return ScriptFieldType::Float; if (typeString == "Double") return ScriptFieldType::Double; @@ -83,11 +83,11 @@ namespace Eppo if (typeString == "Vector4") return ScriptFieldType::Vector4; if (typeString == "Entity") return ScriptFieldType::Entity; - EPPO_ASSERT(false); + EPPO_ASSERT(false) return ScriptFieldType::None; } - inline std::string ScriptFieldTypeToString(ScriptFieldType type) + inline std::string ScriptFieldTypeToString(const ScriptFieldType type) { switch (type) { @@ -108,7 +108,7 @@ namespace Eppo case ScriptFieldType::Entity: return "Entity"; } - EPPO_ASSERT(false); + EPPO_ASSERT(false) return "None"; } } diff --git a/EppoEngine/Source/Scripting/ScriptField.h b/EppoEngine/Source/Scripting/ScriptField.h index f2509d11..640a2df0 100644 --- a/EppoEngine/Source/Scripting/ScriptField.h +++ b/EppoEngine/Source/Scripting/ScriptField.h @@ -4,7 +4,7 @@ typedef struct _MonoClassField MonoClassField; namespace Eppo { - enum class ScriptFieldType + enum class ScriptFieldType : uint8_t { None = 0, Float, Double, diff --git a/EppoEngine/Source/Scripting/ScriptGlue.cpp b/EppoEngine/Source/Scripting/ScriptGlue.cpp index e3073a96..6d93d430 100644 --- a/EppoEngine/Source/Scripting/ScriptGlue.cpp +++ b/EppoEngine/Source/Scripting/ScriptGlue.cpp @@ -15,12 +15,12 @@ namespace Eppo #define EPPO_ADD_INTERNAL_CALL(fn) mono_add_internal_call("Eppo.InternalCalls::"#fn, fn); - static void Log(uint32_t logLevel, MonoString* message) + static void Log(const uint32_t logLevel, MonoString* message) { EPPO_PROFILE_FUNCTION("ScriptGlue::Log"); char* cStr = mono_string_to_utf8(message); - std::string messageStr(cStr); + const std::string messageStr(cStr); mono_free(cStr); switch (logLevel) @@ -32,24 +32,24 @@ namespace Eppo } } - static bool Input_IsKeyPressed(KeyCode keyCode) + static bool Input_IsKeyPressed(const KeyCode keyCode) { EPPO_PROFILE_FUNCTION("ScriptGlue::Input_IsKeyPressed"); return Input::IsKeyPressed(keyCode); } - static void Entity_AddComponent(UUID uuid, MonoString* componentType) + static void Entity_AddComponent(const UUID uuid, MonoString* componentType) { EPPO_PROFILE_FUNCTION("ScriptGlue::Entity_AddComponent"); - Ref scene = ScriptEngine::GetSceneContext(); - EPPO_ASSERT(scene); + const Ref scene = ScriptEngine::GetSceneContext(); + EPPO_ASSERT(scene) Entity entity = scene->FindEntityByUUID(uuid); - EPPO_ASSERT(entity); + EPPO_ASSERT(entity) char* cStr = mono_string_to_utf8(componentType); - std::string componentTypeStr(cStr); + const std::string componentTypeStr(cStr); mono_free(cStr); if (componentTypeStr == "TransformComponent") @@ -70,15 +70,15 @@ namespace Eppo { EPPO_PROFILE_FUNCTION("ScriptGlue::Entity_CreateNewEntity"); - Ref scene = ScriptEngine::GetSceneContext(); - EPPO_ASSERT(scene); + const Ref scene = ScriptEngine::GetSceneContext(); + EPPO_ASSERT(scene) char* cStr = mono_string_to_utf8(name); - std::string nameStr(cStr); + const std::string nameStr(cStr); mono_free(cStr); Entity entity = scene->CreateEntity(nameStr); - EPPO_ASSERT(entity); + EPPO_ASSERT(entity) return entity.GetUUID(); } @@ -87,11 +87,11 @@ namespace Eppo { EPPO_PROFILE_FUNCTION("ScriptGlue::Entity_FindEntityByName"); - Ref scene = ScriptEngine::GetSceneContext(); - EPPO_ASSERT(scene); + const Ref scene = ScriptEngine::GetSceneContext(); + EPPO_ASSERT(scene) char* cStr = mono_string_to_utf8(name); - std::string nameStr(cStr); + const std::string nameStr(cStr); mono_free(cStr); Entity entity = scene->FindEntityByName(nameStr); @@ -101,86 +101,86 @@ namespace Eppo return entity.GetUUID(); } - static MonoString* Entity_GetName(UUID uuid) + static MonoString* Entity_GetName(const UUID uuid) { EPPO_PROFILE_FUNCTION("ScriptGlue::Entity_GetName"); - Ref scene = ScriptEngine::GetSceneContext(); - EPPO_ASSERT(scene); + const Ref scene = ScriptEngine::GetSceneContext(); + EPPO_ASSERT(scene) Entity entity = scene->FindEntityByUUID(uuid); - EPPO_ASSERT(entity); + EPPO_ASSERT(entity) MonoString* monoStr = mono_string_new(ScriptEngine::GetAppDomain(), entity.GetName().c_str()); return monoStr; } - static bool Entity_HasComponent(UUID uuid, MonoReflectionType* componentType) + static bool Entity_HasComponent(const UUID uuid, MonoReflectionType* componentType) { EPPO_PROFILE_FUNCTION("ScriptGlue::Entity_HasComponent"); - Ref scene = ScriptEngine::GetSceneContext(); - EPPO_ASSERT(scene); - Entity entity = scene->FindEntityByUUID(uuid); - EPPO_ASSERT(entity); + const Ref scene = ScriptEngine::GetSceneContext(); + EPPO_ASSERT(scene) + const Entity entity = scene->FindEntityByUUID(uuid); + EPPO_ASSERT(entity) MonoType* managedType = mono_reflection_type_get_type(componentType); - auto it = s_EntityHasComponentFns.find(managedType); - EPPO_ASSERT(it != s_EntityHasComponentFns.end()); + const auto it = s_EntityHasComponentFns.find(managedType); + EPPO_ASSERT(it != s_EntityHasComponentFns.end()) return it->second(entity); } - static void TransformComponent_GetTranslation(UUID uuid, glm::vec3* outTranslation) + static void TransformComponent_GetTranslation(const UUID uuid, glm::vec3* outTranslation) { EPPO_PROFILE_FUNCTION("ScriptGlue::TransformComponent_GetTranslation"); - Ref scene = ScriptEngine::GetSceneContext(); - EPPO_ASSERT(scene); + const Ref scene = ScriptEngine::GetSceneContext(); + EPPO_ASSERT(scene) Entity entity = scene->FindEntityByUUID(uuid); - EPPO_ASSERT(entity); + EPPO_ASSERT(entity) *outTranslation = entity.GetComponent().Translation; } - static void TransformComponent_SetTranslation(UUID uuid, glm::vec3* translation) + static void TransformComponent_SetTranslation(const UUID uuid, const glm::vec3* translation) { EPPO_PROFILE_FUNCTION("ScriptGlue::TransformComponent_SetTranslation"); - Ref scene = ScriptEngine::GetSceneContext(); - EPPO_ASSERT(scene); + const Ref scene = ScriptEngine::GetSceneContext(); + EPPO_ASSERT(scene) Entity entity = scene->FindEntityByUUID(uuid); - EPPO_ASSERT(entity); + EPPO_ASSERT(entity) entity.GetComponent().Translation = *translation; } - static void RigidBodyComponent_ApplyLinearImpulse(UUID uuid, glm::vec3* impulse, glm::vec3* worldPosition) + static void RigidBodyComponent_ApplyLinearImpulse(const UUID uuid, const glm::vec3* impulse, const glm::vec3* worldPosition) { EPPO_PROFILE_FUNCTION("ScriptGlue::RigidBodyComponent_ApplyLinearImpulse"); - Ref scene = ScriptEngine::GetSceneContext(); - EPPO_ASSERT(scene); + const Ref scene = ScriptEngine::GetSceneContext(); + EPPO_ASSERT(scene) Entity entity = scene->FindEntityByUUID(uuid); - EPPO_ASSERT(entity); + EPPO_ASSERT(entity) - auto& rb = entity.GetComponent(); + const auto& rb = entity.GetComponent(); rb.RuntimeBody.ApplyLinearImpulse(*impulse, *worldPosition); } - static void RigidBodyComponent_ApplyLinearImpulseToCenter(UUID uuid, glm::vec3* impulse) + static void RigidBodyComponent_ApplyLinearImpulseToCenter(const UUID uuid, const glm::vec3* impulse) { EPPO_PROFILE_FUNCTION("ScriptGlue::RigidBodyComponent_ApplyLinearImpulseToCenter"); - Ref scene = ScriptEngine::GetSceneContext(); - EPPO_ASSERT(scene); + const Ref scene = ScriptEngine::GetSceneContext(); + EPPO_ASSERT(scene) Entity entity = scene->FindEntityByUUID(uuid); - EPPO_ASSERT(entity); + EPPO_ASSERT(entity) - auto& rb = entity.GetComponent(); + const auto& rb = entity.GetComponent(); rb.RuntimeBody.ApplyLinearImpulse(*impulse); } - static MonoObject* GetScriptInstance(UUID uuid) + static MonoObject* GetScriptInstance(const UUID uuid) { EPPO_PROFILE_FUNCTION("ScriptGlue::GetScriptInstance"); @@ -191,18 +191,18 @@ namespace Eppo { EPPO_PROFILE_FUNCTION("ScriptGlue::RegisterFunctions"); - EPPO_ADD_INTERNAL_CALL(Log); - EPPO_ADD_INTERNAL_CALL(Input_IsKeyPressed); - EPPO_ADD_INTERNAL_CALL(Entity_AddComponent); - EPPO_ADD_INTERNAL_CALL(Entity_CreateNewEntity); - EPPO_ADD_INTERNAL_CALL(Entity_FindEntityByName); - EPPO_ADD_INTERNAL_CALL(Entity_GetName); - EPPO_ADD_INTERNAL_CALL(Entity_HasComponent); - EPPO_ADD_INTERNAL_CALL(TransformComponent_GetTranslation); - EPPO_ADD_INTERNAL_CALL(TransformComponent_SetTranslation); - EPPO_ADD_INTERNAL_CALL(RigidBodyComponent_ApplyLinearImpulse); - EPPO_ADD_INTERNAL_CALL(RigidBodyComponent_ApplyLinearImpulseToCenter); - EPPO_ADD_INTERNAL_CALL(GetScriptInstance); + EPPO_ADD_INTERNAL_CALL(Log) + EPPO_ADD_INTERNAL_CALL(Input_IsKeyPressed) + EPPO_ADD_INTERNAL_CALL(Entity_AddComponent) + EPPO_ADD_INTERNAL_CALL(Entity_CreateNewEntity) + EPPO_ADD_INTERNAL_CALL(Entity_FindEntityByName) + EPPO_ADD_INTERNAL_CALL(Entity_GetName) + EPPO_ADD_INTERNAL_CALL(Entity_HasComponent) + EPPO_ADD_INTERNAL_CALL(TransformComponent_GetTranslation) + EPPO_ADD_INTERNAL_CALL(TransformComponent_SetTranslation) + EPPO_ADD_INTERNAL_CALL(RigidBodyComponent_ApplyLinearImpulse) + EPPO_ADD_INTERNAL_CALL(RigidBodyComponent_ApplyLinearImpulseToCenter) + EPPO_ADD_INTERNAL_CALL(GetScriptInstance) } void ScriptGlue::RegisterComponents() @@ -224,8 +224,8 @@ namespace Eppo { EPPO_PROFILE_FUNCTION("ScriptGlue::RegisterComponent"); - std::string_view typeName = typeid(T).name(); - size_t pos = typeName.find_last_of(':'); + const std::string_view typeName = typeid(T).name(); + const size_t pos = typeName.find_last_of(':'); std::string_view structName = typeName.substr(pos + 1); std::string managedTypeName = fmt::format("Eppo.{}", structName); diff --git a/EppoEngine/Source/Scripting/ScriptInstance.cpp b/EppoEngine/Source/Scripting/ScriptInstance.cpp index 00e2e22f..252ceb23 100644 --- a/EppoEngine/Source/Scripting/ScriptInstance.cpp +++ b/EppoEngine/Source/Scripting/ScriptInstance.cpp @@ -7,7 +7,7 @@ namespace Eppo { - ScriptInstance::ScriptInstance(Ref scriptClass, Entity entity) + ScriptInstance::ScriptInstance(const Ref& scriptClass, Entity entity) : m_ScriptClass(scriptClass) { EPPO_PROFILE_FUNCTION("ScriptInstance::ScriptInstance"); @@ -23,7 +23,7 @@ namespace Eppo m_ScriptClass->InvokeMethod(m_Instance, m_Constructor, ¶m); } - void ScriptInstance::InvokeOnCreate() + void ScriptInstance::InvokeOnCreate() const { EPPO_PROFILE_FUNCTION("ScriptInstance::InvokeOnCreate"); @@ -31,7 +31,7 @@ namespace Eppo m_ScriptClass->InvokeMethod(m_Instance, m_OnCreate); } - void ScriptInstance::InvokeOnUpdate(float timestep) + void ScriptInstance::InvokeOnUpdate(float timestep) const { EPPO_PROFILE_FUNCTION("ScriptInstance::InvokeOnUpdate"); @@ -42,12 +42,12 @@ namespace Eppo } } - bool ScriptInstance::GetFieldValueInternal(const std::string& name, void* buffer) + bool ScriptInstance::GetFieldValueInternal(const std::string& name, void* buffer) const { EPPO_PROFILE_FUNCTION("ScriptInstance::GetFieldValueInternal"); const auto& fields = m_ScriptClass->GetFields(); - auto it = fields.find(name); + const auto it = fields.find(name); if (it == fields.end()) return false; @@ -57,17 +57,17 @@ namespace Eppo return true; } - bool ScriptInstance::SetFieldValueInternal(const std::string& name, const void* value) + bool ScriptInstance::SetFieldValueInternal(const std::string& name, const void* value) const { EPPO_PROFILE_FUNCTION("ScriptInstance::SetFieldValueInternal"); const auto& fields = m_ScriptClass->GetFields(); - auto it = fields.find(name); + const auto it = fields.find(name); if (it == fields.end()) return false; const ScriptField& field = it->second; - mono_field_set_value(m_Instance, field.ClassField, (void*)value); + mono_field_set_value(m_Instance, field.ClassField, const_cast(value)); return true; } diff --git a/EppoEngine/Source/Scripting/ScriptInstance.h b/EppoEngine/Source/Scripting/ScriptInstance.h index 07195cef..803f193f 100644 --- a/EppoEngine/Source/Scripting/ScriptInstance.h +++ b/EppoEngine/Source/Scripting/ScriptInstance.h @@ -11,13 +11,13 @@ namespace Eppo class ScriptInstance { public: - ScriptInstance(Ref scriptClass, Entity entity); + ScriptInstance(const Ref& scriptClass, Entity entity); - void InvokeOnCreate(); - void InvokeOnUpdate(float timestep); + void InvokeOnCreate() const; + void InvokeOnUpdate(float timestep) const; Ref GetScriptClass() { return m_ScriptClass; } - MonoObject* GetManagedObject() { return m_Instance; } + [[nodiscard]] MonoObject* GetManagedObject() const { return m_Instance; } template T GetFieldValue(const std::string& name) @@ -38,8 +38,8 @@ namespace Eppo } private: - bool GetFieldValueInternal(const std::string& name, void* buffer); - bool SetFieldValueInternal(const std::string& name, const void* value); + bool GetFieldValueInternal(const std::string& name, void* buffer) const; + bool SetFieldValueInternal(const std::string& name, const void* value) const; private: Ref m_ScriptClass; diff --git a/EppoEngine/Source/Utility/Random.h b/EppoEngine/Source/Utility/Random.h index 4219e72e..20029fff 100644 --- a/EppoEngine/Source/Utility/Random.h +++ b/EppoEngine/Source/Utility/Random.h @@ -9,30 +9,30 @@ namespace Eppo::Utility static std::mt19937_64 s_Engine64(s_RandomDevice()); // Generate a random 32 bit unsigned integer - inline uint32_t GenerateRandomUInt32(uint32_t min = 0, uint32_t max = UINT32_MAX) + inline uint32_t GenerateRandomUInt32(const uint32_t min = 0, const uint32_t max = UINT32_MAX) { - std::uniform_int_distribution uniformDistribution(min, max); + std::uniform_int_distribution uniformDistribution(min, max); return uniformDistribution(s_Engine32); } // Generate a random 32 bit signed integer - inline int32_t GenerateRandomInt32(int32_t min = INT32_MIN, int32_t max = INT32_MAX) + inline int32_t GenerateRandomInt32(const int32_t min = INT32_MIN, const int32_t max = INT32_MAX) { - std::uniform_int_distribution uniformDistribution(min, max); + std::uniform_int_distribution uniformDistribution(min, max); return uniformDistribution(s_Engine32); } // Generate a random 64 bit unsigned integer - inline uint64_t GenerateRandomUInt64(uint64_t min = 0, uint64_t max = UINT64_MAX) + inline uint64_t GenerateRandomUInt64(const uint64_t min = 0, const uint64_t max = UINT64_MAX) { - std::uniform_int_distribution uniformDistribution(min, max); + std::uniform_int_distribution uniformDistribution(min, max); return uniformDistribution(s_Engine64); } // Generate a random 64 bit signed integer - inline int64_t GenerateRandomInt64(int64_t min = INT64_MIN, int64_t max = INT64_MAX) + inline int64_t GenerateRandomInt64(const int64_t min = INT64_MIN, const int64_t max = INT64_MAX) { - std::uniform_int_distribution uniformDistribution(min, max); + std::uniform_int_distribution uniformDistribution(min, max); return uniformDistribution(s_Engine64); } }