Files
addr2line
adler
aho_corasick
ansi_term
atty
backtrace
base64
bincode
bitflags
bitmaps
bstr
byteorder
bytes
bytesize
cargo
cargo_platform
cfg_if
chrono
clap
color_backtrace
corpus_database
corpus_database_dsl
corpus_extractor
corpus_manager
corpus_manager_driver
corpus_queries_derive
corpus_queries_impl
crates_index
crates_io
crc32fast
crossbeam_queue
crossbeam_utils
crypto_hash
csv
csv_core
curl
curl_sys
darling
darling_core
darling_macro
datafrog
datapond
datapond_derive
datapond_macro
either
encoding_rs
env_logger
error_chain
failure
failure_derive
filetime
flate2
fnv
foreign_types
foreign_types_shared
form_urlencoded
fs2
futures
futures_channel
futures_core
futures_io
futures_macro
futures_sink
futures_task
futures_util
async_await
future
io
lock
stream
task
getrandom
gimli
git2
git2_curl
glob
globset
h2
hashbrown
heck
hex
home
http
http_body
httparse
httpdate
humantime
hyper
hyper_tls
ident_case
idna
ignore
im_rc
indexmap
iovec
ipnet
itertools
itoa
jobserver
lazy_static
lazycell
libc
libgit2_sys
libnghttp2_sys
libssh2_sys
libz_sys
lock_api
log
log_derive
matches
maybe_uninit
memchr
mime
miniz_oxide
mio
mio_uds
native_tls
nix
num_cpus
num_integer
num_traits
object
once_cell
opener
openssl
openssl_probe
openssl_sys
parking_lot
parking_lot_core
percent_encoding
pest
pin_project
pin_project_lite
pin_utils
ppv_lite86
print_stats
proc_macro2
proc_macro_error
proc_macro_error_attr
proc_macro_hack
proc_macro_nested
quick_error
quote
rand
rand_chacha
rand_core
rand_xoshiro
regex
regex_automata
regex_syntax
remove_dir_all
reqwest
rustc
rustc_demangle
rustc_hash
rustc_workspace_hack
rustfix
rustwide
ryu
same_file
scopeguard
semver
semver_parser
serde
serde_derive
serde_ignored
serde_json
serde_urlencoded
shell_escape
signal_hook_registry
simplelog
sized_chunks
slab
smallvec
socket2
strip_ansi_escapes
strsim
structopt
structopt_derive
syn
synstructure
tar
tempdir
tempfile
termcolor
textwrap
thiserror
thiserror_impl
thread_local
time
tinyvec
tinyvec_macros
tokio
future
io
loom
macros
net
park
runtime
sync
task
time
util
tokio_executor
tokio_io
tokio_native_tls
tokio_process
tokio_reactor
tokio_signal
tokio_stream
tokio_sync
tokio_util
toml
tower_service
tracing
tracing_core
tracing_futures
try_lock
typenum
ucd_trie
unicode_bidi
unicode_normalization
unicode_segmentation
unicode_width
unicode_xid
url
utf8parse
vec_map
vte
walkdir
want
xattr
  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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
#![recursion_limit = "128"]

//! # Log Derive
//!
//! `log-derive` provides a simple attribute macro that facilitates logs as part of the [`log`] facade <br>
//! Right now it contains two macros [`logfn`], [`logfn_inputs`] these macros are only for functions but still have a lot of power.
//!
//!
//!  # Use
//! The basic use of these macros is by putting one or both of them on top of the function like this: `#[logfn(INFO)]` <br>
//!
//! The [`logfn`] macro is used to log the *output* of the function and [`logfn_inputs`] is used to log the *inputs*. <br>
//! Please notice, the arguments being logged **must** implement the [`Debug`] trait. <br>
//! (i.e. [`logfn`] requires the output to be [`Debug`] and [`logfn_inputs`] require the inputs to be [`Debug`]) <br>
//!
//! The macros will accept all log levels provided by the [`log`] facade. <br>
//! In [`logfn`] if the function returns a [`Result`] type the macro will accept the following additional attributes: <br>
//! `(ok = "LEVEL")` and `(err = "LEVEL")` this can provide different log levels if the function failed or not. <br>
//!
//! By default the macro uses the following formatting to print the message: <br>
//! [`logfn`]: `("FUNCTION_NAME() => {:?}", return_val)` <br>
//! [`logfn_inputs`]: `"FUNCTION_NAME(a: {:?}, b: {:?})", a, b)` <br>
//! This can be easily changed using the `fmt` attribute: `#[logfn(LEVEL, fmt = "Important Result: {:}")` <br>
//! which will accept format strings similar to [`println!`].
//!
//! [`logfn`]: ./attr.logfn.html
//! [`logfn_inputs`]: ./attr.logfn_inputs.html
//! [`log`]: https://docs.rs/log/latest/log/index.html
//! [`Result`]: https://doc.rust-lang.org/std/result/enum.Result.html
//! [`println!`]: https://doc.rust-lang.org/stable/std/macro.println.html
//! [`Debug`]: https://doc.rust-lang.org/std/fmt/trait.Debug.html
//!
//! ## Examples
//! ```rust
//! use log_derive::{logfn, logfn_inputs};
//!
//! # #[derive(Debug)]
//! struct Error;
//! # #[derive(Debug)]
//! struct Success;
//! # #[derive(Debug)]
//! enum Status { Alive, Dead, Unknown }
//!
//! #[logfn(Warn)]
//! #[logfn_inputs(Info, fmt = "Checking if {:?} is alive")]
//! fn is_alive(person: &Person) -> Status {
//!     # use Response::*;
//!     # use Status::*;
//!    match person.ping() {
//!        Pong => Status::Alive,
//!        Timeout => if person.is_awake() {
//!            Unknown
//!        } else {
//!            Dead
//!        }
//!   }
//!}
//!
//! #[logfn_inputs(Info)]
//! #[logfn(ok = "TRACE", err = "ERROR")]
//! fn call_isan(num: &str) -> Result<Success, Error> {
//!     if num.len() >= 10 && num.len() <= 15 {
//!         Ok(Success)
//!     } else {
//!         Err(Error)
//!     }
//! }
//!
//! #[logfn(INFO, fmt = "a + b = {}")]
//! #[logfn_inputs(Trace, fmt = "adding a: {:?} and b: {:?}")]
//! fn addition(a: usize, b: usize) -> usize {
//!     a + b
//! }
//!
//! #[logfn_inputs(Info)]
//! #[logfn(ok = "TRACE", log_ts = true)]
//! fn time_this(num: &str) -> Result<Success, Error> {
//!     if num.len() >= 10 && num.len() <= 15 {
//!        std::thread::sleep(Duration::from_secs(1));
//!         Ok(Success)
//!     } else {
//!         Err(Error)
//!     }
//! }
//!
//! # enum Response {Pong, Timeout}
//! # #[derive(Debug)]
//! # struct Person;
//! # impl Person {fn ping(&self) -> Response {Response::Pong}fn is_awake(&self) -> bool {true}}
//! # use std::time::Duration;
//! ```
//!
//!
extern crate proc_macro;
extern crate syn;
use darling::{Error, FromMeta};
use proc_macro2::TokenStream;
use quote::{quote, ToTokens};

use syn::punctuated::Punctuated;
use syn::{
    parse_macro_input, spanned::Spanned, token, AttributeArgs, Expr, ExprAsync, ExprAwait, ExprBlock, ExprCall, ExprClosure,
    ExprParen, FnArg, Ident, ItemFn, Meta, NestedMeta, Pat, Result, ReturnType, Stmt, Type, TypePath,
};

struct FormattedAttributes {
    ok_expr: TokenStream,
    err_expr: TokenStream,
    log_ts: bool,
    contained_ok_or_err: bool,
}

impl FormattedAttributes {
    pub fn parse_attributes(attr: &[NestedMeta], fmt_default: String) -> darling::Result<Self> {
        OutputOptions::from_list(attr).map(|opts| Self::get_ok_err_streams(opts, fmt_default))
    }

    fn get_ok_err_streams(att: OutputOptions, fmt_default: String) -> Self {
        let contained_ok_or_err = att.contains_ok_or_err();
        let log_ts = att.log_ts();
        let ok_log = att.ok_log();
        let err_log = att.err_log();
        let mut fmt = att.fmt().unwrap_or(fmt_default);
        if log_ts {
            fmt += ", ts={:#?}"
        };

        let ok_expr = match ok_log {
            Some(loglevel) => {
                let log_token = get_logger_token(&loglevel);
                if log_ts {
                    quote! {log::log!(#log_token, #fmt, result, ts); }
                } else {
                    quote! {log::log!(#log_token, #fmt, result); }
                }
            }
            None => quote! {()},
        };

        let err_expr = match err_log {
            Some(loglevel) => {
                let log_token = get_logger_token(&loglevel);
                if log_ts {
                    quote! {log::log!(#log_token, #fmt, err, ts); }
                } else {
                    quote! {log::log!(#log_token, #fmt, err); }
                }
            }
            None => quote! {()},
        };
        FormattedAttributes { ok_expr, err_expr, log_ts, contained_ok_or_err }
    }
}

#[derive(Default, FromMeta)]
#[darling(default)]
struct OutputNamedOptions {
    ok: Option<Ident>,
    err: Option<Ident>,
    fmt: Option<String>,
    log_ts: Option<bool>,
}

struct OutputOptions {
    /// The log level specified as the first word in the attribute.
    leading_level: Option<Ident>,
    named: OutputNamedOptions,
}

struct InputOptions {
    level: Ident,
    fmt: Option<String>,
}

impl FromMeta for InputOptions {
    fn from_list(items: &[NestedMeta]) -> darling::Result<Self> {
        let level;
        let mut fmt = None;
        if items.is_empty() {
            return Err(Error::too_few_items(1));
        }

        match &items[0] {
            NestedMeta::Meta(first) => {
                if let Meta::Path(path) = first {
                    if let Some(ident) = path.get_ident() {
                        level = ident.clone();
                    } else {
                        return Err(Error::unexpected_type("first item should be a log level"));
                    }
                } else {
                    return Err(Error::unexpected_type("first item should be a log level"));
                }
            }
            NestedMeta::Lit(lit) => return Err(Error::unexpected_lit_type(lit)),
        }

        if items.len() > 1 {
            fmt = String::from_nested_meta(&items[1]).ok();
        }

        Ok(InputOptions { level, fmt })
    }
}

impl OutputOptions {
    pub fn ok_log(&self) -> Option<&Ident> {
        self.named.ok.as_ref().or_else(|| self.leading_level.as_ref())
    }

    pub fn err_log(&self) -> Option<&Ident> {
        self.named.err.as_ref().or_else(|| self.leading_level.as_ref())
    }

    pub fn contains_ok_or_err(&self) -> bool {
        self.named.ok.is_some() || self.named.err.is_some()
    }

    pub fn log_ts(&self) -> bool {
        self.named.log_ts.unwrap_or(false)
    }

    pub fn fmt(&self) -> Option<String> {
        self.named.fmt.clone()
    }
}

impl FromMeta for OutputOptions {
    fn from_list(items: &[NestedMeta]) -> darling::Result<Self> {
        if items.is_empty() {
            return Err(darling::Error::too_few_items(1));
        }

        let mut leading_level = None;

        if let NestedMeta::Meta(first) = &items[0] {
            if let Meta::Path(path) = first {
                leading_level = path.get_ident().cloned();
            }
        }

        let named =
            if leading_level.is_some() { OutputNamedOptions::from_list(&items[1..])? } else { OutputNamedOptions::from_list(items)? };

        Ok(OutputOptions { leading_level, named })
    }
}

/// Check if a return type is some form of `Result`. This assumes that all types named `Result`
/// are in fact results, but is resilient to the possibility of `Result` types being referenced
/// from specific modules.
pub(crate) fn is_result_type(ty: &TypePath) -> bool {
    if let Some(segment) = ty.path.segments.iter().last() {
        segment.ident == "Result"
    } else {
        false
    }
}

fn check_if_return_result(f: &ItemFn) -> bool {
    if let ReturnType::Type(_, t) = &f.sig.output {
        return match t.as_ref() {
            Type::Path(path) => is_result_type(path),
            _ => false,
        };
    }

    false
}

fn get_logger_token(att: &Ident) -> TokenStream {
    // Capitalize the first letter.
    let attr_str = att.to_string().to_lowercase();
    let mut attr_char = attr_str.chars();
    let attr_str = attr_char.next().unwrap().to_uppercase().to_string() + attr_char.as_str();
    let att_str = Ident::new(&attr_str, att.span());
    quote!(log::Level::#att_str)
}

fn make_closure(original: &ItemFn) -> Expr {
    match original.sig.asyncness {
        Some(asyncness) => Expr::Await(ExprAwait {
            attrs: Default::default(),
            await_token: Default::default(),
            dot_token: Default::default(),
            base: Box::new(syn::Expr::Async(ExprAsync {
                attrs: Default::default(),
                capture: Some(token::Move { span: original.span() }),
                block: *original.block.clone(),
                async_token: asyncness,
            })),
        }),
        None => Expr::Call(ExprCall {
            attrs: Default::default(),
            args: Default::default(),
            paren_token: Default::default(),
            func: Box::new(syn::Expr::Paren(ExprParen {
                attrs: Default::default(),
                paren_token: Default::default(),
                expr: Box::new(syn::Expr::Closure(ExprClosure {
                    attrs: Default::default(),
                    asyncness: Default::default(),
                    movability: Default::default(),
                    capture: Some(token::Move { span: original.span() }),
                    or1_token: Default::default(),
                    inputs: Default::default(),
                    or2_token: Default::default(),
                    output: ReturnType::Default,
                    body: Box::new(Expr::Block(ExprBlock {
                        attrs: Default::default(),
                        label: Default::default(),
                        block: *original.block.clone(),
                    })),
                })),
            })),
        }),
    }
}

fn replace_function_headers(original: ItemFn, new: &mut ItemFn) {
    let block = new.block.clone();
    *new = original;
    new.block = block;
}

fn generate_function(closure: &Expr, expressions: FormattedAttributes, result: bool) -> Result<ItemFn> {
    let FormattedAttributes { ok_expr, err_expr, log_ts, contained_ok_or_err } = expressions;
    let result = result || contained_ok_or_err;
    let code = if log_ts {
        if result {
            quote! {
                fn temp() {
                    let instant = std::time::Instant::now();
                    let result = #closure;
                    let ts = instant.elapsed();
                    result.map(|result| { #ok_expr; result })
                        .map_err(|err| { #err_expr; err })
                }
            }
        } else {
            quote! {
                fn temp() {
                    let instant = std::time::Instant::now();
                    let result = #closure;
                    let ts = instant.elapsed();
                    #ok_expr;
                    result
                }
            }
        }
    } else if result {
        quote! {
            fn temp() {
                let result = #closure;
                result.map(|result| { #ok_expr; result })
                    .map_err(|err| { #err_expr; err })
            }
        }
    } else {
        quote! {
            fn temp() {
                let result = #closure;
                #ok_expr;
                result
            }
        }
    };

    syn::parse2(code)
}

/// Logs the result of the function it's above.
/// # Examples
/// ``` rust
///  # #[macro_use] extern crate log_derive;
/// # use std::{net::*, io::{self, Write}};
/// #[logfn(err = "Error", fmt = "Failed Sending Packet: {:?}")]
/// fn send_hi(addr: SocketAddr) -> Result<(), io::Error> {
///     let mut stream = TcpStream::connect(addr)?;
///     stream.write(b"Hi!")?;
///     Ok( () )
/// }
///
///
/// ```
#[proc_macro_attribute]
pub fn logfn(attr: proc_macro::TokenStream, item: proc_macro::TokenStream) -> proc_macro::TokenStream {
    let attr = parse_macro_input!(attr as AttributeArgs);
    let original_fn: ItemFn = parse_macro_input!(item as ItemFn);
    let fmt_default = original_fn.sig.ident.to_string() + "() => {:?}";
    let parsed_attributes: FormattedAttributes = match FormattedAttributes::parse_attributes(&attr, fmt_default) {
        Ok(val) => val,
        Err(err) => {
            return err.write_errors().into();
        }
    };
    let closure = make_closure(&original_fn);
    let is_result = check_if_return_result(&original_fn);
    let mut new_fn = generate_function(&closure, parsed_attributes, is_result).expect("Failed Generating Function");
    replace_function_headers(original_fn, &mut new_fn);
    new_fn.into_token_stream().into()
}

/// Logs the inputs of the function
/// # Examples
/// ``` rust
///  # #[macro_use] extern crate log_derive;
/// # use std::{net::*, io::{self, Write}};
/// #[logfn_inputs(INFO, fmt = "Good morning: {:?}, to: {:?}")]
/// fn good_morning(msg: &str, addr: SocketAddr) -> Result<(), io::Error> {
///     let mut stream = TcpStream::connect(addr)?;
///     stream.write(msg.as_bytes())?;
///     Ok( () )
/// }
///
///
/// ```
#[proc_macro_attribute]
pub fn logfn_inputs(attr: proc_macro::TokenStream, item: proc_macro::TokenStream) -> proc_macro::TokenStream {
    let mut original_fn: ItemFn = parse_macro_input!(item as ItemFn);

    let attr = parse_macro_input!(attr as AttributeArgs);
    let parsed_attributes = match InputOptions::from_list(&attr) {
        Ok(val) => val,
        Err(err) => {
            return err.write_errors().into();
        }
    };

    let mut stmts = match log_fn_inputs(&original_fn, parsed_attributes) {
        Ok(input_log) => vec![input_log],
        Err(e) => return e.to_compile_error().into(),
    };

    stmts.extend(original_fn.block.stmts);
    original_fn.block.stmts = stmts;
    original_fn.into_token_stream().into()
}

fn log_fn_inputs(func: &ItemFn, attr: InputOptions) -> syn::Result<Stmt> {
    let fn_name = func.sig.ident.to_string();
    let inputs: Vec<Ident> = func
        .sig
        .inputs
        .iter()
        .cloned()
        .map(|arg| match arg {
            FnArg::Receiver(arg) => arg.self_token.into(),
            FnArg::Typed(pat_type) => {
                if let Pat::Ident(ident) = *pat_type.pat {
                    ident.ident
                } else {
                    unimplemented!()
                }
            }
        })
        .collect();

    let items: Punctuated<_, token::Comma> = inputs.iter().cloned().collect();

    let level = get_logger_token(&attr.level);
    let fmt = attr.fmt.unwrap_or_else(|| {
        let mut fmt = String::with_capacity(inputs.len() * 9);
        fmt.push_str(&fn_name);
        fmt.push('(');

        for input in inputs {
            fmt.push_str(&input.to_string());
            fmt.push_str(": {:?},");
        }
        fmt.pop(); // Remove the extra comma.
        fmt.push(')');
        fmt
    });

    let res = quote! {
        log::log!(#level, #fmt, #items);
    };
    syn::parse2(res)
}

#[cfg(test)]
mod tests {
    use syn::parse_quote;

    use super::is_result_type;

    #[test]
    fn result_type() {
        assert!(is_result_type(&parse_quote!(Result<T, E>)));
        assert!(is_result_type(&parse_quote!(std::result::Result<T, E>)));
        assert!(is_result_type(&parse_quote!(fmt::Result)));
    }
}