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.
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.
11 use hir::def_id::DefId;
12 use ty::subst::{Kind, Subst, Substs};
13 use ty::{self, Ty, TyCtxt, ToPredicate, ToPolyTraitRef};
14 use ty::outlives::Component;
15 use util::nodemap::FxHashSet;
17 use traits::specialize::specialization_graph::NodeItem;
19 use super::{Obligation, ObligationCause, PredicateObligation, SelectionContext, Normalized};
21 fn anonymize_predicate<'a, 'gcx, 'tcx>(tcx: TyCtxt<'a, 'gcx, 'tcx>,
22 pred: &ty::Predicate<'tcx>)
23 -> ty::Predicate<'tcx> {
25 ty::Predicate::Trait(ref data) =>
26 ty::Predicate::Trait(tcx.anonymize_late_bound_regions(data)),
28 ty::Predicate::RegionOutlives(ref data) =>
29 ty::Predicate::RegionOutlives(tcx.anonymize_late_bound_regions(data)),
31 ty::Predicate::TypeOutlives(ref data) =>
32 ty::Predicate::TypeOutlives(tcx.anonymize_late_bound_regions(data)),
34 ty::Predicate::Projection(ref data) =>
35 ty::Predicate::Projection(tcx.anonymize_late_bound_regions(data)),
37 ty::Predicate::WellFormed(data) =>
38 ty::Predicate::WellFormed(data),
40 ty::Predicate::ObjectSafe(data) =>
41 ty::Predicate::ObjectSafe(data),
43 ty::Predicate::ClosureKind(closure_def_id, closure_substs, kind) =>
44 ty::Predicate::ClosureKind(closure_def_id, closure_substs, kind),
46 ty::Predicate::Subtype(ref data) =>
47 ty::Predicate::Subtype(tcx.anonymize_late_bound_regions(data)),
49 ty::Predicate::ConstEvaluatable(def_id, substs) =>
50 ty::Predicate::ConstEvaluatable(def_id, substs),
55 struct PredicateSet<'a, 'gcx: 'a+'tcx, 'tcx: 'a> {
56 tcx: TyCtxt<'a, 'gcx, 'tcx>,
57 set: FxHashSet<ty::Predicate<'tcx>>,
60 impl<'a, 'gcx, 'tcx> PredicateSet<'a, 'gcx, 'tcx> {
61 fn new(tcx: TyCtxt<'a, 'gcx, 'tcx>) -> PredicateSet<'a, 'gcx, 'tcx> {
62 PredicateSet { tcx: tcx, set: FxHashSet() }
65 fn insert(&mut self, pred: &ty::Predicate<'tcx>) -> bool {
66 // We have to be careful here because we want
68 // for<'a> Foo<&'a int>
72 // for<'b> Foo<&'b int>
74 // to be considered equivalent. So normalize all late-bound
75 // regions before we throw things into the underlying set.
76 self.set.insert(anonymize_predicate(self.tcx, pred))
80 ///////////////////////////////////////////////////////////////////////////
81 // `Elaboration` iterator
82 ///////////////////////////////////////////////////////////////////////////
84 /// "Elaboration" is the process of identifying all the predicates that
85 /// are implied by a source predicate. Currently this basically means
86 /// walking the "supertraits" and other similar assumptions. For
87 /// example, if we know that `T : Ord`, the elaborator would deduce
88 /// that `T : PartialOrd` holds as well. Similarly, if we have `trait
89 /// Foo : 'static`, and we know that `T : Foo`, then we know that `T :
91 pub struct Elaborator<'a, 'gcx: 'a+'tcx, 'tcx: 'a> {
92 stack: Vec<ty::Predicate<'tcx>>,
93 visited: PredicateSet<'a, 'gcx, 'tcx>,
96 pub fn elaborate_trait_ref<'cx, 'gcx, 'tcx>(
97 tcx: TyCtxt<'cx, 'gcx, 'tcx>,
98 trait_ref: ty::PolyTraitRef<'tcx>)
99 -> Elaborator<'cx, 'gcx, 'tcx>
101 elaborate_predicates(tcx, vec![trait_ref.to_predicate()])
104 pub fn elaborate_trait_refs<'cx, 'gcx, 'tcx>(
105 tcx: TyCtxt<'cx, 'gcx, 'tcx>,
106 trait_refs: &[ty::PolyTraitRef<'tcx>])
107 -> Elaborator<'cx, 'gcx, 'tcx>
109 let predicates = trait_refs.iter()
110 .map(|trait_ref| trait_ref.to_predicate())
112 elaborate_predicates(tcx, predicates)
115 pub fn elaborate_predicates<'cx, 'gcx, 'tcx>(
116 tcx: TyCtxt<'cx, 'gcx, 'tcx>,
117 mut predicates: Vec<ty::Predicate<'tcx>>)
118 -> Elaborator<'cx, 'gcx, 'tcx>
120 let mut visited = PredicateSet::new(tcx);
121 predicates.retain(|pred| visited.insert(pred));
122 Elaborator { stack: predicates, visited: visited }
125 impl<'cx, 'gcx, 'tcx> Elaborator<'cx, 'gcx, 'tcx> {
126 pub fn filter_to_traits(self) -> FilterToTraits<Self> {
127 FilterToTraits::new(self)
130 fn push(&mut self, predicate: &ty::Predicate<'tcx>) {
131 let tcx = self.visited.tcx;
133 ty::Predicate::Trait(ref data) => {
134 // Predicates declared on the trait.
135 let predicates = tcx.super_predicates_of(data.def_id());
137 let mut predicates: Vec<_> =
138 predicates.predicates
140 .map(|p| p.subst_supertrait(tcx, &data.to_poly_trait_ref()))
143 debug!("super_predicates: data={:?} predicates={:?}",
146 // Only keep those bounds that we haven't already
147 // seen. This is necessary to prevent infinite
148 // recursion in some cases. One common case is when
149 // people define `trait Sized: Sized { }` rather than `trait
151 predicates.retain(|r| self.visited.insert(r));
153 self.stack.extend(predicates);
155 ty::Predicate::WellFormed(..) => {
156 // Currently, we do not elaborate WF predicates,
157 // although we easily could.
159 ty::Predicate::ObjectSafe(..) => {
160 // Currently, we do not elaborate object-safe
163 ty::Predicate::Subtype(..) => {
164 // Currently, we do not "elaborate" predicates like `X
165 // <: Y`, though conceivably we might.
167 ty::Predicate::Projection(..) => {
168 // Nothing to elaborate in a projection predicate.
170 ty::Predicate::ClosureKind(..) => {
171 // Nothing to elaborate when waiting for a closure's kind to be inferred.
173 ty::Predicate::ConstEvaluatable(..) => {
174 // Currently, we do not elaborate const-evaluatable
178 ty::Predicate::RegionOutlives(..) => {
179 // Nothing to elaborate from `'a: 'b`.
182 ty::Predicate::TypeOutlives(ref data) => {
183 // We know that `T: 'a` for some type `T`. We can
184 // often elaborate this. For example, if we know that
185 // `[U]: 'a`, that implies that `U: 'a`. Similarly, if
186 // we know `&'a U: 'b`, then we know that `'a: 'b` and
189 // We can basically ignore bound regions here. So for
190 // example `for<'c> Foo<'a,'c>: 'b` can be elaborated to
193 // Ignore `for<'a> T: 'a` -- we might in the future
194 // consider this as evidence that `T: 'static`, but
195 // I'm a bit wary of such constructions and so for now
196 // I want to be conservative. --nmatsakis
197 let ty_max = data.skip_binder().0;
198 let r_min = data.skip_binder().1;
199 if r_min.is_late_bound() {
203 let visited = &mut self.visited;
205 tcx.outlives_components(ty_max)
207 .filter_map(|component| match component {
208 Component::Region(r) => if r.is_late_bound() {
211 Some(ty::Predicate::RegionOutlives(
212 ty::Binder::dummy(ty::OutlivesPredicate(r, r_min))))
215 Component::Param(p) => {
216 let ty = tcx.mk_ty_param(p.idx, p.name);
217 Some(ty::Predicate::TypeOutlives(
218 ty::Binder::dummy(ty::OutlivesPredicate(ty, r_min))))
221 Component::UnresolvedInferenceVariable(_) => {
225 Component::Projection(_) |
226 Component::EscapingProjection(_) => {
227 // We can probably do more here. This
228 // corresponds to a case like `<T as
233 .filter(|p| visited.insert(p)));
239 impl<'cx, 'gcx, 'tcx> Iterator for Elaborator<'cx, 'gcx, 'tcx> {
240 type Item = ty::Predicate<'tcx>;
242 fn size_hint(&self) -> (usize, Option<usize>) {
243 (self.stack.len(), None)
246 fn next(&mut self) -> Option<ty::Predicate<'tcx>> {
247 // Extract next item from top-most stack frame, if any.
248 let next_predicate = match self.stack.pop() {
249 Some(predicate) => predicate,
251 // No more stack frames. Done.
255 self.push(&next_predicate);
256 return Some(next_predicate);
260 ///////////////////////////////////////////////////////////////////////////
261 // Supertrait iterator
262 ///////////////////////////////////////////////////////////////////////////
264 pub type Supertraits<'cx, 'gcx, 'tcx> = FilterToTraits<Elaborator<'cx, 'gcx, 'tcx>>;
266 pub fn supertraits<'cx, 'gcx, 'tcx>(tcx: TyCtxt<'cx, 'gcx, 'tcx>,
267 trait_ref: ty::PolyTraitRef<'tcx>)
268 -> Supertraits<'cx, 'gcx, 'tcx>
270 elaborate_trait_ref(tcx, trait_ref).filter_to_traits()
273 pub fn transitive_bounds<'cx, 'gcx, 'tcx>(tcx: TyCtxt<'cx, 'gcx, 'tcx>,
274 bounds: &[ty::PolyTraitRef<'tcx>])
275 -> Supertraits<'cx, 'gcx, 'tcx>
277 elaborate_trait_refs(tcx, bounds).filter_to_traits()
280 ///////////////////////////////////////////////////////////////////////////
281 // Iterator over def-ids of supertraits
283 pub struct SupertraitDefIds<'a, 'gcx: 'a+'tcx, 'tcx: 'a> {
284 tcx: TyCtxt<'a, 'gcx, 'tcx>,
286 visited: FxHashSet<DefId>,
289 pub fn supertrait_def_ids<'cx, 'gcx, 'tcx>(tcx: TyCtxt<'cx, 'gcx, 'tcx>,
291 -> SupertraitDefIds<'cx, 'gcx, 'tcx>
295 stack: vec![trait_def_id],
296 visited: Some(trait_def_id).into_iter().collect(),
300 impl<'cx, 'gcx, 'tcx> Iterator for SupertraitDefIds<'cx, 'gcx, 'tcx> {
303 fn next(&mut self) -> Option<DefId> {
304 let def_id = match self.stack.pop() {
305 Some(def_id) => def_id,
306 None => { return None; }
309 let predicates = self.tcx.super_predicates_of(def_id);
310 let visited = &mut self.visited;
312 predicates.predicates
314 .filter_map(|p| p.to_opt_poly_trait_ref())
316 .filter(|&super_def_id| visited.insert(super_def_id)));
321 ///////////////////////////////////////////////////////////////////////////
323 ///////////////////////////////////////////////////////////////////////////
325 /// A filter around an iterator of predicates that makes it yield up
326 /// just trait references.
327 pub struct FilterToTraits<I> {
331 impl<I> FilterToTraits<I> {
332 fn new(base: I) -> FilterToTraits<I> {
333 FilterToTraits { base_iterator: base }
337 impl<'tcx,I:Iterator<Item=ty::Predicate<'tcx>>> Iterator for FilterToTraits<I> {
338 type Item = ty::PolyTraitRef<'tcx>;
340 fn next(&mut self) -> Option<ty::PolyTraitRef<'tcx>> {
342 match self.base_iterator.next() {
346 Some(ty::Predicate::Trait(data)) => {
347 return Some(data.to_poly_trait_ref());
354 fn size_hint(&self) -> (usize, Option<usize>) {
355 let (_, upper) = self.base_iterator.size_hint();
360 ///////////////////////////////////////////////////////////////////////////
362 ///////////////////////////////////////////////////////////////////////////
364 /// Instantiate all bound parameters of the impl with the given substs,
365 /// returning the resulting trait ref and all obligations that arise.
366 /// The obligations are closed under normalization.
367 pub fn impl_trait_ref_and_oblig<'a, 'gcx, 'tcx>(selcx: &mut SelectionContext<'a, 'gcx, 'tcx>,
368 param_env: ty::ParamEnv<'tcx>,
370 impl_substs: &Substs<'tcx>)
371 -> (ty::TraitRef<'tcx>,
372 Vec<PredicateObligation<'tcx>>)
375 selcx.tcx().impl_trait_ref(impl_def_id).unwrap();
377 impl_trait_ref.subst(selcx.tcx(), impl_substs);
378 let Normalized { value: impl_trait_ref, obligations: normalization_obligations1 } =
379 super::normalize(selcx, param_env, ObligationCause::dummy(), &impl_trait_ref);
381 let predicates = selcx.tcx().predicates_of(impl_def_id);
382 let predicates = predicates.instantiate(selcx.tcx(), impl_substs);
383 let Normalized { value: predicates, obligations: normalization_obligations2 } =
384 super::normalize(selcx, param_env, ObligationCause::dummy(), &predicates);
385 let impl_obligations =
386 predicates_for_generics(ObligationCause::dummy(), 0, param_env, &predicates);
388 let impl_obligations: Vec<_> =
389 impl_obligations.into_iter()
390 .chain(normalization_obligations1)
391 .chain(normalization_obligations2)
394 (impl_trait_ref, impl_obligations)
397 /// See `super::obligations_for_generics`
398 pub fn predicates_for_generics<'tcx>(cause: ObligationCause<'tcx>,
399 recursion_depth: usize,
400 param_env: ty::ParamEnv<'tcx>,
401 generic_bounds: &ty::InstantiatedPredicates<'tcx>)
402 -> Vec<PredicateObligation<'tcx>>
404 debug!("predicates_for_generics(generic_bounds={:?})",
407 generic_bounds.predicates.iter().map(|predicate| {
408 Obligation { cause: cause.clone(),
411 predicate: predicate.clone() }
415 pub fn predicate_for_trait_ref<'tcx>(
416 cause: ObligationCause<'tcx>,
417 param_env: ty::ParamEnv<'tcx>,
418 trait_ref: ty::TraitRef<'tcx>,
419 recursion_depth: usize)
420 -> PredicateObligation<'tcx>
426 predicate: trait_ref.to_predicate(),
430 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
431 pub fn predicate_for_trait_def(self,
432 param_env: ty::ParamEnv<'tcx>,
433 cause: ObligationCause<'tcx>,
435 recursion_depth: usize,
437 params: &[Kind<'tcx>])
438 -> PredicateObligation<'tcx>
440 let trait_ref = ty::TraitRef {
441 def_id: trait_def_id,
442 substs: self.mk_substs_trait(self_ty, params)
444 predicate_for_trait_ref(cause, param_env, trait_ref, recursion_depth)
447 /// Cast a trait reference into a reference to one of its super
448 /// traits; returns `None` if `target_trait_def_id` is not a
450 pub fn upcast_choices(self,
451 source_trait_ref: ty::PolyTraitRef<'tcx>,
452 target_trait_def_id: DefId)
453 -> Vec<ty::PolyTraitRef<'tcx>>
455 if source_trait_ref.def_id() == target_trait_def_id {
456 return vec![source_trait_ref]; // shorcut the most common case
459 supertraits(self, source_trait_ref)
460 .filter(|r| r.def_id() == target_trait_def_id)
464 /// Given a trait `trait_ref`, returns the number of vtable entries
465 /// that come from `trait_ref`, excluding its supertraits. Used in
466 /// computing the vtable base for an upcast trait of a trait object.
467 pub fn count_own_vtable_entries(self, trait_ref: ty::PolyTraitRef<'tcx>) -> usize {
469 // Count number of methods and add them to the total offset.
470 // Skip over associated types and constants.
471 for trait_item in self.associated_items(trait_ref.def_id()) {
472 if trait_item.kind == ty::AssociatedKind::Method {
479 /// Given an upcast trait object described by `object`, returns the
480 /// index of the method `method_def_id` (which should be part of
481 /// `object.upcast_trait_ref`) within the vtable for `object`.
482 pub fn get_vtable_index_of_object_method<N>(self,
483 object: &super::VtableObjectData<'tcx, N>,
484 method_def_id: DefId) -> usize {
485 // Count number of methods preceding the one we are selecting and
486 // add them to the total offset.
487 // Skip over associated types and constants.
488 let mut entries = object.vtable_base;
489 for trait_item in self.associated_items(object.upcast_trait_ref.def_id()) {
490 if trait_item.def_id == method_def_id {
491 // The item with the ID we were given really ought to be a method.
492 assert_eq!(trait_item.kind, ty::AssociatedKind::Method);
495 if trait_item.kind == ty::AssociatedKind::Method {
500 bug!("get_vtable_index_of_object_method: {:?} was not found",
504 pub fn closure_trait_ref_and_return_type(self,
505 fn_trait_def_id: DefId,
507 sig: ty::PolyFnSig<'tcx>,
508 tuple_arguments: TupleArgumentsFlag)
509 -> ty::Binder<(ty::TraitRef<'tcx>, Ty<'tcx>)>
511 let arguments_tuple = match tuple_arguments {
512 TupleArgumentsFlag::No => sig.skip_binder().inputs()[0],
513 TupleArgumentsFlag::Yes =>
514 self.intern_tup(sig.skip_binder().inputs()),
516 let trait_ref = ty::TraitRef {
517 def_id: fn_trait_def_id,
518 substs: self.mk_substs_trait(self_ty, &[arguments_tuple.into()]),
520 ty::Binder::bind((trait_ref, sig.skip_binder().output()))
523 pub fn generator_trait_ref_and_outputs(self,
524 fn_trait_def_id: DefId,
526 sig: ty::PolyGenSig<'tcx>)
527 -> ty::Binder<(ty::TraitRef<'tcx>, Ty<'tcx>, Ty<'tcx>)>
529 let trait_ref = ty::TraitRef {
530 def_id: fn_trait_def_id,
531 substs: self.mk_substs_trait(self_ty, &[]),
533 ty::Binder::bind((trait_ref, sig.skip_binder().yield_ty, sig.skip_binder().return_ty))
536 pub fn impl_is_default(self, node_item_def_id: DefId) -> bool {
537 match self.hir.as_local_node_id(node_item_def_id) {
539 let item = self.hir.expect_item(node_id);
540 if let hir::ItemKind::Impl(_, _, defaultness, ..) = item.node {
541 defaultness.is_default()
548 .impl_defaultness(node_item_def_id)
554 pub fn impl_item_is_final(self, node_item: &NodeItem<hir::Defaultness>) -> bool {
555 node_item.item.is_final() && !self.impl_is_default(node_item.node.def_id())
559 pub enum TupleArgumentsFlag { Yes, No }