clippy_lints/src/utils/mod.rs

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