desktop code refactoring

Signed-off-by: Peter Siegmund <developer@mars3142.org>

.clang-format

@@ -1,4 +1,5 @@
 ---
+BasedOnStyle: Chromium
 Language:        Cpp
 AccessModifierOffset: -4
 AlignAfterOpenBracket: AlwaysBreak

CMakeLists.txt

@@ -45,14 +45,14 @@ include_dependency(u8g2 https://github.com/olikraus/u8g2 1e92781)
 add_subdirectory(components)
 
 configure_file(
-        "${PROJECT_SOURCE_DIR}/include/Version.h.in"
+        "${CMAKE_SOURCE_DIR}/Version.h.in"
-        "${PROJECT_BINARY_DIR}/include/Version.h"
+        "${CMAKE_SOURCE_DIR}/Version.h"
 )
 
 include_directories(
         ${CMAKE_INCLUDE_PATH}
         ${CMAKE_SOURCE_DIR}
-        ${PROJECT_BINARY_DIR}/include
+        ${PROJECT_BINARY_DIR}/src
 )
 
 add_executable(${PROJECT_NAME}

README.md

@@ -1,11 +1,15 @@
 ## Systen Control
 
-### ESP32-S3
+### ESP32-S3 (folder: main)
 
 This is an implementation of my custom system control project (custom pcb with Lolin ESP32-S3 Mini) and LED strip.
 
 The build process is straight forward with ESP-IDF. We used version 5.4 while development and the github actions tried to compile for multiple ESP-IDF versions, so we are safe.
 
-### Desktop
+### Desktop (folder: src)
 
 It's included also a desktop application (with SDL3), so you can test the project without any MCU.
+
+### Global Information
+
+The projects can be generated from the root, because here is the starting CMakeLists.txt file.

include/debug/DebugOverlay.h

@@ -1,19 +0,0 @@
-#pragma once
-
-#include <SDL3/SDL.h>
-
-#include "../model/AppContext.h"
-
-namespace DebugOverlay {
-    inline bool show_debug_window = false;
-    inline bool show_unhandled_events = false;
-    inline bool show_led_matrix = true;
-
-    void init(const AppContext *context);
-
-    void update(AppContext *context, const SDL_Event *event);
-
-    void render(const AppContext *context);
-
-    void cleanup();
-}

include/model/AppContext.h

@@ -1,44 +0,0 @@
-#pragma once
-
-#include "SDL3_ttf/SDL_ttf.h"
-#include "Window.h"
-
-class Matrix;
-
-class AppContext {
-public:
-    explicit AppContext(const Window *window) : m_window(window) {
-        m_font_default = TTF_OpenFont(
-            "assets/haxrcorp-4089.otf", 21);
-        m_font_text = TTF_OpenFont(
-            "assets/Helvetica-Bold.otf", 21);
-    }
-
-    ~AppContext() {
-        TTF_CloseFont(m_font_default);
-        TTF_CloseFont(m_font_text);
-    }
-
-    [[nodiscard]] auto window() const -> SDL_Window *;
-
-    [[nodiscard]] auto renderer() const -> SDL_Renderer *;
-
-    [[nodiscard]] auto surface() const -> SDL_Surface *;
-
-    void setMatrix(Matrix *matrix);
-
-    [[nodiscard]] auto matrix() const -> Matrix *;
-
-    [[nodiscard]] auto matrix_window() const -> SDL_Window *;
-
-    [[nodiscard]] auto matrix_renderer() const -> SDL_Renderer *;
-
-    void matrix_render() const;
-
-    TTF_Font *m_font_default = nullptr;
-
-private:
-    const Window *m_window;
-    Matrix *m_matrix = nullptr;
-    TTF_Font *m_font_text = nullptr;
-};

src/debug/DebugOverlay.cpp

@@ -1,81 +1,80 @@
 #include "debug/DebugOverlay.h"
 
+#include <imgui_impl_sdlrenderer3.h>
+#include "Common.h"
+#include "Version.h"
 #include "imgui.h"
 #include "imgui_impl_sdl3.h"
-#include <imgui_impl_sdlrenderer3.h>
-
-#include "Common.h"
 #include "ui/Matrix.h"
-#include "Version.h"
 
 namespace DebugOverlay {
-    void init(const AppContext *context) {
+void init(const AppContext* context) {
-        IMGUI_CHECKVERSION();
+    IMGUI_CHECKVERSION();
-        ImGui::CreateContext();
+    ImGui::CreateContext();
-        ImGuiIO &io{ImGui::GetIO()};
+    ImGuiIO& io{ImGui::GetIO()};
 
-        io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard;
+    io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard;
 
-        ImGui::StyleColorsDark();
+    ImGui::StyleColorsDark();
 
-        ImGui_ImplSDL3_InitForSDLRenderer(context->window(), context->renderer());
+    ImGui_ImplSDL3_InitForSDLRenderer(context->window(), context->renderer());
-        ImGui_ImplSDLRenderer3_Init(context->renderer());
+    ImGui_ImplSDLRenderer3_Init(context->renderer());
-    }
+}
 
-    void update(AppContext *context, const SDL_Event *event) {
+void update(AppContext* context, const SDL_Event* event) {
-        ImGui_ImplSDL3_ProcessEvent(event);
+    ImGui_ImplSDL3_ProcessEvent(event);
 
-        if (show_led_matrix) {
+    if(show_led_matrix) {
-            if (context->matrix_window() == nullptr) {
+        if(context->matrix_window() == nullptr) {
-                const auto win = createWindow("LED Matrix", 32 * 50, 8 * 50);
+            const auto win = createWindow("LED Matrix", 32 * 50, 8 * 50);
-                SDL_SetWindowFocusable(win->window(), false);
+            SDL_SetWindowFocusable(win->window(), false);
-                SDL_SetRenderVSync(win->renderer(), SDL_RENDERER_VSYNC_ADAPTIVE);
+            SDL_SetRenderVSync(win->renderer(), SDL_RENDERER_VSYNC_ADAPTIVE);
-                SDL_SetWindowPosition(win->window(), 0, 0);
+            SDL_SetWindowPosition(win->window(), 0, 0);
-                SDL_ShowWindow(win->window());
+            SDL_ShowWindow(win->window());
 
-                context->setMatrix(new Matrix(win));
+            context->setMatrix(new Matrix(win));
-            }
-        } else {
-            if (context->matrix_window() != nullptr) {
-                SDL_DestroyWindow(context->matrix_window());
-
-                context->setMatrix(nullptr);
-            }
         }
-    }
+    } else {
+        if(context->matrix_window() != nullptr) {
+            SDL_DestroyWindow(context->matrix_window());
 
-    void render(const AppContext *context) {
+            context->setMatrix(nullptr);
-        ImGui_ImplSDLRenderer3_NewFrame();
-        ImGui_ImplSDL3_NewFrame();
-        ImGui::NewFrame();
-
-        if (show_debug_window && ImGui::BeginMainMenuBar()) {
-            if (ImGui::BeginMenu("Config")) {
-                ImGui::Checkbox("Show LED Matrix", &show_led_matrix);
-                ImGui::Checkbox("Show Unhandled Events", &show_unhandled_events);
-
-                ImGui::EndMenu();
-            }
-            if (ImGui::BeginMenu("Help")) {
-                ImGui::Text("FPS: %.2f", ImGui::GetIO().Framerate);
-                ImGui::SeparatorText("App Info");
-                ImGui::Text("Project: %s", MY_PROJECT);
-                ImGui::Text("Version: %s", MY_VERSION);
-                ImGui::Text("ImGui Version: %s", ImGui::GetVersion());
-
-                ImGui::EndMenu();
-            }
-            ImGui::EndMainMenuBar();
         }
-
-        // Rendering
-        ImGui::Render();
-        ImGui_ImplSDLRenderer3_RenderDrawData(ImGui::GetDrawData(), context->renderer());
-    }
-
-    void cleanup() {
-        ImGui_ImplSDLRenderer3_Shutdown();
-        ImGui_ImplSDL3_Shutdown();
-        ImGui::DestroyContext();
     }
 }
+
+void render(const AppContext* context) {
+    ImGui_ImplSDLRenderer3_NewFrame();
+    ImGui_ImplSDL3_NewFrame();
+    ImGui::NewFrame();
+
+    if(show_debug_window && ImGui::BeginMainMenuBar()) {
+        if(ImGui::BeginMenu("Config")) {
+            ImGui::Checkbox("Show LED Matrix", &show_led_matrix);
+            ImGui::Checkbox("Show Unhandled Events", &show_unhandled_events);
+
+            ImGui::EndMenu();
+        }
+        if(ImGui::BeginMenu("Help")) {
+            ImGui::Text("FPS: %.2f", ImGui::GetIO().Framerate);
+            ImGui::SeparatorText("App Info");
+            ImGui::Text("Project: %s", MY_PROJECT);
+            ImGui::Text("Version: %s", MY_VERSION);
+            ImGui::Text("ImGui Version: %s", ImGui::GetVersion());
+
+            ImGui::EndMenu();
+        }
+        ImGui::EndMainMenuBar();
+    }
+
+    // Rendering
+    ImGui::Render();
+    ImGui_ImplSDLRenderer3_RenderDrawData(ImGui::GetDrawData(), context->renderer());
+}
+
+void cleanup() {
+    ImGui_ImplSDLRenderer3_Shutdown();
+    ImGui_ImplSDL3_Shutdown();
+    ImGui::DestroyContext();
+}
+} // namespace DebugOverlay

src/debug/DebugOverlay.h

@@ -0,0 +1,19 @@
+#pragma once
+
+#include <SDL3/SDL.h>
+
+#include "model/AppContext.h"
+
+namespace DebugOverlay {
+inline bool show_debug_window = false;
+inline bool show_unhandled_events = false;
+inline bool show_led_matrix = true;
+
+void init(const AppContext* context);
+
+void update(AppContext* context, const SDL_Event* event);
+
+void render(const AppContext* context);
+
+void cleanup();
+}

src/hal/u8g2_hal_sdl.h

@@ -2,9 +2,9 @@
 
 #include "u8g2.h"
 
-#define U8G2_SCREEN_WIDTH  (128)
+#define U8G2_SCREEN_WIDTH   (128)
-#define U8G2_SCREEN_HEIGHT (64)
+#define U8G2_SCREEN_HEIGHT  (64)
-#define U8G2_SCREEN_FACTOR (3)
+#define U8G2_SCREEN_FACTOR  (3)
 #define U8G2_SCREEN_PADDING (25)
 
 uint8_t u8x8_byte_sdl_hw_spi(u8x8_t* u8x8, uint8_t msg, uint8_t arg_int, void* arg_ptr);

src/model/AppContext.cpp

@@ -2,42 +2,42 @@
 
 #include "ui/Matrix.h"
 
-auto AppContext::window() const -> SDL_Window * {
+auto AppContext::window() const -> SDL_Window* {
     return m_window->window();
 }
 
-auto AppContext::renderer() const -> SDL_Renderer * {
+auto AppContext::renderer() const -> SDL_Renderer* {
     return m_window->renderer();
 }
 
-auto AppContext::surface() const -> SDL_Surface * {
+auto AppContext::surface() const -> SDL_Surface* {
     return SDL_GetWindowSurface(m_window->window());
 }
 
-void AppContext::setMatrix(Matrix *matrix) {
+void AppContext::setMatrix(Matrix* matrix) {
     m_matrix = matrix;
 }
 
-auto AppContext::matrix() const -> Matrix * {
+auto AppContext::matrix() const -> Matrix* {
     return m_matrix;
 }
 
-auto AppContext::matrix_window() const -> SDL_Window * {
+auto AppContext::matrix_window() const -> SDL_Window* {
-    if (m_matrix && m_matrix->window()) {
+    if(m_matrix && m_matrix->window()) {
         return m_matrix->window()->window();
     }
     return nullptr;
 }
 
-auto AppContext::matrix_renderer() const -> SDL_Renderer * {
+auto AppContext::matrix_renderer() const -> SDL_Renderer* {
-    if (m_matrix && m_matrix->window()) {
+    if(m_matrix && m_matrix->window()) {
         return m_matrix->window()->renderer();
     }
     return nullptr;
 }
 
 void AppContext::matrix_render() const {
-    if (m_matrix && m_matrix->window()) {
+    if(m_matrix && m_matrix->window()) {
         m_matrix->render();
     }
 }

src/model/AppContext.h

@@ -0,0 +1,43 @@
+#pragma once
+
+#include "SDL3_ttf/SDL_ttf.h"
+#include "Window.h"
+
+class Matrix;
+
+class AppContext {
+public:
+    explicit AppContext(const Window* window)
+        : m_window(window) {
+        m_font_default = TTF_OpenFont("assets/haxrcorp-4089.otf", 21);
+        m_font_text = TTF_OpenFont("assets/Helvetica-Bold.otf", 21);
+    }
+
+    ~AppContext() {
+        TTF_CloseFont(m_font_default);
+        TTF_CloseFont(m_font_text);
+    }
+
+    [[nodiscard]] auto window() const -> SDL_Window*;
+
+    [[nodiscard]] auto renderer() const -> SDL_Renderer*;
+
+    [[nodiscard]] auto surface() const -> SDL_Surface*;
+
+    void setMatrix(Matrix* matrix);
+
+    [[nodiscard]] auto matrix() const -> Matrix*;
+
+    [[nodiscard]] auto matrix_window() const -> SDL_Window*;
+
+    [[nodiscard]] auto matrix_renderer() const -> SDL_Renderer*;
+
+    void matrix_render() const;
+
+    TTF_Font* m_font_default = nullptr;
+
+private:
+    const Window* m_window;
+    Matrix* m_matrix = nullptr;
+    TTF_Font* m_font_text = nullptr;
+};

src/model/Window.cpp

@@ -1,9 +1,9 @@
 #include "model/Window.h"
 
-auto Window::window() const -> SDL_Window * {
+auto Window::window() const -> SDL_Window* {
     return m_window;
 }
 
-auto Window::renderer() const -> SDL_Renderer * {
+auto Window::renderer() const -> SDL_Renderer* {
     return SDL_GetRenderer(m_window);
 }

src/model/Window.h

@@ -10,7 +10,7 @@ public:
 
     [[nodiscard]] auto window() const -> SDL_Window*;
 
-    [[nodiscard]] auto renderer() const -> SDL_Renderer *;
+    [[nodiscard]] auto renderer() const -> SDL_Renderer*;
 
 private:
     SDL_Window* m_window = nullptr;

src/ui/Device.h

@@ -5,7 +5,7 @@
 #include <vector>
 
 #include "UIWidget.h"
-#include "../model/AppContext.h"
+#include "model/AppContext.h"
 #include "common/Widget.h"
 
 class Device final : public UIWidget {

src/ui/Matrix.h

@@ -1,16 +1,17 @@
 #pragma once
-#include "../model/Window.h"
+
+#include "model/Window.h"
 
 class Matrix {
 public:
-    explicit Matrix(Window *window);
+    explicit Matrix(Window* window);
 
-    [[nodiscard]] Window *window() const;
+    [[nodiscard]] Window* window() const;
 
     void render() const;
 
 private:
     void draw_colored_grid(int rows, int cols, float cellSize, float spacing) const;
 
-    Window *m_window;
+    Window* m_window;
 };

src/ui/UIWidget.h

@@ -1,6 +1,6 @@
 #pragma once
 
-#include "../model/AppContext.h"
+#include "model/AppContext.h"
 
 class UIWidget {
 public:

src/ui/widgets/Button.cpp

@@ -21,8 +21,10 @@ Button::Button(
 }
 
 void Button::render() const {
-    const auto button = ResourceManager::getInstance().get_texture(get_context()->renderer(), "assets/button_normal.png");
+    const auto button = ResourceManager::getInstance().get_texture(
-    const auto overlay =ResourceManager::getInstance().get_texture(get_context()->renderer(), "assets/button_pressed_overlay.png");
+        get_context()->renderer(), "assets/button_normal.png");
+    const auto overlay = ResourceManager::getInstance().get_texture(
+        get_context()->renderer(), "assets/button_pressed_overlay.png");
 
     const auto dst = SDL_FRect(m_x, m_y, m_width, m_width);
     SDL_RenderTexture(get_context()->renderer(), button, nullptr, &dst);

src/ui/widgets/Button.h

@@ -1,6 +1,6 @@
 #pragma once
 
-#include "../UIWidget.h"
+#include "ui/UIWidget.h"
 
 #include <functional>
 

src/ui/widgets/D_Pad.cpp

@@ -1,6 +1,6 @@
 #include "ui/widgets/D_Pad.h"
 
-#include <ResourceManager.h>
+#include "ResourceManager.h"
 
 D_Pad::D_Pad(
     void* appState,

src/ui/widgets/D_Pad.h

@@ -1,7 +1,6 @@
 #pragma once
 
 #include "functional"
-
 #include "ui/UIWidget.h"
 
 #define DPAD_WIDTH (105)