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::symbol::{self, kw, Symbol};
56 use rustc_span::{BytePos, Pos, Span, DUMMY_SP};
57 use rustc_target::abi::Integer;
58 use rustc_trait_selection::traits::query::normalize::AtExt;
59 use smallvec::SmallVec;
61 use crate::consts::{constant, Constant};
63 /// Returns `true` if the two spans come from differing expansions (i.e., one is
64 /// from a macro and one isn't).
66 pub fn differing_macro_contexts(lhs: Span, rhs: Span) -> bool {
67 rhs.ctxt() != lhs.ctxt()
70 /// Returns `true` if the given `NodeId` is inside a constant context
75 /// if in_constant(cx, expr.hir_id) {
79 pub fn in_constant(cx: &LateContext<'_>, id: HirId) -> bool {
80 let parent_id = cx.tcx.hir().get_parent_item(id);
81 match cx.tcx.hir().get(parent_id) {
83 kind: ItemKind::Const(..) | ItemKind::Static(..),
86 | Node::TraitItem(&TraitItem {
87 kind: TraitItemKind::Const(..),
90 | Node::ImplItem(&ImplItem {
91 kind: ImplItemKind::Const(..),
94 | Node::AnonConst(_) => true,
96 kind: ItemKind::Fn(ref sig, ..),
99 | Node::ImplItem(&ImplItem {
100 kind: ImplItemKind::Fn(ref sig, _),
102 }) => sig.header.constness == Constness::Const,
107 /// Returns `true` if this `span` was expanded by any macro.
109 pub fn in_macro(span: Span) -> bool {
110 if span.from_expansion() {
111 !matches!(span.ctxt().outer_expn_data().kind, ExpnKind::Desugaring(..))
117 // If the snippet is empty, it's an attribute that was inserted during macro
118 // expansion and we want to ignore those, because they could come from external
119 // sources that the user has no control over.
120 // For some reason these attributes don't have any expansion info on them, so
121 // we have to check it this way until there is a better way.
122 pub fn is_present_in_source<T: LintContext>(cx: &T, span: Span) -> bool {
123 if let Some(snippet) = snippet_opt(cx, span) {
124 if snippet.is_empty() {
131 /// Checks if given pattern is a wildcard (`_`)
132 pub fn is_wild<'tcx>(pat: &impl std::ops::Deref<Target = Pat<'tcx>>) -> bool {
133 matches!(pat.kind, PatKind::Wild)
136 /// Checks if type is struct, enum or union type with the given def path.
138 /// If the type is a diagnostic item, use `is_type_diagnostic_item` instead.
139 /// If you change the signature, remember to update the internal lint `MatchTypeOnDiagItem`
140 pub fn match_type(cx: &LateContext<'_>, ty: Ty<'_>, path: &[&str]) -> bool {
142 ty::Adt(adt, _) => match_def_path(cx, adt.did, path),
147 /// Checks if the type is equal to a diagnostic item
149 /// If you change the signature, remember to update the internal lint `MatchTypeOnDiagItem`
150 pub fn is_type_diagnostic_item(cx: &LateContext<'_>, ty: Ty<'_>, diag_item: Symbol) -> bool {
152 ty::Adt(adt, _) => cx.tcx.is_diagnostic_item(diag_item, adt.did),
157 /// Checks if the type is equal to a lang item
158 pub fn is_type_lang_item(cx: &LateContext<'_>, ty: Ty<'_>, lang_item: hir::LangItem) -> bool {
160 ty::Adt(adt, _) => cx.tcx.lang_items().require(lang_item).unwrap() == adt.did,
165 /// Checks if the method call given in `expr` belongs to the given trait.
166 pub fn match_trait_method(cx: &LateContext<'_>, expr: &Expr<'_>, path: &[&str]) -> bool {
167 let def_id = cx.typeck_results().type_dependent_def_id(expr.hir_id).unwrap();
168 let trt_id = cx.tcx.trait_of_item(def_id);
169 trt_id.map_or(false, |trt_id| match_def_path(cx, trt_id, path))
172 /// Checks if an expression references a variable of the given name.
173 pub fn match_var(expr: &Expr<'_>, var: Symbol) -> bool {
174 if let ExprKind::Path(QPath::Resolved(None, ref path)) = expr.kind {
175 if let [p] = path.segments {
176 return p.ident.name == var;
182 pub fn last_path_segment<'tcx>(path: &QPath<'tcx>) -> &'tcx PathSegment<'tcx> {
184 QPath::Resolved(_, ref path) => path.segments.last().expect("A path must have at least one segment"),
185 QPath::TypeRelative(_, ref seg) => seg,
186 QPath::LangItem(..) => panic!("last_path_segment: lang item has no path segments"),
190 pub fn single_segment_path<'tcx>(path: &QPath<'tcx>) -> Option<&'tcx PathSegment<'tcx>> {
192 QPath::Resolved(_, ref path) => path.segments.get(0),
193 QPath::TypeRelative(_, ref seg) => Some(seg),
194 QPath::LangItem(..) => None,
198 /// Matches a `QPath` against a slice of segment string literals.
200 /// There is also `match_path` if you are dealing with a `rustc_hir::Path` instead of a
201 /// `rustc_hir::QPath`.
205 /// match_qpath(path, &["std", "rt", "begin_unwind"])
207 pub fn match_qpath(path: &QPath<'_>, segments: &[&str]) -> bool {
209 QPath::Resolved(_, ref path) => match_path(path, segments),
210 QPath::TypeRelative(ref ty, ref segment) => match ty.kind {
211 TyKind::Path(ref inner_path) => {
212 if let [prefix @ .., end] = segments {
213 if match_qpath(inner_path, prefix) {
214 return segment.ident.name.as_str() == *end;
221 QPath::LangItem(..) => false,
225 /// Matches a `Path` against a slice of segment string literals.
227 /// There is also `match_qpath` if you are dealing with a `rustc_hir::QPath` instead of a
228 /// `rustc_hir::Path`.
233 /// if match_path(&trait_ref.path, &paths::HASH) {
234 /// // This is the `std::hash::Hash` trait.
237 /// if match_path(ty_path, &["rustc", "lint", "Lint"]) {
238 /// // This is a `rustc_middle::lint::Lint`.
241 pub fn match_path(path: &Path<'_>, segments: &[&str]) -> bool {
245 .zip(segments.iter().rev())
246 .all(|(a, b)| a.ident.name.as_str() == *b)
249 /// Matches a `Path` against a slice of segment string literals, e.g.
253 /// match_path_ast(path, &["std", "rt", "begin_unwind"])
255 pub fn match_path_ast(path: &ast::Path, segments: &[&str]) -> bool {
259 .zip(segments.iter().rev())
260 .all(|(a, b)| a.ident.name.as_str() == *b)
263 /// Gets the definition associated to a path.
264 pub fn path_to_res(cx: &LateContext<'_>, path: &[&str]) -> Option<def::Res> {
265 let crates = cx.tcx.crates();
268 .find(|&&krate| cx.tcx.crate_name(krate).as_str() == path[0]);
269 if let Some(krate) = krate {
272 index: CRATE_DEF_INDEX,
274 let mut current_item = None;
275 let mut items = cx.tcx.item_children(krate);
276 let mut path_it = path.iter().skip(1).peekable();
279 let segment = match path_it.next() {
280 Some(segment) => segment,
284 // `get_def_path` seems to generate these empty segments for extern blocks.
285 // We can just ignore them.
286 if segment.is_empty() {
290 let result = SmallVec::<[_; 8]>::new();
291 for item in mem::replace(&mut items, cx.tcx.arena.alloc_slice(&result)).iter() {
292 if item.ident.name.as_str() == *segment {
293 if path_it.peek().is_none() {
294 return Some(item.res);
297 current_item = Some(item);
298 items = cx.tcx.item_children(item.res.def_id());
303 // The segment isn't a child_item.
304 // Try to find it under an inherent impl.
306 if path_it.peek().is_none();
307 if let Some(current_item) = current_item;
308 let item_def_id = current_item.res.def_id();
309 if cx.tcx.def_kind(item_def_id) == DefKind::Struct;
311 // Bad `find_map` suggestion. See #4193.
312 #[allow(clippy::find_map)]
313 return cx.tcx.inherent_impls(item_def_id).iter()
314 .flat_map(|&impl_def_id| cx.tcx.item_children(impl_def_id))
315 .find(|item| item.ident.name.as_str() == *segment)
316 .map(|item| item.res);
325 pub fn qpath_res(cx: &LateContext<'_>, qpath: &hir::QPath<'_>, id: hir::HirId) -> Res {
327 hir::QPath::Resolved(_, path) => path.res,
328 hir::QPath::TypeRelative(..) | hir::QPath::LangItem(..) => {
329 if cx.tcx.has_typeck_results(id.owner.to_def_id()) {
330 cx.tcx.typeck(id.owner).qpath_res(qpath, id)
338 /// Convenience function to get the `DefId` of a trait by path.
339 /// It could be a trait or trait alias.
340 pub fn get_trait_def_id(cx: &LateContext<'_>, path: &[&str]) -> Option<DefId> {
341 let res = match path_to_res(cx, path) {
347 Res::Def(DefKind::Trait | DefKind::TraitAlias, trait_id) => Some(trait_id),
348 Res::Err => unreachable!("this trait resolution is impossible: {:?}", &path),
353 /// Checks whether a type implements a trait.
354 /// See also `get_trait_def_id`.
355 pub fn implements_trait<'tcx>(
356 cx: &LateContext<'tcx>,
359 ty_params: &[GenericArg<'tcx>],
361 // Do not check on infer_types to avoid panic in evaluate_obligation.
362 if ty.has_infer_types() {
365 let ty = cx.tcx.erase_regions(&ty);
366 let ty_params = cx.tcx.mk_substs(ty_params.iter());
367 cx.tcx.type_implements_trait((trait_id, ty, ty_params, cx.param_env))
370 /// Gets the `hir::TraitRef` of the trait the given method is implemented for.
372 /// Use this if you want to find the `TraitRef` of the `Add` trait in this example:
375 /// struct Point(isize, isize);
377 /// impl std::ops::Add for Point {
378 /// type Output = Self;
380 /// fn add(self, other: Self) -> Self {
385 pub fn trait_ref_of_method<'tcx>(cx: &LateContext<'tcx>, hir_id: HirId) -> Option<&'tcx TraitRef<'tcx>> {
386 // Get the implemented trait for the current function
387 let parent_impl = cx.tcx.hir().get_parent_item(hir_id);
389 if parent_impl != hir::CRATE_HIR_ID;
390 if let hir::Node::Item(item) = cx.tcx.hir().get(parent_impl);
391 if let hir::ItemKind::Impl{ of_trait: trait_ref, .. } = &item.kind;
392 then { return trait_ref.as_ref(); }
397 /// Checks whether this type implements `Drop`.
398 pub fn has_drop<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
399 match ty.ty_adt_def() {
400 Some(def) => def.has_dtor(cx.tcx),
405 /// Returns the method names and argument list of nested method call expressions that make up
406 /// `expr`. method/span lists are sorted with the most recent call first.
407 pub fn method_calls<'tcx>(
408 expr: &'tcx Expr<'tcx>,
410 ) -> (Vec<Symbol>, Vec<&'tcx [Expr<'tcx>]>, Vec<Span>) {
411 let mut method_names = Vec::with_capacity(max_depth);
412 let mut arg_lists = Vec::with_capacity(max_depth);
413 let mut spans = Vec::with_capacity(max_depth);
415 let mut current = expr;
416 for _ in 0..max_depth {
417 if let ExprKind::MethodCall(path, span, args, _) = ¤t.kind {
418 if args.iter().any(|e| e.span.from_expansion()) {
421 method_names.push(path.ident.name);
422 arg_lists.push(&**args);
430 (method_names, arg_lists, spans)
433 /// Matches an `Expr` against a chain of methods, and return the matched `Expr`s.
435 /// For example, if `expr` represents the `.baz()` in `foo.bar().baz()`,
436 /// `method_chain_args(expr, &["bar", "baz"])` will return a `Vec`
437 /// containing the `Expr`s for
438 /// `.bar()` and `.baz()`
439 pub fn method_chain_args<'a>(expr: &'a Expr<'_>, methods: &[&str]) -> Option<Vec<&'a [Expr<'a>]>> {
440 let mut current = expr;
441 let mut matched = Vec::with_capacity(methods.len());
442 for method_name in methods.iter().rev() {
443 // method chains are stored last -> first
444 if let ExprKind::MethodCall(ref path, _, ref args, _) = current.kind {
445 if path.ident.name.as_str() == *method_name {
446 if args.iter().any(|e| e.span.from_expansion()) {
449 matched.push(&**args); // build up `matched` backwards
450 current = &args[0] // go to parent expression
458 // Reverse `matched` so that it is in the same order as `methods`.
463 /// Returns `true` if the provided `def_id` is an entrypoint to a program.
464 pub fn is_entrypoint_fn(cx: &LateContext<'_>, def_id: DefId) -> bool {
466 .entry_fn(LOCAL_CRATE)
467 .map_or(false, |(entry_fn_def_id, _)| def_id == entry_fn_def_id.to_def_id())
470 /// Gets the name of the item the expression is in, if available.
471 pub fn get_item_name(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<Symbol> {
472 let parent_id = cx.tcx.hir().get_parent_item(expr.hir_id);
473 match cx.tcx.hir().find(parent_id) {
475 Node::Item(Item { ident, .. })
476 | Node::TraitItem(TraitItem { ident, .. })
477 | Node::ImplItem(ImplItem { ident, .. }),
478 ) => Some(ident.name),
483 /// Gets the name of a `Pat`, if any.
484 pub fn get_pat_name(pat: &Pat<'_>) -> Option<Symbol> {
486 PatKind::Binding(.., ref spname, _) => Some(spname.name),
487 PatKind::Path(ref qpath) => single_segment_path(qpath).map(|ps| ps.ident.name),
488 PatKind::Box(ref p) | PatKind::Ref(ref p, _) => get_pat_name(&*p),
493 struct ContainsName {
498 impl<'tcx> Visitor<'tcx> for ContainsName {
499 type Map = Map<'tcx>;
501 fn visit_name(&mut self, _: Span, name: Symbol) {
502 if self.name == name {
506 fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
507 NestedVisitorMap::None
511 /// Checks if an `Expr` contains a certain name.
512 pub fn contains_name(name: Symbol, expr: &Expr<'_>) -> bool {
513 let mut cn = ContainsName { name, result: false };
518 /// Converts a span to a code snippet if available, otherwise use default.
520 /// This is useful if you want to provide suggestions for your lint or more generally, if you want
521 /// to convert a given `Span` to a `str`.
525 /// snippet(cx, expr.span, "..")
527 pub fn snippet<'a, T: LintContext>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
528 snippet_opt(cx, span).map_or_else(|| Cow::Borrowed(default), From::from)
531 /// Same as `snippet`, but it adapts the applicability level by following rules:
533 /// - Applicability level `Unspecified` will never be changed.
534 /// - If the span is inside a macro, change the applicability level to `MaybeIncorrect`.
535 /// - If the default value is used and the applicability level is `MachineApplicable`, change it to
536 /// `HasPlaceholders`
537 pub fn snippet_with_applicability<'a, T: LintContext>(
541 applicability: &mut Applicability,
543 if *applicability != Applicability::Unspecified && span.from_expansion() {
544 *applicability = Applicability::MaybeIncorrect;
546 snippet_opt(cx, span).map_or_else(
548 if *applicability == Applicability::MachineApplicable {
549 *applicability = Applicability::HasPlaceholders;
551 Cow::Borrowed(default)
557 /// Same as `snippet`, but should only be used when it's clear that the input span is
558 /// not a macro argument.
559 pub fn snippet_with_macro_callsite<'a, T: LintContext>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
560 snippet(cx, span.source_callsite(), default)
563 /// Converts a span to a code snippet. Returns `None` if not available.
564 pub fn snippet_opt<T: LintContext>(cx: &T, span: Span) -> Option<String> {
565 cx.sess().source_map().span_to_snippet(span).ok()
568 /// Converts a span (from a block) to a code snippet if available, otherwise use default.
570 /// This trims the code of indentation, except for the first line. Use it for blocks or block-like
571 /// things which need to be printed as such.
573 /// The `indent_relative_to` arg can be used, to provide a span, where the indentation of the
574 /// resulting snippet of the given span.
579 /// snippet_block(cx, block.span, "..", None)
580 /// // where, `block` is the block of the if expr
584 /// // will return the snippet
591 /// snippet_block(cx, block.span, "..", Some(if_expr.span))
592 /// // where, `block` is the block of the if expr
596 /// // will return the snippet
599 /// } // aligned with `if`
601 /// Note that the first line of the snippet always has 0 indentation.
602 pub fn snippet_block<'a, T: LintContext>(
606 indent_relative_to: Option<Span>,
608 let snip = snippet(cx, span, default);
609 let indent = indent_relative_to.and_then(|s| indent_of(cx, s));
610 reindent_multiline(snip, true, indent)
613 /// Same as `snippet_block`, but adapts the applicability level by the rules of
614 /// `snippet_with_applicability`.
615 pub fn snippet_block_with_applicability<'a, T: LintContext>(
619 indent_relative_to: Option<Span>,
620 applicability: &mut Applicability,
622 let snip = snippet_with_applicability(cx, span, default, applicability);
623 let indent = indent_relative_to.and_then(|s| indent_of(cx, s));
624 reindent_multiline(snip, true, indent)
627 /// Returns a new Span that extends the original Span to the first non-whitespace char of the first
633 /// // will be converted to
637 pub fn first_line_of_span<T: LintContext>(cx: &T, span: Span) -> Span {
638 first_char_in_first_line(cx, span).map_or(span, |first_char_pos| span.with_lo(first_char_pos))
641 fn first_char_in_first_line<T: LintContext>(cx: &T, span: Span) -> Option<BytePos> {
642 let line_span = line_span(cx, span);
643 snippet_opt(cx, line_span).and_then(|snip| {
644 snip.find(|c: char| !c.is_whitespace())
645 .map(|pos| line_span.lo() + BytePos::from_usize(pos))
649 /// Returns the indentation of the line of a span
653 /// // ^^ -- will return 0
655 /// // ^^ -- will return 4
657 pub fn indent_of<T: LintContext>(cx: &T, span: Span) -> Option<usize> {
658 snippet_opt(cx, line_span(cx, span)).and_then(|snip| snip.find(|c: char| !c.is_whitespace()))
661 /// Extends the span to the beginning of the spans line, incl. whitespaces.
666 /// // will be converted to
668 /// // ^^^^^^^^^^^^^^
670 fn line_span<T: LintContext>(cx: &T, span: Span) -> Span {
671 let span = original_sp(span, DUMMY_SP);
672 let source_map_and_line = cx.sess().source_map().lookup_line(span.lo()).unwrap();
673 let line_no = source_map_and_line.line;
674 let line_start = source_map_and_line.sf.lines[line_no];
675 Span::new(line_start, span.hi(), span.ctxt())
678 /// Like `snippet_block`, but add braces if the expr is not an `ExprKind::Block`.
679 /// Also takes an `Option<String>` which can be put inside the braces.
680 pub fn expr_block<'a, T: LintContext>(
683 option: Option<String>,
685 indent_relative_to: Option<Span>,
687 let code = snippet_block(cx, expr.span, default, indent_relative_to);
688 let string = option.unwrap_or_default();
689 if expr.span.from_expansion() {
690 Cow::Owned(format!("{{ {} }}", snippet_with_macro_callsite(cx, expr.span, default)))
691 } else if let ExprKind::Block(_, _) = expr.kind {
692 Cow::Owned(format!("{}{}", code, string))
693 } else if string.is_empty() {
694 Cow::Owned(format!("{{ {} }}", code))
696 Cow::Owned(format!("{{\n{};\n{}\n}}", code, string))
700 /// Reindent a multiline string with possibility of ignoring the first line.
701 #[allow(clippy::needless_pass_by_value)]
702 pub fn reindent_multiline(s: Cow<'_, str>, ignore_first: bool, indent: Option<usize>) -> Cow<'_, str> {
703 let s_space = reindent_multiline_inner(&s, ignore_first, indent, ' ');
704 let s_tab = reindent_multiline_inner(&s_space, ignore_first, indent, '\t');
705 reindent_multiline_inner(&s_tab, ignore_first, indent, ' ').into()
708 fn reindent_multiline_inner(s: &str, ignore_first: bool, indent: Option<usize>, ch: char) -> String {
711 .skip(ignore_first as usize)
716 // ignore empty lines
717 Some(l.char_indices().find(|&(_, x)| x != ch).unwrap_or((l.len(), ch)).0)
722 let indent = indent.unwrap_or(0);
726 if (ignore_first && i == 0) || l.is_empty() {
728 } else if x > indent {
729 l.split_at(x - indent).1.to_owned()
731 " ".repeat(indent - x) + l
734 .collect::<Vec<String>>()
738 /// Gets the parent expression, if any –- this is useful to constrain a lint.
739 pub fn get_parent_expr<'tcx>(cx: &LateContext<'tcx>, e: &Expr<'_>) -> Option<&'tcx Expr<'tcx>> {
740 let map = &cx.tcx.hir();
741 let hir_id = e.hir_id;
742 let parent_id = map.get_parent_node(hir_id);
743 if hir_id == parent_id {
746 map.find(parent_id).and_then(|node| {
747 if let Node::Expr(parent) = node {
755 pub fn get_enclosing_block<'tcx>(cx: &LateContext<'tcx>, hir_id: HirId) -> Option<&'tcx Block<'tcx>> {
756 let map = &cx.tcx.hir();
757 let enclosing_node = map
758 .get_enclosing_scope(hir_id)
759 .and_then(|enclosing_id| map.find(enclosing_id));
760 enclosing_node.and_then(|node| match node {
761 Node::Block(block) => Some(block),
763 kind: ItemKind::Fn(_, _, eid),
766 | Node::ImplItem(&ImplItem {
767 kind: ImplItemKind::Fn(_, eid),
769 }) => match cx.tcx.hir().body(eid).value.kind {
770 ExprKind::Block(ref block, _) => Some(block),
777 /// Returns the base type for HIR references and pointers.
778 pub fn walk_ptrs_hir_ty<'tcx>(ty: &'tcx hir::Ty<'tcx>) -> &'tcx hir::Ty<'tcx> {
780 TyKind::Ptr(ref mut_ty) | TyKind::Rptr(_, ref mut_ty) => walk_ptrs_hir_ty(&mut_ty.ty),
785 /// Returns the base type for references and raw pointers, and count reference
787 pub fn walk_ptrs_ty_depth(ty: Ty<'_>) -> (Ty<'_>, usize) {
788 fn inner(ty: Ty<'_>, depth: usize) -> (Ty<'_>, usize) {
790 ty::Ref(_, ty, _) => inner(ty, depth + 1),
797 /// Checks whether the given expression is a constant integer of the given value.
798 /// unlike `is_integer_literal`, this version does const folding
799 pub fn is_integer_const(cx: &LateContext<'_>, e: &Expr<'_>, value: u128) -> bool {
800 if is_integer_literal(e, value) {
803 let map = cx.tcx.hir();
804 let parent_item = map.get_parent_item(e.hir_id);
805 if let Some((Constant::Int(v), _)) = map
806 .maybe_body_owned_by(parent_item)
807 .and_then(|body_id| constant(cx, cx.tcx.typeck_body(body_id), e))
815 /// Checks whether the given expression is a constant literal of the given value.
816 pub fn is_integer_literal(expr: &Expr<'_>, value: u128) -> bool {
817 // FIXME: use constant folding
818 if let ExprKind::Lit(ref spanned) = expr.kind {
819 if let LitKind::Int(v, _) = spanned.node {
826 /// Returns `true` if the given `Expr` has been coerced before.
828 /// Examples of coercions can be found in the Nomicon at
829 /// <https://doc.rust-lang.org/nomicon/coercions.html>.
831 /// See `rustc_middle::ty::adjustment::Adjustment` and `rustc_typeck::check::coercion` for more
832 /// information on adjustments and coercions.
833 pub fn is_adjusted(cx: &LateContext<'_>, e: &Expr<'_>) -> bool {
834 cx.typeck_results().adjustments().get(e.hir_id).is_some()
837 /// Returns the pre-expansion span if is this comes from an expansion of the
839 /// See also `is_direct_expn_of`.
841 pub fn is_expn_of(mut span: Span, name: &str) -> Option<Span> {
843 if span.from_expansion() {
844 let data = span.ctxt().outer_expn_data();
845 let new_span = data.call_site;
847 if let ExpnKind::Macro(MacroKind::Bang, mac_name) = data.kind {
848 if mac_name.as_str() == name {
849 return Some(new_span);
860 /// Returns the pre-expansion span if the span directly comes from an expansion
861 /// of the macro `name`.
862 /// The difference with `is_expn_of` is that in
866 /// `42` is considered expanded from `foo!` and `bar!` by `is_expn_of` but only
868 /// `is_direct_expn_of`.
870 pub fn is_direct_expn_of(span: Span, name: &str) -> Option<Span> {
871 if span.from_expansion() {
872 let data = span.ctxt().outer_expn_data();
873 let new_span = data.call_site;
875 if let ExpnKind::Macro(MacroKind::Bang, mac_name) = data.kind {
876 if mac_name.as_str() == name {
877 return Some(new_span);
885 /// Convenience function to get the return type of a function.
886 pub fn return_ty<'tcx>(cx: &LateContext<'tcx>, fn_item: hir::HirId) -> Ty<'tcx> {
887 let fn_def_id = cx.tcx.hir().local_def_id(fn_item);
888 let ret_ty = cx.tcx.fn_sig(fn_def_id).output();
889 cx.tcx.erase_late_bound_regions(&ret_ty)
892 /// Walks into `ty` and returns `true` if any inner type is the same as `other_ty`
893 pub fn contains_ty(ty: Ty<'_>, other_ty: Ty<'_>) -> bool {
894 ty.walk().any(|inner| match inner.unpack() {
895 GenericArgKind::Type(inner_ty) => ty::TyS::same_type(other_ty, inner_ty),
896 GenericArgKind::Lifetime(_) | GenericArgKind::Const(_) => false,
900 /// Returns `true` if the given type is an `unsafe` function.
901 pub fn type_is_unsafe_function<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
903 ty::FnDef(..) | ty::FnPtr(_) => ty.fn_sig(cx.tcx).unsafety() == Unsafety::Unsafe,
908 pub fn is_copy<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
909 ty.is_copy_modulo_regions(cx.tcx.at(DUMMY_SP), cx.param_env)
912 /// Checks if an expression is constructing a tuple-like enum variant or struct
913 pub fn is_ctor_or_promotable_const_function(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
914 if let ExprKind::Call(ref fun, _) = expr.kind {
915 if let ExprKind::Path(ref qp) = fun.kind {
916 let res = cx.qpath_res(qp, fun.hir_id);
918 def::Res::Def(DefKind::Variant | DefKind::Ctor(..), ..) => true,
919 def::Res::Def(_, def_id) => cx.tcx.is_promotable_const_fn(def_id),
927 /// Returns `true` if a pattern is refutable.
928 // TODO: should be implemented using rustc/mir_build/thir machinery
929 pub fn is_refutable(cx: &LateContext<'_>, pat: &Pat<'_>) -> bool {
930 fn is_enum_variant(cx: &LateContext<'_>, qpath: &QPath<'_>, id: HirId) -> bool {
932 cx.qpath_res(qpath, id),
933 def::Res::Def(DefKind::Variant, ..) | Res::Def(DefKind::Ctor(def::CtorOf::Variant, _), _)
937 fn are_refutable<'a, I: Iterator<Item = &'a Pat<'a>>>(cx: &LateContext<'_>, mut i: I) -> bool {
938 i.any(|pat| is_refutable(cx, pat))
942 PatKind::Wild => false,
943 PatKind::Binding(_, _, _, pat) => pat.map_or(false, |pat| is_refutable(cx, pat)),
944 PatKind::Box(ref pat) | PatKind::Ref(ref pat, _) => is_refutable(cx, pat),
945 PatKind::Lit(..) | PatKind::Range(..) => true,
946 PatKind::Path(ref qpath) => is_enum_variant(cx, qpath, pat.hir_id),
947 PatKind::Or(ref pats) => {
948 // TODO: should be the honest check, that pats is exhaustive set
949 are_refutable(cx, pats.iter().map(|pat| &**pat))
951 PatKind::Tuple(ref pats, _) => are_refutable(cx, pats.iter().map(|pat| &**pat)),
952 PatKind::Struct(ref qpath, ref fields, _) => {
953 is_enum_variant(cx, qpath, pat.hir_id) || are_refutable(cx, fields.iter().map(|field| &*field.pat))
955 PatKind::TupleStruct(ref qpath, ref pats, _) => {
956 is_enum_variant(cx, qpath, pat.hir_id) || are_refutable(cx, pats.iter().map(|pat| &**pat))
958 PatKind::Slice(ref head, ref middle, ref tail) => {
959 match &cx.typeck_results().node_type(pat.hir_id).kind() {
961 // [..] is the only irrefutable slice pattern.
962 !head.is_empty() || middle.is_none() || !tail.is_empty()
964 ty::Array(..) => are_refutable(cx, head.iter().chain(middle).chain(tail.iter()).map(|pat| &**pat)),
974 /// Checks for the `#[automatically_derived]` attribute all `#[derive]`d
975 /// implementations have.
976 pub fn is_automatically_derived(attrs: &[ast::Attribute]) -> bool {
977 attrs.iter().any(|attr| attr.has_name(sym!(automatically_derived)))
980 /// Remove blocks around an expression.
982 /// Ie. `x`, `{ x }` and `{{{{ x }}}}` all give `x`. `{ x; y }` and `{}` return
984 pub fn remove_blocks<'tcx>(mut expr: &'tcx Expr<'tcx>) -> &'tcx Expr<'tcx> {
985 while let ExprKind::Block(ref block, ..) = expr.kind {
986 match (block.stmts.is_empty(), block.expr.as_ref()) {
987 (true, Some(e)) => expr = e,
994 pub fn is_self(slf: &Param<'_>) -> bool {
995 if let PatKind::Binding(.., name, _) = slf.pat.kind {
996 name.name == kw::SelfLower
1002 pub fn is_self_ty(slf: &hir::Ty<'_>) -> bool {
1004 if let TyKind::Path(ref qp) = slf.kind;
1005 if let QPath::Resolved(None, ref path) = *qp;
1006 if let Res::SelfTy(..) = path.res;
1014 pub fn iter_input_pats<'tcx>(decl: &FnDecl<'_>, body: &'tcx Body<'_>) -> impl Iterator<Item = &'tcx Param<'tcx>> {
1015 (0..decl.inputs.len()).map(move |i| &body.params[i])
1018 /// Checks if a given expression is a match expression expanded from the `?`
1019 /// operator or the `try` macro.
1020 pub fn is_try<'tcx>(expr: &'tcx Expr<'tcx>) -> Option<&'tcx Expr<'tcx>> {
1021 fn is_ok(arm: &Arm<'_>) -> bool {
1023 if let PatKind::TupleStruct(ref path, ref pat, None) = arm.pat.kind;
1024 if match_qpath(path, &paths::RESULT_OK[1..]);
1025 if let PatKind::Binding(_, hir_id, _, None) = pat[0].kind;
1026 if let ExprKind::Path(QPath::Resolved(None, ref path)) = arm.body.kind;
1027 if let Res::Local(lid) = path.res;
1036 fn is_err(arm: &Arm<'_>) -> bool {
1037 if let PatKind::TupleStruct(ref path, _, _) = arm.pat.kind {
1038 match_qpath(path, &paths::RESULT_ERR[1..])
1044 if let ExprKind::Match(_, ref arms, ref source) = expr.kind {
1045 // desugared from a `?` operator
1046 if let MatchSource::TryDesugar = *source {
1052 if arms[0].guard.is_none();
1053 if arms[1].guard.is_none();
1054 if (is_ok(&arms[0]) && is_err(&arms[1])) ||
1055 (is_ok(&arms[1]) && is_err(&arms[0]));
1065 /// Returns `true` if the lint is allowed in the current context
1067 /// Useful for skipping long running code when it's unnecessary
1068 pub fn is_allowed(cx: &LateContext<'_>, lint: &'static Lint, id: HirId) -> bool {
1069 cx.tcx.lint_level_at_node(lint, id).0 == Level::Allow
1072 pub fn get_arg_name(pat: &Pat<'_>) -> Option<Symbol> {
1074 PatKind::Binding(.., ident, None) => Some(ident.name),
1075 PatKind::Ref(ref subpat, _) => get_arg_name(subpat),
1080 pub fn int_bits(tcx: TyCtxt<'_>, ity: ast::IntTy) -> u64 {
1081 Integer::from_attr(&tcx, attr::IntType::SignedInt(ity)).size().bits()
1084 #[allow(clippy::cast_possible_wrap)]
1085 /// Turn a constant int byte representation into an i128
1086 pub fn sext(tcx: TyCtxt<'_>, u: u128, ity: ast::IntTy) -> i128 {
1087 let amt = 128 - int_bits(tcx, ity);
1088 ((u as i128) << amt) >> amt
1091 #[allow(clippy::cast_sign_loss)]
1092 /// clip unused bytes
1093 pub fn unsext(tcx: TyCtxt<'_>, u: i128, ity: ast::IntTy) -> u128 {
1094 let amt = 128 - int_bits(tcx, ity);
1095 ((u as u128) << amt) >> amt
1098 /// clip unused bytes
1099 pub fn clip(tcx: TyCtxt<'_>, u: u128, ity: ast::UintTy) -> u128 {
1100 let bits = Integer::from_attr(&tcx, attr::IntType::UnsignedInt(ity)).size().bits();
1101 let amt = 128 - bits;
1105 /// Removes block comments from the given `Vec` of lines.
1110 /// without_block_comments(vec!["/*", "foo", "*/"]);
1113 /// without_block_comments(vec!["bar", "/*", "foo", "*/"]);
1114 /// // => vec!["bar"]
1116 pub fn without_block_comments(lines: Vec<&str>) -> Vec<&str> {
1117 let mut without = vec![];
1119 let mut nest_level = 0;
1122 if line.contains("/*") {
1125 } else if line.contains("*/") {
1130 if nest_level == 0 {
1138 pub fn any_parent_is_automatically_derived(tcx: TyCtxt<'_>, node: HirId) -> bool {
1139 let map = &tcx.hir();
1140 let mut prev_enclosing_node = None;
1141 let mut enclosing_node = node;
1142 while Some(enclosing_node) != prev_enclosing_node {
1143 if is_automatically_derived(map.attrs(enclosing_node)) {
1146 prev_enclosing_node = Some(enclosing_node);
1147 enclosing_node = map.get_parent_item(enclosing_node);
1152 /// Returns true if ty has `iter` or `iter_mut` methods
1153 pub fn has_iter_method(cx: &LateContext<'_>, probably_ref_ty: Ty<'_>) -> Option<&'static str> {
1154 // FIXME: instead of this hard-coded list, we should check if `<adt>::iter`
1155 // exists and has the desired signature. Unfortunately FnCtxt is not exported
1156 // so we can't use its `lookup_method` method.
1157 let into_iter_collections: [&[&str]; 13] = [
1164 &paths::LINKED_LIST,
1165 &paths::BINARY_HEAP,
1173 let ty_to_check = match probably_ref_ty.kind() {
1174 ty::Ref(_, ty_to_check, _) => ty_to_check,
1175 _ => probably_ref_ty,
1178 let def_id = match ty_to_check.kind() {
1179 ty::Array(..) => return Some("array"),
1180 ty::Slice(..) => return Some("slice"),
1181 ty::Adt(adt, _) => adt.did,
1185 for path in &into_iter_collections {
1186 if match_def_path(cx, def_id, path) {
1187 return Some(*path.last().unwrap());
1193 /// Matches a function call with the given path and returns the arguments.
1198 /// if let Some(args) = match_function_call(cx, begin_panic_call, &paths::BEGIN_PANIC);
1200 pub fn match_function_call<'tcx>(
1201 cx: &LateContext<'tcx>,
1202 expr: &'tcx Expr<'_>,
1204 ) -> Option<&'tcx [Expr<'tcx>]> {
1206 if let ExprKind::Call(ref fun, ref args) = expr.kind;
1207 if let ExprKind::Path(ref qpath) = fun.kind;
1208 if let Some(fun_def_id) = cx.qpath_res(qpath, fun.hir_id).opt_def_id();
1209 if match_def_path(cx, fun_def_id, path);
1217 /// Checks if `Ty` is normalizable. This function is useful
1218 /// to avoid crashes on `layout_of`.
1219 pub fn is_normalizable<'tcx>(cx: &LateContext<'tcx>, param_env: ty::ParamEnv<'tcx>, ty: Ty<'tcx>) -> bool {
1220 cx.tcx.infer_ctxt().enter(|infcx| {
1221 let cause = rustc_middle::traits::ObligationCause::dummy();
1222 infcx.at(&cause, param_env).normalize(&ty).is_ok()
1226 pub fn match_def_path<'tcx>(cx: &LateContext<'tcx>, did: DefId, syms: &[&str]) -> bool {
1227 // We have to convert `syms` to `&[Symbol]` here because rustc's `match_def_path`
1228 // accepts only that. We should probably move to Symbols in Clippy as well.
1229 let syms = syms.iter().map(|p| Symbol::intern(p)).collect::<Vec<Symbol>>();
1230 cx.match_def_path(did, &syms)
1233 /// Returns the list of condition expressions and the list of blocks in a
1234 /// sequence of `if/else`.
1235 /// E.g., this returns `([a, b], [c, d, e])` for the expression
1236 /// `if a { c } else if b { d } else { e }`.
1237 pub fn if_sequence<'tcx>(
1238 mut expr: &'tcx Expr<'tcx>,
1239 ) -> (SmallVec<[&'tcx Expr<'tcx>; 1]>, SmallVec<[&'tcx Block<'tcx>; 1]>) {
1240 let mut conds = SmallVec::new();
1241 let mut blocks: SmallVec<[&Block<'_>; 1]> = SmallVec::new();
1243 while let Some((ref cond, ref then_expr, ref else_expr)) = higher::if_block(&expr) {
1244 conds.push(&**cond);
1245 if let ExprKind::Block(ref block, _) = then_expr.kind {
1248 panic!("ExprKind::If node is not an ExprKind::Block");
1251 if let Some(ref else_expr) = *else_expr {
1258 // final `else {..}`
1259 if !blocks.is_empty() {
1260 if let ExprKind::Block(ref block, _) = expr.kind {
1261 blocks.push(&**block);
1268 pub fn parent_node_is_if_expr(expr: &Expr<'_>, cx: &LateContext<'_>) -> bool {
1269 let map = cx.tcx.hir();
1270 let parent_id = map.get_parent_node(expr.hir_id);
1271 let parent_node = map.get(parent_id);
1274 Node::Expr(e) => higher::if_block(&e).is_some(),
1275 Node::Arm(e) => higher::if_block(&e.body).is_some(),
1280 // Finds the attribute with the given name, if any
1281 pub fn attr_by_name<'a>(attrs: &'a [Attribute], name: &'_ str) -> Option<&'a Attribute> {
1284 .find(|attr| attr.ident().map_or(false, |ident| ident.as_str() == name))
1287 // Finds the `#[must_use]` attribute, if any
1288 pub fn must_use_attr(attrs: &[Attribute]) -> Option<&Attribute> {
1289 attr_by_name(attrs, "must_use")
1292 // Returns whether the type has #[must_use] attribute
1293 pub fn is_must_use_ty<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
1295 ty::Adt(ref adt, _) => must_use_attr(&cx.tcx.get_attrs(adt.did)).is_some(),
1296 ty::Foreign(ref did) => must_use_attr(&cx.tcx.get_attrs(*did)).is_some(),
1298 | ty::Array(ref ty, _)
1299 | ty::RawPtr(ty::TypeAndMut { ref ty, .. })
1300 | ty::Ref(_, ref ty, _) => {
1301 // for the Array case we don't need to care for the len == 0 case
1302 // because we don't want to lint functions returning empty arrays
1303 is_must_use_ty(cx, *ty)
1305 ty::Tuple(ref substs) => substs.types().any(|ty| is_must_use_ty(cx, ty)),
1306 ty::Opaque(ref def_id, _) => {
1307 for (predicate, _) in cx.tcx.explicit_item_bounds(*def_id) {
1308 if let ty::PredicateAtom::Trait(trait_predicate, _) = predicate.skip_binders() {
1309 if must_use_attr(&cx.tcx.get_attrs(trait_predicate.trait_ref.def_id)).is_some() {
1316 ty::Dynamic(binder, _) => {
1317 for predicate in binder.skip_binder().iter() {
1318 if let ty::ExistentialPredicate::Trait(ref trait_ref) = predicate {
1319 if must_use_attr(&cx.tcx.get_attrs(trait_ref.def_id)).is_some() {
1330 // check if expr is calling method or function with #[must_use] attribute
1331 pub fn is_must_use_func_call(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
1332 let did = match expr.kind {
1333 ExprKind::Call(ref path, _) => if_chain! {
1334 if let ExprKind::Path(ref qpath) = path.kind;
1335 if let def::Res::Def(_, did) = cx.qpath_res(qpath, path.hir_id);
1342 ExprKind::MethodCall(_, _, _, _) => cx.typeck_results().type_dependent_def_id(expr.hir_id),
1346 did.map_or(false, |did| must_use_attr(&cx.tcx.get_attrs(did)).is_some())
1349 pub fn is_no_std_crate(krate: &Crate<'_>) -> bool {
1350 krate.item.attrs.iter().any(|attr| {
1351 if let ast::AttrKind::Normal(ref attr) = attr.kind {
1352 attr.path == symbol::sym::no_std
1359 /// Check if parent of a hir node is a trait implementation block.
1360 /// For example, `f` in
1362 /// impl Trait for S {
1366 pub fn is_trait_impl_item(cx: &LateContext<'_>, hir_id: HirId) -> bool {
1367 if let Some(Node::Item(item)) = cx.tcx.hir().find(cx.tcx.hir().get_parent_node(hir_id)) {
1368 matches!(item.kind, ItemKind::Impl{ of_trait: Some(_), .. })
1374 /// Check if it's even possible to satisfy the `where` clause for the item.
1376 /// `trivial_bounds` feature allows functions with unsatisfiable bounds, for example:
1379 /// fn foo() where i32: Iterator {
1380 /// for _ in 2i32 {}
1383 pub fn fn_has_unsatisfiable_preds(cx: &LateContext<'_>, did: DefId) -> bool {
1384 use rustc_trait_selection::traits;
1390 .filter_map(|(p, _)| if p.is_global() { Some(*p) } else { None });
1391 traits::impossible_predicates(
1393 traits::elaborate_predicates(cx.tcx, predicates)
1394 .map(|o| o.predicate)
1395 .collect::<Vec<_>>(),
1399 /// Returns the `DefId` of the callee if the given expression is a function or method call.
1400 pub fn fn_def_id(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<DefId> {
1402 ExprKind::MethodCall(..) => cx.typeck_results().type_dependent_def_id(expr.hir_id),
1405 kind: ExprKind::Path(qpath),
1409 ) => cx.typeck_results().qpath_res(qpath, expr.hir_id).opt_def_id(),
1414 pub fn run_lints(cx: &LateContext<'_>, lints: &[&'static Lint], id: HirId) -> bool {
1415 lints.iter().any(|lint| {
1417 cx.tcx.lint_level_at_node(lint, id),
1418 (Level::Forbid | Level::Deny | Level::Warn, _)
1423 /// Returns true iff the given type is a primitive (a bool or char, any integer or floating-point
1424 /// number type, a str, or an array, slice, or tuple of those types).
1425 pub fn is_recursively_primitive_type(ty: Ty<'_>) -> bool {
1427 ty::Bool | ty::Char | ty::Int(_) | ty::Uint(_) | ty::Float(_) | ty::Str => true,
1428 ty::Ref(_, inner, _) if *inner.kind() == ty::Str => true,
1429 ty::Array(inner_type, _) | ty::Slice(inner_type) => is_recursively_primitive_type(inner_type),
1430 ty::Tuple(inner_types) => inner_types.types().all(is_recursively_primitive_type),
1435 /// Returns Option<String> where String is a textual representation of the type encapsulated in the
1436 /// slice iff the given expression is a slice of primitives (as defined in the
1437 /// `is_recursively_primitive_type` function) and None otherwise.
1438 pub fn is_slice_of_primitives(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<String> {
1439 let expr_type = cx.typeck_results().expr_ty_adjusted(expr);
1440 let expr_kind = expr_type.kind();
1441 let is_primitive = match expr_kind {
1442 ty::Slice(element_type) => is_recursively_primitive_type(element_type),
1443 ty::Ref(_, inner_ty, _) if matches!(inner_ty.kind(), &ty::Slice(_)) => {
1444 if let ty::Slice(element_type) = inner_ty.kind() {
1445 is_recursively_primitive_type(element_type)
1454 // if we have wrappers like Array, Slice or Tuple, print these
1455 // and get the type enclosed in the slice ref
1456 match expr_type.peel_refs().walk().nth(1).unwrap().expect_ty().kind() {
1457 ty::Slice(..) => return Some("slice".into()),
1458 ty::Array(..) => return Some("array".into()),
1459 ty::Tuple(..) => return Some("tuple".into()),
1461 // is_recursively_primitive_type() should have taken care
1462 // of the rest and we can rely on the type that is found
1463 let refs_peeled = expr_type.peel_refs();
1464 return Some(refs_peeled.walk().last().unwrap().to_string());
1471 /// returns list of all pairs (a, b) from `exprs` such that `eq(a, b)`
1472 /// `hash` must be comformed with `eq`
1473 pub fn search_same<T, Hash, Eq>(exprs: &[T], hash: Hash, eq: Eq) -> Vec<(&T, &T)>
1475 Hash: Fn(&T) -> u64,
1476 Eq: Fn(&T, &T) -> bool,
1478 if exprs.len() == 2 && eq(&exprs[0], &exprs[1]) {
1479 return vec![(&exprs[0], &exprs[1])];
1482 let mut match_expr_list: Vec<(&T, &T)> = Vec::new();
1484 let mut map: FxHashMap<_, Vec<&_>> =
1485 FxHashMap::with_capacity_and_hasher(exprs.len(), BuildHasherDefault::default());
1488 match map.entry(hash(expr)) {
1489 Entry::Occupied(mut o) => {
1492 match_expr_list.push((o, expr));
1495 o.get_mut().push(expr);
1497 Entry::Vacant(v) => {
1498 v.insert(vec![expr]);
1507 macro_rules! unwrap_cargo_metadata {
1508 ($cx: ident, $lint: ident, $deps: expr) => {{
1509 let mut command = cargo_metadata::MetadataCommand::new();
1514 match command.exec() {
1515 Ok(metadata) => metadata,
1517 span_lint($cx, $lint, DUMMY_SP, &format!("could not read cargo metadata: {}", err));
1526 use super::{reindent_multiline, without_block_comments};
1529 fn test_reindent_multiline_single_line() {
1530 assert_eq!("", reindent_multiline("".into(), false, None));
1531 assert_eq!("...", reindent_multiline("...".into(), false, None));
1532 assert_eq!("...", reindent_multiline(" ...".into(), false, None));
1533 assert_eq!("...", reindent_multiline("\t...".into(), false, None));
1534 assert_eq!("...", reindent_multiline("\t\t...".into(), false, None));
1539 fn test_reindent_multiline_block() {
1545 }", reindent_multiline(" if x {
1549 }".into(), false, None));
1555 }", reindent_multiline(" if x {
1559 }".into(), false, None));
1564 fn test_reindent_multiline_empty_line() {
1571 }", reindent_multiline(" if x {
1576 }".into(), false, None));
1581 fn test_reindent_multiline_lines_deeper() {
1587 }", reindent_multiline("\
1592 }".into(), true, Some(8)));
1596 fn test_without_block_comments_lines_without_block_comments() {
1597 let result = without_block_comments(vec!["/*", "", "*/"]);
1598 println!("result: {:?}", result);
1599 assert!(result.is_empty());
1601 let result = without_block_comments(vec!["", "/*", "", "*/", "#[crate_type = \"lib\"]", "/*", "", "*/", ""]);
1602 assert_eq!(result, vec!["", "#[crate_type = \"lib\"]", ""]);
1604 let result = without_block_comments(vec!["/* rust", "", "*/"]);
1605 assert!(result.is_empty());
1607 let result = without_block_comments(vec!["/* one-line comment */"]);
1608 assert!(result.is_empty());
1610 let result = without_block_comments(vec!["/* nested", "/* multi-line", "comment", "*/", "test", "*/"]);
1611 assert!(result.is_empty());
1613 let result = without_block_comments(vec!["/* nested /* inline /* comment */ test */ */"]);
1614 assert!(result.is_empty());
1616 let result = without_block_comments(vec!["foo", "bar", "baz"]);
1617 assert_eq!(result, vec!["foo", "bar", "baz"]);