Cleanup SConstruct

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "cpp/vendor/spdlog"]
+	path = cpp/vendor/spdlog
+	url = https://github.com/gabime/spdlog

README.md

@@ -1,7 +1,10 @@
 # GED Engine Snippets
 
 ## Building
-Run `scons` in the root directory. This will generate the shared library as well as executables which run tests.
+Run `scons` in the root directory. This will generate two things:
+
+1. the shared library in `lib/`
+2. test binaries in `test/bin/` which use the library created in step 1
 
 ## Developing
 The `scons` command also generates a `compile_commands.json` which can be used by the VSCodium extension `clangd` for autocompletion, debugging, etc.

SConstruct

@@ -1,15 +1,50 @@
 #!python
 
+# General utility functions
+def add_third_party_includes(env):
+    env.Append(CPPPATH=['cpp/', 'cpp/vendor/spdlog/include'])
+
+
+def add_strict_compile_flags(env):
+    env.Append(CCFLAGS=["-Wall", "-Wextra", "-Werror", "-pedantic"])
+
+
 # Create the environment and create a Compilation Database for use in VSCodium
-env = DefaultEnvironment(tools=['default', 'compilation_db'])
+env = Environment(tools=['default', 'compilation_db'])
 env.CompilationDatabase()
 
-env.Append(CCFLAGS=["-Wall", "-Wextra", "-Werror", "-pedantic"])
+env.Append(CPPPATH=['cpp/', 'include/'])
-env.Append(CPPPATH=['.', 'include'])
+
+add_third_party_includes(env)
+add_strict_compile_flags(env)
+
+# Build the library
+gedeng = env.SharedLibrary('lib/gedeng', Glob('cpp/*.cpp'))
+
+# Install the library to the test application's build directory
+env.Install('test/bin/lib/', gedeng)
+
+# -------------------------------------------------------------------------------
+
+# Test environment setup
+testEnv = Environment(tools=['default'])
+
+testEnv.Append(CPPPATH=['include/', 'test/'])
+
+# Link to the Gedeng library
+testEnv.Append(LIBPATH=['lib/'])
+testEnv.Append(LIBS=['gedeng'])
+
+# Make the test executables search for the gedeng lib in their ./lib folder
+testEnv.Append(LINKFLAGS=[
+    '-Wl,--disable-new-dtags,-rpath,\'$$ORIGIN/lib/\''
+])
+
+add_third_party_includes(testEnv)
+add_strict_compile_flags(testEnv)
 
 # Build the test programs
 catch_cpp = "test/catch_amalgamated.cpp"
-Program('vector-test.out', [catch_cpp, 'test/vector-test.cpp'])
+testEnv.Program('test/bin/vector-test.out', [catch_cpp, 'test/vector/vector-test.cpp'])
 
-# Build the library
+testEnv.Program('test/bin/test-app.out', Glob('test/test-app/*.cpp'))
-SharedLibrary('ged', Glob('cpp/*.cpp'))

cpp/Application.cpp

@@ -0,0 +1,11 @@
+#include "Gedeng/Application.h"
+
+namespace Gedeng {
+
+void Application::run() {
+    while (true) {
+        // TODO: Implement
+    }
+}
+
+} // namespace Gedeng

cpp/Logger.cpp

@@ -1,6 +1,21 @@
-#include "Logger.h"
+#include "Gedeng/Logger.h"
-#include <iostream>
+#include "spdlog/common.h"
+#include "spdlog/sinks/stdout_color_sinks.h"
+#include "spdlog/spdlog.h"
 
-void Logger::debug(const String &text) {
+namespace Gedeng {
-    std::cout << "Debug: " << text << std::endl;
+
+std::shared_ptr<spdlog::logger> Logger::core_logger;
+std::shared_ptr<spdlog::logger> Logger::client_logger;
+
+void Logger::init() {
+    spdlog::set_pattern("%^[%T] %n: %v%$");
+
+    core_logger = spdlog::stdout_color_mt("GEDENG");
+    core_logger->set_level(spdlog::level::trace);
+
+    client_logger = spdlog::stdout_color_mt("APP");
+    client_logger->set_level(spdlog::level::trace);
 }
+
+} // namespace Gedeng

cpp/String.cpp

@@ -1,4 +1,6 @@
-#include "String.h"
+#include "Gedeng/String.h"
+
+namespace Gedeng {
 
 String::String() : String("") {
 }
@@ -116,4 +118,6 @@ const char *String::c_str() const {
 
 size_t String::getLength() const {
     return length;
-}
+}
+
+} // namespace Gedeng

cpp/vendor/spdlog

@@ -0,0 +1 @@
+Subproject commit 44e1f9f6829cd8acbfea282d390560452e889aff

include/Gedeng.h

@@ -0,0 +1,8 @@
+#pragma once
+
+#include "Gedeng/Application.h"
+#include "Gedeng/Logger.h"
+#include "Gedeng/String.h"
+#include "Gedeng/Vector.h"
+
+#include "Gedeng/EntryPoint.h"

include/Gedeng/Application.h

@@ -0,0 +1,18 @@
+#pragma once
+
+namespace Gedeng {
+
+class Application {
+  public:
+    Application() = default;
+
+    // Virtual since this class will be inherited by user-created applications
+    virtual ~Application() = default;
+
+    void run();
+};
+
+// To be defined in client applications
+Application *create_application();
+
+} // namespace Gedeng

include/Gedeng/Core.h

@@ -0,0 +1 @@
+#pragma once

include/Gedeng/EntryPoint.h

@@ -0,0 +1,22 @@
+#pragma once
+
+#include "Gedeng/Application.h"
+
+extern Gedeng::Application *Gedeng::create_application();
+
+// If the user program defines GEDENG_MAIN, supply this main function
+#ifdef GEDENG_MAIN
+int main() {
+    // Initialize logging
+    Gedeng::Logger::init();
+    GG_CORE_WARN("Logger initialized");
+
+    Gedeng::Application *app = Gedeng::create_application();
+
+    app->run();
+
+    delete app;
+
+    return 0;
+}
+#endif

include/Gedeng/Logger.h

@@ -0,0 +1,49 @@
+#pragma once
+
+#include "Gedeng/String.h"
+#include "spdlog/spdlog.h"
+#include <memory>
+
+namespace Gedeng {
+
+class Logger {
+  public:
+    static void init();
+
+    inline static std::shared_ptr<spdlog::logger> &get_core_logger() {
+        return core_logger;
+    }
+    inline static std::shared_ptr<spdlog::logger> &get_client_logger() {
+        return client_logger;
+    }
+
+    static void debug(const String &text);
+
+  private:
+    static std::shared_ptr<spdlog::logger> core_logger;
+    static std::shared_ptr<spdlog::logger> client_logger;
+};
+
+} // namespace Gedeng
+
+// Core log macros
+#define GG_CORE_FATAL(...)                                                     \
+    ::Gedeng::Logger::get_core_logger()->fatal(__VA_ARGS__)
+#define GG_CORE_ERROR(...)                                                     \
+    ::Gedeng::Logger::get_core_logger()->error(__VA_ARGS__)
+#define GG_CORE_WARN(...) ::Gedeng::Logger::get_core_logger()->warn(__VA_ARGS__)
+#define GG_CORE_INFO(...) ::Gedeng::Logger::get_core_logger()->info(__VA_ARGS__)
+#define GG_CORE_TRACE(...)                                                     \
+    ::Gedeng::Logger::get_core_logger()->trace(__VA_ARGS__)
+
+// Client log macros
+#define GG_CLIENT_FATAL(...)                                                   \
+    ::Gedeng::Logger::get_client_logger()->fatal(__VA_ARGS__)
+#define GG_CLIENT_ERROR(...)                                                   \
+    ::Gedeng::Logger::get_client_logger()->error(__VA_ARGS__)
+#define GG_CLIENT_WARN(...)                                                    \
+    ::Gedeng::Logger::get_client_logger()->warn(__VA_ARGS__)
+#define GG_CLIENT_INFO(...)                                                    \
+    ::Gedeng::Logger::get_client_logger()->info(__VA_ARGS__)
+#define GG_CLIENT_TRACE(...)                                                   \
+    ::Gedeng::Logger::get_client_logger()->trace(__VA_ARGS__)

include/Gedeng/String.h

@@ -1,5 +1,9 @@
+#pragma once
+
 #include <cstring>
 
+namespace Gedeng {
+
 class String {
   public:
     /// Create a new empty String
@@ -50,4 +54,6 @@ class String {
     size_t length;
 
     char *text;
-};
+};
+
+} // namespace Gedeng

include/Gedeng/Vector.h

@@ -1,8 +1,11 @@
 #pragma once
+
 #include <algorithm>
 #include <cassert>
 #include <iostream>
 
+namespace Gedeng {
+
 template <class T>
 class Vector {
   public:
@@ -214,3 +217,5 @@ class Vector {
         data = new_data;
     }
 };
+
+} // namespace Gedeng

include/Logger.h

@@ -1,5 +0,0 @@
-#include "String.h"
-
-class Logger {
-    static void debug(const String &text);
-};

test/test-app/main.cpp

@@ -0,0 +1,15 @@
+#include "Gedeng/Logger.h"
+#define GEDENG_MAIN
+#include <Gedeng.h>
+
+class TestApp : public Gedeng::Application {
+  public:
+    TestApp() = default;
+
+    ~TestApp() = default;
+};
+
+Gedeng::Application *Gedeng::create_application() {
+    GG_CLIENT_INFO("Creating Application");
+    return new TestApp();
+}

test/vector/vector-test.cpp

@@ -1,4 +1,4 @@
-#include "Vector.h"
+#include <Gedeng.h>
 #include <iostream>
 
 #define CATCH_CONFIG_MAIN // This tells Catch to provide a main() - only do this
@@ -6,7 +6,7 @@
 #include "catch_amalgamated.hpp"
 
 SCENARIO("Vector size and length are correct", "[vector]") {
-    Vector<int> v(20);
+    Gedeng::Vector<int> v(20);
     v.push_back(1);
 
     REQUIRE(v.size() == 1);
@@ -15,7 +15,7 @@ SCENARIO("Vector size and length are correct", "[vector]") {
 
 SCENARIO("The bracket operator returns the correct element", "[vector]") {
     GIVEN("A vector with some elements") {
-        Vector<int> v(20);
+        Gedeng::Vector<int> v(20);
         v.push_back(1);
         v.push_back(2);
         v.push_back(3);
@@ -32,8 +32,8 @@ SCENARIO("The bracket operator returns the correct element", "[vector]") {
 
 SCENARIO("Equality is returned correctly", "[vector]") {
     GIVEN("Two vectors with the same items") {
-        Vector<int> v1;
+        Gedeng::Vector<int> v1;
-        Vector<int> v2;
+        Gedeng::Vector<int> v2;
 
         v1.push_back(1);
         v2.push_back(1);
@@ -54,8 +54,8 @@ SCENARIO("Equality is returned correctly", "[vector]") {
     }
 
     GIVEN("Two vectors with different items") {
-        Vector<int> v1;
+        Gedeng::Vector<int> v1;
-        Vector<int> v2;
+        Gedeng::Vector<int> v2;
 
         v1.push_back(1);
         v2.push_back(2);
@@ -79,8 +79,8 @@ SCENARIO("Equality is returned correctly", "[vector]") {
 SCENARIO("Erasing an item removes it and moves the following ones forward",
          "[vector]") {
     GIVEN("Two vectors with almost identical items") {
-        Vector<int> v1;
+        Gedeng::Vector<int> v1;
-        Vector<int> v2;
+        Gedeng::Vector<int> v2;
 
         v1.push_back(1);
         v2.push_back(1);
@@ -117,8 +117,8 @@ SCENARIO("Erasing an item removes it and moves the following ones forward",
 
 SCENARIO("Copy Assignment", "[vector]") {
     GIVEN("Two vectors with identical items") {
-        Vector<int> v1;
+        Gedeng::Vector<int> v1;
-        Vector<int> v2;
+        Gedeng::Vector<int> v2;
 
         v1.push_back(1);
         v2.push_back(1);
@@ -130,7 +130,7 @@ SCENARIO("Copy Assignment", "[vector]") {
         REQUIRE(v2.size() == 2);
 
         WHEN("Copy assigning the second vector to a third vector") {
-            Vector<int> v3;
+            Gedeng::Vector<int> v3;
             v3 = v2;
 
             THEN("All vectors should be identical") {
@@ -143,8 +143,8 @@ SCENARIO("Copy Assignment", "[vector]") {
 
 SCENARIO("Move Assignment", "[vector]") {
     GIVEN("Two vectors with identical items") {
-        Vector<int> v1;
+        Gedeng::Vector<int> v1;
-        Vector<int> v2;
+        Gedeng::Vector<int> v2;
 
         v1.push_back(1);
         v2.push_back(1);
@@ -156,7 +156,7 @@ SCENARIO("Move Assignment", "[vector]") {
         REQUIRE(v2.size() == 2);
 
         WHEN("Move assigning the second vector to a third vector") {
-            Vector<int> v3;
+            Gedeng::Vector<int> v3;
             v3 = std::move(v2);
 
             THEN("The first and third vector should be identical") {
@@ -169,7 +169,7 @@ SCENARIO("Move Assignment", "[vector]") {
 
 SCENARIO("Reserve additional space", "[vector]") {
     GIVEN("A vector with a given length") {
-        Vector<int> v(5);
+        Gedeng::Vector<int> v(5);
 
         REQUIRE(v.length() == 5);
 
@@ -185,13 +185,13 @@ SCENARIO("Reserve additional space", "[vector]") {
 
 SCENARIO("Resizing a vector", "[vector]") {
     GIVEN("A vector with 3 items") {
-        Vector<int> v;
+        Gedeng::Vector<int> v;
 
         v.push_back(1);
         v.push_back(2);
         v.push_back(3);
 
-        Vector<int> target;
+        Gedeng::Vector<int> target;
 
         target.push_back(1);
         target.push_back(2);
@@ -256,7 +256,7 @@ SCENARIO("Non-default constructor", "[vector]") {
         };
 
         WHEN("Creating a vector and adding an element") {
-            Vector<NonDefault> non_default_vector;
+            Gedeng::Vector<NonDefault> non_default_vector;
 
             non_default_vector.push_back(NonDefault(1));
 
@@ -266,7 +266,7 @@ SCENARIO("Non-default constructor", "[vector]") {
         }
 
         WHEN("Creating a vector and resizing it") {
-            Vector<NonDefault> non_default_vector;
+            Gedeng::Vector<NonDefault> non_default_vector;
 
             non_default_vector.resize(50, NonDefault(42));
 
@@ -279,7 +279,7 @@ SCENARIO("Non-default constructor", "[vector]") {
 
 SCENARIO("Erase by swap", "[vector]") {
     GIVEN("A vector with some elements") {
-        Vector<int> v(3);
+        Gedeng::Vector<int> v(3);
         v.push_back(1);
         v.push_back(2);
         v.push_back(3);
@@ -330,7 +330,7 @@ class ReferenceCounter {
 SCENARIO("Constructors and Destructors are called as expected", "[vector]") {
     GIVEN("A vector with a custom reference-counting class") {
 
-        Vector<ReferenceCounter> v(3);
+        Gedeng::Vector<ReferenceCounter> v(3);
         v.push_back(ReferenceCounter());
         v.push_back(ReferenceCounter());
         v.push_back(ReferenceCounter());
@@ -370,7 +370,7 @@ SCENARIO("Constructors and Destructors are called as expected", "[vector]") {
         }
 
         WHEN("Move-constructing another vector") {
-            Vector<ReferenceCounter> v2 = std::move(v);
+            Gedeng::Vector<ReferenceCounter> v2 = std::move(v);
 
             THEN("The reference count should have remained the same") {
                 REQUIRE(count == 3);