lint.rs 52.9 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
    type_limits,
87
    unused_unsafe,
88

89 90 91 92
    managed_heap_memory,
    owned_heap_memory,
    heap_memory,

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

98
    missing_doc,
99
    unreachable_code,
100

101 102 103 104
    deprecated,
    experimental,
    unstable,

105
    warnings,
106 107
}

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

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

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

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

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

enum AttributedNode<'self> {
    Item(@ast::item),
    Method(&'self ast::method),
138
    Crate(@ast::Crate),
139
}
140

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

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

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

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

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

S
Sangeun Kim 已提交
177 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
    ("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
     }),

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

S
Sangeun Kim 已提交
212 213 214 215 216 217 218 219 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
    ("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
    }),
267 268 269 270 271 272 273

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

275
    ("missing_doc",
276
     LintSpec {
277 278
        lint: missing_doc,
        desc: "detects missing documentation for public members",
279 280
        default: allow
    }),
281 282 283 284 285 286 287

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

289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
    ("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
    }),

310 311 312 313 314 315
    ("warnings",
     LintSpec {
        lint: warnings,
        desc: "mass-change the level for lints which produce warnings",
        default: warn
    }),
S
Sangeun Kim 已提交
316 317
];

318 319 320 321
/*
  Pass names should not contain a '-', as the compiler normalizes
  '-' to '_' in command-line flags
 */
322
pub fn get_lint_dict() -> LintDict {
323
    let mut map = HashMap::new();
D
Daniel Micay 已提交
324
    for &(k, v) in lint_table.iter() {
325
        map.insert(k, v);
326
    }
327
    return map;
328 329
}

330 331 332
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,
333
                  b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context);
334 335 336 337 338 339 340 341 342 343 344 345 346 347

    // 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,
348
                  sp: Span,
349 350 351 352 353 354
                  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) {
355 356
        visit::walk_item(self, i, e);
    }
357 358 359 360
    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,
361
                  sp: Span, id: ast::NodeId, env: @mut Context) {
362 363 364 365
        visit::walk_fn(self, fk, fd, fb, sp, id, env);
    }
}

366 367 368 369 370 371 372 373
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.
374
    OldVisitor(@mut OuterLint, @mut InnerLint),
375
    NewVisitor(@mut visit::Visitor<()>),
376 377
}

378 379
type VCObj = @mut Visitor<@mut Context>;

380
struct Context {
381 382 383
    // All known lint modes (string versions)
    dict: @LintDict,
    // Current levels of each lint warning
384
    curr: SmallIntMap<(level, LintSource)>,
385 386
    // context we're checking in (used to access fields like sess)
    tcx: ty::ctxt,
387 388 389
    // 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,
390 391 392 393
    // 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,
394 395 396
    // 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.
397
    lint_stack: ~[(lint, level, LintSource)],
398 399 400 401 402
    // 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.
403
    visitors: ~[AnyVisitor],
404
}
405

406
impl Context {
407
    fn get_level(&self, lint: lint) -> level {
408
        match self.curr.find(&(lint as uint)) {
409
          Some(&(lvl, _)) => lvl,
410 411
          None => allow
        }
412 413
    }

414 415 416 417 418 419 420 421
    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) {
422
        if level == allow {
D
Daniel Micay 已提交
423
            self.curr.remove(&(lint as uint));
424
        } else {
425 426 427 428
            self.curr.insert(lint as uint, (level, src));
        }
    }

429
    fn lint_to_str(&self, lint: lint) -> &'static str {
D
Daniel Micay 已提交
430
        for (k, v) in self.dict.iter() {
431
            if v.lint == lint {
432
                return *k;
433
            }
434
        }
435
        fail!("unregistered lint %?", lint);
436 437
    }

438
    fn span_lint(&self, lint: lint, span: Span, msg: &str) {
439
        let (level, src) = match self.curr.find(&(lint as uint)) {
440 441
            None => { return }
            Some(&(warn, src)) => (self.get_level(warnings), src),
442 443
            Some(&pair) => pair,
        };
444
        if level == allow { return }
445 446 447 448 449 450 451

        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!()
452
                    }, self.lint_to_str(lint).replace("_", "-"),
453 454 455 456 457 458 459 460 461 462 463 464 465
                    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 已提交
466
        for &span in note.iter() {
467 468
            self.tcx.sess.span_note(span, "lint level defined here");
        }
469 470
    }

471
    /**
472
     * Merge the lints specified by any lint attributes into the
473
     * current lint context, call the provided function, then reset the
474
     * lints in effect to their previous state.
475
     */
476
    fn with_lint_attrs(@mut self, attrs: &[ast::Attribute], f: &fn()) {
477 478 479 480 481
        // 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;
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
        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));
                    }
                }
506
            }
507 508
            true
        };
509

510
        // detect doc(hidden)
511 512 513 514 515
        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(...)]
516
                }
517 518
        };

519 520 521 522 523 524
        if doc_hidden && !self.doc_hidden {
            self.doc_hidden = true;
        } else {
            doc_hidden = false;
        }

525
        f();
526

527
        // rollback
528 529 530
        if doc_hidden && self.doc_hidden {
            self.doc_hidden = false;
        }
531
        do pushed.times {
532 533
            let (lint, lvl, src) = self.lint_stack.pop();
            self.set_level(lint, lvl, src);
534
        }
535 536
    }

537
    fn add_old_lint(&mut self, v: @mut OuterLint) {
538
        self.visitors.push(OldVisitor(v, v.inner_variant()));
539 540
    }

541
    fn add_lint(&mut self, v: @mut visit::Visitor<()>) {
542
        self.visitors.push(NewVisitor(v));
543 544
    }

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

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

638 639 640 641 642 643 644 645
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,
646
                       _b:&ast::Block, _s:Span, _n:ast::NodeId, _e:@mut Context) {
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
        // 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,
670
                b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
671 672 673 674
        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 {
675
            match *fk {
676 677 678 679 680
                visit::fk_method(*) => {}
                _ => {
                    self.visit_fn_action(fk, fd, b, s, n, e);
                    visit::walk_fn(self, fk, fd, b, s, n, e);
                }
681
            }
682 683 684 685 686 687 688 689 690
        }
    }
}

struct WhileTrueLintVisitor { stopping_on_items: bool }


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

693 694 695 696 697 698
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,
699
                b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
700 701 702
        self.OVERRIDE_visit_fn(fk, fd, b, s, n, e);
    }

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

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

macro_rules! outer_lint_boilerplate_impl(
725
    ($Visitor:ident) =>
726 727 728 729 730 731
    (
        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,
732
                          b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
733 734 735 736 737 738 739 740 741 742 743 744
                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 已提交
745 746
}

747 748 749 750 751 752 753
struct TypeLimitsLintVisitor { stopping_on_items: bool }

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

impl TypeLimitsLintVisitor {
754
    fn is_valid<T:cmp::Ord>(&mut self, binop: ast::BinOp, v: T,
755 756
            min: T, max: T) -> bool {
        match binop {
757 758 759 760 761
            ast::BiLt => v <= max,
            ast::BiLe => v < max,
            ast::BiGt => v >= min,
            ast::BiGe => v > min,
            ast::BiEq | ast::BiNe => v >= min && v <= max,
762
            _ => fail!()
763 764 765
        }
    }

766
    fn rev_binop(&mut self, binop: ast::BinOp) -> ast::BinOp {
767
        match binop {
768 769 770 771
            ast::BiLt => ast::BiGt,
            ast::BiLe => ast::BiGe,
            ast::BiGt => ast::BiLt,
            ast::BiGe => ast::BiLe,
772 773 774 775
            _ => binop
        }
    }

776 777
    // for int & uint, be conservative with the warnings, so that the
    // warnings are consistent between 32- and 64-bit platforms
778
    fn int_ty_range(&mut self, int_ty: ast::int_ty) -> (i64, i64) {
779
        match int_ty {
780
            ast::ty_i =>    (i64::min_value,        i64::max_value),
781 782 783 784 785 786 787
            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)
        }
    }

788
    fn uint_ty_range(&mut self, uint_ty: ast::uint_ty) -> (u64, u64) {
789
        match uint_ty {
790
            ast::ty_u =>   (u64::min_value,         u64::max_value),
791 792 793 794 795 796 797
            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)
        }
    }

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

847
    fn is_comparison(&mut self, binop: ast::BinOp) -> bool {
848
        match binop {
849 850
            ast::BiEq | ast::BiLt | ast::BiLe |
            ast::BiNe | ast::BiGe | ast::BiGt => true,
851 852 853
            _ => false
        }
    }
854 855 856 857 858 859 860 861
}

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,
862
                b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
863 864 865
        self.OVERRIDE_visit_fn(fk, fd, b, s, n, e);
    }

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

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

882 883 884 885
outer_lint_boilerplate_impl!(TypeLimitsLintVisitor)

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

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

911
    fn check_foreign_fn(cx: &Context, decl: &ast::fn_decl) {
D
Daniel Micay 已提交
912
        for input in decl.inputs.iter() {
913
            check_ty(cx, &input.ty);
914
        }
J
James Miller 已提交
915
        check_ty(cx, &decl.output)
916 917
    }

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

933
fn check_type_for_lint(cx: &Context, lint: lint, span: Span, ty: ty::t) {
934
    if cx.get_level(lint) == allow { return }
935

936 937 938 939 940 941 942 943 944 945
    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
    });
946

947 948 949 950 951
    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);
    }
952

953 954 955 956
    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);
957
    }
958
}
959

960
fn check_type(cx: &Context, span: Span, ty: ty::t) {
961
    let xs = [managed_heap_memory, owned_heap_memory, heap_memory];
D
Daniel Micay 已提交
962
    for lint in xs.iter() {
963
        check_type_for_lint(cx, *lint, span, ty);
964
    }
965
}
966

967
fn check_item_heap(cx: &Context, it: &ast::item) {
968 969 970 971 972 973 974 975 976
    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)),
      _ => ()
    }
977

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

991 992 993 994 995 996 997 998 999 1000 1001 1002
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,
1003
                b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
1004 1005 1006
        self.OVERRIDE_visit_fn(fk, fd, b, s, n, e);
    }

1007
    fn visit_expr(&mut self, e:@ast::Expr, cx:@mut Context) {
1008 1009
            let ty = ty::expr_ty(cx.tcx, e);
            check_type(cx, e.span, ty);
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
            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 }
1026 1027
}

1028 1029 1030 1031 1032 1033
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,
1034
                b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
1035 1036 1037
        self.OVERRIDE_visit_fn(fk, fd, b, s, n, e);
    }

1038
    fn visit_stmt(&mut self, s:@ast::Stmt, cx:@mut Context) {
1039
            match s.node {
1040 1041
                ast::StmtSemi(
                    @ast::Expr { node: ast::ExprPath(_), _ },
1042 1043 1044 1045
                    _
                ) => {
                    cx.span_lint(path_statement, s.span,
                                 "path statement with no effect");
1046
                }
1047 1048
                _ => ()
            }
1049 1050 1051 1052 1053 1054 1055 1056 1057
            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
1058 1059
}

1060
fn check_item_non_camel_case_types(cx: &Context, it: &ast::item) {
1061
    fn is_camel_case(cx: ty::ctxt, ident: ast::Ident) -> bool {
P
Paul Stansifer 已提交
1062
        let ident = cx.sess.str_of(ident);
P
Patrick Walton 已提交
1063
        assert!(!ident.is_empty());
1064
        let ident = ident.trim_chars(&'_');
1065 1066 1067 1068

        // 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() &&
1069 1070 1071
            !ident.contains_char('_')
    }

1072
    fn check_case(cx: &Context, sort: &str, ident: ast::Ident, span: Span) {
1073
        if !is_camel_case(cx.tcx, ident) {
1074 1075 1076 1077
            cx.span_lint(
                non_camel_case_types, span,
                fmt!("%s `%s` should have a camel case identifier",
                    sort, cx.tcx.sess.str_of(ident)));
1078 1079 1080
        }
    }

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

1098 1099 1100
fn check_item_non_uppercase_statics(cx: &Context, it: &ast::item) {
    match it.node {
        // only check static constants
1101
        ast::item_static(_, ast::MutImmutable, _) => {
1102 1103 1104 1105
            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)
1106
            if s.iter().any(|c| c.is_lowercase()) {
1107 1108 1109 1110 1111 1112 1113 1114
                cx.span_lint(non_uppercase_statics, it.span,
                             "static constant should have an uppercase identifier");
            }
        }
        _ => {}
    }
}

1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
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,
1127
                b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
1128 1129 1130
        self.OVERRIDE_visit_fn(fk, fd, b, s, n, e);
    }

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

1133
            match e.node {
1134
                ast::ExprBlock(ref blk) if blk.rules == ast::UnsafeBlock => {
1135
                    if !cx.tcx.used_unsafe.contains(&blk.id) {
1136 1137 1138
                        cx.span_lint(unused_unsafe, blk.span,
                                     "unnecessary `unsafe` block");
                    }
1139
                }
1140
                _ => ()
1141
            }
1142 1143 1144 1145 1146 1147 1148 1149
            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
1150 1151
}

1152 1153 1154
struct UnusedMutLintVisitor { stopping_on_items: bool }

impl UnusedMutLintVisitor {
1155
    fn check_pat(&mut self, cx: &Context, p: @ast::Pat) {
1156 1157
        let mut used = false;
        let mut bindings = 0;
1158 1159
        do pat_util::pat_bindings(cx.tcx.def_map, p) |_, id, _, _| {
            used = used || cx.tcx.used_mut_nodes.contains(&id);
1160 1161 1162 1163
            bindings += 1;
        }
        if !used {
            let msg = if bindings == 1 {
S
Seo Sanghyeon 已提交
1164
                "variable does not need to be mutable"
1165
            } else {
S
Seo Sanghyeon 已提交
1166
                "variables do not need to be mutable"
1167
            };
1168
            cx.span_lint(unused_mut, p.span, msg);
1169
        }
1170
    }
1171

1172
    fn visit_fn_decl(&mut self, cx: &Context, fd: &ast::fn_decl) {
D
Daniel Micay 已提交
1173
        for arg in fd.inputs.iter() {
1174
            if arg.is_mutbl {
1175
                self.check_pat(cx, arg.pat);
1176 1177
            }
        }
1178
    }
1179 1180 1181 1182 1183 1184
}

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,
1185
                       _b:&ast::Block, _c:Span, _d:ast::NodeId, cx:@mut Context) {
1186 1187 1188
            self.visit_fn_decl(cx, fd);
    }
}
1189

1190 1191 1192 1193 1194 1195
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,
1196
                b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
1197 1198 1199 1200 1201
        self.OVERRIDE_visit_fn(fk, fd, b, s, n, e);
    }


    fn visit_local(&mut self, l:@ast::Local, cx:@mut Context) {
1202
            if l.is_mutbl {
1203
                self.check_pat(cx, l.pat);
1204
            }
1205 1206 1207 1208 1209 1210 1211 1212 1213
            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) {
1214
            match *tm {
1215 1216
                ast::required(ref tm) => self.visit_fn_decl(cx, &tm.decl),
                ast::provided(m) => self.visit_fn_decl(cx, &m.decl)
1217
            }
1218 1219 1220 1221 1222 1223 1224 1225
            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
1226 1227
}

1228
fn lint_session(cx: @mut Context) -> @mut visit::Visitor<()> {
1229
    ast_util::id_visitor(|id| {
1230 1231 1232
        match cx.tcx.sess.lints.pop(&id) {
            None => {},
            Some(l) => {
1233
                for (lint, span, msg) in l.move_iter() {
1234
                    cx.span_lint(lint, span, msg)
1235
                }
1236 1237
            }
        }
1238
    }, false)
1239 1240
}

1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252
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,
1253
                b:&ast::Block, s:Span, n:ast::NodeId, e:@mut Context) {
1254 1255 1256
        self.OVERRIDE_visit_fn(fk, fd, b, s, n, e);
    }

1257
    fn visit_expr(&mut self, e:@ast::Expr, cx:@mut Context) {
1258 1259 1260 1261 1262 1263
            self.check(cx, e);
            visit::walk_expr(self, e, cx);
    }
}

impl UnnecessaryAllocationLintVisitor {
1264 1265
    // Warn if string and vector literals with sigils are immediately borrowed.
    // Those can have the sigil removed.
1266
    fn check(&mut self, cx: &Context, e: &ast::Expr) {
1267
        match e.node {
1268 1269
            ast::ExprVstore(e2, ast::ExprVstoreUniq) |
            ast::ExprVstore(e2, ast::ExprVstoreBox) => {
1270
                match e2.node {
1271
                    ast::ExprLit(@codemap::Spanned{
1272
                            node: ast::lit_str(*), _}) |
1273
                    ast::ExprVec(*) => {}
1274 1275 1276 1277 1278 1279 1280
                    _ => return
                }
            }

            _ => return
        }

1281 1282 1283
        match cx.tcx.adjustments.find_copy(&e.id) {
            Some(@ty::AutoDerefRef(ty::AutoDerefRef {
                autoref: Some(ty::AutoBorrowVec(*)), _ })) => {
1284 1285 1286 1287 1288 1289 1290 1291
                cx.span_lint(unnecessary_allocation,
                             e.span, "unnecessary allocation, the sigil can be \
                                      removed");
            }

            _ => ()
        }
    }
1292
}
1293

1294 1295 1296 1297
outer_lint_boilerplate_impl!(UnnecessaryAllocationLintVisitor)

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

1300 1301 1302 1303 1304
struct MissingDocLintVisitor { stopping_on_items: bool }

impl MissingDocLintVisitor {
    fn check_attrs(&mut self,
                   cx: @mut Context,
1305
                   attrs: &[ast::Attribute],
1306
                   sp: Span,
1307
                   msg: &str) {
1308 1309 1310 1311 1312 1313
        // 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
1314
        if attrs.iter().any(|a| a.node.is_sugared_doc) { return }
1315 1316 1317

        // otherwise, warn!
        cx.span_lint(missing_doc, sp, msg);
1318
    }
1319 1320 1321 1322 1323 1324
}

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

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

    fn visit_ty_method(&mut self, m:&ast::TypeMethod, cx:@mut Context) {
1332 1333
            // All ty_method objects are linted about because they're part of a
            // trait (no visibility)
1334
            self.check_attrs(cx, m.attrs, m.span,
1335
                        "missing documentation for a method");
1336 1337 1338 1339 1340 1341 1342 1343
            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,
1344
                       _b:&ast::Block, sp:Span, _id:ast::NodeId, cx:@mut Context) {
1345

1346 1347 1348
            // Only warn about explicitly public methods. Soon implicit
            // public-ness will hopefully be going away.
            match *fk {
1349
                visit::fk_method(_, _, m) if m.vis == ast::public => {
1350 1351 1352
                    // If we're in a trait implementation, no need to duplicate
                    // documentation
                    if !cx.in_trait_impl {
1353
                        self.check_attrs(cx, m.attrs, sp,
1354
                                    "missing documentation for a method");
1355 1356
                    }
                }
1357

1358 1359
                _ => {}
            }
1360 1361 1362
    }

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

1364 1365 1366 1367 1368
            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 => {
1369
                    self.check_attrs(cx, it.attrs, it.span,
1370
                                "missing documentation for a struct");
D
Daniel Micay 已提交
1371
                    for field in sdef.fields.iter() {
1372 1373
                        match field.node.kind {
                            ast::named_field(_, vis) if vis != ast::private => {
1374
                                self.check_attrs(cx, field.node.attrs, field.span,
1375
                                            "missing documentation for a field");
1376
                            }
1377
                            ast::unnamed_field | ast::named_field(*) => {}
1378 1379 1380
                        }
                    }
                }
1381 1382

                ast::item_trait(*) if it.vis == ast::public => {
1383
                    self.check_attrs(cx, it.attrs, it.span,
1384 1385 1386 1387
                                "missing documentation for a trait");
                }

                ast::item_fn(*) if it.vis == ast::public => {
1388
                    self.check_attrs(cx, it.attrs, it.span,
1389 1390 1391 1392
                                "missing documentation for a function");
                }

                _ => {}
1393 1394 1395 1396 1397 1398 1399 1400 1401 1402
            }
    }
}

outer_lint_boilerplate_impl!(MissingDocLintVisitor)

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

1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 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
/// 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
}

1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526
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;
                }
    }
1527

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

1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554
                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);
                    }
                }
    }
1555 1556
}

1557
pub fn check_crate(tcx: ty::ctxt, crate: @ast::Crate) {
1558 1559 1560 1561 1562
    let cx = @mut Context {
        dict: @get_lint_dict(),
        curr: SmallIntMap::new(),
        tcx: tcx,
        lint_stack: ~[],
1563
        visitors: ~[],
1564
        in_trait_impl: false,
1565
        doc_hidden: false,
1566 1567 1568
    };

    // Install defaults.
D
Daniel Micay 已提交
1569
    for (_, spec) in cx.dict.iter() {
1570
        cx.set_level(spec.lint, spec.default, Default);
1571 1572 1573
    }

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

1578
    // Register each of the lint passes with the context
1579 1580 1581 1582 1583 1584 1585 1586
    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());
1587
    cx.add_old_lint(lint_stability());
1588
    cx.add_lint(lint_session(cx));
1589

1590
    // Actually perform the lint checks (iterating the ast)
1591
    do cx.with_lint_attrs(crate.attrs) {
1592
        cx.process(Crate(crate));
1593

1594
        let mut visitor = LintCheckVisitor;
1595

1596
        visit::walk_crate(&mut visitor, crate, cx);
1597 1598
    }

1599 1600
    // If we missed any lints added to the session, then there's a bug somewhere
    // in the iteration code.
D
Daniel Micay 已提交
1601 1602
    for (id, v) in tcx.sess.lints.iter() {
        for t in v.iter() {
1603 1604
            match *t {
                (lint, span, ref msg) =>
1605 1606 1607 1608 1609 1610 1611 1612
                    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))
1613 1614 1615
            }
        }
    }
1616

1617
    tcx.sess.abort_if_errors();
1618
}