Auto merge of #91779 - ridwanabdillahi:natvis, r=michaelwoerister

Add a new Rust attribute to support embedding debugger visualizers

Implemented [this RFC](https://github.com/rust-lang/rfcs/pull/3191) to add support for embedding debugger visualizers into a PDB.

Added a new attribute `#[debugger_visualizer]` and updated the `CrateMetadata` to store debugger visualizers for crate dependencies.

RFC: https://github.com/rust-lang/rfcs/pull/3191

8 files changed, 124 insertions, 0 deletions

diff --git a/src/test/debuginfo/msvc-embedded-natvis.natvis b/src/test/debuginfo/msvc-embedded-natvis.natvis
new file mode 100644
index 00000000000..201d014b520
--- /dev/null
+++ b/src/test/debuginfo/msvc-embedded-natvis.natvis
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
+  <Type Name="msvc_embedded_natvis::Point">
+    <DisplayString>({x}, {y})</DisplayString>
+    <Expand>
+      <Item Name="[x]">x</Item>
+      <Item Name="[y]">y</Item>
+    </Expand>
+  </Type>
+
+  <Type Name="msvc_embedded_natvis::Line">
+    <DisplayString>({a}, {b})</DisplayString>
+    <Expand>
+      <Item Name="[a]">a</Item>
+      <Item Name="[b]">b</Item>
+    </Expand>
+  </Type>
+</AutoVisualizer>
diff --git a/src/test/debuginfo/msvc-embedded-natvis.rs b/src/test/debuginfo/msvc-embedded-natvis.rs
new file mode 100644
index 00000000000..f714fb2ad17
--- /dev/null
+++ b/src/test/debuginfo/msvc-embedded-natvis.rs
@@ -0,0 +1,64 @@
+// only-cdb
+// compile-flags:-g
+
+// === CDB TESTS ==================================================================================
+
+// cdb-command: g
+
+// cdb-command: .nvlist
+// cdb-check:    [...].exe (embedded NatVis "[...]msvc_embedded_natvis-0.natvis")
+
+// cdb-command: dx point_a
+// cdb-check:point_a          : (0, 0) [Type: msvc_embedded_natvis::Point]
+// cdb-check:    [<Raw View>]     [Type: msvc_embedded_natvis::Point]
+// cdb-check:    [x]              : 0 [Type: int]
+// cdb-check:    [y]              : 0 [Type: int]
+
+// cdb-command: dx point_b
+// cdb-check:point_b          : (5, 8) [Type: msvc_embedded_natvis::Point]
+// cdb-check:    [<Raw View>]     [Type: msvc_embedded_natvis::Point]
+// cdb-check:    [x]              : 5 [Type: int]
+// cdb-check:    [y]              : 8 [Type: int]
+
+// cdb-command: dx line
+// cdb-check:line             : ((0, 0), (5, 8)) [Type: msvc_embedded_natvis::Line]
+// cdb-check:    [<Raw View>]     [Type: msvc_embedded_natvis::Line]
+// cdb-check:    [a]              : (0, 0) [Type: msvc_embedded_natvis::Point]
+// cdb-check:    [b]              : (5, 8) [Type: msvc_embedded_natvis::Point]
+
+#![feature(debugger_visualizer)]
+#![debugger_visualizer(natvis_file = "msvc-embedded-natvis.natvis")]
+
+pub struct Point {
+    x: i32,
+    y: i32,
+}
+
+impl Point {
+    pub fn new(x: i32, y: i32) -> Point {
+        Point { x: x, y: y }
+    }
+}
+
+pub struct Line {
+    a: Point,
+    b: Point,
+}
+
+impl Line {
+    pub fn new(a: Point, b: Point) -> Line {
+        Line { a: a, b: b }
+    }
+}
+
+fn main() {
+    let point_a = Point::new(0, 0);
+    let point_b = Point::new(5, 8);
+    let line = Line::new(point_a, point_b);
+
+    zzz(); // #break
+}
+
+fn zzz() {
+    ()
+}
diff --git a/src/test/ui/feature-gates/feature-gate-debugger-visualizer.rs b/src/test/ui/feature-gates/feature-gate-debugger-visualizer.rs
new file mode 100644
index 00000000000..3f9eb27a0d6
--- /dev/null
+++ b/src/test/ui/feature-gates/feature-gate-debugger-visualizer.rs
@@ -0,0 +1,3 @@
+#![debugger_visualizer(natvis_file = "../foo.natvis")] //~ ERROR the `#[debugger_visualizer]` attribute is an experimental feature
+
+fn main() {}
diff --git a/src/test/ui/feature-gates/feature-gate-debugger-visualizer.stderr b/src/test/ui/feature-gates/feature-gate-debugger-visualizer.stderr
new file mode 100644
index 00000000000..721b2b185da
--- /dev/null
+++ b/src/test/ui/feature-gates/feature-gate-debugger-visualizer.stderr
@@ -0,0 +1,12 @@
+error[E0658]: the `#[debugger_visualizer]` attribute is an experimental feature
+  --> $DIR/feature-gate-debugger-visualizer.rs:1:1
+   |
+LL | #![debugger_visualizer(natvis_file = "../foo.natvis")]
+   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+   |
+   = note: see issue #95939 <https://github.com/rust-lang/rust/issues/95939> for more information
+   = help: add `#![feature(debugger_visualizer)]` to the crate attributes to enable
+
+error: aborting due to previous error
+
+For more information about this error, try `rustc --explain E0658`.
diff --git a/src/test/ui/invalid/invalid-debugger-visualizer-option.rs b/src/test/ui/invalid/invalid-debugger-visualizer-option.rs
new file mode 100644
index 00000000000..5332298f0ef
--- /dev/null
+++ b/src/test/ui/invalid/invalid-debugger-visualizer-option.rs
@@ -0,0 +1,4 @@
+#![feature(debugger_visualizer)]
+#![debugger_visualizer(random_file = "../foo.random")] //~ ERROR invalid argument
+
+fn main() {}
diff --git a/src/test/ui/invalid/invalid-debugger-visualizer-option.stderr b/src/test/ui/invalid/invalid-debugger-visualizer-option.stderr
new file mode 100644
index 00000000000..24ad9361fe3
--- /dev/null
+++ b/src/test/ui/invalid/invalid-debugger-visualizer-option.stderr
@@ -0,0 +1,10 @@
+error: invalid argument
+  --> $DIR/invalid-debugger-visualizer-option.rs:2:1
+   |
+LL | #![debugger_visualizer(random_file = "../foo.random")]
+   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+   |
+   = note: expected: `natvis_file = "..."`
+
+error: aborting due to previous error
+
diff --git a/src/test/ui/invalid/invalid-debugger-visualizer-target.rs b/src/test/ui/invalid/invalid-debugger-visualizer-target.rs
new file mode 100644
index 00000000000..7668d092e61
--- /dev/null
+++ b/src/test/ui/invalid/invalid-debugger-visualizer-target.rs
@@ -0,0 +1,5 @@
+#![feature(debugger_visualizer)]
+
+#[debugger_visualizer(natvis_file = "../foo.natvis")] //~ ERROR attribute should be applied to a module
+
+fn main() {}
diff --git a/src/test/ui/invalid/invalid-debugger-visualizer-target.stderr b/src/test/ui/invalid/invalid-debugger-visualizer-target.stderr
new file mode 100644
index 00000000000..3555bbb169b
--- /dev/null
+++ b/src/test/ui/invalid/invalid-debugger-visualizer-target.stderr
@@ -0,0 +1,8 @@
+error: attribute should be applied to a module
+  --> $DIR/invalid-debugger-visualizer-target.rs:3:1
+   |
+LL | #[debugger_visualizer(natvis_file = "../foo.natvis")]
+   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+error: aborting due to previous error
+