feat: new library for better diagnostics support

Author: nos1dot618

.gitignore

@@ -2,3 +2,4 @@
 cmake-build-debug/
 venv/
 **__pycache__/
+dump/

CMakeLists.txt

@@ -5,6 +5,8 @@ set(CMAKE_CXX_STANDARD 23)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
+find_package(PkgConfig REQUIRED)
+
 ###### SOURCE ######
 file(GLOB_RECURSE SOURCE_SOURCE_FILES CONFIGURE_DEPENDS
     ${PROJECT_SOURCE_DIR}/src/source/*.cpp
@@ -13,17 +15,33 @@ add_library(lbdSource STATIC)
 target_sources(lbdSource PRIVATE ${SOURCE_SOURCE_FILES})
 target_include_directories(lbdSource PUBLIC ${PROJECT_SOURCE_DIR}/include)
 
+###### DIAGNOSTICS ######
+file(GLOB_RECURSE DIAGNOSTICS_SOURCE_FILES CONFIGURE_DEPENDS
+    ${PROJECT_SOURCE_DIR}/src/diagnostics/*.cpp
+)
+add_library(lbdDiagnostics STATIC)
+target_sources(lbdDiagnostics PRIVATE ${DIAGNOSTICS_SOURCE_FILES})
+target_link_libraries(lbdDiagnostics PUBLIC
+    lbdSource
+)
+target_include_directories(lbdDiagnostics PUBLIC ${PROJECT_SOURCE_DIR}/include)
+
+# Fmt.
+pkg_check_modules(FMT REQUIRED fmt)
+
 ####### FRONTEND #######
 file(GLOB_RECURSE FRONTEND_SOURCE_FILES CONFIGURE_DEPENDS
     ${PROJECT_SOURCE_DIR}/src/frontend/*.cpp
 )
 add_library(lbdFrontend STATIC)
 target_sources(lbdFrontend PRIVATE ${FRONTEND_SOURCE_FILES})
-target_link_libraries(lbdFrontend PUBLIC
-    lbdSource
-)
 target_include_directories(lbdFrontend PUBLIC
     ${PROJECT_SOURCE_DIR}/include
+    ${FMT_INCLUDE_DIRS}
+)
+target_link_libraries(lbdFrontend PRIVATE
+    lbdDiagnostics
+    ${FMT_LIBRARIES}
 )
 
 ####### RUNTIME #######
@@ -32,25 +50,28 @@ file(GLOB_RECURSE RUNTIME_SOURCE_FILES CONFIGURE_DEPENDS
 )
 add_library(lbdRuntime STATIC)
 target_sources(lbdRuntime PRIVATE ${RUNTIME_SOURCE_FILES})
-target_link_libraries(lbdRuntime PUBLIC
-    lbdSource
-)
 target_include_directories(lbdRuntime PUBLIC
     ${PROJECT_SOURCE_DIR}/include
+    ${FMT_INCLUDE_DIRS}
+)
+target_link_libraries(lbdRuntime PRIVATE
+    lbdDiagnostics
+    ${FMT_LIBRARIES}
 )
 
 ###### MAIN EXECUTABLE ######
 file(GLOB LBD_SOURCE_FILES CONFIGURE_DEPENDS
     ${PROJECT_SOURCE_DIR}/src/*.cpp
+    ${PROJECT_SOURCE_DIR}/src/utils/terminal/*.cpp
 )
 add_executable(lbd)
 target_sources(lbd PRIVATE ${LBD_SOURCE_FILES})
 target_link_libraries(lbd PRIVATE
+    lbdDiagnostics
     lbdFrontend
     lbdRuntime
 )
 
-find_package(PkgConfig REQUIRED)
 # Readline.
 pkg_check_modules(READLINE REQUIRED readline)
 target_include_directories(lbd PRIVATE ${READLINE_INCLUDE_DIRS})

README.md

@@ -8,9 +8,8 @@
 
 ### Prerequisites
 
-- **CMake** (version 3.16+ recommended)
-- **Python 3.8+** (for development environment and tooling)
-- A C++17 capable compiler (e.g. `g++`, `clang++`, or MSVC on Windows)
+- **CMake** (version 3.20+ recommended)
+- A C++23 capable compiler (e.g. `g++`, `clang++`, or MSVC on Windows)
 
 ### Setup
 
@@ -117,4 +116,5 @@ lbd [options]
 
 ## Dependencies
 
-1. [readline](https://tiswww.case.edu/php/chet/readline/rltop.html): For better REPL user experience.
+1. [readline](https://man7.org/linux/man-pages/man3/readline.3.html): For better REPL user experience.
+2. [fmt](https://github.com/fmtlib/fmt): For formatting strings.

include/lbd/Context.hpp

@@ -1,23 +1,33 @@
 #pragma once
 
+#include <lbd/Logger.hpp>
 #include <lbd/Options.hpp>
-#include <lbd/source/SourceManager.hpp>
+#include <lbd/diagnostics/DiagnosticEmitter.hpp>
+#include <lbd/source/BufferManager.hpp>
 
 namespace lbd
 {
     class Context
     {
     public:
-        explicit Context(Options options);
+        explicit Context(std::ostream& outputStream, Options options = {});
 
-        [[nodiscard]] source::SourceManager& getSourceManager();
+        [[nodiscard]] source::BufferManager& getBufferManager();
+
+        [[nodiscard]] diagnostics::DiagnosticEmitter& getDiagnosticEmitter();
 
         [[nodiscard]] Options& getOptions();
 
-        // TODO: Add diagnostic emitter and renderer.
+        [[nodiscard]] Logger& getLogger();
+
+        /// Emits error upon unable to load the file.
+        [[nodiscard]] source::BufferId loadFile(const std::string& path, const source::Range& range);
 
     private:
         Options options;
-        source::SourceManager sourceManager;
+        Logger logger;
+        source::BufferManager bufferManager;
+        diagnostics::DiagnosticRenderer diagnosticRenderer;
+        diagnostics::DiagnosticEmitter diagnosticEmitter;
     };
 }

include/lbd/docs.h include/lbd/Docs.hppinclude/lbd/docs.h renamed to include/lbd/Docs.hpp

@@ -2,7 +2,7 @@
 
 #include <iostream>
 
-namespace lbd::docs
+namespace lbd
 {
     void dumpDocs(std::ostream& outputStream);
 }

include/lbd/Driver.hpp

@@ -0,0 +1,19 @@
+#pragma once
+
+#include <lbd/Context.hpp>
+#include <lbd/runtime/interpreter.h>
+#include <lbd/source/Buffer.hpp>
+
+namespace lbd
+{
+    class Driver
+    {
+    public:
+        explicit Driver(Context& context) noexcept;
+
+        [[nodiscard]] runtime::Result run(source::BufferId bufferId) const noexcept;
+
+    private:
+        Context& context;
+    };
+}

include/lbd/logs.h include/lbd/Logger.hppinclude/lbd/logs.h renamed to include/lbd/Logger.hpp

@@ -3,7 +3,8 @@
 #include <optional>
 #include <lbd/exceptions.h>
 #include <lbd/source/Range.hpp>
-#include <lbd/utils/terminal.h>
+#include <lbd/utils/terminal/Colors.hpp>
+#include <lbd/utils/terminal/Terminal.hpp>
 
 namespace lbd
 {
@@ -20,28 +21,14 @@ namespace lbd
         {
             if (useColor)
             {
-                enableVirtualTerminal();
+                utils::terminal::enableVirtualTerminal();
             }
         }
 
         template <typename... Arguments>
-        [[noreturn]] void error(const std::optional<source::Location> location, Arguments&&... arguments) const
+        [[noreturn]] void error(Arguments&&... arguments) const
         {
-            if (useColor)
-            {
-                std::cerr << colors::RED;
-            }
-            if (showLocation && location.has_value())
-            {
-                if (location->getFileId().has_value()) std::cerr << location->getFileId().has_value() << ":";
-                std::cerr << location->getRow() << ":" << location->getColumn() << ": ";
-            }
-            (std::cerr << ... << std::forward<Arguments>(arguments));
-            if (useColor)
-            {
-                std::cerr << colors::RESET;
-            }
-            std::cerr << std::endl;
+            logImplementation(utils::terminal::Colors().red, std::cout, std::forward<Arguments>(arguments)...);
             if (exitOnError)
             {
                 exit(EXIT_FAILURE);
@@ -52,13 +39,13 @@ namespace lbd
         template <typename... Arguments>
         void info(Arguments&&... arguments) const
         {
-            logImplementation(colors::BLUE, std::cout, std::forward<Arguments>(arguments)...);
+            logImplementation(utils::terminal::Colors().blue, std::cout, std::forward<Arguments>(arguments)...);
         }
 
         template <typename... Arguments>
         void debug(Arguments&&... arguments) const
         {
-            logImplementation(colors::YELLOW, std::cout, std::forward<Arguments>(arguments)...);
+            logImplementation(utils::terminal::Colors().yellow, std::cout, std::forward<Arguments>(arguments)...);
         }
 
     private:
@@ -72,7 +59,7 @@ namespace lbd
             (stream << ... << std::forward<Arguments>(arguments));
             if (useColor)
             {
-                stream << colors::RESET;
+                stream << utils::terminal::Colors().reset;
             }
             stream << std::endl;
         }

include/lbd/Options.hpp

@@ -1,30 +1,13 @@
 #pragma once
 
-#include <lbd/logs.h>
-
 namespace lbd
 {
-    class Options
+    // TODO: Ensure these fields are private.
+    struct Options
     {
-    public:
-        explicit Options(bool ownExpression = false, bool forceOnEnvironmentDump = false, bool debug = false);
-
-        [[nodiscard]] bool shouldOwnExpression() const;
-
-        [[nodiscard]] bool shouldForceOnEnvironmentDump() const;
-
-        [[nodiscard]] bool isDebug() const;
-
-        void toggleForceOnEnvironmentDump();
-
-        void toggleDebug();
-
-        // TODO: Instead use diagnostic emitter and renderer.
-        Logger logger;
-
-    private:
-        bool ownExpression; /// Owning Expression inside Thunk. Turned on for REPL
-        bool forceOnEnvironmentDump;
-        bool debug;
+        /// Owning Expression inside Thunk. Turned on for REPL
+        bool ownExpression = false;
+        bool forceOnEnvironmentDump = false;
+        bool debug = false;
     };
 }

include/lbd/repl.h include/lbd/REPL.hppinclude/lbd/repl.h renamed to include/lbd/REPL.hpp

@@ -0,0 +1,20 @@
+#pragma once
+
+#include <lbd/Context.hpp>
+
+namespace lbd
+{
+    class ScopedOptionsOverride
+    {
+    public:
+        explicit ScopedOptionsOverride(Context& context);
+
+        ~ScopedOptionsOverride();
+
+        Options& get() const;
+
+    private:
+        Context& context;
+        Options oldOptions;
+    };
+}