clippy_lints/src/utils/mod.rs

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