feat: Implement TUIKLoader for dynamic UI loading from .tuik files; add example and update documentation

Author: skhelladi

CMakeLists.txt

@@ -30,6 +30,33 @@ include_directories(external/json)
 # PROJECT STRUCTURE
 # =============================================================================
 
+# -----------------------------------------------------------------------------
+# Automatic generation of ui_<project_name>.h headers from .tuik files declared by the user
+# -----------------------------------------------------------------------------
+# Example usage in the project's CMakeLists.txt:
+# set(TUIKIT_UI examples/simple_ui.tuik path/to/other_ui.tuik)
+if(NOT DEFINED TUIKIT_UI)
+    set(TUIKIT_UI "${CMAKE_SOURCE_DIR}/examples/example_2.tuik")
+endif()
+set(EMBEDDED_HEADERS "")
+foreach(TUIK_FILE ${TUIKIT_UI})
+    get_filename_component(TUIK_NAME ${TUIK_FILE} NAME_WE)
+    get_filename_component(TUIK_DIR ${TUIK_FILE} DIRECTORY)
+    set(VAR_NAME "${TUIK_NAME}_tuik")
+    set(HEADER_FILE "${TUIK_DIR}/${TUIK_NAME}_tuik.h")
+    add_custom_command(
+        OUTPUT ${HEADER_FILE}
+        COMMAND ${CMAKE_COMMAND} -E make_directory ${TUIK_DIR}
+        COMMAND xxd -i -n ${VAR_NAME} ${TUIK_FILE} > ${HEADER_FILE}
+        DEPENDS ${TUIK_FILE}
+        COMMENT "Generating ${HEADER_FILE} from ${TUIK_FILE} with variable ${VAR_NAME}"
+        VERBATIM
+    )
+    list(APPEND EMBEDDED_HEADERS ${HEADER_FILE})
+endforeach()
+add_custom_target(generate_embedded_headers ALL DEPENDS ${EMBEDDED_HEADERS})
+
+
 # Headers
 set(TUIKIT_HEADERS
     include/tuikit.h
@@ -140,7 +167,7 @@ install(DIRECTORY include/tuikit/core/ DESTINATION include/tuikit/core FILES_MAT
 install(DIRECTORY include/tuikit/layouts/ DESTINATION include/tuikit/layouts FILES_MATCHING PATTERN "*.h")
 install(DIRECTORY include/tuikit/widgets/ DESTINATION include/tuikit/widgets FILES_MATCHING PATTERN "*.h")
 
-# Installation de la librairie
+# Library installation
 install(TARGETS tuikit
     EXPORT TUIFrameworkTargets
     LIBRARY DESTINATION lib
@@ -149,7 +176,7 @@ install(TARGETS tuikit
     INCLUDES DESTINATION include
 )
 
-# Configuration pour find_package
+# Configuration for find_package
 install(EXPORT TUIFrameworkTargets
     FILE TUIFrameworkTargets.cmake
     NAMESPACE TUIFramework::
@@ -229,22 +256,22 @@ include(CPack)
 # HELPER SCRIPTS
 # =============================================================================
 
-# Script de build rapide
+# Quick build script
 # configure_file(
 #     "${CMAKE_CURRENT_SOURCE_DIR}/scripts/build.sh.in"
 #     "${CMAKE_CURRENT_BINARY_ROOT}/build.sh"
 #     @ONLY
 # )
 
-# Script d'installation
+# Installation script
 # configure_file(
 #     "${CMAKE_CURRENT_SOURCE_DIR}/scripts/install.sh.in"
 #     "${CMAKE_CURRENT_BINARY_ROOT}/install.sh"
 #     @ONLY
 # )
 
 # =============================================================================
-# INFORMATIONS DE BUILD
+# BUILD INFORMATION
 # =============================================================================
 
 message(STATUS "=================================")
@@ -258,3 +285,4 @@ message(STATUS "Build tests: ${BUILD_TESTS}")
 message(STATUS "Build docs: ${BUILD_DOCS}")
 message(STATUS "Install prefix: ${CMAKE_INSTALL_PREFIX}")
 message(STATUS "=================================")
+

README.md

@@ -10,6 +10,7 @@ Based on [FTXUI](https://github.com/ArthurSonzogni/FTXUI), TUIKit is a modern C+
 *   **Event Handling:** Manage user interactions through a signal/slot-like mechanism or callbacks.
 *   **Automatic Layouts:** Employ flexible layout managers (`TUIVBox`, `TUIHBox`) for responsive UI design.
 *   **Advanced Theming:** Customize colors, borders, and styles to create visually appealing interfaces.
+*  **UI Definition Files:** Support for defining UI layouts in JSON-like `.tuik` files, allowing dynamic loading and modification of interfaces.
 
 ## ✨ Implemented Components (Current State)
 
@@ -106,6 +107,75 @@ int main() {
     return app.exec();
 }
 ```
+
+---
+
+## 🆕 Example: Embedding a `.tuik` UI file
+
+TUIKit supports embedding JSON UI definitions (`.tuik` files) directly into your binary using CMake and `xxd`.  
+For each `.tuik` file listed in `TUIKIT_UI`, a header `<name>_tuik.h` is generated with a binary variable.
+
+**Example `.tuik` file (`examples/simple_ui.tuik`):**
+```json
+{
+  "class": "TUIVBoxLayout",
+  "children": [
+    { "class": "TUILabel", "properties": { "text": "Hello from .tuik!" } },
+    { "class": "TUIButton", "properties": { "text": "Click Me" }, "name": "btn" }
+  ]
+}
+```
+
+**C++ usage:**
+```cpp
+#include "tuikit.h"
+#include "examples/simple_ui_tuik.h"
+#include <nlohmann/json.hpp>
+
+using namespace TUIKIT;
+
+int main() {
+    TUIApp app("TUI .tuik Example");
+
+    // Load UI from embedded binary resource
+    std::string tuik_str(reinterpret_cast<const char*>(simple_ui_tuik), simple_ui_tuik_len);
+    nlohmann::json tuik_json = nlohmann::json::parse(tuik_str);
+
+    TUIKLoader loader;
+    auto main_ui_widget = loader.createWidgetFromJson(tuik_json);
+    app.setMainWidget(main_ui_widget);
+
+    // Connect a slot to the button named "btn"
+    auto btn = std::dynamic_pointer_cast<TUIButton>(loader.getWidget("btn"));
+    if (btn) {
+        connect(btn, [&] { /* action */ });
+    }
+
+    return app.exec();
+}
+```
+
+**CMake integration:**
+```cmake
+find_program(XXD_EXE xxd REQUIRED)
+set(TUIKIT_UI "examples/simple_ui.tuik")
+foreach(TUIK_FILE ${TUIKIT_UI})
+    get_filename_component(TUIK_NAME ${TUIK_FILE} NAME_WE)
+    get_filename_component(TUIK_DIR ${TUIK_FILE} DIRECTORY)
+    set(VAR_NAME "${TUIK_NAME}_tuik")
+    set(HEADER_FILE "${TUIK_DIR}/${TUIK_NAME}_tuik.h")
+    add_custom_command(
+        OUTPUT ${HEADER_FILE}
+        COMMAND ${CMAKE_COMMAND} -E make_directory ${TUIK_DIR}
+        COMMAND ${XXD_EXE} -i -n ${VAR_NAME} ${TUIK_FILE} > ${HEADER_FILE}
+        DEPENDS ${TUIK_FILE}
+        COMMENT "Generate ${HEADER_FILE} from ${TUIK_FILE} with variable ${VAR_NAME} (xxd required)"
+        VERBATIM
+    )
+    list(APPEND EMBEDDED_HEADERS ${HEADER_FILE})
+endforeach()
+add_custom_target(generate_embedded_headers ALL DEPENDS ${EMBEDDED_HEADERS})
+```
 <!-- 
 ## 🗺️ Development Roadmap
 

examples/example_2.cpp

@@ -2,44 +2,54 @@
 #include <iostream>
 #include <string>
 #include <fstream>
+#include "example_2_tuik.h"
+#include <nlohmann/json.hpp>
+
+// Ensure the following extern declarations match those in your generated simple_ui_tuik.h
 
 using namespace TUIKIT;
 
-int main() {
+int main()
+{
     std::ofstream cerr_log("debug_log_example2.txt");
-    std::streambuf* old_cerr_buf = std::cerr.rdbuf();
+    std::streambuf *old_cerr_buf = std::cerr.rdbuf();
     std::cerr.rdbuf(cerr_log.rdbuf());
 
     TUIApp app("TUIKIT UI Loader Example");
 
-    // Load UI from .tuik file
-    auto main_ui_widget = app.loadUI("../examples/simple_ui.tuik");
+    // Load UI from binary resource
+    std::string tuik_str(reinterpret_cast<const char *>(example_2_tuik), sizeof(example_2_tuik));
+    nlohmann::json tuik_json = nlohmann::json::parse(tuik_str);
+    TUIKLoader loader;
+    auto main_ui_widget = loader.createWidgetFromJson(tuik_json);
 
-    if (!main_ui_widget) {
-        std::cerr << "Failed to load UI from simple_ui.tuik" << std::endl;
-        std::cout << "Failed to load UI from simple_ui.tuik" << std::endl;
+    if (!main_ui_widget)
+    {
+        std::cerr << "Failed to load UI from embedded JSON" << std::endl;
         return 1;
     }
 
     app.setMainWidget(main_ui_widget);
 
-    // Get named widgets
-    auto name_input = std::dynamic_pointer_cast<TUITextField>(app.getWidget("name_input"));
-    auto submit_button = std::dynamic_pointer_cast<TUIButton>(app.getWidget("submit_button"));
-    auto output_label = std::dynamic_pointer_cast<TUILabel>(app.getWidget("output_label"));
+    // Get named widgets from loader
+    auto name_input = std::dynamic_pointer_cast<TUITextField>(loader.getWidget("name_input"));
+    auto submit_button = std::dynamic_pointer_cast<TUIButton>(loader.getWidget("submit_button"));
+    auto output_label = std::dynamic_pointer_cast<TUILabel>(loader.getWidget("output_label"));
 
-    if (name_input && submit_button && output_label) {
-        connect(submit_button, [&] {
-            output_label->setText("Hello, " + name_input->text() + "!");
-        });
-    } else {
+    if (name_input && submit_button && output_label)
+    {
+        connect(submit_button, [&]
+                { output_label->setText("Hello, " + name_input->text() + "!"); });
+    }
+    else
+    {
         std::cerr << "Error: Could not find all required widgets by name." << std::endl;
     }
 
-    app.setOnExit([&] {
+    app.setOnExit([&]
+                  {
         std::cerr << "Application is exiting. Goodbye from example_2!" << std::endl;
-        std::cerr.rdbuf(old_cerr_buf);
-    });
+        std::cerr.rdbuf(old_cerr_buf); });
 
     int result = app.exec();
 

examples/simple_ui.tuik examples/example_2.tuikexamples/simple_ui.tuik renamed to examples/example_2.tuik

@@ -33,19 +33,21 @@
 #include <string>
 #include <vector>
 
-namespace TUIKIT {
+namespace TUIKIT
+{
 
-class TUIKLoader {
-public:
-    TUIKLoader();
-    std::shared_ptr<TUIWidget> load(const std::string& filepath);
-    std::shared_ptr<TUIWidget> getWidget(const std::string& name);
+    class TUIKLoader
+    {
+    public:
+        TUIKLoader();
+        std::shared_ptr<TUIWidget> load(const std::string &filepath);
+        std::shared_ptr<TUIWidget> getWidget(const std::string &name);
+        std::shared_ptr<TUIWidget> createWidgetFromJson(const nlohmann::json &widget_json);
 
-private:
-    std::map<std::string, std::shared_ptr<TUIWidget>> named_widgets_;
+    private:
+        std::map<std::string, std::shared_ptr<TUIWidget>> named_widgets_;
 
-    std::shared_ptr<TUIWidget> createWidgetFromJson(const nlohmann::json& widget_json);
-    void applyProperties(std::shared_ptr<TUIWidget> widget, const nlohmann::json& properties_json);
-};
+        void applyProperties(std::shared_ptr<TUIWidget> widget, const nlohmann::json &properties_json);
+    };
 
 } // namespace TUIKIT