]> git.lizzy.rs Git - rust.git/blob - src/librustc_privacy/lib.rs
Tell LLVM when a match is exhaustive
[rust.git] / src / librustc_privacy / lib.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 // Do not remove on snapshot creation. Needed for bootstrap. (Issue #22364)
12 #![cfg_attr(stage0, feature(custom_attribute))]
13 #![crate_name = "rustc_privacy"]
14 #![unstable(feature = "rustc_private", issue = "27812")]
15 #![staged_api]
16 #![crate_type = "dylib"]
17 #![crate_type = "rlib"]
18 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
19       html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
20       html_root_url = "https://doc.rust-lang.org/nightly/")]
21
22 #![feature(rustc_diagnostic_macros)]
23 #![feature(rustc_private)]
24 #![feature(staged_api)]
25
26 #[macro_use] extern crate log;
27 #[macro_use] extern crate syntax;
28
29 extern crate rustc;
30 extern crate rustc_front;
31
32 use self::PrivacyResult::*;
33 use self::FieldName::*;
34
35 use std::mem::replace;
36
37 use rustc_front::hir;
38 use rustc_front::visit::{self, Visitor};
39
40 use rustc::middle::def;
41 use rustc::middle::def_id::DefId;
42 use rustc::middle::privacy::ImportUse::*;
43 use rustc::middle::privacy::LastPrivate::*;
44 use rustc::middle::privacy::PrivateDep::*;
45 use rustc::middle::privacy::{ExternalExports, ExportedItems, PublicItems};
46 use rustc::middle::ty::{self, Ty};
47 use rustc::util::nodemap::{NodeMap, NodeSet};
48 use rustc::front::map as ast_map;
49
50 use syntax::ast;
51 use syntax::codemap::Span;
52
53 pub mod diagnostics;
54
55 type Context<'a, 'tcx> = (&'a ty::MethodMap<'tcx>, &'a def::ExportMap);
56
57 /// Result of a checking operation - None => no errors were found. Some => an
58 /// error and contains the span and message for reporting that error and
59 /// optionally the same for a note about the error.
60 type CheckResult = Option<(Span, String, Option<(Span, String)>)>;
61
62 ////////////////////////////////////////////////////////////////////////////////
63 /// The parent visitor, used to determine what's the parent of what (node-wise)
64 ////////////////////////////////////////////////////////////////////////////////
65
66 struct ParentVisitor {
67     parents: NodeMap<ast::NodeId>,
68     curparent: ast::NodeId,
69 }
70
71 impl<'v> Visitor<'v> for ParentVisitor {
72     fn visit_item(&mut self, item: &hir::Item) {
73         self.parents.insert(item.id, self.curparent);
74
75         let prev = self.curparent;
76         match item.node {
77             hir::ItemMod(..) => { self.curparent = item.id; }
78             // Enum variants are parented to the enum definition itself because
79             // they inherit privacy
80             hir::ItemEnum(ref def, _) => {
81                 for variant in &def.variants {
82                     // The parent is considered the enclosing enum because the
83                     // enum will dictate the privacy visibility of this variant
84                     // instead.
85                     self.parents.insert(variant.node.id, item.id);
86                 }
87             }
88
89             // Trait methods are always considered "public", but if the trait is
90             // private then we need some private item in the chain from the
91             // method to the root. In this case, if the trait is private, then
92             // parent all the methods to the trait to indicate that they're
93             // private.
94             hir::ItemTrait(_, _, _, ref trait_items) if item.vis != hir::Public => {
95                 for trait_item in trait_items {
96                     self.parents.insert(trait_item.id, item.id);
97                 }
98             }
99
100             _ => {}
101         }
102         visit::walk_item(self, item);
103         self.curparent = prev;
104     }
105
106     fn visit_foreign_item(&mut self, a: &hir::ForeignItem) {
107         self.parents.insert(a.id, self.curparent);
108         visit::walk_foreign_item(self, a);
109     }
110
111     fn visit_fn(&mut self, a: visit::FnKind<'v>, b: &'v hir::FnDecl,
112                 c: &'v hir::Block, d: Span, id: ast::NodeId) {
113         // We already took care of some trait methods above, otherwise things
114         // like impl methods and pub trait methods are parented to the
115         // containing module, not the containing trait.
116         if !self.parents.contains_key(&id) {
117             self.parents.insert(id, self.curparent);
118         }
119         visit::walk_fn(self, a, b, c, d);
120     }
121
122     fn visit_impl_item(&mut self, ii: &'v hir::ImplItem) {
123         // visit_fn handles methods, but associated consts have to be handled
124         // here.
125         if !self.parents.contains_key(&ii.id) {
126             self.parents.insert(ii.id, self.curparent);
127         }
128         visit::walk_impl_item(self, ii);
129     }
130
131     fn visit_struct_def(&mut self, s: &hir::StructDef, _: ast::Name,
132                         _: &'v hir::Generics, n: ast::NodeId) {
133         // Struct constructors are parented to their struct definitions because
134         // they essentially are the struct definitions.
135         match s.ctor_id {
136             Some(id) => { self.parents.insert(id, n); }
137             None => {}
138         }
139
140         // While we have the id of the struct definition, go ahead and parent
141         // all the fields.
142         for field in &s.fields {
143             self.parents.insert(field.node.id, self.curparent);
144         }
145         visit::walk_struct_def(self, s)
146     }
147 }
148
149 ////////////////////////////////////////////////////////////////////////////////
150 /// The embargo visitor, used to determine the exports of the ast
151 ////////////////////////////////////////////////////////////////////////////////
152
153 struct EmbargoVisitor<'a, 'tcx: 'a> {
154     tcx: &'a ty::ctxt<'tcx>,
155     export_map: &'a def::ExportMap,
156
157     // This flag is an indicator of whether the previous item in the
158     // hierarchical chain was exported or not. This is the indicator of whether
159     // children should be exported as well. Note that this can flip from false
160     // to true if a reexported module is entered (or an action similar).
161     prev_exported: bool,
162
163     // This is a list of all exported items in the AST. An exported item is any
164     // function/method/item which is usable by external crates. This essentially
165     // means that the result is "public all the way down", but the "path down"
166     // may jump across private boundaries through reexport statements.
167     exported_items: ExportedItems,
168
169     // This sets contains all the destination nodes which are publicly
170     // re-exported. This is *not* a set of all reexported nodes, only a set of
171     // all nodes which are reexported *and* reachable from external crates. This
172     // means that the destination of the reexport is exported, and hence the
173     // destination must also be exported.
174     reexports: NodeSet,
175
176     // These two fields are closely related to one another in that they are only
177     // used for generation of the 'PublicItems' set, not for privacy checking at
178     // all
179     public_items: PublicItems,
180     prev_public: bool,
181 }
182
183 impl<'a, 'tcx> EmbargoVisitor<'a, 'tcx> {
184     // There are checks inside of privacy which depend on knowing whether a
185     // trait should be exported or not. The two current consumers of this are:
186     //
187     //  1. Should default methods of a trait be exported?
188     //  2. Should the methods of an implementation of a trait be exported?
189     //
190     // The answer to both of these questions partly rely on whether the trait
191     // itself is exported or not. If the trait is somehow exported, then the
192     // answers to both questions must be yes. Right now this question involves
193     // more analysis than is currently done in rustc, so we conservatively
194     // answer "yes" so that all traits need to be exported.
195     fn exported_trait(&self, _id: ast::NodeId) -> bool {
196         true
197     }
198 }
199
200 impl<'a, 'tcx, 'v> Visitor<'v> for EmbargoVisitor<'a, 'tcx> {
201     fn visit_item(&mut self, item: &hir::Item) {
202         let orig_all_pub = self.prev_public;
203         self.prev_public = orig_all_pub && item.vis == hir::Public;
204         if self.prev_public {
205             self.public_items.insert(item.id);
206         }
207
208         let orig_all_exported = self.prev_exported;
209         match item.node {
210             // impls/extern blocks do not break the "public chain" because they
211             // cannot have visibility qualifiers on them anyway
212             hir::ItemImpl(..) | hir::ItemDefaultImpl(..) | hir::ItemForeignMod(..) => {}
213
214             // Traits are a little special in that even if they themselves are
215             // not public they may still be exported.
216             hir::ItemTrait(..) => {
217                 self.prev_exported = self.exported_trait(item.id);
218             }
219
220             // Private by default, hence we only retain the "public chain" if
221             // `pub` is explicitly listed.
222             _ => {
223                 self.prev_exported =
224                     (orig_all_exported && item.vis == hir::Public) ||
225                      self.reexports.contains(&item.id);
226             }
227         }
228
229         let public_first = self.prev_exported &&
230                            self.exported_items.insert(item.id);
231
232         match item.node {
233             // Enum variants inherit from their parent, so if the enum is
234             // public all variants are public unless they're explicitly priv
235             hir::ItemEnum(ref def, _) if public_first => {
236                 for variant in &def.variants {
237                     self.exported_items.insert(variant.node.id);
238                     self.public_items.insert(variant.node.id);
239                 }
240             }
241
242             // Implementations are a little tricky to determine what's exported
243             // out of them. Here's a few cases which are currently defined:
244             //
245             // * Impls for private types do not need to export their methods
246             //   (either public or private methods)
247             //
248             // * Impls for public types only have public methods exported
249             //
250             // * Public trait impls for public types must have all methods
251             //   exported.
252             //
253             // * Private trait impls for public types can be ignored
254             //
255             // * Public trait impls for private types have their methods
256             //   exported. I'm not entirely certain that this is the correct
257             //   thing to do, but I have seen use cases of where this will cause
258             //   undefined symbols at linkage time if this case is not handled.
259             //
260             // * Private trait impls for private types can be completely ignored
261             hir::ItemImpl(_, _, _, _, ref ty, ref impl_items) => {
262                 let public_ty = match ty.node {
263                     hir::TyPath(..) => {
264                         match self.tcx.def_map.borrow().get(&ty.id).unwrap().full_def() {
265                             def::DefPrimTy(..) => true,
266                             def => {
267                                 let did = def.def_id();
268                                 !did.is_local() ||
269                                  self.exported_items.contains(&did.node)
270                             }
271                         }
272                     }
273                     _ => true,
274                 };
275                 let tr = self.tcx.impl_trait_ref(DefId::local(item.id));
276                 let public_trait = tr.clone().map_or(false, |tr| {
277                     !tr.def_id.is_local() ||
278                      self.exported_items.contains(&tr.def_id.node)
279                 });
280
281                 if public_ty || public_trait {
282                     for impl_item in impl_items {
283                         match impl_item.node {
284                             hir::ConstImplItem(..) => {
285                                 if (public_ty && impl_item.vis == hir::Public)
286                                     || tr.is_some() {
287                                     self.exported_items.insert(impl_item.id);
288                                 }
289                             }
290                             hir::MethodImplItem(ref sig, _) => {
291                                 let meth_public = match sig.explicit_self.node {
292                                     hir::SelfStatic => public_ty,
293                                     _ => true,
294                                 } && impl_item.vis == hir::Public;
295                                 if meth_public || tr.is_some() {
296                                     self.exported_items.insert(impl_item.id);
297                                 }
298                             }
299                             hir::TypeImplItem(_) => {}
300                         }
301                     }
302                 }
303             }
304
305             // Default methods on traits are all public so long as the trait
306             // is public
307             hir::ItemTrait(_, _, _, ref trait_items) if public_first => {
308                 for trait_item in trait_items {
309                     debug!("trait item {}", trait_item.id);
310                     self.exported_items.insert(trait_item.id);
311                 }
312             }
313
314             // Struct constructors are public if the struct is all public.
315             hir::ItemStruct(ref def, _) if public_first => {
316                 match def.ctor_id {
317                     Some(id) => { self.exported_items.insert(id); }
318                     None => {}
319                 }
320                 // fields can be public or private, so lets check
321                 for field in &def.fields {
322                     let vis = match field.node.kind {
323                         hir::NamedField(_, vis) | hir::UnnamedField(vis) => vis
324                     };
325                     if vis == hir::Public {
326                         self.public_items.insert(field.node.id);
327                     }
328                 }
329             }
330
331             hir::ItemTy(ref ty, _) if public_first => {
332                 if let hir::TyPath(..) = ty.node {
333                     match self.tcx.def_map.borrow().get(&ty.id).unwrap().full_def() {
334                         def::DefPrimTy(..) | def::DefTyParam(..) => {},
335                         def => {
336                             let did = def.def_id();
337                             if did.is_local() {
338                                 self.exported_items.insert(did.node);
339                             }
340                         }
341                     }
342                 }
343             }
344
345             _ => {}
346         }
347
348         visit::walk_item(self, item);
349
350         self.prev_exported = orig_all_exported;
351         self.prev_public = orig_all_pub;
352     }
353
354     fn visit_foreign_item(&mut self, a: &hir::ForeignItem) {
355         if (self.prev_exported && a.vis == hir::Public) || self.reexports.contains(&a.id) {
356             self.exported_items.insert(a.id);
357         }
358     }
359
360     fn visit_mod(&mut self, m: &hir::Mod, _sp: Span, id: ast::NodeId) {
361         // This code is here instead of in visit_item so that the
362         // crate module gets processed as well.
363         if self.prev_exported {
364             assert!(self.export_map.contains_key(&id), "wut {}", id);
365             for export in self.export_map.get(&id).unwrap() {
366                 if export.def_id.is_local() {
367                     self.reexports.insert(export.def_id.node);
368                 }
369             }
370         }
371         visit::walk_mod(self, m)
372     }
373 }
374
375 ////////////////////////////////////////////////////////////////////////////////
376 /// The privacy visitor, where privacy checks take place (violations reported)
377 ////////////////////////////////////////////////////////////////////////////////
378
379 struct PrivacyVisitor<'a, 'tcx: 'a> {
380     tcx: &'a ty::ctxt<'tcx>,
381     curitem: ast::NodeId,
382     in_foreign: bool,
383     parents: NodeMap<ast::NodeId>,
384     external_exports: ExternalExports,
385 }
386
387 enum PrivacyResult {
388     Allowable,
389     ExternallyDenied,
390     DisallowedBy(ast::NodeId),
391 }
392
393 enum FieldName {
394     UnnamedField(usize), // index
395     // (Name, not Ident, because struct fields are not macro-hygienic)
396     NamedField(ast::Name),
397 }
398
399 impl<'a, 'tcx> PrivacyVisitor<'a, 'tcx> {
400     // used when debugging
401     fn nodestr(&self, id: ast::NodeId) -> String {
402         self.tcx.map.node_to_string(id).to_string()
403     }
404
405     // Determines whether the given definition is public from the point of view
406     // of the current item.
407     fn def_privacy(&self, did: DefId) -> PrivacyResult {
408         if !did.is_local() {
409             if self.external_exports.contains(&did) {
410                 debug!("privacy - {:?} was externally exported", did);
411                 return Allowable;
412             }
413             debug!("privacy - is {:?} a public method", did);
414
415             return match self.tcx.impl_or_trait_items.borrow().get(&did) {
416                 Some(&ty::ConstTraitItem(ref ac)) => {
417                     debug!("privacy - it's a const: {:?}", *ac);
418                     match ac.container {
419                         ty::TraitContainer(id) => {
420                             debug!("privacy - recursing on trait {:?}", id);
421                             self.def_privacy(id)
422                         }
423                         ty::ImplContainer(id) => {
424                             match self.tcx.impl_trait_ref(id) {
425                                 Some(t) => {
426                                     debug!("privacy - impl of trait {:?}", id);
427                                     self.def_privacy(t.def_id)
428                                 }
429                                 None => {
430                                     debug!("privacy - found inherent \
431                                             associated constant {:?}",
432                                             ac.vis);
433                                     if ac.vis == hir::Public {
434                                         Allowable
435                                     } else {
436                                         ExternallyDenied
437                                     }
438                                 }
439                             }
440                         }
441                     }
442                 }
443                 Some(&ty::MethodTraitItem(ref meth)) => {
444                     debug!("privacy - well at least it's a method: {:?}",
445                            *meth);
446                     match meth.container {
447                         ty::TraitContainer(id) => {
448                             debug!("privacy - recursing on trait {:?}", id);
449                             self.def_privacy(id)
450                         }
451                         ty::ImplContainer(id) => {
452                             match self.tcx.impl_trait_ref(id) {
453                                 Some(t) => {
454                                     debug!("privacy - impl of trait {:?}", id);
455                                     self.def_privacy(t.def_id)
456                                 }
457                                 None => {
458                                     debug!("privacy - found a method {:?}",
459                                             meth.vis);
460                                     if meth.vis == hir::Public {
461                                         Allowable
462                                     } else {
463                                         ExternallyDenied
464                                     }
465                                 }
466                             }
467                         }
468                     }
469                 }
470                 Some(&ty::TypeTraitItem(ref typedef)) => {
471                     match typedef.container {
472                         ty::TraitContainer(id) => {
473                             debug!("privacy - recursing on trait {:?}", id);
474                             self.def_privacy(id)
475                         }
476                         ty::ImplContainer(id) => {
477                             match self.tcx.impl_trait_ref(id) {
478                                 Some(t) => {
479                                     debug!("privacy - impl of trait {:?}", id);
480                                     self.def_privacy(t.def_id)
481                                 }
482                                 None => {
483                                     debug!("privacy - found a typedef {:?}",
484                                             typedef.vis);
485                                     if typedef.vis == hir::Public {
486                                         Allowable
487                                     } else {
488                                         ExternallyDenied
489                                     }
490                                 }
491                             }
492                         }
493                     }
494                 }
495                 None => {
496                     debug!("privacy - nope, not even a method");
497                     ExternallyDenied
498                 }
499             };
500         }
501
502         debug!("privacy - local {} not public all the way down",
503                self.tcx.map.node_to_string(did.node));
504         // return quickly for things in the same module
505         if self.parents.get(&did.node) == self.parents.get(&self.curitem) {
506             debug!("privacy - same parent, we're done here");
507             return Allowable;
508         }
509
510         // We now know that there is at least one private member between the
511         // destination and the root.
512         let mut closest_private_id = did.node;
513         loop {
514             debug!("privacy - examining {}", self.nodestr(closest_private_id));
515             let vis = match self.tcx.map.find(closest_private_id) {
516                 // If this item is a method, then we know for sure that it's an
517                 // actual method and not a static method. The reason for this is
518                 // that these cases are only hit in the ExprMethodCall
519                 // expression, and ExprCall will have its path checked later
520                 // (the path of the trait/impl) if it's a static method.
521                 //
522                 // With this information, then we can completely ignore all
523                 // trait methods. The privacy violation would be if the trait
524                 // couldn't get imported, not if the method couldn't be used
525                 // (all trait methods are public).
526                 //
527                 // However, if this is an impl method, then we dictate this
528                 // decision solely based on the privacy of the method
529                 // invocation.
530                 // FIXME(#10573) is this the right behavior? Why not consider
531                 //               where the method was defined?
532                 Some(ast_map::NodeImplItem(ii)) => {
533                     match ii.node {
534                         hir::ConstImplItem(..) |
535                         hir::MethodImplItem(..) => {
536                             let imp = self.tcx.map
537                                           .get_parent_did(closest_private_id);
538                             match self.tcx.impl_trait_ref(imp) {
539                                 Some(..) => return Allowable,
540                                 _ if ii.vis == hir::Public => {
541                                     return Allowable
542                                 }
543                                 _ => ii.vis
544                             }
545                         }
546                         hir::TypeImplItem(_) => return Allowable,
547                     }
548                 }
549                 Some(ast_map::NodeTraitItem(_)) => {
550                     return Allowable;
551                 }
552
553                 // This is not a method call, extract the visibility as one
554                 // would normally look at it
555                 Some(ast_map::NodeItem(it)) => it.vis,
556                 Some(ast_map::NodeForeignItem(_)) => {
557                     self.tcx.map.get_foreign_vis(closest_private_id)
558                 }
559                 Some(ast_map::NodeVariant(..)) => {
560                     hir::Public // need to move up a level (to the enum)
561                 }
562                 _ => hir::Public,
563             };
564             if vis != hir::Public { break }
565             // if we've reached the root, then everything was allowable and this
566             // access is public.
567             if closest_private_id == ast::CRATE_NODE_ID { return Allowable }
568             closest_private_id = *self.parents.get(&closest_private_id).unwrap();
569
570             // If we reached the top, then we were public all the way down and
571             // we can allow this access.
572             if closest_private_id == ast::DUMMY_NODE_ID { return Allowable }
573         }
574         debug!("privacy - closest priv {}", self.nodestr(closest_private_id));
575         if self.private_accessible(closest_private_id) {
576             Allowable
577         } else {
578             DisallowedBy(closest_private_id)
579         }
580     }
581
582     /// For a local private node in the AST, this function will determine
583     /// whether the node is accessible by the current module that iteration is
584     /// inside.
585     fn private_accessible(&self, id: ast::NodeId) -> bool {
586         let parent = *self.parents.get(&id).unwrap();
587         debug!("privacy - accessible parent {}", self.nodestr(parent));
588
589         // After finding `did`'s closest private member, we roll ourselves back
590         // to see if this private member's parent is anywhere in our ancestry.
591         // By the privacy rules, we can access all of our ancestor's private
592         // members, so that's why we test the parent, and not the did itself.
593         let mut cur = self.curitem;
594         loop {
595             debug!("privacy - questioning {}, {}", self.nodestr(cur), cur);
596             match cur {
597                 // If the relevant parent is in our history, then we're allowed
598                 // to look inside any of our ancestor's immediate private items,
599                 // so this access is valid.
600                 x if x == parent => return true,
601
602                 // If we've reached the root, then we couldn't access this item
603                 // in the first place
604                 ast::DUMMY_NODE_ID => return false,
605
606                 // Keep going up
607                 _ => {}
608             }
609
610             cur = *self.parents.get(&cur).unwrap();
611         }
612     }
613
614     fn report_error(&self, result: CheckResult) -> bool {
615         match result {
616             None => true,
617             Some((span, msg, note)) => {
618                 self.tcx.sess.span_err(span, &msg[..]);
619                 match note {
620                     Some((span, msg)) => {
621                         self.tcx.sess.span_note(span, &msg[..])
622                     }
623                     None => {},
624                 }
625                 false
626             },
627         }
628     }
629
630     /// Guarantee that a particular definition is public. Returns a CheckResult
631     /// which contains any errors found. These can be reported using `report_error`.
632     /// If the result is `None`, no errors were found.
633     fn ensure_public(&self, span: Span, to_check: DefId,
634                      source_did: Option<DefId>, msg: &str) -> CheckResult {
635         let id = match self.def_privacy(to_check) {
636             ExternallyDenied => {
637                 return Some((span, format!("{} is private", msg), None))
638             }
639             Allowable => return None,
640             DisallowedBy(id) => id,
641         };
642
643         // If we're disallowed by a particular id, then we attempt to give a
644         // nice error message to say why it was disallowed. It was either
645         // because the item itself is private or because its parent is private
646         // and its parent isn't in our ancestry.
647         let (err_span, err_msg) = if id == source_did.unwrap_or(to_check).node {
648             return Some((span, format!("{} is private", msg), None));
649         } else {
650             (span, format!("{} is inaccessible", msg))
651         };
652         let item = match self.tcx.map.find(id) {
653             Some(ast_map::NodeItem(item)) => {
654                 match item.node {
655                     // If an impl disallowed this item, then this is resolve's
656                     // way of saying that a struct/enum's static method was
657                     // invoked, and the struct/enum itself is private. Crawl
658                     // back up the chains to find the relevant struct/enum that
659                     // was private.
660                     hir::ItemImpl(_, _, _, _, ref ty, _) => {
661                         match ty.node {
662                             hir::TyPath(..) => {}
663                             _ => return Some((err_span, err_msg, None)),
664                         };
665                         let def = self.tcx.def_map.borrow().get(&ty.id).unwrap().full_def();
666                         let did = def.def_id();
667                         assert!(did.is_local());
668                         match self.tcx.map.get(did.node) {
669                             ast_map::NodeItem(item) => item,
670                             _ => self.tcx.sess.span_bug(item.span,
671                                                         "path is not an item")
672                         }
673                     }
674                     _ => item
675                 }
676             }
677             Some(..) | None => return Some((err_span, err_msg, None)),
678         };
679         let desc = match item.node {
680             hir::ItemMod(..) => "module",
681             hir::ItemTrait(..) => "trait",
682             hir::ItemStruct(..) => "struct",
683             hir::ItemEnum(..) => "enum",
684             _ => return Some((err_span, err_msg, None))
685         };
686         let msg = format!("{} `{}` is private", desc, item.name);
687         Some((err_span, err_msg, Some((span, msg))))
688     }
689
690     // Checks that a field is in scope.
691     fn check_field(&mut self,
692                    span: Span,
693                    def: ty::AdtDef<'tcx>,
694                    v: ty::VariantDef<'tcx>,
695                    name: FieldName) {
696         let field = match name {
697             NamedField(f_name) => {
698                 debug!("privacy - check named field {} in struct {:?}", f_name, def);
699                 v.field_named(f_name)
700             }
701             UnnamedField(idx) => &v.fields[idx]
702         };
703         if field.vis == hir::Public ||
704             (field.did.is_local() && self.private_accessible(field.did.node)) {
705             return
706         }
707
708         let struct_desc = match def.adt_kind() {
709             ty::AdtKind::Struct =>
710                 format!("struct `{}`", self.tcx.item_path_str(def.did)),
711             // struct variant fields have inherited visibility
712             ty::AdtKind::Enum => return
713         };
714         let msg = match name {
715             NamedField(name) => format!("field `{}` of {} is private",
716                                         name, struct_desc),
717             UnnamedField(idx) => format!("field #{} of {} is private",
718                                          idx + 1, struct_desc),
719         };
720         span_err!(self.tcx.sess, span, E0451,
721                   "{}", &msg[..]);
722     }
723
724     // Given the ID of a method, checks to ensure it's in scope.
725     fn check_static_method(&mut self,
726                            span: Span,
727                            method_id: DefId,
728                            name: ast::Name) {
729         // If the method is a default method, we need to use the def_id of
730         // the default implementation.
731         let method_id = match self.tcx.impl_or_trait_item(method_id) {
732             ty::MethodTraitItem(method_type) => {
733                 method_type.provided_source.unwrap_or(method_id)
734             }
735             _ => {
736                 self.tcx.sess
737                     .span_bug(span,
738                               "got non-method item in check_static_method")
739             }
740         };
741
742         self.report_error(self.ensure_public(span,
743                                              method_id,
744                                              None,
745                                              &format!("method `{}`",
746                                                      name)));
747     }
748
749     // Checks that a path is in scope.
750     fn check_path(&mut self, span: Span, path_id: ast::NodeId, last: ast::Name) {
751         debug!("privacy - path {}", self.nodestr(path_id));
752         let path_res = *self.tcx.def_map.borrow().get(&path_id).unwrap();
753         let ck = |tyname: &str| {
754             let ck_public = |def: DefId| {
755                 debug!("privacy - ck_public {:?}", def);
756                 let origdid = path_res.def_id();
757                 self.ensure_public(span,
758                                    def,
759                                    Some(origdid),
760                                    &format!("{} `{}`", tyname, last))
761             };
762
763             match path_res.last_private {
764                 LastMod(AllPublic) => {},
765                 LastMod(DependsOn(def)) => {
766                     self.report_error(ck_public(def));
767                 },
768                 LastImport { value_priv,
769                              value_used: check_value,
770                              type_priv,
771                              type_used: check_type } => {
772                     // This dance with found_error is because we don't want to
773                     // report a privacy error twice for the same directive.
774                     let found_error = match (type_priv, check_type) {
775                         (Some(DependsOn(def)), Used) => {
776                             !self.report_error(ck_public(def))
777                         },
778                         _ => false,
779                     };
780                     if !found_error {
781                         match (value_priv, check_value) {
782                             (Some(DependsOn(def)), Used) => {
783                                 self.report_error(ck_public(def));
784                             },
785                             _ => {},
786                         }
787                     }
788                     // If an import is not used in either namespace, we still
789                     // want to check that it could be legal. Therefore we check
790                     // in both namespaces and only report an error if both would
791                     // be illegal. We only report one error, even if it is
792                     // illegal to import from both namespaces.
793                     match (value_priv, check_value, type_priv, check_type) {
794                         (Some(p), Unused, None, _) |
795                         (None, _, Some(p), Unused) => {
796                             let p = match p {
797                                 AllPublic => None,
798                                 DependsOn(def) => ck_public(def),
799                             };
800                             if p.is_some() {
801                                 self.report_error(p);
802                             }
803                         },
804                         (Some(v), Unused, Some(t), Unused) => {
805                             let v = match v {
806                                 AllPublic => None,
807                                 DependsOn(def) => ck_public(def),
808                             };
809                             let t = match t {
810                                 AllPublic => None,
811                                 DependsOn(def) => ck_public(def),
812                             };
813                             if let (Some(_), Some(t)) = (v, t) {
814                                 self.report_error(Some(t));
815                             }
816                         },
817                         _ => {},
818                     }
819                 },
820             }
821         };
822         // FIXME(#12334) Imports can refer to definitions in both the type and
823         // value namespaces. The privacy information is aware of this, but the
824         // def map is not. Therefore the names we work out below will not always
825         // be accurate and we can get slightly wonky error messages (but type
826         // checking is always correct).
827         match path_res.full_def() {
828             def::DefFn(..) => ck("function"),
829             def::DefStatic(..) => ck("static"),
830             def::DefConst(..) => ck("const"),
831             def::DefAssociatedConst(..) => ck("associated const"),
832             def::DefVariant(..) => ck("variant"),
833             def::DefTy(_, false) => ck("type"),
834             def::DefTy(_, true) => ck("enum"),
835             def::DefTrait(..) => ck("trait"),
836             def::DefStruct(..) => ck("struct"),
837             def::DefMethod(..) => ck("method"),
838             def::DefMod(..) => ck("module"),
839             _ => {}
840         }
841     }
842
843     // Checks that a method is in scope.
844     fn check_method(&mut self, span: Span, method_def_id: DefId,
845                     name: ast::Name) {
846         match self.tcx.impl_or_trait_item(method_def_id).container() {
847             ty::ImplContainer(_) => {
848                 self.check_static_method(span, method_def_id, name)
849             }
850             // Trait methods are always accessible if the trait is in scope.
851             ty::TraitContainer(_) => {}
852         }
853     }
854 }
855
856 impl<'a, 'tcx, 'v> Visitor<'v> for PrivacyVisitor<'a, 'tcx> {
857     fn visit_item(&mut self, item: &hir::Item) {
858         let orig_curitem = replace(&mut self.curitem, item.id);
859         visit::walk_item(self, item);
860         self.curitem = orig_curitem;
861     }
862
863     fn visit_expr(&mut self, expr: &hir::Expr) {
864         match expr.node {
865             hir::ExprField(ref base, name) => {
866                 if let ty::TyStruct(def, _) = self.tcx.expr_ty_adjusted(&**base).sty {
867                     self.check_field(expr.span,
868                                      def,
869                                      def.struct_variant(),
870                                      NamedField(name.node));
871                 }
872             }
873             hir::ExprTupField(ref base, idx) => {
874                 if let ty::TyStruct(def, _) = self.tcx.expr_ty_adjusted(&**base).sty {
875                     self.check_field(expr.span,
876                                      def,
877                                      def.struct_variant(),
878                                      UnnamedField(idx.node));
879                 }
880             }
881             hir::ExprMethodCall(name, _, _) => {
882                 let method_call = ty::MethodCall::expr(expr.id);
883                 let method = self.tcx.tables.borrow().method_map[&method_call];
884                 debug!("(privacy checking) checking impl method");
885                 self.check_method(expr.span, method.def_id, name.node);
886             }
887             hir::ExprStruct(..) => {
888                 let adt = self.tcx.expr_ty(expr).ty_adt_def().unwrap();
889                 let variant = adt.variant_of_def(self.tcx.resolve_expr(expr));
890                 // RFC 736: ensure all unmentioned fields are visible.
891                 // Rather than computing the set of unmentioned fields
892                 // (i.e. `all_fields - fields`), just check them all.
893                 for field in &variant.fields {
894                     self.check_field(expr.span, adt, variant, NamedField(field.name));
895                 }
896             }
897             hir::ExprPath(..) => {
898
899                 if let def::DefStruct(_) = self.tcx.resolve_expr(expr) {
900                     let expr_ty = self.tcx.expr_ty(expr);
901                     let def = match expr_ty.sty {
902                         ty::TyBareFn(_, &ty::BareFnTy { sig: ty::Binder(ty::FnSig {
903                             output: ty::FnConverging(ty), ..
904                         }), ..}) => ty,
905                         _ => expr_ty
906                     }.ty_adt_def().unwrap();
907                     let any_priv = def.struct_variant().fields.iter().any(|f| {
908                         f.vis != hir::Public && (
909                             !f.did.is_local() ||
910                                     !self.private_accessible(f.did.node))
911                         });
912
913                     if any_priv {
914                         span_err!(self.tcx.sess, expr.span, E0450,
915                                   "cannot invoke tuple struct constructor with private \
916                                    fields");
917                     }
918                 }
919             }
920             _ => {}
921         }
922
923         visit::walk_expr(self, expr);
924     }
925
926     fn visit_pat(&mut self, pattern: &hir::Pat) {
927         // Foreign functions do not have their patterns mapped in the def_map,
928         // and there's nothing really relevant there anyway, so don't bother
929         // checking privacy. If you can name the type then you can pass it to an
930         // external C function anyway.
931         if self.in_foreign { return }
932
933         match pattern.node {
934             hir::PatStruct(_, ref fields, _) => {
935                 let adt = self.tcx.pat_ty(pattern).ty_adt_def().unwrap();
936                 let def = self.tcx.def_map.borrow().get(&pattern.id).unwrap().full_def();
937                 let variant = adt.variant_of_def(def);
938                 for field in fields {
939                     self.check_field(pattern.span, adt, variant,
940                                      NamedField(field.node.name));
941                 }
942             }
943
944             // Patterns which bind no fields are allowable (the path is check
945             // elsewhere).
946             hir::PatEnum(_, Some(ref fields)) => {
947                 match self.tcx.pat_ty(pattern).sty {
948                     ty::TyStruct(def, _) => {
949                         for (i, field) in fields.iter().enumerate() {
950                             if let hir::PatWild(..) = field.node {
951                                 continue
952                             }
953                             self.check_field(field.span,
954                                              def,
955                                              def.struct_variant(),
956                                              UnnamedField(i));
957                         }
958                     }
959                     ty::TyEnum(..) => {
960                         // enum fields have no privacy at this time
961                     }
962                     _ => {}
963                 }
964
965             }
966             _ => {}
967         }
968
969         visit::walk_pat(self, pattern);
970     }
971
972     fn visit_foreign_item(&mut self, fi: &hir::ForeignItem) {
973         self.in_foreign = true;
974         visit::walk_foreign_item(self, fi);
975         self.in_foreign = false;
976     }
977
978     fn visit_path(&mut self, path: &hir::Path, id: ast::NodeId) {
979         if !path.segments.is_empty() {
980             self.check_path(path.span, id, path.segments.last().unwrap().identifier.name);
981             visit::walk_path(self, path);
982         }
983     }
984
985     fn visit_path_list_item(&mut self, prefix: &hir::Path, item: &hir::PathListItem) {
986         let name = if let hir::PathListIdent { name, .. } = item.node {
987             name
988         } else if !prefix.segments.is_empty() {
989             prefix.segments.last().unwrap().identifier.name
990         } else {
991             self.tcx.sess.bug("`self` import in an import list with empty prefix");
992         };
993         self.check_path(item.span, item.node.id(), name);
994         visit::walk_path_list_item(self, prefix, item);
995     }
996 }
997
998 ////////////////////////////////////////////////////////////////////////////////
999 /// The privacy sanity check visitor, ensures unnecessary visibility isn't here
1000 ////////////////////////////////////////////////////////////////////////////////
1001
1002 struct SanePrivacyVisitor<'a, 'tcx: 'a> {
1003     tcx: &'a ty::ctxt<'tcx>,
1004     in_fn: bool,
1005 }
1006
1007 impl<'a, 'tcx, 'v> Visitor<'v> for SanePrivacyVisitor<'a, 'tcx> {
1008     fn visit_item(&mut self, item: &hir::Item) {
1009         if self.in_fn {
1010             self.check_all_inherited(item);
1011         } else {
1012             self.check_sane_privacy(item);
1013         }
1014
1015         let in_fn = self.in_fn;
1016         let orig_in_fn = replace(&mut self.in_fn, match item.node {
1017             hir::ItemMod(..) => false, // modules turn privacy back on
1018             _ => in_fn,           // otherwise we inherit
1019         });
1020         visit::walk_item(self, item);
1021         self.in_fn = orig_in_fn;
1022     }
1023
1024     fn visit_fn(&mut self, fk: visit::FnKind<'v>, fd: &'v hir::FnDecl,
1025                 b: &'v hir::Block, s: Span, _: ast::NodeId) {
1026         // This catches both functions and methods
1027         let orig_in_fn = replace(&mut self.in_fn, true);
1028         visit::walk_fn(self, fk, fd, b, s);
1029         self.in_fn = orig_in_fn;
1030     }
1031 }
1032
1033 impl<'a, 'tcx> SanePrivacyVisitor<'a, 'tcx> {
1034     /// Validates all of the visibility qualifiers placed on the item given. This
1035     /// ensures that there are no extraneous qualifiers that don't actually do
1036     /// anything. In theory these qualifiers wouldn't parse, but that may happen
1037     /// later on down the road...
1038     fn check_sane_privacy(&self, item: &hir::Item) {
1039         let tcx = self.tcx;
1040         let check_inherited = |sp: Span, vis: hir::Visibility, note: &str| {
1041             if vis != hir::Inherited {
1042                 span_err!(tcx.sess, sp, E0449,
1043                           "unnecessary visibility qualifier");
1044                 if !note.is_empty() {
1045                     tcx.sess.span_note(sp, note);
1046                 }
1047             }
1048         };
1049         match item.node {
1050             // implementations of traits don't need visibility qualifiers because
1051             // that's controlled by having the trait in scope.
1052             hir::ItemImpl(_, _, _, Some(..), _, ref impl_items) => {
1053                 check_inherited(item.span, item.vis,
1054                                 "visibility qualifiers have no effect on trait \
1055                                  impls");
1056                 for impl_item in impl_items {
1057                     check_inherited(impl_item.span, impl_item.vis, "");
1058                 }
1059             }
1060
1061             hir::ItemImpl(..) => {
1062                 check_inherited(item.span, item.vis,
1063                                 "place qualifiers on individual methods instead");
1064             }
1065             hir::ItemForeignMod(..) => {
1066                 check_inherited(item.span, item.vis,
1067                                 "place qualifiers on individual functions \
1068                                  instead");
1069             }
1070
1071             hir::ItemEnum(..) |
1072             hir::ItemTrait(..) | hir::ItemDefaultImpl(..) |
1073             hir::ItemConst(..) | hir::ItemStatic(..) | hir::ItemStruct(..) |
1074             hir::ItemFn(..) | hir::ItemMod(..) | hir::ItemTy(..) |
1075             hir::ItemExternCrate(_) | hir::ItemUse(_) => {}
1076         }
1077     }
1078
1079     /// When inside of something like a function or a method, visibility has no
1080     /// control over anything so this forbids any mention of any visibility
1081     fn check_all_inherited(&self, item: &hir::Item) {
1082         let tcx = self.tcx;
1083         fn check_inherited(tcx: &ty::ctxt, sp: Span, vis: hir::Visibility) {
1084             if vis != hir::Inherited {
1085                 span_err!(tcx.sess, sp, E0447,
1086                           "visibility has no effect inside functions");
1087             }
1088         }
1089         let check_struct = |def: &hir::StructDef| {
1090             for f in &def.fields {
1091                match f.node.kind {
1092                     hir::NamedField(_, p) => check_inherited(tcx, f.span, p),
1093                     hir::UnnamedField(..) => {}
1094                 }
1095             }
1096         };
1097         check_inherited(tcx, item.span, item.vis);
1098         match item.node {
1099             hir::ItemImpl(_, _, _, _, _, ref impl_items) => {
1100                 for impl_item in impl_items {
1101                     match impl_item.node {
1102                         hir::MethodImplItem(..) => {
1103                             check_inherited(tcx, impl_item.span, impl_item.vis);
1104                         }
1105                         _ => {}
1106                     }
1107                 }
1108             }
1109             hir::ItemForeignMod(ref fm) => {
1110                 for i in &fm.items {
1111                     check_inherited(tcx, i.span, i.vis);
1112                 }
1113             }
1114
1115             hir::ItemStruct(ref def, _) => check_struct(&**def),
1116
1117             hir::ItemEnum(..) |
1118             hir::ItemExternCrate(_) | hir::ItemUse(_) |
1119             hir::ItemTrait(..) | hir::ItemDefaultImpl(..) |
1120             hir::ItemStatic(..) | hir::ItemConst(..) |
1121             hir::ItemFn(..) | hir::ItemMod(..) | hir::ItemTy(..) => {}
1122         }
1123     }
1124 }
1125
1126 struct VisiblePrivateTypesVisitor<'a, 'tcx: 'a> {
1127     tcx: &'a ty::ctxt<'tcx>,
1128     exported_items: &'a ExportedItems,
1129     public_items: &'a PublicItems,
1130     in_variant: bool,
1131 }
1132
1133 struct CheckTypeForPrivatenessVisitor<'a, 'b: 'a, 'tcx: 'b> {
1134     inner: &'a VisiblePrivateTypesVisitor<'b, 'tcx>,
1135     /// whether the type refers to private types.
1136     contains_private: bool,
1137     /// whether we've recurred at all (i.e. if we're pointing at the
1138     /// first type on which visit_ty was called).
1139     at_outer_type: bool,
1140     // whether that first type is a public path.
1141     outer_type_is_public_path: bool,
1142 }
1143
1144 impl<'a, 'tcx> VisiblePrivateTypesVisitor<'a, 'tcx> {
1145     fn path_is_private_type(&self, path_id: ast::NodeId) -> bool {
1146         let did = match self.tcx.def_map.borrow().get(&path_id).map(|d| d.full_def()) {
1147             // `int` etc. (None doesn't seem to occur.)
1148             None | Some(def::DefPrimTy(..)) => return false,
1149             Some(def) => def.def_id(),
1150         };
1151         // A path can only be private if:
1152         // it's in this crate...
1153         if !did.is_local() {
1154             return false
1155         }
1156
1157         // .. and it corresponds to a private type in the AST (this returns
1158         // None for type parameters)
1159         match self.tcx.map.find(did.node) {
1160             Some(ast_map::NodeItem(ref item)) => item.vis != hir::Public,
1161             Some(_) | None => false,
1162         }
1163     }
1164
1165     fn trait_is_public(&self, trait_id: ast::NodeId) -> bool {
1166         // FIXME: this would preferably be using `exported_items`, but all
1167         // traits are exported currently (see `EmbargoVisitor.exported_trait`)
1168         self.public_items.contains(&trait_id)
1169     }
1170
1171     fn check_ty_param_bound(&self,
1172                             ty_param_bound: &hir::TyParamBound) {
1173         if let hir::TraitTyParamBound(ref trait_ref, _) = *ty_param_bound {
1174             if !self.tcx.sess.features.borrow().visible_private_types &&
1175                 self.path_is_private_type(trait_ref.trait_ref.ref_id) {
1176                     let span = trait_ref.trait_ref.path.span;
1177                     span_err!(self.tcx.sess, span, E0445,
1178                               "private trait in exported type parameter bound");
1179             }
1180         }
1181     }
1182
1183     fn item_is_public(&self, id: &ast::NodeId, vis: hir::Visibility) -> bool {
1184         self.exported_items.contains(id) || vis == hir::Public
1185     }
1186 }
1187
1188 impl<'a, 'b, 'tcx, 'v> Visitor<'v> for CheckTypeForPrivatenessVisitor<'a, 'b, 'tcx> {
1189     fn visit_ty(&mut self, ty: &hir::Ty) {
1190         if let hir::TyPath(..) = ty.node {
1191             if self.inner.path_is_private_type(ty.id) {
1192                 self.contains_private = true;
1193                 // found what we're looking for so let's stop
1194                 // working.
1195                 return
1196             } else if self.at_outer_type {
1197                 self.outer_type_is_public_path = true;
1198             }
1199         }
1200         self.at_outer_type = false;
1201         visit::walk_ty(self, ty)
1202     }
1203
1204     // don't want to recurse into [, .. expr]
1205     fn visit_expr(&mut self, _: &hir::Expr) {}
1206 }
1207
1208 impl<'a, 'tcx, 'v> Visitor<'v> for VisiblePrivateTypesVisitor<'a, 'tcx> {
1209     fn visit_item(&mut self, item: &hir::Item) {
1210         match item.node {
1211             // contents of a private mod can be reexported, so we need
1212             // to check internals.
1213             hir::ItemMod(_) => {}
1214
1215             // An `extern {}` doesn't introduce a new privacy
1216             // namespace (the contents have their own privacies).
1217             hir::ItemForeignMod(_) => {}
1218
1219             hir::ItemTrait(_, _, ref bounds, _) => {
1220                 if !self.trait_is_public(item.id) {
1221                     return
1222                 }
1223
1224                 for bound in bounds.iter() {
1225                     self.check_ty_param_bound(bound)
1226                 }
1227             }
1228
1229             // impls need some special handling to try to offer useful
1230             // error messages without (too many) false positives
1231             // (i.e. we could just return here to not check them at
1232             // all, or some worse estimation of whether an impl is
1233             // publicly visible).
1234             hir::ItemImpl(_, _, ref g, ref trait_ref, ref self_, ref impl_items) => {
1235                 // `impl [... for] Private` is never visible.
1236                 let self_contains_private;
1237                 // impl [... for] Public<...>, but not `impl [... for]
1238                 // Vec<Public>` or `(Public,)` etc.
1239                 let self_is_public_path;
1240
1241                 // check the properties of the Self type:
1242                 {
1243                     let mut visitor = CheckTypeForPrivatenessVisitor {
1244                         inner: self,
1245                         contains_private: false,
1246                         at_outer_type: true,
1247                         outer_type_is_public_path: false,
1248                     };
1249                     visitor.visit_ty(&**self_);
1250                     self_contains_private = visitor.contains_private;
1251                     self_is_public_path = visitor.outer_type_is_public_path;
1252                 }
1253
1254                 // miscellaneous info about the impl
1255
1256                 // `true` iff this is `impl Private for ...`.
1257                 let not_private_trait =
1258                     trait_ref.as_ref().map_or(true, // no trait counts as public trait
1259                                               |tr| {
1260                         let did = self.tcx.trait_ref_to_def_id(tr);
1261
1262                         !did.is_local() || self.trait_is_public(did.node)
1263                     });
1264
1265                 // `true` iff this is a trait impl or at least one method is public.
1266                 //
1267                 // `impl Public { $( fn ...() {} )* }` is not visible.
1268                 //
1269                 // This is required over just using the methods' privacy
1270                 // directly because we might have `impl<T: Foo<Private>> ...`,
1271                 // and we shouldn't warn about the generics if all the methods
1272                 // are private (because `T` won't be visible externally).
1273                 let trait_or_some_public_method =
1274                     trait_ref.is_some() ||
1275                     impl_items.iter()
1276                               .any(|impl_item| {
1277                                   match impl_item.node {
1278                                       hir::ConstImplItem(..) |
1279                                       hir::MethodImplItem(..) => {
1280                                           self.exported_items.contains(&impl_item.id)
1281                                       }
1282                                       hir::TypeImplItem(_) => false,
1283                                   }
1284                               });
1285
1286                 if !self_contains_private &&
1287                         not_private_trait &&
1288                         trait_or_some_public_method {
1289
1290                     visit::walk_generics(self, g);
1291
1292                     match *trait_ref {
1293                         None => {
1294                             for impl_item in impl_items {
1295                                 // This is where we choose whether to walk down
1296                                 // further into the impl to check its items. We
1297                                 // should only walk into public items so that we
1298                                 // don't erroneously report errors for private
1299                                 // types in private items.
1300                                 match impl_item.node {
1301                                     hir::ConstImplItem(..) |
1302                                     hir::MethodImplItem(..)
1303                                         if self.item_is_public(&impl_item.id, impl_item.vis) =>
1304                                     {
1305                                         visit::walk_impl_item(self, impl_item)
1306                                     }
1307                                     hir::TypeImplItem(..) => {
1308                                         visit::walk_impl_item(self, impl_item)
1309                                     }
1310                                     _ => {}
1311                                 }
1312                             }
1313                         }
1314                         Some(ref tr) => {
1315                             // Any private types in a trait impl fall into three
1316                             // categories.
1317                             // 1. mentioned in the trait definition
1318                             // 2. mentioned in the type params/generics
1319                             // 3. mentioned in the associated types of the impl
1320                             //
1321                             // Those in 1. can only occur if the trait is in
1322                             // this crate and will've been warned about on the
1323                             // trait definition (there's no need to warn twice
1324                             // so we don't check the methods).
1325                             //
1326                             // Those in 2. are warned via walk_generics and this
1327                             // call here.
1328                             visit::walk_path(self, &tr.path);
1329
1330                             // Those in 3. are warned with this call.
1331                             for impl_item in impl_items {
1332                                 if let hir::TypeImplItem(ref ty) = impl_item.node {
1333                                     self.visit_ty(ty);
1334                                 }
1335                             }
1336                         }
1337                     }
1338                 } else if trait_ref.is_none() && self_is_public_path {
1339                     // impl Public<Private> { ... }. Any public static
1340                     // methods will be visible as `Public::foo`.
1341                     let mut found_pub_static = false;
1342                     for impl_item in impl_items {
1343                         match impl_item.node {
1344                             hir::ConstImplItem(..) => {
1345                                 if self.item_is_public(&impl_item.id, impl_item.vis) {
1346                                     found_pub_static = true;
1347                                     visit::walk_impl_item(self, impl_item);
1348                                 }
1349                             }
1350                             hir::MethodImplItem(ref sig, _) => {
1351                                 if sig.explicit_self.node == hir::SelfStatic &&
1352                                       self.item_is_public(&impl_item.id, impl_item.vis) {
1353                                     found_pub_static = true;
1354                                     visit::walk_impl_item(self, impl_item);
1355                                 }
1356                             }
1357                             _ => {}
1358                         }
1359                     }
1360                     if found_pub_static {
1361                         visit::walk_generics(self, g)
1362                     }
1363                 }
1364                 return
1365             }
1366
1367             // `type ... = ...;` can contain private types, because
1368             // we're introducing a new name.
1369             hir::ItemTy(..) => return,
1370
1371             // not at all public, so we don't care
1372             _ if !self.item_is_public(&item.id, item.vis) => {
1373                 return;
1374             }
1375
1376             _ => {}
1377         }
1378
1379         // We've carefully constructed it so that if we're here, then
1380         // any `visit_ty`'s will be called on things that are in
1381         // public signatures, i.e. things that we're interested in for
1382         // this visitor.
1383         debug!("VisiblePrivateTypesVisitor entering item {:?}", item);
1384         visit::walk_item(self, item);
1385     }
1386
1387     fn visit_generics(&mut self, generics: &hir::Generics) {
1388         for ty_param in generics.ty_params.iter() {
1389             for bound in ty_param.bounds.iter() {
1390                 self.check_ty_param_bound(bound)
1391             }
1392         }
1393         for predicate in &generics.where_clause.predicates {
1394             match predicate {
1395                 &hir::WherePredicate::BoundPredicate(ref bound_pred) => {
1396                     for bound in bound_pred.bounds.iter() {
1397                         self.check_ty_param_bound(bound)
1398                     }
1399                 }
1400                 &hir::WherePredicate::RegionPredicate(_) => {}
1401                 &hir::WherePredicate::EqPredicate(ref eq_pred) => {
1402                     self.visit_ty(&*eq_pred.ty);
1403                 }
1404             }
1405         }
1406     }
1407
1408     fn visit_foreign_item(&mut self, item: &hir::ForeignItem) {
1409         if self.exported_items.contains(&item.id) {
1410             visit::walk_foreign_item(self, item)
1411         }
1412     }
1413
1414     fn visit_ty(&mut self, t: &hir::Ty) {
1415         debug!("VisiblePrivateTypesVisitor checking ty {:?}", t);
1416         if let hir::TyPath(_, ref p) = t.node {
1417             if !self.tcx.sess.features.borrow().visible_private_types &&
1418                 self.path_is_private_type(t.id) {
1419                 span_err!(self.tcx.sess, p.span, E0446,
1420                           "private type in exported type signature");
1421             }
1422         }
1423         visit::walk_ty(self, t)
1424     }
1425
1426     fn visit_variant(&mut self, v: &hir::Variant, g: &hir::Generics) {
1427         if self.exported_items.contains(&v.node.id) {
1428             self.in_variant = true;
1429             visit::walk_variant(self, v, g);
1430             self.in_variant = false;
1431         }
1432     }
1433
1434     fn visit_struct_field(&mut self, s: &hir::StructField) {
1435         match s.node.kind {
1436             hir::NamedField(_, vis) if vis == hir::Public || self.in_variant => {
1437                 visit::walk_struct_field(self, s);
1438             }
1439             _ => {}
1440         }
1441     }
1442
1443
1444     // we don't need to introspect into these at all: an
1445     // expression/block context can't possibly contain exported things.
1446     // (Making them no-ops stops us from traversing the whole AST without
1447     // having to be super careful about our `walk_...` calls above.)
1448     fn visit_block(&mut self, _: &hir::Block) {}
1449     fn visit_expr(&mut self, _: &hir::Expr) {}
1450 }
1451
1452 pub fn check_crate(tcx: &ty::ctxt,
1453                    export_map: &def::ExportMap,
1454                    external_exports: ExternalExports)
1455                    -> (ExportedItems, PublicItems) {
1456     let krate = tcx.map.krate();
1457
1458     // Figure out who everyone's parent is
1459     let mut visitor = ParentVisitor {
1460         parents: NodeMap(),
1461         curparent: ast::DUMMY_NODE_ID,
1462     };
1463     visit::walk_crate(&mut visitor, krate);
1464
1465     // Use the parent map to check the privacy of everything
1466     let mut visitor = PrivacyVisitor {
1467         curitem: ast::DUMMY_NODE_ID,
1468         in_foreign: false,
1469         tcx: tcx,
1470         parents: visitor.parents,
1471         external_exports: external_exports,
1472     };
1473     visit::walk_crate(&mut visitor, krate);
1474
1475     // Sanity check to make sure that all privacy usage and controls are
1476     // reasonable.
1477     let mut visitor = SanePrivacyVisitor {
1478         in_fn: false,
1479         tcx: tcx,
1480     };
1481     visit::walk_crate(&mut visitor, krate);
1482
1483     tcx.sess.abort_if_errors();
1484
1485     // Build up a set of all exported items in the AST. This is a set of all
1486     // items which are reachable from external crates based on visibility.
1487     let mut visitor = EmbargoVisitor {
1488         tcx: tcx,
1489         exported_items: NodeSet(),
1490         public_items: NodeSet(),
1491         reexports: NodeSet(),
1492         export_map: export_map,
1493         prev_exported: true,
1494         prev_public: true,
1495     };
1496     loop {
1497         let before = visitor.exported_items.len();
1498         visit::walk_crate(&mut visitor, krate);
1499         if before == visitor.exported_items.len() {
1500             break
1501         }
1502     }
1503
1504     let EmbargoVisitor { exported_items, public_items, .. } = visitor;
1505
1506     {
1507         let mut visitor = VisiblePrivateTypesVisitor {
1508             tcx: tcx,
1509             exported_items: &exported_items,
1510             public_items: &public_items,
1511             in_variant: false,
1512         };
1513         visit::walk_crate(&mut visitor, krate);
1514     }
1515     return (exported_items, public_items);
1516 }