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