feat: add debug module to rix facade

Author: GaspardKirira

CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.20)
 
 project(rix
-  VERSION 0.1.0
+  VERSION 0.5.0
   DESCRIPTION "Unified Rix facade for Vix C++ projects"
   LANGUAGES CXX
 )
@@ -25,6 +25,7 @@ target_include_directories(rix
 target_link_libraries(rix
   INTERFACE
     rix::csv
+    rix::debug
 )
 
 if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)

examples/CMakeLists.txt

@@ -6,3 +6,21 @@ target_link_libraries(rix_basic
   PRIVATE
     rix::rix
 )
+
+add_executable(rix_csv_example
+  csv.cpp
+)
+
+target_link_libraries(rix_csv_example
+  PRIVATE
+    rix::rix
+)
+
+add_executable(rix_debug_example
+  debug.cpp
+)
+
+target_link_libraries(rix_debug_example
+  PRIVATE
+    rix::rix
+)

examples/basic.cpp

@@ -1,38 +1,14 @@
 /**
  * @file basic.cpp
- * @brief Basic example for the Rix facade.
+ * @brief Basic example for the unified Rix facade.
  */
 
 #include <rix.hpp>
 
-#include <iostream>
-#include <string>
-
-namespace
-{
-  void run_basic_example()
-  {
-    const std::string input =
-        "name,language\n"
-        "Ada,C++\n"
-        "Gaspard,Vix\n";
-
-    const auto table = rix.csv.parse(input);
-
-    for (const auto &row : table)
-    {
-      for (const auto &field : row)
-      {
-        std::cout << field << ' ';
-      }
-
-      std::cout << '\n';
-    }
-  }
-}
-
 int main()
 {
-  run_basic_example();
+  rix.debug.print("Hello {}", "Rix");
+  rix.debug.log("facade is ready");
+
   return 0;
 }

examples/csv.cpp

@@ -0,0 +1,39 @@
+/**
+ * @file csv.cpp
+ * @brief CSV example for the unified Rix facade.
+ */
+
+#include <rix.hpp>
+
+#include <string>
+
+namespace
+{
+  void print_table(const rixlib::csv::Table &table)
+  {
+    for (const auto &row : table)
+    {
+      for (const auto &field : row)
+      {
+        rix.debug.print.inline_text("{} ", field);
+      }
+
+      rix.debug.print();
+    }
+  }
+}
+
+int main()
+{
+  const std::string input =
+      "name,language\n"
+      "Ada,C++\n"
+      "Gaspard,Vix\n";
+
+  const auto table = rix.csv.parse(input);
+
+  rix.debug.log("loaded {} rows", table.size());
+  print_table(table);
+
+  return 0;
+}

examples/debug.cpp

@@ -0,0 +1,22 @@
+/**
+ * @file debug.cpp
+ * @brief Debug example for the unified Rix facade.
+ */
+
+#include <rix.hpp>
+
+#include <string>
+
+int main()
+{
+  rix.debug.print("Hello {}", "Rix");
+
+  const std::string package = rix.debug.format("Package: {}", "rix/rix");
+
+  rix.debug.print(package);
+  rix.debug.log("loaded {} debug APIs", 4);
+  rix.debug.log.warn("this is a warning: {}", "slow path");
+  rix.debug.inspect(package);
+
+  return 0;
+}

include/rix.hpp

@@ -5,13 +5,14 @@
  * This header exposes the global `rix` object.
  *
  * The package `@rix/rix` is the optional unified facade for Rix packages.
- * Individual packages such as `@rix/csv` stay independent, but this facade
- * mounts them into one object-style API.
+ * Individual packages such as `@rix/csv` and `@rix/debug` stay independent,
+ * but this facade mounts them into one object-style API.
  *
  * Example:
  *
  * @code
  * auto table = rix.csv.parse("name,lang\nAda,C++\n");
+ * rix.debug.print("loaded {} rows", table.size());
  * @endcode
  *
  * @author Gaspard Kirira
@@ -21,6 +22,7 @@
 #define RIXCPP_RIX_INCLUDE_RIX_HPP_INCLUDED
 
 #include <rix/csv.hpp>
+#include <rix/debug.hpp>
 
 namespace rixlib
 {
@@ -36,6 +38,11 @@ namespace rixlib
      * @brief CSV reader and writer component.
      */
     rixlib::csv::Csv csv{};
+
+    /**
+     * @brief Debug printing, formatting, logging, and inspection component.
+     */
+    rixlib::debug::Debug debug{};
   };
 }
 
@@ -46,6 +53,10 @@ namespace rixlib
  *
  * @code
  * rix.csv.parse(...)
+ * rix.debug.print(...)
+ * rix.debug.format(...)
+ * rix.debug.log(...)
+ * rix.debug.inspect(...)
  * @endcode
  */
 inline constexpr rixlib::Rix rix{};

packages/debug/README.md

@@ -0,0 +1,83 @@
+# rix/debug
+
+Debug printing, formatting, logging, and inspection utilities for Rix.
+
+`rix/debug` is part of Rix, the userland package layer for the Vix.cpp ecosystem.
+
+The source code lives in its own repository. This folder only keeps the official package entry used by the Rix umbrella repository.
+
+## Install
+
+```bash
+vix add @rix/debug
+vix install
+```
+
+## Use
+
+```cpp
+#include <rix/debug.hpp>
+
+int main()
+{
+  rixlib::debug::Debug debug;
+
+  debug.print("Hello {}", "Rix");
+
+  auto text = debug.format("Package: {}", "rix/debug");
+
+  debug.log("loaded {} rows", 3);
+  debug.log.warn("slow request: {}ms", 120);
+
+  debug.inspect(text);
+}
+```
+
+## Repository
+
+```txt
+https://github.com/rixcpp/debug
+```
+
+## Package
+
+```txt
+rix/debug
+```
+
+## Namespace
+
+```cpp
+rixlib::debug
+```
+
+## CMake target
+
+```cmake
+rix::debug
+```
+
+## Manifest
+
+```txt
+packages/debug/vix.json
+```
+
+## Role in Rix
+
+Rix does not embed package source code.
+
+The real library lives in:
+
+```txt
+github.com/rixcpp/debug
+```
+
+The Rix facade mounts this package as:
+
+```cpp
+rix.debug.print(...)
+rix.debug.format(...)
+rix.debug.log(...)
+rix.debug.inspect(...)
+```

packages/debug/vix.json

@@ -0,0 +1,30 @@
+{
+  "name": "debug",
+  "namespace": "rix",
+  "version": "0.1.0",
+  "type": "header-only",
+  "include": "include",
+  "license": "MIT",
+  "description": "Debug printing, formatting, logging, and inspection utilities for Rix.",
+  "keywords": [
+    "cpp",
+    "debug",
+    "print",
+    "format",
+    "log",
+    "inspect",
+    "rix",
+    "vix"
+  ],
+  "repository": "https://github.com/rixcpp/debug",
+  "maintainers": [
+    {
+      "name": "Rix maintainers",
+      "github": "rixcpp"
+    }
+  ],
+  "cmake": {
+    "target": "rix::debug"
+  },
+  "deps": []
+}