]> git.lizzy.rs Git - rust.git/blob - clippy_lints/src/functions.rs
Auto merge of #3987 - phansch:rustfix_option_map_or_none, r=flip1995
[rust.git] / clippy_lints / src / functions.rs
1 use crate::utils::{iter_input_pats, snippet, span_lint, type_is_unsafe_function};
2 use matches::matches;
3 use rustc::hir;
4 use rustc::hir::def::Def;
5 use rustc::hir::intravisit;
6 use rustc::lint::{in_external_macro, LateContext, LateLintPass, LintArray, LintContext, LintPass};
7 use rustc::ty;
8 use rustc::{declare_tool_lint, impl_lint_pass};
9 use rustc_data_structures::fx::FxHashSet;
10 use rustc_target::spec::abi::Abi;
11 use syntax::source_map::Span;
12
13 declare_clippy_lint! {
14     /// **What it does:** Checks for functions with too many parameters.
15     ///
16     /// **Why is this bad?** Functions with lots of parameters are considered bad
17     /// style and reduce readability (“what does the 5th parameter mean?”). Consider
18     /// grouping some parameters into a new type.
19     ///
20     /// **Known problems:** None.
21     ///
22     /// **Example:**
23     /// ```rust
24     /// fn foo(x: u32, y: u32, name: &str, c: Color, w: f32, h: f32, a: f32, b: f32) {
25     ///     ..
26     /// }
27     /// ```
28     pub TOO_MANY_ARGUMENTS,
29     complexity,
30     "functions with too many arguments"
31 }
32
33 declare_clippy_lint! {
34     /// **What it does:** Checks for functions with a large amount of lines.
35     ///
36     /// **Why is this bad?** Functions with a lot of lines are harder to understand
37     /// due to having to look at a larger amount of code to understand what the
38     /// function is doing. Consider splitting the body of the function into
39     /// multiple functions.
40     ///
41     /// **Known problems:** None.
42     ///
43     /// **Example:**
44     /// ``` rust
45     /// fn im_too_long() {
46     /// println!("");
47     /// // ... 100 more LoC
48     /// println!("");
49     /// }
50     /// ```
51     pub TOO_MANY_LINES,
52     pedantic,
53     "functions with too many lines"
54 }
55
56 declare_clippy_lint! {
57     /// **What it does:** Checks for public functions that dereferences raw pointer
58     /// arguments but are not marked unsafe.
59     ///
60     /// **Why is this bad?** The function should probably be marked `unsafe`, since
61     /// for an arbitrary raw pointer, there is no way of telling for sure if it is
62     /// valid.
63     ///
64     /// **Known problems:**
65     ///
66     /// * It does not check functions recursively so if the pointer is passed to a
67     /// private non-`unsafe` function which does the dereferencing, the lint won't
68     /// trigger.
69     /// * It only checks for arguments whose type are raw pointers, not raw pointers
70     /// got from an argument in some other way (`fn foo(bar: &[*const u8])` or
71     /// `some_argument.get_raw_ptr()`).
72     ///
73     /// **Example:**
74     /// ```rust
75     /// pub fn foo(x: *const u8) {
76     ///     println!("{}", unsafe { *x });
77     /// }
78     /// ```
79     pub NOT_UNSAFE_PTR_ARG_DEREF,
80     correctness,
81     "public functions dereferencing raw pointer arguments but not marked `unsafe`"
82 }
83
84 #[derive(Copy, Clone)]
85 pub struct Functions {
86     threshold: u64,
87     max_lines: u64,
88 }
89
90 impl Functions {
91     pub fn new(threshold: u64, max_lines: u64) -> Self {
92         Self { threshold, max_lines }
93     }
94 }
95
96 impl_lint_pass!(Functions => [TOO_MANY_ARGUMENTS, TOO_MANY_LINES, NOT_UNSAFE_PTR_ARG_DEREF]);
97
98 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Functions {
99     fn check_fn(
100         &mut self,
101         cx: &LateContext<'a, 'tcx>,
102         kind: intravisit::FnKind<'tcx>,
103         decl: &'tcx hir::FnDecl,
104         body: &'tcx hir::Body,
105         span: Span,
106         hir_id: hir::HirId,
107     ) {
108         let is_impl = if let Some(hir::Node::Item(item)) = cx
109             .tcx
110             .hir()
111             .find_by_hir_id(cx.tcx.hir().get_parent_node_by_hir_id(hir_id))
112         {
113             matches!(item.node, hir::ItemKind::Impl(_, _, _, _, Some(_), _, _))
114         } else {
115             false
116         };
117
118         let unsafety = match kind {
119             hir::intravisit::FnKind::ItemFn(_, _, hir::FnHeader { unsafety, .. }, _, _) => unsafety,
120             hir::intravisit::FnKind::Method(_, sig, _, _) => sig.header.unsafety,
121             hir::intravisit::FnKind::Closure(_) => return,
122         };
123
124         // don't warn for implementations, it's not their fault
125         if !is_impl {
126             // don't lint extern functions decls, it's not their fault either
127             match kind {
128                 hir::intravisit::FnKind::Method(
129                     _,
130                     &hir::MethodSig {
131                         header: hir::FnHeader { abi: Abi::Rust, .. },
132                         ..
133                     },
134                     _,
135                     _,
136                 )
137                 | hir::intravisit::FnKind::ItemFn(_, _, hir::FnHeader { abi: Abi::Rust, .. }, _, _) => {
138                     self.check_arg_number(cx, decl, span)
139                 },
140                 _ => {},
141             }
142         }
143
144         self.check_raw_ptr(cx, unsafety, decl, body, hir_id);
145         self.check_line_number(cx, span, body);
146     }
147
148     fn check_trait_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx hir::TraitItem) {
149         if let hir::TraitItemKind::Method(ref sig, ref eid) = item.node {
150             // don't lint extern functions decls, it's not their fault
151             if sig.header.abi == Abi::Rust {
152                 self.check_arg_number(cx, &sig.decl, item.span);
153             }
154
155             if let hir::TraitMethod::Provided(eid) = *eid {
156                 let body = cx.tcx.hir().body(eid);
157                 self.check_raw_ptr(cx, sig.header.unsafety, &sig.decl, body, item.hir_id);
158             }
159         }
160     }
161 }
162
163 impl<'a, 'tcx> Functions {
164     fn check_arg_number(self, cx: &LateContext<'_, '_>, decl: &hir::FnDecl, span: Span) {
165         let args = decl.inputs.len() as u64;
166         if args > self.threshold {
167             span_lint(
168                 cx,
169                 TOO_MANY_ARGUMENTS,
170                 span,
171                 &format!("this function has too many arguments ({}/{})", args, self.threshold),
172             );
173         }
174     }
175
176     fn check_line_number(self, cx: &LateContext<'_, '_>, span: Span, body: &'tcx hir::Body) {
177         if in_external_macro(cx.sess(), span) {
178             return;
179         }
180
181         let code_snippet = snippet(cx, body.value.span, "..");
182         let mut line_count: u64 = 0;
183         let mut in_comment = false;
184         let mut code_in_line;
185
186         // Skip the surrounding function decl.
187         let start_brace_idx = match code_snippet.find('{') {
188             Some(i) => i + 1,
189             None => 0,
190         };
191         let end_brace_idx = match code_snippet.find('}') {
192             Some(i) => i,
193             None => code_snippet.len(),
194         };
195         let function_lines = code_snippet[start_brace_idx..end_brace_idx].lines();
196
197         for mut line in function_lines {
198             code_in_line = false;
199             loop {
200                 line = line.trim_start();
201                 if line.is_empty() {
202                     break;
203                 }
204                 if in_comment {
205                     match line.find("*/") {
206                         Some(i) => {
207                             line = &line[i + 2..];
208                             in_comment = false;
209                             continue;
210                         },
211                         None => break,
212                     }
213                 } else {
214                     let multi_idx = match line.find("/*") {
215                         Some(i) => i,
216                         None => line.len(),
217                     };
218                     let single_idx = match line.find("//") {
219                         Some(i) => i,
220                         None => line.len(),
221                     };
222                     code_in_line |= multi_idx > 0 && single_idx > 0;
223                     // Implies multi_idx is below line.len()
224                     if multi_idx < single_idx {
225                         line = &line[multi_idx + 2..];
226                         in_comment = true;
227                         continue;
228                     }
229                     break;
230                 }
231             }
232             if code_in_line {
233                 line_count += 1;
234             }
235         }
236
237         if line_count > self.max_lines {
238             span_lint(cx, TOO_MANY_LINES, span, "This function has a large number of lines.")
239         }
240     }
241
242     fn check_raw_ptr(
243         self,
244         cx: &LateContext<'a, 'tcx>,
245         unsafety: hir::Unsafety,
246         decl: &'tcx hir::FnDecl,
247         body: &'tcx hir::Body,
248         hir_id: hir::HirId,
249     ) {
250         let expr = &body.value;
251         if unsafety == hir::Unsafety::Normal && cx.access_levels.is_exported(hir_id) {
252             let raw_ptrs = iter_input_pats(decl, body)
253                 .zip(decl.inputs.iter())
254                 .filter_map(|(arg, ty)| raw_ptr_arg(arg, ty))
255                 .collect::<FxHashSet<_>>();
256
257             if !raw_ptrs.is_empty() {
258                 let tables = cx.tcx.body_tables(body.id());
259                 let mut v = DerefVisitor {
260                     cx,
261                     ptrs: raw_ptrs,
262                     tables,
263                 };
264
265                 hir::intravisit::walk_expr(&mut v, expr);
266             }
267         }
268     }
269 }
270
271 fn raw_ptr_arg(arg: &hir::Arg, ty: &hir::Ty) -> Option<hir::HirId> {
272     if let (&hir::PatKind::Binding(_, id, _, _), &hir::TyKind::Ptr(_)) = (&arg.pat.node, &ty.node) {
273         Some(id)
274     } else {
275         None
276     }
277 }
278
279 struct DerefVisitor<'a, 'tcx: 'a> {
280     cx: &'a LateContext<'a, 'tcx>,
281     ptrs: FxHashSet<hir::HirId>,
282     tables: &'a ty::TypeckTables<'tcx>,
283 }
284
285 impl<'a, 'tcx> hir::intravisit::Visitor<'tcx> for DerefVisitor<'a, 'tcx> {
286     fn visit_expr(&mut self, expr: &'tcx hir::Expr) {
287         match expr.node {
288             hir::ExprKind::Call(ref f, ref args) => {
289                 let ty = self.tables.expr_ty(f);
290
291                 if type_is_unsafe_function(self.cx, ty) {
292                     for arg in args {
293                         self.check_arg(arg);
294                     }
295                 }
296             },
297             hir::ExprKind::MethodCall(_, _, ref args) => {
298                 let def_id = self.tables.type_dependent_def_id(expr.hir_id).unwrap();
299                 let base_type = self.cx.tcx.type_of(def_id);
300
301                 if type_is_unsafe_function(self.cx, base_type) {
302                     for arg in args {
303                         self.check_arg(arg);
304                     }
305                 }
306             },
307             hir::ExprKind::Unary(hir::UnDeref, ref ptr) => self.check_arg(ptr),
308             _ => (),
309         }
310
311         hir::intravisit::walk_expr(self, expr);
312     }
313     fn nested_visit_map<'this>(&'this mut self) -> intravisit::NestedVisitorMap<'this, 'tcx> {
314         intravisit::NestedVisitorMap::None
315     }
316 }
317
318 impl<'a, 'tcx: 'a> DerefVisitor<'a, 'tcx> {
319     fn check_arg(&self, ptr: &hir::Expr) {
320         if let hir::ExprKind::Path(ref qpath) = ptr.node {
321             if let Def::Local(id) = self.cx.tables.qpath_def(qpath, ptr.hir_id) {
322                 if self.ptrs.contains(&id) {
323                     span_lint(
324                         self.cx,
325                         NOT_UNSAFE_PTR_ARG_DEREF,
326                         ptr.span,
327                         "this public function dereferences a raw pointer but is not marked `unsafe`",
328                     );
329                 }
330             }
331         }
332     }
333 }