crates/hir_ty/src/display.rs

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