]> git.lizzy.rs Git - rust.git/blob - clippy_lints/src/attrs.rs
Add missing diagnostic item Symbols
[rust.git] / clippy_lints / src / attrs.rs
1 //! checks for attributes
2
3 use crate::utils::{
4     first_line_of_span, is_present_in_source, match_panic_def_id, snippet_opt, span_lint, span_lint_and_help,
5     span_lint_and_sugg, span_lint_and_then, without_block_comments,
6 };
7 use if_chain::if_chain;
8 use rustc_ast::{AttrKind, AttrStyle, Attribute, Lit, LitKind, MetaItemKind, NestedMetaItem};
9 use rustc_errors::Applicability;
10 use rustc_hir::{
11     Block, Expr, ExprKind, ImplItem, ImplItemKind, Item, ItemKind, StmtKind, TraitFn, TraitItem, TraitItemKind,
12 };
13 use rustc_lint::{EarlyContext, EarlyLintPass, LateContext, LateLintPass, LintContext};
14 use rustc_middle::lint::in_external_macro;
15 use rustc_middle::ty;
16 use rustc_session::{declare_lint_pass, declare_tool_lint};
17 use rustc_span::source_map::Span;
18 use rustc_span::sym;
19 use rustc_span::symbol::{Symbol, SymbolStr};
20 use semver::Version;
21
22 static UNIX_SYSTEMS: &[&str] = &[
23     "android",
24     "dragonfly",
25     "emscripten",
26     "freebsd",
27     "fuchsia",
28     "haiku",
29     "illumos",
30     "ios",
31     "l4re",
32     "linux",
33     "macos",
34     "netbsd",
35     "openbsd",
36     "redox",
37     "solaris",
38     "vxworks",
39 ];
40
41 // NOTE: windows is excluded from the list because it's also a valid target family.
42 static NON_UNIX_SYSTEMS: &[&str] = &["hermit", "none", "wasi"];
43
44 declare_clippy_lint! {
45     /// **What it does:** Checks for items annotated with `#[inline(always)]`,
46     /// unless the annotated function is empty or simply panics.
47     ///
48     /// **Why is this bad?** While there are valid uses of this annotation (and once
49     /// you know when to use it, by all means `allow` this lint), it's a common
50     /// newbie-mistake to pepper one's code with it.
51     ///
52     /// As a rule of thumb, before slapping `#[inline(always)]` on a function,
53     /// measure if that additional function call really affects your runtime profile
54     /// sufficiently to make up for the increase in compile time.
55     ///
56     /// **Known problems:** False positives, big time. This lint is meant to be
57     /// deactivated by everyone doing serious performance work. This means having
58     /// done the measurement.
59     ///
60     /// **Example:**
61     /// ```ignore
62     /// #[inline(always)]
63     /// fn not_quite_hot_code(..) { ... }
64     /// ```
65     pub INLINE_ALWAYS,
66     pedantic,
67     "use of `#[inline(always)]`"
68 }
69
70 declare_clippy_lint! {
71     /// **What it does:** Checks for `extern crate` and `use` items annotated with
72     /// lint attributes.
73     ///
74     /// This lint permits `#[allow(unused_imports)]`, `#[allow(deprecated)]`,
75     /// `#[allow(unreachable_pub)]`, `#[allow(clippy::wildcard_imports)]` and
76     /// `#[allow(clippy::enum_glob_use)]` on `use` items and `#[allow(unused_imports)]` on
77     /// `extern crate` items with a `#[macro_use]` attribute.
78     ///
79     /// **Why is this bad?** Lint attributes have no effect on crate imports. Most
80     /// likely a `!` was forgotten.
81     ///
82     /// **Known problems:** None.
83     ///
84     /// **Example:**
85     /// ```ignore
86     /// // Bad
87     /// #[deny(dead_code)]
88     /// extern crate foo;
89     /// #[forbid(dead_code)]
90     /// use foo::bar;
91     ///
92     /// // Ok
93     /// #[allow(unused_imports)]
94     /// use foo::baz;
95     /// #[allow(unused_imports)]
96     /// #[macro_use]
97     /// extern crate baz;
98     /// ```
99     pub USELESS_ATTRIBUTE,
100     correctness,
101     "use of lint attributes on `extern crate` items"
102 }
103
104 declare_clippy_lint! {
105     /// **What it does:** Checks for `#[deprecated]` annotations with a `since`
106     /// field that is not a valid semantic version.
107     ///
108     /// **Why is this bad?** For checking the version of the deprecation, it must be
109     /// a valid semver. Failing that, the contained information is useless.
110     ///
111     /// **Known problems:** None.
112     ///
113     /// **Example:**
114     /// ```rust
115     /// #[deprecated(since = "forever")]
116     /// fn something_else() { /* ... */ }
117     /// ```
118     pub DEPRECATED_SEMVER,
119     correctness,
120     "use of `#[deprecated(since = \"x\")]` where x is not semver"
121 }
122
123 declare_clippy_lint! {
124     /// **What it does:** Checks for empty lines after outer attributes
125     ///
126     /// **Why is this bad?**
127     /// Most likely the attribute was meant to be an inner attribute using a '!'.
128     /// If it was meant to be an outer attribute, then the following item
129     /// should not be separated by empty lines.
130     ///
131     /// **Known problems:** Can cause false positives.
132     ///
133     /// From the clippy side it's difficult to detect empty lines between an attributes and the
134     /// following item because empty lines and comments are not part of the AST. The parsing
135     /// currently works for basic cases but is not perfect.
136     ///
137     /// **Example:**
138     /// ```rust
139     /// // Good (as inner attribute)
140     /// #![allow(dead_code)]
141     ///
142     /// fn this_is_fine() { }
143     ///
144     /// // Bad
145     /// #[allow(dead_code)]
146     ///
147     /// fn not_quite_good_code() { }
148     ///
149     /// // Good (as outer attribute)
150     /// #[allow(dead_code)]
151     /// fn this_is_fine_too() { }
152     /// ```
153     pub EMPTY_LINE_AFTER_OUTER_ATTR,
154     nursery,
155     "empty line after outer attribute"
156 }
157
158 declare_clippy_lint! {
159     /// **What it does:** Checks for `warn`/`deny`/`forbid` attributes targeting the whole clippy::restriction category.
160     ///
161     /// **Why is this bad?** Restriction lints sometimes are in contrast with other lints or even go against idiomatic rust.
162     /// These lints should only be enabled on a lint-by-lint basis and with careful consideration.
163     ///
164     /// **Known problems:** None.
165     ///
166     /// **Example:**
167     /// Bad:
168     /// ```rust
169     /// #![deny(clippy::restriction)]
170     /// ```
171     ///
172     /// Good:
173     /// ```rust
174     /// #![deny(clippy::as_conversions)]
175     /// ```
176     pub BLANKET_CLIPPY_RESTRICTION_LINTS,
177     style,
178     "enabling the complete restriction group"
179 }
180
181 declare_clippy_lint! {
182     /// **What it does:** Checks for `#[cfg_attr(rustfmt, rustfmt_skip)]` and suggests to replace it
183     /// with `#[rustfmt::skip]`.
184     ///
185     /// **Why is this bad?** Since tool_attributes ([rust-lang/rust#44690](https://github.com/rust-lang/rust/issues/44690))
186     /// are stable now, they should be used instead of the old `cfg_attr(rustfmt)` attributes.
187     ///
188     /// **Known problems:** This lint doesn't detect crate level inner attributes, because they get
189     /// processed before the PreExpansionPass lints get executed. See
190     /// [#3123](https://github.com/rust-lang/rust-clippy/pull/3123#issuecomment-422321765)
191     ///
192     /// **Example:**
193     ///
194     /// Bad:
195     /// ```rust
196     /// #[cfg_attr(rustfmt, rustfmt_skip)]
197     /// fn main() { }
198     /// ```
199     ///
200     /// Good:
201     /// ```rust
202     /// #[rustfmt::skip]
203     /// fn main() { }
204     /// ```
205     pub DEPRECATED_CFG_ATTR,
206     complexity,
207     "usage of `cfg_attr(rustfmt)` instead of tool attributes"
208 }
209
210 declare_clippy_lint! {
211     /// **What it does:** Checks for cfg attributes having operating systems used in target family position.
212     ///
213     /// **Why is this bad?** The configuration option will not be recognised and the related item will not be included
214     /// by the conditional compilation engine.
215     ///
216     /// **Known problems:** None.
217     ///
218     /// **Example:**
219     ///
220     /// Bad:
221     /// ```rust
222     /// #[cfg(linux)]
223     /// fn conditional() { }
224     /// ```
225     ///
226     /// Good:
227     /// ```rust
228     /// #[cfg(target_os = "linux")]
229     /// fn conditional() { }
230     /// ```
231     ///
232     /// Or:
233     /// ```rust
234     /// #[cfg(unix)]
235     /// fn conditional() { }
236     /// ```
237     /// Check the [Rust Reference](https://doc.rust-lang.org/reference/conditional-compilation.html#target_os) for more details.
238     pub MISMATCHED_TARGET_OS,
239     correctness,
240     "usage of `cfg(operating_system)` instead of `cfg(target_os = \"operating_system\")`"
241 }
242
243 declare_lint_pass!(Attributes => [
244     INLINE_ALWAYS,
245     DEPRECATED_SEMVER,
246     USELESS_ATTRIBUTE,
247     BLANKET_CLIPPY_RESTRICTION_LINTS,
248 ]);
249
250 impl<'tcx> LateLintPass<'tcx> for Attributes {
251     fn check_attribute(&mut self, cx: &LateContext<'tcx>, attr: &'tcx Attribute) {
252         if let Some(items) = &attr.meta_item_list() {
253             if let Some(ident) = attr.ident() {
254                 let ident = &*ident.as_str();
255                 match ident {
256                     "allow" | "warn" | "deny" | "forbid" => {
257                         check_clippy_lint_names(cx, ident, items);
258                     },
259                     _ => {},
260                 }
261                 if items.is_empty() || !attr.has_name(sym::deprecated) {
262                     return;
263                 }
264                 for item in items {
265                     if_chain! {
266                         if let NestedMetaItem::MetaItem(mi) = &item;
267                         if let MetaItemKind::NameValue(lit) = &mi.kind;
268                         if mi.has_name(sym::since);
269                         then {
270                             check_semver(cx, item.span(), lit);
271                         }
272                     }
273                 }
274             }
275         }
276     }
277
278     fn check_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx Item<'_>) {
279         if is_relevant_item(cx, item) {
280             check_attrs(cx, item.span, item.ident.name, &item.attrs)
281         }
282         match item.kind {
283             ItemKind::ExternCrate(..) | ItemKind::Use(..) => {
284                 let skip_unused_imports = item.attrs.iter().any(|attr| attr.has_name(sym::macro_use));
285
286                 for attr in item.attrs {
287                     if in_external_macro(cx.sess(), attr.span) {
288                         return;
289                     }
290                     if let Some(lint_list) = &attr.meta_item_list() {
291                         if let Some(ident) = attr.ident() {
292                             match &*ident.as_str() {
293                                 "allow" | "warn" | "deny" | "forbid" => {
294                                     // permit `unused_imports`, `deprecated`, `unreachable_pub`,
295                                     // `clippy::wildcard_imports`, and `clippy::enum_glob_use` for `use` items
296                                     // and `unused_imports` for `extern crate` items with `macro_use`
297                                     for lint in lint_list {
298                                         match item.kind {
299                                             ItemKind::Use(..) => {
300                                                 if is_word(lint, sym!(unused_imports))
301                                                     || is_word(lint, sym::deprecated)
302                                                     || is_word(lint, sym!(unreachable_pub))
303                                                     || is_word(lint, sym!(unused))
304                                                     || extract_clippy_lint(lint)
305                                                         .map_or(false, |s| s == "wildcard_imports")
306                                                     || extract_clippy_lint(lint).map_or(false, |s| s == "enum_glob_use")
307                                                 {
308                                                     return;
309                                                 }
310                                             },
311                                             ItemKind::ExternCrate(..) => {
312                                                 if is_word(lint, sym!(unused_imports)) && skip_unused_imports {
313                                                     return;
314                                                 }
315                                                 if is_word(lint, sym!(unused_extern_crates)) {
316                                                     return;
317                                                 }
318                                             },
319                                             _ => {},
320                                         }
321                                     }
322                                     let line_span = first_line_of_span(cx, attr.span);
323
324                                     if let Some(mut sugg) = snippet_opt(cx, line_span) {
325                                         if sugg.contains("#[") {
326                                             span_lint_and_then(
327                                                 cx,
328                                                 USELESS_ATTRIBUTE,
329                                                 line_span,
330                                                 "useless lint attribute",
331                                                 |diag| {
332                                                     sugg = sugg.replacen("#[", "#![", 1);
333                                                     diag.span_suggestion(
334                                                         line_span,
335                                                         "if you just forgot a `!`, use",
336                                                         sugg,
337                                                         Applicability::MaybeIncorrect,
338                                                     );
339                                                 },
340                                             );
341                                         }
342                                     }
343                                 },
344                                 _ => {},
345                             }
346                         }
347                     }
348                 }
349             },
350             _ => {},
351         }
352     }
353
354     fn check_impl_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx ImplItem<'_>) {
355         if is_relevant_impl(cx, item) {
356             check_attrs(cx, item.span, item.ident.name, &item.attrs)
357         }
358     }
359
360     fn check_trait_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx TraitItem<'_>) {
361         if is_relevant_trait(cx, item) {
362             check_attrs(cx, item.span, item.ident.name, &item.attrs)
363         }
364     }
365 }
366
367 /// Returns the lint name if it is clippy lint.
368 fn extract_clippy_lint(lint: &NestedMetaItem) -> Option<SymbolStr> {
369     if_chain! {
370         if let Some(meta_item) = lint.meta_item();
371         if meta_item.path.segments.len() > 1;
372         if let tool_name = meta_item.path.segments[0].ident;
373         if tool_name.name == sym::clippy;
374         let lint_name = meta_item.path.segments.last().unwrap().ident.name;
375         then {
376             return Some(lint_name.as_str());
377         }
378     }
379     None
380 }
381
382 fn check_clippy_lint_names(cx: &LateContext<'_>, ident: &str, items: &[NestedMetaItem]) {
383     for lint in items {
384         if let Some(lint_name) = extract_clippy_lint(lint) {
385             if lint_name == "restriction" && ident != "allow" {
386                 span_lint_and_help(
387                     cx,
388                     BLANKET_CLIPPY_RESTRICTION_LINTS,
389                     lint.span(),
390                     "restriction lints are not meant to be all enabled",
391                     None,
392                     "try enabling only the lints you really need",
393                 );
394             }
395         }
396     }
397 }
398
399 fn is_relevant_item(cx: &LateContext<'_>, item: &Item<'_>) -> bool {
400     if let ItemKind::Fn(_, _, eid) = item.kind {
401         is_relevant_expr(cx, cx.tcx.typeck_body(eid), &cx.tcx.hir().body(eid).value)
402     } else {
403         true
404     }
405 }
406
407 fn is_relevant_impl(cx: &LateContext<'_>, item: &ImplItem<'_>) -> bool {
408     match item.kind {
409         ImplItemKind::Fn(_, eid) => is_relevant_expr(cx, cx.tcx.typeck_body(eid), &cx.tcx.hir().body(eid).value),
410         _ => false,
411     }
412 }
413
414 fn is_relevant_trait(cx: &LateContext<'_>, item: &TraitItem<'_>) -> bool {
415     match item.kind {
416         TraitItemKind::Fn(_, TraitFn::Required(_)) => true,
417         TraitItemKind::Fn(_, TraitFn::Provided(eid)) => {
418             is_relevant_expr(cx, cx.tcx.typeck_body(eid), &cx.tcx.hir().body(eid).value)
419         },
420         _ => false,
421     }
422 }
423
424 fn is_relevant_block(cx: &LateContext<'_>, typeck_results: &ty::TypeckResults<'_>, block: &Block<'_>) -> bool {
425     block.stmts.first().map_or(
426         block
427             .expr
428             .as_ref()
429             .map_or(false, |e| is_relevant_expr(cx, typeck_results, e)),
430         |stmt| match &stmt.kind {
431             StmtKind::Local(_) => true,
432             StmtKind::Expr(expr) | StmtKind::Semi(expr) => is_relevant_expr(cx, typeck_results, expr),
433             _ => false,
434         },
435     )
436 }
437
438 fn is_relevant_expr(cx: &LateContext<'_>, typeck_results: &ty::TypeckResults<'_>, expr: &Expr<'_>) -> bool {
439     match &expr.kind {
440         ExprKind::Block(block, _) => is_relevant_block(cx, typeck_results, block),
441         ExprKind::Ret(Some(e)) => is_relevant_expr(cx, typeck_results, e),
442         ExprKind::Ret(None) | ExprKind::Break(_, None) => false,
443         ExprKind::Call(path_expr, _) => {
444             if let ExprKind::Path(qpath) = &path_expr.kind {
445                 typeck_results
446                     .qpath_res(qpath, path_expr.hir_id)
447                     .opt_def_id()
448                     .map_or(true, |fun_id| !match_panic_def_id(cx, fun_id))
449             } else {
450                 true
451             }
452         },
453         _ => true,
454     }
455 }
456
457 fn check_attrs(cx: &LateContext<'_>, span: Span, name: Symbol, attrs: &[Attribute]) {
458     if span.from_expansion() {
459         return;
460     }
461
462     for attr in attrs {
463         if let Some(values) = attr.meta_item_list() {
464             if values.len() != 1 || !attr.has_name(sym::inline) {
465                 continue;
466             }
467             if is_word(&values[0], sym::always) {
468                 span_lint(
469                     cx,
470                     INLINE_ALWAYS,
471                     attr.span,
472                     &format!(
473                         "you have declared `#[inline(always)]` on `{}`. This is usually a bad idea",
474                         name
475                     ),
476                 );
477             }
478         }
479     }
480 }
481
482 fn check_semver(cx: &LateContext<'_>, span: Span, lit: &Lit) {
483     if let LitKind::Str(is, _) = lit.kind {
484         if Version::parse(&is.as_str()).is_ok() {
485             return;
486         }
487     }
488     span_lint(
489         cx,
490         DEPRECATED_SEMVER,
491         span,
492         "the since field must contain a semver-compliant version",
493     );
494 }
495
496 fn is_word(nmi: &NestedMetaItem, expected: Symbol) -> bool {
497     if let NestedMetaItem::MetaItem(mi) = &nmi {
498         mi.is_word() && mi.has_name(expected)
499     } else {
500         false
501     }
502 }
503
504 declare_lint_pass!(EarlyAttributes => [
505     DEPRECATED_CFG_ATTR,
506     MISMATCHED_TARGET_OS,
507     EMPTY_LINE_AFTER_OUTER_ATTR,
508 ]);
509
510 impl EarlyLintPass for EarlyAttributes {
511     fn check_item(&mut self, cx: &EarlyContext<'_>, item: &rustc_ast::Item) {
512         check_empty_line_after_outer_attr(cx, item);
513     }
514
515     fn check_attribute(&mut self, cx: &EarlyContext<'_>, attr: &Attribute) {
516         check_deprecated_cfg_attr(cx, attr);
517         check_mismatched_target_os(cx, attr);
518     }
519 }
520
521 fn check_empty_line_after_outer_attr(cx: &EarlyContext<'_>, item: &rustc_ast::Item) {
522     for attr in &item.attrs {
523         let attr_item = if let AttrKind::Normal(ref attr, _) = attr.kind {
524             attr
525         } else {
526             return;
527         };
528
529         if attr.style == AttrStyle::Outer {
530             if attr_item.args.inner_tokens().is_empty() || !is_present_in_source(cx, attr.span) {
531                 return;
532             }
533
534             let begin_of_attr_to_item = Span::new(attr.span.lo(), item.span.lo(), item.span.ctxt());
535             let end_of_attr_to_item = Span::new(attr.span.hi(), item.span.lo(), item.span.ctxt());
536
537             if let Some(snippet) = snippet_opt(cx, end_of_attr_to_item) {
538                 let lines = snippet.split('\n').collect::<Vec<_>>();
539                 let lines = without_block_comments(lines);
540
541                 if lines.iter().filter(|l| l.trim().is_empty()).count() > 2 {
542                     span_lint(
543                         cx,
544                         EMPTY_LINE_AFTER_OUTER_ATTR,
545                         begin_of_attr_to_item,
546                         "found an empty line after an outer attribute. \
547                         Perhaps you forgot to add a `!` to make it an inner attribute?",
548                     );
549                 }
550             }
551         }
552     }
553 }
554
555 fn check_deprecated_cfg_attr(cx: &EarlyContext<'_>, attr: &Attribute) {
556     if_chain! {
557         // check cfg_attr
558         if attr.has_name(sym::cfg_attr);
559         if let Some(items) = attr.meta_item_list();
560         if items.len() == 2;
561         // check for `rustfmt`
562         if let Some(feature_item) = items[0].meta_item();
563         if feature_item.has_name(sym::rustfmt);
564         // check for `rustfmt_skip` and `rustfmt::skip`
565         if let Some(skip_item) = &items[1].meta_item();
566         if skip_item.has_name(sym!(rustfmt_skip)) ||
567             skip_item.path.segments.last().expect("empty path in attribute").ident.name == sym!(skip);
568         // Only lint outer attributes, because custom inner attributes are unstable
569         // Tracking issue: https://github.com/rust-lang/rust/issues/54726
570         if let AttrStyle::Outer = attr.style;
571         then {
572             span_lint_and_sugg(
573                 cx,
574                 DEPRECATED_CFG_ATTR,
575                 attr.span,
576                 "`cfg_attr` is deprecated for rustfmt and got replaced by tool attributes",
577                 "use",
578                 "#[rustfmt::skip]".to_string(),
579                 Applicability::MachineApplicable,
580             );
581         }
582     }
583 }
584
585 fn check_mismatched_target_os(cx: &EarlyContext<'_>, attr: &Attribute) {
586     fn find_os(name: &str) -> Option<&'static str> {
587         UNIX_SYSTEMS
588             .iter()
589             .chain(NON_UNIX_SYSTEMS.iter())
590             .find(|&&os| os == name)
591             .copied()
592     }
593
594     fn is_unix(name: &str) -> bool {
595         UNIX_SYSTEMS.iter().any(|&os| os == name)
596     }
597
598     fn find_mismatched_target_os(items: &[NestedMetaItem]) -> Vec<(&str, Span)> {
599         let mut mismatched = Vec::new();
600
601         for item in items {
602             if let NestedMetaItem::MetaItem(meta) = item {
603                 match &meta.kind {
604                     MetaItemKind::List(list) => {
605                         mismatched.extend(find_mismatched_target_os(&list));
606                     },
607                     MetaItemKind::Word => {
608                         if_chain! {
609                             if let Some(ident) = meta.ident();
610                             if let Some(os) = find_os(&*ident.name.as_str());
611                             then {
612                                 mismatched.push((os, ident.span));
613                             }
614                         }
615                     },
616                     _ => {},
617                 }
618             }
619         }
620
621         mismatched
622     }
623
624     if_chain! {
625         if attr.has_name(sym::cfg);
626         if let Some(list) = attr.meta_item_list();
627         let mismatched = find_mismatched_target_os(&list);
628         if !mismatched.is_empty();
629         then {
630             let mess = "operating system used in target family position";
631
632             span_lint_and_then(cx, MISMATCHED_TARGET_OS, attr.span, &mess, |diag| {
633                 // Avoid showing the unix suggestion multiple times in case
634                 // we have more than one mismatch for unix-like systems
635                 let mut unix_suggested = false;
636
637                 for (os, span) in mismatched {
638                     let sugg = format!("target_os = \"{}\"", os);
639                     diag.span_suggestion(span, "try", sugg, Applicability::MaybeIncorrect);
640
641                     if !unix_suggested && is_unix(os) {
642                         diag.help("Did you mean `unix`?");
643                         unix_suggested = true;
644                     }
645                 }
646             });
647         }
648     }
649 }