2016-04-14 16:13:15 +00:00
|
|
|
use rustc::hir::*;
|
2016-04-07 15:46:48 +00:00
|
|
|
use rustc::hir::map::Node::{NodeItem, NodeImplItem};
|
2016-01-28 18:29:59 +00:00
|
|
|
use rustc::lint::*;
|
2016-04-14 16:13:15 +00:00
|
|
|
use utils::paths;
|
2016-02-07 17:30:57 +00:00
|
|
|
use utils::{is_expn_of, match_path, span_lint};
|
2016-01-28 18:29:59 +00:00
|
|
|
|
2016-07-15 22:25:44 +00:00
|
|
|
/// **What it does:** This lint warns whenever you print on *stdout*. The purpose of this lint is
|
|
|
|
/// to catch debugging remnants.
|
2016-01-28 18:29:59 +00:00
|
|
|
///
|
|
|
|
/// **Why is this bad?** People often print on *stdout* while debugging an application and might
|
|
|
|
/// forget to remove those prints afterward.
|
|
|
|
///
|
|
|
|
/// **Known problems:** Only catches `print!` and `println!` calls.
|
|
|
|
///
|
2016-07-15 22:25:44 +00:00
|
|
|
/// **Example:**
|
|
|
|
/// ```rust
|
|
|
|
/// println!("Hello world!");
|
|
|
|
/// ```
|
2016-01-28 18:29:59 +00:00
|
|
|
declare_lint! {
|
|
|
|
pub PRINT_STDOUT,
|
|
|
|
Allow,
|
|
|
|
"printing on stdout"
|
|
|
|
}
|
|
|
|
|
2016-07-15 22:25:44 +00:00
|
|
|
/// **What it does:** This lint warns whenever you use `Debug` formatting. The purpose of this lint
|
|
|
|
/// is to catch debugging remnants.
|
2016-02-07 17:30:57 +00:00
|
|
|
///
|
|
|
|
/// **Why is this bad?** The purpose of the `Debug` trait is to facilitate debugging Rust code. It
|
|
|
|
/// should not be used in in user-facing output.
|
|
|
|
///
|
2016-07-15 22:25:44 +00:00
|
|
|
/// **Example:**
|
|
|
|
/// ```rust
|
|
|
|
/// println!("{:?}", foo);
|
|
|
|
/// ```
|
2016-02-07 17:30:57 +00:00
|
|
|
declare_lint! {
|
|
|
|
pub USE_DEBUG,
|
|
|
|
Allow,
|
|
|
|
"use `Debug`-based formatting"
|
|
|
|
}
|
|
|
|
|
2016-01-28 18:29:59 +00:00
|
|
|
#[derive(Copy, Clone, Debug)]
|
2016-06-10 14:17:20 +00:00
|
|
|
pub struct Pass;
|
2016-01-28 18:29:59 +00:00
|
|
|
|
2016-06-10 14:17:20 +00:00
|
|
|
impl LintPass for Pass {
|
2016-01-28 18:29:59 +00:00
|
|
|
fn get_lints(&self) -> LintArray {
|
2016-02-07 17:30:57 +00:00
|
|
|
lint_array!(PRINT_STDOUT, USE_DEBUG)
|
2016-01-28 18:29:59 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-06-10 14:17:20 +00:00
|
|
|
impl LateLintPass for Pass {
|
2016-01-28 18:29:59 +00:00
|
|
|
fn check_expr(&mut self, cx: &LateContext, expr: &Expr) {
|
2016-02-07 17:30:57 +00:00
|
|
|
if let ExprCall(ref fun, ref args) = expr.node {
|
2016-01-28 18:29:59 +00:00
|
|
|
if let ExprPath(_, ref path) = fun.node {
|
2016-02-07 17:30:57 +00:00
|
|
|
// Search for `std::io::_print(..)` which is unique in a
|
|
|
|
// `print!` expansion.
|
2016-04-14 16:13:15 +00:00
|
|
|
if match_path(path, &paths::IO_PRINT) {
|
2016-01-28 18:29:59 +00:00
|
|
|
if let Some(span) = is_expn_of(cx, expr.span, "print") {
|
2016-02-07 17:30:57 +00:00
|
|
|
// `println!` uses `print!`.
|
2016-01-28 18:29:59 +00:00
|
|
|
let (span, name) = match is_expn_of(cx, span, "println") {
|
|
|
|
Some(span) => (span, "println"),
|
|
|
|
None => (span, "print"),
|
|
|
|
};
|
|
|
|
|
2016-01-30 12:48:39 +00:00
|
|
|
span_lint(cx, PRINT_STDOUT, span, &format!("use of `{}!`", name));
|
2016-01-28 18:29:59 +00:00
|
|
|
}
|
|
|
|
}
|
2016-02-07 17:30:57 +00:00
|
|
|
// Search for something like
|
|
|
|
// `::std::fmt::ArgumentV1::new(__arg0, ::std::fmt::Debug::fmt)`
|
2016-04-14 16:13:15 +00:00
|
|
|
else if args.len() == 2 && match_path(path, &paths::FMT_ARGUMENTV1_NEW) {
|
2016-02-07 17:30:57 +00:00
|
|
|
if let ExprPath(None, ref path) = args[1].node {
|
2016-04-14 16:13:15 +00:00
|
|
|
if match_path(path, &paths::DEBUG_FMT_METHOD) && !is_in_debug_impl(cx, expr) &&
|
2016-02-29 11:19:32 +00:00
|
|
|
is_expn_of(cx, expr.span, "panic").is_none() {
|
2016-02-07 17:30:57 +00:00
|
|
|
span_lint(cx, USE_DEBUG, args[0].span, "use of `Debug`-based formatting");
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2016-01-28 18:29:59 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2016-02-07 17:30:57 +00:00
|
|
|
|
|
|
|
fn is_in_debug_impl(cx: &LateContext, expr: &Expr) -> bool {
|
|
|
|
let map = &cx.tcx.map;
|
|
|
|
|
2016-02-29 11:19:32 +00:00
|
|
|
// `fmt` method
|
|
|
|
if let Some(NodeImplItem(item)) = map.find(map.get_parent(expr.id)) {
|
|
|
|
// `Debug` impl
|
|
|
|
if let Some(NodeItem(item)) = map.find(map.get_parent(item.id)) {
|
2016-02-07 17:30:57 +00:00
|
|
|
if let ItemImpl(_, _, _, Some(ref tr), _, _) = item.node {
|
|
|
|
return match_path(&tr.path, &["Debug"]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
false
|
|
|
|
}
|