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 45
use syntax::ast;
use syntax::attr::ThinAttributesExt;
M
Manish Goregaokar 已提交
46
use rustc_front::hir;
47
use rustc_front::util;
48
use rustc_front::intravisit as hir_visit;
49
use syntax::visit as ast_visit;
50
use syntax::diagnostic;
51 52 53 54 55 56 57 58 59 60 61

/// 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.
62 63
    /// This is only `None` while iterating over the objects. See the definition
    /// of run_lints.
N
Nick Cameron 已提交
64 65
    early_passes: Option<Vec<EarlyLintPassObject>>,
    late_passes: Option<Vec<LateLintPassObject>>,
66 67

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

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

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

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

81 82 83 84 85 86 87
/// 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),
88 89 90 91 92 93 94 95 96

    /// 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
97 98
}

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

107 108 109 110
    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 已提交
111
        if lvlsrc.0 == Allow {
112 113 114 115 116 117 118 119 120
            self.levels.remove(&lint);
        } else {
            self.levels.insert(lint, lvlsrc);
        }
    }

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

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

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

N
Nick Cameron 已提交
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
    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>) {
161
        for &lint in pass.get_lints() {
162
            self.lints.push((*lint, from_plugin));
163

164
            let id = LintId::of(*lint);
165
            if self.by_name.insert(lint.name_lower(), Id(id)).is_some() {
166
                let msg = format!("duplicate specification of lint {}", lint.name_lower());
167 168 169
                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.
170
                    (None, _) => early_error(diagnostic::Auto, &msg[..]),
171
                    (Some(sess), false) => sess.bug(&msg[..]),
172 173

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

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

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

        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.
194
                (None, _) => early_error(diagnostic::Auto, &msg[..]),
195
                (Some(sess), false) => sess.bug(&msg[..]),
196 197

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

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

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

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

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

        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);
            }
        }
270 271 272
    }
}

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

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

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

284 285 286 287 288 289 290 291 292 293
    /// 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.
294
    node_levels: RefCell<FnvHashMap<(ast::NodeId, LintId), LevelSource>>,
295 296
}

297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
/// 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)>,
}

315
/// Convenience macro for calling a `LintPass` method on every pass in the context.
N
Nick Cameron 已提交
316
macro_rules! run_lints { ($cx:expr, $f:ident, $ps:ident, $($args:expr),*) => ({
317 318
    // 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 已提交
319
    let mut passes = $cx.mut_lints().$ps.take().unwrap();
320
    for obj in &mut passes {
321
        obj.$f($cx, $($args),*);
322
    }
N
Nick Cameron 已提交
323
    $cx.mut_lints().$ps = Some(passes);
324
}) }
325

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

        attr::mark_used(attr);

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

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

359 360 361 362 363 364 365 366 367 368 369 370
/// 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 }

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

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

    match (level, span) {
395 396 397 398
        (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[..]),
399 400 401
        _ => sess.bug("impossible level in raw_emit_lint"),
    }

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

407 408 409 410 411
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 已提交
412 413
    fn enter_attrs(&mut self, attrs: &[ast::Attribute]);
    fn exit_attrs(&mut self, attrs: &[ast::Attribute]);
414

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

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

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

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

439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
    /// 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)
        }
    }

461 462 463 464 465
    /// 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 已提交
466 467 468
    /// 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 已提交
469
    fn with_lint_attrs<F>(&mut self,
470
                          attrs: &[ast::Attribute],
471 472
                          f: F)
        where F: FnOnce(&mut Self),
J
Jorge Aparicio 已提交
473
    {
474 475 476 477
        // 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
478
        let mut pushed = 0;
479

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

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

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

        // rollback
531
        for _ in 0..pushed {
532 533 534 535 536 537 538 539 540 541
            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 已提交
542 543
        // We want to own the lint store, so move it out of the session. Remember
        // to put it back later...
544 545 546 547 548 549 550
        let lint_store = mem::replace(&mut *sess.lint_store.borrow_mut(),
                                      LintStore::new());
        EarlyContext {
            sess: sess,
            krate: krate,
            lints: lint_store,
            level_stack: vec![],
551 552 553
        }
    }

554 555 556 557 558 559 560 561 562 563 564 565 566 567
    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,
568
           access_levels: &'a AccessLevels) -> LateContext<'a, 'tcx> {
569 570 571 572 573 574 575
        // 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,
576
            access_levels: access_levels,
577 578 579 580 581 582 583 584
            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 已提交
585
    {
586
        let mut v = util::IdVisitor::new(self);
587 588 589 590
        f(&mut v);
    }
}

591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
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 已提交
609
    fn enter_attrs(&mut self, attrs: &[ast::Attribute]) {
610
        debug!("late context: enter_attrs({:?})", attrs);
N
Nick Cameron 已提交
611
        run_lints!(self, enter_lint_attrs, late_passes, attrs);
612 613
    }

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

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 已提交
638
    fn enter_attrs(&mut self, attrs: &[ast::Attribute]) {
639
        debug!("early context: exit_attrs({:?})", attrs);
N
Nick Cameron 已提交
640
        run_lints!(self, enter_lint_attrs, early_passes, attrs);
641 642
    }

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

impl<'a, 'tcx, 'v> hir_visit::Visitor<'v> for LateContext<'a, 'tcx> {
650 651 652 653 654 655 656
    /// 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 已提交
657
    fn visit_item(&mut self, it: &hir::Item) {
658
        self.with_lint_attrs(&it.attrs, |cx| {
N
Nick Cameron 已提交
659
            run_lints!(cx, check_item, late_passes, it);
660
            cx.visit_ids(|v| v.visit_item(it));
661
            hir_visit::walk_item(cx, it);
662 663 664
        })
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

V
Vadim Petrochenkov 已提交
805 806 807 808 809
    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);
    }

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

815 816
impl<'a, 'v> ast_visit::Visitor<'v> for EarlyContext<'a> {
    fn visit_item(&mut self, it: &ast::Item) {
N
Nick Cameron 已提交
817
        self.with_lint_attrs(&it.attrs, |cx| {
N
Nick Cameron 已提交
818
            run_lints!(cx, check_item, early_passes, it);
819 820 821 822 823 824
            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 已提交
825
        self.with_lint_attrs(&it.attrs, |cx| {
N
Nick Cameron 已提交
826
            run_lints!(cx, check_foreign_item, early_passes, it);
827 828 829 830 831
            ast_visit::walk_foreign_item(cx, it);
        })
    }

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

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

    fn visit_stmt(&mut self, s: &ast::Stmt) {
N
Nick Cameron 已提交
842
        run_lints!(self, check_stmt, early_passes, s);
843 844 845 846 847
        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 已提交
848
        run_lints!(self, check_fn, early_passes, fk, decl, body, span, id);
849 850 851
        ast_visit::walk_fn(self, fk, decl, body, span);
    }

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

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

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

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

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

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

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

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

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

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

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

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

    fn visit_trait_item(&mut self, trait_item: &ast::TraitItem) {
N
Nick Cameron 已提交
922
        self.with_lint_attrs(&trait_item.attrs, |cx| {
N
Nick Cameron 已提交
923
            run_lints!(cx, check_trait_item, early_passes, trait_item);
924 925 926 927 928 929
            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 已提交
930
        self.with_lint_attrs(&impl_item.attrs, |cx| {
N
Nick Cameron 已提交
931
            run_lints!(cx, check_impl_item, early_passes, impl_item);
932 933 934 935 936
            cx.visit_ids(|v| v.visit_impl_item(impl_item));
            ast_visit::walk_impl_item(cx, impl_item);
        });
    }

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

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

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

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

V
Vadim Petrochenkov 已提交
955 956 957
    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);
958 959
    }

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

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

992
// This lint pass is defined here because it touches parts of the `LateContext`
993 994 995 996
// 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`.

997
pub struct GatherNodeLevels;
998 999 1000 1001 1002

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

N
Nick Cameron 已提交
1005
impl LateLintPass for GatherNodeLevels {
1006
    fn check_item(&mut self, cx: &LateContext, it: &hir::Item) {
1007
        match it.node {
M
Manish Goregaokar 已提交
1008
            hir::ItemEnum(..) => {
A
Aaron Turon 已提交
1009
                let lint_id = LintId::of(builtin::VARIANT_SIZE_DIFFERENCES);
1010 1011 1012
                let lvlsrc = cx.lints.get_level_source(lint_id);
                match lvlsrc {
                    (lvl, _) if lvl != Allow => {
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
                        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`.
1027
pub fn check_crate(tcx: &ty::ctxt, access_levels: &AccessLevels) {
1028
    let krate = tcx.map.krate();
1029
    let mut cx = LateContext::new(tcx, krate, access_levels);
1030 1031

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

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

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

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

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

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

    // Visit the whole crate.
N
Nick Cameron 已提交
1062
    cx.with_lint_attrs(&krate.attrs, |cx| {
1063 1064 1065 1066 1067 1068 1069 1070
        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 已提交
1071
        run_lints!(cx, check_crate, early_passes, krate);
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088

        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))
        }
    }
}