]> git.lizzy.rs Git - rust.git/blob - clippy_lints/src/utils/sugg.rs
Auto merge of #4040 - mikerite:fix-build-20190428, r=Manishearth
[rust.git] / clippy_lints / src / utils / sugg.rs
1 //! Contains utility functions to generate suggestions.
2 #![deny(clippy::missing_docs_in_private_items)]
3
4 use crate::utils::{higher, in_macro, snippet, snippet_opt, snippet_with_macro_callsite};
5 use matches::matches;
6 use rustc::hir;
7 use rustc::lint::{EarlyContext, LateContext, LintContext};
8 use rustc_errors;
9 use rustc_errors::Applicability;
10 use std;
11 use std::borrow::Cow;
12 use std::convert::TryInto;
13 use std::fmt::Display;
14 use syntax::ast;
15 use syntax::parse::token;
16 use syntax::print::pprust::token_to_string;
17 use syntax::source_map::{CharPos, Span};
18 use syntax::util::parser::AssocOp;
19 use syntax_pos::{BytePos, Pos};
20
21 /// A helper type to build suggestion correctly handling parenthesis.
22 pub enum Sugg<'a> {
23     /// An expression that never needs parenthesis such as `1337` or `[0; 42]`.
24     NonParen(Cow<'a, str>),
25     /// An expression that does not fit in other variants.
26     MaybeParen(Cow<'a, str>),
27     /// A binary operator expression, including `as`-casts and explicit type
28     /// coercion.
29     BinOp(AssocOp, Cow<'a, str>),
30 }
31
32 /// Literal constant `1`, for convenience.
33 pub const ONE: Sugg<'static> = Sugg::NonParen(Cow::Borrowed("1"));
34
35 impl Display for Sugg<'_> {
36     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
37         match *self {
38             Sugg::NonParen(ref s) | Sugg::MaybeParen(ref s) | Sugg::BinOp(_, ref s) => s.fmt(f),
39         }
40     }
41 }
42
43 #[allow(clippy::wrong_self_convention)] // ok, because of the function `as_ty` method
44 impl<'a> Sugg<'a> {
45     /// Prepare a suggestion from an expression.
46     pub fn hir_opt(cx: &LateContext<'_, '_>, expr: &hir::Expr) -> Option<Self> {
47         snippet_opt(cx, expr.span).map(|snippet| {
48             let snippet = Cow::Owned(snippet);
49             Self::hir_from_snippet(expr, snippet)
50         })
51     }
52
53     /// Convenience function around `hir_opt` for suggestions with a default
54     /// text.
55     pub fn hir(cx: &LateContext<'_, '_>, expr: &hir::Expr, default: &'a str) -> Self {
56         Self::hir_opt(cx, expr).unwrap_or_else(|| Sugg::NonParen(Cow::Borrowed(default)))
57     }
58
59     /// Same as `hir`, but it adapts the applicability level by following rules:
60     ///
61     /// - Applicability level `Unspecified` will never be changed.
62     /// - If the span is inside a macro, change the applicability level to `MaybeIncorrect`.
63     /// - If the default value is used and the applicability level is `MachineApplicable`, change it
64     ///   to
65     /// `HasPlaceholders`
66     pub fn hir_with_applicability(
67         cx: &LateContext<'_, '_>,
68         expr: &hir::Expr,
69         default: &'a str,
70         applicability: &mut Applicability,
71     ) -> Self {
72         if *applicability != Applicability::Unspecified && in_macro(expr.span) {
73             *applicability = Applicability::MaybeIncorrect;
74         }
75         Self::hir_opt(cx, expr).unwrap_or_else(|| {
76             if *applicability == Applicability::MachineApplicable {
77                 *applicability = Applicability::HasPlaceholders;
78             }
79             Sugg::NonParen(Cow::Borrowed(default))
80         })
81     }
82
83     /// Same as `hir`, but will use the pre expansion span if the `expr` was in a macro.
84     pub fn hir_with_macro_callsite(cx: &LateContext<'_, '_>, expr: &hir::Expr, default: &'a str) -> Self {
85         let snippet = snippet_with_macro_callsite(cx, expr.span, default);
86
87         Self::hir_from_snippet(expr, snippet)
88     }
89
90     /// Generate a suggestion for an expression with the given snippet. This is used by the `hir_*`
91     /// function variants of `Sugg`, since these use different snippet functions.
92     fn hir_from_snippet(expr: &hir::Expr, snippet: Cow<'a, str>) -> Self {
93         match expr.node {
94             hir::ExprKind::AddrOf(..)
95             | hir::ExprKind::Box(..)
96             | hir::ExprKind::Closure(.., _)
97             | hir::ExprKind::If(..)
98             | hir::ExprKind::Unary(..)
99             | hir::ExprKind::Match(..) => Sugg::MaybeParen(snippet),
100             hir::ExprKind::Continue(..)
101             | hir::ExprKind::Yield(..)
102             | hir::ExprKind::Array(..)
103             | hir::ExprKind::Block(..)
104             | hir::ExprKind::Break(..)
105             | hir::ExprKind::Call(..)
106             | hir::ExprKind::Field(..)
107             | hir::ExprKind::Index(..)
108             | hir::ExprKind::InlineAsm(..)
109             | hir::ExprKind::Lit(..)
110             | hir::ExprKind::Loop(..)
111             | hir::ExprKind::MethodCall(..)
112             | hir::ExprKind::Path(..)
113             | hir::ExprKind::Repeat(..)
114             | hir::ExprKind::Ret(..)
115             | hir::ExprKind::Struct(..)
116             | hir::ExprKind::Tup(..)
117             | hir::ExprKind::While(..)
118             | hir::ExprKind::Use(_)
119             | hir::ExprKind::Err => Sugg::NonParen(snippet),
120             hir::ExprKind::Assign(..) => Sugg::BinOp(AssocOp::Assign, snippet),
121             hir::ExprKind::AssignOp(op, ..) => Sugg::BinOp(hirbinop2assignop(op), snippet),
122             hir::ExprKind::Binary(op, ..) => Sugg::BinOp(AssocOp::from_ast_binop(higher::binop(op.node)), snippet),
123             hir::ExprKind::Cast(..) => Sugg::BinOp(AssocOp::As, snippet),
124             hir::ExprKind::Type(..) => Sugg::BinOp(AssocOp::Colon, snippet),
125         }
126     }
127
128     /// Prepare a suggestion from an expression.
129     pub fn ast(cx: &EarlyContext<'_>, expr: &ast::Expr, default: &'a str) -> Self {
130         use syntax::ast::RangeLimits;
131
132         let snippet = snippet(cx, expr.span, default);
133
134         match expr.node {
135             ast::ExprKind::AddrOf(..)
136             | ast::ExprKind::Box(..)
137             | ast::ExprKind::Closure(..)
138             | ast::ExprKind::If(..)
139             | ast::ExprKind::IfLet(..)
140             | ast::ExprKind::ObsoleteInPlace(..)
141             | ast::ExprKind::Unary(..)
142             | ast::ExprKind::Match(..) => Sugg::MaybeParen(snippet),
143             ast::ExprKind::Async(..)
144             | ast::ExprKind::Block(..)
145             | ast::ExprKind::Break(..)
146             | ast::ExprKind::Call(..)
147             | ast::ExprKind::Continue(..)
148             | ast::ExprKind::Yield(..)
149             | ast::ExprKind::Field(..)
150             | ast::ExprKind::ForLoop(..)
151             | ast::ExprKind::Index(..)
152             | ast::ExprKind::InlineAsm(..)
153             | ast::ExprKind::Lit(..)
154             | ast::ExprKind::Loop(..)
155             | ast::ExprKind::Mac(..)
156             | ast::ExprKind::MethodCall(..)
157             | ast::ExprKind::Paren(..)
158             | ast::ExprKind::Path(..)
159             | ast::ExprKind::Repeat(..)
160             | ast::ExprKind::Ret(..)
161             | ast::ExprKind::Struct(..)
162             | ast::ExprKind::Try(..)
163             | ast::ExprKind::TryBlock(..)
164             | ast::ExprKind::Tup(..)
165             | ast::ExprKind::Array(..)
166             | ast::ExprKind::While(..)
167             | ast::ExprKind::WhileLet(..)
168             | ast::ExprKind::Err => Sugg::NonParen(snippet),
169             ast::ExprKind::Range(.., RangeLimits::HalfOpen) => Sugg::BinOp(AssocOp::DotDot, snippet),
170             ast::ExprKind::Range(.., RangeLimits::Closed) => Sugg::BinOp(AssocOp::DotDotEq, snippet),
171             ast::ExprKind::Assign(..) => Sugg::BinOp(AssocOp::Assign, snippet),
172             ast::ExprKind::AssignOp(op, ..) => Sugg::BinOp(astbinop2assignop(op), snippet),
173             ast::ExprKind::Binary(op, ..) => Sugg::BinOp(AssocOp::from_ast_binop(op.node), snippet),
174             ast::ExprKind::Cast(..) => Sugg::BinOp(AssocOp::As, snippet),
175             ast::ExprKind::Type(..) => Sugg::BinOp(AssocOp::Colon, snippet),
176         }
177     }
178
179     /// Convenience method to create the `<lhs> && <rhs>` suggestion.
180     pub fn and(self, rhs: &Self) -> Sugg<'static> {
181         make_binop(ast::BinOpKind::And, &self, rhs)
182     }
183
184     /// Convenience method to create the `<lhs> & <rhs>` suggestion.
185     pub fn bit_and(self, rhs: &Self) -> Sugg<'static> {
186         make_binop(ast::BinOpKind::BitAnd, &self, rhs)
187     }
188
189     /// Convenience method to create the `<lhs> as <rhs>` suggestion.
190     pub fn as_ty<R: Display>(self, rhs: R) -> Sugg<'static> {
191         make_assoc(AssocOp::As, &self, &Sugg::NonParen(rhs.to_string().into()))
192     }
193
194     /// Convenience method to create the `&<expr>` suggestion.
195     pub fn addr(self) -> Sugg<'static> {
196         make_unop("&", self)
197     }
198
199     /// Convenience method to create the `&mut <expr>` suggestion.
200     pub fn mut_addr(self) -> Sugg<'static> {
201         make_unop("&mut ", self)
202     }
203
204     /// Convenience method to create the `*<expr>` suggestion.
205     pub fn deref(self) -> Sugg<'static> {
206         make_unop("*", self)
207     }
208
209     /// Convenience method to create the `&*<expr>` suggestion. Currently this
210     /// is needed because `sugg.deref().addr()` produces an unnecessary set of
211     /// parentheses around the deref.
212     pub fn addr_deref(self) -> Sugg<'static> {
213         make_unop("&*", self)
214     }
215
216     /// Convenience method to create the `&mut *<expr>` suggestion. Currently
217     /// this is needed because `sugg.deref().mut_addr()` produces an unnecessary
218     /// set of parentheses around the deref.
219     pub fn mut_addr_deref(self) -> Sugg<'static> {
220         make_unop("&mut *", self)
221     }
222
223     /// Convenience method to transform suggestion into a return call
224     pub fn make_return(self) -> Sugg<'static> {
225         Sugg::NonParen(Cow::Owned(format!("return {}", self)))
226     }
227
228     /// Convenience method to transform suggestion into a block
229     /// where the suggestion is a trailing expression
230     pub fn blockify(self) -> Sugg<'static> {
231         Sugg::NonParen(Cow::Owned(format!("{{ {} }}", self)))
232     }
233
234     /// Convenience method to create the `<lhs>..<rhs>` or `<lhs>...<rhs>`
235     /// suggestion.
236     #[allow(dead_code)]
237     pub fn range(self, end: &Self, limit: ast::RangeLimits) -> Sugg<'static> {
238         match limit {
239             ast::RangeLimits::HalfOpen => make_assoc(AssocOp::DotDot, &self, end),
240             ast::RangeLimits::Closed => make_assoc(AssocOp::DotDotEq, &self, end),
241         }
242     }
243
244     /// Adds parenthesis to any expression that might need them. Suitable to the
245     /// `self` argument of a method call
246     /// (e.g., to build `bar.foo()` or `(1 + 2).foo()`).
247     pub fn maybe_par(self) -> Self {
248         match self {
249             Sugg::NonParen(..) => self,
250             // `(x)` and `(x).y()` both don't need additional parens.
251             Sugg::MaybeParen(sugg) => {
252                 if sugg.starts_with('(') && sugg.ends_with(')') {
253                     Sugg::MaybeParen(sugg)
254                 } else {
255                     Sugg::NonParen(format!("({})", sugg).into())
256                 }
257             },
258             Sugg::BinOp(_, sugg) => Sugg::NonParen(format!("({})", sugg).into()),
259         }
260     }
261 }
262
263 impl<'a, 'b> std::ops::Add<Sugg<'b>> for Sugg<'a> {
264     type Output = Sugg<'static>;
265     fn add(self, rhs: Sugg<'b>) -> Sugg<'static> {
266         make_binop(ast::BinOpKind::Add, &self, &rhs)
267     }
268 }
269
270 impl<'a, 'b> std::ops::Sub<Sugg<'b>> for Sugg<'a> {
271     type Output = Sugg<'static>;
272     fn sub(self, rhs: Sugg<'b>) -> Sugg<'static> {
273         make_binop(ast::BinOpKind::Sub, &self, &rhs)
274     }
275 }
276
277 impl<'a> std::ops::Not for Sugg<'a> {
278     type Output = Sugg<'static>;
279     fn not(self) -> Sugg<'static> {
280         make_unop("!", self)
281     }
282 }
283
284 /// Helper type to display either `foo` or `(foo)`.
285 struct ParenHelper<T> {
286     /// `true` if parentheses are needed.
287     paren: bool,
288     /// The main thing to display.
289     wrapped: T,
290 }
291
292 impl<T> ParenHelper<T> {
293     /// Builds a `ParenHelper`.
294     fn new(paren: bool, wrapped: T) -> Self {
295         Self { paren, wrapped }
296     }
297 }
298
299 impl<T: Display> Display for ParenHelper<T> {
300     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
301         if self.paren {
302             write!(f, "({})", self.wrapped)
303         } else {
304             self.wrapped.fmt(f)
305         }
306     }
307 }
308
309 /// Builds the string for `<op><expr>` adding parenthesis when necessary.
310 ///
311 /// For convenience, the operator is taken as a string because all unary
312 /// operators have the same
313 /// precedence.
314 pub fn make_unop(op: &str, expr: Sugg<'_>) -> Sugg<'static> {
315     Sugg::MaybeParen(format!("{}{}", op, expr.maybe_par()).into())
316 }
317
318 /// Builds the string for `<lhs> <op> <rhs>` adding parenthesis when necessary.
319 ///
320 /// Precedence of shift operator relative to other arithmetic operation is
321 /// often confusing so
322 /// parenthesis will always be added for a mix of these.
323 pub fn make_assoc(op: AssocOp, lhs: &Sugg<'_>, rhs: &Sugg<'_>) -> Sugg<'static> {
324     /// Returns `true` if the operator is a shift operator `<<` or `>>`.
325     fn is_shift(op: &AssocOp) -> bool {
326         matches!(*op, AssocOp::ShiftLeft | AssocOp::ShiftRight)
327     }
328
329     /// Returns `true` if the operator is a arithmetic operator
330     /// (i.e., `+`, `-`, `*`, `/`, `%`).
331     fn is_arith(op: &AssocOp) -> bool {
332         matches!(
333             *op,
334             AssocOp::Add | AssocOp::Subtract | AssocOp::Multiply | AssocOp::Divide | AssocOp::Modulus
335         )
336     }
337
338     /// Returns `true` if the operator `op` needs parenthesis with the operator
339     /// `other` in the direction `dir`.
340     fn needs_paren(op: &AssocOp, other: &AssocOp, dir: Associativity) -> bool {
341         other.precedence() < op.precedence()
342             || (other.precedence() == op.precedence()
343                 && ((op != other && associativity(op) != dir)
344                     || (op == other && associativity(op) != Associativity::Both)))
345             || is_shift(op) && is_arith(other)
346             || is_shift(other) && is_arith(op)
347     }
348
349     let lhs_paren = if let Sugg::BinOp(ref lop, _) = *lhs {
350         needs_paren(&op, lop, Associativity::Left)
351     } else {
352         false
353     };
354
355     let rhs_paren = if let Sugg::BinOp(ref rop, _) = *rhs {
356         needs_paren(&op, rop, Associativity::Right)
357     } else {
358         false
359     };
360
361     let lhs = ParenHelper::new(lhs_paren, lhs);
362     let rhs = ParenHelper::new(rhs_paren, rhs);
363     let sugg = match op {
364         AssocOp::Add
365         | AssocOp::BitAnd
366         | AssocOp::BitOr
367         | AssocOp::BitXor
368         | AssocOp::Divide
369         | AssocOp::Equal
370         | AssocOp::Greater
371         | AssocOp::GreaterEqual
372         | AssocOp::LAnd
373         | AssocOp::LOr
374         | AssocOp::Less
375         | AssocOp::LessEqual
376         | AssocOp::Modulus
377         | AssocOp::Multiply
378         | AssocOp::NotEqual
379         | AssocOp::ShiftLeft
380         | AssocOp::ShiftRight
381         | AssocOp::Subtract => format!(
382             "{} {} {}",
383             lhs,
384             op.to_ast_binop().expect("Those are AST ops").to_string(),
385             rhs
386         ),
387         AssocOp::Assign => format!("{} = {}", lhs, rhs),
388         AssocOp::ObsoleteInPlace => format!("in ({}) {}", lhs, rhs),
389         AssocOp::AssignOp(op) => format!("{} {}= {}", lhs, token_to_string(&token::BinOp(op)), rhs),
390         AssocOp::As => format!("{} as {}", lhs, rhs),
391         AssocOp::DotDot => format!("{}..{}", lhs, rhs),
392         AssocOp::DotDotEq => format!("{}..={}", lhs, rhs),
393         AssocOp::Colon => format!("{}: {}", lhs, rhs),
394     };
395
396     Sugg::BinOp(op, sugg.into())
397 }
398
399 /// Convenience wrapper around `make_assoc` and `AssocOp::from_ast_binop`.
400 pub fn make_binop(op: ast::BinOpKind, lhs: &Sugg<'_>, rhs: &Sugg<'_>) -> Sugg<'static> {
401     make_assoc(AssocOp::from_ast_binop(op), lhs, rhs)
402 }
403
404 #[derive(PartialEq, Eq, Clone, Copy)]
405 /// Operator associativity.
406 enum Associativity {
407     /// The operator is both left-associative and right-associative.
408     Both,
409     /// The operator is left-associative.
410     Left,
411     /// The operator is not associative.
412     None,
413     /// The operator is right-associative.
414     Right,
415 }
416
417 /// Returns the associativity/fixity of an operator. The difference with
418 /// `AssocOp::fixity` is that an operator can be both left and right associative
419 /// (such as `+`: `a + b + c == (a + b) + c == a + (b + c)`.
420 ///
421 /// Chained `as` and explicit `:` type coercion never need inner parenthesis so
422 /// they are considered
423 /// associative.
424 fn associativity(op: &AssocOp) -> Associativity {
425     use syntax::util::parser::AssocOp::*;
426
427     match *op {
428         ObsoleteInPlace | Assign | AssignOp(_) => Associativity::Right,
429         Add | BitAnd | BitOr | BitXor | LAnd | LOr | Multiply | As | Colon => Associativity::Both,
430         Divide | Equal | Greater | GreaterEqual | Less | LessEqual | Modulus | NotEqual | ShiftLeft | ShiftRight
431         | Subtract => Associativity::Left,
432         DotDot | DotDotEq => Associativity::None,
433     }
434 }
435
436 /// Converts a `hir::BinOp` to the corresponding assigning binary operator.
437 fn hirbinop2assignop(op: hir::BinOp) -> AssocOp {
438     use syntax::parse::token::BinOpToken::*;
439
440     AssocOp::AssignOp(match op.node {
441         hir::BinOpKind::Add => Plus,
442         hir::BinOpKind::BitAnd => And,
443         hir::BinOpKind::BitOr => Or,
444         hir::BinOpKind::BitXor => Caret,
445         hir::BinOpKind::Div => Slash,
446         hir::BinOpKind::Mul => Star,
447         hir::BinOpKind::Rem => Percent,
448         hir::BinOpKind::Shl => Shl,
449         hir::BinOpKind::Shr => Shr,
450         hir::BinOpKind::Sub => Minus,
451
452         hir::BinOpKind::And
453         | hir::BinOpKind::Eq
454         | hir::BinOpKind::Ge
455         | hir::BinOpKind::Gt
456         | hir::BinOpKind::Le
457         | hir::BinOpKind::Lt
458         | hir::BinOpKind::Ne
459         | hir::BinOpKind::Or => panic!("This operator does not exist"),
460     })
461 }
462
463 /// Converts an `ast::BinOp` to the corresponding assigning binary operator.
464 fn astbinop2assignop(op: ast::BinOp) -> AssocOp {
465     use syntax::ast::BinOpKind::*;
466     use syntax::parse::token::BinOpToken;
467
468     AssocOp::AssignOp(match op.node {
469         Add => BinOpToken::Plus,
470         BitAnd => BinOpToken::And,
471         BitOr => BinOpToken::Or,
472         BitXor => BinOpToken::Caret,
473         Div => BinOpToken::Slash,
474         Mul => BinOpToken::Star,
475         Rem => BinOpToken::Percent,
476         Shl => BinOpToken::Shl,
477         Shr => BinOpToken::Shr,
478         Sub => BinOpToken::Minus,
479         And | Eq | Ge | Gt | Le | Lt | Ne | Or => panic!("This operator does not exist"),
480     })
481 }
482
483 /// Returns the indentation before `span` if there are nothing but `[ \t]`
484 /// before it on its line.
485 fn indentation<'a, T: LintContext<'a>>(cx: &T, span: Span) -> Option<String> {
486     let lo = cx.sess().source_map().lookup_char_pos(span.lo());
487     if let Some(line) = lo.file.get_line(lo.line - 1 /* line numbers in `Loc` are 1-based */) {
488         if let Some((pos, _)) = line.char_indices().find(|&(_, c)| c != ' ' && c != '\t') {
489             // We can mix char and byte positions here because we only consider `[ \t]`.
490             if lo.col == CharPos(pos) {
491                 Some(line[..pos].into())
492             } else {
493                 None
494             }
495         } else {
496             None
497         }
498     } else {
499         None
500     }
501 }
502
503 /// Convenience extension trait for `DiagnosticBuilder`.
504 pub trait DiagnosticBuilderExt<'a, T: LintContext<'a>> {
505     /// Suggests to add an attribute to an item.
506     ///
507     /// Correctly handles indentation of the attribute and item.
508     ///
509     /// # Example
510     ///
511     /// ```rust,ignore
512     /// db.suggest_item_with_attr(cx, item, "#[derive(Default)]");
513     /// ```
514     fn suggest_item_with_attr<D: Display + ?Sized>(
515         &mut self,
516         cx: &T,
517         item: Span,
518         msg: &str,
519         attr: &D,
520         applicability: Applicability,
521     );
522
523     /// Suggest to add an item before another.
524     ///
525     /// The item should not be indented (expect for inner indentation).
526     ///
527     /// # Example
528     ///
529     /// ```rust,ignore
530     /// db.suggest_prepend_item(cx, item,
531     /// "fn foo() {
532     ///     bar();
533     /// }");
534     /// ```
535     fn suggest_prepend_item(&mut self, cx: &T, item: Span, msg: &str, new_item: &str, applicability: Applicability);
536
537     /// Suggest to completely remove an item.
538     ///
539     /// This will remove an item and all following whitespace until the next non-whitespace
540     /// character. This should work correctly if item is on the same indentation level as the
541     /// following item.
542     ///
543     /// # Example
544     ///
545     /// ```rust,ignore
546     /// db.suggest_remove_item(cx, item, "remove this")
547     /// ```
548     fn suggest_remove_item(&mut self, cx: &T, item: Span, msg: &str, applicability: Applicability);
549 }
550
551 impl<'a, 'b, 'c, T: LintContext<'c>> DiagnosticBuilderExt<'c, T> for rustc_errors::DiagnosticBuilder<'b> {
552     fn suggest_item_with_attr<D: Display + ?Sized>(
553         &mut self,
554         cx: &T,
555         item: Span,
556         msg: &str,
557         attr: &D,
558         applicability: Applicability,
559     ) {
560         if let Some(indent) = indentation(cx, item) {
561             let span = item.with_hi(item.lo());
562
563             self.span_suggestion(span, msg, format!("{}\n{}", attr, indent), applicability);
564         }
565     }
566
567     fn suggest_prepend_item(&mut self, cx: &T, item: Span, msg: &str, new_item: &str, applicability: Applicability) {
568         if let Some(indent) = indentation(cx, item) {
569             let span = item.with_hi(item.lo());
570
571             let mut first = true;
572             let new_item = new_item
573                 .lines()
574                 .map(|l| {
575                     if first {
576                         first = false;
577                         format!("{}\n", l)
578                     } else {
579                         format!("{}{}\n", indent, l)
580                     }
581                 })
582                 .collect::<String>();
583
584             self.span_suggestion(span, msg, format!("{}\n{}", new_item, indent), applicability);
585         }
586     }
587
588     fn suggest_remove_item(&mut self, cx: &T, item: Span, msg: &str, applicability: Applicability) {
589         let mut remove_span = item;
590         let hi = cx.sess().source_map().next_point(remove_span).hi();
591         let fmpos = cx.sess().source_map().lookup_byte_offset(hi);
592
593         if let Some(ref src) = fmpos.sf.src {
594             let non_whitespace_offset = src[fmpos.pos.to_usize()..].find(|c| c != ' ' && c != '\t' && c != '\n');
595
596             if let Some(non_whitespace_offset) = non_whitespace_offset {
597                 remove_span = remove_span
598                     .with_hi(remove_span.hi() + BytePos(non_whitespace_offset.try_into().expect("offset too large")))
599             }
600         }
601
602         self.span_suggestion(remove_span, msg, String::new(), applicability);
603     }
604 }
605
606 #[cfg(test)]
607 mod test {
608     use super::Sugg;
609     use std::borrow::Cow;
610
611     const SUGGESTION: Sugg<'static> = Sugg::NonParen(Cow::Borrowed("function_call()"));
612
613     #[test]
614     fn make_return_transform_sugg_into_a_return_call() {
615         assert_eq!("return function_call()", SUGGESTION.make_return().to_string());
616     }
617
618     #[test]
619     fn blockify_transforms_sugg_into_a_block() {
620         assert_eq!("{ function_call() }", SUGGESTION.blockify().to_string());
621     }
622 }