src/librustc/middle/traits/mod.rs

   1 // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Trait Resolution. See doc.rs.
  12
  13 pub use self::SelectionError::*;
  14 pub use self::FulfillmentErrorCode::*;
  15 pub use self::Vtable::*;
  16 pub use self::ObligationCauseCode::*;
  17
  18 use middle::mem_categorization::Typer;
  19 use middle::subst;
  20 use middle::ty::{self, Ty};
  21 use middle::infer::InferCtxt;
  22 use std::slice::Iter;
  23 use std::rc::Rc;
  24 use syntax::ast;
  25 use syntax::codemap::{Span, DUMMY_SP};
  26 use util::ppaux::{Repr, UserString};
  27
  28 pub use self::error_reporting::report_fulfillment_errors;
  29 pub use self::error_reporting::suggest_new_overflow_limit;
  30 pub use self::coherence::orphan_check;
  31 pub use self::coherence::OrphanCheckErr;
  32 pub use self::fulfill::{FulfillmentContext, RegionObligation};
  33 pub use self::project::MismatchedProjectionTypes;
  34 pub use self::project::normalize;
  35 pub use self::project::Normalized;
  36 pub use self::object_safety::is_object_safe;
  37 pub use self::object_safety::object_safety_violations;
  38 pub use self::object_safety::ObjectSafetyViolation;
  39 pub use self::object_safety::MethodViolationCode;
  40 pub use self::select::SelectionContext;
  41 pub use self::select::SelectionCache;
  42 pub use self::select::{MethodMatchResult, MethodMatched, MethodAmbiguous, MethodDidNotMatch};
  43 pub use self::select::{MethodMatchedData}; // intentionally don't export variants
  44 pub use self::util::elaborate_predicates;
  45 pub use self::util::get_vtable_index_of_object_method;
  46 pub use self::util::trait_ref_for_builtin_bound;
  47 pub use self::util::supertraits;
  48 pub use self::util::Supertraits;
  49 pub use self::util::transitive_bounds;
  50 pub use self::util::upcast;
  51
  52 mod coherence;
  53 mod error_reporting;
  54 mod fulfill;
  55 mod project;
  56 mod object_safety;
  57 mod select;
  58 mod util;
  59
  60 /// An `Obligation` represents some trait reference (e.g. `int:Eq`) for
  61 /// which the vtable must be found.  The process of finding a vtable is
  62 /// called "resolving" the `Obligation`. This process consists of
  63 /// either identifying an `impl` (e.g., `impl Eq for int`) that
  64 /// provides the required vtable, or else finding a bound that is in
  65 /// scope. The eventual result is usually a `Selection` (defined below).
  66 #[derive(Clone)]
  67 pub struct Obligation<'tcx, T> {
  68     pub cause: ObligationCause<'tcx>,
  69     pub recursion_depth: uint,
  70     pub predicate: T,
  71 }
  72
  73 pub type PredicateObligation<'tcx> = Obligation<'tcx, ty::Predicate<'tcx>>;
  74 pub type TraitObligation<'tcx> = Obligation<'tcx, ty::PolyTraitPredicate<'tcx>>;
  75
  76 /// Why did we incur this obligation? Used for error reporting.
  77 #[derive(Clone)]
  78 pub struct ObligationCause<'tcx> {
  79     pub span: Span,
  80
  81     // The id of the fn body that triggered this obligation. This is
  82     // used for region obligations to determine the precise
  83     // environment in which the region obligation should be evaluated
  84     // (in particular, closures can add new assumptions). See the
  85     // field `region_obligations` of the `FulfillmentContext` for more
  86     // information.
  87     pub body_id: ast::NodeId,
  88
  89     pub code: ObligationCauseCode<'tcx>
  90 }
  91
  92 #[derive(Clone)]
  93 pub enum ObligationCauseCode<'tcx> {
  94     /// Not well classified or should be obvious from span.
  95     MiscObligation,
  96
  97     /// In an impl of trait X for type Y, type Y must
  98     /// also implement all supertraits of X.
  99     ItemObligation(ast::DefId),
 100
 101     /// Obligation incurred due to an object cast.
 102     ObjectCastObligation(/* Object type */ Ty<'tcx>),
 103
 104     /// Various cases where expressions must be sized/copy/etc:
 105     AssignmentLhsSized,        // L = X implies that L is Sized
 106     StructInitializerSized,    // S { ... } must be Sized
 107     VariableType(ast::NodeId), // Type of each variable must be Sized
 108     ReturnType,                // Return type must be Sized
 109     RepeatVec,                 // [T,..n] --> T must be Copy
 110
 111     // Captures of variable the given id by a closure (span is the
 112     // span of the closure)
 113     ClosureCapture(ast::NodeId, Span, ty::BuiltinBound),
 114
 115     // Types of fields (other than the last) in a struct must be sized.
 116     FieldSized,
 117
 118     // Only Sized types can be made into objects
 119     ObjectSized,
 120
 121     // static items must have `Sync` type
 122     SharedStatic,
 123
 124
 125     BuiltinDerivedObligation(DerivedObligationCause<'tcx>),
 126
 127     ImplDerivedObligation(DerivedObligationCause<'tcx>),
 128
 129     CompareImplMethodObligation,
 130 }
 131
 132 #[derive(Clone)]
 133 pub struct DerivedObligationCause<'tcx> {
 134     /// The trait reference of the parent obligation that led to the
 135     /// current obligation. Note that only trait obligations lead to
 136     /// derived obligations, so we just store the trait reference here
 137     /// directly.
 138     parent_trait_ref: ty::PolyTraitRef<'tcx>,
 139
 140     /// The parent trait had this cause
 141     parent_code: Rc<ObligationCauseCode<'tcx>>
 142 }
 143
 144 pub type Obligations<'tcx, O> = subst::VecPerParamSpace<Obligation<'tcx, O>>;
 145 pub type PredicateObligations<'tcx> = subst::VecPerParamSpace<PredicateObligation<'tcx>>;
 146 pub type TraitObligations<'tcx> = subst::VecPerParamSpace<TraitObligation<'tcx>>;
 147
 148 pub type Selection<'tcx> = Vtable<'tcx, PredicateObligation<'tcx>>;
 149
 150 #[derive(Clone,Show)]
 151 pub enum SelectionError<'tcx> {
 152     Unimplemented,
 153     Overflow,
 154     OutputTypeParameterMismatch(ty::PolyTraitRef<'tcx>,
 155                                 ty::PolyTraitRef<'tcx>,
 156                                 ty::type_err<'tcx>),
 157 }
 158
 159 pub struct FulfillmentError<'tcx> {
 160     pub obligation: PredicateObligation<'tcx>,
 161     pub code: FulfillmentErrorCode<'tcx>
 162 }
 163
 164 #[derive(Clone)]
 165 pub enum FulfillmentErrorCode<'tcx> {
 166     CodeSelectionError(SelectionError<'tcx>),
 167     CodeProjectionError(MismatchedProjectionTypes<'tcx>),
 168     CodeAmbiguity,
 169 }
 170
 171 /// When performing resolution, it is typically the case that there
 172 /// can be one of three outcomes:
 173 ///
 174 /// - `Ok(Some(r))`: success occurred with result `r`
 175 /// - `Ok(None)`: could not definitely determine anything, usually due
 176 ///   to inconclusive type inference.
 177 /// - `Err(e)`: error `e` occurred
 178 pub type SelectionResult<'tcx, T> = Result<Option<T>, SelectionError<'tcx>>;
 179
 180 /// Given the successful resolution of an obligation, the `Vtable`
 181 /// indicates where the vtable comes from. Note that while we call this
 182 /// a "vtable", it does not necessarily indicate dynamic dispatch at
 183 /// runtime. `Vtable` instances just tell the compiler where to find
 184 /// methods, but in generic code those methods are typically statically
 185 /// dispatched -- only when an object is constructed is a `Vtable`
 186 /// instance reified into an actual vtable.
 187 ///
 188 /// For example, the vtable may be tied to a specific impl (case A),
 189 /// or it may be relative to some bound that is in scope (case B).
 190 ///
 191 ///
 192 /// ```
 193 /// impl<T:Clone> Clone<T> for Option<T> { ... } // Impl_1
 194 /// impl<T:Clone> Clone<T> for Box<T> { ... }    // Impl_2
 195 /// impl Clone for int { ... }             // Impl_3
 196 ///
 197 /// fn foo<T:Clone>(concrete: Option<Box<int>>,
 198 ///                 param: T,
 199 ///                 mixed: Option<T>) {
 200 ///
 201 ///    // Case A: Vtable points at a specific impl. Only possible when
 202 ///    // type is concretely known. If the impl itself has bounded
 203 ///    // type parameters, Vtable will carry resolutions for those as well:
 204 ///    concrete.clone(); // Vtable(Impl_1, [Vtable(Impl_2, [Vtable(Impl_3)])])
 205 ///
 206 ///    // Case B: Vtable must be provided by caller. This applies when
 207 ///    // type is a type parameter.
 208 ///    param.clone();    // VtableParam
 209 ///
 210 ///    // Case C: A mix of cases A and B.
 211 ///    mixed.clone();    // Vtable(Impl_1, [VtableParam])
 212 /// }
 213 /// ```
 214 ///
 215 /// ### The type parameter `N`
 216 ///
 217 /// See explanation on `VtableImplData`.
 218 #[derive(Show,Clone)]
 219 pub enum Vtable<'tcx, N> {
 220     /// Vtable identifying a particular impl.
 221     VtableImpl(VtableImplData<'tcx, N>),
 222
 223     /// Successful resolution to an obligation provided by the caller
 224     /// for some type parameter. The `Vec<N>` represents the
 225     /// obligations incurred from normalizing the where-clause (if
 226     /// any).
 227     VtableParam(Vec<N>),
 228
 229     /// Virtual calls through an object
 230     VtableObject(VtableObjectData<'tcx>),
 231
 232     /// Successful resolution for a builtin trait.
 233     VtableBuiltin(VtableBuiltinData<N>),
 234
 235     /// Vtable automatically generated for an unboxed closure. The def
 236     /// ID is the ID of the closure expression. This is a `VtableImpl`
 237     /// in spirit, but the impl is generated by the compiler and does
 238     /// not appear in the source.
 239     VtableUnboxedClosure(ast::DefId, subst::Substs<'tcx>),
 240
 241     /// Same as above, but for a fn pointer type with the given signature.
 242     VtableFnPointer(ty::Ty<'tcx>),
 243 }
 244
 245 /// Identifies a particular impl in the source, along with a set of
 246 /// substitutions from the impl's type/lifetime parameters. The
 247 /// `nested` vector corresponds to the nested obligations attached to
 248 /// the impl's type parameters.
 249 ///
 250 /// The type parameter `N` indicates the type used for "nested
 251 /// obligations" that are required by the impl. During type check, this
 252 /// is `Obligation`, as one might expect. During trans, however, this
 253 /// is `()`, because trans only requires a shallow resolution of an
 254 /// impl, and nested obligations are satisfied later.
 255 #[derive(Clone)]
 256 pub struct VtableImplData<'tcx, N> {
 257     pub impl_def_id: ast::DefId,
 258     pub substs: subst::Substs<'tcx>,
 259     pub nested: subst::VecPerParamSpace<N>
 260 }
 261
 262 #[derive(Show,Clone)]
 263 pub struct VtableBuiltinData<N> {
 264     pub nested: subst::VecPerParamSpace<N>
 265 }
 266
 267 /// A vtable for some object-safe trait `Foo` automatically derived
 268 /// for the object type `Foo`.
 269 #[derive(PartialEq,Eq,Clone)]
 270 pub struct VtableObjectData<'tcx> {
 271     pub object_ty: Ty<'tcx>,
 272 }
 273
 274 /// True if there exist types that satisfy both of the two given impls.
 275 pub fn overlapping_impls(infcx: &InferCtxt,
 276                          impl1_def_id: ast::DefId,
 277                          impl2_def_id: ast::DefId)
 278                          -> bool
 279 {
 280     coherence::impl_can_satisfy(infcx, impl1_def_id, impl2_def_id) &&
 281     coherence::impl_can_satisfy(infcx, impl2_def_id, impl1_def_id)
 282 }
 283
 284 /// Creates predicate obligations from the generic bounds.
 285 pub fn predicates_for_generics<'tcx>(tcx: &ty::ctxt<'tcx>,
 286                                      cause: ObligationCause<'tcx>,
 287                                      generic_bounds: &ty::GenericBounds<'tcx>)
 288                                      -> PredicateObligations<'tcx>
 289 {
 290     util::predicates_for_generics(tcx, cause, 0, generic_bounds)
 291 }
 292
 293 /// Determines whether the type `ty` is known to meet `bound` and
 294 /// returns true if so. Returns false if `ty` either does not meet
 295 /// `bound` or is not known to meet bound (note that this is
 296 /// conservative towards *no impl*, which is the opposite of the
 297 /// `evaluate` methods).
 298 pub fn evaluate_builtin_bound<'a,'tcx>(infcx: &InferCtxt<'a,'tcx>,
 299                                        typer: &ty::UnboxedClosureTyper<'tcx>,
 300                                        ty: Ty<'tcx>,
 301                                        bound: ty::BuiltinBound,
 302                                        span: Span)
 303                                        -> SelectionResult<'tcx, ()>
 304 {
 305     debug!("type_known_to_meet_builtin_bound(ty={}, bound={:?})",
 306            ty.repr(infcx.tcx),
 307            bound);
 308
 309     let mut fulfill_cx = FulfillmentContext::new();
 310
 311     // We can use a dummy node-id here because we won't pay any mind
 312     // to region obligations that arise (there shouldn't really be any
 313     // anyhow).
 314     let cause = ObligationCause::misc(span, ast::DUMMY_NODE_ID);
 315
 316     fulfill_cx.register_builtin_bound(infcx, ty, bound, cause);
 317
 318     // Note: we only assume something is `Copy` if we can
 319     // *definitively* show that it implements `Copy`. Otherwise,
 320     // assume it is move; linear is always ok.
 321     let result = match fulfill_cx.select_all_or_error(infcx, typer) {
 322         Ok(()) => Ok(Some(())), // Success, we know it implements Copy.
 323         Err(errors) => {
 324             // Check if overflow occurred anywhere and propagate that.
 325             if errors.iter().any(
 326                 |err| match err.code { CodeSelectionError(Overflow) => true, _ => false })
 327             {
 328                 return Err(Overflow);
 329             }
 330
 331             // Otherwise, if there were any hard errors, propagate an
 332             // arbitrary one of those. If no hard errors at all,
 333             // report ambiguity.
 334             let sel_error =
 335                 errors.iter()
 336                       .filter_map(|err| {
 337                           match err.code {
 338                               CodeAmbiguity => None,
 339                               CodeSelectionError(ref e) => Some(e.clone()),
 340                               CodeProjectionError(_) => {
 341                                   infcx.tcx.sess.span_bug(
 342                                       span,
 343                                       "projection error while selecting?")
 344                               }
 345                           }
 346                       })
 347                       .next();
 348             match sel_error {
 349                 None => { Ok(None) }
 350                 Some(e) => { Err(e) }
 351             }
 352         }
 353     };
 354
 355     debug!("type_known_to_meet_builtin_bound: ty={} bound={:?} result={:?}",
 356            ty.repr(infcx.tcx),
 357            bound,
 358            result);
 359
 360     result
 361 }
 362
 363 pub fn type_known_to_meet_builtin_bound<'a,'tcx>(infcx: &InferCtxt<'a,'tcx>,
 364                                                  typer: &ty::UnboxedClosureTyper<'tcx>,
 365                                                  ty: Ty<'tcx>,
 366                                                  bound: ty::BuiltinBound,
 367                                                  span: Span)
 368                                                  -> bool
 369 {
 370     match evaluate_builtin_bound(infcx, typer, ty, bound, span) {
 371         Ok(Some(())) => {
 372             // definitely impl'd
 373             true
 374         }
 375         Ok(None) => {
 376             // ambiguous: if coherence check was successful, shouldn't
 377             // happen, but we might have reported an error and been
 378             // soldering on, so just treat this like not implemented
 379             false
 380         }
 381         Err(Overflow) => {
 382             infcx.tcx.sess.span_err(
 383                 span,
 384                 format!("overflow evaluating whether `{}` is `{}`",
 385                         ty.user_string(infcx.tcx),
 386                         bound.user_string(infcx.tcx)).as_slice());
 387             suggest_new_overflow_limit(infcx.tcx, span);
 388             false
 389         }
 390         Err(_) => {
 391             // other errors: not implemented.
 392             false
 393         }
 394     }
 395 }
 396
 397 impl<'tcx,O> Obligation<'tcx,O> {
 398     pub fn new(cause: ObligationCause<'tcx>,
 399                trait_ref: O)
 400                -> Obligation<'tcx, O>
 401     {
 402         Obligation { cause: cause,
 403                      recursion_depth: 0,
 404                      predicate: trait_ref }
 405     }
 406
 407     fn with_depth(cause: ObligationCause<'tcx>,
 408                   recursion_depth: uint,
 409                   trait_ref: O)
 410                   -> Obligation<'tcx, O>
 411     {
 412         Obligation { cause: cause,
 413                      recursion_depth: recursion_depth,
 414                      predicate: trait_ref }
 415     }
 416
 417     pub fn misc(span: Span, body_id: ast::NodeId, trait_ref: O) -> Obligation<'tcx, O> {
 418         Obligation::new(ObligationCause::misc(span, body_id), trait_ref)
 419     }
 420
 421     pub fn with<P>(&self, value: P) -> Obligation<'tcx,P> {
 422         Obligation { cause: self.cause.clone(),
 423                      recursion_depth: self.recursion_depth,
 424                      predicate: value }
 425     }
 426 }
 427
 428 impl<'tcx> ObligationCause<'tcx> {
 429     pub fn new(span: Span,
 430                body_id: ast::NodeId,
 431                code: ObligationCauseCode<'tcx>)
 432                -> ObligationCause<'tcx> {
 433         ObligationCause { span: span, body_id: body_id, code: code }
 434     }
 435
 436     pub fn misc(span: Span, body_id: ast::NodeId) -> ObligationCause<'tcx> {
 437         ObligationCause { span: span, body_id: body_id, code: MiscObligation }
 438     }
 439
 440     pub fn dummy() -> ObligationCause<'tcx> {
 441         ObligationCause { span: DUMMY_SP, body_id: 0, code: MiscObligation }
 442     }
 443 }
 444
 445 impl<'tcx, N> Vtable<'tcx, N> {
 446     pub fn iter_nested(&self) -> Iter<N> {
 447         match *self {
 448             VtableImpl(ref i) => i.iter_nested(),
 449             VtableFnPointer(..) => (&[]).iter(),
 450             VtableUnboxedClosure(..) => (&[]).iter(),
 451             VtableParam(ref n) => n.iter(),
 452             VtableObject(_) => (&[]).iter(),
 453             VtableBuiltin(ref i) => i.iter_nested(),
 454         }
 455     }
 456
 457     pub fn map_nested<M, F>(&self, op: F) -> Vtable<'tcx, M> where F: FnMut(&N) -> M {
 458         match *self {
 459             VtableImpl(ref i) => VtableImpl(i.map_nested(op)),
 460             VtableFnPointer(ref sig) => VtableFnPointer((*sig).clone()),
 461             VtableUnboxedClosure(d, ref s) => VtableUnboxedClosure(d, s.clone()),
 462             VtableParam(ref n) => VtableParam(n.iter().map(op).collect()),
 463             VtableObject(ref p) => VtableObject(p.clone()),
 464             VtableBuiltin(ref b) => VtableBuiltin(b.map_nested(op)),
 465         }
 466     }
 467
 468     pub fn map_move_nested<M, F>(self, op: F) -> Vtable<'tcx, M> where
 469         F: FnMut(N) -> M,
 470     {
 471         match self {
 472             VtableImpl(i) => VtableImpl(i.map_move_nested(op)),
 473             VtableFnPointer(sig) => VtableFnPointer(sig),
 474             VtableUnboxedClosure(d, s) => VtableUnboxedClosure(d, s),
 475             VtableParam(n) => VtableParam(n.into_iter().map(op).collect()),
 476             VtableObject(p) => VtableObject(p),
 477             VtableBuiltin(no) => VtableBuiltin(no.map_move_nested(op)),
 478         }
 479     }
 480 }
 481
 482 impl<'tcx, N> VtableImplData<'tcx, N> {
 483     pub fn iter_nested(&self) -> Iter<N> {
 484         self.nested.iter()
 485     }
 486
 487     pub fn map_nested<M, F>(&self, op: F) -> VtableImplData<'tcx, M> where
 488         F: FnMut(&N) -> M,
 489     {
 490         VtableImplData {
 491             impl_def_id: self.impl_def_id,
 492             substs: self.substs.clone(),
 493             nested: self.nested.map(op)
 494         }
 495     }
 496
 497     pub fn map_move_nested<M, F>(self, op: F) -> VtableImplData<'tcx, M> where
 498         F: FnMut(N) -> M,
 499     {
 500         let VtableImplData { impl_def_id, substs, nested } = self;
 501         VtableImplData {
 502             impl_def_id: impl_def_id,
 503             substs: substs,
 504             nested: nested.map_move(op)
 505         }
 506     }
 507 }
 508
 509 impl<N> VtableBuiltinData<N> {
 510     pub fn iter_nested(&self) -> Iter<N> {
 511         self.nested.iter()
 512     }
 513
 514     pub fn map_nested<M, F>(&self, op: F) -> VtableBuiltinData<M> where F: FnMut(&N) -> M {
 515         VtableBuiltinData {
 516             nested: self.nested.map(op)
 517         }
 518     }
 519
 520     pub fn map_move_nested<M, F>(self, op: F) -> VtableBuiltinData<M> where
 521         F: FnMut(N) -> M,
 522     {
 523         VtableBuiltinData {
 524             nested: self.nested.map_move(op)
 525         }
 526     }
 527 }
 528
 529 impl<'tcx> FulfillmentError<'tcx> {
 530     fn new(obligation: PredicateObligation<'tcx>,
 531            code: FulfillmentErrorCode<'tcx>)
 532            -> FulfillmentError<'tcx>
 533     {
 534         FulfillmentError { obligation: obligation, code: code }
 535     }
 536
 537     pub fn is_overflow(&self) -> bool {
 538         match self.code {
 539             CodeAmbiguity => false,
 540             CodeSelectionError(Overflow) => true,
 541             CodeSelectionError(_) => false,
 542             CodeProjectionError(_) => false,
 543         }
 544     }
 545 }
 546
 547 impl<'tcx> TraitObligation<'tcx> {
 548     fn self_ty(&self) -> Ty<'tcx> {
 549         self.predicate.0.self_ty()
 550     }
 551 }