clippy_lints/src/lifetimes.rs

   1 use reexport::*;
   2 use rustc::lint::*;
   3 use rustc::hir::def::Def;
   4 use rustc::hir::*;
   5 use rustc::hir::intravisit::{Visitor, walk_ty, walk_ty_param_bound, walk_fn_decl, walk_generics, NestedVisitorMap};
   6 use std::collections::{HashSet, HashMap};
   7 use syntax::codemap::Span;
   8 use utils::{in_external_macro, span_lint, last_path_segment};
   9 use syntax::symbol::keywords;
  10
  11 /// **What it does:** Checks for lifetime annotations which can be removed by
  12 /// relying on lifetime elision.
  13 ///
  14 /// **Why is this bad?** The additional lifetimes make the code look more
  15 /// complicated, while there is nothing out of the ordinary going on. Removing
  16 /// them leads to more readable code.
  17 ///
  18 /// **Known problems:** Potential false negatives: we bail out if the function
  19 /// has a `where` clause where lifetimes are mentioned.
  20 ///
  21 /// **Example:**
  22 /// ```rust
  23 /// fn in_and_out<'a>(x: &'a u8, y: u8) -> &'a u8 { x }
  24 /// ```
  25 declare_lint! {
  26     pub NEEDLESS_LIFETIMES,
  27     Warn,
  28     "using explicit lifetimes for references in function arguments when elision rules \
  29      would allow omitting them"
  30 }
  31
  32 /// **What it does:** Checks for lifetimes in generics that are never used
  33 /// anywhere else.
  34 ///
  35 /// **Why is this bad?** The additional lifetimes make the code look more
  36 /// complicated, while there is nothing out of the ordinary going on. Removing
  37 /// them leads to more readable code.
  38 ///
  39 /// **Known problems:** None.
  40 ///
  41 /// **Example:**
  42 /// ```rust
  43 /// fn unused_lifetime<'a>(x: u8) { .. }
  44 /// ```
  45 declare_lint! {
  46     pub UNUSED_LIFETIMES,
  47     Warn,
  48     "unused lifetimes in function definitions"
  49 }
  50
  51 #[derive(Copy, Clone)]
  52 pub struct LifetimePass;
  53
  54 impl LintPass for LifetimePass {
  55     fn get_lints(&self) -> LintArray {
  56         lint_array!(NEEDLESS_LIFETIMES, UNUSED_LIFETIMES)
  57     }
  58 }
  59
  60 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for LifetimePass {
  61     fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx Item) {
  62         if let ItemFn(ref decl, _, _, _, ref generics, id) = item.node {
  63             check_fn_inner(cx, decl, Some(id), generics, item.span);
  64         }
  65     }
  66
  67     fn check_impl_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx ImplItem) {
  68         if let ImplItemKind::Method(ref sig, id) = item.node {
  69             check_fn_inner(cx, &sig.decl, Some(id), &sig.generics, item.span);
  70         }
  71     }
  72
  73     fn check_trait_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx TraitItem) {
  74         if let TraitItemKind::Method(ref sig, ref body) = item.node {
  75             let body = match *body {
  76                 TraitMethod::Required(_) => None,
  77                 TraitMethod::Provided(id) => Some(id),
  78             };
  79             check_fn_inner(cx, &sig.decl, body, &sig.generics, item.span);
  80         }
  81     }
  82 }
  83
  84 /// The lifetime of a &-reference.
  85 #[derive(PartialEq, Eq, Hash, Debug)]
  86 enum RefLt {
  87     Unnamed,
  88     Static,
  89     Named(Name),
  90 }
  91
  92 fn check_fn_inner<'a, 'tcx>(
  93     cx: &LateContext<'a, 'tcx>,
  94     decl: &'tcx FnDecl,
  95     body: Option<BodyId>,
  96     generics: &'tcx Generics,
  97     span: Span,
  98 ) {
  99     if in_external_macro(cx, span) || has_where_lifetimes(cx, &generics.where_clause) {
 100         return;
 101     }
 102
 103     let mut bounds_lts = Vec::new();
 104     for typ in &generics.ty_params {
 105         for bound in &typ.bounds {
 106             if let TraitTyParamBound(ref trait_ref, _) = *bound {
 107                 let bounds = trait_ref
 108                     .trait_ref
 109                     .path
 110                     .segments
 111                     .last()
 112                     .expect("a path must have at least one segment")
 113                     .parameters
 114                     .lifetimes();
 115                 for bound in bounds {
 116                     if bound.name != "'static" && !bound.is_elided() {
 117                         return;
 118                     }
 119                     bounds_lts.push(bound);
 120                 }
 121             }
 122         }
 123     }
 124     if could_use_elision(cx, decl, body, &generics.lifetimes, bounds_lts) {
 125         span_lint(
 126             cx,
 127             NEEDLESS_LIFETIMES,
 128             span,
 129             "explicit lifetimes given in parameter types where they could be elided",
 130         );
 131     }
 132     report_extra_lifetimes(cx, decl, generics);
 133 }
 134
 135 fn could_use_elision<'a, 'tcx: 'a>(
 136     cx: &LateContext<'a, 'tcx>,
 137     func: &'tcx FnDecl,
 138     body: Option<BodyId>,
 139     named_lts: &'tcx [LifetimeDef],
 140     bounds_lts: Vec<&'tcx Lifetime>,
 141 ) -> bool {
 142     // There are two scenarios where elision works:
 143     // * no output references, all input references have different LT
 144     // * output references, exactly one input reference with same LT
 145     // All lifetimes must be unnamed, 'static or defined without bounds on the
 146     // level of the current item.
 147
 148     // check named LTs
 149     let allowed_lts = allowed_lts_from(named_lts);
 150
 151     // these will collect all the lifetimes for references in arg/return types
 152     let mut input_visitor = RefVisitor::new(cx);
 153     let mut output_visitor = RefVisitor::new(cx);
 154
 155     // extract lifetimes in input argument types
 156     for arg in &func.inputs {
 157         input_visitor.visit_ty(arg);
 158     }
 159     // extract lifetimes in output type
 160     if let Return(ref ty) = func.output {
 161         output_visitor.visit_ty(ty);
 162     }
 163
 164     let input_lts = match input_visitor.into_vec() {
 165         Some(lts) => lts_from_bounds(lts, bounds_lts.into_iter()),
 166         None => return false,
 167     };
 168     let output_lts = match output_visitor.into_vec() {
 169         Some(val) => val,
 170         None => return false,
 171     };
 172
 173     if let Some(body_id) = body {
 174         let mut checker = BodyLifetimeChecker { lifetimes_used_in_body: false };
 175         checker.visit_expr(&cx.tcx.hir.body(body_id).value);
 176         if checker.lifetimes_used_in_body {
 177             return false;
 178         }
 179     }
 180
 181     // check for lifetimes from higher scopes
 182     for lt in input_lts.iter().chain(output_lts.iter()) {
 183         if !allowed_lts.contains(lt) {
 184             return false;
 185         }
 186     }
 187
 188     // no input lifetimes? easy case!
 189     if input_lts.is_empty() {
 190         false
 191     } else if output_lts.is_empty() {
 192         // no output lifetimes, check distinctness of input lifetimes
 193
 194         // only unnamed and static, ok
 195         let unnamed_and_static = input_lts.iter().all(|lt| {
 196             *lt == RefLt::Unnamed || *lt == RefLt::Static
 197         });
 198         if unnamed_and_static {
 199             return false;
 200         }
 201         // we have no output reference, so we only need all distinct lifetimes
 202         input_lts.len() == unique_lifetimes(&input_lts)
 203     } else {
 204         // we have output references, so we need one input reference,
 205         // and all output lifetimes must be the same
 206         if unique_lifetimes(&output_lts) > 1 {
 207             return false;
 208         }
 209         if input_lts.len() == 1 {
 210             match (&input_lts[0], &output_lts[0]) {
 211                 (&RefLt::Named(n1), &RefLt::Named(n2)) if n1 == n2 => true,
 212                 (&RefLt::Named(_), &RefLt::Unnamed) => true,
 213                 _ => false, // already elided, different named lifetimes
 214                 // or something static going on
 215             }
 216         } else {
 217             false
 218         }
 219     }
 220 }
 221
 222 fn allowed_lts_from(named_lts: &[LifetimeDef]) -> HashSet<RefLt> {
 223     let mut allowed_lts = HashSet::new();
 224     for lt in named_lts {
 225         if lt.bounds.is_empty() {
 226             allowed_lts.insert(RefLt::Named(lt.lifetime.name));
 227         }
 228     }
 229     allowed_lts.insert(RefLt::Unnamed);
 230     allowed_lts.insert(RefLt::Static);
 231     allowed_lts
 232 }
 233
 234 fn lts_from_bounds<'a, T: Iterator<Item = &'a Lifetime>>(mut vec: Vec<RefLt>, bounds_lts: T) -> Vec<RefLt> {
 235     for lt in bounds_lts {
 236         if lt.name != "'static" {
 237             vec.push(RefLt::Named(lt.name));
 238         }
 239     }
 240
 241     vec
 242 }
 243
 244 /// Number of unique lifetimes in the given vector.
 245 fn unique_lifetimes(lts: &[RefLt]) -> usize {
 246     lts.iter().collect::<HashSet<_>>().len()
 247 }
 248
 249 /// A visitor usable for `rustc_front::visit::walk_ty()`.
 250 struct RefVisitor<'a, 'tcx: 'a> {
 251     cx: &'a LateContext<'a, 'tcx>,
 252     lts: Vec<RefLt>,
 253     abort: bool,
 254 }
 255
 256 impl<'v, 't> RefVisitor<'v, 't> {
 257     fn new(cx: &'v LateContext<'v, 't>) -> Self {
 258         Self {
 259             cx: cx,
 260             lts: Vec::new(),
 261             abort: false,
 262         }
 263     }
 264
 265     fn record(&mut self, lifetime: &Option<Lifetime>) {
 266         if let Some(ref lt) = *lifetime {
 267             if lt.name == "'static" {
 268                 self.lts.push(RefLt::Static);
 269             } else if lt.is_elided() {
 270                 self.lts.push(RefLt::Unnamed);
 271             } else {
 272                 self.lts.push(RefLt::Named(lt.name));
 273             }
 274         } else {
 275             self.lts.push(RefLt::Unnamed);
 276         }
 277     }
 278
 279     fn into_vec(self) -> Option<Vec<RefLt>> {
 280         if self.abort { None } else { Some(self.lts) }
 281     }
 282
 283     fn collect_anonymous_lifetimes(&mut self, qpath: &QPath, ty: &Ty) {
 284         let last_path_segment = &last_path_segment(qpath).parameters;
 285         if let AngleBracketedParameters(ref params) = *last_path_segment {
 286             if params.lifetimes.is_empty() {
 287                 let hir_id = self.cx.tcx.hir.node_to_hir_id(ty.id);
 288                 match self.cx.tables.qpath_def(qpath, hir_id) {
 289                     Def::TyAlias(def_id) |
 290                     Def::Struct(def_id) => {
 291                         let generics = self.cx.tcx.generics_of(def_id);
 292                         for _ in generics.regions.as_slice() {
 293                             self.record(&None);
 294                         }
 295                     },
 296                     Def::Trait(def_id) => {
 297                         let trait_def = self.cx.tcx.trait_def(def_id);
 298                         for _ in &self.cx.tcx.generics_of(trait_def.def_id).regions {
 299                             self.record(&None);
 300                         }
 301                     },
 302                     _ => (),
 303                 }
 304             }
 305         }
 306     }
 307 }
 308
 309 impl<'a, 'tcx> Visitor<'tcx> for RefVisitor<'a, 'tcx> {
 310     // for lifetimes as parameters of generics
 311     fn visit_lifetime(&mut self, lifetime: &'tcx Lifetime) {
 312         self.record(&Some(*lifetime));
 313     }
 314
 315     fn visit_ty(&mut self, ty: &'tcx Ty) {
 316         match ty.node {
 317             TyRptr(ref lt, _) if lt.is_elided() => {
 318                 self.record(&None);
 319             },
 320             TyPath(ref path) => {
 321                 self.collect_anonymous_lifetimes(path, ty);
 322             },
 323             TyImplTrait(ref param_bounds) => {
 324                 for bound in param_bounds {
 325                     if let RegionTyParamBound(_) = *bound {
 326                         self.record(&None);
 327                     }
 328                 }
 329             },
 330             TyTraitObject(ref bounds, ref lt) => {
 331                 if !lt.is_elided() {
 332                     self.abort = true;
 333                 }
 334                 for bound in bounds {
 335                     self.visit_poly_trait_ref(bound, TraitBoundModifier::None);
 336                 }
 337                 return;
 338             },
 339             _ => (),
 340         }
 341         walk_ty(self, ty);
 342     }
 343     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
 344         NestedVisitorMap::None
 345     }
 346 }
 347
 348 /// Are any lifetimes mentioned in the `where` clause? If yes, we don't try to
 349 /// reason about elision.
 350 fn has_where_lifetimes<'a, 'tcx: 'a>(cx: &LateContext<'a, 'tcx>, where_clause: &'tcx WhereClause) -> bool {
 351     for predicate in &where_clause.predicates {
 352         match *predicate {
 353             WherePredicate::RegionPredicate(..) => return true,
 354             WherePredicate::BoundPredicate(ref pred) => {
 355                 // a predicate like F: Trait or F: for<'a> Trait<'a>
 356                 let mut visitor = RefVisitor::new(cx);
 357                 // walk the type F, it may not contain LT refs
 358                 walk_ty(&mut visitor, &pred.bounded_ty);
 359                 if !visitor.lts.is_empty() {
 360                     return true;
 361                 }
 362                 // if the bounds define new lifetimes, they are fine to occur
 363                 let allowed_lts = allowed_lts_from(&pred.bound_lifetimes);
 364                 // now walk the bounds
 365                 for bound in pred.bounds.iter() {
 366                     walk_ty_param_bound(&mut visitor, bound);
 367                 }
 368                 // and check that all lifetimes are allowed
 369                 match visitor.into_vec() {
 370                     None => return false,
 371                     Some(lts) => {
 372                         for lt in lts {
 373                             if !allowed_lts.contains(&lt) {
 374                                 return true;
 375                             }
 376                         }
 377                     },
 378                 }
 379             },
 380             WherePredicate::EqPredicate(ref pred) => {
 381                 let mut visitor = RefVisitor::new(cx);
 382                 walk_ty(&mut visitor, &pred.lhs_ty);
 383                 walk_ty(&mut visitor, &pred.rhs_ty);
 384                 if !visitor.lts.is_empty() {
 385                     return true;
 386                 }
 387             },
 388         }
 389     }
 390     false
 391 }
 392
 393 struct LifetimeChecker {
 394     map: HashMap<Name, Span>,
 395 }
 396
 397 impl<'tcx> Visitor<'tcx> for LifetimeChecker {
 398     // for lifetimes as parameters of generics
 399     fn visit_lifetime(&mut self, lifetime: &'tcx Lifetime) {
 400         self.map.remove(&lifetime.name);
 401     }
 402
 403     fn visit_lifetime_def(&mut self, _: &'tcx LifetimeDef) {
 404         // don't actually visit `<'a>` or `<'a: 'b>`
 405         // we've already visited the `'a` declarations and
 406         // don't want to spuriously remove them
 407         // `'b` in `'a: 'b` is useless unless used elsewhere in
 408         // a non-lifetime bound
 409     }
 410     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
 411         NestedVisitorMap::None
 412     }
 413 }
 414
 415 fn report_extra_lifetimes<'a, 'tcx: 'a>(cx: &LateContext<'a, 'tcx>, func: &'tcx FnDecl, generics: &'tcx Generics) {
 416     let hs = generics
 417         .lifetimes
 418         .iter()
 419         .map(|lt| (lt.lifetime.name, lt.lifetime.span))
 420         .collect();
 421     let mut checker = LifetimeChecker { map: hs };
 422
 423     walk_generics(&mut checker, generics);
 424     walk_fn_decl(&mut checker, func);
 425
 426     for &v in checker.map.values() {
 427         span_lint(cx, UNUSED_LIFETIMES, v, "this lifetime isn't used in the function definition");
 428     }
 429 }
 430
 431 struct BodyLifetimeChecker {
 432     lifetimes_used_in_body: bool,
 433 }
 434
 435 impl<'tcx> Visitor<'tcx> for BodyLifetimeChecker {
 436     // for lifetimes as parameters of generics
 437     fn visit_lifetime(&mut self, lifetime: &'tcx Lifetime) {
 438         if lifetime.name != keywords::Invalid.name() && lifetime.name != "'static" {
 439             self.lifetimes_used_in_body = true;
 440         }
 441     }
 442
 443     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
 444         NestedVisitorMap::None
 445     }
 446 }