1 //! Contains utility functions to generate suggestions.
2 #![deny(missing_docs_in_private_items)]
3 // currently ignores lifetimes and generics
8 use rustc::lint::{EarlyContext, LateContext, LintContext};
11 use std::fmt::Display;
13 use syntax::source_map::{CharPos, Span};
14 use syntax::parse::token;
15 use syntax::print::pprust::token_to_string;
16 use syntax::util::parser::AssocOp;
18 use crate::utils::{higher, snippet, snippet_opt};
19 use syntax_pos::{BytePos, Pos};
21 /// A helper type to build suggestion correctly handling parenthesis.
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
29 BinOp(AssocOp, Cow<'a, str>),
32 /// Literal constant `1`, for convenience.
33 pub const ONE: Sugg<'static> = Sugg::NonParen(Cow::Borrowed("1"));
35 impl Display for Sugg<'_> {
36 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
38 Sugg::NonParen(ref s) | Sugg::MaybeParen(ref s) | Sugg::BinOp(_, ref s) => s.fmt(f),
43 #[allow(wrong_self_convention)] // ok, because of the function `as_ty` method
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);
50 hir::ExprKind::AddrOf(..) |
51 hir::ExprKind::Box(..) |
52 hir::ExprKind::Closure(.., _) |
53 hir::ExprKind::If(..) |
54 hir::ExprKind::Unary(..) |
55 hir::ExprKind::Match(..) => Sugg::MaybeParen(snippet),
56 hir::ExprKind::Continue(..) |
57 hir::ExprKind::Yield(..) |
58 hir::ExprKind::Array(..) |
59 hir::ExprKind::Block(..) |
60 hir::ExprKind::Break(..) |
61 hir::ExprKind::Call(..) |
62 hir::ExprKind::Field(..) |
63 hir::ExprKind::Index(..) |
64 hir::ExprKind::InlineAsm(..) |
65 hir::ExprKind::Lit(..) |
66 hir::ExprKind::Loop(..) |
67 hir::ExprKind::MethodCall(..) |
68 hir::ExprKind::Path(..) |
69 hir::ExprKind::Repeat(..) |
70 hir::ExprKind::Ret(..) |
71 hir::ExprKind::Struct(..) |
72 hir::ExprKind::Tup(..) |
73 hir::ExprKind::While(..) => Sugg::NonParen(snippet),
74 hir::ExprKind::Assign(..) => Sugg::BinOp(AssocOp::Assign, snippet),
75 hir::ExprKind::AssignOp(op, ..) => Sugg::BinOp(hirbinop2assignop(op), snippet),
76 hir::ExprKind::Binary(op, ..) => Sugg::BinOp(AssocOp::from_ast_binop(higher::binop(op.node)), snippet),
77 hir::ExprKind::Cast(..) => Sugg::BinOp(AssocOp::As, snippet),
78 hir::ExprKind::Type(..) => Sugg::BinOp(AssocOp::Colon, snippet),
83 /// Convenience function around `hir_opt` for suggestions with a default
85 pub fn hir(cx: &LateContext<'_, '_>, expr: &hir::Expr, default: &'a str) -> Self {
86 Self::hir_opt(cx, expr).unwrap_or_else(|| Sugg::NonParen(Cow::Borrowed(default)))
89 /// Prepare a suggestion from an expression.
90 pub fn ast(cx: &EarlyContext<'_>, expr: &ast::Expr, default: &'a str) -> Self {
91 use syntax::ast::RangeLimits;
93 let snippet = snippet(cx, expr.span, default);
96 ast::ExprKind::AddrOf(..) |
97 ast::ExprKind::Box(..) |
98 ast::ExprKind::Closure(..) |
99 ast::ExprKind::If(..) |
100 ast::ExprKind::IfLet(..) |
101 ast::ExprKind::ObsoleteInPlace(..) |
102 ast::ExprKind::Unary(..) |
103 ast::ExprKind::Match(..) => Sugg::MaybeParen(snippet),
104 ast::ExprKind::Async(..) |
105 ast::ExprKind::Block(..) |
106 ast::ExprKind::Break(..) |
107 ast::ExprKind::Call(..) |
108 ast::ExprKind::Continue(..) |
109 ast::ExprKind::Yield(..) |
110 ast::ExprKind::Field(..) |
111 ast::ExprKind::ForLoop(..) |
112 ast::ExprKind::Index(..) |
113 ast::ExprKind::InlineAsm(..) |
114 ast::ExprKind::Lit(..) |
115 ast::ExprKind::Loop(..) |
116 ast::ExprKind::Mac(..) |
117 ast::ExprKind::MethodCall(..) |
118 ast::ExprKind::Paren(..) |
119 ast::ExprKind::Path(..) |
120 ast::ExprKind::Repeat(..) |
121 ast::ExprKind::Ret(..) |
122 ast::ExprKind::Struct(..) |
123 ast::ExprKind::Try(..) |
124 ast::ExprKind::TryBlock(..) |
125 ast::ExprKind::Tup(..) |
126 ast::ExprKind::Array(..) |
127 ast::ExprKind::While(..) |
128 ast::ExprKind::WhileLet(..) => Sugg::NonParen(snippet),
129 ast::ExprKind::Range(.., RangeLimits::HalfOpen) => Sugg::BinOp(AssocOp::DotDot, snippet),
130 ast::ExprKind::Range(.., RangeLimits::Closed) => Sugg::BinOp(AssocOp::DotDotEq, snippet),
131 ast::ExprKind::Assign(..) => Sugg::BinOp(AssocOp::Assign, snippet),
132 ast::ExprKind::AssignOp(op, ..) => Sugg::BinOp(astbinop2assignop(op), snippet),
133 ast::ExprKind::Binary(op, ..) => Sugg::BinOp(AssocOp::from_ast_binop(op.node), snippet),
134 ast::ExprKind::Cast(..) => Sugg::BinOp(AssocOp::As, snippet),
135 ast::ExprKind::Type(..) => Sugg::BinOp(AssocOp::Colon, snippet),
139 /// Convenience method to create the `<lhs> && <rhs>` suggestion.
140 pub fn and(self, rhs: &Self) -> Sugg<'static> {
141 make_binop(ast::BinOpKind::And, &self, rhs)
144 /// Convenience method to create the `<lhs> as <rhs>` suggestion.
145 pub fn as_ty<R: Display>(self, rhs: R) -> Sugg<'static> {
146 make_assoc(AssocOp::As, &self, &Sugg::NonParen(rhs.to_string().into()))
149 /// Convenience method to create the `&<expr>` suggestion.
150 pub fn addr(self) -> Sugg<'static> {
154 /// Convenience method to create the `&mut <expr>` suggestion.
155 pub fn mut_addr(self) -> Sugg<'static> {
156 make_unop("&mut ", self)
159 /// Convenience method to create the `*<expr>` suggestion.
160 pub fn deref(self) -> Sugg<'static> {
164 /// Convenience method to create the `&*<expr>` suggestion. Currently this
165 /// is needed because `sugg.deref().addr()` produces an unnecessary set of
166 /// parentheses around the deref.
167 pub fn addr_deref(self) -> Sugg<'static> {
168 make_unop("&*", self)
171 /// Convenience method to create the `&mut *<expr>` suggestion. Currently
172 /// this is needed because `sugg.deref().mut_addr()` produces an unnecessary
173 /// set of parentheses around the deref.
174 pub fn mut_addr_deref(self) -> Sugg<'static> {
175 make_unop("&mut *", self)
178 /// Add parenthesis to any expression that might need them. Suitable to the
179 /// `self` argument of
180 /// a method call (eg. to build `bar.foo()` or `(1 + 2).foo()`).
181 pub fn maybe_par(self) -> Self {
183 Sugg::NonParen(..) => self,
184 // (x) and (x).y() both don't need additional parens
185 Sugg::MaybeParen(sugg) => if sugg.starts_with('(') && sugg.ends_with(')') {
186 Sugg::MaybeParen(sugg)
188 Sugg::NonParen(format!("({})", sugg).into())
190 Sugg::BinOp(_, sugg) => Sugg::NonParen(format!("({})", sugg).into()),
195 impl<'a, 'b> std::ops::Add<Sugg<'b>> for Sugg<'a> {
196 type Output = Sugg<'static>;
197 fn add(self, rhs: Sugg<'b>) -> Sugg<'static> {
198 make_binop(ast::BinOpKind::Add, &self, &rhs)
202 impl<'a, 'b> std::ops::Sub<Sugg<'b>> for Sugg<'a> {
203 type Output = Sugg<'static>;
204 fn sub(self, rhs: Sugg<'b>) -> Sugg<'static> {
205 make_binop(ast::BinOpKind::Sub, &self, &rhs)
209 impl<'a> std::ops::Not for Sugg<'a> {
210 type Output = Sugg<'static>;
211 fn not(self) -> Sugg<'static> {
216 /// Helper type to display either `foo` or `(foo)`.
217 struct ParenHelper<T> {
218 /// Whether parenthesis are needed.
220 /// The main thing to display.
224 impl<T> ParenHelper<T> {
225 /// Build a `ParenHelper`.
226 fn new(paren: bool, wrapped: T) -> Self {
234 impl<T: Display> Display for ParenHelper<T> {
235 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
237 write!(f, "({})", self.wrapped)
244 /// Build the string for `<op><expr>` adding parenthesis when necessary.
246 /// For convenience, the operator is taken as a string because all unary
247 /// operators have the same
249 pub fn make_unop(op: &str, expr: Sugg<'_>) -> Sugg<'static> {
250 Sugg::MaybeParen(format!("{}{}", op, expr.maybe_par()).into())
253 /// Build the string for `<lhs> <op> <rhs>` adding parenthesis when necessary.
255 /// Precedence of shift operator relative to other arithmetic operation is
256 /// often confusing so
257 /// parenthesis will always be added for a mix of these.
258 pub fn make_assoc(op: AssocOp, lhs: &Sugg<'_>, rhs: &Sugg<'_>) -> Sugg<'static> {
259 /// Whether the operator is a shift operator `<<` or `>>`.
260 fn is_shift(op: &AssocOp) -> bool {
261 matches!(*op, AssocOp::ShiftLeft | AssocOp::ShiftRight)
264 /// Whether the operator is a arithmetic operator (`+`, `-`, `*`, `/`, `%`).
265 fn is_arith(op: &AssocOp) -> bool {
268 AssocOp::Add | AssocOp::Subtract | AssocOp::Multiply | AssocOp::Divide | AssocOp::Modulus
272 /// Whether the operator `op` needs parenthesis with the operator `other`
275 fn needs_paren(op: &AssocOp, other: &AssocOp, dir: Associativity) -> bool {
276 other.precedence() < op.precedence()
277 || (other.precedence() == op.precedence()
278 && ((op != other && associativity(op) != dir)
279 || (op == other && associativity(op) != Associativity::Both)))
280 || is_shift(op) && is_arith(other) || is_shift(other) && is_arith(op)
283 let lhs_paren = if let Sugg::BinOp(ref lop, _) = *lhs {
284 needs_paren(&op, lop, Associativity::Left)
289 let rhs_paren = if let Sugg::BinOp(ref rop, _) = *rhs {
290 needs_paren(&op, rop, Associativity::Right)
295 let lhs = ParenHelper::new(lhs_paren, lhs);
296 let rhs = ParenHelper::new(rhs_paren, rhs);
297 let sugg = match op {
305 AssocOp::GreaterEqual |
314 AssocOp::ShiftRight |
315 AssocOp::Subtract => format!("{} {} {}", lhs, op.to_ast_binop().expect("Those are AST ops").to_string(), rhs),
316 AssocOp::Assign => format!("{} = {}", lhs, rhs),
317 AssocOp::ObsoleteInPlace => format!("in ({}) {}", lhs, rhs),
318 AssocOp::AssignOp(op) => format!("{} {}= {}", lhs, token_to_string(&token::BinOp(op)), rhs),
319 AssocOp::As => format!("{} as {}", lhs, rhs),
320 AssocOp::DotDot => format!("{}..{}", lhs, rhs),
321 AssocOp::DotDotEq => format!("{}..={}", lhs, rhs),
322 AssocOp::Colon => format!("{}: {}", lhs, rhs),
325 Sugg::BinOp(op, sugg.into())
328 /// Convenience wrapper around `make_assoc` and `AssocOp::from_ast_binop`.
329 pub fn make_binop(op: ast::BinOpKind, lhs: &Sugg<'_>, rhs: &Sugg<'_>) -> Sugg<'static> {
330 make_assoc(AssocOp::from_ast_binop(op), lhs, rhs)
333 #[derive(PartialEq, Eq, Clone, Copy)]
334 /// Operator associativity.
336 /// The operator is both left-associative and right-associative.
338 /// The operator is left-associative.
340 /// The operator is not associative.
342 /// The operator is right-associative.
346 /// Return the associativity/fixity of an operator. The difference with
347 /// `AssocOp::fixity` is that
348 /// an operator can be both left and right associative (such as `+`:
349 /// `a + b + c == (a + b) + c == a + (b + c)`.
351 /// Chained `as` and explicit `:` type coercion never need inner parenthesis so
352 /// they are considered
354 fn associativity(op: &AssocOp) -> Associativity {
355 use syntax::util::parser::AssocOp::*;
358 ObsoleteInPlace | Assign | AssignOp(_) => Associativity::Right,
359 Add | BitAnd | BitOr | BitXor | LAnd | LOr | Multiply | As | Colon => Associativity::Both,
370 Subtract => Associativity::Left,
371 DotDot | DotDotEq => Associativity::None,
375 /// Convert a `hir::BinOp` to the corresponding assigning binary operator.
376 fn hirbinop2assignop(op: hir::BinOp) -> AssocOp {
377 use syntax::parse::token::BinOpToken::*;
379 AssocOp::AssignOp(match op.node {
380 hir::BinOpKind::Add => Plus,
381 hir::BinOpKind::BitAnd => And,
382 hir::BinOpKind::BitOr => Or,
383 hir::BinOpKind::BitXor => Caret,
384 hir::BinOpKind::Div => Slash,
385 hir::BinOpKind::Mul => Star,
386 hir::BinOpKind::Rem => Percent,
387 hir::BinOpKind::Shl => Shl,
388 hir::BinOpKind::Shr => Shr,
389 hir::BinOpKind::Sub => Minus,
391 | hir::BinOpKind::And
399 => panic!("This operator does not exist"),
403 /// Convert an `ast::BinOp` to the corresponding assigning binary operator.
404 fn astbinop2assignop(op: ast::BinOp) -> AssocOp {
405 use syntax::ast::BinOpKind::*;
406 use syntax::parse::token::BinOpToken;
408 AssocOp::AssignOp(match op.node {
409 Add => BinOpToken::Plus,
410 BitAnd => BinOpToken::And,
411 BitOr => BinOpToken::Or,
412 BitXor => BinOpToken::Caret,
413 Div => BinOpToken::Slash,
414 Mul => BinOpToken::Star,
415 Rem => BinOpToken::Percent,
416 Shl => BinOpToken::Shl,
417 Shr => BinOpToken::Shr,
418 Sub => BinOpToken::Minus,
419 And | Eq | Ge | Gt | Le | Lt | Ne | Or => panic!("This operator does not exist"),
423 /// Return the indentation before `span` if there are nothing but `[ \t]`
424 /// before it on its line.
425 fn indentation<'a, T: LintContext<'a>>(cx: &T, span: Span) -> Option<String> {
426 let lo = cx.sess().source_map().lookup_char_pos(span.lo());
427 if let Some(line) = lo.file
428 .get_line(lo.line - 1 /* line numbers in `Loc` are 1-based */)
430 if let Some((pos, _)) = line.char_indices().find(|&(_, c)| c != ' ' && c != '\t') {
431 // we can mix char and byte positions here because we only consider `[ \t]`
432 if lo.col == CharPos(pos) {
433 Some(line[..pos].into())
445 /// Convenience extension trait for `DiagnosticBuilder`.
446 pub trait DiagnosticBuilderExt<'a, T: LintContext<'a>> {
447 /// Suggests to add an attribute to an item.
449 /// Correctly handles indentation of the attribute and item.
454 /// db.suggest_item_with_attr(cx, item, "#[derive(Default)]");
456 fn suggest_item_with_attr<D: Display + ?Sized>(&mut self, cx: &T, item: Span, msg: &str, attr: &D);
458 /// Suggest to add an item before another.
460 /// The item should not be indented (expect for inner indentation).
465 /// db.suggest_prepend_item(cx, item,
470 fn suggest_prepend_item(&mut self, cx: &T, item: Span, msg: &str, new_item: &str);
472 /// Suggest to completely remove an item.
474 /// This will remove an item and all following whitespace until the next non-whitespace
475 /// character. This should work correctly if item is on the same indentation level as the
481 /// db.suggest_remove_item(cx, item, "remove this")
483 fn suggest_remove_item(&mut self, cx: &T, item: Span, msg: &str);
486 impl<'a, 'b, 'c, T: LintContext<'c>> DiagnosticBuilderExt<'c, T> for rustc_errors::DiagnosticBuilder<'b> {
487 fn suggest_item_with_attr<D: Display + ?Sized>(&mut self, cx: &T, item: Span, msg: &str, attr: &D) {
488 if let Some(indent) = indentation(cx, item) {
489 let span = item.with_hi(item.lo());
491 self.span_suggestion(span, msg, format!("{}\n{}", attr, indent));
495 fn suggest_prepend_item(&mut self, cx: &T, item: Span, msg: &str, new_item: &str) {
496 if let Some(indent) = indentation(cx, item) {
497 let span = item.with_hi(item.lo());
499 let mut first = true;
500 let new_item = new_item
507 format!("{}{}\n", indent, l)
510 .collect::<String>();
512 self.span_suggestion(span, msg, format!("{}\n{}", new_item, indent));
516 fn suggest_remove_item(&mut self, cx: &T, item: Span, msg: &str) {
517 let mut remove_span = item;
518 let hi = cx.sess().source_map().next_point(remove_span).hi();
519 let fmpos = cx.sess().source_map().lookup_byte_offset(hi);
521 if let Some(ref src) = fmpos.fm.src {
522 let non_whitespace_offset = src[fmpos.pos.to_usize()..].find(|c| c != ' ' && c != '\t' && c != '\n');
524 if let Some(non_whitespace_offset) = non_whitespace_offset {
525 remove_span = remove_span.with_hi(remove_span.hi() + BytePos(non_whitespace_offset as u32))
529 self.span_suggestion(remove_span, msg, String::new());