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