rust-clippy/clippy_lints/src/panic.rs

55 lines
1.9 KiB
Rust
Raw Normal View History

use rustc::hir::*;
2016-04-14 16:13:15 +00:00
use rustc::lint::*;
2016-02-12 17:35:44 +00:00
use syntax::ast::LitKind;
use utils::{is_direct_expn_of, match_def_path, resolve_node, paths, span_lint};
2015-12-23 21:37:52 +00:00
/// **What it does:** Checks for missing parameters in `panic!`.
2015-12-23 21:37:52 +00:00
///
/// **Why is this bad?** Contrary to the `format!` family of macros, there are
/// two forms of `panic!`: if there are no parameters given, the first argument
/// is not a format string and used literally. So while `format!("{}")` will
/// fail to compile, `panic!("{}")` will not.
///
/// **Known problems:** Should you want to use curly brackets in `panic!`
/// without any parameter, this lint will warn.
2015-12-23 21:37:52 +00:00
///
/// **Example:**
2016-07-15 22:25:44 +00:00
/// ```rust
/// panic!("This `panic!` is probably missing a parameter there: {}");
2015-12-23 21:37:52 +00:00
/// ```
declare_lint! {
pub PANIC_PARAMS,
Warn,
"missing parameters in `panic!` calls"
}
2015-12-23 21:37:52 +00:00
#[allow(missing_copy_implementations)]
2016-06-10 14:17:20 +00:00
pub struct Pass;
2015-12-23 21:37:52 +00:00
2016-06-10 14:17:20 +00:00
impl LintPass for Pass {
2015-12-23 21:37:52 +00:00
fn get_lints(&self) -> LintArray {
lint_array!(PANIC_PARAMS)
}
}
impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Pass {
fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
2015-12-23 21:37:52 +00:00
if_let_chain! {[
2015-12-24 09:57:31 +00:00
let ExprBlock(ref block) = expr.node,
let Some(ref ex) = block.expr,
let ExprCall(ref fun, ref params) = ex.node,
2015-12-23 21:37:52 +00:00
params.len() == 2,
let ExprPath(ref qpath) = fun.node,
2017-01-13 16:04:56 +00:00
match_def_path(cx.tcx, resolve_node(cx, qpath, fun.id).def_id(), &paths::BEGIN_PANIC),
2015-12-23 21:37:52 +00:00
let ExprLit(ref lit) = params[0].node,
is_direct_expn_of(params[0].span, "panic").is_some(),
2016-02-12 17:35:44 +00:00
let LitKind::Str(ref string, _) = lit.node,
let Some(par) = string.as_str().find('{'),
string.as_str()[par..].contains('}')
2015-12-23 21:37:52 +00:00
], {
span_lint(cx, PANIC_PARAMS, params[0].span,
"you probably are missing some parameter in your format string");
2015-12-23 21:37:52 +00:00
}}
}
}