]> git.lizzy.rs Git - rust.git/blob - src/librustc_typeck/check/compare_method.rs
Rename AssocKind::Method to AssocKind::Fn
[rust.git] / src / librustc_typeck / check / compare_method.rs
1 use rustc_errors::{pluralize, struct_span_err, Applicability, DiagnosticId, ErrorReported};
2 use rustc_hir as hir;
3 use rustc_hir::def::{DefKind, Res};
4 use rustc_hir::intravisit;
5 use rustc_hir::{GenericParamKind, ImplItemKind, TraitItemKind};
6 use rustc_infer::infer::{self, InferOk, TyCtxtInferExt};
7 use rustc_middle::ty::error::{ExpectedFound, TypeError};
8 use rustc_middle::ty::subst::{InternalSubsts, Subst};
9 use rustc_middle::ty::util::ExplicitSelf;
10 use rustc_middle::ty::{self, GenericParamDefKind, TyCtxt};
11 use rustc_span::Span;
12 use rustc_trait_selection::traits::error_reporting::InferCtxtExt;
13 use rustc_trait_selection::traits::{self, ObligationCause, ObligationCauseCode, Reveal};
14
15 use super::{potentially_plural_count, FnCtxt, Inherited};
16
17 /// Checks that a method from an impl conforms to the signature of
18 /// the same method as declared in the trait.
19 ///
20 /// # Parameters
21 ///
22 /// - `impl_m`: type of the method we are checking
23 /// - `impl_m_span`: span to use for reporting errors
24 /// - `trait_m`: the method in the trait
25 /// - `impl_trait_ref`: the TraitRef corresponding to the trait implementation
26
27 crate fn compare_impl_method<'tcx>(
28     tcx: TyCtxt<'tcx>,
29     impl_m: &ty::AssocItem,
30     impl_m_span: Span,
31     trait_m: &ty::AssocItem,
32     impl_trait_ref: ty::TraitRef<'tcx>,
33     trait_item_span: Option<Span>,
34 ) {
35     debug!("compare_impl_method(impl_trait_ref={:?})", impl_trait_ref);
36
37     let impl_m_span = tcx.sess.source_map().guess_head_span(impl_m_span);
38
39     if let Err(ErrorReported) = compare_self_type(tcx, impl_m, impl_m_span, trait_m, impl_trait_ref)
40     {
41         return;
42     }
43
44     if let Err(ErrorReported) =
45         compare_number_of_generics(tcx, impl_m, impl_m_span, trait_m, trait_item_span)
46     {
47         return;
48     }
49
50     if let Err(ErrorReported) =
51         compare_number_of_method_arguments(tcx, impl_m, impl_m_span, trait_m, trait_item_span)
52     {
53         return;
54     }
55
56     if let Err(ErrorReported) = compare_synthetic_generics(tcx, impl_m, trait_m) {
57         return;
58     }
59
60     if let Err(ErrorReported) =
61         compare_predicate_entailment(tcx, impl_m, impl_m_span, trait_m, impl_trait_ref)
62     {
63         return;
64     }
65 }
66
67 fn compare_predicate_entailment<'tcx>(
68     tcx: TyCtxt<'tcx>,
69     impl_m: &ty::AssocItem,
70     impl_m_span: Span,
71     trait_m: &ty::AssocItem,
72     impl_trait_ref: ty::TraitRef<'tcx>,
73 ) -> Result<(), ErrorReported> {
74     let trait_to_impl_substs = impl_trait_ref.substs;
75
76     // This node-id should be used for the `body_id` field on each
77     // `ObligationCause` (and the `FnCtxt`). This is what
78     // `regionck_item` expects.
79     let impl_m_hir_id = tcx.hir().as_local_hir_id(impl_m.def_id).unwrap();
80
81     let cause = ObligationCause {
82         span: impl_m_span,
83         body_id: impl_m_hir_id,
84         code: ObligationCauseCode::CompareImplMethodObligation {
85             item_name: impl_m.ident.name,
86             impl_item_def_id: impl_m.def_id,
87             trait_item_def_id: trait_m.def_id,
88         },
89     };
90
91     // This code is best explained by example. Consider a trait:
92     //
93     //     trait Trait<'t,T> {
94     //          fn method<'a,M>(t: &'t T, m: &'a M) -> Self;
95     //     }
96     //
97     // And an impl:
98     //
99     //     impl<'i, 'j, U> Trait<'j, &'i U> for Foo {
100     //          fn method<'b,N>(t: &'j &'i U, m: &'b N) -> Foo;
101     //     }
102     //
103     // We wish to decide if those two method types are compatible.
104     //
105     // We start out with trait_to_impl_substs, that maps the trait
106     // type parameters to impl type parameters. This is taken from the
107     // impl trait reference:
108     //
109     //     trait_to_impl_substs = {'t => 'j, T => &'i U, Self => Foo}
110     //
111     // We create a mapping `dummy_substs` that maps from the impl type
112     // parameters to fresh types and regions. For type parameters,
113     // this is the identity transform, but we could as well use any
114     // placeholder types. For regions, we convert from bound to free
115     // regions (Note: but only early-bound regions, i.e., those
116     // declared on the impl or used in type parameter bounds).
117     //
118     //     impl_to_skol_substs = {'i => 'i0, U => U0, N => N0 }
119     //
120     // Now we can apply skol_substs to the type of the impl method
121     // to yield a new function type in terms of our fresh, placeholder
122     // types:
123     //
124     //     <'b> fn(t: &'i0 U0, m: &'b) -> Foo
125     //
126     // We now want to extract and substitute the type of the *trait*
127     // method and compare it. To do so, we must create a compound
128     // substitution by combining trait_to_impl_substs and
129     // impl_to_skol_substs, and also adding a mapping for the method
130     // type parameters. We extend the mapping to also include
131     // the method parameters.
132     //
133     //     trait_to_skol_substs = { T => &'i0 U0, Self => Foo, M => N0 }
134     //
135     // Applying this to the trait method type yields:
136     //
137     //     <'a> fn(t: &'i0 U0, m: &'a) -> Foo
138     //
139     // This type is also the same but the name of the bound region ('a
140     // vs 'b).  However, the normal subtyping rules on fn types handle
141     // this kind of equivalency just fine.
142     //
143     // We now use these substitutions to ensure that all declared bounds are
144     // satisfied by the implementation's method.
145     //
146     // We do this by creating a parameter environment which contains a
147     // substitution corresponding to impl_to_skol_substs. We then build
148     // trait_to_skol_substs and use it to convert the predicates contained
149     // in the trait_m.generics to the placeholder form.
150     //
151     // Finally we register each of these predicates as an obligation in
152     // a fresh FulfillmentCtxt, and invoke select_all_or_error.
153
154     // Create mapping from impl to placeholder.
155     let impl_to_skol_substs = InternalSubsts::identity_for_item(tcx, impl_m.def_id);
156
157     // Create mapping from trait to placeholder.
158     let trait_to_skol_substs =
159         impl_to_skol_substs.rebase_onto(tcx, impl_m.container.id(), trait_to_impl_substs);
160     debug!("compare_impl_method: trait_to_skol_substs={:?}", trait_to_skol_substs);
161
162     let impl_m_generics = tcx.generics_of(impl_m.def_id);
163     let trait_m_generics = tcx.generics_of(trait_m.def_id);
164     let impl_m_predicates = tcx.predicates_of(impl_m.def_id);
165     let trait_m_predicates = tcx.predicates_of(trait_m.def_id);
166
167     // Check region bounds.
168     check_region_bounds_on_impl_item(
169         tcx,
170         impl_m_span,
171         impl_m,
172         trait_m,
173         &trait_m_generics,
174         &impl_m_generics,
175     )?;
176
177     // Create obligations for each predicate declared by the impl
178     // definition in the context of the trait's parameter
179     // environment. We can't just use `impl_env.caller_bounds`,
180     // however, because we want to replace all late-bound regions with
181     // region variables.
182     let impl_predicates = tcx.predicates_of(impl_m_predicates.parent.unwrap());
183     let mut hybrid_preds = impl_predicates.instantiate_identity(tcx);
184
185     debug!("compare_impl_method: impl_bounds={:?}", hybrid_preds);
186
187     // This is the only tricky bit of the new way we check implementation methods
188     // We need to build a set of predicates where only the method-level bounds
189     // are from the trait and we assume all other bounds from the implementation
190     // to be previously satisfied.
191     //
192     // We then register the obligations from the impl_m and check to see
193     // if all constraints hold.
194     hybrid_preds
195         .predicates
196         .extend(trait_m_predicates.instantiate_own(tcx, trait_to_skol_substs).predicates);
197
198     // Construct trait parameter environment and then shift it into the placeholder viewpoint.
199     // The key step here is to update the caller_bounds's predicates to be
200     // the new hybrid bounds we computed.
201     let normalize_cause = traits::ObligationCause::misc(impl_m_span, impl_m_hir_id);
202     let param_env = ty::ParamEnv::new(
203         tcx.intern_predicates(&hybrid_preds.predicates),
204         Reveal::UserFacing,
205         None,
206     );
207     let param_env = traits::normalize_param_env_or_error(
208         tcx,
209         impl_m.def_id,
210         param_env,
211         normalize_cause.clone(),
212     );
213
214     tcx.infer_ctxt().enter(|infcx| {
215         let inh = Inherited::new(infcx, impl_m.def_id.expect_local());
216         let infcx = &inh.infcx;
217
218         debug!("compare_impl_method: caller_bounds={:?}", param_env.caller_bounds);
219
220         let mut selcx = traits::SelectionContext::new(&infcx);
221
222         let impl_m_own_bounds = impl_m_predicates.instantiate_own(tcx, impl_to_skol_substs);
223         let (impl_m_own_bounds, _) = infcx.replace_bound_vars_with_fresh_vars(
224             impl_m_span,
225             infer::HigherRankedType,
226             &ty::Binder::bind(impl_m_own_bounds.predicates),
227         );
228         for predicate in impl_m_own_bounds {
229             let traits::Normalized { value: predicate, obligations } =
230                 traits::normalize(&mut selcx, param_env, normalize_cause.clone(), &predicate);
231
232             inh.register_predicates(obligations);
233             inh.register_predicate(traits::Obligation::new(cause.clone(), param_env, predicate));
234         }
235
236         // We now need to check that the signature of the impl method is
237         // compatible with that of the trait method. We do this by
238         // checking that `impl_fty <: trait_fty`.
239         //
240         // FIXME. Unfortunately, this doesn't quite work right now because
241         // associated type normalization is not integrated into subtype
242         // checks. For the comparison to be valid, we need to
243         // normalize the associated types in the impl/trait methods
244         // first. However, because function types bind regions, just
245         // calling `normalize_associated_types_in` would have no effect on
246         // any associated types appearing in the fn arguments or return
247         // type.
248
249         // Compute placeholder form of impl and trait method tys.
250         let tcx = infcx.tcx;
251
252         let (impl_sig, _) = infcx.replace_bound_vars_with_fresh_vars(
253             impl_m_span,
254             infer::HigherRankedType,
255             &tcx.fn_sig(impl_m.def_id),
256         );
257         let impl_sig =
258             inh.normalize_associated_types_in(impl_m_span, impl_m_hir_id, param_env, &impl_sig);
259         let impl_fty = tcx.mk_fn_ptr(ty::Binder::bind(impl_sig));
260         debug!("compare_impl_method: impl_fty={:?}", impl_fty);
261
262         let trait_sig = tcx.liberate_late_bound_regions(impl_m.def_id, &tcx.fn_sig(trait_m.def_id));
263         let trait_sig = trait_sig.subst(tcx, trait_to_skol_substs);
264         let trait_sig =
265             inh.normalize_associated_types_in(impl_m_span, impl_m_hir_id, param_env, &trait_sig);
266         let trait_fty = tcx.mk_fn_ptr(ty::Binder::bind(trait_sig));
267
268         debug!("compare_impl_method: trait_fty={:?}", trait_fty);
269
270         let sub_result = infcx.at(&cause, param_env).sup(trait_fty, impl_fty).map(
271             |InferOk { obligations, .. }| {
272                 inh.register_predicates(obligations);
273             },
274         );
275
276         if let Err(terr) = sub_result {
277             debug!("sub_types failed: impl ty {:?}, trait ty {:?}", impl_fty, trait_fty);
278
279             let (impl_err_span, trait_err_span) = extract_spans_for_error_reporting(
280                 &infcx, param_env, &terr, &cause, impl_m, impl_sig, trait_m, trait_sig,
281             );
282
283             let cause = ObligationCause { span: impl_err_span, ..cause };
284
285             let mut diag = struct_span_err!(
286                 tcx.sess,
287                 cause.span(tcx),
288                 E0053,
289                 "method `{}` has an incompatible type for trait",
290                 trait_m.ident
291             );
292             if let TypeError::Mutability = terr {
293                 if let Some(trait_err_span) = trait_err_span {
294                     if let Ok(trait_err_str) = tcx.sess.source_map().span_to_snippet(trait_err_span)
295                     {
296                         diag.span_suggestion(
297                             impl_err_span,
298                             "consider change the type to match the mutability in trait",
299                             trait_err_str,
300                             Applicability::MachineApplicable,
301                         );
302                     }
303                 }
304             }
305
306             infcx.note_type_err(
307                 &mut diag,
308                 &cause,
309                 trait_err_span.map(|sp| (sp, "type in trait".to_owned())),
310                 Some(infer::ValuePairs::Types(ExpectedFound {
311                     expected: trait_fty,
312                     found: impl_fty,
313                 })),
314                 &terr,
315             );
316             diag.emit();
317             return Err(ErrorReported);
318         }
319
320         // Check that all obligations are satisfied by the implementation's
321         // version.
322         if let Err(ref errors) = inh.fulfillment_cx.borrow_mut().select_all_or_error(&infcx) {
323             infcx.report_fulfillment_errors(errors, None, false);
324             return Err(ErrorReported);
325         }
326
327         // Finally, resolve all regions. This catches wily misuses of
328         // lifetime parameters.
329         let fcx = FnCtxt::new(&inh, param_env, impl_m_hir_id);
330         fcx.regionck_item(impl_m_hir_id, impl_m_span, &[]);
331
332         Ok(())
333     })
334 }
335
336 fn check_region_bounds_on_impl_item<'tcx>(
337     tcx: TyCtxt<'tcx>,
338     span: Span,
339     impl_m: &ty::AssocItem,
340     trait_m: &ty::AssocItem,
341     trait_generics: &ty::Generics,
342     impl_generics: &ty::Generics,
343 ) -> Result<(), ErrorReported> {
344     let trait_params = trait_generics.own_counts().lifetimes;
345     let impl_params = impl_generics.own_counts().lifetimes;
346
347     debug!(
348         "check_region_bounds_on_impl_item: \
349             trait_generics={:?} \
350             impl_generics={:?}",
351         trait_generics, impl_generics
352     );
353
354     // Must have same number of early-bound lifetime parameters.
355     // Unfortunately, if the user screws up the bounds, then this
356     // will change classification between early and late.  E.g.,
357     // if in trait we have `<'a,'b:'a>`, and in impl we just have
358     // `<'a,'b>`, then we have 2 early-bound lifetime parameters
359     // in trait but 0 in the impl. But if we report "expected 2
360     // but found 0" it's confusing, because it looks like there
361     // are zero. Since I don't quite know how to phrase things at
362     // the moment, give a kind of vague error message.
363     if trait_params != impl_params {
364         let item_kind = assoc_item_kind_str(impl_m);
365         let def_span = tcx.sess.source_map().guess_head_span(span);
366         let span = tcx.hir().get_generics(impl_m.def_id).map(|g| g.span).unwrap_or(def_span);
367         let mut err = struct_span_err!(
368             tcx.sess,
369             span,
370             E0195,
371             "lifetime parameters or bounds on {} `{}` do not match the trait declaration",
372             item_kind,
373             impl_m.ident,
374         );
375         err.span_label(span, &format!("lifetimes do not match {} in trait", item_kind));
376         if let Some(sp) = tcx.hir().span_if_local(trait_m.def_id) {
377             let def_sp = tcx.sess.source_map().guess_head_span(sp);
378             let sp = tcx.hir().get_generics(trait_m.def_id).map(|g| g.span).unwrap_or(def_sp);
379             err.span_label(
380                 sp,
381                 &format!("lifetimes in impl do not match this {} in trait", item_kind),
382             );
383         }
384         err.emit();
385         return Err(ErrorReported);
386     }
387
388     Ok(())
389 }
390
391 fn extract_spans_for_error_reporting<'a, 'tcx>(
392     infcx: &infer::InferCtxt<'a, 'tcx>,
393     param_env: ty::ParamEnv<'tcx>,
394     terr: &TypeError<'_>,
395     cause: &ObligationCause<'tcx>,
396     impl_m: &ty::AssocItem,
397     impl_sig: ty::FnSig<'tcx>,
398     trait_m: &ty::AssocItem,
399     trait_sig: ty::FnSig<'tcx>,
400 ) -> (Span, Option<Span>) {
401     let tcx = infcx.tcx;
402     let impl_m_hir_id = tcx.hir().as_local_hir_id(impl_m.def_id).unwrap();
403     let (impl_m_output, impl_m_iter) = match tcx.hir().expect_impl_item(impl_m_hir_id).kind {
404         ImplItemKind::Fn(ref impl_m_sig, _) => {
405             (&impl_m_sig.decl.output, impl_m_sig.decl.inputs.iter())
406         }
407         _ => bug!("{:?} is not a method", impl_m),
408     };
409
410     match *terr {
411         TypeError::Mutability => {
412             if let Some(trait_m_hir_id) = tcx.hir().as_local_hir_id(trait_m.def_id) {
413                 let trait_m_iter = match tcx.hir().expect_trait_item(trait_m_hir_id).kind {
414                     TraitItemKind::Fn(ref trait_m_sig, _) => trait_m_sig.decl.inputs.iter(),
415                     _ => bug!("{:?} is not a TraitItemKind::Fn", trait_m),
416                 };
417
418                 impl_m_iter
419                     .zip(trait_m_iter)
420                     .find(|&(ref impl_arg, ref trait_arg)| {
421                         match (&impl_arg.kind, &trait_arg.kind) {
422                             (
423                                 &hir::TyKind::Rptr(_, ref impl_mt),
424                                 &hir::TyKind::Rptr(_, ref trait_mt),
425                             )
426                             | (&hir::TyKind::Ptr(ref impl_mt), &hir::TyKind::Ptr(ref trait_mt)) => {
427                                 impl_mt.mutbl != trait_mt.mutbl
428                             }
429                             _ => false,
430                         }
431                     })
432                     .map(|(ref impl_arg, ref trait_arg)| (impl_arg.span, Some(trait_arg.span)))
433                     .unwrap_or_else(|| (cause.span(tcx), tcx.hir().span_if_local(trait_m.def_id)))
434             } else {
435                 (cause.span(tcx), tcx.hir().span_if_local(trait_m.def_id))
436             }
437         }
438         TypeError::Sorts(ExpectedFound { .. }) => {
439             if let Some(trait_m_hir_id) = tcx.hir().as_local_hir_id(trait_m.def_id) {
440                 let (trait_m_output, trait_m_iter) =
441                     match tcx.hir().expect_trait_item(trait_m_hir_id).kind {
442                         TraitItemKind::Fn(ref trait_m_sig, _) => {
443                             (&trait_m_sig.decl.output, trait_m_sig.decl.inputs.iter())
444                         }
445                         _ => bug!("{:?} is not a TraitItemKind::Fn", trait_m),
446                     };
447
448                 let impl_iter = impl_sig.inputs().iter();
449                 let trait_iter = trait_sig.inputs().iter();
450                 impl_iter
451                     .zip(trait_iter)
452                     .zip(impl_m_iter)
453                     .zip(trait_m_iter)
454                     .filter_map(
455                         |(((&impl_arg_ty, &trait_arg_ty), impl_arg), trait_arg)| match infcx
456                             .at(&cause, param_env)
457                             .sub(trait_arg_ty, impl_arg_ty)
458                         {
459                             Ok(_) => None,
460                             Err(_) => Some((impl_arg.span, Some(trait_arg.span))),
461                         },
462                     )
463                     .next()
464                     .unwrap_or_else(|| {
465                         if infcx
466                             .at(&cause, param_env)
467                             .sup(trait_sig.output(), impl_sig.output())
468                             .is_err()
469                         {
470                             (impl_m_output.span(), Some(trait_m_output.span()))
471                         } else {
472                             (cause.span(tcx), tcx.hir().span_if_local(trait_m.def_id))
473                         }
474                     })
475             } else {
476                 (cause.span(tcx), tcx.hir().span_if_local(trait_m.def_id))
477             }
478         }
479         _ => (cause.span(tcx), tcx.hir().span_if_local(trait_m.def_id)),
480     }
481 }
482
483 fn compare_self_type<'tcx>(
484     tcx: TyCtxt<'tcx>,
485     impl_m: &ty::AssocItem,
486     impl_m_span: Span,
487     trait_m: &ty::AssocItem,
488     impl_trait_ref: ty::TraitRef<'tcx>,
489 ) -> Result<(), ErrorReported> {
490     // Try to give more informative error messages about self typing
491     // mismatches.  Note that any mismatch will also be detected
492     // below, where we construct a canonical function type that
493     // includes the self parameter as a normal parameter.  It's just
494     // that the error messages you get out of this code are a bit more
495     // inscrutable, particularly for cases where one method has no
496     // self.
497
498     let self_string = |method: &ty::AssocItem| {
499         let untransformed_self_ty = match method.container {
500             ty::ImplContainer(_) => impl_trait_ref.self_ty(),
501             ty::TraitContainer(_) => tcx.types.self_param,
502         };
503         let self_arg_ty = *tcx.fn_sig(method.def_id).input(0).skip_binder();
504         let param_env = ty::ParamEnv::reveal_all();
505
506         tcx.infer_ctxt().enter(|infcx| {
507             let self_arg_ty =
508                 tcx.liberate_late_bound_regions(method.def_id, &ty::Binder::bind(self_arg_ty));
509             let can_eq_self = |ty| infcx.can_eq(param_env, untransformed_self_ty, ty).is_ok();
510             match ExplicitSelf::determine(self_arg_ty, can_eq_self) {
511                 ExplicitSelf::ByValue => "self".to_owned(),
512                 ExplicitSelf::ByReference(_, hir::Mutability::Not) => "&self".to_owned(),
513                 ExplicitSelf::ByReference(_, hir::Mutability::Mut) => "&mut self".to_owned(),
514                 _ => format!("self: {}", self_arg_ty),
515             }
516         })
517     };
518
519     match (trait_m.fn_has_self_parameter, impl_m.fn_has_self_parameter) {
520         (false, false) | (true, true) => {}
521
522         (false, true) => {
523             let self_descr = self_string(impl_m);
524             let mut err = struct_span_err!(
525                 tcx.sess,
526                 impl_m_span,
527                 E0185,
528                 "method `{}` has a `{}` declaration in the impl, but \
529                                             not in the trait",
530                 trait_m.ident,
531                 self_descr
532             );
533             err.span_label(impl_m_span, format!("`{}` used in impl", self_descr));
534             if let Some(span) = tcx.hir().span_if_local(trait_m.def_id) {
535                 err.span_label(span, format!("trait method declared without `{}`", self_descr));
536             } else {
537                 err.note_trait_signature(trait_m.ident.to_string(), trait_m.signature(tcx));
538             }
539             err.emit();
540             return Err(ErrorReported);
541         }
542
543         (true, false) => {
544             let self_descr = self_string(trait_m);
545             let mut err = struct_span_err!(
546                 tcx.sess,
547                 impl_m_span,
548                 E0186,
549                 "method `{}` has a `{}` declaration in the trait, but \
550                                             not in the impl",
551                 trait_m.ident,
552                 self_descr
553             );
554             err.span_label(impl_m_span, format!("expected `{}` in impl", self_descr));
555             if let Some(span) = tcx.hir().span_if_local(trait_m.def_id) {
556                 err.span_label(span, format!("`{}` used in trait", self_descr));
557             } else {
558                 err.note_trait_signature(trait_m.ident.to_string(), trait_m.signature(tcx));
559             }
560             err.emit();
561             return Err(ErrorReported);
562         }
563     }
564
565     Ok(())
566 }
567
568 fn compare_number_of_generics<'tcx>(
569     tcx: TyCtxt<'tcx>,
570     impl_: &ty::AssocItem,
571     _impl_span: Span,
572     trait_: &ty::AssocItem,
573     trait_span: Option<Span>,
574 ) -> Result<(), ErrorReported> {
575     let trait_own_counts = tcx.generics_of(trait_.def_id).own_counts();
576     let impl_own_counts = tcx.generics_of(impl_.def_id).own_counts();
577
578     let matchings = [
579         ("type", trait_own_counts.types, impl_own_counts.types),
580         ("const", trait_own_counts.consts, impl_own_counts.consts),
581     ];
582
583     let item_kind = assoc_item_kind_str(impl_);
584
585     let mut err_occurred = false;
586     for &(kind, trait_count, impl_count) in &matchings {
587         if impl_count != trait_count {
588             err_occurred = true;
589
590             let (trait_spans, impl_trait_spans) =
591                 if let Some(trait_hir_id) = tcx.hir().as_local_hir_id(trait_.def_id) {
592                     let trait_item = tcx.hir().expect_trait_item(trait_hir_id);
593                     if trait_item.generics.params.is_empty() {
594                         (Some(vec![trait_item.generics.span]), vec![])
595                     } else {
596                         let arg_spans: Vec<Span> =
597                             trait_item.generics.params.iter().map(|p| p.span).collect();
598                         let impl_trait_spans: Vec<Span> = trait_item
599                             .generics
600                             .params
601                             .iter()
602                             .filter_map(|p| match p.kind {
603                                 GenericParamKind::Type {
604                                     synthetic: Some(hir::SyntheticTyParamKind::ImplTrait),
605                                     ..
606                                 } => Some(p.span),
607                                 _ => None,
608                             })
609                             .collect();
610                         (Some(arg_spans), impl_trait_spans)
611                     }
612                 } else {
613                     (trait_span.map(|s| vec![s]), vec![])
614                 };
615
616             let impl_hir_id = tcx.hir().as_local_hir_id(impl_.def_id).unwrap();
617             let impl_item = tcx.hir().expect_impl_item(impl_hir_id);
618             let impl_item_impl_trait_spans: Vec<Span> = impl_item
619                 .generics
620                 .params
621                 .iter()
622                 .filter_map(|p| match p.kind {
623                     GenericParamKind::Type {
624                         synthetic: Some(hir::SyntheticTyParamKind::ImplTrait),
625                         ..
626                     } => Some(p.span),
627                     _ => None,
628                 })
629                 .collect();
630             let spans = impl_item.generics.spans();
631             let span = spans.primary_span();
632
633             let mut err = tcx.sess.struct_span_err_with_code(
634                 spans,
635                 &format!(
636                     "{} `{}` has {} {kind} parameter{} but its trait \
637                      declaration has {} {kind} parameter{}",
638                     item_kind,
639                     trait_.ident,
640                     impl_count,
641                     pluralize!(impl_count),
642                     trait_count,
643                     pluralize!(trait_count),
644                     kind = kind,
645                 ),
646                 DiagnosticId::Error("E0049".into()),
647             );
648
649             let mut suffix = None;
650
651             if let Some(spans) = trait_spans {
652                 let mut spans = spans.iter();
653                 if let Some(span) = spans.next() {
654                     err.span_label(
655                         *span,
656                         format!(
657                             "expected {} {} parameter{}",
658                             trait_count,
659                             kind,
660                             pluralize!(trait_count),
661                         ),
662                     );
663                 }
664                 for span in spans {
665                     err.span_label(*span, "");
666                 }
667             } else {
668                 suffix = Some(format!(", expected {}", trait_count));
669             }
670
671             if let Some(span) = span {
672                 err.span_label(
673                     span,
674                     format!(
675                         "found {} {} parameter{}{}",
676                         impl_count,
677                         kind,
678                         pluralize!(impl_count),
679                         suffix.unwrap_or_else(String::new),
680                     ),
681                 );
682             }
683
684             for span in impl_trait_spans.iter().chain(impl_item_impl_trait_spans.iter()) {
685                 err.span_label(*span, "`impl Trait` introduces an implicit type parameter");
686             }
687
688             err.emit();
689         }
690     }
691
692     if err_occurred { Err(ErrorReported) } else { Ok(()) }
693 }
694
695 fn compare_number_of_method_arguments<'tcx>(
696     tcx: TyCtxt<'tcx>,
697     impl_m: &ty::AssocItem,
698     impl_m_span: Span,
699     trait_m: &ty::AssocItem,
700     trait_item_span: Option<Span>,
701 ) -> Result<(), ErrorReported> {
702     let impl_m_fty = tcx.fn_sig(impl_m.def_id);
703     let trait_m_fty = tcx.fn_sig(trait_m.def_id);
704     let trait_number_args = trait_m_fty.inputs().skip_binder().len();
705     let impl_number_args = impl_m_fty.inputs().skip_binder().len();
706     if trait_number_args != impl_number_args {
707         let trait_m_hir_id = tcx.hir().as_local_hir_id(trait_m.def_id);
708         let trait_span = if let Some(trait_id) = trait_m_hir_id {
709             match tcx.hir().expect_trait_item(trait_id).kind {
710                 TraitItemKind::Fn(ref trait_m_sig, _) => {
711                     let pos = if trait_number_args > 0 { trait_number_args - 1 } else { 0 };
712                     if let Some(arg) = trait_m_sig.decl.inputs.get(pos) {
713                         Some(if pos == 0 {
714                             arg.span
715                         } else {
716                             Span::new(
717                                 trait_m_sig.decl.inputs[0].span.lo(),
718                                 arg.span.hi(),
719                                 arg.span.ctxt(),
720                             )
721                         })
722                     } else {
723                         trait_item_span
724                     }
725                 }
726                 _ => bug!("{:?} is not a method", impl_m),
727             }
728         } else {
729             trait_item_span
730         };
731         let impl_m_hir_id = tcx.hir().as_local_hir_id(impl_m.def_id).unwrap();
732         let impl_span = match tcx.hir().expect_impl_item(impl_m_hir_id).kind {
733             ImplItemKind::Fn(ref impl_m_sig, _) => {
734                 let pos = if impl_number_args > 0 { impl_number_args - 1 } else { 0 };
735                 if let Some(arg) = impl_m_sig.decl.inputs.get(pos) {
736                     if pos == 0 {
737                         arg.span
738                     } else {
739                         Span::new(
740                             impl_m_sig.decl.inputs[0].span.lo(),
741                             arg.span.hi(),
742                             arg.span.ctxt(),
743                         )
744                     }
745                 } else {
746                     impl_m_span
747                 }
748             }
749             _ => bug!("{:?} is not a method", impl_m),
750         };
751         let mut err = struct_span_err!(
752             tcx.sess,
753             impl_span,
754             E0050,
755             "method `{}` has {} but the declaration in \
756                                         trait `{}` has {}",
757             trait_m.ident,
758             potentially_plural_count(impl_number_args, "parameter"),
759             tcx.def_path_str(trait_m.def_id),
760             trait_number_args
761         );
762         if let Some(trait_span) = trait_span {
763             err.span_label(
764                 trait_span,
765                 format!(
766                     "trait requires {}",
767                     potentially_plural_count(trait_number_args, "parameter")
768                 ),
769             );
770         } else {
771             err.note_trait_signature(trait_m.ident.to_string(), trait_m.signature(tcx));
772         }
773         err.span_label(
774             impl_span,
775             format!(
776                 "expected {}, found {}",
777                 potentially_plural_count(trait_number_args, "parameter"),
778                 impl_number_args
779             ),
780         );
781         err.emit();
782         return Err(ErrorReported);
783     }
784
785     Ok(())
786 }
787
788 fn compare_synthetic_generics<'tcx>(
789     tcx: TyCtxt<'tcx>,
790     impl_m: &ty::AssocItem,
791     trait_m: &ty::AssocItem,
792 ) -> Result<(), ErrorReported> {
793     // FIXME(chrisvittal) Clean up this function, list of FIXME items:
794     //     1. Better messages for the span labels
795     //     2. Explanation as to what is going on
796     // If we get here, we already have the same number of generics, so the zip will
797     // be okay.
798     let mut error_found = false;
799     let impl_m_generics = tcx.generics_of(impl_m.def_id);
800     let trait_m_generics = tcx.generics_of(trait_m.def_id);
801     let impl_m_type_params = impl_m_generics.params.iter().filter_map(|param| match param.kind {
802         GenericParamDefKind::Type { synthetic, .. } => Some((param.def_id, synthetic)),
803         GenericParamDefKind::Lifetime | GenericParamDefKind::Const => None,
804     });
805     let trait_m_type_params = trait_m_generics.params.iter().filter_map(|param| match param.kind {
806         GenericParamDefKind::Type { synthetic, .. } => Some((param.def_id, synthetic)),
807         GenericParamDefKind::Lifetime | GenericParamDefKind::Const => None,
808     });
809     for ((impl_def_id, impl_synthetic), (trait_def_id, trait_synthetic)) in
810         impl_m_type_params.zip(trait_m_type_params)
811     {
812         if impl_synthetic != trait_synthetic {
813             let impl_hir_id = tcx.hir().as_local_hir_id(impl_def_id).unwrap();
814             let impl_span = tcx.hir().span(impl_hir_id);
815             let trait_span = tcx.def_span(trait_def_id);
816             let mut err = struct_span_err!(
817                 tcx.sess,
818                 impl_span,
819                 E0643,
820                 "method `{}` has incompatible signature for trait",
821                 trait_m.ident
822             );
823             err.span_label(trait_span, "declaration in trait here");
824             match (impl_synthetic, trait_synthetic) {
825                 // The case where the impl method uses `impl Trait` but the trait method uses
826                 // explicit generics
827                 (Some(hir::SyntheticTyParamKind::ImplTrait), None) => {
828                     err.span_label(impl_span, "expected generic parameter, found `impl Trait`");
829                     (|| {
830                         // try taking the name from the trait impl
831                         // FIXME: this is obviously suboptimal since the name can already be used
832                         // as another generic argument
833                         let new_name = tcx.sess.source_map().span_to_snippet(trait_span).ok()?;
834                         let trait_m = tcx.hir().as_local_hir_id(trait_m.def_id)?;
835                         let trait_m = tcx.hir().trait_item(hir::TraitItemId { hir_id: trait_m });
836
837                         let impl_m = tcx.hir().as_local_hir_id(impl_m.def_id)?;
838                         let impl_m = tcx.hir().impl_item(hir::ImplItemId { hir_id: impl_m });
839
840                         // in case there are no generics, take the spot between the function name
841                         // and the opening paren of the argument list
842                         let new_generics_span =
843                             tcx.sess.source_map().generate_fn_name_span(impl_span)?.shrink_to_hi();
844                         // in case there are generics, just replace them
845                         let generics_span =
846                             impl_m.generics.span.substitute_dummy(new_generics_span);
847                         // replace with the generics from the trait
848                         let new_generics =
849                             tcx.sess.source_map().span_to_snippet(trait_m.generics.span).ok()?;
850
851                         err.multipart_suggestion(
852                             "try changing the `impl Trait` argument to a generic parameter",
853                             vec![
854                                 // replace `impl Trait` with `T`
855                                 (impl_span, new_name),
856                                 // replace impl method generics with trait method generics
857                                 // This isn't quite right, as users might have changed the names
858                                 // of the generics, but it works for the common case
859                                 (generics_span, new_generics),
860                             ],
861                             Applicability::MaybeIncorrect,
862                         );
863                         Some(())
864                     })();
865                 }
866                 // The case where the trait method uses `impl Trait`, but the impl method uses
867                 // explicit generics.
868                 (None, Some(hir::SyntheticTyParamKind::ImplTrait)) => {
869                     err.span_label(impl_span, "expected `impl Trait`, found generic parameter");
870                     (|| {
871                         let impl_m = tcx.hir().as_local_hir_id(impl_m.def_id)?;
872                         let impl_m = tcx.hir().impl_item(hir::ImplItemId { hir_id: impl_m });
873                         let input_tys = match impl_m.kind {
874                             hir::ImplItemKind::Fn(ref sig, _) => sig.decl.inputs,
875                             _ => unreachable!(),
876                         };
877                         struct Visitor(Option<Span>, hir::def_id::DefId);
878                         impl<'v> intravisit::Visitor<'v> for Visitor {
879                             fn visit_ty(&mut self, ty: &'v hir::Ty<'v>) {
880                                 intravisit::walk_ty(self, ty);
881                                 if let hir::TyKind::Path(hir::QPath::Resolved(None, ref path)) =
882                                     ty.kind
883                                 {
884                                     if let Res::Def(DefKind::TyParam, def_id) = path.res {
885                                         if def_id == self.1 {
886                                             self.0 = Some(ty.span);
887                                         }
888                                     }
889                                 }
890                             }
891                             type Map = intravisit::ErasedMap<'v>;
892                             fn nested_visit_map(
893                                 &mut self,
894                             ) -> intravisit::NestedVisitorMap<Self::Map>
895                             {
896                                 intravisit::NestedVisitorMap::None
897                             }
898                         }
899                         let mut visitor = Visitor(None, impl_def_id);
900                         for ty in input_tys {
901                             intravisit::Visitor::visit_ty(&mut visitor, ty);
902                         }
903                         let span = visitor.0?;
904
905                         let bounds =
906                             impl_m.generics.params.iter().find_map(|param| match param.kind {
907                                 GenericParamKind::Lifetime { .. } => None,
908                                 GenericParamKind::Type { .. } | GenericParamKind::Const { .. } => {
909                                     if param.hir_id == impl_hir_id {
910                                         Some(&param.bounds)
911                                     } else {
912                                         None
913                                     }
914                                 }
915                             })?;
916                         let bounds = bounds.first()?.span().to(bounds.last()?.span());
917                         let bounds = tcx.sess.source_map().span_to_snippet(bounds).ok()?;
918
919                         err.multipart_suggestion(
920                             "try removing the generic parameter and using `impl Trait` instead",
921                             vec![
922                                 // delete generic parameters
923                                 (impl_m.generics.span, String::new()),
924                                 // replace param usage with `impl Trait`
925                                 (span, format!("impl {}", bounds)),
926                             ],
927                             Applicability::MaybeIncorrect,
928                         );
929                         Some(())
930                     })();
931                 }
932                 _ => unreachable!(),
933             }
934             err.emit();
935             error_found = true;
936         }
937     }
938     if error_found { Err(ErrorReported) } else { Ok(()) }
939 }
940
941 crate fn compare_const_impl<'tcx>(
942     tcx: TyCtxt<'tcx>,
943     impl_c: &ty::AssocItem,
944     impl_c_span: Span,
945     trait_c: &ty::AssocItem,
946     impl_trait_ref: ty::TraitRef<'tcx>,
947 ) {
948     debug!("compare_const_impl(impl_trait_ref={:?})", impl_trait_ref);
949
950     tcx.infer_ctxt().enter(|infcx| {
951         let param_env = tcx.param_env(impl_c.def_id);
952         let inh = Inherited::new(infcx, impl_c.def_id.expect_local());
953         let infcx = &inh.infcx;
954
955         // The below is for the most part highly similar to the procedure
956         // for methods above. It is simpler in many respects, especially
957         // because we shouldn't really have to deal with lifetimes or
958         // predicates. In fact some of this should probably be put into
959         // shared functions because of DRY violations...
960         let trait_to_impl_substs = impl_trait_ref.substs;
961
962         // Create a parameter environment that represents the implementation's
963         // method.
964         let impl_c_hir_id = tcx.hir().as_local_hir_id(impl_c.def_id).unwrap();
965
966         // Compute placeholder form of impl and trait const tys.
967         let impl_ty = tcx.type_of(impl_c.def_id);
968         let trait_ty = tcx.type_of(trait_c.def_id).subst(tcx, trait_to_impl_substs);
969         let mut cause = ObligationCause::misc(impl_c_span, impl_c_hir_id);
970
971         // There is no "body" here, so just pass dummy id.
972         let impl_ty =
973             inh.normalize_associated_types_in(impl_c_span, impl_c_hir_id, param_env, &impl_ty);
974
975         debug!("compare_const_impl: impl_ty={:?}", impl_ty);
976
977         let trait_ty =
978             inh.normalize_associated_types_in(impl_c_span, impl_c_hir_id, param_env, &trait_ty);
979
980         debug!("compare_const_impl: trait_ty={:?}", trait_ty);
981
982         let err = infcx
983             .at(&cause, param_env)
984             .sup(trait_ty, impl_ty)
985             .map(|ok| inh.register_infer_ok_obligations(ok));
986
987         if let Err(terr) = err {
988             debug!(
989                 "checking associated const for compatibility: impl ty {:?}, trait ty {:?}",
990                 impl_ty, trait_ty
991             );
992
993             // Locate the Span containing just the type of the offending impl
994             match tcx.hir().expect_impl_item(impl_c_hir_id).kind {
995                 ImplItemKind::Const(ref ty, _) => cause.span = ty.span,
996                 _ => bug!("{:?} is not a impl const", impl_c),
997             }
998
999             let mut diag = struct_span_err!(
1000                 tcx.sess,
1001                 cause.span,
1002                 E0326,
1003                 "implemented const `{}` has an incompatible type for \
1004                                              trait",
1005                 trait_c.ident
1006             );
1007
1008             let trait_c_hir_id = tcx.hir().as_local_hir_id(trait_c.def_id);
1009             let trait_c_span = trait_c_hir_id.map(|trait_c_hir_id| {
1010                 // Add a label to the Span containing just the type of the const
1011                 match tcx.hir().expect_trait_item(trait_c_hir_id).kind {
1012                     TraitItemKind::Const(ref ty, _) => ty.span,
1013                     _ => bug!("{:?} is not a trait const", trait_c),
1014                 }
1015             });
1016
1017             infcx.note_type_err(
1018                 &mut diag,
1019                 &cause,
1020                 trait_c_span.map(|span| (span, "type in trait".to_owned())),
1021                 Some(infer::ValuePairs::Types(ExpectedFound {
1022                     expected: trait_ty,
1023                     found: impl_ty,
1024                 })),
1025                 &terr,
1026             );
1027             diag.emit();
1028         }
1029
1030         // Check that all obligations are satisfied by the implementation's
1031         // version.
1032         if let Err(ref errors) = inh.fulfillment_cx.borrow_mut().select_all_or_error(&infcx) {
1033             infcx.report_fulfillment_errors(errors, None, false);
1034             return;
1035         }
1036
1037         let fcx = FnCtxt::new(&inh, param_env, impl_c_hir_id);
1038         fcx.regionck_item(impl_c_hir_id, impl_c_span, &[]);
1039     });
1040 }
1041
1042 crate fn compare_ty_impl<'tcx>(
1043     tcx: TyCtxt<'tcx>,
1044     impl_ty: &ty::AssocItem,
1045     impl_ty_span: Span,
1046     trait_ty: &ty::AssocItem,
1047     impl_trait_ref: ty::TraitRef<'tcx>,
1048     trait_item_span: Option<Span>,
1049 ) {
1050     debug!("compare_impl_type(impl_trait_ref={:?})", impl_trait_ref);
1051
1052     let _: Result<(), ErrorReported> = (|| {
1053         compare_number_of_generics(tcx, impl_ty, impl_ty_span, trait_ty, trait_item_span)?;
1054
1055         compare_type_predicate_entailment(tcx, impl_ty, impl_ty_span, trait_ty, impl_trait_ref)
1056     })();
1057 }
1058
1059 /// The equivalent of [compare_predicate_entailment], but for associated types
1060 /// instead of associated functions.
1061 fn compare_type_predicate_entailment(
1062     tcx: TyCtxt<'tcx>,
1063     impl_ty: &ty::AssocItem,
1064     impl_ty_span: Span,
1065     trait_ty: &ty::AssocItem,
1066     impl_trait_ref: ty::TraitRef<'tcx>,
1067 ) -> Result<(), ErrorReported> {
1068     let impl_substs = InternalSubsts::identity_for_item(tcx, impl_ty.def_id);
1069     let trait_to_impl_substs =
1070         impl_substs.rebase_onto(tcx, impl_ty.container.id(), impl_trait_ref.substs);
1071
1072     let impl_ty_generics = tcx.generics_of(impl_ty.def_id);
1073     let trait_ty_generics = tcx.generics_of(trait_ty.def_id);
1074     let impl_ty_predicates = tcx.predicates_of(impl_ty.def_id);
1075     let trait_ty_predicates = tcx.predicates_of(trait_ty.def_id);
1076
1077     check_region_bounds_on_impl_item(
1078         tcx,
1079         impl_ty_span,
1080         impl_ty,
1081         trait_ty,
1082         &trait_ty_generics,
1083         &impl_ty_generics,
1084     )?;
1085
1086     let impl_ty_own_bounds = impl_ty_predicates.instantiate_own(tcx, impl_substs);
1087
1088     if impl_ty_own_bounds.is_empty() {
1089         // Nothing to check.
1090         return Ok(());
1091     }
1092
1093     // This `HirId` should be used for the `body_id` field on each
1094     // `ObligationCause` (and the `FnCtxt`). This is what
1095     // `regionck_item` expects.
1096     let impl_ty_hir_id = tcx.hir().as_local_hir_id(impl_ty.def_id).unwrap();
1097     let cause = ObligationCause {
1098         span: impl_ty_span,
1099         body_id: impl_ty_hir_id,
1100         code: ObligationCauseCode::CompareImplTypeObligation {
1101             item_name: impl_ty.ident.name,
1102             impl_item_def_id: impl_ty.def_id,
1103             trait_item_def_id: trait_ty.def_id,
1104         },
1105     };
1106
1107     debug!("compare_type_predicate_entailment: trait_to_impl_substs={:?}", trait_to_impl_substs);
1108
1109     // The predicates declared by the impl definition, the trait and the
1110     // associated type in the trait are assumed.
1111     let impl_predicates = tcx.predicates_of(impl_ty_predicates.parent.unwrap());
1112     let mut hybrid_preds = impl_predicates.instantiate_identity(tcx);
1113     hybrid_preds
1114         .predicates
1115         .extend(trait_ty_predicates.instantiate_own(tcx, trait_to_impl_substs).predicates);
1116
1117     debug!("compare_type_predicate_entailment: bounds={:?}", hybrid_preds);
1118
1119     let normalize_cause = traits::ObligationCause::misc(impl_ty_span, impl_ty_hir_id);
1120     let param_env = ty::ParamEnv::new(
1121         tcx.intern_predicates(&hybrid_preds.predicates),
1122         Reveal::UserFacing,
1123         None,
1124     );
1125     let param_env = traits::normalize_param_env_or_error(
1126         tcx,
1127         impl_ty.def_id,
1128         param_env,
1129         normalize_cause.clone(),
1130     );
1131     tcx.infer_ctxt().enter(|infcx| {
1132         let inh = Inherited::new(infcx, impl_ty.def_id.expect_local());
1133         let infcx = &inh.infcx;
1134
1135         debug!("compare_type_predicate_entailment: caller_bounds={:?}", param_env.caller_bounds);
1136
1137         let mut selcx = traits::SelectionContext::new(&infcx);
1138
1139         for predicate in impl_ty_own_bounds.predicates {
1140             let traits::Normalized { value: predicate, obligations } =
1141                 traits::normalize(&mut selcx, param_env, normalize_cause.clone(), &predicate);
1142
1143             inh.register_predicates(obligations);
1144             inh.register_predicate(traits::Obligation::new(cause.clone(), param_env, predicate));
1145         }
1146
1147         // Check that all obligations are satisfied by the implementation's
1148         // version.
1149         if let Err(ref errors) = inh.fulfillment_cx.borrow_mut().select_all_or_error(&infcx) {
1150             infcx.report_fulfillment_errors(errors, None, false);
1151             return Err(ErrorReported);
1152         }
1153
1154         // Finally, resolve all regions. This catches wily misuses of
1155         // lifetime parameters.
1156         let fcx = FnCtxt::new(&inh, param_env, impl_ty_hir_id);
1157         fcx.regionck_item(impl_ty_hir_id, impl_ty_span, &[]);
1158
1159         Ok(())
1160     })
1161 }
1162
1163 fn assoc_item_kind_str(impl_item: &ty::AssocItem) -> &'static str {
1164     match impl_item.kind {
1165         ty::AssocKind::Const => "const",
1166         ty::AssocKind::Fn => "method",
1167         ty::AssocKind::Type | ty::AssocKind::OpaqueTy => "type",
1168     }
1169 }