feat: Add support for hyperlinks in snippet origin

Author: scrabsha

src/renderer/render.rs

@@ -485,6 +485,11 @@ fn render_origin(
         _ => origin.path.to_string(),
     };
 
+    let link = Hyperlink {
+        url: origin.url.as_deref(),
+    };
+    let str = format!("{link}{str}{link:#}");
+
     buffer.append(buffer_msg_line_offset, &str, ElementStyle::LineAndColumn);
     if !renderer.short_message {
         for _ in 0..max_line_num_len {
@@ -552,6 +557,11 @@ fn render_snippet_annotations(
                 }
             }
         }
+
+        if let Some(url) = &snippet.url {
+            origin.url = Some(Cow::Borrowed(url));
+        }
+
         let buffer_msg_line_offset = buffer.num_lines();
         render_origin(
             renderer,

src/snippet.rs

@@ -227,6 +227,7 @@ pub struct Snippet<'a, T> {
     pub(crate) line_start: usize,
     pub(crate) source: Cow<'a, str>,
     pub(crate) markers: Vec<T>,
+    pub(crate) url: Option<Cow<'a, str>>,
     pub(crate) fold: bool,
 }
 
@@ -246,6 +247,7 @@ impl<'a, T: Clone> Snippet<'a, T> {
             line_start: 1,
             source: source.into(),
             markers: vec![],
+            url: None,
             fold: true,
         }
     }
@@ -271,6 +273,19 @@ impl<'a, T: Clone> Snippet<'a, T> {
         self
     }
 
+    /// The URL to the [`source`][Self::source]. Can be a `file://` URL.
+    ///
+    /// Make sure to follow [the OSC 8 reference document][OSC-8], and in
+    /// particular the [`file://` URIs and the hostname][OSC-8-file-URIs] when
+    /// generating a `file://` URL.
+    ///
+    /// [OSC-8]: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
+    /// [OSC-8-file-URIs]: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda#file-uris-and-the-hostname
+    pub fn path_url(mut self, url: impl Into<OptionCow<'a>>) -> Self {
+        self.url = url.into().0;
+        self
+    }
+
     /// Control whether lines without [`Annotation`]s are shown
     ///
     /// The default is `fold(true)`, collapsing uninteresting lines.
@@ -487,6 +502,7 @@ pub struct Origin<'a> {
     pub(crate) path: Cow<'a, str>,
     pub(crate) line: Option<usize>,
     pub(crate) char_column: Option<usize>,
+    pub(crate) url: Option<Cow<'a, str>>,
 }
 
 impl<'a> Origin<'a> {
@@ -502,6 +518,7 @@ impl<'a> Origin<'a> {
             path: path.into(),
             line: None,
             char_column: None,
+            url: None,
         }
     }
 
@@ -522,6 +539,19 @@ impl<'a> Origin<'a> {
         self.char_column = Some(char_column);
         self
     }
+
+    /// The URL to the origin. Can be a `file://` URL.
+    ///
+    /// Make sure to follow [the OSC 8 reference document][OSC-8], and in
+    /// particular the [`file://` URIs and the hostname][OSC-8-file-URIs] when
+    /// generating a `file://` URL.
+    ///
+    /// [OSC-8]: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
+    /// [OSC-8-file-URIs]: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda#file-uris-and-the-hostname
+    pub fn path_url(mut self, uri: impl Into<Cow<'a, str>>) -> Self {
+        self.url = Some(uri.into());
+        self
+    }
 }
 
 impl<'a> From<Cow<'a, str>> for Origin<'a> {

tests/hyperlink.rs

@@ -16,6 +16,7 @@ fn simple() {
                 Snippet::source(source)
                     .line_start(26)
                     .path("examples/footer.rs")
+                    .path_url("file://localhost/home/user/rust/file.rs")
                     .annotation(AnnotationKind::Primary.span(193..195).label(
                         "expected struct `annotate_snippets::snippet::Slice`, found reference",
                     ))