1 // Copyright 2012-2015 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.
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.
11 //! Lints in the Rust compiler.
13 //! This contains lints which can feasibly be implemented as their own
14 //! AST visitor. Also see `rustc::lint::builtin`, which contains the
15 //! definitions of lints that are emitted directly inside the main
18 //! To add a new lint to rustc, declare it here using `declare_lint!()`.
19 //! Then add code to emit the new lint in the appropriate circumstances.
20 //! You can do that in an existing `LintPass` if it makes sense, or in a
21 //! new `LintPass`, or using `Session::add_lint` elsewhere in the
22 //! compiler. Only do the latter if the check can't be written cleanly as a
23 //! `LintPass` (also, note that such lints will need to be defined in
24 //! `rustc::lint::builtin`, not here).
26 //! If you define a new `LintPass`, you will also need to add it to the
27 //! `add_builtin!` or `add_builtin_with_new!` invocation in `lib.rs`.
28 //! Use the former for unit-like structs and the latter for structs with
31 use rustc::hir::def::Def;
32 use rustc::hir::def_id::DefId;
34 use rustc::ty::subst::Substs;
35 use rustc::ty::{self, Ty};
37 use rustc::hir::map as hir_map;
38 use util::nodemap::NodeSet;
39 use lint::{LateContext, LintContext, LintArray};
40 use lint::{LintPass, LateLintPass, EarlyLintPass, EarlyContext};
42 use std::collections::HashSet;
46 use syntax::feature_gate::{AttributeGate, AttributeType, Stability, deprecated_attributes};
47 use syntax_pos::{BytePos, Span, SyntaxContext};
48 use syntax::symbol::keywords;
49 use syntax::errors::DiagnosticBuilder;
51 use rustc::hir::{self, PatKind};
52 use rustc::hir::intravisit::FnKind;
54 use bad_style::{MethodLateContext, method_context};
56 // hardwired lints from librustc
57 pub use lint::builtin::*;
62 "suggest using `loop { }` instead of `while true { }`"
65 #[derive(Copy, Clone)]
68 impl LintPass for WhileTrue {
69 fn get_lints(&self) -> LintArray {
70 lint_array!(WHILE_TRUE)
74 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for WhileTrue {
75 fn check_expr(&mut self, cx: &LateContext, e: &hir::Expr) {
76 if let hir::ExprWhile(ref cond, ..) = e.node {
77 if let hir::ExprLit(ref lit) = cond.node {
78 if let ast::LitKind::Bool(true) = lit.node {
79 if lit.span.ctxt() == SyntaxContext::empty() {
80 let msg = "denote infinite loops with `loop { ... }`";
81 let condition_span = cx.tcx.sess.codemap().def_span(e.span);
82 let mut err = cx.struct_span_lint(WHILE_TRUE, condition_span, msg);
83 err.span_suggestion_short(condition_span, "use `loop`", "loop".to_owned());
95 "use of owned (Box type) heap memory"
98 #[derive(Copy, Clone)]
99 pub struct BoxPointers;
102 fn check_heap_type<'a, 'tcx>(&self, cx: &LateContext, span: Span, ty: Ty) {
103 for leaf_ty in ty.walk() {
104 if leaf_ty.is_box() {
105 let m = format!("type uses owned (Box type) pointers: {}", ty);
106 cx.span_lint(BOX_POINTERS, span, &m);
112 impl LintPass for BoxPointers {
113 fn get_lints(&self) -> LintArray {
114 lint_array!(BOX_POINTERS)
118 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for BoxPointers {
119 fn check_item(&mut self, cx: &LateContext, it: &hir::Item) {
124 hir::ItemStruct(..) |
125 hir::ItemUnion(..) => {
126 let def_id = cx.tcx.hir.local_def_id(it.id);
127 self.check_heap_type(cx, it.span, cx.tcx.type_of(def_id))
132 // If it's a struct, we also have to check the fields' types
134 hir::ItemStruct(ref struct_def, _) |
135 hir::ItemUnion(ref struct_def, _) => {
136 for struct_field in struct_def.fields() {
137 let def_id = cx.tcx.hir.local_def_id(struct_field.id);
138 self.check_heap_type(cx, struct_field.span,
139 cx.tcx.type_of(def_id));
146 fn check_expr(&mut self, cx: &LateContext, e: &hir::Expr) {
147 let ty = cx.tables.node_id_to_type(e.hir_id);
148 self.check_heap_type(cx, e.span, ty);
153 NON_SHORTHAND_FIELD_PATTERNS,
155 "using `Struct { x: x }` instead of `Struct { x }` in a pattern"
158 #[derive(Copy, Clone)]
159 pub struct NonShorthandFieldPatterns;
161 impl LintPass for NonShorthandFieldPatterns {
162 fn get_lints(&self) -> LintArray {
163 lint_array!(NON_SHORTHAND_FIELD_PATTERNS)
167 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for NonShorthandFieldPatterns {
168 fn check_pat(&mut self, cx: &LateContext, pat: &hir::Pat) {
169 if let PatKind::Struct(ref qpath, ref field_pats, _) = pat.node {
170 let variant = cx.tables.pat_ty(pat).ty_adt_def()
171 .expect("struct pattern type is not an ADT")
172 .variant_of_def(cx.tables.qpath_def(qpath, pat.hir_id));
173 for fieldpat in field_pats {
174 if fieldpat.node.is_shorthand {
177 if fieldpat.span.ctxt().outer().expn_info().is_some() {
178 // Don't lint if this is a macro expansion: macro authors
179 // shouldn't have to worry about this kind of style issue
183 if let PatKind::Binding(_, _, name, None) = fieldpat.node.pat.node {
184 let binding_ident = ast::Ident::new(name.node, name.span);
185 if cx.tcx.find_field_index(binding_ident, &variant) ==
186 Some(cx.tcx.field_index(fieldpat.node.id, cx.tables)) {
187 let mut err = cx.struct_span_lint(NON_SHORTHAND_FIELD_PATTERNS,
189 &format!("the `{}:` in this pattern is redundant",
191 let subspan = cx.tcx.sess.codemap().span_through_char(fieldpat.span, ':');
192 err.span_suggestion_short(subspan,
194 format!("{}", name.node));
206 "usage of `unsafe` code"
209 #[derive(Copy, Clone)]
210 pub struct UnsafeCode;
212 impl LintPass for UnsafeCode {
213 fn get_lints(&self) -> LintArray {
214 lint_array!(UNSAFE_CODE)
219 fn report_unsafe(&self, cx: &LateContext, span: Span, desc: &'static str) {
220 // This comes from a macro that has #[allow_internal_unsafe].
221 if span.allows_unsafe() {
225 cx.span_lint(UNSAFE_CODE, span, desc);
229 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnsafeCode {
230 fn check_expr(&mut self, cx: &LateContext, e: &hir::Expr) {
231 if let hir::ExprBlock(ref blk) = e.node {
232 // Don't warn about generated blocks, that'll just pollute the output.
233 if blk.rules == hir::UnsafeBlock(hir::UserProvided) {
234 self.report_unsafe(cx, blk.span, "usage of an `unsafe` block");
239 fn check_item(&mut self, cx: &LateContext, it: &hir::Item) {
241 hir::ItemTrait(_, hir::Unsafety::Unsafe, ..) => {
242 self.report_unsafe(cx, it.span, "declaration of an `unsafe` trait")
245 hir::ItemImpl(hir::Unsafety::Unsafe, ..) => {
246 self.report_unsafe(cx, it.span, "implementation of an `unsafe` trait")
253 fn check_fn(&mut self,
261 FnKind::ItemFn(_, _, hir::Unsafety::Unsafe, ..) => {
262 self.report_unsafe(cx, span, "declaration of an `unsafe` function")
265 FnKind::Method(_, sig, ..) => {
266 if sig.unsafety == hir::Unsafety::Unsafe {
267 self.report_unsafe(cx, span, "implementation of an `unsafe` method")
275 fn check_trait_item(&mut self, cx: &LateContext, item: &hir::TraitItem) {
276 if let hir::TraitItemKind::Method(ref sig, hir::TraitMethod::Required(_)) = item.node {
277 if sig.unsafety == hir::Unsafety::Unsafe {
278 self.report_unsafe(cx, item.span, "declaration of an `unsafe` method")
287 "detects missing documentation for public members"
290 pub struct MissingDoc {
291 /// Stack of whether #[doc(hidden)] is set
292 /// at each level which has lint attributes.
293 doc_hidden_stack: Vec<bool>,
295 /// Private traits or trait items that leaked through. Don't check their methods.
296 private_traits: HashSet<ast::NodeId>,
300 pub fn new() -> MissingDoc {
302 doc_hidden_stack: vec![false],
303 private_traits: HashSet::new(),
307 fn doc_hidden(&self) -> bool {
308 *self.doc_hidden_stack.last().expect("empty doc_hidden_stack")
311 fn check_missing_docs_attrs(&self,
313 id: Option<ast::NodeId>,
314 attrs: &[ast::Attribute],
316 desc: &'static str) {
317 // If we're building a test harness, then warning about
318 // documentation is probably not really relevant right now.
319 if cx.sess().opts.test {
323 // `#[doc(hidden)]` disables missing_docs check.
324 if self.doc_hidden() {
328 // Only check publicly-visible items, using the result from the privacy pass.
329 // It's an option so the crate root can also use this function (it doesn't
331 if let Some(id) = id {
332 if !cx.access_levels.is_exported(id) {
337 fn has_doc(attr: &ast::Attribute) -> bool {
338 if !attr.check_name("doc") {
342 if attr.is_value_str() {
346 if let Some(list) = attr.meta_item_list() {
348 if meta.check_name("include") {
357 let has_doc = attrs.iter().any(|a| has_doc(a));
359 cx.span_lint(MISSING_DOCS,
360 cx.tcx.sess.codemap().def_span(sp),
361 &format!("missing documentation for {}", desc));
366 impl LintPass for MissingDoc {
367 fn get_lints(&self) -> LintArray {
368 lint_array!(MISSING_DOCS)
372 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MissingDoc {
373 fn enter_lint_attrs(&mut self, _: &LateContext, attrs: &[ast::Attribute]) {
374 let doc_hidden = self.doc_hidden() ||
375 attrs.iter().any(|attr| {
376 attr.check_name("doc") &&
377 match attr.meta_item_list() {
379 Some(l) => attr::list_contains_name(&l, "hidden"),
382 self.doc_hidden_stack.push(doc_hidden);
385 fn exit_lint_attrs(&mut self, _: &LateContext, _attrs: &[ast::Attribute]) {
386 self.doc_hidden_stack.pop().expect("empty doc_hidden_stack");
389 fn check_crate(&mut self, cx: &LateContext, krate: &hir::Crate) {
390 self.check_missing_docs_attrs(cx, None, &krate.attrs, krate.span, "crate");
393 fn check_item(&mut self, cx: &LateContext, it: &hir::Item) {
394 let desc = match it.node {
395 hir::ItemFn(..) => "a function",
396 hir::ItemMod(..) => "a module",
397 hir::ItemEnum(..) => "an enum",
398 hir::ItemStruct(..) => "a struct",
399 hir::ItemUnion(..) => "a union",
400 hir::ItemTrait(.., ref trait_item_refs) => {
401 // Issue #11592, traits are always considered exported, even when private.
402 if it.vis == hir::Visibility::Inherited {
403 self.private_traits.insert(it.id);
404 for trait_item_ref in trait_item_refs {
405 self.private_traits.insert(trait_item_ref.id.node_id);
411 hir::ItemTy(..) => "a type alias",
412 hir::ItemImpl(.., Some(ref trait_ref), _, ref impl_item_refs) => {
413 // If the trait is private, add the impl items to private_traits so they don't get
414 // reported for missing docs.
415 let real_trait = trait_ref.path.def.def_id();
416 if let Some(node_id) = cx.tcx.hir.as_local_node_id(real_trait) {
417 match cx.tcx.hir.find(node_id) {
418 Some(hir_map::NodeItem(item)) => {
419 if item.vis == hir::Visibility::Inherited {
420 for impl_item_ref in impl_item_refs {
421 self.private_traits.insert(impl_item_ref.id.node_id);
430 hir::ItemConst(..) => "a constant",
431 hir::ItemStatic(..) => "a static",
435 self.check_missing_docs_attrs(cx, Some(it.id), &it.attrs, it.span, desc);
438 fn check_trait_item(&mut self, cx: &LateContext, trait_item: &hir::TraitItem) {
439 if self.private_traits.contains(&trait_item.id) {
443 let desc = match trait_item.node {
444 hir::TraitItemKind::Const(..) => "an associated constant",
445 hir::TraitItemKind::Method(..) => "a trait method",
446 hir::TraitItemKind::Type(..) => "an associated type",
449 self.check_missing_docs_attrs(cx,
456 fn check_impl_item(&mut self, cx: &LateContext, impl_item: &hir::ImplItem) {
457 // If the method is an impl for a trait, don't doc.
458 if method_context(cx, impl_item.id) == MethodLateContext::TraitImpl {
462 let desc = match impl_item.node {
463 hir::ImplItemKind::Const(..) => "an associated constant",
464 hir::ImplItemKind::Method(..) => "a method",
465 hir::ImplItemKind::Type(_) => "an associated type",
467 self.check_missing_docs_attrs(cx,
474 fn check_struct_field(&mut self, cx: &LateContext, sf: &hir::StructField) {
475 if !sf.is_positional() {
476 self.check_missing_docs_attrs(cx,
484 fn check_variant(&mut self, cx: &LateContext, v: &hir::Variant, _: &hir::Generics) {
485 self.check_missing_docs_attrs(cx,
486 Some(v.node.data.id()),
494 pub MISSING_COPY_IMPLEMENTATIONS,
496 "detects potentially-forgotten implementations of `Copy`"
499 #[derive(Copy, Clone)]
500 pub struct MissingCopyImplementations;
502 impl LintPass for MissingCopyImplementations {
503 fn get_lints(&self) -> LintArray {
504 lint_array!(MISSING_COPY_IMPLEMENTATIONS)
508 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MissingCopyImplementations {
509 fn check_item(&mut self, cx: &LateContext, item: &hir::Item) {
510 if !cx.access_levels.is_reachable(item.id) {
513 let (def, ty) = match item.node {
514 hir::ItemStruct(_, ref ast_generics) => {
515 if !ast_generics.params.is_empty() {
518 let def = cx.tcx.adt_def(cx.tcx.hir.local_def_id(item.id));
519 (def, cx.tcx.mk_adt(def, cx.tcx.intern_substs(&[])))
521 hir::ItemUnion(_, ref ast_generics) => {
522 if !ast_generics.params.is_empty() {
525 let def = cx.tcx.adt_def(cx.tcx.hir.local_def_id(item.id));
526 (def, cx.tcx.mk_adt(def, cx.tcx.intern_substs(&[])))
528 hir::ItemEnum(_, ref ast_generics) => {
529 if !ast_generics.params.is_empty() {
532 let def = cx.tcx.adt_def(cx.tcx.hir.local_def_id(item.id));
533 (def, cx.tcx.mk_adt(def, cx.tcx.intern_substs(&[])))
537 if def.has_dtor(cx.tcx) {
540 let param_env = ty::ParamEnv::empty();
541 if !ty.moves_by_default(cx.tcx, param_env, item.span) {
544 if param_env.can_type_implement_copy(cx.tcx, ty, item.span).is_ok() {
545 cx.span_lint(MISSING_COPY_IMPLEMENTATIONS,
547 "type could implement `Copy`; consider adding `impl \
554 MISSING_DEBUG_IMPLEMENTATIONS,
556 "detects missing implementations of fmt::Debug"
559 pub struct MissingDebugImplementations {
560 impling_types: Option<NodeSet>,
563 impl MissingDebugImplementations {
564 pub fn new() -> MissingDebugImplementations {
565 MissingDebugImplementations { impling_types: None }
569 impl LintPass for MissingDebugImplementations {
570 fn get_lints(&self) -> LintArray {
571 lint_array!(MISSING_DEBUG_IMPLEMENTATIONS)
575 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MissingDebugImplementations {
576 fn check_item(&mut self, cx: &LateContext, item: &hir::Item) {
577 if !cx.access_levels.is_reachable(item.id) {
582 hir::ItemStruct(..) |
584 hir::ItemEnum(..) => {}
588 let debug = match cx.tcx.lang_items().debug_trait() {
589 Some(debug) => debug,
593 if self.impling_types.is_none() {
594 let mut impls = NodeSet();
595 cx.tcx.for_each_impl(debug, |d| {
596 if let Some(ty_def) = cx.tcx.type_of(d).ty_to_def_id() {
597 if let Some(node_id) = cx.tcx.hir.as_local_node_id(ty_def) {
598 impls.insert(node_id);
603 self.impling_types = Some(impls);
604 debug!("{:?}", self.impling_types);
607 if !self.impling_types.as_ref().unwrap().contains(&item.id) {
608 cx.span_lint(MISSING_DEBUG_IMPLEMENTATIONS,
610 "type does not implement `fmt::Debug`; consider adding #[derive(Debug)] \
611 or a manual implementation")
617 pub ANONYMOUS_PARAMETERS,
619 "detects anonymous parameters"
622 /// Checks for use of anonymous parameters (RFC 1685)
624 pub struct AnonymousParameters;
626 impl LintPass for AnonymousParameters {
627 fn get_lints(&self) -> LintArray {
628 lint_array!(ANONYMOUS_PARAMETERS)
632 impl EarlyLintPass for AnonymousParameters {
633 fn check_trait_item(&mut self, cx: &EarlyContext, it: &ast::TraitItem) {
635 ast::TraitItemKind::Method(ref sig, _) => {
636 for arg in sig.decl.inputs.iter() {
638 ast::PatKind::Ident(_, ident, None) => {
639 if ident.name == keywords::Invalid.name() {
640 cx.span_lint(ANONYMOUS_PARAMETERS,
642 "use of deprecated anonymous parameter");
654 /// Checks for use of attributes which have been deprecated.
656 pub struct DeprecatedAttr {
657 // This is not free to compute, so we want to keep it around, rather than
658 // compute it for every attribute.
659 depr_attrs: Vec<&'static (&'static str, AttributeType, AttributeGate)>,
662 impl DeprecatedAttr {
663 pub fn new() -> DeprecatedAttr {
665 depr_attrs: deprecated_attributes(),
670 impl LintPass for DeprecatedAttr {
671 fn get_lints(&self) -> LintArray {
676 impl EarlyLintPass for DeprecatedAttr {
677 fn check_attribute(&mut self, cx: &EarlyContext, attr: &ast::Attribute) {
678 let name = unwrap_or!(attr.name(), return);
679 for &&(n, _, ref g) in &self.depr_attrs {
681 if let &AttributeGate::Gated(Stability::Deprecated(link),
685 let msg = format!("use of deprecated attribute `{}`: {}. See {}",
687 let mut err = cx.struct_span_lint(DEPRECATED, attr.span, &msg);
688 err.span_suggestion_short(attr.span, "remove this attribute", "".to_owned());
698 pub UNUSED_DOC_COMMENT,
700 "detects doc comments that aren't used by rustdoc"
703 #[derive(Copy, Clone)]
704 pub struct UnusedDocComment;
706 impl LintPass for UnusedDocComment {
707 fn get_lints(&self) -> LintArray {
708 lint_array![UNUSED_DOC_COMMENT]
712 impl UnusedDocComment {
713 fn warn_if_doc<'a, 'tcx,
714 I: Iterator<Item=&'a ast::Attribute>,
715 C: LintContext<'tcx>>(&self, mut attrs: I, cx: &C) {
716 if let Some(attr) = attrs.find(|a| a.is_value_str() && a.check_name("doc")) {
717 cx.struct_span_lint(UNUSED_DOC_COMMENT, attr.span, "doc comment not used by rustdoc")
723 impl EarlyLintPass for UnusedDocComment {
724 fn check_local(&mut self, cx: &EarlyContext, decl: &ast::Local) {
725 self.warn_if_doc(decl.attrs.iter(), cx);
728 fn check_arm(&mut self, cx: &EarlyContext, arm: &ast::Arm) {
729 self.warn_if_doc(arm.attrs.iter(), cx);
732 fn check_expr(&mut self, cx: &EarlyContext, expr: &ast::Expr) {
733 self.warn_if_doc(expr.attrs.iter(), cx);
738 pub UNCONDITIONAL_RECURSION,
740 "functions that cannot return without calling themselves"
743 #[derive(Copy, Clone)]
744 pub struct UnconditionalRecursion;
747 impl LintPass for UnconditionalRecursion {
748 fn get_lints(&self) -> LintArray {
749 lint_array![UNCONDITIONAL_RECURSION]
753 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnconditionalRecursion {
754 fn check_fn(&mut self,
761 let method = match fn_kind {
762 FnKind::ItemFn(..) => None,
763 FnKind::Method(..) => {
764 Some(cx.tcx.associated_item(cx.tcx.hir.local_def_id(id)))
766 // closures can't recur, so they don't matter.
767 FnKind::Closure(_) => return,
770 // Walk through this function (say `f`) looking to see if
771 // every possible path references itself, i.e. the function is
772 // called recursively unconditionally. This is done by trying
773 // to find a path from the entry node to the exit node that
774 // *doesn't* call `f` by traversing from the entry while
775 // pretending that calls of `f` are sinks (i.e. ignoring any
776 // exit edges from them).
778 // NB. this has an edge case with non-returning statements,
779 // like `loop {}` or `panic!()`: control flow never reaches
780 // the exit node through these, so one can have a function
781 // that never actually calls itselfs but is still picked up by
784 // fn f(cond: bool) {
785 // if !cond { panic!() } // could come from `assert!(cond)`
789 // In general, functions of that form may be able to call
790 // itself a finite number of times and then diverge. The lint
791 // considers this to be an error for two reasons, (a) it is
792 // easier to implement, and (b) it seems rare to actually want
793 // to have behaviour like the above, rather than
794 // e.g. accidentally recurring after an assert.
796 let cfg = cfg::CFG::new(cx.tcx, &body);
798 let mut work_queue = vec![cfg.entry];
799 let mut reached_exit_without_self_call = false;
800 let mut self_call_spans = vec![];
801 let mut visited = HashSet::new();
803 while let Some(idx) = work_queue.pop() {
806 reached_exit_without_self_call = true;
810 let cfg_id = idx.node_id();
811 if visited.contains(&cfg_id) {
815 visited.insert(cfg_id);
817 // is this a recursive call?
818 let local_id = cfg.graph.node_data(idx).id();
819 if local_id != hir::DUMMY_ITEM_LOCAL_ID {
820 let node_id = cx.tcx.hir.hir_to_node_id(hir::HirId {
821 owner: body.value.hir_id.owner,
824 let self_recursive = match method {
825 Some(ref method) => expr_refers_to_this_method(cx, method, node_id),
826 None => expr_refers_to_this_fn(cx, id, node_id),
829 self_call_spans.push(cx.tcx.hir.span(node_id));
830 // this is a self call, so we shouldn't explore past
831 // this node in the CFG.
836 // add the successors of this node to explore the graph further.
837 for (_, edge) in cfg.graph.outgoing_edges(idx) {
838 let target_idx = edge.target();
839 let target_cfg_id = target_idx.node_id();
840 if !visited.contains(&target_cfg_id) {
841 work_queue.push(target_idx)
846 // Check the number of self calls because a function that
847 // doesn't return (e.g. calls a `-> !` function or `loop { /*
848 // no break */ }`) shouldn't be linted unless it actually
850 if !reached_exit_without_self_call && !self_call_spans.is_empty() {
851 let sp = cx.tcx.sess.codemap().def_span(sp);
852 let mut db = cx.struct_span_lint(UNCONDITIONAL_RECURSION,
854 "function cannot return without recurring");
855 db.span_label(sp, "cannot return without recurring");
856 // offer some help to the programmer.
857 for call in &self_call_spans {
858 db.span_label(*call, "recursive call site");
860 db.help("a `loop` may express intention better if this is on purpose");
867 // Functions for identifying if the given Expr NodeId `id`
868 // represents a call to the function `fn_id`/method `method`.
870 fn expr_refers_to_this_fn(cx: &LateContext, fn_id: ast::NodeId, id: ast::NodeId) -> bool {
871 match cx.tcx.hir.get(id) {
872 hir_map::NodeExpr(&hir::Expr { node: hir::ExprCall(ref callee, _), .. }) => {
873 let def = if let hir::ExprPath(ref qpath) = callee.node {
874 cx.tables.qpath_def(qpath, callee.hir_id)
879 Def::Local(..) | Def::Upvar(..) => false,
880 _ => def.def_id() == cx.tcx.hir.local_def_id(fn_id)
887 // Check if the expression `id` performs a call to `method`.
888 fn expr_refers_to_this_method(cx: &LateContext,
889 method: &ty::AssociatedItem,
892 use rustc::ty::adjustment::*;
894 // Ignore non-expressions.
895 let expr = if let hir_map::NodeExpr(e) = cx.tcx.hir.get(id) {
901 // Check for overloaded autoderef method calls.
902 let mut source = cx.tables.expr_ty(expr);
903 for adjustment in cx.tables.expr_adjustments(expr) {
904 if let Adjust::Deref(Some(deref)) = adjustment.kind {
905 let (def_id, substs) = deref.method_call(cx.tcx, source);
906 if method_call_refers_to_method(cx, method, def_id, substs, id) {
910 source = adjustment.target;
913 // Check for method calls and overloaded operators.
914 if cx.tables.is_method_call(expr) {
915 let hir_id = cx.tcx.hir.definitions().node_to_hir_id(id);
916 let def_id = cx.tables.type_dependent_defs()[hir_id].def_id();
917 let substs = cx.tables.node_substs(hir_id);
918 if method_call_refers_to_method(cx, method, def_id, substs, id) {
923 // Check for calls to methods via explicit paths (e.g. `T::method()`).
925 hir::ExprCall(ref callee, _) => {
926 let def = if let hir::ExprPath(ref qpath) = callee.node {
927 cx.tables.qpath_def(qpath, callee.hir_id)
932 Def::Method(def_id) => {
933 let substs = cx.tables.node_substs(callee.hir_id);
934 method_call_refers_to_method(cx, method, def_id, substs, id)
943 // Check if the method call to the method with the ID `callee_id`
944 // and instantiated with `callee_substs` refers to method `method`.
945 fn method_call_refers_to_method<'a, 'tcx>(cx: &LateContext<'a, 'tcx>,
946 method: &ty::AssociatedItem,
948 callee_substs: &Substs<'tcx>,
949 expr_id: ast::NodeId)
952 let callee_item = tcx.associated_item(callee_id);
954 match callee_item.container {
955 // This is an inherent method, so the `def_id` refers
956 // directly to the method definition.
957 ty::ImplContainer(_) => callee_id == method.def_id,
959 // A trait method, from any number of possible sources.
960 // Attempt to select a concrete impl before checking.
961 ty::TraitContainer(trait_def_id) => {
962 let trait_ref = ty::TraitRef::from_method(tcx, trait_def_id, callee_substs);
963 let trait_ref = ty::Binder::bind(trait_ref);
964 let span = tcx.hir.span(expr_id);
966 traits::Obligation::new(traits::ObligationCause::misc(span, expr_id),
968 trait_ref.to_poly_trait_predicate());
970 tcx.infer_ctxt().enter(|infcx| {
971 let mut selcx = traits::SelectionContext::new(&infcx);
972 match selcx.select(&obligation) {
973 // The method comes from a `T: Trait` bound.
974 // If `T` is `Self`, then this call is inside
975 // a default method definition.
976 Ok(Some(traits::VtableParam(_))) => {
977 let on_self = trait_ref.self_ty().is_self();
978 // We can only be recurring in a default
979 // method if we're being called literally
980 // on the `Self` type.
981 on_self && callee_id == method.def_id
984 // The `impl` is known, so we check that with a
986 Ok(Some(traits::VtableImpl(vtable_impl))) => {
987 let container = ty::ImplContainer(vtable_impl.impl_def_id);
988 // It matches if it comes from the same impl,
989 // and has the same method name.
990 container == method.container && callee_item.name == method.name
993 // There's no way to know if this call is
994 // recursive, so we assume it's not.
1007 "compiler plugin used as ordinary library in non-plugin crate"
1010 #[derive(Copy, Clone)]
1011 pub struct PluginAsLibrary;
1013 impl LintPass for PluginAsLibrary {
1014 fn get_lints(&self) -> LintArray {
1015 lint_array![PLUGIN_AS_LIBRARY]
1019 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for PluginAsLibrary {
1020 fn check_item(&mut self, cx: &LateContext, it: &hir::Item) {
1021 if cx.sess().plugin_registrar_fn.get().is_some() {
1022 // We're compiling a plugin; it's fine to link other plugins.
1027 hir::ItemExternCrate(..) => (),
1031 let def_id = cx.tcx.hir.local_def_id(it.id);
1032 let prfn = match cx.tcx.extern_mod_stmt_cnum(def_id) {
1033 Some(cnum) => cx.tcx.plugin_registrar_fn(cnum),
1035 // Probably means we aren't linking the crate for some reason.
1037 // Not sure if / when this could happen.
1043 cx.span_lint(PLUGIN_AS_LIBRARY,
1045 "compiler plugin used as an ordinary library");
1051 PRIVATE_NO_MANGLE_FNS,
1053 "functions marked #[no_mangle] should be exported"
1057 PRIVATE_NO_MANGLE_STATICS,
1059 "statics marked #[no_mangle] should be exported"
1063 NO_MANGLE_CONST_ITEMS,
1065 "const items will not have their symbols exported"
1069 NO_MANGLE_GENERIC_ITEMS,
1071 "generic items must be mangled"
1074 #[derive(Copy, Clone)]
1075 pub struct InvalidNoMangleItems;
1077 impl LintPass for InvalidNoMangleItems {
1078 fn get_lints(&self) -> LintArray {
1079 lint_array!(PRIVATE_NO_MANGLE_FNS,
1080 PRIVATE_NO_MANGLE_STATICS,
1081 NO_MANGLE_CONST_ITEMS,
1082 NO_MANGLE_GENERIC_ITEMS)
1086 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for InvalidNoMangleItems {
1087 fn check_item(&mut self, cx: &LateContext, it: &hir::Item) {
1089 hir::ItemFn(.., ref generics, _) => {
1090 if let Some(no_mangle_attr) = attr::find_by_name(&it.attrs, "no_mangle") {
1091 if attr::contains_name(&it.attrs, "linkage") {
1094 if !cx.access_levels.is_reachable(it.id) {
1095 let msg = "function is marked #[no_mangle], but not exported";
1096 let mut err = cx.struct_span_lint(PRIVATE_NO_MANGLE_FNS, it.span, msg);
1097 let insertion_span = it.span.shrink_to_lo();
1098 if it.vis == hir::Visibility::Inherited {
1099 err.span_suggestion(insertion_span,
1100 "try making it public",
1105 if generics.is_type_parameterized() {
1106 let mut err = cx.struct_span_lint(NO_MANGLE_GENERIC_ITEMS,
1108 "functions generic over \
1109 types must be mangled");
1110 err.span_suggestion_short(no_mangle_attr.span,
1111 "remove this attribute",
1117 hir::ItemStatic(..) => {
1118 if attr::contains_name(&it.attrs, "no_mangle") &&
1119 !cx.access_levels.is_reachable(it.id) {
1120 let msg = "static is marked #[no_mangle], but not exported";
1121 let mut err = cx.struct_span_lint(PRIVATE_NO_MANGLE_STATICS, it.span, msg);
1122 let insertion_span = it.span.shrink_to_lo();
1123 if it.vis == hir::Visibility::Inherited {
1124 err.span_suggestion(insertion_span,
1125 "try making it public",
1131 hir::ItemConst(..) => {
1132 if attr::contains_name(&it.attrs, "no_mangle") {
1133 // Const items do not refer to a particular location in memory, and therefore
1134 // don't have anything to attach a symbol to
1135 let msg = "const items should never be #[no_mangle]";
1136 let mut err = cx.struct_span_lint(NO_MANGLE_CONST_ITEMS, it.span, msg);
1138 // account for "pub const" (#45562)
1139 let start = cx.tcx.sess.codemap().span_to_snippet(it.span)
1140 .map(|snippet| snippet.find("const").unwrap_or(0))
1141 .unwrap_or(0) as u32;
1142 // `const` is 5 chars
1143 let const_span = it.span.with_hi(BytePos(it.span.lo().0 + start + 5));
1144 err.span_suggestion(const_span,
1145 "try a static value",
1146 "pub static".to_owned());
1155 #[derive(Clone, Copy)]
1156 pub struct MutableTransmutes;
1161 "mutating transmuted &mut T from &T may cause undefined behavior"
1164 impl LintPass for MutableTransmutes {
1165 fn get_lints(&self) -> LintArray {
1166 lint_array!(MUTABLE_TRANSMUTES)
1170 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MutableTransmutes {
1171 fn check_expr(&mut self, cx: &LateContext, expr: &hir::Expr) {
1172 use syntax::abi::Abi::RustIntrinsic;
1174 let msg = "mutating transmuted &mut T from &T may cause undefined behavior, \
1175 consider instead using an UnsafeCell";
1176 match get_transmute_from_to(cx, expr) {
1177 Some((&ty::TyRef(_, from_mt), &ty::TyRef(_, to_mt))) => {
1178 if to_mt.mutbl == hir::Mutability::MutMutable &&
1179 from_mt.mutbl == hir::Mutability::MutImmutable {
1180 cx.span_lint(MUTABLE_TRANSMUTES, expr.span, msg);
1186 fn get_transmute_from_to<'a, 'tcx>
1187 (cx: &LateContext<'a, 'tcx>,
1189 -> Option<(&'tcx ty::TypeVariants<'tcx>, &'tcx ty::TypeVariants<'tcx>)> {
1190 let def = if let hir::ExprPath(ref qpath) = expr.node {
1191 cx.tables.qpath_def(qpath, expr.hir_id)
1195 if let Def::Fn(did) = def {
1196 if !def_id_is_transmute(cx, did) {
1199 let sig = cx.tables.node_id_to_type(expr.hir_id).fn_sig(cx.tcx);
1200 let from = sig.inputs().skip_binder()[0];
1201 let to = *sig.output().skip_binder();
1202 return Some((&from.sty, &to.sty));
1207 fn def_id_is_transmute(cx: &LateContext, def_id: DefId) -> bool {
1208 cx.tcx.fn_sig(def_id).abi() == RustIntrinsic &&
1209 cx.tcx.item_name(def_id) == "transmute"
1214 /// Forbids using the `#[feature(...)]` attribute
1215 #[derive(Copy, Clone)]
1216 pub struct UnstableFeatures;
1221 "enabling unstable features (deprecated. do not use)"
1224 impl LintPass for UnstableFeatures {
1225 fn get_lints(&self) -> LintArray {
1226 lint_array!(UNSTABLE_FEATURES)
1230 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnstableFeatures {
1231 fn check_attribute(&mut self, ctx: &LateContext, attr: &ast::Attribute) {
1232 if attr.check_name("feature") {
1233 if let Some(items) = attr.meta_item_list() {
1235 ctx.span_lint(UNSTABLE_FEATURES, item.span(), "unstable feature");
1242 /// Lint for unions that contain fields with possibly non-trivial destructors.
1243 pub struct UnionsWithDropFields;
1246 UNIONS_WITH_DROP_FIELDS,
1248 "use of unions that contain fields with possibly non-trivial drop code"
1251 impl LintPass for UnionsWithDropFields {
1252 fn get_lints(&self) -> LintArray {
1253 lint_array!(UNIONS_WITH_DROP_FIELDS)
1257 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnionsWithDropFields {
1258 fn check_item(&mut self, ctx: &LateContext, item: &hir::Item) {
1259 if let hir::ItemUnion(ref vdata, _) = item.node {
1260 for field in vdata.fields() {
1261 let field_ty = ctx.tcx.type_of(ctx.tcx.hir.local_def_id(field.id));
1262 if field_ty.needs_drop(ctx.tcx, ctx.param_env) {
1263 ctx.span_lint(UNIONS_WITH_DROP_FIELDS,
1265 "union contains a field with possibly non-trivial drop code, \
1266 drop code of union fields is ignored when dropping the union");
1274 /// Lint for items marked `pub` that aren't reachable from other crates
1275 pub struct UnreachablePub;
1278 pub UNREACHABLE_PUB,
1280 "`pub` items not reachable from crate root"
1283 impl LintPass for UnreachablePub {
1284 fn get_lints(&self) -> LintArray {
1285 lint_array!(UNREACHABLE_PUB)
1289 impl UnreachablePub {
1290 fn perform_lint(&self, cx: &LateContext, what: &str, id: ast::NodeId,
1291 vis: &hir::Visibility, span: Span, exportable: bool) {
1292 if !cx.access_levels.is_reachable(id) && *vis == hir::Visibility::Public {
1293 let def_span = cx.tcx.sess.codemap().def_span(span);
1294 let mut err = cx.struct_span_lint(UNREACHABLE_PUB, def_span,
1295 &format!("unreachable `pub` {}", what));
1296 // visibility is token at start of declaration (can be macro
1297 // variable rather than literal `pub`)
1298 let pub_span = cx.tcx.sess.codemap().span_until_char(def_span, ' ');
1299 let replacement = if cx.tcx.features().crate_visibility_modifier {
1304 err.span_suggestion(pub_span, "consider restricting its visibility", replacement);
1306 err.help("or consider exporting it for use by other crates");
1313 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnreachablePub {
1314 fn check_item(&mut self, cx: &LateContext, item: &hir::Item) {
1315 self.perform_lint(cx, "item", item.id, &item.vis, item.span, true);
1318 fn check_foreign_item(&mut self, cx: &LateContext, foreign_item: &hir::ForeignItem) {
1319 self.perform_lint(cx, "item", foreign_item.id, &foreign_item.vis, foreign_item.span, true);
1322 fn check_struct_field(&mut self, cx: &LateContext, field: &hir::StructField) {
1323 self.perform_lint(cx, "field", field.id, &field.vis, field.span, false);
1326 fn check_impl_item(&mut self, cx: &LateContext, impl_item: &hir::ImplItem) {
1327 self.perform_lint(cx, "item", impl_item.id, &impl_item.vis, impl_item.span, false);
1331 /// Lint for trait and lifetime bounds in type aliases being mostly ignored:
1332 /// They are relevant when using associated types, but otherwise neither checked
1333 /// at definition site nor enforced at use site.
1335 pub struct TypeAliasBounds;
1340 "bounds in type aliases are not enforced"
1343 impl LintPass for TypeAliasBounds {
1344 fn get_lints(&self) -> LintArray {
1345 lint_array!(TYPE_ALIAS_BOUNDS)
1349 impl TypeAliasBounds {
1350 fn is_type_variable_assoc(qpath: &hir::QPath) -> bool {
1352 hir::QPath::TypeRelative(ref ty, _) => {
1353 // If this is a type variable, we found a `T::Assoc`.
1355 hir::TyPath(hir::QPath::Resolved(None, ref path)) => {
1357 Def::TyParam(_) => true,
1364 hir::QPath::Resolved(..) => false,
1368 fn suggest_changing_assoc_types(ty: &hir::Ty, err: &mut DiagnosticBuilder) {
1369 // Access to associates types should use `<T as Bound>::Assoc`, which does not need a
1370 // bound. Let's see if this type does that.
1372 // We use a HIR visitor to walk the type.
1373 use rustc::hir::intravisit::{self, Visitor};
1374 use syntax::ast::NodeId;
1375 struct WalkAssocTypes<'a, 'db> where 'db: 'a {
1376 err: &'a mut DiagnosticBuilder<'db>
1378 impl<'a, 'db, 'v> Visitor<'v> for WalkAssocTypes<'a, 'db> {
1379 fn nested_visit_map<'this>(&'this mut self) -> intravisit::NestedVisitorMap<'this, 'v>
1381 intravisit::NestedVisitorMap::None
1384 fn visit_qpath(&mut self, qpath: &'v hir::QPath, id: NodeId, span: Span) {
1385 if TypeAliasBounds::is_type_variable_assoc(qpath) {
1386 self.err.span_help(span,
1387 "use fully disambiguated paths (i.e., `<T as Trait>::Assoc`) to refer to \
1388 associated types in type aliases");
1390 intravisit::walk_qpath(self, qpath, id, span)
1394 // Let's go for a walk!
1395 let mut visitor = WalkAssocTypes { err };
1396 visitor.visit_ty(ty);
1400 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for TypeAliasBounds {
1401 fn check_item(&mut self, cx: &LateContext, item: &hir::Item) {
1402 let (ty, type_alias_generics) = match item.node {
1403 hir::ItemTy(ref ty, ref generics) => (&*ty, generics),
1406 let mut suggested_changing_assoc_types = false;
1407 // There must not be a where clause
1408 if !type_alias_generics.where_clause.predicates.is_empty() {
1409 let spans : Vec<_> = type_alias_generics.where_clause.predicates.iter()
1410 .map(|pred| pred.span()).collect();
1411 let mut err = cx.struct_span_lint(TYPE_ALIAS_BOUNDS, spans,
1412 "where clauses are not enforced in type aliases");
1413 err.help("the clause will not be checked when the type alias is used, \
1414 and should be removed");
1415 if !suggested_changing_assoc_types {
1416 TypeAliasBounds::suggest_changing_assoc_types(ty, &mut err);
1417 suggested_changing_assoc_types = true;
1421 // The parameters must not have bounds
1422 for param in type_alias_generics.params.iter() {
1423 let spans : Vec<_> = match param {
1424 &hir::GenericParam::Lifetime(ref l) => l.bounds.iter().map(|b| b.span).collect(),
1425 &hir::GenericParam::Type(ref ty) => ty.bounds.iter().map(|b| b.span()).collect(),
1427 if !spans.is_empty() {
1428 let mut err = cx.struct_span_lint(
1431 "bounds on generic parameters are not enforced in type aliases",
1433 err.help("the bound will not be checked when the type alias is used, \
1434 and should be removed");
1435 if !suggested_changing_assoc_types {
1436 TypeAliasBounds::suggest_changing_assoc_types(ty, &mut err);
1437 suggested_changing_assoc_types = true;
1445 /// Lint constants that are erroneous.
1446 /// Without this lint, we might not get any diagnostic if the constant is
1447 /// unused within this crate, even though downstream crates can't use it
1448 /// without producing an error.
1449 pub struct UnusedBrokenConst;
1451 impl LintPass for UnusedBrokenConst {
1452 fn get_lints(&self) -> LintArray {
1457 fn check_const(cx: &LateContext, body_id: hir::BodyId, what: &str) {
1458 let def_id = cx.tcx.hir.body_owner_def_id(body_id);
1459 let param_env = cx.tcx.param_env(def_id);
1460 let cid = ::rustc::mir::interpret::GlobalId {
1461 instance: ty::Instance::mono(cx.tcx, def_id),
1464 if let Err(err) = cx.tcx.const_eval(param_env.and(cid)) {
1465 let span = cx.tcx.def_span(def_id);
1466 let mut diag = cx.struct_span_lint(
1469 &format!("this {} cannot be used", what),
1471 use rustc::middle::const_val::ConstEvalErrDescription;
1472 match err.description() {
1473 ConstEvalErrDescription::Simple(message) => {
1474 diag.span_label(span, message);
1476 ConstEvalErrDescription::Backtrace(miri, frames) => {
1477 diag.span_label(span, format!("{}", miri));
1478 for frame in frames {
1479 diag.span_label(frame.span, format!("inside call to `{}`", frame.location));
1487 struct UnusedBrokenConstVisitor<'a, 'tcx: 'a>(&'a LateContext<'a, 'tcx>);
1489 impl<'a, 'tcx, 'v> hir::intravisit::Visitor<'v> for UnusedBrokenConstVisitor<'a, 'tcx> {
1490 fn visit_nested_body(&mut self, id: hir::BodyId) {
1491 check_const(self.0, id, "array length");
1493 fn nested_visit_map<'this>(&'this mut self) -> hir::intravisit::NestedVisitorMap<'this, 'v> {
1494 hir::intravisit::NestedVisitorMap::None
1498 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnusedBrokenConst {
1499 fn check_item(&mut self, cx: &LateContext, it: &hir::Item) {
1501 hir::ItemConst(_, body_id) => {
1502 check_const(cx, body_id, "constant");
1504 hir::ItemTy(ref ty, _) => hir::intravisit::walk_ty(
1505 &mut UnusedBrokenConstVisitor(cx),