BE-198: HashQL: Track local declaration and types inside of the MIR (#8027)

Author: indietyp

Cargo.lock

@@ -7,7 +7,12 @@ use std::{
 
 use hashql_ast::node::expr::Expr;
 use hashql_core::{
-    heap::Heap, id::IdVec, module::ModuleRegistry, span::SpanId, r#type::environment::Environment,
+    heap::Heap,
+    id::IdVec,
+    module::ModuleRegistry,
+    pretty::Formatter,
+    span::SpanId,
+    r#type::{TypeFormatter, TypeFormatterOptions, environment::Environment},
 };
 use hashql_hir::{context::HirContext, node::NodeData};
 use hashql_mir::{
@@ -98,10 +103,17 @@ impl Suite for MirReifySuite {
 
         let (root, bodies) = mir_reify(heap, expr, &interner, &mut environment, diagnostics)?;
 
+        let formatter = Formatter::new(heap);
+        let mut formatter = TypeFormatter::new(
+            &formatter,
+            &environment,
+            TypeFormatterOptions::terse().with_qualified_opaque_names(true),
+        );
         let mut text_format = TextFormat {
             writer: Vec::new(),
             indent: 4,
             sources: bodies.as_slice(),
+            types: &mut formatter,
         };
         text_format
             .format(&bodies, &[root])
@@ -128,7 +140,7 @@ impl Suite for MirReifySuite {
 
         let now = Instant::now();
         let mut child = Command::new("d2")
-            .args(["-l", "elk", "--stdout-format", "svg", "-"])
+            .args(["-l", "elk", "-b=false", "--stdout-format", "svg", "-"])
             .stdin(Stdio::piped())
             .stdout(Stdio::piped())
             .spawn()
@@ -151,6 +163,7 @@ impl Suite for MirReifySuite {
             sources: bodies.as_slice(),
             dataflow: (),
             buffer: D2Buffer::default(),
+            types: formatter,
         };
         d2_format
             .format(&bodies, &[root])

libs/@local/hashql/compiletest/src/suite/mir_reify.rs

@@ -23,6 +23,7 @@ text-size = { workspace = true, public = true }
 # Private workspace dependencies
 
 # Private third-party dependencies
+anstyle-lossy        = { workspace = true }
 bitvec               = { workspace = true, features = ["alloc"] }
 bumpalo              = { workspace = true }
 derive_more          = { workspace = true, features = ["debug", "from"] }

libs/@local/hashql/core/Cargo.toml

@@ -16,7 +16,7 @@
 //! ```rust
 //! use hashql_core::{
 //!     heap::Heap,
-//!     pretty::{Format, Formatter, RenderOptions},
+//!     pretty::{Formatter, RenderOptions},
 //!     symbol::sym,
 //! };
 //!
@@ -44,19 +44,21 @@ mod write;
 use core::fmt::{self, Display};
 use std::io;
 
-use self::write::{AnsiWriter, PlainWriter, RenderError};
+use self::write::{AnsiWriter, HtmlFragmentWriter, PlainWriter, RenderError, XmlEscapingWriter};
 pub use self::{
     formatter::{Doc, Formatter, FormatterOptions},
     semantic::Semantic,
 };
 
 /// Output format for rendered documents.
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
-pub enum Format {
+pub enum RenderFormat {
     /// Plain text without ANSI escape codes.
     Plain,
     /// ANSI-colored output for terminals.
     Ansi,
+    /// Output as a series of HTML text spans.
+    HtmlFragment,
 }
 
 /// Configuration for rendering documents to output.
@@ -65,7 +67,7 @@ pub enum Format {
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 pub struct RenderOptions {
     /// Whether to use ANSI colors or plain text.
-    pub format: Format,
+    pub format: RenderFormat,
     /// Maximum line width before wrapping (default: 80).
     pub max_width: usize,
 }
@@ -76,7 +78,7 @@ impl RenderOptions {
     /// Enables terminal colors and syntax highlighting in the rendered output.
     #[must_use]
     pub const fn with_ansi(mut self) -> Self {
-        self.format = Format::Ansi;
+        self.format = RenderFormat::Ansi;
         self
     }
 
@@ -86,7 +88,7 @@ impl RenderOptions {
     /// non-terminal output.
     #[must_use]
     pub const fn with_plain(mut self) -> Self {
-        self.format = Format::Plain;
+        self.format = RenderFormat::Plain;
         self
     }
 
@@ -104,7 +106,7 @@ impl RenderOptions {
 impl Default for RenderOptions {
     fn default() -> Self {
         Self {
-            format: Format::Ansi,
+            format: RenderFormat::Ansi,
             max_width: 80,
         }
     }
@@ -121,27 +123,35 @@ pub fn render_into<W>(doc: &Doc<'_>, options: RenderOptions, write: &mut W) -> i
 where
     W: io::Write,
 {
+    let mut writer = PlainWriter::new_io(write);
+
     match options.format {
-        Format::Plain => doc
-            .render_raw(options.max_width, &mut PlainWriter::new_io(write))
-            .map_err(RenderError::into_io),
-        Format::Ansi => doc
-            .render_raw(options.max_width, &mut AnsiWriter::new_io(write))
-            .map_err(RenderError::into_io),
+        RenderFormat::Plain => doc.render_raw(options.max_width, &mut writer),
+        RenderFormat::Ansi => doc.render_raw(options.max_width, &mut AnsiWriter::new(writer)),
+        RenderFormat::HtmlFragment => doc.render_raw(
+            options.max_width,
+            &mut XmlEscapingWriter::new(HtmlFragmentWriter::new(writer)),
+        ),
     }
+    .map_err(RenderError::into_io)
 }
 
 /// Get a displayable representation.
 ///
 /// Returns a [`Display`] implementor for using in formatting contexts.
 #[must_use]
 pub fn render(doc: Doc<'_>, options: RenderOptions) -> impl Display {
-    fmt::from_fn(move |fmt| match options.format {
-        Format::Plain => doc
-            .render_raw(options.max_width, &mut PlainWriter::new_fmt(fmt))
-            .map_err(RenderError::into_fmt),
-        Format::Ansi => doc
-            .render_raw(options.max_width, &mut AnsiWriter::new_fmt(fmt))
-            .map_err(RenderError::into_fmt),
+    fmt::from_fn(move |fmt| {
+        let mut writer = PlainWriter::new_fmt(fmt);
+
+        match options.format {
+            RenderFormat::Plain => doc.render_raw(options.max_width, &mut writer),
+            RenderFormat::Ansi => doc.render_raw(options.max_width, &mut AnsiWriter::new(writer)),
+            RenderFormat::HtmlFragment => doc.render_raw(
+                options.max_width,
+                &mut XmlEscapingWriter::new(HtmlFragmentWriter::new(writer)),
+            ),
+        }
+        .map_err(RenderError::into_fmt)
     })
 }