1 // Copyright 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 use astconv::ExplicitSelf;
12 use check::{Inherited, FnCtxt};
13 use constrained_type_params::{identify_constrained_type_params, Parameter};
15 use hir::def_id::DefId;
16 use rustc::traits::{self, ObligationCauseCode};
17 use rustc::ty::{self, Ty, TyCtxt};
18 use rustc::util::nodemap::{FxHashSet, FxHashMap};
19 use rustc::middle::lang_items;
23 use errors::DiagnosticBuilder;
25 use rustc::hir::intravisit::{self, Visitor, NestedVisitorMap};
28 pub struct CheckTypeWellFormedVisitor<'a, 'tcx:'a> {
29 tcx: TyCtxt<'a, 'tcx, 'tcx>,
30 code: ObligationCauseCode<'tcx>,
33 /// Helper type of a temporary returned by .for_item(...).
34 /// Necessary because we can't write the following bound:
35 /// F: for<'b, 'tcx> where 'gcx: 'tcx FnOnce(FnCtxt<'b, 'gcx, 'tcx>).
36 struct CheckWfFcxBuilder<'a, 'gcx: 'a+'tcx, 'tcx: 'a> {
37 inherited: super::InheritedBuilder<'a, 'gcx, 'tcx>,
38 code: ObligationCauseCode<'gcx>,
41 param_env: ty::ParamEnv<'tcx>,
44 impl<'a, 'gcx, 'tcx> CheckWfFcxBuilder<'a, 'gcx, 'tcx> {
45 fn with_fcx<F>(&'tcx mut self, f: F) where
46 F: for<'b> FnOnce(&FnCtxt<'b, 'gcx, 'tcx>,
47 &mut CheckTypeWellFormedVisitor<'b, 'gcx>) -> Vec<Ty<'tcx>>
49 let code = self.code.clone();
52 let param_env = self.param_env;
53 self.inherited.enter(|inh| {
54 let fcx = FnCtxt::new(&inh, param_env, id);
55 let wf_tys = f(&fcx, &mut CheckTypeWellFormedVisitor {
56 tcx: fcx.tcx.global_tcx(),
59 fcx.select_all_obligations_or_error();
60 fcx.regionck_item(id, span, &wf_tys);
65 impl<'a, 'gcx> CheckTypeWellFormedVisitor<'a, 'gcx> {
66 pub fn new(tcx: TyCtxt<'a, 'gcx, 'gcx>)
67 -> CheckTypeWellFormedVisitor<'a, 'gcx> {
68 CheckTypeWellFormedVisitor {
70 code: ObligationCauseCode::MiscObligation
74 /// Checks that the field types (in a struct def'n) or argument types (in an enum def'n) are
75 /// well-formed, meaning that they do not require any constraints not declared in the struct
76 /// definition itself. For example, this definition would be illegal:
78 /// struct Ref<'a, T> { x: &'a T }
80 /// because the type did not declare that `T:'a`.
82 /// We do this check as a pre-pass before checking fn bodies because if these constraints are
83 /// not included it frequently leads to confusing errors in fn bodies. So it's better to check
85 fn check_item_well_formed(&mut self, item: &hir::Item) {
87 debug!("check_item_well_formed(it.id={}, it.name={})",
89 tcx.item_path_str(tcx.hir.local_def_id(item.id)));
92 // Right now we check that every default trait implementation
93 // has an implementation of itself. Basically, a case like:
95 // `impl Trait for T {}`
97 // has a requirement of `T: Trait` which was required for default
98 // method implementations. Although this could be improved now that
99 // there's a better infrastructure in place for this, it's being left
100 // for a follow-up work.
102 // Since there's such a requirement, we need to check *just* positive
103 // implementations, otherwise things like:
105 // impl !Send for T {}
107 // won't be allowed unless there's an *explicit* implementation of `Send`
109 hir::ItemImpl(_, hir::ImplPolarity::Positive, _, _,
110 ref trait_ref, ref self_ty, _) => {
111 self.check_impl(item, self_ty, trait_ref);
113 hir::ItemImpl(_, hir::ImplPolarity::Negative, _, _, Some(_), ..) => {
114 // FIXME(#27579) what amount of WF checking do we need for neg impls?
116 let trait_ref = tcx.impl_trait_ref(tcx.hir.local_def_id(item.id)).unwrap();
117 if !tcx.trait_has_default_impl(trait_ref.def_id) {
118 error_192(tcx, item.span);
122 self.check_item_fn(item);
124 hir::ItemStatic(..) => {
125 self.check_item_type(item);
127 hir::ItemConst(..) => {
128 self.check_item_type(item);
130 hir::ItemStruct(ref struct_def, ref ast_generics) => {
131 self.check_type_defn(item, false, |fcx| {
132 vec![fcx.struct_variant(struct_def)]
135 self.check_variances_for_type_defn(item, ast_generics);
137 hir::ItemUnion(ref struct_def, ref ast_generics) => {
138 self.check_type_defn(item, true, |fcx| {
139 vec![fcx.struct_variant(struct_def)]
142 self.check_variances_for_type_defn(item, ast_generics);
144 hir::ItemEnum(ref enum_def, ref ast_generics) => {
145 self.check_type_defn(item, true, |fcx| {
146 fcx.enum_variants(enum_def)
149 self.check_variances_for_type_defn(item, ast_generics);
151 hir::ItemTrait(..) => {
152 self.check_trait(item);
158 fn check_associated_item(&mut self,
159 item_id: ast::NodeId,
161 sig_if_method: Option<&hir::MethodSig>) {
162 let code = self.code.clone();
163 self.for_id(item_id, span).with_fcx(|fcx, this| {
164 let item = fcx.tcx.associated_item(fcx.tcx.hir.local_def_id(item_id));
166 let (mut implied_bounds, self_ty) = match item.container {
167 ty::TraitContainer(_) => (vec![], fcx.tcx.mk_self_type()),
168 ty::ImplContainer(def_id) => (fcx.impl_implied_bounds(def_id, span),
169 fcx.tcx.type_of(def_id))
173 ty::AssociatedKind::Const => {
174 let ty = fcx.tcx.type_of(item.def_id);
175 let ty = fcx.normalize_associated_types_in(span, &ty);
176 fcx.register_wf_obligation(ty, span, code.clone());
178 ty::AssociatedKind::Method => {
179 reject_shadowing_type_parameters(fcx.tcx, item.def_id);
180 let sig = fcx.tcx.fn_sig(item.def_id);
181 let sig = fcx.normalize_associated_types_in(span, &sig);
182 let predicates = fcx.tcx.predicates_of(item.def_id)
183 .instantiate_identity(fcx.tcx);
184 let predicates = fcx.normalize_associated_types_in(span, &predicates);
185 this.check_fn_or_method(fcx, span, sig, &predicates,
186 item.def_id, &mut implied_bounds);
187 let sig_if_method = sig_if_method.expect("bad signature for method");
188 this.check_method_receiver(fcx, sig_if_method, &item, self_ty);
190 ty::AssociatedKind::Type => {
191 if item.defaultness.has_value() {
192 let ty = fcx.tcx.type_of(item.def_id);
193 let ty = fcx.normalize_associated_types_in(span, &ty);
194 fcx.register_wf_obligation(ty, span, code.clone());
203 fn for_item<'tcx>(&self, item: &hir::Item)
204 -> CheckWfFcxBuilder<'a, 'gcx, 'tcx> {
205 self.for_id(item.id, item.span)
208 fn for_id<'tcx>(&self, id: ast::NodeId, span: Span)
209 -> CheckWfFcxBuilder<'a, 'gcx, 'tcx> {
210 let def_id = self.tcx.hir.local_def_id(id);
212 inherited: Inherited::build(self.tcx, def_id),
213 code: self.code.clone(),
216 param_env: self.tcx.param_env(def_id),
220 /// In a type definition, we check that to ensure that the types of the fields are well-formed.
221 fn check_type_defn<F>(&mut self, item: &hir::Item, all_sized: bool, mut lookup_fields: F)
222 where F: for<'fcx, 'tcx> FnMut(&FnCtxt<'fcx, 'gcx, 'tcx>) -> Vec<AdtVariant<'tcx>>
224 self.for_item(item).with_fcx(|fcx, this| {
225 let variants = lookup_fields(fcx);
227 for variant in &variants {
228 // For DST, all intermediate types must be sized.
229 let unsized_len = if all_sized || variant.fields.is_empty() { 0 } else { 1 };
230 for field in &variant.fields[..variant.fields.len() - unsized_len] {
233 fcx.tcx.require_lang_item(lang_items::SizedTraitLangItem),
234 traits::ObligationCause::new(field.span,
236 traits::FieldSized(match item.node.adt_kind() {
242 // All field types must be well-formed.
243 for field in &variant.fields {
244 fcx.register_wf_obligation(field.ty, field.span, this.code.clone())
248 let def_id = fcx.tcx.hir.local_def_id(item.id);
249 let predicates = fcx.tcx.predicates_of(def_id).instantiate_identity(fcx.tcx);
250 let predicates = fcx.normalize_associated_types_in(item.span, &predicates);
251 this.check_where_clauses(fcx, item.span, &predicates);
253 vec![] // no implied bounds in a struct def'n
257 fn check_auto_trait(&mut self, trait_def_id: DefId, span: Span) {
258 // We want to ensure:
260 // 1) that there are no items contained within
261 // the trait definition
263 // 2) that the definition doesn't violate the no-super trait rule
266 // 3) that the trait definition does not have any type parameters
268 let predicates = self.tcx.predicates_of(trait_def_id);
270 // We must exclude the Self : Trait predicate contained by all
273 predicates.predicates.iter().any(|predicate| {
275 &ty::Predicate::Trait(ref poly_trait_ref) => {
276 let self_ty = poly_trait_ref.0.self_ty();
277 !(self_ty.is_self() && poly_trait_ref.def_id() == trait_def_id)
283 let has_ty_params = self.tcx.generics_of(trait_def_id).types.len() > 1;
285 // We use an if-else here, since the generics will also trigger
286 // an extraneous error message when we find predicates like
287 // `T : Sized` for a trait like: `trait Magic<T>`.
289 // We also put the check on the number of items here,
290 // as it seems confusing to report an error about
291 // extraneous predicates created by things like
292 // an associated type inside the trait.
294 if !self.tcx.associated_item_def_ids(trait_def_id).is_empty() {
295 error_380(self.tcx, span);
296 } else if has_ty_params {
297 err = Some(struct_span_err!(self.tcx.sess, span, E0567,
298 "traits with auto impls (`e.g. impl \
299 Trait for ..`) can not have type parameters"));
300 } else if has_predicates {
301 err = Some(struct_span_err!(self.tcx.sess, span, E0568,
302 "traits with auto impls (`e.g. impl \
303 Trait for ..`) cannot have predicates"));
306 // Finally if either of the above conditions apply we should add a note
307 // indicating that this error is the result of a recent soundness fix.
311 e.note("the new auto trait rules are the result of a \
312 recent soundness fix; see #29859 for more details");
318 fn check_trait(&mut self, item: &hir::Item) {
319 let trait_def_id = self.tcx.hir.local_def_id(item.id);
321 if self.tcx.trait_has_default_impl(trait_def_id) {
322 self.check_auto_trait(trait_def_id, item.span);
325 self.for_item(item).with_fcx(|fcx, this| {
326 let predicates = fcx.tcx.predicates_of(trait_def_id).instantiate_identity(fcx.tcx);
327 let predicates = fcx.normalize_associated_types_in(item.span, &predicates);
328 this.check_where_clauses(fcx, item.span, &predicates);
333 fn check_item_fn(&mut self, item: &hir::Item) {
334 self.for_item(item).with_fcx(|fcx, this| {
335 let def_id = fcx.tcx.hir.local_def_id(item.id);
336 let sig = fcx.tcx.fn_sig(def_id);
337 let sig = fcx.normalize_associated_types_in(item.span, &sig);
339 let predicates = fcx.tcx.predicates_of(def_id).instantiate_identity(fcx.tcx);
340 let predicates = fcx.normalize_associated_types_in(item.span, &predicates);
342 let mut implied_bounds = vec![];
343 this.check_fn_or_method(fcx, item.span, sig, &predicates,
344 def_id, &mut implied_bounds);
349 fn check_item_type(&mut self,
352 debug!("check_item_type: {:?}", item);
354 self.for_item(item).with_fcx(|fcx, this| {
355 let ty = fcx.tcx.type_of(fcx.tcx.hir.local_def_id(item.id));
356 let item_ty = fcx.normalize_associated_types_in(item.span, &ty);
358 fcx.register_wf_obligation(item_ty, item.span, this.code.clone());
360 vec![] // no implied bounds in a const etc
364 fn check_impl(&mut self,
366 ast_self_ty: &hir::Ty,
367 ast_trait_ref: &Option<hir::TraitRef>)
369 debug!("check_impl: {:?}", item);
371 self.for_item(item).with_fcx(|fcx, this| {
372 let item_def_id = fcx.tcx.hir.local_def_id(item.id);
374 match *ast_trait_ref {
375 Some(ref ast_trait_ref) => {
376 let trait_ref = fcx.tcx.impl_trait_ref(item_def_id).unwrap();
378 fcx.normalize_associated_types_in(
379 ast_trait_ref.path.span, &trait_ref);
381 ty::wf::trait_obligations(fcx,
385 ast_trait_ref.path.span);
386 for obligation in obligations {
387 fcx.register_predicate(obligation);
391 let self_ty = fcx.tcx.type_of(item_def_id);
392 let self_ty = fcx.normalize_associated_types_in(item.span, &self_ty);
393 fcx.register_wf_obligation(self_ty, ast_self_ty.span, this.code.clone());
397 let predicates = fcx.tcx.predicates_of(item_def_id).instantiate_identity(fcx.tcx);
398 let predicates = fcx.normalize_associated_types_in(item.span, &predicates);
399 this.check_where_clauses(fcx, item.span, &predicates);
401 fcx.impl_implied_bounds(item_def_id, item.span)
405 fn check_where_clauses<'fcx, 'tcx>(&mut self,
406 fcx: &FnCtxt<'fcx, 'gcx, 'tcx>,
408 predicates: &ty::InstantiatedPredicates<'tcx>)
411 predicates.predicates
413 .flat_map(|p| ty::wf::predicate_obligations(fcx,
419 for obligation in obligations {
420 fcx.register_predicate(obligation);
424 fn check_fn_or_method<'fcx, 'tcx>(&mut self,
425 fcx: &FnCtxt<'fcx, 'gcx, 'tcx>,
427 sig: ty::PolyFnSig<'tcx>,
428 predicates: &ty::InstantiatedPredicates<'tcx>,
430 implied_bounds: &mut Vec<Ty<'tcx>>)
432 let sig = fcx.normalize_associated_types_in(span, &sig);
433 let sig = fcx.liberate_late_bound_regions(def_id, &sig);
435 for input_ty in sig.inputs() {
436 fcx.register_wf_obligation(&input_ty, span, self.code.clone());
438 implied_bounds.extend(sig.inputs());
440 fcx.register_wf_obligation(sig.output(), span, self.code.clone());
442 // FIXME(#25759) return types should not be implied bounds
443 implied_bounds.push(sig.output());
445 self.check_where_clauses(fcx, span, predicates);
448 fn check_method_receiver<'fcx, 'tcx>(&mut self,
449 fcx: &FnCtxt<'fcx, 'gcx, 'tcx>,
450 method_sig: &hir::MethodSig,
451 method: &ty::AssociatedItem,
452 self_ty: ty::Ty<'tcx>)
454 // check that the type of the method's receiver matches the
455 // method's first parameter.
456 debug!("check_method_receiver({:?}, self_ty={:?})",
459 if !method.method_has_self_argument {
463 let span = method_sig.decl.inputs[0].span;
465 let sig = fcx.tcx.fn_sig(method.def_id);
466 let sig = fcx.normalize_associated_types_in(span, &sig);
467 let sig = fcx.liberate_late_bound_regions(method.def_id, &sig);
469 debug!("check_method_receiver: sig={:?}", sig);
471 let self_arg_ty = sig.inputs()[0];
472 let rcvr_ty = match ExplicitSelf::determine(self_ty, self_arg_ty) {
473 ExplicitSelf::ByValue => self_ty,
474 ExplicitSelf::ByReference(region, mutbl) => {
475 fcx.tcx.mk_ref(region, ty::TypeAndMut {
480 ExplicitSelf::ByBox => fcx.tcx.mk_box(self_ty)
482 let rcvr_ty = fcx.normalize_associated_types_in(span, &rcvr_ty);
483 let rcvr_ty = fcx.liberate_late_bound_regions(method.def_id,
484 &ty::Binder(rcvr_ty));
486 debug!("check_method_receiver: receiver ty = {:?}", rcvr_ty);
488 let cause = fcx.cause(span, ObligationCauseCode::MethodReceiver);
489 if let Some(mut err) = fcx.demand_eqtype_with_origin(&cause, rcvr_ty, self_arg_ty) {
494 fn check_variances_for_type_defn(&self,
496 ast_generics: &hir::Generics)
498 let item_def_id = self.tcx.hir.local_def_id(item.id);
499 let ty = self.tcx.type_of(item_def_id);
500 if self.tcx.has_error_field(ty) {
504 let ty_predicates = self.tcx.predicates_of(item_def_id);
505 assert_eq!(ty_predicates.parent, None);
506 let variances = self.tcx.variances_of(item_def_id);
508 let mut constrained_parameters: FxHashSet<_> =
509 variances.iter().enumerate()
510 .filter(|&(_, &variance)| variance != ty::Bivariant)
511 .map(|(index, _)| Parameter(index as u32))
514 identify_constrained_type_params(self.tcx,
515 ty_predicates.predicates.as_slice(),
517 &mut constrained_parameters);
519 for (index, _) in variances.iter().enumerate() {
520 if constrained_parameters.contains(&Parameter(index as u32)) {
524 let (span, name) = if index < ast_generics.lifetimes.len() {
525 (ast_generics.lifetimes[index].lifetime.span,
526 ast_generics.lifetimes[index].lifetime.name)
528 let index = index - ast_generics.lifetimes.len();
529 (ast_generics.ty_params[index].span,
530 ast_generics.ty_params[index].name)
532 self.report_bivariance(span, name);
536 fn report_bivariance(&self,
538 param_name: ast::Name)
540 let mut err = error_392(self.tcx, span, param_name);
542 let suggested_marker_id = self.tcx.lang_items().phantom_data();
543 match suggested_marker_id {
546 &format!("consider removing `{}` or using a marker such as `{}`",
548 self.tcx.item_path_str(def_id)));
551 // no lang items, no help!
558 fn reject_shadowing_type_parameters(tcx: TyCtxt, def_id: DefId) {
559 let generics = tcx.generics_of(def_id);
560 let parent = tcx.generics_of(generics.parent.unwrap());
561 let impl_params: FxHashMap<_, _> = parent.types
563 .map(|tp| (tp.name, tp.def_id))
566 for method_param in &generics.types {
567 if impl_params.contains_key(&method_param.name) {
568 // Tighten up the span to focus on only the shadowing type
569 let type_span = tcx.def_span(method_param.def_id);
571 // The expectation here is that the original trait declaration is
572 // local so it should be okay to just unwrap everything.
573 let trait_def_id = impl_params[&method_param.name];
574 let trait_decl_span = tcx.def_span(trait_def_id);
575 error_194(tcx, type_span, trait_decl_span, method_param.name);
580 impl<'a, 'tcx, 'v> Visitor<'v> for CheckTypeWellFormedVisitor<'a, 'tcx> {
581 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'v> {
582 NestedVisitorMap::None
585 fn visit_item(&mut self, i: &hir::Item) {
586 debug!("visit_item: {:?}", i);
587 self.check_item_well_formed(i);
588 intravisit::walk_item(self, i);
591 fn visit_trait_item(&mut self, trait_item: &'v hir::TraitItem) {
592 debug!("visit_trait_item: {:?}", trait_item);
593 let method_sig = match trait_item.node {
594 hir::TraitItemKind::Method(ref sig, _) => Some(sig),
597 self.check_associated_item(trait_item.id, trait_item.span, method_sig);
598 intravisit::walk_trait_item(self, trait_item)
601 fn visit_impl_item(&mut self, impl_item: &'v hir::ImplItem) {
602 debug!("visit_impl_item: {:?}", impl_item);
603 let method_sig = match impl_item.node {
604 hir::ImplItemKind::Method(ref sig, _) => Some(sig),
607 self.check_associated_item(impl_item.id, impl_item.span, method_sig);
608 intravisit::walk_impl_item(self, impl_item)
612 ///////////////////////////////////////////////////////////////////////////
615 struct AdtVariant<'tcx> {
616 fields: Vec<AdtField<'tcx>>,
619 struct AdtField<'tcx> {
624 impl<'a, 'gcx, 'tcx> FnCtxt<'a, 'gcx, 'tcx> {
625 fn struct_variant(&self, struct_def: &hir::VariantData) -> AdtVariant<'tcx> {
627 struct_def.fields().iter()
629 let field_ty = self.tcx.type_of(self.tcx.hir.local_def_id(field.id));
630 let field_ty = self.normalize_associated_types_in(field.span,
632 AdtField { ty: field_ty, span: field.span }
635 AdtVariant { fields: fields }
638 fn enum_variants(&self, enum_def: &hir::EnumDef) -> Vec<AdtVariant<'tcx>> {
639 enum_def.variants.iter()
640 .map(|variant| self.struct_variant(&variant.node.data))
644 fn impl_implied_bounds(&self, impl_def_id: DefId, span: Span) -> Vec<Ty<'tcx>> {
645 match self.tcx.impl_trait_ref(impl_def_id) {
646 Some(ref trait_ref) => {
647 // Trait impl: take implied bounds from all types that
648 // appear in the trait reference.
649 let trait_ref = self.normalize_associated_types_in(span, trait_ref);
650 trait_ref.substs.types().collect()
654 // Inherent impl: take implied bounds from the self type.
655 let self_ty = self.tcx.type_of(impl_def_id);
656 let self_ty = self.normalize_associated_types_in(span, &self_ty);
663 fn error_192(tcx: TyCtxt, span: Span) {
664 span_err!(tcx.sess, span, E0192,
665 "negative impls are only allowed for traits with \
666 default impls (e.g., `Send` and `Sync`)")
669 fn error_380(tcx: TyCtxt, span: Span) {
670 span_err!(tcx.sess, span, E0380,
671 "traits with default impls (`e.g. impl \
672 Trait for ..`) must have no methods or associated items")
675 fn error_392<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, span: Span, param_name: ast::Name)
676 -> DiagnosticBuilder<'tcx> {
677 let mut err = struct_span_err!(tcx.sess, span, E0392,
678 "parameter `{}` is never used", param_name);
679 err.span_label(span, "unused type parameter");
683 fn error_194(tcx: TyCtxt, span: Span, trait_decl_span: Span, name: ast::Name) {
684 struct_span_err!(tcx.sess, span, E0194,
685 "type parameter `{}` shadows another type parameter of the same name",
687 .span_label(span, "shadows another type parameter")
688 .span_label(trait_decl_span, format!("first `{}` declared here", name))