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 #![macro_escape]
  32
  33 use std::hash;
  34 use std::ascii::StrAsciiExt;
  35 use syntax::codemap::Span;
  36 use syntax::visit::FnKind;
  37 use syntax::ast;
  38
  39 pub use lint::context::{Context, LintStore, raw_emit_lint, check_crate, gather_attrs};
  40
  41 /// Specification of a single lint.
  42 pub struct Lint {
  43     /// A string identifier for the lint.
  44     ///
  45     /// This identifies the lint in attributes and in command-line arguments.
  46     /// In those contexts it is always lowercase, but this field is compared
  47     /// in a way which is case-insensitive for ASCII characters. This allows
  48     /// `declare_lint!()` invocations to follow the convention of upper-case
  49     /// statics without repeating the name.
  50     ///
  51     /// The name is written with underscores, e.g. "unused_imports".
  52     /// On the command line, underscores become dashes.
  53     pub name: &'static str,
  54
  55     /// Default level for the lint.
  56     pub default_level: Level,
  57
  58     /// Description of the lint or the issue it detects.
  59     ///
  60     /// e.g. "imports that are never used"
  61     pub desc: &'static str,
  62 }
  63
  64 impl Lint {
  65     /// Get the lint's name, with ASCII letters converted to lowercase.
  66     pub fn name_lower(&self) -> String {
  67         self.name.to_ascii_lower()
  68     }
  69 }
  70
  71 /// Build a `Lint` initializer.
  72 #[macro_export]
  73 macro_rules! lint_initializer (
  74     ($name:ident, $level:ident, $desc:expr) => (
  75         ::rustc::lint::Lint {
  76             name: stringify!($name),
  77             default_level: ::rustc::lint::$level,
  78             desc: $desc,
  79         }
  80     )
  81 )
  82
  83 /// Declare a static item of type `&'static Lint`.
  84 #[macro_export]
  85 macro_rules! declare_lint (
  86     // FIXME(#14660): deduplicate
  87     (pub $name:ident, $level:ident, $desc:expr) => (
  88         pub static $name: &'static ::rustc::lint::Lint
  89             = &lint_initializer!($name, $level, $desc);
  90     );
  91     ($name:ident, $level:ident, $desc:expr) => (
  92         static $name: &'static ::rustc::lint::Lint
  93             = &lint_initializer!($name, $level, $desc);
  94     );
  95 )
  96
  97 /// Declare a static `LintArray` and return it as an expression.
  98 #[macro_export]
  99 macro_rules! lint_array ( ($( $lint:expr ),*) => (
 100     {
 101         static array: LintArray = &[ $( $lint ),* ];
 102         array
 103     }
 104 ))
 105
 106 pub type LintArray = &'static [&'static Lint];
 107
 108 /// Trait for types providing lint checks.
 109 ///
 110 /// Each `check` method checks a single syntax node, and should not
 111 /// invoke methods recursively (unlike `Visitor`). By default they
 112 /// do nothing.
 113 //
 114 // FIXME: eliminate the duplication with `Visitor`. But this also
 115 // contains a few lint-specific methods with no equivalent in `Visitor`.
 116 pub trait LintPass {
 117     /// Get descriptions of the lints this `LintPass` object can emit.
 118     ///
 119     /// NB: there is no enforcement that the object only emits lints it registered.
 120     /// And some `rustc` internal `LintPass`es register lints to be emitted by other
 121     /// parts of the compiler. If you want enforced access restrictions for your
 122     /// `Lint`, make it a private `static` item in its own module.
 123     fn get_lints(&self) -> LintArray;
 124
 125     fn check_crate(&mut self, _: &Context, _: &ast::Crate) { }
 126     fn check_ident(&mut self, _: &Context, _: Span, _: ast::Ident) { }
 127     fn check_mod(&mut self, _: &Context, _: &ast::Mod, _: Span, _: ast::NodeId) { }
 128     fn check_view_item(&mut self, _: &Context, _: &ast::ViewItem) { }
 129     fn check_foreign_item(&mut self, _: &Context, _: &ast::ForeignItem) { }
 130     fn check_item(&mut self, _: &Context, _: &ast::Item) { }
 131     fn check_local(&mut self, _: &Context, _: &ast::Local) { }
 132     fn check_block(&mut self, _: &Context, _: &ast::Block) { }
 133     fn check_stmt(&mut self, _: &Context, _: &ast::Stmt) { }
 134     fn check_arm(&mut self, _: &Context, _: &ast::Arm) { }
 135     fn check_pat(&mut self, _: &Context, _: &ast::Pat) { }
 136     fn check_decl(&mut self, _: &Context, _: &ast::Decl) { }
 137     fn check_expr(&mut self, _: &Context, _: &ast::Expr) { }
 138     fn check_expr_post(&mut self, _: &Context, _: &ast::Expr) { }
 139     fn check_ty(&mut self, _: &Context, _: &ast::Ty) { }
 140     fn check_generics(&mut self, _: &Context, _: &ast::Generics) { }
 141     fn check_fn(&mut self, _: &Context,
 142         _: &FnKind, _: &ast::FnDecl, _: &ast::Block, _: Span, _: ast::NodeId) { }
 143     fn check_ty_method(&mut self, _: &Context, _: &ast::TypeMethod) { }
 144     fn check_trait_method(&mut self, _: &Context, _: &ast::TraitMethod) { }
 145     fn check_struct_def(&mut self, _: &Context,
 146         _: &ast::StructDef, _: ast::Ident, _: &ast::Generics, _: ast::NodeId) { }
 147     fn check_struct_def_post(&mut self, _: &Context,
 148         _: &ast::StructDef, _: ast::Ident, _: &ast::Generics, _: ast::NodeId) { }
 149     fn check_struct_field(&mut self, _: &Context, _: &ast::StructField) { }
 150     fn check_variant(&mut self, _: &Context, _: &ast::Variant, _: &ast::Generics) { }
 151     fn check_opt_lifetime_ref(&mut self, _: &Context, _: Span, _: &Option<ast::Lifetime>) { }
 152     fn check_lifetime_ref(&mut self, _: &Context, _: &ast::Lifetime) { }
 153     fn check_lifetime_decl(&mut self, _: &Context, _: &ast::Lifetime) { }
 154     fn check_explicit_self(&mut self, _: &Context, _: &ast::ExplicitSelf) { }
 155     fn check_mac(&mut self, _: &Context, _: &ast::Mac) { }
 156     fn check_path(&mut self, _: &Context, _: &ast::Path, _: ast::NodeId) { }
 157     fn check_attribute(&mut self, _: &Context, _: &ast::Attribute) { }
 158
 159     /// Called when entering a syntax node that can have lint attributes such
 160     /// as `#[allow(...)]`. Called with *all* the attributes of that node.
 161     fn enter_lint_attrs(&mut self, _: &Context, _: &[ast::Attribute]) { }
 162
 163     /// Counterpart to `enter_lint_attrs`.
 164     fn exit_lint_attrs(&mut self, _: &Context, _: &[ast::Attribute]) { }
 165 }
 166
 167 /// A lint pass boxed up as a trait object.
 168 pub type LintPassObject = Box<LintPass + 'static>;
 169
 170 /// Identifies a lint known to the compiler.
 171 #[deriving(Clone)]
 172 pub struct LintId {
 173     // Identity is based on pointer equality of this field.
 174     lint: &'static Lint,
 175 }
 176
 177 impl PartialEq for LintId {
 178     fn eq(&self, other: &LintId) -> bool {
 179         (self.lint as *const Lint) == (other.lint as *const Lint)
 180     }
 181 }
 182
 183 impl Eq for LintId { }
 184
 185 impl<S: hash::Writer> hash::Hash<S> for LintId {
 186     fn hash(&self, state: &mut S) {
 187         let ptr = self.lint as *const Lint;
 188         ptr.hash(state);
 189     }
 190 }
 191
 192 impl LintId {
 193     /// Get the `LintId` for a `Lint`.
 194     pub fn of(lint: &'static Lint) -> LintId {
 195         LintId {
 196             lint: lint,
 197         }
 198     }
 199
 200     /// Get the name of the lint.
 201     pub fn as_str(&self) -> String {
 202         self.lint.name_lower()
 203     }
 204 }
 205
 206 /// Setting for how to handle a lint.
 207 #[deriving(Clone, PartialEq, PartialOrd, Eq, Ord)]
 208 pub enum Level {
 209     Allow, Warn, Deny, Forbid
 210 }
 211
 212 impl Level {
 213     /// Convert a level to a lower-case string.
 214     pub fn as_str(self) -> &'static str {
 215         match self {
 216             Allow => "allow",
 217             Warn => "warn",
 218             Deny => "deny",
 219             Forbid => "forbid",
 220         }
 221     }
 222
 223     /// Convert a lower-case string to a level.
 224     pub fn from_str(x: &str) -> Option<Level> {
 225         match x {
 226             "allow" => Some(Allow),
 227             "warn" => Some(Warn),
 228             "deny" => Some(Deny),
 229             "forbid" => Some(Forbid),
 230             _ => None,
 231         }
 232     }
 233 }
 234
 235 /// How a lint level was set.
 236 #[deriving(Clone, PartialEq, Eq)]
 237 pub enum LintSource {
 238     /// Lint is at the default level as declared
 239     /// in rustc or a plugin.
 240     Default,
 241
 242     /// Lint level was set by an attribute.
 243     Node(Span),
 244
 245     /// Lint level was set by a command-line flag.
 246     CommandLine,
 247 }
 248
 249 pub type LevelSource = (Level, LintSource);
 250
 251 pub mod builtin;
 252
 253 mod context;