clippy_lints/src/utils/mod.rs

   1 use crate::reexport::*;
   2 use if_chain::if_chain;
   3 use matches::matches;
   4 use rustc::hir;
   5 use rustc::hir::def::Def;
   6 use rustc::hir::def_id::{DefId, CRATE_DEF_INDEX, LOCAL_CRATE};
   7 use rustc::hir::intravisit::{NestedVisitorMap, Visitor};
   8 use rustc::hir::Node;
   9 use rustc::hir::*;
  10 use rustc::lint::{LateContext, Level, Lint, LintContext};
  11 use rustc::traits;
  12 use rustc::ty::{
  13     self,
  14     layout::{self, IntegerExt},
  15     subst::Kind,
  16     Binder, Ty, TyCtxt,
  17 };
  18 use rustc_data_structures::sync::Lrc;
  19 use rustc_errors::Applicability;
  20 use std::borrow::Cow;
  21 use std::mem;
  22 use syntax::ast::{self, LitKind};
  23 use syntax::attr;
  24 use syntax::source_map::{Span, DUMMY_SP};
  25 use syntax::symbol;
  26 use syntax::symbol::{keywords, Symbol};
  27
  28 pub mod attrs;
  29 pub mod author;
  30 pub mod camel_case;
  31 pub mod comparisons;
  32 pub mod conf;
  33 pub mod constants;
  34 mod diagnostics;
  35 pub mod higher;
  36 mod hir_utils;
  37 pub mod inspector;
  38 pub mod internal_lints;
  39 pub mod paths;
  40 pub mod ptr;
  41 pub mod sugg;
  42 pub mod usage;
  43 pub use self::attrs::*;
  44 pub use self::diagnostics::*;
  45 pub use self::hir_utils::{SpanlessEq, SpanlessHash};
  46
  47 /// Returns true if the two spans come from differing expansions (i.e. one is
  48 /// from a macro and one
  49 /// isn't).
  50 pub fn differing_macro_contexts(lhs: Span, rhs: Span) -> bool {
  51     rhs.ctxt() != lhs.ctxt()
  52 }
  53
  54 /// Returns `true` if the given `NodeId` is inside a constant context
  55 ///
  56 /// # Example
  57 ///
  58 /// ```rust,ignore
  59 /// if in_constant(cx, expr.id) {
  60 ///     // Do something
  61 /// }
  62 /// ```
  63 pub fn in_constant(cx: &LateContext<'_, '_>, id: HirId) -> bool {
  64     let parent_id = cx.tcx.hir().get_parent_item(id);
  65     match cx.tcx.hir().get_by_hir_id(parent_id) {
  66         Node::Item(&Item {
  67             node: ItemKind::Const(..),
  68             ..
  69         })
  70         | Node::TraitItem(&TraitItem {
  71             node: TraitItemKind::Const(..),
  72             ..
  73         })
  74         | Node::ImplItem(&ImplItem {
  75             node: ImplItemKind::Const(..),
  76             ..
  77         })
  78         | Node::AnonConst(_)
  79         | Node::Item(&Item {
  80             node: ItemKind::Static(..),
  81             ..
  82         }) => true,
  83         Node::Item(&Item {
  84             node: ItemKind::Fn(_, header, ..),
  85             ..
  86         }) => header.constness == Constness::Const,
  87         _ => false,
  88     }
  89 }
  90
  91 /// Returns true if this `expn_info` was expanded by any macro.
  92 pub fn in_macro(span: Span) -> bool {
  93     span.ctxt().outer().expn_info().is_some()
  94 }
  95
  96 /// Used to store the absolute path to a type.
  97 ///
  98 /// See `match_def_path` for usage.
  99 #[derive(Debug)]
 100 pub struct AbsolutePathBuffer {
 101     pub names: Vec<symbol::LocalInternedString>,
 102 }
 103
 104 impl ty::item_path::ItemPathBuffer for AbsolutePathBuffer {
 105     fn root_mode(&self) -> &ty::item_path::RootMode {
 106         const ABSOLUTE: &ty::item_path::RootMode = &ty::item_path::RootMode::Absolute;
 107         ABSOLUTE
 108     }
 109
 110     fn push(&mut self, text: &str) {
 111         self.names.push(symbol::Symbol::intern(text).as_str());
 112     }
 113 }
 114
 115 /// Check if a `DefId`'s path matches the given absolute type path usage.
 116 ///
 117 /// # Examples
 118 /// ```rust,ignore
 119 /// match_def_path(cx.tcx, id, &["core", "option", "Option"])
 120 /// ```
 121 ///
 122 /// See also the `paths` module.
 123 pub fn match_def_path(tcx: TyCtxt<'_, '_, '_>, def_id: DefId, path: &[&str]) -> bool {
 124     let mut apb = AbsolutePathBuffer { names: vec![] };
 125
 126     tcx.push_item_path(&mut apb, def_id, false);
 127
 128     apb.names.len() == path.len() && apb.names.into_iter().zip(path.iter()).all(|(a, &b)| *a == *b)
 129 }
 130
 131 /// Get the absolute path of `def_id` as a vector of `&str`.
 132 ///
 133 /// # Examples
 134 /// ```rust,ignore
 135 /// let def_path = get_def_path(tcx, def_id);
 136 /// if let &["core", "option", "Option"] = &def_path[..] {
 137 ///     // The given `def_id` is that of an `Option` type
 138 /// };
 139 /// ```
 140 pub fn get_def_path(tcx: TyCtxt<'_, '_, '_>, def_id: DefId) -> Vec<&'static str> {
 141     let mut apb = AbsolutePathBuffer { names: vec![] };
 142     tcx.push_item_path(&mut apb, def_id, false);
 143     apb.names
 144         .iter()
 145         .map(syntax_pos::symbol::LocalInternedString::get)
 146         .collect()
 147 }
 148
 149 /// Check if type is struct, enum or union type with given def path.
 150 pub fn match_type(cx: &LateContext<'_, '_>, ty: Ty<'_>, path: &[&str]) -> bool {
 151     match ty.sty {
 152         ty::Adt(adt, _) => match_def_path(cx.tcx, adt.did, path),
 153         _ => false,
 154     }
 155 }
 156
 157 /// Check if the method call given in `expr` belongs to given trait.
 158 pub fn match_trait_method(cx: &LateContext<'_, '_>, expr: &Expr, path: &[&str]) -> bool {
 159     let method_call = cx.tables.type_dependent_defs()[expr.hir_id];
 160     let trt_id = cx.tcx.trait_of_item(method_call.def_id());
 161     if let Some(trt_id) = trt_id {
 162         match_def_path(cx.tcx, trt_id, path)
 163     } else {
 164         false
 165     }
 166 }
 167
 168 /// Check if an expression references a variable of the given name.
 169 pub fn match_var(expr: &Expr, var: Name) -> bool {
 170     if let ExprKind::Path(QPath::Resolved(None, ref path)) = expr.node {
 171         if path.segments.len() == 1 && path.segments[0].ident.name == var {
 172             return true;
 173         }
 174     }
 175     false
 176 }
 177
 178 pub fn last_path_segment(path: &QPath) -> &PathSegment {
 179     match *path {
 180         QPath::Resolved(_, ref path) => path.segments.last().expect("A path must have at least one segment"),
 181         QPath::TypeRelative(_, ref seg) => seg,
 182     }
 183 }
 184
 185 pub fn single_segment_path(path: &QPath) -> Option<&PathSegment> {
 186     match *path {
 187         QPath::Resolved(_, ref path) if path.segments.len() == 1 => Some(&path.segments[0]),
 188         QPath::Resolved(..) => None,
 189         QPath::TypeRelative(_, ref seg) => Some(seg),
 190     }
 191 }
 192
 193 /// Match a `QPath` against a slice of segment string literals.
 194 ///
 195 /// There is also `match_path` if you are dealing with a `rustc::hir::Path` instead of a
 196 /// `rustc::hir::QPath`.
 197 ///
 198 /// # Examples
 199 /// ```rust,ignore
 200 /// match_qpath(path, &["std", "rt", "begin_unwind"])
 201 /// ```
 202 pub fn match_qpath(path: &QPath, segments: &[&str]) -> bool {
 203     match *path {
 204         QPath::Resolved(_, ref path) => match_path(path, segments),
 205         QPath::TypeRelative(ref ty, ref segment) => match ty.node {
 206             TyKind::Path(ref inner_path) => {
 207                 !segments.is_empty()
 208                     && match_qpath(inner_path, &segments[..(segments.len() - 1)])
 209                     && segment.ident.name == segments[segments.len() - 1]
 210             },
 211             _ => false,
 212         },
 213     }
 214 }
 215
 216 /// Match a `Path` against a slice of segment string literals.
 217 ///
 218 /// There is also `match_qpath` if you are dealing with a `rustc::hir::QPath` instead of a
 219 /// `rustc::hir::Path`.
 220 ///
 221 /// # Examples
 222 ///
 223 /// ```rust,ignore
 224 /// if match_path(&trait_ref.path, &paths::HASH) {
 225 ///     // This is the `std::hash::Hash` trait.
 226 /// }
 227 ///
 228 /// if match_path(ty_path, &["rustc", "lint", "Lint"]) {
 229 ///     // This is a `rustc::lint::Lint`.
 230 /// }
 231 /// ```
 232 pub fn match_path(path: &Path, segments: &[&str]) -> bool {
 233     path.segments
 234         .iter()
 235         .rev()
 236         .zip(segments.iter().rev())
 237         .all(|(a, b)| a.ident.name == *b)
 238 }
 239
 240 /// Match a `Path` against a slice of segment string literals, e.g.
 241 ///
 242 /// # Examples
 243 /// ```rust,ignore
 244 /// match_qpath(path, &["std", "rt", "begin_unwind"])
 245 /// ```
 246 pub fn match_path_ast(path: &ast::Path, segments: &[&str]) -> bool {
 247     path.segments
 248         .iter()
 249         .rev()
 250         .zip(segments.iter().rev())
 251         .all(|(a, b)| a.ident.name == *b)
 252 }
 253
 254 /// Get the definition associated to a path.
 255 pub fn path_to_def(cx: &LateContext<'_, '_>, path: &[&str]) -> Option<def::Def> {
 256     let crates = cx.tcx.crates();
 257     let krate = crates.iter().find(|&&krate| cx.tcx.crate_name(krate) == path[0]);
 258     if let Some(krate) = krate {
 259         let krate = DefId {
 260             krate: *krate,
 261             index: CRATE_DEF_INDEX,
 262         };
 263         let mut items = cx.tcx.item_children(krate);
 264         let mut path_it = path.iter().skip(1).peekable();
 265
 266         loop {
 267             let segment = match path_it.next() {
 268                 Some(segment) => segment,
 269                 None => return None,
 270             };
 271
 272             for item in mem::replace(&mut items, Lrc::new(vec![])).iter() {
 273                 if item.ident.name == *segment {
 274                     if path_it.peek().is_none() {
 275                         return Some(item.def);
 276                     }
 277
 278                     items = cx.tcx.item_children(item.def.def_id());
 279                     break;
 280                 }
 281             }
 282         }
 283     } else {
 284         None
 285     }
 286 }
 287
 288 /// Convenience function to get the `DefId` of a trait by path.
 289 pub fn get_trait_def_id(cx: &LateContext<'_, '_>, path: &[&str]) -> Option<DefId> {
 290     let def = match path_to_def(cx, path) {
 291         Some(def) => def,
 292         None => return None,
 293     };
 294
 295     match def {
 296         def::Def::Trait(trait_id) => Some(trait_id),
 297         _ => None,
 298     }
 299 }
 300
 301 /// Check whether a type implements a trait.
 302 /// See also `get_trait_def_id`.
 303 pub fn implements_trait<'a, 'tcx>(
 304     cx: &LateContext<'a, 'tcx>,
 305     ty: Ty<'tcx>,
 306     trait_id: DefId,
 307     ty_params: &[Kind<'tcx>],
 308 ) -> bool {
 309     let ty = cx.tcx.erase_regions(&ty);
 310     let obligation = cx.tcx.predicate_for_trait_def(
 311         cx.param_env,
 312         traits::ObligationCause::dummy(),
 313         trait_id,
 314         0,
 315         ty,
 316         ty_params,
 317     );
 318     cx.tcx
 319         .infer_ctxt()
 320         .enter(|infcx| infcx.predicate_must_hold_modulo_regions(&obligation))
 321 }
 322
 323 /// Get the `hir::TraitRef` of the trait the given method is implemented for
 324 ///
 325 /// Use this if you want to find the `TraitRef` of the `Add` trait in this example:
 326 ///
 327 /// ```rust
 328 /// struct Point(isize, isize);
 329 ///
 330 /// impl std::ops::Add for Point {
 331 ///     type Output = Self;
 332 ///
 333 ///     fn add(self, other: Self) -> Self {
 334 ///         Point(0, 0)
 335 ///     }
 336 /// }
 337 /// ```
 338 pub fn trait_ref_of_method(cx: &LateContext<'_, '_>, hir_id: HirId) -> Option<TraitRef> {
 339     // Get the implemented trait for the current function
 340     let parent_impl = cx.tcx.hir().get_parent_item(hir_id);
 341     if_chain! {
 342         if parent_impl != hir::CRATE_HIR_ID;
 343         if let hir::Node::Item(item) = cx.tcx.hir().get_by_hir_id(parent_impl);
 344         if let hir::ItemKind::Impl(_, _, _, _, trait_ref, _, _) = &item.node;
 345         then { return trait_ref.clone(); }
 346     }
 347     None
 348 }
 349
 350 /// Check whether this type implements Drop.
 351 pub fn has_drop<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
 352     match ty.ty_adt_def() {
 353         Some(def) => def.has_dtor(cx.tcx),
 354         _ => false,
 355     }
 356 }
 357
 358 /// Resolve the definition of a node from its `HirId`.
 359 pub fn resolve_node(cx: &LateContext<'_, '_>, qpath: &QPath, id: HirId) -> def::Def {
 360     cx.tables.qpath_def(qpath, id)
 361 }
 362
 363 /// Return the method names and argument list of nested method call expressions that make up
 364 /// `expr`.
 365 pub fn method_calls<'a>(expr: &'a Expr, max_depth: usize) -> (Vec<Symbol>, Vec<&'a [Expr]>) {
 366     let mut method_names = Vec::with_capacity(max_depth);
 367     let mut arg_lists = Vec::with_capacity(max_depth);
 368
 369     let mut current = expr;
 370     for _ in 0..max_depth {
 371         if let ExprKind::MethodCall(path, _, args) = &current.node {
 372             if args.iter().any(|e| in_macro(e.span)) {
 373                 break;
 374             }
 375             method_names.push(path.ident.name);
 376             arg_lists.push(&**args);
 377             current = &args[0];
 378         } else {
 379             break;
 380         }
 381     }
 382
 383     (method_names, arg_lists)
 384 }
 385
 386 /// Match an `Expr` against a chain of methods, and return the matched `Expr`s.
 387 ///
 388 /// For example, if `expr` represents the `.baz()` in `foo.bar().baz()`,
 389 /// `matched_method_chain(expr, &["bar", "baz"])` will return a `Vec`
 390 /// containing the `Expr`s for
 391 /// `.bar()` and `.baz()`
 392 pub fn method_chain_args<'a>(expr: &'a Expr, methods: &[&str]) -> Option<Vec<&'a [Expr]>> {
 393     let mut current = expr;
 394     let mut matched = Vec::with_capacity(methods.len());
 395     for method_name in methods.iter().rev() {
 396         // method chains are stored last -> first
 397         if let ExprKind::MethodCall(ref path, _, ref args) = current.node {
 398             if path.ident.name == *method_name {
 399                 if args.iter().any(|e| in_macro(e.span)) {
 400                     return None;
 401                 }
 402                 matched.push(&**args); // build up `matched` backwards
 403                 current = &args[0] // go to parent expression
 404             } else {
 405                 return None;
 406             }
 407         } else {
 408             return None;
 409         }
 410     }
 411     matched.reverse(); // reverse `matched`, so that it is in the same order as `methods`
 412     Some(matched)
 413 }
 414
 415 /// Returns true if the provided `def_id` is an entrypoint to a program
 416 pub fn is_entrypoint_fn(cx: &LateContext<'_, '_>, def_id: DefId) -> bool {
 417     if let Some((entry_fn_def_id, _)) = cx.tcx.entry_fn(LOCAL_CRATE) {
 418         return def_id == entry_fn_def_id;
 419     }
 420     false
 421 }
 422
 423 /// Get the name of the item the expression is in, if available.
 424 pub fn get_item_name(cx: &LateContext<'_, '_>, expr: &Expr) -> Option<Name> {
 425     let parent_id = cx.tcx.hir().get_parent_item(expr.hir_id);
 426     match cx.tcx.hir().find_by_hir_id(parent_id) {
 427         Some(Node::Item(&Item { ref ident, .. })) => Some(ident.name),
 428         Some(Node::TraitItem(&TraitItem { ident, .. })) | Some(Node::ImplItem(&ImplItem { ident, .. })) => {
 429             Some(ident.name)
 430         },
 431         _ => None,
 432     }
 433 }
 434
 435 /// Get the name of a `Pat`, if any
 436 pub fn get_pat_name(pat: &Pat) -> Option<Name> {
 437     match pat.node {
 438         PatKind::Binding(.., ref spname, _) => Some(spname.name),
 439         PatKind::Path(ref qpath) => single_segment_path(qpath).map(|ps| ps.ident.name),
 440         PatKind::Box(ref p) | PatKind::Ref(ref p, _) => get_pat_name(&*p),
 441         _ => None,
 442     }
 443 }
 444
 445 struct ContainsName {
 446     name: Name,
 447     result: bool,
 448 }
 449
 450 impl<'tcx> Visitor<'tcx> for ContainsName {
 451     fn visit_name(&mut self, _: Span, name: Name) {
 452         if self.name == name {
 453             self.result = true;
 454         }
 455     }
 456     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
 457         NestedVisitorMap::None
 458     }
 459 }
 460
 461 /// check if an `Expr` contains a certain name
 462 pub fn contains_name(name: Name, expr: &Expr) -> bool {
 463     let mut cn = ContainsName { name, result: false };
 464     cn.visit_expr(expr);
 465     cn.result
 466 }
 467
 468 /// Convert a span to a code snippet if available, otherwise use default.
 469 ///
 470 /// This is useful if you want to provide suggestions for your lint or more generally, if you want
 471 /// to convert a given `Span` to a `str`.
 472 ///
 473 /// # Example
 474 /// ```rust,ignore
 475 /// snippet(cx, expr.span, "..")
 476 /// ```
 477 pub fn snippet<'a, 'b, T: LintContext<'b>>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
 478     snippet_opt(cx, span).map_or_else(|| Cow::Borrowed(default), From::from)
 479 }
 480
 481 /// Same as `snippet`, but it adapts the applicability level by following rules:
 482 ///
 483 /// - Applicability level `Unspecified` will never be changed.
 484 /// - If the span is inside a macro, change the applicability level to `MaybeIncorrect`.
 485 /// - If the default value is used and the applicability level is `MachineApplicable`, change it to
 486 /// `HasPlaceholders`
 487 pub fn snippet_with_applicability<'a, 'b, T: LintContext<'b>>(
 488     cx: &T,
 489     span: Span,
 490     default: &'a str,
 491     applicability: &mut Applicability,
 492 ) -> Cow<'a, str> {
 493     if *applicability != Applicability::Unspecified && in_macro(span) {
 494         *applicability = Applicability::MaybeIncorrect;
 495     }
 496     snippet_opt(cx, span).map_or_else(
 497         || {
 498             if *applicability == Applicability::MachineApplicable {
 499                 *applicability = Applicability::HasPlaceholders;
 500             }
 501             Cow::Borrowed(default)
 502         },
 503         From::from,
 504     )
 505 }
 506
 507 /// Same as `snippet`, but should only be used when it's clear that the input span is
 508 /// not a macro argument.
 509 pub fn snippet_with_macro_callsite<'a, 'b, T: LintContext<'b>>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
 510     snippet(cx, span.source_callsite(), default)
 511 }
 512
 513 /// Convert a span to a code snippet. Returns `None` if not available.
 514 pub fn snippet_opt<'a, T: LintContext<'a>>(cx: &T, span: Span) -> Option<String> {
 515     cx.sess().source_map().span_to_snippet(span).ok()
 516 }
 517
 518 /// Convert a span (from a block) to a code snippet if available, otherwise use
 519 /// default.
 520 /// This trims the code of indentation, except for the first line. Use it for
 521 /// blocks or block-like
 522 /// things which need to be printed as such.
 523 ///
 524 /// # Example
 525 /// ```rust,ignore
 526 /// snippet_block(cx, expr.span, "..")
 527 /// ```
 528 pub fn snippet_block<'a, 'b, T: LintContext<'b>>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
 529     let snip = snippet(cx, span, default);
 530     trim_multiline(snip, true)
 531 }
 532
 533 /// Same as `snippet_block`, but adapts the applicability level by the rules of
 534 /// `snippet_with_applicabiliy`.
 535 pub fn snippet_block_with_applicability<'a, 'b, T: LintContext<'b>>(
 536     cx: &T,
 537     span: Span,
 538     default: &'a str,
 539     applicability: &mut Applicability,
 540 ) -> Cow<'a, str> {
 541     let snip = snippet_with_applicability(cx, span, default, applicability);
 542     trim_multiline(snip, true)
 543 }
 544
 545 /// Returns a new Span that covers the full last line of the given Span
 546 pub fn last_line_of_span<'a, T: LintContext<'a>>(cx: &T, span: Span) -> Span {
 547     let source_map_and_line = cx.sess().source_map().lookup_line(span.lo()).unwrap();
 548     let line_no = source_map_and_line.line;
 549     let line_start = &source_map_and_line.sf.lines[line_no];
 550     Span::new(*line_start, span.hi(), span.ctxt())
 551 }
 552
 553 /// Like `snippet_block`, but add braces if the expr is not an `ExprKind::Block`.
 554 /// Also takes an `Option<String>` which can be put inside the braces.
 555 pub fn expr_block<'a, 'b, T: LintContext<'b>>(
 556     cx: &T,
 557     expr: &Expr,
 558     option: Option<String>,
 559     default: &'a str,
 560 ) -> Cow<'a, str> {
 561     let code = snippet_block(cx, expr.span, default);
 562     let string = option.unwrap_or_default();
 563     if in_macro(expr.span) {
 564         Cow::Owned(format!("{{ {} }}", snippet_with_macro_callsite(cx, expr.span, default)))
 565     } else if let ExprKind::Block(_, _) = expr.node {
 566         Cow::Owned(format!("{}{}", code, string))
 567     } else if string.is_empty() {
 568         Cow::Owned(format!("{{ {} }}", code))
 569     } else {
 570         Cow::Owned(format!("{{\n{};\n{}\n}}", code, string))
 571     }
 572 }
 573
 574 /// Trim indentation from a multiline string with possibility of ignoring the
 575 /// first line.
 576 pub fn trim_multiline(s: Cow<'_, str>, ignore_first: bool) -> Cow<'_, str> {
 577     let s_space = trim_multiline_inner(s, ignore_first, ' ');
 578     let s_tab = trim_multiline_inner(s_space, ignore_first, '\t');
 579     trim_multiline_inner(s_tab, ignore_first, ' ')
 580 }
 581
 582 fn trim_multiline_inner(s: Cow<'_, str>, ignore_first: bool, ch: char) -> Cow<'_, str> {
 583     let x = s
 584         .lines()
 585         .skip(ignore_first as usize)
 586         .filter_map(|l| {
 587             if l.is_empty() {
 588                 None
 589             } else {
 590                 // ignore empty lines
 591                 Some(l.char_indices().find(|&(_, x)| x != ch).unwrap_or((l.len(), ch)).0)
 592             }
 593         })
 594         .min()
 595         .unwrap_or(0);
 596     if x > 0 {
 597         Cow::Owned(
 598             s.lines()
 599                 .enumerate()
 600                 .map(|(i, l)| {
 601                     if (ignore_first && i == 0) || l.is_empty() {
 602                         l
 603                     } else {
 604                         l.split_at(x).1
 605                     }
 606                 })
 607                 .collect::<Vec<_>>()
 608                 .join("\n"),
 609         )
 610     } else {
 611         s
 612     }
 613 }
 614
 615 /// Get a parent expressions if any – this is useful to constrain a lint.
 616 pub fn get_parent_expr<'c>(cx: &'c LateContext<'_, '_>, e: &Expr) -> Option<&'c Expr> {
 617     let map = &cx.tcx.hir();
 618     let hir_id = e.hir_id;
 619     let parent_id = map.get_parent_node_by_hir_id(hir_id);
 620     if hir_id == parent_id {
 621         return None;
 622     }
 623     map.find_by_hir_id(parent_id).and_then(|node| {
 624         if let Node::Expr(parent) = node {
 625             Some(parent)
 626         } else {
 627             None
 628         }
 629     })
 630 }
 631
 632 pub fn get_enclosing_block<'a, 'tcx: 'a>(cx: &LateContext<'a, 'tcx>, node: HirId) -> Option<&'tcx Block> {
 633     let map = &cx.tcx.hir();
 634     let node_id = map.hir_to_node_id(node);
 635     let enclosing_node = map
 636         .get_enclosing_scope(node_id)
 637         .and_then(|enclosing_id| map.find(enclosing_id));
 638     if let Some(node) = enclosing_node {
 639         match node {
 640             Node::Block(block) => Some(block),
 641             Node::Item(&Item {
 642                 node: ItemKind::Fn(_, _, _, eid),
 643                 ..
 644             })
 645             | Node::ImplItem(&ImplItem {
 646                 node: ImplItemKind::Method(_, eid),
 647                 ..
 648             }) => match cx.tcx.hir().body(eid).value.node {
 649                 ExprKind::Block(ref block, _) => Some(block),
 650                 _ => None,
 651             },
 652             _ => None,
 653         }
 654     } else {
 655         None
 656     }
 657 }
 658
 659 /// Return the base type for HIR references and pointers.
 660 pub fn walk_ptrs_hir_ty(ty: &hir::Ty) -> &hir::Ty {
 661     match ty.node {
 662         TyKind::Ptr(ref mut_ty) | TyKind::Rptr(_, ref mut_ty) => walk_ptrs_hir_ty(&mut_ty.ty),
 663         _ => ty,
 664     }
 665 }
 666
 667 /// Return the base type for references and raw pointers.
 668 pub fn walk_ptrs_ty(ty: Ty<'_>) -> Ty<'_> {
 669     match ty.sty {
 670         ty::Ref(_, ty, _) => walk_ptrs_ty(ty),
 671         _ => ty,
 672     }
 673 }
 674
 675 /// Return the base type for references and raw pointers, and count reference
 676 /// depth.
 677 pub fn walk_ptrs_ty_depth(ty: Ty<'_>) -> (Ty<'_>, usize) {
 678     fn inner(ty: Ty<'_>, depth: usize) -> (Ty<'_>, usize) {
 679         match ty.sty {
 680             ty::Ref(_, ty, _) => inner(ty, depth + 1),
 681             _ => (ty, depth),
 682         }
 683     }
 684     inner(ty, 0)
 685 }
 686
 687 /// Check whether the given expression is a constant literal of the given value.
 688 pub fn is_integer_literal(expr: &Expr, value: u128) -> bool {
 689     // FIXME: use constant folding
 690     if let ExprKind::Lit(ref spanned) = expr.node {
 691         if let LitKind::Int(v, _) = spanned.node {
 692             return v == value;
 693         }
 694     }
 695     false
 696 }
 697
 698 /// Returns `true` if the given `Expr` has been coerced before.
 699 ///
 700 /// Examples of coercions can be found in the Nomicon at
 701 /// <https://doc.rust-lang.org/nomicon/coercions.html>.
 702 ///
 703 /// See `rustc::ty::adjustment::Adjustment` and `rustc_typeck::check::coercion` for more
 704 /// information on adjustments and coercions.
 705 pub fn is_adjusted(cx: &LateContext<'_, '_>, e: &Expr) -> bool {
 706     cx.tables.adjustments().get(e.hir_id).is_some()
 707 }
 708
 709 /// Return the pre-expansion span if is this comes from an expansion of the
 710 /// macro `name`.
 711 /// See also `is_direct_expn_of`.
 712 pub fn is_expn_of(mut span: Span, name: &str) -> Option<Span> {
 713     loop {
 714         let span_name_span = span
 715             .ctxt()
 716             .outer()
 717             .expn_info()
 718             .map(|ei| (ei.format.name(), ei.call_site));
 719
 720         match span_name_span {
 721             Some((mac_name, new_span)) if mac_name == name => return Some(new_span),
 722             None => return None,
 723             Some((_, new_span)) => span = new_span,
 724         }
 725     }
 726 }
 727
 728 /// Return the pre-expansion span if is this directly comes from an expansion
 729 /// of the macro `name`.
 730 /// The difference with `is_expn_of` is that in
 731 /// ```rust,ignore
 732 /// foo!(bar!(42));
 733 /// ```
 734 /// `42` is considered expanded from `foo!` and `bar!` by `is_expn_of` but only
 735 /// `bar!` by
 736 /// `is_direct_expn_of`.
 737 pub fn is_direct_expn_of(span: Span, name: &str) -> Option<Span> {
 738     let span_name_span = span
 739         .ctxt()
 740         .outer()
 741         .expn_info()
 742         .map(|ei| (ei.format.name(), ei.call_site));
 743
 744     match span_name_span {
 745         Some((mac_name, new_span)) if mac_name == name => Some(new_span),
 746         _ => None,
 747     }
 748 }
 749
 750 /// Convenience function to get the return type of a function
 751 pub fn return_ty<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, fn_item: hir::HirId) -> Ty<'tcx> {
 752     let fn_def_id = cx.tcx.hir().local_def_id_from_hir_id(fn_item);
 753     let ret_ty = cx.tcx.fn_sig(fn_def_id).output();
 754     cx.tcx.erase_late_bound_regions(&ret_ty)
 755 }
 756
 757 /// Check if two types are the same.
 758 ///
 759 /// This discards any lifetime annotations, too.
 760 // FIXME: this works correctly for lifetimes bounds (`for <'a> Foo<'a>` == `for
 761 // <'b> Foo<'b>` but
 762 // not for type parameters.
 763 pub fn same_tys<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, a: Ty<'tcx>, b: Ty<'tcx>) -> bool {
 764     let a = cx.tcx.erase_late_bound_regions(&Binder::bind(a));
 765     let b = cx.tcx.erase_late_bound_regions(&Binder::bind(b));
 766     cx.tcx
 767         .infer_ctxt()
 768         .enter(|infcx| infcx.can_eq(cx.param_env, a, b).is_ok())
 769 }
 770
 771 /// Return whether the given type is an `unsafe` function.
 772 pub fn type_is_unsafe_function<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
 773     match ty.sty {
 774         ty::FnDef(..) | ty::FnPtr(_) => ty.fn_sig(cx.tcx).unsafety() == Unsafety::Unsafe,
 775         _ => false,
 776     }
 777 }
 778
 779 pub fn is_copy<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
 780     ty.is_copy_modulo_regions(cx.tcx.global_tcx(), cx.param_env, DUMMY_SP)
 781 }
 782
 783 /// Return whether a pattern is refutable.
 784 pub fn is_refutable(cx: &LateContext<'_, '_>, pat: &Pat) -> bool {
 785     fn is_enum_variant(cx: &LateContext<'_, '_>, qpath: &QPath, id: HirId) -> bool {
 786         matches!(
 787             cx.tables.qpath_def(qpath, id),
 788             def::Def::Variant(..) | def::Def::VariantCtor(..)
 789         )
 790     }
 791
 792     fn are_refutable<'a, I: Iterator<Item = &'a Pat>>(cx: &LateContext<'_, '_>, mut i: I) -> bool {
 793         i.any(|pat| is_refutable(cx, pat))
 794     }
 795
 796     match pat.node {
 797         PatKind::Binding(..) | PatKind::Wild => false,
 798         PatKind::Box(ref pat) | PatKind::Ref(ref pat, _) => is_refutable(cx, pat),
 799         PatKind::Lit(..) | PatKind::Range(..) => true,
 800         PatKind::Path(ref qpath) => is_enum_variant(cx, qpath, pat.hir_id),
 801         PatKind::Tuple(ref pats, _) => are_refutable(cx, pats.iter().map(|pat| &**pat)),
 802         PatKind::Struct(ref qpath, ref fields, _) => {
 803             if is_enum_variant(cx, qpath, pat.hir_id) {
 804                 true
 805             } else {
 806                 are_refutable(cx, fields.iter().map(|field| &*field.node.pat))
 807             }
 808         },
 809         PatKind::TupleStruct(ref qpath, ref pats, _) => {
 810             if is_enum_variant(cx, qpath, pat.hir_id) {
 811                 true
 812             } else {
 813                 are_refutable(cx, pats.iter().map(|pat| &**pat))
 814             }
 815         },
 816         PatKind::Slice(ref head, ref middle, ref tail) => {
 817             are_refutable(cx, head.iter().chain(middle).chain(tail.iter()).map(|pat| &**pat))
 818         },
 819     }
 820 }
 821
 822 /// Checks for the `#[automatically_derived]` attribute all `#[derive]`d
 823 /// implementations have.
 824 pub fn is_automatically_derived(attrs: &[ast::Attribute]) -> bool {
 825     attr::contains_name(attrs, "automatically_derived")
 826 }
 827
 828 /// Remove blocks around an expression.
 829 ///
 830 /// Ie. `x`, `{ x }` and `{{{{ x }}}}` all give `x`. `{ x; y }` and `{}` return
 831 /// themselves.
 832 pub fn remove_blocks(expr: &Expr) -> &Expr {
 833     if let ExprKind::Block(ref block, _) = expr.node {
 834         if block.stmts.is_empty() {
 835             if let Some(ref expr) = block.expr {
 836                 remove_blocks(expr)
 837             } else {
 838                 expr
 839             }
 840         } else {
 841             expr
 842         }
 843     } else {
 844         expr
 845     }
 846 }
 847
 848 pub fn is_self(slf: &Arg) -> bool {
 849     if let PatKind::Binding(.., name, _) = slf.pat.node {
 850         name.name == keywords::SelfLower.name()
 851     } else {
 852         false
 853     }
 854 }
 855
 856 pub fn is_self_ty(slf: &hir::Ty) -> bool {
 857     if_chain! {
 858         if let TyKind::Path(ref qp) = slf.node;
 859         if let QPath::Resolved(None, ref path) = *qp;
 860         if let Def::SelfTy(..) = path.def;
 861         then {
 862             return true
 863         }
 864     }
 865     false
 866 }
 867
 868 pub fn iter_input_pats<'tcx>(decl: &FnDecl, body: &'tcx Body) -> impl Iterator<Item = &'tcx Arg> {
 869     (0..decl.inputs.len()).map(move |i| &body.arguments[i])
 870 }
 871
 872 /// Check if a given expression is a match expression
 873 /// expanded from `?` operator or `try` macro.
 874 pub fn is_try<'a>(cx: &'_ LateContext<'_, '_>, expr: &'a Expr) -> Option<&'a Expr> {
 875     fn is_ok(cx: &'_ LateContext<'_, '_>, arm: &Arm) -> bool {
 876         if_chain! {
 877             if let PatKind::TupleStruct(ref path, ref pat, None) = arm.pats[0].node;
 878             if match_qpath(path, &paths::RESULT_OK[1..]);
 879             if let PatKind::Binding(_, hir_id, _, None) = pat[0].node;
 880             if let ExprKind::Path(QPath::Resolved(None, ref path)) = arm.body.node;
 881             if let Def::Local(lid) = path.def;
 882             if cx.tcx.hir().node_to_hir_id(lid) == hir_id;
 883             then {
 884                 return true;
 885             }
 886         }
 887         false
 888     }
 889
 890     fn is_err(arm: &Arm) -> bool {
 891         if let PatKind::TupleStruct(ref path, _, _) = arm.pats[0].node {
 892             match_qpath(path, &paths::RESULT_ERR[1..])
 893         } else {
 894             false
 895         }
 896     }
 897
 898     if let ExprKind::Match(_, ref arms, ref source) = expr.node {
 899         // desugared from a `?` operator
 900         if let MatchSource::TryDesugar = *source {
 901             return Some(expr);
 902         }
 903
 904         if_chain! {
 905             if arms.len() == 2;
 906             if arms[0].pats.len() == 1 && arms[0].guard.is_none();
 907             if arms[1].pats.len() == 1 && arms[1].guard.is_none();
 908             if (is_ok(cx, &arms[0]) && is_err(&arms[1])) ||
 909                 (is_ok(cx, &arms[1]) && is_err(&arms[0]));
 910             then {
 911                 return Some(expr);
 912             }
 913         }
 914     }
 915
 916     None
 917 }
 918
 919 /// Returns true if the lint is allowed in the current context
 920 ///
 921 /// Useful for skipping long running code when it's unnecessary
 922 pub fn is_allowed(cx: &LateContext<'_, '_>, lint: &'static Lint, id: HirId) -> bool {
 923     cx.tcx.lint_level_at_node(lint, id).0 == Level::Allow
 924 }
 925
 926 pub fn get_arg_name(pat: &Pat) -> Option<ast::Name> {
 927     match pat.node {
 928         PatKind::Binding(.., ident, None) => Some(ident.name),
 929         PatKind::Ref(ref subpat, _) => get_arg_name(subpat),
 930         _ => None,
 931     }
 932 }
 933
 934 pub fn int_bits(tcx: TyCtxt<'_, '_, '_>, ity: ast::IntTy) -> u64 {
 935     layout::Integer::from_attr(&tcx, attr::IntType::SignedInt(ity))
 936         .size()
 937         .bits()
 938 }
 939
 940 #[allow(clippy::cast_possible_wrap)]
 941 /// Turn a constant int byte representation into an i128
 942 pub fn sext(tcx: TyCtxt<'_, '_, '_>, u: u128, ity: ast::IntTy) -> i128 {
 943     let amt = 128 - int_bits(tcx, ity);
 944     ((u as i128) << amt) >> amt
 945 }
 946
 947 #[allow(clippy::cast_sign_loss)]
 948 /// clip unused bytes
 949 pub fn unsext(tcx: TyCtxt<'_, '_, '_>, u: i128, ity: ast::IntTy) -> u128 {
 950     let amt = 128 - int_bits(tcx, ity);
 951     ((u as u128) << amt) >> amt
 952 }
 953
 954 /// clip unused bytes
 955 pub fn clip(tcx: TyCtxt<'_, '_, '_>, u: u128, ity: ast::UintTy) -> u128 {
 956     let bits = layout::Integer::from_attr(&tcx, attr::IntType::UnsignedInt(ity))
 957         .size()
 958         .bits();
 959     let amt = 128 - bits;
 960     (u << amt) >> amt
 961 }
 962
 963 /// Remove block comments from the given Vec of lines
 964 ///
 965 /// # Examples
 966 ///
 967 /// ```rust,ignore
 968 /// without_block_comments(vec!["/*", "foo", "*/"]);
 969 /// // => vec![]
 970 ///
 971 /// without_block_comments(vec!["bar", "/*", "foo", "*/"]);
 972 /// // => vec!["bar"]
 973 /// ```
 974 pub fn without_block_comments(lines: Vec<&str>) -> Vec<&str> {
 975     let mut without = vec![];
 976
 977     let mut nest_level = 0;
 978
 979     for line in lines {
 980         if line.contains("/*") {
 981             nest_level += 1;
 982             continue;
 983         } else if line.contains("*/") {
 984             nest_level -= 1;
 985             continue;
 986         }
 987
 988         if nest_level == 0 {
 989             without.push(line);
 990         }
 991     }
 992
 993     without
 994 }
 995
 996 pub fn any_parent_is_automatically_derived(tcx: TyCtxt<'_, '_, '_>, node: HirId) -> bool {
 997     let map = &tcx.hir();
 998     let mut prev_enclosing_node = None;
 999     let mut enclosing_node = node;
1000     while Some(enclosing_node) != prev_enclosing_node {
1001         if is_automatically_derived(map.attrs_by_hir_id(enclosing_node)) {
1002             return true;
1003         }
1004         prev_enclosing_node = Some(enclosing_node);
1005         enclosing_node = map.get_parent_item(enclosing_node);
1006     }
1007     false
1008 }
1009
1010 /// Returns true if ty has `iter` or `iter_mut` methods
1011 pub fn has_iter_method(cx: &LateContext<'_, '_>, probably_ref_ty: ty::Ty<'_>) -> Option<&'static str> {
1012     // FIXME: instead of this hard-coded list, we should check if `<adt>::iter`
1013     // exists and has the desired signature. Unfortunately FnCtxt is not exported
1014     // so we can't use its `lookup_method` method.
1015     static INTO_ITER_COLLECTIONS: [&[&str]; 13] = [
1016         &paths::VEC,
1017         &paths::OPTION,
1018         &paths::RESULT,
1019         &paths::BTREESET,
1020         &paths::BTREEMAP,
1021         &paths::VEC_DEQUE,
1022         &paths::LINKED_LIST,
1023         &paths::BINARY_HEAP,
1024         &paths::HASHSET,
1025         &paths::HASHMAP,
1026         &paths::PATH_BUF,
1027         &paths::PATH,
1028         &paths::RECEIVER,
1029     ];
1030
1031     let ty_to_check = match probably_ref_ty.sty {
1032         ty::Ref(_, ty_to_check, _) => ty_to_check,
1033         _ => probably_ref_ty,
1034     };
1035
1036     let def_id = match ty_to_check.sty {
1037         ty::Array(..) => return Some("array"),
1038         ty::Slice(..) => return Some("slice"),
1039         ty::Adt(adt, _) => adt.did,
1040         _ => return None,
1041     };
1042
1043     for path in &INTO_ITER_COLLECTIONS {
1044         if match_def_path(cx.tcx, def_id, path) {
1045             return Some(path.last().unwrap());
1046         }
1047     }
1048     None
1049 }
1050
1051 #[cfg(test)]
1052 mod test {
1053     use super::{trim_multiline, without_block_comments};
1054
1055     #[test]
1056     fn test_trim_multiline_single_line() {
1057         assert_eq!("", trim_multiline("".into(), false));
1058         assert_eq!("...", trim_multiline("...".into(), false));
1059         assert_eq!("...", trim_multiline("    ...".into(), false));
1060         assert_eq!("...", trim_multiline("\t...".into(), false));
1061         assert_eq!("...", trim_multiline("\t\t...".into(), false));
1062     }
1063
1064     #[test]
1065     #[rustfmt::skip]
1066     fn test_trim_multiline_block() {
1067         assert_eq!("\
1068     if x {
1069         y
1070     } else {
1071         z
1072     }", trim_multiline("    if x {
1073             y
1074         } else {
1075             z
1076         }".into(), false));
1077         assert_eq!("\
1078     if x {
1079     \ty
1080     } else {
1081     \tz
1082     }", trim_multiline("    if x {
1083         \ty
1084         } else {
1085         \tz
1086         }".into(), false));
1087     }
1088
1089     #[test]
1090     #[rustfmt::skip]
1091     fn test_trim_multiline_empty_line() {
1092         assert_eq!("\
1093     if x {
1094         y
1095
1096     } else {
1097         z
1098     }", trim_multiline("    if x {
1099             y
1100
1101         } else {
1102             z
1103         }".into(), false));
1104     }
1105
1106     #[test]
1107     fn test_without_block_comments_lines_without_block_comments() {
1108         let result = without_block_comments(vec!["/*", "", "*/"]);
1109         println!("result: {:?}", result);
1110         assert!(result.is_empty());
1111
1112         let result = without_block_comments(vec!["", "/*", "", "*/", "#[crate_type = \"lib\"]", "/*", "", "*/", ""]);
1113         assert_eq!(result, vec!["", "#[crate_type = \"lib\"]", ""]);
1114
1115         let result = without_block_comments(vec!["/* rust", "", "*/"]);
1116         assert!(result.is_empty());
1117
1118         let result = without_block_comments(vec!["/* one-line comment */"]);
1119         assert!(result.is_empty());
1120
1121         let result = without_block_comments(vec!["/* nested", "/* multi-line", "comment", "*/", "test", "*/"]);
1122         assert!(result.is_empty());
1123
1124         let result = without_block_comments(vec!["/* nested /* inline /* comment */ test */ */"]);
1125         assert!(result.is_empty());
1126
1127         let result = without_block_comments(vec!["foo", "bar", "baz"]);
1128         assert_eq!(result, vec!["foo", "bar", "baz"]);
1129     }
1130 }