clippy_lints/src/inconsistent_struct_constructor.rs

   1 use rustc_data_structures::fx::FxHashMap;
   2 use rustc_errors::Applicability;
   3 use rustc_hir::{self as hir, ExprKind};
   4 use rustc_lint::{LateContext, LateLintPass};
   5 use rustc_session::{declare_lint_pass, declare_tool_lint};
   6 use rustc_span::symbol::Symbol;
   7
   8 use if_chain::if_chain;
   9
  10 use crate::utils::{snippet, span_lint_and_sugg};
  11
  12 declare_clippy_lint! {
  13     /// **What it does:** Checks for struct constructors where all fields are shorthand and
  14     /// the order of the field init shorthand in the constructor is inconsistent
  15     /// with the order in the struct definition.
  16     ///
  17     /// **Why is this bad?** Since the order of fields in a constructor doesn't affect the
  18     /// resulted instance as the below example indicates,
  19     ///
  20     /// ```rust
  21     /// #[derive(Debug, PartialEq, Eq)]
  22     /// struct Foo {
  23     ///     x: i32,
  24     ///     y: i32,
  25     /// }
  26     /// let x = 1;
  27     /// let y = 2;
  28     ///
  29     /// // This assertion never fails:
  30     /// assert_eq!(Foo { x, y }, Foo { y, x });
  31     /// ```
  32     ///
  33     /// inconsistent order can be confusing and decreases readability and consistency.
  34     ///
  35     /// **Known problems:** None.
  36     ///
  37     /// **Example:**
  38     ///
  39     /// ```rust
  40     /// struct Foo {
  41     ///     x: i32,
  42     ///     y: i32,
  43     /// }
  44     /// let x = 1;
  45     /// let y = 2;
  46     ///
  47     /// Foo { y, x };
  48     /// ```
  49     ///
  50     /// Use instead:
  51     /// ```rust
  52     /// # struct Foo {
  53     /// #     x: i32,
  54     /// #     y: i32,
  55     /// # }
  56     /// # let x = 1;
  57     /// # let y = 2;
  58     /// Foo { x, y };
  59     /// ```
  60     pub INCONSISTENT_STRUCT_CONSTRUCTOR,
  61     style,
  62     "the order of the field init shorthand is inconsistent with the order in the struct definition"
  63 }
  64
  65 declare_lint_pass!(InconsistentStructConstructor => [INCONSISTENT_STRUCT_CONSTRUCTOR]);
  66
  67 impl LateLintPass<'_> for InconsistentStructConstructor {
  68     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx hir::Expr<'_>) {
  69         if_chain! {
  70             if let ExprKind::Struct(qpath, fields, base) = expr.kind;
  71             let ty = cx.typeck_results().expr_ty(expr);
  72             if let Some(adt_def) = ty.ty_adt_def();
  73             if adt_def.is_struct();
  74             if let Some(variant) = adt_def.variants.iter().next();
  75             if fields.iter().all(|f| f.is_shorthand);
  76             then {
  77                 let mut def_order_map = FxHashMap::default();
  78                 for (idx, field) in variant.fields.iter().enumerate() {
  79                     def_order_map.insert(field.ident.name, idx);
  80                 }
  81
  82                 if is_consistent_order(fields, &def_order_map) {
  83                     return;
  84                 }
  85
  86                 let mut ordered_fields: Vec<_> = fields.iter().map(|f| f.ident.name).collect();
  87                 ordered_fields.sort_unstable_by_key(|id| def_order_map[id]);
  88
  89                 let mut fields_snippet = String::new();
  90                 let (last_ident, idents) = ordered_fields.split_last().unwrap();
  91                 for ident in idents {
  92                     fields_snippet.push_str(&format!("{}, ", ident));
  93                 }
  94                 fields_snippet.push_str(&last_ident.to_string());
  95
  96                 let base_snippet = if let Some(base) = base {
  97                         format!(", ..{}", snippet(cx, base.span, ".."))
  98                     } else {
  99                         String::new()
 100                     };
 101
 102                 let sugg = format!("{} {{ {}{} }}",
 103                     snippet(cx, qpath.span(), ".."),
 104                     fields_snippet,
 105                     base_snippet,
 106                     );
 107
 108                 span_lint_and_sugg(
 109                     cx,
 110                     INCONSISTENT_STRUCT_CONSTRUCTOR,
 111                     expr.span,
 112                     "struct constructor field order is inconsistent with struct definition field order",
 113                     "try",
 114                     sugg,
 115                     Applicability::MachineApplicable,
 116                 )
 117             }
 118         }
 119     }
 120 }
 121
 122 // Check whether the order of the fields in the constructor is consistent with the order in the
 123 // definition.
 124 fn is_consistent_order<'tcx>(fields: &'tcx [hir::Field<'tcx>], def_order_map: &FxHashMap<Symbol, usize>) -> bool {
 125     let mut cur_idx = usize::MIN;
 126     for f in fields {
 127         let next_idx = def_order_map[&f.ident.name];
 128         if cur_idx > next_idx {
 129             return false;
 130         }
 131         cur_idx = next_idx;
 132     }
 133
 134     true
 135 }