src/tools/clippy/clippy_utils/src/usage.rs

   1 use crate as utils;
   2 use crate::visitors::{for_each_expr, for_each_expr_with_closures, Descend};
   3 use core::ops::ControlFlow;
   4 use rustc_hir as hir;
   5 use rustc_hir::intravisit::{self, Visitor};
   6 use rustc_hir::HirIdSet;
   7 use rustc_hir::{Expr, ExprKind, HirId, Node};
   8 use rustc_hir_typeck::expr_use_visitor::{Delegate, ExprUseVisitor, PlaceBase, PlaceWithHirId};
   9 use rustc_infer::infer::TyCtxtInferExt;
  10 use rustc_lint::LateContext;
  11 use rustc_middle::hir::nested_filter;
  12 use rustc_middle::mir::FakeReadCause;
  13 use rustc_middle::ty;
  14
  15 /// Returns a set of mutated local variable IDs, or `None` if mutations could not be determined.
  16 pub fn mutated_variables<'tcx>(expr: &'tcx Expr<'_>, cx: &LateContext<'tcx>) -> Option<HirIdSet> {
  17     let mut delegate = MutVarsDelegate {
  18         used_mutably: HirIdSet::default(),
  19         skip: false,
  20     };
  21     let infcx = cx.tcx.infer_ctxt().build();
  22     ExprUseVisitor::new(
  23         &mut delegate,
  24         &infcx,
  25         expr.hir_id.owner.def_id,
  26         cx.param_env,
  27         cx.typeck_results(),
  28     )
  29     .walk_expr(expr);
  30
  31     if delegate.skip {
  32         return None;
  33     }
  34     Some(delegate.used_mutably)
  35 }
  36
  37 pub fn is_potentially_mutated<'tcx>(variable: HirId, expr: &'tcx Expr<'_>, cx: &LateContext<'tcx>) -> bool {
  38     mutated_variables(expr, cx).map_or(true, |mutated| mutated.contains(&variable))
  39 }
  40
  41 struct MutVarsDelegate {
  42     used_mutably: HirIdSet,
  43     skip: bool,
  44 }
  45
  46 impl<'tcx> MutVarsDelegate {
  47     fn update(&mut self, cat: &PlaceWithHirId<'tcx>) {
  48         match cat.place.base {
  49             PlaceBase::Local(id) => {
  50                 self.used_mutably.insert(id);
  51             },
  52             PlaceBase::Upvar(_) => {
  53                 //FIXME: This causes false negatives. We can't get the `NodeId` from
  54                 //`Categorization::Upvar(_)`. So we search for any `Upvar`s in the
  55                 //`while`-body, not just the ones in the condition.
  56                 self.skip = true;
  57             },
  58             _ => {},
  59         }
  60     }
  61 }
  62
  63 impl<'tcx> Delegate<'tcx> for MutVarsDelegate {
  64     fn consume(&mut self, _: &PlaceWithHirId<'tcx>, _: HirId) {}
  65
  66     fn borrow(&mut self, cmt: &PlaceWithHirId<'tcx>, _: HirId, bk: ty::BorrowKind) {
  67         if bk == ty::BorrowKind::MutBorrow {
  68             self.update(cmt);
  69         }
  70     }
  71
  72     fn mutate(&mut self, cmt: &PlaceWithHirId<'tcx>, _: HirId) {
  73         self.update(cmt);
  74     }
  75
  76     fn fake_read(&mut self, _: &rustc_hir_typeck::expr_use_visitor::PlaceWithHirId<'tcx>, _: FakeReadCause, _: HirId) {}
  77 }
  78
  79 pub struct ParamBindingIdCollector {
  80     pub binding_hir_ids: Vec<hir::HirId>,
  81 }
  82 impl<'tcx> ParamBindingIdCollector {
  83     fn collect_binding_hir_ids(body: &'tcx hir::Body<'tcx>) -> Vec<hir::HirId> {
  84         let mut hir_ids: Vec<hir::HirId> = Vec::new();
  85         for param in body.params.iter() {
  86             let mut finder = ParamBindingIdCollector {
  87                 binding_hir_ids: Vec::new(),
  88             };
  89             finder.visit_param(param);
  90             for hir_id in &finder.binding_hir_ids {
  91                 hir_ids.push(*hir_id);
  92             }
  93         }
  94         hir_ids
  95     }
  96 }
  97 impl<'tcx> intravisit::Visitor<'tcx> for ParamBindingIdCollector {
  98     fn visit_pat(&mut self, pat: &'tcx hir::Pat<'tcx>) {
  99         if let hir::PatKind::Binding(_, hir_id, ..) = pat.kind {
 100             self.binding_hir_ids.push(hir_id);
 101         }
 102         intravisit::walk_pat(self, pat);
 103     }
 104 }
 105
 106 pub struct BindingUsageFinder<'a, 'tcx> {
 107     cx: &'a LateContext<'tcx>,
 108     binding_ids: Vec<hir::HirId>,
 109     usage_found: bool,
 110 }
 111 impl<'a, 'tcx> BindingUsageFinder<'a, 'tcx> {
 112     pub fn are_params_used(cx: &'a LateContext<'tcx>, body: &'tcx hir::Body<'tcx>) -> bool {
 113         let mut finder = BindingUsageFinder {
 114             cx,
 115             binding_ids: ParamBindingIdCollector::collect_binding_hir_ids(body),
 116             usage_found: false,
 117         };
 118         finder.visit_body(body);
 119         finder.usage_found
 120     }
 121 }
 122 impl<'a, 'tcx> intravisit::Visitor<'tcx> for BindingUsageFinder<'a, 'tcx> {
 123     type NestedFilter = nested_filter::OnlyBodies;
 124
 125     fn visit_expr(&mut self, expr: &'tcx hir::Expr<'tcx>) {
 126         if !self.usage_found {
 127             intravisit::walk_expr(self, expr);
 128         }
 129     }
 130
 131     fn visit_path(&mut self, path: &'tcx hir::Path<'tcx>, _: hir::HirId) {
 132         if let hir::def::Res::Local(id) = path.res {
 133             if self.binding_ids.contains(&id) {
 134                 self.usage_found = true;
 135             }
 136         }
 137     }
 138
 139     fn nested_visit_map(&mut self) -> Self::Map {
 140         self.cx.tcx.hir()
 141     }
 142 }
 143
 144 pub fn contains_return_break_continue_macro(expression: &Expr<'_>) -> bool {
 145     for_each_expr(expression, |e| {
 146         match e.kind {
 147             ExprKind::Ret(..) | ExprKind::Break(..) | ExprKind::Continue(..) => ControlFlow::Break(()),
 148             // Something special could be done here to handle while or for loop
 149             // desugaring, as this will detect a break if there's a while loop
 150             // or a for loop inside the expression.
 151             _ if e.span.from_expansion() => ControlFlow::Break(()),
 152             _ => ControlFlow::Continue(()),
 153         }
 154     })
 155     .is_some()
 156 }
 157
 158 pub fn local_used_after_expr(cx: &LateContext<'_>, local_id: HirId, after: &Expr<'_>) -> bool {
 159     let Some(block) = utils::get_enclosing_block(cx, local_id) else { return false };
 160
 161     // for _ in 1..3 {
 162     //    local
 163     // }
 164     //
 165     // let closure = || local;
 166     // closure();
 167     // closure();
 168     let in_loop_or_closure = cx
 169         .tcx
 170         .hir()
 171         .parent_iter(after.hir_id)
 172         .take_while(|&(id, _)| id != block.hir_id)
 173         .any(|(_, node)| {
 174             matches!(
 175                 node,
 176                 Node::Expr(Expr {
 177                     kind: ExprKind::Loop(..) | ExprKind::Closure { .. },
 178                     ..
 179                 })
 180             )
 181         });
 182     if in_loop_or_closure {
 183         return true;
 184     }
 185
 186     let mut past_expr = false;
 187     for_each_expr_with_closures(cx, block, |e| {
 188         if e.hir_id == after.hir_id {
 189             past_expr = true;
 190             ControlFlow::Continue(Descend::No)
 191         } else if past_expr && utils::path_to_local_id(e, local_id) {
 192             ControlFlow::Break(())
 193         } else {
 194             ControlFlow::Continue(Descend::Yes)
 195         }
 196     })
 197     .is_some()
 198 }