1 use crate::utils::{in_macro, span_lint_and_sugg};
2 use if_chain::if_chain;
3 use rustc_ast::ast::{BindingMode, Lifetime, Mutability, Param, PatKind, Path, TyKind};
4 use rustc_errors::Applicability;
5 use rustc_lint::{EarlyContext, EarlyLintPass};
6 use rustc_session::{declare_lint_pass, declare_tool_lint};
7 use rustc_span::symbol::kw;
10 declare_clippy_lint! {
11 /// **What it does:** The lint checks for `self` in fn parameters that
12 /// specify the `Self`-type explicitly
13 /// **Why is this bad?** Increases the amount and decreases the readability of code
15 /// **Known problems:** None
27 /// pub fn bytes(self: Self) -> usize {
29 /// Self::I32 | Self::F32 => 4,
30 /// Self::I64 | Self::F64 => 8,
36 /// Could be rewritten as
47 /// pub fn bytes(self) -> usize {
49 /// Self::I32 | Self::F32 => 4,
50 /// Self::I64 | Self::F64 => 8,
55 pub NEEDLESS_ARBITRARY_SELF_TYPE,
57 "type of `self` parameter is already by default `Self`"
60 declare_lint_pass!(NeedlessArbitrarySelfType => [NEEDLESS_ARBITRARY_SELF_TYPE]);
63 Ref(Option<Lifetime>),
67 fn check_param_inner(cx: &EarlyContext<'_>, path: &Path, span: Span, binding_mode: &Mode, mutbl: Mutability) {
69 if let [segment] = &path.segments[..];
70 if segment.ident.name == kw::SelfUpper;
72 // In case we have a named lifetime, we check if the name comes from expansion.
73 // If it does, at this point we know the rest of the parameter was written by the user,
74 // so let them decide what the name of the lifetime should be.
75 // See #6089 for more details.
76 let mut applicability = Applicability::MachineApplicable;
77 let self_param = match (binding_mode, mutbl) {
78 (Mode::Ref(None), Mutability::Mut) => "&mut self".to_string(),
79 (Mode::Ref(Some(lifetime)), Mutability::Mut) => {
80 if in_macro(lifetime.ident.span) {
81 applicability = Applicability::HasPlaceholders;
82 "&'_ mut self".to_string()
84 format!("&{} mut self", &lifetime.ident.name)
87 (Mode::Ref(None), Mutability::Not) => "&self".to_string(),
88 (Mode::Ref(Some(lifetime)), Mutability::Not) => {
89 if in_macro(lifetime.ident.span) {
90 applicability = Applicability::HasPlaceholders;
91 "&'_ self".to_string()
93 format!("&{} self", &lifetime.ident.name)
96 (Mode::Value, Mutability::Mut) => "mut self".to_string(),
97 (Mode::Value, Mutability::Not) => "self".to_string(),
102 NEEDLESS_ARBITRARY_SELF_TYPE,
104 "the type of the `self` parameter does not need to be arbitrary",
105 "consider to change this parameter to",
113 impl EarlyLintPass for NeedlessArbitrarySelfType {
114 fn check_param(&mut self, cx: &EarlyContext<'_>, p: &Param) {
115 // Bail out if the parameter it's not a receiver or was not written by the user
116 if !p.is_self() || in_macro(p.span) {
121 TyKind::Path(None, path) => {
122 if let PatKind::Ident(BindingMode::ByValue(mutbl), _, _) = p.pat.kind {
123 check_param_inner(cx, path, p.span.to(p.ty.span), &Mode::Value, mutbl)
126 TyKind::Rptr(lifetime, mut_ty) => {
128 if let TyKind::Path(None, path) = &mut_ty.ty.kind;
129 if let PatKind::Ident(BindingMode::ByValue(Mutability::Not), _, _) = p.pat.kind;
131 check_param_inner(cx, path, p.span.to(p.ty.span), &Mode::Ref(*lifetime), mut_ty.mutbl)