clippy_lints/src/utils/mod.rs

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