clippy_lints/src/attrs.rs

   1 //! checks for attributes
   2
   3 use crate::reexport::*;
   4 use crate::utils::{
   5     is_present_in_source, last_line_of_span, match_def_path, paths, snippet_opt, span_lint, span_lint_and_sugg,
   6     span_lint_and_then, without_block_comments,
   7 };
   8 use if_chain::if_chain;
   9 use rustc::declare_lint_pass;
  10 use rustc::hir::*;
  11 use rustc::lint::{
  12     in_external_macro, CheckLintNameResult, EarlyContext, EarlyLintPass, LateContext, LateLintPass, LintArray,
  13     LintContext, LintPass,
  14 };
  15 use rustc::ty;
  16 use rustc_errors::Applicability;
  17 use rustc_session::declare_tool_lint;
  18 use semver::Version;
  19 use syntax::ast::{AttrKind, AttrStyle, Attribute, Lit, LitKind, MetaItemKind, NestedMetaItem};
  20 use syntax::source_map::Span;
  21 use syntax_pos::symbol::Symbol;
  22
  23 declare_clippy_lint! {
  24     /// **What it does:** Checks for items annotated with `#[inline(always)]`,
  25     /// unless the annotated function is empty or simply panics.
  26     ///
  27     /// **Why is this bad?** While there are valid uses of this annotation (and once
  28     /// you know when to use it, by all means `allow` this lint), it's a common
  29     /// newbie-mistake to pepper one's code with it.
  30     ///
  31     /// As a rule of thumb, before slapping `#[inline(always)]` on a function,
  32     /// measure if that additional function call really affects your runtime profile
  33     /// sufficiently to make up for the increase in compile time.
  34     ///
  35     /// **Known problems:** False positives, big time. This lint is meant to be
  36     /// deactivated by everyone doing serious performance work. This means having
  37     /// done the measurement.
  38     ///
  39     /// **Example:**
  40     /// ```ignore
  41     /// #[inline(always)]
  42     /// fn not_quite_hot_code(..) { ... }
  43     /// ```
  44     pub INLINE_ALWAYS,
  45     pedantic,
  46     "use of `#[inline(always)]`"
  47 }
  48
  49 declare_clippy_lint! {
  50     /// **What it does:** Checks for `extern crate` and `use` items annotated with
  51     /// lint attributes.
  52     ///
  53     /// This lint whitelists `#[allow(unused_imports)]`, `#[allow(deprecated)]` and
  54     /// `#[allow(unreachable_pub)]` on `use` items and `#[allow(unused_imports)]` on
  55     /// `extern crate` items with a `#[macro_use]` attribute.
  56     ///
  57     /// **Why is this bad?** Lint attributes have no effect on crate imports. Most
  58     /// likely a `!` was forgotten.
  59     ///
  60     /// **Known problems:** None.
  61     ///
  62     /// **Example:**
  63     /// ```ignore
  64     /// // Bad
  65     /// #[deny(dead_code)]
  66     /// extern crate foo;
  67     /// #[forbid(dead_code)]
  68     /// use foo::bar;
  69     ///
  70     /// // Ok
  71     /// #[allow(unused_imports)]
  72     /// use foo::baz;
  73     /// #[allow(unused_imports)]
  74     /// #[macro_use]
  75     /// extern crate baz;
  76     /// ```
  77     pub USELESS_ATTRIBUTE,
  78     correctness,
  79     "use of lint attributes on `extern crate` items"
  80 }
  81
  82 declare_clippy_lint! {
  83     /// **What it does:** Checks for `#[deprecated]` annotations with a `since`
  84     /// field that is not a valid semantic version.
  85     ///
  86     /// **Why is this bad?** For checking the version of the deprecation, it must be
  87     /// a valid semver. Failing that, the contained information is useless.
  88     ///
  89     /// **Known problems:** None.
  90     ///
  91     /// **Example:**
  92     /// ```rust
  93     /// #[deprecated(since = "forever")]
  94     /// fn something_else() { /* ... */ }
  95     /// ```
  96     pub DEPRECATED_SEMVER,
  97     correctness,
  98     "use of `#[deprecated(since = \"x\")]` where x is not semver"
  99 }
 100
 101 declare_clippy_lint! {
 102     /// **What it does:** Checks for empty lines after outer attributes
 103     ///
 104     /// **Why is this bad?**
 105     /// Most likely the attribute was meant to be an inner attribute using a '!'.
 106     /// If it was meant to be an outer attribute, then the following item
 107     /// should not be separated by empty lines.
 108     ///
 109     /// **Known problems:** Can cause false positives.
 110     ///
 111     /// From the clippy side it's difficult to detect empty lines between an attributes and the
 112     /// following item because empty lines and comments are not part of the AST. The parsing
 113     /// currently works for basic cases but is not perfect.
 114     ///
 115     /// **Example:**
 116     /// ```rust
 117     /// // Good (as inner attribute)
 118     /// #![inline(always)]
 119     ///
 120     /// fn this_is_fine() { }
 121     ///
 122     /// // Bad
 123     /// #[inline(always)]
 124     ///
 125     /// fn not_quite_good_code() { }
 126     ///
 127     /// // Good (as outer attribute)
 128     /// #[inline(always)]
 129     /// fn this_is_fine_too() { }
 130     /// ```
 131     pub EMPTY_LINE_AFTER_OUTER_ATTR,
 132     nursery,
 133     "empty line after outer attribute"
 134 }
 135
 136 declare_clippy_lint! {
 137     /// **What it does:** Checks for `allow`/`warn`/`deny`/`forbid` attributes with scoped clippy
 138     /// lints and if those lints exist in clippy. If there is an uppercase letter in the lint name
 139     /// (not the tool name) and a lowercase version of this lint exists, it will suggest to lowercase
 140     /// the lint name.
 141     ///
 142     /// **Why is this bad?** A lint attribute with a mistyped lint name won't have an effect.
 143     ///
 144     /// **Known problems:** None.
 145     ///
 146     /// **Example:**
 147     /// Bad:
 148     /// ```rust
 149     /// #![warn(if_not_els)]
 150     /// #![deny(clippy::All)]
 151     /// ```
 152     ///
 153     /// Good:
 154     /// ```rust
 155     /// #![warn(if_not_else)]
 156     /// #![deny(clippy::all)]
 157     /// ```
 158     pub UNKNOWN_CLIPPY_LINTS,
 159     style,
 160     "unknown_lints for scoped Clippy lints"
 161 }
 162
 163 declare_clippy_lint! {
 164     /// **What it does:** Checks for `#[cfg_attr(rustfmt, rustfmt_skip)]` and suggests to replace it
 165     /// with `#[rustfmt::skip]`.
 166     ///
 167     /// **Why is this bad?** Since tool_attributes ([rust-lang/rust#44690](https://github.com/rust-lang/rust/issues/44690))
 168     /// are stable now, they should be used instead of the old `cfg_attr(rustfmt)` attributes.
 169     ///
 170     /// **Known problems:** This lint doesn't detect crate level inner attributes, because they get
 171     /// processed before the PreExpansionPass lints get executed. See
 172     /// [#3123](https://github.com/rust-lang/rust-clippy/pull/3123#issuecomment-422321765)
 173     ///
 174     /// **Example:**
 175     ///
 176     /// Bad:
 177     /// ```rust
 178     /// #[cfg_attr(rustfmt, rustfmt_skip)]
 179     /// fn main() { }
 180     /// ```
 181     ///
 182     /// Good:
 183     /// ```rust
 184     /// #[rustfmt::skip]
 185     /// fn main() { }
 186     /// ```
 187     pub DEPRECATED_CFG_ATTR,
 188     complexity,
 189     "usage of `cfg_attr(rustfmt)` instead of `tool_attributes`"
 190 }
 191
 192 declare_lint_pass!(Attributes => [
 193     INLINE_ALWAYS,
 194     DEPRECATED_SEMVER,
 195     USELESS_ATTRIBUTE,
 196     EMPTY_LINE_AFTER_OUTER_ATTR,
 197     UNKNOWN_CLIPPY_LINTS,
 198 ]);
 199
 200 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Attributes {
 201     fn check_attribute(&mut self, cx: &LateContext<'a, 'tcx>, attr: &'tcx Attribute) {
 202         if let Some(items) = &attr.meta_item_list() {
 203             if let Some(ident) = attr.ident() {
 204                 match &*ident.as_str() {
 205                     "allow" | "warn" | "deny" | "forbid" => {
 206                         check_clippy_lint_names(cx, items);
 207                     },
 208                     _ => {},
 209                 }
 210                 if items.is_empty() || !attr.check_name(sym!(deprecated)) {
 211                     return;
 212                 }
 213                 for item in items {
 214                     if_chain! {
 215                         if let NestedMetaItem::MetaItem(mi) = &item;
 216                         if let MetaItemKind::NameValue(lit) = &mi.kind;
 217                         if mi.check_name(sym!(since));
 218                         then {
 219                             check_semver(cx, item.span(), lit);
 220                         }
 221                     }
 222                 }
 223             }
 224         }
 225     }
 226
 227     fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx Item<'_>) {
 228         if is_relevant_item(cx, item) {
 229             check_attrs(cx, item.span, item.ident.name, &item.attrs)
 230         }
 231         match item.kind {
 232             ItemKind::ExternCrate(..) | ItemKind::Use(..) => {
 233                 let skip_unused_imports = item.attrs.iter().any(|attr| attr.check_name(sym!(macro_use)));
 234
 235                 for attr in item.attrs {
 236                     if in_external_macro(cx.sess(), attr.span) {
 237                         return;
 238                     }
 239                     if let Some(lint_list) = &attr.meta_item_list() {
 240                         if let Some(ident) = attr.ident() {
 241                             match &*ident.as_str() {
 242                                 "allow" | "warn" | "deny" | "forbid" => {
 243                                     // whitelist `unused_imports`, `deprecated` and `unreachable_pub` for `use` items
 244                                     // and `unused_imports` for `extern crate` items with `macro_use`
 245                                     for lint in lint_list {
 246                                         match item.kind {
 247                                             ItemKind::Use(..) => {
 248                                                 if is_word(lint, sym!(unused_imports))
 249                                                     || is_word(lint, sym!(deprecated))
 250                                                     || is_word(lint, sym!(unreachable_pub))
 251                                                 {
 252                                                     return;
 253                                                 }
 254                                             },
 255                                             ItemKind::ExternCrate(..) => {
 256                                                 if is_word(lint, sym!(unused_imports)) && skip_unused_imports {
 257                                                     return;
 258                                                 }
 259                                                 if is_word(lint, sym!(unused_extern_crates)) {
 260                                                     return;
 261                                                 }
 262                                             },
 263                                             _ => {},
 264                                         }
 265                                     }
 266                                     let line_span = last_line_of_span(cx, attr.span);
 267
 268                                     if let Some(mut sugg) = snippet_opt(cx, line_span) {
 269                                         if sugg.contains("#[") {
 270                                             span_lint_and_then(
 271                                                 cx,
 272                                                 USELESS_ATTRIBUTE,
 273                                                 line_span,
 274                                                 "useless lint attribute",
 275                                                 |db| {
 276                                                     sugg = sugg.replacen("#[", "#![", 1);
 277                                                     db.span_suggestion(
 278                                                         line_span,
 279                                                         "if you just forgot a `!`, use",
 280                                                         sugg,
 281                                                         Applicability::MaybeIncorrect,
 282                                                     );
 283                                                 },
 284                                             );
 285                                         }
 286                                     }
 287                                 },
 288                                 _ => {},
 289                             }
 290                         }
 291                     }
 292                 }
 293             },
 294             _ => {},
 295         }
 296     }
 297
 298     fn check_impl_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx ImplItem<'_>) {
 299         if is_relevant_impl(cx, item) {
 300             check_attrs(cx, item.span, item.ident.name, &item.attrs)
 301         }
 302     }
 303
 304     fn check_trait_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx TraitItem<'_>) {
 305         if is_relevant_trait(cx, item) {
 306             check_attrs(cx, item.span, item.ident.name, &item.attrs)
 307         }
 308     }
 309 }
 310
 311 #[allow(clippy::single_match_else)]
 312 fn check_clippy_lint_names(cx: &LateContext<'_, '_>, items: &[NestedMetaItem]) {
 313     let lint_store = cx.lints();
 314     for lint in items {
 315         if_chain! {
 316             if let Some(meta_item) = lint.meta_item();
 317             if meta_item.path.segments.len() > 1;
 318             if let tool_name = meta_item.path.segments[0].ident;
 319             if tool_name.as_str() == "clippy";
 320             let name = meta_item.path.segments.last().unwrap().ident.name;
 321             if let CheckLintNameResult::Tool(Err((None, _))) = lint_store.check_lint_name(
 322                 &name.as_str(),
 323                 Some(tool_name.name),
 324             );
 325             then {
 326                 span_lint_and_then(
 327                     cx,
 328                     UNKNOWN_CLIPPY_LINTS,
 329                     lint.span(),
 330                     &format!("unknown clippy lint: clippy::{}", name),
 331                     |db| {
 332                         if name.as_str().chars().any(char::is_uppercase) {
 333                             let name_lower = name.as_str().to_lowercase();
 334                             match lint_store.check_lint_name(
 335                                 &name_lower,
 336                                 Some(tool_name.name)
 337                             ) {
 338                                 // FIXME: can we suggest similar lint names here?
 339                                 // https://github.com/rust-lang/rust/pull/56992
 340                                 CheckLintNameResult::NoLint(None) => (),
 341                                 _ => {
 342                                     db.span_suggestion(
 343                                         lint.span(),
 344                                         "lowercase the lint name",
 345                                         name_lower,
 346                                         Applicability::MaybeIncorrect,
 347                                     );
 348                                 }
 349                             }
 350                         }
 351                     }
 352                 );
 353             }
 354         };
 355     }
 356 }
 357
 358 fn is_relevant_item(cx: &LateContext<'_, '_>, item: &Item<'_>) -> bool {
 359     if let ItemKind::Fn(_, _, eid) = item.kind {
 360         is_relevant_expr(cx, cx.tcx.body_tables(eid), &cx.tcx.hir().body(eid).value)
 361     } else {
 362         true
 363     }
 364 }
 365
 366 fn is_relevant_impl(cx: &LateContext<'_, '_>, item: &ImplItem<'_>) -> bool {
 367     match item.kind {
 368         ImplItemKind::Method(_, eid) => is_relevant_expr(cx, cx.tcx.body_tables(eid), &cx.tcx.hir().body(eid).value),
 369         _ => false,
 370     }
 371 }
 372
 373 fn is_relevant_trait(cx: &LateContext<'_, '_>, item: &TraitItem<'_>) -> bool {
 374     match item.kind {
 375         TraitItemKind::Method(_, TraitMethod::Required(_)) => true,
 376         TraitItemKind::Method(_, TraitMethod::Provided(eid)) => {
 377             is_relevant_expr(cx, cx.tcx.body_tables(eid), &cx.tcx.hir().body(eid).value)
 378         },
 379         _ => false,
 380     }
 381 }
 382
 383 fn is_relevant_block(cx: &LateContext<'_, '_>, tables: &ty::TypeckTables<'_>, block: &Block<'_>) -> bool {
 384     if let Some(stmt) = block.stmts.first() {
 385         match &stmt.kind {
 386             StmtKind::Local(_) => true,
 387             StmtKind::Expr(expr) | StmtKind::Semi(expr) => is_relevant_expr(cx, tables, expr),
 388             _ => false,
 389         }
 390     } else {
 391         block.expr.as_ref().map_or(false, |e| is_relevant_expr(cx, tables, e))
 392     }
 393 }
 394
 395 fn is_relevant_expr(cx: &LateContext<'_, '_>, tables: &ty::TypeckTables<'_>, expr: &Expr<'_>) -> bool {
 396     match &expr.kind {
 397         ExprKind::Block(block, _) => is_relevant_block(cx, tables, block),
 398         ExprKind::Ret(Some(e)) => is_relevant_expr(cx, tables, e),
 399         ExprKind::Ret(None) | ExprKind::Break(_, None) => false,
 400         ExprKind::Call(path_expr, _) => {
 401             if let ExprKind::Path(qpath) = &path_expr.kind {
 402                 if let Some(fun_id) = tables.qpath_res(qpath, path_expr.hir_id).opt_def_id() {
 403                     !match_def_path(cx, fun_id, &paths::BEGIN_PANIC)
 404                 } else {
 405                     true
 406                 }
 407             } else {
 408                 true
 409             }
 410         },
 411         _ => true,
 412     }
 413 }
 414
 415 fn check_attrs(cx: &LateContext<'_, '_>, span: Span, name: Name, attrs: &[Attribute]) {
 416     if span.from_expansion() {
 417         return;
 418     }
 419
 420     for attr in attrs {
 421         let attr_item = if let AttrKind::Normal(ref attr) = attr.kind {
 422             attr
 423         } else {
 424             continue;
 425         };
 426
 427         if attr.style == AttrStyle::Outer {
 428             if attr_item.args.inner_tokens().is_empty() || !is_present_in_source(cx, attr.span) {
 429                 return;
 430             }
 431
 432             let begin_of_attr_to_item = Span::new(attr.span.lo(), span.lo(), span.ctxt());
 433             let end_of_attr_to_item = Span::new(attr.span.hi(), span.lo(), span.ctxt());
 434
 435             if let Some(snippet) = snippet_opt(cx, end_of_attr_to_item) {
 436                 let lines = snippet.split('\n').collect::<Vec<_>>();
 437                 let lines = without_block_comments(lines);
 438
 439                 if lines.iter().filter(|l| l.trim().is_empty()).count() > 2 {
 440                     span_lint(
 441                         cx,
 442                         EMPTY_LINE_AFTER_OUTER_ATTR,
 443                         begin_of_attr_to_item,
 444                         "Found an empty line after an outer attribute. \
 445                          Perhaps you forgot to add a '!' to make it an inner attribute?",
 446                     );
 447                 }
 448             }
 449         }
 450
 451         if let Some(values) = attr.meta_item_list() {
 452             if values.len() != 1 || !attr.check_name(sym!(inline)) {
 453                 continue;
 454             }
 455             if is_word(&values[0], sym!(always)) {
 456                 span_lint(
 457                     cx,
 458                     INLINE_ALWAYS,
 459                     attr.span,
 460                     &format!(
 461                         "you have declared `#[inline(always)]` on `{}`. This is usually a bad idea",
 462                         name
 463                     ),
 464                 );
 465             }
 466         }
 467     }
 468 }
 469
 470 fn check_semver(cx: &LateContext<'_, '_>, span: Span, lit: &Lit) {
 471     if let LitKind::Str(is, _) = lit.kind {
 472         if Version::parse(&is.as_str()).is_ok() {
 473             return;
 474         }
 475     }
 476     span_lint(
 477         cx,
 478         DEPRECATED_SEMVER,
 479         span,
 480         "the since field must contain a semver-compliant version",
 481     );
 482 }
 483
 484 fn is_word(nmi: &NestedMetaItem, expected: Symbol) -> bool {
 485     if let NestedMetaItem::MetaItem(mi) = &nmi {
 486         mi.is_word() && mi.check_name(expected)
 487     } else {
 488         false
 489     }
 490 }
 491
 492 declare_lint_pass!(DeprecatedCfgAttribute => [DEPRECATED_CFG_ATTR]);
 493
 494 impl EarlyLintPass for DeprecatedCfgAttribute {
 495     fn check_attribute(&mut self, cx: &EarlyContext<'_>, attr: &Attribute) {
 496         if_chain! {
 497             // check cfg_attr
 498             if attr.check_name(sym!(cfg_attr));
 499             if let Some(items) = attr.meta_item_list();
 500             if items.len() == 2;
 501             // check for `rustfmt`
 502             if let Some(feature_item) = items[0].meta_item();
 503             if feature_item.check_name(sym!(rustfmt));
 504             // check for `rustfmt_skip` and `rustfmt::skip`
 505             if let Some(skip_item) = &items[1].meta_item();
 506             if skip_item.check_name(sym!(rustfmt_skip)) ||
 507                 skip_item.path.segments.last().expect("empty path in attribute").ident.name == sym!(skip);
 508             // Only lint outer attributes, because custom inner attributes are unstable
 509             // Tracking issue: https://github.com/rust-lang/rust/issues/54726
 510             if let AttrStyle::Outer = attr.style;
 511             then {
 512                 span_lint_and_sugg(
 513                     cx,
 514                     DEPRECATED_CFG_ATTR,
 515                     attr.span,
 516                     "`cfg_attr` is deprecated for rustfmt and got replaced by tool_attributes",
 517                     "use",
 518                     "#[rustfmt::skip]".to_string(),
 519                     Applicability::MachineApplicable,
 520                 );
 521             }
 522         }
 523     }
 524 }