clippy_lints/src/utils/mod.rs

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