clippy_lints/src/new_without_default.rs

   1 use rustc::hir::intravisit::FnKind;
   2 use rustc::hir::def_id::DefId;
   3 use rustc::hir;
   4 use rustc::lint::*;
   5 use rustc::ty::{self, Ty};
   6 use syntax::ast;
   7 use syntax::codemap::Span;
   8 use utils::paths;
   9 use utils::{get_trait_def_id, implements_trait, in_external_macro, return_ty, same_tys, span_lint_and_then};
  10 use utils::sugg::DiagnosticBuilderExt;
  11
  12 /// **What it does:** Checks for types with a `fn new() -> Self` method and no
  13 /// implementation of
  14 /// [`Default`](https://doc.rust-lang.org/std/default/trait.Default.html).
  15 ///
  16 /// **Why is this bad?** The user might expect to be able to use
  17 /// [`Default`](https://doc.rust-lang.org/std/default/trait.Default.html) as the
  18 /// type can be constructed without arguments.
  19 ///
  20 /// **Known problems:** Hopefully none.
  21 ///
  22 /// **Example:**
  23 ///
  24 /// ```rust,ignore
  25 /// struct Foo(Bar);
  26 ///
  27 /// impl Foo {
  28 ///     fn new() -> Self {
  29 ///         Foo(Bar::new())
  30 ///     }
  31 /// }
  32 /// ```
  33 ///
  34 /// Instead, use:
  35 ///
  36 /// ```rust
  37 /// struct Foo(Bar);
  38 ///
  39 /// impl Default for Foo {
  40 ///     fn default() -> Self {
  41 ///         Foo(Bar::new())
  42 ///     }
  43 /// }
  44 /// ```
  45 ///
  46 /// You can also have `new()` call `Default::default()`.
  47 declare_lint! {
  48     pub NEW_WITHOUT_DEFAULT,
  49     Warn,
  50     "`fn new() -> Self` method without `Default` implementation"
  51 }
  52
  53 /// **What it does:** Checks for types with a `fn new() -> Self` method
  54 /// and no implementation of
  55 /// [`Default`](https://doc.rust-lang.org/std/default/trait.Default.html),
  56 /// where the `Default` can be derived by `#[derive(Default)]`.
  57 ///
  58 /// **Why is this bad?** The user might expect to be able to use
  59 /// [`Default`](https://doc.rust-lang.org/std/default/trait.Default.html) as the
  60 /// type can be constructed without arguments.
  61 ///
  62 /// **Known problems:** Hopefully none.
  63 ///
  64 /// **Example:**
  65 ///
  66 /// ```rust,ignore
  67 /// struct Foo;
  68 ///
  69 /// impl Foo {
  70 ///     fn new() -> Self {
  71 ///         Foo
  72 ///     }
  73 /// }
  74 /// ```
  75 ///
  76 /// Just prepend `#[derive(Default)]` before the `struct` definition.
  77 declare_lint! {
  78     pub NEW_WITHOUT_DEFAULT_DERIVE,
  79     Warn,
  80     "`fn new() -> Self` without `#[derive]`able `Default` implementation"
  81 }
  82
  83 #[derive(Copy, Clone)]
  84 pub struct NewWithoutDefault;
  85
  86 impl LintPass for NewWithoutDefault {
  87     fn get_lints(&self) -> LintArray {
  88         lint_array!(NEW_WITHOUT_DEFAULT, NEW_WITHOUT_DEFAULT_DERIVE)
  89     }
  90 }
  91
  92 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for NewWithoutDefault {
  93     fn check_fn(
  94         &mut self,
  95         cx: &LateContext<'a, 'tcx>,
  96         kind: FnKind<'tcx>,
  97         decl: &'tcx hir::FnDecl,
  98         _: &'tcx hir::Body,
  99         span: Span,
 100         id: ast::NodeId,
 101     ) {
 102         if in_external_macro(cx, span) {
 103             return;
 104         }
 105
 106         if let FnKind::Method(name, sig, _, _) = kind {
 107             if sig.constness == hir::Constness::Const {
 108                 // can't be implemented by default
 109                 return;
 110             }
 111             if !cx.generics
 112                 .expect("method must have generics")
 113                 .ty_params
 114                 .is_empty()
 115             {
 116                 // when the result of `new()` depends on a type parameter we should not require
 117                 // an
 118                 // impl of `Default`
 119                 return;
 120             }
 121             if decl.inputs.is_empty() && name == "new" && cx.access_levels.is_reachable(id) {
 122                 let self_ty = cx.tcx
 123                     .type_of(cx.tcx.hir.local_def_id(cx.tcx.hir.get_parent(id)));
 124                 if_chain! {
 125                     if same_tys(cx, self_ty, return_ty(cx, id));
 126                     if let Some(default_trait_id) = get_trait_def_id(cx, &paths::DEFAULT_TRAIT);
 127                     if !implements_trait(cx, self_ty, default_trait_id, &[]);
 128                     then {
 129                         if let Some(sp) = can_derive_default(self_ty, cx, default_trait_id) {
 130                             span_lint_and_then(
 131                                 cx,
 132                                 NEW_WITHOUT_DEFAULT_DERIVE,
 133                                 span,
 134                                 &format!("you should consider deriving a `Default` implementation for `{}`", self_ty),
 135                                 |db| {
 136                                     db.suggest_item_with_attr(cx, sp, "try this", "#[derive(Default)]");
 137                                 });
 138                         } else {
 139                             span_lint_and_then(
 140                                 cx,
 141                                 NEW_WITHOUT_DEFAULT,
 142                                 span,
 143                                 &format!("you should consider adding a `Default` implementation for `{}`", self_ty),
 144                                 |db| {
 145                                     db.suggest_prepend_item(
 146                                         cx,
 147                                         span,
 148                                         "try this",
 149                                         &create_new_without_default_suggest_msg(self_ty),
 150                                     );
 151                                 },
 152                             );
 153                         }
 154                     }
 155                 }
 156             }
 157         }
 158     }
 159 }
 160
 161 fn create_new_without_default_suggest_msg(ty: Ty) -> String {
 162     #[rustfmt_skip]
 163     format!(
 164 "impl Default for {} {{
 165     fn default() -> Self {{
 166         Self::new()
 167     }}
 168 }}", ty)
 169 }
 170
 171 fn can_derive_default<'t, 'c>(ty: Ty<'t>, cx: &LateContext<'c, 't>, default_trait_id: DefId) -> Option<Span> {
 172     match ty.sty {
 173         ty::TyAdt(adt_def, substs) if adt_def.is_struct() => {
 174             for field in adt_def.all_fields() {
 175                 let f_ty = field.ty(cx.tcx, substs);
 176                 if !implements_trait(cx, f_ty, default_trait_id, &[]) {
 177                     return None;
 178                 }
 179             }
 180             Some(cx.tcx.def_span(adt_def.did))
 181         },
 182         _ => None,
 183     }
 184 }