clippy_lints/src/ptr.rs

   1 //! Checks for usage of  `&Vec[_]` and `&String`.
   2
   3 use crate::utils::ptr::get_spans;
   4 use crate::utils::{match_qpath, match_type, paths, snippet_opt, span_lint, span_lint_and_then, walk_ptrs_hir_ty};
   5 use if_chain::if_chain;
   6 use rustc::hir::QPath;
   7 use rustc::hir::*;
   8 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
   9 use rustc::ty;
  10 use rustc::{declare_tool_lint, lint_array};
  11 use rustc_errors::Applicability;
  12 use std::borrow::Cow;
  13 use syntax::ast::NodeId;
  14 use syntax::source_map::Span;
  15 use syntax_pos::MultiSpan;
  16
  17 /// **What it does:** This lint checks for function arguments of type `&String`
  18 /// or `&Vec` unless the references are mutable. It will also suggest you
  19 /// replace `.clone()` calls with the appropriate `.to_owned()`/`to_string()`
  20 /// calls.
  21 ///
  22 /// **Why is this bad?** Requiring the argument to be of the specific size
  23 /// makes the function less useful for no benefit; slices in the form of `&[T]`
  24 /// or `&str` usually suffice and can be obtained from other types, too.
  25 ///
  26 /// **Known problems:** The lint does not follow data. So if you have an
  27 /// argument `x` and write `let y = x; y.clone()` the lint will not suggest
  28 /// changing that `.clone()` to `.to_owned()`.
  29 ///
  30 /// Other functions called from this function taking a `&String` or `&Vec`
  31 /// argument may also fail to compile if you change the argument. Applying
  32 /// this lint on them will fix the problem, but they may be in other crates.
  33 ///
  34 /// Also there may be `fn(&Vec)`-typed references pointing to your function.
  35 /// If you have them, you will get a compiler error after applying this lint's
  36 /// suggestions. You then have the choice to undo your changes or change the
  37 /// type of the reference.
  38 ///
  39 /// Note that if the function is part of your public interface, there may be
  40 /// other crates referencing it you may not be aware. Carefully deprecate the
  41 /// function before applying the lint suggestions in this case.
  42 ///
  43 /// **Example:**
  44 /// ```rust
  45 /// fn foo(&Vec<u32>) { .. }
  46 /// ```
  47 declare_clippy_lint! {
  48     pub PTR_ARG,
  49     style,
  50     "fn arguments of the type `&Vec<...>` or `&String`, suggesting to use `&[...]` or `&str` instead, respectively"
  51 }
  52
  53 /// **What it does:** This lint checks for equality comparisons with `ptr::null`
  54 ///
  55 /// **Why is this bad?** It's easier and more readable to use the inherent
  56 /// `.is_null()`
  57 /// method instead
  58 ///
  59 /// **Known problems:** None.
  60 ///
  61 /// **Example:**
  62 /// ```rust
  63 /// if x == ptr::null {
  64 ///     ..
  65 /// }
  66 /// ```
  67 declare_clippy_lint! {
  68     pub CMP_NULL,
  69     style,
  70     "comparing a pointer to a null pointer, suggesting to use `.is_null()` instead."
  71 }
  72
  73 /// **What it does:** This lint checks for functions that take immutable
  74 /// references and return
  75 /// mutable ones.
  76 ///
  77 /// **Why is this bad?** This is trivially unsound, as one can create two
  78 /// mutable references
  79 /// from the same (immutable!) source. This
  80 /// [error](https://github.com/rust-lang/rust/issues/39465)
  81 /// actually lead to an interim Rust release 1.15.1.
  82 ///
  83 /// **Known problems:** To be on the conservative side, if there's at least one
  84 /// mutable reference
  85 /// with the output lifetime, this lint will not trigger. In practice, this
  86 /// case is unlikely anyway.
  87 ///
  88 /// **Example:**
  89 /// ```rust
  90 /// fn foo(&Foo) -> &mut Bar { .. }
  91 /// ```
  92 declare_clippy_lint! {
  93     pub MUT_FROM_REF,
  94     correctness,
  95     "fns that create mutable refs from immutable ref args"
  96 }
  97
  98 #[derive(Copy, Clone)]
  99 pub struct PointerPass;
 100
 101 impl LintPass for PointerPass {
 102     fn get_lints(&self) -> LintArray {
 103         lint_array!(PTR_ARG, CMP_NULL, MUT_FROM_REF)
 104     }
 105
 106     fn name(&self) -> &'static str {
 107         "Ptr"
 108     }
 109 }
 110
 111 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for PointerPass {
 112     fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx Item) {
 113         if let ItemKind::Fn(ref decl, _, _, body_id) = item.node {
 114             check_fn(cx, decl, item.id, Some(body_id));
 115         }
 116     }
 117
 118     fn check_impl_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx ImplItem) {
 119         if let ImplItemKind::Method(ref sig, body_id) = item.node {
 120             if let Some(Node::Item(it)) = cx.tcx.hir().find(cx.tcx.hir().get_parent(item.id)) {
 121                 if let ItemKind::Impl(_, _, _, _, Some(_), _, _) = it.node {
 122                     return; // ignore trait impls
 123                 }
 124             }
 125             check_fn(cx, &sig.decl, item.id, Some(body_id));
 126         }
 127     }
 128
 129     fn check_trait_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx TraitItem) {
 130         if let TraitItemKind::Method(ref sig, ref trait_method) = item.node {
 131             let body_id = if let TraitMethod::Provided(b) = *trait_method {
 132                 Some(b)
 133             } else {
 134                 None
 135             };
 136             check_fn(cx, &sig.decl, item.id, body_id);
 137         }
 138     }
 139
 140     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
 141         if let ExprKind::Binary(ref op, ref l, ref r) = expr.node {
 142             if (op.node == BinOpKind::Eq || op.node == BinOpKind::Ne) && (is_null_path(l) || is_null_path(r)) {
 143                 span_lint(
 144                     cx,
 145                     CMP_NULL,
 146                     expr.span,
 147                     "Comparing with null is better expressed by the .is_null() method",
 148                 );
 149             }
 150         }
 151     }
 152 }
 153
 154 fn check_fn(cx: &LateContext<'_, '_>, decl: &FnDecl, fn_id: NodeId, opt_body_id: Option<BodyId>) {
 155     let fn_def_id = cx.tcx.hir().local_def_id(fn_id);
 156     let sig = cx.tcx.fn_sig(fn_def_id);
 157     let fn_ty = sig.skip_binder();
 158
 159     for (idx, (arg, ty)) in decl.inputs.iter().zip(fn_ty.inputs()).enumerate() {
 160         if let ty::Ref(_, ty, MutImmutable) = ty.sty {
 161             if match_type(cx, ty, &paths::VEC) {
 162                 let mut ty_snippet = None;
 163                 if_chain! {
 164                     if let TyKind::Path(QPath::Resolved(_, ref path)) = walk_ptrs_hir_ty(arg).node;
 165                     if let Some(&PathSegment{args: Some(ref parameters), ..}) = path.segments.last();
 166                     then {
 167                         let types: Vec<_> = parameters.args.iter().filter_map(|arg| match arg {
 168                             GenericArg::Type(ty) => Some(ty),
 169                             _ => None,
 170                         }).collect();
 171                         if types.len() == 1 {
 172                             ty_snippet = snippet_opt(cx, types[0].span);
 173                         }
 174                     }
 175                 };
 176                 if let Some(spans) = get_spans(cx, opt_body_id, idx, &[("clone", ".to_owned()")]) {
 177                     span_lint_and_then(
 178                         cx,
 179                         PTR_ARG,
 180                         arg.span,
 181                         "writing `&Vec<_>` instead of `&[_]` involves one more reference and cannot be used \
 182                          with non-Vec-based slices.",
 183                         |db| {
 184                             if let Some(ref snippet) = ty_snippet {
 185                                 db.span_suggestion(
 186                                     arg.span,
 187                                     "change this to",
 188                                     format!("&[{}]", snippet),
 189                                     Applicability::Unspecified,
 190                                 );
 191                             }
 192                             for (clonespan, suggestion) in spans {
 193                                 db.span_suggestion(
 194                                     clonespan,
 195                                     &snippet_opt(cx, clonespan).map_or("change the call to".into(), |x| {
 196                                         Cow::Owned(format!("change `{}` to", x))
 197                                     }),
 198                                     suggestion.into(),
 199                                     Applicability::Unspecified,
 200                                 );
 201                             }
 202                         },
 203                     );
 204                 }
 205             } else if match_type(cx, ty, &paths::STRING) {
 206                 if let Some(spans) = get_spans(cx, opt_body_id, idx, &[("clone", ".to_string()"), ("as_str", "")]) {
 207                     span_lint_and_then(
 208                         cx,
 209                         PTR_ARG,
 210                         arg.span,
 211                         "writing `&String` instead of `&str` involves a new object where a slice will do.",
 212                         |db| {
 213                             db.span_suggestion(arg.span, "change this to", "&str".into(), Applicability::Unspecified);
 214                             for (clonespan, suggestion) in spans {
 215                                 db.span_suggestion_short(
 216                                     clonespan,
 217                                     &snippet_opt(cx, clonespan).map_or("change the call to".into(), |x| {
 218                                         Cow::Owned(format!("change `{}` to", x))
 219                                     }),
 220                                     suggestion.into(),
 221                                     Applicability::Unspecified,
 222                                 );
 223                             }
 224                         },
 225                     );
 226                 }
 227             } else if match_type(cx, ty, &paths::COW) {
 228                 if_chain! {
 229                     if let TyKind::Rptr(_, MutTy { ref ty, ..} ) = arg.node;
 230                     if let TyKind::Path(ref path) = ty.node;
 231                     if let QPath::Resolved(None, ref pp) = *path;
 232                     if let [ref bx] = *pp.segments;
 233                     if let Some(ref params) = bx.args;
 234                     if !params.parenthesized;
 235                     if let Some(inner) = params.args.iter().find_map(|arg| match arg {
 236                         GenericArg::Type(ty) => Some(ty),
 237                         GenericArg::Lifetime(_) => None,
 238                     });
 239                     then {
 240                         let replacement = snippet_opt(cx, inner.span);
 241                         if let Some(r) = replacement {
 242                             span_lint_and_then(
 243                                 cx,
 244                                 PTR_ARG,
 245                                 arg.span,
 246                                 "using a reference to `Cow` is not recommended.",
 247                                 |db| {
 248                                     db.span_suggestion(
 249                                         arg.span,
 250                                         "change this to",
 251                                         "&".to_owned() + &r,
 252                                         Applicability::Unspecified,
 253                                     );
 254                                 },
 255                             );
 256                         }
 257                     }
 258                 }
 259             }
 260         }
 261     }
 262
 263     if let FunctionRetTy::Return(ref ty) = decl.output {
 264         if let Some((out, MutMutable, _)) = get_rptr_lm(ty) {
 265             let mut immutables = vec![];
 266             for (_, ref mutbl, ref argspan) in decl
 267                 .inputs
 268                 .iter()
 269                 .filter_map(|ty| get_rptr_lm(ty))
 270                 .filter(|&(lt, _, _)| lt.name == out.name)
 271             {
 272                 if *mutbl == MutMutable {
 273                     return;
 274                 }
 275                 immutables.push(*argspan);
 276             }
 277             if immutables.is_empty() {
 278                 return;
 279             }
 280             span_lint_and_then(
 281                 cx,
 282                 MUT_FROM_REF,
 283                 ty.span,
 284                 "mutable borrow from immutable input(s)",
 285                 |db| {
 286                     let ms = MultiSpan::from_spans(immutables);
 287                     db.span_note(ms, "immutable borrow here");
 288                 },
 289             );
 290         }
 291     }
 292 }
 293
 294 fn get_rptr_lm(ty: &Ty) -> Option<(&Lifetime, Mutability, Span)> {
 295     if let TyKind::Rptr(ref lt, ref m) = ty.node {
 296         Some((lt, m.mutbl, ty.span))
 297     } else {
 298         None
 299     }
 300 }
 301
 302 fn is_null_path(expr: &Expr) -> bool {
 303     if let ExprKind::Call(ref pathexp, ref args) = expr.node {
 304         if args.is_empty() {
 305             if let ExprKind::Path(ref path) = pathexp.node {
 306                 return match_qpath(path, &paths::PTR_NULL) || match_qpath(path, &paths::PTR_NULL_MUT);
 307             }
 308         }
 309     }
 310     false
 311 }