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