rust/clippy_lints/src/panic_unimplemented.rs

109 lines
3.2 KiB
Rust
Raw Normal View History

use clippy_utils::diagnostics::span_lint;
use clippy_utils::{is_expn_of, match_panic_call};
2018-11-27 14:14:15 -06:00
use if_chain::if_chain;
use rustc_hir::Expr;
2020-01-12 00:08:41 -06:00
use rustc_lint::{LateContext, LateLintPass};
2020-01-11 05:37:08 -06:00
use rustc_session::{declare_lint_pass, declare_tool_lint};
2019-12-30 18:17:56 -06:00
use rustc_span::Span;
2015-12-23 15:37:52 -06:00
declare_clippy_lint! {
/// **What it does:** Checks for usage of `panic!`.
///
/// **Why is this bad?** `panic!` will stop the execution of the executable
///
/// **Known problems:** None.
///
/// **Example:**
/// ```no_run
/// panic!("even with a good reason");
/// ```
pub PANIC,
restriction,
2019-10-16 12:43:26 -05:00
"usage of the `panic!` macro"
}
2018-05-23 09:43:05 -05:00
declare_clippy_lint! {
/// **What it does:** Checks for usage of `unimplemented!`.
///
/// **Why is this bad?** This macro should not be present in production code
///
/// **Known problems:** None.
///
/// **Example:**
2019-03-05 16:23:50 -06:00
/// ```no_run
/// unimplemented!();
/// ```
2018-05-23 09:43:05 -05:00
pub UNIMPLEMENTED,
restriction,
2018-05-23 09:43:05 -05:00
"`unimplemented!` should not be present in production code"
}
2019-10-12 06:26:14 -05:00
declare_clippy_lint! {
/// **What it does:** Checks for usage of `todo!`.
///
/// **Why is this bad?** This macro should not be present in production code
///
/// **Known problems:** None.
///
/// **Example:**
/// ```no_run
/// todo!();
/// ```
pub TODO,
restriction,
"`todo!` should not be present in production code"
}
declare_clippy_lint! {
/// **What it does:** Checks for usage of `unreachable!`.
///
/// **Why is this bad?** This macro can cause code to panic
///
/// **Known problems:** None.
///
/// **Example:**
/// ```no_run
/// unreachable!();
/// ```
pub UNREACHABLE,
restriction,
"usage of the `unreachable!` macro"
}
declare_lint_pass!(PanicUnimplemented => [UNIMPLEMENTED, UNREACHABLE, TODO, PANIC]);
2015-12-23 15:37:52 -06:00
impl<'tcx> LateLintPass<'tcx> for PanicUnimplemented {
fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
if match_panic_call(cx, expr).is_some() && is_expn_of(expr.span, "debug_assert").is_none() {
let span = get_outer_span(expr);
if is_expn_of(expr.span, "unimplemented").is_some() {
span_lint(
cx,
UNIMPLEMENTED,
span,
"`unimplemented` should not be present in production code",
);
} else if is_expn_of(expr.span, "todo").is_some() {
span_lint(cx, TODO, span, "`todo` should not be present in production code");
} else if is_expn_of(expr.span, "unreachable").is_some() {
span_lint(cx, UNREACHABLE, span, "usage of the `unreachable!` macro");
} else if is_expn_of(expr.span, "panic").is_some() {
span_lint(cx, PANIC, span, "`panic` should not be present in production code");
}
}
2015-12-23 15:37:52 -06:00
}
}
2018-05-23 09:43:05 -05:00
2019-12-27 01:12:26 -06:00
fn get_outer_span(expr: &Expr<'_>) -> Span {
if_chain! {
if expr.span.from_expansion();
let first = expr.span.ctxt().outer_expn_data().call_site;
if first.from_expansion();
then {
first.ctxt().outer_expn_data().call_site
} else {
expr.span
}
}
}