async-backtrace 0.2.2

use std::fmt::Display;

use futures::Future;

/// Produces a [`Location`] when invoked in a function body.
///
/// ```
/// use async_backtrace::{location, Location};
///
/// #[tokio::main]
/// async fn main() {
///     assert_eq!(location!().to_string(), "rust_out::main::{{closure}} at src/location.rs:7:16");
///
///     async {
///         assert_eq!(location!().to_string(), "rust_out::main::{{closure}}::{{closure}} at src/location.rs:10:20");
///     }.await;
///     
///     (|| async {
///         assert_eq!(location!().to_string(), "rust_out::main::{{closure}}::{{closure}}::{{closure}} at src/location.rs:14:20");
///     })().await;
/// }
/// ```
#[macro_export]
macro_rules! location {
    () => {{
        macro_rules! fn_name {
            () => {{
                fn type_name_of_val<T: ?Sized>(_: &T) -> &'static str {
                    core::any::type_name::<T>()
                }
                type_name_of_val(&|| {})
                    .strip_suffix("::{{closure}}")
                    .unwrap()
            }};
        }
        $crate::Location::from_components(fn_name!(), &(file!(), line!(), column!()))
    }};
}

/// A source code location in a function body.
///
/// To construct a `Location`, use [`location!()`].
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct Location {
    /// The name of the surrounding function.
    name: Option<&'static str>,
    /// The file name, line number, and column number on which the surrounding
    /// function is defined.
    rest: &'static (&'static str, u32, u32),
}

impl Location {
    /// **DO NOT USE!** The signature of this method may change between
    /// non-breaking releases.
    #[doc(hidden)]
    #[inline(always)]
    pub const fn from_components(
        name: &'static str,
        rest: &'static (&'static str, u32, u32),
    ) -> Self {
        Self {
            name: Some(name),
            rest,
        }
    }

    /// Include the given future in taskdumps with this location.
    ///
    /// ## Examples
    /// ```
    /// # async fn bar() {}
    /// # async fn baz() {}
    /// async fn foo() {
    ///     async_backtrace::location!().frame(async move {
    ///         bar().await;
    ///         baz().await;
    ///     }).await
    /// }
    /// ```
    pub fn frame<F>(self, f: F) -> impl Future<Output = F::Output>
    where
        F: Future,
    {
        crate::Framed::new(f, self)
    }

    /// Produces the function name associated with this location.
    pub const fn name(&self) -> Option<&str> {
        self.name
    }

    /// Produces the file name associated with this location.
    pub const fn file(&self) -> &str {
        self.rest.0
    }

    /// Produces the line number associated with this location.
    pub const fn line(&self) -> u32 {
        self.rest.1
    }

    /// Produces the column number associated with this location.
    pub const fn column(&self) -> u32 {
        self.rest.2
    }
}

impl Display for Location {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let file = self.file();
        let line = self.line();
        let column = self.column();
        if let Some(name) = self.name() {
            f.write_fmt(format_args!("{name} at {file}:{line}:{column}"))
        } else {
            f.write_fmt(format_args!("{file}:{line}:{column}"))
        }
    }
}