q-debug 0.1.1

Quick and dirty debugging for tired Rust programmers
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

/// Expands to the path of the function within which it was invoked e.g.
/// `"crate::module::function::"`
#[macro_export]
macro_rules! function {
    () => {{
        // This works by defining a function within the call site and using
        // (abusing) `std::any::type_name` to retrieve it's full path.
        //
        // Note: it is possible that this may break as the docs for
        // `std::any::type_name`` state:
        //
        // > This is intended for diagnostic use. The exact contents and
        // > format of the string are not specified, other than being a
        // > best-effort description of the type
        //
        // and
        // > ... output may change between versions of the compiler.
        //
        // I'm ok with this because `q` is a low-risk crate (e.g. it's a "cool"
        // debugging tool but if it breaks it won't be the end of the world),
        // it works for now and I can't (currently) think of a better way to
        // do this without more "heavy-weight" methods e.g. parsing backtraces
        // or proc macros.
        fn f() {}
        fn type_name_of<T>(_: T) -> &'static str {
            std::any::type_name::<T>()
        }
        let name = type_name_of(f); // `"crate::module::function::f"`
        &name[..name.len() - 3] // `"crate::module::function::"`
    }};
}

#[macro_export]
macro_rules! loc {
    () => {
        $crate::LogLocation {
            file_path: file!().to_string(),
            func_path: function!().to_string(),
            lineno: line!(),
            thread_id: std::thread::current().id(),
        }
    };
}

// TODO: Variadic arguments e.g. `q!("Hello", 1, foo(2))` -> `"> \"Hello\", 1, foo(2) = 3"`

#[macro_export]
macro_rules! q {
    // Note: `unwrap` is used when accessing the the global `Logger` mutex as
    // trying to recover from lock poisoning is not suitable for this use case.
    () => {
        $crate::LOGGER.write().unwrap().q(loc!());
    };

    ($x:literal) => {{
        let val = $x;
        $crate::LOGGER.write().unwrap().q_literal(&val, loc!());
        val
    }};

    ($x:expr) => {{
        let val = $x;
        $crate::LOGGER
            .write()
            .unwrap()
            .q_expr(&val, stringify!($x), loc!());
        val
    }};
}

#[cfg(test)]
mod tests {

    #[test]
    fn test_function() {
        assert_eq!(function!(), "q_debug::macros::tests::test_function");

        struct Foo {
            bar: String,
        }

        impl Foo {
            pub fn new() -> Self {
                Foo {
                    bar: function!().to_string(),
                }
            }
        }

        assert_eq!(
            Foo::new().bar,
            "q_debug::macros::tests::test_function::Foo::new"
        );
    }
}