src/librustc/lint/mod.rs

   1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Lints, aka compiler warnings.
  12 //!
  13 //! A 'lint' check is a kind of miscellaneous constraint that a user _might_
  14 //! want to enforce, but might reasonably want to permit as well, on a
  15 //! module-by-module basis. They contrast with static constraints enforced by
  16 //! other phases of the compiler, which are generally required to hold in order
  17 //! to compile the program at all.
  18 //!
  19 //! Most lints can be written as `LintPass` instances. These run just before
  20 //! translation to LLVM bytecode. The `LintPass`es built into rustc are defined
  21 //! within `builtin.rs`, which has further comments on how to add such a lint.
  22 //! rustc can also load user-defined lint plugins via the plugin mechanism.
  23 //!
  24 //! Some of rustc's lints are defined elsewhere in the compiler and work by
  25 //! calling `add_lint()` on the overall `Session` object. This works when
  26 //! it happens before the main lint pass, which emits the lints stored by
  27 //! `add_lint()`. To emit lints after the main lint pass (from trans, for
  28 //! example) requires more effort. See `emit_lint` and `GatherNodeLevels`
  29 //! in `context.rs`.
  30
  31 pub use self::Level::*;
  32 pub use self::LintSource::*;
  33
  34 use std::hash;
  35 use std::ascii::AsciiExt;
  36 use syntax::codemap::Span;
  37 use rustc_front::visit::FnKind;
  38 use syntax::visit as ast_visit;
  39 use syntax::ast;
  40 use rustc_front::hir;
  41
  42 pub use lint::context::{LateContext, EarlyContext, LintContext, LintStore,
  43                         raw_emit_lint, check_crate, check_ast_crate, gather_attrs,
  44                         GatherNodeLevels};
  45
  46 /// Specification of a single lint.
  47 #[derive(Copy, Clone, Debug)]
  48 pub struct Lint {
  49     /// A string identifier for the lint.
  50     ///
  51     /// This identifies the lint in attributes and in command-line arguments.
  52     /// In those contexts it is always lowercase, but this field is compared
  53     /// in a way which is case-insensitive for ASCII characters. This allows
  54     /// `declare_lint!()` invocations to follow the convention of upper-case
  55     /// statics without repeating the name.
  56     ///
  57     /// The name is written with underscores, e.g. "unused_imports".
  58     /// On the command line, underscores become dashes.
  59     pub name: &'static str,
  60
  61     /// Default level for the lint.
  62     pub default_level: Level,
  63
  64     /// Description of the lint or the issue it detects.
  65     ///
  66     /// e.g. "imports that are never used"
  67     pub desc: &'static str,
  68 }
  69
  70 impl Lint {
  71     /// Get the lint's name, with ASCII letters converted to lowercase.
  72     pub fn name_lower(&self) -> String {
  73         self.name.to_ascii_lowercase()
  74     }
  75 }
  76
  77 /// Build a `Lint` initializer.
  78 #[macro_export]
  79 macro_rules! lint_initializer {
  80     ($name:ident, $level:ident, $desc:expr) => (
  81         ::rustc::lint::Lint {
  82             name: stringify!($name),
  83             default_level: ::rustc::lint::$level,
  84             desc: $desc,
  85         }
  86     )
  87 }
  88
  89 /// Declare a static item of type `&'static Lint`.
  90 #[macro_export]
  91 macro_rules! declare_lint {
  92     // FIXME(#14660): deduplicate
  93     (pub $name:ident, $level:ident, $desc:expr) => (
  94         pub static $name: &'static ::rustc::lint::Lint
  95             = &lint_initializer!($name, $level, $desc);
  96     );
  97     ($name:ident, $level:ident, $desc:expr) => (
  98         static $name: &'static ::rustc::lint::Lint
  99             = &lint_initializer!($name, $level, $desc);
 100     );
 101 }
 102
 103 /// Declare a static `LintArray` and return it as an expression.
 104 #[macro_export]
 105 macro_rules! lint_array { ($( $lint:expr ),*) => (
 106     {
 107         static ARRAY: LintArray = &[ $( &$lint ),* ];
 108         ARRAY
 109     }
 110 ) }
 111
 112 pub type LintArray = &'static [&'static &'static Lint];
 113
 114 pub trait LintPass {
 115     /// Get descriptions of the lints this `LintPass` object can emit.
 116     ///
 117     /// NB: there is no enforcement that the object only emits lints it registered.
 118     /// And some `rustc` internal `LintPass`es register lints to be emitted by other
 119     /// parts of the compiler. If you want enforced access restrictions for your
 120     /// `Lint`, make it a private `static` item in its own module.
 121     fn get_lints(&self) -> LintArray;
 122 }
 123
 124
 125 /// Trait for types providing lint checks.
 126 ///
 127 /// Each `check` method checks a single syntax node, and should not
 128 /// invoke methods recursively (unlike `Visitor`). By default they
 129 /// do nothing.
 130 //
 131 // FIXME: eliminate the duplication with `Visitor`. But this also
 132 // contains a few lint-specific methods with no equivalent in `Visitor`.
 133 pub trait LateLintPass: LintPass {
 134     fn check_ident(&mut self, _: &LateContext, _: Span, _: ast::Ident) { }
 135     fn check_crate(&mut self, _: &LateContext, _: &hir::Crate) { }
 136     fn check_mod(&mut self, _: &LateContext, _: &hir::Mod, _: Span, _: ast::NodeId) { }
 137     fn check_foreign_item(&mut self, _: &LateContext, _: &hir::ForeignItem) { }
 138     fn check_item(&mut self, _: &LateContext, _: &hir::Item) { }
 139     fn check_local(&mut self, _: &LateContext, _: &hir::Local) { }
 140     fn check_block(&mut self, _: &LateContext, _: &hir::Block) { }
 141     fn check_stmt(&mut self, _: &LateContext, _: &hir::Stmt) { }
 142     fn check_arm(&mut self, _: &LateContext, _: &hir::Arm) { }
 143     fn check_pat(&mut self, _: &LateContext, _: &hir::Pat) { }
 144     fn check_decl(&mut self, _: &LateContext, _: &hir::Decl) { }
 145     fn check_expr(&mut self, _: &LateContext, _: &hir::Expr) { }
 146     fn check_expr_post(&mut self, _: &LateContext, _: &hir::Expr) { }
 147     fn check_ty(&mut self, _: &LateContext, _: &hir::Ty) { }
 148     fn check_generics(&mut self, _: &LateContext, _: &hir::Generics) { }
 149     fn check_fn(&mut self, _: &LateContext,
 150         _: FnKind, _: &hir::FnDecl, _: &hir::Block, _: Span, _: ast::NodeId) { }
 151     fn check_trait_item(&mut self, _: &LateContext, _: &hir::TraitItem) { }
 152     fn check_impl_item(&mut self, _: &LateContext, _: &hir::ImplItem) { }
 153     fn check_struct_def(&mut self, _: &LateContext,
 154         _: &hir::StructDef, _: ast::Ident, _: &hir::Generics, _: ast::NodeId) { }
 155     fn check_struct_def_post(&mut self, _: &LateContext,
 156         _: &hir::StructDef, _: ast::Ident, _: &hir::Generics, _: ast::NodeId) { }
 157     fn check_struct_field(&mut self, _: &LateContext, _: &hir::StructField) { }
 158     fn check_variant(&mut self, _: &LateContext, _: &hir::Variant, _: &hir::Generics) { }
 159     fn check_variant_post(&mut self, _: &LateContext, _: &hir::Variant, _: &hir::Generics) { }
 160     fn check_opt_lifetime_ref(&mut self, _: &LateContext, _: Span, _: &Option<hir::Lifetime>) { }
 161     fn check_lifetime_ref(&mut self, _: &LateContext, _: &hir::Lifetime) { }
 162     fn check_lifetime_def(&mut self, _: &LateContext, _: &hir::LifetimeDef) { }
 163     fn check_explicit_self(&mut self, _: &LateContext, _: &hir::ExplicitSelf) { }
 164     fn check_path(&mut self, _: &LateContext, _: &hir::Path, _: ast::NodeId) { }
 165     fn check_attribute(&mut self, _: &LateContext, _: &ast::Attribute) { }
 166
 167     /// Called when entering a syntax node that can have lint attributes such
 168     /// as `#[allow(...)]`. Called with *all* the attributes of that node.
 169     fn enter_lint_attrs(&mut self, _: &LateContext, _: &[ast::Attribute]) { }
 170
 171     /// Counterpart to `enter_lint_attrs`.
 172     fn exit_lint_attrs(&mut self, _: &LateContext, _: &[ast::Attribute]) { }
 173 }
 174
 175 pub trait EarlyLintPass: LintPass {
 176     fn check_ident(&mut self, _: &EarlyContext, _: Span, _: ast::Ident) { }
 177     fn check_crate(&mut self, _: &EarlyContext, _: &ast::Crate) { }
 178     fn check_mod(&mut self, _: &EarlyContext, _: &ast::Mod, _: Span, _: ast::NodeId) { }
 179     fn check_foreign_item(&mut self, _: &EarlyContext, _: &ast::ForeignItem) { }
 180     fn check_item(&mut self, _: &EarlyContext, _: &ast::Item) { }
 181     fn check_local(&mut self, _: &EarlyContext, _: &ast::Local) { }
 182     fn check_block(&mut self, _: &EarlyContext, _: &ast::Block) { }
 183     fn check_stmt(&mut self, _: &EarlyContext, _: &ast::Stmt) { }
 184     fn check_arm(&mut self, _: &EarlyContext, _: &ast::Arm) { }
 185     fn check_pat(&mut self, _: &EarlyContext, _: &ast::Pat) { }
 186     fn check_decl(&mut self, _: &EarlyContext, _: &ast::Decl) { }
 187     fn check_expr(&mut self, _: &EarlyContext, _: &ast::Expr) { }
 188     fn check_expr_post(&mut self, _: &EarlyContext, _: &ast::Expr) { }
 189     fn check_ty(&mut self, _: &EarlyContext, _: &ast::Ty) { }
 190     fn check_generics(&mut self, _: &EarlyContext, _: &ast::Generics) { }
 191     fn check_fn(&mut self, _: &EarlyContext,
 192         _: ast_visit::FnKind, _: &ast::FnDecl, _: &ast::Block, _: Span, _: ast::NodeId) { }
 193     fn check_trait_item(&mut self, _: &EarlyContext, _: &ast::TraitItem) { }
 194     fn check_impl_item(&mut self, _: &EarlyContext, _: &ast::ImplItem) { }
 195     fn check_struct_def(&mut self, _: &EarlyContext,
 196         _: &ast::StructDef, _: ast::Ident, _: &ast::Generics, _: ast::NodeId) { }
 197     fn check_struct_def_post(&mut self, _: &EarlyContext,
 198         _: &ast::StructDef, _: ast::Ident, _: &ast::Generics, _: ast::NodeId) { }
 199     fn check_struct_field(&mut self, _: &EarlyContext, _: &ast::StructField) { }
 200     fn check_variant(&mut self, _: &EarlyContext, _: &ast::Variant, _: &ast::Generics) { }
 201     fn check_variant_post(&mut self, _: &EarlyContext, _: &ast::Variant, _: &ast::Generics) { }
 202     fn check_opt_lifetime_ref(&mut self,
 203                               _: &EarlyContext,
 204                               _: Span,
 205                               _: &Option<ast::Lifetime>) { }
 206     fn check_lifetime_ref(&mut self, _: &EarlyContext, _: &ast::Lifetime) { }
 207     fn check_lifetime_def(&mut self, _: &EarlyContext, _: &ast::LifetimeDef) { }
 208     fn check_explicit_self(&mut self, _: &EarlyContext, _: &ast::ExplicitSelf) { }
 209     fn check_path(&mut self, _: &EarlyContext, _: &ast::Path, _: ast::NodeId) { }
 210     fn check_attribute(&mut self, _: &EarlyContext, _: &ast::Attribute) { }
 211
 212     /// Called when entering a syntax node that can have lint attributes such
 213     /// as `#[allow(...)]`. Called with *all* the attributes of that node.
 214     fn enter_lint_attrs(&mut self, _: &EarlyContext, _: &[ast::Attribute]) { }
 215
 216     /// Counterpart to `enter_lint_attrs`.
 217     fn exit_lint_attrs(&mut self, _: &EarlyContext, _: &[ast::Attribute]) { }
 218 }
 219
 220 /// A lint pass boxed up as a trait object.
 221 pub type EarlyLintPassObject = Box<EarlyLintPass + 'static>;
 222 pub type LateLintPassObject = Box<LateLintPass + 'static>;
 223
 224 /// Identifies a lint known to the compiler.
 225 #[derive(Clone, Copy)]
 226 pub struct LintId {
 227     // Identity is based on pointer equality of this field.
 228     lint: &'static Lint,
 229 }
 230
 231 impl PartialEq for LintId {
 232     fn eq(&self, other: &LintId) -> bool {
 233         (self.lint as *const Lint) == (other.lint as *const Lint)
 234     }
 235 }
 236
 237 impl Eq for LintId { }
 238
 239 impl hash::Hash for LintId {
 240     fn hash<H: hash::Hasher>(&self, state: &mut H) {
 241         let ptr = self.lint as *const Lint;
 242         ptr.hash(state);
 243     }
 244 }
 245
 246 impl LintId {
 247     /// Get the `LintId` for a `Lint`.
 248     pub fn of(lint: &'static Lint) -> LintId {
 249         LintId {
 250             lint: lint,
 251         }
 252     }
 253
 254     /// Get the name of the lint.
 255     pub fn as_str(&self) -> String {
 256         self.lint.name_lower()
 257     }
 258 }
 259
 260 /// Setting for how to handle a lint.
 261 #[derive(Clone, Copy, PartialEq, PartialOrd, Eq, Ord, Debug)]
 262 pub enum Level {
 263     Allow, Warn, Deny, Forbid
 264 }
 265
 266 impl Level {
 267     /// Convert a level to a lower-case string.
 268     pub fn as_str(self) -> &'static str {
 269         match self {
 270             Allow => "allow",
 271             Warn => "warn",
 272             Deny => "deny",
 273             Forbid => "forbid",
 274         }
 275     }
 276
 277     /// Convert a lower-case string to a level.
 278     pub fn from_str(x: &str) -> Option<Level> {
 279         match x {
 280             "allow" => Some(Allow),
 281             "warn" => Some(Warn),
 282             "deny" => Some(Deny),
 283             "forbid" => Some(Forbid),
 284             _ => None,
 285         }
 286     }
 287 }
 288
 289 /// How a lint level was set.
 290 #[derive(Clone, Copy, PartialEq, Eq)]
 291 pub enum LintSource {
 292     /// Lint is at the default level as declared
 293     /// in rustc or a plugin.
 294     Default,
 295
 296     /// Lint level was set by an attribute.
 297     Node(Span),
 298
 299     /// Lint level was set by a command-line flag.
 300     CommandLine,
 301 }
 302
 303 pub type LevelSource = (Level, LintSource);
 304
 305 pub mod builtin;
 306
 307 mod context;