]> git.lizzy.rs Git - rust.git/blob - src/librustc/ty/mod.rs
Rollup merge of #41141 - michaelwoerister:direct-metadata-ich-final, r=nikomatsakis
[rust.git] / src / librustc / ty / mod.rs
1 // Copyright 2012-2015 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 pub use self::Variance::*;
12 pub use self::AssociatedItemContainer::*;
13 pub use self::BorrowKind::*;
14 pub use self::IntVarValue::*;
15 pub use self::LvaluePreference::*;
16 pub use self::fold::TypeFoldable;
17
18 use dep_graph::{self, DepNode};
19 use hir::{map as hir_map, FreevarMap, TraitMap};
20 use hir::def::{Def, CtorKind, ExportMap};
21 use hir::def_id::{CrateNum, DefId, DefIndex, CRATE_DEF_INDEX, LOCAL_CRATE};
22 use ich::StableHashingContext;
23 use middle::const_val::ConstVal;
24 use middle::lang_items::{FnTraitLangItem, FnMutTraitLangItem, FnOnceTraitLangItem};
25 use middle::privacy::AccessLevels;
26 use middle::region::{CodeExtent, ROOT_CODE_EXTENT};
27 use middle::resolve_lifetime::ObjectLifetimeDefault;
28 use mir::Mir;
29 use traits;
30 use ty;
31 use ty::subst::{Subst, Substs};
32 use ty::util::IntTypeExt;
33 use ty::walk::TypeWalker;
34 use util::common::MemoizationMap;
35 use util::nodemap::{NodeSet, DefIdMap, FxHashMap};
36
37 use serialize::{self, Encodable, Encoder};
38 use std::borrow::Cow;
39 use std::cell::{Cell, RefCell, Ref};
40 use std::collections::BTreeMap;
41 use std::hash::{Hash, Hasher};
42 use std::ops::Deref;
43 use std::rc::Rc;
44 use std::slice;
45 use std::vec::IntoIter;
46 use std::mem;
47 use syntax::ast::{self, Name, NodeId};
48 use syntax::attr;
49 use syntax::symbol::{Symbol, InternedString};
50 use syntax_pos::{DUMMY_SP, Span};
51 use rustc_const_math::ConstInt;
52
53 use rustc_data_structures::accumulate_vec::IntoIter as AccIntoIter;
54 use rustc_data_structures::stable_hasher::{StableHasher, StableHasherResult,
55                                            HashStable};
56
57 use hir;
58 use hir::itemlikevisit::ItemLikeVisitor;
59
60 pub use self::sty::{Binder, DebruijnIndex};
61 pub use self::sty::{FnSig, PolyFnSig};
62 pub use self::sty::{InferTy, ParamTy, ProjectionTy, ExistentialPredicate};
63 pub use self::sty::{ClosureSubsts, TypeAndMut};
64 pub use self::sty::{TraitRef, TypeVariants, PolyTraitRef};
65 pub use self::sty::{ExistentialTraitRef, PolyExistentialTraitRef};
66 pub use self::sty::{ExistentialProjection, PolyExistentialProjection};
67 pub use self::sty::{BoundRegion, EarlyBoundRegion, FreeRegion, Region};
68 pub use self::sty::Issue32330;
69 pub use self::sty::{TyVid, IntVid, FloatVid, RegionVid, SkolemizedRegionVid};
70 pub use self::sty::BoundRegion::*;
71 pub use self::sty::InferTy::*;
72 pub use self::sty::Region::*;
73 pub use self::sty::TypeVariants::*;
74
75 pub use self::contents::TypeContents;
76 pub use self::context::{TyCtxt, GlobalArenas, tls};
77 pub use self::context::{Lift, TypeckTables};
78
79 pub use self::instance::{Instance, InstanceDef};
80
81 pub use self::trait_def::{TraitDef, TraitFlags};
82
83 pub use self::maps::queries;
84
85 pub mod adjustment;
86 pub mod cast;
87 pub mod error;
88 pub mod fast_reject;
89 pub mod fold;
90 pub mod inhabitedness;
91 pub mod item_path;
92 pub mod layout;
93 pub mod _match;
94 pub mod maps;
95 pub mod outlives;
96 pub mod relate;
97 pub mod subst;
98 pub mod trait_def;
99 pub mod walk;
100 pub mod wf;
101 pub mod util;
102
103 mod contents;
104 mod context;
105 mod flags;
106 mod instance;
107 mod structural_impls;
108 mod sty;
109
110 // Data types
111
112 /// The complete set of all analyses described in this module. This is
113 /// produced by the driver and fed to trans and later passes.
114 ///
115 /// NB: These contents are being migrated into queries using the
116 /// *on-demand* infrastructure.
117 #[derive(Clone)]
118 pub struct CrateAnalysis {
119     pub access_levels: Rc<AccessLevels>,
120     pub reachable: NodeSet,
121     pub name: String,
122     pub glob_map: Option<hir::GlobMap>,
123 }
124
125 #[derive(Clone)]
126 pub struct Resolutions {
127     pub freevars: FreevarMap,
128     pub trait_map: TraitMap,
129     pub maybe_unused_trait_imports: NodeSet,
130     pub export_map: ExportMap,
131 }
132
133 #[derive(Clone, Copy, PartialEq, Eq, Debug)]
134 pub enum AssociatedItemContainer {
135     TraitContainer(DefId),
136     ImplContainer(DefId),
137 }
138
139 impl AssociatedItemContainer {
140     pub fn id(&self) -> DefId {
141         match *self {
142             TraitContainer(id) => id,
143             ImplContainer(id) => id,
144         }
145     }
146 }
147
148 /// The "header" of an impl is everything outside the body: a Self type, a trait
149 /// ref (in the case of a trait impl), and a set of predicates (from the
150 /// bounds/where clauses).
151 #[derive(Clone, PartialEq, Eq, Hash, Debug)]
152 pub struct ImplHeader<'tcx> {
153     pub impl_def_id: DefId,
154     pub self_ty: Ty<'tcx>,
155     pub trait_ref: Option<TraitRef<'tcx>>,
156     pub predicates: Vec<Predicate<'tcx>>,
157 }
158
159 impl<'a, 'gcx, 'tcx> ImplHeader<'tcx> {
160     pub fn with_fresh_ty_vars(selcx: &mut traits::SelectionContext<'a, 'gcx, 'tcx>,
161                               impl_def_id: DefId)
162                               -> ImplHeader<'tcx>
163     {
164         let tcx = selcx.tcx();
165         let impl_substs = selcx.infcx().fresh_substs_for_item(DUMMY_SP, impl_def_id);
166
167         let header = ImplHeader {
168             impl_def_id: impl_def_id,
169             self_ty: tcx.item_type(impl_def_id),
170             trait_ref: tcx.impl_trait_ref(impl_def_id),
171             predicates: tcx.item_predicates(impl_def_id).predicates
172         }.subst(tcx, impl_substs);
173
174         let traits::Normalized { value: mut header, obligations } =
175             traits::normalize(selcx, traits::ObligationCause::dummy(), &header);
176
177         header.predicates.extend(obligations.into_iter().map(|o| o.predicate));
178         header
179     }
180 }
181
182 #[derive(Copy, Clone, Debug)]
183 pub struct AssociatedItem {
184     pub def_id: DefId,
185     pub name: Name,
186     pub kind: AssociatedKind,
187     pub vis: Visibility,
188     pub defaultness: hir::Defaultness,
189     pub container: AssociatedItemContainer,
190
191     /// Whether this is a method with an explicit self
192     /// as its first argument, allowing method calls.
193     pub method_has_self_argument: bool,
194 }
195
196 #[derive(Copy, Clone, PartialEq, Eq, Debug, RustcEncodable, RustcDecodable)]
197 pub enum AssociatedKind {
198     Const,
199     Method,
200     Type
201 }
202
203 impl AssociatedItem {
204     pub fn def(&self) -> Def {
205         match self.kind {
206             AssociatedKind::Const => Def::AssociatedConst(self.def_id),
207             AssociatedKind::Method => Def::Method(self.def_id),
208             AssociatedKind::Type => Def::AssociatedTy(self.def_id),
209         }
210     }
211
212     /// Tests whether the associated item admits a non-trivial implementation
213     /// for !
214     pub fn relevant_for_never<'tcx>(&self) -> bool {
215         match self.kind {
216             AssociatedKind::Const => true,
217             AssociatedKind::Type => true,
218             // FIXME(canndrew): Be more thorough here, check if any argument is uninhabited.
219             AssociatedKind::Method => !self.method_has_self_argument,
220         }
221     }
222 }
223
224 #[derive(Clone, Debug, PartialEq, Eq, Copy, RustcEncodable, RustcDecodable)]
225 pub enum Visibility {
226     /// Visible everywhere (including in other crates).
227     Public,
228     /// Visible only in the given crate-local module.
229     Restricted(DefId),
230     /// Not visible anywhere in the local crate. This is the visibility of private external items.
231     Invisible,
232 }
233
234 pub trait DefIdTree: Copy {
235     fn parent(self, id: DefId) -> Option<DefId>;
236
237     fn is_descendant_of(self, mut descendant: DefId, ancestor: DefId) -> bool {
238         if descendant.krate != ancestor.krate {
239             return false;
240         }
241
242         while descendant != ancestor {
243             match self.parent(descendant) {
244                 Some(parent) => descendant = parent,
245                 None => return false,
246             }
247         }
248         true
249     }
250 }
251
252 impl<'a, 'gcx, 'tcx> DefIdTree for TyCtxt<'a, 'gcx, 'tcx> {
253     fn parent(self, id: DefId) -> Option<DefId> {
254         self.def_key(id).parent.map(|index| DefId { index: index, ..id })
255     }
256 }
257
258 impl Visibility {
259     pub fn from_hir(visibility: &hir::Visibility, id: NodeId, tcx: TyCtxt) -> Self {
260         match *visibility {
261             hir::Public => Visibility::Public,
262             hir::Visibility::Crate => Visibility::Restricted(DefId::local(CRATE_DEF_INDEX)),
263             hir::Visibility::Restricted { ref path, .. } => match path.def {
264                 // If there is no resolution, `resolve` will have already reported an error, so
265                 // assume that the visibility is public to avoid reporting more privacy errors.
266                 Def::Err => Visibility::Public,
267                 def => Visibility::Restricted(def.def_id()),
268             },
269             hir::Inherited => {
270                 Visibility::Restricted(tcx.hir.local_def_id(tcx.hir.get_module_parent(id)))
271             }
272         }
273     }
274
275     /// Returns true if an item with this visibility is accessible from the given block.
276     pub fn is_accessible_from<T: DefIdTree>(self, module: DefId, tree: T) -> bool {
277         let restriction = match self {
278             // Public items are visible everywhere.
279             Visibility::Public => return true,
280             // Private items from other crates are visible nowhere.
281             Visibility::Invisible => return false,
282             // Restricted items are visible in an arbitrary local module.
283             Visibility::Restricted(other) if other.krate != module.krate => return false,
284             Visibility::Restricted(module) => module,
285         };
286
287         tree.is_descendant_of(module, restriction)
288     }
289
290     /// Returns true if this visibility is at least as accessible as the given visibility
291     pub fn is_at_least<T: DefIdTree>(self, vis: Visibility, tree: T) -> bool {
292         let vis_restriction = match vis {
293             Visibility::Public => return self == Visibility::Public,
294             Visibility::Invisible => return true,
295             Visibility::Restricted(module) => module,
296         };
297
298         self.is_accessible_from(vis_restriction, tree)
299     }
300 }
301
302 #[derive(Clone, PartialEq, RustcDecodable, RustcEncodable, Copy)]
303 pub enum Variance {
304     Covariant,      // T<A> <: T<B> iff A <: B -- e.g., function return type
305     Invariant,      // T<A> <: T<B> iff B == A -- e.g., type of mutable cell
306     Contravariant,  // T<A> <: T<B> iff B <: A -- e.g., function param type
307     Bivariant,      // T<A> <: T<B>            -- e.g., unused type parameter
308 }
309
310 #[derive(Clone, Copy, Debug, RustcDecodable, RustcEncodable)]
311 pub struct MethodCallee<'tcx> {
312     /// Impl method ID, for inherent methods, or trait method ID, otherwise.
313     pub def_id: DefId,
314     pub ty: Ty<'tcx>,
315     pub substs: &'tcx Substs<'tcx>
316 }
317
318 /// With method calls, we store some extra information in
319 /// side tables (i.e method_map). We use
320 /// MethodCall as a key to index into these tables instead of
321 /// just directly using the expression's NodeId. The reason
322 /// for this being that we may apply adjustments (coercions)
323 /// with the resulting expression also needing to use the
324 /// side tables. The problem with this is that we don't
325 /// assign a separate NodeId to this new expression
326 /// and so it would clash with the base expression if both
327 /// needed to add to the side tables. Thus to disambiguate
328 /// we also keep track of whether there's an adjustment in
329 /// our key.
330 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable)]
331 pub struct MethodCall {
332     pub expr_id: NodeId,
333     pub autoderef: u32
334 }
335
336 impl MethodCall {
337     pub fn expr(id: NodeId) -> MethodCall {
338         MethodCall {
339             expr_id: id,
340             autoderef: 0
341         }
342     }
343
344     pub fn autoderef(expr_id: NodeId, autoderef: u32) -> MethodCall {
345         MethodCall {
346             expr_id: expr_id,
347             autoderef: 1 + autoderef
348         }
349     }
350 }
351
352 // maps from an expression id that corresponds to a method call to the details
353 // of the method to be invoked
354 pub type MethodMap<'tcx> = FxHashMap<MethodCall, MethodCallee<'tcx>>;
355
356 // Contains information needed to resolve types and (in the future) look up
357 // the types of AST nodes.
358 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
359 pub struct CReaderCacheKey {
360     pub cnum: CrateNum,
361     pub pos: usize,
362 }
363
364 /// Describes the fragment-state associated with a NodeId.
365 ///
366 /// Currently only unfragmented paths have entries in the table,
367 /// but longer-term this enum is expected to expand to also
368 /// include data for fragmented paths.
369 #[derive(Copy, Clone, Debug)]
370 pub enum FragmentInfo {
371     Moved { var: NodeId, move_expr: NodeId },
372     Assigned { var: NodeId, assign_expr: NodeId, assignee_id: NodeId },
373 }
374
375 // Flags that we track on types. These flags are propagated upwards
376 // through the type during type construction, so that we can quickly
377 // check whether the type has various kinds of types in it without
378 // recursing over the type itself.
379 bitflags! {
380     flags TypeFlags: u32 {
381         const HAS_PARAMS         = 1 << 0,
382         const HAS_SELF           = 1 << 1,
383         const HAS_TY_INFER       = 1 << 2,
384         const HAS_RE_INFER       = 1 << 3,
385         const HAS_RE_SKOL        = 1 << 4,
386         const HAS_RE_EARLY_BOUND = 1 << 5,
387         const HAS_FREE_REGIONS   = 1 << 6,
388         const HAS_TY_ERR         = 1 << 7,
389         const HAS_PROJECTION     = 1 << 8,
390         const HAS_TY_CLOSURE     = 1 << 9,
391
392         // true if there are "names" of types and regions and so forth
393         // that are local to a particular fn
394         const HAS_LOCAL_NAMES    = 1 << 10,
395
396         // Present if the type belongs in a local type context.
397         // Only set for TyInfer other than Fresh.
398         const KEEP_IN_LOCAL_TCX  = 1 << 11,
399
400         // Is there a projection that does not involve a bound region?
401         // Currently we can't normalize projections w/ bound regions.
402         const HAS_NORMALIZABLE_PROJECTION = 1 << 12,
403
404         const NEEDS_SUBST        = TypeFlags::HAS_PARAMS.bits |
405                                    TypeFlags::HAS_SELF.bits |
406                                    TypeFlags::HAS_RE_EARLY_BOUND.bits,
407
408         // Flags representing the nominal content of a type,
409         // computed by FlagsComputation. If you add a new nominal
410         // flag, it should be added here too.
411         const NOMINAL_FLAGS     = TypeFlags::HAS_PARAMS.bits |
412                                   TypeFlags::HAS_SELF.bits |
413                                   TypeFlags::HAS_TY_INFER.bits |
414                                   TypeFlags::HAS_RE_INFER.bits |
415                                   TypeFlags::HAS_RE_SKOL.bits |
416                                   TypeFlags::HAS_RE_EARLY_BOUND.bits |
417                                   TypeFlags::HAS_FREE_REGIONS.bits |
418                                   TypeFlags::HAS_TY_ERR.bits |
419                                   TypeFlags::HAS_PROJECTION.bits |
420                                   TypeFlags::HAS_TY_CLOSURE.bits |
421                                   TypeFlags::HAS_LOCAL_NAMES.bits |
422                                   TypeFlags::KEEP_IN_LOCAL_TCX.bits,
423
424         // Caches for type_is_sized, type_moves_by_default
425         const SIZEDNESS_CACHED  = 1 << 16,
426         const IS_SIZED          = 1 << 17,
427         const MOVENESS_CACHED   = 1 << 18,
428         const MOVES_BY_DEFAULT  = 1 << 19,
429     }
430 }
431
432 pub struct TyS<'tcx> {
433     pub sty: TypeVariants<'tcx>,
434     pub flags: Cell<TypeFlags>,
435
436     // the maximal depth of any bound regions appearing in this type.
437     region_depth: u32,
438 }
439
440 impl<'tcx> PartialEq for TyS<'tcx> {
441     #[inline]
442     fn eq(&self, other: &TyS<'tcx>) -> bool {
443         // (self as *const _) == (other as *const _)
444         (self as *const TyS<'tcx>) == (other as *const TyS<'tcx>)
445     }
446 }
447 impl<'tcx> Eq for TyS<'tcx> {}
448
449 impl<'tcx> Hash for TyS<'tcx> {
450     fn hash<H: Hasher>(&self, s: &mut H) {
451         (self as *const TyS).hash(s)
452     }
453 }
454
455 impl<'a, 'tcx> HashStable<StableHashingContext<'a, 'tcx>> for ty::TyS<'tcx> {
456     fn hash_stable<W: StableHasherResult>(&self,
457                                           hcx: &mut StableHashingContext<'a, 'tcx>,
458                                           hasher: &mut StableHasher<W>) {
459         let ty::TyS {
460             ref sty,
461
462             // The other fields just provide fast access to information that is
463             // also contained in `sty`, so no need to hash them.
464             flags: _,
465             region_depth: _,
466         } = *self;
467
468         sty.hash_stable(hcx, hasher);
469     }
470 }
471
472 pub type Ty<'tcx> = &'tcx TyS<'tcx>;
473
474 impl<'tcx> serialize::UseSpecializedEncodable for Ty<'tcx> {}
475 impl<'tcx> serialize::UseSpecializedDecodable for Ty<'tcx> {}
476
477 /// A wrapper for slices with the additional invariant
478 /// that the slice is interned and no other slice with
479 /// the same contents can exist in the same context.
480 /// This means we can use pointer + length for both
481 /// equality comparisons and hashing.
482 #[derive(Debug, RustcEncodable)]
483 pub struct Slice<T>([T]);
484
485 impl<T> PartialEq for Slice<T> {
486     #[inline]
487     fn eq(&self, other: &Slice<T>) -> bool {
488         (&self.0 as *const [T]) == (&other.0 as *const [T])
489     }
490 }
491 impl<T> Eq for Slice<T> {}
492
493 impl<T> Hash for Slice<T> {
494     fn hash<H: Hasher>(&self, s: &mut H) {
495         (self.as_ptr(), self.len()).hash(s)
496     }
497 }
498
499 impl<T> Deref for Slice<T> {
500     type Target = [T];
501     fn deref(&self) -> &[T] {
502         &self.0
503     }
504 }
505
506 impl<'a, T> IntoIterator for &'a Slice<T> {
507     type Item = &'a T;
508     type IntoIter = <&'a [T] as IntoIterator>::IntoIter;
509     fn into_iter(self) -> Self::IntoIter {
510         self[..].iter()
511     }
512 }
513
514 impl<'tcx> serialize::UseSpecializedDecodable for &'tcx Slice<Ty<'tcx>> {}
515
516 impl<T> Slice<T> {
517     pub fn empty<'a>() -> &'a Slice<T> {
518         unsafe {
519             mem::transmute(slice::from_raw_parts(0x1 as *const T, 0))
520         }
521     }
522 }
523
524 /// Upvars do not get their own node-id. Instead, we use the pair of
525 /// the original var id (that is, the root variable that is referenced
526 /// by the upvar) and the id of the closure expression.
527 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
528 pub struct UpvarId {
529     pub var_id: NodeId,
530     pub closure_expr_id: NodeId,
531 }
532
533 #[derive(Clone, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable, Copy)]
534 pub enum BorrowKind {
535     /// Data must be immutable and is aliasable.
536     ImmBorrow,
537
538     /// Data must be immutable but not aliasable.  This kind of borrow
539     /// cannot currently be expressed by the user and is used only in
540     /// implicit closure bindings. It is needed when the closure
541     /// is borrowing or mutating a mutable referent, e.g.:
542     ///
543     ///    let x: &mut isize = ...;
544     ///    let y = || *x += 5;
545     ///
546     /// If we were to try to translate this closure into a more explicit
547     /// form, we'd encounter an error with the code as written:
548     ///
549     ///    struct Env { x: & &mut isize }
550     ///    let x: &mut isize = ...;
551     ///    let y = (&mut Env { &x }, fn_ptr);  // Closure is pair of env and fn
552     ///    fn fn_ptr(env: &mut Env) { **env.x += 5; }
553     ///
554     /// This is then illegal because you cannot mutate a `&mut` found
555     /// in an aliasable location. To solve, you'd have to translate with
556     /// an `&mut` borrow:
557     ///
558     ///    struct Env { x: & &mut isize }
559     ///    let x: &mut isize = ...;
560     ///    let y = (&mut Env { &mut x }, fn_ptr); // changed from &x to &mut x
561     ///    fn fn_ptr(env: &mut Env) { **env.x += 5; }
562     ///
563     /// Now the assignment to `**env.x` is legal, but creating a
564     /// mutable pointer to `x` is not because `x` is not mutable. We
565     /// could fix this by declaring `x` as `let mut x`. This is ok in
566     /// user code, if awkward, but extra weird for closures, since the
567     /// borrow is hidden.
568     ///
569     /// So we introduce a "unique imm" borrow -- the referent is
570     /// immutable, but not aliasable. This solves the problem. For
571     /// simplicity, we don't give users the way to express this
572     /// borrow, it's just used when translating closures.
573     UniqueImmBorrow,
574
575     /// Data is mutable and not aliasable.
576     MutBorrow
577 }
578
579 /// Information describing the capture of an upvar. This is computed
580 /// during `typeck`, specifically by `regionck`.
581 #[derive(PartialEq, Clone, Debug, Copy, RustcEncodable, RustcDecodable)]
582 pub enum UpvarCapture<'tcx> {
583     /// Upvar is captured by value. This is always true when the
584     /// closure is labeled `move`, but can also be true in other cases
585     /// depending on inference.
586     ByValue,
587
588     /// Upvar is captured by reference.
589     ByRef(UpvarBorrow<'tcx>),
590 }
591
592 #[derive(PartialEq, Clone, Copy, RustcEncodable, RustcDecodable)]
593 pub struct UpvarBorrow<'tcx> {
594     /// The kind of borrow: by-ref upvars have access to shared
595     /// immutable borrows, which are not part of the normal language
596     /// syntax.
597     pub kind: BorrowKind,
598
599     /// Region of the resulting reference.
600     pub region: &'tcx ty::Region,
601 }
602
603 pub type UpvarCaptureMap<'tcx> = FxHashMap<UpvarId, UpvarCapture<'tcx>>;
604
605 #[derive(Copy, Clone)]
606 pub struct ClosureUpvar<'tcx> {
607     pub def: Def,
608     pub span: Span,
609     pub ty: Ty<'tcx>,
610 }
611
612 #[derive(Clone, Copy, PartialEq)]
613 pub enum IntVarValue {
614     IntType(ast::IntTy),
615     UintType(ast::UintTy),
616 }
617
618 #[derive(Copy, Clone, RustcEncodable, RustcDecodable)]
619 pub struct TypeParameterDef {
620     pub name: Name,
621     pub def_id: DefId,
622     pub index: u32,
623     pub has_default: bool,
624     pub object_lifetime_default: ObjectLifetimeDefault,
625
626     /// `pure_wrt_drop`, set by the (unsafe) `#[may_dangle]` attribute
627     /// on generic parameter `T`, asserts data behind the parameter
628     /// `T` won't be accessed during the parent type's `Drop` impl.
629     pub pure_wrt_drop: bool,
630 }
631
632 #[derive(Copy, Clone, RustcEncodable, RustcDecodable)]
633 pub struct RegionParameterDef {
634     pub name: Name,
635     pub def_id: DefId,
636     pub index: u32,
637     pub issue_32330: Option<ty::Issue32330>,
638
639     /// `pure_wrt_drop`, set by the (unsafe) `#[may_dangle]` attribute
640     /// on generic parameter `'a`, asserts data of lifetime `'a`
641     /// won't be accessed during the parent type's `Drop` impl.
642     pub pure_wrt_drop: bool,
643 }
644
645 impl RegionParameterDef {
646     pub fn to_early_bound_region_data(&self) -> ty::EarlyBoundRegion {
647         ty::EarlyBoundRegion {
648             index: self.index,
649             name: self.name,
650         }
651     }
652
653     pub fn to_bound_region(&self) -> ty::BoundRegion {
654         ty::BoundRegion::BrNamed(self.def_id, self.name)
655     }
656 }
657
658 /// Information about the formal type/lifetime parameters associated
659 /// with an item or method. Analogous to hir::Generics.
660 #[derive(Clone, Debug, RustcEncodable, RustcDecodable)]
661 pub struct Generics {
662     pub parent: Option<DefId>,
663     pub parent_regions: u32,
664     pub parent_types: u32,
665     pub regions: Vec<RegionParameterDef>,
666     pub types: Vec<TypeParameterDef>,
667
668     /// Reverse map to each `TypeParameterDef`'s `index` field, from
669     /// `def_id.index` (`def_id.krate` is the same as the item's).
670     pub type_param_to_index: BTreeMap<DefIndex, u32>,
671
672     pub has_self: bool,
673 }
674
675 impl Generics {
676     pub fn parent_count(&self) -> usize {
677         self.parent_regions as usize + self.parent_types as usize
678     }
679
680     pub fn own_count(&self) -> usize {
681         self.regions.len() + self.types.len()
682     }
683
684     pub fn count(&self) -> usize {
685         self.parent_count() + self.own_count()
686     }
687
688     pub fn region_param(&self, param: &EarlyBoundRegion) -> &RegionParameterDef {
689         assert_eq!(self.parent_count(), 0);
690         &self.regions[param.index as usize - self.has_self as usize]
691     }
692
693     pub fn type_param(&self, param: &ParamTy) -> &TypeParameterDef {
694         assert_eq!(self.parent_count(), 0);
695         &self.types[param.idx as usize - self.has_self as usize - self.regions.len()]
696     }
697 }
698
699 /// Bounds on generics.
700 #[derive(Clone, Default)]
701 pub struct GenericPredicates<'tcx> {
702     pub parent: Option<DefId>,
703     pub predicates: Vec<Predicate<'tcx>>,
704 }
705
706 impl<'tcx> serialize::UseSpecializedEncodable for GenericPredicates<'tcx> {}
707 impl<'tcx> serialize::UseSpecializedDecodable for GenericPredicates<'tcx> {}
708
709 impl<'a, 'gcx, 'tcx> GenericPredicates<'tcx> {
710     pub fn instantiate(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>, substs: &Substs<'tcx>)
711                        -> InstantiatedPredicates<'tcx> {
712         let mut instantiated = InstantiatedPredicates::empty();
713         self.instantiate_into(tcx, &mut instantiated, substs);
714         instantiated
715     }
716     pub fn instantiate_own(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>, substs: &Substs<'tcx>)
717                            -> InstantiatedPredicates<'tcx> {
718         InstantiatedPredicates {
719             predicates: self.predicates.subst(tcx, substs)
720         }
721     }
722
723     fn instantiate_into(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>,
724                         instantiated: &mut InstantiatedPredicates<'tcx>,
725                         substs: &Substs<'tcx>) {
726         if let Some(def_id) = self.parent {
727             tcx.item_predicates(def_id).instantiate_into(tcx, instantiated, substs);
728         }
729         instantiated.predicates.extend(self.predicates.iter().map(|p| p.subst(tcx, substs)))
730     }
731
732     pub fn instantiate_supertrait(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>,
733                                   poly_trait_ref: &ty::PolyTraitRef<'tcx>)
734                                   -> InstantiatedPredicates<'tcx>
735     {
736         assert_eq!(self.parent, None);
737         InstantiatedPredicates {
738             predicates: self.predicates.iter().map(|pred| {
739                 pred.subst_supertrait(tcx, poly_trait_ref)
740             }).collect()
741         }
742     }
743 }
744
745 #[derive(Clone, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
746 pub enum Predicate<'tcx> {
747     /// Corresponds to `where Foo : Bar<A,B,C>`. `Foo` here would be
748     /// the `Self` type of the trait reference and `A`, `B`, and `C`
749     /// would be the type parameters.
750     Trait(PolyTraitPredicate<'tcx>),
751
752     /// where `T1 == T2`.
753     Equate(PolyEquatePredicate<'tcx>),
754
755     /// where 'a : 'b
756     RegionOutlives(PolyRegionOutlivesPredicate<'tcx>),
757
758     /// where T : 'a
759     TypeOutlives(PolyTypeOutlivesPredicate<'tcx>),
760
761     /// where <T as TraitRef>::Name == X, approximately.
762     /// See `ProjectionPredicate` struct for details.
763     Projection(PolyProjectionPredicate<'tcx>),
764
765     /// no syntax: T WF
766     WellFormed(Ty<'tcx>),
767
768     /// trait must be object-safe
769     ObjectSafe(DefId),
770
771     /// No direct syntax. May be thought of as `where T : FnFoo<...>`
772     /// for some substitutions `...` and T being a closure type.
773     /// Satisfied (or refuted) once we know the closure's kind.
774     ClosureKind(DefId, ClosureKind),
775 }
776
777 impl<'a, 'gcx, 'tcx> Predicate<'tcx> {
778     /// Performs a substitution suitable for going from a
779     /// poly-trait-ref to supertraits that must hold if that
780     /// poly-trait-ref holds. This is slightly different from a normal
781     /// substitution in terms of what happens with bound regions.  See
782     /// lengthy comment below for details.
783     pub fn subst_supertrait(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>,
784                             trait_ref: &ty::PolyTraitRef<'tcx>)
785                             -> ty::Predicate<'tcx>
786     {
787         // The interaction between HRTB and supertraits is not entirely
788         // obvious. Let me walk you (and myself) through an example.
789         //
790         // Let's start with an easy case. Consider two traits:
791         //
792         //     trait Foo<'a> : Bar<'a,'a> { }
793         //     trait Bar<'b,'c> { }
794         //
795         // Now, if we have a trait reference `for<'x> T : Foo<'x>`, then
796         // we can deduce that `for<'x> T : Bar<'x,'x>`. Basically, if we
797         // knew that `Foo<'x>` (for any 'x) then we also know that
798         // `Bar<'x,'x>` (for any 'x). This more-or-less falls out from
799         // normal substitution.
800         //
801         // In terms of why this is sound, the idea is that whenever there
802         // is an impl of `T:Foo<'a>`, it must show that `T:Bar<'a,'a>`
803         // holds.  So if there is an impl of `T:Foo<'a>` that applies to
804         // all `'a`, then we must know that `T:Bar<'a,'a>` holds for all
805         // `'a`.
806         //
807         // Another example to be careful of is this:
808         //
809         //     trait Foo1<'a> : for<'b> Bar1<'a,'b> { }
810         //     trait Bar1<'b,'c> { }
811         //
812         // Here, if we have `for<'x> T : Foo1<'x>`, then what do we know?
813         // The answer is that we know `for<'x,'b> T : Bar1<'x,'b>`. The
814         // reason is similar to the previous example: any impl of
815         // `T:Foo1<'x>` must show that `for<'b> T : Bar1<'x, 'b>`.  So
816         // basically we would want to collapse the bound lifetimes from
817         // the input (`trait_ref`) and the supertraits.
818         //
819         // To achieve this in practice is fairly straightforward. Let's
820         // consider the more complicated scenario:
821         //
822         // - We start out with `for<'x> T : Foo1<'x>`. In this case, `'x`
823         //   has a De Bruijn index of 1. We want to produce `for<'x,'b> T : Bar1<'x,'b>`,
824         //   where both `'x` and `'b` would have a DB index of 1.
825         //   The substitution from the input trait-ref is therefore going to be
826         //   `'a => 'x` (where `'x` has a DB index of 1).
827         // - The super-trait-ref is `for<'b> Bar1<'a,'b>`, where `'a` is an
828         //   early-bound parameter and `'b' is a late-bound parameter with a
829         //   DB index of 1.
830         // - If we replace `'a` with `'x` from the input, it too will have
831         //   a DB index of 1, and thus we'll have `for<'x,'b> Bar1<'x,'b>`
832         //   just as we wanted.
833         //
834         // There is only one catch. If we just apply the substitution `'a
835         // => 'x` to `for<'b> Bar1<'a,'b>`, the substitution code will
836         // adjust the DB index because we substituting into a binder (it
837         // tries to be so smart...) resulting in `for<'x> for<'b>
838         // Bar1<'x,'b>` (we have no syntax for this, so use your
839         // imagination). Basically the 'x will have DB index of 2 and 'b
840         // will have DB index of 1. Not quite what we want. So we apply
841         // the substitution to the *contents* of the trait reference,
842         // rather than the trait reference itself (put another way, the
843         // substitution code expects equal binding levels in the values
844         // from the substitution and the value being substituted into, and
845         // this trick achieves that).
846
847         let substs = &trait_ref.0.substs;
848         match *self {
849             Predicate::Trait(ty::Binder(ref data)) =>
850                 Predicate::Trait(ty::Binder(data.subst(tcx, substs))),
851             Predicate::Equate(ty::Binder(ref data)) =>
852                 Predicate::Equate(ty::Binder(data.subst(tcx, substs))),
853             Predicate::RegionOutlives(ty::Binder(ref data)) =>
854                 Predicate::RegionOutlives(ty::Binder(data.subst(tcx, substs))),
855             Predicate::TypeOutlives(ty::Binder(ref data)) =>
856                 Predicate::TypeOutlives(ty::Binder(data.subst(tcx, substs))),
857             Predicate::Projection(ty::Binder(ref data)) =>
858                 Predicate::Projection(ty::Binder(data.subst(tcx, substs))),
859             Predicate::WellFormed(data) =>
860                 Predicate::WellFormed(data.subst(tcx, substs)),
861             Predicate::ObjectSafe(trait_def_id) =>
862                 Predicate::ObjectSafe(trait_def_id),
863             Predicate::ClosureKind(closure_def_id, kind) =>
864                 Predicate::ClosureKind(closure_def_id, kind),
865         }
866     }
867 }
868
869 #[derive(Clone, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
870 pub struct TraitPredicate<'tcx> {
871     pub trait_ref: TraitRef<'tcx>
872 }
873 pub type PolyTraitPredicate<'tcx> = ty::Binder<TraitPredicate<'tcx>>;
874
875 impl<'tcx> TraitPredicate<'tcx> {
876     pub fn def_id(&self) -> DefId {
877         self.trait_ref.def_id
878     }
879
880     /// Creates the dep-node for selecting/evaluating this trait reference.
881     fn dep_node(&self) -> DepNode<DefId> {
882         // Extact the trait-def and first def-id from inputs.  See the
883         // docs for `DepNode::TraitSelect` for more information.
884         let trait_def_id = self.def_id();
885         let input_def_id =
886             self.input_types()
887                 .flat_map(|t| t.walk())
888                 .filter_map(|t| match t.sty {
889                     ty::TyAdt(adt_def, _) => Some(adt_def.did),
890                     _ => None
891                 })
892                 .next()
893                 .unwrap_or(trait_def_id);
894         DepNode::TraitSelect {
895             trait_def_id: trait_def_id,
896             input_def_id: input_def_id
897         }
898     }
899
900     pub fn input_types<'a>(&'a self) -> impl DoubleEndedIterator<Item=Ty<'tcx>> + 'a {
901         self.trait_ref.input_types()
902     }
903
904     pub fn self_ty(&self) -> Ty<'tcx> {
905         self.trait_ref.self_ty()
906     }
907 }
908
909 impl<'tcx> PolyTraitPredicate<'tcx> {
910     pub fn def_id(&self) -> DefId {
911         // ok to skip binder since trait def-id does not care about regions
912         self.0.def_id()
913     }
914
915     pub fn dep_node(&self) -> DepNode<DefId> {
916         // ok to skip binder since depnode does not care about regions
917         self.0.dep_node()
918     }
919 }
920
921 #[derive(Clone, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable)]
922 pub struct EquatePredicate<'tcx>(pub Ty<'tcx>, pub Ty<'tcx>); // `0 == 1`
923 pub type PolyEquatePredicate<'tcx> = ty::Binder<EquatePredicate<'tcx>>;
924
925 #[derive(Clone, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable)]
926 pub struct OutlivesPredicate<A,B>(pub A, pub B); // `A : B`
927 pub type PolyOutlivesPredicate<A,B> = ty::Binder<OutlivesPredicate<A,B>>;
928 pub type PolyRegionOutlivesPredicate<'tcx> = PolyOutlivesPredicate<&'tcx ty::Region,
929                                                                    &'tcx ty::Region>;
930 pub type PolyTypeOutlivesPredicate<'tcx> = PolyOutlivesPredicate<Ty<'tcx>, &'tcx ty::Region>;
931
932 /// This kind of predicate has no *direct* correspondent in the
933 /// syntax, but it roughly corresponds to the syntactic forms:
934 ///
935 /// 1. `T : TraitRef<..., Item=Type>`
936 /// 2. `<T as TraitRef<...>>::Item == Type` (NYI)
937 ///
938 /// In particular, form #1 is "desugared" to the combination of a
939 /// normal trait predicate (`T : TraitRef<...>`) and one of these
940 /// predicates. Form #2 is a broader form in that it also permits
941 /// equality between arbitrary types. Processing an instance of Form
942 /// #2 eventually yields one of these `ProjectionPredicate`
943 /// instances to normalize the LHS.
944 #[derive(Copy, Clone, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
945 pub struct ProjectionPredicate<'tcx> {
946     pub projection_ty: ProjectionTy<'tcx>,
947     pub ty: Ty<'tcx>,
948 }
949
950 pub type PolyProjectionPredicate<'tcx> = Binder<ProjectionPredicate<'tcx>>;
951
952 impl<'tcx> PolyProjectionPredicate<'tcx> {
953     pub fn item_name(&self) -> Name {
954         self.0.projection_ty.item_name // safe to skip the binder to access a name
955     }
956 }
957
958 pub trait ToPolyTraitRef<'tcx> {
959     fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx>;
960 }
961
962 impl<'tcx> ToPolyTraitRef<'tcx> for TraitRef<'tcx> {
963     fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx> {
964         assert!(!self.has_escaping_regions());
965         ty::Binder(self.clone())
966     }
967 }
968
969 impl<'tcx> ToPolyTraitRef<'tcx> for PolyTraitPredicate<'tcx> {
970     fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx> {
971         self.map_bound_ref(|trait_pred| trait_pred.trait_ref)
972     }
973 }
974
975 impl<'tcx> ToPolyTraitRef<'tcx> for PolyProjectionPredicate<'tcx> {
976     fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx> {
977         // Note: unlike with TraitRef::to_poly_trait_ref(),
978         // self.0.trait_ref is permitted to have escaping regions.
979         // This is because here `self` has a `Binder` and so does our
980         // return value, so we are preserving the number of binding
981         // levels.
982         ty::Binder(self.0.projection_ty.trait_ref)
983     }
984 }
985
986 pub trait ToPredicate<'tcx> {
987     fn to_predicate(&self) -> Predicate<'tcx>;
988 }
989
990 impl<'tcx> ToPredicate<'tcx> for TraitRef<'tcx> {
991     fn to_predicate(&self) -> Predicate<'tcx> {
992         // we're about to add a binder, so let's check that we don't
993         // accidentally capture anything, or else that might be some
994         // weird debruijn accounting.
995         assert!(!self.has_escaping_regions());
996
997         ty::Predicate::Trait(ty::Binder(ty::TraitPredicate {
998             trait_ref: self.clone()
999         }))
1000     }
1001 }
1002
1003 impl<'tcx> ToPredicate<'tcx> for PolyTraitRef<'tcx> {
1004     fn to_predicate(&self) -> Predicate<'tcx> {
1005         ty::Predicate::Trait(self.to_poly_trait_predicate())
1006     }
1007 }
1008
1009 impl<'tcx> ToPredicate<'tcx> for PolyEquatePredicate<'tcx> {
1010     fn to_predicate(&self) -> Predicate<'tcx> {
1011         Predicate::Equate(self.clone())
1012     }
1013 }
1014
1015 impl<'tcx> ToPredicate<'tcx> for PolyRegionOutlivesPredicate<'tcx> {
1016     fn to_predicate(&self) -> Predicate<'tcx> {
1017         Predicate::RegionOutlives(self.clone())
1018     }
1019 }
1020
1021 impl<'tcx> ToPredicate<'tcx> for PolyTypeOutlivesPredicate<'tcx> {
1022     fn to_predicate(&self) -> Predicate<'tcx> {
1023         Predicate::TypeOutlives(self.clone())
1024     }
1025 }
1026
1027 impl<'tcx> ToPredicate<'tcx> for PolyProjectionPredicate<'tcx> {
1028     fn to_predicate(&self) -> Predicate<'tcx> {
1029         Predicate::Projection(self.clone())
1030     }
1031 }
1032
1033 impl<'tcx> Predicate<'tcx> {
1034     /// Iterates over the types in this predicate. Note that in all
1035     /// cases this is skipping over a binder, so late-bound regions
1036     /// with depth 0 are bound by the predicate.
1037     pub fn walk_tys(&self) -> IntoIter<Ty<'tcx>> {
1038         let vec: Vec<_> = match *self {
1039             ty::Predicate::Trait(ref data) => {
1040                 data.skip_binder().input_types().collect()
1041             }
1042             ty::Predicate::Equate(ty::Binder(ref data)) => {
1043                 vec![data.0, data.1]
1044             }
1045             ty::Predicate::TypeOutlives(ty::Binder(ref data)) => {
1046                 vec![data.0]
1047             }
1048             ty::Predicate::RegionOutlives(..) => {
1049                 vec![]
1050             }
1051             ty::Predicate::Projection(ref data) => {
1052                 let trait_inputs = data.0.projection_ty.trait_ref.input_types();
1053                 trait_inputs.chain(Some(data.0.ty)).collect()
1054             }
1055             ty::Predicate::WellFormed(data) => {
1056                 vec![data]
1057             }
1058             ty::Predicate::ObjectSafe(_trait_def_id) => {
1059                 vec![]
1060             }
1061             ty::Predicate::ClosureKind(_closure_def_id, _kind) => {
1062                 vec![]
1063             }
1064         };
1065
1066         // The only reason to collect into a vector here is that I was
1067         // too lazy to make the full (somewhat complicated) iterator
1068         // type that would be needed here. But I wanted this fn to
1069         // return an iterator conceptually, rather than a `Vec`, so as
1070         // to be closer to `Ty::walk`.
1071         vec.into_iter()
1072     }
1073
1074     pub fn to_opt_poly_trait_ref(&self) -> Option<PolyTraitRef<'tcx>> {
1075         match *self {
1076             Predicate::Trait(ref t) => {
1077                 Some(t.to_poly_trait_ref())
1078             }
1079             Predicate::Projection(..) |
1080             Predicate::Equate(..) |
1081             Predicate::RegionOutlives(..) |
1082             Predicate::WellFormed(..) |
1083             Predicate::ObjectSafe(..) |
1084             Predicate::ClosureKind(..) |
1085             Predicate::TypeOutlives(..) => {
1086                 None
1087             }
1088         }
1089     }
1090 }
1091
1092 /// Represents the bounds declared on a particular set of type
1093 /// parameters.  Should eventually be generalized into a flag list of
1094 /// where clauses.  You can obtain a `InstantiatedPredicates` list from a
1095 /// `GenericPredicates` by using the `instantiate` method. Note that this method
1096 /// reflects an important semantic invariant of `InstantiatedPredicates`: while
1097 /// the `GenericPredicates` are expressed in terms of the bound type
1098 /// parameters of the impl/trait/whatever, an `InstantiatedPredicates` instance
1099 /// represented a set of bounds for some particular instantiation,
1100 /// meaning that the generic parameters have been substituted with
1101 /// their values.
1102 ///
1103 /// Example:
1104 ///
1105 ///     struct Foo<T,U:Bar<T>> { ... }
1106 ///
1107 /// Here, the `GenericPredicates` for `Foo` would contain a list of bounds like
1108 /// `[[], [U:Bar<T>]]`.  Now if there were some particular reference
1109 /// like `Foo<isize,usize>`, then the `InstantiatedPredicates` would be `[[],
1110 /// [usize:Bar<isize>]]`.
1111 #[derive(Clone)]
1112 pub struct InstantiatedPredicates<'tcx> {
1113     pub predicates: Vec<Predicate<'tcx>>,
1114 }
1115
1116 impl<'tcx> InstantiatedPredicates<'tcx> {
1117     pub fn empty() -> InstantiatedPredicates<'tcx> {
1118         InstantiatedPredicates { predicates: vec![] }
1119     }
1120
1121     pub fn is_empty(&self) -> bool {
1122         self.predicates.is_empty()
1123     }
1124 }
1125
1126 /// When type checking, we use the `ParameterEnvironment` to track
1127 /// details about the type/lifetime parameters that are in scope.
1128 /// It primarily stores the bounds information.
1129 ///
1130 /// Note: This information might seem to be redundant with the data in
1131 /// `tcx.ty_param_defs`, but it is not. That table contains the
1132 /// parameter definitions from an "outside" perspective, but this
1133 /// struct will contain the bounds for a parameter as seen from inside
1134 /// the function body. Currently the only real distinction is that
1135 /// bound lifetime parameters are replaced with free ones, but in the
1136 /// future I hope to refine the representation of types so as to make
1137 /// more distinctions clearer.
1138 #[derive(Clone)]
1139 pub struct ParameterEnvironment<'tcx> {
1140     /// See `construct_free_substs` for details.
1141     pub free_substs: &'tcx Substs<'tcx>,
1142
1143     /// Each type parameter has an implicit region bound that
1144     /// indicates it must outlive at least the function body (the user
1145     /// may specify stronger requirements). This field indicates the
1146     /// region of the callee.
1147     pub implicit_region_bound: &'tcx ty::Region,
1148
1149     /// Obligations that the caller must satisfy. This is basically
1150     /// the set of bounds on the in-scope type parameters, translated
1151     /// into Obligations, and elaborated and normalized.
1152     pub caller_bounds: Vec<ty::Predicate<'tcx>>,
1153
1154     /// Scope that is attached to free regions for this scope. This
1155     /// is usually the id of the fn body, but for more abstract scopes
1156     /// like structs we often use the node-id of the struct.
1157     ///
1158     /// FIXME(#3696). It would be nice to refactor so that free
1159     /// regions don't have this implicit scope and instead introduce
1160     /// relationships in the environment.
1161     pub free_id_outlive: CodeExtent,
1162
1163     /// A cache for `moves_by_default`.
1164     pub is_copy_cache: RefCell<FxHashMap<Ty<'tcx>, bool>>,
1165
1166     /// A cache for `type_is_sized`
1167     pub is_sized_cache: RefCell<FxHashMap<Ty<'tcx>, bool>>,
1168 }
1169
1170 impl<'a, 'tcx> ParameterEnvironment<'tcx> {
1171     pub fn with_caller_bounds(&self,
1172                               caller_bounds: Vec<ty::Predicate<'tcx>>)
1173                               -> ParameterEnvironment<'tcx>
1174     {
1175         ParameterEnvironment {
1176             free_substs: self.free_substs,
1177             implicit_region_bound: self.implicit_region_bound,
1178             caller_bounds: caller_bounds,
1179             free_id_outlive: self.free_id_outlive,
1180             is_copy_cache: RefCell::new(FxHashMap()),
1181             is_sized_cache: RefCell::new(FxHashMap()),
1182         }
1183     }
1184
1185     /// Construct a parameter environment given an item, impl item, or trait item
1186     pub fn for_item(tcx: TyCtxt<'a, 'tcx, 'tcx>, id: NodeId)
1187                     -> ParameterEnvironment<'tcx> {
1188         match tcx.hir.find(id) {
1189             Some(hir_map::NodeImplItem(ref impl_item)) => {
1190                 match impl_item.node {
1191                     hir::ImplItemKind::Type(_) | hir::ImplItemKind::Const(..) => {
1192                         // associated types don't have their own entry (for some reason),
1193                         // so for now just grab environment for the impl
1194                         let impl_id = tcx.hir.get_parent(id);
1195                         let impl_def_id = tcx.hir.local_def_id(impl_id);
1196                         tcx.construct_parameter_environment(impl_item.span,
1197                                                             impl_def_id,
1198                                                             tcx.region_maps.item_extent(id))
1199                     }
1200                     hir::ImplItemKind::Method(_, ref body) => {
1201                         tcx.construct_parameter_environment(
1202                             impl_item.span,
1203                             tcx.hir.local_def_id(id),
1204                             tcx.region_maps.call_site_extent(id, body.node_id))
1205                     }
1206                 }
1207             }
1208             Some(hir_map::NodeTraitItem(trait_item)) => {
1209                 match trait_item.node {
1210                     hir::TraitItemKind::Type(..) | hir::TraitItemKind::Const(..) => {
1211                         // associated types don't have their own entry (for some reason),
1212                         // so for now just grab environment for the trait
1213                         let trait_id = tcx.hir.get_parent(id);
1214                         let trait_def_id = tcx.hir.local_def_id(trait_id);
1215                         tcx.construct_parameter_environment(trait_item.span,
1216                                                             trait_def_id,
1217                                                             tcx.region_maps.item_extent(id))
1218                     }
1219                     hir::TraitItemKind::Method(_, ref body) => {
1220                         // Use call-site for extent (unless this is a
1221                         // trait method with no default; then fallback
1222                         // to the method id).
1223                         let extent = if let hir::TraitMethod::Provided(body_id) = *body {
1224                             // default impl: use call_site extent as free_id_outlive bound.
1225                             tcx.region_maps.call_site_extent(id, body_id.node_id)
1226                         } else {
1227                             // no default impl: use item extent as free_id_outlive bound.
1228                             tcx.region_maps.item_extent(id)
1229                         };
1230                         tcx.construct_parameter_environment(
1231                             trait_item.span,
1232                             tcx.hir.local_def_id(id),
1233                             extent)
1234                     }
1235                 }
1236             }
1237             Some(hir_map::NodeItem(item)) => {
1238                 match item.node {
1239                     hir::ItemFn(.., body_id) => {
1240                         // We assume this is a function.
1241                         let fn_def_id = tcx.hir.local_def_id(id);
1242
1243                         tcx.construct_parameter_environment(
1244                             item.span,
1245                             fn_def_id,
1246                             tcx.region_maps.call_site_extent(id, body_id.node_id))
1247                     }
1248                     hir::ItemEnum(..) |
1249                     hir::ItemStruct(..) |
1250                     hir::ItemUnion(..) |
1251                     hir::ItemTy(..) |
1252                     hir::ItemImpl(..) |
1253                     hir::ItemConst(..) |
1254                     hir::ItemStatic(..) => {
1255                         let def_id = tcx.hir.local_def_id(id);
1256                         tcx.construct_parameter_environment(item.span,
1257                                                             def_id,
1258                                                             tcx.region_maps.item_extent(id))
1259                     }
1260                     hir::ItemTrait(..) => {
1261                         let def_id = tcx.hir.local_def_id(id);
1262                         tcx.construct_parameter_environment(item.span,
1263                                                             def_id,
1264                                                             tcx.region_maps.item_extent(id))
1265                     }
1266                     _ => {
1267                         span_bug!(item.span,
1268                                   "ParameterEnvironment::for_item():
1269                                    can't create a parameter \
1270                                    environment for this kind of item")
1271                     }
1272                 }
1273             }
1274             Some(hir_map::NodeExpr(expr)) => {
1275                 // This is a convenience to allow closures to work.
1276                 if let hir::ExprClosure(.., body, _) = expr.node {
1277                     let def_id = tcx.hir.local_def_id(id);
1278                     let base_def_id = tcx.closure_base_def_id(def_id);
1279                     tcx.construct_parameter_environment(
1280                         expr.span,
1281                         base_def_id,
1282                         tcx.region_maps.call_site_extent(id, body.node_id))
1283                 } else {
1284                     tcx.empty_parameter_environment()
1285                 }
1286             }
1287             Some(hir_map::NodeForeignItem(item)) => {
1288                 let def_id = tcx.hir.local_def_id(id);
1289                 tcx.construct_parameter_environment(item.span,
1290                                                     def_id,
1291                                                     ROOT_CODE_EXTENT)
1292             }
1293             Some(hir_map::NodeStructCtor(..)) |
1294             Some(hir_map::NodeVariant(..)) => {
1295                 let def_id = tcx.hir.local_def_id(id);
1296                 tcx.construct_parameter_environment(tcx.hir.span(id),
1297                                                     def_id,
1298                                                     ROOT_CODE_EXTENT)
1299             }
1300             it => {
1301                 bug!("ParameterEnvironment::from_item(): \
1302                       `{}` = {:?} is unsupported",
1303                      tcx.hir.node_to_string(id), it)
1304             }
1305         }
1306     }
1307 }
1308
1309 #[derive(Copy, Clone, Debug)]
1310 pub struct Destructor {
1311     /// The def-id of the destructor method
1312     pub did: DefId,
1313     /// Invoking the destructor of a dtorck type during usual cleanup
1314     /// (e.g. the glue emitted for stack unwinding) requires all
1315     /// lifetimes in the type-structure of `adt` to strictly outlive
1316     /// the adt value itself.
1317     ///
1318     /// If `adt` is not dtorck, then the adt's destructor can be
1319     /// invoked even when there are lifetimes in the type-structure of
1320     /// `adt` that do not strictly outlive the adt value itself.
1321     /// (This allows programs to make cyclic structures without
1322     /// resorting to unsafe means; see RFCs 769 and 1238).
1323     pub is_dtorck: bool,
1324 }
1325
1326 bitflags! {
1327     flags AdtFlags: u32 {
1328         const NO_ADT_FLAGS        = 0,
1329         const IS_ENUM             = 1 << 0,
1330         const IS_PHANTOM_DATA     = 1 << 1,
1331         const IS_FUNDAMENTAL      = 1 << 2,
1332         const IS_UNION            = 1 << 3,
1333         const IS_BOX              = 1 << 4,
1334     }
1335 }
1336
1337 #[derive(Debug)]
1338 pub struct VariantDef {
1339     /// The variant's DefId. If this is a tuple-like struct,
1340     /// this is the DefId of the struct's ctor.
1341     pub did: DefId,
1342     pub name: Name, // struct's name if this is a struct
1343     pub discr: VariantDiscr,
1344     pub fields: Vec<FieldDef>,
1345     pub ctor_kind: CtorKind,
1346 }
1347
1348 #[derive(Copy, Clone, Debug, PartialEq, Eq, RustcEncodable, RustcDecodable)]
1349 pub enum VariantDiscr {
1350     /// Explicit value for this variant, i.e. `X = 123`.
1351     /// The `DefId` corresponds to the embedded constant.
1352     Explicit(DefId),
1353
1354     /// The previous variant's discriminant plus one.
1355     /// For efficiency reasons, the distance from the
1356     /// last `Explicit` discriminant is being stored,
1357     /// or `0` for the first variant, if it has none.
1358     Relative(usize),
1359 }
1360
1361 #[derive(Debug)]
1362 pub struct FieldDef {
1363     pub did: DefId,
1364     pub name: Name,
1365     pub vis: Visibility,
1366 }
1367
1368 /// The definition of an abstract data type - a struct or enum.
1369 ///
1370 /// These are all interned (by intern_adt_def) into the adt_defs
1371 /// table.
1372 pub struct AdtDef {
1373     pub did: DefId,
1374     pub variants: Vec<VariantDef>,
1375     flags: AdtFlags,
1376     pub repr: ReprOptions,
1377 }
1378
1379 impl PartialEq for AdtDef {
1380     // AdtDef are always interned and this is part of TyS equality
1381     #[inline]
1382     fn eq(&self, other: &Self) -> bool { self as *const _ == other as *const _ }
1383 }
1384
1385 impl Eq for AdtDef {}
1386
1387 impl Hash for AdtDef {
1388     #[inline]
1389     fn hash<H: Hasher>(&self, s: &mut H) {
1390         (self as *const AdtDef).hash(s)
1391     }
1392 }
1393
1394 impl<'tcx> serialize::UseSpecializedEncodable for &'tcx AdtDef {
1395     fn default_encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
1396         self.did.encode(s)
1397     }
1398 }
1399
1400 impl<'tcx> serialize::UseSpecializedDecodable for &'tcx AdtDef {}
1401
1402
1403 impl<'a, 'tcx> HashStable<StableHashingContext<'a, 'tcx>> for AdtDef {
1404     fn hash_stable<W: StableHasherResult>(&self,
1405                                           hcx: &mut StableHashingContext<'a, 'tcx>,
1406                                           hasher: &mut StableHasher<W>) {
1407         let ty::AdtDef {
1408             did,
1409             ref variants,
1410             ref flags,
1411             ref repr,
1412         } = *self;
1413
1414         did.hash_stable(hcx, hasher);
1415         variants.hash_stable(hcx, hasher);
1416         flags.hash_stable(hcx, hasher);
1417         repr.hash_stable(hcx, hasher);
1418     }
1419 }
1420
1421 #[derive(Copy, Clone, Debug, Eq, PartialEq)]
1422 pub enum AdtKind { Struct, Union, Enum }
1423
1424 /// Represents the repr options provided by the user,
1425 #[derive(Copy, Clone, Eq, PartialEq, RustcEncodable, RustcDecodable, Default)]
1426 pub struct ReprOptions {
1427     pub c: bool,
1428     pub packed: bool,
1429     pub simd: bool,
1430     pub int: Option<attr::IntType>,
1431     // Internal only for now. If true, don't reorder fields.
1432     pub linear: bool,
1433 }
1434
1435 impl_stable_hash_for!(struct ReprOptions {
1436     c,
1437     packed,
1438     simd,
1439     int,
1440     linear
1441 });
1442
1443 impl ReprOptions {
1444     pub fn new(tcx: TyCtxt, did: DefId) -> ReprOptions {
1445         let mut ret = ReprOptions::default();
1446
1447         for attr in tcx.get_attrs(did).iter() {
1448             for r in attr::find_repr_attrs(tcx.sess.diagnostic(), attr) {
1449                 match r {
1450                     attr::ReprExtern => ret.c = true,
1451                     attr::ReprPacked => ret.packed = true,
1452                     attr::ReprSimd => ret.simd = true,
1453                     attr::ReprInt(i) => ret.int = Some(i),
1454                 }
1455             }
1456         }
1457
1458         // FIXME(eddyb) This is deprecated and should be removed.
1459         if tcx.has_attr(did, "simd") {
1460             ret.simd = true;
1461         }
1462
1463         // This is here instead of layout because the choice must make it into metadata.
1464         ret.linear = !tcx.consider_optimizing(|| format!("Reorder fields of {:?}",
1465             tcx.item_path_str(did)));
1466         ret
1467     }
1468
1469     pub fn discr_type(&self) -> attr::IntType {
1470         self.int.unwrap_or(attr::SignedInt(ast::IntTy::Is))
1471     }
1472
1473     /// Returns true if this `#[repr()]` should inhabit "smart enum
1474     /// layout" optimizations, such as representing `Foo<&T>` as a
1475     /// single pointer.
1476     pub fn inhibit_enum_layout_opt(&self) -> bool {
1477         self.c || self.int.is_some()
1478     }
1479 }
1480
1481 impl<'a, 'gcx, 'tcx> AdtDef {
1482     fn new(tcx: TyCtxt,
1483            did: DefId,
1484            kind: AdtKind,
1485            variants: Vec<VariantDef>,
1486            repr: ReprOptions) -> Self {
1487         let mut flags = AdtFlags::NO_ADT_FLAGS;
1488         let attrs = tcx.get_attrs(did);
1489         if attr::contains_name(&attrs, "fundamental") {
1490             flags = flags | AdtFlags::IS_FUNDAMENTAL;
1491         }
1492         if Some(did) == tcx.lang_items.phantom_data() {
1493             flags = flags | AdtFlags::IS_PHANTOM_DATA;
1494         }
1495         if Some(did) == tcx.lang_items.owned_box() {
1496             flags = flags | AdtFlags::IS_BOX;
1497         }
1498         match kind {
1499             AdtKind::Enum => flags = flags | AdtFlags::IS_ENUM,
1500             AdtKind::Union => flags = flags | AdtFlags::IS_UNION,
1501             AdtKind::Struct => {}
1502         }
1503         AdtDef {
1504             did: did,
1505             variants: variants,
1506             flags: flags,
1507             repr: repr,
1508         }
1509     }
1510
1511     #[inline]
1512     pub fn is_struct(&self) -> bool {
1513         !self.is_union() && !self.is_enum()
1514     }
1515
1516     #[inline]
1517     pub fn is_union(&self) -> bool {
1518         self.flags.intersects(AdtFlags::IS_UNION)
1519     }
1520
1521     #[inline]
1522     pub fn is_enum(&self) -> bool {
1523         self.flags.intersects(AdtFlags::IS_ENUM)
1524     }
1525
1526     /// Returns the kind of the ADT - Struct or Enum.
1527     #[inline]
1528     pub fn adt_kind(&self) -> AdtKind {
1529         if self.is_enum() {
1530             AdtKind::Enum
1531         } else if self.is_union() {
1532             AdtKind::Union
1533         } else {
1534             AdtKind::Struct
1535         }
1536     }
1537
1538     pub fn descr(&self) -> &'static str {
1539         match self.adt_kind() {
1540             AdtKind::Struct => "struct",
1541             AdtKind::Union => "union",
1542             AdtKind::Enum => "enum",
1543         }
1544     }
1545
1546     pub fn variant_descr(&self) -> &'static str {
1547         match self.adt_kind() {
1548             AdtKind::Struct => "struct",
1549             AdtKind::Union => "union",
1550             AdtKind::Enum => "variant",
1551         }
1552     }
1553
1554     /// Returns whether this is a dtorck type. If this returns
1555     /// true, this type being safe for destruction requires it to be
1556     /// alive; Otherwise, only the contents are required to be.
1557     #[inline]
1558     pub fn is_dtorck(&'gcx self, tcx: TyCtxt) -> bool {
1559         self.destructor(tcx).map_or(false, |d| d.is_dtorck)
1560     }
1561
1562     /// Returns whether this type is #[fundamental] for the purposes
1563     /// of coherence checking.
1564     #[inline]
1565     pub fn is_fundamental(&self) -> bool {
1566         self.flags.intersects(AdtFlags::IS_FUNDAMENTAL)
1567     }
1568
1569     /// Returns true if this is PhantomData<T>.
1570     #[inline]
1571     pub fn is_phantom_data(&self) -> bool {
1572         self.flags.intersects(AdtFlags::IS_PHANTOM_DATA)
1573     }
1574
1575     /// Returns true if this is Box<T>.
1576     #[inline]
1577     pub fn is_box(&self) -> bool {
1578         self.flags.intersects(AdtFlags::IS_BOX)
1579     }
1580
1581     /// Returns whether this type has a destructor.
1582     pub fn has_dtor(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> bool {
1583         self.destructor(tcx).is_some()
1584     }
1585
1586     /// Asserts this is a struct and returns the struct's unique
1587     /// variant.
1588     pub fn struct_variant(&self) -> &VariantDef {
1589         assert!(!self.is_enum());
1590         &self.variants[0]
1591     }
1592
1593     #[inline]
1594     pub fn predicates(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> GenericPredicates<'gcx> {
1595         tcx.item_predicates(self.did)
1596     }
1597
1598     /// Returns an iterator over all fields contained
1599     /// by this ADT.
1600     #[inline]
1601     pub fn all_fields<'s>(&'s self) -> impl Iterator<Item = &'s FieldDef> {
1602         self.variants.iter().flat_map(|v| v.fields.iter())
1603     }
1604
1605     #[inline]
1606     pub fn is_univariant(&self) -> bool {
1607         self.variants.len() == 1
1608     }
1609
1610     pub fn is_payloadfree(&self) -> bool {
1611         !self.variants.is_empty() &&
1612             self.variants.iter().all(|v| v.fields.is_empty())
1613     }
1614
1615     pub fn variant_with_id(&self, vid: DefId) -> &VariantDef {
1616         self.variants
1617             .iter()
1618             .find(|v| v.did == vid)
1619             .expect("variant_with_id: unknown variant")
1620     }
1621
1622     pub fn variant_index_with_id(&self, vid: DefId) -> usize {
1623         self.variants
1624             .iter()
1625             .position(|v| v.did == vid)
1626             .expect("variant_index_with_id: unknown variant")
1627     }
1628
1629     pub fn variant_of_def(&self, def: Def) -> &VariantDef {
1630         match def {
1631             Def::Variant(vid) | Def::VariantCtor(vid, ..) => self.variant_with_id(vid),
1632             Def::Struct(..) | Def::StructCtor(..) | Def::Union(..) |
1633             Def::TyAlias(..) | Def::AssociatedTy(..) | Def::SelfTy(..) => self.struct_variant(),
1634             _ => bug!("unexpected def {:?} in variant_of_def", def)
1635         }
1636     }
1637
1638     pub fn discriminants(&'a self, tcx: TyCtxt<'a, 'gcx, 'tcx>)
1639                          -> impl Iterator<Item=ConstInt> + 'a {
1640         let repr_type = self.repr.discr_type();
1641         let initial = repr_type.initial_discriminant(tcx.global_tcx());
1642         let mut prev_discr = None::<ConstInt>;
1643         self.variants.iter().map(move |v| {
1644             let mut discr = prev_discr.map_or(initial, |d| d.wrap_incr());
1645             if let VariantDiscr::Explicit(expr_did) = v.discr {
1646                 match tcx.maps.monomorphic_const_eval.borrow()[&expr_did] {
1647                     Ok(ConstVal::Integral(v)) => {
1648                         discr = v;
1649                     }
1650                     _ => {}
1651                 }
1652             }
1653             prev_discr = Some(discr);
1654
1655             discr
1656         })
1657     }
1658
1659     pub fn destructor(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> Option<Destructor> {
1660         queries::adt_destructor::get(tcx, DUMMY_SP, self.did)
1661     }
1662
1663     /// Returns a simpler type such that `Self: Sized` if and only
1664     /// if that type is Sized, or `TyErr` if this type is recursive.
1665     ///
1666     /// HACK: instead of returning a list of types, this function can
1667     /// return a tuple. In that case, the result is Sized only if
1668     /// all elements of the tuple are Sized.
1669     ///
1670     /// This is generally the `struct_tail` if this is a struct, or a
1671     /// tuple of them if this is an enum.
1672     ///
1673     /// Oddly enough, checking that the sized-constraint is Sized is
1674     /// actually more expressive than checking all members:
1675     /// the Sized trait is inductive, so an associated type that references
1676     /// Self would prevent its containing ADT from being Sized.
1677     ///
1678     /// Due to normalization being eager, this applies even if
1679     /// the associated type is behind a pointer, e.g. issue #31299.
1680     pub fn sized_constraint(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> Ty<'tcx> {
1681         self.calculate_sized_constraint_inner(tcx.global_tcx(), &mut Vec::new())
1682     }
1683
1684     /// Calculates the Sized-constraint.
1685     ///
1686     /// As the Sized-constraint of enums can be a *set* of types,
1687     /// the Sized-constraint may need to be a set also. Because introducing
1688     /// a new type of IVar is currently a complex affair, the Sized-constraint
1689     /// may be a tuple.
1690     ///
1691     /// In fact, there are only a few options for the constraint:
1692     ///     - `bool`, if the type is always Sized
1693     ///     - an obviously-unsized type
1694     ///     - a type parameter or projection whose Sizedness can't be known
1695     ///     - a tuple of type parameters or projections, if there are multiple
1696     ///       such.
1697     ///     - a TyError, if a type contained itself. The representability
1698     ///       check should catch this case.
1699     fn calculate_sized_constraint_inner(&self,
1700                                         tcx: TyCtxt<'a, 'tcx, 'tcx>,
1701                                         stack: &mut Vec<DefId>)
1702                                         -> Ty<'tcx>
1703     {
1704         if let Some(ty) = tcx.maps.adt_sized_constraint.borrow().get(&self.did) {
1705             return ty;
1706         }
1707
1708         // Follow the memoization pattern: push the computation of
1709         // DepNode::SizedConstraint as our current task.
1710         let _task = tcx.dep_graph.in_task(DepNode::SizedConstraint(self.did));
1711
1712         if stack.contains(&self.did) {
1713             debug!("calculate_sized_constraint: {:?} is recursive", self);
1714             // This should be reported as an error by `check_representable`.
1715             //
1716             // Consider the type as Sized in the meanwhile to avoid
1717             // further errors.
1718             tcx.maps.adt_sized_constraint.borrow_mut().insert(self.did, tcx.types.err);
1719             return tcx.types.err;
1720         }
1721
1722         stack.push(self.did);
1723
1724         let tys : Vec<_> =
1725             self.variants.iter().flat_map(|v| {
1726                 v.fields.last()
1727             }).flat_map(|f| {
1728                 let ty = tcx.item_type(f.did);
1729                 self.sized_constraint_for_ty(tcx, stack, ty)
1730             }).collect();
1731
1732         let self_ = stack.pop().unwrap();
1733         assert_eq!(self_, self.did);
1734
1735         let ty = match tys.len() {
1736             _ if tys.references_error() => tcx.types.err,
1737             0 => tcx.types.bool,
1738             1 => tys[0],
1739             _ => tcx.intern_tup(&tys[..], false)
1740         };
1741
1742         let old = tcx.maps.adt_sized_constraint.borrow().get(&self.did).cloned();
1743         match old {
1744             Some(old_ty) => {
1745                 debug!("calculate_sized_constraint: {:?} recurred", self);
1746                 assert_eq!(old_ty, tcx.types.err);
1747                 old_ty
1748             }
1749             None => {
1750                 debug!("calculate_sized_constraint: {:?} => {:?}", self, ty);
1751                 tcx.maps.adt_sized_constraint.borrow_mut().insert(self.did, ty);
1752                 ty
1753             }
1754         }
1755     }
1756
1757     fn sized_constraint_for_ty(&self,
1758                                tcx: TyCtxt<'a, 'tcx, 'tcx>,
1759                                stack: &mut Vec<DefId>,
1760                                ty: Ty<'tcx>)
1761                                -> Vec<Ty<'tcx>> {
1762         let result = match ty.sty {
1763             TyBool | TyChar | TyInt(..) | TyUint(..) | TyFloat(..) |
1764             TyRawPtr(..) | TyRef(..) | TyFnDef(..) | TyFnPtr(_) |
1765             TyArray(..) | TyClosure(..) | TyNever => {
1766                 vec![]
1767             }
1768
1769             TyStr | TyDynamic(..) | TySlice(_) | TyError => {
1770                 // these are never sized - return the target type
1771                 vec![ty]
1772             }
1773
1774             TyTuple(ref tys, _) => {
1775                 match tys.last() {
1776                     None => vec![],
1777                     Some(ty) => self.sized_constraint_for_ty(tcx, stack, ty)
1778                 }
1779             }
1780
1781             TyAdt(adt, substs) => {
1782                 // recursive case
1783                 let adt_ty =
1784                     adt.calculate_sized_constraint_inner(tcx, stack)
1785                        .subst(tcx, substs);
1786                 debug!("sized_constraint_for_ty({:?}) intermediate = {:?}",
1787                        ty, adt_ty);
1788                 if let ty::TyTuple(ref tys, _) = adt_ty.sty {
1789                     tys.iter().flat_map(|ty| {
1790                         self.sized_constraint_for_ty(tcx, stack, ty)
1791                     }).collect()
1792                 } else {
1793                     self.sized_constraint_for_ty(tcx, stack, adt_ty)
1794                 }
1795             }
1796
1797             TyProjection(..) | TyAnon(..) => {
1798                 // must calculate explicitly.
1799                 // FIXME: consider special-casing always-Sized projections
1800                 vec![ty]
1801             }
1802
1803             TyParam(..) => {
1804                 // perf hack: if there is a `T: Sized` bound, then
1805                 // we know that `T` is Sized and do not need to check
1806                 // it on the impl.
1807
1808                 let sized_trait = match tcx.lang_items.sized_trait() {
1809                     Some(x) => x,
1810                     _ => return vec![ty]
1811                 };
1812                 let sized_predicate = Binder(TraitRef {
1813                     def_id: sized_trait,
1814                     substs: tcx.mk_substs_trait(ty, &[])
1815                 }).to_predicate();
1816                 let predicates = tcx.item_predicates(self.did).predicates;
1817                 if predicates.into_iter().any(|p| p == sized_predicate) {
1818                     vec![]
1819                 } else {
1820                     vec![ty]
1821                 }
1822             }
1823
1824             TyInfer(..) => {
1825                 bug!("unexpected type `{:?}` in sized_constraint_for_ty",
1826                      ty)
1827             }
1828         };
1829         debug!("sized_constraint_for_ty({:?}) = {:?}", ty, result);
1830         result
1831     }
1832 }
1833
1834 impl<'a, 'gcx, 'tcx> VariantDef {
1835     #[inline]
1836     pub fn find_field_named(&self,
1837                             name: ast::Name)
1838                             -> Option<&FieldDef> {
1839         self.fields.iter().find(|f| f.name == name)
1840     }
1841
1842     #[inline]
1843     pub fn index_of_field_named(&self,
1844                                 name: ast::Name)
1845                                 -> Option<usize> {
1846         self.fields.iter().position(|f| f.name == name)
1847     }
1848
1849     #[inline]
1850     pub fn field_named(&self, name: ast::Name) -> &FieldDef {
1851         self.find_field_named(name).unwrap()
1852     }
1853 }
1854
1855 impl<'a, 'gcx, 'tcx> FieldDef {
1856     pub fn ty(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>, subst: &Substs<'tcx>) -> Ty<'tcx> {
1857         tcx.item_type(self.did).subst(tcx, subst)
1858     }
1859 }
1860
1861 /// Records the substitutions used to translate the polytype for an
1862 /// item into the monotype of an item reference.
1863 #[derive(Clone, RustcEncodable, RustcDecodable)]
1864 pub struct ItemSubsts<'tcx> {
1865     pub substs: &'tcx Substs<'tcx>,
1866 }
1867
1868 #[derive(Clone, Copy, PartialOrd, Ord, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable)]
1869 pub enum ClosureKind {
1870     // Warning: Ordering is significant here! The ordering is chosen
1871     // because the trait Fn is a subtrait of FnMut and so in turn, and
1872     // hence we order it so that Fn < FnMut < FnOnce.
1873     Fn,
1874     FnMut,
1875     FnOnce,
1876 }
1877
1878 impl<'a, 'tcx> ClosureKind {
1879     pub fn trait_did(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> DefId {
1880         match *self {
1881             ClosureKind::Fn => tcx.require_lang_item(FnTraitLangItem),
1882             ClosureKind::FnMut => {
1883                 tcx.require_lang_item(FnMutTraitLangItem)
1884             }
1885             ClosureKind::FnOnce => {
1886                 tcx.require_lang_item(FnOnceTraitLangItem)
1887             }
1888         }
1889     }
1890
1891     /// True if this a type that impls this closure kind
1892     /// must also implement `other`.
1893     pub fn extends(self, other: ty::ClosureKind) -> bool {
1894         match (self, other) {
1895             (ClosureKind::Fn, ClosureKind::Fn) => true,
1896             (ClosureKind::Fn, ClosureKind::FnMut) => true,
1897             (ClosureKind::Fn, ClosureKind::FnOnce) => true,
1898             (ClosureKind::FnMut, ClosureKind::FnMut) => true,
1899             (ClosureKind::FnMut, ClosureKind::FnOnce) => true,
1900             (ClosureKind::FnOnce, ClosureKind::FnOnce) => true,
1901             _ => false,
1902         }
1903     }
1904 }
1905
1906 impl<'tcx> TyS<'tcx> {
1907     /// Iterator that walks `self` and any types reachable from
1908     /// `self`, in depth-first order. Note that just walks the types
1909     /// that appear in `self`, it does not descend into the fields of
1910     /// structs or variants. For example:
1911     ///
1912     /// ```notrust
1913     /// isize => { isize }
1914     /// Foo<Bar<isize>> => { Foo<Bar<isize>>, Bar<isize>, isize }
1915     /// [isize] => { [isize], isize }
1916     /// ```
1917     pub fn walk(&'tcx self) -> TypeWalker<'tcx> {
1918         TypeWalker::new(self)
1919     }
1920
1921     /// Iterator that walks the immediate children of `self`.  Hence
1922     /// `Foo<Bar<i32>, u32>` yields the sequence `[Bar<i32>, u32]`
1923     /// (but not `i32`, like `walk`).
1924     pub fn walk_shallow(&'tcx self) -> AccIntoIter<walk::TypeWalkerArray<'tcx>> {
1925         walk::walk_shallow(self)
1926     }
1927
1928     /// Walks `ty` and any types appearing within `ty`, invoking the
1929     /// callback `f` on each type. If the callback returns false, then the
1930     /// children of the current type are ignored.
1931     ///
1932     /// Note: prefer `ty.walk()` where possible.
1933     pub fn maybe_walk<F>(&'tcx self, mut f: F)
1934         where F : FnMut(Ty<'tcx>) -> bool
1935     {
1936         let mut walker = self.walk();
1937         while let Some(ty) = walker.next() {
1938             if !f(ty) {
1939                 walker.skip_current_subtree();
1940             }
1941         }
1942     }
1943 }
1944
1945 impl<'tcx> ItemSubsts<'tcx> {
1946     pub fn is_noop(&self) -> bool {
1947         self.substs.is_noop()
1948     }
1949 }
1950
1951 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
1952 pub enum LvaluePreference {
1953     PreferMutLvalue,
1954     NoPreference
1955 }
1956
1957 impl LvaluePreference {
1958     pub fn from_mutbl(m: hir::Mutability) -> Self {
1959         match m {
1960             hir::MutMutable => PreferMutLvalue,
1961             hir::MutImmutable => NoPreference,
1962         }
1963     }
1964 }
1965
1966 impl BorrowKind {
1967     pub fn from_mutbl(m: hir::Mutability) -> BorrowKind {
1968         match m {
1969             hir::MutMutable => MutBorrow,
1970             hir::MutImmutable => ImmBorrow,
1971         }
1972     }
1973
1974     /// Returns a mutability `m` such that an `&m T` pointer could be used to obtain this borrow
1975     /// kind. Because borrow kinds are richer than mutabilities, we sometimes have to pick a
1976     /// mutability that is stronger than necessary so that it at least *would permit* the borrow in
1977     /// question.
1978     pub fn to_mutbl_lossy(self) -> hir::Mutability {
1979         match self {
1980             MutBorrow => hir::MutMutable,
1981             ImmBorrow => hir::MutImmutable,
1982
1983             // We have no type corresponding to a unique imm borrow, so
1984             // use `&mut`. It gives all the capabilities of an `&uniq`
1985             // and hence is a safe "over approximation".
1986             UniqueImmBorrow => hir::MutMutable,
1987         }
1988     }
1989
1990     pub fn to_user_str(&self) -> &'static str {
1991         match *self {
1992             MutBorrow => "mutable",
1993             ImmBorrow => "immutable",
1994             UniqueImmBorrow => "uniquely immutable",
1995         }
1996     }
1997 }
1998
1999 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
2000     pub fn body_tables(self, body: hir::BodyId) -> &'gcx TypeckTables<'gcx> {
2001         self.item_tables(self.hir.body_owner_def_id(body))
2002     }
2003
2004     pub fn item_tables(self, def_id: DefId) -> &'gcx TypeckTables<'gcx> {
2005         queries::typeck_tables::get(self, DUMMY_SP, def_id)
2006     }
2007
2008     pub fn expr_span(self, id: NodeId) -> Span {
2009         match self.hir.find(id) {
2010             Some(hir_map::NodeExpr(e)) => {
2011                 e.span
2012             }
2013             Some(f) => {
2014                 bug!("Node id {} is not an expr: {:?}", id, f);
2015             }
2016             None => {
2017                 bug!("Node id {} is not present in the node map", id);
2018             }
2019         }
2020     }
2021
2022     pub fn local_var_name_str(self, id: NodeId) -> InternedString {
2023         match self.hir.find(id) {
2024             Some(hir_map::NodeLocal(pat)) => {
2025                 match pat.node {
2026                     hir::PatKind::Binding(_, _, ref path1, _) => path1.node.as_str(),
2027                     _ => {
2028                         bug!("Variable id {} maps to {:?}, not local", id, pat);
2029                     },
2030                 }
2031             },
2032             r => bug!("Variable id {} maps to {:?}, not local", id, r),
2033         }
2034     }
2035
2036     pub fn expr_is_lval(self, expr: &hir::Expr) -> bool {
2037          match expr.node {
2038             hir::ExprPath(hir::QPath::Resolved(_, ref path)) => {
2039                 match path.def {
2040                     Def::Local(..) | Def::Upvar(..) | Def::Static(..) | Def::Err => true,
2041                     _ => false,
2042                 }
2043             }
2044
2045             hir::ExprType(ref e, _) => {
2046                 self.expr_is_lval(e)
2047             }
2048
2049             hir::ExprUnary(hir::UnDeref, _) |
2050             hir::ExprField(..) |
2051             hir::ExprTupField(..) |
2052             hir::ExprIndex(..) => {
2053                 true
2054             }
2055
2056             // Partially qualified paths in expressions can only legally
2057             // refer to associated items which are always rvalues.
2058             hir::ExprPath(hir::QPath::TypeRelative(..)) |
2059
2060             hir::ExprCall(..) |
2061             hir::ExprMethodCall(..) |
2062             hir::ExprStruct(..) |
2063             hir::ExprTup(..) |
2064             hir::ExprIf(..) |
2065             hir::ExprMatch(..) |
2066             hir::ExprClosure(..) |
2067             hir::ExprBlock(..) |
2068             hir::ExprRepeat(..) |
2069             hir::ExprArray(..) |
2070             hir::ExprBreak(..) |
2071             hir::ExprAgain(..) |
2072             hir::ExprRet(..) |
2073             hir::ExprWhile(..) |
2074             hir::ExprLoop(..) |
2075             hir::ExprAssign(..) |
2076             hir::ExprInlineAsm(..) |
2077             hir::ExprAssignOp(..) |
2078             hir::ExprLit(_) |
2079             hir::ExprUnary(..) |
2080             hir::ExprBox(..) |
2081             hir::ExprAddrOf(..) |
2082             hir::ExprBinary(..) |
2083             hir::ExprCast(..) => {
2084                 false
2085             }
2086         }
2087     }
2088
2089     pub fn provided_trait_methods(self, id: DefId) -> Vec<AssociatedItem> {
2090         self.associated_items(id)
2091             .filter(|item| item.kind == AssociatedKind::Method && item.defaultness.has_value())
2092             .collect()
2093     }
2094
2095     pub fn trait_impl_polarity(self, id: DefId) -> hir::ImplPolarity {
2096         if let Some(id) = self.hir.as_local_node_id(id) {
2097             match self.hir.expect_item(id).node {
2098                 hir::ItemImpl(_, polarity, ..) => polarity,
2099                 ref item => bug!("trait_impl_polarity: {:?} not an impl", item)
2100             }
2101         } else {
2102             self.sess.cstore.impl_polarity(id)
2103         }
2104     }
2105
2106     pub fn trait_relevant_for_never(self, did: DefId) -> bool {
2107         self.associated_items(did).any(|item| {
2108             item.relevant_for_never()
2109         })
2110     }
2111
2112     pub fn coerce_unsized_info(self, did: DefId) -> adjustment::CoerceUnsizedInfo {
2113         queries::coerce_unsized_info::get(self, DUMMY_SP, did)
2114     }
2115
2116     pub fn associated_item(self, def_id: DefId) -> AssociatedItem {
2117         queries::associated_item::get(self, DUMMY_SP, def_id)
2118     }
2119
2120     fn associated_item_from_trait_item_ref(self,
2121                                            parent_def_id: DefId,
2122                                            trait_item_ref: &hir::TraitItemRef)
2123                                            -> AssociatedItem {
2124         let def_id = self.hir.local_def_id(trait_item_ref.id.node_id);
2125         let (kind, has_self) = match trait_item_ref.kind {
2126             hir::AssociatedItemKind::Const => (ty::AssociatedKind::Const, false),
2127             hir::AssociatedItemKind::Method { has_self } => {
2128                 (ty::AssociatedKind::Method, has_self)
2129             }
2130             hir::AssociatedItemKind::Type => (ty::AssociatedKind::Type, false),
2131         };
2132
2133         AssociatedItem {
2134             name: trait_item_ref.name,
2135             kind: kind,
2136             vis: Visibility::from_hir(&hir::Inherited, trait_item_ref.id.node_id, self),
2137             defaultness: trait_item_ref.defaultness,
2138             def_id: def_id,
2139             container: TraitContainer(parent_def_id),
2140             method_has_self_argument: has_self
2141         }
2142     }
2143
2144     fn associated_item_from_impl_item_ref(self,
2145                                           parent_def_id: DefId,
2146                                           from_trait_impl: bool,
2147                                           impl_item_ref: &hir::ImplItemRef)
2148                                           -> AssociatedItem {
2149         let def_id = self.hir.local_def_id(impl_item_ref.id.node_id);
2150         let (kind, has_self) = match impl_item_ref.kind {
2151             hir::AssociatedItemKind::Const => (ty::AssociatedKind::Const, false),
2152             hir::AssociatedItemKind::Method { has_self } => {
2153                 (ty::AssociatedKind::Method, has_self)
2154             }
2155             hir::AssociatedItemKind::Type => (ty::AssociatedKind::Type, false),
2156         };
2157
2158         // Trait impl items are always public.
2159         let public = hir::Public;
2160         let vis = if from_trait_impl { &public } else { &impl_item_ref.vis };
2161
2162         ty::AssociatedItem {
2163             name: impl_item_ref.name,
2164             kind: kind,
2165             vis: ty::Visibility::from_hir(vis, impl_item_ref.id.node_id, self),
2166             defaultness: impl_item_ref.defaultness,
2167             def_id: def_id,
2168             container: ImplContainer(parent_def_id),
2169             method_has_self_argument: has_self
2170         }
2171     }
2172
2173     pub fn associated_item_def_ids(self, def_id: DefId) -> Rc<Vec<DefId>> {
2174         if !def_id.is_local() {
2175             return queries::associated_item_def_ids::get(self, DUMMY_SP, def_id);
2176         }
2177
2178         self.maps.associated_item_def_ids.memoize(def_id, || {
2179             let id = self.hir.as_local_node_id(def_id).unwrap();
2180             let item = self.hir.expect_item(id);
2181             let vec: Vec<_> = match item.node {
2182                 hir::ItemTrait(.., ref trait_item_refs) => {
2183                     trait_item_refs.iter()
2184                                    .map(|trait_item_ref| trait_item_ref.id)
2185                                    .map(|id| self.hir.local_def_id(id.node_id))
2186                                    .collect()
2187                 }
2188                 hir::ItemImpl(.., ref impl_item_refs) => {
2189                     impl_item_refs.iter()
2190                                   .map(|impl_item_ref| impl_item_ref.id)
2191                                   .map(|id| self.hir.local_def_id(id.node_id))
2192                                   .collect()
2193                 }
2194                 _ => span_bug!(item.span, "associated_item_def_ids: not impl or trait")
2195             };
2196             Rc::new(vec)
2197         })
2198     }
2199
2200     #[inline] // FIXME(#35870) Avoid closures being unexported due to impl Trait.
2201     pub fn associated_items(self, def_id: DefId)
2202                             -> impl Iterator<Item = ty::AssociatedItem> + 'a {
2203         let def_ids = self.associated_item_def_ids(def_id);
2204         (0..def_ids.len()).map(move |i| self.associated_item(def_ids[i]))
2205     }
2206
2207     /// Returns the trait-ref corresponding to a given impl, or None if it is
2208     /// an inherent impl.
2209     pub fn impl_trait_ref(self, id: DefId) -> Option<TraitRef<'gcx>> {
2210         queries::impl_trait_ref::get(self, DUMMY_SP, id)
2211     }
2212
2213     // Returns `ty::VariantDef` if `def` refers to a struct,
2214     // or variant or their constructors, panics otherwise.
2215     pub fn expect_variant_def(self, def: Def) -> &'tcx VariantDef {
2216         match def {
2217             Def::Variant(did) | Def::VariantCtor(did, ..) => {
2218                 let enum_did = self.parent_def_id(did).unwrap();
2219                 self.lookup_adt_def(enum_did).variant_with_id(did)
2220             }
2221             Def::Struct(did) | Def::Union(did) => {
2222                 self.lookup_adt_def(did).struct_variant()
2223             }
2224             Def::StructCtor(ctor_did, ..) => {
2225                 let did = self.parent_def_id(ctor_did).expect("struct ctor has no parent");
2226                 self.lookup_adt_def(did).struct_variant()
2227             }
2228             _ => bug!("expect_variant_def used with unexpected def {:?}", def)
2229         }
2230     }
2231
2232     pub fn def_key(self, id: DefId) -> hir_map::DefKey {
2233         if id.is_local() {
2234             self.hir.def_key(id)
2235         } else {
2236             self.sess.cstore.def_key(id)
2237         }
2238     }
2239
2240     /// Convert a `DefId` into its fully expanded `DefPath` (every
2241     /// `DefId` is really just an interned def-path).
2242     ///
2243     /// Note that if `id` is not local to this crate, the result will
2244     //  be a non-local `DefPath`.
2245     pub fn def_path(self, id: DefId) -> hir_map::DefPath {
2246         if id.is_local() {
2247             self.hir.def_path(id)
2248         } else {
2249             self.sess.cstore.def_path(id)
2250         }
2251     }
2252
2253     #[inline]
2254     pub fn def_path_hash(self, def_id: DefId) -> u64 {
2255         if def_id.is_local() {
2256             self.hir.definitions().def_path_hash(def_id.index)
2257         } else {
2258             self.sess.cstore.def_path_hash(def_id)
2259         }
2260     }
2261
2262     pub fn def_span(self, def_id: DefId) -> Span {
2263         if let Some(id) = self.hir.as_local_node_id(def_id) {
2264             self.hir.span(id)
2265         } else {
2266             self.sess.cstore.def_span(&self.sess, def_id)
2267         }
2268     }
2269
2270     pub fn vis_is_accessible_from(self, vis: Visibility, block: NodeId) -> bool {
2271         vis.is_accessible_from(self.hir.local_def_id(self.hir.get_module_parent(block)), self)
2272     }
2273
2274     pub fn item_name(self, id: DefId) -> ast::Name {
2275         if let Some(id) = self.hir.as_local_node_id(id) {
2276             self.hir.name(id)
2277         } else if id.index == CRATE_DEF_INDEX {
2278             self.sess.cstore.original_crate_name(id.krate)
2279         } else {
2280             let def_key = self.sess.cstore.def_key(id);
2281             // The name of a StructCtor is that of its struct parent.
2282             if let hir_map::DefPathData::StructCtor = def_key.disambiguated_data.data {
2283                 self.item_name(DefId {
2284                     krate: id.krate,
2285                     index: def_key.parent.unwrap()
2286                 })
2287             } else {
2288                 def_key.disambiguated_data.data.get_opt_name().unwrap_or_else(|| {
2289                     bug!("item_name: no name for {:?}", self.def_path(id));
2290                 })
2291             }
2292         }
2293     }
2294
2295     // If the given item is in an external crate, looks up its type and adds it to
2296     // the type cache. Returns the type parameters and type.
2297     pub fn item_type(self, did: DefId) -> Ty<'gcx> {
2298         queries::ty::get(self, DUMMY_SP, did)
2299     }
2300
2301     /// Given the did of a trait, returns its canonical trait ref.
2302     pub fn lookup_trait_def(self, did: DefId) -> &'gcx TraitDef {
2303         queries::trait_def::get(self, DUMMY_SP, did)
2304     }
2305
2306     /// Given the did of an ADT, return a reference to its definition.
2307     pub fn lookup_adt_def(self, did: DefId) -> &'gcx AdtDef {
2308         queries::adt_def::get(self, DUMMY_SP, did)
2309     }
2310
2311     /// Given the did of an item, returns its generics.
2312     pub fn item_generics(self, did: DefId) -> &'gcx Generics {
2313         queries::generics::get(self, DUMMY_SP, did)
2314     }
2315
2316     /// Given the did of an item, returns its full set of predicates.
2317     pub fn item_predicates(self, did: DefId) -> GenericPredicates<'gcx> {
2318         queries::predicates::get(self, DUMMY_SP, did)
2319     }
2320
2321     /// Given the did of a trait, returns its superpredicates.
2322     pub fn item_super_predicates(self, did: DefId) -> GenericPredicates<'gcx> {
2323         queries::super_predicates::get(self, DUMMY_SP, did)
2324     }
2325
2326     /// Given the did of an item, returns its MIR, borrowed immutably.
2327     pub fn item_mir(self, did: DefId) -> Ref<'gcx, Mir<'gcx>> {
2328         queries::mir::get(self, DUMMY_SP, did).borrow()
2329     }
2330
2331     /// Return the possibly-auto-generated MIR of a (DefId, Subst) pair.
2332     pub fn instance_mir(self, instance: ty::InstanceDef<'gcx>)
2333                         -> Ref<'gcx, Mir<'gcx>>
2334     {
2335         match instance {
2336             ty::InstanceDef::Item(did) if true => self.item_mir(did),
2337             _ => queries::mir_shims::get(self, DUMMY_SP, instance).borrow(),
2338         }
2339     }
2340
2341     /// Given the DefId of an item, returns its MIR, borrowed immutably.
2342     /// Returns None if there is no MIR for the DefId
2343     pub fn maybe_item_mir(self, did: DefId) -> Option<Ref<'gcx, Mir<'gcx>>> {
2344         if did.is_local() && !self.maps.mir.borrow().contains_key(&did) {
2345             return None;
2346         }
2347
2348         if !did.is_local() && !self.sess.cstore.is_item_mir_available(did) {
2349             return None;
2350         }
2351
2352         Some(self.item_mir(did))
2353     }
2354
2355     /// If `type_needs_drop` returns true, then `ty` is definitely
2356     /// non-copy and *might* have a destructor attached; if it returns
2357     /// false, then `ty` definitely has no destructor (i.e. no drop glue).
2358     ///
2359     /// (Note that this implies that if `ty` has a destructor attached,
2360     /// then `type_needs_drop` will definitely return `true` for `ty`.)
2361     pub fn type_needs_drop_given_env(self,
2362                                      ty: Ty<'gcx>,
2363                                      param_env: &ty::ParameterEnvironment<'gcx>) -> bool {
2364         // Issue #22536: We first query type_moves_by_default.  It sees a
2365         // normalized version of the type, and therefore will definitely
2366         // know whether the type implements Copy (and thus needs no
2367         // cleanup/drop/zeroing) ...
2368         let tcx = self.global_tcx();
2369         let implements_copy = !ty.moves_by_default(tcx, param_env, DUMMY_SP);
2370
2371         if implements_copy { return false; }
2372
2373         // ... (issue #22536 continued) but as an optimization, still use
2374         // prior logic of asking if the `needs_drop` bit is set; we need
2375         // not zero non-Copy types if they have no destructor.
2376
2377         // FIXME(#22815): Note that calling `ty::type_contents` is a
2378         // conservative heuristic; it may report that `needs_drop` is set
2379         // when actual type does not actually have a destructor associated
2380         // with it. But since `ty` absolutely did not have the `Copy`
2381         // bound attached (see above), it is sound to treat it as having a
2382         // destructor (e.g. zero its memory on move).
2383
2384         let contents = ty.type_contents(tcx);
2385         debug!("type_needs_drop ty={:?} contents={:?}", ty, contents);
2386         contents.needs_drop(tcx)
2387     }
2388
2389     /// Get the attributes of a definition.
2390     pub fn get_attrs(self, did: DefId) -> Cow<'gcx, [ast::Attribute]> {
2391         if let Some(id) = self.hir.as_local_node_id(did) {
2392             Cow::Borrowed(self.hir.attrs(id))
2393         } else {
2394             Cow::Owned(self.sess.cstore.item_attrs(did))
2395         }
2396     }
2397
2398     /// Determine whether an item is annotated with an attribute
2399     pub fn has_attr(self, did: DefId, attr: &str) -> bool {
2400         self.get_attrs(did).iter().any(|item| item.check_name(attr))
2401     }
2402
2403     pub fn item_variances(self, item_id: DefId) -> Rc<Vec<ty::Variance>> {
2404         queries::variances::get(self, DUMMY_SP, item_id)
2405     }
2406
2407     pub fn trait_has_default_impl(self, trait_def_id: DefId) -> bool {
2408         let def = self.lookup_trait_def(trait_def_id);
2409         def.flags.get().intersects(TraitFlags::HAS_DEFAULT_IMPL)
2410     }
2411
2412     /// Populates the type context with all the implementations for the given
2413     /// trait if necessary.
2414     pub fn populate_implementations_for_trait_if_necessary(self, trait_id: DefId) {
2415         if trait_id.is_local() {
2416             return
2417         }
2418
2419         // The type is not local, hence we are reading this out of
2420         // metadata and don't need to track edges.
2421         let _ignore = self.dep_graph.in_ignore();
2422
2423         let def = self.lookup_trait_def(trait_id);
2424         if def.flags.get().intersects(TraitFlags::HAS_REMOTE_IMPLS) {
2425             return;
2426         }
2427
2428         debug!("populate_implementations_for_trait_if_necessary: searching for {:?}", def);
2429
2430         for impl_def_id in self.sess.cstore.implementations_of_trait(Some(trait_id)) {
2431             let trait_ref = self.impl_trait_ref(impl_def_id).unwrap();
2432
2433             // Record the trait->implementation mapping.
2434             let parent = self.sess.cstore.impl_parent(impl_def_id).unwrap_or(trait_id);
2435             def.record_remote_impl(self, impl_def_id, trait_ref, parent);
2436         }
2437
2438         def.flags.set(def.flags.get() | TraitFlags::HAS_REMOTE_IMPLS);
2439     }
2440
2441     pub fn closure_kind(self, def_id: DefId) -> ty::ClosureKind {
2442         queries::closure_kind::get(self, DUMMY_SP, def_id)
2443     }
2444
2445     pub fn closure_type(self, def_id: DefId) -> ty::PolyFnSig<'tcx> {
2446         queries::closure_type::get(self, DUMMY_SP, def_id)
2447     }
2448
2449     /// Given the def_id of an impl, return the def_id of the trait it implements.
2450     /// If it implements no trait, return `None`.
2451     pub fn trait_id_of_impl(self, def_id: DefId) -> Option<DefId> {
2452         self.impl_trait_ref(def_id).map(|tr| tr.def_id)
2453     }
2454
2455     /// If the given def ID describes a method belonging to an impl, return the
2456     /// ID of the impl that the method belongs to. Otherwise, return `None`.
2457     pub fn impl_of_method(self, def_id: DefId) -> Option<DefId> {
2458         let item = if def_id.krate != LOCAL_CRATE {
2459             if let Some(Def::Method(_)) = self.sess.cstore.describe_def(def_id) {
2460                 Some(self.associated_item(def_id))
2461             } else {
2462                 None
2463             }
2464         } else {
2465             self.maps.associated_item.borrow().get(&def_id).cloned()
2466         };
2467
2468         match item {
2469             Some(trait_item) => {
2470                 match trait_item.container {
2471                     TraitContainer(_) => None,
2472                     ImplContainer(def_id) => Some(def_id),
2473                 }
2474             }
2475             None => None
2476         }
2477     }
2478
2479     /// If the given def ID describes an item belonging to a trait,
2480     /// return the ID of the trait that the trait item belongs to.
2481     /// Otherwise, return `None`.
2482     pub fn trait_of_item(self, def_id: DefId) -> Option<DefId> {
2483         if def_id.krate != LOCAL_CRATE {
2484             return self.sess.cstore.trait_of_item(def_id);
2485         }
2486         match self.maps.associated_item.borrow().get(&def_id) {
2487             Some(associated_item) => {
2488                 match associated_item.container {
2489                     TraitContainer(def_id) => Some(def_id),
2490                     ImplContainer(_) => None
2491                 }
2492             }
2493             None => None
2494         }
2495     }
2496
2497     /// Construct a parameter environment suitable for static contexts or other contexts where there
2498     /// are no free type/lifetime parameters in scope.
2499     pub fn empty_parameter_environment(self) -> ParameterEnvironment<'tcx> {
2500
2501         // for an empty parameter environment, there ARE no free
2502         // regions, so it shouldn't matter what we use for the free id
2503         let free_id_outlive = self.region_maps.node_extent(ast::DUMMY_NODE_ID);
2504         ty::ParameterEnvironment {
2505             free_substs: self.intern_substs(&[]),
2506             caller_bounds: Vec::new(),
2507             implicit_region_bound: self.mk_region(ty::ReEmpty),
2508             free_id_outlive: free_id_outlive,
2509             is_copy_cache: RefCell::new(FxHashMap()),
2510             is_sized_cache: RefCell::new(FxHashMap()),
2511         }
2512     }
2513
2514     /// Constructs and returns a substitution that can be applied to move from
2515     /// the "outer" view of a type or method to the "inner" view.
2516     /// In general, this means converting from bound parameters to
2517     /// free parameters. Since we currently represent bound/free type
2518     /// parameters in the same way, this only has an effect on regions.
2519     pub fn construct_free_substs(self, def_id: DefId,
2520                                  free_id_outlive: CodeExtent)
2521                                  -> &'gcx Substs<'gcx> {
2522
2523         let substs = Substs::for_item(self.global_tcx(), def_id, |def, _| {
2524             // map bound 'a => free 'a
2525             self.global_tcx().mk_region(ReFree(FreeRegion {
2526                 scope: free_id_outlive,
2527                 bound_region: def.to_bound_region()
2528             }))
2529         }, |def, _| {
2530             // map T => T
2531             self.global_tcx().mk_param_from_def(def)
2532         });
2533
2534         debug!("construct_parameter_environment: {:?}", substs);
2535         substs
2536     }
2537
2538     /// See `ParameterEnvironment` struct def'n for details.
2539     /// If you were using `free_id: NodeId`, you might try `self.region_maps.item_extent(free_id)`
2540     /// for the `free_id_outlive` parameter. (But note that this is not always quite right.)
2541     pub fn construct_parameter_environment(self,
2542                                            span: Span,
2543                                            def_id: DefId,
2544                                            free_id_outlive: CodeExtent)
2545                                            -> ParameterEnvironment<'gcx>
2546     {
2547         //
2548         // Construct the free substs.
2549         //
2550
2551         let free_substs = self.construct_free_substs(def_id, free_id_outlive);
2552
2553         //
2554         // Compute the bounds on Self and the type parameters.
2555         //
2556
2557         let tcx = self.global_tcx();
2558         let generic_predicates = tcx.item_predicates(def_id);
2559         let bounds = generic_predicates.instantiate(tcx, free_substs);
2560         let bounds = tcx.liberate_late_bound_regions(free_id_outlive, &ty::Binder(bounds));
2561         let predicates = bounds.predicates;
2562
2563         // Finally, we have to normalize the bounds in the environment, in
2564         // case they contain any associated type projections. This process
2565         // can yield errors if the put in illegal associated types, like
2566         // `<i32 as Foo>::Bar` where `i32` does not implement `Foo`. We
2567         // report these errors right here; this doesn't actually feel
2568         // right to me, because constructing the environment feels like a
2569         // kind of a "idempotent" action, but I'm not sure where would be
2570         // a better place. In practice, we construct environments for
2571         // every fn once during type checking, and we'll abort if there
2572         // are any errors at that point, so after type checking you can be
2573         // sure that this will succeed without errors anyway.
2574         //
2575
2576         let unnormalized_env = ty::ParameterEnvironment {
2577             free_substs: free_substs,
2578             implicit_region_bound: tcx.mk_region(ty::ReScope(free_id_outlive)),
2579             caller_bounds: predicates,
2580             free_id_outlive: free_id_outlive,
2581             is_copy_cache: RefCell::new(FxHashMap()),
2582             is_sized_cache: RefCell::new(FxHashMap()),
2583         };
2584
2585         let cause = traits::ObligationCause::misc(span, free_id_outlive.node_id(&self.region_maps));
2586         traits::normalize_param_env_or_error(tcx, unnormalized_env, cause)
2587     }
2588
2589     pub fn node_scope_region(self, id: NodeId) -> &'tcx Region {
2590         self.mk_region(ty::ReScope(self.region_maps.node_extent(id)))
2591     }
2592
2593     pub fn visit_all_item_likes_in_krate<V,F>(self,
2594                                               dep_node_fn: F,
2595                                               visitor: &mut V)
2596         where F: FnMut(DefId) -> DepNode<DefId>, V: ItemLikeVisitor<'gcx>
2597     {
2598         dep_graph::visit_all_item_likes_in_krate(self.global_tcx(), dep_node_fn, visitor);
2599     }
2600
2601     /// Invokes `callback` for each body in the krate. This will
2602     /// create a read edge from `DepNode::Krate` to the current task;
2603     /// it is meant to be run in the context of some global task like
2604     /// `BorrowckCrate`. The callback would then create a task like
2605     /// `BorrowckBody(DefId)` to process each individual item.
2606     pub fn visit_all_bodies_in_krate<C>(self, callback: C)
2607         where C: Fn(/* body_owner */ DefId, /* body id */ hir::BodyId),
2608     {
2609         dep_graph::visit_all_bodies_in_krate(self.global_tcx(), callback)
2610     }
2611
2612     /// Looks up the span of `impl_did` if the impl is local; otherwise returns `Err`
2613     /// with the name of the crate containing the impl.
2614     pub fn span_of_impl(self, impl_did: DefId) -> Result<Span, Symbol> {
2615         if impl_did.is_local() {
2616             let node_id = self.hir.as_local_node_id(impl_did).unwrap();
2617             Ok(self.hir.span(node_id))
2618         } else {
2619             Err(self.sess.cstore.crate_name(impl_did.krate))
2620         }
2621     }
2622 }
2623
2624 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
2625     pub fn with_freevars<T, F>(self, fid: NodeId, f: F) -> T where
2626         F: FnOnce(&[hir::Freevar]) -> T,
2627     {
2628         match self.freevars.borrow().get(&fid) {
2629             None => f(&[]),
2630             Some(d) => f(&d[..])
2631         }
2632     }
2633 }
2634
2635 fn associated_item<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId)
2636     -> AssociatedItem
2637 {
2638     let id = tcx.hir.as_local_node_id(def_id).unwrap();
2639     let parent_id = tcx.hir.get_parent(id);
2640     let parent_def_id = tcx.hir.local_def_id(parent_id);
2641     let parent_item = tcx.hir.expect_item(parent_id);
2642     match parent_item.node {
2643         hir::ItemImpl(.., ref impl_trait_ref, _, ref impl_item_refs) => {
2644             if let Some(impl_item_ref) = impl_item_refs.iter().find(|i| i.id.node_id == id) {
2645                 let assoc_item =
2646                     tcx.associated_item_from_impl_item_ref(parent_def_id,
2647                                                             impl_trait_ref.is_some(),
2648                                                             impl_item_ref);
2649                 debug_assert_eq!(assoc_item.def_id, def_id);
2650                 return assoc_item;
2651             }
2652         }
2653
2654         hir::ItemTrait(.., ref trait_item_refs) => {
2655             if let Some(trait_item_ref) = trait_item_refs.iter().find(|i| i.id.node_id == id) {
2656                 let assoc_item =
2657                     tcx.associated_item_from_trait_item_ref(parent_def_id, trait_item_ref);
2658                 debug_assert_eq!(assoc_item.def_id, def_id);
2659                 return assoc_item;
2660             }
2661         }
2662
2663         ref r => {
2664             panic!("unexpected container of associated items: {:?}", r)
2665         }
2666     }
2667     panic!("associated item not found for def_id: {:?}", def_id);
2668 }
2669
2670 pub fn provide(providers: &mut ty::maps::Providers) {
2671     *providers = ty::maps::Providers {
2672         associated_item,
2673         ..*providers
2674     };
2675 }
2676
2677
2678 /// A map for the local crate mapping each type to a vector of its
2679 /// inherent impls. This is not meant to be used outside of coherence;
2680 /// rather, you should request the vector for a specific type via
2681 /// `ty::queries::inherent_impls::get(def_id)` so as to minimize your
2682 /// dependencies (constructing this map requires touching the entire
2683 /// crate).
2684 #[derive(Clone, Debug)]
2685 pub struct CrateInherentImpls {
2686     pub inherent_impls: DefIdMap<Rc<Vec<DefId>>>,
2687 }
2688