clippy_lints/src/attrs.rs

   1 //! checks for attributes
   2
   3 use reexport::*;
   4 use rustc::lint::*;
   5 use rustc::hir::*;
   6 use rustc::ty::{self, TyCtxt};
   7 use semver::Version;
   8 use syntax::ast::{Attribute, Lit, LitKind, MetaItemKind, NestedMetaItem, NestedMetaItemKind};
   9 use syntax::codemap::Span;
  10 use utils::{in_macro, match_def_path, paths, snippet_opt, span_lint, span_lint_and_then, opt_def_id};
  11
  12 /// **What it does:** Checks for items annotated with `#[inline(always)]`,
  13 /// unless the annotated function is empty or simply panics.
  14 ///
  15 /// **Why is this bad?** While there are valid uses of this annotation (and once
  16 /// you know when to use it, by all means `allow` this lint), it's a common
  17 /// newbie-mistake to pepper one's code with it.
  18 ///
  19 /// As a rule of thumb, before slapping `#[inline(always)]` on a function,
  20 /// measure if that additional function call really affects your runtime profile
  21 /// sufficiently to make up for the increase in compile time.
  22 ///
  23 /// **Known problems:** False positives, big time. This lint is meant to be
  24 /// deactivated by everyone doing serious performance work. This means having
  25 /// done the measurement.
  26 ///
  27 /// **Example:**
  28 /// ```rust
  29 /// #[inline(always)]
  30 /// fn not_quite_hot_code(..) { ... }
  31 /// ```
  32 declare_lint! {
  33     pub INLINE_ALWAYS,
  34     Warn,
  35     "use of `#[inline(always)]`"
  36 }
  37
  38 /// **What it does:** Checks for `extern crate` and `use` items annotated with
  39 /// lint attributes
  40 ///
  41 /// **Why is this bad?** Lint attributes have no effect on crate imports. Most
  42 /// likely a `!` was
  43 /// forgotten
  44 ///
  45 /// **Known problems:** Technically one might allow `unused_import` on a `use`
  46 /// item,
  47 /// but it's easier to remove the unused item.
  48 ///
  49 /// **Example:**
  50 /// ```rust
  51 /// #[deny(dead_code)]
  52 /// extern crate foo;
  53 /// #[allow(unused_import)]
  54 /// use foo::bar;
  55 /// ```
  56 declare_lint! {
  57     pub USELESS_ATTRIBUTE,
  58     Warn,
  59     "use of lint attributes on `extern crate` items"
  60 }
  61
  62 /// **What it does:** Checks for `#[deprecated]` annotations with a `since`
  63 /// field that is not a valid semantic version.
  64 ///
  65 /// **Why is this bad?** For checking the version of the deprecation, it must be
  66 /// a valid semver. Failing that, the contained information is useless.
  67 ///
  68 /// **Known problems:** None.
  69 ///
  70 /// **Example:**
  71 /// ```rust
  72 /// #[deprecated(since = "forever")]
  73 /// fn something_else(..) { ... }
  74 /// ```
  75 declare_lint! {
  76     pub DEPRECATED_SEMVER,
  77     Warn,
  78     "use of `#[deprecated(since = \"x\")]` where x is not semver"
  79 }
  80
  81 #[derive(Copy, Clone)]
  82 pub struct AttrPass;
  83
  84 impl LintPass for AttrPass {
  85     fn get_lints(&self) -> LintArray {
  86         lint_array!(INLINE_ALWAYS, DEPRECATED_SEMVER, USELESS_ATTRIBUTE)
  87     }
  88 }
  89
  90 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for AttrPass {
  91     fn check_attribute(&mut self, cx: &LateContext<'a, 'tcx>, attr: &'tcx Attribute) {
  92         if let Some(ref items) = attr.meta_item_list() {
  93             if items.is_empty() || attr.name().map_or(true, |n| n != "deprecated") {
  94                 return;
  95             }
  96             for item in items {
  97                 if_let_chain! {[
  98                     let NestedMetaItemKind::MetaItem(ref mi) = item.node,
  99                     let MetaItemKind::NameValue(ref lit) = mi.node,
 100                     mi.name() == "since",
 101                 ], {
 102                     check_semver(cx, item.span, lit);
 103                 }}
 104             }
 105         }
 106     }
 107
 108     fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx Item) {
 109         if is_relevant_item(cx.tcx, item) {
 110             check_attrs(cx, item.span, &item.name, &item.attrs)
 111         }
 112         match item.node {
 113             ItemExternCrate(_) | ItemUse(_, _) => {
 114                 for attr in &item.attrs {
 115                     if let Some(ref lint_list) = attr.meta_item_list() {
 116                         if let Some(name) = attr.name() {
 117                             match &*name.as_str() {
 118                                 "allow" | "warn" | "deny" | "forbid" => {
 119                                     // whitelist `unused_imports` and `deprecated`
 120                                     for lint in lint_list {
 121                                         if is_word(lint, "unused_imports") || is_word(lint, "deprecated") {
 122                                             if let ItemUse(_, _) = item.node {
 123                                                 return;
 124                                             }
 125                                         }
 126                                     }
 127                                     if let Some(mut sugg) = snippet_opt(cx, attr.span) {
 128                                         if sugg.len() > 1 {
 129                                             span_lint_and_then(
 130                                                 cx,
 131                                                 USELESS_ATTRIBUTE,
 132                                                 attr.span,
 133                                                 "useless lint attribute",
 134                                                 |db| {
 135                                                     sugg.insert(1, '!');
 136                                                     db.span_suggestion(
 137                                                         attr.span,
 138                                                         "if you just forgot a `!`, use",
 139                                                         sugg,
 140                                                     );
 141                                                 },
 142                                             );
 143                                         }
 144                                     }
 145                                 },
 146                                 _ => {},
 147                             }
 148                         }
 149                     }
 150                 }
 151             },
 152             _ => {},
 153         }
 154     }
 155
 156     fn check_impl_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx ImplItem) {
 157         if is_relevant_impl(cx.tcx, item) {
 158             check_attrs(cx, item.span, &item.name, &item.attrs)
 159         }
 160     }
 161
 162     fn check_trait_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx TraitItem) {
 163         if is_relevant_trait(cx.tcx, item) {
 164             check_attrs(cx, item.span, &item.name, &item.attrs)
 165         }
 166     }
 167 }
 168
 169 fn is_relevant_item(tcx: TyCtxt, item: &Item) -> bool {
 170     if let ItemFn(_, _, _, _, _, eid) = item.node {
 171         is_relevant_expr(tcx, tcx.body_tables(eid), &tcx.hir.body(eid).value)
 172     } else {
 173         false
 174     }
 175 }
 176
 177 fn is_relevant_impl(tcx: TyCtxt, item: &ImplItem) -> bool {
 178     match item.node {
 179         ImplItemKind::Method(_, eid) => is_relevant_expr(tcx, tcx.body_tables(eid), &tcx.hir.body(eid).value),
 180         _ => false,
 181     }
 182 }
 183
 184 fn is_relevant_trait(tcx: TyCtxt, item: &TraitItem) -> bool {
 185     match item.node {
 186         TraitItemKind::Method(_, TraitMethod::Required(_)) => true,
 187         TraitItemKind::Method(_, TraitMethod::Provided(eid)) => {
 188             is_relevant_expr(tcx, tcx.body_tables(eid), &tcx.hir.body(eid).value)
 189         },
 190         _ => false,
 191     }
 192 }
 193
 194 fn is_relevant_block(tcx: TyCtxt, tables: &ty::TypeckTables, block: &Block) -> bool {
 195     if let Some(stmt) = block.stmts.first() {
 196         match stmt.node {
 197             StmtDecl(_, _) => true,
 198             StmtExpr(ref expr, _) | StmtSemi(ref expr, _) => is_relevant_expr(tcx, tables, expr),
 199         }
 200     } else {
 201         block
 202             .expr
 203             .as_ref()
 204             .map_or(false, |e| is_relevant_expr(tcx, tables, e))
 205     }
 206 }
 207
 208 fn is_relevant_expr(tcx: TyCtxt, tables: &ty::TypeckTables, expr: &Expr) -> bool {
 209     match expr.node {
 210         ExprBlock(ref block) => is_relevant_block(tcx, tables, block),
 211         ExprRet(Some(ref e)) => is_relevant_expr(tcx, tables, e),
 212         ExprRet(None) | ExprBreak(_, None) => false,
 213         ExprCall(ref path_expr, _) => if let ExprPath(ref qpath) = path_expr.node {
 214             if let Some(fun_id) = opt_def_id(tables.qpath_def(qpath, path_expr.hir_id)) {
 215                 !match_def_path(tcx, fun_id, &paths::BEGIN_PANIC)
 216             } else {
 217                 true
 218             }
 219         } else {
 220             true
 221         },
 222         _ => true,
 223     }
 224 }
 225
 226 fn check_attrs(cx: &LateContext, span: Span, name: &Name, attrs: &[Attribute]) {
 227     if in_macro(span) {
 228         return;
 229     }
 230
 231     for attr in attrs {
 232         if let Some(ref values) = attr.meta_item_list() {
 233             if values.len() != 1 || attr.name().map_or(true, |n| n != "inline") {
 234                 continue;
 235             }
 236             if is_word(&values[0], "always") {
 237                 span_lint(
 238                     cx,
 239                     INLINE_ALWAYS,
 240                     attr.span,
 241                     &format!(
 242                         "you have declared `#[inline(always)]` on `{}`. This is usually a bad idea",
 243                         name
 244                     ),
 245                 );
 246             }
 247         }
 248     }
 249 }
 250
 251 fn check_semver(cx: &LateContext, span: Span, lit: &Lit) {
 252     if let LitKind::Str(ref is, _) = lit.node {
 253         if Version::parse(&is.as_str()).is_ok() {
 254             return;
 255         }
 256     }
 257     span_lint(
 258         cx,
 259         DEPRECATED_SEMVER,
 260         span,
 261         "the since field must contain a semver-compliant version",
 262     );
 263 }
 264
 265 fn is_word(nmi: &NestedMetaItem, expected: &str) -> bool {
 266     if let NestedMetaItemKind::MetaItem(ref mi) = nmi.node {
 267         mi.is_word() && mi.name() == expected
 268     } else {
 269         false
 270     }
 271 }