Merge pull request #405 from ArkScript-lang/feat/logging-strategy

chore: updating the logging strategy (streams/printf removed, using fmt::print)

Author: SuperFola

CHANGELOG.md

@@ -10,12 +10,15 @@
 - more documentation about the compiler implementation
 - more documentation about the virtual machine
 - closures can be now be compared field per field: `(= closure1 closure2)` will work only if they have the same fields (name) and if the values match
+- upgraded lib fmt to 9.1.0
+- using fmtlib nearly everywhere possible to replace streams and printf mixed with termcolor
 
 ### Removed
 - removing the custom string, replacing it with std::string (the format engine of the custom string had a lot of memory leaks)
 - `Utils::digPlaces` and `Utils::decPlaces` got removed as they were no longer needed
 - removed unused `NodeType::Closure`
 - removed deprecated code (`list:removeAt`, `ark` executable now replaced by `arkscript`)
+- removed unused debug level attribute from the lexer, macro executor, macro processor, json compiler and compiler
 
 ## [3.4.0] - 2022-09-12
 ### Added

CMakeLists.txt

@@ -26,8 +26,7 @@ set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 
 # files needed for the library ArkReactor
 file(GLOB_RECURSE SOURCE_FILES
-    ${ark_SOURCE_DIR}/src/arkreactor/*.cpp
-    ${ark_SOURCE_DIR}/lib/fmt/src/*.cc)
+    ${ark_SOURCE_DIR}/src/arkreactor/*.cpp)
 
 add_library(ArkReactor SHARED ${SOURCE_FILES})
 
@@ -97,15 +96,15 @@ endif()
 
 # Link libraries
 
-add_subdirectory("${ark_SOURCE_DIR}/lib/termcolor" EXCLUDE_FROM_ALL)
+add_subdirectory(${ark_SOURCE_DIR}/lib/termcolor EXCLUDE_FROM_ALL)
+add_subdirectory(${ark_SOURCE_DIR}/lib/fmt EXCLUDE_FROM_ALL)
 
 target_include_directories(ArkReactor
     PUBLIC
-    "${ark_SOURCE_DIR}/lib/utf8_decoder/"
-    "${ark_SOURCE_DIR}/lib/picosha2/"
-    "${ark_SOURCE_DIR}/lib/fmt/include")
+    ${ark_SOURCE_DIR}/lib/utf8_decoder/
+    ${ark_SOURCE_DIR}/lib/picosha2/)
 
-target_link_libraries(ArkReactor PUBLIC termcolor)
+target_link_libraries(ArkReactor PUBLIC termcolor fmt::fmt-header-only)
 
 if (UNIX OR LINUX)
     if (CMAKE_COMPILER_IS_GNUCXX OR CMAKE_COMPILER_IS_CLANG)

include/Ark/Compiler/AST/Lexer.hpp

@@ -29,9 +29,8 @@ namespace Ark::internal
         /**
          * @brief Construct a new Lexer object
          *
-         * @param debug the debug level
          */
-        explicit Lexer(unsigned debug) noexcept;
+        Lexer() noexcept;
 
         /**
          * @brief Give code to tokenize and create the list of tokens
@@ -48,7 +47,6 @@ namespace Ark::internal
         std::vector<Token>& tokens() noexcept;
 
     private:
-        unsigned m_debug;
         std::vector<Token> m_tokens;
 
         inline constexpr bool isHexChar(char chr)

include/Ark/Compiler/BytecodeReader.hpp

@@ -2,11 +2,11 @@
  * @file BytecodeReader.hpp
  * @author Alexandre Plateau (lexplt.dev@gmail.com)
  * @brief A bytecode disassembler for ArkScript
- * @version 0.3
+ * @version 0.4
  * @date 2020-10-27
- * 
- * @copyright Copyright (c) 2020-2021
- * 
+ *
+ * @copyright Copyright (c) 2020-2022
+ *
  */
 
 #ifndef ARK_COMPILER_BYTECODEREADER_HPP
@@ -37,35 +37,35 @@ namespace Ark
      * @brief This class is just a helper to
      * - check if a bytecode is valid
      * - display it in a human readable way by using the opcode names
-     * 
+     *
      */
     class ARK_API BytecodeReader
     {
     public:
         /**
          * @brief Construct a new Bytecode Reader object
-         * 
+         *
          */
         BytecodeReader() = default;
 
         /**
          * @brief Construct needed data before displaying information about a given file
-         * 
+         *
          * @param file filename of the bytecode file
          */
         void feed(const std::string& file);
 
         /**
          * @brief Return the bytecode object constructed
-         * 
-         * @return const bytecode_t& 
+         *
+         * @return const bytecode_t&
          */
         const bytecode_t& bytecode() noexcept;
 
         /**
          * @brief Return the read timestamp from the bytecode file
-         * 
-         * @return unsigned long long 
+         *
+         * @return unsigned long long
          */
         unsigned long long timestamp();
 
@@ -87,7 +87,7 @@ namespace Ark
 
         /**
          * @brief Read a number from the bytecode, under the instruction pointer i
-         * 
+         *
          * @param i this parameter is being modified to point to the next value
          * @return uint16_t the number we read (big endian)
          */

include/Ark/Compiler/Compiler.hpp

@@ -85,9 +85,7 @@ namespace Ark
         std::vector<internal::ValTableElem> m_values;
         std::vector<std::vector<internal::Word>> m_code_pages;
         std::vector<std::vector<internal::Word>> m_temp_pages;  ///< we need temporary code pages for some compilations passes
-
         bytecode_t m_bytecode;
-        unsigned m_debug;  ///< the debug level of the compiler
 
         /**
          * @brief Push the file headers (magic, version used, timestamp)

include/Ark/Compiler/JsonCompiler.hpp

@@ -42,7 +42,6 @@ namespace Ark
         internal::Parser m_parser;
         internal::Optimizer m_optimizer;
         uint16_t m_options;
-        unsigned m_debug;  ///< the debug level of the compiler
 
         /**
          * @brief Compile a single node and return its representation

include/Ark/Compiler/Macros/Executor.hpp

@@ -31,9 +31,8 @@ namespace Ark::internal
          * @brief Construct a new Macro Executor object
          * 
          * @param macroprocessor 
-         * @param debug 
          */
-        MacroExecutor(MacroProcessor* macroprocessor, unsigned debug = 0);
+        explicit MacroExecutor(MacroProcessor* macroprocessor);
 
         /**
          * @brief Need a virtual destructor to correctly destory object.
@@ -59,7 +58,6 @@ namespace Ark::internal
         virtual bool canHandle(Node& node) = 0;
 
     protected:
-        unsigned int m_debug;
         MacroProcessor* m_macroprocessor;  // Note: Non owned pointer.
 
         /**

include/Ark/Compiler/Macros/Processor.hpp

@@ -32,10 +32,9 @@ namespace Ark::internal
         /**
          * @brief Construct a new Macro Processor object
          * 
-         * @param debug the debug level
          * @param options the options flags
          */
-        MacroProcessor(unsigned debug, uint16_t options) noexcept;
+        MacroProcessor(uint16_t options) noexcept;
 
         /**
          * @brief Send the complete AST (after the inclusions and stuff), and work on it
@@ -54,7 +53,6 @@ namespace Ark::internal
         friend class MacroExecutor;
 
     private:
-        unsigned m_debug;  ///< The debug level
         uint16_t m_options;
         Node m_ast;                                                   ///< The modified AST
         std::vector<std::unordered_map<std::string, Node>> m_macros;  ///< Handling macros in a scope fashion

include/Ark/REPL/Repl.hpp

@@ -47,8 +47,7 @@ namespace Ark
         std::vector<std::string> m_libenv;
 
         inline void print_repl_header();
-        int count_open_parentheses(const std::string& line);
-        int count_open_braces(const std::string& line);
+        int count_open_group(const std::string& line, char left, char right);
         void trim_whitespace(std::string& line);
         void cui_setup();
     };

include/Ark/Utils.hpp

@@ -12,7 +12,7 @@
 #ifndef INCLUDE_ARK_UTILS_HPP
 #define INCLUDE_ARK_UTILS_HPP
 
-#include <algorithm>  // std::min
+#include <algorithm>
 #include <string>
 #include <iostream>
 #include <fstream>
@@ -41,7 +41,7 @@ namespace Ark::Utils
             if (c != sep)
                 output.back() += c;
             else
-                output.emplace_back();  // add empty string
+                output.emplace_back();
         }
 
         return output;