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.
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 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
12 html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
13 html_root_url = "https://doc.rust-lang.org/nightly/")]
15 #![feature(rustc_diagnostic_macros)]
17 #![recursion_limit="256"]
19 #[macro_use] extern crate rustc;
20 #[macro_use] extern crate syntax;
21 extern crate rustc_typeck;
22 extern crate syntax_pos;
23 extern crate rustc_data_structures;
25 use rustc::hir::{self, GenericParamKind, PatKind};
26 use rustc::hir::def::Def;
27 use rustc::hir::def_id::{CRATE_DEF_INDEX, LOCAL_CRATE, CrateNum, DefId};
28 use rustc::hir::intravisit::{self, Visitor, NestedVisitorMap};
29 use rustc::hir::itemlikevisit::DeepVisitor;
31 use rustc::middle::privacy::{AccessLevel, AccessLevels};
32 use rustc::ty::{self, TyCtxt, Ty, TypeFoldable, GenericParamDefKind};
33 use rustc::ty::fold::TypeVisitor;
34 use rustc::ty::query::Providers;
35 use rustc::ty::subst::UnpackedKind;
36 use rustc::util::nodemap::NodeSet;
37 use syntax::ast::{self, CRATE_NODE_ID, Ident};
38 use syntax::symbol::keywords;
42 use std::mem::replace;
43 use rustc_data_structures::fx::FxHashSet;
44 use rustc_data_structures::sync::Lrc;
48 ////////////////////////////////////////////////////////////////////////////////
49 /// Visitor used to determine if pub(restricted) is used anywhere in the crate.
51 /// This is done so that `private_in_public` warnings can be turned into hard errors
52 /// in crates that have been updated to use pub(restricted).
53 ////////////////////////////////////////////////////////////////////////////////
54 struct PubRestrictedVisitor<'a, 'tcx: 'a> {
55 tcx: TyCtxt<'a, 'tcx, 'tcx>,
56 has_pub_restricted: bool,
59 impl<'a, 'tcx> Visitor<'tcx> for PubRestrictedVisitor<'a, 'tcx> {
60 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
61 NestedVisitorMap::All(&self.tcx.hir)
63 fn visit_vis(&mut self, vis: &'tcx hir::Visibility) {
64 self.has_pub_restricted = self.has_pub_restricted || vis.node.is_pub_restricted();
68 ////////////////////////////////////////////////////////////////////////////////
69 /// The embargo visitor, used to determine the exports of the ast
70 ////////////////////////////////////////////////////////////////////////////////
72 struct EmbargoVisitor<'a, 'tcx: 'a> {
73 tcx: TyCtxt<'a, 'tcx, 'tcx>,
75 // Accessibility levels for reachable nodes
76 access_levels: AccessLevels,
77 // Previous accessibility level, None means unreachable
78 prev_level: Option<AccessLevel>,
79 // Have something changed in the level map?
83 struct ReachEverythingInTheInterfaceVisitor<'b, 'a: 'b, 'tcx: 'a> {
85 ev: &'b mut EmbargoVisitor<'a, 'tcx>,
88 impl<'a, 'tcx> EmbargoVisitor<'a, 'tcx> {
89 fn item_ty_level(&self, item_def_id: DefId) -> Option<AccessLevel> {
90 let ty_def_id = match self.tcx.type_of(item_def_id).sty {
91 ty::TyAdt(adt, _) => adt.did,
92 ty::TyForeign(did) => did,
93 ty::TyDynamic(ref obj, ..) if obj.principal().is_some() =>
94 obj.principal().unwrap().def_id(),
95 ty::TyProjection(ref proj) => proj.trait_ref(self.tcx).def_id,
96 _ => return Some(AccessLevel::Public)
98 if let Some(node_id) = self.tcx.hir.as_local_node_id(ty_def_id) {
101 Some(AccessLevel::Public)
105 fn impl_trait_level(&self, impl_def_id: DefId) -> Option<AccessLevel> {
106 if let Some(trait_ref) = self.tcx.impl_trait_ref(impl_def_id) {
107 if let Some(node_id) = self.tcx.hir.as_local_node_id(trait_ref.def_id) {
108 return self.get(node_id);
111 Some(AccessLevel::Public)
114 fn get(&self, id: ast::NodeId) -> Option<AccessLevel> {
115 self.access_levels.map.get(&id).cloned()
118 // Updates node level and returns the updated level
119 fn update(&mut self, id: ast::NodeId, level: Option<AccessLevel>) -> Option<AccessLevel> {
120 let old_level = self.get(id);
121 // Accessibility levels can only grow
122 if level > old_level {
123 self.access_levels.map.insert(id, level.unwrap());
131 fn reach<'b>(&'b mut self, item_id: ast::NodeId)
132 -> ReachEverythingInTheInterfaceVisitor<'b, 'a, 'tcx> {
133 ReachEverythingInTheInterfaceVisitor {
134 item_def_id: self.tcx.hir.local_def_id(item_id),
140 impl<'a, 'tcx> Visitor<'tcx> for EmbargoVisitor<'a, 'tcx> {
141 /// We want to visit items in the context of their containing
142 /// module and so forth, so supply a crate for doing a deep walk.
143 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
144 NestedVisitorMap::All(&self.tcx.hir)
147 fn visit_item(&mut self, item: &'tcx hir::Item) {
148 let inherited_item_level = match item.node {
149 // Impls inherit level from their types and traits
150 hir::ItemKind::Impl(..) => {
151 let def_id = self.tcx.hir.local_def_id(item.id);
152 cmp::min(self.item_ty_level(def_id), self.impl_trait_level(def_id))
154 // Foreign mods inherit level from parents
155 hir::ItemKind::ForeignMod(..) => {
158 // Other `pub` items inherit levels from parents
159 hir::ItemKind::Const(..) | hir::ItemKind::Enum(..) | hir::ItemKind::ExternCrate(..) |
160 hir::ItemKind::GlobalAsm(..) | hir::ItemKind::Fn(..) | hir::ItemKind::Mod(..) |
161 hir::ItemKind::Static(..) | hir::ItemKind::Struct(..) |
162 hir::ItemKind::Trait(..) | hir::ItemKind::TraitAlias(..) |
163 hir::ItemKind::Existential(..) |
164 hir::ItemKind::Ty(..) | hir::ItemKind::Union(..) | hir::ItemKind::Use(..) => {
165 if item.vis.node.is_pub() { self.prev_level } else { None }
169 // Update level of the item itself
170 let item_level = self.update(item.id, inherited_item_level);
172 // Update levels of nested things
174 hir::ItemKind::Enum(ref def, _) => {
175 for variant in &def.variants {
176 let variant_level = self.update(variant.node.data.id(), item_level);
177 for field in variant.node.data.fields() {
178 self.update(field.id, variant_level);
182 hir::ItemKind::Impl(.., None, _, ref impl_item_refs) => {
183 for impl_item_ref in impl_item_refs {
184 if impl_item_ref.vis.node.is_pub() {
185 self.update(impl_item_ref.id.node_id, item_level);
189 hir::ItemKind::Impl(.., Some(_), _, ref impl_item_refs) => {
190 for impl_item_ref in impl_item_refs {
191 self.update(impl_item_ref.id.node_id, item_level);
194 hir::ItemKind::Trait(.., ref trait_item_refs) => {
195 for trait_item_ref in trait_item_refs {
196 self.update(trait_item_ref.id.node_id, item_level);
199 hir::ItemKind::Struct(ref def, _) | hir::ItemKind::Union(ref def, _) => {
200 if !def.is_struct() {
201 self.update(def.id(), item_level);
203 for field in def.fields() {
204 if field.vis.node.is_pub() {
205 self.update(field.id, item_level);
209 hir::ItemKind::ForeignMod(ref foreign_mod) => {
210 for foreign_item in &foreign_mod.items {
211 if foreign_item.vis.node.is_pub() {
212 self.update(foreign_item.id, item_level);
216 hir::ItemKind::Existential(..) |
217 hir::ItemKind::Use(..) |
218 hir::ItemKind::Static(..) |
219 hir::ItemKind::Const(..) |
220 hir::ItemKind::GlobalAsm(..) |
221 hir::ItemKind::Ty(..) |
222 hir::ItemKind::Mod(..) |
223 hir::ItemKind::TraitAlias(..) |
224 hir::ItemKind::Fn(..) |
225 hir::ItemKind::ExternCrate(..) => {}
228 // Mark all items in interfaces of reachable items as reachable
230 // The interface is empty
231 hir::ItemKind::ExternCrate(..) => {}
232 // All nested items are checked by visit_item
233 hir::ItemKind::Mod(..) => {}
234 // Re-exports are handled in visit_mod
235 hir::ItemKind::Use(..) => {}
236 // The interface is empty
237 hir::ItemKind::GlobalAsm(..) => {}
238 hir::ItemKind::Existential(hir::ExistTy { impl_trait_fn: Some(_), .. }) => {
239 if item_level.is_some() {
240 // Reach the (potentially private) type and the API being exposed
241 self.reach(item.id).ty().predicates();
245 hir::ItemKind::Const(..) | hir::ItemKind::Static(..) |
246 hir::ItemKind::Existential(..) |
247 hir::ItemKind::Fn(..) | hir::ItemKind::Ty(..) => {
248 if item_level.is_some() {
249 self.reach(item.id).generics().predicates().ty();
252 hir::ItemKind::Trait(.., ref trait_item_refs) => {
253 if item_level.is_some() {
254 self.reach(item.id).generics().predicates();
256 for trait_item_ref in trait_item_refs {
257 let mut reach = self.reach(trait_item_ref.id.node_id);
258 reach.generics().predicates();
260 if trait_item_ref.kind == hir::AssociatedItemKind::Type &&
261 !trait_item_ref.defaultness.has_value() {
269 hir::ItemKind::TraitAlias(..) => {
270 if item_level.is_some() {
271 self.reach(item.id).generics().predicates();
274 // Visit everything except for private impl items
275 hir::ItemKind::Impl(.., ref trait_ref, _, ref impl_item_refs) => {
276 if item_level.is_some() {
277 self.reach(item.id).generics().predicates().impl_trait_ref();
279 for impl_item_ref in impl_item_refs {
280 let id = impl_item_ref.id.node_id;
281 if trait_ref.is_some() || self.get(id).is_some() {
282 self.reach(id).generics().predicates().ty();
288 // Visit everything, but enum variants have their own levels
289 hir::ItemKind::Enum(ref def, _) => {
290 if item_level.is_some() {
291 self.reach(item.id).generics().predicates();
293 for variant in &def.variants {
294 if self.get(variant.node.data.id()).is_some() {
295 for field in variant.node.data.fields() {
296 self.reach(field.id).ty();
298 // Corner case: if the variant is reachable, but its
299 // enum is not, make the enum reachable as well.
300 self.update(item.id, Some(AccessLevel::Reachable));
304 // Visit everything, but foreign items have their own levels
305 hir::ItemKind::ForeignMod(ref foreign_mod) => {
306 for foreign_item in &foreign_mod.items {
307 if self.get(foreign_item.id).is_some() {
308 self.reach(foreign_item.id).generics().predicates().ty();
312 // Visit everything except for private fields
313 hir::ItemKind::Struct(ref struct_def, _) |
314 hir::ItemKind::Union(ref struct_def, _) => {
315 if item_level.is_some() {
316 self.reach(item.id).generics().predicates();
317 for field in struct_def.fields() {
318 if self.get(field.id).is_some() {
319 self.reach(field.id).ty();
326 let orig_level = self.prev_level;
327 self.prev_level = item_level;
329 intravisit::walk_item(self, item);
331 self.prev_level = orig_level;
334 fn visit_block(&mut self, b: &'tcx hir::Block) {
335 let orig_level = replace(&mut self.prev_level, None);
337 // Blocks can have public items, for example impls, but they always
338 // start as completely private regardless of publicity of a function,
339 // constant, type, field, etc. in which this block resides
340 intravisit::walk_block(self, b);
342 self.prev_level = orig_level;
345 fn visit_mod(&mut self, m: &'tcx hir::Mod, _sp: Span, id: ast::NodeId) {
346 // This code is here instead of in visit_item so that the
347 // crate module gets processed as well.
348 if self.prev_level.is_some() {
349 let def_id = self.tcx.hir.local_def_id(id);
350 if let Some(exports) = self.tcx.module_exports(def_id) {
351 for export in exports.iter() {
352 if let Some(node_id) = self.tcx.hir.as_local_node_id(export.def.def_id()) {
353 if export.vis == ty::Visibility::Public {
354 self.update(node_id, Some(AccessLevel::Exported));
361 intravisit::walk_mod(self, m, id);
364 fn visit_macro_def(&mut self, md: &'tcx hir::MacroDef) {
366 self.update(md.id, Some(AccessLevel::Public));
370 let module_did = ty::DefIdTree::parent(self.tcx, self.tcx.hir.local_def_id(md.id)).unwrap();
371 let mut module_id = self.tcx.hir.as_local_node_id(module_did).unwrap();
372 let level = if md.vis.node.is_pub() { self.get(module_id) } else { None };
373 let level = self.update(md.id, level);
379 let module = if module_id == ast::CRATE_NODE_ID {
380 &self.tcx.hir.krate().module
381 } else if let hir::ItemKind::Mod(ref module) = self.tcx.hir.expect_item(module_id).node
387 for id in &module.item_ids {
388 self.update(id.id, level);
390 let def_id = self.tcx.hir.local_def_id(module_id);
391 if let Some(exports) = self.tcx.module_exports(def_id) {
392 for export in exports.iter() {
393 if let Some(node_id) = self.tcx.hir.as_local_node_id(export.def.def_id()) {
394 self.update(node_id, level);
399 if module_id == ast::CRATE_NODE_ID {
402 module_id = self.tcx.hir.get_parent_node(module_id);
407 impl<'b, 'a, 'tcx> ReachEverythingInTheInterfaceVisitor<'b, 'a, 'tcx> {
408 fn generics(&mut self) -> &mut Self {
409 for param in &self.ev.tcx.generics_of(self.item_def_id).params {
411 GenericParamDefKind::Type { has_default, .. } => {
413 self.ev.tcx.type_of(param.def_id).visit_with(self);
416 GenericParamDefKind::Lifetime => {}
422 fn predicates(&mut self) -> &mut Self {
423 let predicates = self.ev.tcx.predicates_of(self.item_def_id);
424 for predicate in &predicates.predicates {
425 predicate.visit_with(self);
427 &ty::Predicate::Trait(poly_predicate) => {
428 self.check_trait_ref(poly_predicate.skip_binder().trait_ref);
430 &ty::Predicate::Projection(poly_predicate) => {
431 let tcx = self.ev.tcx;
432 self.check_trait_ref(
433 poly_predicate.skip_binder().projection_ty.trait_ref(tcx)
442 fn ty(&mut self) -> &mut Self {
443 let ty = self.ev.tcx.type_of(self.item_def_id);
445 if let ty::TyFnDef(def_id, _) = ty.sty {
446 if def_id == self.item_def_id {
447 self.ev.tcx.fn_sig(def_id).visit_with(self);
453 fn impl_trait_ref(&mut self) -> &mut Self {
454 if let Some(impl_trait_ref) = self.ev.tcx.impl_trait_ref(self.item_def_id) {
455 self.check_trait_ref(impl_trait_ref);
456 impl_trait_ref.super_visit_with(self);
461 fn check_trait_ref(&mut self, trait_ref: ty::TraitRef<'tcx>) {
462 if let Some(node_id) = self.ev.tcx.hir.as_local_node_id(trait_ref.def_id) {
463 let item = self.ev.tcx.hir.expect_item(node_id);
464 self.ev.update(item.id, Some(AccessLevel::Reachable));
469 impl<'b, 'a, 'tcx> TypeVisitor<'tcx> for ReachEverythingInTheInterfaceVisitor<'b, 'a, 'tcx> {
470 fn visit_ty(&mut self, ty: Ty<'tcx>) -> bool {
471 let ty_def_id = match ty.sty {
472 ty::TyAdt(adt, _) => Some(adt.did),
473 ty::TyForeign(did) => Some(did),
474 ty::TyDynamic(ref obj, ..) => obj.principal().map(|p| p.def_id()),
475 ty::TyProjection(ref proj) => Some(proj.item_def_id),
476 ty::TyFnDef(def_id, ..) |
477 ty::TyClosure(def_id, ..) |
478 ty::TyGenerator(def_id, ..) |
479 ty::TyAnon(def_id, _) => Some(def_id),
483 if let Some(def_id) = ty_def_id {
484 if let Some(node_id) = self.ev.tcx.hir.as_local_node_id(def_id) {
485 self.ev.update(node_id, Some(AccessLevel::Reachable));
489 ty.super_visit_with(self)
493 //////////////////////////////////////////////////////////////////////////////////////
494 /// Name privacy visitor, checks privacy and reports violations.
495 /// Most of name privacy checks are performed during the main resolution phase,
496 /// or later in type checking when field accesses and associated items are resolved.
497 /// This pass performs remaining checks for fields in struct expressions and patterns.
498 //////////////////////////////////////////////////////////////////////////////////////
500 struct NamePrivacyVisitor<'a, 'tcx: 'a> {
501 tcx: TyCtxt<'a, 'tcx, 'tcx>,
502 tables: &'a ty::TypeckTables<'tcx>,
503 current_item: ast::NodeId,
504 empty_tables: &'a ty::TypeckTables<'tcx>,
507 impl<'a, 'tcx> NamePrivacyVisitor<'a, 'tcx> {
508 // Checks that a field in a struct constructor (expression or pattern) is accessible.
509 fn check_field(&mut self,
510 use_ctxt: Span, // Syntax context of the field name at the use site
511 span: Span, // Span of the field pattern, e.g. `x: 0`
512 def: &'tcx ty::AdtDef, // Definition of the struct or enum
513 field: &'tcx ty::FieldDef) { // Definition of the field
514 let ident = Ident::new(keywords::Invalid.name(), use_ctxt);
515 let def_id = self.tcx.adjust_ident(ident, def.did, self.current_item).1;
516 if !def.is_enum() && !field.vis.is_accessible_from(def_id, self.tcx) {
517 struct_span_err!(self.tcx.sess, span, E0451, "field `{}` of {} `{}` is private",
518 field.ident, def.variant_descr(), self.tcx.item_path_str(def.did))
519 .span_label(span, format!("field `{}` is private", field.ident))
525 // Set the correct TypeckTables for the given `item_id` (or an empty table if
526 // there is no TypeckTables for the item).
527 fn update_tables<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
528 item_id: ast::NodeId,
529 tables: &mut &'a ty::TypeckTables<'tcx>,
530 empty_tables: &'a ty::TypeckTables<'tcx>)
531 -> &'a ty::TypeckTables<'tcx> {
532 let def_id = tcx.hir.local_def_id(item_id);
534 if tcx.has_typeck_tables(def_id) {
535 replace(tables, tcx.typeck_tables_of(def_id))
537 replace(tables, empty_tables)
541 impl<'a, 'tcx> Visitor<'tcx> for NamePrivacyVisitor<'a, 'tcx> {
542 /// We want to visit items in the context of their containing
543 /// module and so forth, so supply a crate for doing a deep walk.
544 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
545 NestedVisitorMap::All(&self.tcx.hir)
548 fn visit_nested_body(&mut self, body: hir::BodyId) {
549 let orig_tables = replace(&mut self.tables, self.tcx.body_tables(body));
550 let body = self.tcx.hir.body(body);
551 self.visit_body(body);
552 self.tables = orig_tables;
555 fn visit_item(&mut self, item: &'tcx hir::Item) {
556 let orig_current_item = replace(&mut self.current_item, item.id);
557 let orig_tables = update_tables(self.tcx, item.id, &mut self.tables, self.empty_tables);
558 intravisit::walk_item(self, item);
559 self.current_item = orig_current_item;
560 self.tables = orig_tables;
563 fn visit_trait_item(&mut self, ti: &'tcx hir::TraitItem) {
564 let orig_tables = update_tables(self.tcx, ti.id, &mut self.tables, self.empty_tables);
565 intravisit::walk_trait_item(self, ti);
566 self.tables = orig_tables;
569 fn visit_impl_item(&mut self, ii: &'tcx hir::ImplItem) {
570 let orig_tables = update_tables(self.tcx, ii.id, &mut self.tables, self.empty_tables);
571 intravisit::walk_impl_item(self, ii);
572 self.tables = orig_tables;
575 fn visit_expr(&mut self, expr: &'tcx hir::Expr) {
577 hir::ExprKind::Struct(ref qpath, ref fields, ref base) => {
578 let def = self.tables.qpath_def(qpath, expr.hir_id);
579 let adt = self.tables.expr_ty(expr).ty_adt_def().unwrap();
580 let variant = adt.variant_of_def(def);
581 if let Some(ref base) = *base {
582 // If the expression uses FRU we need to make sure all the unmentioned fields
583 // are checked for privacy (RFC 736). Rather than computing the set of
584 // unmentioned fields, just check them all.
585 for (vf_index, variant_field) in variant.fields.iter().enumerate() {
586 let field = fields.iter().find(|f| {
587 self.tcx.field_index(f.id, self.tables) == vf_index
589 let (use_ctxt, span) = match field {
590 Some(field) => (field.ident.span, field.span),
591 None => (base.span, base.span),
593 self.check_field(use_ctxt, span, adt, variant_field);
596 for field in fields {
597 let use_ctxt = field.ident.span;
598 let index = self.tcx.field_index(field.id, self.tables);
599 self.check_field(use_ctxt, field.span, adt, &variant.fields[index]);
606 intravisit::walk_expr(self, expr);
609 fn visit_pat(&mut self, pat: &'tcx hir::Pat) {
611 PatKind::Struct(ref qpath, ref fields, _) => {
612 let def = self.tables.qpath_def(qpath, pat.hir_id);
613 let adt = self.tables.pat_ty(pat).ty_adt_def().unwrap();
614 let variant = adt.variant_of_def(def);
615 for field in fields {
616 let use_ctxt = field.node.ident.span;
617 let index = self.tcx.field_index(field.node.id, self.tables);
618 self.check_field(use_ctxt, field.span, adt, &variant.fields[index]);
624 intravisit::walk_pat(self, pat);
628 ////////////////////////////////////////////////////////////////////////////////////////////
629 /// Type privacy visitor, checks types for privacy and reports violations.
630 /// Both explicitly written types and inferred types of expressions and patters are checked.
631 /// Checks are performed on "semantic" types regardless of names and their hygiene.
632 ////////////////////////////////////////////////////////////////////////////////////////////
634 struct TypePrivacyVisitor<'a, 'tcx: 'a> {
635 tcx: TyCtxt<'a, 'tcx, 'tcx>,
636 tables: &'a ty::TypeckTables<'tcx>,
640 empty_tables: &'a ty::TypeckTables<'tcx>,
641 visited_anon_tys: FxHashSet<DefId>
644 impl<'a, 'tcx> TypePrivacyVisitor<'a, 'tcx> {
645 fn def_id_visibility(&self, did: DefId) -> ty::Visibility {
646 match self.tcx.hir.as_local_node_id(did) {
648 let vis = match self.tcx.hir.get(node_id) {
649 hir::map::NodeItem(item) => &item.vis,
650 hir::map::NodeForeignItem(foreign_item) => &foreign_item.vis,
651 hir::map::NodeImplItem(impl_item) => &impl_item.vis,
652 hir::map::NodeTraitItem(..) |
653 hir::map::NodeVariant(..) => {
654 return self.def_id_visibility(self.tcx.hir.get_parent_did(node_id));
656 hir::map::NodeStructCtor(vdata) => {
657 let struct_node_id = self.tcx.hir.get_parent(node_id);
658 let struct_vis = match self.tcx.hir.get(struct_node_id) {
659 hir::map::NodeItem(item) => &item.vis,
660 node => bug!("unexpected node kind: {:?}", node),
663 = ty::Visibility::from_hir(struct_vis, struct_node_id, self.tcx);
664 for field in vdata.fields() {
665 let field_vis = ty::Visibility::from_hir(&field.vis, node_id, self.tcx);
666 if ctor_vis.is_at_least(field_vis, self.tcx) {
667 ctor_vis = field_vis;
671 // If the structure is marked as non_exhaustive then lower the
672 // visibility to within the crate.
673 let struct_def_id = self.tcx.hir.get_parent_did(node_id);
674 let adt_def = self.tcx.adt_def(struct_def_id);
675 if adt_def.is_non_exhaustive() && ctor_vis == ty::Visibility::Public {
676 ctor_vis = ty::Visibility::Restricted(
677 DefId::local(CRATE_DEF_INDEX));
682 node => bug!("unexpected node kind: {:?}", node)
684 ty::Visibility::from_hir(vis, node_id, self.tcx)
686 None => self.tcx.visibility(did),
690 fn item_is_accessible(&self, did: DefId) -> bool {
691 self.def_id_visibility(did).is_accessible_from(self.current_item, self.tcx)
694 // Take node ID of an expression or pattern and check its type for privacy.
695 fn check_expr_pat_type(&mut self, id: hir::HirId, span: Span) -> bool {
697 if self.tables.node_id_to_type(id).visit_with(self) {
700 if self.tables.node_substs(id).visit_with(self) {
703 if let Some(adjustments) = self.tables.adjustments().get(id) {
704 for adjustment in adjustments {
705 if adjustment.target.visit_with(self) {
713 fn check_trait_ref(&mut self, trait_ref: ty::TraitRef<'tcx>) -> bool {
714 if !self.item_is_accessible(trait_ref.def_id) {
715 let msg = format!("trait `{}` is private", trait_ref);
716 self.tcx.sess.span_err(self.span, &msg);
720 trait_ref.super_visit_with(self)
724 impl<'a, 'tcx> Visitor<'tcx> for TypePrivacyVisitor<'a, 'tcx> {
725 /// We want to visit items in the context of their containing
726 /// module and so forth, so supply a crate for doing a deep walk.
727 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
728 NestedVisitorMap::All(&self.tcx.hir)
731 fn visit_nested_body(&mut self, body: hir::BodyId) {
732 let orig_tables = replace(&mut self.tables, self.tcx.body_tables(body));
733 let orig_in_body = replace(&mut self.in_body, true);
734 let body = self.tcx.hir.body(body);
735 self.visit_body(body);
736 self.tables = orig_tables;
737 self.in_body = orig_in_body;
740 fn visit_ty(&mut self, hir_ty: &'tcx hir::Ty) {
741 self.span = hir_ty.span;
744 if self.tables.node_id_to_type(hir_ty.hir_id).visit_with(self) {
748 // Types in signatures.
749 // FIXME: This is very ineffective. Ideally each HIR type should be converted
750 // into a semantic type only once and the result should be cached somehow.
751 if rustc_typeck::hir_ty_to_ty(self.tcx, hir_ty).visit_with(self) {
756 intravisit::walk_ty(self, hir_ty);
759 fn visit_trait_ref(&mut self, trait_ref: &'tcx hir::TraitRef) {
760 self.span = trait_ref.path.span;
762 // Avoid calling `hir_trait_to_predicates` in bodies, it will ICE.
763 // The traits' privacy in bodies is already checked as a part of trait object types.
764 let (principal, projections) =
765 rustc_typeck::hir_trait_to_predicates(self.tcx, trait_ref);
766 if self.check_trait_ref(*principal.skip_binder()) {
769 for poly_predicate in projections {
771 if self.check_trait_ref(poly_predicate.skip_binder().projection_ty.trait_ref(tcx)) {
777 intravisit::walk_trait_ref(self, trait_ref);
780 // Check types of expressions
781 fn visit_expr(&mut self, expr: &'tcx hir::Expr) {
782 if self.check_expr_pat_type(expr.hir_id, expr.span) {
783 // Do not check nested expressions if the error already happened.
787 hir::ExprKind::Assign(.., ref rhs) | hir::ExprKind::Match(ref rhs, ..) => {
788 // Do not report duplicate errors for `x = y` and `match x { ... }`.
789 if self.check_expr_pat_type(rhs.hir_id, rhs.span) {
793 hir::ExprKind::MethodCall(_, span, _) => {
794 // Method calls have to be checked specially.
796 if let Some(def) = self.tables.type_dependent_defs().get(expr.hir_id) {
797 let def_id = def.def_id();
798 if self.tcx.type_of(def_id).visit_with(self) {
802 self.tcx.sess.delay_span_bug(expr.span,
803 "no type-dependent def for method call");
809 intravisit::walk_expr(self, expr);
812 // Prohibit access to associated items with insufficient nominal visibility.
814 // Additionally, until better reachability analysis for macros 2.0 is available,
815 // we prohibit access to private statics from other crates, this allows to give
816 // more code internal visibility at link time. (Access to private functions
817 // is already prohibited by type privacy for function types.)
818 fn visit_qpath(&mut self, qpath: &'tcx hir::QPath, id: hir::HirId, span: Span) {
819 let def = match *qpath {
820 hir::QPath::Resolved(_, ref path) => match path.def {
821 Def::Method(..) | Def::AssociatedConst(..) |
822 Def::AssociatedTy(..) | Def::Static(..) => Some(path.def),
825 hir::QPath::TypeRelative(..) => {
826 self.tables.type_dependent_defs().get(id).cloned()
829 if let Some(def) = def {
830 let def_id = def.def_id();
831 let is_local_static = if let Def::Static(..) = def { def_id.is_local() } else { false };
832 if !self.item_is_accessible(def_id) && !is_local_static {
833 let name = match *qpath {
834 hir::QPath::Resolved(_, ref path) => path.to_string(),
835 hir::QPath::TypeRelative(_, ref segment) => segment.ident.to_string(),
837 let msg = format!("{} `{}` is private", def.kind_name(), name);
838 self.tcx.sess.span_err(span, &msg);
843 intravisit::walk_qpath(self, qpath, id, span);
846 // Check types of patterns
847 fn visit_pat(&mut self, pattern: &'tcx hir::Pat) {
848 if self.check_expr_pat_type(pattern.hir_id, pattern.span) {
849 // Do not check nested patterns if the error already happened.
853 intravisit::walk_pat(self, pattern);
856 fn visit_local(&mut self, local: &'tcx hir::Local) {
857 if let Some(ref init) = local.init {
858 if self.check_expr_pat_type(init.hir_id, init.span) {
859 // Do not report duplicate errors for `let x = y`.
864 intravisit::walk_local(self, local);
867 // Check types in item interfaces
868 fn visit_item(&mut self, item: &'tcx hir::Item) {
869 let orig_current_item = self.current_item;
870 let orig_tables = update_tables(self.tcx,
874 let orig_in_body = replace(&mut self.in_body, false);
875 self.current_item = self.tcx.hir.local_def_id(item.id);
876 intravisit::walk_item(self, item);
877 self.tables = orig_tables;
878 self.in_body = orig_in_body;
879 self.current_item = orig_current_item;
882 fn visit_trait_item(&mut self, ti: &'tcx hir::TraitItem) {
883 let orig_tables = update_tables(self.tcx, ti.id, &mut self.tables, self.empty_tables);
884 intravisit::walk_trait_item(self, ti);
885 self.tables = orig_tables;
888 fn visit_impl_item(&mut self, ii: &'tcx hir::ImplItem) {
889 let orig_tables = update_tables(self.tcx, ii.id, &mut self.tables, self.empty_tables);
890 intravisit::walk_impl_item(self, ii);
891 self.tables = orig_tables;
895 impl<'a, 'tcx> TypeVisitor<'tcx> for TypePrivacyVisitor<'a, 'tcx> {
896 fn visit_ty(&mut self, ty: Ty<'tcx>) -> bool {
898 ty::TyAdt(&ty::AdtDef { did: def_id, .. }, ..) |
899 ty::TyFnDef(def_id, ..) |
900 ty::TyForeign(def_id) => {
901 if !self.item_is_accessible(def_id) {
902 let msg = format!("type `{}` is private", ty);
903 self.tcx.sess.span_err(self.span, &msg);
906 if let ty::TyFnDef(..) = ty.sty {
907 if self.tcx.fn_sig(def_id).visit_with(self) {
911 // Inherent static methods don't have self type in substs,
912 // we have to check it additionally.
913 if let Some(assoc_item) = self.tcx.opt_associated_item(def_id) {
914 if let ty::ImplContainer(impl_def_id) = assoc_item.container {
915 if self.tcx.type_of(impl_def_id).visit_with(self) {
921 ty::TyDynamic(ref predicates, ..) => {
922 let is_private = predicates.skip_binder().iter().any(|predicate| {
923 let def_id = match *predicate {
924 ty::ExistentialPredicate::Trait(trait_ref) => trait_ref.def_id,
925 ty::ExistentialPredicate::Projection(proj) =>
926 proj.trait_ref(self.tcx).def_id,
927 ty::ExistentialPredicate::AutoTrait(def_id) => def_id,
929 !self.item_is_accessible(def_id)
932 let msg = format!("type `{}` is private", ty);
933 self.tcx.sess.span_err(self.span, &msg);
937 ty::TyProjection(ref proj) => {
939 if self.check_trait_ref(proj.trait_ref(tcx)) {
943 ty::TyAnon(def_id, ..) => {
944 for predicate in &self.tcx.predicates_of(def_id).predicates {
945 let trait_ref = match *predicate {
946 ty::Predicate::Trait(ref poly_trait_predicate) => {
947 Some(poly_trait_predicate.skip_binder().trait_ref)
949 ty::Predicate::Projection(ref poly_projection_predicate) => {
950 if poly_projection_predicate.skip_binder().ty.visit_with(self) {
953 Some(poly_projection_predicate.skip_binder()
954 .projection_ty.trait_ref(self.tcx))
956 ty::Predicate::TypeOutlives(..) => None,
957 _ => bug!("unexpected predicate: {:?}", predicate),
959 if let Some(trait_ref) = trait_ref {
960 if !self.item_is_accessible(trait_ref.def_id) {
961 let msg = format!("trait `{}` is private", trait_ref);
962 self.tcx.sess.span_err(self.span, &msg);
965 for subst in trait_ref.substs.iter() {
966 // Skip repeated `TyAnon`s to avoid infinite recursion.
967 if let UnpackedKind::Type(ty) = subst.unpack() {
968 if let ty::TyAnon(def_id, ..) = ty.sty {
969 if !self.visited_anon_tys.insert(def_id) {
974 if subst.visit_with(self) {
984 ty.super_visit_with(self)
988 ///////////////////////////////////////////////////////////////////////////////
989 /// Obsolete visitors for checking for private items in public interfaces.
990 /// These visitors are supposed to be kept in frozen state and produce an
991 /// "old error node set". For backward compatibility the new visitor reports
992 /// warnings instead of hard errors when the erroneous node is not in this old set.
993 ///////////////////////////////////////////////////////////////////////////////
995 struct ObsoleteVisiblePrivateTypesVisitor<'a, 'tcx: 'a> {
996 tcx: TyCtxt<'a, 'tcx, 'tcx>,
997 access_levels: &'a AccessLevels,
999 // set of errors produced by this obsolete visitor
1000 old_error_set: NodeSet,
1003 struct ObsoleteCheckTypeForPrivatenessVisitor<'a, 'b: 'a, 'tcx: 'b> {
1004 inner: &'a ObsoleteVisiblePrivateTypesVisitor<'b, 'tcx>,
1005 /// whether the type refers to private types.
1006 contains_private: bool,
1007 /// whether we've recurred at all (i.e. if we're pointing at the
1008 /// first type on which visit_ty was called).
1009 at_outer_type: bool,
1010 // whether that first type is a public path.
1011 outer_type_is_public_path: bool,
1014 impl<'a, 'tcx> ObsoleteVisiblePrivateTypesVisitor<'a, 'tcx> {
1015 fn path_is_private_type(&self, path: &hir::Path) -> bool {
1016 let did = match path.def {
1017 Def::PrimTy(..) | Def::SelfTy(..) | Def::Err => return false,
1018 def => def.def_id(),
1021 // A path can only be private if:
1022 // it's in this crate...
1023 if let Some(node_id) = self.tcx.hir.as_local_node_id(did) {
1024 // .. and it corresponds to a private type in the AST (this returns
1025 // None for type parameters)
1026 match self.tcx.hir.find(node_id) {
1027 Some(hir::map::NodeItem(ref item)) => !item.vis.node.is_pub(),
1028 Some(_) | None => false,
1035 fn trait_is_public(&self, trait_id: ast::NodeId) -> bool {
1036 // FIXME: this would preferably be using `exported_items`, but all
1037 // traits are exported currently (see `EmbargoVisitor.exported_trait`)
1038 self.access_levels.is_public(trait_id)
1041 fn check_generic_bound(&mut self, bound: &hir::GenericBound) {
1042 if let hir::GenericBound::Trait(ref trait_ref, _) = *bound {
1043 if self.path_is_private_type(&trait_ref.trait_ref.path) {
1044 self.old_error_set.insert(trait_ref.trait_ref.ref_id);
1049 fn item_is_public(&self, id: &ast::NodeId, vis: &hir::Visibility) -> bool {
1050 self.access_levels.is_reachable(*id) || vis.node.is_pub()
1054 impl<'a, 'b, 'tcx, 'v> Visitor<'v> for ObsoleteCheckTypeForPrivatenessVisitor<'a, 'b, 'tcx> {
1055 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'v> {
1056 NestedVisitorMap::None
1059 fn visit_ty(&mut self, ty: &hir::Ty) {
1060 if let hir::TyKind::Path(hir::QPath::Resolved(_, ref path)) = ty.node {
1061 if self.inner.path_is_private_type(path) {
1062 self.contains_private = true;
1063 // found what we're looking for so let's stop
1068 if let hir::TyKind::Path(_) = ty.node {
1069 if self.at_outer_type {
1070 self.outer_type_is_public_path = true;
1073 self.at_outer_type = false;
1074 intravisit::walk_ty(self, ty)
1077 // don't want to recurse into [, .. expr]
1078 fn visit_expr(&mut self, _: &hir::Expr) {}
1081 impl<'a, 'tcx> Visitor<'tcx> for ObsoleteVisiblePrivateTypesVisitor<'a, 'tcx> {
1082 /// We want to visit items in the context of their containing
1083 /// module and so forth, so supply a crate for doing a deep walk.
1084 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1085 NestedVisitorMap::All(&self.tcx.hir)
1088 fn visit_item(&mut self, item: &'tcx hir::Item) {
1090 // contents of a private mod can be re-exported, so we need
1091 // to check internals.
1092 hir::ItemKind::Mod(_) => {}
1094 // An `extern {}` doesn't introduce a new privacy
1095 // namespace (the contents have their own privacies).
1096 hir::ItemKind::ForeignMod(_) => {}
1098 hir::ItemKind::Trait(.., ref bounds, _) => {
1099 if !self.trait_is_public(item.id) {
1103 for bound in bounds.iter() {
1104 self.check_generic_bound(bound)
1108 // impls need some special handling to try to offer useful
1109 // error messages without (too many) false positives
1110 // (i.e. we could just return here to not check them at
1111 // all, or some worse estimation of whether an impl is
1112 // publicly visible).
1113 hir::ItemKind::Impl(.., ref g, ref trait_ref, ref self_, ref impl_item_refs) => {
1114 // `impl [... for] Private` is never visible.
1115 let self_contains_private;
1116 // impl [... for] Public<...>, but not `impl [... for]
1117 // Vec<Public>` or `(Public,)` etc.
1118 let self_is_public_path;
1120 // check the properties of the Self type:
1122 let mut visitor = ObsoleteCheckTypeForPrivatenessVisitor {
1124 contains_private: false,
1125 at_outer_type: true,
1126 outer_type_is_public_path: false,
1128 visitor.visit_ty(&self_);
1129 self_contains_private = visitor.contains_private;
1130 self_is_public_path = visitor.outer_type_is_public_path;
1133 // miscellaneous info about the impl
1135 // `true` iff this is `impl Private for ...`.
1136 let not_private_trait =
1137 trait_ref.as_ref().map_or(true, // no trait counts as public trait
1139 let did = tr.path.def.def_id();
1141 if let Some(node_id) = self.tcx.hir.as_local_node_id(did) {
1142 self.trait_is_public(node_id)
1144 true // external traits must be public
1148 // `true` iff this is a trait impl or at least one method is public.
1150 // `impl Public { $( fn ...() {} )* }` is not visible.
1152 // This is required over just using the methods' privacy
1153 // directly because we might have `impl<T: Foo<Private>> ...`,
1154 // and we shouldn't warn about the generics if all the methods
1155 // are private (because `T` won't be visible externally).
1156 let trait_or_some_public_method =
1157 trait_ref.is_some() ||
1158 impl_item_refs.iter()
1159 .any(|impl_item_ref| {
1160 let impl_item = self.tcx.hir.impl_item(impl_item_ref.id);
1161 match impl_item.node {
1162 hir::ImplItemKind::Const(..) |
1163 hir::ImplItemKind::Method(..) => {
1164 self.access_levels.is_reachable(impl_item.id)
1166 hir::ImplItemKind::Existential(..) |
1167 hir::ImplItemKind::Type(_) => false,
1171 if !self_contains_private &&
1172 not_private_trait &&
1173 trait_or_some_public_method {
1175 intravisit::walk_generics(self, g);
1179 for impl_item_ref in impl_item_refs {
1180 // This is where we choose whether to walk down
1181 // further into the impl to check its items. We
1182 // should only walk into public items so that we
1183 // don't erroneously report errors for private
1184 // types in private items.
1185 let impl_item = self.tcx.hir.impl_item(impl_item_ref.id);
1186 match impl_item.node {
1187 hir::ImplItemKind::Const(..) |
1188 hir::ImplItemKind::Method(..)
1189 if self.item_is_public(&impl_item.id, &impl_item.vis) =>
1191 intravisit::walk_impl_item(self, impl_item)
1193 hir::ImplItemKind::Type(..) => {
1194 intravisit::walk_impl_item(self, impl_item)
1201 // Any private types in a trait impl fall into three
1203 // 1. mentioned in the trait definition
1204 // 2. mentioned in the type params/generics
1205 // 3. mentioned in the associated types of the impl
1207 // Those in 1. can only occur if the trait is in
1208 // this crate and will've been warned about on the
1209 // trait definition (there's no need to warn twice
1210 // so we don't check the methods).
1212 // Those in 2. are warned via walk_generics and this
1214 intravisit::walk_path(self, &tr.path);
1216 // Those in 3. are warned with this call.
1217 for impl_item_ref in impl_item_refs {
1218 let impl_item = self.tcx.hir.impl_item(impl_item_ref.id);
1219 if let hir::ImplItemKind::Type(ref ty) = impl_item.node {
1225 } else if trait_ref.is_none() && self_is_public_path {
1226 // impl Public<Private> { ... }. Any public static
1227 // methods will be visible as `Public::foo`.
1228 let mut found_pub_static = false;
1229 for impl_item_ref in impl_item_refs {
1230 if self.item_is_public(&impl_item_ref.id.node_id, &impl_item_ref.vis) {
1231 let impl_item = self.tcx.hir.impl_item(impl_item_ref.id);
1232 match impl_item_ref.kind {
1233 hir::AssociatedItemKind::Const => {
1234 found_pub_static = true;
1235 intravisit::walk_impl_item(self, impl_item);
1237 hir::AssociatedItemKind::Method { has_self: false } => {
1238 found_pub_static = true;
1239 intravisit::walk_impl_item(self, impl_item);
1245 if found_pub_static {
1246 intravisit::walk_generics(self, g)
1252 // `type ... = ...;` can contain private types, because
1253 // we're introducing a new name.
1254 hir::ItemKind::Ty(..) => return,
1256 // not at all public, so we don't care
1257 _ if !self.item_is_public(&item.id, &item.vis) => {
1264 // We've carefully constructed it so that if we're here, then
1265 // any `visit_ty`'s will be called on things that are in
1266 // public signatures, i.e. things that we're interested in for
1268 intravisit::walk_item(self, item);
1271 fn visit_generics(&mut self, generics: &'tcx hir::Generics) {
1272 generics.params.iter().for_each(|param| match param.kind {
1273 GenericParamKind::Lifetime { .. } => {}
1274 GenericParamKind::Type { .. } => {
1275 for bound in ¶m.bounds {
1276 self.check_generic_bound(bound);
1280 for predicate in &generics.where_clause.predicates {
1282 &hir::WherePredicate::BoundPredicate(ref bound_pred) => {
1283 for bound in bound_pred.bounds.iter() {
1284 self.check_generic_bound(bound)
1287 &hir::WherePredicate::RegionPredicate(_) => {}
1288 &hir::WherePredicate::EqPredicate(ref eq_pred) => {
1289 self.visit_ty(&eq_pred.rhs_ty);
1295 fn visit_foreign_item(&mut self, item: &'tcx hir::ForeignItem) {
1296 if self.access_levels.is_reachable(item.id) {
1297 intravisit::walk_foreign_item(self, item)
1301 fn visit_ty(&mut self, t: &'tcx hir::Ty) {
1302 if let hir::TyKind::Path(hir::QPath::Resolved(_, ref path)) = t.node {
1303 if self.path_is_private_type(path) {
1304 self.old_error_set.insert(t.id);
1307 intravisit::walk_ty(self, t)
1310 fn visit_variant(&mut self,
1311 v: &'tcx hir::Variant,
1312 g: &'tcx hir::Generics,
1313 item_id: ast::NodeId) {
1314 if self.access_levels.is_reachable(v.node.data.id()) {
1315 self.in_variant = true;
1316 intravisit::walk_variant(self, v, g, item_id);
1317 self.in_variant = false;
1321 fn visit_struct_field(&mut self, s: &'tcx hir::StructField) {
1322 if s.vis.node.is_pub() || self.in_variant {
1323 intravisit::walk_struct_field(self, s);
1327 // we don't need to introspect into these at all: an
1328 // expression/block context can't possibly contain exported things.
1329 // (Making them no-ops stops us from traversing the whole AST without
1330 // having to be super careful about our `walk_...` calls above.)
1331 fn visit_block(&mut self, _: &'tcx hir::Block) {}
1332 fn visit_expr(&mut self, _: &'tcx hir::Expr) {}
1335 ///////////////////////////////////////////////////////////////////////////////
1336 /// SearchInterfaceForPrivateItemsVisitor traverses an item's interface and
1337 /// finds any private components in it.
1338 /// PrivateItemsInPublicInterfacesVisitor ensures there are no private types
1339 /// and traits in public interfaces.
1340 ///////////////////////////////////////////////////////////////////////////////
1342 struct SearchInterfaceForPrivateItemsVisitor<'a, 'tcx: 'a> {
1343 tcx: TyCtxt<'a, 'tcx, 'tcx>,
1346 /// The visitor checks that each component type is at least this visible
1347 required_visibility: ty::Visibility,
1348 /// The visibility of the least visible component that has been visited
1349 min_visibility: ty::Visibility,
1350 has_pub_restricted: bool,
1351 has_old_errors: bool,
1355 impl<'a, 'tcx: 'a> SearchInterfaceForPrivateItemsVisitor<'a, 'tcx> {
1356 fn generics(&mut self) -> &mut Self {
1357 for param in &self.tcx.generics_of(self.item_def_id).params {
1359 GenericParamDefKind::Type { has_default, .. } => {
1361 self.tcx.type_of(param.def_id).visit_with(self);
1364 GenericParamDefKind::Lifetime => {}
1370 fn predicates(&mut self) -> &mut Self {
1371 let predicates = self.tcx.predicates_of(self.item_def_id);
1372 for predicate in &predicates.predicates {
1373 predicate.visit_with(self);
1375 &ty::Predicate::Trait(poly_predicate) => {
1376 self.check_trait_ref(poly_predicate.skip_binder().trait_ref);
1378 &ty::Predicate::Projection(poly_predicate) => {
1380 self.check_trait_ref(
1381 poly_predicate.skip_binder().projection_ty.trait_ref(tcx)
1390 fn ty(&mut self) -> &mut Self {
1391 let ty = self.tcx.type_of(self.item_def_id);
1392 ty.visit_with(self);
1393 if let ty::TyFnDef(def_id, _) = ty.sty {
1394 if def_id == self.item_def_id {
1395 self.tcx.fn_sig(def_id).visit_with(self);
1401 fn impl_trait_ref(&mut self) -> &mut Self {
1402 if let Some(impl_trait_ref) = self.tcx.impl_trait_ref(self.item_def_id) {
1403 self.check_trait_ref(impl_trait_ref);
1404 impl_trait_ref.super_visit_with(self);
1409 fn check_trait_ref(&mut self, trait_ref: ty::TraitRef<'tcx>) {
1410 // Non-local means public (private items can't leave their crate, modulo bugs)
1411 if let Some(node_id) = self.tcx.hir.as_local_node_id(trait_ref.def_id) {
1412 let item = self.tcx.hir.expect_item(node_id);
1413 let vis = ty::Visibility::from_hir(&item.vis, node_id, self.tcx);
1414 if !vis.is_at_least(self.min_visibility, self.tcx) {
1415 self.min_visibility = vis;
1417 if !vis.is_at_least(self.required_visibility, self.tcx) {
1418 if self.has_pub_restricted || self.has_old_errors || self.in_assoc_ty {
1419 struct_span_err!(self.tcx.sess, self.span, E0445,
1420 "private trait `{}` in public interface", trait_ref)
1421 .span_label(self.span, format!(
1422 "can't leak private trait"))
1425 self.tcx.lint_node(lint::builtin::PRIVATE_IN_PUBLIC,
1428 &format!("private trait `{}` in public \
1429 interface (error E0445)", trait_ref));
1436 impl<'a, 'tcx: 'a> TypeVisitor<'tcx> for SearchInterfaceForPrivateItemsVisitor<'a, 'tcx> {
1437 fn visit_ty(&mut self, ty: Ty<'tcx>) -> bool {
1438 let ty_def_id = match ty.sty {
1439 ty::TyAdt(adt, _) => Some(adt.did),
1440 ty::TyForeign(did) => Some(did),
1441 ty::TyDynamic(ref obj, ..) => obj.principal().map(|p| p.def_id()),
1442 ty::TyProjection(ref proj) => {
1443 if self.required_visibility == ty::Visibility::Invisible {
1444 // Conservatively approximate the whole type alias as public without
1445 // recursing into its components when determining impl publicity.
1446 // For example, `impl <Type as Trait>::Alias {...}` may be a public impl
1447 // even if both `Type` and `Trait` are private.
1448 // Ideally, associated types should be substituted in the same way as
1449 // free type aliases, but this isn't done yet.
1452 let trait_ref = proj.trait_ref(self.tcx);
1453 Some(trait_ref.def_id)
1458 if let Some(def_id) = ty_def_id {
1459 // Non-local means public (private items can't leave their crate, modulo bugs)
1460 if let Some(node_id) = self.tcx.hir.as_local_node_id(def_id) {
1461 let hir_vis = match self.tcx.hir.find(node_id) {
1462 Some(hir::map::NodeItem(item)) => &item.vis,
1463 Some(hir::map::NodeForeignItem(item)) => &item.vis,
1464 _ => bug!("expected item of foreign item"),
1467 let vis = ty::Visibility::from_hir(hir_vis, node_id, self.tcx);
1469 if !vis.is_at_least(self.min_visibility, self.tcx) {
1470 self.min_visibility = vis;
1472 if !vis.is_at_least(self.required_visibility, self.tcx) {
1473 let vis_adj = match hir_vis.node {
1474 hir::VisibilityKind::Crate(_) => "crate-visible",
1475 hir::VisibilityKind::Restricted { .. } => "restricted",
1479 if self.has_pub_restricted || self.has_old_errors || self.in_assoc_ty {
1480 let mut err = struct_span_err!(self.tcx.sess, self.span, E0446,
1481 "{} type `{}` in public interface", vis_adj, ty);
1482 err.span_label(self.span, format!("can't leak {} type", vis_adj));
1483 err.span_label(hir_vis.span, format!("`{}` declared as {}", ty, vis_adj));
1486 self.tcx.lint_node(lint::builtin::PRIVATE_IN_PUBLIC,
1489 &format!("{} type `{}` in public \
1490 interface (error E0446)", vis_adj, ty));
1496 ty.super_visit_with(self)
1500 struct PrivateItemsInPublicInterfacesVisitor<'a, 'tcx: 'a> {
1501 tcx: TyCtxt<'a, 'tcx, 'tcx>,
1502 has_pub_restricted: bool,
1503 old_error_set: &'a NodeSet,
1504 inner_visibility: ty::Visibility,
1507 impl<'a, 'tcx> PrivateItemsInPublicInterfacesVisitor<'a, 'tcx> {
1508 fn check(&self, item_id: ast::NodeId, required_visibility: ty::Visibility)
1509 -> SearchInterfaceForPrivateItemsVisitor<'a, 'tcx> {
1510 let mut has_old_errors = false;
1512 // Slow path taken only if there any errors in the crate.
1513 for &id in self.old_error_set {
1514 // Walk up the nodes until we find `item_id` (or we hit a root).
1518 has_old_errors = true;
1521 let parent = self.tcx.hir.get_parent_node(id);
1533 SearchInterfaceForPrivateItemsVisitor {
1535 item_def_id: self.tcx.hir.local_def_id(item_id),
1536 span: self.tcx.hir.span(item_id),
1537 min_visibility: ty::Visibility::Public,
1538 required_visibility,
1539 has_pub_restricted: self.has_pub_restricted,
1546 impl<'a, 'tcx> Visitor<'tcx> for PrivateItemsInPublicInterfacesVisitor<'a, 'tcx> {
1547 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1548 NestedVisitorMap::OnlyBodies(&self.tcx.hir)
1551 fn visit_item(&mut self, item: &'tcx hir::Item) {
1553 let min = |vis1: ty::Visibility, vis2| {
1554 if vis1.is_at_least(vis2, tcx) { vis2 } else { vis1 }
1557 let item_visibility = ty::Visibility::from_hir(&item.vis, item.id, tcx);
1560 // Crates are always public
1561 hir::ItemKind::ExternCrate(..) => {}
1562 // All nested items are checked by visit_item
1563 hir::ItemKind::Mod(..) => {}
1564 // Checked in resolve
1565 hir::ItemKind::Use(..) => {}
1567 hir::ItemKind::GlobalAsm(..) => {}
1568 hir::ItemKind::Existential(hir::ExistTy { impl_trait_fn: Some(_), .. }) => {
1569 // Check the traits being exposed, as they're separate,
1570 // e.g. `impl Iterator<Item=T>` has two predicates,
1571 // `X: Iterator` and `<X as Iterator>::Item == T`,
1572 // where `X` is the `impl Iterator<Item=T>` itself,
1573 // stored in `predicates_of`, not in the `Ty` itself.
1575 self.check(item.id, item_visibility).predicates();
1577 // Subitems of these items have inherited publicity
1578 hir::ItemKind::Const(..) | hir::ItemKind::Static(..) | hir::ItemKind::Fn(..) |
1579 hir::ItemKind::Existential(..) |
1580 hir::ItemKind::Ty(..) => {
1581 self.check(item.id, item_visibility).generics().predicates().ty();
1583 // Recurse for e.g. `impl Trait` (see `visit_ty`).
1584 self.inner_visibility = item_visibility;
1585 intravisit::walk_item(self, item);
1587 hir::ItemKind::Trait(.., ref trait_item_refs) => {
1588 self.check(item.id, item_visibility).generics().predicates();
1590 for trait_item_ref in trait_item_refs {
1591 let mut check = self.check(trait_item_ref.id.node_id, item_visibility);
1592 check.in_assoc_ty = trait_item_ref.kind == hir::AssociatedItemKind::Type;
1593 check.generics().predicates();
1595 if trait_item_ref.kind == hir::AssociatedItemKind::Type &&
1596 !trait_item_ref.defaultness.has_value() {
1597 // No type to visit.
1603 hir::ItemKind::TraitAlias(..) => {
1604 self.check(item.id, item_visibility).generics().predicates();
1606 hir::ItemKind::Enum(ref def, _) => {
1607 self.check(item.id, item_visibility).generics().predicates();
1609 for variant in &def.variants {
1610 for field in variant.node.data.fields() {
1611 self.check(field.id, item_visibility).ty();
1615 // Subitems of foreign modules have their own publicity
1616 hir::ItemKind::ForeignMod(ref foreign_mod) => {
1617 for foreign_item in &foreign_mod.items {
1618 let vis = ty::Visibility::from_hir(&foreign_item.vis, item.id, tcx);
1619 self.check(foreign_item.id, vis).generics().predicates().ty();
1622 // Subitems of structs and unions have their own publicity
1623 hir::ItemKind::Struct(ref struct_def, _) |
1624 hir::ItemKind::Union(ref struct_def, _) => {
1625 self.check(item.id, item_visibility).generics().predicates();
1627 for field in struct_def.fields() {
1628 let field_visibility = ty::Visibility::from_hir(&field.vis, item.id, tcx);
1629 self.check(field.id, min(item_visibility, field_visibility)).ty();
1632 // An inherent impl is public when its type is public
1633 // Subitems of inherent impls have their own publicity
1634 hir::ItemKind::Impl(.., None, _, ref impl_item_refs) => {
1636 self.check(item.id, ty::Visibility::Invisible).ty().min_visibility;
1637 self.check(item.id, ty_vis).generics().predicates();
1639 for impl_item_ref in impl_item_refs {
1640 let impl_item = self.tcx.hir.impl_item(impl_item_ref.id);
1641 let impl_item_vis = ty::Visibility::from_hir(&impl_item.vis, item.id, tcx);
1642 let mut check = self.check(impl_item.id, min(impl_item_vis, ty_vis));
1643 check.in_assoc_ty = impl_item_ref.kind == hir::AssociatedItemKind::Type;
1644 check.generics().predicates().ty();
1646 // Recurse for e.g. `impl Trait` (see `visit_ty`).
1647 self.inner_visibility = impl_item_vis;
1648 intravisit::walk_impl_item(self, impl_item);
1651 // A trait impl is public when both its type and its trait are public
1652 // Subitems of trait impls have inherited publicity
1653 hir::ItemKind::Impl(.., Some(_), _, ref impl_item_refs) => {
1654 let vis = self.check(item.id, ty::Visibility::Invisible)
1655 .ty().impl_trait_ref().min_visibility;
1656 self.check(item.id, vis).generics().predicates();
1657 for impl_item_ref in impl_item_refs {
1658 let impl_item = self.tcx.hir.impl_item(impl_item_ref.id);
1659 let mut check = self.check(impl_item.id, vis);
1660 check.in_assoc_ty = impl_item_ref.kind == hir::AssociatedItemKind::Type;
1661 check.generics().predicates().ty();
1663 // Recurse for e.g. `impl Trait` (see `visit_ty`).
1664 self.inner_visibility = vis;
1665 intravisit::walk_impl_item(self, impl_item);
1671 fn visit_impl_item(&mut self, _impl_item: &'tcx hir::ImplItem) {
1672 // handled in `visit_item` above
1675 // Don't recurse into expressions in array sizes or const initializers
1676 fn visit_expr(&mut self, _: &'tcx hir::Expr) {}
1677 // Don't recurse into patterns in function arguments
1678 fn visit_pat(&mut self, _: &'tcx hir::Pat) {}
1681 pub fn provide(providers: &mut Providers) {
1682 *providers = Providers {
1683 privacy_access_levels,
1688 pub fn check_crate<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>) -> Lrc<AccessLevels> {
1689 tcx.privacy_access_levels(LOCAL_CRATE)
1692 fn privacy_access_levels<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
1694 -> Lrc<AccessLevels> {
1695 assert_eq!(krate, LOCAL_CRATE);
1697 let krate = tcx.hir.krate();
1698 let empty_tables = ty::TypeckTables::empty(None);
1700 // Check privacy of names not checked in previous compilation stages.
1701 let mut visitor = NamePrivacyVisitor {
1703 tables: &empty_tables,
1704 current_item: CRATE_NODE_ID,
1705 empty_tables: &empty_tables,
1707 intravisit::walk_crate(&mut visitor, krate);
1709 // Check privacy of explicitly written types and traits as well as
1710 // inferred types of expressions and patterns.
1711 let mut visitor = TypePrivacyVisitor {
1713 tables: &empty_tables,
1714 current_item: DefId::local(CRATE_DEF_INDEX),
1717 empty_tables: &empty_tables,
1718 visited_anon_tys: FxHashSet()
1720 intravisit::walk_crate(&mut visitor, krate);
1722 // Build up a set of all exported items in the AST. This is a set of all
1723 // items which are reachable from external crates based on visibility.
1724 let mut visitor = EmbargoVisitor {
1726 access_levels: Default::default(),
1727 prev_level: Some(AccessLevel::Public),
1731 intravisit::walk_crate(&mut visitor, krate);
1732 if visitor.changed {
1733 visitor.changed = false;
1738 visitor.update(ast::CRATE_NODE_ID, Some(AccessLevel::Public));
1741 let mut visitor = ObsoleteVisiblePrivateTypesVisitor {
1743 access_levels: &visitor.access_levels,
1745 old_error_set: NodeSet(),
1747 intravisit::walk_crate(&mut visitor, krate);
1750 let has_pub_restricted = {
1751 let mut pub_restricted_visitor = PubRestrictedVisitor {
1753 has_pub_restricted: false
1755 intravisit::walk_crate(&mut pub_restricted_visitor, krate);
1756 pub_restricted_visitor.has_pub_restricted
1759 // Check for private types and traits in public interfaces
1760 let mut visitor = PrivateItemsInPublicInterfacesVisitor {
1763 old_error_set: &visitor.old_error_set,
1764 inner_visibility: ty::Visibility::Public,
1766 krate.visit_all_item_likes(&mut DeepVisitor::new(&mut visitor));
1769 Lrc::new(visitor.access_levels)
1772 __build_diagnostic_array! { librustc_privacy, DIAGNOSTICS }