crates/hir_def/src/type_ref.rs

   1 //! HIR for references to types. Paths in these are not yet resolved. They can
   2 //! be directly created from an ast::TypeRef, without further queries.
   3
   4 use hir_expand::{name::Name, AstId, InFile};
   5 use std::convert::TryInto;
   6 use syntax::ast;
   7
   8 use crate::{body::LowerCtx, intern::Interned, path::Path};
   9
  10 #[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
  11 pub enum Mutability {
  12     Shared,
  13     Mut,
  14 }
  15
  16 impl Mutability {
  17     pub fn from_mutable(mutable: bool) -> Mutability {
  18         if mutable {
  19             Mutability::Mut
  20         } else {
  21             Mutability::Shared
  22         }
  23     }
  24
  25     pub fn as_keyword_for_ref(self) -> &'static str {
  26         match self {
  27             Mutability::Shared => "",
  28             Mutability::Mut => "mut ",
  29         }
  30     }
  31
  32     pub fn as_keyword_for_ptr(self) -> &'static str {
  33         match self {
  34             Mutability::Shared => "const ",
  35             Mutability::Mut => "mut ",
  36         }
  37     }
  38 }
  39
  40 #[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
  41 pub enum Rawness {
  42     RawPtr,
  43     Ref,
  44 }
  45
  46 impl Rawness {
  47     pub fn from_raw(is_raw: bool) -> Rawness {
  48         if is_raw {
  49             Rawness::RawPtr
  50         } else {
  51             Rawness::Ref
  52         }
  53     }
  54 }
  55
  56 #[derive(Clone, PartialEq, Eq, Hash, Debug)]
  57 pub struct TraitRef {
  58     pub path: Path,
  59 }
  60
  61 impl TraitRef {
  62     /// Converts an `ast::PathType` to a `hir::TraitRef`.
  63     pub(crate) fn from_ast(ctx: &LowerCtx, node: ast::Type) -> Option<Self> {
  64         // FIXME: Use `Path::from_src`
  65         match node {
  66             ast::Type::PathType(path) => {
  67                 path.path().and_then(|it| ctx.lower_path(it)).map(|path| TraitRef { path })
  68             }
  69             _ => None,
  70         }
  71     }
  72 }
  73
  74 /// Compare ty::Ty
  75 ///
  76 /// Note: Most users of `TypeRef` that end up in the salsa database intern it using
  77 /// `Interned<TypeRef>` to save space. But notably, nested `TypeRef`s are not interned, since that
  78 /// does not seem to save any noticeable amount of memory.
  79 #[derive(Clone, PartialEq, Eq, Hash, Debug)]
  80 pub enum TypeRef {
  81     Never,
  82     Placeholder,
  83     Tuple(Vec<TypeRef>),
  84     Path(Path),
  85     RawPtr(Box<TypeRef>, Mutability),
  86     Reference(Box<TypeRef>, Option<LifetimeRef>, Mutability),
  87     // FIXME: for full const generics, the latter element (length) here is going to have to be an
  88     // expression that is further lowered later in hir_ty.
  89     Array(Box<TypeRef>, ConstScalar),
  90     Slice(Box<TypeRef>),
  91     /// A fn pointer. Last element of the vector is the return type.
  92     Fn(Vec<TypeRef>, bool /*varargs*/),
  93     // For
  94     ImplTrait(Vec<Interned<TypeBound>>),
  95     DynTrait(Vec<Interned<TypeBound>>),
  96     Macro(AstId<ast::MacroCall>),
  97     Error,
  98 }
  99
 100 #[derive(Clone, PartialEq, Eq, Hash, Debug)]
 101 pub struct LifetimeRef {
 102     pub name: Name,
 103 }
 104
 105 impl LifetimeRef {
 106     pub(crate) fn new_name(name: Name) -> Self {
 107         LifetimeRef { name }
 108     }
 109
 110     pub(crate) fn new(lifetime: &ast::Lifetime) -> Self {
 111         LifetimeRef { name: Name::new_lifetime(lifetime) }
 112     }
 113
 114     pub fn missing() -> LifetimeRef {
 115         LifetimeRef { name: Name::missing() }
 116     }
 117 }
 118
 119 #[derive(Clone, PartialEq, Eq, Hash, Debug)]
 120 pub enum TypeBound {
 121     Path(Path),
 122     ForLifetime(Box<[Name]>, Path),
 123     Lifetime(LifetimeRef),
 124     Error,
 125 }
 126
 127 impl TypeRef {
 128     /// Converts an `ast::TypeRef` to a `hir::TypeRef`.
 129     pub fn from_ast(ctx: &LowerCtx, node: ast::Type) -> Self {
 130         match node {
 131             ast::Type::ParenType(inner) => TypeRef::from_ast_opt(ctx, inner.ty()),
 132             ast::Type::TupleType(inner) => {
 133                 TypeRef::Tuple(inner.fields().map(|it| TypeRef::from_ast(ctx, it)).collect())
 134             }
 135             ast::Type::NeverType(..) => TypeRef::Never,
 136             ast::Type::PathType(inner) => {
 137                 // FIXME: Use `Path::from_src`
 138                 inner
 139                     .path()
 140                     .and_then(|it| ctx.lower_path(it))
 141                     .map(TypeRef::Path)
 142                     .unwrap_or(TypeRef::Error)
 143             }
 144             ast::Type::PtrType(inner) => {
 145                 let inner_ty = TypeRef::from_ast_opt(ctx, inner.ty());
 146                 let mutability = Mutability::from_mutable(inner.mut_token().is_some());
 147                 TypeRef::RawPtr(Box::new(inner_ty), mutability)
 148             }
 149             ast::Type::ArrayType(inner) => {
 150                 // FIXME: This is a hack. We should probably reuse the machinery of
 151                 // `hir_def::body::lower` to lower this into an `Expr` and then evaluate it at the
 152                 // `hir_ty` level, which would allow knowing the type of:
 153                 // let v: [u8; 2 + 2] = [0u8; 4];
 154                 let len = inner
 155                     .expr()
 156                     .map(ConstScalar::usize_from_literal_expr)
 157                     .unwrap_or(ConstScalar::Unknown);
 158
 159                 TypeRef::Array(Box::new(TypeRef::from_ast_opt(ctx, inner.ty())), len)
 160             }
 161             ast::Type::SliceType(inner) => {
 162                 TypeRef::Slice(Box::new(TypeRef::from_ast_opt(ctx, inner.ty())))
 163             }
 164             ast::Type::RefType(inner) => {
 165                 let inner_ty = TypeRef::from_ast_opt(ctx, inner.ty());
 166                 let lifetime = inner.lifetime().map(|lt| LifetimeRef::new(&lt));
 167                 let mutability = Mutability::from_mutable(inner.mut_token().is_some());
 168                 TypeRef::Reference(Box::new(inner_ty), lifetime, mutability)
 169             }
 170             ast::Type::InferType(_inner) => TypeRef::Placeholder,
 171             ast::Type::FnPtrType(inner) => {
 172                 let ret_ty = inner
 173                     .ret_type()
 174                     .and_then(|rt| rt.ty())
 175                     .map(|it| TypeRef::from_ast(ctx, it))
 176                     .unwrap_or_else(|| TypeRef::Tuple(Vec::new()));
 177                 let mut is_varargs = false;
 178                 let mut params = if let Some(pl) = inner.param_list() {
 179                     if let Some(param) = pl.params().last() {
 180                         is_varargs = param.dotdotdot_token().is_some();
 181                     }
 182
 183                     pl.params().map(|p| p.ty()).map(|it| TypeRef::from_ast_opt(ctx, it)).collect()
 184                 } else {
 185                     Vec::new()
 186                 };
 187                 params.push(ret_ty);
 188                 TypeRef::Fn(params, is_varargs)
 189             }
 190             // for types are close enough for our purposes to the inner type for now...
 191             ast::Type::ForType(inner) => TypeRef::from_ast_opt(ctx, inner.ty()),
 192             ast::Type::ImplTraitType(inner) => {
 193                 TypeRef::ImplTrait(type_bounds_from_ast(ctx, inner.type_bound_list()))
 194             }
 195             ast::Type::DynTraitType(inner) => {
 196                 TypeRef::DynTrait(type_bounds_from_ast(ctx, inner.type_bound_list()))
 197             }
 198             ast::Type::MacroType(mt) => match mt.macro_call() {
 199                 Some(mc) => ctx
 200                     .ast_id(&mc)
 201                     .map(|mc| TypeRef::Macro(InFile::new(ctx.file_id(), mc)))
 202                     .unwrap_or(TypeRef::Error),
 203                 None => TypeRef::Error,
 204             },
 205         }
 206     }
 207
 208     pub(crate) fn from_ast_opt(ctx: &LowerCtx, node: Option<ast::Type>) -> Self {
 209         if let Some(node) = node {
 210             TypeRef::from_ast(ctx, node)
 211         } else {
 212             TypeRef::Error
 213         }
 214     }
 215
 216     pub(crate) fn unit() -> TypeRef {
 217         TypeRef::Tuple(Vec::new())
 218     }
 219
 220     pub fn walk(&self, f: &mut impl FnMut(&TypeRef)) {
 221         go(self, f);
 222
 223         fn go(type_ref: &TypeRef, f: &mut impl FnMut(&TypeRef)) {
 224             f(type_ref);
 225             match type_ref {
 226                 TypeRef::Fn(types, _) | TypeRef::Tuple(types) => {
 227                     types.iter().for_each(|t| go(t, f))
 228                 }
 229                 TypeRef::RawPtr(type_ref, _)
 230                 | TypeRef::Reference(type_ref, ..)
 231                 | TypeRef::Array(type_ref, _)
 232                 | TypeRef::Slice(type_ref) => go(type_ref, f),
 233                 TypeRef::ImplTrait(bounds) | TypeRef::DynTrait(bounds) => {
 234                     for bound in bounds {
 235                         match bound.as_ref() {
 236                             TypeBound::Path(path) | TypeBound::ForLifetime(_, path) => {
 237                                 go_path(path, f)
 238                             }
 239                             TypeBound::Lifetime(_) | TypeBound::Error => (),
 240                         }
 241                     }
 242                 }
 243                 TypeRef::Path(path) => go_path(path, f),
 244                 TypeRef::Never | TypeRef::Placeholder | TypeRef::Macro(_) | TypeRef::Error => {}
 245             };
 246         }
 247
 248         fn go_path(path: &Path, f: &mut impl FnMut(&TypeRef)) {
 249             if let Some(type_ref) = path.type_anchor() {
 250                 go(type_ref, f);
 251             }
 252             for segment in path.segments().iter() {
 253                 if let Some(args_and_bindings) = segment.args_and_bindings {
 254                     for arg in &args_and_bindings.args {
 255                         match arg {
 256                             crate::path::GenericArg::Type(type_ref) => {
 257                                 go(type_ref, f);
 258                             }
 259                             crate::path::GenericArg::Lifetime(_) => {}
 260                         }
 261                     }
 262                     for binding in &args_and_bindings.bindings {
 263                         if let Some(type_ref) = &binding.type_ref {
 264                             go(type_ref, f);
 265                         }
 266                         for bound in &binding.bounds {
 267                             match bound.as_ref() {
 268                                 TypeBound::Path(path) | TypeBound::ForLifetime(_, path) => {
 269                                     go_path(path, f)
 270                                 }
 271                                 TypeBound::Lifetime(_) | TypeBound::Error => (),
 272                             }
 273                         }
 274                     }
 275                 }
 276             }
 277         }
 278     }
 279 }
 280
 281 pub(crate) fn type_bounds_from_ast(
 282     lower_ctx: &LowerCtx,
 283     type_bounds_opt: Option<ast::TypeBoundList>,
 284 ) -> Vec<Interned<TypeBound>> {
 285     if let Some(type_bounds) = type_bounds_opt {
 286         type_bounds.bounds().map(|it| Interned::new(TypeBound::from_ast(lower_ctx, it))).collect()
 287     } else {
 288         vec![]
 289     }
 290 }
 291
 292 impl TypeBound {
 293     pub(crate) fn from_ast(ctx: &LowerCtx, node: ast::TypeBound) -> Self {
 294         let lower_path_type = |path_type: ast::PathType| ctx.lower_path(path_type.path()?);
 295
 296         match node.kind() {
 297             ast::TypeBoundKind::PathType(path_type) => {
 298                 lower_path_type(path_type).map(TypeBound::Path).unwrap_or(TypeBound::Error)
 299             }
 300             ast::TypeBoundKind::ForType(for_type) => {
 301                 let lt_refs = match for_type.generic_param_list() {
 302                     Some(gpl) => gpl
 303                         .lifetime_params()
 304                         .flat_map(|lp| lp.lifetime().map(|lt| Name::new_lifetime(&lt)))
 305                         .collect(),
 306                     None => Box::default(),
 307                 };
 308                 let path = for_type.ty().and_then(|ty| match ty {
 309                     ast::Type::PathType(path_type) => lower_path_type(path_type),
 310                     _ => None,
 311                 });
 312                 match path {
 313                     Some(p) => TypeBound::ForLifetime(lt_refs, p),
 314                     None => TypeBound::Error,
 315                 }
 316             }
 317             ast::TypeBoundKind::Lifetime(lifetime) => {
 318                 TypeBound::Lifetime(LifetimeRef::new(&lifetime))
 319             }
 320         }
 321     }
 322
 323     pub fn as_path(&self) -> Option<&Path> {
 324         match self {
 325             TypeBound::Path(p) | TypeBound::ForLifetime(_, p) => Some(p),
 326             TypeBound::Lifetime(_) | TypeBound::Error => None,
 327         }
 328     }
 329 }
 330
 331 /// A concrete constant value
 332 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 333 pub enum ConstScalar {
 334     // for now, we only support the trivial case of constant evaluating the length of an array
 335     // Note that this is u64 because the target usize may be bigger than our usize
 336     Usize(u64),
 337
 338     /// Case of an unknown value that rustc might know but we don't
 339     // FIXME: this is a hack to get around chalk not being able to represent unevaluatable
 340     // constants
 341     // https://github.com/rust-analyzer/rust-analyzer/pull/8813#issuecomment-840679177
 342     // https://rust-lang.zulipchat.com/#narrow/stream/144729-wg-traits/topic/Handling.20non.20evaluatable.20constants'.20equality/near/238386348
 343     Unknown,
 344 }
 345
 346 impl std::fmt::Display for ConstScalar {
 347     fn fmt(&self, fmt: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
 348         match self {
 349             ConstScalar::Usize(us) => write!(fmt, "{}", us),
 350             ConstScalar::Unknown => write!(fmt, "_"),
 351         }
 352     }
 353 }
 354
 355 impl ConstScalar {
 356     /// Gets a target usize out of the ConstScalar
 357     pub fn as_usize(&self) -> Option<u64> {
 358         match self {
 359             &ConstScalar::Usize(us) => Some(us),
 360             _ => None,
 361         }
 362     }
 363
 364     // FIXME: as per the comments on `TypeRef::Array`, this evaluation should not happen at this
 365     // parse stage.
 366     fn usize_from_literal_expr(expr: ast::Expr) -> ConstScalar {
 367         match expr {
 368             ast::Expr::Literal(lit) => {
 369                 let lkind = lit.kind();
 370                 match lkind {
 371                     ast::LiteralKind::IntNumber(num)
 372                         if num.suffix() == None || num.suffix() == Some("usize") =>
 373                     {
 374                         num.value().and_then(|v| v.try_into().ok())
 375                     }
 376                     _ => None,
 377                 }
 378             }
 379             _ => None,
 380         }
 381         .map(ConstScalar::Usize)
 382         .unwrap_or(ConstScalar::Unknown)
 383     }
 384 }