109 lines
3.2 KiB
Rust
109 lines
3.2 KiB
Rust
use clippy_utils::diagnostics::span_lint;
|
|
use clippy_utils::{is_expn_of, match_panic_call};
|
|
use if_chain::if_chain;
|
|
use rustc_hir::Expr;
|
|
use rustc_lint::{LateContext, LateLintPass};
|
|
use rustc_session::{declare_lint_pass, declare_tool_lint};
|
|
use rustc_span::Span;
|
|
|
|
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,
|
|
"usage of the `panic!` macro"
|
|
}
|
|
|
|
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:**
|
|
/// ```no_run
|
|
/// unimplemented!();
|
|
/// ```
|
|
pub UNIMPLEMENTED,
|
|
restriction,
|
|
"`unimplemented!` should not be present in production code"
|
|
}
|
|
|
|
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]);
|
|
|
|
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");
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
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
|
|
}
|
|
}
|
|
}
|