2021-03-25 13:29:11 -05:00
|
|
|
use clippy_utils::diagnostics::span_lint;
|
2022-01-13 06:18:19 -06:00
|
|
|
use clippy_utils::macros::{is_panic, root_macro_call_first_node};
|
2020-11-19 11:13:32 -06:00
|
|
|
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};
|
2015-12-23 15:37:52 -06:00
|
|
|
|
2019-10-11 06:58:56 -05:00
|
|
|
declare_clippy_lint! {
|
2021-07-29 05:16:06 -05:00
|
|
|
/// ### What it does
|
|
|
|
/// Checks for usage of `panic!`.
|
2019-10-11 06:58:56 -05:00
|
|
|
///
|
2021-07-29 05:16:06 -05:00
|
|
|
/// ### Why is this bad?
|
2023-10-27 12:22:41 -05:00
|
|
|
/// `panic!` will stop the execution of the executable.
|
2019-10-11 06:58:56 -05:00
|
|
|
///
|
2021-07-29 05:16:06 -05:00
|
|
|
/// ### Example
|
2019-10-11 06:58:56 -05:00
|
|
|
/// ```no_run
|
|
|
|
/// panic!("even with a good reason");
|
|
|
|
/// ```
|
2021-12-06 05:33:31 -06:00
|
|
|
#[clippy::version = "1.40.0"]
|
2019-10-11 06:58:56 -05:00
|
|
|
pub PANIC,
|
|
|
|
restriction,
|
2019-10-16 12:43:26 -05:00
|
|
|
"usage of the `panic!` macro"
|
2019-10-11 06:58:56 -05:00
|
|
|
}
|
|
|
|
|
2018-05-23 09:43:05 -05:00
|
|
|
declare_clippy_lint! {
|
2021-07-29 05:16:06 -05:00
|
|
|
/// ### What it does
|
|
|
|
/// Checks for usage of `unimplemented!`.
|
2019-03-05 10:50:33 -06:00
|
|
|
///
|
2021-07-29 05:16:06 -05:00
|
|
|
/// ### Why is this bad?
|
2023-10-27 12:22:41 -05:00
|
|
|
/// This macro should not be present in production code.
|
2019-03-05 10:50:33 -06:00
|
|
|
///
|
2021-07-29 05:16:06 -05:00
|
|
|
/// ### Example
|
2019-03-05 16:23:50 -06:00
|
|
|
/// ```no_run
|
2019-03-05 10:50:33 -06:00
|
|
|
/// unimplemented!();
|
|
|
|
/// ```
|
2021-12-06 05:33:31 -06:00
|
|
|
#[clippy::version = "pre 1.29.0"]
|
2018-05-23 09:43:05 -05:00
|
|
|
pub UNIMPLEMENTED,
|
2018-05-24 12:26:04 -05:00
|
|
|
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! {
|
2021-07-29 05:16:06 -05:00
|
|
|
/// ### What it does
|
|
|
|
/// Checks for usage of `todo!`.
|
2019-10-12 06:26:14 -05:00
|
|
|
///
|
2021-07-29 05:16:06 -05:00
|
|
|
/// ### Why is this bad?
|
2023-10-27 12:22:41 -05:00
|
|
|
/// The `todo!` macro is often used for unfinished code, and it causes
|
|
|
|
/// code to panic. It should not be present in production code.
|
2019-10-12 06:26:14 -05:00
|
|
|
///
|
2021-07-29 05:16:06 -05:00
|
|
|
/// ### Example
|
2019-10-12 06:26:14 -05:00
|
|
|
/// ```no_run
|
|
|
|
/// todo!();
|
|
|
|
/// ```
|
2023-10-27 12:22:41 -05:00
|
|
|
/// Finish the implementation, or consider marking it as explicitly unimplemented.
|
|
|
|
/// ```no_run
|
|
|
|
/// unimplemented!();
|
|
|
|
/// ```
|
2021-12-06 05:33:31 -06:00
|
|
|
#[clippy::version = "1.40.0"]
|
2019-10-12 06:26:14 -05:00
|
|
|
pub TODO,
|
|
|
|
restriction,
|
|
|
|
"`todo!` should not be present in production code"
|
|
|
|
}
|
|
|
|
|
2019-10-11 06:58:56 -05:00
|
|
|
declare_clippy_lint! {
|
2021-07-29 05:16:06 -05:00
|
|
|
/// ### What it does
|
|
|
|
/// Checks for usage of `unreachable!`.
|
2019-10-11 06:58:56 -05:00
|
|
|
///
|
2021-07-29 05:16:06 -05:00
|
|
|
/// ### Why is this bad?
|
2023-10-27 12:22:41 -05:00
|
|
|
/// This macro can cause code to panic.
|
2019-10-11 06:58:56 -05:00
|
|
|
///
|
2021-07-29 05:16:06 -05:00
|
|
|
/// ### Example
|
2019-10-11 06:58:56 -05:00
|
|
|
/// ```no_run
|
|
|
|
/// unreachable!();
|
|
|
|
/// ```
|
2021-12-06 05:33:31 -06:00
|
|
|
#[clippy::version = "1.40.0"]
|
2019-10-11 06:58:56 -05:00
|
|
|
pub UNREACHABLE,
|
|
|
|
restriction,
|
2020-12-06 08:01:03 -06:00
|
|
|
"usage of the `unreachable!` macro"
|
2019-10-11 06:58:56 -05:00
|
|
|
}
|
|
|
|
|
2020-11-19 11:13:32 -06:00
|
|
|
declare_lint_pass!(PanicUnimplemented => [UNIMPLEMENTED, UNREACHABLE, TODO, PANIC]);
|
2015-12-23 15:37:52 -06:00
|
|
|
|
2020-06-25 15:41:36 -05:00
|
|
|
impl<'tcx> LateLintPass<'tcx> for PanicUnimplemented {
|
|
|
|
fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
|
2023-07-14 06:27:56 -05:00
|
|
|
let Some(macro_call) = root_macro_call_first_node(cx, expr) else {
|
|
|
|
return;
|
|
|
|
};
|
2022-01-13 06:18:19 -06:00
|
|
|
if is_panic(cx, macro_call.def_id) {
|
2022-04-07 12:39:59 -05:00
|
|
|
if cx.tcx.hir().is_inside_const_context(expr.hir_id) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2022-01-13 06:18:19 -06:00
|
|
|
span_lint(
|
|
|
|
cx,
|
|
|
|
PANIC,
|
|
|
|
macro_call.span,
|
|
|
|
"`panic` should not be present in production code",
|
|
|
|
);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
match cx.tcx.item_name(macro_call.def_id).as_str() {
|
|
|
|
"todo" => {
|
|
|
|
span_lint(
|
|
|
|
cx,
|
|
|
|
TODO,
|
|
|
|
macro_call.span,
|
|
|
|
"`todo` should not be present in production code",
|
|
|
|
);
|
|
|
|
},
|
|
|
|
"unimplemented" => {
|
2020-11-17 14:16:15 -06:00
|
|
|
span_lint(
|
|
|
|
cx,
|
|
|
|
UNIMPLEMENTED,
|
2022-01-13 06:18:19 -06:00
|
|
|
macro_call.span,
|
2020-11-17 14:16:15 -06:00
|
|
|
"`unimplemented` should not be present in production code",
|
|
|
|
);
|
2022-01-13 06:18:19 -06:00
|
|
|
},
|
|
|
|
"unreachable" => {
|
|
|
|
span_lint(cx, UNREACHABLE, macro_call.span, "usage of the `unreachable!` macro");
|
|
|
|
},
|
|
|
|
_ => {},
|
2018-05-24 12:26:04 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|