crates/hir_ty/src/display.rs

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