2016-04-07 10:46:48 -05:00
|
|
|
use rustc::hir::*;
|
2016-04-14 11:13:15 -05:00
|
|
|
use rustc::lint::*;
|
2016-02-12 11:35:44 -06:00
|
|
|
use syntax::ast::LitKind;
|
2017-09-12 07:26:40 -05:00
|
|
|
use utils::{is_direct_expn_of, match_def_path, paths, resolve_node, span_lint, opt_def_id};
|
2015-12-23 15:37:52 -06:00
|
|
|
|
2016-08-06 02:55:04 -05:00
|
|
|
/// **What it does:** Checks for missing parameters in `panic!`.
|
2015-12-23 15:37:52 -06:00
|
|
|
///
|
2016-08-06 02:55:04 -05: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 15:37:52 -06:00
|
|
|
///
|
|
|
|
/// **Example:**
|
2016-07-15 17:25:44 -05:00
|
|
|
/// ```rust
|
2016-02-05 17:41:54 -06:00
|
|
|
/// panic!("This `panic!` is probably missing a parameter there: {}");
|
2015-12-23 15:37:52 -06:00
|
|
|
/// ```
|
2016-02-05 17:13:29 -06:00
|
|
|
declare_lint! {
|
2016-08-06 03:18:36 -05:00
|
|
|
pub PANIC_PARAMS,
|
|
|
|
Warn,
|
|
|
|
"missing parameters in `panic!` calls"
|
2016-02-05 17:13:29 -06:00
|
|
|
}
|
2015-12-23 15:37:52 -06:00
|
|
|
|
|
|
|
#[allow(missing_copy_implementations)]
|
2016-06-10 09:17:20 -05:00
|
|
|
pub struct Pass;
|
2015-12-23 15:37:52 -06:00
|
|
|
|
2016-06-10 09:17:20 -05:00
|
|
|
impl LintPass for Pass {
|
2015-12-23 15:37:52 -06:00
|
|
|
fn get_lints(&self) -> LintArray {
|
|
|
|
lint_array!(PANIC_PARAMS)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-12-07 06:13:40 -06:00
|
|
|
impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Pass {
|
|
|
|
fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
|
2015-12-23 15:37:52 -06:00
|
|
|
if_let_chain! {[
|
2015-12-24 03:57:31 -06:00
|
|
|
let ExprBlock(ref block) = expr.node,
|
|
|
|
let Some(ref ex) = block.expr,
|
|
|
|
let ExprCall(ref fun, ref params) = ex.node,
|
2015-12-23 15:37:52 -06:00
|
|
|
params.len() == 2,
|
2016-12-01 15:31:56 -06:00
|
|
|
let ExprPath(ref qpath) = fun.node,
|
2017-09-12 07:26:40 -05:00
|
|
|
let Some(fun_def_id) = opt_def_id(resolve_node(cx, qpath, fun.hir_id)),
|
|
|
|
match_def_path(cx.tcx, fun_def_id, &paths::BEGIN_PANIC),
|
2015-12-23 15:37:52 -06:00
|
|
|
let ExprLit(ref lit) = params[0].node,
|
2017-04-07 04:21:39 -05:00
|
|
|
is_direct_expn_of(expr.span, "panic").is_some(),
|
2016-02-12 11:35:44 -06:00
|
|
|
let LitKind::Str(ref string, _) = lit.node,
|
2016-11-23 14:19:03 -06:00
|
|
|
let Some(par) = string.as_str().find('{'),
|
2017-08-21 16:23:54 -05:00
|
|
|
string.as_str()[par..].contains('}'),
|
|
|
|
params[0].span.source_callee().is_none()
|
2015-12-23 15:37:52 -06:00
|
|
|
], {
|
2016-03-15 15:02:08 -05:00
|
|
|
span_lint(cx, PANIC_PARAMS, params[0].span,
|
|
|
|
"you probably are missing some parameter in your format string");
|
2015-12-23 15:37:52 -06:00
|
|
|
}}
|
|
|
|
}
|
|
|
|
}
|