compare_method.rs 59.1 KB
Newer Older
1
use crate::errors::LifetimesOrBoundsMismatchOnTrait;
2
use rustc_errors::{pluralize, struct_span_err, Applicability, DiagnosticId, ErrorReported};
3 4
use rustc_hir as hir;
use rustc_hir::def::{DefKind, Res};
5
use rustc_hir::intravisit;
6
use rustc_hir::{GenericParamKind, ImplItemKind, TraitItemKind};
C
Camille GILLOT 已提交
7
use rustc_infer::infer::{self, InferOk, TyCtxtInferExt};
8
use rustc_infer::traits::util;
9
use rustc_middle::ty;
10
use rustc_middle::ty::error::{ExpectedFound, TypeError};
11
use rustc_middle::ty::subst::{InternalSubsts, Subst};
12
use rustc_middle::ty::util::ExplicitSelf;
13
use rustc_middle::ty::{GenericParamDefKind, ToPredicate, TyCtxt};
14
use rustc_span::Span;
C
Camille GILLOT 已提交
15 16
use rustc_trait_selection::traits::error_reporting::InferCtxtExt;
use rustc_trait_selection::traits::{self, ObligationCause, ObligationCauseCode, Reveal};
J
Josh Stone 已提交
17
use std::iter;
18

M
Mark Rousskov 已提交
19
use super::{potentially_plural_count, FnCtxt, Inherited};
20 21 22 23 24 25

/// Checks that a method from an impl conforms to the signature of
/// the same method as declared in the trait.
///
/// # Parameters
///
A
Alexander Regueiro 已提交
26 27 28 29
/// - `impl_m`: type of the method we are checking
/// - `impl_m_span`: span to use for reporting errors
/// - `trait_m`: the method in the trait
/// - `impl_trait_ref`: the TraitRef corresponding to the trait implementation
30

31
crate fn compare_impl_method<'tcx>(
32
    tcx: TyCtxt<'tcx>,
33 34 35 36 37 38
    impl_m: &ty::AssocItem,
    impl_m_span: Span,
    trait_m: &ty::AssocItem,
    impl_trait_ref: ty::TraitRef<'tcx>,
    trait_item_span: Option<Span>,
) {
M
Mark Rousskov 已提交
39
    debug!("compare_impl_method(impl_trait_ref={:?})", impl_trait_ref);
40

41
    let impl_m_span = tcx.sess.source_map().guess_head_span(impl_m_span);
42

M
Mark Rousskov 已提交
43 44
    if let Err(ErrorReported) = compare_self_type(tcx, impl_m, impl_m_span, trait_m, impl_trait_ref)
    {
N
Niko Matsakis 已提交
45
        return;
46 47
    }

M
Mark Rousskov 已提交
48 49 50
    if let Err(ErrorReported) =
        compare_number_of_generics(tcx, impl_m, impl_m_span, trait_m, trait_item_span)
    {
N
Niko Matsakis 已提交
51 52
        return;
    }
T
Tim Neumann 已提交
53

M
Mark Rousskov 已提交
54 55 56
    if let Err(ErrorReported) =
        compare_number_of_method_arguments(tcx, impl_m, impl_m_span, trait_m, trait_item_span)
    {
57 58 59
        return;
    }

M
Mark Rousskov 已提交
60
    if let Err(ErrorReported) = compare_synthetic_generics(tcx, impl_m, trait_m) {
61 62 63
        return;
    }

M
Mark Rousskov 已提交
64 65 66
    if let Err(ErrorReported) =
        compare_predicate_entailment(tcx, impl_m, impl_m_span, trait_m, impl_trait_ref)
    {
67 68
        return;
    }
69 70 71 72

    if let Err(ErrorReported) = compare_const_param_types(tcx, impl_m, trait_m, trait_item_span) {
        return;
    }
N
Niko Matsakis 已提交
73 74
}

75
fn compare_predicate_entailment<'tcx>(
76
    tcx: TyCtxt<'tcx>,
77 78 79 80 81
    impl_m: &ty::AssocItem,
    impl_m_span: Span,
    trait_m: &ty::AssocItem,
    impl_trait_ref: ty::TraitRef<'tcx>,
) -> Result<(), ErrorReported> {
82
    let trait_to_impl_substs = impl_trait_ref.substs;
83

T
Taylor Cramer 已提交
84 85 86
    // This node-id should be used for the `body_id` field on each
    // `ObligationCause` (and the `FnCtxt`). This is what
    // `regionck_item` expects.
87
    let impl_m_hir_id = tcx.hir().local_def_id_to_hir_id(impl_m.def_id.expect_local());
T
Taylor Cramer 已提交
88

89 90 91 92 93
    // We sometimes modify the span further down.
    let mut cause = ObligationCause::new(
        impl_m_span,
        impl_m_hir_id,
        ObligationCauseCode::CompareImplMethodObligation {
94
            item_name: impl_m.ident.name,
95 96 97
            impl_item_def_id: impl_m.def_id,
            trait_item_def_id: trait_m.def_id,
        },
98
    );
99

100 101
    // This code is best explained by example. Consider a trait:
    //
B
Bastian Kauschke 已提交
102 103
    //     trait Trait<'t, T> {
    //         fn method<'a, M>(t: &'t T, m: &'a M) -> Self;
104 105 106 107 108
    //     }
    //
    // And an impl:
    //
    //     impl<'i, 'j, U> Trait<'j, &'i U> for Foo {
B
Bastian Kauschke 已提交
109
    //          fn method<'b, N>(t: &'j &'i U, m: &'b N) -> Foo;
110 111 112 113 114 115 116 117 118 119 120 121 122
    //     }
    //
    // We wish to decide if those two method types are compatible.
    //
    // We start out with trait_to_impl_substs, that maps the trait
    // type parameters to impl type parameters. This is taken from the
    // impl trait reference:
    //
    //     trait_to_impl_substs = {'t => 'j, T => &'i U, Self => Foo}
    //
    // We create a mapping `dummy_substs` that maps from the impl type
    // parameters to fresh types and regions. For type parameters,
    // this is the identity transform, but we could as well use any
N
Niko Matsakis 已提交
123
    // placeholder types. For regions, we convert from bound to free
124 125 126
    // regions (Note: but only early-bound regions, i.e., those
    // declared on the impl or used in type parameter bounds).
    //
B
Bastian Kauschke 已提交
127
    //     impl_to_placeholder_substs = {'i => 'i0, U => U0, N => N0 }
128
    //
B
Bastian Kauschke 已提交
129
    // Now we can apply placeholder_substs to the type of the impl method
N
Niko Matsakis 已提交
130
    // to yield a new function type in terms of our fresh, placeholder
131 132 133 134 135 136 137
    // types:
    //
    //     <'b> fn(t: &'i0 U0, m: &'b) -> Foo
    //
    // We now want to extract and substitute the type of the *trait*
    // method and compare it. To do so, we must create a compound
    // substitution by combining trait_to_impl_substs and
B
Bastian Kauschke 已提交
138
    // impl_to_placeholder_substs, and also adding a mapping for the method
139 140 141
    // type parameters. We extend the mapping to also include
    // the method parameters.
    //
B
Bastian Kauschke 已提交
142
    //     trait_to_placeholder_substs = { T => &'i0 U0, Self => Foo, M => N0 }
143 144 145 146 147 148 149 150 151
    //
    // Applying this to the trait method type yields:
    //
    //     <'a> fn(t: &'i0 U0, m: &'a) -> Foo
    //
    // This type is also the same but the name of the bound region ('a
    // vs 'b).  However, the normal subtyping rules on fn types handle
    // this kind of equivalency just fine.
    //
J
Joseph Crail 已提交
152
    // We now use these substitutions to ensure that all declared bounds are
153 154 155
    // satisfied by the implementation's method.
    //
    // We do this by creating a parameter environment which contains a
B
Bastian Kauschke 已提交
156 157
    // substitution corresponding to impl_to_placeholder_substs. We then build
    // trait_to_placeholder_substs and use it to convert the predicates contained
N
Niko Matsakis 已提交
158
    // in the trait_m.generics to the placeholder form.
159 160 161 162
    //
    // Finally we register each of these predicates as an obligation in
    // a fresh FulfillmentCtxt, and invoke select_all_or_error.

N
Niko Matsakis 已提交
163
    // Create mapping from impl to placeholder.
B
Bastian Kauschke 已提交
164
    let impl_to_placeholder_substs = InternalSubsts::identity_for_item(tcx, impl_m.def_id);
165

N
Niko Matsakis 已提交
166
    // Create mapping from trait to placeholder.
B
Bastian Kauschke 已提交
167 168 169
    let trait_to_placeholder_substs =
        impl_to_placeholder_substs.rebase_onto(tcx, impl_m.container.id(), trait_to_impl_substs);
    debug!("compare_impl_method: trait_to_placeholder_substs={:?}", trait_to_placeholder_substs);
170

171 172 173 174
    let impl_m_generics = tcx.generics_of(impl_m.def_id);
    let trait_m_generics = tcx.generics_of(trait_m.def_id);
    let impl_m_predicates = tcx.predicates_of(impl_m.def_id);
    let trait_m_predicates = tcx.predicates_of(trait_m.def_id);
175

N
Niko Matsakis 已提交
176
    // Check region bounds.
177 178 179 180 181 182 183 184
    check_region_bounds_on_impl_item(
        tcx,
        impl_m_span,
        impl_m,
        trait_m,
        &trait_m_generics,
        &impl_m_generics,
    )?;
N
Niko Matsakis 已提交
185 186 187 188 189 190

    // Create obligations for each predicate declared by the impl
    // definition in the context of the trait's parameter
    // environment. We can't just use `impl_env.caller_bounds`,
    // however, because we want to replace all late-bound regions with
    // region variables.
191
    let impl_predicates = tcx.predicates_of(impl_m_predicates.parent.unwrap());
192
    let mut hybrid_preds = impl_predicates.instantiate_identity(tcx);
N
Niko Matsakis 已提交
193 194 195 196 197 198 199 200 201 202

    debug!("compare_impl_method: impl_bounds={:?}", hybrid_preds);

    // This is the only tricky bit of the new way we check implementation methods
    // We need to build a set of predicates where only the method-level bounds
    // are from the trait and we assume all other bounds from the implementation
    // to be previously satisfied.
    //
    // We then register the obligations from the impl_m and check to see
    // if all constraints hold.
M
Mark Rousskov 已提交
203 204
    hybrid_preds
        .predicates
B
Bastian Kauschke 已提交
205
        .extend(trait_m_predicates.instantiate_own(tcx, trait_to_placeholder_substs).predicates);
N
Niko Matsakis 已提交
206

N
Niko Matsakis 已提交
207
    // Construct trait parameter environment and then shift it into the placeholder viewpoint.
N
Niko Matsakis 已提交
208 209
    // The key step here is to update the caller_bounds's predicates to be
    // the new hybrid bounds we computed.
L
ljedrz 已提交
210
    let normalize_cause = traits::ObligationCause::misc(impl_m_span, impl_m_hir_id);
211 212
    let param_env =
        ty::ParamEnv::new(tcx.intern_predicates(&hybrid_preds.predicates), Reveal::UserFacing);
M
Mark Rousskov 已提交
213 214 215 216 217
    let param_env = traits::normalize_param_env_or_error(
        tcx,
        impl_m.def_id,
        param_env,
        normalize_cause.clone(),
S
scalexm 已提交
218
    );
219

220
    tcx.infer_ctxt().enter(|infcx| {
221
        let inh = Inherited::new(infcx, impl_m.def_id.expect_local());
222
        let infcx = &inh.infcx;
223

M
Mark Rousskov 已提交
224
        debug!("compare_impl_method: caller_bounds={:?}", param_env.caller_bounds());
225 226 227

        let mut selcx = traits::SelectionContext::new(&infcx);

B
Bastian Kauschke 已提交
228
        let impl_m_own_bounds = impl_m_predicates.instantiate_own(tcx, impl_to_placeholder_substs);
Y
Yuki Okushi 已提交
229
        for predicate in impl_m_own_bounds.predicates {
230
            let traits::Normalized { value: predicate, obligations } =
B
Bastian Kauschke 已提交
231
                traits::normalize(&mut selcx, param_env, normalize_cause.clone(), predicate);
232

233
            inh.register_predicates(obligations);
N
Niko Matsakis 已提交
234
            inh.register_predicate(traits::Obligation::new(cause.clone(), param_env, predicate));
235
        }
236

237 238 239 240 241 242 243 244 245 246 247 248 249
        // We now need to check that the signature of the impl method is
        // compatible with that of the trait method. We do this by
        // checking that `impl_fty <: trait_fty`.
        //
        // FIXME. Unfortunately, this doesn't quite work right now because
        // associated type normalization is not integrated into subtype
        // checks. For the comparison to be valid, we need to
        // normalize the associated types in the impl/trait methods
        // first. However, because function types bind regions, just
        // calling `normalize_associated_types_in` would have no effect on
        // any associated types appearing in the fn arguments or return
        // type.

N
Niko Matsakis 已提交
250
        // Compute placeholder form of impl and trait method tys.
251 252
        let tcx = infcx.tcx;

253 254
        let mut wf_tys = vec![];

S
scalexm 已提交
255 256 257
        let (impl_sig, _) = infcx.replace_bound_vars_with_fresh_vars(
            impl_m_span,
            infer::HigherRankedType,
B
Bastian Kauschke 已提交
258
            tcx.fn_sig(impl_m.def_id),
S
scalexm 已提交
259
        );
260
        let impl_sig =
B
Bastian Kauschke 已提交
261
            inh.normalize_associated_types_in(impl_m_span, impl_m_hir_id, param_env, impl_sig);
Y
Yuki Okushi 已提交
262
        let impl_fty = tcx.mk_fn_ptr(ty::Binder::dummy(impl_sig));
263 264
        debug!("compare_impl_method: impl_fty={:?}", impl_fty);

265
        // First liberate late bound regions and subst placeholders
B
Bastian Kauschke 已提交
266
        let trait_sig = tcx.liberate_late_bound_regions(impl_m.def_id, tcx.fn_sig(trait_m.def_id));
B
Bastian Kauschke 已提交
267
        let trait_sig = trait_sig.subst(tcx, trait_to_placeholder_substs);
268 269 270 271
        // Next, add all inputs and output as well-formed tys. Importantly,
        // we have to do this before normalization, since the normalized ty may
        // not contain the input parameters. See issue #87748.
        wf_tys.extend(trait_sig.inputs_and_output.iter());
272
        let trait_sig =
B
Bastian Kauschke 已提交
273
            inh.normalize_associated_types_in(impl_m_span, impl_m_hir_id, param_env, trait_sig);
274 275 276
        // Also add the resulting inputs and output as well-formed.
        // This probably isn't strictly necessary.
        wf_tys.extend(trait_sig.inputs_and_output.iter());
Y
Yuki Okushi 已提交
277
        let trait_fty = tcx.mk_fn_ptr(ty::Binder::dummy(trait_sig));
278 279 280

        debug!("compare_impl_method: trait_fty={:?}", trait_fty);

M
Mark Rousskov 已提交
281 282 283 284 285
        let sub_result = infcx.at(&cause, param_env).sup(trait_fty, impl_fty).map(
            |InferOk { obligations, .. }| {
                inh.register_predicates(obligations);
            },
        );
286 287

        if let Err(terr) = sub_result {
M
Mark Rousskov 已提交
288 289
            debug!("sub_types failed: impl ty {:?}, trait ty {:?}", impl_fty, trait_fty);

290 291
            let (impl_err_span, trait_err_span) =
                extract_spans_for_error_reporting(&infcx, &terr, &cause, impl_m, trait_m);
M
Mark Rousskov 已提交
292

293
            cause.make_mut().span = impl_err_span;
M
Mark Rousskov 已提交
294 295 296 297 298 299 300 301

            let mut diag = struct_span_err!(
                tcx.sess,
                cause.span(tcx),
                E0053,
                "method `{}` has an incompatible type for trait",
                trait_m.ident
            );
302 303 304 305 306 307
            match &terr {
                TypeError::ArgumentMutability(0) | TypeError::ArgumentSorts(_, 0)
                    if trait_m.fn_has_self_parameter =>
                {
                    let ty = trait_sig.inputs()[0];
                    let sugg = match ExplicitSelf::determine(ty, |_| ty == impl_trait_ref.self_ty())
M
Mark Rousskov 已提交
308
                    {
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
                        ExplicitSelf::ByValue => "self".to_owned(),
                        ExplicitSelf::ByReference(_, hir::Mutability::Not) => "&self".to_owned(),
                        ExplicitSelf::ByReference(_, hir::Mutability::Mut) => {
                            "&mut self".to_owned()
                        }
                        _ => format!("self: {}", ty),
                    };

                    // When the `impl` receiver is an arbitrary self type, like `self: Box<Self>`, the
                    // span points only at the type `Box<Self`>, but we want to cover the whole
                    // argument pattern and type.
                    let impl_m_hir_id =
                        tcx.hir().local_def_id_to_hir_id(impl_m.def_id.expect_local());
                    let span = match tcx.hir().expect_impl_item(impl_m_hir_id).kind {
                        ImplItemKind::Fn(ref sig, body) => tcx
                            .hir()
                            .body_param_names(body)
                            .zip(sig.decl.inputs.iter())
                            .map(|(param, ty)| param.span.to(ty.span))
                            .next()
                            .unwrap_or(impl_err_span),
                        _ => bug!("{:?} is not a method", impl_m),
                    };

                    diag.span_suggestion(
                        span,
                        "change the self-receiver type to match the trait",
                        sugg,
                        Applicability::MachineApplicable,
                    );
                }
                TypeError::ArgumentMutability(i) | TypeError::ArgumentSorts(_, i) => {
E
Esteban Küber 已提交
341 342 343 344 345 346 347 348 349
                    if trait_sig.inputs().len() == *i {
                        // Suggestion to change output type. We do not suggest in `async` functions
                        // to avoid complex logic or incorrect output.
                        let impl_m_hir_id =
                            tcx.hir().local_def_id_to_hir_id(impl_m.def_id.expect_local());
                        match tcx.hir().expect_impl_item(impl_m_hir_id).kind {
                            ImplItemKind::Fn(ref sig, _)
                                if sig.header.asyncness == hir::IsAsync::NotAsync =>
                            {
350 351 352
                                let msg = "change the output type to match the trait";
                                let ap = Applicability::MachineApplicable;
                                match sig.decl.output {
E
Esteban Küber 已提交
353
                                    hir::FnRetTy::DefaultReturn(sp) => {
354 355
                                        let sugg = format!("-> {} ", trait_sig.output());
                                        diag.span_suggestion_verbose(sp, msg, sugg, ap);
E
Esteban Küber 已提交
356 357
                                    }
                                    hir::FnRetTy::Return(hir_ty) => {
358 359
                                        let sugg = trait_sig.output().to_string();
                                        diag.span_suggestion(hir_ty.span, msg, sugg, ap);
E
Esteban Küber 已提交
360 361 362 363 364 365
                                    }
                                };
                            }
                            _ => {}
                        };
                    } else if let Some(trait_ty) = trait_sig.inputs().get(*i) {
366
                        diag.span_suggestion(
367
                            impl_err_span,
368 369
                            "change the parameter type to match the trait",
                            trait_ty.to_string(),
370
                            Applicability::MachineApplicable,
371 372 373
                        );
                    }
                }
374
                _ => {}
375
            }
376

M
Mark Rousskov 已提交
377 378 379 380 381 382 383 384 385 386
            infcx.note_type_err(
                &mut diag,
                &cause,
                trait_err_span.map(|sp| (sp, "type in trait".to_owned())),
                Some(infer::ValuePairs::Types(ExpectedFound {
                    expected: trait_fty,
                    found: impl_fty,
                })),
                &terr,
            );
387
            diag.emit();
N
Niko Matsakis 已提交
388
            return Err(ErrorReported);
389 390
        }

391 392
        // Check that all obligations are satisfied by the implementation's
        // version.
393
        if let Err(ref errors) = inh.fulfillment_cx.borrow_mut().select_all_or_error(&infcx) {
394
            infcx.report_fulfillment_errors(errors, None, false);
N
Niko Matsakis 已提交
395
            return Err(ErrorReported);
396
        }
397

398
        // Finally, resolve all regions. This catches wily misuses of
399
        // lifetime parameters.
L
ljedrz 已提交
400
        let fcx = FnCtxt::new(&inh, param_env, impl_m_hir_id);
401
        fcx.regionck_item(impl_m_hir_id, impl_m_span, &wf_tys);
N
Niko Matsakis 已提交
402 403 404 405 406

        Ok(())
    })
}

407
fn check_region_bounds_on_impl_item<'tcx>(
408
    tcx: TyCtxt<'tcx>,
409 410 411 412 413 414
    span: Span,
    impl_m: &ty::AssocItem,
    trait_m: &ty::AssocItem,
    trait_generics: &ty::Generics,
    impl_generics: &ty::Generics,
) -> Result<(), ErrorReported> {
V
varkor 已提交
415 416
    let trait_params = trait_generics.own_counts().lifetimes;
    let impl_params = impl_generics.own_counts().lifetimes;
N
Niko Matsakis 已提交
417

M
Mark Rousskov 已提交
418 419
    debug!(
        "check_region_bounds_on_impl_item: \
N
Niko Matsakis 已提交
420
            trait_generics={:?} \
421
            impl_generics={:?}",
M
Mark Rousskov 已提交
422 423
        trait_generics, impl_generics
    );
N
Niko Matsakis 已提交
424 425 426 427 428 429 430 431 432 433

    // Must have same number of early-bound lifetime parameters.
    // Unfortunately, if the user screws up the bounds, then this
    // will change classification between early and late.  E.g.,
    // if in trait we have `<'a,'b:'a>`, and in impl we just have
    // `<'a,'b>`, then we have 2 early-bound lifetime parameters
    // in trait but 0 in the impl. But if we report "expected 2
    // but found 0" it's confusing, because it looks like there
    // are zero. Since I don't quite know how to phrase things at
    // the moment, give a kind of vague error message.
434
    if trait_params != impl_params {
435
        let item_kind = assoc_item_kind_str(impl_m);
436
        let def_span = tcx.sess.source_map().guess_head_span(span);
437
        let span = tcx.hir().get_generics(impl_m.def_id).map_or(def_span, |g| g.span);
438
        let generics_span = tcx.hir().span_if_local(trait_m.def_id).map(|sp| {
439
            let def_sp = tcx.sess.source_map().guess_head_span(sp);
440 441
            tcx.hir().get_generics(trait_m.def_id).map_or(def_sp, |g| g.span)
        });
442

443
        tcx.sess.emit_err(LifetimesOrBoundsMismatchOnTrait {
444
            span,
445
            item_kind,
446 447 448
            ident: impl_m.ident,
            generics_span,
        });
N
Niko Matsakis 已提交
449 450 451
        return Err(ErrorReported);
    }

452
    Ok(())
N
Niko Matsakis 已提交
453 454
}

455 456 457 458 459 460 461
fn extract_spans_for_error_reporting<'a, 'tcx>(
    infcx: &infer::InferCtxt<'a, 'tcx>,
    terr: &TypeError<'_>,
    cause: &ObligationCause<'tcx>,
    impl_m: &ty::AssocItem,
    trait_m: &ty::AssocItem,
) -> (Span, Option<Span>) {
N
Niko Matsakis 已提交
462
    let tcx = infcx.tcx;
463
    let impl_m_hir_id = tcx.hir().local_def_id_to_hir_id(impl_m.def_id.expect_local());
464 465 466
    let mut impl_args = match tcx.hir().expect_impl_item(impl_m_hir_id).kind {
        ImplItemKind::Fn(ref sig, _) => {
            sig.decl.inputs.iter().map(|t| t.span).chain(iter::once(sig.decl.output.span()))
N
Niko Matsakis 已提交
467 468 469
        }
        _ => bug!("{:?} is not a method", impl_m),
    };
470 471 472 473 474 475 476 477 478
    let trait_args = trait_m.def_id.as_local().map(|def_id| {
        let trait_m_hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
        match tcx.hir().expect_trait_item(trait_m_hir_id).kind {
            TraitItemKind::Fn(ref sig, _) => {
                sig.decl.inputs.iter().map(|t| t.span).chain(iter::once(sig.decl.output.span()))
            }
            _ => bug!("{:?} is not a TraitItemKind::Fn", trait_m),
        }
    });
N
Niko Matsakis 已提交
479 480

    match *terr {
481 482
        TypeError::ArgumentMutability(i) => {
            (impl_args.nth(i).unwrap(), trait_args.and_then(|mut args| args.nth(i)))
483
        }
484 485
        TypeError::ArgumentSorts(ExpectedFound { .. }, i) => {
            (impl_args.nth(i).unwrap(), trait_args.and_then(|mut args| args.nth(i)))
N
Niko Matsakis 已提交
486
        }
F
flip1995 已提交
487
        _ => (cause.span(tcx), tcx.hir().span_if_local(trait_m.def_id)),
488
    }
N
Niko Matsakis 已提交
489
}
490

491
fn compare_self_type<'tcx>(
492
    tcx: TyCtxt<'tcx>,
493 494 495 496 497
    impl_m: &ty::AssocItem,
    impl_m_span: Span,
    trait_m: &ty::AssocItem,
    impl_trait_ref: ty::TraitRef<'tcx>,
) -> Result<(), ErrorReported> {
N
Niko Matsakis 已提交
498 499 500 501 502 503 504
    // Try to give more informative error messages about self typing
    // mismatches.  Note that any mismatch will also be detected
    // below, where we construct a canonical function type that
    // includes the self parameter as a normal parameter.  It's just
    // that the error messages you get out of this code are a bit more
    // inscrutable, particularly for cases where one method has no
    // self.
505

A
Andrew Xu 已提交
506
    let self_string = |method: &ty::AssocItem| {
507 508
        let untransformed_self_ty = match method.container {
            ty::ImplContainer(_) => impl_trait_ref.self_ty(),
M
Mark Rousskov 已提交
509
            ty::TraitContainer(_) => tcx.types.self_param,
510
        };
J
Jack Huey 已提交
511
        let self_arg_ty = tcx.fn_sig(method.def_id).input(0);
512
        let param_env = ty::ParamEnv::reveal_all();
513

514
        tcx.infer_ctxt().enter(|infcx| {
J
Jack Huey 已提交
515
            let self_arg_ty = tcx.liberate_late_bound_regions(method.def_id, self_arg_ty);
516 517
            let can_eq_self = |ty| infcx.can_eq(param_env, untransformed_self_ty, ty).is_ok();
            match ExplicitSelf::determine(self_arg_ty, can_eq_self) {
518
                ExplicitSelf::ByValue => "self".to_owned(),
519 520
                ExplicitSelf::ByReference(_, hir::Mutability::Not) => "&self".to_owned(),
                ExplicitSelf::ByReference(_, hir::Mutability::Mut) => "&mut self".to_owned(),
M
Mark Rousskov 已提交
521
                _ => format!("self: {}", self_arg_ty),
522 523
            }
        })
524 525
    };

526
    match (trait_m.fn_has_self_parameter, impl_m.fn_has_self_parameter) {
527 528 529 530
        (false, false) | (true, true) => {}

        (false, true) => {
            let self_descr = self_string(impl_m);
M
Mark Rousskov 已提交
531 532 533 534
            let mut err = struct_span_err!(
                tcx.sess,
                impl_m_span,
                E0185,
535
                "method `{}` has a `{}` declaration in the impl, but not in the trait",
M
Mark Rousskov 已提交
536 537 538
                trait_m.ident,
                self_descr
            );
539
            err.span_label(impl_m_span, format!("`{}` used in impl", self_descr));
540
            if let Some(span) = tcx.hir().span_if_local(trait_m.def_id) {
E
Esteban Küber 已提交
541 542
                err.span_label(span, format!("trait method declared without `{}`", self_descr));
            } else {
M
Mark Rousskov 已提交
543
                err.note_trait_signature(trait_m.ident.to_string(), trait_m.signature(tcx));
N
Niko Matsakis 已提交
544 545 546 547
            }
            err.emit();
            return Err(ErrorReported);
        }
548 549 550

        (true, false) => {
            let self_descr = self_string(trait_m);
M
Mark Rousskov 已提交
551 552 553 554
            let mut err = struct_span_err!(
                tcx.sess,
                impl_m_span,
                E0186,
555
                "method `{}` has a `{}` declaration in the trait, but not in the impl",
M
Mark Rousskov 已提交
556 557 558
                trait_m.ident,
                self_descr
            );
E
Esteban Küber 已提交
559
            err.span_label(impl_m_span, format!("expected `{}` in impl", self_descr));
560
            if let Some(span) = tcx.hir().span_if_local(trait_m.def_id) {
561
                err.span_label(span, format!("`{}` used in trait", self_descr));
562
            } else {
M
Mark Rousskov 已提交
563
                err.note_trait_signature(trait_m.ident.to_string(), trait_m.signature(tcx));
N
Niko Matsakis 已提交
564 565 566 567 568 569 570 571 572
            }
            err.emit();
            return Err(ErrorReported);
        }
    }

    Ok(())
}

573
fn compare_number_of_generics<'tcx>(
574
    tcx: TyCtxt<'tcx>,
A
Andrew Xu 已提交
575
    impl_: &ty::AssocItem,
576
    _impl_span: Span,
A
Andrew Xu 已提交
577
    trait_: &ty::AssocItem,
V
varkor 已提交
578 579 580 581 582 583 584 585 586 587
    trait_span: Option<Span>,
) -> Result<(), ErrorReported> {
    let trait_own_counts = tcx.generics_of(trait_.def_id).own_counts();
    let impl_own_counts = tcx.generics_of(impl_.def_id).own_counts();

    let matchings = [
        ("type", trait_own_counts.types, impl_own_counts.types),
        ("const", trait_own_counts.consts, impl_own_counts.consts),
    ];

588 589
    let item_kind = assoc_item_kind_str(impl_);

V
varkor 已提交
590
    let mut err_occurred = false;
591
    for (kind, trait_count, impl_count) in matchings {
V
varkor 已提交
592 593 594
        if impl_count != trait_count {
            err_occurred = true;

M
marmeladema 已提交
595
            let (trait_spans, impl_trait_spans) = if let Some(def_id) = trait_.def_id.as_local() {
596
                let trait_hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
597 598 599
                let trait_item = tcx.hir().expect_trait_item(trait_hir_id);
                if trait_item.generics.params.is_empty() {
                    (Some(vec![trait_item.generics.span]), vec![])
600
                } else {
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
                    let arg_spans: Vec<Span> =
                        trait_item.generics.params.iter().map(|p| p.span).collect();
                    let impl_trait_spans: Vec<Span> = trait_item
                        .generics
                        .params
                        .iter()
                        .filter_map(|p| match p.kind {
                            GenericParamKind::Type {
                                synthetic: Some(hir::SyntheticTyParamKind::ImplTrait),
                                ..
                            } => Some(p.span),
                            _ => None,
                        })
                        .collect();
                    (Some(arg_spans), impl_trait_spans)
                }
            } else {
                (trait_span.map(|s| vec![s]), vec![])
            };
620

621
            let impl_hir_id = tcx.hir().local_def_id_to_hir_id(impl_.def_id.expect_local());
622
            let impl_item = tcx.hir().expect_impl_item(impl_hir_id);
M
Mark Rousskov 已提交
623 624 625 626
            let impl_item_impl_trait_spans: Vec<Span> = impl_item
                .generics
                .params
                .iter()
627 628
                .filter_map(|p| match p.kind {
                    GenericParamKind::Type {
M
Mark Rousskov 已提交
629 630
                        synthetic: Some(hir::SyntheticTyParamKind::ImplTrait),
                        ..
631 632
                    } => Some(p.span),
                    _ => None,
M
Mark Rousskov 已提交
633 634
                })
                .collect();
635 636 637
            let spans = impl_item.generics.spans();
            let span = spans.primary_span();

V
varkor 已提交
638
            let mut err = tcx.sess.struct_span_err_with_code(
639
                spans,
V
varkor 已提交
640
                &format!(
641
                    "{} `{}` has {} {kind} parameter{} but its trait \
V
varkor 已提交
642
                     declaration has {} {kind} parameter{}",
643
                    item_kind,
V
varkor 已提交
644 645
                    trait_.ident,
                    impl_count,
646
                    pluralize!(impl_count),
V
varkor 已提交
647
                    trait_count,
648
                    pluralize!(trait_count),
V
varkor 已提交
649 650 651 652
                    kind = kind,
                ),
                DiagnosticId::Error("E0049".into()),
            );
653

V
varkor 已提交
654
            let mut suffix = None;
N
Niko Matsakis 已提交
655

656 657 658
            if let Some(spans) = trait_spans {
                let mut spans = spans.iter();
                if let Some(span) = spans.next() {
M
Mark Rousskov 已提交
659 660 661 662 663 664 665 666 667
                    err.span_label(
                        *span,
                        format!(
                            "expected {} {} parameter{}",
                            trait_count,
                            kind,
                            pluralize!(trait_count),
                        ),
                    );
668 669 670 671
                }
                for span in spans {
                    err.span_label(*span, "");
                }
V
varkor 已提交
672 673 674
            } else {
                suffix = Some(format!(", expected {}", trait_count));
            }
N
Niko Matsakis 已提交
675

676
            if let Some(span) = span {
M
Mark Rousskov 已提交
677 678 679 680 681 682 683
                err.span_label(
                    span,
                    format!(
                        "found {} {} parameter{}{}",
                        impl_count,
                        kind,
                        pluralize!(impl_count),
684
                        suffix.unwrap_or_else(String::new),
M
Mark Rousskov 已提交
685 686
                    ),
                );
687
            }
N
Niko Matsakis 已提交
688

689 690 691 692
            for span in impl_trait_spans.iter().chain(impl_item_impl_trait_spans.iter()) {
                err.span_label(*span, "`impl Trait` introduces an implicit type parameter");
            }

V
varkor 已提交
693 694
            err.emit();
        }
N
Niko Matsakis 已提交
695 696
    }

M
Mark Rousskov 已提交
697
    if err_occurred { Err(ErrorReported) } else { Ok(()) }
N
Niko Matsakis 已提交
698 699
}

700
fn compare_number_of_method_arguments<'tcx>(
701
    tcx: TyCtxt<'tcx>,
702 703 704 705 706
    impl_m: &ty::AssocItem,
    impl_m_span: Span,
    trait_m: &ty::AssocItem,
    trait_item_span: Option<Span>,
) -> Result<(), ErrorReported> {
707 708
    let impl_m_fty = tcx.fn_sig(impl_m.def_id);
    let trait_m_fty = tcx.fn_sig(trait_m.def_id);
709 710
    let trait_number_args = trait_m_fty.inputs().skip_binder().len();
    let impl_number_args = impl_m_fty.inputs().skip_binder().len();
711
    if trait_number_args != impl_number_args {
712
        let trait_span = if let Some(def_id) = trait_m.def_id.as_local() {
713
            let trait_id = tcx.hir().local_def_id_to_hir_id(def_id);
714
            match tcx.hir().expect_trait_item(trait_id).kind {
M
Mark Mansi 已提交
715
                TraitItemKind::Fn(ref trait_m_sig, _) => {
M
Mark Rousskov 已提交
716
                    let pos = if trait_number_args > 0 { trait_number_args - 1 } else { 0 };
717 718 719 720
                    if let Some(arg) = trait_m_sig.decl.inputs.get(pos) {
                        Some(if pos == 0 {
                            arg.span
                        } else {
721
                            arg.span.with_lo(trait_m_sig.decl.inputs[0].span.lo())
722
                        })
N
Niko Matsakis 已提交
723 724 725
                    } else {
                        trait_item_span
                    }
726
                }
N
Niko Matsakis 已提交
727
                _ => bug!("{:?} is not a method", impl_m),
728
            }
N
Niko Matsakis 已提交
729 730 731
        } else {
            trait_item_span
        };
732
        let impl_m_hir_id = tcx.hir().local_def_id_to_hir_id(impl_m.def_id.expect_local());
733
        let impl_span = match tcx.hir().expect_impl_item(impl_m_hir_id).kind {
M
Mark Mansi 已提交
734
            ImplItemKind::Fn(ref impl_m_sig, _) => {
M
Mark Rousskov 已提交
735
                let pos = if impl_number_args > 0 { impl_number_args - 1 } else { 0 };
736 737 738 739
                if let Some(arg) = impl_m_sig.decl.inputs.get(pos) {
                    if pos == 0 {
                        arg.span
                    } else {
740
                        arg.span.with_lo(impl_m_sig.decl.inputs[0].span.lo())
741
                    }
N
Niko Matsakis 已提交
742 743
                } else {
                    impl_m_span
744 745
                }
            }
N
Niko Matsakis 已提交
746 747
            _ => bug!("{:?} is not a method", impl_m),
        };
M
Mark Rousskov 已提交
748 749 750 751 752
        let mut err = struct_span_err!(
            tcx.sess,
            impl_span,
            E0050,
            "method `{}` has {} but the declaration in \
N
Niko Matsakis 已提交
753
                                        trait `{}` has {}",
M
Mark Rousskov 已提交
754 755 756 757 758
            trait_m.ident,
            potentially_plural_count(impl_number_args, "parameter"),
            tcx.def_path_str(trait_m.def_id),
            trait_number_args
        );
N
Niko Matsakis 已提交
759
        if let Some(trait_span) = trait_span {
M
Mark Rousskov 已提交
760 761 762 763 764 765 766
            err.span_label(
                trait_span,
                format!(
                    "trait requires {}",
                    potentially_plural_count(trait_number_args, "parameter")
                ),
            );
767
        } else {
M
Mark Rousskov 已提交
768
            err.note_trait_signature(trait_m.ident.to_string(), trait_m.signature(tcx));
769
        }
M
Mark Rousskov 已提交
770 771 772 773 774 775 776 777
        err.span_label(
            impl_span,
            format!(
                "expected {}, found {}",
                potentially_plural_count(trait_number_args, "parameter"),
                impl_number_args
            ),
        );
N
Niko Matsakis 已提交
778 779
        err.emit();
        return Err(ErrorReported);
780
    }
N
Niko Matsakis 已提交
781 782

    Ok(())
783
}
784

785
fn compare_synthetic_generics<'tcx>(
786
    tcx: TyCtxt<'tcx>,
787 788 789
    impl_m: &ty::AssocItem,
    trait_m: &ty::AssocItem,
) -> Result<(), ErrorReported> {
790
    // FIXME(chrisvittal) Clean up this function, list of FIXME items:
791
    //     1. Better messages for the span labels
792 793 794 795 796 797
    //     2. Explanation as to what is going on
    // If we get here, we already have the same number of generics, so the zip will
    // be okay.
    let mut error_found = false;
    let impl_m_generics = tcx.generics_of(impl_m.def_id);
    let trait_m_generics = tcx.generics_of(trait_m.def_id);
798 799
    let impl_m_type_params = impl_m_generics.params.iter().filter_map(|param| match param.kind {
        GenericParamDefKind::Type { synthetic, .. } => Some((param.def_id, synthetic)),
800
        GenericParamDefKind::Lifetime | GenericParamDefKind::Const { .. } => None,
V
varkor 已提交
801
    });
M
Mark Rousskov 已提交
802 803
    let trait_m_type_params = trait_m_generics.params.iter().filter_map(|param| match param.kind {
        GenericParamDefKind::Type { synthetic, .. } => Some((param.def_id, synthetic)),
804
        GenericParamDefKind::Lifetime | GenericParamDefKind::Const { .. } => None,
V
varkor 已提交
805
    });
M
Mark Rousskov 已提交
806
    for ((impl_def_id, impl_synthetic), (trait_def_id, trait_synthetic)) in
J
Josh Stone 已提交
807
        iter::zip(impl_m_type_params, trait_m_type_params)
808
    {
V
varkor 已提交
809
        if impl_synthetic != trait_synthetic {
810
            let impl_hir_id = tcx.hir().local_def_id_to_hir_id(impl_def_id.expect_local());
811
            let impl_span = tcx.hir().span(impl_hir_id);
V
varkor 已提交
812
            let trait_span = tcx.def_span(trait_def_id);
M
Mark Rousskov 已提交
813 814 815 816 817 818 819
            let mut err = struct_span_err!(
                tcx.sess,
                impl_span,
                E0643,
                "method `{}` has incompatible signature for trait",
                trait_m.ident
            );
820 821 822 823 824 825 826 827 828 829
            err.span_label(trait_span, "declaration in trait here");
            match (impl_synthetic, trait_synthetic) {
                // The case where the impl method uses `impl Trait` but the trait method uses
                // explicit generics
                (Some(hir::SyntheticTyParamKind::ImplTrait), None) => {
                    err.span_label(impl_span, "expected generic parameter, found `impl Trait`");
                    (|| {
                        // try taking the name from the trait impl
                        // FIXME: this is obviously suboptimal since the name can already be used
                        // as another generic argument
M
Mark Rousskov 已提交
830
                        let new_name = tcx.sess.source_map().span_to_snippet(trait_span).ok()?;
831 832
                        let trait_m = trait_m.def_id.as_local()?;
                        let trait_m = tcx.hir().trait_item(hir::TraitItemId { def_id: trait_m });
833

834 835
                        let impl_m = impl_m.def_id.as_local()?;
                        let impl_m = tcx.hir().impl_item(hir::ImplItemId { def_id: impl_m });
836 837 838

                        // in case there are no generics, take the spot between the function name
                        // and the opening paren of the argument list
M
Mark Rousskov 已提交
839 840
                        let new_generics_span =
                            tcx.sess.source_map().generate_fn_name_span(impl_span)?.shrink_to_hi();
841
                        // in case there are generics, just replace them
M
Mark Rousskov 已提交
842 843
                        let generics_span =
                            impl_m.generics.span.substitute_dummy(new_generics_span);
844
                        // replace with the generics from the trait
M
Mark Rousskov 已提交
845 846
                        let new_generics =
                            tcx.sess.source_map().span_to_snippet(trait_m.generics.span).ok()?;
847

848
                        err.multipart_suggestion(
849 850 851 852 853 854 855 856 857
                            "try changing the `impl Trait` argument to a generic parameter",
                            vec![
                                // replace `impl Trait` with `T`
                                (impl_span, new_name),
                                // replace impl method generics with trait method generics
                                // This isn't quite right, as users might have changed the names
                                // of the generics, but it works for the common case
                                (generics_span, new_generics),
                            ],
858
                            Applicability::MaybeIncorrect,
859 860 861
                        );
                        Some(())
                    })();
M
Mark Rousskov 已提交
862
                }
863 864 865 866 867
                // The case where the trait method uses `impl Trait`, but the impl method uses
                // explicit generics.
                (None, Some(hir::SyntheticTyParamKind::ImplTrait)) => {
                    err.span_label(impl_span, "expected `impl Trait`, found generic parameter");
                    (|| {
868 869
                        let impl_m = impl_m.def_id.as_local()?;
                        let impl_m = tcx.hir().impl_item(hir::ImplItemId { def_id: impl_m });
870
                        let input_tys = match impl_m.kind {
M
Mark Mansi 已提交
871
                            hir::ImplItemKind::Fn(ref sig, _) => sig.decl.inputs,
872 873 874
                            _ => unreachable!(),
                        };
                        struct Visitor(Option<Span>, hir::def_id::DefId);
875
                        impl<'v> intravisit::Visitor<'v> for Visitor {
C
Camille GILLOT 已提交
876
                            fn visit_ty(&mut self, ty: &'v hir::Ty<'v>) {
877
                                intravisit::walk_ty(self, ty);
M
Mark Rousskov 已提交
878 879
                                if let hir::TyKind::Path(hir::QPath::Resolved(None, ref path)) =
                                    ty.kind
880
                                {
881
                                    if let Res::Def(DefKind::TyParam, def_id) = path.res {
882 883
                                        if def_id == self.1 {
                                            self.0 = Some(ty.span);
884
                                        }
885
                                    }
886 887
                                }
                            }
888
                            type Map = intravisit::ErasedMap<'v>;
889 890
                            fn nested_visit_map(
                                &mut self,
891
                            ) -> intravisit::NestedVisitorMap<Self::Map>
M
Mark Rousskov 已提交
892
                            {
893
                                intravisit::NestedVisitorMap::None
894 895 896 897
                            }
                        }
                        let mut visitor = Visitor(None, impl_def_id);
                        for ty in input_tys {
898
                            intravisit::Visitor::visit_ty(&mut visitor, ty);
899 900 901
                        }
                        let span = visitor.0?;

M
Mark Rousskov 已提交
902 903
                        let bounds =
                            impl_m.generics.params.iter().find_map(|param| match param.kind {
V
varkor 已提交
904
                                GenericParamKind::Lifetime { .. } => None,
M
Mark Rousskov 已提交
905
                                GenericParamKind::Type { .. } | GenericParamKind::Const { .. } => {
V
varkor 已提交
906
                                    if param.hir_id == impl_hir_id {
V
varkor 已提交
907
                                        Some(&param.bounds)
908 909 910
                                    } else {
                                        None
                                    }
V
varkor 已提交
911
                                }
M
Mark Rousskov 已提交
912
                            })?;
V
varkor 已提交
913
                        let bounds = bounds.first()?.span().to(bounds.last()?.span());
M
Mark Rousskov 已提交
914
                        let bounds = tcx.sess.source_map().span_to_snippet(bounds).ok()?;
915

916
                        err.multipart_suggestion(
917 918 919 920 921 922 923
                            "try removing the generic parameter and using `impl Trait` instead",
                            vec![
                                // delete generic parameters
                                (impl_m.generics.span, String::new()),
                                // replace param usage with `impl Trait`
                                (span, format!("impl {}", bounds)),
                            ],
924
                            Applicability::MaybeIncorrect,
925 926 927
                        );
                        Some(())
                    })();
M
Mark Rousskov 已提交
928
                }
929 930
                _ => unreachable!(),
            }
931 932 933 934
            err.emit();
            error_found = true;
        }
    }
M
Mark Rousskov 已提交
935
    if error_found { Err(ErrorReported) } else { Ok(()) }
936 937
}

938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999
fn compare_const_param_types<'tcx>(
    tcx: TyCtxt<'tcx>,
    impl_m: &ty::AssocItem,
    trait_m: &ty::AssocItem,
    trait_item_span: Option<Span>,
) -> Result<(), ErrorReported> {
    let const_params_of = |def_id| {
        tcx.generics_of(def_id).params.iter().filter_map(|param| match param.kind {
            GenericParamDefKind::Const { .. } => Some(param.def_id),
            _ => None,
        })
    };
    let const_params_impl = const_params_of(impl_m.def_id);
    let const_params_trait = const_params_of(trait_m.def_id);

    for (const_param_impl, const_param_trait) in iter::zip(const_params_impl, const_params_trait) {
        let impl_ty = tcx.type_of(const_param_impl);
        let trait_ty = tcx.type_of(const_param_trait);
        if impl_ty != trait_ty {
            let (impl_span, impl_ident) = match tcx.hir().get_if_local(const_param_impl) {
                Some(hir::Node::GenericParam(hir::GenericParam { span, name, .. })) => (
                    span,
                    match name {
                        hir::ParamName::Plain(ident) => Some(ident),
                        _ => None,
                    },
                ),
                other => bug!(
                    "expected GenericParam, found {:?}",
                    other.map_or_else(|| "nothing".to_string(), |n| format!("{:?}", n))
                ),
            };
            let trait_span = match tcx.hir().get_if_local(const_param_trait) {
                Some(hir::Node::GenericParam(hir::GenericParam { span, .. })) => Some(span),
                _ => None,
            };
            let mut err = struct_span_err!(
                tcx.sess,
                *impl_span,
                E0053,
                "method `{}` has an incompatible const parameter type for trait",
                trait_m.ident
            );
            err.span_note(
                trait_span.map_or_else(|| trait_item_span.unwrap_or(*impl_span), |span| *span),
                &format!(
                    "the const parameter{} has type `{}`, but the declaration \
                              in trait `{}` has type `{}`",
                    &impl_ident.map_or_else(|| "".to_string(), |ident| format!(" `{}`", ident)),
                    impl_ty,
                    tcx.def_path_str(trait_m.def_id),
                    trait_ty
                ),
            );
            err.emit();
            return Err(ErrorReported);
        }
    }

    Ok(())
}

1000
crate fn compare_const_impl<'tcx>(
1001
    tcx: TyCtxt<'tcx>,
1002 1003 1004 1005 1006
    impl_c: &ty::AssocItem,
    impl_c_span: Span,
    trait_c: &ty::AssocItem,
    impl_trait_ref: ty::TraitRef<'tcx>,
) {
1007
    debug!("compare_const_impl(impl_trait_ref={:?})", impl_trait_ref);
1008

1009
    tcx.infer_ctxt().enter(|infcx| {
K
kyren 已提交
1010
        let param_env = tcx.param_env(impl_c.def_id);
1011
        let inh = Inherited::new(infcx, impl_c.def_id.expect_local());
1012
        let infcx = &inh.infcx;
1013 1014 1015 1016 1017 1018

        // The below is for the most part highly similar to the procedure
        // for methods above. It is simpler in many respects, especially
        // because we shouldn't really have to deal with lifetimes or
        // predicates. In fact some of this should probably be put into
        // shared functions because of DRY violations...
1019
        let trait_to_impl_substs = impl_trait_ref.substs;
1020 1021 1022

        // Create a parameter environment that represents the implementation's
        // method.
1023
        let impl_c_hir_id = tcx.hir().local_def_id_to_hir_id(impl_c.def_id.expect_local());
1024

N
Niko Matsakis 已提交
1025
        // Compute placeholder form of impl and trait const tys.
1026 1027
        let impl_ty = tcx.type_of(impl_c.def_id);
        let trait_ty = tcx.type_of(trait_c.def_id).subst(tcx, trait_to_impl_substs);
1028 1029 1030 1031 1032
        let mut cause = ObligationCause::new(
            impl_c_span,
            impl_c_hir_id,
            ObligationCauseCode::CompareImplConstObligation,
        );
1033

1034
        // There is no "body" here, so just pass dummy id.
M
Mark Rousskov 已提交
1035
        let impl_ty =
B
Bastian Kauschke 已提交
1036
            inh.normalize_associated_types_in(impl_c_span, impl_c_hir_id, param_env, impl_ty);
1037

1038
        debug!("compare_const_impl: impl_ty={:?}", impl_ty);
1039

M
Mark Rousskov 已提交
1040
        let trait_ty =
B
Bastian Kauschke 已提交
1041
            inh.normalize_associated_types_in(impl_c_span, impl_c_hir_id, param_env, trait_ty);
1042

1043
        debug!("compare_const_impl: trait_ty={:?}", trait_ty);
1044

M
Mark Rousskov 已提交
1045 1046 1047 1048
        let err = infcx
            .at(&cause, param_env)
            .sup(trait_ty, impl_ty)
            .map(|ok| inh.register_infer_ok_obligations(ok));
1049

1050
        if let Err(terr) = err {
M
Mark Rousskov 已提交
1051 1052 1053 1054
            debug!(
                "checking associated const for compatibility: impl ty {:?}, trait ty {:?}",
                impl_ty, trait_ty
            );
T
trixnz 已提交
1055 1056

            // Locate the Span containing just the type of the offending impl
1057
            match tcx.hir().expect_impl_item(impl_c_hir_id).kind {
1058
                ImplItemKind::Const(ref ty, _) => cause.make_mut().span = ty.span,
1059
                _ => bug!("{:?} is not a impl const", impl_c),
T
trixnz 已提交
1060 1061
            }

M
Mark Rousskov 已提交
1062 1063 1064 1065
            let mut diag = struct_span_err!(
                tcx.sess,
                cause.span,
                E0326,
1066
                "implemented const `{}` has an incompatible type for trait",
M
Mark Rousskov 已提交
1067 1068
                trait_c.ident
            );
T
trixnz 已提交
1069

1070
            let trait_c_hir_id =
1071
                trait_c.def_id.as_local().map(|def_id| tcx.hir().local_def_id_to_hir_id(def_id));
1072
            let trait_c_span = trait_c_hir_id.map(|trait_c_hir_id| {
1073
                // Add a label to the Span containing just the type of the const
1074
                match tcx.hir().expect_trait_item(trait_c_hir_id).kind {
1075 1076 1077 1078
                    TraitItemKind::Const(ref ty, _) => ty.span,
                    _ => bug!("{:?} is not a trait const", trait_c),
                }
            });
T
trixnz 已提交
1079

M
Mark Rousskov 已提交
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
            infcx.note_type_err(
                &mut diag,
                &cause,
                trait_c_span.map(|span| (span, "type in trait".to_owned())),
                Some(infer::ValuePairs::Types(ExpectedFound {
                    expected: trait_ty,
                    found: impl_ty,
                })),
                &terr,
            );
1090
            diag.emit();
1091
        }
1092

1093 1094 1095
        // Check that all obligations are satisfied by the implementation's
        // version.
        if let Err(ref errors) = inh.fulfillment_cx.borrow_mut().select_all_or_error(&infcx) {
1096
            infcx.report_fulfillment_errors(errors, None, false);
1097 1098 1099
            return;
        }

L
ljedrz 已提交
1100 1101
        let fcx = FnCtxt::new(&inh, param_env, impl_c_hir_id);
        fcx.regionck_item(impl_c_hir_id, impl_c_span, &[]);
1102
    });
1103
}
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117

crate fn compare_ty_impl<'tcx>(
    tcx: TyCtxt<'tcx>,
    impl_ty: &ty::AssocItem,
    impl_ty_span: Span,
    trait_ty: &ty::AssocItem,
    impl_trait_ref: ty::TraitRef<'tcx>,
    trait_item_span: Option<Span>,
) {
    debug!("compare_impl_type(impl_trait_ref={:?})", impl_trait_ref);

    let _: Result<(), ErrorReported> = (|| {
        compare_number_of_generics(tcx, impl_ty, impl_ty_span, trait_ty, trait_item_span)?;

1118 1119
        compare_type_predicate_entailment(tcx, impl_ty, impl_ty_span, trait_ty, impl_trait_ref)?;

1120
        check_type_bounds(tcx, trait_ty, impl_ty, impl_ty_span, impl_trait_ref)
1121 1122 1123 1124 1125
    })();
}

/// The equivalent of [compare_predicate_entailment], but for associated types
/// instead of associated functions.
1126
fn compare_type_predicate_entailment<'tcx>(
1127 1128 1129 1130 1131 1132 1133
    tcx: TyCtxt<'tcx>,
    impl_ty: &ty::AssocItem,
    impl_ty_span: Span,
    trait_ty: &ty::AssocItem,
    impl_trait_ref: ty::TraitRef<'tcx>,
) -> Result<(), ErrorReported> {
    let impl_substs = InternalSubsts::identity_for_item(tcx, impl_ty.def_id);
M
Mark Rousskov 已提交
1134 1135
    let trait_to_impl_substs =
        impl_substs.rebase_onto(tcx, impl_ty.container.id(), impl_trait_ref.substs);
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160

    let impl_ty_generics = tcx.generics_of(impl_ty.def_id);
    let trait_ty_generics = tcx.generics_of(trait_ty.def_id);
    let impl_ty_predicates = tcx.predicates_of(impl_ty.def_id);
    let trait_ty_predicates = tcx.predicates_of(trait_ty.def_id);

    check_region_bounds_on_impl_item(
        tcx,
        impl_ty_span,
        impl_ty,
        trait_ty,
        &trait_ty_generics,
        &impl_ty_generics,
    )?;

    let impl_ty_own_bounds = impl_ty_predicates.instantiate_own(tcx, impl_substs);

    if impl_ty_own_bounds.is_empty() {
        // Nothing to check.
        return Ok(());
    }

    // This `HirId` should be used for the `body_id` field on each
    // `ObligationCause` (and the `FnCtxt`). This is what
    // `regionck_item` expects.
1161
    let impl_ty_hir_id = tcx.hir().local_def_id_to_hir_id(impl_ty.def_id.expect_local());
1162 1163 1164 1165
    let cause = ObligationCause::new(
        impl_ty_span,
        impl_ty_hir_id,
        ObligationCauseCode::CompareImplTypeObligation {
1166 1167 1168 1169
            item_name: impl_ty.ident.name,
            impl_item_def_id: impl_ty.def_id,
            trait_item_def_id: trait_ty.def_id,
        },
1170
    );
1171 1172 1173 1174 1175 1176 1177

    debug!("compare_type_predicate_entailment: trait_to_impl_substs={:?}", trait_to_impl_substs);

    // The predicates declared by the impl definition, the trait and the
    // associated type in the trait are assumed.
    let impl_predicates = tcx.predicates_of(impl_ty_predicates.parent.unwrap());
    let mut hybrid_preds = impl_predicates.instantiate_identity(tcx);
M
Mark Rousskov 已提交
1178 1179 1180
    hybrid_preds
        .predicates
        .extend(trait_ty_predicates.instantiate_own(tcx, trait_to_impl_substs).predicates);
1181 1182 1183 1184

    debug!("compare_type_predicate_entailment: bounds={:?}", hybrid_preds);

    let normalize_cause = traits::ObligationCause::misc(impl_ty_span, impl_ty_hir_id);
1185 1186
    let param_env =
        ty::ParamEnv::new(tcx.intern_predicates(&hybrid_preds.predicates), Reveal::UserFacing);
M
Mark Rousskov 已提交
1187 1188 1189 1190 1191
    let param_env = traits::normalize_param_env_or_error(
        tcx,
        impl_ty.def_id,
        param_env,
        normalize_cause.clone(),
1192 1193
    );
    tcx.infer_ctxt().enter(|infcx| {
1194
        let inh = Inherited::new(infcx, impl_ty.def_id.expect_local());
1195 1196
        let infcx = &inh.infcx;

M
Mark Rousskov 已提交
1197
        debug!("compare_type_predicate_entailment: caller_bounds={:?}", param_env.caller_bounds());
1198 1199 1200 1201 1202

        let mut selcx = traits::SelectionContext::new(&infcx);

        for predicate in impl_ty_own_bounds.predicates {
            let traits::Normalized { value: predicate, obligations } =
B
Bastian Kauschke 已提交
1203
                traits::normalize(&mut selcx, param_env, normalize_cause.clone(), predicate);
1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224

            inh.register_predicates(obligations);
            inh.register_predicate(traits::Obligation::new(cause.clone(), param_env, predicate));
        }

        // Check that all obligations are satisfied by the implementation's
        // version.
        if let Err(ref errors) = inh.fulfillment_cx.borrow_mut().select_all_or_error(&infcx) {
            infcx.report_fulfillment_errors(errors, None, false);
            return Err(ErrorReported);
        }

        // Finally, resolve all regions. This catches wily misuses of
        // lifetime parameters.
        let fcx = FnCtxt::new(&inh, param_env, impl_ty_hir_id);
        fcx.regionck_item(impl_ty_hir_id, impl_ty_span, &[]);

        Ok(())
    })
}

1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
/// Validate that `ProjectionCandidate`s created for this associated type will
/// be valid.
///
/// Usually given
///
/// trait X { type Y: Copy } impl X for T { type Y = S; }
///
/// We are able to normalize `<T as X>::U` to `S`, and so when we check the
/// impl is well-formed we have to prove `S: Copy`.
///
/// For default associated types the normalization is not possible (the value
/// from the impl could be overridden). We also can't normalize generic
/// associated types (yet) because they contain bound parameters.
1238
#[tracing::instrument(level = "debug", skip(tcx))]
1239
pub fn check_type_bounds<'tcx>(
1240 1241 1242 1243 1244 1245
    tcx: TyCtxt<'tcx>,
    trait_ty: &ty::AssocItem,
    impl_ty: &ty::AssocItem,
    impl_ty_span: Span,
    impl_trait_ref: ty::TraitRef<'tcx>,
) -> Result<(), ErrorReported> {
1246 1247 1248 1249 1250 1251
    // Given
    //
    // impl<A, B> Foo<u32> for (A, B) {
    //     type Bar<C> =...
    // }
    //
1252
    // - `impl_trait_ref` would be `<(A, B) as Foo<u32>>
J
jackh726 已提交
1253
    // - `impl_ty_substs` would be `[A, B, ^0.0]` (`^0.0` here is the bound var with db 0 and index 0)
1254 1255
    // - `rebased_substs` would be `[(A, B), u32, ^0.0]`, combining the substs from
    //    the *trait* with the generic associated type parameters (as bound vars).
J
jackh726 已提交
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281
    //
    // A note regarding the use of bound vars here:
    // Imagine as an example
    // ```
    // trait Family {
    //     type Member<C: Eq>;
    // }
    //
    // impl Family for VecFamily {
    //     type Member<C: Eq> = i32;
    // }
    // ```
    // Here, we would generate
    // ```notrust
    // forall<C> { Normalize(<VecFamily as Family>::Member<C> => i32) }
    // ```
    // when we really would like to generate
    // ```notrust
    // forall<C> { Normalize(<VecFamily as Family>::Member<C> => i32) :- Implemented(C: Eq) }
    // ```
    // But, this is probably fine, because although the first clause can be used with types C that
    // do not implement Eq, for it to cause some kind of problem, there would have to be a
    // VecFamily::Member<X> for some type X where !(X: Eq), that appears in the value of type
    // Member<C: Eq> = .... That type would fail a well-formedness check that we ought to be doing
    // elsewhere, which would check that any <T as Family>::Member<X> meets the bounds declared in
    // the trait (notably, that X: Eq and T: Family).
1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328
    let defs: &ty::Generics = tcx.generics_of(impl_ty.def_id);
    let mut substs = smallvec::SmallVec::with_capacity(defs.count());
    if let Some(def_id) = defs.parent {
        let parent_defs = tcx.generics_of(def_id);
        InternalSubsts::fill_item(&mut substs, tcx, parent_defs, &mut |param, _| {
            tcx.mk_param_from_def(param)
        });
    }
    let mut bound_vars: smallvec::SmallVec<[ty::BoundVariableKind; 8]> =
        smallvec::SmallVec::with_capacity(defs.count());
    InternalSubsts::fill_single(&mut substs, defs, &mut |param, _| match param.kind {
        GenericParamDefKind::Type { .. } => {
            let kind = ty::BoundTyKind::Param(param.name);
            let bound_var = ty::BoundVariableKind::Ty(kind);
            bound_vars.push(bound_var);
            tcx.mk_ty(ty::Bound(
                ty::INNERMOST,
                ty::BoundTy { var: ty::BoundVar::from_usize(bound_vars.len() - 1), kind },
            ))
            .into()
        }
        GenericParamDefKind::Lifetime => {
            let kind = ty::BoundRegionKind::BrNamed(param.def_id, param.name);
            let bound_var = ty::BoundVariableKind::Region(kind);
            bound_vars.push(bound_var);
            tcx.mk_region(ty::ReLateBound(
                ty::INNERMOST,
                ty::BoundRegion { var: ty::BoundVar::from_usize(bound_vars.len() - 1), kind },
            ))
            .into()
        }
        GenericParamDefKind::Const { .. } => {
            let bound_var = ty::BoundVariableKind::Const;
            bound_vars.push(bound_var);
            tcx.mk_const(ty::Const {
                ty: tcx.type_of(param.def_id),
                val: ty::ConstKind::Bound(
                    ty::INNERMOST,
                    ty::BoundVar::from_usize(bound_vars.len() - 1),
                ),
            })
            .into()
        }
    });
    let bound_vars = tcx.mk_bound_variable_kinds(bound_vars.into_iter());
    let impl_ty_substs = tcx.intern_substs(&substs);

1329 1330
    let rebased_substs =
        impl_ty_substs.rebase_onto(tcx, impl_ty.container.id(), impl_trait_ref.substs);
1331 1332
    let impl_ty_value = tcx.type_of(impl_ty.def_id);

1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
    let param_env = tcx.param_env(impl_ty.def_id);

    // When checking something like
    //
    // trait X { type Y: PartialEq<<Self as X>::Y> }
    // impl X for T { default type Y = S; }
    //
    // We will have to prove the bound S: PartialEq<<T as X>::Y>. In this case
    // we want <T as X>::Y to normalize to S. This is valid because we are
    // checking the default value specifically here. Add this equality to the
    // ParamEnv for normalization specifically.
1344
    let normalize_param_env = {
1345
        let mut predicates = param_env.caller_bounds().iter().collect::<Vec<_>>();
1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356
        match impl_ty_value.kind() {
            ty::Projection(proj)
                if proj.item_def_id == trait_ty.def_id && proj.substs == rebased_substs =>
            {
                // Don't include this predicate if the projected type is
                // exactly the same as the projection. This can occur in
                // (somewhat dubious) code like this:
                //
                // impl<T> X for T where T: X { type Y = <T as X>::Y; }
            }
            _ => predicates.push(
1357 1358 1359 1360 1361 1362 1363
                ty::Binder::bind_with_vars(
                    ty::ProjectionPredicate {
                        projection_ty: ty::ProjectionTy {
                            item_def_id: trait_ty.def_id,
                            substs: rebased_substs,
                        },
                        ty: impl_ty_value,
1364
                    },
1365 1366
                    bound_vars,
                )
1367 1368 1369
                .to_predicate(tcx),
            ),
        };
1370
        ty::ParamEnv::new(tcx.intern_predicates(&predicates), Reveal::UserFacing)
1371
    };
1372 1373 1374 1375 1376
    debug!(?normalize_param_env);

    let impl_ty_substs = InternalSubsts::identity_for_item(tcx, impl_ty.def_id);
    let rebased_substs =
        impl_ty_substs.rebase_onto(tcx, impl_ty.container.id(), impl_trait_ref.substs);
1377

1378
    tcx.infer_ctxt().enter(move |infcx| {
1379 1380 1381 1382 1383 1384
        let constness = impl_ty
            .container
            .impl_def_id()
            .map(|did| tcx.impl_constness(did))
            .unwrap_or(hir::Constness::NotConst);

1385
        let inh = Inherited::with_constness(infcx, impl_ty.def_id.expect_local(), constness);
1386 1387 1388
        let infcx = &inh.infcx;
        let mut selcx = traits::SelectionContext::new(&infcx);

1389
        let impl_ty_hir_id = tcx.hir().local_def_id_to_hir_id(impl_ty.def_id.expect_local());
1390
        let normalize_cause = traits::ObligationCause::misc(impl_ty_span, impl_ty_hir_id);
M
Matthew Jasper 已提交
1391 1392 1393 1394 1395 1396 1397
        let mk_cause = |span| {
            ObligationCause::new(
                impl_ty_span,
                impl_ty_hir_id,
                ObligationCauseCode::BindingObligation(trait_ty.def_id, span),
            )
        };
1398

1399 1400 1401 1402
        let obligations = tcx
            .explicit_item_bounds(trait_ty.def_id)
            .iter()
            .map(|&(bound, span)| {
1403
                debug!(?bound);
1404
                let concrete_ty_bound = bound.subst(tcx, rebased_substs);
1405
                debug!("check_type_bounds: concrete_ty_bound = {:?}", concrete_ty_bound);
1406

1407 1408 1409 1410 1411
                traits::Obligation::new(mk_cause(span), param_env, concrete_ty_bound)
            })
            .collect();
        debug!("check_type_bounds: item_bounds={:?}", obligations);

M
Matthew Jasper 已提交
1412
        for mut obligation in util::elaborate_obligations(tcx, obligations) {
1413 1414
            let traits::Normalized { value: normalized_predicate, obligations } = traits::normalize(
                &mut selcx,
1415
                normalize_param_env,
1416
                normalize_cause.clone(),
B
Bastian Kauschke 已提交
1417
                obligation.predicate,
1418 1419
            );
            debug!("compare_projection_bounds: normalized predicate = {:?}", normalized_predicate);
M
Matthew Jasper 已提交
1420
            obligation.predicate = normalized_predicate;
1421

1422
            inh.register_predicates(obligations);
1423
            inh.register_predicate(obligation);
1424 1425 1426 1427
        }

        // Check that all obligations are satisfied by the implementation's
        // version.
D
Deadbeef 已提交
1428 1429 1430
        if let Err(ref errors) =
            inh.fulfillment_cx.borrow_mut().select_all_with_constness_or_error(&infcx, constness)
        {
1431 1432 1433 1434 1435 1436 1437
            infcx.report_fulfillment_errors(errors, None, false);
            return Err(ErrorReported);
        }

        // Finally, resolve all regions. This catches wily misuses of
        // lifetime parameters.
        let fcx = FnCtxt::new(&inh, param_env, impl_ty_hir_id);
1438 1439 1440 1441 1442
        let implied_bounds = match impl_ty.container {
            ty::TraitContainer(_) => vec![],
            ty::ImplContainer(def_id) => fcx.impl_implied_bounds(def_id, impl_ty_span),
        };
        fcx.regionck_item(impl_ty_hir_id, impl_ty_span, &implied_bounds);
1443 1444 1445 1446 1447

        Ok(())
    })
}

1448 1449 1450
fn assoc_item_kind_str(impl_item: &ty::AssocItem) -> &'static str {
    match impl_item.kind {
        ty::AssocKind::Const => "const",
1451
        ty::AssocKind::Fn => "method",
M
Matthew Jasper 已提交
1452
        ty::AssocKind::Type => "type",
1453 1454
    }
}