context.rs 37.8 KB
Newer Older
1
// Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Implementation of lint checking.
//!
//! The lint checking is mostly consolidated into one pass which runs just
//! before translation to LLVM bytecode. Throughout compilation, lint warnings
//! can be added via the `add_lint` method on the Session structure. This
//! requires a span and an id of the node that the lint is being added to. The
//! lint isn't actually emitted at that time because it is unknown what the
//! actual lint level at that location is.
//!
//! To actually emit lint warnings/errors, a separate pass is used just before
//! translation. A context keeps track of the current state of all lint levels.
//! Upon entering a node of the ast which can modify the lint settings, the
//! previous lint state is pushed onto a stack and the ast is then recursed
//! upon.  As the ast is traversed, this keeps track of the current lint level
//! for all lint attributes.
S
Steven Fackler 已提交
26
use self::TargetLint::*;
27

28
use middle::privacy::AccessLevels;
29
use middle::ty::{self, Ty};
30
use session::{early_error, Session};
N
Nick Cameron 已提交
31 32
use lint::{Level, LevelSource, Lint, LintId, LintArray, LintPass};
use lint::{EarlyLintPass, EarlyLintPassObject, LateLintPass, LateLintPassObject};
33
use lint::{Default, CommandLine, Node, Allow, Warn, Deny, Forbid};
34
use lint::builtin;
35
use util::nodemap::FnvHashMap;
36 37

use std::cell::RefCell;
38
use std::cmp;
39
use std::mem;
40
use syntax::ast_util::{self, IdVisitingOperation};
41
use syntax::attr::{self, AttrMetaMethods};
42
use syntax::codemap::Span;
43
use syntax::parse::token::InternedString;
44
use syntax::ast::{self, ThinAttributesExt};
M
Manish Goregaokar 已提交
45
use rustc_front::hir;
46
use rustc_front::util;
47
use rustc_front::intravisit as hir_visit;
48
use syntax::visit as ast_visit;
49
use syntax::diagnostic;
50 51 52 53 54 55 56 57 58 59 60

/// Information about the registered lints.
///
/// This is basically the subset of `Context` that we can
/// build early in the compile pipeline.
pub struct LintStore {
    /// Registered lints. The bool is true if the lint was
    /// added by a plugin.
    lints: Vec<(&'static Lint, bool)>,

    /// Trait objects for each lint pass.
61 62
    /// This is only `None` while iterating over the objects. See the definition
    /// of run_lints.
N
Nick Cameron 已提交
63 64
    early_passes: Option<Vec<EarlyLintPassObject>>,
    late_passes: Option<Vec<LateLintPassObject>>,
65 66

    /// Lints indexed by name.
67
    by_name: FnvHashMap<String, TargetLint>,
68 69

    /// Current levels of each lint, and where they were set.
70
    levels: FnvHashMap<LintId, LevelSource>,
71 72 73

    /// Map of registered lint groups to what lints they expand to. The bool
    /// is true if the lint group was added by a plugin.
74
    lint_groups: FnvHashMap<&'static str, (Vec<LintId>, bool)>,
75 76 77

    /// Maximum level a lint can be
    lint_cap: Option<Level>,
78 79
}

80 81 82 83 84 85 86
/// The targed of the `by_name` map, which accounts for renaming/deprecation.
enum TargetLint {
    /// A direct lint target
    Id(LintId),

    /// Temporary renaming, used for easing migration pain; see #16545
    Renamed(String, LintId),
87 88 89 90 91 92 93 94 95

    /// Lint with this name existed previously, but has been removed/deprecated.
    /// The string argument is the reason for removal.
    Removed(String),
}

enum FindLintError {
    NotFound,
    Removed
96 97
}

98 99
impl LintStore {
    fn get_level_source(&self, lint: LintId) -> LevelSource {
100
        match self.levels.get(&lint) {
101 102 103 104 105
            Some(&s) => s,
            None => (Allow, Default),
        }
    }

106 107 108 109
    fn set_level(&mut self, lint: LintId, mut lvlsrc: LevelSource) {
        if let Some(cap) = self.lint_cap {
            lvlsrc.0 = cmp::min(lvlsrc.0, cap);
        }
J
Jorge Aparicio 已提交
110
        if lvlsrc.0 == Allow {
111 112 113 114 115 116 117 118 119
            self.levels.remove(&lint);
        } else {
            self.levels.insert(lint, lvlsrc);
        }
    }

    pub fn new() -> LintStore {
        LintStore {
            lints: vec!(),
N
Nick Cameron 已提交
120 121
            early_passes: Some(vec!()),
            late_passes: Some(vec!()),
122 123 124
            by_name: FnvHashMap(),
            levels: FnvHashMap(),
            lint_groups: FnvHashMap(),
125
            lint_cap: None,
126 127 128 129
        }
    }

    pub fn get_lints<'t>(&'t self) -> &'t [(&'static Lint, bool)] {
130
        &self.lints
131 132
    }

133
    pub fn get_lint_groups<'t>(&'t self) -> Vec<(&'static str, Vec<LintId>, bool)> {
134
        self.lint_groups.iter().map(|(k, v)| (*k,
J
Jorge Aparicio 已提交
135 136
                                              v.0.clone(),
                                              v.1)).collect()
137 138
    }

N
Nick Cameron 已提交
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
    pub fn register_early_pass(&mut self,
                               sess: Option<&Session>,
                               from_plugin: bool,
                               pass: EarlyLintPassObject) {
        self.push_pass(sess, from_plugin, &pass);
        self.early_passes.as_mut().unwrap().push(pass);
    }

    pub fn register_late_pass(&mut self,
                              sess: Option<&Session>,
                              from_plugin: bool,
                              pass: LateLintPassObject) {
        self.push_pass(sess, from_plugin, &pass);
        self.late_passes.as_mut().unwrap().push(pass);
    }

    // Helper method for register_early/late_pass
    fn push_pass<P: LintPass + ?Sized + 'static>(&mut self,
                                        sess: Option<&Session>,
                                        from_plugin: bool,
                                        pass: &Box<P>) {
160
        for &lint in pass.get_lints() {
161
            self.lints.push((*lint, from_plugin));
162

163
            let id = LintId::of(*lint);
164
            if self.by_name.insert(lint.name_lower(), Id(id)).is_some() {
165
                let msg = format!("duplicate specification of lint {}", lint.name_lower());
166 167 168
                match (sess, from_plugin) {
                    // We load builtin lints first, so a duplicate is a compiler bug.
                    // Use early_error when handling -W help with no crate.
169
                    (None, _) => early_error(diagnostic::Auto, &msg[..]),
170
                    (Some(sess), false) => sess.bug(&msg[..]),
171 172

                    // A duplicate name from a plugin is a user error.
173
                    (Some(sess), true)  => sess.err(&msg[..]),
174 175 176 177 178 179 180 181 182
                }
            }

            if lint.default_level != Allow {
                self.levels.insert(id, (lint.default_level, Default));
            }
        }
    }

183 184 185
    pub fn register_group(&mut self, sess: Option<&Session>,
                          from_plugin: bool, name: &'static str,
                          to: Vec<LintId>) {
186
        let new = self.lint_groups.insert(name, (to, from_plugin)).is_none();
187 188 189 190 191 192

        if !new {
            let msg = format!("duplicate specification of lint group {}", name);
            match (sess, from_plugin) {
                // We load builtin lints first, so a duplicate is a compiler bug.
                // Use early_error when handling -W help with no crate.
193
                (None, _) => early_error(diagnostic::Auto, &msg[..]),
194
                (Some(sess), false) => sess.bug(&msg[..]),
195 196

                // A duplicate name from a plugin is a user error.
197
                (Some(sess), true)  => sess.err(&msg[..]),
198 199 200 201
            }
        }
    }

202
    pub fn register_renamed(&mut self, old_name: &str, new_name: &str) {
A
Aaron Turon 已提交
203
        let target = match self.by_name.get(new_name) {
204
            Some(&Id(lint_id)) => lint_id.clone(),
S
Steve Klabnik 已提交
205
            _ => panic!("invalid lint renaming of {} to {}", old_name, new_name)
206 207 208 209
        };
        self.by_name.insert(old_name.to_string(), Renamed(new_name.to_string(), target));
    }

210 211 212 213
    pub fn register_removed(&mut self, name: &str, reason: &str) {
        self.by_name.insert(name.into(), Removed(reason.into()));
    }

A
Alex Crichton 已提交
214
    #[allow(unused_variables)]
215
    fn find_lint(&self, lint_name: &str, sess: &Session, span: Option<Span>)
216
                 -> Result<LintId, FindLintError>
217
    {
A
Aaron Turon 已提交
218
        match self.by_name.get(lint_name) {
219
            Some(&Id(lint_id)) => Ok(lint_id),
220
            Some(&Renamed(ref new_name, lint_id)) => {
221 222 223
                let warning = format!("lint {} has been renamed to {}",
                                      lint_name, new_name);
                match span {
224 225
                    Some(span) => sess.span_warn(span, &warning[..]),
                    None => sess.warn(&warning[..]),
226
                };
227 228 229 230 231 232 233 234 235 236 237
                Ok(lint_id)
            },
            Some(&Removed(ref reason)) => {
                let warning = format!("lint {} has been removed: {}", lint_name, reason);
                match span {
                    Some(span) => sess.span_warn(span, &warning[..]),
                    None => sess.warn(&warning[..])
                }
                Err(FindLintError::Removed)
            },
            None => Err(FindLintError::NotFound)
238
        }
239 240 241
    }

    pub fn process_command_line(&mut self, sess: &Session) {
242
        for &(ref lint_name, level) in &sess.opts.lint_opts {
243
            match self.find_lint(&lint_name[..], sess, None) {
244 245
                Ok(lint_id) => self.set_level(lint_id, (level, CommandLine)),
                Err(_) => {
J
Jorge Aparicio 已提交
246
                    match self.lint_groups.iter().map(|(&x, pair)| (x, pair.0.clone()))
247 248
                                                 .collect::<FnvHashMap<&'static str,
                                                                       Vec<LintId>>>()
249
                                                 .get(&lint_name[..]) {
250 251 252 253 254 255
                        Some(v) => {
                            v.iter()
                             .map(|lint_id: &LintId|
                                     self.set_level(*lint_id, (level, CommandLine)))
                             .collect::<Vec<()>>();
                        }
J
Jorge Aparicio 已提交
256
                        None => sess.err(&format!("unknown {} flag: {}",
257
                                                 level.as_str(), lint_name)),
258 259
                    }
                }
260 261
            }
        }
262 263 264 265 266 267 268

        self.lint_cap = sess.opts.lint_cap;
        if let Some(cap) = self.lint_cap {
            for level in self.levels.iter_mut().map(|p| &mut (p.1).0) {
                *level = cmp::min(*level, cap);
            }
        }
269 270 271
    }
}

272 273
/// Context for lint checking after type checking.
pub struct LateContext<'a, 'tcx: 'a> {
274
    /// Type context we're checking in.
275
    pub tcx: &'a ty::ctxt<'tcx>,
276

277
    /// The crate being checked.
M
Manish Goregaokar 已提交
278
    pub krate: &'a hir::Crate,
279

280 281
    /// Items accessible from the crate being checked.
    pub access_levels: &'a AccessLevels,
282

283 284 285 286 287 288 289 290 291 292
    /// The store of registered lints.
    lints: LintStore,

    /// When recursing into an attributed node of the ast which modifies lint
    /// levels, this stack keeps track of the previous lint levels of whatever
    /// was modified.
    level_stack: Vec<(LintId, LevelSource)>,

    /// Level of lints for certain NodeIds, stored here because the body of
    /// the lint needs to run in trans.
293
    node_levels: RefCell<FnvHashMap<(ast::NodeId, LintId), LevelSource>>,
294 295
}

296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
/// Context for lint checking of the AST, after expansion, before lowering to
/// HIR.
pub struct EarlyContext<'a> {
    /// Type context we're checking in.
    pub sess: &'a Session,

    /// The crate being checked.
    pub krate: &'a ast::Crate,

    /// The store of registered lints.
    lints: LintStore,

    /// When recursing into an attributed node of the ast which modifies lint
    /// levels, this stack keeps track of the previous lint levels of whatever
    /// was modified.
    level_stack: Vec<(LintId, LevelSource)>,
}

314
/// Convenience macro for calling a `LintPass` method on every pass in the context.
N
Nick Cameron 已提交
315
macro_rules! run_lints { ($cx:expr, $f:ident, $ps:ident, $($args:expr),*) => ({
316 317
    // Move the vector of passes out of `$cx` so that we can
    // iterate over it mutably while passing `$cx` to the methods.
N
Nick Cameron 已提交
318
    let mut passes = $cx.mut_lints().$ps.take().unwrap();
319
    for obj in &mut passes {
320
        obj.$f($cx, $($args),*);
321
    }
N
Nick Cameron 已提交
322
    $cx.mut_lints().$ps = Some(passes);
323
}) }
324

325 326
/// Parse the lint attributes into a vector, with `Err`s for malformed lint
/// attributes. Writing this as an iterator is an enormous mess.
327
// See also the hir version just below.
328
pub fn gather_attrs(attrs: &[ast::Attribute])
329 330
                    -> Vec<Result<(InternedString, Level, Span), Span>> {
    let mut out = vec!();
331
    for attr in attrs {
332
        let level = match Level::from_str(&attr.name()) {
333 334 335 336 337 338
            None => continue,
            Some(lvl) => lvl,
        };

        attr::mark_used(attr);

339
        let meta = &attr.node.value;
340
        let metas = match meta.node {
341
            ast::MetaList(_, ref metas) => metas,
342 343 344 345 346 347 348 349
            _ => {
                out.push(Err(meta.span));
                continue;
            }
        };

        for meta in metas {
            out.push(match meta.node {
350
                ast::MetaWord(ref lint_name) => Ok((lint_name.clone(), level, meta.span)),
351 352 353 354 355 356
                _ => Err(meta.span),
            });
        }
    }
    out
}
357

358 359 360 361 362 363 364 365 366 367 368 369
/// Emit a lint as a warning or an error (or not at all)
/// according to `level`.
///
/// This lives outside of `Context` so it can be used by checks
/// in trans that run after the main lint pass is finished. Most
/// lints elsewhere in the compiler should call
/// `Session::add_lint()` instead.
pub fn raw_emit_lint(sess: &Session, lint: &'static Lint,
                     lvlsrc: LevelSource, span: Option<Span>, msg: &str) {
    let (mut level, source) = lvlsrc;
    if level == Allow { return }

370
    let name = lint.name_lower();
B
Brian Anderson 已提交
371
    let mut def = None;
372 373 374
    let msg = match source {
        Default => {
            format!("{}, #[{}({})] on by default", msg,
375
                    level.as_str(), name)
376 377 378
        },
        CommandLine => {
            format!("{} [-{} {}]", msg,
379 380
                    match level {
                        Warn => 'W', Deny => 'D', Forbid => 'F',
S
Steve Klabnik 已提交
381
                        Allow => panic!()
382
                    }, name.replace("_", "-"))
383 384
        },
        Node(src) => {
B
Brian Anderson 已提交
385 386 387
            def = Some(src);
            msg.to_string()
        }
388 389 390 391 392 393
    };

    // For purposes of printing, we can treat forbid as deny.
    if level == Forbid { level = Deny; }

    match (level, span) {
394 395 396 397
        (Warn, Some(sp)) => sess.span_warn(sp, &msg[..]),
        (Warn, None)     => sess.warn(&msg[..]),
        (Deny, Some(sp)) => sess.span_err(sp, &msg[..]),
        (Deny, None)     => sess.err(&msg[..]),
398 399 400
        _ => sess.bug("impossible level in raw_emit_lint"),
    }

401
    if let Some(span) = def {
402 403 404 405
        sess.span_note(span, "lint level defined here");
    }
}

406 407 408 409 410
pub trait LintContext: Sized {
    fn sess(&self) -> &Session;
    fn lints(&self) -> &LintStore;
    fn mut_lints(&mut self) -> &mut LintStore;
    fn level_stack(&mut self) -> &mut Vec<(LintId, LevelSource)>;
N
Nick Cameron 已提交
411 412
    fn enter_attrs(&mut self, attrs: &[ast::Attribute]);
    fn exit_attrs(&mut self, attrs: &[ast::Attribute]);
413

414 415
    /// Get the level of `lint` at the current position of the lint
    /// traversal.
416 417
    fn current_level(&self, lint: &'static Lint) -> Level {
        self.lints().levels.get(&LintId::of(lint)).map_or(Allow, |&(lvl, _)| lvl)
418 419
    }

420
    fn lookup_and_emit(&self, lint: &'static Lint, span: Option<Span>, msg: &str) {
421
        let (level, src) = match self.lints().levels.get(&LintId::of(lint)) {
422 423
            None => return,
            Some(&(Warn, src)) => {
424
                let lint_id = LintId::of(builtin::WARNINGS);
425
                (self.lints().get_level_source(lint_id).0, src)
426 427 428 429
            }
            Some(&pair) => pair,
        };

430
        raw_emit_lint(&self.sess(), lint, (level, src), span, msg);
431 432 433
    }

    /// Emit a lint at the appropriate level, for a particular span.
434
    fn span_lint(&self, lint: &'static Lint, span: Span, msg: &str) {
435 436 437
        self.lookup_and_emit(lint, Some(span), msg);
    }

438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
    /// Emit a lint and note at the appropriate level, for a particular span.
    fn span_lint_note(&self, lint: &'static Lint, span: Span, msg: &str,
                      note_span: Span, note: &str) {
        self.span_lint(lint, span, msg);
        if self.current_level(lint) != Level::Allow {
            if note_span == span {
                self.sess().fileline_note(note_span, note)
            } else {
                self.sess().span_note(note_span, note)
            }
        }
    }

    /// Emit a lint and help at the appropriate level, for a particular span.
    fn span_lint_help(&self, lint: &'static Lint, span: Span,
                      msg: &str, help: &str) {
        self.span_lint(lint, span, msg);
        if self.current_level(lint) != Level::Allow {
            self.sess().span_help(span, help)
        }
    }

460 461 462 463 464
    /// Emit a lint at the appropriate level, with no associated span.
    fn lint(&self, lint: &'static Lint, msg: &str) {
        self.lookup_and_emit(lint, None, msg);
    }

S
Steve Klabnik 已提交
465 466 467
    /// Merge the lints specified by any lint attributes into the
    /// current lint context, call the provided function, then reset the
    /// lints in effect to their previous state.
J
Jorge Aparicio 已提交
468
    fn with_lint_attrs<F>(&mut self,
469
                          attrs: &[ast::Attribute],
470 471
                          f: F)
        where F: FnOnce(&mut Self),
J
Jorge Aparicio 已提交
472
    {
473 474 475 476
        // Parse all of the lint attributes, and then add them all to the
        // current dictionary of lint information. Along the way, keep a history
        // of what we changed so we can roll everything back after invoking the
        // specified closure
477
        let mut pushed = 0;
478

479
        for result in gather_attrs(attrs) {
480
            let v = match result {
481
                Err(span) => {
482
                    span_err!(self.sess(), span, E0452,
483
                              "malformed lint attribute");
484 485 486
                    continue;
                }
                Ok((lint_name, level, span)) => {
487
                    match self.lints().find_lint(&lint_name, &self.sess(), Some(span)) {
488 489
                        Ok(lint_id) => vec![(lint_id, level, span)],
                        Err(FindLintError::NotFound) => {
490
                            match self.lints().lint_groups.get(&lint_name[..]) {
491 492 493 494 495
                                Some(&(ref v, _)) => v.iter()
                                                      .map(|lint_id: &LintId|
                                                           (*lint_id, level, span))
                                                      .collect(),
                                None => {
A
Aaron Turon 已提交
496
                                    self.span_lint(builtin::UNKNOWN_LINTS, span,
497 498
                                                   &format!("unknown `{}` attribute: `{}`",
                                                            level.as_str(), lint_name));
499 500 501
                                    continue;
                                }
                            }
502 503
                        },
                        Err(FindLintError::Removed) => { continue; }
504 505 506 507
                    }
                }
            };

508
            for (lint_id, level, span) in v {
509
                let now = self.lints().get_level_source(lint_id).0;
510 511
                if now == Forbid && level != Forbid {
                    let lint_name = lint_id.as_str();
512
                    span_err!(self.sess(), span, E0453,
513 514 515
                              "{}({}) overruled by outer forbid({})",
                              level.as_str(), lint_name,
                              lint_name);
516
                } else if now != level {
517 518
                    let src = self.lints().get_level_source(lint_id).1;
                    self.level_stack().push((lint_id, (now, src)));
519
                    pushed += 1;
520
                    self.mut_lints().set_level(lint_id, (level, Node(span)));
521
                }
522 523 524
            }
        }

525
        self.enter_attrs(attrs);
526
        f(self);
527
        self.exit_attrs(attrs);
528 529

        // rollback
530
        for _ in 0..pushed {
531 532 533 534 535 536 537 538 539 540
            let (lint, lvlsrc) = self.level_stack().pop().unwrap();
            self.mut_lints().set_level(lint, lvlsrc);
        }
    }
}


impl<'a> EarlyContext<'a> {
    fn new(sess: &'a Session,
           krate: &'a ast::Crate) -> EarlyContext<'a> {
N
Nick Cameron 已提交
541 542
        // We want to own the lint store, so move it out of the session. Remember
        // to put it back later...
543 544 545 546 547 548 549
        let lint_store = mem::replace(&mut *sess.lint_store.borrow_mut(),
                                      LintStore::new());
        EarlyContext {
            sess: sess,
            krate: krate,
            lints: lint_store,
            level_stack: vec![],
550 551 552
        }
    }

553 554 555 556 557 558 559 560 561 562 563 564 565 566
    fn visit_ids<F>(&mut self, f: F)
        where F: FnOnce(&mut ast_util::IdVisitor<EarlyContext>)
    {
        let mut v = ast_util::IdVisitor {
            operation: self,
            visited_outermost: false,
        };
        f(&mut v);
    }
}

impl<'a, 'tcx> LateContext<'a, 'tcx> {
    fn new(tcx: &'a ty::ctxt<'tcx>,
           krate: &'a hir::Crate,
567
           access_levels: &'a AccessLevels) -> LateContext<'a, 'tcx> {
568 569 570 571 572 573 574
        // We want to own the lint store, so move it out of the session.
        let lint_store = mem::replace(&mut *tcx.sess.lint_store.borrow_mut(),
                                      LintStore::new());

        LateContext {
            tcx: tcx,
            krate: krate,
575
            access_levels: access_levels,
576 577 578 579 580 581 582 583
            lints: lint_store,
            level_stack: vec![],
            node_levels: RefCell::new(FnvHashMap()),
        }
    }

    fn visit_ids<F>(&mut self, f: F)
        where F: FnOnce(&mut util::IdVisitor<LateContext>)
J
Jorge Aparicio 已提交
584
    {
585
        let mut v = util::IdVisitor::new(self);
586 587 588 589
        f(&mut v);
    }
}

590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
impl<'a, 'tcx> LintContext for LateContext<'a, 'tcx> {
    /// Get the overall compiler `Session` object.
    fn sess(&self) -> &Session {
        &self.tcx.sess
    }

    fn lints(&self) -> &LintStore {
        &self.lints
    }

    fn mut_lints(&mut self) -> &mut LintStore {
        &mut self.lints
    }

    fn level_stack(&mut self) -> &mut Vec<(LintId, LevelSource)> {
        &mut self.level_stack
    }

N
Nick Cameron 已提交
608
    fn enter_attrs(&mut self, attrs: &[ast::Attribute]) {
609
        debug!("late context: enter_attrs({:?})", attrs);
N
Nick Cameron 已提交
610
        run_lints!(self, enter_lint_attrs, late_passes, attrs);
611 612
    }

N
Nick Cameron 已提交
613
    fn exit_attrs(&mut self, attrs: &[ast::Attribute]) {
614
        debug!("late context: exit_attrs({:?})", attrs);
N
Nick Cameron 已提交
615
        run_lints!(self, exit_lint_attrs, late_passes, attrs);
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
    }
}

impl<'a> LintContext for EarlyContext<'a> {
    /// Get the overall compiler `Session` object.
    fn sess(&self) -> &Session {
        &self.sess
    }

    fn lints(&self) -> &LintStore {
        &self.lints
    }

    fn mut_lints(&mut self) -> &mut LintStore {
        &mut self.lints
    }

    fn level_stack(&mut self) -> &mut Vec<(LintId, LevelSource)> {
        &mut self.level_stack
    }

N
Nick Cameron 已提交
637
    fn enter_attrs(&mut self, attrs: &[ast::Attribute]) {
638
        debug!("early context: exit_attrs({:?})", attrs);
N
Nick Cameron 已提交
639
        run_lints!(self, enter_lint_attrs, early_passes, attrs);
640 641
    }

N
Nick Cameron 已提交
642
    fn exit_attrs(&mut self, attrs: &[ast::Attribute]) {
643
        debug!("early context: exit_attrs({:?})", attrs);
N
Nick Cameron 已提交
644
        run_lints!(self, exit_lint_attrs, early_passes, attrs);
645 646 647 648
    }
}

impl<'a, 'tcx, 'v> hir_visit::Visitor<'v> for LateContext<'a, 'tcx> {
649 650 651 652 653 654 655
    /// Because lints are scoped lexically, we want to walk nested
    /// items in the context of the outer item, so enable
    /// deep-walking.
    fn visit_nested_item(&mut self, item: hir::ItemId) {
        self.visit_item(self.tcx.map.expect_item(item.id))
    }

M
Manish Goregaokar 已提交
656
    fn visit_item(&mut self, it: &hir::Item) {
657
        self.with_lint_attrs(&it.attrs, |cx| {
N
Nick Cameron 已提交
658
            run_lints!(cx, check_item, late_passes, it);
659
            cx.visit_ids(|v| v.visit_item(it));
660
            hir_visit::walk_item(cx, it);
661 662 663
        })
    }

M
Manish Goregaokar 已提交
664
    fn visit_foreign_item(&mut self, it: &hir::ForeignItem) {
665
        self.with_lint_attrs(&it.attrs, |cx| {
N
Nick Cameron 已提交
666
            run_lints!(cx, check_foreign_item, late_passes, it);
667
            hir_visit::walk_foreign_item(cx, it);
668 669 670
        })
    }

M
Manish Goregaokar 已提交
671
    fn visit_pat(&mut self, p: &hir::Pat) {
N
Nick Cameron 已提交
672
        run_lints!(self, check_pat, late_passes, p);
673
        hir_visit::walk_pat(self, p);
674 675
    }

M
Manish Goregaokar 已提交
676
    fn visit_expr(&mut self, e: &hir::Expr) {
677 678 679 680
        self.with_lint_attrs(e.attrs.as_attrs(), |cx| {
            run_lints!(cx, check_expr, late_passes, e);
            hir_visit::walk_expr(cx, e);
        })
681 682
    }

M
Manish Goregaokar 已提交
683
    fn visit_stmt(&mut self, s: &hir::Stmt) {
684 685 686 687 688
        // statement attributes are actually just attributes on one of
        // - item
        // - local
        // - expression
        // so we keep track of lint levels there
N
Nick Cameron 已提交
689
        run_lints!(self, check_stmt, late_passes, s);
690
        hir_visit::walk_stmt(self, s);
691 692
    }

693
    fn visit_fn(&mut self, fk: hir_visit::FnKind<'v>, decl: &'v hir::FnDecl,
M
Manish Goregaokar 已提交
694
                body: &'v hir::Block, span: Span, id: ast::NodeId) {
N
Nick Cameron 已提交
695
        run_lints!(self, check_fn, late_passes, fk, decl, body, span, id);
696
        hir_visit::walk_fn(self, fk, decl, body, span);
697 698
    }

699 700
    fn visit_variant_data(&mut self,
                        s: &hir::VariantData,
701
                        name: ast::Name,
M
Manish Goregaokar 已提交
702
                        g: &hir::Generics,
703 704
                        item_id: ast::NodeId,
                        _: Span) {
705
        run_lints!(self, check_struct_def, late_passes, s, name, g, item_id);
706
        hir_visit::walk_struct_def(self, s);
707
        run_lints!(self, check_struct_def_post, late_passes, s, name, g, item_id);
708 709
    }

M
Manish Goregaokar 已提交
710
    fn visit_struct_field(&mut self, s: &hir::StructField) {
711
        self.with_lint_attrs(&s.node.attrs, |cx| {
N
Nick Cameron 已提交
712
            run_lints!(cx, check_struct_field, late_passes, s);
713
            hir_visit::walk_struct_field(cx, s);
714 715 716
        })
    }

717
    fn visit_variant(&mut self, v: &hir::Variant, g: &hir::Generics, item_id: ast::NodeId) {
718
        self.with_lint_attrs(&v.node.attrs, |cx| {
N
Nick Cameron 已提交
719
            run_lints!(cx, check_variant, late_passes, v, g);
720
            hir_visit::walk_variant(cx, v, g, item_id);
N
Nick Cameron 已提交
721
            run_lints!(cx, check_variant_post, late_passes, v, g);
722 723 724
        })
    }

M
Manish Goregaokar 已提交
725
    fn visit_ty(&mut self, t: &hir::Ty) {
N
Nick Cameron 已提交
726
        run_lints!(self, check_ty, late_passes, t);
727
        hir_visit::walk_ty(self, t);
728 729
    }

730 731
    fn visit_name(&mut self, sp: Span, name: ast::Name) {
        run_lints!(self, check_name, late_passes, sp, name);
732 733
    }

M
Manish Goregaokar 已提交
734
    fn visit_mod(&mut self, m: &hir::Mod, s: Span, n: ast::NodeId) {
N
Nick Cameron 已提交
735
        run_lints!(self, check_mod, late_passes, m, s, n);
736
        hir_visit::walk_mod(self, m);
737 738
    }

M
Manish Goregaokar 已提交
739
    fn visit_local(&mut self, l: &hir::Local) {
740 741 742 743
        self.with_lint_attrs(l.attrs.as_attrs(), |cx| {
            run_lints!(cx, check_local, late_passes, l);
            hir_visit::walk_local(cx, l);
        })
744 745
    }

M
Manish Goregaokar 已提交
746
    fn visit_block(&mut self, b: &hir::Block) {
N
Nick Cameron 已提交
747
        run_lints!(self, check_block, late_passes, b);
748
        hir_visit::walk_block(self, b);
749 750
    }

M
Manish Goregaokar 已提交
751
    fn visit_arm(&mut self, a: &hir::Arm) {
N
Nick Cameron 已提交
752
        run_lints!(self, check_arm, late_passes, a);
753
        hir_visit::walk_arm(self, a);
754 755
    }

M
Manish Goregaokar 已提交
756
    fn visit_decl(&mut self, d: &hir::Decl) {
N
Nick Cameron 已提交
757
        run_lints!(self, check_decl, late_passes, d);
758
        hir_visit::walk_decl(self, d);
759 760
    }

M
Manish Goregaokar 已提交
761
    fn visit_expr_post(&mut self, e: &hir::Expr) {
N
Nick Cameron 已提交
762
        run_lints!(self, check_expr_post, late_passes, e);
763 764
    }

M
Manish Goregaokar 已提交
765
    fn visit_generics(&mut self, g: &hir::Generics) {
N
Nick Cameron 已提交
766
        run_lints!(self, check_generics, late_passes, g);
767
        hir_visit::walk_generics(self, g);
768 769
    }

M
Manish Goregaokar 已提交
770
    fn visit_trait_item(&mut self, trait_item: &hir::TraitItem) {
771
        self.with_lint_attrs(&trait_item.attrs, |cx| {
N
Nick Cameron 已提交
772
            run_lints!(cx, check_trait_item, late_passes, trait_item);
773
            cx.visit_ids(|v| v.visit_trait_item(trait_item));
774
            hir_visit::walk_trait_item(cx, trait_item);
775 776 777
        });
    }

M
Manish Goregaokar 已提交
778
    fn visit_impl_item(&mut self, impl_item: &hir::ImplItem) {
779
        self.with_lint_attrs(&impl_item.attrs, |cx| {
N
Nick Cameron 已提交
780
            run_lints!(cx, check_impl_item, late_passes, impl_item);
781
            cx.visit_ids(|v| v.visit_impl_item(impl_item));
782
            hir_visit::walk_impl_item(cx, impl_item);
783
        });
784 785
    }

786 787
    fn visit_lifetime(&mut self, lt: &hir::Lifetime) {
        run_lints!(self, check_lifetime, late_passes, lt);
788 789
    }

M
Manish Goregaokar 已提交
790
    fn visit_lifetime_def(&mut self, lt: &hir::LifetimeDef) {
N
Nick Cameron 已提交
791
        run_lints!(self, check_lifetime_def, late_passes, lt);
792 793
    }

M
Manish Goregaokar 已提交
794
    fn visit_explicit_self(&mut self, es: &hir::ExplicitSelf) {
N
Nick Cameron 已提交
795
        run_lints!(self, check_explicit_self, late_passes, es);
796
        hir_visit::walk_explicit_self(self, es);
797 798
    }

M
Manish Goregaokar 已提交
799
    fn visit_path(&mut self, p: &hir::Path, id: ast::NodeId) {
N
Nick Cameron 已提交
800
        run_lints!(self, check_path, late_passes, p, id);
801
        hir_visit::walk_path(self, p);
802 803
    }

V
Vadim Petrochenkov 已提交
804 805 806 807 808
    fn visit_path_list_item(&mut self, prefix: &hir::Path, item: &hir::PathListItem) {
        run_lints!(self, check_path_list_item, late_passes, item);
        hir_visit::walk_path_list_item(self, prefix, item);
    }

809
    fn visit_attribute(&mut self, attr: &ast::Attribute) {
N
Nick Cameron 已提交
810
        run_lints!(self, check_attribute, late_passes, attr);
811 812 813
    }
}

814 815
impl<'a, 'v> ast_visit::Visitor<'v> for EarlyContext<'a> {
    fn visit_item(&mut self, it: &ast::Item) {
N
Nick Cameron 已提交
816
        self.with_lint_attrs(&it.attrs, |cx| {
N
Nick Cameron 已提交
817
            run_lints!(cx, check_item, early_passes, it);
818 819 820 821 822 823
            cx.visit_ids(|v| v.visit_item(it));
            ast_visit::walk_item(cx, it);
        })
    }

    fn visit_foreign_item(&mut self, it: &ast::ForeignItem) {
N
Nick Cameron 已提交
824
        self.with_lint_attrs(&it.attrs, |cx| {
N
Nick Cameron 已提交
825
            run_lints!(cx, check_foreign_item, early_passes, it);
826 827 828 829 830
            ast_visit::walk_foreign_item(cx, it);
        })
    }

    fn visit_pat(&mut self, p: &ast::Pat) {
N
Nick Cameron 已提交
831
        run_lints!(self, check_pat, early_passes, p);
832 833 834 835
        ast_visit::walk_pat(self, p);
    }

    fn visit_expr(&mut self, e: &ast::Expr) {
N
Nick Cameron 已提交
836
        run_lints!(self, check_expr, early_passes, e);
837 838 839 840
        ast_visit::walk_expr(self, e);
    }

    fn visit_stmt(&mut self, s: &ast::Stmt) {
N
Nick Cameron 已提交
841
        run_lints!(self, check_stmt, early_passes, s);
842 843 844 845 846
        ast_visit::walk_stmt(self, s);
    }

    fn visit_fn(&mut self, fk: ast_visit::FnKind<'v>, decl: &'v ast::FnDecl,
                body: &'v ast::Block, span: Span, id: ast::NodeId) {
N
Nick Cameron 已提交
847
        run_lints!(self, check_fn, early_passes, fk, decl, body, span, id);
848 849 850
        ast_visit::walk_fn(self, fk, decl, body, span);
    }

851 852
    fn visit_variant_data(&mut self,
                        s: &ast::VariantData,
853 854
                        ident: ast::Ident,
                        g: &ast::Generics,
855 856
                        item_id: ast::NodeId,
                        _: Span) {
857
        run_lints!(self, check_struct_def, early_passes, s, ident, g, item_id);
858
        ast_visit::walk_struct_def(self, s);
859
        run_lints!(self, check_struct_def_post, early_passes, s, ident, g, item_id);
860 861 862
    }

    fn visit_struct_field(&mut self, s: &ast::StructField) {
N
Nick Cameron 已提交
863
        self.with_lint_attrs(&s.node.attrs, |cx| {
N
Nick Cameron 已提交
864
            run_lints!(cx, check_struct_field, early_passes, s);
865 866 867 868
            ast_visit::walk_struct_field(cx, s);
        })
    }

869
    fn visit_variant(&mut self, v: &ast::Variant, g: &ast::Generics, item_id: ast::NodeId) {
N
Nick Cameron 已提交
870
        self.with_lint_attrs(&v.node.attrs, |cx| {
N
Nick Cameron 已提交
871
            run_lints!(cx, check_variant, early_passes, v, g);
872
            ast_visit::walk_variant(cx, v, g, item_id);
N
Nick Cameron 已提交
873
            run_lints!(cx, check_variant_post, early_passes, v, g);
874 875 876 877
        })
    }

    fn visit_ty(&mut self, t: &ast::Ty) {
N
Nick Cameron 已提交
878
        run_lints!(self, check_ty, early_passes, t);
879 880 881 882
        ast_visit::walk_ty(self, t);
    }

    fn visit_ident(&mut self, sp: Span, id: ast::Ident) {
N
Nick Cameron 已提交
883
        run_lints!(self, check_ident, early_passes, sp, id);
884 885 886
    }

    fn visit_mod(&mut self, m: &ast::Mod, s: Span, n: ast::NodeId) {
N
Nick Cameron 已提交
887
        run_lints!(self, check_mod, early_passes, m, s, n);
888 889 890 891
        ast_visit::walk_mod(self, m);
    }

    fn visit_local(&mut self, l: &ast::Local) {
N
Nick Cameron 已提交
892
        run_lints!(self, check_local, early_passes, l);
893 894 895 896
        ast_visit::walk_local(self, l);
    }

    fn visit_block(&mut self, b: &ast::Block) {
N
Nick Cameron 已提交
897
        run_lints!(self, check_block, early_passes, b);
898 899 900 901
        ast_visit::walk_block(self, b);
    }

    fn visit_arm(&mut self, a: &ast::Arm) {
N
Nick Cameron 已提交
902
        run_lints!(self, check_arm, early_passes, a);
903 904 905 906
        ast_visit::walk_arm(self, a);
    }

    fn visit_decl(&mut self, d: &ast::Decl) {
N
Nick Cameron 已提交
907
        run_lints!(self, check_decl, early_passes, d);
908 909 910 911
        ast_visit::walk_decl(self, d);
    }

    fn visit_expr_post(&mut self, e: &ast::Expr) {
N
Nick Cameron 已提交
912
        run_lints!(self, check_expr_post, early_passes, e);
913 914 915
    }

    fn visit_generics(&mut self, g: &ast::Generics) {
N
Nick Cameron 已提交
916
        run_lints!(self, check_generics, early_passes, g);
917 918 919 920
        ast_visit::walk_generics(self, g);
    }

    fn visit_trait_item(&mut self, trait_item: &ast::TraitItem) {
N
Nick Cameron 已提交
921
        self.with_lint_attrs(&trait_item.attrs, |cx| {
N
Nick Cameron 已提交
922
            run_lints!(cx, check_trait_item, early_passes, trait_item);
923 924 925 926 927 928
            cx.visit_ids(|v| v.visit_trait_item(trait_item));
            ast_visit::walk_trait_item(cx, trait_item);
        });
    }

    fn visit_impl_item(&mut self, impl_item: &ast::ImplItem) {
N
Nick Cameron 已提交
929
        self.with_lint_attrs(&impl_item.attrs, |cx| {
N
Nick Cameron 已提交
930
            run_lints!(cx, check_impl_item, early_passes, impl_item);
931 932 933 934 935
            cx.visit_ids(|v| v.visit_impl_item(impl_item));
            ast_visit::walk_impl_item(cx, impl_item);
        });
    }

936 937
    fn visit_lifetime(&mut self, lt: &ast::Lifetime) {
        run_lints!(self, check_lifetime, early_passes, lt);
938 939 940
    }

    fn visit_lifetime_def(&mut self, lt: &ast::LifetimeDef) {
N
Nick Cameron 已提交
941
        run_lints!(self, check_lifetime_def, early_passes, lt);
942 943 944
    }

    fn visit_explicit_self(&mut self, es: &ast::ExplicitSelf) {
N
Nick Cameron 已提交
945
        run_lints!(self, check_explicit_self, early_passes, es);
946 947 948 949
        ast_visit::walk_explicit_self(self, es);
    }

    fn visit_path(&mut self, p: &ast::Path, id: ast::NodeId) {
N
Nick Cameron 已提交
950
        run_lints!(self, check_path, early_passes, p, id);
951 952 953
        ast_visit::walk_path(self, p);
    }

V
Vadim Petrochenkov 已提交
954 955 956
    fn visit_path_list_item(&mut self, prefix: &ast::Path, item: &ast::PathListItem) {
        run_lints!(self, check_path_list_item, early_passes, item);
        ast_visit::walk_path_list_item(self, prefix, item);
957 958
    }

959
    fn visit_attribute(&mut self, attr: &ast::Attribute) {
N
Nick Cameron 已提交
960
        run_lints!(self, check_attribute, early_passes, attr);
961 962 963
    }
}

964
// Output any lints that were previously added to the session.
965 966 967 968 969
impl<'a, 'tcx> IdVisitingOperation for LateContext<'a, 'tcx> {
    fn visit_id(&mut self, id: ast::NodeId) {
        match self.sess().lints.borrow_mut().remove(&id) {
            None => {}
            Some(lints) => {
970
                debug!("LateContext::visit_id: id={:?} lints={:?}", id, lints);
971 972 973 974 975 976 977 978
                for (lint_id, span, msg) in lints {
                    self.span_lint(lint_id.lint, span, &msg[..])
                }
            }
        }
    }
}
impl<'a> IdVisitingOperation for EarlyContext<'a> {
A
Ariel Ben-Yehuda 已提交
979
    fn visit_id(&mut self, id: ast::NodeId) {
980
        match self.sess.lints.borrow_mut().remove(&id) {
981 982
            None => {}
            Some(lints) => {
983
                for (lint_id, span, msg) in lints {
984
                    self.span_lint(lint_id.lint, span, &msg[..])
985 986 987 988 989 990
                }
            }
        }
    }
}

991
// This lint pass is defined here because it touches parts of the `LateContext`
992 993 994 995
// that we don't want to expose. It records the lint level at certain AST
// nodes, so that the variant size difference check in trans can call
// `raw_emit_lint`.

996
pub struct GatherNodeLevels;
997 998 999 1000 1001

impl LintPass for GatherNodeLevels {
    fn get_lints(&self) -> LintArray {
        lint_array!()
    }
N
Nick Cameron 已提交
1002
}
1003

N
Nick Cameron 已提交
1004
impl LateLintPass for GatherNodeLevels {
1005
    fn check_item(&mut self, cx: &LateContext, it: &hir::Item) {
1006
        match it.node {
M
Manish Goregaokar 已提交
1007
            hir::ItemEnum(..) => {
A
Aaron Turon 已提交
1008
                let lint_id = LintId::of(builtin::VARIANT_SIZE_DIFFERENCES);
1009 1010 1011
                let lvlsrc = cx.lints.get_level_source(lint_id);
                match lvlsrc {
                    (lvl, _) if lvl != Allow => {
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
                        cx.node_levels.borrow_mut()
                            .insert((it.id, lint_id), lvlsrc);
                    },
                    _ => { }
                }
            },
            _ => { }
        }
    }
}

/// Perform lint checking on a crate.
///
/// Consumes the `lint_store` field of the `Session`.
1026
pub fn check_crate(tcx: &ty::ctxt, access_levels: &AccessLevels) {
1027
    let krate = tcx.map.krate();
1028
    let mut cx = LateContext::new(tcx, krate, access_levels);
1029 1030

    // Visit the whole crate.
1031
    cx.with_lint_attrs(&krate.attrs, |cx| {
1032 1033
        cx.visit_id(ast::CRATE_NODE_ID);
        cx.visit_ids(|v| {
1034
            hir_visit::walk_crate(v, krate);
1035 1036 1037 1038
        });

        // since the root module isn't visited as an item (because it isn't an
        // item), warn for it here.
N
Nick Cameron 已提交
1039
        run_lints!(cx, check_crate, late_passes, krate);
1040

1041
        hir_visit::walk_crate(cx, krate);
1042 1043 1044 1045
    });

    // If we missed any lints added to the session, then there's a bug somewhere
    // in the iteration code.
1046
    for (id, v) in tcx.sess.lints.borrow().iter() {
1047
        for &(lint, span, ref msg) in v {
1048
            tcx.sess.span_bug(span,
1049 1050
                              &format!("unprocessed lint {} at {}: {}",
                                       lint.as_str(), tcx.map.node_to_string(*id), *msg))
1051 1052 1053
        }
    }

1054
    *tcx.node_lint_levels.borrow_mut() = cx.node_levels.into_inner();
1055
}
1056 1057 1058 1059 1060

pub fn check_ast_crate(sess: &Session, krate: &ast::Crate) {
    let mut cx = EarlyContext::new(sess, krate);

    // Visit the whole crate.
N
Nick Cameron 已提交
1061
    cx.with_lint_attrs(&krate.attrs, |cx| {
1062 1063 1064 1065 1066 1067 1068 1069
        cx.visit_id(ast::CRATE_NODE_ID);
        cx.visit_ids(|v| {
            v.visited_outermost = true;
            ast_visit::walk_crate(v, krate);
        });

        // since the root module isn't visited as an item (because it isn't an
        // item), warn for it here.
N
Nick Cameron 已提交
1070
        run_lints!(cx, check_crate, early_passes, krate);
1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087

        ast_visit::walk_crate(cx, krate);
    });

    // Put the lint store back in the session.
    mem::replace(&mut *sess.lint_store.borrow_mut(), cx.lints);

    // If we missed any lints added to the session, then there's a bug somewhere
    // in the iteration code.
    for (_, v) in sess.lints.borrow().iter() {
        for &(lint, span, ref msg) in v {
            sess.span_bug(span,
                          &format!("unprocessed lint {}: {}",
                                   lint.as_str(), *msg))
        }
    }
}