add new lint zero_repeat_side_effects
This commit is contained in:
parent
c173ea64b7
commit
0e59259add
7 changed files with 355 additions and 0 deletions
|
|
@ -751,5 +751,6 @@ pub(crate) static LINTS: &[&crate::LintInfo] = &[
|
|||
crate::write::WRITE_LITERAL_INFO,
|
||||
crate::write::WRITE_WITH_NEWLINE_INFO,
|
||||
crate::zero_div_zero::ZERO_DIVIDED_BY_ZERO_INFO,
|
||||
crate::zero_repeat_side_effects::ZERO_REPEAT_SIDE_EFFECTS_INFO,
|
||||
crate::zero_sized_map_values::ZERO_SIZED_MAP_VALUES_INFO,
|
||||
];
|
||||
|
|
|
|||
|
|
@ -373,6 +373,7 @@ mod visibility;
|
|||
mod wildcard_imports;
|
||||
mod write;
|
||||
mod zero_div_zero;
|
||||
mod zero_repeat_side_effects;
|
||||
mod zero_sized_map_values;
|
||||
// end lints modules, do not remove this comment, it’s used in `update_lints`
|
||||
|
||||
|
|
@ -1120,6 +1121,7 @@ pub fn register_lints(store: &mut rustc_lint::LintStore, conf: &'static Conf) {
|
|||
store.register_late_pass(|_| Box::new(to_string_trait_impl::ToStringTraitImpl));
|
||||
store.register_early_pass(|| Box::new(multiple_bound_locations::MultipleBoundLocations));
|
||||
store.register_late_pass(|_| Box::new(assigning_clones::AssigningClones));
|
||||
store.register_late_pass(|_| Box::new(zero_repeat_side_effects::ZeroRepeatSideEffects));
|
||||
// add lints here, do not remove this comment, it's used in `new_lint`
|
||||
}
|
||||
|
||||
|
|
|
|||
154
clippy_lints/src/zero_repeat_side_effects.rs
Normal file
154
clippy_lints/src/zero_repeat_side_effects.rs
Normal file
|
|
@ -0,0 +1,154 @@
|
|||
use clippy_utils::diagnostics::span_lint_and_sugg;
|
||||
use clippy_utils::higher::VecArgs;
|
||||
use clippy_utils::source::snippet;
|
||||
use clippy_utils::visitors::for_each_expr;
|
||||
use rustc_ast::LitKind;
|
||||
use rustc_errors::Applicability;
|
||||
use rustc_hir::{ExprKind, Node};
|
||||
use rustc_lint::{LateContext, LateLintPass};
|
||||
use rustc_middle::ty::{self, ConstKind, Ty};
|
||||
use rustc_session::declare_lint_pass;
|
||||
use rustc_span::Span;
|
||||
|
||||
declare_clippy_lint! {
|
||||
/// ### What it does
|
||||
/// Checks for array or vec initializations which call a function or method,
|
||||
/// but which have a repeat count of zero.
|
||||
///
|
||||
/// ### Why is this bad?
|
||||
/// Such an initialization, despite having a repeat length of 0, will still call the inner function.
|
||||
/// This may not be obvious and as such there may be unintended side effects in code.
|
||||
///
|
||||
/// ### Example
|
||||
/// ```no_run
|
||||
/// fn side_effect(): i32 {
|
||||
/// println!("side effect");
|
||||
/// 10
|
||||
/// }
|
||||
/// let a = [side_effect(); 0];
|
||||
/// ```
|
||||
/// Use instead:
|
||||
/// ```no_run
|
||||
/// fn side_effect(): i32 {
|
||||
/// println!("side effect");
|
||||
/// 10
|
||||
/// }
|
||||
/// side_effect();
|
||||
/// let a: [i32; 0] = [];
|
||||
/// ```
|
||||
#[clippy::version = "1.75.0"]
|
||||
pub ZERO_REPEAT_SIDE_EFFECTS,
|
||||
suspicious,
|
||||
"usage of zero-sized initializations of arrays or vecs causing side effects"
|
||||
}
|
||||
|
||||
declare_lint_pass!(ZeroRepeatSideEffects => [ZERO_REPEAT_SIDE_EFFECTS]);
|
||||
|
||||
impl LateLintPass<'_> for ZeroRepeatSideEffects {
|
||||
fn check_expr(&mut self, cx: &LateContext<'_>, expr: &'_ rustc_hir::Expr<'_>) {
|
||||
if let Some(args) = VecArgs::hir(cx, expr)
|
||||
&& let VecArgs::Repeat(inner_expr, len) = args
|
||||
&& let ExprKind::Lit(l) = len.kind
|
||||
&& let LitKind::Int(i, _) = l.node
|
||||
&& i.0 == 0
|
||||
{
|
||||
inner_check(cx, expr, inner_expr, true);
|
||||
} else if let ExprKind::Repeat(inner_expr, _) = expr.kind
|
||||
&& let ty::Array(_, cst) = cx.typeck_results().expr_ty(expr).kind()
|
||||
&& let ConstKind::Value(ty::ValTree::Leaf(element_count)) = cst.kind()
|
||||
&& let Ok(element_count) = element_count.try_to_target_usize(cx.tcx)
|
||||
&& element_count == 0
|
||||
{
|
||||
inner_check(cx, expr, inner_expr, false);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn inner_check(cx: &LateContext<'_>, expr: &'_ rustc_hir::Expr<'_>, inner_expr: &'_ rustc_hir::Expr<'_>, is_vec: bool) {
|
||||
// check if expr is a call or has a call inside it
|
||||
if for_each_expr(inner_expr, |x| {
|
||||
if let ExprKind::Call(_, _) | ExprKind::MethodCall(_, _, _, _) = x.kind {
|
||||
std::ops::ControlFlow::Break(())
|
||||
} else {
|
||||
std::ops::ControlFlow::Continue(())
|
||||
}
|
||||
})
|
||||
.is_some()
|
||||
{
|
||||
let parent_hir_node = cx.tcx.parent_hir_node(expr.hir_id);
|
||||
let return_type = cx.typeck_results().expr_ty(expr);
|
||||
|
||||
if let Node::Local(l) = parent_hir_node {
|
||||
array_span_lint(
|
||||
cx,
|
||||
l.span,
|
||||
inner_expr.span,
|
||||
l.pat.span,
|
||||
Some(return_type),
|
||||
is_vec,
|
||||
false,
|
||||
);
|
||||
} else if let Node::Expr(x) = parent_hir_node
|
||||
&& let ExprKind::Assign(l, _, _) = x.kind
|
||||
{
|
||||
array_span_lint(cx, x.span, inner_expr.span, l.span, Some(return_type), is_vec, true);
|
||||
} else {
|
||||
span_lint_and_sugg(
|
||||
cx,
|
||||
ZERO_REPEAT_SIDE_EFFECTS,
|
||||
expr.span.source_callsite(),
|
||||
"function or method calls as the initial value in zero-sized array initializers may cause side effects",
|
||||
"consider using",
|
||||
format!(
|
||||
"{{ {}; {}[] as {return_type} }}",
|
||||
snippet(cx, inner_expr.span.source_callsite(), ".."),
|
||||
if is_vec { "vec!" } else { "" },
|
||||
),
|
||||
Applicability::Unspecified,
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn array_span_lint(
|
||||
cx: &LateContext<'_>,
|
||||
expr_span: Span,
|
||||
func_call_span: Span,
|
||||
variable_name_span: Span,
|
||||
expr_ty: Option<Ty<'_>>,
|
||||
is_vec: bool,
|
||||
is_assign: bool,
|
||||
) {
|
||||
let has_ty = expr_ty.is_some();
|
||||
|
||||
span_lint_and_sugg(
|
||||
cx,
|
||||
ZERO_REPEAT_SIDE_EFFECTS,
|
||||
expr_span.source_callsite(),
|
||||
"function or method calls as the initial value in zero-sized array initializers may cause side effects",
|
||||
"consider using",
|
||||
format!(
|
||||
"{}; {}{}{} = {}[]{}{}",
|
||||
snippet(cx, func_call_span.source_callsite(), ".."),
|
||||
if has_ty && !is_assign { "let " } else { "" },
|
||||
snippet(cx, variable_name_span.source_callsite(), ".."),
|
||||
if let Some(ty) = expr_ty
|
||||
&& !is_assign
|
||||
{
|
||||
format!(": {ty}")
|
||||
} else {
|
||||
String::new()
|
||||
},
|
||||
if is_vec { "vec!" } else { "" },
|
||||
if let Some(ty) = expr_ty
|
||||
&& is_assign
|
||||
{
|
||||
format!(" as {ty}")
|
||||
} else {
|
||||
String::new()
|
||||
},
|
||||
if is_assign { "" } else { ";" }
|
||||
),
|
||||
Applicability::Unspecified,
|
||||
);
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue