src/librustc/middle/ty.rs

   1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 #![allow(non_camel_case_types)]
  12
  13 use back::svh::Svh;
  14 use driver::session::Session;
  15 use lint;
  16 use metadata::csearch;
  17 use middle::const_eval;
  18 use middle::def;
  19 use middle::dependency_format;
  20 use middle::freevars::CaptureModeMap;
  21 use middle::freevars;
  22 use middle::lang_items::{FnTraitLangItem, FnMutTraitLangItem};
  23 use middle::lang_items::{FnOnceTraitLangItem, OpaqueStructLangItem};
  24 use middle::lang_items::{TyDescStructLangItem, TyVisitorTraitLangItem};
  25 use middle::mem_categorization as mc;
  26 use middle::resolve;
  27 use middle::resolve_lifetime;
  28 use middle::stability;
  29 use middle::subst::{Subst, Substs, VecPerParamSpace};
  30 use middle::subst;
  31 use middle::ty;
  32 use middle::typeck;
  33 use middle::ty_fold;
  34 use middle::ty_fold::{TypeFoldable,TypeFolder};
  35 use middle;
  36 use util::ppaux::{note_and_explain_region, bound_region_ptr_to_string};
  37 use util::ppaux::{trait_store_to_string, ty_to_string};
  38 use util::ppaux::{Repr, UserString};
  39 use util::common::{indenter};
  40 use util::nodemap::{NodeMap, NodeSet, DefIdMap, DefIdSet, FnvHashMap};
  41
  42 use std::cell::{Cell, RefCell};
  43 use std::cmp;
  44 use std::fmt::Show;
  45 use std::fmt;
  46 use std::hash::{Hash, sip, Writer};
  47 use std::gc::Gc;
  48 use std::iter::AdditiveIterator;
  49 use std::mem;
  50 use std::ops;
  51 use std::rc::Rc;
  52 use std::collections::{HashMap, HashSet};
  53 use arena::TypedArena;
  54 use syntax::abi;
  55 use syntax::ast::{CrateNum, DefId, FnStyle, Ident, ItemTrait, LOCAL_CRATE};
  56 use syntax::ast::{MutImmutable, MutMutable, Name, NamedField, NodeId};
  57 use syntax::ast::{Onceness, StmtExpr, StmtSemi, StructField, UnnamedField};
  58 use syntax::ast::{Visibility};
  59 use syntax::ast_util::{PostExpansionMethod, is_local, lit_is_str};
  60 use syntax::ast_util;
  61 use syntax::attr;
  62 use syntax::attr::AttrMetaMethods;
  63 use syntax::codemap::Span;
  64 use syntax::parse::token;
  65 use syntax::parse::token::InternedString;
  66 use syntax::{ast, ast_map};
  67 use syntax::util::small_vector::SmallVector;
  68 use std::collections::enum_set::{EnumSet, CLike};
  69
  70 pub type Disr = u64;
  71
  72 pub static INITIAL_DISCRIMINANT_VALUE: Disr = 0;
  73
  74 // Data types
  75
  76 #[deriving(PartialEq, Eq, Hash)]
  77 pub struct field {
  78     pub ident: ast::Ident,
  79     pub mt: mt
  80 }
  81
  82 #[deriving(Clone)]
  83 pub enum ImplOrTraitItemContainer {
  84     TraitContainer(ast::DefId),
  85     ImplContainer(ast::DefId),
  86 }
  87
  88 impl ImplOrTraitItemContainer {
  89     pub fn id(&self) -> ast::DefId {
  90         match *self {
  91             TraitContainer(id) => id,
  92             ImplContainer(id) => id,
  93         }
  94     }
  95 }
  96
  97 #[deriving(Clone)]
  98 pub enum ImplOrTraitItem {
  99     MethodTraitItem(Rc<Method>),
 100 }
 101
 102 impl ImplOrTraitItem {
 103     fn id(&self) -> ImplOrTraitItemId {
 104         match *self {
 105             MethodTraitItem(ref method) => MethodTraitItemId(method.def_id),
 106         }
 107     }
 108
 109     pub fn def_id(&self) -> ast::DefId {
 110         match *self {
 111             MethodTraitItem(ref method) => method.def_id,
 112         }
 113     }
 114
 115     pub fn ident(&self) -> ast::Ident {
 116         match *self {
 117             MethodTraitItem(ref method) => method.ident,
 118         }
 119     }
 120
 121     pub fn container(&self) -> ImplOrTraitItemContainer {
 122         match *self {
 123             MethodTraitItem(ref method) => method.container,
 124         }
 125     }
 126 }
 127
 128 #[deriving(Clone)]
 129 pub enum ImplOrTraitItemId {
 130     MethodTraitItemId(ast::DefId),
 131 }
 132
 133 impl ImplOrTraitItemId {
 134     pub fn def_id(&self) -> ast::DefId {
 135         match *self {
 136             MethodTraitItemId(def_id) => def_id,
 137         }
 138     }
 139 }
 140
 141 #[deriving(Clone)]
 142 pub struct Method {
 143     pub ident: ast::Ident,
 144     pub generics: ty::Generics,
 145     pub fty: BareFnTy,
 146     pub explicit_self: ExplicitSelfCategory,
 147     pub vis: ast::Visibility,
 148     pub def_id: ast::DefId,
 149     pub container: ImplOrTraitItemContainer,
 150
 151     // If this method is provided, we need to know where it came from
 152     pub provided_source: Option<ast::DefId>
 153 }
 154
 155 impl Method {
 156     pub fn new(ident: ast::Ident,
 157                generics: ty::Generics,
 158                fty: BareFnTy,
 159                explicit_self: ExplicitSelfCategory,
 160                vis: ast::Visibility,
 161                def_id: ast::DefId,
 162                container: ImplOrTraitItemContainer,
 163                provided_source: Option<ast::DefId>)
 164                -> Method {
 165        Method {
 166             ident: ident,
 167             generics: generics,
 168             fty: fty,
 169             explicit_self: explicit_self,
 170             vis: vis,
 171             def_id: def_id,
 172             container: container,
 173             provided_source: provided_source
 174         }
 175     }
 176
 177     pub fn container_id(&self) -> ast::DefId {
 178         match self.container {
 179             TraitContainer(id) => id,
 180             ImplContainer(id) => id,
 181         }
 182     }
 183 }
 184
 185 #[deriving(Clone, PartialEq, Eq, Hash, Show)]
 186 pub struct mt {
 187     pub ty: t,
 188     pub mutbl: ast::Mutability,
 189 }
 190
 191 #[deriving(Clone, PartialEq, Eq, Hash, Encodable, Decodable, Show)]
 192 pub enum TraitStore {
 193     /// Box<Trait>
 194     UniqTraitStore,
 195     /// &Trait and &mut Trait
 196     RegionTraitStore(Region, ast::Mutability),
 197 }
 198
 199 #[deriving(Clone, Show)]
 200 pub struct field_ty {
 201     pub name: Name,
 202     pub id: DefId,
 203     pub vis: ast::Visibility,
 204     pub origin: ast::DefId,  // The DefId of the struct in which the field is declared.
 205 }
 206
 207 // Contains information needed to resolve types and (in the future) look up
 208 // the types of AST nodes.
 209 #[deriving(PartialEq, Eq, Hash)]
 210 pub struct creader_cache_key {
 211     pub cnum: CrateNum,
 212     pub pos: uint,
 213     pub len: uint
 214 }
 215
 216 pub type creader_cache = RefCell<HashMap<creader_cache_key, t>>;
 217
 218 pub struct intern_key {
 219     sty: *const sty,
 220 }
 221
 222 // NB: Do not replace this with #[deriving(PartialEq)]. The automatically-derived
 223 // implementation will not recurse through sty and you will get stack
 224 // exhaustion.
 225 impl cmp::PartialEq for intern_key {
 226     fn eq(&self, other: &intern_key) -> bool {
 227         unsafe {
 228             *self.sty == *other.sty
 229         }
 230     }
 231     fn ne(&self, other: &intern_key) -> bool {
 232         !self.eq(other)
 233     }
 234 }
 235
 236 impl Eq for intern_key {}
 237
 238 impl<W:Writer> Hash<W> for intern_key {
 239     fn hash(&self, s: &mut W) {
 240         unsafe { (*self.sty).hash(s) }
 241     }
 242 }
 243
 244 pub enum ast_ty_to_ty_cache_entry {
 245     atttce_unresolved,  /* not resolved yet */
 246     atttce_resolved(t)  /* resolved to a type, irrespective of region */
 247 }
 248
 249 #[deriving(Clone, PartialEq, Decodable, Encodable)]
 250 pub struct ItemVariances {
 251     pub types: VecPerParamSpace<Variance>,
 252     pub regions: VecPerParamSpace<Variance>,
 253 }
 254
 255 #[deriving(Clone, PartialEq, Decodable, Encodable, Show)]
 256 pub enum Variance {
 257     Covariant,      // T<A> <: T<B> iff A <: B -- e.g., function return type
 258     Invariant,      // T<A> <: T<B> iff B == A -- e.g., type of mutable cell
 259     Contravariant,  // T<A> <: T<B> iff B <: A -- e.g., function param type
 260     Bivariant,      // T<A> <: T<B>            -- e.g., unused type parameter
 261 }
 262
 263 #[deriving(Clone)]
 264 pub enum AutoAdjustment {
 265     AutoAddEnv(ty::TraitStore),
 266     AutoDerefRef(AutoDerefRef)
 267 }
 268
 269 #[deriving(Clone, PartialEq)]
 270 pub enum UnsizeKind {
 271     // [T, ..n] -> [T], the uint field is n.
 272     UnsizeLength(uint),
 273     // An unsize coercion applied to the tail field of a struct.
 274     // The uint is the index of the type parameter which is unsized.
 275     UnsizeStruct(Box<UnsizeKind>, uint),
 276     UnsizeVtable(ty::ExistentialBounds,
 277                  ast::DefId, /* Trait ID */
 278                  subst::Substs /* Trait substitutions */)
 279 }
 280
 281 #[deriving(Clone)]
 282 pub struct AutoDerefRef {
 283     pub autoderefs: uint,
 284     pub autoref: Option<AutoRef>
 285 }
 286
 287 #[deriving(Clone, PartialEq)]
 288 pub enum AutoRef {
 289     /// Convert from T to &T
 290     /// The third field allows us to wrap other AutoRef adjustments.
 291     AutoPtr(Region, ast::Mutability, Option<Box<AutoRef>>),
 292
 293     /// Convert [T, ..n] to [T] (or similar, depending on the kind)
 294     AutoUnsize(UnsizeKind),
 295
 296     /// Convert Box<[T, ..n]> to Box<[T]> or something similar in a Box.
 297     /// With DST and Box a library type, this should be replaced by UnsizeStruct.
 298     AutoUnsizeUniq(UnsizeKind),
 299
 300     /// Convert from T to *T
 301     /// Value to thin pointer
 302     /// The second field allows us to wrap other AutoRef adjustments.
 303     AutoUnsafe(ast::Mutability, Option<Box<AutoRef>>),
 304 }
 305
 306 // Ugly little helper function. The first bool in the returned tuple is true if
 307 // there is an 'unsize to trait object' adjustment at the bottom of the
 308 // adjustment. If that is surrounded by an AutoPtr, then we also return the
 309 // region of the AutoPtr (in the third argument). The second bool is true if the
 310 // adjustment is unique.
 311 fn autoref_object_region(autoref: &AutoRef) -> (bool, bool, Option<Region>) {
 312     fn unsize_kind_is_object(k: &UnsizeKind) -> bool {
 313         match k {
 314             &UnsizeVtable(..) => true,
 315             &UnsizeStruct(box ref k, _) => unsize_kind_is_object(k),
 316             _ => false
 317         }
 318     }
 319
 320     match autoref {
 321         &AutoUnsize(ref k) => (unsize_kind_is_object(k), false, None),
 322         &AutoUnsizeUniq(ref k) => (unsize_kind_is_object(k), true, None),
 323         &AutoPtr(adj_r, _, Some(box ref autoref)) => {
 324             let (b, u, r) = autoref_object_region(autoref);
 325             if r.is_some() || u {
 326                 (b, u, r)
 327             } else {
 328                 (b, u, Some(adj_r))
 329             }
 330         }
 331         &AutoUnsafe(_, Some(box ref autoref)) => autoref_object_region(autoref),
 332         _ => (false, false, None)
 333     }
 334 }
 335
 336 // If the adjustment introduces a borrowed reference to a trait object, then
 337 // returns the region of the borrowed reference.
 338 pub fn adjusted_object_region(adj: &AutoAdjustment) -> Option<Region> {
 339     match adj {
 340         &AutoDerefRef(AutoDerefRef{autoref: Some(ref autoref), ..}) => {
 341             let (b, _, r) = autoref_object_region(autoref);
 342             if b {
 343                 r
 344             } else {
 345                 None
 346             }
 347         }
 348         _ => None
 349     }
 350 }
 351
 352 // Returns true if there is a trait cast at the bottom of the adjustment.
 353 pub fn adjust_is_object(adj: &AutoAdjustment) -> bool {
 354     match adj {
 355         &AutoDerefRef(AutoDerefRef{autoref: Some(ref autoref), ..}) => {
 356             let (b, _, _) = autoref_object_region(autoref);
 357             b
 358         }
 359         _ => false
 360     }
 361 }
 362
 363 // If possible, returns the type expected from the given adjustment. This is not
 364 // possible if the adjustment depends on the type of the adjusted expression.
 365 pub fn type_of_adjust(cx: &ctxt, adj: &AutoAdjustment) -> Option<t> {
 366     fn type_of_autoref(cx: &ctxt, autoref: &AutoRef) -> Option<t> {
 367         match autoref {
 368             &AutoUnsize(ref k) => match k {
 369                 &UnsizeVtable(bounds, def_id, ref substs) => {
 370                     Some(mk_trait(cx, def_id, substs.clone(), bounds))
 371                 }
 372                 _ => None
 373             },
 374             &AutoUnsizeUniq(ref k) => match k {
 375                 &UnsizeVtable(bounds, def_id, ref substs) => {
 376                     Some(mk_uniq(cx, mk_trait(cx, def_id, substs.clone(), bounds)))
 377                 }
 378                 _ => None
 379             },
 380             &AutoPtr(r, m, Some(box ref autoref)) => {
 381                 match type_of_autoref(cx, autoref) {
 382                     Some(t) => Some(mk_rptr(cx, r, mt {mutbl: m, ty: t})),
 383                     None => None
 384                 }
 385             }
 386             &AutoUnsafe(m, Some(box ref autoref)) => {
 387                 match type_of_autoref(cx, autoref) {
 388                     Some(t) => Some(mk_ptr(cx, mt {mutbl: m, ty: t})),
 389                     None => None
 390                 }
 391             }
 392             _ => None
 393         }
 394     }
 395
 396     match adj {
 397         &AutoDerefRef(AutoDerefRef{autoref: Some(ref autoref), ..}) => {
 398             type_of_autoref(cx, autoref)
 399         }
 400         _ => None
 401     }
 402 }
 403
 404
 405
 406 /// A restriction that certain types must be the same size. The use of
 407 /// `transmute` gives rise to these restrictions.
 408 pub struct TransmuteRestriction {
 409     /// The span from whence the restriction comes.
 410     pub span: Span,
 411     /// The type being transmuted from.
 412     pub from: t,
 413     /// The type being transmuted to.
 414     pub to: t,
 415     /// NodeIf of the transmute intrinsic.
 416     pub id: ast::NodeId,
 417 }
 418
 419 /// The data structure to keep track of all the information that typechecker
 420 /// generates so that so that it can be reused and doesn't have to be redone
 421 /// later on.
 422 pub struct ctxt<'tcx> {
 423     /// The arena that types are allocated from.
 424     type_arena: &'tcx TypedArena<t_box_>,
 425
 426     /// Specifically use a speedy hash algorithm for this hash map, it's used
 427     /// quite often.
 428     interner: RefCell<FnvHashMap<intern_key, &'tcx t_box_>>,
 429     pub next_id: Cell<uint>,
 430     pub sess: Session,
 431     pub def_map: resolve::DefMap,
 432
 433     pub named_region_map: resolve_lifetime::NamedRegionMap,
 434
 435     pub region_maps: middle::region::RegionMaps,
 436
 437     /// Stores the types for various nodes in the AST.  Note that this table
 438     /// is not guaranteed to be populated until after typeck.  See
 439     /// typeck::check::fn_ctxt for details.
 440     pub node_types: node_type_table,
 441
 442     /// Stores the type parameters which were substituted to obtain the type
 443     /// of this node.  This only applies to nodes that refer to entities
 444     /// parameterized by type parameters, such as generic fns, types, or
 445     /// other items.
 446     pub item_substs: RefCell<NodeMap<ItemSubsts>>,
 447
 448     /// Maps from a trait item to the trait item "descriptor"
 449     pub impl_or_trait_items: RefCell<DefIdMap<ImplOrTraitItem>>,
 450
 451     /// Maps from a trait def-id to a list of the def-ids of its trait items
 452     pub trait_item_def_ids: RefCell<DefIdMap<Rc<Vec<ImplOrTraitItemId>>>>,
 453
 454     /// A cache for the trait_items() routine
 455     pub trait_items_cache: RefCell<DefIdMap<Rc<Vec<ImplOrTraitItem>>>>,
 456
 457     pub impl_trait_cache: RefCell<DefIdMap<Option<Rc<ty::TraitRef>>>>,
 458
 459     pub trait_refs: RefCell<NodeMap<Rc<TraitRef>>>,
 460     pub trait_defs: RefCell<DefIdMap<Rc<TraitDef>>>,
 461
 462     pub map: ast_map::Map,
 463     pub intrinsic_defs: RefCell<DefIdMap<t>>,
 464     pub freevars: RefCell<freevars::freevar_map>,
 465     pub tcache: type_cache,
 466     pub rcache: creader_cache,
 467     pub short_names_cache: RefCell<HashMap<t, String>>,
 468     pub needs_unwind_cleanup_cache: RefCell<HashMap<t, bool>>,
 469     pub tc_cache: RefCell<HashMap<uint, TypeContents>>,
 470     pub ast_ty_to_ty_cache: RefCell<NodeMap<ast_ty_to_ty_cache_entry>>,
 471     pub enum_var_cache: RefCell<DefIdMap<Rc<Vec<Rc<VariantInfo>>>>>,
 472     pub ty_param_defs: RefCell<NodeMap<TypeParameterDef>>,
 473     pub adjustments: RefCell<NodeMap<AutoAdjustment>>,
 474     pub normalized_cache: RefCell<HashMap<t, t>>,
 475     pub lang_items: middle::lang_items::LanguageItems,
 476     /// A mapping of fake provided method def_ids to the default implementation
 477     pub provided_method_sources: RefCell<DefIdMap<ast::DefId>>,
 478     pub superstructs: RefCell<DefIdMap<Option<ast::DefId>>>,
 479     pub struct_fields: RefCell<DefIdMap<Rc<Vec<field_ty>>>>,
 480
 481     /// Maps from def-id of a type or region parameter to its
 482     /// (inferred) variance.
 483     pub item_variance_map: RefCell<DefIdMap<Rc<ItemVariances>>>,
 484
 485     /// True if the variance has been computed yet; false otherwise.
 486     pub variance_computed: Cell<bool>,
 487
 488     /// A mapping from the def ID of an enum or struct type to the def ID
 489     /// of the method that implements its destructor. If the type is not
 490     /// present in this map, it does not have a destructor. This map is
 491     /// populated during the coherence phase of typechecking.
 492     pub destructor_for_type: RefCell<DefIdMap<ast::DefId>>,
 493
 494     /// A method will be in this list if and only if it is a destructor.
 495     pub destructors: RefCell<DefIdSet>,
 496
 497     /// Maps a trait onto a list of impls of that trait.
 498     pub trait_impls: RefCell<DefIdMap<Rc<RefCell<Vec<ast::DefId>>>>>,
 499
 500     /// Maps a DefId of a type to a list of its inherent impls.
 501     /// Contains implementations of methods that are inherent to a type.
 502     /// Methods in these implementations don't need to be exported.
 503     pub inherent_impls: RefCell<DefIdMap<Rc<RefCell<Vec<ast::DefId>>>>>,
 504
 505     /// Maps a DefId of an impl to a list of its items.
 506     /// Note that this contains all of the impls that we know about,
 507     /// including ones in other crates. It's not clear that this is the best
 508     /// way to do it.
 509     pub impl_items: RefCell<DefIdMap<Vec<ImplOrTraitItemId>>>,
 510
 511     /// Set of used unsafe nodes (functions or blocks). Unsafe nodes not
 512     /// present in this set can be warned about.
 513     pub used_unsafe: RefCell<NodeSet>,
 514
 515     /// Set of nodes which mark locals as mutable which end up getting used at
 516     /// some point. Local variable definitions not in this set can be warned
 517     /// about.
 518     pub used_mut_nodes: RefCell<NodeSet>,
 519
 520     /// vtable resolution information for impl declarations
 521     pub impl_vtables: typeck::impl_vtable_map,
 522
 523     /// The set of external nominal types whose implementations have been read.
 524     /// This is used for lazy resolution of methods.
 525     pub populated_external_types: RefCell<DefIdSet>,
 526
 527     /// The set of external traits whose implementations have been read. This
 528     /// is used for lazy resolution of traits.
 529     pub populated_external_traits: RefCell<DefIdSet>,
 530
 531     /// Borrows
 532     pub upvar_borrow_map: RefCell<UpvarBorrowMap>,
 533
 534     /// These two caches are used by const_eval when decoding external statics
 535     /// and variants that are found.
 536     pub extern_const_statics: RefCell<DefIdMap<Option<Gc<ast::Expr>>>>,
 537     pub extern_const_variants: RefCell<DefIdMap<Option<Gc<ast::Expr>>>>,
 538
 539     pub method_map: typeck::MethodMap,
 540     pub vtable_map: typeck::vtable_map,
 541
 542     pub dependency_formats: RefCell<dependency_format::Dependencies>,
 543
 544     /// Records the type of each unboxed closure. The def ID is the ID of the
 545     /// expression defining the unboxed closure.
 546     pub unboxed_closures: RefCell<DefIdMap<UnboxedClosure>>,
 547
 548     pub node_lint_levels: RefCell<HashMap<(ast::NodeId, lint::LintId),
 549                                           lint::LevelSource>>,
 550
 551     /// The types that must be asserted to be the same size for `transmute`
 552     /// to be valid. We gather up these restrictions in the intrinsicck pass
 553     /// and check them in trans.
 554     pub transmute_restrictions: RefCell<Vec<TransmuteRestriction>>,
 555
 556     /// Maps any item's def-id to its stability index.
 557     pub stability: RefCell<stability::Index>,
 558
 559     /// Maps closures to their capture clauses.
 560     pub capture_modes: RefCell<CaptureModeMap>,
 561 }
 562
 563 pub enum tbox_flag {
 564     has_params = 1,
 565     has_self = 2,
 566     needs_infer = 4,
 567     has_regions = 8,
 568     has_ty_err = 16,
 569     has_ty_bot = 32,
 570
 571     // a meta-pub flag: subst may be required if the type has parameters, a self
 572     // type, or references bound regions
 573     needs_subst = 1 | 2 | 8
 574 }
 575
 576 pub type t_box = &'static t_box_;
 577
 578 #[deriving(Show)]
 579 pub struct t_box_ {
 580     pub sty: sty,
 581     pub id: uint,
 582     pub flags: uint,
 583 }
 584
 585 // To reduce refcounting cost, we're representing types as unsafe pointers
 586 // throughout the compiler. These are simply casted t_box values. Use ty::get
 587 // to cast them back to a box. (Without the cast, compiler performance suffers
 588 // ~15%.) This does mean that a t value relies on the ctxt to keep its box
 589 // alive, and using ty::get is unsafe when the ctxt is no longer alive.
 590 enum t_opaque {}
 591
 592 #[allow(raw_pointer_deriving)]
 593 #[deriving(Clone, PartialEq, Eq, Hash)]
 594 pub struct t { inner: *const t_opaque }
 595
 596 impl fmt::Show for t {
 597     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 598         write!(f, "{}", get(*self))
 599     }
 600 }
 601
 602 pub fn get(t: t) -> t_box {
 603     unsafe {
 604         let t2: t_box = mem::transmute(t);
 605         t2
 606     }
 607 }
 608
 609 pub fn tbox_has_flag(tb: t_box, flag: tbox_flag) -> bool {
 610     (tb.flags & (flag as uint)) != 0u
 611 }
 612 pub fn type_has_params(t: t) -> bool {
 613     tbox_has_flag(get(t), has_params)
 614 }
 615 pub fn type_has_self(t: t) -> bool { tbox_has_flag(get(t), has_self) }
 616 pub fn type_needs_infer(t: t) -> bool {
 617     tbox_has_flag(get(t), needs_infer)
 618 }
 619 pub fn type_id(t: t) -> uint { get(t).id }
 620
 621 #[deriving(Clone, PartialEq, Eq, Hash, Show)]
 622 pub struct BareFnTy {
 623     pub fn_style: ast::FnStyle,
 624     pub abi: abi::Abi,
 625     pub sig: FnSig,
 626 }
 627
 628 #[deriving(Clone, PartialEq, Eq, Hash, Show)]
 629 pub struct ClosureTy {
 630     pub fn_style: ast::FnStyle,
 631     pub onceness: ast::Onceness,
 632     pub store: TraitStore,
 633     pub bounds: ExistentialBounds,
 634     pub sig: FnSig,
 635     pub abi: abi::Abi,
 636 }
 637
 638 /**
 639  * Signature of a function type, which I have arbitrarily
 640  * decided to use to refer to the input/output types.
 641  *
 642  * - `binder_id` is the node id where this fn type appeared;
 643  *   it is used to identify all the bound regions appearing
 644  *   in the input/output types that are bound by this fn type
 645  *   (vs some enclosing or enclosed fn type)
 646  * - `inputs` is the list of arguments and their modes.
 647  * - `output` is the return type.
 648  * - `variadic` indicates whether this is a varidic function. (only true for foreign fns)
 649  */
 650 #[deriving(Clone, PartialEq, Eq, Hash)]
 651 pub struct FnSig {
 652     pub binder_id: ast::NodeId,
 653     pub inputs: Vec<t>,
 654     pub output: t,
 655     pub variadic: bool
 656 }
 657
 658 #[deriving(Clone, PartialEq, Eq, Hash, Show)]
 659 pub struct ParamTy {
 660     pub space: subst::ParamSpace,
 661     pub idx: uint,
 662     pub def_id: DefId
 663 }
 664
 665 /// Representation of regions:
 666 #[deriving(Clone, PartialEq, Eq, Hash, Encodable, Decodable, Show)]
 667 pub enum Region {
 668     // Region bound in a type or fn declaration which will be
 669     // substituted 'early' -- that is, at the same time when type
 670     // parameters are substituted.
 671     ReEarlyBound(/* param id */ ast::NodeId,
 672                  subst::ParamSpace,
 673                  /*index*/ uint,
 674                  ast::Name),
 675
 676     // Region bound in a function scope, which will be substituted when the
 677     // function is called. The first argument must be the `binder_id` of
 678     // some enclosing function signature.
 679     ReLateBound(/* binder_id */ ast::NodeId, BoundRegion),
 680
 681     /// When checking a function body, the types of all arguments and so forth
 682     /// that refer to bound region parameters are modified to refer to free
 683     /// region parameters.
 684     ReFree(FreeRegion),
 685
 686     /// A concrete region naming some expression within the current function.
 687     ReScope(NodeId),
 688
 689     /// Static data that has an "infinite" lifetime. Top in the region lattice.
 690     ReStatic,
 691
 692     /// A region variable.  Should not exist after typeck.
 693     ReInfer(InferRegion),
 694
 695     /// Empty lifetime is for data that is never accessed.
 696     /// Bottom in the region lattice. We treat ReEmpty somewhat
 697     /// specially; at least right now, we do not generate instances of
 698     /// it during the GLB computations, but rather
 699     /// generate an error instead. This is to improve error messages.
 700     /// The only way to get an instance of ReEmpty is to have a region
 701     /// variable with no constraints.
 702     ReEmpty,
 703 }
 704
 705 /**
 706  * Upvars do not get their own node-id. Instead, we use the pair of
 707  * the original var id (that is, the root variable that is referenced
 708  * by the upvar) and the id of the closure expression.
 709  */
 710 #[deriving(Clone, PartialEq, Eq, Hash)]
 711 pub struct UpvarId {
 712     pub var_id: ast::NodeId,
 713     pub closure_expr_id: ast::NodeId,
 714 }
 715
 716 #[deriving(Clone, PartialEq, Eq, Hash, Show, Encodable, Decodable)]
 717 pub enum BorrowKind {
 718     /// Data must be immutable and is aliasable.
 719     ImmBorrow,
 720
 721     /// Data must be immutable but not aliasable.  This kind of borrow
 722     /// cannot currently be expressed by the user and is used only in
 723     /// implicit closure bindings. It is needed when you the closure
 724     /// is borrowing or mutating a mutable referent, e.g.:
 725     ///
 726     ///    let x: &mut int = ...;
 727     ///    let y = || *x += 5;
 728     ///
 729     /// If we were to try to translate this closure into a more explicit
 730     /// form, we'd encounter an error with the code as written:
 731     ///
 732     ///    struct Env { x: & &mut int }
 733     ///    let x: &mut int = ...;
 734     ///    let y = (&mut Env { &x }, fn_ptr);  // Closure is pair of env and fn
 735     ///    fn fn_ptr(env: &mut Env) { **env.x += 5; }
 736     ///
 737     /// This is then illegal because you cannot mutate a `&mut` found
 738     /// in an aliasable location. To solve, you'd have to translate with
 739     /// an `&mut` borrow:
 740     ///
 741     ///    struct Env { x: & &mut int }
 742     ///    let x: &mut int = ...;
 743     ///    let y = (&mut Env { &mut x }, fn_ptr); // changed from &x to &mut x
 744     ///    fn fn_ptr(env: &mut Env) { **env.x += 5; }
 745     ///
 746     /// Now the assignment to `**env.x` is legal, but creating a
 747     /// mutable pointer to `x` is not because `x` is not mutable. We
 748     /// could fix this by declaring `x` as `let mut x`. This is ok in
 749     /// user code, if awkward, but extra weird for closures, since the
 750     /// borrow is hidden.
 751     ///
 752     /// So we introduce a "unique imm" borrow -- the referent is
 753     /// immutable, but not aliasable. This solves the problem. For
 754     /// simplicity, we don't give users the way to express this
 755     /// borrow, it's just used when translating closures.
 756     UniqueImmBorrow,
 757
 758     /// Data is mutable and not aliasable.
 759     MutBorrow
 760 }
 761
 762 /**
 763  * Information describing the borrowing of an upvar. This is computed
 764  * during `typeck`, specifically by `regionck`. The general idea is
 765  * that the compiler analyses treat closures like:
 766  *
 767  *     let closure: &'e fn() = || {
 768  *        x = 1;   // upvar x is assigned to
 769  *        use(y);  // upvar y is read
 770  *        foo(&z); // upvar z is borrowed immutably
 771  *     };
 772  *
 773  * as if they were "desugared" to something loosely like:
 774  *
 775  *     struct Vars<'x,'y,'z> { x: &'x mut int,
 776  *                             y: &'y const int,
 777  *                             z: &'z int }
 778  *     let closure: &'e fn() = {
 779  *         fn f(env: &Vars) {
 780  *             *env.x = 1;
 781  *             use(*env.y);
 782  *             foo(env.z);
 783  *         }
 784  *         let env: &'e mut Vars<'x,'y,'z> = &mut Vars { x: &'x mut x,
 785  *                                                       y: &'y const y,
 786  *                                                       z: &'z z };
 787  *         (env, f)
 788  *     };
 789  *
 790  * This is basically what happens at runtime. The closure is basically
 791  * an existentially quantified version of the `(env, f)` pair.
 792  *
 793  * This data structure indicates the region and mutability of a single
 794  * one of the `x...z` borrows.
 795  *
 796  * It may not be obvious why each borrowed variable gets its own
 797  * lifetime (in the desugared version of the example, these are indicated
 798  * by the lifetime parameters `'x`, `'y`, and `'z` in the `Vars` definition).
 799  * Each such lifetime must encompass the lifetime `'e` of the closure itself,
 800  * but need not be identical to it. The reason that this makes sense:
 801  *
 802  * - Callers are only permitted to invoke the closure, and hence to
 803  *   use the pointers, within the lifetime `'e`, so clearly `'e` must
 804  *   be a sublifetime of `'x...'z`.
 805  * - The closure creator knows which upvars were borrowed by the closure
 806  *   and thus `x...z` will be reserved for `'x...'z` respectively.
 807  * - Through mutation, the borrowed upvars can actually escape
 808  *   the closure, so sometimes it is necessary for them to be larger
 809  *   than the closure lifetime itself.
 810  */
 811 #[deriving(PartialEq, Clone, Encodable, Decodable)]
 812 pub struct UpvarBorrow {
 813     pub kind: BorrowKind,
 814     pub region: ty::Region,
 815 }
 816
 817 pub type UpvarBorrowMap = HashMap<UpvarId, UpvarBorrow>;
 818
 819 impl Region {
 820     pub fn is_bound(&self) -> bool {
 821         match self {
 822             &ty::ReEarlyBound(..) => true,
 823             &ty::ReLateBound(..) => true,
 824             _ => false
 825         }
 826     }
 827 }
 828
 829 #[deriving(Clone, PartialEq, PartialOrd, Eq, Ord, Hash, Encodable, Decodable, Show)]
 830 pub struct FreeRegion {
 831     pub scope_id: NodeId,
 832     pub bound_region: BoundRegion
 833 }
 834
 835 #[deriving(Clone, PartialEq, PartialOrd, Eq, Ord, Hash, Encodable, Decodable, Show)]
 836 pub enum BoundRegion {
 837     /// An anonymous region parameter for a given fn (&T)
 838     BrAnon(uint),
 839
 840     /// Named region parameters for functions (a in &'a T)
 841     ///
 842     /// The def-id is needed to distinguish free regions in
 843     /// the event of shadowing.
 844     BrNamed(ast::DefId, ast::Name),
 845
 846     /// Fresh bound identifiers created during GLB computations.
 847     BrFresh(uint),
 848 }
 849
 850 mod primitives {
 851     use super::t_box_;
 852
 853     use syntax::ast;
 854
 855     macro_rules! def_prim_ty(
 856         ($name:ident, $sty:expr, $id:expr) => (
 857             pub static $name: t_box_ = t_box_ {
 858                 sty: $sty,
 859                 id: $id,
 860                 flags: 0,
 861             };
 862         )
 863     )
 864
 865     def_prim_ty!(TY_NIL,    super::ty_nil,                  0)
 866     def_prim_ty!(TY_BOOL,   super::ty_bool,                 1)
 867     def_prim_ty!(TY_CHAR,   super::ty_char,                 2)
 868     def_prim_ty!(TY_INT,    super::ty_int(ast::TyI),        3)
 869     def_prim_ty!(TY_I8,     super::ty_int(ast::TyI8),       4)
 870     def_prim_ty!(TY_I16,    super::ty_int(ast::TyI16),      5)
 871     def_prim_ty!(TY_I32,    super::ty_int(ast::TyI32),      6)
 872     def_prim_ty!(TY_I64,    super::ty_int(ast::TyI64),      7)
 873     def_prim_ty!(TY_UINT,   super::ty_uint(ast::TyU),       8)
 874     def_prim_ty!(TY_U8,     super::ty_uint(ast::TyU8),      9)
 875     def_prim_ty!(TY_U16,    super::ty_uint(ast::TyU16),     10)
 876     def_prim_ty!(TY_U32,    super::ty_uint(ast::TyU32),     11)
 877     def_prim_ty!(TY_U64,    super::ty_uint(ast::TyU64),     12)
 878     def_prim_ty!(TY_F32,    super::ty_float(ast::TyF32),    14)
 879     def_prim_ty!(TY_F64,    super::ty_float(ast::TyF64),    15)
 880
 881     pub static TY_BOT: t_box_ = t_box_ {
 882         sty: super::ty_bot,
 883         id: 16,
 884         flags: super::has_ty_bot as uint,
 885     };
 886
 887     pub static TY_ERR: t_box_ = t_box_ {
 888         sty: super::ty_err,
 889         id: 17,
 890         flags: super::has_ty_err as uint,
 891     };
 892
 893     pub static LAST_PRIMITIVE_ID: uint = 18;
 894 }
 895
 896 // NB: If you change this, you'll probably want to change the corresponding
 897 // AST structure in libsyntax/ast.rs as well.
 898 #[deriving(Clone, PartialEq, Eq, Hash, Show)]
 899 pub enum sty {
 900     ty_nil,
 901     ty_bot,
 902     ty_bool,
 903     ty_char,
 904     ty_int(ast::IntTy),
 905     ty_uint(ast::UintTy),
 906     ty_float(ast::FloatTy),
 907     /// Substs here, possibly against intuition, *may* contain `ty_param`s.
 908     /// That is, even after substitution it is possible that there are type
 909     /// variables. This happens when the `ty_enum` corresponds to an enum
 910     /// definition and not a concrete use of it. To get the correct `ty_enum`
 911     /// from the tcx, use the `NodeId` from the `ast::Ty` and look it up in
 912     /// the `ast_ty_to_ty_cache`. This is probably true for `ty_struct` as
 913     /// well.`
 914     ty_enum(DefId, Substs),
 915     ty_box(t),
 916     ty_uniq(t),
 917     ty_str,
 918     ty_vec(t, Option<uint>), // Second field is length.
 919     ty_ptr(mt),
 920     ty_rptr(Region, mt),
 921     ty_bare_fn(BareFnTy),
 922     ty_closure(Box<ClosureTy>),
 923     ty_trait(Box<TyTrait>),
 924     ty_struct(DefId, Substs),
 925     ty_unboxed_closure(DefId, Region),
 926     ty_tup(Vec<t>),
 927
 928     ty_param(ParamTy), // type parameter
 929     ty_open(t),  // A deref'ed fat pointer, i.e., a dynamically sized value
 930                  // and its size. Only ever used in trans. It is not necessary
 931                  // earlier since we don't need to distinguish a DST with its
 932                  // size (e.g., in a deref) vs a DST with the size elsewhere (
 933                  // e.g., in a field).
 934
 935     ty_infer(InferTy), // something used only during inference/typeck
 936     ty_err, // Also only used during inference/typeck, to represent
 937             // the type of an erroneous expression (helps cut down
 938             // on non-useful type error messages)
 939 }
 940
 941 #[deriving(Clone, PartialEq, Eq, Hash, Show)]
 942 pub struct TyTrait {
 943     pub def_id: DefId,
 944     pub substs: Substs,
 945     pub bounds: ExistentialBounds
 946 }
 947
 948 #[deriving(PartialEq, Eq, Hash, Show)]
 949 pub struct TraitRef {
 950     pub def_id: DefId,
 951     pub substs: Substs,
 952 }
 953
 954 #[deriving(Clone, PartialEq)]
 955 pub enum IntVarValue {
 956     IntType(ast::IntTy),
 957     UintType(ast::UintTy),
 958 }
 959
 960 #[deriving(Clone, Show)]
 961 pub enum terr_vstore_kind {
 962     terr_vec,
 963     terr_str,
 964     terr_fn,
 965     terr_trait
 966 }
 967
 968 #[deriving(Clone, Show)]
 969 pub struct expected_found<T> {
 970     pub expected: T,
 971     pub found: T
 972 }
 973
 974 // Data structures used in type unification
 975 #[deriving(Clone, Show)]
 976 pub enum type_err {
 977     terr_mismatch,
 978     terr_fn_style_mismatch(expected_found<FnStyle>),
 979     terr_onceness_mismatch(expected_found<Onceness>),
 980     terr_abi_mismatch(expected_found<abi::Abi>),
 981     terr_mutability,
 982     terr_sigil_mismatch(expected_found<TraitStore>),
 983     terr_box_mutability,
 984     terr_ptr_mutability,
 985     terr_ref_mutability,
 986     terr_vec_mutability,
 987     terr_tuple_size(expected_found<uint>),
 988     terr_ty_param_size(expected_found<uint>),
 989     terr_record_size(expected_found<uint>),
 990     terr_record_mutability,
 991     terr_record_fields(expected_found<Ident>),
 992     terr_arg_count,
 993     terr_regions_does_not_outlive(Region, Region),
 994     terr_regions_not_same(Region, Region),
 995     terr_regions_no_overlap(Region, Region),
 996     terr_regions_insufficiently_polymorphic(BoundRegion, Region),
 997     terr_regions_overly_polymorphic(BoundRegion, Region),
 998     terr_trait_stores_differ(terr_vstore_kind, expected_found<TraitStore>),
 999     terr_sorts(expected_found<t>),
1000     terr_integer_as_char,
1001     terr_int_mismatch(expected_found<IntVarValue>),
1002     terr_float_mismatch(expected_found<ast::FloatTy>),
1003     terr_traits(expected_found<ast::DefId>),
1004     terr_builtin_bounds(expected_found<BuiltinBounds>),
1005     terr_variadic_mismatch(expected_found<bool>)
1006 }
1007
1008 /// Bounds suitable for a named type parameter like `A` in `fn foo<A>`
1009 /// as well as the existential type parameter in an object type.
1010 #[deriving(PartialEq, Eq, Hash, Clone, Show)]
1011 pub struct ParamBounds {
1012     pub opt_region_bound: Option<ty::Region>,
1013     pub builtin_bounds: BuiltinBounds,
1014     pub trait_bounds: Vec<Rc<TraitRef>>
1015 }
1016
1017 /// Bounds suitable for an existentially quantified type parameter
1018 /// such as those that appear in object types or closure types. The
1019 /// major difference between this case and `ParamBounds` is that
1020 /// general purpose trait bounds are omitted.
1021 #[deriving(PartialEq, Eq, Hash, Clone, Show)]
1022 pub struct ExistentialBounds {
1023     pub region_bound: ty::Region,
1024     pub builtin_bounds: BuiltinBounds
1025 }
1026
1027 pub type BuiltinBounds = EnumSet<BuiltinBound>;
1028
1029 #[deriving(Clone, Encodable, PartialEq, Eq, Decodable, Hash, Show)]
1030 #[repr(uint)]
1031 pub enum BuiltinBound {
1032     BoundSend,
1033     BoundSized,
1034     BoundCopy,
1035     BoundSync,
1036 }
1037
1038 pub fn empty_builtin_bounds() -> BuiltinBounds {
1039     EnumSet::empty()
1040 }
1041
1042 pub fn all_builtin_bounds() -> BuiltinBounds {
1043     let mut set = EnumSet::empty();
1044     set.add(BoundSend);
1045     set.add(BoundSized);
1046     set.add(BoundSync);
1047     set
1048 }
1049
1050 pub fn region_existential_bound(r: ty::Region) -> ExistentialBounds {
1051     /*!
1052      * An existential bound that does not implement any traits.
1053      */
1054
1055     ty::ExistentialBounds { region_bound: r,
1056                             builtin_bounds: empty_builtin_bounds() }
1057 }
1058
1059 impl CLike for BuiltinBound {
1060     fn to_uint(&self) -> uint {
1061         *self as uint
1062     }
1063     fn from_uint(v: uint) -> BuiltinBound {
1064         unsafe { mem::transmute(v) }
1065     }
1066 }
1067
1068 #[deriving(Clone, PartialEq, Eq, Hash)]
1069 pub struct TyVid {
1070     pub index: uint
1071 }
1072
1073 #[deriving(Clone, PartialEq, Eq, Hash)]
1074 pub struct IntVid {
1075     pub index: uint
1076 }
1077
1078 #[deriving(Clone, PartialEq, Eq, Hash)]
1079 pub struct FloatVid {
1080     pub index: uint
1081 }
1082
1083 #[deriving(Clone, PartialEq, Eq, Encodable, Decodable, Hash)]
1084 pub struct RegionVid {
1085     pub index: uint
1086 }
1087
1088 #[deriving(Clone, PartialEq, Eq, Hash)]
1089 pub enum InferTy {
1090     TyVar(TyVid),
1091     IntVar(IntVid),
1092     FloatVar(FloatVid)
1093 }
1094
1095 #[deriving(Clone, Encodable, Decodable, Eq, Hash, Show)]
1096 pub enum InferRegion {
1097     ReVar(RegionVid),
1098     ReSkolemized(uint, BoundRegion)
1099 }
1100
1101 impl cmp::PartialEq for InferRegion {
1102     fn eq(&self, other: &InferRegion) -> bool {
1103         match ((*self), *other) {
1104             (ReVar(rva), ReVar(rvb)) => {
1105                 rva == rvb
1106             }
1107             (ReSkolemized(rva, _), ReSkolemized(rvb, _)) => {
1108                 rva == rvb
1109             }
1110             _ => false
1111         }
1112     }
1113     fn ne(&self, other: &InferRegion) -> bool {
1114         !((*self) == (*other))
1115     }
1116 }
1117
1118 impl fmt::Show for TyVid {
1119     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result{
1120         write!(f, "<generic #{}>", self.index)
1121     }
1122 }
1123
1124 impl fmt::Show for IntVid {
1125     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1126         write!(f, "<generic integer #{}>", self.index)
1127     }
1128 }
1129
1130 impl fmt::Show for FloatVid {
1131     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1132         write!(f, "<generic float #{}>", self.index)
1133     }
1134 }
1135
1136 impl fmt::Show for RegionVid {
1137     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1138         write!(f, "'<generic lifetime #{}>", self.index)
1139     }
1140 }
1141
1142 impl fmt::Show for FnSig {
1143     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1144         // grr, without tcx not much we can do.
1145         write!(f, "(...)")
1146     }
1147 }
1148
1149 impl fmt::Show for InferTy {
1150     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1151         match *self {
1152             TyVar(ref v) => v.fmt(f),
1153             IntVar(ref v) => v.fmt(f),
1154             FloatVar(ref v) => v.fmt(f),
1155         }
1156     }
1157 }
1158
1159 impl fmt::Show for IntVarValue {
1160     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1161         match *self {
1162             IntType(ref v) => v.fmt(f),
1163             UintType(ref v) => v.fmt(f),
1164         }
1165     }
1166 }
1167
1168 #[deriving(Clone, Show)]
1169 pub struct TypeParameterDef {
1170     pub ident: ast::Ident,
1171     pub def_id: ast::DefId,
1172     pub space: subst::ParamSpace,
1173     pub index: uint,
1174     pub bounds: ParamBounds,
1175     pub default: Option<ty::t>,
1176 }
1177
1178 #[deriving(Encodable, Decodable, Clone, Show)]
1179 pub struct RegionParameterDef {
1180     pub name: ast::Name,
1181     pub def_id: ast::DefId,
1182     pub space: subst::ParamSpace,
1183     pub index: uint,
1184     pub bounds: Vec<ty::Region>,
1185 }
1186
1187 /// Information about the type/lifetime parameters associated with an
1188 /// item or method. Analogous to ast::Generics.
1189 #[deriving(Clone, Show)]
1190 pub struct Generics {
1191     pub types: VecPerParamSpace<TypeParameterDef>,
1192     pub regions: VecPerParamSpace<RegionParameterDef>,
1193 }
1194
1195 impl Generics {
1196     pub fn empty() -> Generics {
1197         Generics { types: VecPerParamSpace::empty(),
1198                    regions: VecPerParamSpace::empty() }
1199     }
1200
1201     pub fn has_type_params(&self, space: subst::ParamSpace) -> bool {
1202         !self.types.is_empty_in(space)
1203     }
1204
1205     pub fn has_region_params(&self, space: subst::ParamSpace) -> bool {
1206         !self.regions.is_empty_in(space)
1207     }
1208 }
1209
1210 /// When type checking, we use the `ParameterEnvironment` to track
1211 /// details about the type/lifetime parameters that are in scope.
1212 /// It primarily stores the bounds information.
1213 ///
1214 /// Note: This information might seem to be redundant with the data in
1215 /// `tcx.ty_param_defs`, but it is not. That table contains the
1216 /// parameter definitions from an "outside" perspective, but this
1217 /// struct will contain the bounds for a parameter as seen from inside
1218 /// the function body. Currently the only real distinction is that
1219 /// bound lifetime parameters are replaced with free ones, but in the
1220 /// future I hope to refine the representation of types so as to make
1221 /// more distinctions clearer.
1222 pub struct ParameterEnvironment {
1223     /// A substitution that can be applied to move from
1224     /// the "outer" view of a type or method to the "inner" view.
1225     /// In general, this means converting from bound parameters to
1226     /// free parameters. Since we currently represent bound/free type
1227     /// parameters in the same way, this only has an affect on regions.
1228     pub free_substs: Substs,
1229
1230     /// Bounds on the various type parameters
1231     pub bounds: VecPerParamSpace<ParamBounds>,
1232
1233     /// Each type parameter has an implicit region bound that
1234     /// indicates it must outlive at least the function body (the user
1235     /// may specify stronger requirements). This field indicates the
1236     /// region of the callee.
1237     pub implicit_region_bound: ty::Region,
1238 }
1239
1240 impl ParameterEnvironment {
1241     pub fn for_item(cx: &ctxt, id: NodeId) -> ParameterEnvironment {
1242         match cx.map.find(id) {
1243             Some(ast_map::NodeImplItem(ref impl_item)) => {
1244                 match **impl_item {
1245                     ast::MethodImplItem(ref method) => {
1246                         let method_def_id = ast_util::local_def(id);
1247                         match ty::impl_or_trait_item(cx, method_def_id) {
1248                             MethodTraitItem(ref method_ty) => {
1249                                 let method_generics = &method_ty.generics;
1250                                 construct_parameter_environment(
1251                                     cx,
1252                                     method_generics,
1253                                     method.pe_body().id)
1254                             }
1255                         }
1256                     }
1257                 }
1258             }
1259             Some(ast_map::NodeTraitItem(trait_method)) => {
1260                 match *trait_method {
1261                     ast::RequiredMethod(ref required) => {
1262                         cx.sess.span_bug(required.span,
1263                                          "ParameterEnvironment::from_item():
1264                                           can't create a parameter \
1265                                           environment for required trait \
1266                                           methods")
1267                     }
1268                     ast::ProvidedMethod(ref method) => {
1269                         let method_def_id = ast_util::local_def(id);
1270                         match ty::impl_or_trait_item(cx, method_def_id) {
1271                             MethodTraitItem(ref method_ty) => {
1272                                 let method_generics = &method_ty.generics;
1273                                 construct_parameter_environment(
1274                                     cx,
1275                                     method_generics,
1276                                     method.pe_body().id)
1277                             }
1278                         }
1279                     }
1280                 }
1281             }
1282             Some(ast_map::NodeItem(item)) => {
1283                 match item.node {
1284                     ast::ItemFn(_, _, _, _, ref body) => {
1285                         // We assume this is a function.
1286                         let fn_def_id = ast_util::local_def(id);
1287                         let fn_pty = ty::lookup_item_type(cx, fn_def_id);
1288
1289                         construct_parameter_environment(cx,
1290                                                         &fn_pty.generics,
1291                                                         body.id)
1292                     }
1293                     ast::ItemEnum(..) |
1294                     ast::ItemStruct(..) |
1295                     ast::ItemImpl(..) |
1296                     ast::ItemStatic(..) => {
1297                         let def_id = ast_util::local_def(id);
1298                         let pty = ty::lookup_item_type(cx, def_id);
1299                         construct_parameter_environment(cx, &pty.generics, id)
1300                     }
1301                     _ => {
1302                         cx.sess.span_bug(item.span,
1303                                          "ParameterEnvironment::from_item():
1304                                           can't create a parameter \
1305                                           environment for this kind of item")
1306                     }
1307                 }
1308             }
1309             _ => {
1310                 cx.sess.bug(format!("ParameterEnvironment::from_item(): \
1311                                      `{}` is not an item",
1312                                     cx.map.node_to_string(id)).as_slice())
1313             }
1314         }
1315     }
1316 }
1317
1318 /// A polytype.
1319 ///
1320 /// - `generics`: the set of type parameters and their bounds
1321 /// - `ty`: the base types, which may reference the parameters defined
1322 ///   in `generics`
1323 #[deriving(Clone, Show)]
1324 pub struct Polytype {
1325     pub generics: Generics,
1326     pub ty: t
1327 }
1328
1329 /// As `Polytype` but for a trait ref.
1330 pub struct TraitDef {
1331     pub generics: Generics,
1332     pub bounds: ParamBounds,
1333     pub trait_ref: Rc<ty::TraitRef>,
1334 }
1335
1336 /// Records the substitutions used to translate the polytype for an
1337 /// item into the monotype of an item reference.
1338 #[deriving(Clone)]
1339 pub struct ItemSubsts {
1340     pub substs: Substs,
1341 }
1342
1343 pub type type_cache = RefCell<DefIdMap<Polytype>>;
1344
1345 pub type node_type_table = RefCell<HashMap<uint,t>>;
1346
1347 /// Records information about each unboxed closure.
1348 pub struct UnboxedClosure {
1349     /// The type of the unboxed closure.
1350     pub closure_type: ClosureTy,
1351     /// The kind of unboxed closure this is.
1352     pub kind: UnboxedClosureKind,
1353 }
1354
1355 #[deriving(PartialEq, Eq)]
1356 pub enum UnboxedClosureKind {
1357     FnUnboxedClosureKind,
1358     FnMutUnboxedClosureKind,
1359     FnOnceUnboxedClosureKind,
1360 }
1361
1362 impl UnboxedClosureKind {
1363     pub fn trait_did(&self, cx: &ctxt) -> ast::DefId {
1364         let result = match *self {
1365             FnUnboxedClosureKind => cx.lang_items.require(FnTraitLangItem),
1366             FnMutUnboxedClosureKind => {
1367                 cx.lang_items.require(FnMutTraitLangItem)
1368             }
1369             FnOnceUnboxedClosureKind => {
1370                 cx.lang_items.require(FnOnceTraitLangItem)
1371             }
1372         };
1373         match result {
1374             Ok(trait_did) => trait_did,
1375             Err(err) => cx.sess.fatal(err.as_slice()),
1376         }
1377     }
1378 }
1379
1380 pub fn mk_ctxt<'tcx>(s: Session,
1381                      type_arena: &'tcx TypedArena<t_box_>,
1382                      dm: resolve::DefMap,
1383                      named_region_map: resolve_lifetime::NamedRegionMap,
1384                      map: ast_map::Map,
1385                      freevars: freevars::freevar_map,
1386                      capture_modes: freevars::CaptureModeMap,
1387                      region_maps: middle::region::RegionMaps,
1388                      lang_items: middle::lang_items::LanguageItems,
1389                      stability: stability::Index) -> ctxt<'tcx> {
1390     ctxt {
1391         type_arena: type_arena,
1392         interner: RefCell::new(FnvHashMap::new()),
1393         named_region_map: named_region_map,
1394         item_variance_map: RefCell::new(DefIdMap::new()),
1395         variance_computed: Cell::new(false),
1396         next_id: Cell::new(primitives::LAST_PRIMITIVE_ID),
1397         sess: s,
1398         def_map: dm,
1399         region_maps: region_maps,
1400         node_types: RefCell::new(HashMap::new()),
1401         item_substs: RefCell::new(NodeMap::new()),
1402         trait_refs: RefCell::new(NodeMap::new()),
1403         trait_defs: RefCell::new(DefIdMap::new()),
1404         map: map,
1405         intrinsic_defs: RefCell::new(DefIdMap::new()),
1406         freevars: RefCell::new(freevars),
1407         tcache: RefCell::new(DefIdMap::new()),
1408         rcache: RefCell::new(HashMap::new()),
1409         short_names_cache: RefCell::new(HashMap::new()),
1410         needs_unwind_cleanup_cache: RefCell::new(HashMap::new()),
1411         tc_cache: RefCell::new(HashMap::new()),
1412         ast_ty_to_ty_cache: RefCell::new(NodeMap::new()),
1413         enum_var_cache: RefCell::new(DefIdMap::new()),
1414         impl_or_trait_items: RefCell::new(DefIdMap::new()),
1415         trait_item_def_ids: RefCell::new(DefIdMap::new()),
1416         trait_items_cache: RefCell::new(DefIdMap::new()),
1417         impl_trait_cache: RefCell::new(DefIdMap::new()),
1418         ty_param_defs: RefCell::new(NodeMap::new()),
1419         adjustments: RefCell::new(NodeMap::new()),
1420         normalized_cache: RefCell::new(HashMap::new()),
1421         lang_items: lang_items,
1422         provided_method_sources: RefCell::new(DefIdMap::new()),
1423         superstructs: RefCell::new(DefIdMap::new()),
1424         struct_fields: RefCell::new(DefIdMap::new()),
1425         destructor_for_type: RefCell::new(DefIdMap::new()),
1426         destructors: RefCell::new(DefIdSet::new()),
1427         trait_impls: RefCell::new(DefIdMap::new()),
1428         inherent_impls: RefCell::new(DefIdMap::new()),
1429         impl_items: RefCell::new(DefIdMap::new()),
1430         used_unsafe: RefCell::new(NodeSet::new()),
1431         used_mut_nodes: RefCell::new(NodeSet::new()),
1432         impl_vtables: RefCell::new(DefIdMap::new()),
1433         populated_external_types: RefCell::new(DefIdSet::new()),
1434         populated_external_traits: RefCell::new(DefIdSet::new()),
1435         upvar_borrow_map: RefCell::new(HashMap::new()),
1436         extern_const_statics: RefCell::new(DefIdMap::new()),
1437         extern_const_variants: RefCell::new(DefIdMap::new()),
1438         method_map: RefCell::new(FnvHashMap::new()),
1439         vtable_map: RefCell::new(FnvHashMap::new()),
1440         dependency_formats: RefCell::new(HashMap::new()),
1441         unboxed_closures: RefCell::new(DefIdMap::new()),
1442         node_lint_levels: RefCell::new(HashMap::new()),
1443         transmute_restrictions: RefCell::new(Vec::new()),
1444         stability: RefCell::new(stability),
1445         capture_modes: RefCell::new(capture_modes),
1446     }
1447 }
1448
1449 // Type constructors
1450
1451 // Interns a type/name combination, stores the resulting box in cx.interner,
1452 // and returns the box as cast to an unsafe ptr (see comments for t above).
1453 pub fn mk_t(cx: &ctxt, st: sty) -> t {
1454     // Check for primitive types.
1455     match st {
1456         ty_nil => return mk_nil(),
1457         ty_err => return mk_err(),
1458         ty_bool => return mk_bool(),
1459         ty_int(i) => return mk_mach_int(i),
1460         ty_uint(u) => return mk_mach_uint(u),
1461         ty_float(f) => return mk_mach_float(f),
1462         ty_char => return mk_char(),
1463         ty_bot => return mk_bot(),
1464         _ => {}
1465     };
1466
1467     let key = intern_key { sty: &st };
1468
1469     match cx.interner.borrow().find(&key) {
1470         Some(t) => unsafe { return mem::transmute(&t.sty); },
1471         _ => ()
1472     }
1473
1474     let mut flags = 0u;
1475     fn rflags(r: Region) -> uint {
1476         (has_regions as uint) | {
1477             match r {
1478               ty::ReInfer(_) => needs_infer as uint,
1479               _ => 0u
1480             }
1481         }
1482     }
1483     fn sflags(substs: &Substs) -> uint {
1484         let mut f = 0u;
1485         let mut i = substs.types.iter();
1486         for tt in i {
1487             f |= get(*tt).flags;
1488         }
1489         match substs.regions {
1490             subst::ErasedRegions => {}
1491             subst::NonerasedRegions(ref regions) => {
1492                 for r in regions.iter() {
1493                     f |= rflags(*r)
1494                 }
1495             }
1496         }
1497         return f;
1498     }
1499     fn flags_for_bounds(bounds: &ExistentialBounds) -> uint {
1500         rflags(bounds.region_bound)
1501     }
1502     match &st {
1503       &ty_nil | &ty_bool | &ty_char | &ty_int(_) | &ty_float(_) | &ty_uint(_) |
1504       &ty_str => {}
1505       // You might think that we could just return ty_err for
1506       // any type containing ty_err as a component, and get
1507       // rid of the has_ty_err flag -- likewise for ty_bot (with
1508       // the exception of function types that return bot).
1509       // But doing so caused sporadic memory corruption, and
1510       // neither I (tjc) nor nmatsakis could figure out why,
1511       // so we're doing it this way.
1512       &ty_bot => flags |= has_ty_bot as uint,
1513       &ty_err => flags |= has_ty_err as uint,
1514       &ty_param(ref p) => {
1515           if p.space == subst::SelfSpace {
1516               flags |= has_self as uint;
1517           } else {
1518               flags |= has_params as uint;
1519           }
1520       }
1521       &ty_unboxed_closure(_, ref region) => flags |= rflags(*region),
1522       &ty_infer(_) => flags |= needs_infer as uint,
1523       &ty_enum(_, ref substs) | &ty_struct(_, ref substs) => {
1524           flags |= sflags(substs);
1525       }
1526       &ty_trait(box ty::TyTrait { ref substs, ref bounds, .. }) => {
1527           flags |= sflags(substs);
1528           flags |= flags_for_bounds(bounds);
1529       }
1530       &ty_box(tt) | &ty_uniq(tt) | &ty_vec(tt, _) | &ty_open(tt) => {
1531         flags |= get(tt).flags
1532       }
1533       &ty_ptr(ref m) => {
1534         flags |= get(m.ty).flags;
1535       }
1536       &ty_rptr(r, ref m) => {
1537         flags |= rflags(r);
1538         flags |= get(m.ty).flags;
1539       }
1540       &ty_tup(ref ts) => for tt in ts.iter() { flags |= get(*tt).flags; },
1541       &ty_bare_fn(ref f) => {
1542         for a in f.sig.inputs.iter() { flags |= get(*a).flags; }
1543         flags |= get(f.sig.output).flags;
1544         // T -> _|_ is *not* _|_ !
1545         flags &= !(has_ty_bot as uint);
1546       }
1547       &ty_closure(ref f) => {
1548         match f.store {
1549             RegionTraitStore(r, _) => {
1550                 flags |= rflags(r);
1551             }
1552             _ => {}
1553         }
1554         for a in f.sig.inputs.iter() { flags |= get(*a).flags; }
1555         flags |= get(f.sig.output).flags;
1556         // T -> _|_ is *not* _|_ !
1557         flags &= !(has_ty_bot as uint);
1558         flags |= flags_for_bounds(&f.bounds);
1559       }
1560     }
1561
1562     let t = cx.type_arena.alloc(t_box_ {
1563         sty: st,
1564         id: cx.next_id.get(),
1565         flags: flags,
1566     });
1567
1568     let sty_ptr = &t.sty as *const sty;
1569
1570     let key = intern_key {
1571         sty: sty_ptr,
1572     };
1573
1574     cx.interner.borrow_mut().insert(key, t);
1575
1576     cx.next_id.set(cx.next_id.get() + 1);
1577
1578     unsafe {
1579         mem::transmute::<*const sty, t>(sty_ptr)
1580     }
1581 }
1582
1583 #[inline]
1584 pub fn mk_prim_t(primitive: &'static t_box_) -> t {
1585     unsafe {
1586         mem::transmute::<&'static t_box_, t>(primitive)
1587     }
1588 }
1589
1590 #[inline]
1591 pub fn mk_nil() -> t { mk_prim_t(&primitives::TY_NIL) }
1592
1593 #[inline]
1594 pub fn mk_err() -> t { mk_prim_t(&primitives::TY_ERR) }
1595
1596 #[inline]
1597 pub fn mk_bot() -> t { mk_prim_t(&primitives::TY_BOT) }
1598
1599 #[inline]
1600 pub fn mk_bool() -> t { mk_prim_t(&primitives::TY_BOOL) }
1601
1602 #[inline]
1603 pub fn mk_int() -> t { mk_prim_t(&primitives::TY_INT) }
1604
1605 #[inline]
1606 pub fn mk_i8() -> t { mk_prim_t(&primitives::TY_I8) }
1607
1608 #[inline]
1609 pub fn mk_i16() -> t { mk_prim_t(&primitives::TY_I16) }
1610
1611 #[inline]
1612 pub fn mk_i32() -> t { mk_prim_t(&primitives::TY_I32) }
1613
1614 #[inline]
1615 pub fn mk_i64() -> t { mk_prim_t(&primitives::TY_I64) }
1616
1617 #[inline]
1618 pub fn mk_f32() -> t { mk_prim_t(&primitives::TY_F32) }
1619
1620 #[inline]
1621 pub fn mk_f64() -> t { mk_prim_t(&primitives::TY_F64) }
1622
1623 #[inline]
1624 pub fn mk_uint() -> t { mk_prim_t(&primitives::TY_UINT) }
1625
1626 #[inline]
1627 pub fn mk_u8() -> t { mk_prim_t(&primitives::TY_U8) }
1628
1629 #[inline]
1630 pub fn mk_u16() -> t { mk_prim_t(&primitives::TY_U16) }
1631
1632 #[inline]
1633 pub fn mk_u32() -> t { mk_prim_t(&primitives::TY_U32) }
1634
1635 #[inline]
1636 pub fn mk_u64() -> t { mk_prim_t(&primitives::TY_U64) }
1637
1638 pub fn mk_mach_int(tm: ast::IntTy) -> t {
1639     match tm {
1640         ast::TyI    => mk_int(),
1641         ast::TyI8   => mk_i8(),
1642         ast::TyI16  => mk_i16(),
1643         ast::TyI32  => mk_i32(),
1644         ast::TyI64  => mk_i64(),
1645     }
1646 }
1647
1648 pub fn mk_mach_uint(tm: ast::UintTy) -> t {
1649     match tm {
1650         ast::TyU    => mk_uint(),
1651         ast::TyU8   => mk_u8(),
1652         ast::TyU16  => mk_u16(),
1653         ast::TyU32  => mk_u32(),
1654         ast::TyU64  => mk_u64(),
1655     }
1656 }
1657
1658 pub fn mk_mach_float(tm: ast::FloatTy) -> t {
1659     match tm {
1660         ast::TyF32  => mk_f32(),
1661         ast::TyF64  => mk_f64(),
1662     }
1663 }
1664
1665 #[inline]
1666 pub fn mk_char() -> t { mk_prim_t(&primitives::TY_CHAR) }
1667
1668 pub fn mk_str(cx: &ctxt) -> t {
1669     mk_t(cx, ty_str)
1670 }
1671
1672 pub fn mk_str_slice(cx: &ctxt, r: Region, m: ast::Mutability) -> t {
1673     mk_rptr(cx, r,
1674             mt {
1675                 ty: mk_t(cx, ty_str),
1676                 mutbl: m
1677             })
1678 }
1679
1680 pub fn mk_enum(cx: &ctxt, did: ast::DefId, substs: Substs) -> t {
1681     // take a copy of substs so that we own the vectors inside
1682     mk_t(cx, ty_enum(did, substs))
1683 }
1684
1685 pub fn mk_box(cx: &ctxt, ty: t) -> t { mk_t(cx, ty_box(ty)) }
1686
1687 pub fn mk_uniq(cx: &ctxt, ty: t) -> t { mk_t(cx, ty_uniq(ty)) }
1688
1689 pub fn mk_ptr(cx: &ctxt, tm: mt) -> t { mk_t(cx, ty_ptr(tm)) }
1690
1691 pub fn mk_rptr(cx: &ctxt, r: Region, tm: mt) -> t { mk_t(cx, ty_rptr(r, tm)) }
1692
1693 pub fn mk_mut_rptr(cx: &ctxt, r: Region, ty: t) -> t {
1694     mk_rptr(cx, r, mt {ty: ty, mutbl: ast::MutMutable})
1695 }
1696 pub fn mk_imm_rptr(cx: &ctxt, r: Region, ty: t) -> t {
1697     mk_rptr(cx, r, mt {ty: ty, mutbl: ast::MutImmutable})
1698 }
1699
1700 pub fn mk_mut_ptr(cx: &ctxt, ty: t) -> t {
1701     mk_ptr(cx, mt {ty: ty, mutbl: ast::MutMutable})
1702 }
1703
1704 pub fn mk_imm_ptr(cx: &ctxt, ty: t) -> t {
1705     mk_ptr(cx, mt {ty: ty, mutbl: ast::MutImmutable})
1706 }
1707
1708 pub fn mk_nil_ptr(cx: &ctxt) -> t {
1709     mk_ptr(cx, mt {ty: mk_nil(), mutbl: ast::MutImmutable})
1710 }
1711
1712 pub fn mk_vec(cx: &ctxt, t: t, sz: Option<uint>) -> t {
1713     mk_t(cx, ty_vec(t, sz))
1714 }
1715
1716 pub fn mk_slice(cx: &ctxt, r: Region, tm: mt) -> t {
1717     mk_rptr(cx, r,
1718             mt {
1719                 ty: mk_vec(cx, tm.ty, None),
1720                 mutbl: tm.mutbl
1721             })
1722 }
1723
1724 pub fn mk_tup(cx: &ctxt, ts: Vec<t>) -> t { mk_t(cx, ty_tup(ts)) }
1725
1726 pub fn mk_closure(cx: &ctxt, fty: ClosureTy) -> t {
1727     mk_t(cx, ty_closure(box fty))
1728 }
1729
1730 pub fn mk_bare_fn(cx: &ctxt, fty: BareFnTy) -> t {
1731     mk_t(cx, ty_bare_fn(fty))
1732 }
1733
1734 pub fn mk_ctor_fn(cx: &ctxt,
1735                   binder_id: ast::NodeId,
1736                   input_tys: &[ty::t],
1737                   output: ty::t) -> t {
1738     let input_args = input_tys.iter().map(|t| *t).collect();
1739     mk_bare_fn(cx,
1740                BareFnTy {
1741                    fn_style: ast::NormalFn,
1742                    abi: abi::Rust,
1743                    sig: FnSig {
1744                     binder_id: binder_id,
1745                     inputs: input_args,
1746                     output: output,
1747                     variadic: false
1748                    }
1749                 })
1750 }
1751
1752
1753 pub fn mk_trait(cx: &ctxt,
1754                 did: ast::DefId,
1755                 substs: Substs,
1756                 bounds: ExistentialBounds)
1757                 -> t {
1758     // take a copy of substs so that we own the vectors inside
1759     let inner = box TyTrait {
1760         def_id: did,
1761         substs: substs,
1762         bounds: bounds
1763     };
1764     mk_t(cx, ty_trait(inner))
1765 }
1766
1767 pub fn mk_struct(cx: &ctxt, struct_id: ast::DefId, substs: Substs) -> t {
1768     // take a copy of substs so that we own the vectors inside
1769     mk_t(cx, ty_struct(struct_id, substs))
1770 }
1771
1772 pub fn mk_unboxed_closure(cx: &ctxt, closure_id: ast::DefId, region: Region)
1773                           -> t {
1774     mk_t(cx, ty_unboxed_closure(closure_id, region))
1775 }
1776
1777 pub fn mk_var(cx: &ctxt, v: TyVid) -> t { mk_infer(cx, TyVar(v)) }
1778
1779 pub fn mk_int_var(cx: &ctxt, v: IntVid) -> t { mk_infer(cx, IntVar(v)) }
1780
1781 pub fn mk_float_var(cx: &ctxt, v: FloatVid) -> t { mk_infer(cx, FloatVar(v)) }
1782
1783 pub fn mk_infer(cx: &ctxt, it: InferTy) -> t { mk_t(cx, ty_infer(it)) }
1784
1785 pub fn mk_param(cx: &ctxt, space: subst::ParamSpace, n: uint, k: DefId) -> t {
1786     mk_t(cx, ty_param(ParamTy { space: space, idx: n, def_id: k }))
1787 }
1788
1789 pub fn mk_self_type(cx: &ctxt, did: ast::DefId) -> t {
1790     mk_param(cx, subst::SelfSpace, 0, did)
1791 }
1792
1793 pub fn mk_param_from_def(cx: &ctxt, def: &TypeParameterDef) -> t {
1794     mk_param(cx, def.space, def.index, def.def_id)
1795 }
1796
1797 pub fn mk_open(cx: &ctxt, t: t) -> t { mk_t(cx, ty_open(t)) }
1798
1799 pub fn walk_ty(ty: t, f: |t|) {
1800     maybe_walk_ty(ty, |t| { f(t); true });
1801 }
1802
1803 pub fn maybe_walk_ty(ty: t, f: |t| -> bool) {
1804     if !f(ty) {
1805         return;
1806     }
1807     match get(ty).sty {
1808         ty_nil | ty_bot | ty_bool | ty_char | ty_int(_) | ty_uint(_) | ty_float(_) |
1809         ty_str | ty_infer(_) | ty_param(_) | ty_unboxed_closure(_, _) | ty_err => {}
1810         ty_box(ty) | ty_uniq(ty) | ty_vec(ty, _) | ty_open(ty) => maybe_walk_ty(ty, f),
1811         ty_ptr(ref tm) | ty_rptr(_, ref tm) => {
1812             maybe_walk_ty(tm.ty, f);
1813         }
1814         ty_enum(_, ref substs) | ty_struct(_, ref substs) |
1815         ty_trait(box TyTrait { ref substs, .. }) => {
1816             for subty in (*substs).types.iter() {
1817                 maybe_walk_ty(*subty, |x| f(x));
1818             }
1819         }
1820         ty_tup(ref ts) => { for tt in ts.iter() { maybe_walk_ty(*tt, |x| f(x)); } }
1821         ty_bare_fn(ref ft) => {
1822             for a in ft.sig.inputs.iter() { maybe_walk_ty(*a, |x| f(x)); }
1823             maybe_walk_ty(ft.sig.output, f);
1824         }
1825         ty_closure(ref ft) => {
1826             for a in ft.sig.inputs.iter() { maybe_walk_ty(*a, |x| f(x)); }
1827             maybe_walk_ty(ft.sig.output, f);
1828         }
1829     }
1830 }
1831
1832 // Folds types from the bottom up.
1833 pub fn fold_ty(cx: &ctxt, t0: t, fldop: |t| -> t) -> t {
1834     let mut f = ty_fold::BottomUpFolder {tcx: cx, fldop: fldop};
1835     f.fold_ty(t0)
1836 }
1837
1838 pub fn walk_regions_and_ty(cx: &ctxt, ty: t, fldr: |r: Region|, fldt: |t: t|)
1839                            -> t {
1840     ty_fold::RegionFolder::general(cx,
1841                                    |r| { fldr(r); r },
1842                                    |t| { fldt(t); t }).fold_ty(ty)
1843 }
1844
1845 impl ParamTy {
1846     pub fn new(space: subst::ParamSpace,
1847                index: uint,
1848                def_id: ast::DefId)
1849                -> ParamTy {
1850         ParamTy { space: space, idx: index, def_id: def_id }
1851     }
1852
1853     pub fn for_self(trait_def_id: ast::DefId) -> ParamTy {
1854         ParamTy::new(subst::SelfSpace, 0, trait_def_id)
1855     }
1856
1857     pub fn for_def(def: &TypeParameterDef) -> ParamTy {
1858         ParamTy::new(def.space, def.index, def.def_id)
1859     }
1860
1861     pub fn to_ty(self, tcx: &ty::ctxt) -> ty::t {
1862         ty::mk_param(tcx, self.space, self.idx, self.def_id)
1863     }
1864 }
1865
1866 impl ItemSubsts {
1867     pub fn empty() -> ItemSubsts {
1868         ItemSubsts { substs: Substs::empty() }
1869     }
1870
1871     pub fn is_noop(&self) -> bool {
1872         self.substs.is_noop()
1873     }
1874 }
1875
1876 // Type utilities
1877
1878 pub fn type_is_nil(ty: t) -> bool { get(ty).sty == ty_nil }
1879
1880 pub fn type_is_bot(ty: t) -> bool {
1881     (get(ty).flags & (has_ty_bot as uint)) != 0
1882 }
1883
1884 pub fn type_is_error(ty: t) -> bool {
1885     (get(ty).flags & (has_ty_err as uint)) != 0
1886 }
1887
1888 pub fn type_needs_subst(ty: t) -> bool {
1889     tbox_has_flag(get(ty), needs_subst)
1890 }
1891
1892 pub fn trait_ref_contains_error(tref: &ty::TraitRef) -> bool {
1893     tref.substs.types.any(|&t| type_is_error(t))
1894 }
1895
1896 pub fn type_is_ty_var(ty: t) -> bool {
1897     match get(ty).sty {
1898       ty_infer(TyVar(_)) => true,
1899       _ => false
1900     }
1901 }
1902
1903 pub fn type_is_bool(ty: t) -> bool { get(ty).sty == ty_bool }
1904
1905 pub fn type_is_self(ty: t) -> bool {
1906     match get(ty).sty {
1907         ty_param(ref p) => p.space == subst::SelfSpace,
1908         _ => false
1909     }
1910 }
1911
1912 fn type_is_slice(ty: t) -> bool {
1913     match get(ty).sty {
1914         ty_ptr(mt) | ty_rptr(_, mt) => match get(mt.ty).sty {
1915             ty_vec(_, None) | ty_str => true,
1916             _ => false,
1917         },
1918         _ => false
1919     }
1920 }
1921
1922 pub fn type_is_vec(ty: t) -> bool {
1923     match get(ty).sty {
1924         ty_vec(..) => true,
1925         ty_ptr(mt{ty: t, ..}) | ty_rptr(_, mt{ty: t, ..}) |
1926         ty_box(t) | ty_uniq(t) => match get(t).sty {
1927             ty_vec(_, None) => true,
1928             _ => false
1929         },
1930         _ => false
1931     }
1932 }
1933
1934 pub fn type_is_structural(ty: t) -> bool {
1935     match get(ty).sty {
1936       ty_struct(..) | ty_tup(_) | ty_enum(..) | ty_closure(_) |
1937       ty_vec(_, Some(_)) | ty_unboxed_closure(..) => true,
1938       _ => type_is_slice(ty) | type_is_trait(ty)
1939     }
1940 }
1941
1942 pub fn type_is_simd(cx: &ctxt, ty: t) -> bool {
1943     match get(ty).sty {
1944         ty_struct(did, _) => lookup_simd(cx, did),
1945         _ => false
1946     }
1947 }
1948
1949 pub fn sequence_element_type(cx: &ctxt, ty: t) -> t {
1950     match get(ty).sty {
1951         ty_vec(ty, _) => ty,
1952         ty_str => mk_mach_uint(ast::TyU8),
1953         ty_open(ty) => sequence_element_type(cx, ty),
1954         _ => cx.sess.bug(format!("sequence_element_type called on non-sequence value: {}",
1955                                  ty_to_string(cx, ty)).as_slice()),
1956     }
1957 }
1958
1959 pub fn simd_type(cx: &ctxt, ty: t) -> t {
1960     match get(ty).sty {
1961         ty_struct(did, ref substs) => {
1962             let fields = lookup_struct_fields(cx, did);
1963             lookup_field_type(cx, did, fields.get(0).id, substs)
1964         }
1965         _ => fail!("simd_type called on invalid type")
1966     }
1967 }
1968
1969 pub fn simd_size(cx: &ctxt, ty: t) -> uint {
1970     match get(ty).sty {
1971         ty_struct(did, _) => {
1972             let fields = lookup_struct_fields(cx, did);
1973             fields.len()
1974         }
1975         _ => fail!("simd_size called on invalid type")
1976     }
1977 }
1978
1979 pub fn type_is_boxed(ty: t) -> bool {
1980     match get(ty).sty {
1981       ty_box(_) => true,
1982       _ => false
1983     }
1984 }
1985
1986 pub fn type_is_region_ptr(ty: t) -> bool {
1987     match get(ty).sty {
1988         ty_rptr(..) => true,
1989         _ => false
1990     }
1991 }
1992
1993 pub fn type_is_unsafe_ptr(ty: t) -> bool {
1994     match get(ty).sty {
1995       ty_ptr(_) => return true,
1996       _ => return false
1997     }
1998 }
1999
2000 pub fn type_is_unique(ty: t) -> bool {
2001     match get(ty).sty {
2002         ty_uniq(_) => match get(ty).sty {
2003             ty_trait(..) => false,
2004             _ => true
2005         },
2006         _ => false
2007     }
2008 }
2009
2010 pub fn type_is_fat_ptr(cx: &ctxt, ty: t) -> bool {
2011     match get(ty).sty {
2012         ty_ptr(mt{ty, ..}) | ty_rptr(_, mt{ty, ..})
2013         | ty_uniq(ty) if !type_is_sized(cx, ty) => true,
2014         _ => false,
2015     }
2016 }
2017
2018 /*
2019  A scalar type is one that denotes an atomic datum, with no sub-components.
2020  (A ty_ptr is scalar because it represents a non-managed pointer, so its
2021  contents are abstract to rustc.)
2022 */
2023 pub fn type_is_scalar(ty: t) -> bool {
2024     match get(ty).sty {
2025       ty_nil | ty_bool | ty_char | ty_int(_) | ty_float(_) | ty_uint(_) |
2026       ty_infer(IntVar(_)) | ty_infer(FloatVar(_)) |
2027       ty_bare_fn(..) | ty_ptr(_) => true,
2028       _ => false
2029     }
2030 }
2031
2032 /// Returns true if this type is a floating point type and false otherwise.
2033 pub fn type_is_floating_point(ty: t) -> bool {
2034     match get(ty).sty {
2035         ty_float(_) => true,
2036         _ => false,
2037     }
2038 }
2039
2040 pub fn type_needs_drop(cx: &ctxt, ty: t) -> bool {
2041     type_contents(cx, ty).needs_drop(cx)
2042 }
2043
2044 // Some things don't need cleanups during unwinding because the
2045 // task can free them all at once later. Currently only things
2046 // that only contain scalars and shared boxes can avoid unwind
2047 // cleanups.
2048 pub fn type_needs_unwind_cleanup(cx: &ctxt, ty: t) -> bool {
2049     match cx.needs_unwind_cleanup_cache.borrow().find(&ty) {
2050         Some(&result) => return result,
2051         None => ()
2052     }
2053
2054     let mut tycache = HashSet::new();
2055     let needs_unwind_cleanup =
2056         type_needs_unwind_cleanup_(cx, ty, &mut tycache, false);
2057     cx.needs_unwind_cleanup_cache.borrow_mut().insert(ty, needs_unwind_cleanup);
2058     return needs_unwind_cleanup;
2059 }
2060
2061 fn type_needs_unwind_cleanup_(cx: &ctxt, ty: t,
2062                               tycache: &mut HashSet<t>,
2063                               encountered_box: bool) -> bool {
2064
2065     // Prevent infinite recursion
2066     if !tycache.insert(ty) {
2067         return false;
2068     }
2069
2070     let mut encountered_box = encountered_box;
2071     let mut needs_unwind_cleanup = false;
2072     maybe_walk_ty(ty, |ty| {
2073         let old_encountered_box = encountered_box;
2074         let result = match get(ty).sty {
2075           ty_box(_) => {
2076             encountered_box = true;
2077             true
2078           }
2079           ty_nil | ty_bot | ty_bool | ty_int(_) | ty_uint(_) | ty_float(_) |
2080           ty_tup(_) | ty_ptr(_) => {
2081             true
2082           }
2083           ty_enum(did, ref substs) => {
2084             for v in (*enum_variants(cx, did)).iter() {
2085                 for aty in v.args.iter() {
2086                     let t = aty.subst(cx, substs);
2087                     needs_unwind_cleanup |=
2088                         type_needs_unwind_cleanup_(cx, t, tycache,
2089                                                    encountered_box);
2090                 }
2091             }
2092             !needs_unwind_cleanup
2093           }
2094           ty_uniq(_) => {
2095             // Once we're inside a box, the annihilator will find
2096             // it and destroy it.
2097             if !encountered_box {
2098                 needs_unwind_cleanup = true;
2099                 false
2100             } else {
2101                 true
2102             }
2103           }
2104           _ => {
2105             needs_unwind_cleanup = true;
2106             false
2107           }
2108         };
2109
2110         encountered_box = old_encountered_box;
2111         result
2112     });
2113
2114     return needs_unwind_cleanup;
2115 }
2116
2117 /**
2118  * Type contents is how the type checker reasons about kinds.
2119  * They track what kinds of things are found within a type.  You can
2120  * think of them as kind of an "anti-kind".  They track the kinds of values
2121  * and thinks that are contained in types.  Having a larger contents for
2122  * a type tends to rule that type *out* from various kinds.  For example,
2123  * a type that contains a reference is not sendable.
2124  *
2125  * The reason we compute type contents and not kinds is that it is
2126  * easier for me (nmatsakis) to think about what is contained within
2127  * a type than to think about what is *not* contained within a type.
2128  */
2129 pub struct TypeContents {
2130     pub bits: u64
2131 }
2132
2133 macro_rules! def_type_content_sets(
2134     (mod $mname:ident { $($name:ident = $bits:expr),+ }) => {
2135         #[allow(non_snake_case)]
2136         mod $mname {
2137             use middle::ty::TypeContents;
2138             $(pub static $name: TypeContents = TypeContents { bits: $bits };)+
2139         }
2140     }
2141 )
2142
2143 def_type_content_sets!(
2144     mod TC {
2145         None                                = 0b0000_0000__0000_0000__0000,
2146
2147         // Things that are interior to the value (first nibble):
2148         InteriorUnsized                     = 0b0000_0000__0000_0000__0001,
2149         InteriorUnsafe                      = 0b0000_0000__0000_0000__0010,
2150         // InteriorAll                         = 0b00000000__00000000__1111,
2151
2152         // Things that are owned by the value (second and third nibbles):
2153         OwnsOwned                           = 0b0000_0000__0000_0001__0000,
2154         OwnsDtor                            = 0b0000_0000__0000_0010__0000,
2155         OwnsManaged /* see [1] below */     = 0b0000_0000__0000_0100__0000,
2156         OwnsAffine                          = 0b0000_0000__0000_1000__0000,
2157         OwnsAll                             = 0b0000_0000__1111_1111__0000,
2158
2159         // Things that are reachable by the value in any way (fourth nibble):
2160         ReachesNonsendAnnot                 = 0b0000_0001__0000_0000__0000,
2161         ReachesBorrowed                     = 0b0000_0010__0000_0000__0000,
2162         // ReachesManaged /* see [1] below */  = 0b0000_0100__0000_0000__0000,
2163         ReachesMutable                      = 0b0000_1000__0000_0000__0000,
2164         ReachesNoSync                       = 0b0001_0000__0000_0000__0000,
2165         ReachesFfiUnsafe                    = 0b0010_0000__0000_0000__0000,
2166         ReachesAll                          = 0b0011_1111__0000_0000__0000,
2167
2168         // Things that cause values to *move* rather than *copy*
2169         Moves                               = 0b0000_0000__0000_1011__0000,
2170
2171         // Things that mean drop glue is necessary
2172         NeedsDrop                           = 0b0000_0000__0000_0111__0000,
2173
2174         // Things that prevent values from being sent
2175         //
2176         // Note: For checking whether something is sendable, it'd
2177         //       be sufficient to have ReachesManaged. However, we include
2178         //       both ReachesManaged and OwnsManaged so that when
2179         //       a parameter has a bound T:Send, we are able to deduce
2180         //       that it neither reaches nor owns a managed pointer.
2181         Nonsendable                         = 0b0000_0111__0000_0100__0000,
2182
2183         // Things that prevent values from being considered sized
2184         Nonsized                            = 0b0000_0000__0000_0000__0001,
2185
2186         // Things that prevent values from being sync
2187         Nonsync                             = 0b0001_0000__0000_0000__0000,
2188
2189         // Things that make values considered not POD (would be same
2190         // as `Moves`, but for the fact that managed data `@` is
2191         // not considered POD)
2192         Noncopy                              = 0b0000_0000__0000_1111__0000,
2193
2194         // Bits to set when a managed value is encountered
2195         //
2196         // [1] Do not set the bits TC::OwnsManaged or
2197         //     TC::ReachesManaged directly, instead reference
2198         //     TC::Managed to set them both at once.
2199         Managed                             = 0b0000_0100__0000_0100__0000,
2200
2201         // All bits
2202         All                                 = 0b1111_1111__1111_1111__1111
2203     }
2204 )
2205
2206 impl TypeContents {
2207     pub fn meets_builtin_bound(&self, cx: &ctxt, bb: BuiltinBound) -> bool {
2208         match bb {
2209             BoundSend => self.is_sendable(cx),
2210             BoundSized => self.is_sized(cx),
2211             BoundCopy => self.is_copy(cx),
2212             BoundSync => self.is_sync(cx),
2213         }
2214     }
2215
2216     pub fn when(&self, cond: bool) -> TypeContents {
2217         if cond {*self} else {TC::None}
2218     }
2219
2220     pub fn intersects(&self, tc: TypeContents) -> bool {
2221         (self.bits & tc.bits) != 0
2222     }
2223
2224     pub fn is_sendable(&self, _: &ctxt) -> bool {
2225         !self.intersects(TC::Nonsendable)
2226     }
2227
2228     pub fn is_sync(&self, _: &ctxt) -> bool {
2229         !self.intersects(TC::Nonsync)
2230     }
2231
2232     pub fn owns_managed(&self) -> bool {
2233         self.intersects(TC::OwnsManaged)
2234     }
2235
2236     pub fn owns_owned(&self) -> bool {
2237         self.intersects(TC::OwnsOwned)
2238     }
2239
2240     pub fn is_sized(&self, _: &ctxt) -> bool {
2241         !self.intersects(TC::Nonsized)
2242     }
2243
2244     pub fn is_copy(&self, _: &ctxt) -> bool {
2245         !self.intersects(TC::Noncopy)
2246     }
2247
2248     pub fn interior_unsafe(&self) -> bool {
2249         self.intersects(TC::InteriorUnsafe)
2250     }
2251
2252     pub fn interior_unsized(&self) -> bool {
2253         self.intersects(TC::InteriorUnsized)
2254     }
2255
2256     pub fn moves_by_default(&self, _: &ctxt) -> bool {
2257         self.intersects(TC::Moves)
2258     }
2259
2260     pub fn needs_drop(&self, _: &ctxt) -> bool {
2261         self.intersects(TC::NeedsDrop)
2262     }
2263
2264     pub fn owned_pointer(&self) -> TypeContents {
2265         /*!
2266          * Includes only those bits that still apply
2267          * when indirected through a `Box` pointer
2268          */
2269         TC::OwnsOwned | (
2270             *self & (TC::OwnsAll | TC::ReachesAll))
2271     }
2272
2273     pub fn reference(&self, bits: TypeContents) -> TypeContents {
2274         /*!
2275          * Includes only those bits that still apply
2276          * when indirected through a reference (`&`)
2277          */
2278         bits | (
2279             *self & TC::ReachesAll)
2280     }
2281
2282     pub fn managed_pointer(&self) -> TypeContents {
2283         /*!
2284          * Includes only those bits that still apply
2285          * when indirected through a managed pointer (`@`)
2286          */
2287         TC::Managed | (
2288             *self & TC::ReachesAll)
2289     }
2290
2291     pub fn unsafe_pointer(&self) -> TypeContents {
2292         /*!
2293          * Includes only those bits that still apply
2294          * when indirected through an unsafe pointer (`*`)
2295          */
2296         *self & TC::ReachesAll
2297     }
2298
2299     pub fn union<T>(v: &[T], f: |&T| -> TypeContents) -> TypeContents {
2300         v.iter().fold(TC::None, |tc, t| tc | f(t))
2301     }
2302
2303     pub fn has_dtor(&self) -> bool {
2304         self.intersects(TC::OwnsDtor)
2305     }
2306 }
2307
2308 impl ops::BitOr<TypeContents,TypeContents> for TypeContents {
2309     fn bitor(&self, other: &TypeContents) -> TypeContents {
2310         TypeContents {bits: self.bits | other.bits}
2311     }
2312 }
2313
2314 impl ops::BitAnd<TypeContents,TypeContents> for TypeContents {
2315     fn bitand(&self, other: &TypeContents) -> TypeContents {
2316         TypeContents {bits: self.bits & other.bits}
2317     }
2318 }
2319
2320 impl ops::Sub<TypeContents,TypeContents> for TypeContents {
2321     fn sub(&self, other: &TypeContents) -> TypeContents {
2322         TypeContents {bits: self.bits & !other.bits}
2323     }
2324 }
2325
2326 impl fmt::Show for TypeContents {
2327     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2328         write!(f, "TypeContents({:t})", self.bits)
2329     }
2330 }
2331
2332 pub fn type_is_sendable(cx: &ctxt, t: ty::t) -> bool {
2333     type_contents(cx, t).is_sendable(cx)
2334 }
2335
2336 pub fn type_interior_is_unsafe(cx: &ctxt, t: ty::t) -> bool {
2337     type_contents(cx, t).interior_unsafe()
2338 }
2339
2340 pub fn type_contents(cx: &ctxt, ty: t) -> TypeContents {
2341     let ty_id = type_id(ty);
2342
2343     match cx.tc_cache.borrow().find(&ty_id) {
2344         Some(tc) => { return *tc; }
2345         None => {}
2346     }
2347
2348     let mut cache = HashMap::new();
2349     let result = tc_ty(cx, ty, &mut cache);
2350
2351     cx.tc_cache.borrow_mut().insert(ty_id, result);
2352     return result;
2353
2354     fn tc_ty(cx: &ctxt,
2355              ty: t,
2356              cache: &mut HashMap<uint, TypeContents>) -> TypeContents
2357     {
2358         // Subtle: Note that we are *not* using cx.tc_cache here but rather a
2359         // private cache for this walk.  This is needed in the case of cyclic
2360         // types like:
2361         //
2362         //     struct List { next: Box<Option<List>>, ... }
2363         //
2364         // When computing the type contents of such a type, we wind up deeply
2365         // recursing as we go.  So when we encounter the recursive reference
2366         // to List, we temporarily use TC::None as its contents.  Later we'll
2367         // patch up the cache with the correct value, once we've computed it
2368         // (this is basically a co-inductive process, if that helps).  So in
2369         // the end we'll compute TC::OwnsOwned, in this case.
2370         //
2371         // The problem is, as we are doing the computation, we will also
2372         // compute an *intermediate* contents for, e.g., Option<List> of
2373         // TC::None.  This is ok during the computation of List itself, but if
2374         // we stored this intermediate value into cx.tc_cache, then later
2375         // requests for the contents of Option<List> would also yield TC::None
2376         // which is incorrect.  This value was computed based on the crutch
2377         // value for the type contents of list.  The correct value is
2378         // TC::OwnsOwned.  This manifested as issue #4821.
2379         let ty_id = type_id(ty);
2380         match cache.find(&ty_id) {
2381             Some(tc) => { return *tc; }
2382             None => {}
2383         }
2384         match cx.tc_cache.borrow().find(&ty_id) {    // Must check both caches!
2385             Some(tc) => { return *tc; }
2386             None => {}
2387         }
2388         cache.insert(ty_id, TC::None);
2389
2390         let result = match get(ty).sty {
2391             // uint and int are ffi-unsafe
2392             ty_uint(ast::TyU) | ty_int(ast::TyI) => {
2393                 TC::ReachesFfiUnsafe
2394             }
2395
2396             // Scalar and unique types are sendable, and durable
2397             ty_nil | ty_bot | ty_bool | ty_int(_) | ty_uint(_) | ty_float(_) |
2398             ty_bare_fn(_) | ty::ty_char => {
2399                 TC::None
2400             }
2401
2402             ty_closure(ref c) => {
2403                 closure_contents(cx, &**c) | TC::ReachesFfiUnsafe
2404             }
2405
2406             ty_box(typ) => {
2407                 tc_ty(cx, typ, cache).managed_pointer() | TC::ReachesFfiUnsafe
2408             }
2409
2410             ty_uniq(typ) => {
2411                 TC::ReachesFfiUnsafe | match get(typ).sty {
2412                     ty_str => TC::OwnsOwned,
2413                     _ => tc_ty(cx, typ, cache).owned_pointer(),
2414                 }
2415             }
2416
2417             ty_trait(box ty::TyTrait { bounds, .. }) => {
2418                 object_contents(cx, bounds) | TC::ReachesFfiUnsafe | TC::Nonsized
2419             }
2420
2421             ty_ptr(ref mt) => {
2422                 tc_ty(cx, mt.ty, cache).unsafe_pointer()
2423             }
2424
2425             ty_rptr(r, ref mt) => {
2426                 TC::ReachesFfiUnsafe | match get(mt.ty).sty {
2427                     ty_str => borrowed_contents(r, ast::MutImmutable),
2428                     ty_vec(..) => tc_ty(cx, mt.ty, cache).reference(borrowed_contents(r, mt.mutbl)),
2429                     _ => tc_ty(cx, mt.ty, cache).reference(borrowed_contents(r, mt.mutbl)),
2430                 }
2431             }
2432
2433             ty_vec(t, Some(_)) => {
2434                 tc_ty(cx, t, cache)
2435             }
2436
2437             ty_vec(t, None) => {
2438                 tc_ty(cx, t, cache) | TC::Nonsized
2439             }
2440             ty_str => TC::Nonsized,
2441
2442             ty_struct(did, ref substs) => {
2443                 let flds = struct_fields(cx, did, substs);
2444                 let mut res =
2445                     TypeContents::union(flds.as_slice(),
2446                                         |f| tc_mt(cx, f.mt, cache));
2447
2448                 if !lookup_repr_hints(cx, did).contains(&attr::ReprExtern) {
2449                     res = res | TC::ReachesFfiUnsafe;
2450                 }
2451
2452                 if ty::has_dtor(cx, did) {
2453                     res = res | TC::OwnsDtor;
2454                 }
2455                 apply_lang_items(cx, did, res)
2456             }
2457
2458             ty_unboxed_closure(did, r) => {
2459                 // FIXME(#14449): `borrowed_contents` below assumes `&mut`
2460                 // unboxed closure.
2461                 let upvars = unboxed_closure_upvars(cx, did);
2462                 TypeContents::union(upvars.as_slice(),
2463                                     |f| tc_ty(cx, f.ty, cache)) |
2464                     borrowed_contents(r, MutMutable)
2465             }
2466
2467             ty_tup(ref tys) => {
2468                 TypeContents::union(tys.as_slice(),
2469                                     |ty| tc_ty(cx, *ty, cache))
2470             }
2471
2472             ty_enum(did, ref substs) => {
2473                 let variants = substd_enum_variants(cx, did, substs);
2474                 let mut res =
2475                     TypeContents::union(variants.as_slice(), |variant| {
2476                         TypeContents::union(variant.args.as_slice(),
2477                                             |arg_ty| {
2478                             tc_ty(cx, *arg_ty, cache)
2479                         })
2480                     });
2481
2482                 if ty::has_dtor(cx, did) {
2483                     res = res | TC::OwnsDtor;
2484                 }
2485
2486                 if variants.len() != 0 {
2487                     let repr_hints = lookup_repr_hints(cx, did);
2488                     if repr_hints.len() > 1 {
2489                         // this is an error later on, but this type isn't safe
2490                         res = res | TC::ReachesFfiUnsafe;
2491                     }
2492
2493                     match repr_hints.as_slice().get(0) {
2494                         Some(h) => if !h.is_ffi_safe() {
2495                             res = res | TC::ReachesFfiUnsafe;
2496                         },
2497                         // ReprAny
2498                         None => {
2499                             res = res | TC::ReachesFfiUnsafe;
2500
2501                             // We allow ReprAny enums if they are eligible for
2502                             // the nullable pointer optimization and the
2503                             // contained type is an `extern fn`
2504
2505                             if variants.len() == 2 {
2506                                 let mut data_idx = 0;
2507
2508                                 if variants.get(0).args.len() == 0 {
2509                                     data_idx = 1;
2510                                 }
2511
2512                                 if variants.get(data_idx).args.len() == 1 {
2513                                     match get(*variants.get(data_idx).args.get(0)).sty {
2514                                         ty_bare_fn(..) => { res = res - TC::ReachesFfiUnsafe; }
2515                                         _ => { }
2516                                     }
2517                                 }
2518                             }
2519                         }
2520                     }
2521                 }
2522
2523
2524                 apply_lang_items(cx, did, res)
2525             }
2526
2527             ty_param(p) => {
2528                 // We only ever ask for the kind of types that are defined in
2529                 // the current crate; therefore, the only type parameters that
2530                 // could be in scope are those defined in the current crate.
2531                 // If this assertion failures, it is likely because of a
2532                 // failure in the cross-crate inlining code to translate a
2533                 // def-id.
2534                 assert_eq!(p.def_id.krate, ast::LOCAL_CRATE);
2535
2536                 let ty_param_defs = cx.ty_param_defs.borrow();
2537                 let tp_def = ty_param_defs.get(&p.def_id.node);
2538                 kind_bounds_to_contents(
2539                     cx,
2540                     tp_def.bounds.builtin_bounds,
2541                     tp_def.bounds.trait_bounds.as_slice())
2542             }
2543
2544             ty_infer(_) => {
2545                 // This occurs during coherence, but shouldn't occur at other
2546                 // times.
2547                 TC::All
2548             }
2549
2550             ty_open(t) => {
2551                 let result = tc_ty(cx, t, cache);
2552                 assert!(!result.is_sized(cx))
2553                 result.unsafe_pointer() | TC::Nonsized
2554             }
2555
2556             ty_err => {
2557                 cx.sess.bug("asked to compute contents of error type");
2558             }
2559         };
2560
2561         cache.insert(ty_id, result);
2562         return result;
2563     }
2564
2565     fn tc_mt(cx: &ctxt,
2566              mt: mt,
2567              cache: &mut HashMap<uint, TypeContents>) -> TypeContents
2568     {
2569         let mc = TC::ReachesMutable.when(mt.mutbl == MutMutable);
2570         mc | tc_ty(cx, mt.ty, cache)
2571     }
2572
2573     fn apply_lang_items(cx: &ctxt,
2574                         did: ast::DefId,
2575                         tc: TypeContents)
2576                         -> TypeContents {
2577         if Some(did) == cx.lang_items.no_send_bound() {
2578             tc | TC::ReachesNonsendAnnot
2579         } else if Some(did) == cx.lang_items.managed_bound() {
2580             tc | TC::Managed
2581         } else if Some(did) == cx.lang_items.no_copy_bound() {
2582             tc | TC::OwnsAffine
2583         } else if Some(did) == cx.lang_items.no_sync_bound() {
2584             tc | TC::ReachesNoSync
2585         } else if Some(did) == cx.lang_items.unsafe_type() {
2586             // FIXME(#13231): This shouldn't be needed after
2587             // opt-in built-in bounds are implemented.
2588             (tc | TC::InteriorUnsafe) - TC::Nonsync
2589         } else {
2590             tc
2591         }
2592     }
2593
2594     fn borrowed_contents(region: ty::Region,
2595                          mutbl: ast::Mutability)
2596                          -> TypeContents {
2597         /*!
2598          * Type contents due to containing a reference
2599          * with the region `region` and borrow kind `bk`
2600          */
2601
2602         let b = match mutbl {
2603             ast::MutMutable => TC::ReachesMutable | TC::OwnsAffine,
2604             ast::MutImmutable => TC::None,
2605         };
2606         b | (TC::ReachesBorrowed).when(region != ty::ReStatic)
2607     }
2608
2609     fn closure_contents(cx: &ctxt, cty: &ClosureTy) -> TypeContents {
2610         // Closure contents are just like trait contents, but with potentially
2611         // even more stuff.
2612         let st = object_contents(cx, cty.bounds);
2613
2614         let st = match cty.store {
2615             UniqTraitStore => {
2616                 st.owned_pointer()
2617             }
2618             RegionTraitStore(r, mutbl) => {
2619                 st.reference(borrowed_contents(r, mutbl))
2620             }
2621         };
2622
2623         // This also prohibits "@once fn" from being copied, which allows it to
2624         // be called. Neither way really makes much sense.
2625         let ot = match cty.onceness {
2626             ast::Once => TC::OwnsAffine,
2627             ast::Many => TC::None,
2628         };
2629
2630         st | ot
2631     }
2632
2633     fn object_contents(cx: &ctxt,
2634                        bounds: ExistentialBounds)
2635                        -> TypeContents {
2636         // These are the type contents of the (opaque) interior
2637         kind_bounds_to_contents(cx, bounds.builtin_bounds, [])
2638     }
2639
2640     fn kind_bounds_to_contents(cx: &ctxt,
2641                                bounds: BuiltinBounds,
2642                                traits: &[Rc<TraitRef>])
2643                                -> TypeContents {
2644         let _i = indenter();
2645         let mut tc = TC::All;
2646         each_inherited_builtin_bound(cx, bounds, traits, |bound| {
2647             tc = tc - match bound {
2648                 BoundSend => TC::Nonsendable,
2649                 BoundSized => TC::Nonsized,
2650                 BoundCopy => TC::Noncopy,
2651                 BoundSync => TC::Nonsync,
2652             };
2653         });
2654         return tc;
2655
2656         // Iterates over all builtin bounds on the type parameter def, including
2657         // those inherited from traits with builtin-kind-supertraits.
2658         fn each_inherited_builtin_bound(cx: &ctxt,
2659                                         bounds: BuiltinBounds,
2660                                         traits: &[Rc<TraitRef>],
2661                                         f: |BuiltinBound|) {
2662             for bound in bounds.iter() {
2663                 f(bound);
2664             }
2665
2666             each_bound_trait_and_supertraits(cx, traits, |trait_ref| {
2667                 let trait_def = lookup_trait_def(cx, trait_ref.def_id);
2668                 for bound in trait_def.bounds.builtin_bounds.iter() {
2669                     f(bound);
2670                 }
2671                 true
2672             });
2673         }
2674     }
2675 }
2676
2677 pub fn type_moves_by_default(cx: &ctxt, ty: t) -> bool {
2678     type_contents(cx, ty).moves_by_default(cx)
2679 }
2680
2681 pub fn is_ffi_safe(cx: &ctxt, ty: t) -> bool {
2682     !type_contents(cx, ty).intersects(TC::ReachesFfiUnsafe)
2683 }
2684
2685 // True if instantiating an instance of `r_ty` requires an instance of `r_ty`.
2686 pub fn is_instantiable(cx: &ctxt, r_ty: t) -> bool {
2687     fn type_requires(cx: &ctxt, seen: &mut Vec<DefId>,
2688                      r_ty: t, ty: t) -> bool {
2689         debug!("type_requires({}, {})?",
2690                ::util::ppaux::ty_to_string(cx, r_ty),
2691                ::util::ppaux::ty_to_string(cx, ty));
2692
2693         let r = {
2694             get(r_ty).sty == get(ty).sty ||
2695                 subtypes_require(cx, seen, r_ty, ty)
2696         };
2697
2698         debug!("type_requires({}, {})? {}",
2699                ::util::ppaux::ty_to_string(cx, r_ty),
2700                ::util::ppaux::ty_to_string(cx, ty),
2701                r);
2702         return r;
2703     }
2704
2705     fn subtypes_require(cx: &ctxt, seen: &mut Vec<DefId>,
2706                         r_ty: t, ty: t) -> bool {
2707         debug!("subtypes_require({}, {})?",
2708                ::util::ppaux::ty_to_string(cx, r_ty),
2709                ::util::ppaux::ty_to_string(cx, ty));
2710
2711         let r = match get(ty).sty {
2712             // fixed length vectors need special treatment compared to
2713             // normal vectors, since they don't necessarily have the
2714             // possibility to have length zero.
2715             ty_vec(_, Some(0)) => false, // don't need no contents
2716             ty_vec(ty, Some(_)) => type_requires(cx, seen, r_ty, ty),
2717
2718             ty_nil |
2719             ty_bot |
2720             ty_bool |
2721             ty_char |
2722             ty_int(_) |
2723             ty_uint(_) |
2724             ty_float(_) |
2725             ty_str |
2726             ty_bare_fn(_) |
2727             ty_closure(_) |
2728             ty_infer(_) |
2729             ty_err |
2730             ty_param(_) |
2731             ty_vec(_, None) => {
2732                 false
2733             }
2734             ty_box(typ) | ty_uniq(typ) | ty_open(typ) => {
2735                 type_requires(cx, seen, r_ty, typ)
2736             }
2737             ty_rptr(_, ref mt) => {
2738                 type_requires(cx, seen, r_ty, mt.ty)
2739             }
2740
2741             ty_ptr(..) => {
2742                 false           // unsafe ptrs can always be NULL
2743             }
2744
2745             ty_trait(..) => {
2746                 false
2747             }
2748
2749             ty_struct(ref did, _) if seen.contains(did) => {
2750                 false
2751             }
2752
2753             ty_struct(did, ref substs) => {
2754                 seen.push(did);
2755                 let fields = struct_fields(cx, did, substs);
2756                 let r = fields.iter().any(|f| type_requires(cx, seen, r_ty, f.mt.ty));
2757                 seen.pop().unwrap();
2758                 r
2759             }
2760
2761             ty_unboxed_closure(did, _) => {
2762                 let upvars = unboxed_closure_upvars(cx, did);
2763                 upvars.iter().any(|f| type_requires(cx, seen, r_ty, f.ty))
2764             }
2765
2766             ty_tup(ref ts) => {
2767                 ts.iter().any(|t| type_requires(cx, seen, r_ty, *t))
2768             }
2769
2770             ty_enum(ref did, _) if seen.contains(did) => {
2771                 false
2772             }
2773
2774             ty_enum(did, ref substs) => {
2775                 seen.push(did);
2776                 let vs = enum_variants(cx, did);
2777                 let r = !vs.is_empty() && vs.iter().all(|variant| {
2778                     variant.args.iter().any(|aty| {
2779                         let sty = aty.subst(cx, substs);
2780                         type_requires(cx, seen, r_ty, sty)
2781                     })
2782                 });
2783                 seen.pop().unwrap();
2784                 r
2785             }
2786         };
2787
2788         debug!("subtypes_require({}, {})? {}",
2789                ::util::ppaux::ty_to_string(cx, r_ty),
2790                ::util::ppaux::ty_to_string(cx, ty),
2791                r);
2792
2793         return r;
2794     }
2795
2796     let mut seen = Vec::new();
2797     !subtypes_require(cx, &mut seen, r_ty, r_ty)
2798 }
2799
2800 /// Describes whether a type is representable. For types that are not
2801 /// representable, 'SelfRecursive' and 'ContainsRecursive' are used to
2802 /// distinguish between types that are recursive with themselves and types that
2803 /// contain a different recursive type. These cases can therefore be treated
2804 /// differently when reporting errors.
2805 #[deriving(PartialEq)]
2806 pub enum Representability {
2807     Representable,
2808     SelfRecursive,
2809     ContainsRecursive,
2810 }
2811
2812 /// Check whether a type is representable. This means it cannot contain unboxed
2813 /// structural recursion. This check is needed for structs and enums.
2814 pub fn is_type_representable(cx: &ctxt, sp: Span, ty: t) -> Representability {
2815
2816     // Iterate until something non-representable is found
2817     fn find_nonrepresentable<It: Iterator<t>>(cx: &ctxt, sp: Span, seen: &mut Vec<DefId>,
2818                                               mut iter: It) -> Representability {
2819         for ty in iter {
2820             let r = type_structurally_recursive(cx, sp, seen, ty);
2821             if r != Representable {
2822                  return r
2823             }
2824         }
2825         Representable
2826     }
2827
2828     // Does the type `ty` directly (without indirection through a pointer)
2829     // contain any types on stack `seen`?
2830     fn type_structurally_recursive(cx: &ctxt, sp: Span, seen: &mut Vec<DefId>,
2831                                    ty: t) -> Representability {
2832         debug!("type_structurally_recursive: {}",
2833                ::util::ppaux::ty_to_string(cx, ty));
2834
2835         // Compare current type to previously seen types
2836         match get(ty).sty {
2837             ty_struct(did, _) |
2838             ty_enum(did, _) => {
2839                 for (i, &seen_did) in seen.iter().enumerate() {
2840                     if did == seen_did {
2841                         return if i == 0 { SelfRecursive }
2842                                else { ContainsRecursive }
2843                     }
2844                 }
2845             }
2846             _ => (),
2847         }
2848
2849         // Check inner types
2850         match get(ty).sty {
2851             // Tuples
2852             ty_tup(ref ts) => {
2853                 find_nonrepresentable(cx, sp, seen, ts.iter().map(|t| *t))
2854             }
2855             // Fixed-length vectors.
2856             // FIXME(#11924) Behavior undecided for zero-length vectors.
2857             ty_vec(ty, Some(_)) => {
2858                 type_structurally_recursive(cx, sp, seen, ty)
2859             }
2860
2861             // Push struct and enum def-ids onto `seen` before recursing.
2862             ty_struct(did, ref substs) => {
2863                 seen.push(did);
2864                 let fields = struct_fields(cx, did, substs);
2865                 let r = find_nonrepresentable(cx, sp, seen,
2866                                               fields.iter().map(|f| f.mt.ty));
2867                 seen.pop();
2868                 r
2869             }
2870
2871             ty_enum(did, ref substs) => {
2872                 seen.push(did);
2873                 let vs = enum_variants(cx, did);
2874
2875                 let mut r = Representable;
2876                 for variant in vs.iter() {
2877                     let iter = variant.args.iter().map(|aty| {
2878                         aty.subst_spanned(cx, substs, Some(sp))
2879                     });
2880                     r = find_nonrepresentable(cx, sp, seen, iter);
2881
2882                     if r != Representable { break }
2883                 }
2884
2885                 seen.pop();
2886                 r
2887             }
2888
2889             ty_unboxed_closure(did, _) => {
2890                 let upvars = unboxed_closure_upvars(cx, did);
2891                 find_nonrepresentable(cx,
2892                                       sp,
2893                                       seen,
2894                                       upvars.iter().map(|f| f.ty))
2895             }
2896
2897             _ => Representable,
2898         }
2899     }
2900
2901     debug!("is_type_representable: {}",
2902            ::util::ppaux::ty_to_string(cx, ty));
2903
2904     // To avoid a stack overflow when checking an enum variant or struct that
2905     // contains a different, structurally recursive type, maintain a stack
2906     // of seen types and check recursion for each of them (issues #3008, #3779).
2907     let mut seen: Vec<DefId> = Vec::new();
2908     type_structurally_recursive(cx, sp, &mut seen, ty)
2909 }
2910
2911 pub fn type_is_trait(ty: t) -> bool {
2912     match get(ty).sty {
2913         ty_uniq(ty) | ty_rptr(_, mt { ty, ..}) | ty_ptr(mt { ty, ..}) => match get(ty).sty {
2914             ty_trait(..) => true,
2915             _ => false
2916         },
2917         ty_trait(..) => true,
2918         _ => false
2919     }
2920 }
2921
2922 pub fn type_is_integral(ty: t) -> bool {
2923     match get(ty).sty {
2924       ty_infer(IntVar(_)) | ty_int(_) | ty_uint(_) => true,
2925       _ => false
2926     }
2927 }
2928
2929 pub fn type_is_uint(ty: t) -> bool {
2930     match get(ty).sty {
2931       ty_infer(IntVar(_)) | ty_uint(ast::TyU) => true,
2932       _ => false
2933     }
2934 }
2935
2936 pub fn type_is_char(ty: t) -> bool {
2937     match get(ty).sty {
2938         ty_char => true,
2939         _ => false
2940     }
2941 }
2942
2943 pub fn type_is_bare_fn(ty: t) -> bool {
2944     match get(ty).sty {
2945         ty_bare_fn(..) => true,
2946         _ => false
2947     }
2948 }
2949
2950 pub fn type_is_fp(ty: t) -> bool {
2951     match get(ty).sty {
2952       ty_infer(FloatVar(_)) | ty_float(_) => true,
2953       _ => false
2954     }
2955 }
2956
2957 pub fn type_is_numeric(ty: t) -> bool {
2958     return type_is_integral(ty) || type_is_fp(ty);
2959 }
2960
2961 pub fn type_is_signed(ty: t) -> bool {
2962     match get(ty).sty {
2963       ty_int(_) => true,
2964       _ => false
2965     }
2966 }
2967
2968 pub fn type_is_machine(ty: t) -> bool {
2969     match get(ty).sty {
2970         ty_int(ast::TyI) | ty_uint(ast::TyU) => false,
2971         ty_int(..) | ty_uint(..) | ty_float(..) => true,
2972         _ => false
2973     }
2974 }
2975
2976 // Is the type's representation size known at compile time?
2977 pub fn type_is_sized(cx: &ctxt, ty: t) -> bool {
2978     type_contents(cx, ty).is_sized(cx)
2979 }
2980
2981 pub fn lltype_is_sized(cx: &ctxt, ty: t) -> bool {
2982     match get(ty).sty {
2983         ty_open(_) => true,
2984         _ => type_contents(cx, ty).is_sized(cx)
2985     }
2986 }
2987
2988 // Return the smallest part of t which is unsized. Fails if t is sized.
2989 // 'Smallest' here means component of the static representation of the type; not
2990 // the size of an object at runtime.
2991 pub fn unsized_part_of_type(cx: &ctxt, ty: t) -> t {
2992     match get(ty).sty {
2993         ty_str | ty_trait(..) | ty_vec(..) => ty,
2994         ty_struct(_, ref substs) => {
2995             // Exactly one of the type parameters must be unsized.
2996             for tp in substs.types.get_slice(subst::TypeSpace).iter() {
2997                 if !type_is_sized(cx, *tp) {
2998                     return unsized_part_of_type(cx, *tp);
2999                 }
3000             }
3001             fail!("Unsized struct type with no unsized type params? {}", ty_to_string(cx, ty));
3002         }
3003         _ => {
3004             assert!(type_is_sized(cx, ty),
3005                     "unsized_part_of_type failed even though ty is unsized");
3006             fail!("called unsized_part_of_type with sized ty");
3007         }
3008     }
3009 }
3010
3011 // Whether a type is enum like, that is an enum type with only nullary
3012 // constructors
3013 pub fn type_is_c_like_enum(cx: &ctxt, ty: t) -> bool {
3014     match get(ty).sty {
3015         ty_enum(did, _) => {
3016             let variants = enum_variants(cx, did);
3017             if variants.len() == 0 {
3018                 false
3019             } else {
3020                 variants.iter().all(|v| v.args.len() == 0)
3021             }
3022         }
3023         _ => false
3024     }
3025 }
3026
3027 // Returns the type and mutability of *t.
3028 //
3029 // The parameter `explicit` indicates if this is an *explicit* dereference.
3030 // Some types---notably unsafe ptrs---can only be dereferenced explicitly.
3031 pub fn deref(t: t, explicit: bool) -> Option<mt> {
3032     match get(t).sty {
3033         ty_box(ty) | ty_uniq(ty) => {
3034             Some(mt {
3035                 ty: ty,
3036                 mutbl: ast::MutImmutable,
3037             })
3038         },
3039         ty_rptr(_, mt) => Some(mt),
3040         ty_ptr(mt) if explicit => Some(mt),
3041         _ => None
3042     }
3043 }
3044
3045 pub fn deref_or_dont(t: t) -> t {
3046     match get(t).sty {
3047         ty_box(ty) | ty_uniq(ty) => {
3048             ty
3049         },
3050         ty_rptr(_, mt) | ty_ptr(mt) => mt.ty,
3051         _ => t
3052     }
3053 }
3054
3055 pub fn close_type(cx: &ctxt, t: t) -> t {
3056     match get(t).sty {
3057         ty_open(t) => mk_rptr(cx, ReStatic, mt {ty: t, mutbl:ast::MutImmutable}),
3058         _ => cx.sess.bug(format!("Trying to close a non-open type {}",
3059                                  ty_to_string(cx, t)).as_slice())
3060     }
3061 }
3062
3063 pub fn type_content(t: t) -> t {
3064     match get(t).sty {
3065         ty_box(ty) | ty_uniq(ty) => ty,
3066         ty_rptr(_, mt) |ty_ptr(mt) => mt.ty,
3067         _ => t
3068     }
3069
3070 }
3071
3072 // Extract the unsized type in an open type (or just return t if it is not open).
3073 pub fn unopen_type(t: t) -> t {
3074     match get(t).sty {
3075         ty_open(t) => t,
3076         _ => t
3077     }
3078 }
3079
3080 // Returns the type of t[i]
3081 pub fn index(ty: t) -> Option<t> {
3082     match get(ty).sty {
3083         ty_vec(t, _) => Some(t),
3084         _ => None
3085     }
3086 }
3087
3088 // Returns the type of elements contained within an 'array-like' type.
3089 // This is exactly the same as the above, except it supports strings,
3090 // which can't actually be indexed.
3091 pub fn array_element_ty(t: t) -> Option<t> {
3092     match get(t).sty {
3093         ty_vec(t, _) => Some(t),
3094         ty_str => Some(mk_u8()),
3095         _ => None
3096     }
3097 }
3098
3099 pub fn node_id_to_trait_ref(cx: &ctxt, id: ast::NodeId) -> Rc<ty::TraitRef> {
3100     match cx.trait_refs.borrow().find(&id) {
3101         Some(t) => t.clone(),
3102         None => cx.sess.bug(
3103             format!("node_id_to_trait_ref: no trait ref for node `{}`",
3104                     cx.map.node_to_string(id)).as_slice())
3105     }
3106 }
3107
3108 pub fn try_node_id_to_type(cx: &ctxt, id: ast::NodeId) -> Option<t> {
3109     cx.node_types.borrow().find_copy(&(id as uint))
3110 }
3111
3112 pub fn node_id_to_type(cx: &ctxt, id: ast::NodeId) -> t {
3113     match try_node_id_to_type(cx, id) {
3114        Some(t) => t,
3115        None => cx.sess.bug(
3116            format!("node_id_to_type: no type for node `{}`",
3117                    cx.map.node_to_string(id)).as_slice())
3118     }
3119 }
3120
3121 pub fn node_id_to_type_opt(cx: &ctxt, id: ast::NodeId) -> Option<t> {
3122     match cx.node_types.borrow().find(&(id as uint)) {
3123        Some(&t) => Some(t),
3124        None => None
3125     }
3126 }
3127
3128 pub fn node_id_item_substs(cx: &ctxt, id: ast::NodeId) -> ItemSubsts {
3129     match cx.item_substs.borrow().find(&id) {
3130       None => ItemSubsts::empty(),
3131       Some(ts) => ts.clone(),
3132     }
3133 }
3134
3135 pub fn fn_is_variadic(fty: t) -> bool {
3136     match get(fty).sty {
3137         ty_bare_fn(ref f) => f.sig.variadic,
3138         ty_closure(ref f) => f.sig.variadic,
3139         ref s => {
3140             fail!("fn_is_variadic() called on non-fn type: {:?}", s)
3141         }
3142     }
3143 }
3144
3145 pub fn ty_fn_sig(fty: t) -> FnSig {
3146     match get(fty).sty {
3147         ty_bare_fn(ref f) => f.sig.clone(),
3148         ty_closure(ref f) => f.sig.clone(),
3149         ref s => {
3150             fail!("ty_fn_sig() called on non-fn type: {:?}", s)
3151         }
3152     }
3153 }
3154
3155 /// Returns the ABI of the given function.
3156 pub fn ty_fn_abi(fty: t) -> abi::Abi {
3157     match get(fty).sty {
3158         ty_bare_fn(ref f) => f.abi,
3159         ty_closure(ref f) => f.abi,
3160         _ => fail!("ty_fn_abi() called on non-fn type"),
3161     }
3162 }
3163
3164 // Type accessors for substructures of types
3165 pub fn ty_fn_args(fty: t) -> Vec<t> {
3166     match get(fty).sty {
3167         ty_bare_fn(ref f) => f.sig.inputs.clone(),
3168         ty_closure(ref f) => f.sig.inputs.clone(),
3169         ref s => {
3170             fail!("ty_fn_args() called on non-fn type: {:?}", s)
3171         }
3172     }
3173 }
3174
3175 pub fn ty_closure_store(fty: t) -> TraitStore {
3176     match get(fty).sty {
3177         ty_closure(ref f) => f.store,
3178         ty_unboxed_closure(..) => {
3179             // Close enough for the purposes of all the callers of this
3180             // function (which is soon to be deprecated anyhow).
3181             UniqTraitStore
3182         }
3183         ref s => {
3184             fail!("ty_closure_store() called on non-closure type: {:?}", s)
3185         }
3186     }
3187 }
3188
3189 pub fn ty_fn_ret(fty: t) -> t {
3190     match get(fty).sty {
3191         ty_bare_fn(ref f) => f.sig.output,
3192         ty_closure(ref f) => f.sig.output,
3193         ref s => {
3194             fail!("ty_fn_ret() called on non-fn type: {:?}", s)
3195         }
3196     }
3197 }
3198
3199 pub fn is_fn_ty(fty: t) -> bool {
3200     match get(fty).sty {
3201         ty_bare_fn(_) => true,
3202         ty_closure(_) => true,
3203         _ => false
3204     }
3205 }
3206
3207 pub fn ty_region(tcx: &ctxt,
3208                  span: Span,
3209                  ty: t) -> Region {
3210     match get(ty).sty {
3211         ty_rptr(r, _) => r,
3212         ref s => {
3213             tcx.sess.span_bug(
3214                 span,
3215                 format!("ty_region() invoked on in appropriate ty: {:?}",
3216                         s).as_slice());
3217         }
3218     }
3219 }
3220
3221 pub fn free_region_from_def(free_id: ast::NodeId, def: &RegionParameterDef)
3222     -> ty::Region
3223 {
3224     ty::ReFree(ty::FreeRegion { scope_id: free_id,
3225                                 bound_region: ty::BrNamed(def.def_id,
3226                                                           def.name) })
3227 }
3228
3229 // Returns the type of a pattern as a monotype. Like @expr_ty, this function
3230 // doesn't provide type parameter substitutions.
3231 pub fn pat_ty(cx: &ctxt, pat: &ast::Pat) -> t {
3232     return node_id_to_type(cx, pat.id);
3233 }
3234
3235
3236 // Returns the type of an expression as a monotype.
3237 //
3238 // NB (1): This is the PRE-ADJUSTMENT TYPE for the expression.  That is, in
3239 // some cases, we insert `AutoAdjustment` annotations such as auto-deref or
3240 // auto-ref.  The type returned by this function does not consider such
3241 // adjustments.  See `expr_ty_adjusted()` instead.
3242 //
3243 // NB (2): This type doesn't provide type parameter substitutions; e.g. if you
3244 // ask for the type of "id" in "id(3)", it will return "fn(&int) -> int"
3245 // instead of "fn(t) -> T with T = int".
3246 pub fn expr_ty(cx: &ctxt, expr: &ast::Expr) -> t {
3247     return node_id_to_type(cx, expr.id);
3248 }
3249
3250 pub fn expr_ty_opt(cx: &ctxt, expr: &ast::Expr) -> Option<t> {
3251     return node_id_to_type_opt(cx, expr.id);
3252 }
3253
3254 pub fn expr_ty_adjusted(cx: &ctxt, expr: &ast::Expr) -> t {
3255     /*!
3256      *
3257      * Returns the type of `expr`, considering any `AutoAdjustment`
3258      * entry recorded for that expression.
3259      *
3260      * It would almost certainly be better to store the adjusted ty in with
3261      * the `AutoAdjustment`, but I opted not to do this because it would
3262      * require serializing and deserializing the type and, although that's not
3263      * hard to do, I just hate that code so much I didn't want to touch it
3264      * unless it was to fix it properly, which seemed a distraction from the
3265      * task at hand! -nmatsakis
3266      */
3267
3268     adjust_ty(cx, expr.span, expr.id, expr_ty(cx, expr),
3269               cx.adjustments.borrow().find(&expr.id),
3270               |method_call| cx.method_map.borrow().find(&method_call).map(|method| method.ty))
3271 }
3272
3273 pub fn expr_span(cx: &ctxt, id: NodeId) -> Span {
3274     match cx.map.find(id) {
3275         Some(ast_map::NodeExpr(e)) => {
3276             e.span
3277         }
3278         Some(f) => {
3279             cx.sess.bug(format!("Node id {} is not an expr: {:?}",
3280                                 id,
3281                                 f).as_slice());
3282         }
3283         None => {
3284             cx.sess.bug(format!("Node id {} is not present \
3285                                 in the node map", id).as_slice());
3286         }
3287     }
3288 }
3289
3290 pub fn local_var_name_str(cx: &ctxt, id: NodeId) -> InternedString {
3291     match cx.map.find(id) {
3292         Some(ast_map::NodeLocal(pat)) => {
3293             match pat.node {
3294                 ast::PatIdent(_, ref path1, _) => {
3295                     token::get_ident(path1.node)
3296                 }
3297                 _ => {
3298                     cx.sess.bug(
3299                         format!("Variable id {} maps to {:?}, not local",
3300                                 id,
3301                                 pat).as_slice());
3302                 }
3303             }
3304         }
3305         r => {
3306             cx.sess.bug(format!("Variable id {} maps to {:?}, not local",
3307                                 id,
3308                                 r).as_slice());
3309         }
3310     }
3311 }
3312
3313 pub fn adjust_ty(cx: &ctxt,
3314                  span: Span,
3315                  expr_id: ast::NodeId,
3316                  unadjusted_ty: ty::t,
3317                  adjustment: Option<&AutoAdjustment>,
3318                  method_type: |typeck::MethodCall| -> Option<ty::t>)
3319                  -> ty::t {
3320     /*! See `expr_ty_adjusted` */
3321
3322     match get(unadjusted_ty).sty {
3323         ty_err => return unadjusted_ty,
3324         _ => {}
3325     }
3326
3327     return match adjustment {
3328         Some(adjustment) => {
3329             match *adjustment {
3330                 AutoAddEnv(store) => {
3331                     match ty::get(unadjusted_ty).sty {
3332                         ty::ty_bare_fn(ref b) => {
3333                             let bounds = ty::ExistentialBounds {
3334                                 region_bound: ReStatic,
3335                                 builtin_bounds: all_builtin_bounds(),
3336                             };
3337
3338                             ty::mk_closure(
3339                                 cx,
3340                                 ty::ClosureTy {fn_style: b.fn_style,
3341                                                onceness: ast::Many,
3342                                                store: store,
3343                                                bounds: bounds,
3344                                                sig: b.sig.clone(),
3345                                                abi: b.abi})
3346                         }
3347                         ref b => {
3348                             cx.sess.bug(
3349                                 format!("add_env adjustment on non-bare-fn: \
3350                                          {:?}",
3351                                         b).as_slice());
3352                         }
3353                     }
3354                 }
3355
3356                 AutoDerefRef(ref adj) => {
3357                     let mut adjusted_ty = unadjusted_ty;
3358
3359                     if !ty::type_is_error(adjusted_ty) {
3360                         for i in range(0, adj.autoderefs) {
3361                             let method_call = typeck::MethodCall::autoderef(expr_id, i);
3362                             match method_type(method_call) {
3363                                 Some(method_ty) => {
3364                                     adjusted_ty = ty_fn_ret(method_ty);
3365                                 }
3366                                 None => {}
3367                             }
3368                             match deref(adjusted_ty, true) {
3369                                 Some(mt) => { adjusted_ty = mt.ty; }
3370                                 None => {
3371                                     cx.sess.span_bug(
3372                                         span,
3373                                         format!("the {}th autoderef failed: \
3374                                                 {}",
3375                                                 i,
3376                                                 ty_to_string(cx, adjusted_ty))
3377                                                           .as_slice());
3378                                 }
3379                             }
3380                         }
3381                     }
3382
3383                     match adj.autoref {
3384                         None => adjusted_ty,
3385                         Some(ref autoref) => adjust_for_autoref(cx, span, adjusted_ty, autoref)
3386                     }
3387                 }
3388             }
3389         }
3390         None => unadjusted_ty
3391     };
3392
3393     fn adjust_for_autoref(cx: &ctxt,
3394                           span: Span,
3395                           ty: ty::t,
3396                           autoref: &AutoRef) -> ty::t{
3397         match *autoref {
3398             AutoPtr(r, m, ref a) => {
3399                 let adjusted_ty = match a {
3400                     &Some(box ref a) => adjust_for_autoref(cx, span, ty, a),
3401                     &None => ty
3402                 };
3403                 mk_rptr(cx, r, mt {
3404                     ty: adjusted_ty,
3405                     mutbl: m
3406                 })
3407             }
3408
3409             AutoUnsafe(m, ref a) => {
3410                 let adjusted_ty = match a {
3411                     &Some(box ref a) => adjust_for_autoref(cx, span, ty, a),
3412                     &None => ty
3413                 };
3414                 mk_ptr(cx, mt {ty: adjusted_ty, mutbl: m})
3415             }
3416
3417             AutoUnsize(ref k) => unsize_ty(cx, ty, k, span),
3418             AutoUnsizeUniq(ref k) => ty::mk_uniq(cx, unsize_ty(cx, ty, k, span)),
3419         }
3420     }
3421 }
3422
3423 // Take a sized type and a sizing adjustment and produce an unsized version of
3424 // the type.
3425 pub fn unsize_ty(cx: &ctxt,
3426                  ty: ty::t,
3427                  kind: &UnsizeKind,
3428                  span: Span)
3429                  -> ty::t {
3430     match kind {
3431         &UnsizeLength(len) => match get(ty).sty {
3432             ty_vec(t, Some(n)) => {
3433                 assert!(len == n);
3434                 mk_vec(cx, t, None)
3435             }
3436             _ => cx.sess.span_bug(span,
3437                                   format!("UnsizeLength with bad sty: {}",
3438                                           ty_to_string(cx, ty)).as_slice())
3439         },
3440         &UnsizeStruct(box ref k, tp_index) => match get(ty).sty {
3441             ty_struct(did, ref substs) => {
3442                 let ty_substs = substs.types.get_slice(subst::TypeSpace);
3443                 let new_ty = unsize_ty(cx, ty_substs[tp_index], k, span);
3444                 let mut unsized_substs = substs.clone();
3445                 unsized_substs.types.get_mut_slice(subst::TypeSpace)[tp_index] = new_ty;
3446                 mk_struct(cx, did, unsized_substs)
3447             }
3448             _ => cx.sess.span_bug(span,
3449                                   format!("UnsizeStruct with bad sty: {}",
3450                                           ty_to_string(cx, ty)).as_slice())
3451         },
3452         &UnsizeVtable(bounds, def_id, ref substs) => {
3453             mk_trait(cx, def_id, substs.clone(), bounds)
3454         }
3455     }
3456 }
3457
3458 impl AutoRef {
3459     pub fn map_region(&self, f: |Region| -> Region) -> AutoRef {
3460         match *self {
3461             ty::AutoPtr(r, m, None) => ty::AutoPtr(f(r), m, None),
3462             ty::AutoPtr(r, m, Some(ref a)) => ty::AutoPtr(f(r), m, Some(box a.map_region(f))),
3463             ty::AutoUnsize(ref k) => ty::AutoUnsize(k.clone()),
3464             ty::AutoUnsizeUniq(ref k) => ty::AutoUnsizeUniq(k.clone()),
3465             ty::AutoUnsafe(m, None) => ty::AutoUnsafe(m, None),
3466             ty::AutoUnsafe(m, Some(ref a)) => ty::AutoUnsafe(m, Some(box a.map_region(f))),
3467         }
3468     }
3469 }
3470
3471 pub fn method_call_type_param_defs<'tcx, T>(typer: &T,
3472                                             origin: typeck::MethodOrigin)
3473                                             -> VecPerParamSpace<TypeParameterDef>
3474                                             where T: mc::Typer<'tcx> {
3475     match origin {
3476         typeck::MethodStatic(did) => {
3477             ty::lookup_item_type(typer.tcx(), did).generics.types.clone()
3478         }
3479         typeck::MethodStaticUnboxedClosure(did) => {
3480             let def_id = typer.unboxed_closures()
3481                               .borrow()
3482                               .find(&did)
3483                               .expect("method_call_type_param_defs: didn't \
3484                                        find unboxed closure")
3485                               .kind
3486                               .trait_did(typer.tcx());
3487             lookup_trait_def(typer.tcx(), def_id).generics.types.clone()
3488         }
3489         typeck::MethodParam(typeck::MethodParam{
3490             trait_id: trt_id,
3491             method_num: n_mth,
3492             ..
3493         }) |
3494         typeck::MethodObject(typeck::MethodObject{
3495                 trait_id: trt_id,
3496                 method_num: n_mth,
3497                 ..
3498         }) => {
3499             match ty::trait_item(typer.tcx(), trt_id, n_mth) {
3500                 ty::MethodTraitItem(method) => method.generics.types.clone(),
3501             }
3502         }
3503     }
3504 }
3505
3506 pub fn resolve_expr(tcx: &ctxt, expr: &ast::Expr) -> def::Def {
3507     match tcx.def_map.borrow().find(&expr.id) {
3508         Some(&def) => def,
3509         None => {
3510             tcx.sess.span_bug(expr.span, format!(
3511                 "no def-map entry for expr {:?}", expr.id).as_slice());
3512         }
3513     }
3514 }
3515
3516 pub fn expr_is_lval(tcx: &ctxt, e: &ast::Expr) -> bool {
3517     match expr_kind(tcx, e) {
3518         LvalueExpr => true,
3519         RvalueDpsExpr | RvalueDatumExpr | RvalueStmtExpr => false
3520     }
3521 }
3522
3523 /// We categorize expressions into three kinds.  The distinction between
3524 /// lvalue/rvalue is fundamental to the language.  The distinction between the
3525 /// two kinds of rvalues is an artifact of trans which reflects how we will
3526 /// generate code for that kind of expression.  See trans/expr.rs for more
3527 /// information.
3528 pub enum ExprKind {
3529     LvalueExpr,
3530     RvalueDpsExpr,
3531     RvalueDatumExpr,
3532     RvalueStmtExpr
3533 }
3534
3535 pub fn expr_kind(tcx: &ctxt, expr: &ast::Expr) -> ExprKind {
3536     if tcx.method_map.borrow().contains_key(&typeck::MethodCall::expr(expr.id)) {
3537         // Overloaded operations are generally calls, and hence they are
3538         // generated via DPS, but there are a few exceptions:
3539         return match expr.node {
3540             // `a += b` has a unit result.
3541             ast::ExprAssignOp(..) => RvalueStmtExpr,
3542
3543             // the deref method invoked for `*a` always yields an `&T`
3544             ast::ExprUnary(ast::UnDeref, _) => LvalueExpr,
3545
3546             // the index method invoked for `a[i]` always yields an `&T`
3547             ast::ExprIndex(..) => LvalueExpr,
3548
3549             // `for` loops are statements
3550             ast::ExprForLoop(..) => RvalueStmtExpr,
3551
3552             // in the general case, result could be any type, use DPS
3553             _ => RvalueDpsExpr
3554         };
3555     }
3556
3557     match expr.node {
3558         ast::ExprPath(..) => {
3559             match resolve_expr(tcx, expr) {
3560                 def::DefVariant(tid, vid, _) => {
3561                     let variant_info = enum_variant_with_id(tcx, tid, vid);
3562                     if variant_info.args.len() > 0u {
3563                         // N-ary variant.
3564                         RvalueDatumExpr
3565                     } else {
3566                         // Nullary variant.
3567                         RvalueDpsExpr
3568                     }
3569                 }
3570
3571                 def::DefStruct(_) => {
3572                     match get(expr_ty(tcx, expr)).sty {
3573                         ty_bare_fn(..) => RvalueDatumExpr,
3574                         _ => RvalueDpsExpr
3575                     }
3576                 }
3577
3578                 // Fn pointers are just scalar values.
3579                 def::DefFn(..) | def::DefStaticMethod(..) => RvalueDatumExpr,
3580
3581                 // Note: there is actually a good case to be made that
3582                 // DefArg's, particularly those of immediate type, ought to
3583                 // considered rvalues.
3584                 def::DefStatic(..) |
3585                 def::DefBinding(..) |
3586                 def::DefUpvar(..) |
3587                 def::DefArg(..) |
3588                 def::DefLocal(..) => LvalueExpr,
3589
3590                 def => {
3591                     tcx.sess.span_bug(
3592                         expr.span,
3593                         format!("uncategorized def for expr {:?}: {:?}",
3594                                 expr.id,
3595                                 def).as_slice());
3596                 }
3597             }
3598         }
3599
3600         ast::ExprUnary(ast::UnDeref, _) |
3601         ast::ExprField(..) |
3602         ast::ExprTupField(..) |
3603         ast::ExprIndex(..) => {
3604             LvalueExpr
3605         }
3606
3607         ast::ExprCall(..) |
3608         ast::ExprMethodCall(..) |
3609         ast::ExprStruct(..) |
3610         ast::ExprTup(..) |
3611         ast::ExprIf(..) |
3612         ast::ExprMatch(..) |
3613         ast::ExprFnBlock(..) |
3614         ast::ExprProc(..) |
3615         ast::ExprUnboxedFn(..) |
3616         ast::ExprBlock(..) |
3617         ast::ExprRepeat(..) |
3618         ast::ExprVec(..) => {
3619             RvalueDpsExpr
3620         }
3621
3622         ast::ExprLit(lit) if lit_is_str(lit) => {
3623             RvalueDpsExpr
3624         }
3625
3626         ast::ExprCast(..) => {
3627             match tcx.node_types.borrow().find(&(expr.id as uint)) {
3628                 Some(&t) => {
3629                     if type_is_trait(t) {
3630                         RvalueDpsExpr
3631                     } else {
3632                         RvalueDatumExpr
3633                     }
3634                 }
3635                 None => {
3636                     // Technically, it should not happen that the expr is not
3637                     // present within the table.  However, it DOES happen
3638                     // during type check, because the final types from the
3639                     // expressions are not yet recorded in the tcx.  At that
3640                     // time, though, we are only interested in knowing lvalue
3641                     // vs rvalue.  It would be better to base this decision on
3642                     // the AST type in cast node---but (at the time of this
3643                     // writing) it's not easy to distinguish casts to traits
3644                     // from other casts based on the AST.  This should be
3645                     // easier in the future, when casts to traits
3646                     // would like @Foo, Box<Foo>, or &Foo.
3647                     RvalueDatumExpr
3648                 }
3649             }
3650         }
3651
3652         ast::ExprBreak(..) |
3653         ast::ExprAgain(..) |
3654         ast::ExprRet(..) |
3655         ast::ExprWhile(..) |
3656         ast::ExprLoop(..) |
3657         ast::ExprAssign(..) |
3658         ast::ExprInlineAsm(..) |
3659         ast::ExprAssignOp(..) |
3660         ast::ExprForLoop(..) => {
3661             RvalueStmtExpr
3662         }
3663
3664         ast::ExprLit(_) | // Note: LitStr is carved out above
3665         ast::ExprUnary(..) |
3666         ast::ExprAddrOf(..) |
3667         ast::ExprBinary(..) => {
3668             RvalueDatumExpr
3669         }
3670
3671         ast::ExprBox(place, _) => {
3672             // Special case `Box<T>`/`Gc<T>` for now:
3673             let definition = match tcx.def_map.borrow().find(&place.id) {
3674                 Some(&def) => def,
3675                 None => fail!("no def for place"),
3676             };
3677             let def_id = definition.def_id();
3678             if tcx.lang_items.exchange_heap() == Some(def_id) ||
3679                tcx.lang_items.managed_heap() == Some(def_id) {
3680                 RvalueDatumExpr
3681             } else {
3682                 RvalueDpsExpr
3683             }
3684         }
3685
3686         ast::ExprParen(ref e) => expr_kind(tcx, &**e),
3687
3688         ast::ExprMac(..) => {
3689             tcx.sess.span_bug(
3690                 expr.span,
3691                 "macro expression remains after expansion");
3692         }
3693     }
3694 }
3695
3696 pub fn stmt_node_id(s: &ast::Stmt) -> ast::NodeId {
3697     match s.node {
3698       ast::StmtDecl(_, id) | StmtExpr(_, id) | StmtSemi(_, id) => {
3699         return id;
3700       }
3701       ast::StmtMac(..) => fail!("unexpanded macro in trans")
3702     }
3703 }
3704
3705 pub fn field_idx_strict(tcx: &ctxt, name: ast::Name, fields: &[field])
3706                      -> uint {
3707     let mut i = 0u;
3708     for f in fields.iter() { if f.ident.name == name { return i; } i += 1u; }
3709     tcx.sess.bug(format!(
3710         "no field named `{}` found in the list of fields `{:?}`",
3711         token::get_name(name),
3712         fields.iter()
3713               .map(|f| token::get_ident(f.ident).get().to_string())
3714               .collect::<Vec<String>>()).as_slice());
3715 }
3716
3717 pub fn impl_or_trait_item_idx(id: ast::Ident, trait_items: &[ImplOrTraitItem])
3718                               -> Option<uint> {
3719     trait_items.iter().position(|m| m.ident() == id)
3720 }
3721
3722 /// Returns a vector containing the indices of all type parameters that appear
3723 /// in `ty`.  The vector may contain duplicates.  Probably should be converted
3724 /// to a bitset or some other representation.
3725 pub fn param_tys_in_type(ty: t) -> Vec<ParamTy> {
3726     let mut rslt = Vec::new();
3727     walk_ty(ty, |ty| {
3728         match get(ty).sty {
3729           ty_param(p) => {
3730             rslt.push(p);
3731           }
3732           _ => ()
3733         }
3734     });
3735     rslt
3736 }
3737
3738 pub fn ty_sort_string(cx: &ctxt, t: t) -> String {
3739     match get(t).sty {
3740         ty_nil | ty_bot | ty_bool | ty_char | ty_int(_) |
3741         ty_uint(_) | ty_float(_) | ty_str => {
3742             ::util::ppaux::ty_to_string(cx, t)
3743         }
3744
3745         ty_enum(id, _) => format!("enum {}", item_path_str(cx, id)),
3746         ty_box(_) => "Gc-ptr".to_string(),
3747         ty_uniq(_) => "box".to_string(),
3748         ty_vec(_, _) => "vector".to_string(),
3749         ty_ptr(_) => "*-ptr".to_string(),
3750         ty_rptr(_, _) => "&-ptr".to_string(),
3751         ty_bare_fn(_) => "extern fn".to_string(),
3752         ty_closure(_) => "fn".to_string(),
3753         ty_trait(ref inner) => {
3754             format!("trait {}", item_path_str(cx, inner.def_id))
3755         }
3756         ty_struct(id, _) => {
3757             format!("struct {}", item_path_str(cx, id))
3758         }
3759         ty_unboxed_closure(..) => "closure".to_string(),
3760         ty_tup(_) => "tuple".to_string(),
3761         ty_infer(TyVar(_)) => "inferred type".to_string(),
3762         ty_infer(IntVar(_)) => "integral variable".to_string(),
3763         ty_infer(FloatVar(_)) => "floating-point variable".to_string(),
3764         ty_param(ref p) => {
3765             if p.space == subst::SelfSpace {
3766                 "Self".to_string()
3767             } else {
3768                 "type parameter".to_string()
3769             }
3770         }
3771         ty_err => "type error".to_string(),
3772         ty_open(_) => "opened DST".to_string(),
3773     }
3774 }
3775
3776 pub fn type_err_to_str(cx: &ctxt, err: &type_err) -> String {
3777     /*!
3778      *
3779      * Explains the source of a type err in a short,
3780      * human readable way.  This is meant to be placed in
3781      * parentheses after some larger message.  You should
3782      * also invoke `note_and_explain_type_err()` afterwards
3783      * to present additional details, particularly when
3784      * it comes to lifetime-related errors. */
3785
3786     fn tstore_to_closure(s: &TraitStore) -> String {
3787         match s {
3788             &UniqTraitStore => "proc".to_string(),
3789             &RegionTraitStore(..) => "closure".to_string()
3790         }
3791     }
3792
3793     match *err {
3794         terr_mismatch => "types differ".to_string(),
3795         terr_fn_style_mismatch(values) => {
3796             format!("expected {} fn, found {} fn",
3797                     values.expected.to_string(),
3798                     values.found.to_string())
3799         }
3800         terr_abi_mismatch(values) => {
3801             format!("expected {} fn, found {} fn",
3802                     values.expected.to_string(),
3803                     values.found.to_string())
3804         }
3805         terr_onceness_mismatch(values) => {
3806             format!("expected {} fn, found {} fn",
3807                     values.expected.to_string(),
3808                     values.found.to_string())
3809         }
3810         terr_sigil_mismatch(values) => {
3811             format!("expected {}, found {}",
3812                     tstore_to_closure(&values.expected),
3813                     tstore_to_closure(&values.found))
3814         }
3815         terr_mutability => "values differ in mutability".to_string(),
3816         terr_box_mutability => {
3817             "boxed values differ in mutability".to_string()
3818         }
3819         terr_vec_mutability => "vectors differ in mutability".to_string(),
3820         terr_ptr_mutability => "pointers differ in mutability".to_string(),
3821         terr_ref_mutability => "references differ in mutability".to_string(),
3822         terr_ty_param_size(values) => {
3823             format!("expected a type with {} type params, \
3824                      found one with {} type params",
3825                     values.expected,
3826                     values.found)
3827         }
3828         terr_tuple_size(values) => {
3829             format!("expected a tuple with {} elements, \
3830                      found one with {} elements",
3831                     values.expected,
3832                     values.found)
3833         }
3834         terr_record_size(values) => {
3835             format!("expected a record with {} fields, \
3836                      found one with {} fields",
3837                     values.expected,
3838                     values.found)
3839         }
3840         terr_record_mutability => {
3841             "record elements differ in mutability".to_string()
3842         }
3843         terr_record_fields(values) => {
3844             format!("expected a record with field `{}`, found one \
3845                      with field `{}`",
3846                     token::get_ident(values.expected),
3847                     token::get_ident(values.found))
3848         }
3849         terr_arg_count => {
3850             "incorrect number of function parameters".to_string()
3851         }
3852         terr_regions_does_not_outlive(..) => {
3853             "lifetime mismatch".to_string()
3854         }
3855         terr_regions_not_same(..) => {
3856             "lifetimes are not the same".to_string()
3857         }
3858         terr_regions_no_overlap(..) => {
3859             "lifetimes do not intersect".to_string()
3860         }
3861         terr_regions_insufficiently_polymorphic(br, _) => {
3862             format!("expected bound lifetime parameter {}, \
3863                      found concrete lifetime",
3864                     bound_region_ptr_to_string(cx, br))
3865         }
3866         terr_regions_overly_polymorphic(br, _) => {
3867             format!("expected concrete lifetime, \
3868                      found bound lifetime parameter {}",
3869                     bound_region_ptr_to_string(cx, br))
3870         }
3871         terr_trait_stores_differ(_, ref values) => {
3872             format!("trait storage differs: expected `{}`, found `{}`",
3873                     trait_store_to_string(cx, (*values).expected),
3874                     trait_store_to_string(cx, (*values).found))
3875         }
3876         terr_sorts(values) => {
3877             format!("expected {}, found {}",
3878                     ty_sort_string(cx, values.expected),
3879                     ty_sort_string(cx, values.found))
3880         }
3881         terr_traits(values) => {
3882             format!("expected trait `{}`, found trait `{}`",
3883                     item_path_str(cx, values.expected),
3884                     item_path_str(cx, values.found))
3885         }
3886         terr_builtin_bounds(values) => {
3887             if values.expected.is_empty() {
3888                 format!("expected no bounds, found `{}`",
3889                         values.found.user_string(cx))
3890             } else if values.found.is_empty() {
3891                 format!("expected bounds `{}`, found no bounds",
3892                         values.expected.user_string(cx))
3893             } else {
3894                 format!("expected bounds `{}`, found bounds `{}`",
3895                         values.expected.user_string(cx),
3896                         values.found.user_string(cx))
3897             }
3898         }
3899         terr_integer_as_char => {
3900             "expected an integral type, found `char`".to_string()
3901         }
3902         terr_int_mismatch(ref values) => {
3903             format!("expected `{}`, found `{}`",
3904                     values.expected.to_string(),
3905                     values.found.to_string())
3906         }
3907         terr_float_mismatch(ref values) => {
3908             format!("expected `{}`, found `{}`",
3909                     values.expected.to_string(),
3910                     values.found.to_string())
3911         }
3912         terr_variadic_mismatch(ref values) => {
3913             format!("expected {} fn, found {} function",
3914                     if values.expected { "variadic" } else { "non-variadic" },
3915                     if values.found { "variadic" } else { "non-variadic" })
3916         }
3917     }
3918 }
3919
3920 pub fn note_and_explain_type_err(cx: &ctxt, err: &type_err) {
3921     match *err {
3922         terr_regions_does_not_outlive(subregion, superregion) => {
3923             note_and_explain_region(cx, "", subregion, "...");
3924             note_and_explain_region(cx, "...does not necessarily outlive ",
3925                                     superregion, "");
3926         }
3927         terr_regions_not_same(region1, region2) => {
3928             note_and_explain_region(cx, "", region1, "...");
3929             note_and_explain_region(cx, "...is not the same lifetime as ",
3930                                     region2, "");
3931         }
3932         terr_regions_no_overlap(region1, region2) => {
3933             note_and_explain_region(cx, "", region1, "...");
3934             note_and_explain_region(cx, "...does not overlap ",
3935                                     region2, "");
3936         }
3937         terr_regions_insufficiently_polymorphic(_, conc_region) => {
3938             note_and_explain_region(cx,
3939                                     "concrete lifetime that was found is ",
3940                                     conc_region, "");
3941         }
3942         terr_regions_overly_polymorphic(_, conc_region) => {
3943             note_and_explain_region(cx,
3944                                     "expected concrete lifetime is ",
3945                                     conc_region, "");
3946         }
3947         _ => {}
3948     }
3949 }
3950
3951 pub fn provided_source(cx: &ctxt, id: ast::DefId) -> Option<ast::DefId> {
3952     cx.provided_method_sources.borrow().find(&id).map(|x| *x)
3953 }
3954
3955 pub fn provided_trait_methods(cx: &ctxt, id: ast::DefId) -> Vec<Rc<Method>> {
3956     if is_local(id) {
3957         match cx.map.find(id.node) {
3958             Some(ast_map::NodeItem(item)) => {
3959                 match item.node {
3960                     ItemTrait(_, _, _, ref ms) => {
3961                         let (_, p) = ast_util::split_trait_methods(ms.as_slice());
3962                         p.iter()
3963                          .map(|m| {
3964                             match impl_or_trait_item(
3965                                     cx,
3966                                     ast_util::local_def(m.id)) {
3967                                 MethodTraitItem(m) => m,
3968                             }
3969                          })
3970                          .collect()
3971                     }
3972                     _ => {
3973                         cx.sess.bug(format!("provided_trait_methods: `{}` is \
3974                                              not a trait",
3975                                             id).as_slice())
3976                     }
3977                 }
3978             }
3979             _ => {
3980                 cx.sess.bug(format!("provided_trait_methods: `{}` is not a \
3981                                      trait",
3982                                     id).as_slice())
3983             }
3984         }
3985     } else {
3986         csearch::get_provided_trait_methods(cx, id)
3987     }
3988 }
3989
3990 fn lookup_locally_or_in_crate_store<V:Clone>(
3991                                     descr: &str,
3992                                     def_id: ast::DefId,
3993                                     map: &mut DefIdMap<V>,
3994                                     load_external: || -> V) -> V {
3995     /*!
3996      * Helper for looking things up in the various maps
3997      * that are populated during typeck::collect (e.g.,
3998      * `cx.impl_or_trait_items`, `cx.tcache`, etc).  All of these share
3999      * the pattern that if the id is local, it should have
4000      * been loaded into the map by the `typeck::collect` phase.
4001      * If the def-id is external, then we have to go consult
4002      * the crate loading code (and cache the result for the future).
4003      */
4004
4005     match map.find_copy(&def_id) {
4006         Some(v) => { return v; }
4007         None => { }
4008     }
4009
4010     if def_id.krate == ast::LOCAL_CRATE {
4011         fail!("No def'n found for {:?} in tcx.{}", def_id, descr);
4012     }
4013     let v = load_external();
4014     map.insert(def_id, v.clone());
4015     v
4016 }
4017
4018 pub fn trait_item(cx: &ctxt, trait_did: ast::DefId, idx: uint)
4019                   -> ImplOrTraitItem {
4020     let method_def_id = ty::trait_item_def_ids(cx, trait_did).get(idx)
4021                                                              .def_id();
4022     impl_or_trait_item(cx, method_def_id)
4023 }
4024
4025 pub fn trait_items(cx: &ctxt, trait_did: ast::DefId)
4026                    -> Rc<Vec<ImplOrTraitItem>> {
4027     let mut trait_items = cx.trait_items_cache.borrow_mut();
4028     match trait_items.find_copy(&trait_did) {
4029         Some(trait_items) => trait_items,
4030         None => {
4031             let def_ids = ty::trait_item_def_ids(cx, trait_did);
4032             let items: Rc<Vec<ImplOrTraitItem>> =
4033                 Rc::new(def_ids.iter()
4034                                .map(|d| impl_or_trait_item(cx, d.def_id()))
4035                                .collect());
4036             trait_items.insert(trait_did, items.clone());
4037             items
4038         }
4039     }
4040 }
4041
4042 pub fn impl_or_trait_item(cx: &ctxt, id: ast::DefId) -> ImplOrTraitItem {
4043     lookup_locally_or_in_crate_store("impl_or_trait_items",
4044                                      id,
4045                                      &mut *cx.impl_or_trait_items
4046                                              .borrow_mut(),
4047                                      || {
4048         csearch::get_impl_or_trait_item(cx, id)
4049     })
4050 }
4051
4052 pub fn trait_item_def_ids(cx: &ctxt, id: ast::DefId)
4053                           -> Rc<Vec<ImplOrTraitItemId>> {
4054     lookup_locally_or_in_crate_store("trait_item_def_ids",
4055                                      id,
4056                                      &mut *cx.trait_item_def_ids.borrow_mut(),
4057                                      || {
4058         Rc::new(csearch::get_trait_item_def_ids(&cx.sess.cstore, id))
4059     })
4060 }
4061
4062 pub fn impl_trait_ref(cx: &ctxt, id: ast::DefId) -> Option<Rc<TraitRef>> {
4063     match cx.impl_trait_cache.borrow().find(&id) {
4064         Some(ret) => { return ret.clone(); }
4065         None => {}
4066     }
4067
4068     let ret = if id.krate == ast::LOCAL_CRATE {
4069         debug!("(impl_trait_ref) searching for trait impl {:?}", id);
4070         match cx.map.find(id.node) {
4071             Some(ast_map::NodeItem(item)) => {
4072                 match item.node {
4073                     ast::ItemImpl(_, ref opt_trait, _, _) => {
4074                         match opt_trait {
4075                             &Some(ref t) => {
4076                                 Some(ty::node_id_to_trait_ref(cx, t.ref_id))
4077                             }
4078                             &None => None
4079                         }
4080                     }
4081                     _ => None
4082                 }
4083             }
4084             _ => None
4085         }
4086     } else {
4087         csearch::get_impl_trait(cx, id)
4088     };
4089
4090     cx.impl_trait_cache.borrow_mut().insert(id, ret.clone());
4091     ret
4092 }
4093
4094 pub fn trait_ref_to_def_id(tcx: &ctxt, tr: &ast::TraitRef) -> ast::DefId {
4095     let def = *tcx.def_map.borrow()
4096                      .find(&tr.ref_id)
4097                      .expect("no def-map entry for trait");
4098     def.def_id()
4099 }
4100
4101 pub fn try_add_builtin_trait(
4102     tcx: &ctxt,
4103     trait_def_id: ast::DefId,
4104     builtin_bounds: &mut EnumSet<BuiltinBound>)
4105     -> bool
4106 {
4107     //! Checks whether `trait_ref` refers to one of the builtin
4108     //! traits, like `Send`, and adds the corresponding
4109     //! bound to the set `builtin_bounds` if so. Returns true if `trait_ref`
4110     //! is a builtin trait.
4111
4112     match tcx.lang_items.to_builtin_kind(trait_def_id) {
4113         Some(bound) => { builtin_bounds.add(bound); true }
4114         None => false
4115     }
4116 }
4117
4118 pub fn ty_to_def_id(ty: t) -> Option<ast::DefId> {
4119     match get(ty).sty {
4120         ty_trait(box TyTrait { def_id: id, .. }) |
4121         ty_struct(id, _) |
4122         ty_enum(id, _) |
4123         ty_unboxed_closure(id, _) => Some(id),
4124         _ => None
4125     }
4126 }
4127
4128 // Enum information
4129 #[deriving(Clone)]
4130 pub struct VariantInfo {
4131     pub args: Vec<t>,
4132     pub arg_names: Option<Vec<ast::Ident> >,
4133     pub ctor_ty: t,
4134     pub name: ast::Ident,
4135     pub id: ast::DefId,
4136     pub disr_val: Disr,
4137     pub vis: Visibility
4138 }
4139
4140 impl VariantInfo {
4141
4142     /// Creates a new VariantInfo from the corresponding ast representation.
4143     ///
4144     /// Does not do any caching of the value in the type context.
4145     pub fn from_ast_variant(cx: &ctxt,
4146                             ast_variant: &ast::Variant,
4147                             discriminant: Disr) -> VariantInfo {
4148         let ctor_ty = node_id_to_type(cx, ast_variant.node.id);
4149
4150         match ast_variant.node.kind {
4151             ast::TupleVariantKind(ref args) => {
4152                 let arg_tys = if args.len() > 0 {
4153                     ty_fn_args(ctor_ty).iter().map(|a| *a).collect()
4154                 } else {
4155                     Vec::new()
4156                 };
4157
4158                 return VariantInfo {
4159                     args: arg_tys,
4160                     arg_names: None,
4161                     ctor_ty: ctor_ty,
4162                     name: ast_variant.node.name,
4163                     id: ast_util::local_def(ast_variant.node.id),
4164                     disr_val: discriminant,
4165                     vis: ast_variant.node.vis
4166                 };
4167             },
4168             ast::StructVariantKind(ref struct_def) => {
4169
4170                 let fields: &[StructField] = struct_def.fields.as_slice();
4171
4172                 assert!(fields.len() > 0);
4173
4174                 let arg_tys = ty_fn_args(ctor_ty).iter().map(|a| *a).collect();
4175                 let arg_names = fields.iter().map(|field| {
4176                     match field.node.kind {
4177                         NamedField(ident, _) => ident,
4178                         UnnamedField(..) => cx.sess.bug(
4179                             "enum_variants: all fields in struct must have a name")
4180                     }
4181                 }).collect();
4182
4183                 return VariantInfo {
4184                     args: arg_tys,
4185                     arg_names: Some(arg_names),
4186                     ctor_ty: ctor_ty,
4187                     name: ast_variant.node.name,
4188                     id: ast_util::local_def(ast_variant.node.id),
4189                     disr_val: discriminant,
4190                     vis: ast_variant.node.vis
4191                 };
4192             }
4193         }
4194     }
4195 }
4196
4197 pub fn substd_enum_variants(cx: &ctxt,
4198                             id: ast::DefId,
4199                             substs: &Substs)
4200                          -> Vec<Rc<VariantInfo>> {
4201     enum_variants(cx, id).iter().map(|variant_info| {
4202         let substd_args = variant_info.args.iter()
4203             .map(|aty| aty.subst(cx, substs)).collect::<Vec<_>>();
4204
4205         let substd_ctor_ty = variant_info.ctor_ty.subst(cx, substs);
4206
4207         Rc::new(VariantInfo {
4208             args: substd_args,
4209             ctor_ty: substd_ctor_ty,
4210             ..(**variant_info).clone()
4211         })
4212     }).collect()
4213 }
4214
4215 pub fn item_path_str(cx: &ctxt, id: ast::DefId) -> String {
4216     with_path(cx, id, |path| ast_map::path_to_string(path)).to_string()
4217 }
4218
4219 pub enum DtorKind {
4220     NoDtor,
4221     TraitDtor(DefId, bool)
4222 }
4223
4224 impl DtorKind {
4225     pub fn is_present(&self) -> bool {
4226         match *self {
4227             TraitDtor(..) => true,
4228             _ => false
4229         }
4230     }
4231
4232     pub fn has_drop_flag(&self) -> bool {
4233         match self {
4234             &NoDtor => false,
4235             &TraitDtor(_, flag) => flag
4236         }
4237     }
4238 }
4239
4240 /* If struct_id names a struct with a dtor, return Some(the dtor's id).
4241    Otherwise return none. */
4242 pub fn ty_dtor(cx: &ctxt, struct_id: DefId) -> DtorKind {
4243     match cx.destructor_for_type.borrow().find(&struct_id) {
4244         Some(&method_def_id) => {
4245             let flag = !has_attr(cx, struct_id, "unsafe_no_drop_flag");
4246
4247             TraitDtor(method_def_id, flag)
4248         }
4249         None => NoDtor,
4250     }
4251 }
4252
4253 pub fn has_dtor(cx: &ctxt, struct_id: DefId) -> bool {
4254     ty_dtor(cx, struct_id).is_present()
4255 }
4256
4257 pub fn with_path<T>(cx: &ctxt, id: ast::DefId, f: |ast_map::PathElems| -> T) -> T {
4258     if id.krate == ast::LOCAL_CRATE {
4259         cx.map.with_path(id.node, f)
4260     } else {
4261         f(ast_map::Values(csearch::get_item_path(cx, id).iter()).chain(None))
4262     }
4263 }
4264
4265 pub fn enum_is_univariant(cx: &ctxt, id: ast::DefId) -> bool {
4266     enum_variants(cx, id).len() == 1
4267 }
4268
4269 pub fn type_is_empty(cx: &ctxt, t: t) -> bool {
4270     match ty::get(t).sty {
4271        ty_enum(did, _) => (*enum_variants(cx, did)).is_empty(),
4272        _ => false
4273      }
4274 }
4275
4276 pub fn enum_variants(cx: &ctxt, id: ast::DefId) -> Rc<Vec<Rc<VariantInfo>>> {
4277     match cx.enum_var_cache.borrow().find(&id) {
4278         Some(variants) => return variants.clone(),
4279         _ => { /* fallthrough */ }
4280     }
4281
4282     let result = if ast::LOCAL_CRATE != id.krate {
4283         Rc::new(csearch::get_enum_variants(cx, id))
4284     } else {
4285         /*
4286           Although both this code and check_enum_variants in typeck/check
4287           call eval_const_expr, it should never get called twice for the same
4288           expr, since check_enum_variants also updates the enum_var_cache
4289          */
4290         match cx.map.get(id.node) {
4291             ast_map::NodeItem(item) => {
4292                 match item.node {
4293                     ast::ItemEnum(ref enum_definition, _) => {
4294                         let mut last_discriminant: Option<Disr> = None;
4295                         Rc::new(enum_definition.variants.iter().map(|&variant| {
4296
4297                             let mut discriminant = match last_discriminant {
4298                                 Some(val) => val + 1,
4299                                 None => INITIAL_DISCRIMINANT_VALUE
4300                             };
4301
4302                             match variant.node.disr_expr {
4303                                 Some(ref e) => match const_eval::eval_const_expr_partial(cx, &**e) {
4304                                     Ok(const_eval::const_int(val)) => {
4305                                         discriminant = val as Disr
4306                                     }
4307                                     Ok(const_eval::const_uint(val)) => {
4308                                         discriminant = val as Disr
4309                                     }
4310                                     Ok(_) => {
4311                                         cx.sess
4312                                           .span_err(e.span,
4313                                                     "expected signed integer constant");
4314                                     }
4315                                     Err(ref err) => {
4316                                         cx.sess
4317                                           .span_err(e.span,
4318                                                     format!("expected constant: {}",
4319                                                             *err).as_slice());
4320                                     }
4321                                 },
4322                                 None => {}
4323                             };
4324
4325                             last_discriminant = Some(discriminant);
4326                             Rc::new(VariantInfo::from_ast_variant(cx, &*variant,
4327                                                                   discriminant))
4328                         }).collect())
4329                     }
4330                     _ => {
4331                         cx.sess.bug("enum_variants: id not bound to an enum")
4332                     }
4333                 }
4334             }
4335             _ => cx.sess.bug("enum_variants: id not bound to an enum")
4336         }
4337     };
4338
4339     cx.enum_var_cache.borrow_mut().insert(id, result.clone());
4340     result
4341 }
4342
4343
4344 // Returns information about the enum variant with the given ID:
4345 pub fn enum_variant_with_id(cx: &ctxt,
4346                             enum_id: ast::DefId,
4347                             variant_id: ast::DefId)
4348                          -> Rc<VariantInfo> {
4349     enum_variants(cx, enum_id).iter()
4350                               .find(|variant| variant.id == variant_id)
4351                               .expect("enum_variant_with_id(): no variant exists with that ID")
4352                               .clone()
4353 }
4354
4355
4356 // If the given item is in an external crate, looks up its type and adds it to
4357 // the type cache. Returns the type parameters and type.
4358 pub fn lookup_item_type(cx: &ctxt,
4359                         did: ast::DefId)
4360                      -> Polytype {
4361     lookup_locally_or_in_crate_store(
4362         "tcache", did, &mut *cx.tcache.borrow_mut(),
4363         || csearch::get_type(cx, did))
4364 }
4365
4366 pub fn lookup_impl_vtables(cx: &ctxt,
4367                            did: ast::DefId)
4368                            -> typeck::vtable_res {
4369     lookup_locally_or_in_crate_store(
4370         "impl_vtables", did, &mut *cx.impl_vtables.borrow_mut(),
4371         || csearch::get_impl_vtables(cx, did) )
4372 }
4373
4374 /// Given the did of a trait, returns its canonical trait ref.
4375 pub fn lookup_trait_def(cx: &ctxt, did: ast::DefId) -> Rc<ty::TraitDef> {
4376     let mut trait_defs = cx.trait_defs.borrow_mut();
4377     match trait_defs.find_copy(&did) {
4378         Some(trait_def) => {
4379             // The item is in this crate. The caller should have added it to the
4380             // type cache already
4381             trait_def
4382         }
4383         None => {
4384             assert!(did.krate != ast::LOCAL_CRATE);
4385             let trait_def = Rc::new(csearch::get_trait_def(cx, did));
4386             trait_defs.insert(did, trait_def.clone());
4387             trait_def
4388         }
4389     }
4390 }
4391
4392 /// Given a reference to a trait, returns the bounds declared on the
4393 /// trait, with appropriate substitutions applied.
4394 pub fn bounds_for_trait_ref(tcx: &ctxt,
4395                             trait_ref: &TraitRef)
4396                             -> ty::ParamBounds
4397 {
4398     let trait_def = lookup_trait_def(tcx, trait_ref.def_id);
4399     debug!("bounds_for_trait_ref(trait_def={}, trait_ref={})",
4400            trait_def.repr(tcx), trait_ref.repr(tcx));
4401     trait_def.bounds.subst(tcx, &trait_ref.substs)
4402 }
4403
4404 /// Iterate over attributes of a definition.
4405 // (This should really be an iterator, but that would require csearch and
4406 // decoder to use iterators instead of higher-order functions.)
4407 pub fn each_attr(tcx: &ctxt, did: DefId, f: |&ast::Attribute| -> bool) -> bool {
4408     if is_local(did) {
4409         let item = tcx.map.expect_item(did.node);
4410         item.attrs.iter().all(|attr| f(attr))
4411     } else {
4412         info!("getting foreign attrs");
4413         let mut cont = true;
4414         csearch::get_item_attrs(&tcx.sess.cstore, did, |attrs| {
4415             if cont {
4416                 cont = attrs.iter().all(|attr| f(attr));
4417             }
4418         });
4419         info!("done");
4420         cont
4421     }
4422 }
4423
4424 /// Determine whether an item is annotated with an attribute
4425 pub fn has_attr(tcx: &ctxt, did: DefId, attr: &str) -> bool {
4426     let mut found = false;
4427     each_attr(tcx, did, |item| {
4428         if item.check_name(attr) {
4429             found = true;
4430             false
4431         } else {
4432             true
4433         }
4434     });
4435     found
4436 }
4437
4438 /// Determine whether an item is annotated with `#[repr(packed)]`
4439 pub fn lookup_packed(tcx: &ctxt, did: DefId) -> bool {
4440     lookup_repr_hints(tcx, did).contains(&attr::ReprPacked)
4441 }
4442
4443 /// Determine whether an item is annotated with `#[simd]`
4444 pub fn lookup_simd(tcx: &ctxt, did: DefId) -> bool {
4445     has_attr(tcx, did, "simd")
4446 }
4447
4448 /// Obtain the representation annotation for a struct definition.
4449 pub fn lookup_repr_hints(tcx: &ctxt, did: DefId) -> Vec<attr::ReprAttr> {
4450     let mut acc = Vec::new();
4451
4452     ty::each_attr(tcx, did, |meta| {
4453         acc.extend(attr::find_repr_attrs(tcx.sess.diagnostic(), meta).move_iter());
4454         true
4455     });
4456
4457     acc
4458 }
4459
4460 // Look up a field ID, whether or not it's local
4461 // Takes a list of type substs in case the struct is generic
4462 pub fn lookup_field_type(tcx: &ctxt,
4463                          struct_id: DefId,
4464                          id: DefId,
4465                          substs: &Substs)
4466                       -> ty::t {
4467     let t = if id.krate == ast::LOCAL_CRATE {
4468         node_id_to_type(tcx, id.node)
4469     } else {
4470         let mut tcache = tcx.tcache.borrow_mut();
4471         let pty = tcache.find_or_insert_with(id, |_| {
4472             csearch::get_field_type(tcx, struct_id, id)
4473         });
4474         pty.ty
4475     };
4476     t.subst(tcx, substs)
4477 }
4478
4479 // Lookup all ancestor structs of a struct indicated by did. That is the reflexive,
4480 // transitive closure of doing a single lookup in cx.superstructs.
4481 fn each_super_struct(cx: &ctxt, mut did: ast::DefId, f: |ast::DefId|) {
4482     let superstructs = cx.superstructs.borrow();
4483
4484     loop {
4485         f(did);
4486         match superstructs.find(&did) {
4487             Some(&Some(def_id)) => {
4488                 did = def_id;
4489             },
4490             Some(&None) => break,
4491             None => {
4492                 cx.sess.bug(
4493                     format!("ID not mapped to super-struct: {}",
4494                             cx.map.node_to_string(did.node)).as_slice());
4495             }
4496         }
4497     }
4498 }
4499
4500 // Look up the list of field names and IDs for a given struct.
4501 // Fails if the id is not bound to a struct.
4502 pub fn lookup_struct_fields(cx: &ctxt, did: ast::DefId) -> Vec<field_ty> {
4503     if did.krate == ast::LOCAL_CRATE {
4504         // We store the fields which are syntactically in each struct in cx. So
4505         // we have to walk the inheritance chain of the struct to get all the
4506         // structs (explicit and inherited) for a struct. If this is expensive
4507         // we could cache the whole list of fields here.
4508         let struct_fields = cx.struct_fields.borrow();
4509         let mut results: SmallVector<&[field_ty]> = SmallVector::zero();
4510         each_super_struct(cx, did, |s| {
4511             match struct_fields.find(&s) {
4512                 Some(fields) => results.push(fields.as_slice()),
4513                 _ => {
4514                     cx.sess.bug(
4515                         format!("ID not mapped to struct fields: {}",
4516                                 cx.map.node_to_string(did.node)).as_slice());
4517                 }
4518             }
4519         });
4520
4521         let len = results.as_slice().iter().map(|x| x.len()).sum();
4522         let mut result: Vec<field_ty> = Vec::with_capacity(len);
4523         result.extend(results.as_slice().iter().flat_map(|rs| rs.iter().map(|f| f.clone())));
4524         assert!(result.len() == len);
4525         result
4526     } else {
4527         csearch::get_struct_fields(&cx.sess.cstore, did)
4528     }
4529 }
4530
4531 pub fn is_tuple_struct(cx: &ctxt, did: ast::DefId) -> bool {
4532     let fields = lookup_struct_fields(cx, did);
4533     !fields.is_empty() && fields.iter().all(|f| f.name == token::special_names::unnamed_field)
4534 }
4535
4536 pub fn lookup_struct_field(cx: &ctxt,
4537                            parent: ast::DefId,
4538                            field_id: ast::DefId)
4539                         -> field_ty {
4540     let r = lookup_struct_fields(cx, parent);
4541     match r.iter().find(|f| f.id.node == field_id.node) {
4542         Some(t) => t.clone(),
4543         None => cx.sess.bug("struct ID not found in parent's fields")
4544     }
4545 }
4546
4547 // Returns a list of fields corresponding to the struct's items. trans uses
4548 // this. Takes a list of substs with which to instantiate field types.
4549 pub fn struct_fields(cx: &ctxt, did: ast::DefId, substs: &Substs)
4550                      -> Vec<field> {
4551     lookup_struct_fields(cx, did).iter().map(|f| {
4552        field {
4553             // FIXME #6993: change type of field to Name and get rid of new()
4554             ident: ast::Ident::new(f.name),
4555             mt: mt {
4556                 ty: lookup_field_type(cx, did, f.id, substs),
4557                 mutbl: MutImmutable
4558             }
4559         }
4560     }).collect()
4561 }
4562
4563 // Returns a list of fields corresponding to the tuple's items. trans uses
4564 // this.
4565 pub fn tup_fields(v: &[t]) -> Vec<field> {
4566     v.iter().enumerate().map(|(i, &f)| {
4567        field {
4568             // FIXME #6993: change type of field to Name and get rid of new()
4569             ident: ast::Ident::new(token::intern(i.to_string().as_slice())),
4570             mt: mt {
4571                 ty: f,
4572                 mutbl: MutImmutable
4573             }
4574         }
4575     }).collect()
4576 }
4577
4578 pub struct UnboxedClosureUpvar {
4579     pub def: def::Def,
4580     pub span: Span,
4581     pub ty: t,
4582 }
4583
4584 // Returns a list of `UnboxedClosureUpvar`s for each upvar.
4585 pub fn unboxed_closure_upvars(tcx: &ctxt, closure_id: ast::DefId)
4586                               -> Vec<UnboxedClosureUpvar> {
4587     if closure_id.krate == ast::LOCAL_CRATE {
4588         match tcx.freevars.borrow().find(&closure_id.node) {
4589             None => tcx.sess.bug("no freevars for unboxed closure?!"),
4590             Some(ref freevars) => {
4591                 freevars.iter().map(|freevar| {
4592                     let freevar_def_id = freevar.def.def_id();
4593                     UnboxedClosureUpvar {
4594                         def: freevar.def,
4595                         span: freevar.span,
4596                         ty: node_id_to_type(tcx, freevar_def_id.node),
4597                     }
4598                 }).collect()
4599             }
4600         }
4601     } else {
4602         tcx.sess.bug("unimplemented cross-crate closure upvars")
4603     }
4604 }
4605
4606 pub fn is_binopable(cx: &ctxt, ty: t, op: ast::BinOp) -> bool {
4607     static tycat_other: int = 0;
4608     static tycat_bool: int = 1;
4609     static tycat_char: int = 2;
4610     static tycat_int: int = 3;
4611     static tycat_float: int = 4;
4612     static tycat_bot: int = 5;
4613     static tycat_raw_ptr: int = 6;
4614
4615     static opcat_add: int = 0;
4616     static opcat_sub: int = 1;
4617     static opcat_mult: int = 2;
4618     static opcat_shift: int = 3;
4619     static opcat_rel: int = 4;
4620     static opcat_eq: int = 5;
4621     static opcat_bit: int = 6;
4622     static opcat_logic: int = 7;
4623     static opcat_mod: int = 8;
4624
4625     fn opcat(op: ast::BinOp) -> int {
4626         match op {
4627           ast::BiAdd => opcat_add,
4628           ast::BiSub => opcat_sub,
4629           ast::BiMul => opcat_mult,
4630           ast::BiDiv => opcat_mult,
4631           ast::BiRem => opcat_mod,
4632           ast::BiAnd => opcat_logic,
4633           ast::BiOr => opcat_logic,
4634           ast::BiBitXor => opcat_bit,
4635           ast::BiBitAnd => opcat_bit,
4636           ast::BiBitOr => opcat_bit,
4637           ast::BiShl => opcat_shift,
4638           ast::BiShr => opcat_shift,
4639           ast::BiEq => opcat_eq,
4640           ast::BiNe => opcat_eq,
4641           ast::BiLt => opcat_rel,
4642           ast::BiLe => opcat_rel,
4643           ast::BiGe => opcat_rel,
4644           ast::BiGt => opcat_rel
4645         }
4646     }
4647
4648     fn tycat(cx: &ctxt, ty: t) -> int {
4649         if type_is_simd(cx, ty) {
4650             return tycat(cx, simd_type(cx, ty))
4651         }
4652         match get(ty).sty {
4653           ty_char => tycat_char,
4654           ty_bool => tycat_bool,
4655           ty_int(_) | ty_uint(_) | ty_infer(IntVar(_)) => tycat_int,
4656           ty_float(_) | ty_infer(FloatVar(_)) => tycat_float,
4657           ty_bot => tycat_bot,
4658           ty_ptr(_) => tycat_raw_ptr,
4659           _ => tycat_other
4660         }
4661     }
4662
4663     static t: bool = true;
4664     static f: bool = false;
4665
4666     let tbl = [
4667     //           +, -, *, shift, rel, ==, bit, logic, mod
4668     /*other*/   [f, f, f, f,     f,   f,  f,   f,     f],
4669     /*bool*/    [f, f, f, f,     t,   t,  t,   t,     f],
4670     /*char*/    [f, f, f, f,     t,   t,  f,   f,     f],
4671     /*int*/     [t, t, t, t,     t,   t,  t,   f,     t],
4672     /*float*/   [t, t, t, f,     t,   t,  f,   f,     f],
4673     /*bot*/     [t, t, t, t,     t,   t,  t,   t,     t],
4674     /*raw ptr*/ [f, f, f, f,     t,   t,  f,   f,     f]];
4675
4676     return tbl[tycat(cx, ty) as uint ][opcat(op) as uint];
4677 }
4678
4679 /// Returns an equivalent type with all the typedefs and self regions removed.
4680 pub fn normalize_ty(cx: &ctxt, t: t) -> t {
4681     let u = TypeNormalizer(cx).fold_ty(t);
4682     return u;
4683
4684     struct TypeNormalizer<'a, 'tcx: 'a>(&'a ctxt<'tcx>);
4685
4686     impl<'a, 'tcx> TypeFolder<'tcx> for TypeNormalizer<'a, 'tcx> {
4687         fn tcx<'a>(&'a self) -> &'a ctxt<'tcx> { let TypeNormalizer(c) = *self; c }
4688
4689         fn fold_ty(&mut self, t: ty::t) -> ty::t {
4690             match self.tcx().normalized_cache.borrow().find_copy(&t) {
4691                 None => {}
4692                 Some(u) => return u
4693             }
4694
4695             let t_norm = ty_fold::super_fold_ty(self, t);
4696             self.tcx().normalized_cache.borrow_mut().insert(t, t_norm);
4697             return t_norm;
4698         }
4699
4700         fn fold_region(&mut self, _: ty::Region) -> ty::Region {
4701             ty::ReStatic
4702         }
4703
4704         fn fold_substs(&mut self,
4705                        substs: &subst::Substs)
4706                        -> subst::Substs {
4707             subst::Substs { regions: subst::ErasedRegions,
4708                             types: substs.types.fold_with(self) }
4709         }
4710
4711         fn fold_sig(&mut self,
4712                     sig: &ty::FnSig)
4713                     -> ty::FnSig {
4714             // The binder-id is only relevant to bound regions, which
4715             // are erased at trans time.
4716             ty::FnSig {
4717                 binder_id: ast::DUMMY_NODE_ID,
4718                 inputs: sig.inputs.fold_with(self),
4719                 output: sig.output.fold_with(self),
4720                 variadic: sig.variadic,
4721             }
4722         }
4723     }
4724 }
4725
4726 // Returns the repeat count for a repeating vector expression.
4727 pub fn eval_repeat_count(tcx: &ctxt, count_expr: &ast::Expr) -> uint {
4728     match const_eval::eval_const_expr_partial(tcx, count_expr) {
4729       Ok(ref const_val) => match *const_val {
4730         const_eval::const_int(count) => if count < 0 {
4731             tcx.sess.span_err(count_expr.span,
4732                               "expected positive integer for \
4733                                repeat count, found negative integer");
4734             0
4735         } else {
4736             count as uint
4737         },
4738         const_eval::const_uint(count) => count as uint,
4739         const_eval::const_float(count) => {
4740             tcx.sess.span_err(count_expr.span,
4741                               "expected positive integer for \
4742                                repeat count, found float");
4743             count as uint
4744         }
4745         const_eval::const_str(_) => {
4746             tcx.sess.span_err(count_expr.span,
4747                               "expected positive integer for \
4748                                repeat count, found string");
4749             0
4750         }
4751         const_eval::const_bool(_) => {
4752             tcx.sess.span_err(count_expr.span,
4753                               "expected positive integer for \
4754                                repeat count, found boolean");
4755             0
4756         }
4757         const_eval::const_binary(_) => {
4758             tcx.sess.span_err(count_expr.span,
4759                               "expected positive integer for \
4760                                repeat count, found binary array");
4761             0
4762         }
4763         const_eval::const_nil => {
4764             tcx.sess.span_err(count_expr.span,
4765                               "expected positive integer for \
4766                                repeat count, found ()");
4767             0
4768         }
4769       },
4770       Err(..) => {
4771         tcx.sess.span_err(count_expr.span,
4772                           "expected constant integer for repeat count, \
4773                            found variable");
4774         0
4775       }
4776     }
4777 }
4778
4779 // Iterate over a type parameter's bounded traits and any supertraits
4780 // of those traits, ignoring kinds.
4781 // Here, the supertraits are the transitive closure of the supertrait
4782 // relation on the supertraits from each bounded trait's constraint
4783 // list.
4784 pub fn each_bound_trait_and_supertraits(tcx: &ctxt,
4785                                         bounds: &[Rc<TraitRef>],
4786                                         f: |Rc<TraitRef>| -> bool)
4787                                         -> bool {
4788     for bound_trait_ref in bounds.iter() {
4789         let mut supertrait_set = HashMap::new();
4790         let mut trait_refs = Vec::new();
4791         let mut i = 0;
4792
4793         // Seed the worklist with the trait from the bound
4794         supertrait_set.insert(bound_trait_ref.def_id, ());
4795         trait_refs.push(bound_trait_ref.clone());
4796
4797         // Add the given trait ty to the hash map
4798         while i < trait_refs.len() {
4799             debug!("each_bound_trait_and_supertraits(i={:?}, trait_ref={})",
4800                    i, trait_refs.get(i).repr(tcx));
4801
4802             if !f(trait_refs.get(i).clone()) {
4803                 return false;
4804             }
4805
4806             // Add supertraits to supertrait_set
4807             let trait_ref = trait_refs.get(i).clone();
4808             let trait_def = lookup_trait_def(tcx, trait_ref.def_id);
4809             for supertrait_ref in trait_def.bounds.trait_bounds.iter() {
4810                 let supertrait_ref = supertrait_ref.subst(tcx, &trait_ref.substs);
4811                 debug!("each_bound_trait_and_supertraits(supertrait_ref={})",
4812                        supertrait_ref.repr(tcx));
4813
4814                 let d_id = supertrait_ref.def_id;
4815                 if !supertrait_set.contains_key(&d_id) {
4816                     // FIXME(#5527) Could have same trait multiple times
4817                     supertrait_set.insert(d_id, ());
4818                     trait_refs.push(supertrait_ref.clone());
4819                 }
4820             }
4821
4822             i += 1;
4823         }
4824     }
4825     return true;
4826 }
4827
4828 pub fn required_region_bounds(tcx: &ctxt,
4829                               region_bounds: &[ty::Region],
4830                               builtin_bounds: BuiltinBounds,
4831                               trait_bounds: &[Rc<TraitRef>])
4832                               -> Vec<ty::Region>
4833 {
4834     /*!
4835      * Given a type which must meet the builtin bounds and trait
4836      * bounds, returns a set of lifetimes which the type must outlive.
4837      *
4838      * Requires that trait definitions have been processed.
4839      */
4840
4841     let mut all_bounds = Vec::new();
4842
4843     debug!("required_region_bounds(builtin_bounds={}, trait_bounds={})",
4844            builtin_bounds.repr(tcx),
4845            trait_bounds.repr(tcx));
4846
4847     all_bounds.push_all(region_bounds);
4848
4849     push_region_bounds([],
4850                        builtin_bounds,
4851                        &mut all_bounds);
4852
4853     debug!("from builtin bounds: all_bounds={}", all_bounds.repr(tcx));
4854
4855     each_bound_trait_and_supertraits(
4856         tcx,
4857         trait_bounds,
4858         |trait_ref| {
4859             let bounds = ty::bounds_for_trait_ref(tcx, &*trait_ref);
4860             push_region_bounds(bounds.opt_region_bound.as_slice(),
4861                                bounds.builtin_bounds,
4862                                &mut all_bounds);
4863             debug!("from {}: bounds={} all_bounds={}",
4864                    trait_ref.repr(tcx),
4865                    bounds.repr(tcx),
4866                    all_bounds.repr(tcx));
4867             true
4868         });
4869
4870     return all_bounds;
4871
4872     fn push_region_bounds(region_bounds: &[ty::Region],
4873                           builtin_bounds: ty::BuiltinBounds,
4874                           all_bounds: &mut Vec<ty::Region>) {
4875         all_bounds.push_all(region_bounds.as_slice());
4876
4877         if builtin_bounds.contains_elem(ty::BoundSend) {
4878             all_bounds.push(ty::ReStatic);
4879         }
4880     }
4881 }
4882
4883 pub fn get_tydesc_ty(tcx: &ctxt) -> Result<t, String> {
4884     tcx.lang_items.require(TyDescStructLangItem).map(|tydesc_lang_item| {
4885         tcx.intrinsic_defs.borrow().find_copy(&tydesc_lang_item)
4886             .expect("Failed to resolve TyDesc")
4887     })
4888 }
4889
4890 pub fn get_opaque_ty(tcx: &ctxt) -> Result<t, String> {
4891     tcx.lang_items.require(OpaqueStructLangItem).map(|opaque_lang_item| {
4892         tcx.intrinsic_defs.borrow().find_copy(&opaque_lang_item)
4893             .expect("Failed to resolve Opaque")
4894     })
4895 }
4896
4897 pub fn visitor_object_ty(tcx: &ctxt,
4898                          ptr_region: ty::Region,
4899                          trait_region: ty::Region)
4900                          -> Result<(Rc<TraitRef>, t), String>
4901 {
4902     let trait_lang_item = match tcx.lang_items.require(TyVisitorTraitLangItem) {
4903         Ok(id) => id,
4904         Err(s) => { return Err(s); }
4905     };
4906     let substs = Substs::empty();
4907     let trait_ref = Rc::new(TraitRef { def_id: trait_lang_item, substs: substs });
4908     Ok((trait_ref.clone(),
4909         mk_rptr(tcx, ptr_region,
4910                 mt {mutbl: ast::MutMutable,
4911                     ty: mk_trait(tcx,
4912                                  trait_ref.def_id,
4913                                  trait_ref.substs.clone(),
4914                                  ty::region_existential_bound(trait_region))})))
4915 }
4916
4917 pub fn item_variances(tcx: &ctxt, item_id: ast::DefId) -> Rc<ItemVariances> {
4918     lookup_locally_or_in_crate_store(
4919         "item_variance_map", item_id, &mut *tcx.item_variance_map.borrow_mut(),
4920         || Rc::new(csearch::get_item_variances(&tcx.sess.cstore, item_id)))
4921 }
4922
4923 /// Records a trait-to-implementation mapping.
4924 pub fn record_trait_implementation(tcx: &ctxt,
4925                                    trait_def_id: DefId,
4926                                    impl_def_id: DefId) {
4927     match tcx.trait_impls.borrow().find(&trait_def_id) {
4928         Some(impls_for_trait) => {
4929             impls_for_trait.borrow_mut().push(impl_def_id);
4930             return;
4931         }
4932         None => {}
4933     }
4934     tcx.trait_impls.borrow_mut().insert(trait_def_id, Rc::new(RefCell::new(vec!(impl_def_id))));
4935 }
4936
4937 /// Populates the type context with all the implementations for the given type
4938 /// if necessary.
4939 pub fn populate_implementations_for_type_if_necessary(tcx: &ctxt,
4940                                                       type_id: ast::DefId) {
4941     if type_id.krate == LOCAL_CRATE {
4942         return
4943     }
4944     if tcx.populated_external_types.borrow().contains(&type_id) {
4945         return
4946     }
4947
4948     csearch::each_implementation_for_type(&tcx.sess.cstore, type_id,
4949             |impl_def_id| {
4950         let impl_items = csearch::get_impl_items(&tcx.sess.cstore,
4951                                                  impl_def_id);
4952
4953         // Record the trait->implementation mappings, if applicable.
4954         let associated_traits = csearch::get_impl_trait(tcx, impl_def_id);
4955         for trait_ref in associated_traits.iter() {
4956             record_trait_implementation(tcx, trait_ref.def_id, impl_def_id);
4957         }
4958
4959         // For any methods that use a default implementation, add them to
4960         // the map. This is a bit unfortunate.
4961         for impl_item_def_id in impl_items.iter() {
4962             let method_def_id = impl_item_def_id.def_id();
4963             match impl_or_trait_item(tcx, method_def_id) {
4964                 MethodTraitItem(method) => {
4965                     for &source in method.provided_source.iter() {
4966                         tcx.provided_method_sources
4967                            .borrow_mut()
4968                            .insert(method_def_id, source);
4969                     }
4970                 }
4971             }
4972         }
4973
4974         // Store the implementation info.
4975         tcx.impl_items.borrow_mut().insert(impl_def_id, impl_items);
4976
4977         // If this is an inherent implementation, record it.
4978         if associated_traits.is_none() {
4979             match tcx.inherent_impls.borrow().find(&type_id) {
4980                 Some(implementation_list) => {
4981                     implementation_list.borrow_mut().push(impl_def_id);
4982                     return;
4983                 }
4984                 None => {}
4985             }
4986             tcx.inherent_impls.borrow_mut().insert(type_id,
4987                                                    Rc::new(RefCell::new(vec!(impl_def_id))));
4988         }
4989     });
4990
4991     tcx.populated_external_types.borrow_mut().insert(type_id);
4992 }
4993
4994 /// Populates the type context with all the implementations for the given
4995 /// trait if necessary.
4996 pub fn populate_implementations_for_trait_if_necessary(
4997         tcx: &ctxt,
4998         trait_id: ast::DefId) {
4999     if trait_id.krate == LOCAL_CRATE {
5000         return
5001     }
5002     if tcx.populated_external_traits.borrow().contains(&trait_id) {
5003         return
5004     }
5005
5006     csearch::each_implementation_for_trait(&tcx.sess.cstore, trait_id,
5007             |implementation_def_id| {
5008         let impl_items = csearch::get_impl_items(&tcx.sess.cstore, implementation_def_id);
5009
5010         // Record the trait->implementation mapping.
5011         record_trait_implementation(tcx, trait_id, implementation_def_id);
5012
5013         // For any methods that use a default implementation, add them to
5014         // the map. This is a bit unfortunate.
5015         for impl_item_def_id in impl_items.iter() {
5016             let method_def_id = impl_item_def_id.def_id();
5017             match impl_or_trait_item(tcx, method_def_id) {
5018                 MethodTraitItem(method) => {
5019                     for &source in method.provided_source.iter() {
5020                         tcx.provided_method_sources
5021                            .borrow_mut()
5022                            .insert(method_def_id, source);
5023                     }
5024                 }
5025             }
5026         }
5027
5028         // Store the implementation info.
5029         tcx.impl_items.borrow_mut().insert(implementation_def_id, impl_items);
5030     });
5031
5032     tcx.populated_external_traits.borrow_mut().insert(trait_id);
5033 }
5034
5035 /// Given the def_id of an impl, return the def_id of the trait it implements.
5036 /// If it implements no trait, return `None`.
5037 pub fn trait_id_of_impl(tcx: &ctxt,
5038                         def_id: ast::DefId) -> Option<ast::DefId> {
5039     let node = match tcx.map.find(def_id.node) {
5040         Some(node) => node,
5041         None => return None
5042     };
5043     match node {
5044         ast_map::NodeItem(item) => {
5045             match item.node {
5046                 ast::ItemImpl(_, Some(ref trait_ref), _, _) => {
5047                     Some(node_id_to_trait_ref(tcx, trait_ref.ref_id).def_id)
5048                 }
5049                 _ => None
5050             }
5051         }
5052         _ => None
5053     }
5054 }
5055
5056 /// If the given def ID describes a method belonging to an impl, return the
5057 /// ID of the impl that the method belongs to. Otherwise, return `None`.
5058 pub fn impl_of_method(tcx: &ctxt, def_id: ast::DefId)
5059                        -> Option<ast::DefId> {
5060     if def_id.krate != LOCAL_CRATE {
5061         return match csearch::get_impl_or_trait_item(tcx,
5062                                                      def_id).container() {
5063             TraitContainer(_) => None,
5064             ImplContainer(def_id) => Some(def_id),
5065         };
5066     }
5067     match tcx.impl_or_trait_items.borrow().find_copy(&def_id) {
5068         Some(trait_item) => {
5069             match trait_item.container() {
5070                 TraitContainer(_) => None,
5071                 ImplContainer(def_id) => Some(def_id),
5072             }
5073         }
5074         None => None
5075     }
5076 }
5077
5078 /// If the given def ID describes an item belonging to a trait (either a
5079 /// default method or an implementation of a trait method), return the ID of
5080 /// the trait that the method belongs to. Otherwise, return `None`.
5081 pub fn trait_of_item(tcx: &ctxt, def_id: ast::DefId) -> Option<ast::DefId> {
5082     if def_id.krate != LOCAL_CRATE {
5083         return csearch::get_trait_of_item(&tcx.sess.cstore, def_id, tcx);
5084     }
5085     match tcx.impl_or_trait_items.borrow().find_copy(&def_id) {
5086         Some(impl_or_trait_item) => {
5087             match impl_or_trait_item.container() {
5088                 TraitContainer(def_id) => Some(def_id),
5089                 ImplContainer(def_id) => trait_id_of_impl(tcx, def_id),
5090             }
5091         }
5092         None => None
5093     }
5094 }
5095
5096 /// If the given def ID describes an item belonging to a trait, (either a
5097 /// default method or an implementation of a trait method), return the ID of
5098 /// the method inside trait definition (this means that if the given def ID
5099 /// is already that of the original trait method, then the return value is
5100 /// the same).
5101 /// Otherwise, return `None`.
5102 pub fn trait_item_of_item(tcx: &ctxt, def_id: ast::DefId)
5103                           -> Option<ImplOrTraitItemId> {
5104     let impl_item = match tcx.impl_or_trait_items.borrow().find(&def_id) {
5105         Some(m) => m.clone(),
5106         None => return None,
5107     };
5108     let name = match impl_item {
5109         MethodTraitItem(method) => method.ident.name,
5110     };
5111     match trait_of_item(tcx, def_id) {
5112         Some(trait_did) => {
5113             let trait_items = ty::trait_items(tcx, trait_did);
5114             trait_items.iter()
5115                 .position(|m| m.ident().name == name)
5116                 .map(|idx| ty::trait_item(tcx, trait_did, idx).id())
5117         }
5118         None => None
5119     }
5120 }
5121
5122 /// Creates a hash of the type `t` which will be the same no matter what crate
5123 /// context it's calculated within. This is used by the `type_id` intrinsic.
5124 pub fn hash_crate_independent(tcx: &ctxt, t: t, svh: &Svh) -> u64 {
5125     let mut state = sip::SipState::new();
5126     macro_rules! byte( ($b:expr) => { ($b as u8).hash(&mut state) } );
5127     macro_rules! hash( ($e:expr) => { $e.hash(&mut state) } );
5128
5129     let region = |_state: &mut sip::SipState, r: Region| {
5130         match r {
5131             ReStatic => {}
5132
5133             ReEmpty |
5134             ReEarlyBound(..) |
5135             ReLateBound(..) |
5136             ReFree(..) |
5137             ReScope(..) |
5138             ReInfer(..) => {
5139                 tcx.sess.bug("non-static region found when hashing a type")
5140             }
5141         }
5142     };
5143     let did = |state: &mut sip::SipState, did: DefId| {
5144         let h = if ast_util::is_local(did) {
5145             svh.clone()
5146         } else {
5147             tcx.sess.cstore.get_crate_hash(did.krate)
5148         };
5149         h.as_str().hash(state);
5150         did.node.hash(state);
5151     };
5152     let mt = |state: &mut sip::SipState, mt: mt| {
5153         mt.mutbl.hash(state);
5154     };
5155     ty::walk_ty(t, |t| {
5156         match ty::get(t).sty {
5157             ty_nil => byte!(0),
5158             ty_bot => byte!(1),
5159             ty_bool => byte!(2),
5160             ty_char => byte!(3),
5161             ty_int(i) => {
5162                 byte!(4);
5163                 hash!(i);
5164             }
5165             ty_uint(u) => {
5166                 byte!(5);
5167                 hash!(u);
5168             }
5169             ty_float(f) => {
5170                 byte!(6);
5171                 hash!(f);
5172             }
5173             ty_str => {
5174                 byte!(7);
5175             }
5176             ty_enum(d, _) => {
5177                 byte!(8);
5178                 did(&mut state, d);
5179             }
5180             ty_box(_) => {
5181                 byte!(9);
5182             }
5183             ty_uniq(_) => {
5184                 byte!(10);
5185             }
5186             ty_vec(_, Some(n)) => {
5187                 byte!(11);
5188                 n.hash(&mut state);
5189             }
5190             ty_vec(_, None) => {
5191                 byte!(11);
5192                 0u8.hash(&mut state);
5193             }
5194             ty_ptr(m) => {
5195                 byte!(12);
5196                 mt(&mut state, m);
5197             }
5198             ty_rptr(r, m) => {
5199                 byte!(13);
5200                 region(&mut state, r);
5201                 mt(&mut state, m);
5202             }
5203             ty_bare_fn(ref b) => {
5204                 byte!(14);
5205                 hash!(b.fn_style);
5206                 hash!(b.abi);
5207             }
5208             ty_closure(ref c) => {
5209                 byte!(15);
5210                 hash!(c.fn_style);
5211                 hash!(c.onceness);
5212                 hash!(c.bounds);
5213                 match c.store {
5214                     UniqTraitStore => byte!(0),
5215                     RegionTraitStore(r, m) => {
5216                         byte!(1)
5217                         region(&mut state, r);
5218                         assert_eq!(m, ast::MutMutable);
5219                     }
5220                 }
5221             }
5222             ty_trait(box ty::TyTrait { def_id: d, bounds, .. }) => {
5223                 byte!(17);
5224                 did(&mut state, d);
5225                 hash!(bounds);
5226             }
5227             ty_struct(d, _) => {
5228                 byte!(18);
5229                 did(&mut state, d);
5230             }
5231             ty_tup(ref inner) => {
5232                 byte!(19);
5233                 hash!(inner.len());
5234             }
5235             ty_param(p) => {
5236                 byte!(20);
5237                 hash!(p.idx);
5238                 did(&mut state, p.def_id);
5239             }
5240             ty_open(_) => byte!(22),
5241             ty_infer(_) => unreachable!(),
5242             ty_err => byte!(23),
5243             ty_unboxed_closure(d, r) => {
5244                 byte!(24);
5245                 did(&mut state, d);
5246                 region(&mut state, r);
5247             }
5248         }
5249     });
5250
5251     state.result()
5252 }
5253
5254 impl Variance {
5255     pub fn to_string(self) -> &'static str {
5256         match self {
5257             Covariant => "+",
5258             Contravariant => "-",
5259             Invariant => "o",
5260             Bivariant => "*",
5261         }
5262     }
5263 }
5264
5265 pub fn construct_parameter_environment(
5266     tcx: &ctxt,
5267     generics: &ty::Generics,
5268     free_id: ast::NodeId)
5269     -> ParameterEnvironment
5270 {
5271     /*! See `ParameterEnvironment` struct def'n for details */
5272
5273     //
5274     // Construct the free substs.
5275     //
5276
5277     // map T => T
5278     let mut types = VecPerParamSpace::empty();
5279     for &space in subst::ParamSpace::all().iter() {
5280         push_types_from_defs(tcx, &mut types, space,
5281                              generics.types.get_slice(space));
5282     }
5283
5284     // map bound 'a => free 'a
5285     let mut regions = VecPerParamSpace::empty();
5286     for &space in subst::ParamSpace::all().iter() {
5287         push_region_params(&mut regions, space, free_id,
5288                            generics.regions.get_slice(space));
5289     }
5290
5291     let free_substs = Substs {
5292         types: types,
5293         regions: subst::NonerasedRegions(regions)
5294     };
5295
5296     //
5297     // Compute the bounds on Self and the type parameters.
5298     //
5299
5300     let mut bounds = VecPerParamSpace::empty();
5301     for &space in subst::ParamSpace::all().iter() {
5302         push_bounds_from_defs(tcx, &mut bounds, space, &free_substs,
5303                               generics.types.get_slice(space));
5304     }
5305
5306     //
5307     // Compute region bounds. For now, these relations are stored in a
5308     // global table on the tcx, so just enter them there. I'm not
5309     // crazy about this scheme, but it's convenient, at least.
5310     //
5311
5312     for &space in subst::ParamSpace::all().iter() {
5313         record_region_bounds_from_defs(tcx, space, &free_substs,
5314                                        generics.regions.get_slice(space));
5315     }
5316
5317
5318     debug!("construct_parameter_environment: free_id={} \
5319            free_subst={} \
5320            bounds={}",
5321            free_id,
5322            free_substs.repr(tcx),
5323            bounds.repr(tcx));
5324
5325     return ty::ParameterEnvironment {
5326         free_substs: free_substs,
5327         bounds: bounds,
5328         implicit_region_bound: ty::ReScope(free_id),
5329     };
5330
5331     fn push_region_params(regions: &mut VecPerParamSpace<ty::Region>,
5332                           space: subst::ParamSpace,
5333                           free_id: ast::NodeId,
5334                           region_params: &[RegionParameterDef])
5335     {
5336         for r in region_params.iter() {
5337             regions.push(space, ty::free_region_from_def(free_id, r));
5338         }
5339     }
5340
5341     fn push_types_from_defs(tcx: &ty::ctxt,
5342                             types: &mut subst::VecPerParamSpace<ty::t>,
5343                             space: subst::ParamSpace,
5344                             defs: &[TypeParameterDef]) {
5345         for (i, def) in defs.iter().enumerate() {
5346             let ty = ty::mk_param(tcx, space, i, def.def_id);
5347             types.push(space, ty);
5348         }
5349     }
5350
5351     fn push_bounds_from_defs(tcx: &ty::ctxt,
5352                              bounds: &mut subst::VecPerParamSpace<ParamBounds>,
5353                              space: subst::ParamSpace,
5354                              free_substs: &subst::Substs,
5355                              defs: &[TypeParameterDef]) {
5356         for def in defs.iter() {
5357             let b = def.bounds.subst(tcx, free_substs);
5358             bounds.push(space, b);
5359         }
5360     }
5361
5362     fn record_region_bounds_from_defs(tcx: &ty::ctxt,
5363                                       space: subst::ParamSpace,
5364                                       free_substs: &subst::Substs,
5365                                       defs: &[RegionParameterDef]) {
5366         for (subst_region, def) in
5367             free_substs.regions().get_slice(space).iter().zip(
5368                 defs.iter())
5369         {
5370             // For each region parameter 'subst...
5371             let bounds = def.bounds.subst(tcx, free_substs);
5372             for bound_region in bounds.iter() {
5373                 // Which is declared with a bound like 'subst:'bound...
5374                 match (subst_region, bound_region) {
5375                     (&ty::ReFree(subst_fr), &ty::ReFree(bound_fr)) => {
5376                         // Record that 'subst outlives 'bound. Or, put
5377                         // another way, 'bound <= 'subst.
5378                         tcx.region_maps.relate_free_regions(bound_fr, subst_fr);
5379                     },
5380                     _ => {
5381                         // All named regions are instantiated with free regions.
5382                         tcx.sess.bug(
5383                             format!("push_region_bounds_from_defs: \
5384                                      non free region: {} / {}",
5385                                     subst_region.repr(tcx),
5386                                     bound_region.repr(tcx)).as_slice());
5387                     }
5388                 }
5389             }
5390         }
5391     }
5392 }
5393
5394 impl BorrowKind {
5395     pub fn from_mutbl(m: ast::Mutability) -> BorrowKind {
5396         match m {
5397             ast::MutMutable => MutBorrow,
5398             ast::MutImmutable => ImmBorrow,
5399         }
5400     }
5401
5402     pub fn to_user_str(&self) -> &'static str {
5403         match *self {
5404             MutBorrow => "mutable",
5405             ImmBorrow => "immutable",
5406             UniqueImmBorrow => "uniquely immutable",
5407         }
5408     }
5409 }
5410
5411 impl<'tcx> mc::Typer<'tcx> for ty::ctxt<'tcx> {
5412     fn tcx<'a>(&'a self) -> &'a ty::ctxt<'tcx> {
5413         self
5414     }
5415
5416     fn node_ty(&self, id: ast::NodeId) -> mc::McResult<ty::t> {
5417         Ok(ty::node_id_to_type(self, id))
5418     }
5419
5420     fn node_method_ty(&self, method_call: typeck::MethodCall) -> Option<ty::t> {
5421         self.method_map.borrow().find(&method_call).map(|method| method.ty)
5422     }
5423
5424     fn adjustments<'a>(&'a self) -> &'a RefCell<NodeMap<ty::AutoAdjustment>> {
5425         &self.adjustments
5426     }
5427
5428     fn is_method_call(&self, id: ast::NodeId) -> bool {
5429         self.method_map.borrow().contains_key(&typeck::MethodCall::expr(id))
5430     }
5431
5432     fn temporary_scope(&self, rvalue_id: ast::NodeId) -> Option<ast::NodeId> {
5433         self.region_maps.temporary_scope(rvalue_id)
5434     }
5435
5436     fn upvar_borrow(&self, upvar_id: ty::UpvarId) -> ty::UpvarBorrow {
5437         self.upvar_borrow_map.borrow().get_copy(&upvar_id)
5438     }
5439
5440     fn capture_mode(&self, closure_expr_id: ast::NodeId)
5441                     -> freevars::CaptureMode {
5442         self.capture_modes.borrow().get_copy(&closure_expr_id)
5443     }
5444
5445     fn unboxed_closures<'a>(&'a self)
5446                         -> &'a RefCell<DefIdMap<UnboxedClosure>> {
5447         &self.unboxed_closures
5448     }
5449 }
5450
5451 /// The category of explicit self.
5452 #[deriving(Clone, Eq, PartialEq)]
5453 pub enum ExplicitSelfCategory {
5454     StaticExplicitSelfCategory,
5455     ByValueExplicitSelfCategory,
5456     ByReferenceExplicitSelfCategory(Region, ast::Mutability),
5457     ByBoxExplicitSelfCategory,
5458 }
5459
5460 /// Pushes all the lifetimes in the given type onto the given list. A
5461 /// "lifetime in a type" is a lifetime specified by a reference or a lifetime
5462 /// in a list of type substitutions. This does *not* traverse into nominal
5463 /// types, nor does it resolve fictitious types.
5464 pub fn accumulate_lifetimes_in_type(accumulator: &mut Vec<ty::Region>,
5465                                     typ: t) {
5466     walk_ty(typ, |typ| {
5467         match get(typ).sty {
5468             ty_rptr(region, _) => accumulator.push(region),
5469             ty_enum(_, ref substs) |
5470             ty_trait(box TyTrait {
5471                 substs: ref substs,
5472                 ..
5473             }) |
5474             ty_struct(_, ref substs) => {
5475                 match substs.regions {
5476                     subst::ErasedRegions => {}
5477                     subst::NonerasedRegions(ref regions) => {
5478                         for region in regions.iter() {
5479                             accumulator.push(*region)
5480                         }
5481                     }
5482                 }
5483             }
5484             ty_closure(ref closure_ty) => {
5485                 match closure_ty.store {
5486                     RegionTraitStore(region, _) => accumulator.push(region),
5487                     UniqTraitStore => {}
5488                 }
5489             }
5490             ty_unboxed_closure(_, ref region) => accumulator.push(*region),
5491             ty_nil |
5492             ty_bot |
5493             ty_bool |
5494             ty_char |
5495             ty_int(_) |
5496             ty_uint(_) |
5497             ty_float(_) |
5498             ty_box(_) |
5499             ty_uniq(_) |
5500             ty_str |
5501             ty_vec(_, _) |
5502             ty_ptr(_) |
5503             ty_bare_fn(_) |
5504             ty_tup(_) |
5505             ty_param(_) |
5506             ty_infer(_) |
5507             ty_open(_) |
5508             ty_err => {}
5509         }
5510     })
5511 }