clippy_utils/src/sugg.rs

   1 //! Contains utility functions to generate suggestions.
   2 #![deny(clippy::missing_docs_in_private_items)]
   3
   4 use crate::source::{snippet, snippet_opt, snippet_with_applicability, snippet_with_macro_callsite};
   5 use crate::ty::expr_sig;
   6 use crate::{get_parent_expr_for_hir, higher};
   7 use rustc_ast::util::parser::AssocOp;
   8 use rustc_ast::{ast, token};
   9 use rustc_ast_pretty::pprust::token_kind_to_string;
  10 use rustc_errors::Applicability;
  11 use rustc_hir as hir;
  12 use rustc_hir::{Closure, ExprKind, HirId, MutTy, TyKind};
  13 use rustc_infer::infer::TyCtxtInferExt;
  14 use rustc_lint::{EarlyContext, LateContext, LintContext};
  15 use rustc_middle::hir::place::ProjectionKind;
  16 use rustc_middle::mir::{FakeReadCause, Mutability};
  17 use rustc_middle::ty;
  18 use rustc_span::source_map::{BytePos, CharPos, Pos, Span, SyntaxContext};
  19 use rustc_typeck::expr_use_visitor::{Delegate, ExprUseVisitor, PlaceBase, PlaceWithHirId};
  20 use std::borrow::Cow;
  21 use std::fmt::{Display, Write as _};
  22 use std::ops::{Add, Neg, Not, Sub};
  23
  24 /// A helper type to build suggestion correctly handling parentheses.
  25 #[derive(Clone, PartialEq)]
  26 pub enum Sugg<'a> {
  27     /// An expression that never needs parentheses such as `1337` or `[0; 42]`.
  28     NonParen(Cow<'a, str>),
  29     /// An expression that does not fit in other variants.
  30     MaybeParen(Cow<'a, str>),
  31     /// A binary operator expression, including `as`-casts and explicit type
  32     /// coercion.
  33     BinOp(AssocOp, Cow<'a, str>, Cow<'a, str>),
  34 }
  35
  36 /// Literal constant `0`, for convenience.
  37 pub const ZERO: Sugg<'static> = Sugg::NonParen(Cow::Borrowed("0"));
  38 /// Literal constant `1`, for convenience.
  39 pub const ONE: Sugg<'static> = Sugg::NonParen(Cow::Borrowed("1"));
  40 /// a constant represents an empty string, for convenience.
  41 pub const EMPTY: Sugg<'static> = Sugg::NonParen(Cow::Borrowed(""));
  42
  43 impl Display for Sugg<'_> {
  44     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
  45         match *self {
  46             Sugg::NonParen(ref s) | Sugg::MaybeParen(ref s) => s.fmt(f),
  47             Sugg::BinOp(op, ref lhs, ref rhs) => binop_to_string(op, lhs, rhs).fmt(f),
  48         }
  49     }
  50 }
  51
  52 #[expect(clippy::wrong_self_convention)] // ok, because of the function `as_ty` method
  53 impl<'a> Sugg<'a> {
  54     /// Prepare a suggestion from an expression.
  55     pub fn hir_opt(cx: &LateContext<'_>, expr: &hir::Expr<'_>) -> Option<Self> {
  56         let get_snippet = |span| snippet(cx, span, "");
  57         snippet_opt(cx, expr.span).map(|_| Self::hir_from_snippet(expr, get_snippet))
  58     }
  59
  60     /// Convenience function around `hir_opt` for suggestions with a default
  61     /// text.
  62     pub fn hir(cx: &LateContext<'_>, expr: &hir::Expr<'_>, default: &'a str) -> Self {
  63         Self::hir_opt(cx, expr).unwrap_or(Sugg::NonParen(Cow::Borrowed(default)))
  64     }
  65
  66     /// Same as `hir`, but it adapts the applicability level by following rules:
  67     ///
  68     /// - Applicability level `Unspecified` will never be changed.
  69     /// - If the span is inside a macro, change the applicability level to `MaybeIncorrect`.
  70     /// - If the default value is used and the applicability level is `MachineApplicable`, change it
  71     ///   to
  72     /// `HasPlaceholders`
  73     pub fn hir_with_applicability(
  74         cx: &LateContext<'_>,
  75         expr: &hir::Expr<'_>,
  76         default: &'a str,
  77         applicability: &mut Applicability,
  78     ) -> Self {
  79         if *applicability != Applicability::Unspecified && expr.span.from_expansion() {
  80             *applicability = Applicability::MaybeIncorrect;
  81         }
  82         Self::hir_opt(cx, expr).unwrap_or_else(|| {
  83             if *applicability == Applicability::MachineApplicable {
  84                 *applicability = Applicability::HasPlaceholders;
  85             }
  86             Sugg::NonParen(Cow::Borrowed(default))
  87         })
  88     }
  89
  90     /// Same as `hir`, but will use the pre expansion span if the `expr` was in a macro.
  91     pub fn hir_with_macro_callsite(cx: &LateContext<'_>, expr: &hir::Expr<'_>, default: &'a str) -> Self {
  92         let get_snippet = |span| snippet_with_macro_callsite(cx, span, default);
  93         Self::hir_from_snippet(expr, get_snippet)
  94     }
  95
  96     /// Same as `hir`, but first walks the span up to the given context. This will result in the
  97     /// macro call, rather then the expansion, if the span is from a child context. If the span is
  98     /// not from a child context, it will be used directly instead.
  99     ///
 100     /// e.g. Given the expression `&vec![]`, getting a snippet from the span for `vec![]` as a HIR
 101     /// node would result in `box []`. If given the context of the address of expression, this
 102     /// function will correctly get a snippet of `vec![]`.
 103     pub fn hir_with_context(
 104         cx: &LateContext<'_>,
 105         expr: &hir::Expr<'_>,
 106         ctxt: SyntaxContext,
 107         default: &'a str,
 108         applicability: &mut Applicability,
 109     ) -> Self {
 110         if expr.span.ctxt() == ctxt {
 111             Self::hir_from_snippet(expr, |span| snippet(cx, span, default))
 112         } else {
 113             let snip = snippet_with_applicability(cx, expr.span, default, applicability);
 114             Sugg::NonParen(snip)
 115         }
 116     }
 117
 118     /// Generate a suggestion for an expression with the given snippet. This is used by the `hir_*`
 119     /// function variants of `Sugg`, since these use different snippet functions.
 120     fn hir_from_snippet(expr: &hir::Expr<'_>, get_snippet: impl Fn(Span) -> Cow<'a, str>) -> Self {
 121         if let Some(range) = higher::Range::hir(expr) {
 122             let op = match range.limits {
 123                 ast::RangeLimits::HalfOpen => AssocOp::DotDot,
 124                 ast::RangeLimits::Closed => AssocOp::DotDotEq,
 125             };
 126             let start = range.start.map_or("".into(), |expr| get_snippet(expr.span));
 127             let end = range.end.map_or("".into(), |expr| get_snippet(expr.span));
 128
 129             return Sugg::BinOp(op, start, end);
 130         }
 131
 132         match expr.kind {
 133             hir::ExprKind::AddrOf(..)
 134             | hir::ExprKind::Box(..)
 135             | hir::ExprKind::If(..)
 136             | hir::ExprKind::Let(..)
 137             | hir::ExprKind::Closure { .. }
 138             | hir::ExprKind::Unary(..)
 139             | hir::ExprKind::Match(..) => Sugg::MaybeParen(get_snippet(expr.span)),
 140             hir::ExprKind::Continue(..)
 141             | hir::ExprKind::Yield(..)
 142             | hir::ExprKind::Array(..)
 143             | hir::ExprKind::Block(..)
 144             | hir::ExprKind::Break(..)
 145             | hir::ExprKind::Call(..)
 146             | hir::ExprKind::Field(..)
 147             | hir::ExprKind::Index(..)
 148             | hir::ExprKind::InlineAsm(..)
 149             | hir::ExprKind::ConstBlock(..)
 150             | hir::ExprKind::Lit(..)
 151             | hir::ExprKind::Loop(..)
 152             | hir::ExprKind::MethodCall(..)
 153             | hir::ExprKind::Path(..)
 154             | hir::ExprKind::Repeat(..)
 155             | hir::ExprKind::Ret(..)
 156             | hir::ExprKind::Struct(..)
 157             | hir::ExprKind::Tup(..)
 158             | hir::ExprKind::DropTemps(_)
 159             | hir::ExprKind::Err => Sugg::NonParen(get_snippet(expr.span)),
 160             hir::ExprKind::Assign(lhs, rhs, _) => {
 161                 Sugg::BinOp(AssocOp::Assign, get_snippet(lhs.span), get_snippet(rhs.span))
 162             },
 163             hir::ExprKind::AssignOp(op, lhs, rhs) => {
 164                 Sugg::BinOp(hirbinop2assignop(op), get_snippet(lhs.span), get_snippet(rhs.span))
 165             },
 166             hir::ExprKind::Binary(op, lhs, rhs) => Sugg::BinOp(
 167                 AssocOp::from_ast_binop(op.node.into()),
 168                 get_snippet(lhs.span),
 169                 get_snippet(rhs.span),
 170             ),
 171             hir::ExprKind::Cast(lhs, ty) => Sugg::BinOp(AssocOp::As, get_snippet(lhs.span), get_snippet(ty.span)),
 172             hir::ExprKind::Type(lhs, ty) => Sugg::BinOp(AssocOp::Colon, get_snippet(lhs.span), get_snippet(ty.span)),
 173         }
 174     }
 175
 176     /// Prepare a suggestion from an expression.
 177     pub fn ast(cx: &EarlyContext<'_>, expr: &ast::Expr, default: &'a str) -> Self {
 178         use rustc_ast::ast::RangeLimits;
 179
 180         let get_whole_snippet = || {
 181             if expr.span.from_expansion() {
 182                 snippet_with_macro_callsite(cx, expr.span, default)
 183             } else {
 184                 snippet(cx, expr.span, default)
 185             }
 186         };
 187
 188         match expr.kind {
 189             ast::ExprKind::AddrOf(..)
 190             | ast::ExprKind::Box(..)
 191             | ast::ExprKind::Closure { .. }
 192             | ast::ExprKind::If(..)
 193             | ast::ExprKind::Let(..)
 194             | ast::ExprKind::Unary(..)
 195             | ast::ExprKind::Match(..) => Sugg::MaybeParen(get_whole_snippet()),
 196             ast::ExprKind::Async(..)
 197             | ast::ExprKind::Block(..)
 198             | ast::ExprKind::Break(..)
 199             | ast::ExprKind::Call(..)
 200             | ast::ExprKind::Continue(..)
 201             | ast::ExprKind::Yield(..)
 202             | ast::ExprKind::Field(..)
 203             | ast::ExprKind::ForLoop(..)
 204             | ast::ExprKind::Index(..)
 205             | ast::ExprKind::InlineAsm(..)
 206             | ast::ExprKind::ConstBlock(..)
 207             | ast::ExprKind::Lit(..)
 208             | ast::ExprKind::Loop(..)
 209             | ast::ExprKind::MacCall(..)
 210             | ast::ExprKind::MethodCall(..)
 211             | ast::ExprKind::Paren(..)
 212             | ast::ExprKind::Underscore
 213             | ast::ExprKind::Path(..)
 214             | ast::ExprKind::Repeat(..)
 215             | ast::ExprKind::Ret(..)
 216             | ast::ExprKind::Yeet(..)
 217             | ast::ExprKind::Struct(..)
 218             | ast::ExprKind::Try(..)
 219             | ast::ExprKind::TryBlock(..)
 220             | ast::ExprKind::Tup(..)
 221             | ast::ExprKind::Array(..)
 222             | ast::ExprKind::While(..)
 223             | ast::ExprKind::Await(..)
 224             | ast::ExprKind::Err => Sugg::NonParen(get_whole_snippet()),
 225             ast::ExprKind::Range(ref lhs, ref rhs, RangeLimits::HalfOpen) => Sugg::BinOp(
 226                 AssocOp::DotDot,
 227                 lhs.as_ref().map_or("".into(), |lhs| snippet(cx, lhs.span, default)),
 228                 rhs.as_ref().map_or("".into(), |rhs| snippet(cx, rhs.span, default)),
 229             ),
 230             ast::ExprKind::Range(ref lhs, ref rhs, RangeLimits::Closed) => Sugg::BinOp(
 231                 AssocOp::DotDotEq,
 232                 lhs.as_ref().map_or("".into(), |lhs| snippet(cx, lhs.span, default)),
 233                 rhs.as_ref().map_or("".into(), |rhs| snippet(cx, rhs.span, default)),
 234             ),
 235             ast::ExprKind::Assign(ref lhs, ref rhs, _) => Sugg::BinOp(
 236                 AssocOp::Assign,
 237                 snippet(cx, lhs.span, default),
 238                 snippet(cx, rhs.span, default),
 239             ),
 240             ast::ExprKind::AssignOp(op, ref lhs, ref rhs) => Sugg::BinOp(
 241                 astbinop2assignop(op),
 242                 snippet(cx, lhs.span, default),
 243                 snippet(cx, rhs.span, default),
 244             ),
 245             ast::ExprKind::Binary(op, ref lhs, ref rhs) => Sugg::BinOp(
 246                 AssocOp::from_ast_binop(op.node),
 247                 snippet(cx, lhs.span, default),
 248                 snippet(cx, rhs.span, default),
 249             ),
 250             ast::ExprKind::Cast(ref lhs, ref ty) => Sugg::BinOp(
 251                 AssocOp::As,
 252                 snippet(cx, lhs.span, default),
 253                 snippet(cx, ty.span, default),
 254             ),
 255             ast::ExprKind::Type(ref lhs, ref ty) => Sugg::BinOp(
 256                 AssocOp::Colon,
 257                 snippet(cx, lhs.span, default),
 258                 snippet(cx, ty.span, default),
 259             ),
 260         }
 261     }
 262
 263     /// Convenience method to create the `<lhs> && <rhs>` suggestion.
 264     pub fn and(self, rhs: &Self) -> Sugg<'static> {
 265         make_binop(ast::BinOpKind::And, &self, rhs)
 266     }
 267
 268     /// Convenience method to create the `<lhs> & <rhs>` suggestion.
 269     pub fn bit_and(self, rhs: &Self) -> Sugg<'static> {
 270         make_binop(ast::BinOpKind::BitAnd, &self, rhs)
 271     }
 272
 273     /// Convenience method to create the `<lhs> as <rhs>` suggestion.
 274     pub fn as_ty<R: Display>(self, rhs: R) -> Sugg<'static> {
 275         make_assoc(AssocOp::As, &self, &Sugg::NonParen(rhs.to_string().into()))
 276     }
 277
 278     /// Convenience method to create the `&<expr>` suggestion.
 279     pub fn addr(self) -> Sugg<'static> {
 280         make_unop("&", self)
 281     }
 282
 283     /// Convenience method to create the `&mut <expr>` suggestion.
 284     pub fn mut_addr(self) -> Sugg<'static> {
 285         make_unop("&mut ", self)
 286     }
 287
 288     /// Convenience method to create the `*<expr>` suggestion.
 289     pub fn deref(self) -> Sugg<'static> {
 290         make_unop("*", self)
 291     }
 292
 293     /// Convenience method to create the `&*<expr>` suggestion. Currently this
 294     /// is needed because `sugg.deref().addr()` produces an unnecessary set of
 295     /// parentheses around the deref.
 296     pub fn addr_deref(self) -> Sugg<'static> {
 297         make_unop("&*", self)
 298     }
 299
 300     /// Convenience method to create the `&mut *<expr>` suggestion. Currently
 301     /// this is needed because `sugg.deref().mut_addr()` produces an unnecessary
 302     /// set of parentheses around the deref.
 303     pub fn mut_addr_deref(self) -> Sugg<'static> {
 304         make_unop("&mut *", self)
 305     }
 306
 307     /// Convenience method to transform suggestion into a return call
 308     pub fn make_return(self) -> Sugg<'static> {
 309         Sugg::NonParen(Cow::Owned(format!("return {}", self)))
 310     }
 311
 312     /// Convenience method to transform suggestion into a block
 313     /// where the suggestion is a trailing expression
 314     pub fn blockify(self) -> Sugg<'static> {
 315         Sugg::NonParen(Cow::Owned(format!("{{ {} }}", self)))
 316     }
 317
 318     /// Convenience method to prefix the expression with the `async` keyword.
 319     /// Can be used after `blockify` to create an async block.
 320     pub fn asyncify(self) -> Sugg<'static> {
 321         Sugg::NonParen(Cow::Owned(format!("async {}", self)))
 322     }
 323
 324     /// Convenience method to create the `<lhs>..<rhs>` or `<lhs>...<rhs>`
 325     /// suggestion.
 326     pub fn range(self, end: &Self, limit: ast::RangeLimits) -> Sugg<'static> {
 327         match limit {
 328             ast::RangeLimits::HalfOpen => make_assoc(AssocOp::DotDot, &self, end),
 329             ast::RangeLimits::Closed => make_assoc(AssocOp::DotDotEq, &self, end),
 330         }
 331     }
 332
 333     /// Adds parentheses to any expression that might need them. Suitable to the
 334     /// `self` argument of a method call
 335     /// (e.g., to build `bar.foo()` or `(1 + 2).foo()`).
 336     #[must_use]
 337     pub fn maybe_par(self) -> Self {
 338         match self {
 339             Sugg::NonParen(..) => self,
 340             // `(x)` and `(x).y()` both don't need additional parens.
 341             Sugg::MaybeParen(sugg) => {
 342                 if has_enclosing_paren(&sugg) {
 343                     Sugg::MaybeParen(sugg)
 344                 } else {
 345                     Sugg::NonParen(format!("({})", sugg).into())
 346                 }
 347             },
 348             Sugg::BinOp(op, lhs, rhs) => {
 349                 let sugg = binop_to_string(op, &lhs, &rhs);
 350                 Sugg::NonParen(format!("({})", sugg).into())
 351             },
 352         }
 353     }
 354 }
 355
 356 /// Generates a string from the operator and both sides.
 357 fn binop_to_string(op: AssocOp, lhs: &str, rhs: &str) -> String {
 358     match op {
 359         AssocOp::Add
 360         | AssocOp::Subtract
 361         | AssocOp::Multiply
 362         | AssocOp::Divide
 363         | AssocOp::Modulus
 364         | AssocOp::LAnd
 365         | AssocOp::LOr
 366         | AssocOp::BitXor
 367         | AssocOp::BitAnd
 368         | AssocOp::BitOr
 369         | AssocOp::ShiftLeft
 370         | AssocOp::ShiftRight
 371         | AssocOp::Equal
 372         | AssocOp::Less
 373         | AssocOp::LessEqual
 374         | AssocOp::NotEqual
 375         | AssocOp::Greater
 376         | AssocOp::GreaterEqual => {
 377             format!(
 378                 "{} {} {}",
 379                 lhs,
 380                 op.to_ast_binop().expect("Those are AST ops").to_string(),
 381                 rhs
 382             )
 383         },
 384         AssocOp::Assign => format!("{} = {}", lhs, rhs),
 385         AssocOp::AssignOp(op) => {
 386             format!("{} {}= {}", lhs, token_kind_to_string(&token::BinOp(op)), rhs)
 387         },
 388         AssocOp::As => format!("{} as {}", lhs, rhs),
 389         AssocOp::DotDot => format!("{}..{}", lhs, rhs),
 390         AssocOp::DotDotEq => format!("{}..={}", lhs, rhs),
 391         AssocOp::Colon => format!("{}: {}", lhs, rhs),
 392     }
 393 }
 394
 395 /// Return `true` if `sugg` is enclosed in parenthesis.
 396 pub fn has_enclosing_paren(sugg: impl AsRef<str>) -> bool {
 397     let mut chars = sugg.as_ref().chars();
 398     if chars.next() == Some('(') {
 399         let mut depth = 1;
 400         for c in &mut chars {
 401             if c == '(' {
 402                 depth += 1;
 403             } else if c == ')' {
 404                 depth -= 1;
 405             }
 406             if depth == 0 {
 407                 break;
 408             }
 409         }
 410         chars.next().is_none()
 411     } else {
 412         false
 413     }
 414 }
 415
 416 /// Copied from the rust standard library, and then edited
 417 macro_rules! forward_binop_impls_to_ref {
 418     (impl $imp:ident, $method:ident for $t:ty, type Output = $o:ty) => {
 419         impl $imp<$t> for &$t {
 420             type Output = $o;
 421
 422             fn $method(self, other: $t) -> $o {
 423                 $imp::$method(self, &other)
 424             }
 425         }
 426
 427         impl $imp<&$t> for $t {
 428             type Output = $o;
 429
 430             fn $method(self, other: &$t) -> $o {
 431                 $imp::$method(&self, other)
 432             }
 433         }
 434
 435         impl $imp for $t {
 436             type Output = $o;
 437
 438             fn $method(self, other: $t) -> $o {
 439                 $imp::$method(&self, &other)
 440             }
 441         }
 442     };
 443 }
 444
 445 impl Add for &Sugg<'_> {
 446     type Output = Sugg<'static>;
 447     fn add(self, rhs: &Sugg<'_>) -> Sugg<'static> {
 448         make_binop(ast::BinOpKind::Add, self, rhs)
 449     }
 450 }
 451
 452 impl Sub for &Sugg<'_> {
 453     type Output = Sugg<'static>;
 454     fn sub(self, rhs: &Sugg<'_>) -> Sugg<'static> {
 455         make_binop(ast::BinOpKind::Sub, self, rhs)
 456     }
 457 }
 458
 459 forward_binop_impls_to_ref!(impl Add, add for Sugg<'_>, type Output = Sugg<'static>);
 460 forward_binop_impls_to_ref!(impl Sub, sub for Sugg<'_>, type Output = Sugg<'static>);
 461
 462 impl Neg for Sugg<'_> {
 463     type Output = Sugg<'static>;
 464     fn neg(self) -> Sugg<'static> {
 465         make_unop("-", self)
 466     }
 467 }
 468
 469 impl<'a> Not for Sugg<'a> {
 470     type Output = Sugg<'a>;
 471     fn not(self) -> Sugg<'a> {
 472         use AssocOp::{Equal, Greater, GreaterEqual, Less, LessEqual, NotEqual};
 473
 474         if let Sugg::BinOp(op, lhs, rhs) = self {
 475             let to_op = match op {
 476                 Equal => NotEqual,
 477                 NotEqual => Equal,
 478                 Less => GreaterEqual,
 479                 GreaterEqual => Less,
 480                 Greater => LessEqual,
 481                 LessEqual => Greater,
 482                 _ => return make_unop("!", Sugg::BinOp(op, lhs, rhs)),
 483             };
 484             Sugg::BinOp(to_op, lhs, rhs)
 485         } else {
 486             make_unop("!", self)
 487         }
 488     }
 489 }
 490
 491 /// Helper type to display either `foo` or `(foo)`.
 492 struct ParenHelper<T> {
 493     /// `true` if parentheses are needed.
 494     paren: bool,
 495     /// The main thing to display.
 496     wrapped: T,
 497 }
 498
 499 impl<T> ParenHelper<T> {
 500     /// Builds a `ParenHelper`.
 501     fn new(paren: bool, wrapped: T) -> Self {
 502         Self { paren, wrapped }
 503     }
 504 }
 505
 506 impl<T: Display> Display for ParenHelper<T> {
 507     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
 508         if self.paren {
 509             write!(f, "({})", self.wrapped)
 510         } else {
 511             self.wrapped.fmt(f)
 512         }
 513     }
 514 }
 515
 516 /// Builds the string for `<op><expr>` adding parenthesis when necessary.
 517 ///
 518 /// For convenience, the operator is taken as a string because all unary
 519 /// operators have the same
 520 /// precedence.
 521 pub fn make_unop(op: &str, expr: Sugg<'_>) -> Sugg<'static> {
 522     Sugg::MaybeParen(format!("{}{}", op, expr.maybe_par()).into())
 523 }
 524
 525 /// Builds the string for `<lhs> <op> <rhs>` adding parenthesis when necessary.
 526 ///
 527 /// Precedence of shift operator relative to other arithmetic operation is
 528 /// often confusing so
 529 /// parenthesis will always be added for a mix of these.
 530 pub fn make_assoc(op: AssocOp, lhs: &Sugg<'_>, rhs: &Sugg<'_>) -> Sugg<'static> {
 531     /// Returns `true` if the operator is a shift operator `<<` or `>>`.
 532     fn is_shift(op: AssocOp) -> bool {
 533         matches!(op, AssocOp::ShiftLeft | AssocOp::ShiftRight)
 534     }
 535
 536     /// Returns `true` if the operator is an arithmetic operator
 537     /// (i.e., `+`, `-`, `*`, `/`, `%`).
 538     fn is_arith(op: AssocOp) -> bool {
 539         matches!(
 540             op,
 541             AssocOp::Add | AssocOp::Subtract | AssocOp::Multiply | AssocOp::Divide | AssocOp::Modulus
 542         )
 543     }
 544
 545     /// Returns `true` if the operator `op` needs parenthesis with the operator
 546     /// `other` in the direction `dir`.
 547     fn needs_paren(op: AssocOp, other: AssocOp, dir: Associativity) -> bool {
 548         other.precedence() < op.precedence()
 549             || (other.precedence() == op.precedence()
 550                 && ((op != other && associativity(op) != dir)
 551                     || (op == other && associativity(op) != Associativity::Both)))
 552             || is_shift(op) && is_arith(other)
 553             || is_shift(other) && is_arith(op)
 554     }
 555
 556     let lhs_paren = if let Sugg::BinOp(lop, _, _) = *lhs {
 557         needs_paren(op, lop, Associativity::Left)
 558     } else {
 559         false
 560     };
 561
 562     let rhs_paren = if let Sugg::BinOp(rop, _, _) = *rhs {
 563         needs_paren(op, rop, Associativity::Right)
 564     } else {
 565         false
 566     };
 567
 568     let lhs = ParenHelper::new(lhs_paren, lhs).to_string();
 569     let rhs = ParenHelper::new(rhs_paren, rhs).to_string();
 570     Sugg::BinOp(op, lhs.into(), rhs.into())
 571 }
 572
 573 /// Convenience wrapper around `make_assoc` and `AssocOp::from_ast_binop`.
 574 pub fn make_binop(op: ast::BinOpKind, lhs: &Sugg<'_>, rhs: &Sugg<'_>) -> Sugg<'static> {
 575     make_assoc(AssocOp::from_ast_binop(op), lhs, rhs)
 576 }
 577
 578 #[derive(PartialEq, Eq, Clone, Copy)]
 579 /// Operator associativity.
 580 enum Associativity {
 581     /// The operator is both left-associative and right-associative.
 582     Both,
 583     /// The operator is left-associative.
 584     Left,
 585     /// The operator is not associative.
 586     None,
 587     /// The operator is right-associative.
 588     Right,
 589 }
 590
 591 /// Returns the associativity/fixity of an operator. The difference with
 592 /// `AssocOp::fixity` is that an operator can be both left and right associative
 593 /// (such as `+`: `a + b + c == (a + b) + c == a + (b + c)`.
 594 ///
 595 /// Chained `as` and explicit `:` type coercion never need inner parenthesis so
 596 /// they are considered
 597 /// associative.
 598 #[must_use]
 599 fn associativity(op: AssocOp) -> Associativity {
 600     use rustc_ast::util::parser::AssocOp::{
 601         Add, As, Assign, AssignOp, BitAnd, BitOr, BitXor, Colon, Divide, DotDot, DotDotEq, Equal, Greater,
 602         GreaterEqual, LAnd, LOr, Less, LessEqual, Modulus, Multiply, NotEqual, ShiftLeft, ShiftRight, Subtract,
 603     };
 604
 605     match op {
 606         Assign | AssignOp(_) => Associativity::Right,
 607         Add | BitAnd | BitOr | BitXor | LAnd | LOr | Multiply | As | Colon => Associativity::Both,
 608         Divide | Equal | Greater | GreaterEqual | Less | LessEqual | Modulus | NotEqual | ShiftLeft | ShiftRight
 609         | Subtract => Associativity::Left,
 610         DotDot | DotDotEq => Associativity::None,
 611     }
 612 }
 613
 614 /// Converts a `hir::BinOp` to the corresponding assigning binary operator.
 615 fn hirbinop2assignop(op: hir::BinOp) -> AssocOp {
 616     use rustc_ast::token::BinOpToken::{And, Caret, Minus, Or, Percent, Plus, Shl, Shr, Slash, Star};
 617
 618     AssocOp::AssignOp(match op.node {
 619         hir::BinOpKind::Add => Plus,
 620         hir::BinOpKind::BitAnd => And,
 621         hir::BinOpKind::BitOr => Or,
 622         hir::BinOpKind::BitXor => Caret,
 623         hir::BinOpKind::Div => Slash,
 624         hir::BinOpKind::Mul => Star,
 625         hir::BinOpKind::Rem => Percent,
 626         hir::BinOpKind::Shl => Shl,
 627         hir::BinOpKind::Shr => Shr,
 628         hir::BinOpKind::Sub => Minus,
 629
 630         hir::BinOpKind::And
 631         | hir::BinOpKind::Eq
 632         | hir::BinOpKind::Ge
 633         | hir::BinOpKind::Gt
 634         | hir::BinOpKind::Le
 635         | hir::BinOpKind::Lt
 636         | hir::BinOpKind::Ne
 637         | hir::BinOpKind::Or => panic!("This operator does not exist"),
 638     })
 639 }
 640
 641 /// Converts an `ast::BinOp` to the corresponding assigning binary operator.
 642 fn astbinop2assignop(op: ast::BinOp) -> AssocOp {
 643     use rustc_ast::ast::BinOpKind::{
 644         Add, And, BitAnd, BitOr, BitXor, Div, Eq, Ge, Gt, Le, Lt, Mul, Ne, Or, Rem, Shl, Shr, Sub,
 645     };
 646     use rustc_ast::token::BinOpToken;
 647
 648     AssocOp::AssignOp(match op.node {
 649         Add => BinOpToken::Plus,
 650         BitAnd => BinOpToken::And,
 651         BitOr => BinOpToken::Or,
 652         BitXor => BinOpToken::Caret,
 653         Div => BinOpToken::Slash,
 654         Mul => BinOpToken::Star,
 655         Rem => BinOpToken::Percent,
 656         Shl => BinOpToken::Shl,
 657         Shr => BinOpToken::Shr,
 658         Sub => BinOpToken::Minus,
 659         And | Eq | Ge | Gt | Le | Lt | Ne | Or => panic!("This operator does not exist"),
 660     })
 661 }
 662
 663 /// Returns the indentation before `span` if there are nothing but `[ \t]`
 664 /// before it on its line.
 665 fn indentation<T: LintContext>(cx: &T, span: Span) -> Option<String> {
 666     let lo = cx.sess().source_map().lookup_char_pos(span.lo());
 667     lo.file
 668         .get_line(lo.line - 1 /* line numbers in `Loc` are 1-based */)
 669         .and_then(|line| {
 670             if let Some((pos, _)) = line.char_indices().find(|&(_, c)| c != ' ' && c != '\t') {
 671                 // We can mix char and byte positions here because we only consider `[ \t]`.
 672                 if lo.col == CharPos(pos) {
 673                     Some(line[..pos].into())
 674                 } else {
 675                     None
 676                 }
 677             } else {
 678                 None
 679             }
 680         })
 681 }
 682
 683 /// Convenience extension trait for `Diagnostic`.
 684 pub trait DiagnosticExt<T: LintContext> {
 685     /// Suggests to add an attribute to an item.
 686     ///
 687     /// Correctly handles indentation of the attribute and item.
 688     ///
 689     /// # Example
 690     ///
 691     /// ```rust,ignore
 692     /// diag.suggest_item_with_attr(cx, item, "#[derive(Default)]");
 693     /// ```
 694     fn suggest_item_with_attr<D: Display + ?Sized>(
 695         &mut self,
 696         cx: &T,
 697         item: Span,
 698         msg: &str,
 699         attr: &D,
 700         applicability: Applicability,
 701     );
 702
 703     /// Suggest to add an item before another.
 704     ///
 705     /// The item should not be indented (except for inner indentation).
 706     ///
 707     /// # Example
 708     ///
 709     /// ```rust,ignore
 710     /// diag.suggest_prepend_item(cx, item,
 711     /// "fn foo() {
 712     ///     bar();
 713     /// }");
 714     /// ```
 715     fn suggest_prepend_item(&mut self, cx: &T, item: Span, msg: &str, new_item: &str, applicability: Applicability);
 716
 717     /// Suggest to completely remove an item.
 718     ///
 719     /// This will remove an item and all following whitespace until the next non-whitespace
 720     /// character. This should work correctly if item is on the same indentation level as the
 721     /// following item.
 722     ///
 723     /// # Example
 724     ///
 725     /// ```rust,ignore
 726     /// diag.suggest_remove_item(cx, item, "remove this")
 727     /// ```
 728     fn suggest_remove_item(&mut self, cx: &T, item: Span, msg: &str, applicability: Applicability);
 729 }
 730
 731 impl<T: LintContext> DiagnosticExt<T> for rustc_errors::Diagnostic {
 732     fn suggest_item_with_attr<D: Display + ?Sized>(
 733         &mut self,
 734         cx: &T,
 735         item: Span,
 736         msg: &str,
 737         attr: &D,
 738         applicability: Applicability,
 739     ) {
 740         if let Some(indent) = indentation(cx, item) {
 741             let span = item.with_hi(item.lo());
 742
 743             self.span_suggestion(span, msg, format!("{}\n{}", attr, indent), applicability);
 744         }
 745     }
 746
 747     fn suggest_prepend_item(&mut self, cx: &T, item: Span, msg: &str, new_item: &str, applicability: Applicability) {
 748         if let Some(indent) = indentation(cx, item) {
 749             let span = item.with_hi(item.lo());
 750
 751             let mut first = true;
 752             let new_item = new_item
 753                 .lines()
 754                 .map(|l| {
 755                     if first {
 756                         first = false;
 757                         format!("{}\n", l)
 758                     } else {
 759                         format!("{}{}\n", indent, l)
 760                     }
 761                 })
 762                 .collect::<String>();
 763
 764             self.span_suggestion(span, msg, format!("{}\n{}", new_item, indent), applicability);
 765         }
 766     }
 767
 768     fn suggest_remove_item(&mut self, cx: &T, item: Span, msg: &str, applicability: Applicability) {
 769         let mut remove_span = item;
 770         let hi = cx.sess().source_map().next_point(remove_span).hi();
 771         let fmpos = cx.sess().source_map().lookup_byte_offset(hi);
 772
 773         if let Some(ref src) = fmpos.sf.src {
 774             let non_whitespace_offset = src[fmpos.pos.to_usize()..].find(|c| c != ' ' && c != '\t' && c != '\n');
 775
 776             if let Some(non_whitespace_offset) = non_whitespace_offset {
 777                 remove_span = remove_span
 778                     .with_hi(remove_span.hi() + BytePos(non_whitespace_offset.try_into().expect("offset too large")));
 779             }
 780         }
 781
 782         self.span_suggestion(remove_span, msg, "", applicability);
 783     }
 784 }
 785
 786 /// Suggestion results for handling closure
 787 /// args dereferencing and borrowing
 788 pub struct DerefClosure {
 789     /// confidence on the built suggestion
 790     pub applicability: Applicability,
 791     /// gradually built suggestion
 792     pub suggestion: String,
 793 }
 794
 795 /// Build suggestion gradually by handling closure arg specific usages,
 796 /// such as explicit deref and borrowing cases.
 797 /// Returns `None` if no such use cases have been triggered in closure body
 798 ///
 799 /// note: this only works on single line immutable closures with exactly one input parameter.
 800 pub fn deref_closure_args<'tcx>(cx: &LateContext<'_>, closure: &'tcx hir::Expr<'_>) -> Option<DerefClosure> {
 801     if let hir::ExprKind::Closure(&Closure { fn_decl, body, .. }) = closure.kind {
 802         let closure_body = cx.tcx.hir().body(body);
 803         // is closure arg a type annotated double reference (i.e.: `|x: &&i32| ...`)
 804         // a type annotation is present if param `kind` is different from `TyKind::Infer`
 805         let closure_arg_is_type_annotated_double_ref = if let TyKind::Rptr(_, MutTy { ty, .. }) = fn_decl.inputs[0].kind
 806         {
 807             matches!(ty.kind, TyKind::Rptr(_, MutTy { .. }))
 808         } else {
 809             false
 810         };
 811
 812         let mut visitor = DerefDelegate {
 813             cx,
 814             closure_span: closure.span,
 815             closure_arg_is_type_annotated_double_ref,
 816             next_pos: closure.span.lo(),
 817             suggestion_start: String::new(),
 818             applicability: Applicability::MachineApplicable,
 819         };
 820
 821         let fn_def_id = cx.tcx.hir().local_def_id(closure.hir_id);
 822         cx.tcx.infer_ctxt().enter(|infcx| {
 823             ExprUseVisitor::new(&mut visitor, &infcx, fn_def_id, cx.param_env, cx.typeck_results())
 824                 .consume_body(closure_body);
 825         });
 826
 827         if !visitor.suggestion_start.is_empty() {
 828             return Some(DerefClosure {
 829                 applicability: visitor.applicability,
 830                 suggestion: visitor.finish(),
 831             });
 832         }
 833     }
 834     None
 835 }
 836
 837 /// Visitor struct used for tracking down
 838 /// dereferencing and borrowing of closure's args
 839 struct DerefDelegate<'a, 'tcx> {
 840     /// The late context of the lint
 841     cx: &'a LateContext<'tcx>,
 842     /// The span of the input closure to adapt
 843     closure_span: Span,
 844     /// Indicates if the arg of the closure is a type annotated double reference
 845     closure_arg_is_type_annotated_double_ref: bool,
 846     /// last position of the span to gradually build the suggestion
 847     next_pos: BytePos,
 848     /// starting part of the gradually built suggestion
 849     suggestion_start: String,
 850     /// confidence on the built suggestion
 851     applicability: Applicability,
 852 }
 853
 854 impl<'tcx> DerefDelegate<'_, 'tcx> {
 855     /// build final suggestion:
 856     /// - create the ending part of suggestion
 857     /// - concatenate starting and ending parts
 858     /// - potentially remove needless borrowing
 859     pub fn finish(&mut self) -> String {
 860         let end_span = Span::new(self.next_pos, self.closure_span.hi(), self.closure_span.ctxt(), None);
 861         let end_snip = snippet_with_applicability(self.cx, end_span, "..", &mut self.applicability);
 862         let sugg = format!("{}{}", self.suggestion_start, end_snip);
 863         if self.closure_arg_is_type_annotated_double_ref {
 864             sugg.replacen('&', "", 1)
 865         } else {
 866             sugg
 867         }
 868     }
 869
 870     /// indicates whether the function from `parent_expr` takes its args by double reference
 871     fn func_takes_arg_by_double_ref(&self, parent_expr: &'tcx hir::Expr<'_>, cmt_hir_id: HirId) -> bool {
 872         let ty = match parent_expr.kind {
 873             ExprKind::MethodCall(_, receiver, call_args, _) => {
 874                 if let Some(sig) = self
 875                     .cx
 876                     .typeck_results()
 877                     .type_dependent_def_id(parent_expr.hir_id)
 878                     .map(|did| self.cx.tcx.fn_sig(did).skip_binder())
 879                 {
 880                     std::iter::once(receiver)
 881                         .chain(call_args.iter())
 882                         .position(|arg| arg.hir_id == cmt_hir_id)
 883                         .map(|i| sig.inputs()[i])
 884                 } else {
 885                     return false;
 886                 }
 887             },
 888             ExprKind::Call(func, call_args) => {
 889                 if let Some(sig) = expr_sig(self.cx, func) {
 890                     call_args
 891                         .iter()
 892                         .position(|arg| arg.hir_id == cmt_hir_id)
 893                         .and_then(|i| sig.input(i))
 894                         .map(ty::Binder::skip_binder)
 895                 } else {
 896                     return false;
 897                 }
 898             },
 899             _ => return false,
 900         };
 901
 902         ty.map_or(false, |ty| matches!(ty.kind(), ty::Ref(_, inner, _) if inner.is_ref()))
 903     }
 904 }
 905
 906 impl<'tcx> Delegate<'tcx> for DerefDelegate<'_, 'tcx> {
 907     fn consume(&mut self, _: &PlaceWithHirId<'tcx>, _: HirId) {}
 908
 909     fn borrow(&mut self, cmt: &PlaceWithHirId<'tcx>, _: HirId, _: ty::BorrowKind) {
 910         if let PlaceBase::Local(id) = cmt.place.base {
 911             let map = self.cx.tcx.hir();
 912             let span = map.span(cmt.hir_id);
 913             let start_span = Span::new(self.next_pos, span.lo(), span.ctxt(), None);
 914             let mut start_snip = snippet_with_applicability(self.cx, start_span, "..", &mut self.applicability);
 915
 916             // identifier referring to the variable currently triggered (i.e.: `fp`)
 917             let ident_str = map.name(id).to_string();
 918             // full identifier that includes projection (i.e.: `fp.field`)
 919             let ident_str_with_proj = snippet(self.cx, span, "..").to_string();
 920
 921             if cmt.place.projections.is_empty() {
 922                 // handle item without any projection, that needs an explicit borrowing
 923                 // i.e.: suggest `&x` instead of `x`
 924                 let _ = write!(self.suggestion_start, "{}&{}", start_snip, ident_str);
 925             } else {
 926                 // cases where a parent `Call` or `MethodCall` is using the item
 927                 // i.e.: suggest `.contains(&x)` for `.find(|x| [1, 2, 3].contains(x)).is_none()`
 928                 //
 929                 // Note about method calls:
 930                 // - compiler automatically dereference references if the target type is a reference (works also for
 931                 //   function call)
 932                 // - `self` arguments in the case of `x.is_something()` are also automatically (de)referenced, and
 933                 //   no projection should be suggested
 934                 if let Some(parent_expr) = get_parent_expr_for_hir(self.cx, cmt.hir_id) {
 935                     match &parent_expr.kind {
 936                         // given expression is the self argument and will be handled completely by the compiler
 937                         // i.e.: `|x| x.is_something()`
 938                         ExprKind::MethodCall(_, self_expr, ..) if self_expr.hir_id == cmt.hir_id => {
 939                             let _ = write!(self.suggestion_start, "{}{}", start_snip, ident_str_with_proj);
 940                             self.next_pos = span.hi();
 941                             return;
 942                         },
 943                         // item is used in a call
 944                         // i.e.: `Call`: `|x| please(x)` or `MethodCall`: `|x| [1, 2, 3].contains(x)`
 945                         ExprKind::Call(_, [call_args @ ..]) | ExprKind::MethodCall(_, _, [call_args @ ..], _) => {
 946                             let expr = self.cx.tcx.hir().expect_expr(cmt.hir_id);
 947                             let arg_ty_kind = self.cx.typeck_results().expr_ty(expr).kind();
 948
 949                             if matches!(arg_ty_kind, ty::Ref(_, _, Mutability::Not)) {
 950                                 // suggest ampersand if call function is taking args by double reference
 951                                 let takes_arg_by_double_ref =
 952                                     self.func_takes_arg_by_double_ref(parent_expr, cmt.hir_id);
 953
 954                                 // compiler will automatically dereference field or index projection, so no need
 955                                 // to suggest ampersand, but full identifier that includes projection is required
 956                                 let has_field_or_index_projection =
 957                                     cmt.place.projections.iter().any(|proj| {
 958                                         matches!(proj.kind, ProjectionKind::Field(..) | ProjectionKind::Index)
 959                                     });
 960
 961                                 // no need to bind again if the function doesn't take arg by double ref
 962                                 // and if the item is already a double ref
 963                                 let ident_sugg = if !call_args.is_empty()
 964                                     && !takes_arg_by_double_ref
 965                                     && (self.closure_arg_is_type_annotated_double_ref || has_field_or_index_projection)
 966                                 {
 967                                     let ident = if has_field_or_index_projection {
 968                                         ident_str_with_proj
 969                                     } else {
 970                                         ident_str
 971                                     };
 972                                     format!("{}{}", start_snip, ident)
 973                                 } else {
 974                                     format!("{}&{}", start_snip, ident_str)
 975                                 };
 976                                 self.suggestion_start.push_str(&ident_sugg);
 977                                 self.next_pos = span.hi();
 978                                 return;
 979                             }
 980
 981                             self.applicability = Applicability::Unspecified;
 982                         },
 983                         _ => (),
 984                     }
 985                 }
 986
 987                 let mut replacement_str = ident_str;
 988                 let mut projections_handled = false;
 989                 cmt.place.projections.iter().enumerate().for_each(|(i, proj)| {
 990                     match proj.kind {
 991                         // Field projection like `|v| v.foo`
 992                         // no adjustment needed here, as field projections are handled by the compiler
 993                         ProjectionKind::Field(..) => match cmt.place.ty_before_projection(i).kind() {
 994                             ty::Adt(..) | ty::Tuple(_) => {
 995                                 replacement_str = ident_str_with_proj.clone();
 996                                 projections_handled = true;
 997                             },
 998                             _ => (),
 999                         },
1000                         // Index projection like `|x| foo[x]`
1001                         // the index is dropped so we can't get it to build the suggestion,
1002                         // so the span is set-up again to get more code, using `span.hi()` (i.e.: `foo[x]`)
1003                         // instead of `span.lo()` (i.e.: `foo`)
1004                         ProjectionKind::Index => {
1005                             let start_span = Span::new(self.next_pos, span.hi(), span.ctxt(), None);
1006                             start_snip = snippet_with_applicability(self.cx, start_span, "..", &mut self.applicability);
1007                             replacement_str.clear();
1008                             projections_handled = true;
1009                         },
1010                         // note: unable to trigger `Subslice` kind in tests
1011                         ProjectionKind::Subslice => (),
1012                         ProjectionKind::Deref => {
1013                             // Explicit derefs are typically handled later on, but
1014                             // some items do not need explicit deref, such as array accesses,
1015                             // so we mark them as already processed
1016                             // i.e.: don't suggest `*sub[1..4].len()` for `|sub| sub[1..4].len() == 3`
1017                             if let ty::Ref(_, inner, _) = cmt.place.ty_before_projection(i).kind() {
1018                                 if matches!(inner.kind(), ty::Ref(_, innermost, _) if innermost.is_array()) {
1019                                     projections_handled = true;
1020                                 }
1021                             }
1022                         },
1023                     }
1024                 });
1025
1026                 // handle `ProjectionKind::Deref` by removing one explicit deref
1027                 // if no special case was detected (i.e.: suggest `*x` instead of `**x`)
1028                 if !projections_handled {
1029                     let last_deref = cmt
1030                         .place
1031                         .projections
1032                         .iter()
1033                         .rposition(|proj| proj.kind == ProjectionKind::Deref);
1034
1035                     if let Some(pos) = last_deref {
1036                         let mut projections = cmt.place.projections.clone();
1037                         projections.truncate(pos);
1038
1039                         for item in projections {
1040                             if item.kind == ProjectionKind::Deref {
1041                                 replacement_str = format!("*{}", replacement_str);
1042                             }
1043                         }
1044                     }
1045                 }
1046
1047                 let _ = write!(self.suggestion_start, "{}{}", start_snip, replacement_str);
1048             }
1049             self.next_pos = span.hi();
1050         }
1051     }
1052
1053     fn mutate(&mut self, _: &PlaceWithHirId<'tcx>, _: HirId) {}
1054
1055     fn fake_read(&mut self, _: &rustc_typeck::expr_use_visitor::PlaceWithHirId<'tcx>, _: FakeReadCause, _: HirId) {}
1056 }
1057
1058 #[cfg(test)]
1059 mod test {
1060     use super::Sugg;
1061
1062     use rustc_ast::util::parser::AssocOp;
1063     use std::borrow::Cow;
1064
1065     const SUGGESTION: Sugg<'static> = Sugg::NonParen(Cow::Borrowed("function_call()"));
1066
1067     #[test]
1068     fn make_return_transform_sugg_into_a_return_call() {
1069         assert_eq!("return function_call()", SUGGESTION.make_return().to_string());
1070     }
1071
1072     #[test]
1073     fn blockify_transforms_sugg_into_a_block() {
1074         assert_eq!("{ function_call() }", SUGGESTION.blockify().to_string());
1075     }
1076
1077     #[test]
1078     fn binop_maybe_par() {
1079         let sugg = Sugg::BinOp(AssocOp::Add, "1".into(), "1".into());
1080         assert_eq!("(1 + 1)", sugg.maybe_par().to_string());
1081
1082         let sugg = Sugg::BinOp(AssocOp::Add, "(1 + 1)".into(), "(1 + 1)".into());
1083         assert_eq!("((1 + 1) + (1 + 1))", sugg.maybe_par().to_string());
1084     }
1085     #[test]
1086     fn not_op() {
1087         use AssocOp::{Add, Equal, Greater, GreaterEqual, LAnd, LOr, Less, LessEqual, NotEqual};
1088
1089         fn test_not(op: AssocOp, correct: &str) {
1090             let sugg = Sugg::BinOp(op, "x".into(), "y".into());
1091             assert_eq!((!sugg).to_string(), correct);
1092         }
1093
1094         // Invert the comparison operator.
1095         test_not(Equal, "x != y");
1096         test_not(NotEqual, "x == y");
1097         test_not(Less, "x >= y");
1098         test_not(LessEqual, "x > y");
1099         test_not(Greater, "x <= y");
1100         test_not(GreaterEqual, "x < y");
1101
1102         // Other operators are inverted like !(..).
1103         test_not(Add, "!(x + y)");
1104         test_not(LAnd, "!(x && y)");
1105         test_not(LOr, "!(x || y)");
1106     }
1107 }