compiler/rustc_hir_analysis/src/structured_errors/wrong_number_of_generic_args.rs

   1 use crate::structured_errors::StructuredDiagnostic;
   2 use rustc_errors::{
   3     pluralize, Applicability, Diagnostic, DiagnosticBuilder, DiagnosticId, ErrorGuaranteed,
   4     MultiSpan,
   5 };
   6 use rustc_hir as hir;
   7 use rustc_middle::ty::{self as ty, AssocItems, AssocKind, TyCtxt};
   8 use rustc_session::Session;
   9 use rustc_span::def_id::DefId;
  10 use std::iter;
  11
  12 use GenericArgsInfo::*;
  13
  14 /// Handles the `wrong number of type / lifetime / ... arguments` family of error messages.
  15 pub struct WrongNumberOfGenericArgs<'a, 'tcx> {
  16     pub(crate) tcx: TyCtxt<'tcx>,
  17
  18     pub(crate) angle_brackets: AngleBrackets,
  19
  20     pub(crate) gen_args_info: GenericArgsInfo,
  21
  22     /// Offending path segment
  23     pub(crate) path_segment: &'a hir::PathSegment<'a>,
  24
  25     /// Generic parameters as expected by type or trait
  26     pub(crate) gen_params: &'a ty::Generics,
  27
  28     /// Index offset into parameters. Depends on whether `Self` is included and on
  29     /// number of lifetime parameters in case we're processing missing or redundant
  30     /// type or constant arguments.
  31     pub(crate) params_offset: usize,
  32
  33     /// Generic arguments as provided by user
  34     pub(crate) gen_args: &'a hir::GenericArgs<'a>,
  35
  36     /// DefId of the generic type
  37     pub(crate) def_id: DefId,
  38 }
  39
  40 // Provides information about the kind of arguments that were provided for
  41 // the PathSegment, for which missing generic arguments were detected
  42 #[derive(Debug)]
  43 pub(crate) enum AngleBrackets {
  44     // No angle brackets were provided, but generic arguments exist in elided form
  45     Implied,
  46
  47     // No angle brackets were provided
  48     Missing,
  49
  50     // Angle brackets are available, but missing some generic arguments
  51     Available,
  52 }
  53
  54 // Information about the kind of arguments that are either missing or are unexpected
  55 #[derive(Debug)]
  56 pub enum GenericArgsInfo {
  57     MissingLifetimes {
  58         num_missing_args: usize,
  59     },
  60     ExcessLifetimes {
  61         num_redundant_args: usize,
  62     },
  63     MissingTypesOrConsts {
  64         num_missing_args: usize,
  65
  66         // type or const generic arguments can have default values
  67         num_default_params: usize,
  68
  69         // lifetime arguments precede type and const parameters, this
  70         // field gives the number of generic lifetime arguments to let
  71         // us infer the position of type and const generic arguments
  72         // in the angle brackets
  73         args_offset: usize,
  74     },
  75
  76     ExcessTypesOrConsts {
  77         num_redundant_args: usize,
  78
  79         // type or const generic arguments can have default values
  80         num_default_params: usize,
  81
  82         // lifetime arguments precede type and const parameters, this
  83         // field gives the number of generic lifetime arguments to let
  84         // us infer the position of type and const generic arguments
  85         // in the angle brackets
  86         args_offset: usize,
  87
  88         // if synthetic type arguments (e.g. `impl Trait`) are specified
  89         synth_provided: bool,
  90     },
  91 }
  92
  93 impl<'a, 'tcx> WrongNumberOfGenericArgs<'a, 'tcx> {
  94     pub fn new(
  95         tcx: TyCtxt<'tcx>,
  96         gen_args_info: GenericArgsInfo,
  97         path_segment: &'a hir::PathSegment<'_>,
  98         gen_params: &'a ty::Generics,
  99         params_offset: usize,
 100         gen_args: &'a hir::GenericArgs<'a>,
 101         def_id: DefId,
 102     ) -> Self {
 103         let angle_brackets = if gen_args.span_ext().is_none() {
 104             if gen_args.is_empty() { AngleBrackets::Missing } else { AngleBrackets::Implied }
 105         } else {
 106             AngleBrackets::Available
 107         };
 108
 109         Self {
 110             tcx,
 111             angle_brackets,
 112             gen_args_info,
 113             path_segment,
 114             gen_params,
 115             params_offset,
 116             gen_args,
 117             def_id,
 118         }
 119     }
 120
 121     fn missing_lifetimes(&self) -> bool {
 122         match self.gen_args_info {
 123             MissingLifetimes { .. } | ExcessLifetimes { .. } => true,
 124             MissingTypesOrConsts { .. } | ExcessTypesOrConsts { .. } => false,
 125         }
 126     }
 127
 128     fn kind(&self) -> &str {
 129         if self.missing_lifetimes() { "lifetime" } else { "generic" }
 130     }
 131
 132     fn num_provided_args(&self) -> usize {
 133         if self.missing_lifetimes() {
 134             self.num_provided_lifetime_args()
 135         } else {
 136             self.num_provided_type_or_const_args()
 137         }
 138     }
 139
 140     fn num_provided_lifetime_args(&self) -> usize {
 141         match self.angle_brackets {
 142             AngleBrackets::Missing => 0,
 143             // Only lifetime arguments can be implied
 144             AngleBrackets::Implied => self.gen_args.args.len(),
 145             AngleBrackets::Available => self.gen_args.num_lifetime_params(),
 146         }
 147     }
 148
 149     fn num_provided_type_or_const_args(&self) -> usize {
 150         match self.angle_brackets {
 151             AngleBrackets::Missing => 0,
 152             // Only lifetime arguments can be implied
 153             AngleBrackets::Implied => 0,
 154             AngleBrackets::Available => self.gen_args.num_generic_params(),
 155         }
 156     }
 157
 158     fn num_expected_lifetime_args(&self) -> usize {
 159         let num_provided_args = self.num_provided_lifetime_args();
 160         match self.gen_args_info {
 161             MissingLifetimes { num_missing_args } => num_provided_args + num_missing_args,
 162             ExcessLifetimes { num_redundant_args } => num_provided_args - num_redundant_args,
 163             _ => 0,
 164         }
 165     }
 166
 167     fn num_expected_type_or_const_args(&self) -> usize {
 168         let num_provided_args = self.num_provided_type_or_const_args();
 169         match self.gen_args_info {
 170             MissingTypesOrConsts { num_missing_args, .. } => num_provided_args + num_missing_args,
 171             ExcessTypesOrConsts { num_redundant_args, .. } => {
 172                 num_provided_args - num_redundant_args
 173             }
 174             _ => 0,
 175         }
 176     }
 177
 178     // Gives the number of expected arguments taking into account default arguments
 179     fn num_expected_type_or_const_args_including_defaults(&self) -> usize {
 180         let provided_args = self.num_provided_type_or_const_args();
 181         match self.gen_args_info {
 182             MissingTypesOrConsts { num_missing_args, num_default_params, .. } => {
 183                 provided_args + num_missing_args - num_default_params
 184             }
 185             ExcessTypesOrConsts { num_redundant_args, num_default_params, .. } => {
 186                 provided_args - num_redundant_args - num_default_params
 187             }
 188             _ => 0,
 189         }
 190     }
 191
 192     fn num_missing_lifetime_args(&self) -> usize {
 193         let missing_args = self.num_expected_lifetime_args() - self.num_provided_lifetime_args();
 194         assert!(missing_args > 0);
 195         missing_args
 196     }
 197
 198     fn num_missing_type_or_const_args(&self) -> usize {
 199         let missing_args = self.num_expected_type_or_const_args_including_defaults()
 200             - self.num_provided_type_or_const_args();
 201         assert!(missing_args > 0);
 202         missing_args
 203     }
 204
 205     fn num_excess_lifetime_args(&self) -> usize {
 206         match self.gen_args_info {
 207             ExcessLifetimes { num_redundant_args } => num_redundant_args,
 208             _ => 0,
 209         }
 210     }
 211
 212     fn num_excess_type_or_const_args(&self) -> usize {
 213         match self.gen_args_info {
 214             ExcessTypesOrConsts { num_redundant_args, .. } => num_redundant_args,
 215             _ => 0,
 216         }
 217     }
 218
 219     fn too_many_args_provided(&self) -> bool {
 220         match self.gen_args_info {
 221             MissingLifetimes { .. } | MissingTypesOrConsts { .. } => false,
 222             ExcessLifetimes { num_redundant_args }
 223             | ExcessTypesOrConsts { num_redundant_args, .. } => {
 224                 assert!(num_redundant_args > 0);
 225                 true
 226             }
 227         }
 228     }
 229
 230     fn not_enough_args_provided(&self) -> bool {
 231         match self.gen_args_info {
 232             MissingLifetimes { num_missing_args }
 233             | MissingTypesOrConsts { num_missing_args, .. } => {
 234                 assert!(num_missing_args > 0);
 235                 true
 236             }
 237             ExcessLifetimes { .. } | ExcessTypesOrConsts { .. } => false,
 238         }
 239     }
 240
 241     // Helper method to get the index offset in angle brackets, at which type or const arguments
 242     // start appearing
 243     fn get_lifetime_args_offset(&self) -> usize {
 244         match self.gen_args_info {
 245             MissingLifetimes { .. } | ExcessLifetimes { .. } => 0,
 246             MissingTypesOrConsts { args_offset, .. } | ExcessTypesOrConsts { args_offset, .. } => {
 247                 args_offset
 248             }
 249         }
 250     }
 251
 252     fn get_num_default_params(&self) -> usize {
 253         match self.gen_args_info {
 254             MissingTypesOrConsts { num_default_params, .. }
 255             | ExcessTypesOrConsts { num_default_params, .. } => num_default_params,
 256             _ => 0,
 257         }
 258     }
 259
 260     fn is_synth_provided(&self) -> bool {
 261         match self.gen_args_info {
 262             ExcessTypesOrConsts { synth_provided, .. } => synth_provided,
 263             _ => false,
 264         }
 265     }
 266
 267     // Helper function to choose a quantifier word for the number of expected arguments
 268     // and to give a bound for the number of expected arguments
 269     fn get_quantifier_and_bound(&self) -> (&'static str, usize) {
 270         if self.get_num_default_params() == 0 {
 271             match self.gen_args_info {
 272                 MissingLifetimes { .. } | ExcessLifetimes { .. } => {
 273                     ("", self.num_expected_lifetime_args())
 274                 }
 275                 MissingTypesOrConsts { .. } | ExcessTypesOrConsts { .. } => {
 276                     ("", self.num_expected_type_or_const_args())
 277                 }
 278             }
 279         } else {
 280             match self.gen_args_info {
 281                 MissingLifetimes { .. } => ("at least ", self.num_expected_lifetime_args()),
 282                 MissingTypesOrConsts { .. } => {
 283                     ("at least ", self.num_expected_type_or_const_args_including_defaults())
 284                 }
 285                 ExcessLifetimes { .. } => ("at most ", self.num_expected_lifetime_args()),
 286                 ExcessTypesOrConsts { .. } => ("at most ", self.num_expected_type_or_const_args()),
 287             }
 288         }
 289     }
 290
 291     // Creates lifetime name suggestions from the lifetime parameter names
 292     fn get_lifetime_args_suggestions_from_param_names(
 293         &self,
 294         path_hir_id: hir::HirId,
 295         num_params_to_take: usize,
 296     ) -> String {
 297         debug!(?path_hir_id);
 298
 299         let mut ret = Vec::new();
 300         for (id, node) in self.tcx.hir().parent_iter(path_hir_id) {
 301             debug!(?id);
 302             let params = if let Some(generics) = node.generics() {
 303                 generics.params
 304             } else if let hir::Node::Ty(ty) = node
 305                 && let hir::TyKind::BareFn(bare_fn) = ty.kind
 306             {
 307                 bare_fn.generic_params
 308             } else {
 309                 &[]
 310             };
 311             ret.extend(params.iter().filter_map(|p| {
 312                 let hir::GenericParamKind::Lifetime { kind: hir::LifetimeParamKind::Explicit }
 313                     = p.kind
 314                 else { return None };
 315                 let hir::ParamName::Plain(name) = p.name else { return None };
 316                 Some(name.to_string())
 317             }));
 318             // Suggest `'static` when in const/static item-like.
 319             if let hir::Node::Item(hir::Item {
 320                 kind: hir::ItemKind::Static { .. } | hir::ItemKind::Const { .. },
 321                 ..
 322             })
 323             | hir::Node::TraitItem(hir::TraitItem {
 324                 kind: hir::TraitItemKind::Const { .. },
 325                 ..
 326             })
 327             | hir::Node::ImplItem(hir::ImplItem {
 328                 kind: hir::ImplItemKind::Const { .. },
 329                 ..
 330             })
 331             | hir::Node::ForeignItem(hir::ForeignItem {
 332                 kind: hir::ForeignItemKind::Static { .. },
 333                 ..
 334             })
 335             | hir::Node::AnonConst(..) = node
 336             {
 337                 ret.extend(
 338                     std::iter::repeat("'static".to_owned())
 339                         .take(num_params_to_take.saturating_sub(ret.len())),
 340                 );
 341             }
 342             if ret.len() >= num_params_to_take {
 343                 return ret[..num_params_to_take].join(", ");
 344             }
 345             // We cannot refer to lifetimes defined in an outer function.
 346             if let hir::Node::Item(_) = node {
 347                 break;
 348             }
 349         }
 350
 351         // We could not gather enough lifetime parameters in the scope.
 352         // We use the parameter names from the target type's definition instead.
 353         self.gen_params
 354             .params
 355             .iter()
 356             .skip(self.params_offset + self.num_provided_lifetime_args())
 357             .take(num_params_to_take)
 358             .map(|param| param.name.to_string())
 359             .collect::<Vec<_>>()
 360             .join(", ")
 361     }
 362
 363     // Creates type or constant name suggestions from the provided parameter names
 364     fn get_type_or_const_args_suggestions_from_param_names(
 365         &self,
 366         num_params_to_take: usize,
 367     ) -> String {
 368         let fn_sig = self.tcx.hir().get_if_local(self.def_id).and_then(hir::Node::fn_sig);
 369         let is_used_in_input = |def_id| {
 370             fn_sig.map_or(false, |fn_sig| {
 371                 fn_sig.decl.inputs.iter().any(|ty| match ty.kind {
 372                     hir::TyKind::Path(hir::QPath::Resolved(
 373                         None,
 374                         hir::Path { res: hir::def::Res::Def(_, id), .. },
 375                     )) => *id == def_id,
 376                     _ => false,
 377                 })
 378             })
 379         };
 380         self.gen_params
 381             .params
 382             .iter()
 383             .skip(self.params_offset + self.num_provided_type_or_const_args())
 384             .take(num_params_to_take)
 385             .map(|param| match param.kind {
 386                 // This is being inferred from the item's inputs, no need to set it.
 387                 ty::GenericParamDefKind::Type { .. } if is_used_in_input(param.def_id) => {
 388                     "_".to_string()
 389                 }
 390                 _ => param.name.to_string(),
 391             })
 392             .collect::<Vec<_>>()
 393             .join(", ")
 394     }
 395
 396     fn get_unbound_associated_types(&self) -> Vec<String> {
 397         if self.tcx.is_trait(self.def_id) {
 398             let items: &AssocItems<'_> = self.tcx.associated_items(self.def_id);
 399             items
 400                 .in_definition_order()
 401                 .filter(|item| item.kind == AssocKind::Type)
 402                 .filter(|item| {
 403                     !self.gen_args.bindings.iter().any(|binding| binding.ident.name == item.name)
 404                 })
 405                 .map(|item| item.name.to_ident_string())
 406                 .collect()
 407         } else {
 408             Vec::default()
 409         }
 410     }
 411
 412     fn create_error_message(&self) -> String {
 413         let def_path = self.tcx.def_path_str(self.def_id);
 414         let def_kind = self.tcx.def_kind(self.def_id).descr(self.def_id);
 415         let (quantifier, bound) = self.get_quantifier_and_bound();
 416         let kind = self.kind();
 417         let provided_lt_args = self.num_provided_lifetime_args();
 418         let provided_type_or_const_args = self.num_provided_type_or_const_args();
 419
 420         let (provided_args_str, verb) = match self.gen_args_info {
 421             MissingLifetimes { .. } | ExcessLifetimes { .. } => (
 422                 format!("{} lifetime argument{}", provided_lt_args, pluralize!(provided_lt_args)),
 423                 pluralize!("was", provided_lt_args),
 424             ),
 425             MissingTypesOrConsts { .. } | ExcessTypesOrConsts { .. } => (
 426                 format!(
 427                     "{} generic argument{}",
 428                     provided_type_or_const_args,
 429                     pluralize!(provided_type_or_const_args)
 430                 ),
 431                 pluralize!("was", provided_type_or_const_args),
 432             ),
 433         };
 434
 435         if self.gen_args.span_ext().is_some() {
 436             format!(
 437                 "this {} takes {}{} {} argument{} but {} {} supplied",
 438                 def_kind,
 439                 quantifier,
 440                 bound,
 441                 kind,
 442                 pluralize!(bound),
 443                 provided_args_str.as_str(),
 444                 verb
 445             )
 446         } else {
 447             format!("missing generics for {} `{}`", def_kind, def_path)
 448         }
 449     }
 450
 451     fn start_diagnostics(&self) -> DiagnosticBuilder<'tcx, ErrorGuaranteed> {
 452         let span = self.path_segment.ident.span;
 453         let msg = self.create_error_message();
 454
 455         self.tcx.sess.struct_span_err_with_code(span, &msg, self.code())
 456     }
 457
 458     /// Builds the `expected 1 type argument / supplied 2 type arguments` message.
 459     fn notify(&self, err: &mut Diagnostic) {
 460         let (quantifier, bound) = self.get_quantifier_and_bound();
 461         let provided_args = self.num_provided_args();
 462
 463         err.span_label(
 464             self.path_segment.ident.span,
 465             format!(
 466                 "expected {}{} {} argument{}",
 467                 quantifier,
 468                 bound,
 469                 self.kind(),
 470                 pluralize!(bound),
 471             ),
 472         );
 473
 474         // When too many arguments were provided, we don't highlight each of them, because it
 475         // would overlap with the suggestion to remove them:
 476         //
 477         // ```
 478         // type Foo = Bar<usize, usize>;
 479         //                -----  ----- supplied 2 type arguments
 480         //                     ^^^^^^^ remove this type argument
 481         // ```
 482         if self.too_many_args_provided() {
 483             return;
 484         }
 485
 486         let args = self
 487             .gen_args
 488             .args
 489             .iter()
 490             .skip(self.get_lifetime_args_offset())
 491             .take(provided_args)
 492             .enumerate();
 493
 494         for (i, arg) in args {
 495             err.span_label(
 496                 arg.span(),
 497                 if i + 1 == provided_args {
 498                     format!(
 499                         "supplied {} {} argument{}",
 500                         provided_args,
 501                         self.kind(),
 502                         pluralize!(provided_args)
 503                     )
 504                 } else {
 505                     String::new()
 506                 },
 507             );
 508         }
 509     }
 510
 511     fn suggest(&self, err: &mut Diagnostic) {
 512         debug!(
 513             "suggest(self.provided {:?}, self.gen_args.span(): {:?})",
 514             self.num_provided_args(),
 515             self.gen_args.span(),
 516         );
 517
 518         match self.angle_brackets {
 519             AngleBrackets::Missing | AngleBrackets::Implied => self.suggest_adding_args(err),
 520             AngleBrackets::Available => {
 521                 if self.not_enough_args_provided() {
 522                     self.suggest_adding_args(err);
 523                 } else if self.too_many_args_provided() {
 524                     self.suggest_moving_args_from_assoc_fn_to_trait(err);
 525                     self.suggest_removing_args_or_generics(err);
 526                 } else {
 527                     unreachable!();
 528                 }
 529             }
 530         }
 531     }
 532
 533     /// Suggests to add missing argument(s) when current invocation site already contains some
 534     /// generics:
 535     ///
 536     /// ```text
 537     /// type Map = HashMap<String>;
 538     /// ```
 539     fn suggest_adding_args(&self, err: &mut Diagnostic) {
 540         if self.gen_args.parenthesized {
 541             return;
 542         }
 543
 544         match self.gen_args_info {
 545             MissingLifetimes { .. } => {
 546                 self.suggest_adding_lifetime_args(err);
 547             }
 548             MissingTypesOrConsts { .. } => {
 549                 self.suggest_adding_type_and_const_args(err);
 550             }
 551             _ => unreachable!(),
 552         }
 553     }
 554
 555     fn suggest_adding_lifetime_args(&self, err: &mut Diagnostic) {
 556         debug!("suggest_adding_lifetime_args(path_segment: {:?})", self.path_segment);
 557         let num_missing_args = self.num_missing_lifetime_args();
 558         let num_params_to_take = num_missing_args;
 559         let msg = format!("add missing {} argument{}", self.kind(), pluralize!(num_missing_args));
 560
 561         let suggested_args = self.get_lifetime_args_suggestions_from_param_names(
 562             self.path_segment.hir_id,
 563             num_params_to_take,
 564         );
 565         debug!("suggested_args: {:?}", &suggested_args);
 566
 567         match self.angle_brackets {
 568             AngleBrackets::Missing => {
 569                 let span = self.path_segment.ident.span;
 570
 571                 // insert a suggestion of the form "Y<'a, 'b>"
 572                 let ident = self.path_segment.ident.name.to_ident_string();
 573                 let sugg = format!("{}<{}>", ident, suggested_args);
 574                 debug!("sugg: {:?}", sugg);
 575
 576                 err.span_suggestion_verbose(span, &msg, sugg, Applicability::HasPlaceholders);
 577             }
 578
 579             AngleBrackets::Available => {
 580                 let (sugg_span, is_first) = if self.num_provided_lifetime_args() == 0 {
 581                     (self.gen_args.span().unwrap().shrink_to_lo(), true)
 582                 } else {
 583                     let last_lt = &self.gen_args.args[self.num_provided_lifetime_args() - 1];
 584                     (last_lt.span().shrink_to_hi(), false)
 585                 };
 586                 let has_non_lt_args = self.num_provided_type_or_const_args() != 0;
 587                 let has_bindings = !self.gen_args.bindings.is_empty();
 588
 589                 let sugg_prefix = if is_first { "" } else { ", " };
 590                 let sugg_suffix =
 591                     if is_first && (has_non_lt_args || has_bindings) { ", " } else { "" };
 592
 593                 let sugg = format!("{}{}{}", sugg_prefix, suggested_args, sugg_suffix);
 594                 debug!("sugg: {:?}", sugg);
 595
 596                 err.span_suggestion_verbose(sugg_span, &msg, sugg, Applicability::HasPlaceholders);
 597             }
 598             AngleBrackets::Implied => {
 599                 // We never encounter missing lifetimes in situations in which lifetimes are elided
 600                 unreachable!();
 601             }
 602         }
 603     }
 604
 605     fn suggest_adding_type_and_const_args(&self, err: &mut Diagnostic) {
 606         let num_missing_args = self.num_missing_type_or_const_args();
 607         let msg = format!("add missing {} argument{}", self.kind(), pluralize!(num_missing_args));
 608
 609         let suggested_args =
 610             self.get_type_or_const_args_suggestions_from_param_names(num_missing_args);
 611         debug!("suggested_args: {:?}", suggested_args);
 612
 613         match self.angle_brackets {
 614             AngleBrackets::Missing | AngleBrackets::Implied => {
 615                 let span = self.path_segment.ident.span;
 616
 617                 // insert a suggestion of the form "Y<T, U>"
 618                 let ident = self.path_segment.ident.name.to_ident_string();
 619                 let sugg = format!("{}<{}>", ident, suggested_args);
 620                 debug!("sugg: {:?}", sugg);
 621
 622                 err.span_suggestion_verbose(span, &msg, sugg, Applicability::HasPlaceholders);
 623             }
 624             AngleBrackets::Available => {
 625                 let gen_args_span = self.gen_args.span().unwrap();
 626                 let sugg_offset =
 627                     self.get_lifetime_args_offset() + self.num_provided_type_or_const_args();
 628
 629                 let (sugg_span, is_first) = if sugg_offset == 0 {
 630                     (gen_args_span.shrink_to_lo(), true)
 631                 } else {
 632                     let arg_span = self.gen_args.args[sugg_offset - 1].span();
 633                     // If we came here then inferred lifetime's spans can only point
 634                     // to either the opening bracket or to the space right after.
 635                     // Both of these spans have an `hi` lower than or equal to the span
 636                     // of the generics excluding the brackets.
 637                     // This allows us to check if `arg_span` is the artificial span of
 638                     // an inferred lifetime, in which case the generic we're suggesting to
 639                     // add will be the first visible, even if it isn't the actual first generic.
 640                     (arg_span.shrink_to_hi(), arg_span.hi() <= gen_args_span.lo())
 641                 };
 642
 643                 let sugg_prefix = if is_first { "" } else { ", " };
 644                 let sugg_suffix =
 645                     if is_first && !self.gen_args.bindings.is_empty() { ", " } else { "" };
 646
 647                 let sugg = format!("{}{}{}", sugg_prefix, suggested_args, sugg_suffix);
 648                 debug!("sugg: {:?}", sugg);
 649
 650                 err.span_suggestion_verbose(sugg_span, &msg, sugg, Applicability::HasPlaceholders);
 651             }
 652         }
 653     }
 654
 655     /// Suggests moving redundant argument(s) of an associate function to the
 656     /// trait it belongs to.
 657     ///
 658     /// ```compile_fail
 659     /// Into::into::<Option<_>>(42) // suggests considering `Into::<Option<_>>::into(42)`
 660     /// ```
 661     fn suggest_moving_args_from_assoc_fn_to_trait(&self, err: &mut Diagnostic) {
 662         let trait_ = match self.tcx.trait_of_item(self.def_id) {
 663             Some(def_id) => def_id,
 664             None => return,
 665         };
 666
 667         // Skip suggestion when the associated function is itself generic, it is unclear
 668         // how to split the provided parameters between those to suggest to the trait and
 669         // those to remain on the associated type.
 670         let num_assoc_fn_expected_args =
 671             self.num_expected_type_or_const_args() + self.num_expected_lifetime_args();
 672         if num_assoc_fn_expected_args > 0 {
 673             return;
 674         }
 675
 676         let num_assoc_fn_excess_args =
 677             self.num_excess_type_or_const_args() + self.num_excess_lifetime_args();
 678
 679         let trait_generics = self.tcx.generics_of(trait_);
 680         let num_trait_generics_except_self =
 681             trait_generics.count() - if trait_generics.has_self { 1 } else { 0 };
 682
 683         let msg = format!(
 684             "consider moving {these} generic argument{s} to the `{name}` trait, which takes up to {num} argument{s}",
 685             these = pluralize!("this", num_assoc_fn_excess_args),
 686             s = pluralize!(num_assoc_fn_excess_args),
 687             name = self.tcx.item_name(trait_),
 688             num = num_trait_generics_except_self,
 689         );
 690
 691         if let Some(parent_node) = self.tcx.hir().find_parent_node(self.path_segment.hir_id)
 692         && let Some(parent_node) = self.tcx.hir().find(parent_node)
 693         && let hir::Node::Expr(expr) = parent_node {
 694             match expr.kind {
 695                 hir::ExprKind::Path(ref qpath) => {
 696                     self.suggest_moving_args_from_assoc_fn_to_trait_for_qualified_path(
 697                         err,
 698                         qpath,
 699                         msg,
 700                         num_assoc_fn_excess_args,
 701                         num_trait_generics_except_self
 702                     )
 703                 },
 704                 hir::ExprKind::MethodCall(..) => {
 705                     self.suggest_moving_args_from_assoc_fn_to_trait_for_method_call(
 706                         err,
 707                         trait_,
 708                         expr,
 709                         msg,
 710                         num_assoc_fn_excess_args,
 711                         num_trait_generics_except_self
 712                     )
 713                 },
 714                 _ => return,
 715             }
 716         }
 717     }
 718
 719     fn suggest_moving_args_from_assoc_fn_to_trait_for_qualified_path(
 720         &self,
 721         err: &mut Diagnostic,
 722         qpath: &'tcx hir::QPath<'tcx>,
 723         msg: String,
 724         num_assoc_fn_excess_args: usize,
 725         num_trait_generics_except_self: usize,
 726     ) {
 727         if let hir::QPath::Resolved(_, path) = qpath
 728         && let Some(trait_path_segment) = path.segments.get(0) {
 729             let num_generic_args_supplied_to_trait = trait_path_segment.args().num_generic_params();
 730
 731             if num_assoc_fn_excess_args == num_trait_generics_except_self - num_generic_args_supplied_to_trait {
 732                 if let Some(span) = self.gen_args.span_ext()
 733                 && let Ok(snippet) = self.tcx.sess.source_map().span_to_snippet(span) {
 734                     let sugg = vec![
 735                         (self.path_segment.ident.span, format!("{}::{}", snippet, self.path_segment.ident)),
 736                         (span.with_lo(self.path_segment.ident.span.hi()), "".to_owned())
 737                     ];
 738
 739                     err.multipart_suggestion(
 740                         msg,
 741                         sugg,
 742                         Applicability::MaybeIncorrect
 743                     );
 744                 }
 745             }
 746         }
 747     }
 748
 749     fn suggest_moving_args_from_assoc_fn_to_trait_for_method_call(
 750         &self,
 751         err: &mut Diagnostic,
 752         trait_def_id: DefId,
 753         expr: &'tcx hir::Expr<'tcx>,
 754         msg: String,
 755         num_assoc_fn_excess_args: usize,
 756         num_trait_generics_except_self: usize,
 757     ) {
 758         let sm = self.tcx.sess.source_map();
 759         let hir::ExprKind::MethodCall(_, rcvr, args, _) = expr.kind else { return; };
 760         if num_assoc_fn_excess_args != num_trait_generics_except_self {
 761             return;
 762         }
 763         let Some(gen_args) = self.gen_args.span_ext() else { return; };
 764         let Ok(generics) = sm.span_to_snippet(gen_args) else { return; };
 765         let Ok(rcvr) = sm.span_to_snippet(
 766             rcvr.span.find_ancestor_inside(expr.span).unwrap_or(rcvr.span)
 767         ) else { return; };
 768         let Ok(rest) =
 769             (match args {
 770                 [] => Ok(String::new()),
 771                 [arg] => sm.span_to_snippet(
 772                     arg.span.find_ancestor_inside(expr.span).unwrap_or(arg.span),
 773                 ),
 774                 [first, .., last] => {
 775                     let first_span =
 776                         first.span.find_ancestor_inside(expr.span).unwrap_or(first.span);
 777                     let last_span =
 778                         last.span.find_ancestor_inside(expr.span).unwrap_or(last.span);
 779                     sm.span_to_snippet(first_span.to(last_span))
 780                 }
 781             }) else { return; };
 782         let comma = if args.len() > 0 { ", " } else { "" };
 783         let trait_path = self.tcx.def_path_str(trait_def_id);
 784         let method_name = self.tcx.item_name(self.def_id);
 785         err.span_suggestion(
 786             expr.span,
 787             msg,
 788             format!("{trait_path}::{generics}::{method_name}({rcvr}{comma}{rest})"),
 789             Applicability::MaybeIncorrect,
 790         );
 791     }
 792
 793     /// Suggests to remove redundant argument(s):
 794     ///
 795     /// ```text
 796     /// type Map = HashMap<String, String, String, String>;
 797     /// ```
 798     fn suggest_removing_args_or_generics(&self, err: &mut Diagnostic) {
 799         let num_provided_lt_args = self.num_provided_lifetime_args();
 800         let num_provided_type_const_args = self.num_provided_type_or_const_args();
 801         let unbound_types = self.get_unbound_associated_types();
 802         let num_provided_args = num_provided_lt_args + num_provided_type_const_args;
 803         assert!(num_provided_args > 0);
 804
 805         let num_redundant_lt_args = self.num_excess_lifetime_args();
 806         let num_redundant_type_or_const_args = self.num_excess_type_or_const_args();
 807         let num_redundant_args = num_redundant_lt_args + num_redundant_type_or_const_args;
 808
 809         let redundant_lifetime_args = num_redundant_lt_args > 0;
 810         let redundant_type_or_const_args = num_redundant_type_or_const_args > 0;
 811
 812         let remove_entire_generics = num_redundant_args >= self.gen_args.args.len();
 813         let provided_args_matches_unbound_traits =
 814             unbound_types.len() == num_redundant_type_or_const_args;
 815
 816         let remove_lifetime_args = |err: &mut Diagnostic| {
 817             let mut lt_arg_spans = Vec::new();
 818             let mut found_redundant = false;
 819             for arg in self.gen_args.args {
 820                 if let hir::GenericArg::Lifetime(_) = arg {
 821                     lt_arg_spans.push(arg.span());
 822                     if lt_arg_spans.len() > self.num_expected_lifetime_args() {
 823                         found_redundant = true;
 824                     }
 825                 } else if found_redundant {
 826                     // Argument which is redundant and separated like this `'c`
 827                     // is not included to avoid including `Bar` in span.
 828                     // ```
 829                     // type Foo<'a, T> = &'a T;
 830                     // let _: Foo<'a, 'b, Bar, 'c>;
 831                     // ```
 832                     break;
 833                 }
 834             }
 835
 836             let span_lo_redundant_lt_args = lt_arg_spans[self.num_expected_lifetime_args()];
 837             let span_hi_redundant_lt_args = lt_arg_spans[lt_arg_spans.len() - 1];
 838
 839             let span_redundant_lt_args = span_lo_redundant_lt_args.to(span_hi_redundant_lt_args);
 840             debug!("span_redundant_lt_args: {:?}", span_redundant_lt_args);
 841
 842             let num_redundant_lt_args = lt_arg_spans.len() - self.num_expected_lifetime_args();
 843             let msg_lifetimes = format!(
 844                 "remove {these} lifetime argument{s}",
 845                 these = pluralize!("this", num_redundant_lt_args),
 846                 s = pluralize!(num_redundant_lt_args),
 847             );
 848
 849             err.span_suggestion(
 850                 span_redundant_lt_args,
 851                 &msg_lifetimes,
 852                 "",
 853                 Applicability::MaybeIncorrect,
 854             );
 855         };
 856
 857         let remove_type_or_const_args = |err: &mut Diagnostic| {
 858             let mut gen_arg_spans = Vec::new();
 859             let mut found_redundant = false;
 860             for arg in self.gen_args.args {
 861                 match arg {
 862                     hir::GenericArg::Type(_)
 863                     | hir::GenericArg::Const(_)
 864                     | hir::GenericArg::Infer(_) => {
 865                         gen_arg_spans.push(arg.span());
 866                         if gen_arg_spans.len() > self.num_expected_type_or_const_args() {
 867                             found_redundant = true;
 868                         }
 869                     }
 870                     _ if found_redundant => break,
 871                     _ => {}
 872                 }
 873             }
 874
 875             let span_lo_redundant_type_or_const_args =
 876                 gen_arg_spans[self.num_expected_type_or_const_args()];
 877             let span_hi_redundant_type_or_const_args = gen_arg_spans[gen_arg_spans.len() - 1];
 878
 879             let span_redundant_type_or_const_args =
 880                 span_lo_redundant_type_or_const_args.to(span_hi_redundant_type_or_const_args);
 881             debug!("span_redundant_type_or_const_args: {:?}", span_redundant_type_or_const_args);
 882
 883             let num_redundant_gen_args =
 884                 gen_arg_spans.len() - self.num_expected_type_or_const_args();
 885             let msg_types_or_consts = format!(
 886                 "remove {these} generic argument{s}",
 887                 these = pluralize!("this", num_redundant_gen_args),
 888                 s = pluralize!(num_redundant_gen_args),
 889             );
 890
 891             err.span_suggestion(
 892                 span_redundant_type_or_const_args,
 893                 &msg_types_or_consts,
 894                 "",
 895                 Applicability::MaybeIncorrect,
 896             );
 897         };
 898
 899         // If there is a single unbound associated type and a single excess generic param
 900         // suggest replacing the generic param with the associated type bound
 901         if provided_args_matches_unbound_traits && !unbound_types.is_empty() {
 902             let unused_generics = &self.gen_args.args[self.num_expected_type_or_const_args()..];
 903             let suggestions = iter::zip(unused_generics, &unbound_types)
 904                 .map(|(potential, name)| (potential.span().shrink_to_lo(), format!("{name} = ")))
 905                 .collect::<Vec<_>>();
 906
 907             if !suggestions.is_empty() {
 908                 err.multipart_suggestion_verbose(
 909                     &format!(
 910                         "replace the generic bound{s} with the associated type{s}",
 911                         s = pluralize!(unbound_types.len())
 912                     ),
 913                     suggestions,
 914                     Applicability::MaybeIncorrect,
 915                 );
 916             }
 917         } else if remove_entire_generics {
 918             let span = self
 919                 .path_segment
 920                 .args
 921                 .unwrap()
 922                 .span_ext()
 923                 .unwrap()
 924                 .with_lo(self.path_segment.ident.span.hi());
 925
 926             let msg = format!(
 927                 "remove these {}generics",
 928                 if self.gen_args.parenthesized { "parenthetical " } else { "" },
 929             );
 930
 931             err.span_suggestion(span, &msg, "", Applicability::MaybeIncorrect);
 932         } else if redundant_lifetime_args && redundant_type_or_const_args {
 933             remove_lifetime_args(err);
 934             remove_type_or_const_args(err);
 935         } else if redundant_lifetime_args {
 936             remove_lifetime_args(err);
 937         } else {
 938             assert!(redundant_type_or_const_args);
 939             remove_type_or_const_args(err);
 940         }
 941     }
 942
 943     /// Builds the `type defined here` message.
 944     fn show_definition(&self, err: &mut Diagnostic) {
 945         let mut spans: MultiSpan = if let Some(def_span) = self.tcx.def_ident_span(self.def_id) {
 946             if self.tcx.sess.source_map().is_span_accessible(def_span) {
 947                 def_span.into()
 948             } else {
 949                 return;
 950             }
 951         } else {
 952             return;
 953         };
 954
 955         let msg = {
 956             let def_kind = self.tcx.def_kind(self.def_id).descr(self.def_id);
 957             let (quantifier, bound) = self.get_quantifier_and_bound();
 958
 959             let params = if bound == 0 {
 960                 String::new()
 961             } else {
 962                 let params = self
 963                     .gen_params
 964                     .params
 965                     .iter()
 966                     .skip(self.params_offset)
 967                     .take(bound)
 968                     .map(|param| {
 969                         let span = self.tcx.def_span(param.def_id);
 970                         spans.push_span_label(span, "");
 971                         param
 972                     })
 973                     .map(|param| format!("`{}`", param.name))
 974                     .collect::<Vec<_>>()
 975                     .join(", ");
 976
 977                 format!(": {}", params)
 978             };
 979
 980             format!(
 981                 "{} defined here, with {}{} {} parameter{}{}",
 982                 def_kind,
 983                 quantifier,
 984                 bound,
 985                 self.kind(),
 986                 pluralize!(bound),
 987                 params,
 988             )
 989         };
 990
 991         err.span_note(spans, &msg);
 992     }
 993
 994     /// Add note if `impl Trait` is explicitly specified.
 995     fn note_synth_provided(&self, err: &mut Diagnostic) {
 996         if !self.is_synth_provided() {
 997             return;
 998         }
 999
1000         err.note("`impl Trait` cannot be explicitly specified as a generic argument");
1001     }
1002 }
1003
1004 impl<'tcx> StructuredDiagnostic<'tcx> for WrongNumberOfGenericArgs<'_, 'tcx> {
1005     fn session(&self) -> &Session {
1006         self.tcx.sess
1007     }
1008
1009     fn code(&self) -> DiagnosticId {
1010         rustc_errors::error_code!(E0107)
1011     }
1012
1013     fn diagnostic_common(&self) -> DiagnosticBuilder<'tcx, ErrorGuaranteed> {
1014         let mut err = self.start_diagnostics();
1015
1016         self.notify(&mut err);
1017         self.suggest(&mut err);
1018         self.show_definition(&mut err);
1019         self.note_synth_provided(&mut err);
1020
1021         err
1022     }
1023 }