From 26f409c5252c3fda5ead140eb4d5ec282f47f0f7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Kat=20March=C3=A1n?= <kzm@zkat.tech>
Date: Tue, 17 Aug 2021 19:14:27 -0700
Subject: [PATCH] feat(offsets): nice utility function to get an offset from a
 Rust callsite

Fixes: https://github.com/zkat/miette/issues/19
---
 src/protocol.rs | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/src/protocol.rs b/src/protocol.rs
index 6d0fe9a..737a32b 100644
--- a/src/protocol.rs
+++ b/src/protocol.rs
@@ -4,7 +4,7 @@ that you can implement to get access to miette's (and related library's) full
 reporting and such features.
 */
 
-use std::fmt::Display;
+use std::{fmt::Display, fs, panic::Location};
 
 use crate::MietteError;
 
@@ -313,6 +313,27 @@ impl SourceOffset {
 
         SourceOffset(offset)
     }
+
+    /// Returns an offset for the _file_ location of wherever this function is
+    /// called. If you want to get _that_ caller's location, mark this
+    /// function's caller with #[track_caller] (and so on and so forth).
+    ///
+    /// Returns both the filename that was given and the offset of the caller
+    /// as a SourceOffset
+    ///
+    /// Keep in mind that this fill only work if the file your Rust source
+    /// file was compiled from is actually available at that location. If
+    /// you're shipping binaries for your application, you'll want to ignore
+    /// the Err case or otherwise report it.
+    #[track_caller]
+    pub fn from_current_location() -> Result<(String, Self), MietteError> {
+        let loc = Location::caller();
+        Ok((
+            loc.file().into(),
+            fs::read_to_string(loc.file())
+                .map(|txt| Self::from_location(&txt, loc.line() as usize, loc.column() as usize))?,
+        ))
+    }
 }
 
 impl From<ByteOffset> for SourceOffset {