devela 0.28.0

A development substrate of coherence.
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235

// devela::code::util::cdbg
//
//! Defines the custom debug macro [`cdbg!`].
//

#[doc = crate::_tags!(code debug)]
/// *`c`ustomizable [`dbg!`]* macro.
#[doc = crate::_doc_meta!{location("code/util")}]
///
/// - By default uses `{:?}` instead of `{:#?}` for formatting.
/// - By default doesn't show the location (file, line and column).
/// - It can show the `$n` last components, instead of the full path.
/// - It can use a string prefix before `;`, replacing the default `expr = ` label.
///
/// # Examples
/// ```
/// # use devela::cdbg;
/// let a = vec![1, 2, 3];
///
/// let _ = cdbg![&a];
/// let _ = cdbg![@ &a];
/// let _ = cdbg![0@ &a];
/// //      ^-- prints: &a = [1, 2, 3]
/// let _ = cdbg![1@ &a];
/// //      ^-- prints: [main.rs:6:10] &a = [1, 2, 3]
/// let _ = cdbg![2@ &a];
/// //      ^-- prints: [src/main.rs:8:10] &a = [1, 2, 3]
/// let _ = cdbg![f@ &a];
/// //      ^-- prints: [/full/path/.../src/main.rs:10:9] &a = [1, 2, 3]
/// let _ = cdbg![fln@ &a];
/// //      ^-- prints: [/full/path/.../src/main.rs:12:9]
/// //                  &a = [1, 2, 3]
///
/// // use `;` to indicate a custom prefix:
/// let _ = cdbg!["a: "; &a];
/// //      ^-- prints: a: [1, 2, 3]
/// let _ = cdbg![; &a];
/// //      ^-- prints: [1, 2, 3]
/// let _ = cdbg!["a: "; 1@ &a];
/// //      ^-- prints: [main.rs:16:10] a: [1, 2, 3]
///
/// // use `#` for pretty-printing:
/// let _ = cdbg![# &a];
/// let _ = cdbg![0# &a];    // same as cdbg![# &a]
/// let _ = cdbg![1# &a];
/// let _ = cdbg![f # &a];   // same as `dbg!` macro (notice the required whitespace)
/// let _ = cdbg![fln # &a]; // same as before, but separates the path in a new line
/// ```
// Source code began with Rust std `dbg!` implementation. Look where we are now.
#[macro_export]
#[cfg_attr(nightly_doc, doc(cfg(feature = "std")))]
#[cfg_attr(cargo_primary_package, doc(hidden))]
macro_rules! cdbg {
    (
     // shows no location (pretty-print)                            cdbg![# x];
     # $v:expr $(,)?) => { $crate::cdbg![%fmt # concat!(stringify!($v), " = "), $v] };
    (# $($v:expr),+ $(,)?) => { ($($crate::cdbg![# $v]),+,) };
    (
     // shows no location                                           cdbg![x];
     //                                                             cdbg![@ x];
     $(@)? $v:expr $(,)?) => { $crate::cdbg![%fmt ? concat!(stringify!($v), " = "), $v] };
    ($($v:expr),+ $(,)?) => { ($($crate::cdbg![$v]),+,) };
    (
     // shows no location with a custom prefix (pretty-print)       cdbg!["x: "; # x];
     $prefix:literal ; # $v:expr $(,)?) => { $crate::cdbg![%fmt # $prefix, $v] };
    ($prefix:literal ; # $($v:expr),+ $(,)?) => { ($($crate::cdbg![$prefix; # $v]),+,) };
    (
     // shows no location with a custom prefix                      cdbg!["x: "; x];
     //                                                             cdbg![""; x];
     $prefix:literal ; $(@)? $v:expr $(,)?) => { $crate::cdbg![%fmt ? $prefix, $v] };
    ($prefix:literal ; $($v:expr),+ $(,)?) => { ($($crate::cdbg![$prefix; $v]),+,) };
    (

     // shows the last $n location components with a custom prefix
     // ($n=0 no location, $n=1 just the filename)                  cdbg!["x: "; 1@ x];
     $prefix:literal ; $n:literal @ $v:expr $(,)?) => {{
        if $crate::cif!(diff($n, 0)) {
            let (path, mut new_path) = (std::path::Path::new(file!()), std::path::PathBuf::new());
            for c in path.components().rev().take($n).collect::<Vec<_>>().into_iter().rev() {
                new_path.push(c.as_os_str()); }
            eprint!("[{}:{}:{}] ", new_path.display(), line!(), column!());
        }
        $crate::cdbg![$prefix; $v]
    }};
    ($prefix:literal ; $n:literal @ $($v:expr),+ $(,)?) => {
        ($( $crate::cdbg![$prefix; $n@ $v] ),+,)
    };
    (
     // shows the last $n location components                       cdbg![1@ x];
     // ($n=0 no location, $n=1 just the filename)
     $n:literal @ $v:expr $(,)?) => {{
        if $crate::cif!(diff($n, 0)) {
            let (path, mut new_path) = (std::path::Path::new(file!()), std::path::PathBuf::new());
            for c in path.components().rev().take($n).collect::<Vec<_>>().into_iter().rev() {
                new_path.push(c.as_os_str()); }
            eprint!("[{}:{}:{}] ", new_path.display(), line!(), column!());
        }
        $crate::cdbg![$v]
    }};
    ($n:literal @ $($v:expr),+ $(,)?) => { ($( $crate::cdbg![$n@ $v] ),+,) };
    ($n:literal @) => {{
        let (path, mut new_path) = (std::path::Path::new(file!()), std::path::PathBuf::new());
        for c in path.components().rev().take($n).collect::<Vec<_>>().into_iter().rev() {
            new_path.push(c.as_os_str()); }
        eprintln!("[{}:{}:{}]", new_path.display(), line!(), column!())
    }};
    (// shows the last $n location components with a custom prefix
     // (pretty-print)                                              cdbg!["x: "; 1# x];
     $prefix:literal ; $n:literal # $v:expr $(,)?) => {{
        if $crate::cif!(diff($n, 0)) {
            let (path, mut new_path) = (std::path::Path::new(file!()), std::path::PathBuf::new());
            for c in path.components().rev().take($n).collect::<Vec<_>>().into_iter().rev() {
                new_path.push(c.as_os_str()); }
            eprint!("[{}:{}:{}] ", new_path.display(), line!(), column!());
        }
        $crate::cdbg![$prefix; # $v]
    }};
    ($prefix:literal ; $n:literal # $($v:expr),+ $(,)?) => {
        ($( $crate::cdbg![$prefix; $n # $v] ),+,)
    };
    (// shows the last $n location components                       cdbg![1# x];
     // (pretty-print)
     $n:literal # $v:expr $(,)?) => {{
        if $crate::cif!(diff($n, 0)) {
            let (path, mut new_path) = (std::path::Path::new(file!()), std::path::PathBuf::new());
            for c in path.components().rev().take($n).collect::<Vec<_>>().into_iter().rev() {
                new_path.push(c.as_os_str()); }
            eprint!("[{}:{}:{}] ", new_path.display(), line!(), column!());
        }
        $crate::cdbg![# $v]
    }};
    ($n:literal # $($v:expr),+ $(,)?) => { ($( $crate::cdbg![$n # $v] ),+,) };
    ($n:literal #) => {{
        let (path, mut new_path) = (std::path::Path::new(file!()), std::path::PathBuf::new());
        for c in path.components().rev().take($n).collect::<Vec<_>>().into_iter().rev() {
            new_path.push(c.as_os_str()); }
        eprintln!("[{}:{}:{}]", new_path.display(), line!(), column!())
    }};
    (

     // shows the full path location with a custom prefix           cdbg!["x: "; f@ x];
     $prefix:literal ; f @ $v:expr $(,)?) => {{
        eprint!("[{}:{}:{}] ", file!(), line!(), column!());
        $crate::cdbg![$prefix; $v]
    }};
    ($prefix:literal ; f @ $($v:expr),+ $(,)?) => {
        ($($crate::cdbg![$prefix; f @ $v]),+,)
    };
    (
     // shows the full path location                                cdbg![f@ x];
     f @ $v:expr $(,)?) => {{
        eprint!("[{}:{}:{}] ", file!(), line!(), column!());
        $crate::cdbg![$v]
    }};
    (f @ $($v:expr),+ $(,)?) => { ($($crate::cdbg![f @ $v]),+,) };
    (f @) => { eprintln!("[{}:{}:{}]", file!(), line!(), column!()) };

    (// shows the full path location with a custom prefix           cdbg!["x: "; f # x];
     // (pretty-print)
     $prefix:literal ; f # $v:expr $(,)?) => {{
        eprint!("[{}:{}:{}] ", file!(), line!(), column!());
        $crate::cdbg![$prefix; # $v]
    }};
    ($prefix:literal ; f # $($v:expr),+ $(,)?) => {
        ($($crate::cdbg![$prefix; f # $v]),+,)
    };
    (// shows the full path location                                cdbg![f # x];
     // (pretty-print, equivalent to `dbg!`)
     f # $v:expr $(,)?) => {{
        eprint!("[{}:{}:{}] ", file!(), line!(), column!());
        $crate::cdbg![# $v]
    }};
    (f # $($v:expr),+ $(,)?) => { ($($crate::cdbg![f # $v]),+,) };
    (f #) => { eprintln!("[{}:{}:{}]", file!(), line!(), column!()) };

    (
     // shows the full path location in a separate line with a custom prefix
     //                                                             cdbg!["x: "; fln@ x];
     $prefix:literal ; fln @ $v:expr $(,)?) => {{
        eprintln!("[{}:{}:{}]", file!(), line!(), column!());
        $crate::cdbg![$prefix; $v]
    }};
    ($prefix:literal ; fln @ $($v:expr),+ $(,)?) => {
        ($($crate::cdbg![$prefix; fln @ $v]),+,)
    };
    (
     // shows the full path location in a separate line             cdbg![fln@ x];
     fln @ $v:expr $(,)?) => {{
        eprintln!("[{}:{}:{}]", file!(), line!(), column!());
        $crate::cdbg![$v]
    }};
    (fln @ $($v:expr),+ $(,)?) => { ($($crate::cdbg![fln @ $v]),+,) };
    (fln @) => { eprintln!("[{}:{}:{}]", file!(), line!(), column!()) };

    (// shows the full path location in a separate line with a custom prefix
     // (pretty-print)                                              cdbg!["x: "; fln # x];
     $prefix:literal ; fln # $v:expr $(,)?) => {{
        eprintln!("[{}:{}:{}]", file!(), line!(), column!());
        $crate::cdbg![$prefix; # $v]
    }};
    ($prefix:literal ; fln # $($v:expr),+ $(,)?) => {
        ($($crate::cdbg![$prefix; fln # $v]),+,)
    };
    (// shows the full path location in a separate line             cdbg![fln # x];
     // (pretty-print)
     fln # $v:expr $(,)?) => {{
        eprintln!("[{}:{}:{}]", file!(), line!(), column!());
        $crate::cdbg![# $v]
    }};
    (fln # $($v:expr),+ $(,)?) => { ($($crate::cdbg![fln # $v]),+,) };
    (fln #) => { eprintln!("[{}:{}:{}]", file!(), line!(), column!()) };

    /* private */
    //
    // prints a debug value with a custom prefix
    (%fmt ? $prefix:expr, $v:expr $(,)?) => {{
        let prefix: &str = $prefix;
        match $v { v => { eprintln!("{}{:?}", prefix, &v); v } }
    }};
    // pretty-prints a debug value with a custom prefix
    (%fmt # $prefix:expr, $v:expr $(,)?) => {{
        let prefix: &str = $prefix;
        match $v { v => { eprintln!("{}{:#?}", prefix, &v); v } }
    }};
    (
    // empty prefix shorthand                                       cdbg![; x];
    ; $($tt:tt)+) => { $crate::cdbg![""; $($tt)+] };
    (
    // no-op                                                        cdbg![;];
    //                                                              cdbg![];
    ;) => { () };
    () => { () };
}
#[doc(inline)]
pub use cdbg;