crates/hir_ty/src/display.rs

   1 //! FIXME: write short doc here
   2
   3 use std::{array, fmt};
   4
   5 use chalk_ir::Mutability;
   6 use hir_def::{
   7     db::DefDatabase,
   8     find_path,
   9     generics::TypeParamProvenance,
  10     item_scope::ItemInNs,
  11     path::{GenericArg, Path, PathKind},
  12     type_ref::{TypeBound, TypeRef},
  13     visibility::Visibility,
  14     AssocContainerId, Lookup, ModuleId, TraitId,
  15 };
  16 use hir_expand::name::Name;
  17
  18 use crate::{
  19     db::HirDatabase, from_assoc_type_id, from_foreign_def_id, from_placeholder_idx, primitive,
  20     to_assoc_type_id, traits::chalk::from_chalk, utils::generics, AdtId, AliasEq, AliasTy,
  21     CallableDefId, CallableSig, DomainGoal, ImplTraitId, Interner, Lifetime, OpaqueTy,
  22     ProjectionTy, QuantifiedWhereClause, Scalar, Substitution, TraitRef, Ty, TyKind, WhereClause,
  23 };
  24
  25 pub struct HirFormatter<'a> {
  26     pub db: &'a dyn HirDatabase,
  27     fmt: &'a mut dyn fmt::Write,
  28     buf: String,
  29     curr_size: usize,
  30     pub(crate) max_size: Option<usize>,
  31     omit_verbose_types: bool,
  32     display_target: DisplayTarget,
  33 }
  34
  35 pub trait HirDisplay {
  36     fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError>;
  37
  38     /// Returns a `Display`able type that is human-readable.
  39     fn into_displayable<'a>(
  40         &'a self,
  41         db: &'a dyn HirDatabase,
  42         max_size: Option<usize>,
  43         omit_verbose_types: bool,
  44         display_target: DisplayTarget,
  45     ) -> HirDisplayWrapper<'a, Self>
  46     where
  47         Self: Sized,
  48     {
  49         HirDisplayWrapper { db, t: self, max_size, omit_verbose_types, display_target }
  50     }
  51
  52     /// Returns a `Display`able type that is human-readable.
  53     /// Use this for showing types to the user (e.g. diagnostics)
  54     fn display<'a>(&'a self, db: &'a dyn HirDatabase) -> HirDisplayWrapper<'a, Self>
  55     where
  56         Self: Sized,
  57     {
  58         HirDisplayWrapper {
  59             db,
  60             t: self,
  61             max_size: None,
  62             omit_verbose_types: false,
  63             display_target: DisplayTarget::Diagnostics,
  64         }
  65     }
  66
  67     /// Returns a `Display`able type that is human-readable and tries to be succinct.
  68     /// Use this for showing types to the user where space is constrained (e.g. doc popups)
  69     fn display_truncated<'a>(
  70         &'a self,
  71         db: &'a dyn HirDatabase,
  72         max_size: Option<usize>,
  73     ) -> HirDisplayWrapper<'a, Self>
  74     where
  75         Self: Sized,
  76     {
  77         HirDisplayWrapper {
  78             db,
  79             t: self,
  80             max_size,
  81             omit_verbose_types: true,
  82             display_target: DisplayTarget::Diagnostics,
  83         }
  84     }
  85
  86     /// Returns a String representation of `self` that can be inserted into the given module.
  87     /// Use this when generating code (e.g. assists)
  88     fn display_source_code<'a>(
  89         &'a self,
  90         db: &'a dyn HirDatabase,
  91         module_id: ModuleId,
  92     ) -> Result<String, DisplaySourceCodeError> {
  93         let mut result = String::new();
  94         match self.hir_fmt(&mut HirFormatter {
  95             db,
  96             fmt: &mut result,
  97             buf: String::with_capacity(20),
  98             curr_size: 0,
  99             max_size: None,
 100             omit_verbose_types: false,
 101             display_target: DisplayTarget::SourceCode { module_id },
 102         }) {
 103             Ok(()) => {}
 104             Err(HirDisplayError::FmtError) => panic!("Writing to String can't fail!"),
 105             Err(HirDisplayError::DisplaySourceCodeError(e)) => return Err(e),
 106         };
 107         Ok(result)
 108     }
 109
 110     /// Returns a String representation of `self` for test purposes
 111     fn display_test<'a>(&'a self, db: &'a dyn HirDatabase) -> HirDisplayWrapper<'a, Self>
 112     where
 113         Self: Sized,
 114     {
 115         HirDisplayWrapper {
 116             db,
 117             t: self,
 118             max_size: None,
 119             omit_verbose_types: false,
 120             display_target: DisplayTarget::Test,
 121         }
 122     }
 123 }
 124
 125 impl<'a> HirFormatter<'a> {
 126     pub fn write_joined<T: HirDisplay>(
 127         &mut self,
 128         iter: impl IntoIterator<Item = T>,
 129         sep: &str,
 130     ) -> Result<(), HirDisplayError> {
 131         let mut first = true;
 132         for e in iter {
 133             if !first {
 134                 write!(self, "{}", sep)?;
 135             }
 136             first = false;
 137             e.hir_fmt(self)?;
 138         }
 139         Ok(())
 140     }
 141
 142     /// This allows using the `write!` macro directly with a `HirFormatter`.
 143     pub fn write_fmt(&mut self, args: fmt::Arguments) -> Result<(), HirDisplayError> {
 144         // We write to a buffer first to track output size
 145         self.buf.clear();
 146         fmt::write(&mut self.buf, args)?;
 147         self.curr_size += self.buf.len();
 148
 149         // Then we write to the internal formatter from the buffer
 150         self.fmt.write_str(&self.buf).map_err(HirDisplayError::from)
 151     }
 152
 153     pub fn should_truncate(&self) -> bool {
 154         if let Some(max_size) = self.max_size {
 155             self.curr_size >= max_size
 156         } else {
 157             false
 158         }
 159     }
 160
 161     pub fn omit_verbose_types(&self) -> bool {
 162         self.omit_verbose_types
 163     }
 164 }
 165
 166 #[derive(Clone, Copy)]
 167 pub enum DisplayTarget {
 168     /// Display types for inlays, doc popups, autocompletion, etc...
 169     /// Showing `{unknown}` or not qualifying paths is fine here.
 170     /// There's no reason for this to fail.
 171     Diagnostics,
 172     /// Display types for inserting them in source files.
 173     /// The generated code should compile, so paths need to be qualified.
 174     SourceCode { module_id: ModuleId },
 175     /// Only for test purpose to keep real types
 176     Test,
 177 }
 178
 179 impl DisplayTarget {
 180     fn is_source_code(&self) -> bool {
 181         matches!(self, Self::SourceCode { .. })
 182     }
 183     fn is_test(&self) -> bool {
 184         matches!(self, Self::Test)
 185     }
 186 }
 187
 188 #[derive(Debug)]
 189 pub enum DisplaySourceCodeError {
 190     PathNotFound,
 191     UnknownType,
 192     Closure,
 193 }
 194
 195 pub enum HirDisplayError {
 196     /// Errors that can occur when generating source code
 197     DisplaySourceCodeError(DisplaySourceCodeError),
 198     /// `FmtError` is required to be compatible with std::fmt::Display
 199     FmtError,
 200 }
 201 impl From<fmt::Error> for HirDisplayError {
 202     fn from(_: fmt::Error) -> Self {
 203         Self::FmtError
 204     }
 205 }
 206
 207 pub struct HirDisplayWrapper<'a, T> {
 208     db: &'a dyn HirDatabase,
 209     t: &'a T,
 210     max_size: Option<usize>,
 211     omit_verbose_types: bool,
 212     display_target: DisplayTarget,
 213 }
 214
 215 impl<'a, T> fmt::Display for HirDisplayWrapper<'a, T>
 216 where
 217     T: HirDisplay,
 218 {
 219     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 220         match self.t.hir_fmt(&mut HirFormatter {
 221             db: self.db,
 222             fmt: f,
 223             buf: String::with_capacity(20),
 224             curr_size: 0,
 225             max_size: self.max_size,
 226             omit_verbose_types: self.omit_verbose_types,
 227             display_target: self.display_target,
 228         }) {
 229             Ok(()) => Ok(()),
 230             Err(HirDisplayError::FmtError) => Err(fmt::Error),
 231             Err(HirDisplayError::DisplaySourceCodeError(_)) => {
 232                 // This should never happen
 233                 panic!("HirDisplay failed when calling Display::fmt!")
 234             }
 235         }
 236     }
 237 }
 238
 239 const TYPE_HINT_TRUNCATION: &str = "…";
 240
 241 impl<T: HirDisplay> HirDisplay for &'_ T {
 242     fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
 243         HirDisplay::hir_fmt(*self, f)
 244     }
 245 }
 246
 247 impl HirDisplay for ProjectionTy {
 248     fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
 249         if f.should_truncate() {
 250             return write!(f, "{}", TYPE_HINT_TRUNCATION);
 251         }
 252
 253         let trait_ = f.db.trait_data(self.trait_(f.db));
 254         let first_parameter = self.substitution[0].into_displayable(
 255             f.db,
 256             f.max_size,
 257             f.omit_verbose_types,
 258             f.display_target,
 259         );
 260         write!(f, "<{} as {}", first_parameter, trait_.name)?;
 261         if self.substitution.len() > 1 {
 262             write!(f, "<")?;
 263             f.write_joined(&self.substitution[1..], ", ")?;
 264             write!(f, ">")?;
 265         }
 266         write!(f, ">::{}", f.db.type_alias_data(from_assoc_type_id(self.associated_ty_id)).name)?;
 267         Ok(())
 268     }
 269 }
 270
 271 impl HirDisplay for OpaqueTy {
 272     fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
 273         if f.should_truncate() {
 274             return write!(f, "{}", TYPE_HINT_TRUNCATION);
 275         }
 276
 277         self.substitution[0].hir_fmt(f)
 278     }
 279 }
 280
 281 impl HirDisplay for Ty {
 282     fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
 283         if f.should_truncate() {
 284             return write!(f, "{}", TYPE_HINT_TRUNCATION);
 285         }
 286
 287         match self.interned(&Interner) {
 288             TyKind::Never => write!(f, "!")?,
 289             TyKind::Str => write!(f, "str")?,
 290             TyKind::Scalar(Scalar::Bool) => write!(f, "bool")?,
 291             TyKind::Scalar(Scalar::Char) => write!(f, "char")?,
 292             &TyKind::Scalar(Scalar::Float(t)) => write!(f, "{}", primitive::float_ty_to_string(t))?,
 293             &TyKind::Scalar(Scalar::Int(t)) => write!(f, "{}", primitive::int_ty_to_string(t))?,
 294             &TyKind::Scalar(Scalar::Uint(t)) => write!(f, "{}", primitive::uint_ty_to_string(t))?,
 295             TyKind::Slice(t) => {
 296                 write!(f, "[")?;
 297                 t.hir_fmt(f)?;
 298                 write!(f, "]")?;
 299             }
 300             TyKind::Array(t) => {
 301                 write!(f, "[")?;
 302                 t.hir_fmt(f)?;
 303                 write!(f, "; _]")?;
 304             }
 305             TyKind::Raw(m, t) | TyKind::Ref(m, t) => {
 306                 let ty_display =
 307                     t.into_displayable(f.db, f.max_size, f.omit_verbose_types, f.display_target);
 308
 309                 if matches!(self.interned(&Interner), TyKind::Raw(..)) {
 310                     write!(
 311                         f,
 312                         "*{}",
 313                         match m {
 314                             Mutability::Not => "const ",
 315                             Mutability::Mut => "mut ",
 316                         }
 317                     )?;
 318                 } else {
 319                     write!(
 320                         f,
 321                         "&{}",
 322                         match m {
 323                             Mutability::Not => "",
 324                             Mutability::Mut => "mut ",
 325                         }
 326                     )?;
 327                 }
 328
 329                 // FIXME: all this just to decide whether to use parentheses...
 330                 let datas;
 331                 let predicates: Vec<_> = match t.interned(&Interner) {
 332                     TyKind::Dyn(dyn_ty) if dyn_ty.bounds.skip_binders().interned().len() > 1 => {
 333                         dyn_ty.bounds.skip_binders().interned().iter().cloned().collect()
 334                     }
 335                     &TyKind::Alias(AliasTy::Opaque(OpaqueTy {
 336                         opaque_ty_id,
 337                         substitution: ref parameters,
 338                     })) => {
 339                         let impl_trait_id = f.db.lookup_intern_impl_trait_id(opaque_ty_id.into());
 340                         if let ImplTraitId::ReturnTypeImplTrait(func, idx) = impl_trait_id {
 341                             datas =
 342                                 f.db.return_type_impl_traits(func)
 343                                     .expect("impl trait id without data");
 344                             let data = (*datas)
 345                                 .as_ref()
 346                                 .map(|rpit| rpit.impl_traits[idx as usize].bounds.clone());
 347                             let bounds = data.subst(parameters);
 348                             bounds.value
 349                         } else {
 350                             Vec::new()
 351                         }
 352                     }
 353                     _ => Vec::new(),
 354                 };
 355
 356                 if let Some(WhereClause::Implemented(trait_ref)) =
 357                     predicates.get(0).map(|b| b.skip_binders())
 358                 {
 359                     let trait_ = trait_ref.hir_trait_id();
 360                     if fn_traits(f.db.upcast(), trait_).any(|it| it == trait_)
 361                         && predicates.len() <= 2
 362                     {
 363                         return write!(f, "{}", ty_display);
 364                     }
 365                 }
 366
 367                 if predicates.len() > 1 {
 368                     write!(f, "(")?;
 369                     write!(f, "{}", ty_display)?;
 370                     write!(f, ")")?;
 371                 } else {
 372                     write!(f, "{}", ty_display)?;
 373                 }
 374             }
 375             TyKind::Tuple(_, substs) => {
 376                 if substs.len() == 1 {
 377                     write!(f, "(")?;
 378                     substs[0].hir_fmt(f)?;
 379                     write!(f, ",)")?;
 380                 } else {
 381                     write!(f, "(")?;
 382                     f.write_joined(&*substs.0, ", ")?;
 383                     write!(f, ")")?;
 384                 }
 385             }
 386             TyKind::Function(fn_ptr) => {
 387                 let sig = CallableSig::from_fn_ptr(fn_ptr);
 388                 sig.hir_fmt(f)?;
 389             }
 390             TyKind::FnDef(def, parameters) => {
 391                 let def = from_chalk(f.db, *def);
 392                 let sig = f.db.callable_item_signature(def).subst(parameters);
 393                 match def {
 394                     CallableDefId::FunctionId(ff) => {
 395                         write!(f, "fn {}", f.db.function_data(ff).name)?
 396                     }
 397                     CallableDefId::StructId(s) => write!(f, "{}", f.db.struct_data(s).name)?,
 398                     CallableDefId::EnumVariantId(e) => {
 399                         write!(f, "{}", f.db.enum_data(e.parent).variants[e.local_id].name)?
 400                     }
 401                 };
 402                 if parameters.len() > 0 {
 403                     let generics = generics(f.db.upcast(), def.into());
 404                     let (parent_params, self_param, type_params, _impl_trait_params) =
 405                         generics.provenance_split();
 406                     let total_len = parent_params + self_param + type_params;
 407                     // We print all params except implicit impl Trait params. Still a bit weird; should we leave out parent and self?
 408                     if total_len > 0 {
 409                         write!(f, "<")?;
 410                         f.write_joined(&parameters.0[..total_len], ", ")?;
 411                         write!(f, ">")?;
 412                     }
 413                 }
 414                 write!(f, "(")?;
 415                 f.write_joined(sig.params(), ", ")?;
 416                 write!(f, ")")?;
 417                 let ret = sig.ret();
 418                 if *ret != Ty::unit() {
 419                     let ret_display = ret.into_displayable(
 420                         f.db,
 421                         f.max_size,
 422                         f.omit_verbose_types,
 423                         f.display_target,
 424                     );
 425
 426                     write!(f, " -> {}", ret_display)?;
 427                 }
 428             }
 429             TyKind::Adt(AdtId(def_id), parameters) => {
 430                 match f.display_target {
 431                     DisplayTarget::Diagnostics | DisplayTarget::Test => {
 432                         let name = match *def_id {
 433                             hir_def::AdtId::StructId(it) => f.db.struct_data(it).name.clone(),
 434                             hir_def::AdtId::UnionId(it) => f.db.union_data(it).name.clone(),
 435                             hir_def::AdtId::EnumId(it) => f.db.enum_data(it).name.clone(),
 436                         };
 437                         write!(f, "{}", name)?;
 438                     }
 439                     DisplayTarget::SourceCode { module_id } => {
 440                         if let Some(path) = find_path::find_path(
 441                             f.db.upcast(),
 442                             ItemInNs::Types((*def_id).into()),
 443                             module_id,
 444                         ) {
 445                             write!(f, "{}", path)?;
 446                         } else {
 447                             return Err(HirDisplayError::DisplaySourceCodeError(
 448                                 DisplaySourceCodeError::PathNotFound,
 449                             ));
 450                         }
 451                     }
 452                 }
 453
 454                 if parameters.len() > 0 {
 455                     let parameters_to_write = if f.display_target.is_source_code()
 456                         || f.omit_verbose_types()
 457                     {
 458                         match self
 459                             .as_generic_def(f.db)
 460                             .map(|generic_def_id| f.db.generic_defaults(generic_def_id))
 461                             .filter(|defaults| !defaults.is_empty())
 462                         {
 463                             None => parameters.0.as_ref(),
 464                             Some(default_parameters) => {
 465                                 let mut default_from = 0;
 466                                 for (i, parameter) in parameters.iter().enumerate() {
 467                                     match (parameter.interned(&Interner), default_parameters.get(i))
 468                                     {
 469                                         (&TyKind::Unknown, _) | (_, None) => {
 470                                             default_from = i + 1;
 471                                         }
 472                                         (_, Some(default_parameter)) => {
 473                                             let actual_default = default_parameter
 474                                                 .clone()
 475                                                 .subst(&parameters.prefix(i));
 476                                             if parameter != &actual_default {
 477                                                 default_from = i + 1;
 478                                             }
 479                                         }
 480                                     }
 481                                 }
 482                                 &parameters.0[0..default_from]
 483                             }
 484                         }
 485                     } else {
 486                         parameters.0.as_ref()
 487                     };
 488                     if !parameters_to_write.is_empty() {
 489                         write!(f, "<")?;
 490                         f.write_joined(parameters_to_write, ", ")?;
 491                         write!(f, ">")?;
 492                     }
 493                 }
 494             }
 495             TyKind::AssociatedType(assoc_type_id, parameters) => {
 496                 let type_alias = from_assoc_type_id(*assoc_type_id);
 497                 let trait_ = match type_alias.lookup(f.db.upcast()).container {
 498                     AssocContainerId::TraitId(it) => it,
 499                     _ => panic!("not an associated type"),
 500                 };
 501                 let trait_ = f.db.trait_data(trait_);
 502                 let type_alias_data = f.db.type_alias_data(type_alias);
 503
 504                 // Use placeholder associated types when the target is test (https://rust-lang.github.io/chalk/book/clauses/type_equality.html#placeholder-associated-types)
 505                 if f.display_target.is_test() {
 506                     write!(f, "{}::{}", trait_.name, type_alias_data.name)?;
 507                     if parameters.len() > 0 {
 508                         write!(f, "<")?;
 509                         f.write_joined(&*parameters.0, ", ")?;
 510                         write!(f, ">")?;
 511                     }
 512                 } else {
 513                     let projection_ty = ProjectionTy {
 514                         associated_ty_id: to_assoc_type_id(type_alias),
 515                         substitution: parameters.clone(),
 516                     };
 517
 518                     projection_ty.hir_fmt(f)?;
 519                 }
 520             }
 521             TyKind::ForeignType(type_alias) => {
 522                 let type_alias = f.db.type_alias_data(from_foreign_def_id(*type_alias));
 523                 write!(f, "{}", type_alias.name)?;
 524             }
 525             TyKind::OpaqueType(opaque_ty_id, parameters) => {
 526                 let impl_trait_id = f.db.lookup_intern_impl_trait_id((*opaque_ty_id).into());
 527                 match impl_trait_id {
 528                     ImplTraitId::ReturnTypeImplTrait(func, idx) => {
 529                         let datas =
 530                             f.db.return_type_impl_traits(func).expect("impl trait id without data");
 531                         let data = (*datas)
 532                             .as_ref()
 533                             .map(|rpit| rpit.impl_traits[idx as usize].bounds.clone());
 534                         let bounds = data.subst(&parameters);
 535                         write_bounds_like_dyn_trait_with_prefix("impl", &bounds.value, f)?;
 536                         // FIXME: it would maybe be good to distinguish this from the alias type (when debug printing), and to show the substitution
 537                     }
 538                     ImplTraitId::AsyncBlockTypeImplTrait(..) => {
 539                         write!(f, "impl Future<Output = ")?;
 540                         parameters[0].hir_fmt(f)?;
 541                         write!(f, ">")?;
 542                     }
 543                 }
 544             }
 545             TyKind::Closure(.., substs) => {
 546                 if f.display_target.is_source_code() {
 547                     return Err(HirDisplayError::DisplaySourceCodeError(
 548                         DisplaySourceCodeError::Closure,
 549                     ));
 550                 }
 551                 let sig = substs[0].callable_sig(f.db);
 552                 if let Some(sig) = sig {
 553                     if sig.params().is_empty() {
 554                         write!(f, "||")?;
 555                     } else if f.omit_verbose_types() {
 556                         write!(f, "|{}|", TYPE_HINT_TRUNCATION)?;
 557                     } else {
 558                         write!(f, "|")?;
 559                         f.write_joined(sig.params(), ", ")?;
 560                         write!(f, "|")?;
 561                     };
 562
 563                     let ret_display = sig.ret().into_displayable(
 564                         f.db,
 565                         f.max_size,
 566                         f.omit_verbose_types,
 567                         f.display_target,
 568                     );
 569                     write!(f, " -> {}", ret_display)?;
 570                 } else {
 571                     write!(f, "{{closure}}")?;
 572                 }
 573             }
 574             TyKind::Placeholder(idx) => {
 575                 let id = from_placeholder_idx(f.db, *idx);
 576                 let generics = generics(f.db.upcast(), id.parent);
 577                 let param_data = &generics.params.types[id.local_id];
 578                 match param_data.provenance {
 579                     TypeParamProvenance::TypeParamList | TypeParamProvenance::TraitSelf => {
 580                         write!(f, "{}", param_data.name.clone().unwrap_or_else(Name::missing))?
 581                     }
 582                     TypeParamProvenance::ArgumentImplTrait => {
 583                         let substs = Substitution::type_params_for_generics(f.db, &generics);
 584                         let bounds = f
 585                             .db
 586                             .generic_predicates(id.parent)
 587                             .into_iter()
 588                             .map(|pred| pred.clone().subst(&substs))
 589                             .filter(|wc| match &wc.skip_binders() {
 590                                 WhereClause::Implemented(tr) => tr.self_type_parameter() == self,
 591                                 WhereClause::AliasEq(AliasEq {
 592                                     alias: AliasTy::Projection(proj),
 593                                     ty: _,
 594                                 }) => proj.self_type_parameter() == self,
 595                                 _ => false,
 596                             })
 597                             .collect::<Vec<_>>();
 598                         write_bounds_like_dyn_trait_with_prefix("impl", &bounds, f)?;
 599                     }
 600                 }
 601             }
 602             TyKind::BoundVar(idx) => write!(f, "?{}.{}", idx.debruijn.depth(), idx.index)?,
 603             TyKind::Dyn(dyn_ty) => {
 604                 write_bounds_like_dyn_trait_with_prefix(
 605                     "dyn",
 606                     dyn_ty.bounds.skip_binders().interned(),
 607                     f,
 608                 )?;
 609             }
 610             TyKind::Alias(AliasTy::Projection(p_ty)) => p_ty.hir_fmt(f)?,
 611             TyKind::Alias(AliasTy::Opaque(opaque_ty)) => {
 612                 let impl_trait_id = f.db.lookup_intern_impl_trait_id(opaque_ty.opaque_ty_id.into());
 613                 match impl_trait_id {
 614                     ImplTraitId::ReturnTypeImplTrait(func, idx) => {
 615                         let datas =
 616                             f.db.return_type_impl_traits(func).expect("impl trait id without data");
 617                         let data = (*datas)
 618                             .as_ref()
 619                             .map(|rpit| rpit.impl_traits[idx as usize].bounds.clone());
 620                         let bounds = data.subst(&opaque_ty.substitution);
 621                         write_bounds_like_dyn_trait_with_prefix("impl", &bounds.value, f)?;
 622                     }
 623                     ImplTraitId::AsyncBlockTypeImplTrait(..) => {
 624                         write!(f, "{{async block}}")?;
 625                     }
 626                 };
 627             }
 628             TyKind::Unknown => {
 629                 if f.display_target.is_source_code() {
 630                     return Err(HirDisplayError::DisplaySourceCodeError(
 631                         DisplaySourceCodeError::UnknownType,
 632                     ));
 633                 }
 634                 write!(f, "{{unknown}}")?;
 635             }
 636             TyKind::InferenceVar(..) => write!(f, "_")?,
 637         }
 638         Ok(())
 639     }
 640 }
 641
 642 impl HirDisplay for CallableSig {
 643     fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
 644         write!(f, "fn(")?;
 645         f.write_joined(self.params(), ", ")?;
 646         if self.is_varargs {
 647             if self.params().is_empty() {
 648                 write!(f, "...")?;
 649             } else {
 650                 write!(f, ", ...")?;
 651             }
 652         }
 653         write!(f, ")")?;
 654         let ret = self.ret();
 655         if *ret != Ty::unit() {
 656             let ret_display =
 657                 ret.into_displayable(f.db, f.max_size, f.omit_verbose_types, f.display_target);
 658             write!(f, " -> {}", ret_display)?;
 659         }
 660         Ok(())
 661     }
 662 }
 663
 664 fn fn_traits(db: &dyn DefDatabase, trait_: TraitId) -> impl Iterator<Item = TraitId> {
 665     let krate = trait_.lookup(db).container.krate();
 666     let fn_traits = [
 667         db.lang_item(krate, "fn".into()),
 668         db.lang_item(krate, "fn_mut".into()),
 669         db.lang_item(krate, "fn_once".into()),
 670     ];
 671     array::IntoIter::new(fn_traits).into_iter().flatten().flat_map(|it| it.as_trait())
 672 }
 673
 674 pub fn write_bounds_like_dyn_trait_with_prefix(
 675     prefix: &str,
 676     predicates: &[QuantifiedWhereClause],
 677     f: &mut HirFormatter,
 678 ) -> Result<(), HirDisplayError> {
 679     write!(f, "{}", prefix)?;
 680     if !predicates.is_empty() {
 681         write!(f, " ")?;
 682         write_bounds_like_dyn_trait(predicates, f)
 683     } else {
 684         Ok(())
 685     }
 686 }
 687
 688 fn write_bounds_like_dyn_trait(
 689     predicates: &[QuantifiedWhereClause],
 690     f: &mut HirFormatter,
 691 ) -> Result<(), HirDisplayError> {
 692     // Note: This code is written to produce nice results (i.e.
 693     // corresponding to surface Rust) for types that can occur in
 694     // actual Rust. It will have weird results if the predicates
 695     // aren't as expected (i.e. self types = $0, projection
 696     // predicates for a certain trait come after the Implemented
 697     // predicate for that trait).
 698     let mut first = true;
 699     let mut angle_open = false;
 700     let mut is_fn_trait = false;
 701     for p in predicates.iter() {
 702         match p.skip_binders() {
 703             WhereClause::Implemented(trait_ref) => {
 704                 let trait_ = trait_ref.hir_trait_id();
 705                 if !is_fn_trait {
 706                     is_fn_trait = fn_traits(f.db.upcast(), trait_).any(|it| it == trait_);
 707                 }
 708                 if !is_fn_trait && angle_open {
 709                     write!(f, ">")?;
 710                     angle_open = false;
 711                 }
 712                 if !first {
 713                     write!(f, " + ")?;
 714                 }
 715                 // We assume that the self type is $0 (i.e. the
 716                 // existential) here, which is the only thing that's
 717                 // possible in actual Rust, and hence don't print it
 718                 write!(f, "{}", f.db.trait_data(trait_).name)?;
 719                 if let [_, params @ ..] = &*trait_ref.substitution.0 {
 720                     if is_fn_trait {
 721                         if let Some(args) = params.first().and_then(|it| it.as_tuple()) {
 722                             write!(f, "(")?;
 723                             f.write_joined(&*args.0, ", ")?;
 724                             write!(f, ")")?;
 725                         }
 726                     } else if !params.is_empty() {
 727                         write!(f, "<")?;
 728                         f.write_joined(params, ", ")?;
 729                         // there might be assoc type bindings, so we leave the angle brackets open
 730                         angle_open = true;
 731                     }
 732                 }
 733             }
 734             WhereClause::AliasEq(alias_eq) if is_fn_trait => {
 735                 is_fn_trait = false;
 736                 write!(f, " -> ")?;
 737                 alias_eq.ty.hir_fmt(f)?;
 738             }
 739             WhereClause::AliasEq(AliasEq { ty, alias }) => {
 740                 // in types in actual Rust, these will always come
 741                 // after the corresponding Implemented predicate
 742                 if angle_open {
 743                     write!(f, ", ")?;
 744                 } else {
 745                     write!(f, "<")?;
 746                     angle_open = true;
 747                 }
 748                 if let AliasTy::Projection(proj) = alias {
 749                     let type_alias =
 750                         f.db.type_alias_data(from_assoc_type_id(proj.associated_ty_id));
 751                     write!(f, "{} = ", type_alias.name)?;
 752                 }
 753                 ty.hir_fmt(f)?;
 754             }
 755         }
 756         first = false;
 757     }
 758     if angle_open {
 759         write!(f, ">")?;
 760     }
 761     Ok(())
 762 }
 763
 764 impl TraitRef {
 765     fn hir_fmt_ext(&self, f: &mut HirFormatter, use_as: bool) -> Result<(), HirDisplayError> {
 766         if f.should_truncate() {
 767             return write!(f, "{}", TYPE_HINT_TRUNCATION);
 768         }
 769
 770         self.substitution[0].hir_fmt(f)?;
 771         if use_as {
 772             write!(f, " as ")?;
 773         } else {
 774             write!(f, ": ")?;
 775         }
 776         write!(f, "{}", f.db.trait_data(self.hir_trait_id()).name)?;
 777         if self.substitution.len() > 1 {
 778             write!(f, "<")?;
 779             f.write_joined(&self.substitution[1..], ", ")?;
 780             write!(f, ">")?;
 781         }
 782         Ok(())
 783     }
 784 }
 785
 786 impl HirDisplay for TraitRef {
 787     fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
 788         self.hir_fmt_ext(f, false)
 789     }
 790 }
 791
 792 impl HirDisplay for WhereClause {
 793     fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
 794         if f.should_truncate() {
 795             return write!(f, "{}", TYPE_HINT_TRUNCATION);
 796         }
 797
 798         match self {
 799             WhereClause::Implemented(trait_ref) => trait_ref.hir_fmt(f)?,
 800             WhereClause::AliasEq(AliasEq { alias: AliasTy::Projection(projection_ty), ty }) => {
 801                 write!(f, "<")?;
 802                 projection_ty.trait_ref(f.db).hir_fmt_ext(f, true)?;
 803                 write!(
 804                     f,
 805                     ">::{} = ",
 806                     f.db.type_alias_data(from_assoc_type_id(projection_ty.associated_ty_id)).name,
 807                 )?;
 808                 ty.hir_fmt(f)?;
 809             }
 810             WhereClause::AliasEq(_) => write!(f, "{{error}}")?,
 811         }
 812         Ok(())
 813     }
 814 }
 815
 816 impl HirDisplay for Lifetime {
 817     fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
 818         match self {
 819             Lifetime::Parameter(id) => {
 820                 let generics = generics(f.db.upcast(), id.parent);
 821                 let param_data = &generics.params.lifetimes[id.local_id];
 822                 write!(f, "{}", &param_data.name)
 823             }
 824             Lifetime::Static => write!(f, "'static"),
 825         }
 826     }
 827 }
 828
 829 impl HirDisplay for DomainGoal {
 830     fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
 831         match self {
 832             DomainGoal::Holds(wc) => {
 833                 write!(f, "Holds(")?;
 834                 wc.hir_fmt(f)?;
 835                 write!(f, ")")
 836             }
 837         }
 838     }
 839 }
 840
 841 pub fn write_visibility(
 842     module_id: ModuleId,
 843     vis: Visibility,
 844     f: &mut HirFormatter,
 845 ) -> Result<(), HirDisplayError> {
 846     match vis {
 847         Visibility::Public => write!(f, "pub "),
 848         Visibility::Module(vis_id) => {
 849             let def_map = module_id.def_map(f.db.upcast());
 850             let root_module_id = def_map.module_id(def_map.root());
 851             if vis_id == module_id {
 852                 // pub(self) or omitted
 853                 Ok(())
 854             } else if root_module_id == vis_id {
 855                 write!(f, "pub(crate) ")
 856             } else if module_id.containing_module(f.db.upcast()) == Some(vis_id) {
 857                 write!(f, "pub(super) ")
 858             } else {
 859                 write!(f, "pub(in ...) ")
 860             }
 861         }
 862     }
 863 }
 864
 865 impl HirDisplay for TypeRef {
 866     fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
 867         match self {
 868             TypeRef::Never => write!(f, "!")?,
 869             TypeRef::Placeholder => write!(f, "_")?,
 870             TypeRef::Tuple(elems) => {
 871                 write!(f, "(")?;
 872                 f.write_joined(elems, ", ")?;
 873                 if elems.len() == 1 {
 874                     write!(f, ",")?;
 875                 }
 876                 write!(f, ")")?;
 877             }
 878             TypeRef::Path(path) => path.hir_fmt(f)?,
 879             TypeRef::RawPtr(inner, mutability) => {
 880                 let mutability = match mutability {
 881                     hir_def::type_ref::Mutability::Shared => "*const ",
 882                     hir_def::type_ref::Mutability::Mut => "*mut ",
 883                 };
 884                 write!(f, "{}", mutability)?;
 885                 inner.hir_fmt(f)?;
 886             }
 887             TypeRef::Reference(inner, lifetime, mutability) => {
 888                 let mutability = match mutability {
 889                     hir_def::type_ref::Mutability::Shared => "",
 890                     hir_def::type_ref::Mutability::Mut => "mut ",
 891                 };
 892                 write!(f, "&")?;
 893                 if let Some(lifetime) = lifetime {
 894                     write!(f, "{} ", lifetime.name)?;
 895                 }
 896                 write!(f, "{}", mutability)?;
 897                 inner.hir_fmt(f)?;
 898             }
 899             TypeRef::Array(inner) => {
 900                 write!(f, "[")?;
 901                 inner.hir_fmt(f)?;
 902                 // FIXME: Array length?
 903                 write!(f, "; _]")?;
 904             }
 905             TypeRef::Slice(inner) => {
 906                 write!(f, "[")?;
 907                 inner.hir_fmt(f)?;
 908                 write!(f, "]")?;
 909             }
 910             TypeRef::Fn(tys, is_varargs) => {
 911                 // FIXME: Function pointer qualifiers.
 912                 write!(f, "fn(")?;
 913                 f.write_joined(&tys[..tys.len() - 1], ", ")?;
 914                 if *is_varargs {
 915                     write!(f, "{}...", if tys.len() == 1 { "" } else { ", " })?;
 916                 }
 917                 write!(f, ")")?;
 918                 let ret_ty = tys.last().unwrap();
 919                 match ret_ty {
 920                     TypeRef::Tuple(tup) if tup.is_empty() => {}
 921                     _ => {
 922                         write!(f, " -> ")?;
 923                         ret_ty.hir_fmt(f)?;
 924                     }
 925                 }
 926             }
 927             TypeRef::ImplTrait(bounds) => {
 928                 write!(f, "impl ")?;
 929                 f.write_joined(bounds, " + ")?;
 930             }
 931             TypeRef::DynTrait(bounds) => {
 932                 write!(f, "dyn ")?;
 933                 f.write_joined(bounds, " + ")?;
 934             }
 935             TypeRef::Error => write!(f, "{{error}}")?,
 936         }
 937         Ok(())
 938     }
 939 }
 940
 941 impl HirDisplay for TypeBound {
 942     fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
 943         match self {
 944             TypeBound::Path(path) => path.hir_fmt(f),
 945             TypeBound::Lifetime(lifetime) => write!(f, "{}", lifetime.name),
 946             TypeBound::Error => write!(f, "{{error}}"),
 947         }
 948     }
 949 }
 950
 951 impl HirDisplay for Path {
 952     fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
 953         match (self.type_anchor(), self.kind()) {
 954             (Some(anchor), _) => {
 955                 write!(f, "<")?;
 956                 anchor.hir_fmt(f)?;
 957                 write!(f, ">")?;
 958             }
 959             (_, PathKind::Plain) => {}
 960             (_, PathKind::Abs) => write!(f, "::")?,
 961             (_, PathKind::Crate) => write!(f, "crate")?,
 962             (_, PathKind::Super(0)) => write!(f, "self")?,
 963             (_, PathKind::Super(n)) => {
 964                 write!(f, "super")?;
 965                 for _ in 0..*n {
 966                     write!(f, "::super")?;
 967                 }
 968             }
 969             (_, PathKind::DollarCrate(_)) => write!(f, "{{extern_crate}}")?,
 970         }
 971
 972         for (seg_idx, segment) in self.segments().iter().enumerate() {
 973             if seg_idx != 0 {
 974                 write!(f, "::")?;
 975             }
 976             write!(f, "{}", segment.name)?;
 977             if let Some(generic_args) = segment.args_and_bindings {
 978                 // We should be in type context, so format as `Foo<Bar>` instead of `Foo::<Bar>`.
 979                 // Do we actually format expressions?
 980                 write!(f, "<")?;
 981                 let mut first = true;
 982                 for arg in &generic_args.args {
 983                     if first {
 984                         first = false;
 985                         if generic_args.has_self_type {
 986                             // FIXME: Convert to `<Ty as Trait>` form.
 987                             write!(f, "Self = ")?;
 988                         }
 989                     } else {
 990                         write!(f, ", ")?;
 991                     }
 992                     arg.hir_fmt(f)?;
 993                 }
 994                 for binding in &generic_args.bindings {
 995                     if first {
 996                         first = false;
 997                     } else {
 998                         write!(f, ", ")?;
 999                     }
1000                     write!(f, "{}", binding.name)?;
1001                     match &binding.type_ref {
1002                         Some(ty) => {
1003                             write!(f, " = ")?;
1004                             ty.hir_fmt(f)?
1005                         }
1006                         None => {
1007                             write!(f, ": ")?;
1008                             f.write_joined(&binding.bounds, " + ")?;
1009                         }
1010                     }
1011                 }
1012                 write!(f, ">")?;
1013             }
1014         }
1015         Ok(())
1016     }
1017 }
1018
1019 impl HirDisplay for GenericArg {
1020     fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
1021         match self {
1022             GenericArg::Type(ty) => ty.hir_fmt(f),
1023             GenericArg::Lifetime(lifetime) => write!(f, "{}", lifetime.name),
1024         }
1025     }
1026 }