]> git.lizzy.rs Git - rust.git/blob - src/librustc/lint/builtin.rs
auto merge of #15569 : pcwalton/rust/reexport-intrinsics, r=cmr
[rust.git] / src / librustc / lint / builtin.rs
1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
4 //
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
10
11 //! Lints built in to rustc.
12 //!
13 //! This is a sibling of `lint::context` in order to ensure that
14 //! lints implemented here use the same public API as lint plugins.
15 //!
16 //! To add a new lint to rustc, declare it here using `declare_lint!()`.
17 //! Then add code to emit the new lint in the appropriate circumstances.
18 //! You can do that in an existing `LintPass` if it makes sense, or in
19 //! a new `LintPass`, or using `Session::add_lint` elsewhere in the
20 //! compiler. Only do the latter if the check can't be written cleanly
21 //! as a `LintPass`.
22 //!
23 //! If you define a new `LintPass`, you will also need to add it to the
24 //! `add_builtin!` or `add_builtin_with_new!` invocation in `context.rs`.
25 //! Use the former for unit-like structs and the latter for structs with
26 //! a `pub fn new()`.
27
28 use metadata::csearch;
29 use middle::def::*;
30 use middle::trans::adt; // for `adt::is_ffi_safe`
31 use middle::typeck::astconv::ast_ty_to_ty;
32 use middle::typeck::infer;
33 use middle::{typeck, ty, def, pat_util, stability};
34 use util::ppaux::{ty_to_string};
35 use util::nodemap::NodeSet;
36 use lint::{Context, LintPass, LintArray};
37
38 use std::cmp;
39 use std::collections::HashMap;
40 use std::i16;
41 use std::i32;
42 use std::i64;
43 use std::i8;
44 use std::u16;
45 use std::u32;
46 use std::u64;
47 use std::u8;
48 use std::gc::Gc;
49 use syntax::abi;
50 use syntax::ast_map;
51 use syntax::attr::AttrMetaMethods;
52 use syntax::attr;
53 use syntax::codemap::Span;
54 use syntax::parse::token;
55 use syntax::{ast, ast_util, visit};
56
57 declare_lint!(WHILE_TRUE, Warn,
58               "suggest using `loop { }` instead of `while true { }`")
59
60 pub struct WhileTrue;
61
62 impl LintPass for WhileTrue {
63     fn get_lints(&self) -> LintArray {
64         lint_array!(WHILE_TRUE)
65     }
66
67     fn check_expr(&mut self, cx: &Context, e: &ast::Expr) {
68         match e.node {
69             ast::ExprWhile(cond, _) => {
70                 match cond.node {
71                     ast::ExprLit(lit) => {
72                         match lit.node {
73                             ast::LitBool(true) => {
74                                 cx.span_lint(WHILE_TRUE, e.span,
75                                              "denote infinite loops with loop \
76                                               { ... }");
77                             }
78                             _ => {}
79                         }
80                     }
81                     _ => ()
82                 }
83             }
84             _ => ()
85         }
86     }
87 }
88
89 declare_lint!(UNNECESSARY_TYPECAST, Allow,
90               "detects unnecessary type casts, that can be removed")
91
92 pub struct UnusedCasts;
93
94 impl LintPass for UnusedCasts {
95     fn get_lints(&self) -> LintArray {
96         lint_array!(UNNECESSARY_TYPECAST)
97     }
98
99     fn check_expr(&mut self, cx: &Context, e: &ast::Expr) {
100         match e.node {
101             ast::ExprCast(expr, ty) => {
102                 let t_t = ast_ty_to_ty(cx, &infer::new_infer_ctxt(cx.tcx), &*ty);
103                 if ty::get(ty::expr_ty(cx.tcx, &*expr)).sty == ty::get(t_t).sty {
104                     cx.span_lint(UNNECESSARY_TYPECAST, ty.span, "unnecessary type cast");
105                 }
106             }
107             _ => ()
108         }
109     }
110 }
111
112 declare_lint!(UNSIGNED_NEGATE, Warn,
113               "using an unary minus operator on unsigned type")
114
115 declare_lint!(TYPE_LIMITS, Warn,
116               "comparisons made useless by limits of the types involved")
117
118 declare_lint!(TYPE_OVERFLOW, Warn,
119               "literal out of range for its type")
120
121 pub struct TypeLimits {
122     /// Id of the last visited negated expression
123     negated_expr_id: ast::NodeId,
124 }
125
126 impl TypeLimits {
127     pub fn new() -> TypeLimits {
128         TypeLimits {
129             negated_expr_id: -1,
130         }
131     }
132 }
133
134 impl LintPass for TypeLimits {
135     fn get_lints(&self) -> LintArray {
136         lint_array!(UNSIGNED_NEGATE, TYPE_LIMITS, TYPE_OVERFLOW)
137     }
138
139     fn check_expr(&mut self, cx: &Context, e: &ast::Expr) {
140         match e.node {
141             ast::ExprUnary(ast::UnNeg, expr) => {
142                 match expr.node  {
143                     ast::ExprLit(lit) => {
144                         match lit.node {
145                             ast::LitUint(..) => {
146                                 cx.span_lint(UNSIGNED_NEGATE, e.span,
147                                              "negation of unsigned int literal may \
148                                              be unintentional");
149                             },
150                             _ => ()
151                         }
152                     },
153                     _ => {
154                         let t = ty::expr_ty(cx.tcx, &*expr);
155                         match ty::get(t).sty {
156                             ty::ty_uint(_) => {
157                                 cx.span_lint(UNSIGNED_NEGATE, e.span,
158                                              "negation of unsigned int variable may \
159                                              be unintentional");
160                             },
161                             _ => ()
162                         }
163                     }
164                 };
165                 // propagate negation, if the negation itself isn't negated
166                 if self.negated_expr_id != e.id {
167                     self.negated_expr_id = expr.id;
168                 }
169             },
170             ast::ExprParen(expr) if self.negated_expr_id == e.id => {
171                 self.negated_expr_id = expr.id;
172             },
173             ast::ExprBinary(binop, l, r) => {
174                 if is_comparison(binop) && !check_limits(cx.tcx, binop, &*l, &*r) {
175                     cx.span_lint(TYPE_LIMITS, e.span,
176                                  "comparison is useless due to type limits");
177                 }
178             },
179             ast::ExprLit(lit) => {
180                 match ty::get(ty::expr_ty(cx.tcx, e)).sty {
181                     ty::ty_int(t) => {
182                         let int_type = if t == ast::TyI {
183                             cx.sess().targ_cfg.int_type
184                         } else { t };
185                         let (min, max) = int_ty_range(int_type);
186                         let mut lit_val: i64 = match lit.node {
187                             ast::LitInt(v, _) => v,
188                             ast::LitUint(v, _) => v as i64,
189                             ast::LitIntUnsuffixed(v) => v,
190                             _ => fail!()
191                         };
192                         if self.negated_expr_id == e.id {
193                             lit_val *= -1;
194                         }
195                         if  lit_val < min || lit_val > max {
196                             cx.span_lint(TYPE_OVERFLOW, e.span,
197                                          "literal out of range for its type");
198                         }
199                     },
200                     ty::ty_uint(t) => {
201                         let uint_type = if t == ast::TyU {
202                             cx.sess().targ_cfg.uint_type
203                         } else { t };
204                         let (min, max) = uint_ty_range(uint_type);
205                         let lit_val: u64 = match lit.node {
206                             ast::LitByte(_v) => return,  // _v is u8, within range by definition
207                             ast::LitInt(v, _) => v as u64,
208                             ast::LitUint(v, _) => v,
209                             ast::LitIntUnsuffixed(v) => v as u64,
210                             _ => fail!()
211                         };
212                         if  lit_val < min || lit_val > max {
213                             cx.span_lint(TYPE_OVERFLOW, e.span,
214                                          "literal out of range for its type");
215                         }
216                     },
217
218                     _ => ()
219                 };
220             },
221             _ => ()
222         };
223
224         fn is_valid<T:cmp::PartialOrd>(binop: ast::BinOp, v: T,
225                                 min: T, max: T) -> bool {
226             match binop {
227                 ast::BiLt => v >  min && v <= max,
228                 ast::BiLe => v >= min && v <  max,
229                 ast::BiGt => v >= min && v <  max,
230                 ast::BiGe => v >  min && v <= max,
231                 ast::BiEq | ast::BiNe => v >= min && v <= max,
232                 _ => fail!()
233             }
234         }
235
236         fn rev_binop(binop: ast::BinOp) -> ast::BinOp {
237             match binop {
238                 ast::BiLt => ast::BiGt,
239                 ast::BiLe => ast::BiGe,
240                 ast::BiGt => ast::BiLt,
241                 ast::BiGe => ast::BiLe,
242                 _ => binop
243             }
244         }
245
246         // for int & uint, be conservative with the warnings, so that the
247         // warnings are consistent between 32- and 64-bit platforms
248         fn int_ty_range(int_ty: ast::IntTy) -> (i64, i64) {
249             match int_ty {
250                 ast::TyI =>    (i64::MIN,        i64::MAX),
251                 ast::TyI8 =>   (i8::MIN  as i64, i8::MAX  as i64),
252                 ast::TyI16 =>  (i16::MIN as i64, i16::MAX as i64),
253                 ast::TyI32 =>  (i32::MIN as i64, i32::MAX as i64),
254                 ast::TyI64 =>  (i64::MIN,        i64::MAX)
255             }
256         }
257
258         fn uint_ty_range(uint_ty: ast::UintTy) -> (u64, u64) {
259             match uint_ty {
260                 ast::TyU =>   (u64::MIN,         u64::MAX),
261                 ast::TyU8 =>  (u8::MIN   as u64, u8::MAX   as u64),
262                 ast::TyU16 => (u16::MIN  as u64, u16::MAX  as u64),
263                 ast::TyU32 => (u32::MIN  as u64, u32::MAX  as u64),
264                 ast::TyU64 => (u64::MIN,         u64::MAX)
265             }
266         }
267
268         fn check_limits(tcx: &ty::ctxt, binop: ast::BinOp,
269                         l: &ast::Expr, r: &ast::Expr) -> bool {
270             let (lit, expr, swap) = match (&l.node, &r.node) {
271                 (&ast::ExprLit(_), _) => (l, r, true),
272                 (_, &ast::ExprLit(_)) => (r, l, false),
273                 _ => return true
274             };
275             // Normalize the binop so that the literal is always on the RHS in
276             // the comparison
277             let norm_binop = if swap { rev_binop(binop) } else { binop };
278             match ty::get(ty::expr_ty(tcx, expr)).sty {
279                 ty::ty_int(int_ty) => {
280                     let (min, max) = int_ty_range(int_ty);
281                     let lit_val: i64 = match lit.node {
282                         ast::ExprLit(li) => match li.node {
283                             ast::LitInt(v, _) => v,
284                             ast::LitUint(v, _) => v as i64,
285                             ast::LitIntUnsuffixed(v) => v,
286                             _ => return true
287                         },
288                         _ => fail!()
289                     };
290                     is_valid(norm_binop, lit_val, min, max)
291                 }
292                 ty::ty_uint(uint_ty) => {
293                     let (min, max): (u64, u64) = uint_ty_range(uint_ty);
294                     let lit_val: u64 = match lit.node {
295                         ast::ExprLit(li) => match li.node {
296                             ast::LitInt(v, _) => v as u64,
297                             ast::LitUint(v, _) => v,
298                             ast::LitIntUnsuffixed(v) => v as u64,
299                             _ => return true
300                         },
301                         _ => fail!()
302                     };
303                     is_valid(norm_binop, lit_val, min, max)
304                 }
305                 _ => true
306             }
307         }
308
309         fn is_comparison(binop: ast::BinOp) -> bool {
310             match binop {
311                 ast::BiEq | ast::BiLt | ast::BiLe |
312                 ast::BiNe | ast::BiGe | ast::BiGt => true,
313                 _ => false
314             }
315         }
316     }
317 }
318
319 declare_lint!(CTYPES, Warn,
320               "proper use of libc types in foreign modules")
321
322 pub struct CTypes;
323
324 impl LintPass for CTypes {
325     fn get_lints(&self) -> LintArray {
326         lint_array!(CTYPES)
327     }
328
329     fn check_item(&mut self, cx: &Context, it: &ast::Item) {
330         fn check_ty(cx: &Context, ty: &ast::Ty) {
331             match ty.node {
332                 ast::TyPath(_, _, id) => {
333                     match cx.tcx.def_map.borrow().get_copy(&id) {
334                         def::DefPrimTy(ast::TyInt(ast::TyI)) => {
335                             cx.span_lint(CTYPES, ty.span,
336                                          "found rust type `int` in foreign module, while \
337                                           libc::c_int or libc::c_long should be used");
338                         }
339                         def::DefPrimTy(ast::TyUint(ast::TyU)) => {
340                             cx.span_lint(CTYPES, ty.span,
341                                          "found rust type `uint` in foreign module, while \
342                                           libc::c_uint or libc::c_ulong should be used");
343                         }
344                         def::DefTy(def_id) => {
345                             if !adt::is_ffi_safe(cx.tcx, def_id) {
346                                 cx.span_lint(CTYPES, ty.span,
347                                              "found enum type without foreign-function-safe \
348                                               representation annotation in foreign module");
349                                 // hmm... this message could be more helpful
350                             }
351                         }
352                         _ => ()
353                     }
354                 }
355                 ast::TyPtr(ref mt) => { check_ty(cx, &*mt.ty) }
356                 _ => {}
357             }
358         }
359
360         fn check_foreign_fn(cx: &Context, decl: &ast::FnDecl) {
361             for input in decl.inputs.iter() {
362                 check_ty(cx, &*input.ty);
363             }
364             check_ty(cx, &*decl.output)
365         }
366
367         match it.node {
368           ast::ItemForeignMod(ref nmod) if nmod.abi != abi::RustIntrinsic => {
369             for ni in nmod.items.iter() {
370                 match ni.node {
371                     ast::ForeignItemFn(decl, _) => check_foreign_fn(cx, &*decl),
372                     ast::ForeignItemStatic(t, _) => check_ty(cx, &*t)
373                 }
374             }
375           }
376           _ => {/* nothing to do */ }
377         }
378     }
379 }
380
381 declare_lint!(MANAGED_HEAP_MEMORY, Allow,
382               "use of managed (@ type) heap memory")
383
384 declare_lint!(OWNED_HEAP_MEMORY, Allow,
385               "use of owned (Box type) heap memory")
386
387 declare_lint!(HEAP_MEMORY, Allow,
388               "use of any (Box type or @ type) heap memory")
389
390 pub struct HeapMemory;
391
392 impl HeapMemory {
393     fn check_heap_type(&self, cx: &Context, span: Span, ty: ty::t) {
394         let mut n_box = 0i;
395         let mut n_uniq = 0i;
396         ty::fold_ty(cx.tcx, ty, |t| {
397             match ty::get(t).sty {
398                 ty::ty_box(_) => {
399                     n_box += 1;
400                 }
401                 ty::ty_uniq(_) |
402                 ty::ty_closure(box ty::ClosureTy {
403                     store: ty::UniqTraitStore,
404                     ..
405                 }) => {
406                     n_uniq += 1;
407                 }
408
409                 _ => ()
410             };
411             t
412         });
413
414         if n_uniq > 0 {
415             let s = ty_to_string(cx.tcx, ty);
416             let m = format!("type uses owned (Box type) pointers: {}", s);
417             cx.span_lint(OWNED_HEAP_MEMORY, span, m.as_slice());
418             cx.span_lint(HEAP_MEMORY, span, m.as_slice());
419         }
420
421         if n_box > 0 {
422             let s = ty_to_string(cx.tcx, ty);
423             let m = format!("type uses managed (@ type) pointers: {}", s);
424             cx.span_lint(MANAGED_HEAP_MEMORY, span, m.as_slice());
425             cx.span_lint(HEAP_MEMORY, span, m.as_slice());
426         }
427     }
428 }
429
430 impl LintPass for HeapMemory {
431     fn get_lints(&self) -> LintArray {
432         lint_array!(MANAGED_HEAP_MEMORY, OWNED_HEAP_MEMORY, HEAP_MEMORY)
433     }
434
435     fn check_item(&mut self, cx: &Context, it: &ast::Item) {
436         match it.node {
437             ast::ItemFn(..) |
438             ast::ItemTy(..) |
439             ast::ItemEnum(..) |
440             ast::ItemStruct(..) =>
441                 self.check_heap_type(cx, it.span,
442                                      ty::node_id_to_type(cx.tcx, it.id)),
443             _ => ()
444         }
445
446         // If it's a struct, we also have to check the fields' types
447         match it.node {
448             ast::ItemStruct(struct_def, _) => {
449                 for struct_field in struct_def.fields.iter() {
450                     self.check_heap_type(cx, struct_field.span,
451                                          ty::node_id_to_type(cx.tcx, struct_field.node.id));
452                 }
453             }
454             _ => ()
455         }
456     }
457
458     fn check_expr(&mut self, cx: &Context, e: &ast::Expr) {
459         let ty = ty::expr_ty(cx.tcx, e);
460         self.check_heap_type(cx, e.span, ty);
461     }
462 }
463
464 declare_lint!(RAW_POINTER_DERIVING, Warn,
465               "uses of #[deriving] with raw pointers are rarely correct")
466
467 struct RawPtrDerivingVisitor<'a> {
468     cx: &'a Context<'a>
469 }
470
471 impl<'a> visit::Visitor<()> for RawPtrDerivingVisitor<'a> {
472     fn visit_ty(&mut self, ty: &ast::Ty, _: ()) {
473         static MSG: &'static str = "use of `#[deriving]` with a raw pointer";
474         match ty.node {
475             ast::TyPtr(..) => self.cx.span_lint(RAW_POINTER_DERIVING, ty.span, MSG),
476             _ => {}
477         }
478         visit::walk_ty(self, ty, ());
479     }
480     // explicit override to a no-op to reduce code bloat
481     fn visit_expr(&mut self, _: &ast::Expr, _: ()) {}
482     fn visit_block(&mut self, _: &ast::Block, _: ()) {}
483 }
484
485 pub struct RawPointerDeriving {
486     checked_raw_pointers: NodeSet,
487 }
488
489 impl RawPointerDeriving {
490     pub fn new() -> RawPointerDeriving {
491         RawPointerDeriving {
492             checked_raw_pointers: NodeSet::new(),
493         }
494     }
495 }
496
497 impl LintPass for RawPointerDeriving {
498     fn get_lints(&self) -> LintArray {
499         lint_array!(RAW_POINTER_DERIVING)
500     }
501
502     fn check_item(&mut self, cx: &Context, item: &ast::Item) {
503         if !attr::contains_name(item.attrs.as_slice(), "automatically_derived") {
504             return
505         }
506         let did = match item.node {
507             ast::ItemImpl(..) => {
508                 match ty::get(ty::node_id_to_type(cx.tcx, item.id)).sty {
509                     ty::ty_enum(did, _) => did,
510                     ty::ty_struct(did, _) => did,
511                     _ => return,
512                 }
513             }
514             _ => return,
515         };
516         if !ast_util::is_local(did) { return }
517         let item = match cx.tcx.map.find(did.node) {
518             Some(ast_map::NodeItem(item)) => item,
519             _ => return,
520         };
521         if !self.checked_raw_pointers.insert(item.id) { return }
522         match item.node {
523             ast::ItemStruct(..) | ast::ItemEnum(..) => {
524                 let mut visitor = RawPtrDerivingVisitor { cx: cx };
525                 visit::walk_item(&mut visitor, &*item, ());
526             }
527             _ => {}
528         }
529     }
530 }
531
532 declare_lint!(UNUSED_ATTRIBUTE, Warn,
533               "detects attributes that were not used by the compiler")
534
535 pub struct UnusedAttribute;
536
537 impl LintPass for UnusedAttribute {
538     fn get_lints(&self) -> LintArray {
539         lint_array!(UNUSED_ATTRIBUTE)
540     }
541
542     fn check_attribute(&mut self, cx: &Context, attr: &ast::Attribute) {
543         static ATTRIBUTE_WHITELIST: &'static [&'static str] = &[
544             // FIXME: #14408 whitelist docs since rustdoc looks at them
545             "doc",
546
547             // FIXME: #14406 these are processed in trans, which happens after the
548             // lint pass
549             "cold",
550             "inline",
551             "link",
552             "link_name",
553             "link_section",
554             "no_builtins",
555             "no_mangle",
556             "no_split_stack",
557             "packed",
558             "static_assert",
559             "thread_local",
560
561             // not used anywhere (!?) but apparently we want to keep them around
562             "comment",
563             "desc",
564             "license",
565
566             // FIXME: #14407 these are only looked at on-demand so we can't
567             // guarantee they'll have already been checked
568             "deprecated",
569             "experimental",
570             "frozen",
571             "locked",
572             "must_use",
573             "stable",
574             "unstable",
575         ];
576
577         static CRATE_ATTRS: &'static [&'static str] = &[
578             "crate_name",
579             "crate_type",
580             "feature",
581             "no_start",
582             "no_main",
583             "no_std",
584             "desc",
585             "comment",
586             "license",
587             "copyright",
588             "no_builtins",
589         ];
590
591         for &name in ATTRIBUTE_WHITELIST.iter() {
592             if attr.check_name(name) {
593                 break;
594             }
595         }
596
597         if !attr::is_used(attr) {
598             cx.span_lint(UNUSED_ATTRIBUTE, attr.span, "unused attribute");
599             if CRATE_ATTRS.contains(&attr.name().get()) {
600                 let msg = match attr.node.style {
601                     ast::AttrOuter => "crate-level attribute should be an inner \
602                                        attribute: add an exclamation mark: #![foo]",
603                     ast::AttrInner => "crate-level attribute should be in the \
604                                        root module",
605                 };
606                 cx.span_lint(UNUSED_ATTRIBUTE, attr.span, msg);
607             }
608         }
609     }
610 }
611
612 declare_lint!(PATH_STATEMENT, Warn,
613               "path statements with no effect")
614
615 pub struct PathStatement;
616
617 impl LintPass for PathStatement {
618     fn get_lints(&self) -> LintArray {
619         lint_array!(PATH_STATEMENT)
620     }
621
622     fn check_stmt(&mut self, cx: &Context, s: &ast::Stmt) {
623         match s.node {
624             ast::StmtSemi(expr, _) => {
625                 match expr.node {
626                     ast::ExprPath(_) => cx.span_lint(PATH_STATEMENT, s.span,
627                                                      "path statement with no effect"),
628                     _ => ()
629                 }
630             }
631             _ => ()
632         }
633     }
634 }
635
636 declare_lint!(UNUSED_MUST_USE, Warn,
637               "unused result of a type flagged as #[must_use]")
638
639 declare_lint!(UNUSED_RESULT, Allow,
640               "unused result of an expression in a statement")
641
642 pub struct UnusedResult;
643
644 impl LintPass for UnusedResult {
645     fn get_lints(&self) -> LintArray {
646         lint_array!(UNUSED_MUST_USE, UNUSED_RESULT)
647     }
648
649     fn check_stmt(&mut self, cx: &Context, s: &ast::Stmt) {
650         let expr = match s.node {
651             ast::StmtSemi(expr, _) => expr,
652             _ => return
653         };
654         let t = ty::expr_ty(cx.tcx, &*expr);
655         match ty::get(t).sty {
656             ty::ty_nil | ty::ty_bot | ty::ty_bool => return,
657             _ => {}
658         }
659         match expr.node {
660             ast::ExprRet(..) => return,
661             _ => {}
662         }
663
664         let t = ty::expr_ty(cx.tcx, &*expr);
665         let mut warned = false;
666         match ty::get(t).sty {
667             ty::ty_struct(did, _) |
668             ty::ty_enum(did, _) => {
669                 if ast_util::is_local(did) {
670                     match cx.tcx.map.get(did.node) {
671                         ast_map::NodeItem(it) => {
672                             warned |= check_must_use(cx, it.attrs.as_slice(), s.span);
673                         }
674                         _ => {}
675                     }
676                 } else {
677                     csearch::get_item_attrs(&cx.sess().cstore, did, |attrs| {
678                         warned |= check_must_use(cx, attrs.as_slice(), s.span);
679                     });
680                 }
681             }
682             _ => {}
683         }
684         if !warned {
685             cx.span_lint(UNUSED_RESULT, s.span, "unused result");
686         }
687
688         fn check_must_use(cx: &Context, attrs: &[ast::Attribute], sp: Span) -> bool {
689             for attr in attrs.iter() {
690                 if attr.check_name("must_use") {
691                     let mut msg = "unused result which must be used".to_string();
692                     // check for #[must_use="..."]
693                     match attr.value_str() {
694                         None => {}
695                         Some(s) => {
696                             msg.push_str(": ");
697                             msg.push_str(s.get());
698                         }
699                     }
700                     cx.span_lint(UNUSED_MUST_USE, sp, msg.as_slice());
701                     return true;
702                 }
703             }
704             false
705         }
706     }
707 }
708
709 declare_lint!(NON_CAMEL_CASE_TYPES, Warn,
710               "types, variants and traits should have camel case names")
711
712 pub struct NonCamelCaseTypes;
713
714 impl LintPass for NonCamelCaseTypes {
715     fn get_lints(&self) -> LintArray {
716         lint_array!(NON_CAMEL_CASE_TYPES)
717     }
718
719     fn check_item(&mut self, cx: &Context, it: &ast::Item) {
720         fn is_camel_case(ident: ast::Ident) -> bool {
721             let ident = token::get_ident(ident);
722             assert!(!ident.get().is_empty());
723             let ident = ident.get().trim_chars('_');
724
725             // start with a non-lowercase letter rather than non-uppercase
726             // ones (some scripts don't have a concept of upper/lowercase)
727             !ident.char_at(0).is_lowercase() && !ident.contains_char('_')
728         }
729
730         fn to_camel_case(s: &str) -> String {
731             s.split('_').flat_map(|word| word.chars().enumerate().map(|(i, c)|
732                 if i == 0 { c.to_uppercase() }
733                 else { c }
734             )).collect()
735         }
736
737         fn check_case(cx: &Context, sort: &str, ident: ast::Ident, span: Span) {
738             let s = token::get_ident(ident);
739
740             if !is_camel_case(ident) {
741                 cx.span_lint(NON_CAMEL_CASE_TYPES, span,
742                     format!("{} `{}` should have a camel case name such as `{}`",
743                             sort, s, to_camel_case(s.get())).as_slice());
744             }
745         }
746
747         match it.node {
748             ast::ItemTy(..) | ast::ItemStruct(..) => {
749                 check_case(cx, "type", it.ident, it.span)
750             }
751             ast::ItemTrait(..) => {
752                 check_case(cx, "trait", it.ident, it.span)
753             }
754             ast::ItemEnum(ref enum_definition, _) => {
755                 check_case(cx, "type", it.ident, it.span);
756                 for variant in enum_definition.variants.iter() {
757                     check_case(cx, "variant", variant.node.name, variant.span);
758                 }
759             }
760             _ => ()
761         }
762     }
763 }
764
765 #[deriving(PartialEq)]
766 enum MethodContext {
767     TraitDefaultImpl,
768     TraitImpl,
769     PlainImpl
770 }
771
772 fn method_context(cx: &Context, m: &ast::Method) -> MethodContext {
773     let did = ast::DefId {
774         krate: ast::LOCAL_CRATE,
775         node: m.id
776     };
777
778     match cx.tcx.methods.borrow().find_copy(&did) {
779         None => cx.sess().span_bug(m.span, "missing method descriptor?!"),
780         Some(md) => {
781             match md.container {
782                 ty::TraitContainer(..) => TraitDefaultImpl,
783                 ty::ImplContainer(cid) => {
784                     match ty::impl_trait_ref(cx.tcx, cid) {
785                         Some(..) => TraitImpl,
786                         None => PlainImpl
787                     }
788                 }
789             }
790         }
791     }
792 }
793
794 declare_lint!(NON_SNAKE_CASE_FUNCTIONS, Warn,
795               "methods and functions should have snake case names")
796
797 pub struct NonSnakeCaseFunctions;
798
799 impl NonSnakeCaseFunctions {
800     fn check_snake_case(&self, cx: &Context, sort: &str, ident: ast::Ident, span: Span) {
801         fn is_snake_case(ident: ast::Ident) -> bool {
802             let ident = token::get_ident(ident);
803             assert!(!ident.get().is_empty());
804             let ident = ident.get().trim_chars('_');
805
806             let mut allow_underscore = true;
807             ident.chars().all(|c| {
808                 allow_underscore = match c {
809                     c if c.is_lowercase() || c.is_digit() => true,
810                     '_' if allow_underscore => false,
811                     _ => return false,
812                 };
813                 true
814             })
815         }
816
817         fn to_snake_case(str: &str) -> String {
818             let mut words = vec![];
819             for s in str.split('_') {
820                 let mut buf = String::new();
821                 if s.is_empty() { continue; }
822                 for ch in s.chars() {
823                     if !buf.is_empty() && ch.is_uppercase() {
824                         words.push(buf);
825                         buf = String::new();
826                     }
827                     buf.push_char(ch.to_lowercase());
828                 }
829                 words.push(buf);
830             }
831             words.connect("_")
832         }
833
834         let s = token::get_ident(ident);
835
836         if !is_snake_case(ident) {
837             cx.span_lint(NON_SNAKE_CASE_FUNCTIONS, span,
838                 format!("{} `{}` should have a snake case name such as `{}`",
839                         sort, s, to_snake_case(s.get())).as_slice());
840         }
841     }
842 }
843
844 impl LintPass for NonSnakeCaseFunctions {
845     fn get_lints(&self) -> LintArray {
846         lint_array!(NON_SNAKE_CASE_FUNCTIONS)
847     }
848
849     fn check_fn(&mut self, cx: &Context,
850                 fk: &visit::FnKind, _: &ast::FnDecl,
851                 _: &ast::Block, span: Span, _: ast::NodeId) {
852         match *fk {
853             visit::FkMethod(ident, _, m) => match method_context(cx, m) {
854                 PlainImpl
855                     => self.check_snake_case(cx, "method", ident, span),
856                 TraitDefaultImpl
857                     => self.check_snake_case(cx, "trait method", ident, span),
858                 _ => (),
859             },
860             visit::FkItemFn(ident, _, _, _)
861                 => self.check_snake_case(cx, "function", ident, span),
862             _ => (),
863         }
864     }
865
866     fn check_ty_method(&mut self, cx: &Context, t: &ast::TypeMethod) {
867         self.check_snake_case(cx, "trait method", t.ident, t.span);
868     }
869 }
870
871 declare_lint!(NON_UPPERCASE_STATICS, Allow,
872               "static constants should have uppercase identifiers")
873
874 pub struct NonUppercaseStatics;
875
876 impl LintPass for NonUppercaseStatics {
877     fn get_lints(&self) -> LintArray {
878         lint_array!(NON_UPPERCASE_STATICS)
879     }
880
881     fn check_item(&mut self, cx: &Context, it: &ast::Item) {
882         match it.node {
883             // only check static constants
884             ast::ItemStatic(_, ast::MutImmutable, _) => {
885                 let s = token::get_ident(it.ident);
886                 // check for lowercase letters rather than non-uppercase
887                 // ones (some scripts don't have a concept of
888                 // upper/lowercase)
889                 if s.get().chars().any(|c| c.is_lowercase()) {
890                     cx.span_lint(NON_UPPERCASE_STATICS, it.span,
891                         format!("static constant `{}` should have an uppercase name \
892                                  such as `{}`",
893                                 s.get(), s.get().chars().map(|c| c.to_uppercase())
894                                 .collect::<String>().as_slice()).as_slice());
895                 }
896             }
897             _ => {}
898         }
899     }
900 }
901
902 declare_lint!(NON_UPPERCASE_PATTERN_STATICS, Warn,
903               "static constants in match patterns should be all caps")
904
905 pub struct NonUppercasePatternStatics;
906
907 impl LintPass for NonUppercasePatternStatics {
908     fn get_lints(&self) -> LintArray {
909         lint_array!(NON_UPPERCASE_PATTERN_STATICS)
910     }
911
912     fn check_pat(&mut self, cx: &Context, p: &ast::Pat) {
913         // Lint for constants that look like binding identifiers (#7526)
914         match (&p.node, cx.tcx.def_map.borrow().find(&p.id)) {
915             (&ast::PatIdent(_, ref path1, _), Some(&def::DefStatic(_, false))) => {
916                 let s = token::get_ident(path1.node);
917                 if s.get().chars().any(|c| c.is_lowercase()) {
918                     cx.span_lint(NON_UPPERCASE_PATTERN_STATICS, path1.span,
919                         format!("static constant in pattern `{}` should have an uppercase \
920                                  name such as `{}`",
921                                 s.get(), s.get().chars().map(|c| c.to_uppercase())
922                                     .collect::<String>().as_slice()).as_slice());
923                 }
924             }
925             _ => {}
926         }
927     }
928 }
929
930 declare_lint!(UPPERCASE_VARIABLES, Warn,
931               "variable and structure field names should start with a lowercase character")
932
933 pub struct UppercaseVariables;
934
935 impl LintPass for UppercaseVariables {
936     fn get_lints(&self) -> LintArray {
937         lint_array!(UPPERCASE_VARIABLES)
938     }
939
940     fn check_pat(&mut self, cx: &Context, p: &ast::Pat) {
941         match &p.node {
942             &ast::PatIdent(_, ref path1, _) => {
943                 match cx.tcx.def_map.borrow().find(&p.id) {
944                     Some(&def::DefLocal(_, _)) | Some(&def::DefBinding(_, _)) |
945                             Some(&def::DefArg(_, _)) => {
946                         let s = token::get_ident(path1.node);
947                         if s.get().len() > 0 && s.get().char_at(0).is_uppercase() {
948                             cx.span_lint(UPPERCASE_VARIABLES, path1.span,
949                                          "variable names should start with \
950                                           a lowercase character");
951                         }
952                     }
953                     _ => {}
954                 }
955             }
956             _ => {}
957         }
958     }
959
960     fn check_struct_def(&mut self, cx: &Context, s: &ast::StructDef,
961             _: ast::Ident, _: &ast::Generics, _: ast::NodeId) {
962         for sf in s.fields.iter() {
963             match sf.node {
964                 ast::StructField_ { kind: ast::NamedField(ident, _), .. } => {
965                     let s = token::get_ident(ident);
966                     if s.get().char_at(0).is_uppercase() {
967                         cx.span_lint(UPPERCASE_VARIABLES, sf.span,
968                                      "structure field names should start with \
969                                       a lowercase character");
970                     }
971                 }
972                 _ => {}
973             }
974         }
975     }
976 }
977
978 declare_lint!(UNNECESSARY_PARENS, Warn,
979               "`if`, `match`, `while` and `return` do not need parentheses")
980
981 pub struct UnnecessaryParens;
982
983 impl UnnecessaryParens {
984     fn check_unnecessary_parens_core(&self, cx: &Context, value: &ast::Expr, msg: &str,
985                                      struct_lit_needs_parens: bool) {
986         match value.node {
987             ast::ExprParen(ref inner) => {
988                 let necessary = struct_lit_needs_parens && contains_exterior_struct_lit(&**inner);
989                 if !necessary {
990                     cx.span_lint(UNNECESSARY_PARENS, value.span,
991                                  format!("unnecessary parentheses around {}",
992                                          msg).as_slice())
993                 }
994             }
995             _ => {}
996         }
997
998         /// Expressions that syntactically contain an "exterior" struct
999         /// literal i.e. not surrounded by any parens or other
1000         /// delimiters, e.g. `X { y: 1 }`, `X { y: 1 }.method()`, `foo
1001         /// == X { y: 1 }` and `X { y: 1 } == foo` all do, but `(X {
1002         /// y: 1 }) == foo` does not.
1003         fn contains_exterior_struct_lit(value: &ast::Expr) -> bool {
1004             match value.node {
1005                 ast::ExprStruct(..) => true,
1006
1007                 ast::ExprAssign(ref lhs, ref rhs) |
1008                 ast::ExprAssignOp(_, ref lhs, ref rhs) |
1009                 ast::ExprBinary(_, ref lhs, ref rhs) => {
1010                     // X { y: 1 } + X { y: 2 }
1011                     contains_exterior_struct_lit(&**lhs) ||
1012                         contains_exterior_struct_lit(&**rhs)
1013                 }
1014                 ast::ExprUnary(_, ref x) |
1015                 ast::ExprCast(ref x, _) |
1016                 ast::ExprField(ref x, _, _) |
1017                 ast::ExprIndex(ref x, _) => {
1018                     // &X { y: 1 }, X { y: 1 }.y
1019                     contains_exterior_struct_lit(&**x)
1020                 }
1021
1022                 ast::ExprMethodCall(_, _, ref exprs) => {
1023                     // X { y: 1 }.bar(...)
1024                     contains_exterior_struct_lit(&**exprs.get(0))
1025                 }
1026
1027                 _ => false
1028             }
1029         }
1030     }
1031 }
1032
1033 impl LintPass for UnnecessaryParens {
1034     fn get_lints(&self) -> LintArray {
1035         lint_array!(UNNECESSARY_PARENS)
1036     }
1037
1038     fn check_expr(&mut self, cx: &Context, e: &ast::Expr) {
1039         let (value, msg, struct_lit_needs_parens) = match e.node {
1040             ast::ExprIf(cond, _, _) => (cond, "`if` condition", true),
1041             ast::ExprWhile(cond, _) => (cond, "`while` condition", true),
1042             ast::ExprMatch(head, _) => (head, "`match` head expression", true),
1043             ast::ExprRet(Some(value)) => (value, "`return` value", false),
1044             ast::ExprAssign(_, value) => (value, "assigned value", false),
1045             ast::ExprAssignOp(_, _, value) => (value, "assigned value", false),
1046             _ => return
1047         };
1048         self.check_unnecessary_parens_core(cx, &*value, msg, struct_lit_needs_parens);
1049     }
1050
1051     fn check_stmt(&mut self, cx: &Context, s: &ast::Stmt) {
1052         let (value, msg) = match s.node {
1053             ast::StmtDecl(decl, _) => match decl.node {
1054                 ast::DeclLocal(local) => match local.init {
1055                     Some(value) => (value, "assigned value"),
1056                     None => return
1057                 },
1058                 _ => return
1059             },
1060             _ => return
1061         };
1062         self.check_unnecessary_parens_core(cx, &*value, msg, false);
1063     }
1064 }
1065
1066 declare_lint!(UNUSED_UNSAFE, Warn,
1067               "unnecessary use of an `unsafe` block")
1068
1069 pub struct UnusedUnsafe;
1070
1071 impl LintPass for UnusedUnsafe {
1072     fn get_lints(&self) -> LintArray {
1073         lint_array!(UNUSED_UNSAFE)
1074     }
1075
1076     fn check_expr(&mut self, cx: &Context, e: &ast::Expr) {
1077         match e.node {
1078             // Don't warn about generated blocks, that'll just pollute the output.
1079             ast::ExprBlock(ref blk) => {
1080                 if blk.rules == ast::UnsafeBlock(ast::UserProvided) &&
1081                     !cx.tcx.used_unsafe.borrow().contains(&blk.id) {
1082                     cx.span_lint(UNUSED_UNSAFE, blk.span, "unnecessary `unsafe` block");
1083                 }
1084             }
1085             _ => ()
1086         }
1087     }
1088 }
1089
1090 declare_lint!(UNSAFE_BLOCK, Allow,
1091               "usage of an `unsafe` block")
1092
1093 pub struct UnsafeBlock;
1094
1095 impl LintPass for UnsafeBlock {
1096     fn get_lints(&self) -> LintArray {
1097         lint_array!(UNSAFE_BLOCK)
1098     }
1099
1100     fn check_expr(&mut self, cx: &Context, e: &ast::Expr) {
1101         match e.node {
1102             // Don't warn about generated blocks, that'll just pollute the output.
1103             ast::ExprBlock(ref blk) if blk.rules == ast::UnsafeBlock(ast::UserProvided) => {
1104                 cx.span_lint(UNSAFE_BLOCK, blk.span, "usage of an `unsafe` block");
1105             }
1106             _ => ()
1107         }
1108     }
1109 }
1110
1111 declare_lint!(UNUSED_MUT, Warn,
1112               "detect mut variables which don't need to be mutable")
1113
1114 pub struct UnusedMut;
1115
1116 impl UnusedMut {
1117     fn check_unused_mut_pat(&self, cx: &Context, pats: &[Gc<ast::Pat>]) {
1118         // collect all mutable pattern and group their NodeIDs by their Identifier to
1119         // avoid false warnings in match arms with multiple patterns
1120         let mut mutables = HashMap::new();
1121         for &p in pats.iter() {
1122             pat_util::pat_bindings(&cx.tcx.def_map, &*p, |mode, id, _, path1| {
1123                 let ident = path1.node;
1124                 match mode {
1125                     ast::BindByValue(ast::MutMutable) => {
1126                         if !token::get_ident(ident).get().starts_with("_") {
1127                             mutables.insert_or_update_with(ident.name.uint(),
1128                                 vec!(id), |_, old| { old.push(id); });
1129                         }
1130                     }
1131                     _ => {
1132                     }
1133                 }
1134             });
1135         }
1136
1137         let used_mutables = cx.tcx.used_mut_nodes.borrow();
1138         for (_, v) in mutables.iter() {
1139             if !v.iter().any(|e| used_mutables.contains(e)) {
1140                 cx.span_lint(UNUSED_MUT, cx.tcx.map.span(*v.get(0)),
1141                              "variable does not need to be mutable");
1142             }
1143         }
1144     }
1145 }
1146
1147 impl LintPass for UnusedMut {
1148     fn get_lints(&self) -> LintArray {
1149         lint_array!(UNUSED_MUT)
1150     }
1151
1152     fn check_expr(&mut self, cx: &Context, e: &ast::Expr) {
1153         match e.node {
1154             ast::ExprMatch(_, ref arms) => {
1155                 for a in arms.iter() {
1156                     self.check_unused_mut_pat(cx, a.pats.as_slice())
1157                 }
1158             }
1159             _ => {}
1160         }
1161     }
1162
1163     fn check_stmt(&mut self, cx: &Context, s: &ast::Stmt) {
1164         match s.node {
1165             ast::StmtDecl(d, _) => {
1166                 match d.node {
1167                     ast::DeclLocal(l) => {
1168                         self.check_unused_mut_pat(cx, &[l.pat]);
1169                     },
1170                     _ => {}
1171                 }
1172             },
1173             _ => {}
1174         }
1175     }
1176
1177     fn check_fn(&mut self, cx: &Context,
1178                 _: &visit::FnKind, decl: &ast::FnDecl,
1179                 _: &ast::Block, _: Span, _: ast::NodeId) {
1180         for a in decl.inputs.iter() {
1181             self.check_unused_mut_pat(cx, &[a.pat]);
1182         }
1183     }
1184 }
1185
1186 enum Allocation {
1187     VectorAllocation,
1188     BoxAllocation
1189 }
1190
1191 declare_lint!(UNNECESSARY_ALLOCATION, Warn,
1192               "detects unnecessary allocations that can be eliminated")
1193
1194 pub struct UnnecessaryAllocation;
1195
1196 impl LintPass for UnnecessaryAllocation {
1197     fn get_lints(&self) -> LintArray {
1198         lint_array!(UNNECESSARY_ALLOCATION)
1199     }
1200
1201     fn check_expr(&mut self, cx: &Context, e: &ast::Expr) {
1202         // Warn if string and vector literals with sigils, or boxing expressions,
1203         // are immediately borrowed.
1204         let allocation = match e.node {
1205             ast::ExprVstore(e2, ast::ExprVstoreUniq) => {
1206                 match e2.node {
1207                     ast::ExprLit(lit) if ast_util::lit_is_str(lit) => {
1208                         VectorAllocation
1209                     }
1210                     ast::ExprVec(..) => VectorAllocation,
1211                     _ => return
1212                 }
1213             }
1214             ast::ExprUnary(ast::UnUniq, _) |
1215             ast::ExprUnary(ast::UnBox, _) => BoxAllocation,
1216
1217             _ => return
1218         };
1219
1220         match cx.tcx.adjustments.borrow().find(&e.id) {
1221             Some(adjustment) => {
1222                 match *adjustment {
1223                     ty::AutoDerefRef(ty::AutoDerefRef { autoref, .. }) => {
1224                         match (allocation, autoref) {
1225                             (VectorAllocation, Some(ty::AutoBorrowVec(..))) => {
1226                                 cx.span_lint(UNNECESSARY_ALLOCATION, e.span,
1227                                              "unnecessary allocation, the sigil can be removed");
1228                             }
1229                             (BoxAllocation,
1230                              Some(ty::AutoPtr(_, ast::MutImmutable))) => {
1231                                 cx.span_lint(UNNECESSARY_ALLOCATION, e.span,
1232                                              "unnecessary allocation, use & instead");
1233                             }
1234                             (BoxAllocation,
1235                              Some(ty::AutoPtr(_, ast::MutMutable))) => {
1236                                 cx.span_lint(UNNECESSARY_ALLOCATION, e.span,
1237                                              "unnecessary allocation, use &mut instead");
1238                             }
1239                             _ => ()
1240                         }
1241                     }
1242                     _ => {}
1243                 }
1244             }
1245             _ => ()
1246         }
1247     }
1248 }
1249
1250 declare_lint!(MISSING_DOC, Allow,
1251               "detects missing documentation for public members")
1252
1253 pub struct MissingDoc {
1254     /// Stack of IDs of struct definitions.
1255     struct_def_stack: Vec<ast::NodeId>,
1256
1257     /// Stack of whether #[doc(hidden)] is set
1258     /// at each level which has lint attributes.
1259     doc_hidden_stack: Vec<bool>,
1260 }
1261
1262 impl MissingDoc {
1263     pub fn new() -> MissingDoc {
1264         MissingDoc {
1265             struct_def_stack: vec!(),
1266             doc_hidden_stack: vec!(false),
1267         }
1268     }
1269
1270     fn doc_hidden(&self) -> bool {
1271         *self.doc_hidden_stack.last().expect("empty doc_hidden_stack")
1272     }
1273
1274     fn check_missing_doc_attrs(&self,
1275                                cx: &Context,
1276                                id: Option<ast::NodeId>,
1277                                attrs: &[ast::Attribute],
1278                                sp: Span,
1279                                desc: &'static str) {
1280         // If we're building a test harness, then warning about
1281         // documentation is probably not really relevant right now.
1282         if cx.sess().opts.test { return }
1283
1284         // `#[doc(hidden)]` disables missing_doc check.
1285         if self.doc_hidden() { return }
1286
1287         // Only check publicly-visible items, using the result from the privacy pass.
1288         // It's an option so the crate root can also use this function (it doesn't
1289         // have a NodeId).
1290         match id {
1291             Some(ref id) if !cx.exported_items.contains(id) => return,
1292             _ => ()
1293         }
1294
1295         let has_doc = attrs.iter().any(|a| {
1296             match a.node.value.node {
1297                 ast::MetaNameValue(ref name, _) if name.equiv(&("doc")) => true,
1298                 _ => false
1299             }
1300         });
1301         if !has_doc {
1302             cx.span_lint(MISSING_DOC, sp,
1303                 format!("missing documentation for {}", desc).as_slice());
1304         }
1305     }
1306 }
1307
1308 impl LintPass for MissingDoc {
1309     fn get_lints(&self) -> LintArray {
1310         lint_array!(MISSING_DOC)
1311     }
1312
1313     fn enter_lint_attrs(&mut self, _: &Context, attrs: &[ast::Attribute]) {
1314         let doc_hidden = self.doc_hidden() || attrs.iter().any(|attr| {
1315             attr.check_name("doc") && match attr.meta_item_list() {
1316                 None => false,
1317                 Some(l) => attr::contains_name(l.as_slice(), "hidden"),
1318             }
1319         });
1320         self.doc_hidden_stack.push(doc_hidden);
1321     }
1322
1323     fn exit_lint_attrs(&mut self, _: &Context, _: &[ast::Attribute]) {
1324         self.doc_hidden_stack.pop().expect("empty doc_hidden_stack");
1325     }
1326
1327     fn check_struct_def(&mut self, _: &Context,
1328         _: &ast::StructDef, _: ast::Ident, _: &ast::Generics, id: ast::NodeId) {
1329         self.struct_def_stack.push(id);
1330     }
1331
1332     fn check_struct_def_post(&mut self, _: &Context,
1333         _: &ast::StructDef, _: ast::Ident, _: &ast::Generics, id: ast::NodeId) {
1334         let popped = self.struct_def_stack.pop().expect("empty struct_def_stack");
1335         assert!(popped == id);
1336     }
1337
1338     fn check_crate(&mut self, cx: &Context, krate: &ast::Crate) {
1339         self.check_missing_doc_attrs(cx, None, krate.attrs.as_slice(),
1340                                      krate.span, "crate");
1341     }
1342
1343     fn check_item(&mut self, cx: &Context, it: &ast::Item) {
1344         let desc = match it.node {
1345             ast::ItemFn(..) => "a function",
1346             ast::ItemMod(..) => "a module",
1347             ast::ItemEnum(..) => "an enum",
1348             ast::ItemStruct(..) => "a struct",
1349             ast::ItemTrait(..) => "a trait",
1350             _ => return
1351         };
1352         self.check_missing_doc_attrs(cx, Some(it.id), it.attrs.as_slice(),
1353                                      it.span, desc);
1354     }
1355
1356     fn check_fn(&mut self, cx: &Context,
1357             fk: &visit::FnKind, _: &ast::FnDecl,
1358             _: &ast::Block, _: Span, _: ast::NodeId) {
1359         match *fk {
1360             visit::FkMethod(_, _, m) => {
1361                 // If the method is an impl for a trait, don't doc.
1362                 if method_context(cx, m) == TraitImpl { return; }
1363
1364                 // Otherwise, doc according to privacy. This will also check
1365                 // doc for default methods defined on traits.
1366                 self.check_missing_doc_attrs(cx, Some(m.id), m.attrs.as_slice(),
1367                                              m.span, "a method");
1368             }
1369             _ => {}
1370         }
1371     }
1372
1373     fn check_ty_method(&mut self, cx: &Context, tm: &ast::TypeMethod) {
1374         self.check_missing_doc_attrs(cx, Some(tm.id), tm.attrs.as_slice(),
1375                                      tm.span, "a type method");
1376     }
1377
1378     fn check_struct_field(&mut self, cx: &Context, sf: &ast::StructField) {
1379         match sf.node.kind {
1380             ast::NamedField(_, vis) if vis == ast::Public => {
1381                 let cur_struct_def = *self.struct_def_stack.last()
1382                     .expect("empty struct_def_stack");
1383                 self.check_missing_doc_attrs(cx, Some(cur_struct_def),
1384                                              sf.node.attrs.as_slice(), sf.span,
1385                                              "a struct field")
1386             }
1387             _ => {}
1388         }
1389     }
1390
1391     fn check_variant(&mut self, cx: &Context, v: &ast::Variant, _: &ast::Generics) {
1392         self.check_missing_doc_attrs(cx, Some(v.node.id), v.node.attrs.as_slice(),
1393                                      v.span, "a variant");
1394     }
1395 }
1396
1397 declare_lint!(DEPRECATED, Warn,
1398               "detects use of #[deprecated] items")
1399
1400 // FIXME #6875: Change to Warn after std library stabilization is complete
1401 declare_lint!(EXPERIMENTAL, Allow,
1402               "detects use of #[experimental] items")
1403
1404 declare_lint!(UNSTABLE, Allow,
1405               "detects use of #[unstable] items (incl. items with no stability attribute)")
1406
1407 /// Checks for use of items with `#[deprecated]`, `#[experimental]` and
1408 /// `#[unstable]` attributes, or no stability attribute.
1409 pub struct Stability;
1410
1411 impl LintPass for Stability {
1412     fn get_lints(&self) -> LintArray {
1413         lint_array!(DEPRECATED, EXPERIMENTAL, UNSTABLE)
1414     }
1415
1416     fn check_expr(&mut self, cx: &Context, e: &ast::Expr) {
1417         let id = match e.node {
1418             ast::ExprPath(..) | ast::ExprStruct(..) => {
1419                 match cx.tcx.def_map.borrow().find(&e.id) {
1420                     Some(&def) => def.def_id(),
1421                     None => return
1422                 }
1423             }
1424             ast::ExprMethodCall(..) => {
1425                 let method_call = typeck::MethodCall::expr(e.id);
1426                 match cx.tcx.method_map.borrow().find(&method_call) {
1427                     Some(method) => {
1428                         match method.origin {
1429                             typeck::MethodStatic(def_id) => {
1430                                 def_id
1431                             }
1432                             typeck::MethodParam(typeck::MethodParam {
1433                                 trait_id: trait_id,
1434                                 method_num: index,
1435                                 ..
1436                             })
1437                             | typeck::MethodObject(typeck::MethodObject {
1438                                 trait_id: trait_id,
1439                                 method_num: index,
1440                                 ..
1441                             }) => ty::trait_method(cx.tcx, trait_id, index).def_id
1442                         }
1443                     }
1444                     None => return
1445                 }
1446             }
1447             _ => return
1448         };
1449
1450         // stability attributes are promises made across crates; do not
1451         // check anything for crate-local usage.
1452         if ast_util::is_local(id) { return }
1453
1454         let stability = stability::lookup(cx.tcx, id);
1455         let (lint, label) = match stability {
1456             // no stability attributes == Unstable
1457             None => (UNSTABLE, "unmarked"),
1458             Some(attr::Stability { level: attr::Unstable, .. }) =>
1459                     (UNSTABLE, "unstable"),
1460             Some(attr::Stability { level: attr::Experimental, .. }) =>
1461                     (EXPERIMENTAL, "experimental"),
1462             Some(attr::Stability { level: attr::Deprecated, .. }) =>
1463                     (DEPRECATED, "deprecated"),
1464             _ => return
1465         };
1466
1467         let msg = match stability {
1468             Some(attr::Stability { text: Some(ref s), .. }) => {
1469                 format!("use of {} item: {}", label, *s)
1470             }
1471             _ => format!("use of {} item", label)
1472         };
1473
1474         cx.span_lint(lint, e.span, msg.as_slice());
1475     }
1476 }
1477
1478 declare_lint!(pub UNUSED_IMPORTS, Warn,
1479               "imports that are never used")
1480
1481 declare_lint!(pub UNNECESSARY_QUALIFICATION, Allow,
1482               "detects unnecessarily qualified names")
1483
1484 declare_lint!(pub UNRECOGNIZED_LINT, Warn,
1485               "unrecognized lint attribute")
1486
1487 declare_lint!(pub UNUSED_VARIABLE, Warn,
1488               "detect variables which are not used in any way")
1489
1490 declare_lint!(pub DEAD_ASSIGNMENT, Warn,
1491               "detect assignments that will never be read")
1492
1493 declare_lint!(pub DEAD_CODE, Warn,
1494               "detect piece of code that will never be used")
1495
1496 declare_lint!(pub VISIBLE_PRIVATE_TYPES, Warn,
1497               "detect use of private types in exported type signatures")
1498
1499 declare_lint!(pub UNREACHABLE_CODE, Warn,
1500               "detects unreachable code")
1501
1502 declare_lint!(pub WARNINGS, Warn,
1503               "mass-change the level for lints which produce warnings")
1504
1505 declare_lint!(pub UNKNOWN_FEATURES, Deny,
1506               "unknown features found in crate-level #[feature] directives")
1507
1508 declare_lint!(pub UNKNOWN_CRATE_TYPE, Deny,
1509               "unknown crate type found in #[crate_type] directive")
1510
1511 declare_lint!(pub VARIANT_SIZE_DIFFERENCE, Allow,
1512               "detects enums with widely varying variant sizes")
1513
1514 /// Does nothing as a lint pass, but registers some `Lint`s
1515 /// which are used by other parts of the compiler.
1516 pub struct HardwiredLints;
1517
1518 impl LintPass for HardwiredLints {
1519     fn get_lints(&self) -> LintArray {
1520         lint_array!(
1521             UNUSED_IMPORTS,
1522             UNNECESSARY_QUALIFICATION,
1523             UNRECOGNIZED_LINT,
1524             UNUSED_VARIABLE,
1525             DEAD_ASSIGNMENT,
1526             DEAD_CODE,
1527             VISIBLE_PRIVATE_TYPES,
1528             UNREACHABLE_CODE,
1529             WARNINGS,
1530             UNKNOWN_FEATURES,
1531             UNKNOWN_CRATE_TYPE,
1532             VARIANT_SIZE_DIFFERENCE
1533         )
1534     }
1535 }