1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
#![deny(rust_2018_idioms)] //! Contains the definition for the "Rust IR" -- this is basically a "lowered" //! version of the AST, roughly corresponding to [the HIR] in the Rust //! compiler. use chalk_derive::{Fold, HasInterner, Visit}; use chalk_ir::cast::Cast; use chalk_ir::fold::shift::Shift; use chalk_ir::interner::{Interner, TargetInterner}; use chalk_ir::{ AliasEq, AliasTy, AssocTypeId, Binders, BoundVar, DebruijnIndex, ImplId, LifetimeData, OpaqueTyId, Parameter, ParameterKind, ProjectionTy, QuantifiedWhereClause, StructId, Substitution, TraitId, TraitRef, Ty, TyData, TypeName, WhereClause, }; use std::iter; /// Identifier for an "associated type value" found in some impl. #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)] pub struct AssociatedTyValueId<I: Interner>(pub I::DefId); chalk_ir::id_fold!(AssociatedTyValueId); #[derive(Clone, Debug, PartialEq, Eq, Hash)] pub struct ImplDatum<I: Interner> { pub polarity: Polarity, pub binders: Binders<ImplDatumBound<I>>, pub impl_type: ImplType, pub associated_ty_value_ids: Vec<AssociatedTyValueId<I>>, } impl<I: Interner> ImplDatum<I> { pub fn is_positive(&self) -> bool { self.polarity.is_positive() } pub fn trait_id(&self) -> TraitId<I> { self.binders.skip_binders().trait_ref.trait_id } pub fn self_type_struct_id(&self, interner: &I) -> Option<StructId<I>> { match self .binders .skip_binders() .trait_ref .self_type_parameter(interner) .data(interner) { TyData::Apply(apply) => match apply.name { TypeName::Struct(id) => Some(id), _ => None, }, _ => None, } } } #[derive(Clone, Debug, PartialEq, Eq, Hash, HasInterner, Fold)] pub struct ImplDatumBound<I: Interner> { pub trait_ref: TraitRef<I>, pub where_clauses: Vec<QuantifiedWhereClause<I>>, } #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] pub enum ImplType { Local, External, } #[derive(Clone, Debug, PartialEq, Eq, Hash)] pub struct DefaultImplDatum<I: Interner> { pub binders: Binders<DefaultImplDatumBound<I>>, } #[derive(Clone, Debug, PartialEq, Eq, Hash, HasInterner)] pub struct DefaultImplDatumBound<I: Interner> { pub trait_ref: TraitRef<I>, pub accessible_tys: Vec<Ty<I>>, } #[derive(Clone, Debug, PartialEq, Eq, Hash)] pub struct StructDatum<I: Interner> { pub binders: Binders<StructDatumBound<I>>, pub id: StructId<I>, pub flags: StructFlags, } impl<I: Interner> StructDatum<I> { pub fn name(&self, interner: &I) -> TypeName<I> { self.id.cast(interner) } } #[derive(Clone, Debug, PartialEq, Eq, Hash, Fold, HasInterner)] pub struct StructDatumBound<I: Interner> { pub fields: Vec<Ty<I>>, pub where_clauses: Vec<QuantifiedWhereClause<I>>, } #[derive(Clone, Debug, PartialEq, Eq, Hash)] pub struct StructFlags { pub upstream: bool, pub fundamental: bool, } #[derive(Clone, Debug, PartialEq, Eq, Hash)] /// A rust intermediate representation (rust_ir) of a Trait Definition. For /// example, given the following rust code: /// /// ```compile_fail /// use std::fmt::Debug; /// /// trait Foo<T> /// where /// T: Debug, /// { /// type Bar<U>; /// } /// ``` /// /// This would represent the `trait Foo` declaration. Note that the details of /// the trait members (e.g., the associated type declaration (`type Bar<U>`) are /// not contained in this type, and are represented separately (e.g., in /// [`AssociatedTyDatum`]). /// /// Not to be confused with the rust_ir for a Trait Implementation, which is /// represented by [`ImplDatum`] /// /// [`ImplDatum`]: struct.ImplDatum.html /// [`AssociatedTyDatum`]: struct.AssociatedTyDatum.html pub struct TraitDatum<I: Interner> { pub id: TraitId<I>, pub binders: Binders<TraitDatumBound<I>>, /// "Flags" indicate special kinds of traits, like auto traits. /// In Rust syntax these are represented in different ways, but in /// chalk we add annotations like `#[auto]`. pub flags: TraitFlags, pub associated_ty_ids: Vec<AssocTypeId<I>>, /// If this is a well-known trait, which one? If `None`, this is a regular, /// user-defined trait. pub well_known: Option<WellKnownTrait>, } /// A list of the traits that are "well known" to chalk, which means that /// the chalk-solve crate has special, hard-coded impls for them. #[derive(Copy, Clone, Debug, PartialEq, Eq, Ord, PartialOrd, Hash)] pub enum WellKnownTrait { SizedTrait, CopyTrait, CloneTrait, DropTrait, } impl<I: Interner> TraitDatum<I> { pub fn is_auto_trait(&self) -> bool { self.flags.auto } pub fn is_non_enumerable_trait(&self) -> bool { self.flags.non_enumerable } pub fn is_coinductive_trait(&self) -> bool { self.flags.coinductive } } #[derive(Clone, Debug, PartialEq, Eq, Hash, HasInterner)] pub struct TraitDatumBound<I: Interner> { /// Where clauses defined on the trait: /// /// ```ignore /// trait Foo<T> where T: Debug { } /// ^^^^^^^^^^^^^^ /// ``` pub where_clauses: Vec<QuantifiedWhereClause<I>>, } #[derive(Clone, Debug, PartialEq, Eq, Hash)] pub struct TraitFlags { /// An "auto trait" is one that is "automatically implemented" for every /// struct, so long as no explicit impl is given. /// /// Examples are `Send` and `Sync`. pub auto: bool, pub marker: bool, /// Indicate that a trait is defined upstream (in a dependency), used during /// coherence checking. pub upstream: bool, /// A fundamental trait is a trait where adding an impl for an existing type /// is considered a breaking change. Examples of fundamental traits are the /// closure traits like `Fn` and `FnMut`. /// /// As of this writing (2020-03-27), fundamental traits are declared by the /// unstable `#[fundamental]` attribute in rustc, and hence cannot appear /// outside of the standard library. pub fundamental: bool, /// Indicates that chalk cannot list all of the implementations of the given /// trait, likely because it is a publicly exported trait in a library. /// /// Currently (2020-03-27) rustc and rust-analyzer mark all traits as /// non_enumerable, and in the future it may become the only option. pub non_enumerable: bool, pub coinductive: bool, } /// An inline bound, e.g. `: Foo<K>` in `impl<K, T: Foo<K>> SomeType<T>`. #[derive(Clone, Debug, PartialEq, Eq, Hash, Fold, Visit, HasInterner)] pub enum InlineBound<I: Interner> { TraitBound(TraitBound<I>), AliasEqBound(AliasEqBound<I>), } #[allow(type_alias_bounds)] pub type QuantifiedInlineBound<I: Interner> = Binders<InlineBound<I>>; pub trait IntoWhereClauses<I: Interner> { type Output; fn into_where_clauses(&self, interner: &I, self_ty: Ty<I>) -> Vec<Self::Output>; } impl<I: Interner> IntoWhereClauses<I> for InlineBound<I> { type Output = WhereClause<I>; /// Applies the `InlineBound` to `self_ty` and lowers to a /// [`chalk_ir::DomainGoal`]. /// /// Because an `InlineBound` does not know anything about what it's binding, /// you must provide that type as `self_ty`. fn into_where_clauses(&self, interner: &I, self_ty: Ty<I>) -> Vec<WhereClause<I>> { match self { InlineBound::TraitBound(b) => b.into_where_clauses(interner, self_ty), InlineBound::AliasEqBound(b) => b.into_where_clauses(interner, self_ty), } } } impl<I: Interner> IntoWhereClauses<I> for QuantifiedInlineBound<I> { type Output = QuantifiedWhereClause<I>; fn into_where_clauses(&self, interner: &I, self_ty: Ty<I>) -> Vec<QuantifiedWhereClause<I>> { let self_ty = self_ty.shifted_in(interner); self.map_ref(|b| b.into_where_clauses(interner, self_ty)) .into_iter() .collect() } } /// Represents a trait bound on e.g. a type or type parameter. /// Does not know anything about what it's binding. #[derive(Clone, Debug, PartialEq, Eq, Hash, Fold, Visit)] pub struct TraitBound<I: Interner> { pub trait_id: TraitId<I>, pub args_no_self: Vec<Parameter<I>>, } impl<I: Interner> TraitBound<I> { fn into_where_clauses(&self, interner: &I, self_ty: Ty<I>) -> Vec<WhereClause<I>> { let trait_ref = self.as_trait_ref(interner, self_ty); vec![WhereClause::Implemented(trait_ref)] } pub fn as_trait_ref(&self, interner: &I, self_ty: Ty<I>) -> TraitRef<I> { TraitRef { trait_id: self.trait_id, substitution: Substitution::from( interner, iter::once(self_ty.cast(interner)).chain(self.args_no_self.iter().cloned()), ), } } } /// Represents an alias equality bound on e.g. a type or type parameter. /// Does not know anything about what it's binding. #[derive(Clone, Debug, PartialEq, Eq, Hash, Fold, Visit)] pub struct AliasEqBound<I: Interner> { pub trait_bound: TraitBound<I>, pub associated_ty_id: AssocTypeId<I>, /// Does not include trait parameters. pub parameters: Vec<Parameter<I>>, pub value: Ty<I>, } impl<I: Interner> AliasEqBound<I> { fn into_where_clauses(&self, interner: &I, self_ty: Ty<I>) -> Vec<WhereClause<I>> { let trait_ref = self.trait_bound.as_trait_ref(interner, self_ty); let substitution = Substitution::from( interner, self.parameters .iter() .cloned() .chain(trait_ref.substitution.iter(interner).cloned()), ); vec![ WhereClause::Implemented(trait_ref), WhereClause::AliasEq(AliasEq { alias: AliasTy::Projection(ProjectionTy { associated_ty_id: self.associated_ty_id, substitution, }), ty: self.value.clone(), }), ] } } pub trait Anonymize { /// Utility function that converts from a list of generic parameters /// which *have* names (`ParameterKind<T>`) to a list of /// "anonymous" generic parameters that just preserves their /// kinds (`ParameterKind<()>`). Often convenient in lowering. fn anonymize(&self) -> Vec<ParameterKind<()>>; } impl<T> Anonymize for [ParameterKind<T>] { fn anonymize(&self) -> Vec<ParameterKind<()>> { self.iter().map(|pk| pk.map_ref(|_| ())).collect() } } pub trait ToParameter { /// Utility for converting a list of all the binders into scope /// into references to those binders. Simply pair the binders with /// the indices, and invoke `to_parameter()` on the `(binder, /// index)` pair. The result will be a reference to a bound /// variable of appropriate kind at the corresponding index. fn to_parameter<I: Interner>(&self, interner: &I) -> Parameter<I> { self.to_parameter_at_depth(interner, DebruijnIndex::INNERMOST) } fn to_parameter_at_depth<I: Interner>( &self, interner: &I, debruijn: DebruijnIndex, ) -> Parameter<I>; } impl<'a> ToParameter for (&'a ParameterKind<()>, usize) { fn to_parameter_at_depth<I: Interner>( &self, interner: &I, debruijn: DebruijnIndex, ) -> Parameter<I> { let &(binder, index) = self; let bound_var = BoundVar::new(debruijn, index); match *binder { ParameterKind::Lifetime(_) => LifetimeData::BoundVar(bound_var) .intern(interner) .cast(interner), ParameterKind::Ty(_) => TyData::BoundVar(bound_var).intern(interner).cast(interner), } } } /// Represents an associated type declaration found inside of a trait: /// /// ```notrust /// trait Foo<P1..Pn> { // P0 is Self /// type Bar<Pn..Pm>: [bounds] /// where /// [where_clauses]; /// } /// ``` /// /// The meaning of each of these parts: /// /// * The *parameters* `P0...Pm` are all in scope for this associated type. /// * The *bounds* `bounds` are things that the impl must prove to be true. /// * The *where clauses* `where_clauses` are things that the impl can *assume* to be true /// (but which projectors must prove). #[derive(Clone, Debug, PartialEq, Eq, Hash)] pub struct AssociatedTyDatum<I: Interner> { /// The trait this associated type is defined in. pub trait_id: TraitId<I>, /// The ID of this associated type pub id: AssocTypeId<I>, /// Name of this associated type. pub name: I::Identifier, /// These binders represent the `P0...Pm` variables. The binders /// are in the order `[Pn..Pm; P0..Pn]`. That is, the variables /// from `Bar` come first (corresponding to the de bruijn concept /// that "inner" binders are lower indices, although within a /// given binder we do not have an ordering). pub binders: Binders<AssociatedTyDatumBound<I>>, } /// Encodes the parts of `AssociatedTyDatum` where the parameters /// `P0..Pm` are in scope (`bounds` and `where_clauses`). #[derive(Clone, Debug, PartialEq, Eq, Hash, Fold, Visit, HasInterner)] pub struct AssociatedTyDatumBound<I: Interner> { /// Bounds on the associated type itself. /// /// These must be proven by the implementer, for all possible parameters that /// would result in a well-formed projection. pub bounds: Vec<QuantifiedInlineBound<I>>, /// Where clauses that must hold for the projection to be well-formed. pub where_clauses: Vec<QuantifiedWhereClause<I>>, } impl<I: Interner> AssociatedTyDatum<I> { /// Returns the associated ty's bounds applied to the projection type, e.g.: /// /// ```notrust /// Implemented(<?0 as Foo>::Item<?1>: Sized) /// ``` /// /// these quantified where clauses are in the scope of the /// `binders` field. pub fn bounds_on_self(&self, interner: &I) -> Vec<QuantifiedWhereClause<I>> { let (binders, assoc_ty_datum) = self.binders.as_ref().into(); // Create a list `P0...Pn` of references to the binders in // scope for this associated type: let substitution = Substitution::from( interner, binders .iter(interner) .zip(0..) .map(|p| p.to_parameter(interner)), ); // The self type will be `<P0 as Foo<P1..Pn>>::Item<Pn..Pm>` etc let self_ty = TyData::Alias(AliasTy::Projection(ProjectionTy { associated_ty_id: self.id, substitution, })) .intern(interner); // Now use that as the self type for the bounds, transforming // something like `type Bar<Pn..Pm>: Debug` into // // ``` // <P0 as Foo<P1..Pn>>::Item<Pn..Pm>: Debug // ``` assoc_ty_datum .bounds .iter() .flat_map(|b| b.into_where_clauses(interner, self_ty.clone())) .collect() } } /// Represents the *value* of an associated type that is assigned /// from within some impl. /// /// ```ignore /// impl Iterator for Foo { /// type Item = XXX; // <-- represents this line! /// } /// ``` #[derive(Clone, Debug, PartialEq, Eq, Hash, Fold, Visit)] pub struct AssociatedTyValue<I: Interner> { /// Impl in which this associated type value is found. You might /// need to look at this to find the generic parameters defined on /// the impl, for example. /// /// ```ignore /// impl Iterator for Foo { // <-- refers to this impl /// type Item = XXX; // <-- (where this is self) /// } /// ``` pub impl_id: ImplId<I>, /// Associated type being defined. /// /// ```ignore /// impl Iterator for Foo { /// type Item = XXX; // <-- (where this is self) /// } /// ... /// trait Iterator { /// type Item; // <-- refers to this declaration here! /// } /// ``` pub associated_ty_id: AssocTypeId<I>, /// Additional binders declared on the associated type itself, /// beyond those from the impl. This would be empty for normal /// associated types, but non-empty for generic associated types. /// /// ```ignore /// impl<T> Iterable for Vec<T> { /// type Iter<'a> = vec::Iter<'a, T>; /// // ^^^^ refers to these generics here /// } /// ``` pub value: Binders<AssociatedTyValueBound<I>>, } #[derive(Clone, Debug, PartialEq, Eq, Hash, Fold, Visit, HasInterner)] pub struct AssociatedTyValueBound<I: Interner> { /// Type that we normalize to. The X in `type Foo<'a> = X`. pub ty: Ty<I>, } /// Represents the bounds for an `impl Trait` type. /// /// ```ignore /// opaque type T: A + B = HiddenTy; /// ``` #[derive(Clone, Debug, PartialEq, Eq, Hash, Fold)] pub struct OpaqueTyDatum<I: Interner> { /// The placeholder `!T` that corresponds to the opaque type `T`. pub opaque_ty_id: OpaqueTyId<I>, /// The type bound to when revealed. pub bound: Binders<OpaqueTyDatumBound<I>>, } #[derive(Clone, Debug, PartialEq, Eq, Hash, Fold, HasInterner)] pub struct OpaqueTyDatumBound<I: Interner> { /// The value for the "hidden type" for `opaque type Foo = ...` pub hidden_ty: Ty<I>, /// Trait bounds for the opaque type. pub bounds: Binders<Vec<QuantifiedWhereClause<I>>>, } #[derive(Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord, Debug)] pub enum Polarity { Positive, Negative, } impl Polarity { pub fn is_positive(&self) -> bool { match *self { Polarity::Positive => true, Polarity::Negative => false, } } }