clippy_lints/src/utils/higher.rs

   1 //! This module contains functions for retrieve the original AST from lowered
   2 //! `hir`.
   3
   4 #![deny(missing_docs_in_private_items)]
   5
   6 use rustc::hir;
   7 use rustc::lint::LateContext;
   8 use syntax::ast;
   9 use utils::{is_expn_of, match_def_path, match_qpath, paths, resolve_node, opt_def_id};
  10
  11 /// Convert a hir binary operator to the corresponding `ast` type.
  12 pub fn binop(op: hir::BinOp_) -> ast::BinOpKind {
  13     match op {
  14         hir::BiEq => ast::BinOpKind::Eq,
  15         hir::BiGe => ast::BinOpKind::Ge,
  16         hir::BiGt => ast::BinOpKind::Gt,
  17         hir::BiLe => ast::BinOpKind::Le,
  18         hir::BiLt => ast::BinOpKind::Lt,
  19         hir::BiNe => ast::BinOpKind::Ne,
  20         hir::BiOr => ast::BinOpKind::Or,
  21         hir::BiAdd => ast::BinOpKind::Add,
  22         hir::BiAnd => ast::BinOpKind::And,
  23         hir::BiBitAnd => ast::BinOpKind::BitAnd,
  24         hir::BiBitOr => ast::BinOpKind::BitOr,
  25         hir::BiBitXor => ast::BinOpKind::BitXor,
  26         hir::BiDiv => ast::BinOpKind::Div,
  27         hir::BiMul => ast::BinOpKind::Mul,
  28         hir::BiRem => ast::BinOpKind::Rem,
  29         hir::BiShl => ast::BinOpKind::Shl,
  30         hir::BiShr => ast::BinOpKind::Shr,
  31         hir::BiSub => ast::BinOpKind::Sub,
  32     }
  33 }
  34
  35 /// Represent a range akin to `ast::ExprKind::Range`.
  36 #[derive(Debug, Copy, Clone)]
  37 pub struct Range<'a> {
  38     /// The lower bound of the range, or `None` for ranges such as `..X`.
  39     pub start: Option<&'a hir::Expr>,
  40     /// The upper bound of the range, or `None` for ranges such as `X..`.
  41     pub end: Option<&'a hir::Expr>,
  42     /// Whether the interval is open or closed.
  43     pub limits: ast::RangeLimits,
  44 }
  45
  46 /// Higher a `hir` range to something similar to `ast::ExprKind::Range`.
  47 pub fn range(expr: &hir::Expr) -> Option<Range> {
  48     /// Find the field named `name` in the field. Always return `Some` for
  49     /// convenience.
  50     fn get_field<'a>(name: &str, fields: &'a [hir::Field]) -> Option<&'a hir::Expr> {
  51         let expr = &fields
  52             .iter()
  53             .find(|field| field.name.node == name)?
  54             .expr;
  55
  56         Some(expr)
  57     }
  58
  59     // The range syntax is expanded to literal paths starting with `core` or `std`
  60     // depending on
  61     // `#[no_std]`. Testing both instead of resolving the paths.
  62
  63     match expr.node {
  64         hir::ExprPath(ref path) => {
  65             if match_qpath(path, &paths::RANGE_FULL_STD) || match_qpath(path, &paths::RANGE_FULL) {
  66                 Some(Range {
  67                     start: None,
  68                     end: None,
  69                     limits: ast::RangeLimits::HalfOpen,
  70                 })
  71             } else {
  72                 None
  73             }
  74         },
  75         hir::ExprStruct(ref path, ref fields, None) => if match_qpath(path, &paths::RANGE_FROM_STD) ||
  76             match_qpath(path, &paths::RANGE_FROM)
  77         {
  78             Some(Range {
  79                 start: Some(get_field("start", fields)?),
  80                 end: None,
  81                 limits: ast::RangeLimits::HalfOpen,
  82             })
  83         } else if match_qpath(path, &paths::RANGE_INCLUSIVE_STD) || match_qpath(path, &paths::RANGE_INCLUSIVE) {
  84             Some(Range {
  85                 start: Some(get_field("start", fields)?),
  86                 end: Some(get_field("end", fields)?),
  87                 limits: ast::RangeLimits::Closed,
  88             })
  89         } else if match_qpath(path, &paths::RANGE_STD) || match_qpath(path, &paths::RANGE) {
  90             Some(Range {
  91                 start: Some(get_field("start", fields)?),
  92                 end: Some(get_field("end", fields)?),
  93                 limits: ast::RangeLimits::HalfOpen,
  94             })
  95         } else if match_qpath(path, &paths::RANGE_TO_INCLUSIVE_STD) || match_qpath(path, &paths::RANGE_TO_INCLUSIVE) {
  96             Some(Range {
  97                 start: None,
  98                 end: Some(get_field("end", fields)?),
  99                 limits: ast::RangeLimits::Closed,
 100             })
 101         } else if match_qpath(path, &paths::RANGE_TO_STD) || match_qpath(path, &paths::RANGE_TO) {
 102             Some(Range {
 103                 start: None,
 104                 end: Some(get_field("end", fields)?),
 105                 limits: ast::RangeLimits::HalfOpen,
 106             })
 107         } else {
 108             None
 109         },
 110         _ => None,
 111     }
 112 }
 113
 114 /// Checks if a `let` decl is from a `for` loop desugaring.
 115 pub fn is_from_for_desugar(decl: &hir::Decl) -> bool {
 116     // This will detect plain for-loops without an actual variable binding:
 117     //
 118     // ```
 119     // for x in some_vec {
 120     //   // do stuff
 121     // }
 122     // ```
 123     if_chain! {
 124         if let hir::DeclLocal(ref loc) = decl.node;
 125         if let Some(ref expr) = loc.init;
 126         if let hir::ExprMatch(_, _, hir::MatchSource::ForLoopDesugar) = expr.node;
 127         then {
 128             return true;
 129         }
 130     }
 131
 132     // This detects a variable binding in for loop to avoid `let_unit_value`
 133     // lint (see issue #1964).
 134     //
 135     // ```
 136     // for _ in vec![()] {
 137     //   // anything
 138     // }
 139     // ```
 140     if_chain! {
 141         if let hir::DeclLocal(ref loc) = decl.node;
 142         if let hir::LocalSource::ForLoopDesugar = loc.source;
 143         then {
 144             return true;
 145         }
 146     }
 147
 148     false
 149 }
 150
 151 /// Recover the essential nodes of a desugared for loop:
 152 /// `for pat in arg { body }` becomes `(pat, arg, body)`.
 153 pub fn for_loop(expr: &hir::Expr) -> Option<(&hir::Pat, &hir::Expr, &hir::Expr)> {
 154     if_chain! {
 155         if let hir::ExprMatch(ref iterexpr, ref arms, hir::MatchSource::ForLoopDesugar) = expr.node;
 156         if let hir::ExprCall(_, ref iterargs) = iterexpr.node;
 157         if iterargs.len() == 1 && arms.len() == 1 && arms[0].guard.is_none();
 158         if let hir::ExprLoop(ref block, _, _) = arms[0].body.node;
 159         if block.expr.is_none();
 160         if let [ _, _, ref let_stmt, ref body ] = *block.stmts;
 161         if let hir::StmtDecl(ref decl, _) = let_stmt.node;
 162         if let hir::DeclLocal(ref decl) = decl.node;
 163         if let hir::StmtExpr(ref expr, _) = body.node;
 164         then {
 165             return Some((&*decl.pat, &iterargs[0], expr));
 166         }
 167     }
 168     None
 169 }
 170
 171 /// Represent the pre-expansion arguments of a `vec!` invocation.
 172 pub enum VecArgs<'a> {
 173     /// `vec![elem; len]`
 174     Repeat(&'a hir::Expr, &'a hir::Expr),
 175     /// `vec![a, b, c]`
 176     Vec(&'a [hir::Expr]),
 177 }
 178
 179 /// Returns the arguments of the `vec!` macro if this expression was expanded
 180 /// from `vec!`.
 181 pub fn vec_macro<'e>(cx: &LateContext, expr: &'e hir::Expr) -> Option<VecArgs<'e>> {
 182     if_chain! {
 183         if let hir::ExprCall(ref fun, ref args) = expr.node;
 184         if let hir::ExprPath(ref path) = fun.node;
 185         if is_expn_of(fun.span, "vec").is_some();
 186         if let Some(fun_def_id) = opt_def_id(resolve_node(cx, path, fun.hir_id));
 187         then {
 188             return if match_def_path(cx.tcx, fun_def_id, &paths::VEC_FROM_ELEM) && args.len() == 2 {
 189                 // `vec![elem; size]` case
 190                 Some(VecArgs::Repeat(&args[0], &args[1]))
 191             }
 192             else if match_def_path(cx.tcx, fun_def_id, &paths::SLICE_INTO_VEC) && args.len() == 1 {
 193                 // `vec![a, b, c]` case
 194                 if_chain! {
 195                     if let hir::ExprBox(ref boxed) = args[0].node;
 196                     if let hir::ExprArray(ref args) = boxed.node;
 197                     then {
 198                         return Some(VecArgs::Vec(&*args));
 199                     }
 200                 }
 201
 202                 None
 203             }
 204             else {
 205                 None
 206             };
 207         }
 208     }
 209
 210     None
 211 }