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>,
43 impl<'a, 'gcx, 'tcx> CheckWfFcxBuilder<'a, 'gcx, 'tcx> {
44 fn with_fcx<F>(&'tcx mut self, f: F) where
45 F: for<'b> FnOnce(&FnCtxt<'b, 'gcx, 'tcx>,
46 &mut CheckTypeWellFormedVisitor<'b, 'gcx>) -> Vec<Ty<'tcx>>
48 let code = self.code.clone();
51 self.inherited.enter(|inh| {
52 let fcx = FnCtxt::new(&inh, id);
53 let wf_tys = f(&fcx, &mut CheckTypeWellFormedVisitor {
54 tcx: fcx.tcx.global_tcx(),
57 fcx.select_all_obligations_or_error();
58 fcx.regionck_item(id, span, &wf_tys);
63 impl<'a, 'gcx> CheckTypeWellFormedVisitor<'a, 'gcx> {
64 pub fn new(tcx: TyCtxt<'a, 'gcx, 'gcx>)
65 -> CheckTypeWellFormedVisitor<'a, 'gcx> {
66 CheckTypeWellFormedVisitor {
68 code: ObligationCauseCode::MiscObligation
72 /// Checks that the field types (in a struct def'n) or argument types (in an enum def'n) are
73 /// well-formed, meaning that they do not require any constraints not declared in the struct
74 /// definition itself. For example, this definition would be illegal:
76 /// struct Ref<'a, T> { x: &'a T }
78 /// because the type did not declare that `T:'a`.
80 /// We do this check as a pre-pass before checking fn bodies because if these constraints are
81 /// not included it frequently leads to confusing errors in fn bodies. So it's better to check
83 fn check_item_well_formed(&mut self, item: &hir::Item) {
85 debug!("check_item_well_formed(it.id={}, it.name={})",
87 tcx.item_path_str(tcx.hir.local_def_id(item.id)));
90 /// Right now we check that every default trait implementation
91 /// has an implementation of itself. Basically, a case like:
93 /// `impl Trait for T {}`
95 /// has a requirement of `T: Trait` which was required for default
96 /// method implementations. Although this could be improved now that
97 /// there's a better infrastructure in place for this, it's being left
98 /// for a follow-up work.
100 /// Since there's such a requirement, we need to check *just* positive
101 /// implementations, otherwise things like:
103 /// impl !Send for T {}
105 /// won't be allowed unless there's an *explicit* implementation of `Send`
107 hir::ItemImpl(_, hir::ImplPolarity::Positive, _, _,
108 ref trait_ref, ref self_ty, _) => {
109 self.check_impl(item, self_ty, trait_ref);
111 hir::ItemImpl(_, hir::ImplPolarity::Negative, _, _, Some(_), ..) => {
112 // FIXME(#27579) what amount of WF checking do we need for neg impls?
114 let trait_ref = tcx.impl_trait_ref(tcx.hir.local_def_id(item.id)).unwrap();
115 if !tcx.trait_has_default_impl(trait_ref.def_id) {
116 error_192(tcx, item.span);
120 self.check_item_fn(item);
122 hir::ItemStatic(..) => {
123 self.check_item_type(item);
125 hir::ItemConst(..) => {
126 self.check_item_type(item);
128 hir::ItemStruct(ref struct_def, ref ast_generics) => {
129 self.check_type_defn(item, false, |fcx| {
130 vec![fcx.struct_variant(struct_def)]
133 self.check_variances_for_type_defn(item, ast_generics);
135 hir::ItemUnion(ref struct_def, ref ast_generics) => {
136 self.check_type_defn(item, true, |fcx| {
137 vec![fcx.struct_variant(struct_def)]
140 self.check_variances_for_type_defn(item, ast_generics);
142 hir::ItemEnum(ref enum_def, ref ast_generics) => {
143 self.check_type_defn(item, true, |fcx| {
144 fcx.enum_variants(enum_def)
147 self.check_variances_for_type_defn(item, ast_generics);
149 hir::ItemTrait(..) => {
150 self.check_trait(item);
156 fn check_associated_item(&mut self,
157 item_id: ast::NodeId,
159 sig_if_method: Option<&hir::MethodSig>) {
160 let code = self.code.clone();
161 self.for_id(item_id, span).with_fcx(|fcx, this| {
162 let free_substs = &fcx.parameter_environment.free_substs;
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.instantiate_type_scheme(span, free_substs, &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 method_ty = fcx.tcx.type_of(item.def_id);
181 let method_ty = fcx.instantiate_type_scheme(span, free_substs, &method_ty);
182 let predicates = fcx.instantiate_bounds(span, item.def_id, free_substs);
183 let sig = method_ty.fn_sig();
184 this.check_fn_or_method(fcx, span, sig, &predicates,
185 item.def_id, &mut implied_bounds);
186 let sig_if_method = sig_if_method.expect("bad signature for method");
187 this.check_method_receiver(fcx, sig_if_method, &item, self_ty);
189 ty::AssociatedKind::Type => {
190 if item.defaultness.has_value() {
191 let ty = fcx.tcx.type_of(item.def_id);
192 let ty = fcx.instantiate_type_scheme(span, free_substs, &ty);
193 fcx.register_wf_obligation(ty, span, code.clone());
202 fn for_item<'tcx>(&self, item: &hir::Item)
203 -> CheckWfFcxBuilder<'a, 'gcx, 'tcx> {
204 self.for_id(item.id, item.span)
207 fn for_id<'tcx>(&self, id: ast::NodeId, span: Span)
208 -> CheckWfFcxBuilder<'a, 'gcx, 'tcx> {
210 inherited: Inherited::build(self.tcx, self.tcx.hir.local_def_id(id)),
211 code: self.code.clone(),
217 /// In a type definition, we check that to ensure that the types of the fields are well-formed.
218 fn check_type_defn<F>(&mut self, item: &hir::Item, all_sized: bool, mut lookup_fields: F)
219 where F: for<'fcx, 'tcx> FnMut(&FnCtxt<'fcx, 'gcx, 'tcx>) -> Vec<AdtVariant<'tcx>>
221 self.for_item(item).with_fcx(|fcx, this| {
222 let variants = lookup_fields(fcx);
224 for variant in &variants {
225 // For DST, all intermediate types must be sized.
226 let unsized_len = if all_sized || variant.fields.is_empty() { 0 } else { 1 };
227 for field in &variant.fields[..variant.fields.len() - unsized_len] {
230 fcx.tcx.require_lang_item(lang_items::SizedTraitLangItem),
231 traits::ObligationCause::new(field.span,
233 traits::FieldSized));
236 // All field types must be well-formed.
237 for field in &variant.fields {
238 fcx.register_wf_obligation(field.ty, field.span, this.code.clone())
242 let free_substs = &fcx.parameter_environment.free_substs;
243 let def_id = fcx.tcx.hir.local_def_id(item.id);
244 let predicates = fcx.instantiate_bounds(item.span, def_id, free_substs);
245 this.check_where_clauses(fcx, item.span, &predicates);
247 vec![] // no implied bounds in a struct def'n
251 fn check_auto_trait(&mut self, trait_def_id: DefId, span: Span) {
252 // We want to ensure:
254 // 1) that there are no items contained within
255 // the trait defintion
257 // 2) that the definition doesn't violate the no-super trait rule
260 // 3) that the trait definition does not have any type parameters
262 let predicates = self.tcx.predicates_of(trait_def_id);
264 // We must exclude the Self : Trait predicate contained by all
267 predicates.predicates.iter().any(|predicate| {
269 &ty::Predicate::Trait(ref poly_trait_ref) => {
270 let self_ty = poly_trait_ref.0.self_ty();
271 !(self_ty.is_self() && poly_trait_ref.def_id() == trait_def_id)
277 let has_ty_params = self.tcx.generics_of(trait_def_id).types.len() > 1;
279 // We use an if-else here, since the generics will also trigger
280 // an extraneous error message when we find predicates like
281 // `T : Sized` for a trait like: `trait Magic<T>`.
283 // We also put the check on the number of items here,
284 // as it seems confusing to report an error about
285 // extraneous predicates created by things like
286 // an associated type inside the trait.
288 if !self.tcx.associated_item_def_ids(trait_def_id).is_empty() {
289 error_380(self.tcx, span);
290 } else if has_ty_params {
291 err = Some(struct_span_err!(self.tcx.sess, span, E0567,
292 "traits with auto impls (`e.g. impl \
293 Trait for ..`) can not have type parameters"));
294 } else if has_predicates {
295 err = Some(struct_span_err!(self.tcx.sess, span, E0568,
296 "traits with auto impls (`e.g. impl \
297 Trait for ..`) cannot have predicates"));
300 // Finally if either of the above conditions apply we should add a note
301 // indicating that this error is the result of a recent soundness fix.
305 e.note("the new auto trait rules are the result of a \
306 recent soundness fix; see #29859 for more details");
312 fn check_trait(&mut self, item: &hir::Item) {
313 let trait_def_id = self.tcx.hir.local_def_id(item.id);
315 if self.tcx.trait_has_default_impl(trait_def_id) {
316 self.check_auto_trait(trait_def_id, item.span);
319 self.for_item(item).with_fcx(|fcx, this| {
320 let free_substs = &fcx.parameter_environment.free_substs;
321 let predicates = fcx.instantiate_bounds(item.span, trait_def_id, free_substs);
322 this.check_where_clauses(fcx, item.span, &predicates);
327 fn check_item_fn(&mut self, item: &hir::Item) {
328 self.for_item(item).with_fcx(|fcx, this| {
329 let free_substs = &fcx.parameter_environment.free_substs;
330 let def_id = fcx.tcx.hir.local_def_id(item.id);
331 let ty = fcx.tcx.type_of(def_id);
332 let item_ty = fcx.instantiate_type_scheme(item.span, free_substs, &ty);
333 let sig = item_ty.fn_sig();
335 let predicates = fcx.instantiate_bounds(item.span, def_id, free_substs);
337 let mut implied_bounds = vec![];
338 this.check_fn_or_method(fcx, item.span, sig, &predicates,
339 def_id, &mut implied_bounds);
344 fn check_item_type(&mut self,
347 debug!("check_item_type: {:?}", item);
349 self.for_item(item).with_fcx(|fcx, this| {
350 let ty = fcx.tcx.type_of(fcx.tcx.hir.local_def_id(item.id));
351 let item_ty = fcx.instantiate_type_scheme(item.span,
352 &fcx.parameter_environment
356 fcx.register_wf_obligation(item_ty, item.span, this.code.clone());
358 vec![] // no implied bounds in a const etc
362 fn check_impl(&mut self,
364 ast_self_ty: &hir::Ty,
365 ast_trait_ref: &Option<hir::TraitRef>)
367 debug!("check_impl: {:?}", item);
369 self.for_item(item).with_fcx(|fcx, this| {
370 let free_substs = &fcx.parameter_environment.free_substs;
371 let item_def_id = fcx.tcx.hir.local_def_id(item.id);
373 match *ast_trait_ref {
374 Some(ref ast_trait_ref) => {
375 let trait_ref = fcx.tcx.impl_trait_ref(item_def_id).unwrap();
377 fcx.instantiate_type_scheme(
378 ast_trait_ref.path.span, free_substs, &trait_ref);
380 ty::wf::trait_obligations(fcx,
383 ast_trait_ref.path.span);
384 for obligation in obligations {
385 fcx.register_predicate(obligation);
389 let self_ty = fcx.tcx.type_of(item_def_id);
390 let self_ty = fcx.instantiate_type_scheme(item.span, free_substs, &self_ty);
391 fcx.register_wf_obligation(self_ty, ast_self_ty.span, this.code.clone());
395 let predicates = fcx.instantiate_bounds(item.span, item_def_id, free_substs);
396 this.check_where_clauses(fcx, item.span, &predicates);
398 fcx.impl_implied_bounds(item_def_id, item.span)
402 fn check_where_clauses<'fcx, 'tcx>(&mut self,
403 fcx: &FnCtxt<'fcx, 'gcx, 'tcx>,
405 predicates: &ty::InstantiatedPredicates<'tcx>)
408 predicates.predicates
410 .flat_map(|p| ty::wf::predicate_obligations(fcx,
415 for obligation in obligations {
416 fcx.register_predicate(obligation);
420 fn check_fn_or_method<'fcx, 'tcx>(&mut self,
421 fcx: &FnCtxt<'fcx, 'gcx, 'tcx>,
423 sig: ty::PolyFnSig<'tcx>,
424 predicates: &ty::InstantiatedPredicates<'tcx>,
426 implied_bounds: &mut Vec<Ty<'tcx>>)
428 let free_substs = &fcx.parameter_environment.free_substs;
429 let sig = fcx.instantiate_type_scheme(span, free_substs, &sig);
430 let sig = fcx.tcx.liberate_late_bound_regions(def_id, &sig);
432 for input_ty in sig.inputs() {
433 fcx.register_wf_obligation(&input_ty, span, self.code.clone());
435 implied_bounds.extend(sig.inputs());
437 fcx.register_wf_obligation(sig.output(), span, self.code.clone());
439 // FIXME(#25759) return types should not be implied bounds
440 implied_bounds.push(sig.output());
442 self.check_where_clauses(fcx, span, predicates);
445 fn check_method_receiver<'fcx, 'tcx>(&mut self,
446 fcx: &FnCtxt<'fcx, 'gcx, 'tcx>,
447 method_sig: &hir::MethodSig,
448 method: &ty::AssociatedItem,
449 self_ty: ty::Ty<'tcx>)
451 // check that the type of the method's receiver matches the
452 // method's first parameter.
453 debug!("check_method_receiver({:?}, self_ty={:?})",
456 if !method.method_has_self_argument {
460 let span = method_sig.decl.inputs[0].span;
462 let free_substs = &fcx.parameter_environment.free_substs;
463 let method_ty = fcx.tcx.type_of(method.def_id);
464 let fty = fcx.instantiate_type_scheme(span, free_substs, &method_ty);
465 let sig = fcx.tcx.liberate_late_bound_regions(method.def_id, &fty.fn_sig());
467 debug!("check_method_receiver: sig={:?}", sig);
469 let self_arg_ty = sig.inputs()[0];
470 let rcvr_ty = match ExplicitSelf::determine(self_ty, self_arg_ty) {
471 ExplicitSelf::ByValue => self_ty,
472 ExplicitSelf::ByReference(region, mutbl) => {
473 fcx.tcx.mk_ref(region, ty::TypeAndMut {
478 ExplicitSelf::ByBox => fcx.tcx.mk_box(self_ty)
480 let rcvr_ty = fcx.instantiate_type_scheme(span, free_substs, &rcvr_ty);
481 let rcvr_ty = fcx.tcx.liberate_late_bound_regions(method.def_id,
482 &ty::Binder(rcvr_ty));
484 debug!("check_method_receiver: receiver ty = {:?}", rcvr_ty);
486 let cause = fcx.cause(span, ObligationCauseCode::MethodReceiver);
487 if let Some(mut err) = fcx.demand_eqtype_with_origin(&cause, rcvr_ty, self_arg_ty) {
492 fn check_variances_for_type_defn(&self,
494 ast_generics: &hir::Generics)
496 let item_def_id = self.tcx.hir.local_def_id(item.id);
497 let ty = self.tcx.type_of(item_def_id);
498 if self.tcx.has_error_field(ty) {
502 let ty_predicates = self.tcx.predicates_of(item_def_id);
503 assert_eq!(ty_predicates.parent, None);
504 let variances = self.tcx.variances_of(item_def_id);
506 let mut constrained_parameters: FxHashSet<_> =
507 variances.iter().enumerate()
508 .filter(|&(_, &variance)| variance != ty::Bivariant)
509 .map(|(index, _)| Parameter(index as u32))
512 identify_constrained_type_params(ty_predicates.predicates.as_slice(),
514 &mut constrained_parameters);
516 for (index, _) in variances.iter().enumerate() {
517 if constrained_parameters.contains(&Parameter(index as u32)) {
521 let (span, name) = if index < ast_generics.lifetimes.len() {
522 (ast_generics.lifetimes[index].lifetime.span,
523 ast_generics.lifetimes[index].lifetime.name)
525 let index = index - ast_generics.lifetimes.len();
526 (ast_generics.ty_params[index].span,
527 ast_generics.ty_params[index].name)
529 self.report_bivariance(span, name);
533 fn report_bivariance(&self,
535 param_name: ast::Name)
537 let mut err = error_392(self.tcx, span, param_name);
539 let suggested_marker_id = self.tcx.lang_items.phantom_data();
540 match suggested_marker_id {
543 &format!("consider removing `{}` or using a marker such as `{}`",
545 self.tcx.item_path_str(def_id)));
548 // no lang items, no help!
555 fn reject_shadowing_type_parameters(tcx: TyCtxt, def_id: DefId) {
556 let generics = tcx.generics_of(def_id);
557 let parent = tcx.generics_of(generics.parent.unwrap());
558 let impl_params: FxHashMap<_, _> = parent.types
560 .map(|tp| (tp.name, tp.def_id))
563 for method_param in &generics.types {
564 if impl_params.contains_key(&method_param.name) {
565 // Tighten up the span to focus on only the shadowing type
566 let type_span = tcx.def_span(method_param.def_id);
568 // The expectation here is that the original trait declaration is
569 // local so it should be okay to just unwrap everything.
570 let trait_def_id = impl_params[&method_param.name];
571 let trait_decl_span = tcx.def_span(trait_def_id);
572 error_194(tcx, type_span, trait_decl_span, method_param.name);
577 impl<'a, 'tcx, 'v> Visitor<'v> for CheckTypeWellFormedVisitor<'a, 'tcx> {
578 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'v> {
579 NestedVisitorMap::None
582 fn visit_item(&mut self, i: &hir::Item) {
583 debug!("visit_item: {:?}", i);
584 self.check_item_well_formed(i);
585 intravisit::walk_item(self, i);
588 fn visit_trait_item(&mut self, trait_item: &'v hir::TraitItem) {
589 debug!("visit_trait_item: {:?}", trait_item);
590 let method_sig = match trait_item.node {
591 hir::TraitItemKind::Method(ref sig, _) => Some(sig),
594 self.check_associated_item(trait_item.id, trait_item.span, method_sig);
595 intravisit::walk_trait_item(self, trait_item)
598 fn visit_impl_item(&mut self, impl_item: &'v hir::ImplItem) {
599 debug!("visit_impl_item: {:?}", impl_item);
600 let method_sig = match impl_item.node {
601 hir::ImplItemKind::Method(ref sig, _) => Some(sig),
604 self.check_associated_item(impl_item.id, impl_item.span, method_sig);
605 intravisit::walk_impl_item(self, impl_item)
609 ///////////////////////////////////////////////////////////////////////////
612 struct AdtVariant<'tcx> {
613 fields: Vec<AdtField<'tcx>>,
616 struct AdtField<'tcx> {
621 impl<'a, 'gcx, 'tcx> FnCtxt<'a, 'gcx, 'tcx> {
622 fn struct_variant(&self, struct_def: &hir::VariantData) -> AdtVariant<'tcx> {
624 struct_def.fields().iter()
626 let field_ty = self.tcx.type_of(self.tcx.hir.local_def_id(field.id));
627 let field_ty = self.instantiate_type_scheme(field.span,
628 &self.parameter_environment
631 AdtField { ty: field_ty, span: field.span }
634 AdtVariant { fields: fields }
637 fn enum_variants(&self, enum_def: &hir::EnumDef) -> Vec<AdtVariant<'tcx>> {
638 enum_def.variants.iter()
639 .map(|variant| self.struct_variant(&variant.node.data))
643 fn impl_implied_bounds(&self, impl_def_id: DefId, span: Span) -> Vec<Ty<'tcx>> {
644 let free_substs = &self.parameter_environment.free_substs;
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.instantiate_type_scheme(span, free_substs, 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.instantiate_type_scheme(span, free_substs, &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))