4 #[allow(clippy::module_name_repetitions)]
13 pub mod eager_or_lazy;
17 pub mod internal_lints;
18 pub mod numeric_literal;
21 pub mod qualify_min_const_fn;
25 pub use self::attrs::*;
26 pub use self::diagnostics::*;
27 pub use self::hir_utils::{both, eq_expr_value, over, SpanlessEq, SpanlessHash};
30 use std::collections::hash_map::Entry;
31 use std::hash::BuildHasherDefault;
34 use if_chain::if_chain;
35 use rustc_ast::ast::{self, Attribute, LitKind};
36 use rustc_attr as attr;
37 use rustc_data_structures::fx::FxHashMap;
38 use rustc_errors::Applicability;
40 use rustc_hir::def::{DefKind, Res};
41 use rustc_hir::def_id::{DefId, CRATE_DEF_INDEX, LOCAL_CRATE};
42 use rustc_hir::intravisit::{NestedVisitorMap, Visitor};
45 def, Arm, Block, Body, Constness, Crate, Expr, ExprKind, FnDecl, HirId, ImplItem, ImplItemKind, Item, ItemKind,
46 MatchSource, Param, Pat, PatKind, Path, PathSegment, QPath, TraitItem, TraitItemKind, TraitRef, TyKind, Unsafety,
48 use rustc_infer::infer::TyCtxtInferExt;
49 use rustc_lint::{LateContext, Level, Lint, LintContext};
50 use rustc_middle::hir::map::Map;
51 use rustc_middle::ty::subst::{GenericArg, GenericArgKind};
52 use rustc_middle::ty::{self, layout::IntegerExt, Ty, TyCtxt, TypeFoldable};
53 use rustc_span::hygiene::{ExpnKind, MacroKind};
54 use rustc_span::source_map::original_sp;
55 use rustc_span::sym as rustc_sym;
56 use rustc_span::symbol::{self, kw, Symbol};
57 use rustc_span::{BytePos, Pos, Span, DUMMY_SP};
58 use rustc_target::abi::Integer;
59 use rustc_trait_selection::traits::query::normalize::AtExt;
60 use smallvec::SmallVec;
62 use crate::consts::{constant, Constant};
64 /// Returns `true` if the two spans come from differing expansions (i.e., one is
65 /// from a macro and one isn't).
67 pub fn differing_macro_contexts(lhs: Span, rhs: Span) -> bool {
68 rhs.ctxt() != lhs.ctxt()
71 /// Returns `true` if the given `NodeId` is inside a constant context
76 /// if in_constant(cx, expr.hir_id) {
80 pub fn in_constant(cx: &LateContext<'_>, id: HirId) -> bool {
81 let parent_id = cx.tcx.hir().get_parent_item(id);
82 match cx.tcx.hir().get(parent_id) {
84 kind: ItemKind::Const(..) | ItemKind::Static(..),
87 | Node::TraitItem(&TraitItem {
88 kind: TraitItemKind::Const(..),
91 | Node::ImplItem(&ImplItem {
92 kind: ImplItemKind::Const(..),
95 | Node::AnonConst(_) => true,
97 kind: ItemKind::Fn(ref sig, ..),
100 | Node::ImplItem(&ImplItem {
101 kind: ImplItemKind::Fn(ref sig, _),
103 }) => sig.header.constness == Constness::Const,
108 /// Returns `true` if this `span` was expanded by any macro.
110 pub fn in_macro(span: Span) -> bool {
111 if span.from_expansion() {
112 !matches!(span.ctxt().outer_expn_data().kind, ExpnKind::Desugaring(..))
118 // If the snippet is empty, it's an attribute that was inserted during macro
119 // expansion and we want to ignore those, because they could come from external
120 // sources that the user has no control over.
121 // For some reason these attributes don't have any expansion info on them, so
122 // we have to check it this way until there is a better way.
123 pub fn is_present_in_source<T: LintContext>(cx: &T, span: Span) -> bool {
124 if let Some(snippet) = snippet_opt(cx, span) {
125 if snippet.is_empty() {
132 /// Checks if given pattern is a wildcard (`_`)
133 pub fn is_wild<'tcx>(pat: &impl std::ops::Deref<Target = Pat<'tcx>>) -> bool {
134 matches!(pat.kind, PatKind::Wild)
137 /// Checks if type is struct, enum or union type with the given def path.
139 /// If the type is a diagnostic item, use `is_type_diagnostic_item` instead.
140 /// If you change the signature, remember to update the internal lint `MatchTypeOnDiagItem`
141 pub fn match_type(cx: &LateContext<'_>, ty: Ty<'_>, path: &[&str]) -> bool {
143 ty::Adt(adt, _) => match_def_path(cx, adt.did, path),
148 /// Checks if the type is equal to a diagnostic item
150 /// If you change the signature, remember to update the internal lint `MatchTypeOnDiagItem`
151 pub fn is_type_diagnostic_item(cx: &LateContext<'_>, ty: Ty<'_>, diag_item: Symbol) -> bool {
153 ty::Adt(adt, _) => cx.tcx.is_diagnostic_item(diag_item, adt.did),
158 /// Checks if the type is equal to a lang item
159 pub fn is_type_lang_item(cx: &LateContext<'_>, ty: Ty<'_>, lang_item: hir::LangItem) -> bool {
161 ty::Adt(adt, _) => cx.tcx.lang_items().require(lang_item).unwrap() == adt.did,
166 /// Checks if the method call given in `expr` belongs to the given trait.
167 pub fn match_trait_method(cx: &LateContext<'_>, expr: &Expr<'_>, path: &[&str]) -> bool {
168 let def_id = cx.typeck_results().type_dependent_def_id(expr.hir_id).unwrap();
169 let trt_id = cx.tcx.trait_of_item(def_id);
170 trt_id.map_or(false, |trt_id| match_def_path(cx, trt_id, path))
173 /// Checks if an expression references a variable of the given name.
174 pub fn match_var(expr: &Expr<'_>, var: Symbol) -> bool {
175 if let ExprKind::Path(QPath::Resolved(None, ref path)) = expr.kind {
176 if let [p] = path.segments {
177 return p.ident.name == var;
183 pub fn last_path_segment<'tcx>(path: &QPath<'tcx>) -> &'tcx PathSegment<'tcx> {
185 QPath::Resolved(_, ref path) => path.segments.last().expect("A path must have at least one segment"),
186 QPath::TypeRelative(_, ref seg) => seg,
187 QPath::LangItem(..) => panic!("last_path_segment: lang item has no path segments"),
191 pub fn single_segment_path<'tcx>(path: &QPath<'tcx>) -> Option<&'tcx PathSegment<'tcx>> {
193 QPath::Resolved(_, ref path) => path.segments.get(0),
194 QPath::TypeRelative(_, ref seg) => Some(seg),
195 QPath::LangItem(..) => None,
199 /// Matches a `QPath` against a slice of segment string literals.
201 /// There is also `match_path` if you are dealing with a `rustc_hir::Path` instead of a
202 /// `rustc_hir::QPath`.
206 /// match_qpath(path, &["std", "rt", "begin_unwind"])
208 pub fn match_qpath(path: &QPath<'_>, segments: &[&str]) -> bool {
210 QPath::Resolved(_, ref path) => match_path(path, segments),
211 QPath::TypeRelative(ref ty, ref segment) => match ty.kind {
212 TyKind::Path(ref inner_path) => {
213 if let [prefix @ .., end] = segments {
214 if match_qpath(inner_path, prefix) {
215 return segment.ident.name.as_str() == *end;
222 QPath::LangItem(..) => false,
226 /// Matches a `Path` against a slice of segment string literals.
228 /// There is also `match_qpath` if you are dealing with a `rustc_hir::QPath` instead of a
229 /// `rustc_hir::Path`.
234 /// if match_path(&trait_ref.path, &paths::HASH) {
235 /// // This is the `std::hash::Hash` trait.
238 /// if match_path(ty_path, &["rustc", "lint", "Lint"]) {
239 /// // This is a `rustc_middle::lint::Lint`.
242 pub fn match_path(path: &Path<'_>, segments: &[&str]) -> bool {
246 .zip(segments.iter().rev())
247 .all(|(a, b)| a.ident.name.as_str() == *b)
250 /// Matches a `Path` against a slice of segment string literals, e.g.
254 /// match_path_ast(path, &["std", "rt", "begin_unwind"])
256 pub fn match_path_ast(path: &ast::Path, segments: &[&str]) -> bool {
260 .zip(segments.iter().rev())
261 .all(|(a, b)| a.ident.name.as_str() == *b)
264 /// Gets the definition associated to a path.
265 pub fn path_to_res(cx: &LateContext<'_>, path: &[&str]) -> Option<def::Res> {
266 let crates = cx.tcx.crates();
269 .find(|&&krate| cx.tcx.crate_name(krate).as_str() == path[0]);
270 if let Some(krate) = krate {
273 index: CRATE_DEF_INDEX,
275 let mut current_item = None;
276 let mut items = cx.tcx.item_children(krate);
277 let mut path_it = path.iter().skip(1).peekable();
280 let segment = match path_it.next() {
281 Some(segment) => segment,
285 // `get_def_path` seems to generate these empty segments for extern blocks.
286 // We can just ignore them.
287 if segment.is_empty() {
291 let result = SmallVec::<[_; 8]>::new();
292 for item in mem::replace(&mut items, cx.tcx.arena.alloc_slice(&result)).iter() {
293 if item.ident.name.as_str() == *segment {
294 if path_it.peek().is_none() {
295 return Some(item.res);
298 current_item = Some(item);
299 items = cx.tcx.item_children(item.res.def_id());
304 // The segment isn't a child_item.
305 // Try to find it under an inherent impl.
307 if path_it.peek().is_none();
308 if let Some(current_item) = current_item;
309 let item_def_id = current_item.res.def_id();
310 if cx.tcx.def_kind(item_def_id) == DefKind::Struct;
312 // Bad `find_map` suggestion. See #4193.
313 #[allow(clippy::find_map)]
314 return cx.tcx.inherent_impls(item_def_id).iter()
315 .flat_map(|&impl_def_id| cx.tcx.item_children(impl_def_id))
316 .find(|item| item.ident.name.as_str() == *segment)
317 .map(|item| item.res);
326 pub fn qpath_res(cx: &LateContext<'_>, qpath: &hir::QPath<'_>, id: hir::HirId) -> Res {
328 hir::QPath::Resolved(_, path) => path.res,
329 hir::QPath::TypeRelative(..) | hir::QPath::LangItem(..) => {
330 if cx.tcx.has_typeck_results(id.owner.to_def_id()) {
331 cx.tcx.typeck(id.owner).qpath_res(qpath, id)
339 /// Convenience function to get the `DefId` of a trait by path.
340 /// It could be a trait or trait alias.
341 pub fn get_trait_def_id(cx: &LateContext<'_>, path: &[&str]) -> Option<DefId> {
342 let res = match path_to_res(cx, path) {
348 Res::Def(DefKind::Trait | DefKind::TraitAlias, trait_id) => Some(trait_id),
349 Res::Err => unreachable!("this trait resolution is impossible: {:?}", &path),
354 /// Checks whether a type implements a trait.
355 /// See also `get_trait_def_id`.
356 pub fn implements_trait<'tcx>(
357 cx: &LateContext<'tcx>,
360 ty_params: &[GenericArg<'tcx>],
362 // Do not check on infer_types to avoid panic in evaluate_obligation.
363 if ty.has_infer_types() {
366 let ty = cx.tcx.erase_regions(ty);
367 let ty_params = cx.tcx.mk_substs(ty_params.iter());
368 cx.tcx.type_implements_trait((trait_id, ty, ty_params, cx.param_env))
371 /// Gets the `hir::TraitRef` of the trait the given method is implemented for.
373 /// Use this if you want to find the `TraitRef` of the `Add` trait in this example:
376 /// struct Point(isize, isize);
378 /// impl std::ops::Add for Point {
379 /// type Output = Self;
381 /// fn add(self, other: Self) -> Self {
386 pub fn trait_ref_of_method<'tcx>(cx: &LateContext<'tcx>, hir_id: HirId) -> Option<&'tcx TraitRef<'tcx>> {
387 // Get the implemented trait for the current function
388 let parent_impl = cx.tcx.hir().get_parent_item(hir_id);
390 if parent_impl != hir::CRATE_HIR_ID;
391 if let hir::Node::Item(item) = cx.tcx.hir().get(parent_impl);
392 if let hir::ItemKind::Impl{ of_trait: trait_ref, .. } = &item.kind;
393 then { return trait_ref.as_ref(); }
398 /// Checks whether this type implements `Drop`.
399 pub fn has_drop<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
400 match ty.ty_adt_def() {
401 Some(def) => def.has_dtor(cx.tcx),
406 /// Returns the method names and argument list of nested method call expressions that make up
407 /// `expr`. method/span lists are sorted with the most recent call first.
408 pub fn method_calls<'tcx>(
409 expr: &'tcx Expr<'tcx>,
411 ) -> (Vec<Symbol>, Vec<&'tcx [Expr<'tcx>]>, Vec<Span>) {
412 let mut method_names = Vec::with_capacity(max_depth);
413 let mut arg_lists = Vec::with_capacity(max_depth);
414 let mut spans = Vec::with_capacity(max_depth);
416 let mut current = expr;
417 for _ in 0..max_depth {
418 if let ExprKind::MethodCall(path, span, args, _) = ¤t.kind {
419 if args.iter().any(|e| e.span.from_expansion()) {
422 method_names.push(path.ident.name);
423 arg_lists.push(&**args);
431 (method_names, arg_lists, spans)
434 /// Matches an `Expr` against a chain of methods, and return the matched `Expr`s.
436 /// For example, if `expr` represents the `.baz()` in `foo.bar().baz()`,
437 /// `method_chain_args(expr, &["bar", "baz"])` will return a `Vec`
438 /// containing the `Expr`s for
439 /// `.bar()` and `.baz()`
440 pub fn method_chain_args<'a>(expr: &'a Expr<'_>, methods: &[&str]) -> Option<Vec<&'a [Expr<'a>]>> {
441 let mut current = expr;
442 let mut matched = Vec::with_capacity(methods.len());
443 for method_name in methods.iter().rev() {
444 // method chains are stored last -> first
445 if let ExprKind::MethodCall(ref path, _, ref args, _) = current.kind {
446 if path.ident.name.as_str() == *method_name {
447 if args.iter().any(|e| e.span.from_expansion()) {
450 matched.push(&**args); // build up `matched` backwards
451 current = &args[0] // go to parent expression
459 // Reverse `matched` so that it is in the same order as `methods`.
464 /// Returns `true` if the provided `def_id` is an entrypoint to a program.
465 pub fn is_entrypoint_fn(cx: &LateContext<'_>, def_id: DefId) -> bool {
467 .entry_fn(LOCAL_CRATE)
468 .map_or(false, |(entry_fn_def_id, _)| def_id == entry_fn_def_id.to_def_id())
471 /// Gets the name of the item the expression is in, if available.
472 pub fn get_item_name(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<Symbol> {
473 let parent_id = cx.tcx.hir().get_parent_item(expr.hir_id);
474 match cx.tcx.hir().find(parent_id) {
476 Node::Item(Item { ident, .. })
477 | Node::TraitItem(TraitItem { ident, .. })
478 | Node::ImplItem(ImplItem { ident, .. }),
479 ) => Some(ident.name),
484 /// Gets the name of a `Pat`, if any.
485 pub fn get_pat_name(pat: &Pat<'_>) -> Option<Symbol> {
487 PatKind::Binding(.., ref spname, _) => Some(spname.name),
488 PatKind::Path(ref qpath) => single_segment_path(qpath).map(|ps| ps.ident.name),
489 PatKind::Box(ref p) | PatKind::Ref(ref p, _) => get_pat_name(&*p),
494 struct ContainsName {
499 impl<'tcx> Visitor<'tcx> for ContainsName {
500 type Map = Map<'tcx>;
502 fn visit_name(&mut self, _: Span, name: Symbol) {
503 if self.name == name {
507 fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
508 NestedVisitorMap::None
512 /// Checks if an `Expr` contains a certain name.
513 pub fn contains_name(name: Symbol, expr: &Expr<'_>) -> bool {
514 let mut cn = ContainsName { name, result: false };
519 /// Converts a span to a code snippet if available, otherwise use default.
521 /// This is useful if you want to provide suggestions for your lint or more generally, if you want
522 /// to convert a given `Span` to a `str`.
526 /// snippet(cx, expr.span, "..")
528 pub fn snippet<'a, T: LintContext>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
529 snippet_opt(cx, span).map_or_else(|| Cow::Borrowed(default), From::from)
532 /// Same as `snippet`, but it adapts the applicability level by following rules:
534 /// - Applicability level `Unspecified` will never be changed.
535 /// - If the span is inside a macro, change the applicability level to `MaybeIncorrect`.
536 /// - If the default value is used and the applicability level is `MachineApplicable`, change it to
537 /// `HasPlaceholders`
538 pub fn snippet_with_applicability<'a, T: LintContext>(
542 applicability: &mut Applicability,
544 if *applicability != Applicability::Unspecified && span.from_expansion() {
545 *applicability = Applicability::MaybeIncorrect;
547 snippet_opt(cx, span).map_or_else(
549 if *applicability == Applicability::MachineApplicable {
550 *applicability = Applicability::HasPlaceholders;
552 Cow::Borrowed(default)
558 /// Same as `snippet`, but should only be used when it's clear that the input span is
559 /// not a macro argument.
560 pub fn snippet_with_macro_callsite<'a, T: LintContext>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
561 snippet(cx, span.source_callsite(), default)
564 /// Converts a span to a code snippet. Returns `None` if not available.
565 pub fn snippet_opt<T: LintContext>(cx: &T, span: Span) -> Option<String> {
566 cx.sess().source_map().span_to_snippet(span).ok()
569 /// Converts a span (from a block) to a code snippet if available, otherwise use default.
571 /// This trims the code of indentation, except for the first line. Use it for blocks or block-like
572 /// things which need to be printed as such.
574 /// The `indent_relative_to` arg can be used, to provide a span, where the indentation of the
575 /// resulting snippet of the given span.
580 /// snippet_block(cx, block.span, "..", None)
581 /// // where, `block` is the block of the if expr
585 /// // will return the snippet
592 /// snippet_block(cx, block.span, "..", Some(if_expr.span))
593 /// // where, `block` is the block of the if expr
597 /// // will return the snippet
600 /// } // aligned with `if`
602 /// Note that the first line of the snippet always has 0 indentation.
603 pub fn snippet_block<'a, T: LintContext>(
607 indent_relative_to: Option<Span>,
609 let snip = snippet(cx, span, default);
610 let indent = indent_relative_to.and_then(|s| indent_of(cx, s));
611 reindent_multiline(snip, true, indent)
614 /// Same as `snippet_block`, but adapts the applicability level by the rules of
615 /// `snippet_with_applicability`.
616 pub fn snippet_block_with_applicability<'a, T: LintContext>(
620 indent_relative_to: Option<Span>,
621 applicability: &mut Applicability,
623 let snip = snippet_with_applicability(cx, span, default, applicability);
624 let indent = indent_relative_to.and_then(|s| indent_of(cx, s));
625 reindent_multiline(snip, true, indent)
628 /// Returns a new Span that extends the original Span to the first non-whitespace char of the first
634 /// // will be converted to
638 pub fn first_line_of_span<T: LintContext>(cx: &T, span: Span) -> Span {
639 first_char_in_first_line(cx, span).map_or(span, |first_char_pos| span.with_lo(first_char_pos))
642 fn first_char_in_first_line<T: LintContext>(cx: &T, span: Span) -> Option<BytePos> {
643 let line_span = line_span(cx, span);
644 snippet_opt(cx, line_span).and_then(|snip| {
645 snip.find(|c: char| !c.is_whitespace())
646 .map(|pos| line_span.lo() + BytePos::from_usize(pos))
650 /// Returns the indentation of the line of a span
654 /// // ^^ -- will return 0
656 /// // ^^ -- will return 4
658 pub fn indent_of<T: LintContext>(cx: &T, span: Span) -> Option<usize> {
659 snippet_opt(cx, line_span(cx, span)).and_then(|snip| snip.find(|c: char| !c.is_whitespace()))
662 /// Extends the span to the beginning of the spans line, incl. whitespaces.
667 /// // will be converted to
669 /// // ^^^^^^^^^^^^^^
671 fn line_span<T: LintContext>(cx: &T, span: Span) -> Span {
672 let span = original_sp(span, DUMMY_SP);
673 let source_map_and_line = cx.sess().source_map().lookup_line(span.lo()).unwrap();
674 let line_no = source_map_and_line.line;
675 let line_start = source_map_and_line.sf.lines[line_no];
676 Span::new(line_start, span.hi(), span.ctxt())
679 /// Like `snippet_block`, but add braces if the expr is not an `ExprKind::Block`.
680 /// Also takes an `Option<String>` which can be put inside the braces.
681 pub fn expr_block<'a, T: LintContext>(
684 option: Option<String>,
686 indent_relative_to: Option<Span>,
688 let code = snippet_block(cx, expr.span, default, indent_relative_to);
689 let string = option.unwrap_or_default();
690 if expr.span.from_expansion() {
691 Cow::Owned(format!("{{ {} }}", snippet_with_macro_callsite(cx, expr.span, default)))
692 } else if let ExprKind::Block(_, _) = expr.kind {
693 Cow::Owned(format!("{}{}", code, string))
694 } else if string.is_empty() {
695 Cow::Owned(format!("{{ {} }}", code))
697 Cow::Owned(format!("{{\n{};\n{}\n}}", code, string))
701 /// Reindent a multiline string with possibility of ignoring the first line.
702 #[allow(clippy::needless_pass_by_value)]
703 pub fn reindent_multiline(s: Cow<'_, str>, ignore_first: bool, indent: Option<usize>) -> Cow<'_, str> {
704 let s_space = reindent_multiline_inner(&s, ignore_first, indent, ' ');
705 let s_tab = reindent_multiline_inner(&s_space, ignore_first, indent, '\t');
706 reindent_multiline_inner(&s_tab, ignore_first, indent, ' ').into()
709 fn reindent_multiline_inner(s: &str, ignore_first: bool, indent: Option<usize>, ch: char) -> String {
712 .skip(ignore_first as usize)
717 // ignore empty lines
718 Some(l.char_indices().find(|&(_, x)| x != ch).unwrap_or((l.len(), ch)).0)
723 let indent = indent.unwrap_or(0);
727 if (ignore_first && i == 0) || l.is_empty() {
729 } else if x > indent {
730 l.split_at(x - indent).1.to_owned()
732 " ".repeat(indent - x) + l
735 .collect::<Vec<String>>()
739 /// Gets the parent expression, if any –- this is useful to constrain a lint.
740 pub fn get_parent_expr<'tcx>(cx: &LateContext<'tcx>, e: &Expr<'_>) -> Option<&'tcx Expr<'tcx>> {
741 let map = &cx.tcx.hir();
742 let hir_id = e.hir_id;
743 let parent_id = map.get_parent_node(hir_id);
744 if hir_id == parent_id {
747 map.find(parent_id).and_then(|node| {
748 if let Node::Expr(parent) = node {
756 pub fn get_enclosing_block<'tcx>(cx: &LateContext<'tcx>, hir_id: HirId) -> Option<&'tcx Block<'tcx>> {
757 let map = &cx.tcx.hir();
758 let enclosing_node = map
759 .get_enclosing_scope(hir_id)
760 .and_then(|enclosing_id| map.find(enclosing_id));
761 enclosing_node.and_then(|node| match node {
762 Node::Block(block) => Some(block),
764 kind: ItemKind::Fn(_, _, eid),
767 | Node::ImplItem(&ImplItem {
768 kind: ImplItemKind::Fn(_, eid),
770 }) => match cx.tcx.hir().body(eid).value.kind {
771 ExprKind::Block(ref block, _) => Some(block),
778 /// Returns the base type for HIR references and pointers.
779 pub fn walk_ptrs_hir_ty<'tcx>(ty: &'tcx hir::Ty<'tcx>) -> &'tcx hir::Ty<'tcx> {
781 TyKind::Ptr(ref mut_ty) | TyKind::Rptr(_, ref mut_ty) => walk_ptrs_hir_ty(&mut_ty.ty),
786 /// Returns the base type for references and raw pointers, and count reference
788 pub fn walk_ptrs_ty_depth(ty: Ty<'_>) -> (Ty<'_>, usize) {
789 fn inner(ty: Ty<'_>, depth: usize) -> (Ty<'_>, usize) {
791 ty::Ref(_, ty, _) => inner(ty, depth + 1),
798 /// Checks whether the given expression is a constant integer of the given value.
799 /// unlike `is_integer_literal`, this version does const folding
800 pub fn is_integer_const(cx: &LateContext<'_>, e: &Expr<'_>, value: u128) -> bool {
801 if is_integer_literal(e, value) {
804 let map = cx.tcx.hir();
805 let parent_item = map.get_parent_item(e.hir_id);
806 if let Some((Constant::Int(v), _)) = map
807 .maybe_body_owned_by(parent_item)
808 .and_then(|body_id| constant(cx, cx.tcx.typeck_body(body_id), e))
816 /// Checks whether the given expression is a constant literal of the given value.
817 pub fn is_integer_literal(expr: &Expr<'_>, value: u128) -> bool {
818 // FIXME: use constant folding
819 if let ExprKind::Lit(ref spanned) = expr.kind {
820 if let LitKind::Int(v, _) = spanned.node {
827 /// Returns `true` if the given `Expr` has been coerced before.
829 /// Examples of coercions can be found in the Nomicon at
830 /// <https://doc.rust-lang.org/nomicon/coercions.html>.
832 /// See `rustc_middle::ty::adjustment::Adjustment` and `rustc_typeck::check::coercion` for more
833 /// information on adjustments and coercions.
834 pub fn is_adjusted(cx: &LateContext<'_>, e: &Expr<'_>) -> bool {
835 cx.typeck_results().adjustments().get(e.hir_id).is_some()
838 /// Returns the pre-expansion span if is this comes from an expansion of the
840 /// See also `is_direct_expn_of`.
842 pub fn is_expn_of(mut span: Span, name: &str) -> Option<Span> {
844 if span.from_expansion() {
845 let data = span.ctxt().outer_expn_data();
846 let new_span = data.call_site;
848 if let ExpnKind::Macro(MacroKind::Bang, mac_name) = data.kind {
849 if mac_name.as_str() == name {
850 return Some(new_span);
861 /// Returns the pre-expansion span if the span directly comes from an expansion
862 /// of the macro `name`.
863 /// The difference with `is_expn_of` is that in
867 /// `42` is considered expanded from `foo!` and `bar!` by `is_expn_of` but only
869 /// `is_direct_expn_of`.
871 pub fn is_direct_expn_of(span: Span, name: &str) -> Option<Span> {
872 if span.from_expansion() {
873 let data = span.ctxt().outer_expn_data();
874 let new_span = data.call_site;
876 if let ExpnKind::Macro(MacroKind::Bang, mac_name) = data.kind {
877 if mac_name.as_str() == name {
878 return Some(new_span);
886 /// Convenience function to get the return type of a function.
887 pub fn return_ty<'tcx>(cx: &LateContext<'tcx>, fn_item: hir::HirId) -> Ty<'tcx> {
888 let fn_def_id = cx.tcx.hir().local_def_id(fn_item);
889 let ret_ty = cx.tcx.fn_sig(fn_def_id).output();
890 cx.tcx.erase_late_bound_regions(ret_ty)
893 /// Walks into `ty` and returns `true` if any inner type is the same as `other_ty`
894 pub fn contains_ty(ty: Ty<'_>, other_ty: Ty<'_>) -> bool {
895 ty.walk().any(|inner| match inner.unpack() {
896 GenericArgKind::Type(inner_ty) => ty::TyS::same_type(other_ty, inner_ty),
897 GenericArgKind::Lifetime(_) | GenericArgKind::Const(_) => false,
901 /// Returns `true` if the given type is an `unsafe` function.
902 pub fn type_is_unsafe_function<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
904 ty::FnDef(..) | ty::FnPtr(_) => ty.fn_sig(cx.tcx).unsafety() == Unsafety::Unsafe,
909 pub fn is_copy<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
910 ty.is_copy_modulo_regions(cx.tcx.at(DUMMY_SP), cx.param_env)
913 /// Checks if an expression is constructing a tuple-like enum variant or struct
914 pub fn is_ctor_or_promotable_const_function(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
915 if let ExprKind::Call(ref fun, _) = expr.kind {
916 if let ExprKind::Path(ref qp) = fun.kind {
917 let res = cx.qpath_res(qp, fun.hir_id);
919 def::Res::Def(DefKind::Variant | DefKind::Ctor(..), ..) => true,
920 def::Res::Def(_, def_id) => cx.tcx.is_promotable_const_fn(def_id),
928 /// Returns `true` if a pattern is refutable.
929 // TODO: should be implemented using rustc/mir_build/thir machinery
930 pub fn is_refutable(cx: &LateContext<'_>, pat: &Pat<'_>) -> bool {
931 fn is_enum_variant(cx: &LateContext<'_>, qpath: &QPath<'_>, id: HirId) -> bool {
933 cx.qpath_res(qpath, id),
934 def::Res::Def(DefKind::Variant, ..) | Res::Def(DefKind::Ctor(def::CtorOf::Variant, _), _)
938 fn are_refutable<'a, I: Iterator<Item = &'a Pat<'a>>>(cx: &LateContext<'_>, mut i: I) -> bool {
939 i.any(|pat| is_refutable(cx, pat))
943 PatKind::Wild => false,
944 PatKind::Binding(_, _, _, pat) => pat.map_or(false, |pat| is_refutable(cx, pat)),
945 PatKind::Box(ref pat) | PatKind::Ref(ref pat, _) => is_refutable(cx, pat),
946 PatKind::Lit(..) | PatKind::Range(..) => true,
947 PatKind::Path(ref qpath) => is_enum_variant(cx, qpath, pat.hir_id),
948 PatKind::Or(ref pats) => {
949 // TODO: should be the honest check, that pats is exhaustive set
950 are_refutable(cx, pats.iter().map(|pat| &**pat))
952 PatKind::Tuple(ref pats, _) => are_refutable(cx, pats.iter().map(|pat| &**pat)),
953 PatKind::Struct(ref qpath, ref fields, _) => {
954 is_enum_variant(cx, qpath, pat.hir_id) || are_refutable(cx, fields.iter().map(|field| &*field.pat))
956 PatKind::TupleStruct(ref qpath, ref pats, _) => {
957 is_enum_variant(cx, qpath, pat.hir_id) || are_refutable(cx, pats.iter().map(|pat| &**pat))
959 PatKind::Slice(ref head, ref middle, ref tail) => {
960 match &cx.typeck_results().node_type(pat.hir_id).kind() {
962 // [..] is the only irrefutable slice pattern.
963 !head.is_empty() || middle.is_none() || !tail.is_empty()
965 ty::Array(..) => are_refutable(cx, head.iter().chain(middle).chain(tail.iter()).map(|pat| &**pat)),
975 /// Checks for the `#[automatically_derived]` attribute all `#[derive]`d
976 /// implementations have.
977 pub fn is_automatically_derived(attrs: &[ast::Attribute]) -> bool {
978 attrs.iter().any(|attr| attr.has_name(rustc_sym::automatically_derived))
981 /// Remove blocks around an expression.
983 /// Ie. `x`, `{ x }` and `{{{{ x }}}}` all give `x`. `{ x; y }` and `{}` return
985 pub fn remove_blocks<'tcx>(mut expr: &'tcx Expr<'tcx>) -> &'tcx Expr<'tcx> {
986 while let ExprKind::Block(ref block, ..) = expr.kind {
987 match (block.stmts.is_empty(), block.expr.as_ref()) {
988 (true, Some(e)) => expr = e,
995 pub fn is_self(slf: &Param<'_>) -> bool {
996 if let PatKind::Binding(.., name, _) = slf.pat.kind {
997 name.name == kw::SelfLower
1003 pub fn is_self_ty(slf: &hir::Ty<'_>) -> bool {
1005 if let TyKind::Path(ref qp) = slf.kind;
1006 if let QPath::Resolved(None, ref path) = *qp;
1007 if let Res::SelfTy(..) = path.res;
1015 pub fn iter_input_pats<'tcx>(decl: &FnDecl<'_>, body: &'tcx Body<'_>) -> impl Iterator<Item = &'tcx Param<'tcx>> {
1016 (0..decl.inputs.len()).map(move |i| &body.params[i])
1019 /// Checks if a given expression is a match expression expanded from the `?`
1020 /// operator or the `try` macro.
1021 pub fn is_try<'tcx>(expr: &'tcx Expr<'tcx>) -> Option<&'tcx Expr<'tcx>> {
1022 fn is_ok(arm: &Arm<'_>) -> bool {
1024 if let PatKind::TupleStruct(ref path, ref pat, None) = arm.pat.kind;
1025 if match_qpath(path, &paths::RESULT_OK[1..]);
1026 if let PatKind::Binding(_, hir_id, _, None) = pat[0].kind;
1027 if let ExprKind::Path(QPath::Resolved(None, ref path)) = arm.body.kind;
1028 if let Res::Local(lid) = path.res;
1037 fn is_err(arm: &Arm<'_>) -> bool {
1038 if let PatKind::TupleStruct(ref path, _, _) = arm.pat.kind {
1039 match_qpath(path, &paths::RESULT_ERR[1..])
1045 if let ExprKind::Match(_, ref arms, ref source) = expr.kind {
1046 // desugared from a `?` operator
1047 if let MatchSource::TryDesugar = *source {
1053 if arms[0].guard.is_none();
1054 if arms[1].guard.is_none();
1055 if (is_ok(&arms[0]) && is_err(&arms[1])) ||
1056 (is_ok(&arms[1]) && is_err(&arms[0]));
1066 /// Returns `true` if the lint is allowed in the current context
1068 /// Useful for skipping long running code when it's unnecessary
1069 pub fn is_allowed(cx: &LateContext<'_>, lint: &'static Lint, id: HirId) -> bool {
1070 cx.tcx.lint_level_at_node(lint, id).0 == Level::Allow
1073 pub fn get_arg_name(pat: &Pat<'_>) -> Option<Symbol> {
1075 PatKind::Binding(.., ident, None) => Some(ident.name),
1076 PatKind::Ref(ref subpat, _) => get_arg_name(subpat),
1081 pub fn int_bits(tcx: TyCtxt<'_>, ity: ast::IntTy) -> u64 {
1082 Integer::from_attr(&tcx, attr::IntType::SignedInt(ity)).size().bits()
1085 #[allow(clippy::cast_possible_wrap)]
1086 /// Turn a constant int byte representation into an i128
1087 pub fn sext(tcx: TyCtxt<'_>, u: u128, ity: ast::IntTy) -> i128 {
1088 let amt = 128 - int_bits(tcx, ity);
1089 ((u as i128) << amt) >> amt
1092 #[allow(clippy::cast_sign_loss)]
1093 /// clip unused bytes
1094 pub fn unsext(tcx: TyCtxt<'_>, u: i128, ity: ast::IntTy) -> u128 {
1095 let amt = 128 - int_bits(tcx, ity);
1096 ((u as u128) << amt) >> amt
1099 /// clip unused bytes
1100 pub fn clip(tcx: TyCtxt<'_>, u: u128, ity: ast::UintTy) -> u128 {
1101 let bits = Integer::from_attr(&tcx, attr::IntType::UnsignedInt(ity)).size().bits();
1102 let amt = 128 - bits;
1106 /// Removes block comments from the given `Vec` of lines.
1111 /// without_block_comments(vec!["/*", "foo", "*/"]);
1114 /// without_block_comments(vec!["bar", "/*", "foo", "*/"]);
1115 /// // => vec!["bar"]
1117 pub fn without_block_comments(lines: Vec<&str>) -> Vec<&str> {
1118 let mut without = vec![];
1120 let mut nest_level = 0;
1123 if line.contains("/*") {
1126 } else if line.contains("*/") {
1131 if nest_level == 0 {
1139 pub fn any_parent_is_automatically_derived(tcx: TyCtxt<'_>, node: HirId) -> bool {
1140 let map = &tcx.hir();
1141 let mut prev_enclosing_node = None;
1142 let mut enclosing_node = node;
1143 while Some(enclosing_node) != prev_enclosing_node {
1144 if is_automatically_derived(map.attrs(enclosing_node)) {
1147 prev_enclosing_node = Some(enclosing_node);
1148 enclosing_node = map.get_parent_item(enclosing_node);
1153 /// Returns true if ty has `iter` or `iter_mut` methods
1154 pub fn has_iter_method(cx: &LateContext<'_>, probably_ref_ty: Ty<'_>) -> Option<&'static str> {
1155 // FIXME: instead of this hard-coded list, we should check if `<adt>::iter`
1156 // exists and has the desired signature. Unfortunately FnCtxt is not exported
1157 // so we can't use its `lookup_method` method.
1158 let into_iter_collections: [&[&str]; 13] = [
1165 &paths::LINKED_LIST,
1166 &paths::BINARY_HEAP,
1174 let ty_to_check = match probably_ref_ty.kind() {
1175 ty::Ref(_, ty_to_check, _) => ty_to_check,
1176 _ => probably_ref_ty,
1179 let def_id = match ty_to_check.kind() {
1180 ty::Array(..) => return Some("array"),
1181 ty::Slice(..) => return Some("slice"),
1182 ty::Adt(adt, _) => adt.did,
1186 for path in &into_iter_collections {
1187 if match_def_path(cx, def_id, path) {
1188 return Some(*path.last().unwrap());
1194 /// Matches a function call with the given path and returns the arguments.
1199 /// if let Some(args) = match_function_call(cx, begin_panic_call, &paths::BEGIN_PANIC);
1201 pub fn match_function_call<'tcx>(
1202 cx: &LateContext<'tcx>,
1203 expr: &'tcx Expr<'_>,
1205 ) -> Option<&'tcx [Expr<'tcx>]> {
1207 if let ExprKind::Call(ref fun, ref args) = expr.kind;
1208 if let ExprKind::Path(ref qpath) = fun.kind;
1209 if let Some(fun_def_id) = cx.qpath_res(qpath, fun.hir_id).opt_def_id();
1210 if match_def_path(cx, fun_def_id, path);
1218 /// Checks if `Ty` is normalizable. This function is useful
1219 /// to avoid crashes on `layout_of`.
1220 pub fn is_normalizable<'tcx>(cx: &LateContext<'tcx>, param_env: ty::ParamEnv<'tcx>, ty: Ty<'tcx>) -> bool {
1221 cx.tcx.infer_ctxt().enter(|infcx| {
1222 let cause = rustc_middle::traits::ObligationCause::dummy();
1223 infcx.at(&cause, param_env).normalize(ty).is_ok()
1227 pub fn match_def_path<'tcx>(cx: &LateContext<'tcx>, did: DefId, syms: &[&str]) -> bool {
1228 // We have to convert `syms` to `&[Symbol]` here because rustc's `match_def_path`
1229 // accepts only that. We should probably move to Symbols in Clippy as well.
1230 let syms = syms.iter().map(|p| Symbol::intern(p)).collect::<Vec<Symbol>>();
1231 cx.match_def_path(did, &syms)
1234 /// Returns the list of condition expressions and the list of blocks in a
1235 /// sequence of `if/else`.
1236 /// E.g., this returns `([a, b], [c, d, e])` for the expression
1237 /// `if a { c } else if b { d } else { e }`.
1238 pub fn if_sequence<'tcx>(
1239 mut expr: &'tcx Expr<'tcx>,
1240 ) -> (SmallVec<[&'tcx Expr<'tcx>; 1]>, SmallVec<[&'tcx Block<'tcx>; 1]>) {
1241 let mut conds = SmallVec::new();
1242 let mut blocks: SmallVec<[&Block<'_>; 1]> = SmallVec::new();
1244 while let Some((ref cond, ref then_expr, ref else_expr)) = higher::if_block(&expr) {
1245 conds.push(&**cond);
1246 if let ExprKind::Block(ref block, _) = then_expr.kind {
1249 panic!("ExprKind::If node is not an ExprKind::Block");
1252 if let Some(ref else_expr) = *else_expr {
1259 // final `else {..}`
1260 if !blocks.is_empty() {
1261 if let ExprKind::Block(ref block, _) = expr.kind {
1262 blocks.push(&**block);
1269 pub fn parent_node_is_if_expr(expr: &Expr<'_>, cx: &LateContext<'_>) -> bool {
1270 let map = cx.tcx.hir();
1271 let parent_id = map.get_parent_node(expr.hir_id);
1272 let parent_node = map.get(parent_id);
1275 Node::Expr(e) => higher::if_block(&e).is_some(),
1276 Node::Arm(e) => higher::if_block(&e.body).is_some(),
1281 // Finds the attribute with the given name, if any
1282 pub fn attr_by_name<'a>(attrs: &'a [Attribute], name: &'_ str) -> Option<&'a Attribute> {
1285 .find(|attr| attr.ident().map_or(false, |ident| ident.as_str() == name))
1288 // Finds the `#[must_use]` attribute, if any
1289 pub fn must_use_attr(attrs: &[Attribute]) -> Option<&Attribute> {
1290 attr_by_name(attrs, "must_use")
1293 // Returns whether the type has #[must_use] attribute
1294 pub fn is_must_use_ty<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
1296 ty::Adt(ref adt, _) => must_use_attr(&cx.tcx.get_attrs(adt.did)).is_some(),
1297 ty::Foreign(ref did) => must_use_attr(&cx.tcx.get_attrs(*did)).is_some(),
1299 | ty::Array(ref ty, _)
1300 | ty::RawPtr(ty::TypeAndMut { ref ty, .. })
1301 | ty::Ref(_, ref ty, _) => {
1302 // for the Array case we don't need to care for the len == 0 case
1303 // because we don't want to lint functions returning empty arrays
1304 is_must_use_ty(cx, *ty)
1306 ty::Tuple(ref substs) => substs.types().any(|ty| is_must_use_ty(cx, ty)),
1307 ty::Opaque(ref def_id, _) => {
1308 for (predicate, _) in cx.tcx.explicit_item_bounds(*def_id) {
1309 if let ty::PredicateAtom::Trait(trait_predicate, _) = predicate.skip_binders() {
1310 if must_use_attr(&cx.tcx.get_attrs(trait_predicate.trait_ref.def_id)).is_some() {
1317 ty::Dynamic(binder, _) => {
1318 for predicate in binder.skip_binder().iter() {
1319 if let ty::ExistentialPredicate::Trait(ref trait_ref) = predicate {
1320 if must_use_attr(&cx.tcx.get_attrs(trait_ref.def_id)).is_some() {
1331 // check if expr is calling method or function with #[must_use] attribute
1332 pub fn is_must_use_func_call(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
1333 let did = match expr.kind {
1334 ExprKind::Call(ref path, _) => if_chain! {
1335 if let ExprKind::Path(ref qpath) = path.kind;
1336 if let def::Res::Def(_, did) = cx.qpath_res(qpath, path.hir_id);
1343 ExprKind::MethodCall(_, _, _, _) => cx.typeck_results().type_dependent_def_id(expr.hir_id),
1347 did.map_or(false, |did| must_use_attr(&cx.tcx.get_attrs(did)).is_some())
1350 pub fn is_no_std_crate(krate: &Crate<'_>) -> bool {
1351 krate.item.attrs.iter().any(|attr| {
1352 if let ast::AttrKind::Normal(ref attr, _) = attr.kind {
1353 attr.path == symbol::sym::no_std
1360 /// Check if parent of a hir node is a trait implementation block.
1361 /// For example, `f` in
1363 /// impl Trait for S {
1367 pub fn is_trait_impl_item(cx: &LateContext<'_>, hir_id: HirId) -> bool {
1368 if let Some(Node::Item(item)) = cx.tcx.hir().find(cx.tcx.hir().get_parent_node(hir_id)) {
1369 matches!(item.kind, ItemKind::Impl{ of_trait: Some(_), .. })
1375 /// Check if it's even possible to satisfy the `where` clause for the item.
1377 /// `trivial_bounds` feature allows functions with unsatisfiable bounds, for example:
1380 /// fn foo() where i32: Iterator {
1381 /// for _ in 2i32 {}
1384 pub fn fn_has_unsatisfiable_preds(cx: &LateContext<'_>, did: DefId) -> bool {
1385 use rustc_trait_selection::traits;
1391 .filter_map(|(p, _)| if p.is_global() { Some(*p) } else { None });
1392 traits::impossible_predicates(
1394 traits::elaborate_predicates(cx.tcx, predicates)
1395 .map(|o| o.predicate)
1396 .collect::<Vec<_>>(),
1400 /// Returns the `DefId` of the callee if the given expression is a function or method call.
1401 pub fn fn_def_id(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<DefId> {
1403 ExprKind::MethodCall(..) => cx.typeck_results().type_dependent_def_id(expr.hir_id),
1406 kind: ExprKind::Path(qpath),
1410 ) => cx.typeck_results().qpath_res(qpath, expr.hir_id).opt_def_id(),
1415 pub fn run_lints(cx: &LateContext<'_>, lints: &[&'static Lint], id: HirId) -> bool {
1416 lints.iter().any(|lint| {
1418 cx.tcx.lint_level_at_node(lint, id),
1419 (Level::Forbid | Level::Deny | Level::Warn, _)
1424 /// Returns true iff the given type is a primitive (a bool or char, any integer or floating-point
1425 /// number type, a str, or an array, slice, or tuple of those types).
1426 pub fn is_recursively_primitive_type(ty: Ty<'_>) -> bool {
1428 ty::Bool | ty::Char | ty::Int(_) | ty::Uint(_) | ty::Float(_) | ty::Str => true,
1429 ty::Ref(_, inner, _) if *inner.kind() == ty::Str => true,
1430 ty::Array(inner_type, _) | ty::Slice(inner_type) => is_recursively_primitive_type(inner_type),
1431 ty::Tuple(inner_types) => inner_types.types().all(is_recursively_primitive_type),
1436 /// Returns Option<String> where String is a textual representation of the type encapsulated in the
1437 /// slice iff the given expression is a slice of primitives (as defined in the
1438 /// `is_recursively_primitive_type` function) and None otherwise.
1439 pub fn is_slice_of_primitives(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<String> {
1440 let expr_type = cx.typeck_results().expr_ty_adjusted(expr);
1441 let expr_kind = expr_type.kind();
1442 let is_primitive = match expr_kind {
1443 ty::Slice(element_type) => is_recursively_primitive_type(element_type),
1444 ty::Ref(_, inner_ty, _) if matches!(inner_ty.kind(), &ty::Slice(_)) => {
1445 if let ty::Slice(element_type) = inner_ty.kind() {
1446 is_recursively_primitive_type(element_type)
1455 // if we have wrappers like Array, Slice or Tuple, print these
1456 // and get the type enclosed in the slice ref
1457 match expr_type.peel_refs().walk().nth(1).unwrap().expect_ty().kind() {
1458 ty::Slice(..) => return Some("slice".into()),
1459 ty::Array(..) => return Some("array".into()),
1460 ty::Tuple(..) => return Some("tuple".into()),
1462 // is_recursively_primitive_type() should have taken care
1463 // of the rest and we can rely on the type that is found
1464 let refs_peeled = expr_type.peel_refs();
1465 return Some(refs_peeled.walk().last().unwrap().to_string());
1472 /// returns list of all pairs (a, b) from `exprs` such that `eq(a, b)`
1473 /// `hash` must be comformed with `eq`
1474 pub fn search_same<T, Hash, Eq>(exprs: &[T], hash: Hash, eq: Eq) -> Vec<(&T, &T)>
1476 Hash: Fn(&T) -> u64,
1477 Eq: Fn(&T, &T) -> bool,
1479 if exprs.len() == 2 && eq(&exprs[0], &exprs[1]) {
1480 return vec![(&exprs[0], &exprs[1])];
1483 let mut match_expr_list: Vec<(&T, &T)> = Vec::new();
1485 let mut map: FxHashMap<_, Vec<&_>> =
1486 FxHashMap::with_capacity_and_hasher(exprs.len(), BuildHasherDefault::default());
1489 match map.entry(hash(expr)) {
1490 Entry::Occupied(mut o) => {
1493 match_expr_list.push((o, expr));
1496 o.get_mut().push(expr);
1498 Entry::Vacant(v) => {
1499 v.insert(vec![expr]);
1508 macro_rules! unwrap_cargo_metadata {
1509 ($cx: ident, $lint: ident, $deps: expr) => {{
1510 let mut command = cargo_metadata::MetadataCommand::new();
1515 match command.exec() {
1516 Ok(metadata) => metadata,
1518 span_lint($cx, $lint, DUMMY_SP, &format!("could not read cargo metadata: {}", err));
1527 use super::{reindent_multiline, without_block_comments};
1530 fn test_reindent_multiline_single_line() {
1531 assert_eq!("", reindent_multiline("".into(), false, None));
1532 assert_eq!("...", reindent_multiline("...".into(), false, None));
1533 assert_eq!("...", reindent_multiline(" ...".into(), false, None));
1534 assert_eq!("...", reindent_multiline("\t...".into(), false, None));
1535 assert_eq!("...", reindent_multiline("\t\t...".into(), false, None));
1540 fn test_reindent_multiline_block() {
1546 }", reindent_multiline(" if x {
1550 }".into(), false, None));
1556 }", reindent_multiline(" if x {
1560 }".into(), false, None));
1565 fn test_reindent_multiline_empty_line() {
1572 }", reindent_multiline(" if x {
1577 }".into(), false, None));
1582 fn test_reindent_multiline_lines_deeper() {
1588 }", reindent_multiline("\
1593 }".into(), true, Some(8)));
1597 fn test_without_block_comments_lines_without_block_comments() {
1598 let result = without_block_comments(vec!["/*", "", "*/"]);
1599 println!("result: {:?}", result);
1600 assert!(result.is_empty());
1602 let result = without_block_comments(vec!["", "/*", "", "*/", "#[crate_type = \"lib\"]", "/*", "", "*/", ""]);
1603 assert_eq!(result, vec!["", "#[crate_type = \"lib\"]", ""]);
1605 let result = without_block_comments(vec!["/* rust", "", "*/"]);
1606 assert!(result.is_empty());
1608 let result = without_block_comments(vec!["/* one-line comment */"]);
1609 assert!(result.is_empty());
1611 let result = without_block_comments(vec!["/* nested", "/* multi-line", "comment", "*/", "test", "*/"]);
1612 assert!(result.is_empty());
1614 let result = without_block_comments(vec!["/* nested /* inline /* comment */ test */ */"]);
1615 assert!(result.is_empty());
1617 let result = without_block_comments(vec!["foo", "bar", "baz"]);
1618 assert_eq!(result, vec!["foo", "bar", "baz"]);