clippy_lints/src/utils/mod.rs

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