lint.rs 53.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
// Copyright 2012 The Rust Project Developers. See the COPYRIGHT
// 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.

11

12
use driver::session;
P
Patrick Walton 已提交
13
use middle::ty;
14
use middle::pat_util;
15
use metadata::csearch;
P
Patrick Walton 已提交
16
use util::ppaux::{ty_to_str};
17

18 19 20 21 22 23 24 25 26 27
use std::cmp;
use std::hashmap::HashMap;
use std::i16;
use std::i32;
use std::i64;
use std::i8;
use std::u16;
use std::u32;
use std::u64;
use std::u8;
28
use extra::smallintmap::SmallIntMap;
29
use syntax::ast_map;
30
use syntax::attr;
31
use syntax::attr::{AttrMetaMethods, AttributeMethods};
32
use syntax::codemap::Span;
J
John Clements 已提交
33
use syntax::codemap;
34
use syntax::parse::token;
35 36
use syntax::{ast, ast_util, visit};
use syntax::visit::Visitor;
37

38 39 40 41 42 43 44
/**
 * A 'lint' check is a kind of miscellaneous constraint that a user _might_
 * want to enforce, but might reasonably want to permit as well, on a
 * module-by-module basis. They contrast with static constraints enforced by
 * other phases of the compiler, which are generally required to hold in order
 * to compile the program at all.
 *
45 46 47 48 49
 * The lint checking is all 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
50
 * level at that location is.
51
 *
52 53 54 55 56 57
 * 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.
58
 *
59
 * At each node of the ast which can modify lint attributes, all known lint
60
 * passes are also applied.  Each lint pass is a visit::Visitor implementator.
61 62 63 64 65 66
 * The visitors are constructed via the lint_*() functions below. There are
 * also some lint checks which operate directly on ast nodes (such as
 * @ast::item), and those are organized as check_item_*(). Each visitor added
 * to the lint context is modified to stop once it reaches a node which could
 * alter the lint levels. This means that everything is looked at once and
 * only once by every lint pass.
67 68 69 70 71 72
 *
 * With this all in place, to add a new lint warning, all you need to do is to
 * either invoke `add_lint` on the session at the appropriate time, or write a
 * lint pass in this module which is just an ast visitor. The context used when
 * traversing the ast has a `span_lint` method which only needs the span of the
 * item that's being warned about.
73
 */
74

75
#[deriving(Clone, Eq)]
76
pub enum lint {
P
Patrick Walton 已提交
77
    ctypes,
78
    cstack,
79
    unused_imports,
80
    unnecessary_qualification,
81 82
    while_true,
    path_statement,
83
    unrecognized_lint,
84
    non_camel_case_types,
85
    non_uppercase_statics,
86
    non_uppercase_pattern_statics,
87
    type_limits,
88
    unused_unsafe,
89

90 91 92 93
    managed_heap_memory,
    owned_heap_memory,
    heap_memory,

94 95
    unused_variable,
    dead_assignment,
96
    unused_mut,
97
    unnecessary_allocation,
98

99
    missing_doc,
100
    unreachable_code,
101

102 103 104 105
    deprecated,
    experimental,
    unstable,

106
    warnings,
107 108
}

109
pub fn level_to_str(lv: level) -> &'static str {
110
    match lv {
111 112 113 114
      allow => "allow",
      warn => "warn",
      deny => "deny",
      forbid => "forbid"
115 116 117
    }
}

118
#[deriving(Clone, Eq, Ord)]
119
pub enum level {
120
    allow, warn, deny, forbid
121 122
}

123
#[deriving(Clone, Eq)]
124
pub struct LintSpec {
125
    lint: lint,
126
    desc: &'static str,
127
    default: level
128
}
129

130 131 132 133
impl Ord for LintSpec {
    fn lt(&self, other: &LintSpec) -> bool { self.default < other.default }
}

134
pub type LintDict = HashMap<&'static str, LintSpec>;
135 136 137 138

enum AttributedNode<'self> {
    Item(@ast::item),
    Method(&'self ast::method),
A
Alex Crichton 已提交
139
    Crate(&'self ast::Crate),
140
}
141

142 143
#[deriving(Eq)]
enum LintSource {
144
    Node(Span),
145 146 147 148
    Default,
    CommandLine
}

S
Sangeun Kim 已提交
149 150 151 152
static lint_table: &'static [(&'static str, LintSpec)] = &[
    ("ctypes",
     LintSpec {
        lint: ctypes,
153
        desc: "proper use of std::libc types in foreign modules",
S
Sangeun Kim 已提交
154 155 156
        default: warn
     }),

157 158 159 160 161 162 163
    ("cstack",
     LintSpec {
        lint: cstack,
        desc: "only invoke foreign functions from fixedstacksegment fns",
        default: deny
     }),

S
Sangeun Kim 已提交
164 165 166 167 168 169 170
    ("unused_imports",
     LintSpec {
        lint: unused_imports,
        desc: "imports that are never used",
        default: warn
     }),

171 172 173 174 175 176 177
    ("unnecessary_qualification",
     LintSpec {
        lint: unnecessary_qualification,
        desc: "detects unnecessarily qualified names",
        default: allow
     }),

S
Sangeun Kim 已提交
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
    ("while_true",
     LintSpec {
        lint: while_true,
        desc: "suggest using loop { } instead of while(true) { }",
        default: warn
     }),

    ("path_statement",
     LintSpec {
        lint: path_statement,
        desc: "path statements with no effect",
        default: warn
     }),

    ("unrecognized_lint",
     LintSpec {
        lint: unrecognized_lint,
        desc: "unrecognized lint attribute",
        default: warn
     }),

    ("non_camel_case_types",
     LintSpec {
        lint: non_camel_case_types,
        desc: "types, variants and traits should have camel case names",
        default: allow
     }),

206 207 208 209
    ("non_uppercase_statics",
     LintSpec {
         lint: non_uppercase_statics,
         desc: "static constants should have uppercase identifiers",
210
         default: allow
211 212
     }),

213 214 215 216 217 218 219
    ("non_uppercase_pattern_statics",
     LintSpec {
         lint: non_uppercase_pattern_statics,
         desc: "static constants in match patterns should be uppercased",
         default: warn
     }),

S
Sangeun Kim 已提交
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
    ("managed_heap_memory",
     LintSpec {
        lint: managed_heap_memory,
        desc: "use of managed (@ type) heap memory",
        default: allow
     }),

    ("owned_heap_memory",
     LintSpec {
        lint: owned_heap_memory,
        desc: "use of owned (~ type) heap memory",
        default: allow
     }),

    ("heap_memory",
     LintSpec {
        lint: heap_memory,
        desc: "use of any (~ type or @ type) heap memory",
        default: allow
     }),

    ("type_limits",
     LintSpec {
        lint: type_limits,
        desc: "comparisons made useless by limits of the types involved",
        default: warn
     }),

    ("unused_unsafe",
     LintSpec {
        lint: unused_unsafe,
        desc: "unnecessary use of an `unsafe` block",
        default: warn
    }),

    ("unused_variable",
     LintSpec {
        lint: unused_variable,
        desc: "detect variables which are not used in any way",
        default: warn
    }),

    ("dead_assignment",
     LintSpec {
        lint: dead_assignment,
        desc: "detect assignments that will never be read",
        default: warn
    }),

    ("unused_mut",
     LintSpec {
        lint: unused_mut,
        desc: "detect mut variables which don't need to be mutable",
        default: warn
    }),
275 276 277 278 279 280 281

    ("unnecessary_allocation",
     LintSpec {
        lint: unnecessary_allocation,
        desc: "detects unnecessary allocations that can be eliminated",
        default: warn
    }),
282

283
    ("missing_doc",
284
     LintSpec {
285 286
        lint: missing_doc,
        desc: "detects missing documentation for public members",
287 288
        default: allow
    }),
289 290 291 292 293 294 295

    ("unreachable_code",
     LintSpec {
        lint: unreachable_code,
        desc: "detects unreachable code",
        default: warn
    }),
296

297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
    ("deprecated",
     LintSpec {
        lint: deprecated,
        desc: "detects use of #[deprecated] items",
        default: warn
    }),

    ("experimental",
     LintSpec {
        lint: experimental,
        desc: "detects use of #[experimental] items",
        default: warn
    }),

    ("unstable",
     LintSpec {
        lint: unstable,
        desc: "detects use of #[unstable] items (incl. items with no stability attribute)",
        default: allow
    }),

318 319 320 321 322 323
    ("warnings",
     LintSpec {
        lint: warnings,
        desc: "mass-change the level for lints which produce warnings",
        default: warn
    }),
S
Sangeun Kim 已提交
324 325
];

326 327 328 329
/*
  Pass names should not contain a '-', as the compiler normalizes
  '-' to '_' in command-line flags
 */
330
pub fn get_lint_dict() -> LintDict {
331
    let mut map = HashMap::new();
D
Daniel Micay 已提交
332
    for &(k, v) in lint_table.iter() {
333
        map.insert(k, v);
334
    }
335
    return map;
336 337
}

338 339 340
trait OuterLint {
    fn process_item(@mut self, i:@ast::item, e:@mut Context);
    fn process_fn(@mut self, fk:&visit::fn_kind, fd:&ast::fn_decl,
341
                  b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context);
342 343 344 345 346 347 348 349 350 351 352 353 354 355

    // Returned inner variant will not proceed past subitems.
    // Supports decomposition of simple lints into subitem-traversing
    // outer lint visitor and subitem-stopping inner lint visitor.
    fn inner_variant(@mut self) -> @mut InnerLint;
}

trait InnerLint {
    fn descend_item(@mut self, i:&ast::item, e:@mut Context);
    fn descend_crate(@mut self, crate: &ast::Crate, env: @mut Context);
    fn descend_fn(@mut self,
                  function_kind: &visit::fn_kind,
                  function_declaration: &ast::fn_decl,
                  function_body: &ast::Block,
356
                  sp: Span,
357 358 359 360 361 362
                  id: ast::NodeId,
                  env: @mut Context);
}

impl<V:Visitor<@mut Context>> InnerLint for V {
    fn descend_item(@mut self, i:&ast::item, e:@mut Context) {
363 364
        visit::walk_item(self, i, e);
    }
365 366 367 368
    fn descend_crate(@mut self, crate: &ast::Crate, env: @mut Context) {
        visit::walk_crate(self, crate, env);
    }
    fn descend_fn(@mut self, fk: &visit::fn_kind, fd: &ast::fn_decl, fb: &ast::Block,
369
                  sp: Span, id: ast::NodeId, env: @mut Context) {
370 371 372 373
        visit::walk_fn(self, fk, fd, fb, sp, id, env);
    }
}

374 375 376 377 378 379 380 381
enum AnyVisitor {
    // This is a pair so every visitor can visit every node. When a lint pass
    // is registered, another visitor is created which stops at all items
    // which can alter the attributes of the ast. This "item stopping visitor"
    // is the second element of the pair, while the original visitor is the
    // first element. This means that when visiting a node, the original
    // recursive call can use the original visitor's method, although the
    // recursing visitor supplied to the method is the item stopping visitor.
382
    OldVisitor(@mut OuterLint, @mut InnerLint),
383
    NewVisitor(@mut visit::Visitor<()>),
384 385
}

386
struct Context {
387 388 389
    // All known lint modes (string versions)
    dict: @LintDict,
    // Current levels of each lint warning
390
    curr: SmallIntMap<(level, LintSource)>,
391 392
    // context we're checking in (used to access fields like sess)
    tcx: ty::ctxt,
393 394 395
    // Just a simple flag if we're currently recursing into a trait
    // implementation. This is only used by the lint_missing_doc() pass
    in_trait_impl: bool,
396 397 398 399
    // Another flag for doc lint emissions. Does some parent of the current node
    // have the doc(hidden) attribute? Treating this as allow(missing_doc) would
    // play badly with forbid(missing_doc) when it shouldn't.
    doc_hidden: bool,
400 401 402
    // 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.
403
    lint_stack: ~[(lint, level, LintSource)],
404 405 406 407 408
    // Each of these visitors represents a lint pass. A number of the lint
    // attributes are registered by adding a visitor to iterate over the ast.
    // Others operate directly on @ast::item structures (or similar). Finally,
    // others still are added to the Session object via `add_lint`, and these
    // are all passed with the lint_session visitor.
409
    visitors: ~[AnyVisitor],
410
}
411

412
impl Context {
413
    fn get_level(&self, lint: lint) -> level {
414
        match self.curr.find(&(lint as uint)) {
415
          Some(&(lvl, _)) => lvl,
416 417
          None => allow
        }
418 419
    }

420 421 422 423 424 425 426 427
    fn get_source(&self, lint: lint) -> LintSource {
        match self.curr.find(&(lint as uint)) {
          Some(&(_, src)) => src,
          None => Default
        }
    }

    fn set_level(&mut self, lint: lint, level: level, src: LintSource) {
428
        if level == allow {
D
Daniel Micay 已提交
429
            self.curr.remove(&(lint as uint));
430
        } else {
431 432 433 434
            self.curr.insert(lint as uint, (level, src));
        }
    }

435
    fn lint_to_str(&self, lint: lint) -> &'static str {
D
Daniel Micay 已提交
436
        for (k, v) in self.dict.iter() {
437
            if v.lint == lint {
438
                return *k;
439
            }
440
        }
441
        fail!("unregistered lint %?", lint);
442 443
    }

444
    fn span_lint(&self, lint: lint, span: Span, msg: &str) {
445
        let (level, src) = match self.curr.find(&(lint as uint)) {
446 447
            None => { return }
            Some(&(warn, src)) => (self.get_level(warnings), src),
448 449
            Some(&pair) => pair,
        };
450
        if level == allow { return }
451 452 453 454 455 456 457

        let mut note = None;
        let msg = match src {
            Default | CommandLine => {
                fmt!("%s [-%c %s%s]", msg, match level {
                        warn => 'W', deny => 'D', forbid => 'F',
                        allow => fail!()
458
                    }, self.lint_to_str(lint).replace("_", "-"),
459 460 461 462 463 464 465 466 467 468 469 470 471
                    if src == Default { " (default)" } else { "" })
            },
            Node(src) => {
                note = Some(src);
                msg.to_str()
            }
        };
        match level {
            warn =>          { self.tcx.sess.span_warn(span, msg); }
            deny | forbid => { self.tcx.sess.span_err(span, msg);  }
            allow => fail!(),
        }

D
Daniel Micay 已提交
472
        for &span in note.iter() {
473 474
            self.tcx.sess.span_note(span, "lint level defined here");
        }
475 476
    }

477
    /**
478
     * Merge the lints specified by any lint attributes into the
479
     * current lint context, call the provided function, then reset the
480
     * lints in effect to their previous state.
481
     */
482
    fn with_lint_attrs(@mut self, attrs: &[ast::Attribute], f: &fn()) {
483 484 485 486 487
        // 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
        let mut pushed = 0u;
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
        do each_lint(self.tcx.sess, attrs) |meta, level, lintname| {
            match self.dict.find_equiv(&lintname) {
                None => {
                    self.span_lint(
                        unrecognized_lint,
                        meta.span,
                        fmt!("unknown `%s` attribute: `%s`",
                        level_to_str(level), lintname));
                }
                Some(lint) => {
                    let lint = lint.lint;
                    let now = self.get_level(lint);
                    if now == forbid && level != forbid {
                        self.tcx.sess.span_err(meta.span,
                        fmt!("%s(%s) overruled by outer forbid(%s)",
                        level_to_str(level),
                        lintname, lintname));
                    } else if now != level {
                        let src = self.get_source(lint);
                        self.lint_stack.push((lint, now, src));
                        pushed += 1;
                        self.set_level(lint, level, Node(meta.span));
                    }
                }
512
            }
513 514
            true
        };
515

516
        // detect doc(hidden)
517 518 519 520 521
        let mut doc_hidden = do attrs.iter().any |attr| {
            "doc" == attr.name() &&
                match attr.meta_item_list() {
                    Some(l) => attr::contains_name(l, "hidden"),
                    None    => false // not of the form #[doc(...)]
522
                }
523 524
        };

525 526 527 528 529 530
        if doc_hidden && !self.doc_hidden {
            self.doc_hidden = true;
        } else {
            doc_hidden = false;
        }

531
        f();
532

533
        // rollback
534 535 536
        if doc_hidden && self.doc_hidden {
            self.doc_hidden = false;
        }
537
        do pushed.times {
538 539
            let (lint, lvl, src) = self.lint_stack.pop();
            self.set_level(lint, lvl, src);
540
        }
541 542
    }

543
    fn add_old_lint(&mut self, v: @mut OuterLint) {
544
        self.visitors.push(OldVisitor(v, v.inner_variant()));
545 546
    }

547
    fn add_lint(&mut self, v: @mut visit::Visitor<()>) {
548
        self.visitors.push(NewVisitor(v));
549 550
    }

551
    fn process(@mut self, n: AttributedNode) {
552 553
        // see comment of the `visitors` field in the struct for why there's a
        // pair instead of just one visitor.
554
        match n {
555
            Item(it) => {
D
Daniel Micay 已提交
556
                for visitor in self.visitors.iter() {
557 558
                    match *visitor {
                        OldVisitor(orig, stopping) => {
559 560
                            orig.process_item(it, self);
                            stopping.descend_item(it, self);
561 562
                        }
                        NewVisitor(new_visitor) => {
563
                            let new_visitor = new_visitor;
564 565 566
                            new_visitor.visit_item(it, ());
                        }
                    }
567 568 569
                }
            }
            Crate(c) => {
D
Daniel Micay 已提交
570
                for visitor in self.visitors.iter() {
571 572
                    match *visitor {
                        OldVisitor(_, stopping) => {
573
                            stopping.descend_crate(c, self)
574 575
                        }
                        NewVisitor(new_visitor) => {
576 577
                            let mut new_visitor = new_visitor;
                            visit::walk_crate(&mut new_visitor, c, ())
578 579
                        }
                    }
580 581
                }
            }
582
            // Can't use visit::walk_method_helper because the
583 584
            // item_stopping_visitor has overridden visit_fn(&fk_method(... ))
            // to be a no-op, so manually invoke visit_fn.
585
            Method(m) => {
D
Daniel Micay 已提交
586
                for visitor in self.visitors.iter() {
587 588
                    match *visitor {
                        OldVisitor(orig, stopping) => {
589 590 591
                            let fk = visit::fk_method(m.ident, &m.generics, m);
                            orig.process_fn(&fk, &m.decl, &m.body, m.span, m.id, self);
                            stopping.descend_fn(&fk, &m.decl, &m.body, m.span, m.id, self);
592 593 594 595 596
                        }
                        NewVisitor(new_visitor) => {
                            let fk = visit::fk_method(m.ident,
                                                      &m.generics,
                                                      m);
597
                            let new_visitor = new_visitor;
598 599 600 601 602 603 604 605
                            new_visitor.visit_fn(&fk,
                                                 &m.decl,
                                                 &m.body,
                                                 m.span,
                                                 m.id,
                                                 ())
                        }
                    }
606 607
                }
            }
608 609 610 611
        }
    }
}

612
pub fn each_lint(sess: session::Session,
613 614
                 attrs: &[ast::Attribute],
                 f: &fn(@ast::MetaItem, level, @str) -> bool) -> bool {
615
    let xs = [allow, warn, deny, forbid];
D
Daniel Micay 已提交
616
    for &level in xs.iter() {
617
        let level_name = level_to_str(level);
D
Daniel Micay 已提交
618
        for attr in attrs.iter().filter(|m| level_name == m.name()) {
619 620
            let meta = attr.node.value;
            let metas = match meta.node {
621
                ast::MetaList(_, ref metas) => metas,
622
                _ => {
623
                    sess.span_err(meta.span, "malformed lint attribute");
624 625 626
                    loop;
                }
            };
D
Daniel Micay 已提交
627
            for meta in metas.iter() {
628
                match meta.node {
629
                    ast::MetaWord(lintname) => {
630 631 632 633 634
                        if !f(*meta, level, lintname) {
                            return false;
                        }
                    }
                    _ => {
635
                        sess.span_err(meta.span, "malformed lint attribute");
636 637 638 639 640
                    }
                }
            }
        }
    }
641
    true
642 643
}

644 645 646 647 648 649 650 651
trait SubitemStoppableVisitor : Visitor<@mut Context> {
    fn is_running_on_items(&mut self) -> bool;

    fn visit_item_action(&mut self, _i:@ast::item, _e:@mut Context) {
        // fill in with particular action without recursion if desired
    }

    fn visit_fn_action(&mut self, _fk:&visit::fn_kind, _fd:&ast::fn_decl,
652
                       _b:&ast::Block, _s:Span, _n:ast::NodeId, _e:@mut Context) {
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
        // fill in with particular action without recursion if desired
    }

    // The two OVERRIDE methods:
    //
    //   OVERRIDE_visit_item
    //   OVERRIDE_visit_fn
    //
    // *must* be included as initial reimplementations of the standard
    // default behavior of visit_item and visit_fn for every impl of
    // Visitor, in order to recreate the effect of having two variant
    // Outer/Inner behaviors of lint visitors.  (See earlier versions
    // of this module to see what the original encoding was of this
    // emulated behavior.)

    fn OVERRIDE_visit_item(&mut self, i:@ast::item, e:@mut Context) {
        if self.is_running_on_items() {
            self.visit_item_action(i, e);
            visit::walk_item(self, i, e);
        }
    }

    fn OVERRIDE_visit_fn(&mut self, fk:&visit::fn_kind, fd:&ast::fn_decl,
676
                b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
677 678 679 680
        if self.is_running_on_items() {
            self.visit_fn_action(fk, fd, b, s, n, e);
            visit::walk_fn(self, fk, fd, b, s, n, e);
        } else {
681
            match *fk {
682 683 684 685 686
                visit::fk_method(*) => {}
                _ => {
                    self.visit_fn_action(fk, fd, b, s, n, e);
                    visit::walk_fn(self, fk, fd, b, s, n, e);
                }
687
            }
688 689 690 691 692 693 694 695 696
        }
    }
}

struct WhileTrueLintVisitor { stopping_on_items: bool }


impl SubitemStoppableVisitor for WhileTrueLintVisitor {
    fn is_running_on_items(&mut self) -> bool { !self.stopping_on_items }
697 698
}

699 700 701 702 703 704
impl Visitor<@mut Context> for WhileTrueLintVisitor {
    fn visit_item(&mut self, i:@ast::item, e:@mut Context) {
        self.OVERRIDE_visit_item(i, e);
    }

    fn visit_fn(&mut self, fk:&visit::fn_kind, fd:&ast::fn_decl,
705
                b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
706 707 708
        self.OVERRIDE_visit_fn(fk, fd, b, s, n, e);
    }

709
    fn visit_expr(&mut self, e:@ast::Expr, cx:@mut Context) {
710

711
            match e.node {
712
                ast::ExprWhile(cond, _) => {
713
                    match cond.node {
714
                        ast::ExprLit(@codemap::Spanned {
715 716 717 718 719
                            node: ast::lit_bool(true), _}) =>
                        {
                            cx.span_lint(while_true, e.span,
                                         "denote infinite loops with \
                                          loop { ... }");
720
                        }
721
                        _ => ()
722 723
                    }
                }
724 725
                _ => ()
            }
726 727 728 729 730
            visit::walk_expr(self, e, cx);
    }
}

macro_rules! outer_lint_boilerplate_impl(
731
    ($Visitor:ident) =>
732 733 734 735 736 737
    (
        impl OuterLint for $Visitor {
            fn process_item(@mut self, i:@ast::item, e:@mut Context) {
                self.visit_item_action(i, e);
            }
            fn process_fn(@mut self, fk:&visit::fn_kind, fd:&ast::fn_decl,
738
                          b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
739 740 741 742 743 744 745 746 747 748 749 750
                self.visit_fn_action(fk, fd, b, s, n, e);
            }
            fn inner_variant(@mut self) -> @mut InnerLint {
                @mut $Visitor { stopping_on_items: true } as @mut InnerLint
            }
        }
    ))

outer_lint_boilerplate_impl!(WhileTrueLintVisitor)

fn lint_while_true() -> @mut OuterLint {
    @mut WhileTrueLintVisitor{ stopping_on_items: false } as @mut OuterLint
V
Viktor Dahl 已提交
751 752
}

753 754 755 756 757 758 759
struct TypeLimitsLintVisitor { stopping_on_items: bool }

impl SubitemStoppableVisitor for TypeLimitsLintVisitor {
    fn is_running_on_items(&mut self) -> bool { !self.stopping_on_items }
}

impl TypeLimitsLintVisitor {
760
    fn is_valid<T:cmp::Ord>(&mut self, binop: ast::BinOp, v: T,
761 762
            min: T, max: T) -> bool {
        match binop {
763 764 765 766 767
            ast::BiLt => v <= max,
            ast::BiLe => v < max,
            ast::BiGt => v >= min,
            ast::BiGe => v > min,
            ast::BiEq | ast::BiNe => v >= min && v <= max,
768
            _ => fail!()
769 770 771
        }
    }

772
    fn rev_binop(&mut self, binop: ast::BinOp) -> ast::BinOp {
773
        match binop {
774 775 776 777
            ast::BiLt => ast::BiGt,
            ast::BiLe => ast::BiGe,
            ast::BiGt => ast::BiLt,
            ast::BiGe => ast::BiLe,
778 779 780 781
            _ => binop
        }
    }

782 783
    // for int & uint, be conservative with the warnings, so that the
    // warnings are consistent between 32- and 64-bit platforms
784
    fn int_ty_range(&mut self, int_ty: ast::int_ty) -> (i64, i64) {
785
        match int_ty {
786
            ast::ty_i =>    (i64::min_value,        i64::max_value),
787 788 789 790 791 792 793
            ast::ty_i8 =>   (i8::min_value  as i64, i8::max_value  as i64),
            ast::ty_i16 =>  (i16::min_value as i64, i16::max_value as i64),
            ast::ty_i32 =>  (i32::min_value as i64, i32::max_value as i64),
            ast::ty_i64 =>  (i64::min_value,        i64::max_value)
        }
    }

794
    fn uint_ty_range(&mut self, uint_ty: ast::uint_ty) -> (u64, u64) {
795
        match uint_ty {
796
            ast::ty_u =>   (u64::min_value,         u64::max_value),
797 798 799 800 801 802 803
            ast::ty_u8 =>  (u8::min_value   as u64, u8::max_value   as u64),
            ast::ty_u16 => (u16::min_value  as u64, u16::max_value  as u64),
            ast::ty_u32 => (u32::min_value  as u64, u32::max_value  as u64),
            ast::ty_u64 => (u64::min_value,         u64::max_value)
        }
    }

804 805
    fn check_limits(&mut self,
                    cx: &Context,
806 807 808
                    binop: ast::BinOp,
                    l: @ast::Expr,
                    r: @ast::Expr)
809
                    -> bool {
810
        let (lit, expr, swap) = match (&l.node, &r.node) {
811 812
            (&ast::ExprLit(_), _) => (l, r, true),
            (_, &ast::ExprLit(_)) => (r, l, false),
813 814 815 816
            _ => return true
        };
        // Normalize the binop so that the literal is always on the RHS in
        // the comparison
817
        let norm_binop = if swap {
818
            self.rev_binop(binop)
819 820 821
        } else {
            binop
        };
822
        match ty::get(ty::expr_ty(cx.tcx, expr)).sty {
823
            ty::ty_int(int_ty) => {
824
                let (min, max) = self.int_ty_range(int_ty);
825
                let lit_val: i64 = match lit.node {
826
                    ast::ExprLit(@li) => match li.node {
827 828 829 830 831
                        ast::lit_int(v, _) => v,
                        ast::lit_uint(v, _) => v as i64,
                        ast::lit_int_unsuffixed(v) => v,
                        _ => return true
                    },
832
                    _ => fail!()
833
                };
834
                self.is_valid(norm_binop, lit_val, min, max)
835 836
            }
            ty::ty_uint(uint_ty) => {
837
                let (min, max): (u64, u64) = self.uint_ty_range(uint_ty);
838
                let lit_val: u64 = match lit.node {
839
                    ast::ExprLit(@li) => match li.node {
840 841 842 843 844
                        ast::lit_int(v, _) => v as u64,
                        ast::lit_uint(v, _) => v,
                        ast::lit_int_unsuffixed(v) => v as u64,
                        _ => return true
                    },
845
                    _ => fail!()
846
                };
847
                self.is_valid(norm_binop, lit_val, min, max)
848 849 850 851 852
            }
            _ => true
        }
    }

853
    fn is_comparison(&mut self, binop: ast::BinOp) -> bool {
854
        match binop {
855 856
            ast::BiEq | ast::BiLt | ast::BiLe |
            ast::BiNe | ast::BiGe | ast::BiGt => true,
857 858 859
            _ => false
        }
    }
860 861 862 863 864 865 866 867
}

impl Visitor<@mut Context> for TypeLimitsLintVisitor {
    fn visit_item(&mut self, i:@ast::item, e:@mut Context) {
        self.OVERRIDE_visit_item(i, e);
    }

    fn visit_fn(&mut self, fk:&visit::fn_kind, fd:&ast::fn_decl,
868
                b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
869 870 871
        self.OVERRIDE_visit_fn(fk, fd, b, s, n, e);
    }

872
    fn visit_expr(&mut self, e:@ast::Expr, cx:@mut Context) {
873

874
            match e.node {
875
                ast::ExprBinary(_, ref binop, l, r) => {
876 877
                    if self.is_comparison(*binop)
                        && !self.check_limits(cx, *binop, l, r) {
878 879 880
                        cx.span_lint(type_limits, e.span,
                                     "comparison is useless due to type limits");
                    }
881
                }
882
                _ => ()
883
            }
884 885 886
            visit::walk_expr(self, e, cx);
    }
}
887

888 889 890 891
outer_lint_boilerplate_impl!(TypeLimitsLintVisitor)

fn lint_type_limits() -> @mut OuterLint {
    @mut TypeLimitsLintVisitor{ stopping_on_items: false } as @mut OuterLint
892 893
}

894 895
fn check_item_ctypes(cx: &Context, it: &ast::item) {
    fn check_ty(cx: &Context, ty: &ast::Ty) {
896 897 898
        match ty.node {
            ast::ty_path(_, _, id) => {
                match cx.tcx.def_map.get_copy(&id) {
899
                    ast::DefPrimTy(ast::ty_int(ast::ty_i)) => {
900 901 902 903
                        cx.span_lint(ctypes, ty.span,
                                "found rust type `int` in foreign module, while \
                                libc::c_int or libc::c_long should be used");
                    }
904
                    ast::DefPrimTy(ast::ty_uint(ast::ty_u)) => {
905 906 907 908 909 910 911
                        cx.span_lint(ctypes, ty.span,
                                "found rust type `uint` in foreign module, while \
                                libc::c_uint or libc::c_ulong should be used");
                    }
                    _ => ()
                }
            }
912
            ast::ty_ptr(ref mt) => { check_ty(cx, mt.ty) }
913 914 915
            _ => ()
        }
    }
916

917
    fn check_foreign_fn(cx: &Context, decl: &ast::fn_decl) {
D
Daniel Micay 已提交
918
        for input in decl.inputs.iter() {
919
            check_ty(cx, &input.ty);
920
        }
J
James Miller 已提交
921
        check_ty(cx, &decl.output)
922 923
    }

924
    match it.node {
925
      ast::item_foreign_mod(ref nmod) if !nmod.abis.is_intrinsic() => {
D
Daniel Micay 已提交
926
        for ni in nmod.items.iter() {
927
            match ni.node {
928
                ast::foreign_item_fn(ref decl, _) => {
929 930
                    check_foreign_fn(cx, decl);
                }
J
James Miller 已提交
931
                ast::foreign_item_static(ref t, _) => { check_ty(cx, t); }
932 933
            }
        }
934
      }
B
Brian Anderson 已提交
935
      _ => {/* nothing to do */ }
936 937
    }
}
938

939
fn check_type_for_lint(cx: &Context, lint: lint, span: Span, ty: ty::t) {
940
    if cx.get_level(lint) == allow { return }
941

942 943 944 945 946 947 948 949 950 951
    let mut n_box = 0;
    let mut n_uniq = 0;
    ty::fold_ty(cx.tcx, ty, |t| {
        match ty::get(t).sty {
          ty::ty_box(_) => n_box += 1,
          ty::ty_uniq(_) => n_uniq += 1,
          _ => ()
        };
        t
    });
952

953 954 955 956 957
    if n_uniq > 0 && lint != managed_heap_memory {
        let s = ty_to_str(cx.tcx, ty);
        let m = ~"type uses owned (~ type) pointers: " + s;
        cx.span_lint(lint, span, m);
    }
958

959 960 961 962
    if n_box > 0 && lint != owned_heap_memory {
        let s = ty_to_str(cx.tcx, ty);
        let m = ~"type uses managed (@ type) pointers: " + s;
        cx.span_lint(lint, span, m);
963
    }
964
}
965

966
fn check_type(cx: &Context, span: Span, ty: ty::t) {
967
    let xs = [managed_heap_memory, owned_heap_memory, heap_memory];
D
Daniel Micay 已提交
968
    for lint in xs.iter() {
969
        check_type_for_lint(cx, *lint, span, ty);
970
    }
971
}
972

973
fn check_item_heap(cx: &Context, it: &ast::item) {
974 975 976 977 978 979 980 981 982
    match it.node {
      ast::item_fn(*) |
      ast::item_ty(*) |
      ast::item_enum(*) |
      ast::item_struct(*) => check_type(cx, it.span,
                                        ty::node_id_to_type(cx.tcx,
                                                            it.id)),
      _ => ()
    }
983

984 985 986
    // If it's a struct, we also have to check the fields' types
    match it.node {
        ast::item_struct(struct_def, _) => {
D
Daniel Micay 已提交
987
            for struct_field in struct_def.fields.iter() {
988 989 990
                check_type(cx, struct_field.span,
                           ty::node_id_to_type(cx.tcx,
                                               struct_field.node.id));
991 992 993 994
            }
        }
        _ => ()
    }
995
}
996

997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
struct HeapLintVisitor { stopping_on_items: bool }

impl SubitemStoppableVisitor for HeapLintVisitor {
    fn is_running_on_items(&mut self) -> bool { !self.stopping_on_items }
}

impl Visitor<@mut Context> for HeapLintVisitor {
    fn visit_item(&mut self, i:@ast::item, e:@mut Context) {
        self.OVERRIDE_visit_item(i, e);
    }

    fn visit_fn(&mut self, fk:&visit::fn_kind, fd:&ast::fn_decl,
1009
                b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
1010 1011 1012
        self.OVERRIDE_visit_fn(fk, fd, b, s, n, e);
    }

1013
    fn visit_expr(&mut self, e:@ast::Expr, cx:@mut Context) {
1014 1015
            let ty = ty::expr_ty(cx.tcx, e);
            check_type(cx, e.span, ty);
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
            visit::walk_expr(self, e, cx);
    }
}

outer_lint_boilerplate_impl!(HeapLintVisitor)

fn lint_heap() -> @mut OuterLint {
    @mut HeapLintVisitor { stopping_on_items: false } as @mut OuterLint
}

struct PathStatementLintVisitor {
    stopping_on_items: bool
}

impl SubitemStoppableVisitor for PathStatementLintVisitor {
    fn is_running_on_items(&mut self) -> bool { !self.stopping_on_items }
1032 1033
}

1034 1035 1036 1037 1038 1039
impl Visitor<@mut Context> for PathStatementLintVisitor {
    fn visit_item(&mut self, i:@ast::item, e:@mut Context) {
        self.OVERRIDE_visit_item(i, e);
    }

    fn visit_fn(&mut self, fk:&visit::fn_kind, fd:&ast::fn_decl,
1040
                b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
1041 1042 1043
        self.OVERRIDE_visit_fn(fk, fd, b, s, n, e);
    }

1044
    fn visit_stmt(&mut self, s:@ast::Stmt, cx:@mut Context) {
1045
            match s.node {
1046 1047
                ast::StmtSemi(
                    @ast::Expr { node: ast::ExprPath(_), _ },
1048 1049 1050 1051
                    _
                ) => {
                    cx.span_lint(path_statement, s.span,
                                 "path statement with no effect");
1052
                }
1053 1054
                _ => ()
            }
1055 1056 1057 1058 1059 1060 1061 1062 1063
            visit::walk_stmt(self, s, cx);

    }
}

outer_lint_boilerplate_impl!(PathStatementLintVisitor)

fn lint_path_statement() -> @mut OuterLint {
    @mut PathStatementLintVisitor{ stopping_on_items: false } as @mut OuterLint
1064 1065
}

1066
fn check_item_non_camel_case_types(cx: &Context, it: &ast::item) {
1067
    fn is_camel_case(cx: ty::ctxt, ident: ast::Ident) -> bool {
P
Paul Stansifer 已提交
1068
        let ident = cx.sess.str_of(ident);
P
Patrick Walton 已提交
1069
        assert!(!ident.is_empty());
1070
        let ident = ident.trim_chars(&'_');
1071 1072 1073 1074

        // start with a non-lowercase letter rather than non-uppercase
        // ones (some scripts don't have a concept of upper/lowercase)
        !ident.char_at(0).is_lowercase() &&
1075 1076 1077
            !ident.contains_char('_')
    }

1078
    fn check_case(cx: &Context, sort: &str, ident: ast::Ident, span: Span) {
1079
        if !is_camel_case(cx.tcx, ident) {
1080 1081 1082 1083
            cx.span_lint(
                non_camel_case_types, span,
                fmt!("%s `%s` should have a camel case identifier",
                    sort, cx.tcx.sess.str_of(ident)));
1084 1085 1086
        }
    }

1087
    match it.node {
1088 1089 1090
        ast::item_ty(*) | ast::item_struct(*) => {
            check_case(cx, "type", it.ident, it.span)
        }
E
Erick Tryzelaar 已提交
1091
        ast::item_trait(*) => {
1092
            check_case(cx, "trait", it.ident, it.span)
1093
        }
E
Erick Tryzelaar 已提交
1094
        ast::item_enum(ref enum_definition, _) => {
1095
            check_case(cx, "type", it.ident, it.span);
D
Daniel Micay 已提交
1096
            for variant in enum_definition.variants.iter() {
1097
                check_case(cx, "variant", variant.node.name, variant.span);
E
Erick Tryzelaar 已提交
1098 1099 1100
            }
        }
        _ => ()
1101 1102 1103
    }
}

1104 1105 1106
fn check_item_non_uppercase_statics(cx: &Context, it: &ast::item) {
    match it.node {
        // only check static constants
1107
        ast::item_static(_, ast::MutImmutable, _) => {
1108 1109 1110 1111
            let s = cx.tcx.sess.str_of(it.ident);
            // check for lowercase letters rather than non-uppercase
            // ones (some scripts don't have a concept of
            // upper/lowercase)
1112
            if s.iter().any(|c| c.is_lowercase()) {
1113 1114 1115 1116 1117 1118 1119 1120
                cx.span_lint(non_uppercase_statics, it.span,
                             "static constant should have an uppercase identifier");
            }
        }
        _ => {}
    }
}

1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
struct UnusedUnsafeLintVisitor { stopping_on_items: bool }

impl SubitemStoppableVisitor for UnusedUnsafeLintVisitor {
    fn is_running_on_items(&mut self) -> bool { !self.stopping_on_items }
}

impl Visitor<@mut Context> for UnusedUnsafeLintVisitor {
    fn visit_item(&mut self, i:@ast::item, e:@mut Context) {
        self.OVERRIDE_visit_item(i, e);
    }

    fn visit_fn(&mut self, fk:&visit::fn_kind, fd:&ast::fn_decl,
1133
                b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
1134 1135 1136
        self.OVERRIDE_visit_fn(fk, fd, b, s, n, e);
    }

1137
    fn visit_expr(&mut self, e:@ast::Expr, cx:@mut Context) {
1138

1139
            match e.node {
1140 1141
                // Don't warn about generated blocks, that'll just pollute the
                // output.
1142 1143 1144
                ast::ExprBlock(ref blk) => {
                    if blk.rules == ast::UnsafeBlock(ast::UserProvided) &&
                       !cx.tcx.used_unsafe.contains(&blk.id) {
1145 1146 1147
                        cx.span_lint(unused_unsafe, blk.span,
                                     "unnecessary `unsafe` block");
                    }
1148
                }
1149
                _ => ()
1150
            }
1151 1152 1153 1154 1155 1156 1157 1158
            visit::walk_expr(self, e, cx);
    }
}

outer_lint_boilerplate_impl!(UnusedUnsafeLintVisitor)

fn lint_unused_unsafe() -> @mut OuterLint {
    @mut UnusedUnsafeLintVisitor{ stopping_on_items: false } as @mut OuterLint
1159 1160
}

1161 1162 1163
struct UnusedMutLintVisitor { stopping_on_items: bool }

impl UnusedMutLintVisitor {
1164
    fn check_pat(&mut self, cx: &Context, p: @ast::Pat) {
1165 1166
        let mut used = false;
        let mut bindings = 0;
1167 1168
        do pat_util::pat_bindings(cx.tcx.def_map, p) |_, id, _, _| {
            used = used || cx.tcx.used_mut_nodes.contains(&id);
1169 1170 1171 1172
            bindings += 1;
        }
        if !used {
            let msg = if bindings == 1 {
S
Seo Sanghyeon 已提交
1173
                "variable does not need to be mutable"
1174
            } else {
S
Seo Sanghyeon 已提交
1175
                "variables do not need to be mutable"
1176
            };
1177
            cx.span_lint(unused_mut, p.span, msg);
1178
        }
1179
    }
1180

1181
    fn visit_fn_decl(&mut self, cx: &Context, fd: &ast::fn_decl) {
D
Daniel Micay 已提交
1182
        for arg in fd.inputs.iter() {
1183
            if arg.is_mutbl {
1184
                self.check_pat(cx, arg.pat);
1185 1186
            }
        }
1187
    }
1188 1189 1190 1191 1192 1193
}

impl SubitemStoppableVisitor for UnusedMutLintVisitor {
    fn is_running_on_items(&mut self) -> bool { !self.stopping_on_items }

    fn visit_fn_action(&mut self, _a:&visit::fn_kind, fd:&ast::fn_decl,
1194
                       _b:&ast::Block, _c:Span, _d:ast::NodeId, cx:@mut Context) {
1195 1196 1197
            self.visit_fn_decl(cx, fd);
    }
}
1198

1199 1200 1201 1202 1203 1204
impl Visitor<@mut Context> for UnusedMutLintVisitor {
    fn visit_item(&mut self, i:@ast::item, e:@mut Context) {
        self.OVERRIDE_visit_item(i, e);
    }

    fn visit_fn(&mut self, fk:&visit::fn_kind, fd:&ast::fn_decl,
1205
                b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
1206 1207 1208 1209 1210
        self.OVERRIDE_visit_fn(fk, fd, b, s, n, e);
    }


    fn visit_local(&mut self, l:@ast::Local, cx:@mut Context) {
1211
            if l.is_mutbl {
1212
                self.check_pat(cx, l.pat);
1213
            }
1214 1215 1216 1217 1218 1219 1220 1221 1222
            visit::walk_local(self, l, cx);
    }

    fn visit_ty_method(&mut self, tm:&ast::TypeMethod, cx:@mut Context) {
            self.visit_fn_decl(cx, &tm.decl);
            visit::walk_ty_method(self, tm, cx);
    }

    fn visit_trait_method(&mut self, tm:&ast::trait_method, cx:@mut Context) {
1223
            match *tm {
1224 1225
                ast::required(ref tm) => self.visit_fn_decl(cx, &tm.decl),
                ast::provided(m) => self.visit_fn_decl(cx, &m.decl)
1226
            }
1227 1228 1229 1230 1231 1232 1233 1234
            visit::walk_trait_method(self, tm, cx);
    }
}

outer_lint_boilerplate_impl!(UnusedMutLintVisitor)

fn lint_unused_mut() -> @mut OuterLint {
    @mut UnusedMutLintVisitor{ stopping_on_items: false } as @mut OuterLint
1235 1236
}

1237 1238 1239 1240 1241 1242 1243 1244
struct LintReportingIdVisitor {
    cx: @mut Context,
}

impl ast_util::IdVisitingOperation for LintReportingIdVisitor {
    fn visit_id(&self, id: ast::NodeId) {
        match self.cx.tcx.sess.lints.pop(&id) {
            None => {}
1245
            Some(l) => {
1246
                for (lint, span, msg) in l.move_iter() {
1247
                    self.cx.span_lint(lint, span, msg)
1248
                }
1249 1250
            }
        }
1251 1252 1253 1254 1255 1256 1257
    }
}

fn lint_session(cx: @mut Context) -> @mut visit::Visitor<()> {
    ast_util::id_visitor(@LintReportingIdVisitor {
        cx: cx,
    } as @ast_util::IdVisitingOperation, false)
1258 1259
}

1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
struct UnnecessaryAllocationLintVisitor { stopping_on_items: bool }

impl SubitemStoppableVisitor for UnnecessaryAllocationLintVisitor {
    fn is_running_on_items(&mut self) -> bool { !self.stopping_on_items }
}

impl Visitor<@mut Context> for UnnecessaryAllocationLintVisitor {
    fn visit_item(&mut self, i:@ast::item, e:@mut Context) {
        self.OVERRIDE_visit_item(i, e);
    }

    fn visit_fn(&mut self, fk:&visit::fn_kind, fd:&ast::fn_decl,
1272
                b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
1273 1274 1275
        self.OVERRIDE_visit_fn(fk, fd, b, s, n, e);
    }

1276
    fn visit_expr(&mut self, e:@ast::Expr, cx:@mut Context) {
1277 1278 1279 1280 1281 1282
            self.check(cx, e);
            visit::walk_expr(self, e, cx);
    }
}

impl UnnecessaryAllocationLintVisitor {
1283 1284
    // Warn if string and vector literals with sigils are immediately borrowed.
    // Those can have the sigil removed.
1285
    fn check(&mut self, cx: &Context, e: &ast::Expr) {
1286
        match e.node {
1287 1288
            ast::ExprVstore(e2, ast::ExprVstoreUniq) |
            ast::ExprVstore(e2, ast::ExprVstoreBox) => {
1289
                match e2.node {
1290
                    ast::ExprLit(@codemap::Spanned{
1291
                            node: ast::lit_str(*), _}) |
1292
                    ast::ExprVec(*) => {}
1293 1294 1295 1296 1297 1298 1299
                    _ => return
                }
            }

            _ => return
        }

1300 1301 1302
        match cx.tcx.adjustments.find_copy(&e.id) {
            Some(@ty::AutoDerefRef(ty::AutoDerefRef {
                autoref: Some(ty::AutoBorrowVec(*)), _ })) => {
1303 1304 1305 1306 1307 1308 1309 1310
                cx.span_lint(unnecessary_allocation,
                             e.span, "unnecessary allocation, the sigil can be \
                                      removed");
            }

            _ => ()
        }
    }
1311
}
1312

1313 1314 1315 1316
outer_lint_boilerplate_impl!(UnnecessaryAllocationLintVisitor)

fn lint_unnecessary_allocations() -> @mut OuterLint {
    @mut UnnecessaryAllocationLintVisitor{ stopping_on_items: false } as @mut OuterLint
1317 1318
}

1319 1320 1321 1322 1323
struct MissingDocLintVisitor { stopping_on_items: bool }

impl MissingDocLintVisitor {
    fn check_attrs(&mut self,
                   cx: @mut Context,
1324
                   attrs: &[ast::Attribute],
1325
                   sp: Span,
1326
                   msg: &str) {
1327 1328 1329 1330 1331 1332
        // If we're building a test harness, then warning about documentation is
        // probably not really relevant right now
        if cx.tcx.sess.opts.test { return }
        // If we have doc(hidden), nothing to do
        if cx.doc_hidden { return }
        // If we're documented, nothing to do
1333
        if attrs.iter().any(|a| a.node.is_sugared_doc) { return }
1334 1335 1336

        // otherwise, warn!
        cx.span_lint(missing_doc, sp, msg);
1337
    }
1338 1339 1340 1341 1342 1343
}

impl Visitor<@mut Context> for MissingDocLintVisitor {
    fn visit_item(&mut self, i:@ast::item, e:@mut Context) {
        self.OVERRIDE_visit_item(i, e);
    }
1344

1345
    fn visit_fn(&mut self, fk:&visit::fn_kind, fd:&ast::fn_decl,
1346
                b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
1347 1348 1349 1350
        self.OVERRIDE_visit_fn(fk, fd, b, s, n, e);
    }

    fn visit_ty_method(&mut self, m:&ast::TypeMethod, cx:@mut Context) {
1351 1352
            // All ty_method objects are linted about because they're part of a
            // trait (no visibility)
1353
            self.check_attrs(cx, m.attrs, m.span,
1354
                        "missing documentation for a method");
1355 1356 1357 1358 1359 1360 1361 1362
            visit::walk_ty_method(self, m, cx);
    }
}

impl SubitemStoppableVisitor for MissingDocLintVisitor {
    fn is_running_on_items(&mut self) -> bool { !self.stopping_on_items }

    fn visit_fn_action(&mut self, fk:&visit::fn_kind, _d:&ast::fn_decl,
1363
                       _b:&ast::Block, sp:Span, _id:ast::NodeId, cx:@mut Context) {
1364

1365 1366 1367
            // Only warn about explicitly public methods. Soon implicit
            // public-ness will hopefully be going away.
            match *fk {
1368
                visit::fk_method(_, _, m) if m.vis == ast::public => {
1369 1370 1371
                    // If we're in a trait implementation, no need to duplicate
                    // documentation
                    if !cx.in_trait_impl {
1372
                        self.check_attrs(cx, m.attrs, sp,
1373
                                    "missing documentation for a method");
1374 1375
                    }
                }
1376

1377 1378
                _ => {}
            }
1379 1380 1381
    }

    fn visit_item_action(&mut self, it:@ast::item, cx:@mut Context) {
1382

1383 1384 1385 1386 1387
            match it.node {
                // Go ahead and match the fields here instead of using
                // visit_struct_field while we have access to the enclosing
                // struct's visibility
                ast::item_struct(sdef, _) if it.vis == ast::public => {
1388
                    self.check_attrs(cx, it.attrs, it.span,
1389
                                "missing documentation for a struct");
D
Daniel Micay 已提交
1390
                    for field in sdef.fields.iter() {
1391 1392
                        match field.node.kind {
                            ast::named_field(_, vis) if vis != ast::private => {
1393
                                self.check_attrs(cx, field.node.attrs, field.span,
1394
                                            "missing documentation for a field");
1395
                            }
1396
                            ast::unnamed_field | ast::named_field(*) => {}
1397 1398 1399
                        }
                    }
                }
1400 1401

                ast::item_trait(*) if it.vis == ast::public => {
1402
                    self.check_attrs(cx, it.attrs, it.span,
1403 1404 1405 1406
                                "missing documentation for a trait");
                }

                ast::item_fn(*) if it.vis == ast::public => {
1407
                    self.check_attrs(cx, it.attrs, it.span,
1408 1409 1410 1411
                                "missing documentation for a function");
                }

                _ => {}
1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
            }
    }
}

outer_lint_boilerplate_impl!(MissingDocLintVisitor)

fn lint_missing_doc() -> @mut OuterLint {
    @mut MissingDocLintVisitor { stopping_on_items: false } as @mut OuterLint
}

1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522
/// Checks for use of items with #[deprecated], #[experimental] and
/// #[unstable] (or none of them) attributes.
struct StabilityLintVisitor { stopping_on_items: bool }

impl StabilityLintVisitor {
    fn handle_def(&mut self, sp: Span, def: &ast::Def, cx: @mut Context) {
        let id = ast_util::def_id_of_def(*def);

        let stability = if ast_util::is_local(id) {
            // this crate
            match cx.tcx.items.find(&id.node) {
                Some(ast_node) => {
                    let s = do ast_node.with_attrs |attrs| {
                        do attrs.map_move |a| {
                            attr::find_stability(a.iter().map(|a| a.meta()))
                        }
                    };
                    match s {
                        Some(s) => s,

                        // no possibility of having attributes
                        // (e.g. it's a local variable), so just
                        // ignore it.
                        None => return
                    }
                }
                _ => cx.tcx.sess.bug(fmt!("handle_def: %? not found", id))
            }
        } else {
            // cross-crate

            let mut s = None;
            // run through all the attributes and take the first
            // stability one.
            do csearch::get_item_attrs(cx.tcx.cstore, id) |meta_items| {
                if s.is_none() {
                    s = attr::find_stability(meta_items.move_iter())
                }
            }
            s
        };

        let (lint, label) = match stability {
            // no stability attributes == Unstable
            None => (unstable, "unmarked"),
            Some(attr::Stability { level: attr::Unstable, _ }) => (unstable, "unstable"),
            Some(attr::Stability { level: attr::Experimental, _ }) => {
                (experimental, "experimental")
            }
            Some(attr::Stability { level: attr::Deprecated, _ }) => (deprecated, "deprecated"),
            _ => return
        };

        let msg = match stability {
            Some(attr::Stability { text: Some(ref s), _ }) => {
                fmt!("use of %s item: %s", label, *s)
            }
            _ => fmt!("use of %s item", label)
        };

        cx.span_lint(lint, sp, msg);
    }
}

impl SubitemStoppableVisitor for StabilityLintVisitor {
    fn is_running_on_items(&mut self) -> bool { !self.stopping_on_items }
}

impl Visitor<@mut Context> for StabilityLintVisitor {
    fn visit_item(&mut self, i:@ast::item, e:@mut Context) {
        self.OVERRIDE_visit_item(i, e);
    }

    fn visit_fn(&mut self, fk:&visit::fn_kind, fd:&ast::fn_decl,
                b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
        self.OVERRIDE_visit_fn(fk, fd, b, s, n, e);
    }

    fn visit_expr(&mut self, ex: @ast::Expr, cx: @mut Context) {
        match ex.node {
            ast::ExprMethodCall(*) |
            ast::ExprPath(*) |
            ast::ExprStruct(*) => {
                match cx.tcx.def_map.find(&ex.id) {
                    Some(def) => self.handle_def(ex.span, def, cx),
                    None => {}
                }
            }
            _ => {}
        }

        visit::walk_expr(self, ex, cx)
    }
}

outer_lint_boilerplate_impl!(StabilityLintVisitor)

fn lint_stability() -> @mut OuterLint {
    @mut StabilityLintVisitor { stopping_on_items: false } as @mut OuterLint
}

1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545
struct LintCheckVisitor;

impl Visitor<@mut Context> for LintCheckVisitor {

    fn visit_item(&mut self, it:@ast::item, cx: @mut Context) {

                do cx.with_lint_attrs(it.attrs) {
                    match it.node {
                        ast::item_impl(_, Some(*), _, _) => {
                            cx.in_trait_impl = true;
                        }
                        _ => {}
                    }
                    check_item_ctypes(cx, it);
                    check_item_non_camel_case_types(cx, it);
                    check_item_non_uppercase_statics(cx, it);
                    check_item_heap(cx, it);

                    cx.process(Item(it));
                    visit::walk_item(self, it, cx);
                    cx.in_trait_impl = false;
                }
    }
1546

1547
    fn visit_fn(&mut self, fk:&visit::fn_kind, decl:&ast::fn_decl,
1548
                body:&ast::Block, span:Span, id:ast::NodeId, cx:@mut Context) {
1549

1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573
                match *fk {
                    visit::fk_method(_, _, m) => {
                        do cx.with_lint_attrs(m.attrs) {
                            cx.process(Method(m));
                            visit::walk_fn(self,
                                               fk,
                                               decl,
                                               body,
                                               span,
                                               id,
                                               cx);
                        }
                    }
                    _ => {
                        visit::walk_fn(self,
                                           fk,
                                           decl,
                                           body,
                                           span,
                                           id,
                                           cx);
                    }
                }
    }
1574 1575
}

A
Alex Crichton 已提交
1576
pub fn check_crate(tcx: ty::ctxt, crate: &ast::Crate) {
1577 1578 1579 1580 1581
    let cx = @mut Context {
        dict: @get_lint_dict(),
        curr: SmallIntMap::new(),
        tcx: tcx,
        lint_stack: ~[],
1582
        visitors: ~[],
1583
        in_trait_impl: false,
1584
        doc_hidden: false,
1585 1586 1587
    };

    // Install defaults.
D
Daniel Micay 已提交
1588
    for (_, spec) in cx.dict.iter() {
1589
        cx.set_level(spec.lint, spec.default, Default);
1590 1591 1592
    }

    // Install command-line options, overriding defaults.
D
Daniel Micay 已提交
1593
    for &(lint, level) in tcx.sess.opts.lint_opts.iter() {
1594
        cx.set_level(lint, level, CommandLine);
1595 1596
    }

1597
    // Register each of the lint passes with the context
1598 1599 1600 1601 1602 1603 1604 1605
    cx.add_old_lint(lint_while_true());
    cx.add_old_lint(lint_path_statement());
    cx.add_old_lint(lint_heap());
    cx.add_old_lint(lint_type_limits());
    cx.add_old_lint(lint_unused_unsafe());
    cx.add_old_lint(lint_unused_mut());
    cx.add_old_lint(lint_unnecessary_allocations());
    cx.add_old_lint(lint_missing_doc());
1606
    cx.add_old_lint(lint_stability());
1607
    cx.add_lint(lint_session(cx));
1608

1609
    // Actually perform the lint checks (iterating the ast)
1610
    do cx.with_lint_attrs(crate.attrs) {
1611
        cx.process(Crate(crate));
1612

1613
        let mut visitor = LintCheckVisitor;
1614

1615
        visit::walk_crate(&mut visitor, crate, cx);
1616 1617
    }

1618 1619
    // If we missed any lints added to the session, then there's a bug somewhere
    // in the iteration code.
D
Daniel Micay 已提交
1620 1621
    for (id, v) in tcx.sess.lints.iter() {
        for t in v.iter() {
1622 1623
            match *t {
                (lint, span, ref msg) =>
1624 1625 1626 1627 1628 1629 1630 1631
                    tcx.sess.span_bug(span, fmt!("unprocessed lint %? at %s: \
                                                  %s",
                                                 lint,
                                                 ast_map::node_id_to_str(
                                                 tcx.items,
                                                 *id,
                                                 token::get_ident_interner()),
                                                 *msg))
1632 1633 1634
            }
        }
    }
1635

1636
    tcx.sess.abort_if_errors();
1637
}