clippy_lints/src/utils/higher.rs

   1 //! This module contains functions for retrieve the original AST from lowered
   2 //! `hir`.
   3
   4 #![deny(clippy::missing_docs_in_private_items)]
   5
   6 use crate::utils::{is_expn_of, match_def_path, match_qpath, paths, resolve_node};
   7 use if_chain::if_chain;
   8 use rustc::lint::LateContext;
   9 use rustc::{hir, ty};
  10 use syntax::ast;
  11
  12 /// Converts a hir binary operator to the corresponding `ast` type.
  13 pub fn binop(op: hir::BinOpKind) -> ast::BinOpKind {
  14     match op {
  15         hir::BinOpKind::Eq => ast::BinOpKind::Eq,
  16         hir::BinOpKind::Ge => ast::BinOpKind::Ge,
  17         hir::BinOpKind::Gt => ast::BinOpKind::Gt,
  18         hir::BinOpKind::Le => ast::BinOpKind::Le,
  19         hir::BinOpKind::Lt => ast::BinOpKind::Lt,
  20         hir::BinOpKind::Ne => ast::BinOpKind::Ne,
  21         hir::BinOpKind::Or => ast::BinOpKind::Or,
  22         hir::BinOpKind::Add => ast::BinOpKind::Add,
  23         hir::BinOpKind::And => ast::BinOpKind::And,
  24         hir::BinOpKind::BitAnd => ast::BinOpKind::BitAnd,
  25         hir::BinOpKind::BitOr => ast::BinOpKind::BitOr,
  26         hir::BinOpKind::BitXor => ast::BinOpKind::BitXor,
  27         hir::BinOpKind::Div => ast::BinOpKind::Div,
  28         hir::BinOpKind::Mul => ast::BinOpKind::Mul,
  29         hir::BinOpKind::Rem => ast::BinOpKind::Rem,
  30         hir::BinOpKind::Shl => ast::BinOpKind::Shl,
  31         hir::BinOpKind::Shr => ast::BinOpKind::Shr,
  32         hir::BinOpKind::Sub => ast::BinOpKind::Sub,
  33     }
  34 }
  35
  36 /// Represent a range akin to `ast::ExprKind::Range`.
  37 #[derive(Debug, Copy, Clone)]
  38 pub struct Range<'a> {
  39     /// The lower bound of the range, or `None` for ranges such as `..X`.
  40     pub start: Option<&'a hir::Expr>,
  41     /// The upper bound of the range, or `None` for ranges such as `X..`.
  42     pub end: Option<&'a hir::Expr>,
  43     /// Whether the interval is open or closed.
  44     pub limits: ast::RangeLimits,
  45 }
  46
  47 /// Higher a `hir` range to something similar to `ast::ExprKind::Range`.
  48 pub fn range<'a, 'b, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'b hir::Expr) -> Option<Range<'b>> {
  49     /// Finds the field named `name` in the field. Always return `Some` for
  50     /// convenience.
  51     fn get_field<'c>(name: &str, fields: &'c [hir::Field]) -> Option<&'c hir::Expr> {
  52         let expr = &fields.iter().find(|field| field.ident.name.as_str() == name)?.expr;
  53
  54         Some(expr)
  55     }
  56
  57     let def_path = match cx.tables.expr_ty(expr).kind {
  58         ty::Adt(def, _) => cx.tcx.def_path(def.did),
  59         _ => return None,
  60     };
  61
  62     // sanity checks for std::ops::RangeXXXX
  63     if def_path.data.len() != 3 {
  64         return None;
  65     }
  66     if def_path.data.get(0)?.data.as_interned_str().as_symbol() != sym!(ops) {
  67         return None;
  68     }
  69     if def_path.data.get(1)?.data.as_interned_str().as_symbol() != sym!(range) {
  70         return None;
  71     }
  72     let type_name = def_path.data.get(2)?.data.as_interned_str();
  73     let range_types = [
  74         "RangeFrom",
  75         "RangeFull",
  76         "RangeInclusive",
  77         "Range",
  78         "RangeTo",
  79         "RangeToInclusive",
  80     ];
  81     if !range_types.contains(&&*type_name.as_str()) {
  82         return None;
  83     }
  84
  85     // The range syntax is expanded to literal paths starting with `core` or `std`
  86     // depending on
  87     // `#[no_std]`. Testing both instead of resolving the paths.
  88
  89     match expr.node {
  90         hir::ExprKind::Path(ref path) => {
  91             if match_qpath(path, &paths::RANGE_FULL_STD) || match_qpath(path, &paths::RANGE_FULL) {
  92                 Some(Range {
  93                     start: None,
  94                     end: None,
  95                     limits: ast::RangeLimits::HalfOpen,
  96                 })
  97             } else {
  98                 None
  99             }
 100         },
 101         hir::ExprKind::Call(ref path, ref args) => {
 102             if let hir::ExprKind::Path(ref path) = path.node {
 103                 if match_qpath(path, &paths::RANGE_INCLUSIVE_STD_NEW) || match_qpath(path, &paths::RANGE_INCLUSIVE_NEW)
 104                 {
 105                     Some(Range {
 106                         start: Some(&args[0]),
 107                         end: Some(&args[1]),
 108                         limits: ast::RangeLimits::Closed,
 109                     })
 110                 } else {
 111                     None
 112                 }
 113             } else {
 114                 None
 115             }
 116         },
 117         hir::ExprKind::Struct(ref path, ref fields, None) => {
 118             if match_qpath(path, &paths::RANGE_FROM_STD) || match_qpath(path, &paths::RANGE_FROM) {
 119                 Some(Range {
 120                     start: Some(get_field("start", fields)?),
 121                     end: None,
 122                     limits: ast::RangeLimits::HalfOpen,
 123                 })
 124             } else if match_qpath(path, &paths::RANGE_STD) || match_qpath(path, &paths::RANGE) {
 125                 Some(Range {
 126                     start: Some(get_field("start", fields)?),
 127                     end: Some(get_field("end", fields)?),
 128                     limits: ast::RangeLimits::HalfOpen,
 129                 })
 130             } else if match_qpath(path, &paths::RANGE_TO_INCLUSIVE_STD) || match_qpath(path, &paths::RANGE_TO_INCLUSIVE)
 131             {
 132                 Some(Range {
 133                     start: None,
 134                     end: Some(get_field("end", fields)?),
 135                     limits: ast::RangeLimits::Closed,
 136                 })
 137             } else if match_qpath(path, &paths::RANGE_TO_STD) || match_qpath(path, &paths::RANGE_TO) {
 138                 Some(Range {
 139                     start: None,
 140                     end: Some(get_field("end", fields)?),
 141                     limits: ast::RangeLimits::HalfOpen,
 142                 })
 143             } else {
 144                 None
 145             }
 146         },
 147         _ => None,
 148     }
 149 }
 150
 151 /// Checks if a `let` statement is from a `for` loop desugaring.
 152 pub fn is_from_for_desugar(local: &hir::Local) -> bool {
 153     // This will detect plain for-loops without an actual variable binding:
 154     //
 155     // ```
 156     // for x in some_vec {
 157     //     // do stuff
 158     // }
 159     // ```
 160     if_chain! {
 161         if let Some(ref expr) = local.init;
 162         if let hir::ExprKind::Match(_, _, hir::MatchSource::ForLoopDesugar) = expr.node;
 163         then {
 164             return true;
 165         }
 166     }
 167
 168     // This detects a variable binding in for loop to avoid `let_unit_value`
 169     // lint (see issue #1964).
 170     //
 171     // ```
 172     // for _ in vec![()] {
 173     //     // anything
 174     // }
 175     // ```
 176     if let hir::LocalSource::ForLoopDesugar = local.source {
 177         return true;
 178     }
 179
 180     false
 181 }
 182
 183 /// Recover the essential nodes of a desugared for loop:
 184 /// `for pat in arg { body }` becomes `(pat, arg, body)`.
 185 pub fn for_loop(expr: &hir::Expr) -> Option<(&hir::Pat, &hir::Expr, &hir::Expr)> {
 186     if_chain! {
 187         if let hir::ExprKind::Match(ref iterexpr, ref arms, hir::MatchSource::ForLoopDesugar) = expr.node;
 188         if let hir::ExprKind::Call(_, ref iterargs) = iterexpr.node;
 189         if iterargs.len() == 1 && arms.len() == 1 && arms[0].guard.is_none();
 190         if let hir::ExprKind::Loop(ref block, _, _) = arms[0].body.node;
 191         if block.expr.is_none();
 192         if let [ _, _, ref let_stmt, ref body ] = *block.stmts;
 193         if let hir::StmtKind::Local(ref local) = let_stmt.node;
 194         if let hir::StmtKind::Expr(ref expr) = body.node;
 195         then {
 196             return Some((&*local.pat, &iterargs[0], expr));
 197         }
 198     }
 199     None
 200 }
 201
 202 /// Recover the essential nodes of a desugared while loop:
 203 /// `while cond { body }` becomes `(cond, body)`.
 204 pub fn while_loop(expr: &hir::Expr) -> Option<(&hir::Expr, &hir::Expr)> {
 205     if_chain! {
 206         if let hir::ExprKind::Loop(block, _, hir::LoopSource::While) = &expr.node;
 207         if let hir::Block { expr: Some(expr), .. } = &**block;
 208         if let hir::ExprKind::Match(cond, arms, hir::MatchSource::WhileDesugar) = &expr.node;
 209         if let hir::ExprKind::DropTemps(cond) = &cond.node;
 210         if let [arm, ..] = &arms[..];
 211         if let hir::Arm { body, .. } = arm;
 212         then {
 213             return Some((cond, body));
 214         }
 215     }
 216     None
 217 }
 218
 219 /// Recover the essential nodes of a desugared if block
 220 /// `if cond { then } else { els }` becomes `(cond, then, Some(els))`
 221 pub fn if_block(expr: &hir::Expr) -> Option<(&hir::Expr, &hir::Expr, Option<&hir::Expr>)> {
 222     if let hir::ExprKind::Match(ref cond, ref arms, hir::MatchSource::IfDesugar { contains_else_clause }) = expr.node {
 223         let cond = if let hir::ExprKind::DropTemps(ref cond) = cond.node {
 224             cond
 225         } else {
 226             panic!("If block desugar must contain DropTemps");
 227         };
 228         let then = &arms[0].body;
 229         let els = if contains_else_clause {
 230             Some(&*arms[1].body)
 231         } else {
 232             None
 233         };
 234         Some((cond, then, els))
 235     } else {
 236         None
 237     }
 238 }
 239
 240 /// Represent the pre-expansion arguments of a `vec!` invocation.
 241 pub enum VecArgs<'a> {
 242     /// `vec![elem; len]`
 243     Repeat(&'a hir::Expr, &'a hir::Expr),
 244     /// `vec![a, b, c]`
 245     Vec(&'a [hir::Expr]),
 246 }
 247
 248 /// Returns the arguments of the `vec!` macro if this expression was expanded
 249 /// from `vec!`.
 250 pub fn vec_macro<'e>(cx: &LateContext<'_, '_>, expr: &'e hir::Expr) -> Option<VecArgs<'e>> {
 251     if_chain! {
 252         if let hir::ExprKind::Call(ref fun, ref args) = expr.node;
 253         if let hir::ExprKind::Path(ref path) = fun.node;
 254         if is_expn_of(fun.span, "vec").is_some();
 255         if let Some(fun_def_id) = resolve_node(cx, path, fun.hir_id).opt_def_id();
 256         then {
 257             return if match_def_path(cx, fun_def_id, &paths::VEC_FROM_ELEM) && args.len() == 2 {
 258                 // `vec![elem; size]` case
 259                 Some(VecArgs::Repeat(&args[0], &args[1]))
 260             }
 261             else if match_def_path(cx, fun_def_id, &paths::SLICE_INTO_VEC) && args.len() == 1 {
 262                 // `vec![a, b, c]` case
 263                 if_chain! {
 264                     if let hir::ExprKind::Box(ref boxed) = args[0].node;
 265                     if let hir::ExprKind::Array(ref args) = boxed.node;
 266                     then {
 267                         return Some(VecArgs::Vec(&*args));
 268                     }
 269                 }
 270
 271                 None
 272             }
 273             else {
 274                 None
 275             };
 276         }
 277     }
 278
 279     None
 280 }