feat(error): replaced Node::operator<< with Node::debugPrint, using N…

…ode::repr in error messages as it is more suited

CHANGELOG.md

@@ -27,6 +27,7 @@
 - macros can be declared inside a begin block within a cond macro and used in the scope surrounding the cond macro
 - `arkscript --version` and `arkscript --help` now output ArkScript version with the commit hash
 - `void Value::toString(std::ostream&, VM&)` now becomes `std::string Value::toString(VM&)`
+- removed `Node::operator<<` to replace it with `Node::debugPrint`
 
 ### Removed
 - removed unused `NodeType::Closure`

include/Ark/Compiler/AST/Node.hpp

@@ -171,7 +171,13 @@ namespace Ark::internal
          */
         [[nodiscard]] std::string repr() const noexcept;
 
-        friend ARK_API std::ostream& operator<<(std::ostream& os, const Node& N) noexcept;
+        /**
+         * @brief Print a node to an output stream with added type annotations
+         * @param os
+         * @return
+         */
+        [[nodiscard]] std::ostream& debugPrint(std::ostream& os) const noexcept;
+
         friend bool operator==(const Node& A, const Node& B);
         friend bool operator<(const Node& A, const Node& B);
         friend bool operator!(const Node& A);
@@ -186,8 +192,6 @@ namespace Ark::internal
         std::string m_after_comment;  ///< Comment after node
     };
 
-    ARK_API std::ostream& operator<<(std::ostream& os, const std::vector<Node>& node) noexcept;
-
     const Node& getTrueNode();
     const Node& getFalseNode();
     const Node& getNilNode();

src/arkreactor/Compiler/AST/Node.cpp

@@ -206,21 +206,21 @@ namespace Ark::internal
         return data;
     }
 
-    std::ostream& operator<<(std::ostream& os, const Node& node) noexcept
+    std::ostream& Node::debugPrint(std::ostream& os) const noexcept
     {
-        switch (node.m_type)
+        switch (m_type)
         {
             case NodeType::Symbol:
-                os << "Symbol:" << node.string();
+                os << "Symbol:" << string();
                 break;
 
             case NodeType::Capture:
-                os << "Capture:" << node.string();
+                os << "Capture:" << string();
                 break;
 
             case NodeType::Keyword:
                 os << "Keyword:";
-                switch (node.keyword())
+                switch (keyword())
                 {
                     case Keyword::Fun: os << "Fun"; break;
                     case Keyword::Let: os << "Let"; break;
@@ -235,40 +235,40 @@ namespace Ark::internal
                 break;
 
             case NodeType::String:
-                os << "String:" << node.string();
+                os << "String:" << string();
                 break;
 
             case NodeType::Number:
-                os << "Number:" << node.number();
+                os << "Number:" << number();
                 break;
 
             case NodeType::List:
                 os << "( ";
-                for (const auto& i : node.constList())
-                    os << i << " ";
+                for (const auto& i : constList())
+                    i.debugPrint(os) << " ";
                 os << ")";
                 break;
 
             case NodeType::Field:
                 os << "( Field ";
-                for (const auto& i : node.constList())
-                    os << i << " ";
+                for (const auto& i : constList())
+                    i.debugPrint(os) << " ";
                 os << ")";
                 break;
 
             case NodeType::Macro:
                 os << "( Macro ";
-                for (const auto& i : node.constList())
-                    os << i << " ";
+                for (const auto& i : constList())
+                    i.debugPrint(os) << " ";
                 os << ")";
                 break;
 
             case NodeType::Spread:
-                os << "Spread:" << node.string();
+                os << "Spread:" << string();
                 break;
 
             case NodeType::Unused:
-                os << "Unused:" << node.string();
+                os << "Unused:" << string();
                 break;
 
             default:

src/arkreactor/Compiler/AST/Optimizer.cpp

@@ -1,7 +1,5 @@
 #include <Ark/Compiler/AST/Optimizer.hpp>
 
-#include <sstream>
-
 namespace Ark::internal
 {
     Optimizer::Optimizer(uint16_t options) noexcept :
@@ -23,10 +21,7 @@ namespace Ark::internal
 
     void Optimizer::throwOptimizerError(const std::string& message, const Node& node)
     {
-        std::stringstream ss;
-        ss << node;
-
-        throw CodeError(message, node.filename(), node.line(), node.col(), ss.str());
+        throw CodeError(message, node.filename(), node.line(), node.col(), node.repr());
     }
 
     void Optimizer::remove_unused()

src/arkreactor/Compiler/Compiler.cpp

@@ -253,9 +253,7 @@ namespace Ark
 
     void Compiler::throwCompilerError(const std::string& message, const Node& node)
     {
-        std::stringstream ss;
-        ss << node;
-        throw CodeError(message, node.filename(), node.line(), node.col(), ss.str());
+        throw CodeError(message, node.filename(), node.line(), node.col(), node.repr());
     }
 
     void Compiler::compileExpression(const Node& x, int p, bool is_result_unused, bool is_terminal, const std::string& var_name)

src/arkreactor/Compiler/Macros/Processor.cpp

@@ -41,7 +41,7 @@ namespace Ark::internal
         if (m_debug >= 3)
         {
             std::cout << "(MacroProcessor) AST after processing macros\n";
-            std::cout << m_ast << '\n';
+            m_ast.debugPrint(std::cout) << '\n';
         }
     }
 

src/arkreactor/Exceptions.cpp

@@ -145,7 +145,7 @@ namespace Ark::Diagnostics
             message,
             node.filename(),
             (node.filename() == ARK_NO_NAME_FILE) ? "" : Utils::readFile(node.filename()),
-            node,
+            node.repr(),
             node.line(),
             node.col(),
             size);

tests/unittests/ParserSuite.cpp

@@ -16,7 +16,7 @@ std::string astToString(Ark::internal::Parser& parser)
 
     std::stringstream ss;
     for (auto it = parser.ast().constList().begin() + 1, end = parser.ast().constList().end(); it != end; ++it)
-        ss << *it << "\n";
+        it->debugPrint(ss) << "\n";
 
     const auto& imports = parser.imports();
 
@@ -96,4 +96,4 @@ ut::suite<"Parser"> parser_suite = [] {
                 }
             });
     };
-};
+};