feat(logs): allow using a custom output stream for warnings

SuperFola · SuperFola · commit 1ba43e05833d · 2026-03-09T20:10:50.000+01:00
diff --git a/include/Ark/Compiler/AST/Optimizer.hpp b/include/Ark/Compiler/AST/Optimizer.hpp
@@ -40,14 +40,14 @@ namespace Ark::internal
          *
          * @param ast
          */
-        void process(const Node& ast) override;
+        void process(const Node& ast);
 
         /**
          * @brief Returns the modified AST
          *
          * @return const Node&
          */
-        [[nodiscard]] const Node& ast() const noexcept override;
+        [[nodiscard]] const Node& ast() const noexcept;
 
     private:
         Node m_ast;
diff --git a/include/Ark/Compiler/IntermediateRepresentation/IRCompiler.hpp b/include/Ark/Compiler/IntermediateRepresentation/IRCompiler.hpp
@@ -17,12 +17,13 @@
 #include <Ark/Utils/Platform.hpp>
 #include <Ark/Utils/Logger.hpp>
 #include <Ark/Compiler/Common.hpp>
+#include <Ark/Compiler/Pass.hpp>
 #include <Ark/Compiler/ValTableElem.hpp>
 #include <Ark/Compiler/IntermediateRepresentation/Entity.hpp>
 
 namespace Ark::internal
 {
-    class ARK_API IRCompiler final
+    class ARK_API IRCompiler final : public Pass
     {
     public:
         /**
@@ -56,7 +57,6 @@ namespace Ark::internal
         [[nodiscard]] const bytecode_t& bytecode() const noexcept;
 
     private:
-        Logger m_logger;
         bytecode_t m_bytecode;
         std::vector<IR::Block> m_ir;
         std::vector<std::string> m_filenames;
diff --git a/include/Ark/Compiler/IntermediateRepresentation/IROptimizer.hpp b/include/Ark/Compiler/IntermediateRepresentation/IROptimizer.hpp
@@ -13,6 +13,7 @@
 #include <Ark/Utils/Platform.hpp>
 #include <Ark/Utils/Logger.hpp>
 #include <Ark/Compiler/ValTableElem.hpp>
+#include <Ark/Compiler/Pass.hpp>
 #include <Ark/Compiler/IntermediateRepresentation/Entity.hpp>
 
 #include <span>
@@ -27,7 +28,7 @@ namespace Ark::internal
         std::size_t offset;
     };
 
-    class ARK_API IROptimizer final
+    class ARK_API IROptimizer final : public Pass
     {
     public:
         /**
@@ -87,7 +88,6 @@ namespace Ark::internal
 
         std::vector<Rule> m_ruleset;
 
-        Logger m_logger;
         std::vector<IR::Block> m_ir;
         std::vector<std::string> m_symbols;
         std::vector<ValTableElem> m_values;
diff --git a/include/Ark/Compiler/Lowerer/ASTLowerer.hpp b/include/Ark/Compiler/Lowerer/ASTLowerer.hpp
@@ -19,6 +19,7 @@
 
 #include <Ark/Utils/Platform.hpp>
 #include <Ark/Utils/Logger.hpp>
+#include <Ark/Compiler/Pass.hpp>
 #include <Ark/Compiler/Instructions.hpp>
 #include <Ark/Compiler/IntermediateRepresentation/Entity.hpp>
 #include <Ark/Compiler/AST/Node.hpp>
@@ -37,7 +38,7 @@ namespace Ark::internal
      * @brief The ArkScript AST to IR compiler
      *
      */
-    class ARK_API ASTLowerer final
+    class ARK_API ASTLowerer final : public Pass
     {
     public:
         /**
@@ -108,8 +109,6 @@ namespace Ark::internal
         IR::label_t m_current_label = 0;
         std::stack<std::string> m_opened_vars;  ///< stack of vars we are currently declaring
 
-        Logger m_logger;
-
         enum class ErrorKind
         {
             InvalidNodeMacro,
diff --git a/include/Ark/Compiler/Macros/Processor.hpp b/include/Ark/Compiler/Macros/Processor.hpp
@@ -43,14 +43,14 @@ namespace Ark::internal
          *
          * @param ast
          */
-        void process(const Node& ast) override;
+        void process(const Node& ast);
 
         /**
          * @brief Return the modified AST
          *
          * @return Node&
          */
-        [[nodiscard]] const Node& ast() const noexcept override;
+        [[nodiscard]] const Node& ast() const noexcept;
 
         friend class MacroExecutor;
 
diff --git a/include/Ark/Compiler/NameResolution/NameResolutionPass.hpp b/include/Ark/Compiler/NameResolution/NameResolutionPass.hpp
@@ -17,6 +17,7 @@
 
 #include <Ark/Utils/Platform.hpp>
 #include <Ark/Compiler/Pass.hpp>
+#include <Ark/Compiler/AST/Node.hpp>
 #include <Ark/Compiler/NameResolution/ScopeResolver.hpp>
 
 namespace Ark::internal
@@ -34,13 +35,13 @@ namespace Ark::internal
          * @brief Start visiting the given AST, checking for mutability violation and unbound variables
          * @param ast AST to analyze
          */
-        void process(const Node& ast) override;
+        void process(const Node& ast);
 
         /**
          * @brief Unused overload that return the input AST (untouched as this pass only generates errors)
          * @return const Node& ast
          */
-        [[nodiscard]] const Node& ast() const noexcept override;
+        [[nodiscard]] const Node& ast() const noexcept;
 
         /**
          * @brief Register a symbol as defined, so that later we can throw errors on undefined symbols
diff --git a/include/Ark/Compiler/Package/ImportSolver.hpp b/include/Ark/Compiler/Package/ImportSolver.hpp
@@ -43,9 +43,9 @@ namespace Ark::internal
          */
         ImportSolver& setup(const std::filesystem::path& root, const std::vector<Import>& origin_imports);
 
-        void process(const Node& origin_ast) override;
+        void process(const Node& origin_ast);
 
-        [[nodiscard]] const Node& ast() const noexcept override;
+        [[nodiscard]] const Node& ast() const noexcept;
 
     private:
         struct ImportWithSource
diff --git a/include/Ark/Compiler/Pass.hpp b/include/Ark/Compiler/Pass.hpp
@@ -1,7 +1,7 @@
 /**
  * @file Pass.hpp
  * @author Lexy Plateau (lexplt.dev@gmail.com)
- * @brief Interface for a compiler pass (take in an AST, output an AST)
+ * @brief Interface for a compiler pass
  * @date 2024-07-21
  *
  * @copyright Copyright (c) 2024-2026
@@ -11,9 +11,10 @@
 #define ARK_COMPILER_PASS_HPP
 
 #include <Ark/Utils/Platform.hpp>
-#include <Ark/Compiler/AST/Node.hpp>
 #include <Ark/Utils/Logger.hpp>
 
+#include <ostream>
+
 namespace Ark::internal
 {
     /**
@@ -33,17 +34,11 @@ namespace Ark::internal
         virtual ~Pass() = default;
 
         /**
-         * @brief Start processing the given AST
-         * @param ast
-         */
-        virtual void process(const Node& ast) = 0;
-
-        /**
-         * @brief Output of the compiler pass
+         * @brief Set a custom output stream for the logger
          *
-         * @return const Node& the modified AST
+         * @param os output stream
          */
-        [[nodiscard]] virtual const Node& ast() const noexcept = 0;
+        void configureLogger(std::ostream& os);
 
     protected:
         Logger m_logger;
diff --git a/include/Ark/Compiler/Welder.hpp b/include/Ark/Compiler/Welder.hpp
@@ -100,6 +100,12 @@ namespace Ark
          */
         bool saveBytecodeToFile(const std::string& filename);
 
+        /**
+         * @brief Redirect the logs to a given stream
+         * @param os output stream
+         */
+        void redirectLogsTo(std::ostream& os);
+
         [[nodiscard]] const internal::Node& ast() const noexcept;
         [[nodiscard]] std::string textualIR() const noexcept;
         [[nodiscard]] const bytecode_t& bytecode() const noexcept;
diff --git a/include/Ark/Error/Diagnostics.hpp b/include/Ark/Error/Diagnostics.hpp
@@ -60,9 +60,10 @@ namespace Ark::Diagnostics
      *
      * @param message error message to be included in the context
      * @param node AST node with the error
+     * @param colorize toggle context colors (default: true)
      * @return std::string
      */
-    std::string makeContextWithNode(const std::string& message, const internal::Node& node);
+    std::string makeContextWithNode(const std::string& message, const internal::Node& node, bool colorize = true);
 
     ARK_API void generateWithCode(const CodeError& e, const std::string& code, std::ostream& os = std::cerr, bool colorize = true);
 
diff --git a/include/Ark/State.hpp b/include/Ark/State.hpp
@@ -69,20 +69,22 @@ namespace Ark
          *
          * @param file_path path to an ArkScript code file
          * @param features compiler features to enable/disable
+         * @param stream optional output stream for the logger
          * @return true on success
          * @return false on failure
          */
-        bool doFile(const std::string& file_path, uint16_t features = DefaultFeatures);
+        bool doFile(const std::string& file_path, uint16_t features = DefaultFeatures, std::ostream* stream = nullptr);
 
         /**
          * @brief Compile a string (representing ArkScript code) and store resulting bytecode in m_bytecode
          *
          * @param code the ArkScript code
          * @param features compiler features to enable/disable
+         * @param stream optional output stream for the logger
          * @return true on success
          * @return false on failure
          */
-        bool doString(const std::string& code, uint16_t features = DefaultFeatures);
+        bool doString(const std::string& code, uint16_t features = DefaultFeatures, std::ostream* stream = nullptr);
 
         /**
          * @brief Register a function in the virtual machine
@@ -146,10 +148,11 @@ namespace Ark
          *
          * @param file the path of file code to compile
          * @param output set path of .arkc file
+         * @param stream output stream for the logger
          * @return true on success
          * @return false on failure and raise an exception
          */
-        [[nodiscard]] bool compile(const std::string& file, const std::string& output);
+        [[nodiscard]] bool compile(const std::string& file, const std::string& output, std::ostream* stream = nullptr);
 
         static void throwStateError(const std::string& message)
         {
diff --git a/include/Ark/Utils/Logger.hpp b/include/Ark/Utils/Logger.hpp
@@ -80,9 +80,9 @@ namespace Ark::internal
         void warn(const char* fmt, Args&&... args)
         {
             fmt::println(
-                std::cerr,
+                m_stream == nullptr ? std::cerr : *m_stream,
                 "{}: {}",
-                fmt::styled("Warning", fmt::fg(fmt::color::dark_orange)),
+                fmt::styled("Warning", colorize() ? fmt::fg(fmt::color::dark_orange) : fmt::text_style()),
                 fmt::vformat(fmt, fmt::make_format_args(args...)));
         }
 
@@ -139,12 +139,33 @@ namespace Ark::internal
                     fmt::vformat(fmt, fmt::make_format_args(args...)));
         }
 
+        /**
+         * @brief Set a custom output stream to use for warnings. This will disable colors.
+         *
+         * @param os output stream
+         */
+        void configureOutputStream(std::ostream* os)
+        {
+            m_stream = os;
+        }
+
+        /**
+         * @brief Check if logs can be colorized
+         *
+         * @return true if logs can be colorized
+         */
+        inline bool colorize() const noexcept
+        {
+            return m_stream == nullptr;
+        }
+
     private:
         unsigned m_debug;
         std::string m_name;
         fmt::color m_pass_color;
         std::unordered_map<std::string, std::chrono::time_point<std::chrono::high_resolution_clock>> m_trace_starts;
         std::vector<std::string> m_active_traces;
+        std::ostream* m_stream;
     };
 }
 
diff --git a/src/arkreactor/Compiler/IntermediateRepresentation/IRCompiler.cpp b/src/arkreactor/Compiler/IntermediateRepresentation/IRCompiler.cpp
@@ -18,7 +18,7 @@ namespace Ark::internal
     using namespace literals;
 
     IRCompiler::IRCompiler(const unsigned debug) :
-        m_logger("IRCompiler", debug)
+        Pass("IRCompiler", debug)
     {}
 
     void IRCompiler::process(const std::vector<IR::Block>& pages, const std::vector<std::string>& symbols, const std::vector<ValTableElem>& values)
diff --git a/src/arkreactor/Compiler/IntermediateRepresentation/IROptimizer.cpp b/src/arkreactor/Compiler/IntermediateRepresentation/IROptimizer.cpp
@@ -20,7 +20,7 @@ namespace Ark::internal
     }
 
     IROptimizer::IROptimizer(const unsigned debug) :
-        m_logger("IROptimizer", debug)
+        Pass("IROptimizer", debug)
     {
         m_ruleset = {
             Rule { { LOAD_CONST, LOAD_CONST }, LOAD_CONST_LOAD_CONST },
diff --git a/src/arkreactor/Compiler/Lowerer/ASTLowerer.cpp b/src/arkreactor/Compiler/Lowerer/ASTLowerer.cpp
@@ -15,7 +15,7 @@ namespace Ark::internal
     using namespace literals;
 
     ASTLowerer::ASTLowerer(const unsigned debug) :
-        m_logger("ASTLowerer", debug)
+        Pass("ASTLowerer", debug)
     {}
 
     void ASTLowerer::addToTables(const std::vector<std::string>& symbols, const std::vector<ValTableElem>& constants)
@@ -159,7 +159,7 @@ namespace Ark::internal
 
     void ASTLowerer::warning(const std::string& message, const Node& node)
     {
-        m_logger.warn("{}", Diagnostics::makeContextWithNode(message, node));
+        m_logger.warn("{}", Diagnostics::makeContextWithNode(message, node, m_logger.colorize()));
     }
 
     void ASTLowerer::buildAndThrowError(const std::string& message, const Node& node)
diff --git a/src/arkreactor/Compiler/Pass.cpp b/src/arkreactor/Compiler/Pass.cpp
@@ -7,4 +7,8 @@ namespace Ark::internal
         m_logger(std::move(name), debug_level)
     {}
 
+    void Pass::configureLogger(std::ostream& os)
+    {
+        m_logger.configureOutputStream(&os);
+    }
 }
diff --git a/src/arkreactor/Compiler/Welder.cpp b/src/arkreactor/Compiler/Welder.cpp
@@ -135,6 +135,18 @@ namespace Ark
         return true;
     }
 
+    void Welder::redirectLogsTo(std::ostream& os)
+    {
+        m_import_solver.configureLogger(os);
+        m_macro_processor.configureLogger(os);
+        m_ast_optimizer.configureLogger(os);
+        m_name_resolver.configureLogger(os);
+        m_lowerer.configureLogger(os);
+        m_ir_optimizer.configureLogger(os);
+        m_ir_compiler.configureLogger(os);
+        m_logger.configureOutputStream(&os);
+    }
+
     const internal::Node& Welder::ast() const noexcept
     {
         return m_computed_ast;
diff --git a/src/arkreactor/Error/Diagnostics.cpp b/src/arkreactor/Error/Diagnostics.cpp
@@ -210,14 +210,14 @@ namespace Ark::Diagnostics
             fmt::print(os, "        {}\n", text);
     }
 
-    std::string makeContextWithNode(const std::string& message, const internal::Node& node)
+    std::string makeContextWithNode(const std::string& message, const internal::Node& node, const bool colorize)
     {
         std::stringstream ss;
 
         helper(
             ss,
             message,
-            true,
+            colorize,
             node.filename(),
             node.position());
 
diff --git a/src/arkreactor/State.cpp b/src/arkreactor/State.cpp
diff --git a/src/arkreactor/Utils/Logger.cpp b/src/arkreactor/Utils/Logger.cpp
diff --git a/tests/unittests/Suites/DiagnosticsSuite.cpp b/tests/unittests/Suites/DiagnosticsSuite.cpp
diff --git a/tests/unittests/resources/DiagnosticsSuite/warnings/deprecated.ark b/tests/unittests/resources/DiagnosticsSuite/warnings/deprecated.ark
diff --git a/tests/unittests/resources/DiagnosticsSuite/warnings/deprecated.expected b/tests/unittests/resources/DiagnosticsSuite/warnings/deprecated.expected
diff --git a/tests/unittests/resources/DiagnosticsSuite/warnings/ignoring_return_value.ark b/tests/unittests/resources/DiagnosticsSuite/warnings/ignoring_return_value.ark
diff --git a/tests/unittests/resources/DiagnosticsSuite/warnings/ignoring_return_value.expected b/tests/unittests/resources/DiagnosticsSuite/warnings/ignoring_return_value.expected
diff --git a/tests/unittests/resources/DiagnosticsSuite/warnings/statement_no_effect.ark b/tests/unittests/resources/DiagnosticsSuite/warnings/statement_no_effect.ark
diff --git a/tests/unittests/resources/DiagnosticsSuite/warnings/statement_no_effect.expected b/tests/unittests/resources/DiagnosticsSuite/warnings/statement_no_effect.expected

Original file line number	Diff line number	Diff line change
`@@ -43,14 +43,14 @@ namespace Ark::internal`
`43`	`43`	`*`
`44`	`44`	`* @param ast`
`45`	`45`	`*/`
`46`		`- void process(const Node& ast) override;`
	`46`	`+ void process(const Node& ast);`
`47`	`47`
`48`	`48`	`/**`
`49`	`49`	`* @brief Return the modified AST`
`50`	`50`	`*`
`51`	`51`	`* @return Node&`
`52`	`52`	`*/`
`53`		`- [[nodiscard]] const Node& ast() const noexcept override;`
	`53`	`+ [[nodiscard]] const Node& ast() const noexcept;`
`54`	`54`
`55`	`55`	`friend class MacroExecutor;`
`56`	`56`